api.class.php

<?php
/* Copyright (C) 2015     Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2016   Laurent Destailleur   <eldy@users.sourceforge.net>
/* Copyright (C) 2015       Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2016     Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2020-2025  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2024-2025  MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025-2026  William Mead      <william@m34d.com>
 *
 * 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/>.
 */
 
use Luracast\Restler\Restler;
use Luracast\Restler\Defaults;
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
 
 
class DolibarrApi
{
  protected $db;
 
  public $r;
 
  public function __construct($db, $cachedir = '', $refreshCache = false)
  {
    global $conf, $dolibarr_main_url_root;
 
    if (empty($cachedir)) {
      $cachedir = $conf->api->dir_temp;
    }
    Defaults::$cacheDirectory = $cachedir;
 
    $this->db = $db;
 
    $production_mode = getDolGlobalBool('API_PRODUCTION_MODE');
 
    if ($production_mode) {
      // Create the directory Defaults::$cacheDirectory if it does not exist. If dir does not exist, using production_mode generates an error 500.
      include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
      if (!dol_is_dir(Defaults::$cacheDirectory)) {
        dol_mkdir(Defaults::$cacheDirectory, DOL_DATA_ROOT);
      }
      if (getDolGlobalString('MAIN_API_DEBUG')) {
        dol_syslog("Debug API construct::cacheDirectory=".Defaults::$cacheDirectory, LOG_DEBUG, 0, '_api');
      }
    }
 
    $this->r = new Restler($production_mode, $refreshCache);
 
    $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
    $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
 
    $urlwithouturlrootautodetect = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim(DOL_MAIN_URL_ROOT));
    $urlwithrootautodetect = $urlwithouturlroot.DOL_URL_ROOT; // This is to use local domain autodetected by dolibarr from url
 
