DoliDB.class.php

Go to the documentation of this file.

<?php
/*
 * Copyright (C) 2013-2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2014-2015 Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2024-2026  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       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/Database.interface.php';
 
 
abstract class DoliDB implements Database
{
  const VERSIONMIN = self::VERSIONMIN;
  const LABEL = self::LABEL;
 
  public $db;
  public $type;
  public $forcecharset = 'utf8';
  public $forcecollate = 'utf8_unicode_ci';
 
  private $_results; // @phpstan-ignore-line
 
  public $connected;
  public $database_selected;
  public $database_name;
  public $database_user;
  public $database_host;
  public $database_port;
  public $transaction_opened;
  public $lastquery;
  public $lastqueryerror;
  public $lasterror;
  public $lasterrno;
 
  public $prefix_db;
 
  public $ok;
  public $error;
 
 
 
  public function prefix()
  {
    return (empty($this->prefix_db) ? MAIN_DB_PREFIX : $this->prefix_db);
  }
 
  public function ifsql($test, $resok, $resko)
  {
    //return 'IF('.$test.','.$resok.','.$resko.')';   // Not sql standard
    return '(CASE WHEN '.$test.' THEN '.$resok.' ELSE '.$resko.' END)';
  }
 
  public function stddevpop($nameoffield)
  {
    return 'STDDEV_POP('.$nameoffield.')';
  }
 
  public function hintindex($nameofindex, $mode = 1)
  {
    return '';
  }
 
 
  public function regexpsql($subject, $pattern, $sqlstring = 0)
  {
    if ($sqlstring) {
      return "(". $subject ." REGEXP '" . $this->escape($pattern) . "')";
    }
 
    return "('". $this->escape($subject) ."' REGEXP '" . $this->escape($pattern) . "')";
  }
 
 
  public function idate($param, $gm = 'tzserver')
  {
    // TODO $param should be gmt, so we should have default $gm to 'gmt' instead of default 'tzserver'
    return dol_print_date($param, "%Y-%m-%d %H:%M:%S", $gm);
  }
 
  public function lasterrno()
  {
    return $this->lasterrno;
  }
 
  public function sanitize($stringtosanitize, $allowsimplequote = 0, $allowsequals = 0, $allowsspace = 0, $allowschars = 1)
  {
    $result = preg_replace('/[^0-9_\-\.,'.($allowschars ? '\p{L}' : '').($allowsequals ? '=' : '').($allowsimplequote ? "\'" : '').($allowsspace ? ' ' : '').']/ui', '', $stringtosanitize);
    //$result = preg_replace('/[^0-9_\-\.,'.($allowschars ? 'a-z' : '').($allowsequals ? '=' : '').($allowsimplequote ? "\'" : '').($allowsspace ? ' ' : '').']/i', '', $stringtosanitize);
 
    if ($allowsimplequote == 1) {
      // Remove all quotes that are inside a string and not around
      $tmpchars = explode(',', $result);
      $newstringarray = array();
      foreach ($tmpchars as $tmpchar) {
        $reg = array();
        if (preg_match('/^\'(.*)\'$/', $tmpchar, $reg)) {
          $newstringarray[] = "'".str_replace("'", "", $reg[1])."'";
        } else {
          $newstringarray[] = str_replace("'", "", $tmpchar);
        }
      }
      $result = implode(',', $newstringarray);
    }
 
    return $result;
  }
 
  public function begin($textinlog = '')
  {
    if (!$this->transaction_opened) {
      $ret = $this->query("BEGIN");
      if ($ret) {
        $this->transaction_opened++;
        dol_syslog("BEGIN Transaction".($textinlog ? ' '.$textinlog : ''), LOG_DEBUG);
        dol_syslog('', 0, 1);
        return 1;
      } else {
        return 0;
      }
    } else {
      $this->transaction_opened++;
      dol_syslog('', 0, 1);
      return 1;
    }
  }
 
  public function commit($log = '')
  {
    dol_syslog('', 0, -1);
    if ($this->transaction_opened <= 1) {
      $ret = $this->query("COMMIT");
      if ($ret) {
        $this->transaction_opened = 0;
        dol_syslog("COMMIT Transaction".($log ? ' '.$log : ''), LOG_DEBUG);
        return 1;
      } else {
        return 0;
      }
    } else {
      $this->transaction_opened--;
      return 1;
    }
  }
 
  public function rollback($log = '')
  {
    dol_syslog('', 0, -1);
    if ($this->transaction_opened <= 1) {
      $ret = $this->query("ROLLBACK");
      $this->transaction_opened = 0;
      dol_syslog("ROLLBACK Transaction".($log ? ' '.$log : ''), LOG_DEBUG);
      return $ret;
    } else {
      $this->transaction_opened--;
      return 1;
    }
  }
 
  public function plimit($limit = 0, $offset = 0)
  {
    global $conf;
    if (empty($limit)) {
      return "";
    }
    if ($limit < 0) {
      $limit = $conf->liste_limit;
    }
    if ($offset > 0) {
      return " LIMIT ".((int) $offset).",".((int) $limit)." ";
    } else {
      return " LIMIT ".((int) $limit)." ";
    }
  }
 
  public function getVersionArray()
  {
    return preg_split("/[\.,-]/", $this->getVersion());
  }
 
  public function lastquery()
  {
    return $this->lastquery;
  }
 
  public function order($sortfield = '', $sortorder = '')
  {
    if (!empty($sortfield)) {
      $oldsortorder = '';
      $return = '';
 
      // If text is "field1, f(a,b,c) as xxx, field2", we must convert string into 'field1,xxx,field2'
      $sortfield = preg_replace('/[a-z_]+\‍([^\‍)]*\‍) as ([\w]+)/i', '\1', $sortfield);
 
      $fields = explode(',', $sortfield);
      $orders = (!empty($sortorder) ? explode(',', $sortorder) : array());
      $i = 0;
 
 
      foreach ($fields as $val) {
        // Sanitized fieldname
        $fieldname = preg_replace('/[^0-9a-z_\.]/i', '', $val);
        if (!$fieldname) {
          continue;
        }
 
        if (!$return) {
          $return .= ' ORDER BY ';
        } else {
          $return .= ', ';
        }
 
        // Add field
        $return .= $fieldname;
 
        $tmpsortorder = (empty($orders[$i]) ? '' : trim($orders[$i]));
 
        // Only ASC and DESC values are valid SQL
        if (strtoupper($tmpsortorder) === 'ASC') {
          $oldsortorder = 'ASC';
          $return .= ' ASC';
        } elseif (strtoupper($tmpsortorder) === 'DESC') {
          $oldsortorder = 'DESC';
          $return .= ' DESC';
        } else {
          $return .= ' '.($oldsortorder ? $oldsortorder : 'ASC');
        }
 
        $i++;
      }
      return $return;
    } else {
      return '';
    }
  }
 
  public function lasterror()
  {
    return $this->lasterror;
  }
 
  public function jdate($string, $gm = 'tzserver')
  {
    // TODO $string should be converted into a GMT timestamp, so param gm should be set to true by default instead of false
 
    $string = (string) $string;
    if ($string == '' || $string == '0' || $string == "0000-00-00 00:00:00") {
      return '';
    }
    $string = preg_replace('/([^0-9])/i', '', $string);
    $tmp = $string.'000000';
    $date = dol_mktime((int) substr($tmp, 8, 2), (int) substr($tmp, 10, 2), (int) substr($tmp, 12, 2), (int) substr($tmp, 4, 2), (int) substr($tmp, 6, 2), (int) substr($tmp, 0, 4), $gm);
 
    return $date;
  }
 
  public function lastqueryerror()
  {
    return $this->lastqueryerror;
  }
 
  public function getRow($sql)
  {
    $sql .= ' LIMIT 1';
 
    $resql = $this->query($sql);
    if ($resql) {
      $obj = $this->fetch_object($resql);
      if ($obj) {
        $this->free($resql);
        return $obj;
      } else {
        return 0;
      }
    }
 
    return false;
  }
 
  public function getRows($sql)
  {
    if (!preg_match('/LIMIT \d+(?:(?:,\ *\d*)|(?:\ +OFFSET\ +\d*))?\ *;?$/', $sql)) {
      trigger_error(__CLASS__ .'::'.__FUNCTION__.'() query must have a LIMIT clause', E_USER_ERROR);
    }
 
    $resql = $this->query($sql);
    if ($resql) {
      $results = array();
      if ($this->num_rows($resql) > 0) {
        while ($obj = $this->fetch_object($resql)) {
          $results[] = $obj;
        }
      }
      $this->free($resql);
      return $results;
    }
 
    return false;
  }
 
  public function getNextAutoIncrementId($table)
  {
    $this->lasterror = 'getNextAutoIncrementId() not implemented for this driver. Failed to get next ID for table '.$table;
 
    return -1;
  }
 
  public function prepare($sql)
  {
    $this->lasterror = 'prepare() not implemented for this driver. Failed to prepare '.$sql;
 
    return false;
  }
}