sqlite3.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2001      Fabien Seisen        <seisen@linuxfr.org>
 * Copyright (C) 2002-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2011 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2006      Andre Cianfarani     <acianfa@free.fr>
 * Copyright (C) 2005-2009 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2015      Raphaël Doursenaud   <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2024-2026  MDW         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2026  Frédéric France         <frederic.france@free.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/db/DoliDB.class.php';
 
class DoliDBSqlite3 extends DoliDB
{
  public $type = 'sqlite3';
  const LABEL = 'Sqlite3';
  const VERSIONMIN = '3.0.0';
 
  private $_results;
 
  private $queryString;
 
  const WEEK_MONDAY_FIRST = 1;
  const WEEK_YEAR = 2;
  const WEEK_FIRST_WEEKDAY = 4;
 
 
  public function __construct($type, $host, $user, $pass, $name = '', $port = 0, $forcenew = false)  // @phpstan-ignore constructor.unusedParameter, constructor.unusedParameter
  {
    global $conf;
 
    // Note that having "static" property for "$forcecharset" and "$forcecollate" will make error here in strict mode, so they are not static
    if (!empty($conf->db->character_set)) {
      $this->forcecharset = $conf->db->character_set;
    }
    if (!empty($conf->db->dolibarr_main_db_collation)) {
      $this->forcecollate = $conf->db->dolibarr_main_db_collation;
    }
 
    $this->database_user = $user;
    $this->database_host = $host;
    $this->database_port = $port;
 
    $this->transaction_opened = 0;
 
    //print "Name DB: $host,$user,$pass,$name<br>";
 
    /*if (! function_exists("sqlite_query"))
    {
      $this->connected = false;
      $this->ok = false;
      $this->error="Sqlite PHP functions for using Sqlite driver are not available in this version of PHP. Try to use another driver.";
      dol_syslog(get_class($this)."::DoliDBSqlite3 : Sqlite PHP functions for using Sqlite driver are not available in this version of PHP. Try to use another driver.",LOG_ERR);
      return;
    }*/
 
    /*if (! $host)
    {
      $this->connected = false;
      $this->ok = false;
      $this->error=$langs->trans("ErrorWrongHostParameter");
      dol_syslog(get_class($this)."::DoliDBSqlite3 : Erreur Connect, wrong host parameters",LOG_ERR);
      return;
    }*/
 
    // Essai connection serveur
    // We do not try to connect to database, only to server. Connect to database is done later in constructor
    $this->db = $this->connect($host, $user, $pass, $name, $port);
 
    if ($this->db) {
      $this->connected = true;
      $this->ok = true;
      $this->database_selected = true;
      $this->database_name = $name;
 
      $this->addCustomFunction('IF');
      $this->addCustomFunction('MONTH');
      $this->addCustomFunction('CURTIME');
      $this->addCustomFunction('CURDATE');
      $this->addCustomFunction('WEEK', 1);
      $this->addCustomFunction('WEEK', 2);
      $this->addCustomFunction('WEEKDAY');
      $this->addCustomFunction('date_format');
      //$this->db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
    } else {
      // host, login ou password incorrect
      $this->connected = false;
      $this->ok = false;
      $this->database_selected = false;
      $this->database_name = '';
      //$this->error=sqlite_connect_error();
      dol_syslog(get_class($this)."::DoliDBSqlite3 : Error Connect ".$this->error, LOG_ERR);
    }
  }
 
 
  public function convertSQLFromMysql($line, $type = 'ddl')
  {
    // Removed empty line if this is a comment line for SVN tagging
    if (preg_match('/^--\s\$Id/i', $line)) {
      return '';
    }
    // Return line if this is a comment
    if (preg_match('/^#/i', $line) || preg_match('/^$/i', $line) || preg_match('/^--/i', $line)) {
      return $line;
    }
    if ($line != "") {
      if ($type == 'auto') {
        if (preg_match('/ALTER TABLE/i', $line)) {
          $type = 'dml';
        } elseif (preg_match('/CREATE TABLE/i', $line)) {
          $type = 'dml';
        } elseif (preg_match('/DROP TABLE/i', $line)) {
          $type = 'dml';
        }
      }
 
      if ($type == 'dml') {
        $line = preg_replace('/\s/', ' ', $line); // Replace tabulation with space
 
        // we are inside create table statement so let's process datatypes
        if (preg_match('/(ISAM|innodb)/i', $line)) { // end of create table sequence
          $line = preg_replace('/\‍)[\s\t]*type[\s\t]*=[\s\t]*(MyISAM|innodb);/i', ');', $line);
          $line = preg_replace('/\‍)[\s\t]*engine[\s\t]*=[\s\t]*(MyISAM|innodb);/i', ');', $line);
          $line = preg_replace('/,$/', '', $line);
        }
 
        // Process case: "CREATE TABLE llx_mytable(rowid integer NOT NULL AUTO_INCREMENT PRIMARY KEY,code..."
        if (preg_match('/[\s\t\‍(]*(\w*)[\s\t]+int.*auto_increment/i', $line, $reg)) {
          $newline = preg_replace('/([\s\t\‍(]*)([a-zA-Z_0-9]*)[\s\t]+int.*auto_increment[^,]*/i', '\\1 \\2 integer PRIMARY KEY AUTOINCREMENT', $line);
          //$line = "-- ".$line." replaced by --\n".$newline;
          $line = $newline;
        }
 
        // tinyint type conversion
        $line = str_replace('tinyint', 'smallint', $line);
 
        // nuke unsigned
        $line = preg_replace('/(int\w+|smallint)\s+unsigned/i', '\\1', $line);
 
        // blob -> text
        $line = preg_replace('/\w*blob/i', 'text', $line);
 
        // tinytext/mediumtext -> text
        $line = preg_replace('/tinytext/i', 'text', $line);
        $line = preg_replace('/mediumtext/i', 'text', $line);
 
        // change not null datetime field to null valid ones
        // (to support remapping of "zero time" to null
        $line = preg_replace('/datetime not null/i', 'datetime', $line);
        $line = preg_replace('/datetime/i', 'timestamp', $line);
 
        // double -> numeric
        $line = preg_replace('/^double/i', 'numeric', $line);
        $line = preg_replace('/(\s*)double/i', '\\1numeric', $line);
        // float -> numeric
        $line = preg_replace('/^float/i', 'numeric', $line);
        $line = preg_replace('/(\s*)float/i', '\\1numeric', $line);
 
        // unique index(field1,field2)
        if (preg_match('/unique index\s*\‍((\w+\s*,\s*\w+)\‍)/i', $line)) {
          $line = preg_replace('/unique index\s*\‍((\w+\s*,\s*\w+)\‍)/i', 'UNIQUE\‍(\\1\‍)', $line);
        }
 
        // We remove end of requests "AFTER fieldxxx"
        $line = preg_replace('/AFTER [a-z0-9_]+/i', '', $line);
 
        // We remove start of requests "ALTER TABLE tablexxx" if this is a DROP INDEX
        $line = preg_replace('/ALTER TABLE [a-z0-9_]+ DROP INDEX/i', 'DROP INDEX', $line);
 
        // Translate order to rename fields
        if (preg_match('/ALTER TABLE ([a-z0-9_]+) CHANGE(?: COLUMN)? ([a-z0-9_]+) ([a-z0-9_]+)(.*)$/i', $line, $reg)) {
          $line = "-- ".$line." replaced by --\n";
          $line .= "ALTER TABLE ".$reg[1]." RENAME COLUMN ".$reg[2]." TO ".$reg[3];
        }
 
        // Translate order to modify field format
        if (preg_match('/ALTER TABLE ([a-z0-9_]+) MODIFY(?: COLUMN)? ([a-z0-9_]+) (.*)$/i', $line, $reg)) {
          $line = "-- ".$line." replaced by --\n";
          $newreg3 = $reg[3];
          $newreg3 = preg_replace('/ DEFAULT NULL/i', '', $newreg3);
          $newreg3 = preg_replace('/ NOT NULL/i', '', $newreg3);
          $newreg3 = preg_replace('/ NULL/i', '', $newreg3);
          $newreg3 = preg_replace('/ DEFAULT 0/i', '', $newreg3);
          $newreg3 = preg_replace('/ DEFAULT \'[0-9a-zA-Z_@]*\'/i', '', $newreg3);
          $line .= "ALTER TABLE ".$reg[1]." ALTER COLUMN ".$reg[2]." TYPE ".$newreg3;
          // TODO Add alter to set default value or null/not null if there is this in $reg[3]
        }
 
        // alter table add primary key (field1, field2 ...) -> We create a unique index instead as dynamic creation of primary key is not supported
        // ALTER TABLE llx_dolibarr_modules ADD PRIMARY KEY pk_dolibarr_modules (numero, entity);
        if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+PRIMARY\s+KEY\s*(.*)\s*\‍((.*)$/i', $line, $reg)) {
          $line = "-- ".$line." replaced by --\n";
          $line .= "CREATE UNIQUE INDEX ".$reg[2]." ON ".$reg[1]."(".$reg[3];
        }
 
        // Translate order to drop foreign keys
        // ALTER TABLE llx_dolibarr_modules DROP FOREIGN KEY fk_xxx;
        if (preg_match('/ALTER\s+TABLE\s*(.*)\s*DROP\s+FOREIGN\s+KEY\s*(.*)$/i', $line, $reg)) {
          $line = "-- ".$line." replaced by --\n";
          $line .= "ALTER TABLE ".$reg[1]." DROP CONSTRAINT ".$reg[2];
        }
 
        // alter table add [unique] [index] (field1, field2 ...)
        // ALTER TABLE llx_accountingaccount ADD INDEX idx_accountingaccount_fk_pcg_version (fk_pcg_version)
        if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+(UNIQUE INDEX|INDEX|UNIQUE)\s+(.*)\s*\‍(([\w,\s]+)\‍)/i', $line, $reg)) {
          $fieldlist = $reg[4];
          $idxname = $reg[3];
          $tablename = $reg[1];
          $line = "-- ".$line." replaced by --\n";
          $line .= "CREATE ".(preg_match('/UNIQUE/', $reg[2]) ? 'UNIQUE ' : '')."INDEX ".$idxname." ON ".$tablename." (".$fieldlist.")";
        }
        if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+CONSTRAINT\s+(.*)\s*FOREIGN\s+KEY\s*\‍(([\w,\s]+)\‍)\s*REFERENCES\s+(\w+)\s*\‍(([\w,\s]+)\‍)/i', $line, $reg)) {
          // Constraints are not yet created
          dol_syslog(get_class().'::query line emptied');
          $line = 'SELECT 0;';
        }
 
        //if (preg_match('/rowid\s+.*\s+PRIMARY\s+KEY,/i', $line)) {
        //preg_replace('/(rowid\s+.*\s+PRIMARY\s+KEY\s*,)/i', '/* \\1 */', $line);
        //}
      }
 
