api_documents.class.php

<?php
 
/* Copyright (C) 2016     Xebax Christy           <xebax@wanadoo.fr>
 * Copyright (C) 2016   Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2016     Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2023     Romain Neil             <contact@romain-neil.fr>
 * Copyright (C) 2024-2025  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2025-2026  MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025   William Mead      <william@m34d.com>
 * Copyright (C) 2025-2026  Charlene Benke      <charlene@patas-monkey.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\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/api/class/api.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
 
class Documents extends DolibarrApi
{
  public function __construct()
  {
    global $db;
    $this->db = $db;
  }
 
 
  public function index($modulepart, $original_file = '')
  {
    global $conf;
 
    if (empty($modulepart)) {
      throw new RestException(400, 'bad value for parameter modulepart');
    }
    if (empty($original_file)) {
      throw new RestException(400, 'bad value for parameter original_file');
    }
 
    // Normalize modulepart for project_task
    if ($modulepart == 'task' || $modulepart == 'project_task') {
      $modulepart = 'project_task';
    }
 
    //--- Finds and returns the document
    $entity = $conf->entity;
 
    // Special cases that need to use get_exdir to get real dir of object
    // If future, all object should use this to define path of documents.
    /*
    $tmpreldir = '';
    if ($modulepart == 'supplier_invoice') {
      $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
    }
 
    $relativefile = $tmpreldir.dol_sanitizeFileName($object->ref); */
    $relativefile = $original_file;
 
    $check_access = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'read');
    $accessallowed = $check_access['accessallowed'];
    $sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
    $original_file = $check_access['original_file'];
 
    if (preg_match('/\.\./', $original_file) || preg_match('/[<>|]/', $original_file)) {
      throw new RestException(403);
    }
    if (!$accessallowed) {
      throw new RestException(403);
    }
 
    if (DolibarrApiAccess::$user->socid > 0) {
      if ($sqlprotectagainstexternals) {
        $resql = $this->db->query($sqlprotectagainstexternals);
        if ($resql) {
          $num = $this->db->num_rows($resql);
          $i = 0;
          while ($i < $num) {
            $obj = $this->db->fetch_object($resql);
            if (DolibarrApiAccess::$user->socid != $obj->fk_soc) {
              throw new RestException(403, 'Not allowed to download documents with such a ref');
            }
            $i++;
          }
        }
      }
    }
 
    $filename = basename($original_file);
    $original_file_osencoded = dol_osencode($original_file); // New file name encoded in OS encoding charset
 
    if (!file_exists($original_file_osencoded)) {
      dol_syslog("Try to download not found file ".$original_file_osencoded, LOG_WARNING);
      throw new RestException(404, 'File not found');
    }
 
    $file_content = file_get_contents($original_file_osencoded);
    return array('filename' => $filename, 'content-type' => dol_mimetype($filename), 'filesize' => filesize($original_file), 'content' => base64_encode($file_content), 'encoding' => 'base64');
  }
 
 
  public function builddoc($modulepart, $original_file = '', $doctemplate = '', $langcode = '')
  {
    global $conf, $langs;
 
    if (empty($modulepart)) {
      throw new RestException(400, 'bad value for parameter modulepart');
    }
    if (empty($original_file)) {
      throw new RestException(400, 'bad value for parameter original_file');
    }
 
    $outputlangs = $langs;
    if ($langcode && $langs->defaultlang != $langcode) {
      $outputlangs = new Translate('', $conf);
      $outputlangs->setDefaultLang($langcode);
    }
 
    //--- Finds and returns the document
    $entity = $conf->entity;
 
    // Special cases that need to use get_exdir to get real dir of object
    // If future, all object should use this to define path of documents.
    /*
    $tmpreldir = '';
    if ($modulepart == 'supplier_invoice') {
      $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
    }
 
    $relativefile = $tmpreldir.dol_sanitizeFileName($object->ref); */
    $relativefile = $original_file;
 
    $check_access = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'write');
    $accessallowed              = $check_access['accessallowed'];
    $sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
    $original_file              = $check_access['original_file'];
 
    if (preg_match('/\.\./', $original_file) || preg_match('/[<>|]/', $original_file)) {
      throw new RestException(403);
    }
    if (!$accessallowed) {
      throw new RestException(403);
    }
 
    if (DolibarrApiAccess::$user->socid > 0) {
      if ($sqlprotectagainstexternals) {
        $resql = $this->db->query($sqlprotectagainstexternals);
        if ($resql) {
          $num = $this->db->num_rows($resql);
          $i = 0;
          while ($i < $num) {
            $obj = $this->db->fetch_object($resql);
            if (DolibarrApiAccess::$user->socid != $obj->fk_soc) {
              throw new RestException(403, 'Not allowed to download documents with such a ref');
            }
            $i++;
          }
        }
      }
    }
 
    // --- Generates the document
    $hidedetails = !getDolGlobalString('MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS') ? 0 : 1;
    $hidedesc = !getDolGlobalString('MAIN_GENERATE_DOCUMENTS_HIDE_DESC') ? 0 : 1;
    $hideref = !getDolGlobalString('MAIN_GENERATE_DOCUMENTS_HIDE_REF') ? 0 : 1;
 
    $templateused = '';
 
    if ($modulepart == 'facture' || $modulepart == 'invoice') {
      require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
      $tmpobject = new Facture($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
      if (!$result) {
        throw new RestException(404, 'Invoice not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'facture_fournisseur' || $modulepart == 'invoice_supplier') {
      require_once DOL_DOCUMENT_ROOT . '/fourn/class/fournisseur.facture.class.php';
      $tmpobject = new FactureFournisseur($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
      if (!$result) {
        throw new RestException(404, 'Supplier invoice not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
      if ($result < 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'commande' || $modulepart == 'order') {
      require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
      $tmpobject = new Commande($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
      if (!$result) {
        throw new RestException(404, 'Order not found');
      }
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'propal' || $modulepart == 'proposal') {
      require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php';
      $tmpobject = new Propal($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
      if (!$result) {
        throw new RestException(404, 'Proposal not found');
      }
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'contrat' || $modulepart == 'contract') {
      require_once DOL_DOCUMENT_ROOT . '/contrat/class/contrat.class.php';
 
      $tmpobject = new Contrat($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'Contract not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'expedition' || $modulepart == 'shipment') {
      require_once DOL_DOCUMENT_ROOT . '/expedition/class/expedition.class.php';
 
      $tmpobject = new Expedition($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'Shipment not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'mrp') {
      require_once DOL_DOCUMENT_ROOT . '/mrp/class/mo.class.php';
 
      $tmpobject = new Mo($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'MO not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'expensereport') {
      require_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php';
 
      $tmpobject = new ExpenseReport($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'Expense report not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'holiday') {
      require_once DOL_DOCUMENT_ROOT.'/holiday/class/holiday.class.php';
 
      $tmpobject = new Holiday($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'Holiday not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'product') {
      require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
 
      $tmpobject = new Product($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'Product not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'stock' || $modulepart == 'entrepot') {
      require_once DOL_DOCUMENT_ROOT . '/product/stock/class/entrepot.class.php';
 
      $tmpobject = new Entrepot($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'Warehouse not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } elseif ($modulepart == 'fichinter' || $modulepart == 'intervention') {
      require_once DOL_DOCUMENT_ROOT . '/fichinter/class/fichinter.class.php';
 
      $tmpobject = new Fichinter($this->db);
      $result = $tmpobject->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
 
      if (!$result) {
        throw new RestException(404, 'Intervention not found');
      }
 
      $templateused = $doctemplate ? $doctemplate : $tmpobject->model_pdf;
      $result = $tmpobject->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
 
      if ($result <= 0) {
        throw new RestException(500, 'Error generating document');
      }
    } else {
      throw new RestException(403, 'Generation not available for this modulepart');
    }
 
    $filename = basename($original_file);
    $original_file_osencoded = dol_osencode($original_file); // New file name encoded in OS encoding charset
 
    if (!file_exists($original_file_osencoded)) {
      throw new RestException(404, 'File not found');
    }
 
    $file_content = file_get_contents($original_file_osencoded);
    return array('filename' => $filename, 'content-type' => dol_mimetype($filename), 'filesize' => filesize($original_file), 'content' => base64_encode($file_content), 'langcode' => $outputlangs->defaultlang, 'template' => $templateused, 'encoding' => 'base64');
  }
 
  public function getDocumentsListByElement($modulepart, $id = 0, $ref = '', $sortfield = '', $sortorder = '', $limit = 100, $page = 0, $content_type = '', $pagination_data = false)
  {
    if (empty($modulepart)) {
      throw new RestException(400, 'bad value for parameter modulepart');
    }
 
    if (empty($id) && empty($ref)) {
      throw new RestException(400, 'bad value for parameter id or ref');
    }
 
    $id = (empty($id) ? 0 : $id);
 
    if ($modulepart == 'facture_fournisseur') {
      $modulepart = 'supplier_invoice'; // Alias unknown by fetchObjectByElement()
    }
 
    // Define $object
    $object = fetchObjectByElement($id, $modulepart, $ref);   // Note that we don't mind id and ref, we want to get a valid instantiated $object but not necessarily initialized
    if (!is_object($object)) {
      throw new RestException(404, 'Module for modulepart = '.$modulepart." is not enabled (or not yet supported by API");
    }
 
    // Define $upload_dir to scan
    if ($object->element == 'invoice_supplier' && $object->id > 0) {
      // Supplier invoices are stored under a hashed subdir, as in the other methods of this file
      $upload_dir = getMultidirOutput($object).'/'.get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier').dol_sanitizeFileName($object->ref);
    } else {
      $upload_dir = (string) getMultidirOutput($object, '', 1);
    }
 
    // Check object-level permissions
    $ok = checkUserAccessToObject(DolibarrApiAccess::$user, array($object->element), $object, $object->table_element, '');
    if (empty($ok)) {
      throw new RestException(403, 'Access not allowed to this object (refused by checkUserAccessToObject)');
    }
 
    // Check permission on module
    if ($modulepart == 'societe' || $modulepart == 'thirdparty') {
      if (!DolibarrApiAccess::$user->hasRight('societe', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'user') {
      // Can get doc if has permission to read all user or if it is user itself
      if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && DolibarrApiAccess::$user->id != $id) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'adherent' || $modulepart == 'member') {
      if (!DolibarrApiAccess::$user->hasRight('adherent', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'propal' || $modulepart == 'proposal') {
      if (!DolibarrApiAccess::$user->hasRight('propal', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'supplier_proposal') {
      if (!DolibarrApiAccess::$user->hasRight('supplier_proposal', 'read')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'commande' || $modulepart == 'order') {
      if (!DolibarrApiAccess::$user->hasRight('commande', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'commande_fournisseur' || $modulepart == 'supplier_order') {
      $modulepart = 'supplier_order';
      if (!DolibarrApiAccess::$user->hasRight('fournisseur', 'commande', 'lire') && !DolibarrApiAccess::$user->hasRight('supplier_order', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'shipment' || $modulepart == 'expedition') {
      if (!DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'facture' || $modulepart == 'invoice') {
      if (!DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'facture_fournisseur' || $modulepart == 'supplier_invoice') {
      $modulepart = 'supplier_invoice';
      if (!DolibarrApiAccess::$user->hasRight('fournisseur', 'facture', 'lire') && !DolibarrApiAccess::$user->hasRight('supplier_invoice', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'produit' || $modulepart == 'product' || $modulepart == 'service') {
      if (!DolibarrApiAccess::$user->hasRight('produit', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'agenda' || $modulepart == 'action' || $modulepart == 'event' || $modulepart == 'actioncomm') {
      if (!DolibarrApiAccess::$user->hasRight('agenda', 'myactions', 'read') && !DolibarrApiAccess::$user->hasRight('agenda', 'allactions', 'read')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'expensereport') {
      if (!DolibarrApiAccess::$user->hasRight('expensereport', 'read')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'holiday') {
      if (!DolibarrApiAccess::$user->hasRight('holiday', 'read')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'ticket') {
      if (!DolibarrApiAccess::$user->hasRight('ticket', 'read')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'knowledgemanagement') {
      if (!DolibarrApiAccess::$user->hasRight('knowledgemanagement', 'knowledgerecord', 'read')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'categorie' || $modulepart == 'category') {
      if (!DolibarrApiAccess::$user->hasRight('categorie', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'ecm') {
      throw new RestException(500, 'Modulepart Ecm not implemented yet.');
      // if (!DolibarrApiAccess::$user->hasRight('ecm', 'read')) {
      //  throw new RestException(403);
      // }
    } elseif ($modulepart == 'contrat' || $modulepart == 'contract') {
      $modulepart = 'contrat';
      if (!DolibarrApiAccess::$user->hasRight('contrat', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'intervention' || $modulepart == 'ficheinter') {
      $modulepart = 'ficheinter';
      if (!DolibarrApiAccess::$user->hasRight('ficheinter', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'projet' || $modulepart == 'project') {
      $modulepart = 'project';
      if (!DolibarrApiAccess::$user->hasRight('projet', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'task' || $modulepart == 'project_task') {
      $modulepart = 'project_task';
      if (!DolibarrApiAccess::$user->hasRight('projet', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'mrp') {
      $modulepart = 'mrp';
      if (!DolibarrApiAccess::$user->hasRight('mrp', 'read')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'contact' || $modulepart == 'socpeople') {
      $modulepart = 'contact';
      if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'lire')) {
        throw new RestException(403);
      }
    } elseif ($modulepart == 'stock') {
      if (!DolibarrApiAccess::$user->hasRight('stock', 'lire')) {
        throw new RestException(403);
      }
    } else {
      throw new RestException(500, 'Modulepart '.$modulepart.' not implemented yet.');
    }
 
    // Scan files into directory
    $recursive = 0;
    $type = 'files';
 
    $objectType = $modulepart;
    if (! empty($object->id) && ! empty($object->table_element)) {
      $objectType = $object->table_element;
    }
 
    $filearray = dol_dir_list($upload_dir, $type, $recursive, '', '(\.meta|_preview.*\.png)$', $sortfield, (strtolower($sortorder) == 'desc' ? SORT_DESC : SORT_ASC), 1);
 
    $countarray = is_array($filearray) ? count($filearray) : 0;
 
    if (empty($filearray)) {
      throw new RestException(404, 'Search for modulepart '.$modulepart.' with Id '.$id.(!empty($ref) ? ' or Ref '.$ref : '').' does not return any document.');
    } else {
      $filearray = array_slice($filearray, $limit * $page, $limit);
      if (($object->id) > 0 && !empty($modulepart)) {
        require_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
        $ecmfile = new EcmFiles($this->db);
        $result = $ecmfile->fetchAll('', '', 0, 0, array('t.src_object_type' => $objectType, 't.src_object_id' => $object->id));
        if ($result < 0) {
          throw new RestException(503, 'Error when retrieve ecm list : '.$this->db->lasterror());
        } elseif (is_array($ecmfile->lines) && count($ecmfile->lines) > 0) {
          foreach ($filearray as &$fileitem) {
            foreach ($ecmfile->lines as $line) {
              if ($fileitem['name'] == $line->filename) {
                // Next line converts EcmFilesLine properties to array
                //$fileitem = array_merge($fileitem, (array) $line);
                $fileitem['ref'] = $line->ref;
                $fileitem['label'] = $line->label;
                $fileitem['filepath'] = $line->filepath;
                $fileitem['filename'] = $line->filename;
                $fileitem['fullpath_orig'] = $line->fullpath_orig;
                $fileitem['position'] = $line->position;
                $fileitem['gen_or_uploaded'] = $line->gen_or_uploaded;
                $fileitem['description'] = $line->desc;
                $fileitem['keywords'] = $line->keywords;
                $fileitem['cover'] = $line->cover;
                $fileitem['share'] = $line->share;
                $fileitem['date_c'] = $line->date_c;
                $fileitem['agenda_id'] = $line->agenda_id;
                $fileitem['fk_user_c'] = $line->fk_user_c;
                $fileitem['fk_user_m'] = $line->fk_user_m;
                $fileitem['note_private'] = $line->note_private;
                $fileitem['note_public'] = $line->note_public;
              }
            }
            if (isset($fileitem['relativename'])) {
              $fileitem['content-type'] = dol_mimetype((string) $fileitem['relativename']);
            }
          }
 
          // Select only files that match the requested $content_type, if provided
          $arraycontenttype = explode(",", $content_type);
          if (!empty($content_type)) {
            $filearray = array_filter(
              $filearray,
              static function ($fileitem) use (&$arraycontenttype) {
                return in_array(($fileitem['content-type'] ?: 'UNKNOWN'), $arraycontenttype);
              }
            );
          }
        }
      }
    }
 
    // Clean result from fullname
    foreach ($filearray as $tmpkey => $tmpval) {
      unset($filearray[$tmpkey]['path']);
      unset($filearray[$tmpkey]['fullname']);
    }
 
    //if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
    if ($pagination_data) {
      $filearray = [
        'data' => $filearray,
        'pagination' => [
          'total' => (int) $countarray,
          'page' => $page, // count starts from 0
          'page_count' => (int) ceil((int) $countarray / $limit),
          'limit' => $limit
        ]
      ];
    }
 
    return $filearray;
  }
 
 
  /*
  public function get($id) {
    return array('note'=>'xxx');
  }*/
 
 
  public function post($filename, $modulepart, $ref = '', $subdir = '', $filecontent = '', $fileencoding = '', $overwriteifexists = 0, $createdirifnotexists = 1, $position = 0, $cover = '', $array_options = [], $generateThumbs = 0, $share = 0)
  {
    global $conf;
 
    $modulepartorig = $modulepart;
 
    if (empty($modulepart)) {
      throw new RestException(400, 'Modulepart not provided.');
    }
 
    $newfilecontent = '';
    if (empty($fileencoding)) {
      $newfilecontent = $filecontent;
    }
    if ($fileencoding == 'base64') {
      $newfilecontent = base64_decode($filecontent);
    }
 
    $original_file = dol_sanitizeFileName($filename);
    $relativefile = 'UNSET';
 
    // Define $uploadir
    $object = null;
    $entity = DolibarrApiAccess::$user->entity;
    if (empty($entity)) {
      $entity = 1;
    }
 
    if ($ref) {
      $tmpreldir = '';
      $fetchbyid = false;
 
      if ($modulepart == 'facture' || $modulepart == 'invoice') {
        $modulepart = 'facture';
 
        require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
        $object = new Facture($this->db);
      } elseif ($modulepart == 'facture_fournisseur' || $modulepart == 'supplier_invoice') {
        $modulepart = 'supplier_invoice';
 
        require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.facture.class.php';
        $object = new FactureFournisseur($this->db);
      } elseif ($modulepart == 'commande' || $modulepart == 'order') {
        $modulepart = 'commande';
 
        require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
        $object = new Commande($this->db);
      } elseif ($modulepart == 'commande_fournisseur' || $modulepart == 'supplier_order') {
        $modulepart = 'supplier_order';
 
        require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php';
        $object = new CommandeFournisseur($this->db);
      } elseif ($modulepart == 'projet' || $modulepart == 'project') {
        require_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php';
        $object = new Project($this->db);
      } elseif ($modulepart == 'task' || $modulepart == 'project_task') {
        $modulepart = 'project_task';
 
        require_once DOL_DOCUMENT_ROOT.'/projet/class/task.class.php';
        $object = new Task($this->db);
 
        $task_result = $object->fetch(0, $ref);
 
        // Fetching the tasks project is required because its out_dir might be a sub-directory of the project
        if ($task_result > 0) {
          $project_result = $object->fetchProject();
 
          if ($project_result >= 0) {
            $tmpreldir = dol_sanitizeFileName((string) $object->project->ref).'/';
          }
        } else {
          throw new RestException(500, 'Error while fetching Task '.$ref);
        }
      } elseif ($modulepart == 'product' || $modulepart == 'produit' || $modulepart == 'service' || $modulepart == 'produit|service') {
        require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
        $object = new Product($this->db);
      } elseif ($modulepart == 'expensereport') {
        require_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php';
        $object = new ExpenseReport($this->db);
      } elseif ($modulepart == 'holiday') {
        require_once DOL_DOCUMENT_ROOT.'/holiday/class/holiday.class.php';
        $object = new Holiday($this->db);
      } elseif ($modulepart == 'ficheinter' || $modulepart == 'intervention') {
        require_once DOL_DOCUMENT_ROOT.'/fichinter/class/fichinter.class.php';
        $object = new Fichinter($this->db);
      } elseif ($modulepart == 'shipment' || $modulepart == 'expedition') {
        require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
        $object = new Expedition($this->db);
      } elseif ($modulepart == 'adherent' || $modulepart == 'member') {
        $modulepart = 'adherent';
        require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
        $object = new Adherent($this->db);
      } elseif ($modulepart == 'proposal' || $modulepart == 'propal' || $modulepart == 'propale') {
        $modulepart = 'propale';
        require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php';
        $object = new Propal($this->db);
      } elseif ($modulepart == 'agenda' || $modulepart == 'action' || $modulepart == 'event') {
        $modulepart = 'agenda';
        require_once DOL_DOCUMENT_ROOT . '/comm/action/class/actioncomm.class.php';
        $object = new ActionComm($this->db);
      } elseif ($modulepart == 'contact' || $modulepart == 'socpeople') {
        $modulepart = 'contact';
        require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
        $object = new Contact($this->db);
        $fetchbyid = true;
      } elseif ($modulepart == 'societe' || $modulepart == 'company') {
        $modulepart = 'societe';
        require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
        $object = new Societe($this->db);
        $fetchbyid = true;
      } elseif ($modulepart == 'knowledgemanagement') {
        $modulepart = 'knowledgemanagement';
        require_once DOL_DOCUMENT_ROOT.'/knowledgemanagement/class/knowledgerecord.class.php';
        $object = new KnowledgeRecord($this->db);
        $fetchbyid = true;
      } elseif ($modulepart == 'ticket') {
        $modulepart = 'ticket';
        require_once DOL_DOCUMENT_ROOT.'/ticket/class/ticket.class.php';
        $object = new Ticket($this->db);
        $fetchbyid = true;
      } elseif ($modulepart == 'contrat' || $modulepart == 'contract') {
        $modulepart = 'contrat';
        require_once DOL_DOCUMENT_ROOT . '/contrat/class/contrat.class.php';
        $object = new Contrat($this->db);
      } elseif ($modulepart == 'mrp') {
        $modulepart = 'mrp';
        require_once DOL_DOCUMENT_ROOT . '/mrp/class/mo.class.php';
        $object = new Mo($this->db);
      } elseif ($modulepart == 'stock') {
        $modulepart = 'stock';
        require_once DOL_DOCUMENT_ROOT . '/product/stock/class/entrepot.class.php';
        $object = new Entrepot($this->db);
      } elseif ($modulepart == 'ecm') {
        throw new RestException(500, 'Using a non empty "ref" is not compatible with using modulepart = '.$modulepart);
      } else {
        // TODO Implement additional moduleparts
        throw new RestException(500, 'Modulepart '.$modulepart.' not implemented yet.');
      }
 
      // at this step $object is always an object
      if ($fetchbyid) {
        // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
        $result = $object->fetch((int) $ref);
      } else {
        $result = $object->fetch(0, $ref);
      }
 
      if ($result == 0) {
        throw new RestException(404, "Object with ref '".$ref."' was not found.");
      } elseif ($result < 0) {
        throw new RestException(500, 'Error while fetching object: '.$object->errorsToString());
      }
 
      if (!($object->id > 0)) {
        throw new RestException(404, 'The object '.$modulepart." with ref '".$ref."' was not found.");
      }
 
      // Special cases that need to use get_exdir to get real dir of object
      // In future, all object should use this to define path of documents.
      if ($modulepart == 'supplier_invoice') {
        $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
      }
 
      // Test on permissions
      //if ($modulepart != 'ecm') { // Here $modulepart is always != 'ecm'
      if ($modulepart == 'societe') {
        $relativefile = $tmpreldir.dol_sanitizeFileName((string) $object->id);
      } else {
        $relativefile = $tmpreldir.dol_sanitizeFileName((string) $object->ref);
      }
      $tmp = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, $ref, 'write');
      if (empty($tmp['accessallowed'])) {
        throw new RestException(403, 'Access not allowed to upload file into this directory');
      }
      $upload_dir = $tmp['original_file']; // No dirname here, tmp['original_file'] is already the dir because dol_check_secure_access_document was called with param original_file that is only the dir
      /*} else {
        if (!DolibarrApiAccess::$user->hasRight('ecm', 'upload')) {
          throw new RestException(403, 'Missing permission to upload files in ECM module');
        }
        $upload_dir = $conf->medias->multidir_output[$conf->entity];
      }*/
 
      if (empty($upload_dir) || $upload_dir == '/') {
        throw new RestException(500, 'This value of modulepart ('.$modulepart.') does not support yet usage of ref. Check modulepart parameter or try to use subdir parameter instead of ref.');
      }
    } else {
      if ($modulepart == 'invoice') {
        $modulepart = 'facture';
      }
      if ($modulepart == 'member') {
        $modulepart = 'adherent';
      }
 
      // Test on permissions
      if ($modulepart != 'ecm') {
        $relativefile = $subdir;
        $tmp = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'write');
        if (empty($tmp['accessallowed'])) {
          throw new RestException(403, 'Access not allowed to upload file into this directory');
        }
        $upload_dir = $tmp['original_file']; // No dirname here, tmp['original_file'] is already the dir because dol_check_secure_access_document was called with param original_file that is only the dir
      } else {
        if (!DolibarrApiAccess::$user->hasRight('ecm', 'upload')) {
          throw new RestException(403, 'Missing permission to upload files in ECM module');
        }
        $upload_dir = $conf->medias->multidir_output[$conf->entity];
      }
 
      if (empty($upload_dir) || $upload_dir == '/') {
        if (!empty($tmp['error'])) {
          throw new RestException(403, 'Error returned by dol_check_secure_access_document: '.$tmp['error']);
        } else {
          throw new RestException(400, 'This value of modulepart ('.$modulepart.') is not allowed with this value of subdir ('.$relativefile.')');
        }
      }
    }
    // $original_file here is still value of filename without any dir.
 
    $upload_dir = dol_sanitizePathName($upload_dir);
 
    if (!empty($createdirifnotexists)) {
      if (dol_mkdir($upload_dir) < 0) { // needed by products
        throw new RestException(500, 'Error while trying to create directory '.$upload_dir);
      }
    }
 
    $destfile = $upload_dir.'/'.$original_file;
    $destfiletmp = DOL_DATA_ROOT.'/admin/temp/'.$original_file;
    dol_delete_file($destfiletmp);
    //var_dump($original_file);exit;
 
    if (!dol_is_dir(dirname($destfile))) {
      throw new RestException(400, 'Directory does not exists : '.dirname($destfile));
    }
 
    if (!$overwriteifexists && dol_is_file($destfile)) {
      throw new RestException(400, "File with name '".$original_file."' already exists.");
    }
 
    // in case temporary directory admin/temp doesn't exist
    if (!dol_is_dir(dirname($destfiletmp))) {
      dol_mkdir(dirname($destfiletmp));
    }
 
    $fhandle = @fopen($destfiletmp, 'w');
    if ($fhandle) {
      $nbofbyteswrote = fwrite($fhandle, $newfilecontent);
      fclose($fhandle);
      dolChmod($destfiletmp);
    } else {
      throw new RestException(500, "Failed to open file '".$destfiletmp."' for write");
    }
 
    $disablevirusscan = 0;
    $src_file = $destfiletmp;
    $dest_file = $destfile;
 
    // Security:
    // If we need to make a virus scan
    if (empty($disablevirusscan) && file_exists($src_file)) {
      $checkvirusarray = dolCheckVirus($src_file, $dest_file);
      if (count($checkvirusarray)) {
        dol_syslog('Files.lib::dol_move_uploaded_file File "'.$src_file.'" (target name "'.$dest_file.'") KO with antivirus: errors='.implode(',', $checkvirusarray), LOG_WARNING);
        throw new RestException(500, 'ErrorFileIsInfectedWithAVirus: '.implode(',', $checkvirusarray));
      }
    }
 
    // Security:
    // Disallow file with some extensions. We rename them.
    // Because if we put the documents directory into a directory inside web root (very bad), this allows to execute on demand arbitrary code.
    if (isAFileWithExecutableContent($dest_file) && !getDolGlobalString('MAIN_DOCUMENT_IS_OUTSIDE_WEBROOT_SO_NOEXE_NOT_REQUIRED')) {
      // $upload_dir ends with a slash, so be must be sure the medias dir to compare to ends with slash too.
      $publicmediasdirwithslash = $conf->medias->multidir_output[$conf->entity];
      if (!preg_match('/\/$/', $publicmediasdirwithslash)) {
        $publicmediasdirwithslash .= '/';
      }
 
      if (strpos($upload_dir, $publicmediasdirwithslash) !== 0 || !getDolGlobalInt("MAIN_DOCUMENT_DISABLE_NOEXE_IN_MEDIAS_DIR")) {  // We never add .noexe on files into media directory
        $dest_file .= '.noexe';
      }
    }
 
    // Security:
    // We refuse cache files/dirs, upload using .. and pipes into filenames.
    if (preg_match('/^\./', basename($src_file)) || preg_match('/\.\./', $src_file) || preg_match('/[<>|]/', $src_file)) {
      dol_syslog("Refused to deliver file ".$src_file, LOG_WARNING);
      throw new RestException(500, "Refused to deliver file ".$src_file);
    }
 
    // Security:
    // We refuse cache files/dirs, upload using .. and pipes into filenames.
    if (preg_match('/^\./', basename($dest_file)) || preg_match('/\.\./', $dest_file) || preg_match('/[<>|]/', $dest_file)) {
      dol_syslog("Refused to deliver file ".$dest_file, LOG_WARNING);
      throw new RestException(500, "Refused to deliver file ".$dest_file);
    }
 
    $moreinfo = array('note_private' => 'File uploaded using API /documents from IP '.getUserRemoteIP());
    // $object may be null
    if (is_object($object) && $object->id > 0) {
      $moreinfo['src_object_type'] = $object->table_element;
      $moreinfo['src_object_id'] = $object->id;
    }
    if (!empty($array_options)) {
      $moreinfo = array_merge($moreinfo, ["array_options" => $array_options]);
    }
    if (!empty($position)) {
      $moreinfo = array_merge($moreinfo, ["position" => $position]);
    }
    if (!empty($cover)) {
      $moreinfo = array_merge($moreinfo, ["cover" => $cover]);
    }
    if (!empty($share)) {
      require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
      $moreinfo = array_merge($moreinfo, ["share" => getRandomPassword(true)]);
    }
    $moreinfo['gen_or_uploaded'] = 'api';
 
    // Move the temporary file at its final emplacement
    $result = dol_move($destfiletmp, $dest_file, '0', $overwriteifexists, 1, 1, $moreinfo);
    if (!$result) {
      throw new RestException(500, "Failed to move file into '".$dest_file."'");
    }
 
    if (is_object($object) && $generateThumbs) {
      require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
      require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';  // image_format_supported() is defined here
      if (image_format_supported($dest_file)) {
        $object->addThumbs($dest_file);
      }
    }
 
    return dol_basename($destfile);
  }
 
  public function delete($modulepart, $original_file)
  {
    global $conf;
 
    if (empty($modulepart)) {
      throw new RestException(400, 'bad value for parameter modulepart');
    }
    if (empty($original_file)) {
      throw new RestException(400, 'bad value for parameter original_file');
    }
 
    // Normalize modulepart for project_task
    if ($modulepart == 'task') {
      $modulepart = 'project_task';
    }
 
    //--- Finds and returns the document
    $entity = $conf->entity;
 
    // Special cases that need to use get_exdir to get real dir of object
    // If future, all object should use this to define path of documents.
    /*
    $tmpreldir = '';
    if ($modulepart == 'supplier_invoice') {
      $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
    }
 
    $relativefile = $tmpreldir.dol_sanitizeFileName($object->ref); */
    $relativefile = $original_file;
 
    $check_access = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'write');
    $accessallowed = $check_access['accessallowed'];
    $sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
    $original_file = $check_access['original_file'];
 
    if (preg_match('/\.\./', $original_file) || preg_match('/[<>|]/', $original_file)) {
      throw new RestException(403);
    }
    if (!$accessallowed) {
      throw new RestException(403);
    }
 
    if (DolibarrApiAccess::$user->socid > 0) {
      if ($sqlprotectagainstexternals) {
        $resql = $this->db->query($sqlprotectagainstexternals);
        if ($resql) {
          $num = $this->db->num_rows($resql);
          $i = 0;
          while ($i < $num) {
            $obj = $this->db->fetch_object($resql);
            if (DolibarrApiAccess::$user->socid != $obj->fk_soc) {
              throw new RestException(403, 'Not allowed to download documents with such a ref');
            }
            $i++;
          }
        }
      }
    }
 
    $filename = basename($original_file);
    $original_file_osencoded = dol_osencode($original_file); // New file name encoded in OS encoding charset
 
    if (!file_exists($original_file_osencoded)) {
      dol_syslog("Try to download not found file ".$original_file_osencoded, LOG_WARNING);
      throw new RestException(404, 'File not found');
    }
 
    if (@unlink($original_file_osencoded)) {
      return array(
        'success' => array(
          'code' => 200,
          'message' => 'Document deleted'
        )
      );
    }
 
    throw new RestException(403);
  }
}