forked from Wavyzz/dolibarr
801 lines
27 KiB
PHP
801 lines
27 KiB
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>
|
|
*
|
|
* 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;
|
|
use Luracast\Restler\Format\UploadFormat;
|
|
|
|
|
|
require_once DOL_DOCUMENT_ROOT.'/main.inc.php';
|
|
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
|
|
|
|
/**
|
|
* API class for receive files
|
|
*
|
|
* @access protected
|
|
* @class Documents {@requires user,external}
|
|
*/
|
|
class Documents extends DolibarrApi
|
|
{
|
|
|
|
/**
|
|
* @var array $DOCUMENT_FIELDS Mandatory fields, checked when create and update object
|
|
*/
|
|
static $DOCUMENT_FIELDS = array(
|
|
'modulepart'
|
|
);
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct()
|
|
{
|
|
global $db;
|
|
$this->db = $db;
|
|
}
|
|
|
|
|
|
/**
|
|
* Download a document.
|
|
*
|
|
* Note that, this API is similar to using the wrapper link "documents.php" to download a file (used for
|
|
* internal HTML links of documents into application), but with no need to have a session cookie (the token is used instead).
|
|
*
|
|
* @param string $modulepart Name of module or area concerned by file download ('facture', ...)
|
|
* @param string $original_file Relative path with filename, relative to modulepart (for example: IN201701-999/IN201701-999.pdf)
|
|
* @return array List of documents
|
|
*
|
|
* @throws RestException 400
|
|
* @throws RestException 401
|
|
* @throws RestException 404
|
|
*
|
|
* @url GET /download
|
|
*/
|
|
public function index($modulepart, $original_file = '')
|
|
{
|
|
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');
|
|
}
|
|
|
|
//--- 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(401);
|
|
}
|
|
if (!$accessallowed) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$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');
|
|
}
|
|
|
|
|
|
/**
|
|
* Build a document.
|
|
*
|
|
* Test sample 1: { "module_part": "invoice", "original_file": "FA1701-001/FA1701-001.pdf", "doctemplate": "crabe", "langcode": "fr_FR" }.
|
|
*
|
|
* @param string $modulepart Name of module or area concerned by file download ('invoice', 'order', ...).
|
|
* @param string $original_file Relative path with filename, relative to modulepart (for example: IN201701-999/IN201701-999.pdf).
|
|
* @param string $doctemplate Set here the doc template to use for document generation (If not set, use the default template).
|
|
* @param string $langcode Language code like 'en_US', 'fr_FR', 'es_ES', ... (If not set, use the default language).
|
|
* @return array List of documents
|
|
*
|
|
* @throws RestException 500
|
|
* @throws RestException 501
|
|
* @throws RestException 400
|
|
* @throws RestException 401
|
|
* @throws RestException 404
|
|
*
|
|
* @url PUT /builddoc
|
|
*/
|
|
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(401);
|
|
}
|
|
if (!$accessallowed) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
// --- Generates the document
|
|
$hidedetails = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS) ? 0 : 1;
|
|
$hidedesc = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DESC) ? 0 : 1;
|
|
$hideref = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_REF) ? 0 : 1;
|
|
|
|
$templateused = '';
|
|
|
|
if ($modulepart == 'facture' || $modulepart == 'invoice')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
|
|
$this->invoice = new Facture($this->db);
|
|
$result = $this->invoice->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
|
|
if (!$result) {
|
|
throw new RestException(404, 'Invoice not found');
|
|
}
|
|
|
|
$templateused = $doctemplate ? $doctemplate : $this->invoice->modelpdf;
|
|
$result = $this->invoice->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';
|
|
$this->order = new Commande($this->db);
|
|
$result = $this->order->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
|
|
if (!$result) {
|
|
throw new RestException(404, 'Order not found');
|
|
}
|
|
$templateused = $doctemplate ? $doctemplate : $this->order->modelpdf;
|
|
$result = $this->order->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';
|
|
$this->propal = new Propal($this->db);
|
|
$result = $this->propal->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
|
|
if (!$result) {
|
|
throw new RestException(404, 'Proposal not found');
|
|
}
|
|
$templateused = $doctemplate ? $doctemplate : $this->propal->modelpdf;
|
|
$result = $this->propal->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');
|
|
}
|
|
|
|
/**
|
|
* Return the list of documents of a dedicated element (from its ID or Ref)
|
|
*
|
|
* @param string $modulepart Name of module or area concerned ('thirdparty', 'member', 'proposal', 'order', 'invoice', 'supplier_invoice', 'shipment', 'project', ...)
|
|
* @param int $id ID of element
|
|
* @param string $ref Ref of element
|
|
* @param string $sortfield Sort criteria ('','fullname','relativename','name','date','size')
|
|
* @param string $sortorder Sort order ('asc' or 'desc')
|
|
* @return array Array of documents with path
|
|
*
|
|
* @throws RestException 400
|
|
* @throws RestException 401
|
|
* @throws RestException 404
|
|
* @throws RestException 500
|
|
*
|
|
* @url GET /
|
|
*/
|
|
public function getDocumentsListByElement($modulepart, $id = 0, $ref = '', $sortfield = '', $sortorder = '')
|
|
{
|
|
global $conf;
|
|
|
|
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 == 'societe' || $modulepart == 'thirdparty')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->societe->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Societe($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Thirdparty not found');
|
|
}
|
|
|
|
$upload_dir = $conf->societe->multidir_output[$object->entity]."/".$object->id;
|
|
}
|
|
elseif ($modulepart == 'user')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
|
|
|
|
// Can get doc if has permission to read all user or if it is user itself
|
|
if (!DolibarrApiAccess::$user->rights->user->user->lire && DolibarrApiAccess::$user->id != $id) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new User($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'User not found');
|
|
}
|
|
|
|
$upload_dir = $conf->user->dir_output.'/'.get_exdir(0, 0, 0, 0, $object, 'user').'/'.$object->id;
|
|
}
|
|
elseif ($modulepart == 'adherent' || $modulepart == 'member')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->adherent->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Adherent($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Member not found');
|
|
}
|
|
|
|
$upload_dir = $conf->adherent->dir_output."/".get_exdir(0, 0, 0, 1, $object, 'member');
|
|
}
|
|
elseif ($modulepart == 'propal' || $modulepart == 'proposal')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->propal->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Propal($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Proposal not found');
|
|
}
|
|
|
|
$upload_dir = $conf->propal->multidir_output[$object->entity]."/".get_exdir(0, 0, 0, 1, $object, 'propal');
|
|
}
|
|
elseif ($modulepart == 'commande' || $modulepart == 'order')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->commande->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Commande($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Order not found');
|
|
}
|
|
|
|
$upload_dir = $conf->commande->dir_output."/".get_exdir(0, 0, 0, 1, $object, 'commande');
|
|
}
|
|
elseif ($modulepart == 'shipment' || $modulepart == 'expedition')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->expedition->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Expedition($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Shipment not found');
|
|
}
|
|
|
|
$upload_dir = $conf->expedition->dir_output."/sending/".get_exdir(0, 0, 0, 1, $object, 'shipment');
|
|
}
|
|
elseif ($modulepart == 'facture' || $modulepart == 'invoice')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->facture->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Facture($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Invoice not found');
|
|
}
|
|
|
|
$upload_dir = $conf->facture->dir_output."/".get_exdir(0, 0, 0, 1, $object, 'invoice');
|
|
}
|
|
elseif ($modulepart == 'facture_fournisseur' || $modulepart == 'supplier_invoice')
|
|
{
|
|
$modulepart = 'supplier_invoice';
|
|
|
|
require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.facture.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->fournisseur->facture->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new FactureFournisseur($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Invoice not found');
|
|
}
|
|
|
|
$upload_dir = $conf->fournisseur->dir_output."/facture/".get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier').dol_sanitizeFileName($object->ref);
|
|
}
|
|
elseif ($modulepart == 'produit' || $modulepart == 'product')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->produit->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Product($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Product not found');
|
|
}
|
|
|
|
$upload_dir = $conf->product->multidir_output[$object->entity].'/'.get_exdir(0, 0, 0, 0, $object, 'product').dol_sanitizeFileName($object->ref);
|
|
}
|
|
elseif ($modulepart == 'agenda' || $modulepart == 'action' || $modulepart == 'event')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->agenda->myactions->read && !DolibarrApiAccess::$user->rights->agenda->allactions->read) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new ActionComm($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Event not found');
|
|
}
|
|
|
|
$upload_dir = $conf->agenda->dir_output.'/'.dol_sanitizeFileName($object->ref);
|
|
}
|
|
elseif ($modulepart == 'expensereport')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->expensereport->read && !DolibarrApiAccess::$user->rights->expensereport->read) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new ExpenseReport($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Expense report not found');
|
|
}
|
|
|
|
$upload_dir = $conf->expensereport->dir_output.'/'.dol_sanitizeFileName($object->ref);
|
|
}
|
|
elseif ($modulepart == 'categorie' || $modulepart == 'category')
|
|
{
|
|
require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
|
|
|
|
if (!DolibarrApiAccess::$user->rights->categorie->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$object = new Categorie($this->db);
|
|
$result = $object->fetch($id, $ref);
|
|
if (!$result) {
|
|
throw new RestException(404, 'Category not found');
|
|
}
|
|
|
|
$upload_dir = $conf->categorie->multidir_output[$object->entity].'/'.get_exdir($object->id, 2, 0, 0, $object, 'category').$object->id."/photos/".dol_sanitizeFileName($object->ref);
|
|
}
|
|
else
|
|
{
|
|
throw new RestException(500, 'Modulepart '.$modulepart.' not implemented yet.');
|
|
}
|
|
|
|
$filearray = dol_dir_list($upload_dir, "files", 0, '', '(\.meta|_preview.*\.png)$', $sortfield, (strtolower($sortorder) == 'desc' ?SORT_DESC:SORT_ASC), 1);
|
|
if (empty($filearray)) {
|
|
throw new RestException(404, 'Search for modulepart '.$modulepart.' with Id '.$object->id.(!empty($object->Ref) ? ' or Ref '.$object->ref : '').' does not return any document.');
|
|
}
|
|
|
|
return $filearray;
|
|
}
|
|
|
|
|
|
/**
|
|
* Return a document.
|
|
*
|
|
* @param int $id ID of document
|
|
* @return array Array with data of file
|
|
*
|
|
* @throws RestException
|
|
*/
|
|
/*
|
|
public function get($id) {
|
|
return array('note'=>'xxx');
|
|
}*/
|
|
|
|
|
|
/**
|
|
* Upload a file.
|
|
*
|
|
* Test sample for invoice: { "filename": "mynewfile.txt", "modulepart": "invoice", "ref": "FA1701-001", "subdir": "", "filecontent": "content text", "fileencoding": "", "overwriteifexists": "0" }.
|
|
* Test sample for supplier invoice: { "filename": "mynewfile.txt", "modulepart": "supplier_invoice", "ref": "FA1701-001", "subdir": "", "filecontent": "content text", "fileencoding": "", "overwriteifexists": "0" }.
|
|
* Test sample for medias file: { "filename": "mynewfile.txt", "modulepart": "medias", "ref": "", "subdir": "image/mywebsite", "filecontent": "Y29udGVudCB0ZXh0Cg==", "fileencoding": "base64", "overwriteifexists": "0" }.
|
|
*
|
|
* @param string $filename Name of file to create ('FA1705-0123.txt')
|
|
* @param string $modulepart Name of module or area concerned by file upload ('facture', 'project', 'project_task', ...)
|
|
* @param string $ref Reference of object (This will define subdir automatically and store submited file into it)
|
|
* @param string $subdir Subdirectory (Only if ref not provided)
|
|
* @param string $filecontent File content (string with file content. An empty file will be created if this parameter is not provided)
|
|
* @param string $fileencoding File encoding (''=no encoding, 'base64'=Base 64)
|
|
* @param int $overwriteifexists Overwrite file if exists (1 by default)
|
|
* @return string
|
|
*
|
|
* @throws RestException 400
|
|
* @throws RestException 401
|
|
* @throws RestException 404
|
|
* @throws RestException 500
|
|
*
|
|
* @url POST /upload
|
|
*/
|
|
public function post($filename, $modulepart, $ref = '', $subdir = '', $filecontent = '', $fileencoding = '', $overwriteifexists = 0)
|
|
{
|
|
global $db, $conf;
|
|
|
|
/*var_dump($modulepart);
|
|
var_dump($filename);
|
|
var_dump($filecontent);
|
|
exit;*/
|
|
|
|
if (empty($modulepart))
|
|
{
|
|
throw new RestException(400, 'Modulepart not provided.');
|
|
}
|
|
|
|
if (!DolibarrApiAccess::$user->rights->ecm->upload) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$newfilecontent = '';
|
|
if (empty($fileencoding)) $newfilecontent = $filecontent;
|
|
if ($fileencoding == 'base64') $newfilecontent = base64_decode($filecontent);
|
|
|
|
$original_file = dol_sanitizeFileName($filename);
|
|
|
|
// Define $uploadir
|
|
$object = null;
|
|
$entity = DolibarrApiAccess::$user->entity;
|
|
if ($ref)
|
|
{
|
|
$tmpreldir = '';
|
|
|
|
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 == '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('', $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->fetch_projet();
|
|
|
|
if ($project_result >= 0)
|
|
{
|
|
$tmpreldir = dol_sanitizeFileName($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);
|
|
}
|
|
// TODO Implement additional moduleparts
|
|
else
|
|
{
|
|
throw new RestException(500, 'Modulepart '.$modulepart.' not implemented yet.');
|
|
}
|
|
|
|
if (is_object($object))
|
|
{
|
|
$result = $object->fetch('', $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.');
|
|
}
|
|
}
|
|
|
|
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
|
|
// If 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');
|
|
}
|
|
|
|
$relativefile = $tmpreldir.dol_sanitizeFileName($object->ref);
|
|
|
|
$tmp = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, $ref, 'write');
|
|
$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
|
|
|
|
if (empty($upload_dir) || $upload_dir == '/')
|
|
{
|
|
throw new RestException(500, 'This value of 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';
|
|
|
|
$relativefile = $subdir;
|
|
|
|
$tmp = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'write');
|
|
$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
|
|
|
|
if (empty($upload_dir) || $upload_dir == '/')
|
|
{
|
|
throw new RestException(500, 'This value of modulepart does not support yet usage of ref. Check modulepart parameter or try to use subdir parameter instead of ref.');
|
|
}
|
|
}
|
|
// $original_file here is still value of filename without any dir.
|
|
|
|
$upload_dir = dol_sanitizePathName($upload_dir);
|
|
|
|
if (dol_mkdir($upload_dir) < 0) // needed by products
|
|
{
|
|
throw new RestException(500, 'Error while trying to create directory.');
|
|
}
|
|
|
|
$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(401, 'Directory not exists : '.dirname($destfile));
|
|
}
|
|
|
|
if (!$overwriteifexists && dol_is_file($destfile))
|
|
{
|
|
throw new RestException(500, "File with name '".$original_file."' already exists.");
|
|
}
|
|
|
|
$fhandle = @fopen($destfiletmp, 'w');
|
|
if ($fhandle)
|
|
{
|
|
$nbofbyteswrote = fwrite($fhandle, $newfilecontent);
|
|
fclose($fhandle);
|
|
@chmod($destfiletmp, octdec($conf->global->MAIN_UMASK));
|
|
}
|
|
else
|
|
{
|
|
throw new RestException(500, "Failed to open file '".$destfiletmp."' for write");
|
|
}
|
|
|
|
$result = dol_move($destfiletmp, $destfile, 0, $overwriteifexists, 1);
|
|
if (!$result)
|
|
{
|
|
throw new RestException(500, "Failed to move file into '".$destfile."'");
|
|
}
|
|
|
|
return dol_basename($destfile);
|
|
}
|
|
|
|
/**
|
|
* Delete a document.
|
|
*
|
|
* @param string $modulepart Name of module or area concerned by file download ('product', ...)
|
|
* @param string $original_file Relative path with filename, relative to modulepart (for example: PRODUCT-REF-999/IMAGE-999.jpg)
|
|
* @return array List of documents
|
|
*
|
|
* @throws RestException 400
|
|
* @throws RestException 401
|
|
* @throws RestException 404
|
|
*
|
|
* @url DELETE /
|
|
*/
|
|
public function delete($modulepart, $original_file)
|
|
{
|
|
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');
|
|
}
|
|
|
|
//--- 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(401);
|
|
}
|
|
if (!$accessallowed) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$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(401);
|
|
}
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName
|
|
/**
|
|
* Validate fields before create or update object
|
|
*
|
|
* @param array $data Array with data to verify
|
|
* @return array
|
|
* @throws RestException
|
|
*/
|
|
private function _validate_file($data)
|
|
{
|
|
// phpcs:enable
|
|
$result = array();
|
|
foreach (Documents::$DOCUMENT_FIELDS as $field) {
|
|
if (!isset($data[$field]))
|
|
throw new RestException(400, "$field field missing");
|
|
$result[$field] = $data[$field];
|
|
}
|
|
return $result;
|
|
}
|
|
}
|