      // Delete using criteria on other table must not declare twice the deleted table
      // DELETE FROM tabletodelete USING tabletodelete, othertable -> DELETE FROM tabletodelete USING othertable
      if (preg_match('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i', $line, $reg)) {
        if ($reg[1] == $reg[2]) { // If same table, we remove second one
          $line = preg_replace('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i', 'DELETE FROM \\1 USING \\3', $line);
        }
      }
 
      // Remove () in the tables in FROM if one table
      $line = preg_replace('/FROM\s*\‍((([a-z_]+)\s+as\s+([a-z_]+)\s*)\‍)/i', 'FROM \\1', $line);
      //print $line."\n";
 
      // Remove () in the tables in FROM if two table
      $line = preg_replace('/FROM\s*\‍(([a-z_]+\s+as\s+[a-z_]+)\s*,\s*([a-z_]+\s+as\s+[a-z_]+\s*)\‍)/i', 'FROM \\1, \\2', $line);
      //print $line."\n";
 
      // Remove () in the tables in FROM if two table
      $line = preg_replace('/FROM\s*\‍(([a-z_]+\s+as\s+[a-z_]+)\s*,\s*([a-z_]+\s+as\s+[a-z_]+\s*),\s*([a-z_]+\s+as\s+[a-z_]+\s*)\‍)/i', 'FROM \\1, \\2, \\3', $line);
      //print $line."\n";
 