    $this->r->setBaseUrls($urlwithouturlroot, $urlwithouturlrootautodetect);
    $this->r->setAPIVersion(1);
    //$this->r->setSupportedFormats('json');
    //$this->r->setSupportedFormats('jsonFormat');
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _checkValForAPI($field, $value, $object)
  {
    // phpcs:enable
    if (!preg_match('/^[a-zA-Z0-9_]+$/', $field)) {
      throw new RestException(400, 'Parameter '.$field.' is not allowed in request');
    }
 
    if (!is_array($value)) {
      // Make protected values for forbidden properties
      if (in_array($field, array(
        'db', 'table_element', 'table_rowid', 'table_ref_field', 'table_element_line', 'element', 'fk_element', 'element_for_permission', 'class_element_line',
        'fields', 'TRIGGER_PREFIX', 'picto',
        'restrictiononfksoc', 'ismultientitymanaged', 'isextrafieldmanaged',
        'module', 'error', 'errorhidden', 'errors', 'warning', 'warnings', 'validateFieldsErrors',
        'oldcopy', 'oldref', 'newref', 'context',
        'actionmsg', 'actionmsg2', 'thirdparty', 'user',
        'tpl', 'extraparams',
        'childtables', 'childtablesoncascade'
      ))) {
        throw new RestException(400, 'Parameter '.$field.' is not allowed in request');
      }
      if (in_array($field, array('specimen'))) {
        // Allowed but not used
        dol_syslog('Debug API _checkValForAPI, found use of field specimen', LOG_DEBUG, 0, '_api');
      }
 
      // Sanitize the value using its type declared into ->fields of $object
      if (!empty($object->fields) && !empty($object->fields[$field]) && !empty($object->fields[$field]['type'])) {
        if (strpos($object->fields[$field]['type'], 'int') === 0 || strpos($object->fields[$field]['type'], 'double') === 0 || in_array($object->fields[$field]['type'], array('real', 'price', 'stock'))) {
          return sanitizeVal($value, 'int');
        }
        if ($object->fields[$field]['type'] == 'html') {
          return sanitizeVal($value, 'restricthtml');
        }
        if ($object->fields[$field]['type'] == 'select') {
          // Check values are in the list of possible 'options'
          return sanitizeVal($value, 'alphanohtml');
        }
        if ($object->fields[$field]['type'] == 'sellist' || $object->fields[$field]['type'] == 'checkbox') {
          return sanitizeVal($value, 'alphanohtml');
        }
        if ($object->fields[$field]['type'] == 'boolean' || $object->fields[$field]['type'] == 'radio') {
          return sanitizeVal($value, 'alphanohtml');
        }
        if ($object->fields[$field]['type'] == 'email') {
          return sanitizeVal($value, 'email');
        }
        if ($object->fields[$field]['type'] == 'password') {
          return sanitizeVal($value, 'password');
        }
        // Others will use 'alphanohtml'
      }
 
      // In case of a field with unknown type (legacy code), we use other tricks to guess a more accurate type
 
      // We try to use its name to have a chance to sanitize it
      if (preg_match('/^fk_/i', $field)) {
        // We accept only integer
        return sanitizeVal($value, 'int');
      }
      if (in_array($field, array('note', 'note_private', 'note_public', 'desc', 'description'))) {
        return sanitizeVal($value, 'restricthtml');
      }
 
      return sanitizeVal($value, 'alphanohtml');
    } else {  // Example when $field = 'extrafields' and $value = content of $object->array_options
      $newarrayvalue = array();
      foreach ($value as $tmpkey => $tmpvalue) {
        $newarrayvalue[$tmpkey] = $this->_checkValForAPI($tmpkey, $tmpvalue, $object);
      }
 
      return $newarrayvalue;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _checkValExtrafieldsForAPI($field, $value, $object)
  {
    // phpcs:enable
    global $extrafields;
 
    if (!preg_match('/^[a-zA-Z0-9_]+$/', $field)) {
      throw new RestException(400, 'Parameter '.$field.' is not allowed in request');
    }
 
    if (!is_array($value)) {
      // Sanitize the value using its type declared into ->fields of $object
      $typeOfExtraField = '';
      if (!empty($extrafields->attributes) && !empty($extrafields->attributes[$object->table_element])
        && !empty($extrafields->attributes[$object->table_element]['type'])
        && !empty($extrafields->attributes[$object->table_element]['type'][$field])) {
        $typeOfExtraField = $extrafields->attributes[$object->table_element]['type'][$field];
      }
 
      if ($typeOfExtraField) {
        if (strpos($typeOfExtraField, 'int') === 0 || strpos($typeOfExtraField, 'double') === 0 || in_array($typeOfExtraField, array('real', 'price', 'stock'))) {
          return sanitizeVal($value, 'int');
        }
        if ($typeOfExtraField == 'html') {
          return sanitizeVal($value, 'restricthtml');
        }
        if ($typeOfExtraField == 'select') {
          // TODO Check values are in the list of possible 'options'
          return sanitizeVal($value, 'alphanohtml');
        }
        if ($typeOfExtraField == 'sellist' || $typeOfExtraField == 'checkbox') {
          return sanitizeVal($value, 'alphanohtml');
        }
        if ($typeOfExtraField == 'boolean' || $typeOfExtraField == 'radio') {
          return sanitizeVal($value, 'alphanohtml');
        }
        if ($typeOfExtraField == 'email') {
          return sanitizeVal($value, 'email');
        }
        if ($typeOfExtraField == 'password') {
          return sanitizeVal($value, 'password');
        }
        // Others will use 'alphanohtml'
      }
 
      return sanitizeVal($value, 'alphanohtml');
    } else {  // Example when $field = 'extrafields' and $value = content of $object->array_options
      $newarrayvalue = array();
      foreach ($value as $tmpkey => $tmpvalue) {
        $newarrayvalue[$tmpkey] = $this->_checkValExtrafieldsForAPI($tmpkey, $tmpvalue, $object);
      }
 
      return $newarrayvalue;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _filterObjectProperties($object, $properties)
  {
    // phpcs:enable
    // If properties is empty, we return all properties
    if (empty($properties)) {
      return $object;
    }
 
    // Copy of exploded array for efficiency
    $arr_properties = explode(',', $properties);
    $magic_properties = array();
    $real_properties = get_object_vars($object);
 
    // Unsetting real properties may unset magic properties.
    // We keep a copy of the requested magic properties
    foreach ($arr_properties as $key) {
      if (!array_key_exists($key, $real_properties)) {
        // Not a real property,
        // check if $key is a magic property (we want to keep '$obj->$key')
        if (property_exists($object, $key) && isset($object->$key)) {
          $magic_properties[$key] = $object->$key;
        }
      }
    }
 
    // Filter real properties (may indirectly unset magic properties)
    foreach (get_object_vars($object) as $key => $value) {
      if (!in_array($key, $arr_properties)) {
        unset($object->$key);
      }
    }
 
    // Restore the magic properties
    foreach ($magic_properties as $key => $value) {
      $object->$key = $value;
    }
 
    return $object;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    // Remove $db object property for object
    unset($object->db);
    unset($object->isextrafieldmanaged);
    unset($object->ismultientitymanaged);
    unset($object->restrictiononfksoc);
    unset($object->table_rowid);
    unset($object->pass);
    unset($object->pass_indatabase);
    unset($object->pass_indatabase_crypted);
 
    // Remove linkedObjects. We should already have and keep only linkedObjectsIds that avoid huge responses
    unset($object->linkedObjects);
    //unset($object->lines[$i]->linked_objects);    // This is the array to create linked object during create
 
    unset($object->fields);
    unset($object->oldline);
 
    unset($object->error);
    unset($object->errors);
    unset($object->errorhidden);
    unset($object->warning);
    unset($object->warnings);
    unset($object->TRIGGER_PREFIX);
 
    unset($object->ref_previous);
    unset($object->ref_next);
    unset($object->imgWidth);
    unset($object->imgHeight);
    unset($object->barcode_type_code);
    unset($object->barcode_type_label);
 
    unset($object->mode_reglement);   // We use mode_reglement_id now
    unset($object->cond_reglement);   // We use cond_reglement_id now
    unset($object->note);       // We use note_public or note_private now
    unset($object->contact);      // We use contact_id now
    unset($object->thirdparty);     // We use thirdparty_id or fk_soc or socid now
 
    unset($object->project); // Should be fk_project
    unset($object->fk_projet); // Should be fk_project
    unset($object->author); // Should be fk_user_author
    unset($object->timespent_old_duration);
    unset($object->timespent_id);
    unset($object->timespent_duration);
    unset($object->timespent_date);
    unset($object->timespent_datehour);
    unset($object->timespent_withhour);
    unset($object->timespent_fk_user);
    unset($object->timespent_note);
    unset($object->fk_delivery_address);
    unset($object->fk_multicurrency);
    //unset($object->model_pdf);
    unset($object->sendtoid);
    unset($object->name_bis);
    unset($object->newref);
    unset($object->oldref);
    unset($object->alreadypaid);
    unset($object->openid);
    unset($object->fk_bank);
    unset($object->showphoto_on_popup);
    unset($object->nb);
    unset($object->nbphoto);
    unset($object->output);
    unset($object->tpl);
    //unset($object->libelle);
 
    unset($object->stats_propale);
    unset($object->stats_commande);
    unset($object->stats_contrat);
    unset($object->stats_facture);
    unset($object->stats_commande_fournisseur);
    unset($object->stats_reception);
    unset($object->stats_mrptoconsume);
    unset($object->stats_mrptoproduce);
 
    unset($object->fieldsforcombobox);
    unset($object->regeximgext);
 
    unset($object->skip_update_total);
    unset($object->context);
    unset($object->next_prev_filter);
 
    unset($object->region);
    unset($object->region_code);
    unset($object->country);
    unset($object->state);
    unset($object->state_code);
    unset($object->departement);
    unset($object->departement_code);
 
    unset($object->libelle_statut);
    unset($object->libelle_paiement);
    unset($object->labelStatus);
    unset($object->labelStatusShort);
 
    unset($object->actionmsg);
    unset($object->actionmsg2);
 
    unset($object->prefix_comm);
 
    if (!isset($object->table_element) || ! in_array($object->table_element, array('expensereport_det', 'ticket'))) {
      unset($object->comments);
    }
 
    unset($object->module);
    unset($object->origin_object);
    unset($object->origin);
    unset($object->element);
    unset($object->element_for_permission);
    unset($object->fk_element);
    unset($object->table_element);
    unset($object->table_element_line);
    unset($object->class_element_line);
    unset($object->picto);
    unset($object->linked_objects);
 
    // Remove the $oldcopy property because it is not supported by the JSON
    // encoder. The following error is generated when trying to serialize
    // it: "Error encoding/decoding JSON: Type is not supported"
    // Note: Event if this property was correctly handled by the JSON
    // encoder, it should be ignored because keeping it would let the API
    // have a very strange behavior: calling PUT and then GET on the same
    // resource would give different results:
    // PUT /objects/{id} -> returns object with oldcopy = previous version of the object
    // GET /objects/{id} -> returns object with oldcopy empty
    unset($object->oldcopy);
 
    // If object has lines, remove $db property
    if (isset($object->lines) && is_array($object->lines) && count($object->lines) > 0) {
      $nboflines = count($object->lines);
      for ($i = 0; $i < $nboflines; $i++) {
        $this->_cleanObjectDatas($object->lines[$i]);
 
        unset($object->lines[$i]->contact);
        unset($object->lines[$i]->contact_id);
        unset($object->lines[$i]->country);
        unset($object->lines[$i]->country_id);
        unset($object->lines[$i]->country_code);
        unset($object->lines[$i]->deposit_percent);
        unset($object->lines[$i]->mode_reglement_id);
        unset($object->lines[$i]->mode_reglement_code);
        unset($object->lines[$i]->mode_reglement);
        unset($object->lines[$i]->cond_reglement_id);
        unset($object->lines[$i]->cond_reglement_supplier_id);
        unset($object->lines[$i]->cond_reglement_code);
        unset($object->lines[$i]->cond_reglement);
        unset($object->lines[$i]->fk_delivery_address);
        unset($object->lines[$i]->fk_projet);
        unset($object->lines[$i]->fk_project);
 
        unset($object->lines[$i]->thirdparty);
        unset($object->lines[$i]->user);
        unset($object->lines[$i]->product);
 
        unset($object->lines[$i]->model_pdf);
        unset($object->lines[$i]->note_public);
        unset($object->lines[$i]->note_private);
        unset($object->lines[$i]->fk_incoterms);
        unset($object->lines[$i]->label_incoterms);
        unset($object->lines[$i]->location_incoterms);
        unset($object->lines[$i]->name);
        unset($object->lines[$i]->lastname);
        unset($object->lines[$i]->firstname);
        unset($object->lines[$i]->civility_id);
        unset($object->lines[$i]->fk_multicurrency);
        unset($object->lines[$i]->multicurrency_code);
        unset($object->lines[$i]->shipping_method_id);
      }
    }
 
    if (!empty($object->thirdparty) && is_object($object->thirdparty)) {
      $this->_cleanObjectDatas($object->thirdparty);
    }
 
    if (!empty($object->product) && is_object($object->product)) {
      $this->_cleanObjectDatas($object->product);
    }
 
    return $object;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected static function _checkAccessToResource($resource, $resource_id = 0, $dbtablename = '', $feature2 = '', $dbt_keyfield = 'fk_soc', $dbt_select = 'rowid', $parenttableforentity = '')
  {
    // phpcs:enable
    // Features/modules to check
    $featuresarray = array($resource);
    if (preg_match('/&/', $resource)) {
      $featuresarray = explode("&", $resource);
    } elseif (preg_match('/\|/', $resource)) {
      $featuresarray = explode("|", $resource);
    }
 
    // More subfeatures to check
    if (!empty($feature2)) {
      $feature2 = explode("|", $feature2);
    }
 
    return checkUserAccessToObject(DolibarrApiAccess::$user, $featuresarray, $resource_id, $dbtablename, $feature2, $dbt_keyfield, $dbt_select, $parenttableforentity);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _checkFilters($sqlfilters, &$error = '')
  {
    // phpcs:enable
    $firstandlastparenthesis = 0;
    return dolCheckFilters($sqlfilters, $error, $firstandlastparenthesis);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected static function _forge_criteria_callback($matches)
  {
    return dolForgeSQLCriteriaCallback($matches);
  }
}