forked from Wavyzz/dolibarr
328 lines
12 KiB
PHP
328 lines
12 KiB
PHP
<?php
|
|
/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
|
|
* Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
|
|
*
|
|
* 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\RestException;
|
|
use Luracast\Restler\Defaults;
|
|
use Luracast\Restler\Format\UploadFormat;
|
|
|
|
require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
|
|
|
|
/**
|
|
* Class for API REST v1
|
|
*/
|
|
class DolibarrApi
|
|
{
|
|
|
|
/**
|
|
* @var DoliDb $db Database object
|
|
*/
|
|
protected $db;
|
|
|
|
/**
|
|
* @var Restler $r Restler object
|
|
*/
|
|
public $r;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param DoliDb $db Database handler
|
|
* @param string $cachedir Cache dir
|
|
* @param boolean $refreshCache Update cache
|
|
*/
|
|
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 = ( empty($conf->global->API_PRODUCTION_MODE) ? false : true );
|
|
$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');
|
|
}
|
|
|
|
/**
|
|
* Executed method when API is called without parameter
|
|
*
|
|
* Display a short message an return a http code 200
|
|
*
|
|
* @return array
|
|
*/
|
|
/* Disabled, most APIs does not share same signature for method index
|
|
function index()
|
|
{
|
|
return array(
|
|
'success' => array(
|
|
'code' => 200,
|
|
'message' => __class__.' is up and running!'
|
|
)
|
|
);
|
|
}*/
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
|
|
/**
|
|
* Clean sensible object datas
|
|
*
|
|
* @param object $object Object to clean
|
|
* @return array Array of cleaned object properties
|
|
*/
|
|
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);
|
|
|
|
// Remove linkedObjects. We should already have linkedObjectIds that avoid huge responses
|
|
unset($object->linkedObjects);
|
|
|
|
unset($object->fields);
|
|
unset($object->oldline);
|
|
|
|
unset($object->error);
|
|
unset($object->errors);
|
|
|
|
unset($object->ref_previous);
|
|
unset($object->ref_next);
|
|
unset($object->ref_int);
|
|
|
|
unset($object->projet); // Should be fk_project
|
|
unset($object->project); // 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->statuts);
|
|
unset($object->statuts_short);
|
|
unset($object->statuts_logo);
|
|
unset($object->statuts_long);
|
|
unset($object->labelStatus);
|
|
unset($object->labelStatusShort);
|
|
|
|
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->element);
|
|
unset($object->fk_element);
|
|
unset($object->table_element);
|
|
unset($object->table_element_line);
|
|
unset($object->class_element_line);
|
|
unset($object->picto);
|
|
|
|
unset($object->fieldsforcombobox);
|
|
|
|
unset($object->skip_update_total);
|
|
unset($object->context);
|
|
unset($object->next_prev_filter);
|
|
|
|
unset($object->region);
|
|
unset($object->region_code);
|
|
|
|
unset($object->libelle_statut);
|
|
unset($object->libelle_paiement);
|
|
|
|
if ($object->table_element != 'ticket') {
|
|
unset($object->comments);
|
|
}
|
|
|
|
// 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]->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_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]->model_pdf);
|
|
unset($object->lines[$i]->modelpdf);
|
|
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);
|
|
}
|
|
|
|
return $object;
|
|
}
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
|
|
/**
|
|
* Check user access to a resource
|
|
*
|
|
* Check access by user to a given resource
|
|
*
|
|
* @param string $resource element to check
|
|
* @param int $resource_id Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
|
|
* @param string $dbtablename 'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
|
|
* @param string $feature2 Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
|
|
* @param string $dbt_keyfield Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
|
|
* @param string $dbt_select Field name for select if not rowid. Not used if objectid is null (optional)
|
|
* @return bool
|
|
* @throws RestException
|
|
*/
|
|
protected static function _checkAccessToResource($resource, $resource_id = 0, $dbtablename = '', $feature2 = '', $dbt_keyfield = 'fk_soc', $dbt_select = 'rowid')
|
|
{
|
|
// 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);
|
|
}
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
|
|
/**
|
|
* Return if a $sqlfilters parameter is valid
|
|
*
|
|
* @param string $sqlfilters sqlfilter string
|
|
* @return boolean True if valid, False if not valid
|
|
*/
|
|
protected function _checkFilters($sqlfilters)
|
|
{
|
|
// phpcs:enable
|
|
//$regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
|
|
//$tmp=preg_replace_all('/'.$regexstring.'/', '', $sqlfilters);
|
|
$tmp=$sqlfilters;
|
|
$ok=0;
|
|
$i=0; $nb=strlen($tmp);
|
|
$counter=0;
|
|
while ($i < $nb)
|
|
{
|
|
if ($tmp[$i]=='(') $counter++;
|
|
if ($tmp[$i]==')') $counter--;
|
|
if ($counter < 0)
|
|
{
|
|
$error="Bad sqlfilters=".$sqlfilters;
|
|
dol_syslog($error, LOG_WARNING);
|
|
return false;
|
|
}
|
|
$i++;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
|
|
/**
|
|
* Function to forge a SQL criteria
|
|
*
|
|
* @param array $matches Array of found string by regex search. Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.nature:is:NULL"
|
|
* @return string Forged criteria. Example: "t.field like 'abc%'"
|
|
*/
|
|
protected static function _forge_criteria_callback($matches)
|
|
{
|
|
// phpcs:enable
|
|
global $db;
|
|
|
|
//dol_syslog("Convert matches ".$matches[1]);
|
|
if (empty($matches[1])) return '';
|
|
$tmp=explode(':', $matches[1]);
|
|
if (count($tmp) < 3) return '';
|
|
|
|
$tmpescaped=$tmp[2];
|
|
$regbis = array();
|
|
if (preg_match('/^\'(.*)\'$/', $tmpescaped, $regbis))
|
|
{
|
|
$tmpescaped = "'".$db->escape($regbis[1])."'";
|
|
}
|
|
else
|
|
{
|
|
$tmpescaped = $db->escape($tmpescaped);
|
|
}
|
|
return $db->escape($tmp[0]).' '.strtoupper($db->escape($tmp[1]))." ".$tmpescaped;
|
|
}
|
|
}
|