      //print "type=".$type." newline=".$line."<br>\n";
    }
 
    return $line;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function select_db($database)
  {
    // phpcs:enable
    dol_syslog(get_class($this)."::select_db database=".$database, LOG_DEBUG);
    // sqlite_select_db() does not exist
    //return sqlite_select_db($this->db,$database);
    return true;
  }
 
 
  public function connect($host, $login, $passwd, $name, $port = 0, $forcenew = false)
  {
    global $main_data_dir;
 
    dol_syslog(get_class($this)."::connect name=".$name, LOG_DEBUG);
 
    $dir = $main_data_dir;
    if (empty($dir)) {
      $dir = DOL_DATA_ROOT;
    }
    // With sqlite, port must be in connect parameters
    //if (! $newport) $newport=3306;
    $database_name = $dir.'/database_'.$name.'.sdb';
    try {
      /*** connect to SQLite database ***/
      //$this->db = new PDO("sqlite:".$dir.'/database_'.$name.'.sdb');
      $this->db = new SQLite3($database_name);
      //$this->db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
    } catch (Throwable $e) {
      $this->error = self::LABEL.' '.$e->getMessage().' current dir='.$database_name;
      return false;
    }
 
    //print "Result of connect function: ".$this->db;
    return $this->db;
  }
 
 
  public function getVersion()
  {
    $tmp = $this->db->version();
    return $tmp['versionString'];
  }
 
  public function getDriverInfo()
  {
    return 'sqlite3 php driver';
  }
 
 
  public function close()
  {
    if ($this->db) {
      if ($this->transaction_opened > 0) {
        dol_syslog(get_class($this)."::close Closing a connection with an opened transaction depth=".$this->transaction_opened, LOG_ERR);
      }
      $this->connected = false;
      $this->db->close();
      unset($this->db); // Clean this->db
      return true;
    }
    return false;
  }
 
  public function query($query, $usesavepoint = 0, $type = 'auto', $result_mode = 0)
  {
    global $conf, $dolibarr_main_db_readonly;
 
    $ret = false;
 
    $query = trim($query);
 
    $this->error = '';
 
    // Convert MySQL syntax to SQLite syntax
    $reg = array();
    if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+CONSTRAINT\s+(.*)\s*FOREIGN\s+KEY\s*\‍(([\w,\s]+)\‍)\s*REFERENCES\s+(\w+)\s*\‍(([\w,\s]+)\‍)/i', $query, $reg)) {
      // Adding a foreign key to the table
      // table replacement procedure to add the constraint
      // Example : ALTER TABLE llx_adherent ADD CONSTRAINT adherent_fk_soc FOREIGN KEY (fk_soc) REFERENCES llx_societe (rowid)
      // -> CREATE TABLE ( ... ,CONSTRAINT adherent_fk_soc FOREIGN KEY (fk_soc) REFERENCES llx_societe (rowid))
      $foreignFields = $reg[5];
      $foreignTable = $reg[4];
      $localfields = $reg[3];
      $constraintname = trim($reg[2]);
      $tablename = trim($reg[1]);
 
      $descTable = $this->db->querySingle("SELECT sql FROM sqlite_master WHERE name='".$this->escape($tablename)."'");
 
      // 1- Rename the table to a temporary name
      $this->query("ALTER TABLE ".$tablename." RENAME TO tmp_".$tablename);
 
      // 2- Recreate the table with the new constraint
 
      // Adjust the SQL request to add the constraint
      $descTable = substr($descTable, 0, strlen($descTable) - 1);
      $descTable .= ", CONSTRAINT ".$constraintname." FOREIGN KEY (".$localfields.") REFERENCES ".$foreignTable."(".$foreignFields.")";
 
      // Add closing parenthesis for SQL query
      $descTable .= ')';
 
      // Perform query to create the table
      $this->query($descTable);
 
      // 3- Copy the data from the temporary table (before adding constraint)
      $this->query("INSERT INTO ".$tablename." SELECT * FROM tmp_".$tablename);
 
      // 4- Delete the original (now temporary) table
      $this->query("DROP TABLE tmp_".$tablename);
 
      // dummy statement
      $query = "SELECT 0";
    } else {
      $query = $this->convertSQLFromMysql($query, $type);
    }
    //print "After convertSQLFromMysql:\n".$query."<br>\n";
 
    if (!in_array($query, array('BEGIN', 'COMMIT', 'ROLLBACK'))) {
      $SYSLOG_SQL_LIMIT = 10000; // limit log to 10kb per line to limit DOS attacks
      dol_syslog('sql='.substr($query, 0, $SYSLOG_SQL_LIMIT), LOG_DEBUG);
    }
    if (empty($query)) {
      return false; // Return false = error if empty request
    }
 
    if (!empty($dolibarr_main_db_readonly)) {
      if (preg_match('/^(INSERT|UPDATE|REPLACE|DELETE|CREATE|ALTER|TRUNCATE|DROP)/i', $query)) {
        $this->lasterror = 'Application in read-only mode';
        $this->lasterrno = 'APPREADONLY';
        $this->lastquery = $query;
        return false;
      }
    }
 
    // SQL statement that does not require a connection to a database (example: CREATE DATABASE)
    try {
      //$ret = $this->db->exec($query);
      $ret = $this->db->query($query); // $ret is a Sqlite3Result
      if ($ret) {
        $this->queryString = $query;
      }
    } catch (Throwable $e) {
      $this->error = $this->db->lastErrorMsg();
    }
 
    if (!preg_match("/^COMMIT/i", $query) && !preg_match("/^ROLLBACK/i", $query)) {
      // If it is a user query, save it along with its resultset
      if (!is_object($ret) || $this->error) {
        $this->lastqueryerror = $query;
        $this->lasterror = $this->error();
        $this->lasterrno = $this->errno();
 
        dol_syslog(get_class($this)."::query SQL Error query: ".$query, LOG_ERR);
 
        $errormsg = get_class($this)."::query SQL Error message: ".$this->lasterror;
 
        if (preg_match('/[0-9]/', $this->lasterrno)) {
          $errormsg .= ' ('.$this->lasterrno.')';
        }
 
        if (getDolGlobalString('SYSLOG_LEVEL') < LOG_DEBUG) {
          dol_syslog(get_class($this)."::query SQL Error query: ".$query, LOG_ERR); // Log of request was not yet done previously
        }
        dol_syslog(get_class($this)."::query SQL Error message: ".$errormsg, LOG_ERR);
      }
      $this->lastquery = $query;
      $this->_results = $ret;
    }
 
    return $ret;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_object($resultset)
  {
    // phpcs:enable
    // If the resultset is not provided, use the last one used on this connection
    if (!is_object($resultset)) {
      $resultset = $this->_results;
    }
    //return $resultset->fetch(PDO::FETCH_OBJ);
    $ret = $resultset->fetchArray(SQLITE3_ASSOC);
    if ($ret) {
      return (object) $ret;
    }
    return false;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_array($resultset)
  {
    // phpcs:enable
    // If resultset not provided, we take the last used by connection
    if (!is_object($resultset)) {
      $resultset = $this->_results;
    }
    //return $resultset->fetch(PDO::FETCH_ASSOC);
    $ret = $resultset->fetchArray(SQLITE3_ASSOC);
    return $ret;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_row($resultset)
  {
    // phpcs:enable
    // If resultset not provided, we take the last used by connection
    if (!is_bool($resultset)) {
      if (!is_object($resultset)) {
        $resultset = $this->_results;
      }
      return $resultset->fetchArray(SQLITE3_NUM);
    } else {
      // If the cursor is a boolean, return 0
      return 0;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function num_rows($resultset)
  {
    // phpcs:enable
 
    // If resultset not provided, we take the last used by connection
    if (!is_object($resultset)) {
      $resultset = $this->_results;
    }
    // Ignore Phan - queryString is added as dynamic property @phan-suppress-next-line PhanUndeclaredProperty
    if (preg_match("/^SELECT/i", $resultset->queryString)) {
      // Ignore Phan - queryString is added as dynamic property @phan-suppress-next-line PhanUndeclaredProperty
      return $this->db->querySingle("SELECT count(*) FROM (".$resultset->queryString.") q");
    }
    return 0;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function affected_rows($resultset)
  {
    // phpcs:enable
 
    // If resultset not provided, we take the last used by connection
    if (!is_object($resultset)) {
      $resultset = $this->_results;
    }
    if (preg_match("/^SELECT/i", $this->queryString)) {
      return $this->num_rows($resultset);
    }
    // mysql requires a base link for this function, unlike pgsql which takes a resultset
    return $this->db->changes();
  }
 
 
  public function free($resultset = null)
  {
    // If resultset not provided, we take the last used by connection
    if (!is_object($resultset)) {
      $resultset = $this->_results;
    }
    // If resultset is one, free the memory
    if ($resultset && is_object($resultset)) {
      $resultset->finalize();
    }
  }
 
  public function escape($stringtoencode)
  {
    return SQLite3::escapeString((string) $stringtoencode);
  }
 
  public function escapeforlike($stringtoencode)
  {
    return str_replace(array('\\', '_', '%'), array('\\\\', '\_', '\%'), (string) $stringtoencode);
  }
 
  public function errno()
  {
    if (!$this->connected) {
      // If the connection failed, $this->db is not valid.
      return 'DB_ERROR_FAILED_TO_CONNECT';
    } else {
      // Constants to convert error code to a generic Dolibarr error code
      /*$errorcode_map = array(
      1004 => 'DB_ERROR_CANNOT_CREATE',
      1005 => 'DB_ERROR_CANNOT_CREATE',
      1006 => 'DB_ERROR_CANNOT_CREATE',
      1007 => 'DB_ERROR_ALREADY_EXISTS',
      1008 => 'DB_ERROR_CANNOT_DROP',
      1025 => 'DB_ERROR_NO_FOREIGN_KEY_TO_DROP',
      1044 => 'DB_ERROR_ACCESSDENIED',
      1046 => 'DB_ERROR_NODBSELECTED',
      1048 => 'DB_ERROR_CONSTRAINT',
      'HY000' => 'DB_ERROR_TABLE_ALREADY_EXISTS',
      1051 => 'DB_ERROR_NOSUCHTABLE',
      1054 => 'DB_ERROR_NOSUCHFIELD',
      1060 => 'DB_ERROR_COLUMN_ALREADY_EXISTS',
      1061 => 'DB_ERROR_KEY_NAME_ALREADY_EXISTS',
      1062 => 'DB_ERROR_RECORD_ALREADY_EXISTS',
      1064 => 'DB_ERROR_SYNTAX',
      1068 => 'DB_ERROR_PRIMARY_KEY_ALREADY_EXISTS',
      1075 => 'DB_ERROR_CANT_DROP_PRIMARY_KEY',
      1091 => 'DB_ERROR_NOSUCHFIELD',
      1100 => 'DB_ERROR_NOT_LOCKED',
      1136 => 'DB_ERROR_VALUE_COUNT_ON_ROW',
      1146 => 'DB_ERROR_NOSUCHTABLE',
      1216 => 'DB_ERROR_NO_PARENT',
      1217 => 'DB_ERROR_CHILD_EXISTS',
      1451 => 'DB_ERROR_CHILD_EXISTS'
      );
 
      if (isset($errorcode_map[$this->db->errorCode()]))
      {
        return $errorcode_map[$this->db->errorCode()];
      }*/
      $errno = $this->db->lastErrorCode();
      if ($errno == 'HY000' || $errno == 0) {
        if (preg_match('/table.*already exists/i', $this->error)) {
          return 'DB_ERROR_TABLE_ALREADY_EXISTS';
        } elseif (preg_match('/index.*already exists/i', $this->error)) {
          return 'DB_ERROR_KEY_NAME_ALREADY_EXISTS';
        } elseif (preg_match('/syntax error/i', $this->error)) {
          return 'DB_ERROR_SYNTAX';
        }
      }
      if ($errno == '23000') {
        if (preg_match('/column.* not unique/i', $this->error)) {
          return 'DB_ERROR_RECORD_ALREADY_EXISTS';
        } elseif (preg_match('/PRIMARY KEY must be unique/i', $this->error)) {
          return 'DB_ERROR_RECORD_ALREADY_EXISTS';
        }
      }
      if ($errno > 1) {
        // TODO See the list of error messages
      }
 
      return ($errno ? 'DB_ERROR_'.$errno : '0');
    }
  }
 
  public function error()
  {
    if (!$this->connected) {
      // If the connection failed, $this->db is not valid for sqlite_error.
      return 'Not connected. Check setup parameters in conf/conf.php file and your sqlite version';
    } else {
      return $this->error;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function last_insert_id($tab, $fieldid = 'rowid')
  {
    // phpcs:enable
    return $this->db->lastInsertRowId();
  }
 
  public function encrypt($fieldorvalue, $withQuotes = 1)
  {
    global $conf;
 
    // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
    $cryptType = (!empty($conf->db->dolibarr_main_db_encryption) ? $conf->db->dolibarr_main_db_encryption : 0);
 
    //Encryption key
    $cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey) ? $conf->db->dolibarr_main_db_cryptkey : '');
 
    $escapedstringwithquotes = ($withQuotes ? "'" : "").$this->escape($fieldorvalue).($withQuotes ? "'" : "");
 
    if ($cryptType && !empty($cryptKey)) {
      if ($cryptType == 2) {
        $escapedstringwithquotes = "AES_ENCRYPT(".$escapedstringwithquotes.", '".$this->escape($cryptKey)."')";
      } elseif ($cryptType == 1) {
        $escapedstringwithquotes = "DES_ENCRYPT(".$escapedstringwithquotes.", '".$this->escape($cryptKey)."')";
      }
    }
 
    return $escapedstringwithquotes;
  }
 
  public function decrypt($value)
  {
    global $conf;
 
    // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
    $cryptType = ($conf->db->dolibarr_main_db_encryption ? $conf->db->dolibarr_main_db_encryption : 0);
 
    //Encryption key
    $cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey) ? $conf->db->dolibarr_main_db_cryptkey : '');
 
    $return = $value;
 
    if ($cryptType && !empty($cryptKey)) {
      if ($cryptType == 2) {
        $return = 'AES_DECRYPT('.$value.',\''.$cryptKey.'\')';
      } elseif ($cryptType == 1) {
        $return = 'DES_DECRYPT('.$value.',\''.$cryptKey.'\')';
      }
    }
 
    return $return;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLGetConnectId()
  {
    // phpcs:enable
    return '?';
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLCreateDb($database, $charset = '', $collation = '', $owner = '')
  {
    // phpcs:enable
    if (empty($charset)) {
      $charset = $this->forcecharset;
    }
    if (empty($collation)) {
      $collation = $this->forcecollate;
    }
 
    // ALTER DATABASE dolibarr_db DEFAULT CHARACTER SET latin DEFAULT COLLATE latin1_swedish_ci
    $sql = "CREATE DATABASE ".$this->sanitize($database);
    $sql .= " DEFAULT CHARACTER SET ".$this->sanitize($charset)." DEFAULT COLLATE ".$this->sanitize($collation);
 
    dol_syslog($sql, LOG_DEBUG);
    $ret = $this->query($sql);
 
    return $ret;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLListTables($database, $table = '')
  {
    // phpcs:enable
    $listtables = array();
 
    $sanitizedlike = '';
    if ($table) {
      $tmptable = preg_replace('/[^a-z0-9\.\-\_%]/i', '', $table);
 
      $sanitizedlike = "LIKE '".$this->escape($tmptable)."'";
    }
    $sanitizedtmpdatabase = preg_replace('/[^a-z0-9\.\-\_]/i', '', $database);  // @phan-suppress-current-line SqlInjection
 
    $sql = "SHOW TABLES FROM ".$sanitizedtmpdatabase." ".$sanitizedlike.";";
    //print $sql;
    $result = $this->query($sql);
    if ($result) {
      while ($row = $this->fetch_row($result)) {
        $listtables[] = $row[0];
      }
    }
    return $listtables;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLListTablesFull($database, $table = '')
  {
    // phpcs:enable
    $listtables = array();
 
    $sanitizedlike = '';
    if ($table) {
      $tmptable = preg_replace('/[^a-z0-9\.\-\_%]/i', '', $table);
 
      $sanitizedlike = "LIKE '".$this->escape($tmptable)."'";
    }
    $sanitizedtmpdatabase = preg_replace('/[^a-z0-9\.\-\_]/i', '', $database);  // @phan-suppress-current-line SqlInjection
 
    $sql = "SHOW FULL TABLES FROM ".$sanitizedtmpdatabase." ".$sanitizedlike.";";
    //print $sql;
    $result = $this->query($sql);
    if ($result) {
      while ($row = $this->fetch_row($result)) {
        $listtables[] = $row;
      }
    }
    return $listtables;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLInfoTable($table)
  {
    // phpcs:enable
    $infotables = array();
 
    $sanitizedtmptable = preg_replace('/[^a-z0-9\.\-\_]/i', '', $table);
 
    $sql = "SHOW FULL COLUMNS FROM ".$sanitizedtmptable.";";
 
    dol_syslog($sql, LOG_DEBUG);
    $result = $this->query($sql);
    if ($result) {
      while ($row = $this->fetch_row($result)) {
        $infotables[] = $row;
      }
    }
    return $infotables;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null)
  {
    // phpcs:enable
    // @TODO: $fulltext_keys parameter is unused
 
    $sqlk = array();
    $sqluq = array();
 
    // Keys found into the array $fields: type,value,attribute,null,default,extra
    // ex. : $fields['rowid'] = array(
    //      'type'=>'int' or 'integer',
    //      'value'=>'11',
    //      'null'=>'not null',
    //      'extra'=> 'auto_increment'
    //    );
    $sql = "CREATE TABLE ".$this->sanitize($table)."(";
    $i = 0;
    $sqlfields = array();
    foreach ($fields as $field_name => $field_desc) {
      $sqlfields[$i] = $this->sanitize($field_name)." ";
      $sqlfields[$i] .= $this->sanitize($field_desc['type']);
      if (!is_null($field_desc['value']) && $field_desc['value'] !== '') {
        $sqlfields[$i] .= "(".$this->sanitize($field_desc['value']).")";
      }
      if (!is_null($field_desc['attribute']) && $field_desc['attribute'] !== '') {
        $sqlfields[$i] .= " ".$this->sanitize($field_desc['attribute']);
      }
      if (!is_null($field_desc['default']) && $field_desc['default'] !== '') {
        if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
          $sqlfields[$i] .= " DEFAULT ".((float) $field_desc['default']);
        } elseif ($field_desc['default'] == 'null' || $field_desc['default'] == 'CURRENT_TIMESTAMP') {
          $sqlfields[$i] .= " DEFAULT ".$this->sanitize($field_desc['default']);
        } else {
          $sqlfields[$i] .= " DEFAULT '".$this->escape($field_desc['default'])."'";
        }
      }
      if (!is_null($field_desc['null']) && $field_desc['null'] !== '') {
        $sqlfields[$i] .= " ".$this->sanitize($field_desc['null'], 0, 0, 1);
      }
      if (!is_null($field_desc['extra']) && $field_desc['extra'] !== '') {
        $sqlfields[$i] .= " ".$this->sanitize($field_desc['extra'], 0, 0, 1);
      }
      $i++;
    }
    if ($primary_key != "") {
      $sanitizedpk = "PRIMARY KEY(".$this->sanitize($primary_key).")";
    } else {
      $sanitizedpk = "";
    }
 
 
    if (is_array($unique_keys)) {
      $i = 0;
      foreach ($unique_keys as $key => $value) {
        $sqluq[$i] = "UNIQUE KEY '".$this->sanitize($key)."' ('".$this->escape($value)."')";
        $i++;
      }
    }
    if (is_array($keys)) {
      $i = 0;
      foreach ($keys as $key => $value) {
        $sqlk[$i] = "KEY ".$this->sanitize($key)." (".$value.")";
        $i++;
      }
    }
    $sql .= implode(',', $sqlfields);
    if ($primary_key != "") {
      $sql .= ",".$sanitizedpk;
    }
    if ($unique_keys != "") {
      $sql .= ",".implode(',', $sqluq);
    }
    if (is_array($keys)) {
      $sql .= ",".implode(',', $sqlk);
    }
    $sql .= ")";
    //$sql .= " engine=".$this->sanitize($type);
 
    if (!$this->query($sql)) {
      return -1;
    } else {
      return 1;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLDropTable($table)
  {
    // phpcs:enable
    $sanitizedtmptable = preg_replace('/[^a-z0-9\.\-\_]/i', '', $table);
 
    $sql = "DROP TABLE ".$sanitizedtmptable;
 
    if (!$this->query($sql)) {
      return -1;
    } else {
      return 1;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLDescTable($table, $field = "")
  {
    // phpcs:enable
    $sql = "DESC ".$this->sanitize($table)." ".$this->sanitize($field);
 
    dol_syslog(get_class($this)."::DDLDescTable ".$sql, LOG_DEBUG);
    $this->_results = $this->query($sql);
    return $this->_results;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLAddField($table, $field_name, $field_desc, $field_position = "")
  {
    // phpcs:enable
    // keys looked up in the descriptions array (field_desc): type,value,attribute,null,default,extra
    // ex. : $field_desc = array('type'=>'int','value'=>'11','null'=>'not null','extra'=> 'auto_increment');
    $sql = "ALTER TABLE ".$this->sanitize($table)." ADD ".$this->sanitize($field_name)." ";
 
    if ($field_desc['type'] !== 'datetimegmt') {
      $sql .= $this->sanitize($field_desc['type']);
    } else {
      $sql .= 'datetime';
    }
 
    if (in_array($field_desc['type'], array('double', 'int', 'varchar')) && array_key_exists('value', $field_desc) && !empty($field_desc['value'])) {
      $sql .= "(".$this->sanitize($field_desc['value']).")";
    }
    if (isset($field_desc['attribute']) && preg_match("/^[^\s]/i", $field_desc['attribute'])) {
      $sql .= " ".$this->sanitize($field_desc['attribute']);
    }
    if (isset($field_desc['null']) && preg_match("/^[^\s]/i", $field_desc['null'])) {
      if ($field_desc['null'] == 'NOT NULL') {
        $sql .= " ".$this->sanitize($field_desc['null'], 0, 0, 1);
      } else {
        $sql .= " ".$this->sanitize($field_desc['null']);
      }
    }
    if (isset($field_desc['default']) && preg_match("/^[^\s]/i", $field_desc['default'])) {
      if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
        $sql .= " DEFAULT ".((float) $field_desc['default']);
      } elseif ($field_desc['default'] == 'null' || $field_desc['default'] == 'CURRENT_TIMESTAMP') {
        $sql .= " DEFAULT ".$this->sanitize($field_desc['default']);
      } else {
        $sql .= " DEFAULT '".$this->escape($field_desc['default'])."'";
      }
    }
    if (isset($field_desc['extra']) && preg_match("/^[^\s]/i", $field_desc['extra'])) {
      $sql .= " ".$this->sanitize($field_desc['extra'], 0, 0, 1);
    }
    $sql .= " ".$this->sanitize($field_position, 0, 0, 1);
 
    dol_syslog(get_class($this)."::DDLAddField ".$sql, LOG_DEBUG);
    if (!$this->query($sql)) {
      return -1;
    }
    return 1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLUpdateField($table, $field_name, $field_desc)
  {
    // phpcs:enable
    $sql = "ALTER TABLE ".$this->sanitize($table);
    $sql .= " MODIFY COLUMN ".$this->sanitize($field_name)." ";
 
    if ($field_desc['type'] !== 'datetimegmt') {
      $sql .= $this->sanitize($field_desc['type']);
    } else {
      $sql .= 'datetime';
    }
 
    if (in_array($field_desc['type'], array('double', 'int', 'varchar')) && array_key_exists('value', $field_desc) && !empty($field_desc['value'])) {
      $sql .= "(".$this->sanitize($field_desc['value']).")";
    }
 
    dol_syslog(get_class($this)."::DDLUpdateField ".$sql, LOG_DEBUG);
    if (!$this->query($sql)) {
      return -1;
    }
    return 1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLDropField($table, $field_name)
  {
    // phpcs:enable
    $tmp_field_name = preg_replace('/[^a-z0-9\.\-\_]/i', '', $field_name);
 
    $sql = "ALTER TABLE ".$this->sanitize($table)." DROP COLUMN `".$this->sanitize($tmp_field_name)."`";
    if (!$this->query($sql)) {
      $this->error = $this->lasterror();
      return -1;
    }
    return 1;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name)
  {
    // phpcs:enable
    $sql = "INSERT INTO user ";
    $sql .= "(Host,User,password,Select_priv,Insert_priv,Update_priv,Delete_priv,Create_priv,Drop_priv,Index_Priv,Alter_priv,Lock_tables_priv)";
    $sql .= " VALUES ('".$this->escape($dolibarr_main_db_host)."','".$this->escape($dolibarr_main_db_user)."',password('".$this->escape($dolibarr_main_db_pass)."')";
    $sql .= ",'Y','Y','Y','Y','Y','Y','Y','Y','Y')";
 
    dol_syslog(get_class($this)."::DDLCreateUser", LOG_DEBUG); // No sql to avoid password in log
    $resql = $this->query($sql);
    if (!$resql) {
      return -1;
    }
 
    $sql = "INSERT INTO db ";
    $sql .= "(Host,Db,User,Select_priv,Insert_priv,Update_priv,Delete_priv,Create_priv,Drop_priv,Index_Priv,Alter_priv,Lock_tables_priv)";
    $sql .= " VALUES ('".$this->escape($dolibarr_main_db_host)."','".$this->escape($dolibarr_main_db_name)."','".$this->escape($dolibarr_main_db_user)."'";
    $sql .= ",'Y','Y','Y','Y','Y','Y','Y','Y','Y')";
 
    dol_syslog(get_class($this)."::DDLCreateUser", LOG_DEBUG);
    $resql = $this->query($sql);
    if (!$resql) {
      return -1;
    }
 
    $sql = "FLUSH Privileges";
 
    dol_syslog(get_class($this)."::DDLCreateUser", LOG_DEBUG);
    $resql = $this->query($sql);
    if (!$resql) {
      return -1;
    }
    return 1;
  }
 
  public function getDefaultCharacterSetDatabase()
  {
    return 'UTF-8';
  }
 
  public function getListOfCharacterSet()
  {
    $liste = array();
    $i = 0;
    $liste[$i]['charset'] = 'UTF-8';
    $liste[$i]['description'] = 'UTF-8';
    return $liste;
  }
 
  public function getDefaultCollationDatabase()
  {
    return 'UTF-8';
  }
 
  public function getListOfCollation()
  {
    $liste = array();
    $i = 0;
    $liste[$i]['collation'] = 'UTF-8';
    return $liste;
  }
 
  public function getPathOfDump()
  {
    // FIXME: not for SQLite
    $fullpathofdump = '/pathtomysqldump/mysqldump';
 
    $resql = $this->query("SHOW VARIABLES LIKE 'basedir'");
    if ($resql) {
      $liste = $this->fetch_array($resql);
      $basedir = $liste['Value'];
      $fullpathofdump = $basedir.(preg_match('/\/$/', $basedir) ? '' : '/').'bin/mysqldump';
    }
    return $fullpathofdump;
  }
 
  public function getPathOfRestore()
  {
    // FIXME: not for SQLite
    $fullpathofimport = '/pathtomysql/mysql';
 
    $resql = $this->query("SHOW VARIABLES LIKE 'basedir'");
    if ($resql) {
      $liste = $this->fetch_array($resql);
      $basedir = $liste['Value'];
      $fullpathofimport = $basedir.(preg_match('/\/$/', $basedir) ? '' : '/').'bin/mysql';
    }
    return $fullpathofimport;
  }
 
  public function getServerParametersValues($filter = '')
  {
    $result = array();
    static $pragmas;
    if (!isset($pragmas)) {
      // Define the list of pragmas used that return only a single value
      // independent of the database.
      // cf. http://www.sqlite.org/pragma.html
      $pragmas = array(
        'application_id', 'auto_vacuum', 'automatic_index', 'busy_timeout', 'cache_size',
        'cache_spill', 'case_sensitive_like', 'checkpoint_fullsync', 'collation_list',
        'compile_options', 'data_version', /*'database_list',*/
        'defer_foreign_keys', 'encoding', 'foreign_key_check', 'freelist_count',
        'full_column_names', 'fullsync', 'ingore_check_constraints', 'integrity_check',
        'journal_mode', 'journal_size_limit', 'legacy_file_format', 'locking_mode',
        'max_page_count', 'page_count', 'page_size', 'parser_trace',
        'query_only', 'quick_check', 'read_uncommitted', 'recursive_triggers',
        'reverse_unordered_selects', 'schema_version', 'user_version',
        'secure_delete', 'short_column_names', 'shrink_memory', 'soft_heap_limit',
        'synchronous', 'temp_store', /*'temp_store_directory',*/ 'threads',
        'vdbe_addoptrace', 'vdbe_debug', 'vdbe_listing', 'vdbe_trace',
        'wal_autocheckpoint',
      );
    }
 
    // TODO prendre en compte le filtre
    foreach ($pragmas as $var) {
      $sql = "PRAGMA $var";  // @phan-suppress-current-line SqlInjection
      $resql = $this->query($sql);
      if ($resql) {
        $obj = $this->fetch_row($resql);
        //dol_syslog(get_class($this)."::select_db getServerParametersValues $var=". print_r($obj, true), LOG_DEBUG);
        $result[$var] = $obj[0];
      } else {
        // TODO Retrieve the message
        $result[$var] = 'FAIL';
      }
    }
    return $result;
  }
 
  public function getServerStatusValues($filter = '')
  {
    $result = array();
    /*
    $sql='SHOW STATUS';
    if ($filter) {
      $sql.=" LIKE '".$this->escape($filter)."'";
    }
    $resql=$this->query($sql);
    if ($resql)
    {
      while ($obj=$this->fetch_object($resql)) $result[$obj->Variable_name]=$obj->Value;
    }
     */
 
    return $result;
  }
 
  private function addCustomFunction($name, $arg_count = -1)
  {
    if ($this->db) {
      $newname = preg_replace('/_/', '', $name);
      $localname = __CLASS__.'::db'.$newname;
      $reflectClass = new ReflectionClass(__CLASS__);
      $reflectFunction = $reflectClass->getMethod('db'.$newname);
      if ($arg_count < 0) {
        $arg_count = $reflectFunction->getNumberOfParameters();
      }
      if (!$this->db->createFunction($name, $localname, $arg_count)) {
        $this->error = "unable to create custom function '$name'";
      }
    }
  }
 
  public function prepare($sql)
  {
    $sql = $this->convertSQLFromMysql($sql);
 
    dol_syslog(get_class($this)."::prepare sql=".$sql, LOG_DEBUG);
 
    try {
      $stmt = $this->db->prepare($sql);
    } catch (Throwable $e) {
      $stmt = false;
      $this->error = $e->getMessage();
    }
    if (!($stmt instanceof SQLite3Stmt)) {
      $this->lasterror = $this->error ? $this->error : $this->db->lastErrorMsg();
      $this->lastqueryerror = $sql;
      return false;
    }
    // Keep the query text so num_rows()/affected_rows() can tell a SELECT from the rest
    $this->queryString = $sql;
 
    return $stmt;
  }
 
  public function execute($stmt, $params = array())
  {
    if (!($stmt instanceof SQLite3Stmt)) {
      $this->lasterror = 'execute() called with an invalid statement';
      return false;
    }
 
    $this->lasterror = '';
    $this->error = '';
 
    $i = 1;
    foreach (array_values($params) as $v) {
      if (is_int($v) || is_bool($v)) {
        $stmt->bindValue($i, (int) $v, SQLITE3_INTEGER);
      } elseif (is_float($v)) {
        $stmt->bindValue($i, $v, SQLITE3_FLOAT);
      } elseif (is_null($v)) {
        $stmt->bindValue($i, null, SQLITE3_NULL);
      } else {
        $stmt->bindValue($i, (string) $v, SQLITE3_TEXT);
      }
      $i++;
    }
 
    dol_syslog(get_class($this)."::execute (".($i - 1)." bound param(s))", LOG_DEBUG);
 
    try {
      $res = $stmt->execute();
    } catch (Throwable $e) {
      $res = false;
      $this->error = $e->getMessage();
    }
    if (!($res instanceof SQLite3Result)) {
      $this->lasterror = $this->error ? $this->error : $this->db->lastErrorMsg();
      return false;
    }
 
    $this->_results = $res;
 
    return ($res->numColumns() > 0) ? $res : true;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  /* Unused/commented
   * calc_daynr
   *
   * param  int   $year   Year
   * param  int   $month    Month
   * param  int     $day    Day
   * return int Formatted date
   */
  /*
  private static function calc_daynr($year, $month, $day)
  {
    // phpcs:enable
    $y = $year;
    if ($y == 0 && $month == 0) {
      return 0;
    }
    $num = (365 * $y + 31 * ($month - 1) + $day);
    if ($month <= 2) {
      $y--;
    } else {
      $num -= floor(($month * 4 + 23) / 10);
    }
    $temp = floor(($y / 100 + 1) * 3 / 4);
    return (int) ($num + floor($y / 4) - $temp);
  }
  */
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  /* Unused/commented
   * calc_weekday
   *
   * param int  $daynr              ???
   * param bool $sunday_first_day_of_week   ???
   * return int
   */
  /*
  private static function calc_weekday($daynr, $sunday_first_day_of_week)
  {
    // phpcs:enable
    $ret = (int) floor(($daynr + 5 + ($sunday_first_day_of_week ? 1 : 0)) % 7);
    return $ret;
  }
  */
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  /* Unused/commented
   * calc_days_in_year
   *
   * param  int   $year   Year
   * return int         Nb of days in year
   */
  /*
  private static function calc_days_in_year($year)
  {
    // phpcs:enable
    return (($year & 3) == 0 && ($year % 100 || ($year % 400 == 0 && $year)) ? 366 : 365);
  }
  */
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  /* Unused/commented
   * calc_week
   *
   * param  int   $year       Year
   * param  int   $month        Month
   * param  int   $day        Day
   * param  int   $week_behaviour   Week behaviour, bit masks: WEEK_MONDAY_FIRST, WEEK_YEAR, WEEK_FIRST_WEEKDAY
   * param  int   $calc_year      ??? Year where the week started
   * return int             ??? Week number in year
   */
  /*
  private static function calc_week($year, $month, $day, $week_behaviour, &$calc_year)
  {
    // phpcs:enable
    $daynr = self::calc_daynr($year, $month, $day);
    $first_daynr = self::calc_daynr($year, 1, 1);
    $monday_first = ($week_behaviour & self::WEEK_MONDAY_FIRST) ? 1 : 0;
    $week_year = ($week_behaviour & self::WEEK_YEAR) ? 1 : 0;
    $first_weekday = ($week_behaviour & self::WEEK_FIRST_WEEKDAY) ? 1 : 0;
 
    $weekday = self::calc_weekday($first_daynr, !$monday_first);
    $calc_year = $year;
 
    if ($month == 1 && $day <= 7 - $weekday) {
      if (!$week_year && (($first_weekday && $weekday != 0) || (!$first_weekday && $weekday >= 4))) {
        return 0;
      }
      $week_year = 1;
      $calc_year--;
      $first_daynr -= ($days = self::calc_days_in_year($calc_year));
      $weekday = ($weekday + 53 * 7 - $days) % 7;
    }
 
    if (($first_weekday && $weekday != 0) || (!$first_weekday && $weekday >= 4)) {
      $days = $daynr - ($first_daynr + (7 - $weekday));
    } else {
      $days = $daynr - ($first_daynr - $weekday);
    }
 
    if ($week_year && $days >= 52 * 7) {
      $weekday = ($weekday + self::calc_days_in_year($calc_year)) % 7;
      if ((!$first_weekday && $weekday < 4) || ($first_weekday && $weekday == 0)) {
        $calc_year++;
        return 1;
      }
    }
    return (int) floor($days / 7 + 1);
  }
  */
}