dolibarr  16.0.1
api_documents.class.php
1 <?php
2 /* Copyright (C) 2016 Xebax Christy <xebax@wanadoo.fr>
3  * Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2016 Jean-François Ferry <jfefe@aternatik.fr>
5  *
6  * This program is free software you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <https://www.gnu.org/licenses/>.
18  */
19 
20 use Luracast\Restler\RestException;
21 use Luracast\Restler\Format\UploadFormat;
22 
23 require_once DOL_DOCUMENT_ROOT.'/main.inc.php';
24 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
25 
32 class Documents extends DolibarrApi
33 {
34 
38  public static $DOCUMENT_FIELDS = array(
39  'modulepart'
40  );
41 
45  public function __construct()
46  {
47  global $db;
48  $this->db = $db;
49  }
50 
51 
68  public function index($modulepart, $original_file = '')
69  {
70  global $conf, $langs;
71 
72  if (empty($modulepart)) {
73  throw new RestException(400, 'bad value for parameter modulepart');
74  }
75  if (empty($original_file)) {
76  throw new RestException(400, 'bad value for parameter original_file');
77  }
78 
79  //--- Finds and returns the document
80  $entity = $conf->entity;
81 
82  // Special cases that need to use get_exdir to get real dir of object
83  // If future, all object should use this to define path of documents.
84  /*
85  $tmpreldir = '';
86  if ($modulepart == 'supplier_invoice') {
87  $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
88  }
89 
90  $relativefile = $tmpreldir.dol_sanitizeFileName($object->ref); */
91  $relativefile = $original_file;
92 
93  $check_access = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'read');
94  $accessallowed = $check_access['accessallowed'];
95  $sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
96  $original_file = $check_access['original_file'];
97 
98  if (preg_match('/\.\./', $original_file) || preg_match('/[<>|]/', $original_file)) {
99  throw new RestException(401);
100  }
101  if (!$accessallowed) {
102  throw new RestException(401);
103  }
104 
105  $filename = basename($original_file);
106  $original_file_osencoded = dol_osencode($original_file); // New file name encoded in OS encoding charset
107 
108  if (!file_exists($original_file_osencoded)) {
109  dol_syslog("Try to download not found file ".$original_file_osencoded, LOG_WARNING);
110  throw new RestException(404, 'File not found');
111  }
112 
113  $file_content = file_get_contents($original_file_osencoded);
114  return array('filename'=>$filename, 'content-type' => dol_mimetype($filename), 'filesize'=>filesize($original_file), 'content'=>base64_encode($file_content), 'encoding'=>'base64');
115  }
116 
117 
137  public function builddoc($modulepart, $original_file = '', $doctemplate = '', $langcode = '')
138  {
139  global $conf, $langs;
140 
141  if (empty($modulepart)) {
142  throw new RestException(400, 'bad value for parameter modulepart');
143  }
144  if (empty($original_file)) {
145  throw new RestException(400, 'bad value for parameter original_file');
146  }
147 
148  $outputlangs = $langs;
149  if ($langcode && $langs->defaultlang != $langcode) {
150  $outputlangs = new Translate('', $conf);
151  $outputlangs->setDefaultLang($langcode);
152  }
153 
154  //--- Finds and returns the document
155  $entity = $conf->entity;
156 
157  // Special cases that need to use get_exdir to get real dir of object
158  // If future, all object should use this to define path of documents.
159  /*
160  $tmpreldir = '';
161  if ($modulepart == 'supplier_invoice') {
162  $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
163  }
164 
165  $relativefile = $tmpreldir.dol_sanitizeFileName($object->ref); */
166  $relativefile = $original_file;
167 
168  $check_access = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'write');
169  $accessallowed = $check_access['accessallowed'];
170  $sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
171  $original_file = $check_access['original_file'];
172 
173  if (preg_match('/\.\./', $original_file) || preg_match('/[<>|]/', $original_file)) {
174  throw new RestException(401);
175  }
176  if (!$accessallowed) {
177  throw new RestException(401);
178  }
179 
180  // --- Generates the document
181  $hidedetails = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS) ? 0 : 1;
182  $hidedesc = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DESC) ? 0 : 1;
183  $hideref = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_REF) ? 0 : 1;
184 
185  $templateused = '';
186 
187  if ($modulepart == 'facture' || $modulepart == 'invoice') {
188  require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
189  $this->invoice = new Facture($this->db);
190  $result = $this->invoice->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
191  if (!$result) {
192  throw new RestException(404, 'Invoice not found');
193  }
194 
195  $templateused = $doctemplate ? $doctemplate : $this->invoice->model_pdf;
196  $result = $this->invoice->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
197  if ($result <= 0) {
198  throw new RestException(500, 'Error generating document');
199  }
200  } elseif ($modulepart == 'commande' || $modulepart == 'order') {
201  require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
202  $this->order = new Commande($this->db);
203  $result = $this->order->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
204  if (!$result) {
205  throw new RestException(404, 'Order not found');
206  }
207  $templateused = $doctemplate ? $doctemplate : $this->order->model_pdf;
208  $result = $this->order->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
209  if ($result <= 0) {
210  throw new RestException(500, 'Error generating document');
211  }
212  } elseif ($modulepart == 'propal' || $modulepart == 'proposal') {
213  require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php';
214  $this->propal = new Propal($this->db);
215  $result = $this->propal->fetch(0, preg_replace('/\.[^\.]+$/', '', basename($original_file)));
216  if (!$result) {
217  throw new RestException(404, 'Proposal not found');
218  }
219  $templateused = $doctemplate ? $doctemplate : $this->propal->model_pdf;
220  $result = $this->propal->generateDocument($templateused, $outputlangs, $hidedetails, $hidedesc, $hideref);
221  if ($result <= 0) {
222  throw new RestException(500, 'Error generating document');
223  }
224  } else {
225  throw new RestException(403, 'Generation not available for this modulepart');
226  }
227 
228  $filename = basename($original_file);
229  $original_file_osencoded = dol_osencode($original_file); // New file name encoded in OS encoding charset
230 
231  if (!file_exists($original_file_osencoded)) {
232  throw new RestException(404, 'File not found');
233  }
234 
235  $file_content = file_get_contents($original_file_osencoded);
236  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');
237  }
238 
256  public function getDocumentsListByElement($modulepart, $id = 0, $ref = '', $sortfield = '', $sortorder = '')
257  {
258  global $conf;
259 
260  if (empty($modulepart)) {
261  throw new RestException(400, 'bad value for parameter modulepart');
262  }
263 
264  if (empty($id) && empty($ref)) {
265  throw new RestException(400, 'bad value for parameter id or ref');
266  }
267 
268  $id = (empty($id) ? 0 : $id);
269  $recursive = 0;
270  $type = 'files';
271 
272  if ($modulepart == 'societe' || $modulepart == 'thirdparty') {
273  require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
274 
275  if (!DolibarrApiAccess::$user->rights->societe->lire) {
276  throw new RestException(401);
277  }
278 
279  $object = new Societe($this->db);
280  $result = $object->fetch($id, $ref);
281  if (!$result) {
282  throw new RestException(404, 'Thirdparty not found');
283  }
284 
285  $upload_dir = $conf->societe->multidir_output[$object->entity]."/".$object->id;
286  } elseif ($modulepart == 'user') {
287  require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
288 
289  // Can get doc if has permission to read all user or if it is user itself
290  if (!DolibarrApiAccess::$user->rights->user->user->lire && DolibarrApiAccess::$user->id != $id) {
291  throw new RestException(401);
292  }
293 
294  $object = new User($this->db);
295  $result = $object->fetch($id, $ref);
296  if (!$result) {
297  throw new RestException(404, 'User not found');
298  }
299 
300  $upload_dir = $conf->user->dir_output.'/'.get_exdir(0, 0, 0, 0, $object, 'user').'/'.$object->id;
301  } elseif ($modulepart == 'adherent' || $modulepart == 'member') {
302  require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
303 
304  if (!DolibarrApiAccess::$user->rights->adherent->lire) {
305  throw new RestException(401);
306  }
307 
308  $object = new Adherent($this->db);
309  $result = $object->fetch($id, $ref);
310  if (!$result) {
311  throw new RestException(404, 'Member not found');
312  }
313 
314  $upload_dir = $conf->adherent->dir_output."/".get_exdir(0, 0, 0, 1, $object, 'member');
315  } elseif ($modulepart == 'propal' || $modulepart == 'proposal') {
316  require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php';
317 
318  if (!DolibarrApiAccess::$user->rights->propal->lire) {
319  throw new RestException(401);
320  }
321 
322  $object = new Propal($this->db);
323  $result = $object->fetch($id, $ref);
324  if (!$result) {
325  throw new RestException(404, 'Proposal not found');
326  }
327 
328  $upload_dir = $conf->propal->multidir_output[$object->entity]."/".get_exdir(0, 0, 0, 1, $object, 'propal');
329  } elseif ($modulepart == 'supplier_proposal') {
330  require_once DOL_DOCUMENT_ROOT.'/supplier_proposal/class/supplier_proposal.class.php';
331 
332  if (!DolibarrApiAccess::$user->rights->supplier_proposal->read) {
333  throw new RestException(401);
334  }
335 
336  $object = new Propal($this->db);
337  $result = $object->fetch($id, $ref);
338  if (!$result) {
339  throw new RestException(404, 'Supplier proposal not found');
340  }
341 
342  $upload_dir = $conf->propal->multidir_output[$object->entity]."/".get_exdir(0, 0, 0, 1, $object, 'propal');
343  } elseif ($modulepart == 'commande' || $modulepart == 'order') {
344  require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
345 
346  if (!DolibarrApiAccess::$user->rights->commande->lire) {
347  throw new RestException(401);
348  }
349 
350  $object = new Commande($this->db);
351  $result = $object->fetch($id, $ref);
352  if (!$result) {
353  throw new RestException(404, 'Order not found');
354  }
355 
356  $upload_dir = $conf->commande->dir_output."/".get_exdir(0, 0, 0, 1, $object, 'commande');
357  } elseif ($modulepart == 'commande_fournisseur' || $modulepart == 'supplier_order') {
358  $modulepart = 'supplier_order';
359 
360  require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php';
361 
362  if (empty(DolibarrApiAccess::$user->rights->fournisseur->commande->lire) && empty(DolibarrApiAccess::$user->rights->supplier_order->lire)) {
363  throw new RestException(401);
364  }
365 
366  $object = new CommandeFournisseur($this->db);
367  $result = $object->fetch($id, $ref);
368  if (!$result) {
369  throw new RestException(404, 'Purchase order not found');
370  }
371 
372  $upload_dir = $conf->fournisseur->dir_output."/facture/".get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier').dol_sanitizeFileName($object->ref);
373  } elseif ($modulepart == 'shipment' || $modulepart == 'expedition') {
374  require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
375 
376  if (!DolibarrApiAccess::$user->rights->expedition->lire) {
377  throw new RestException(401);
378  }
379 
380  $object = new Expedition($this->db);
381  $result = $object->fetch($id, $ref);
382  if (!$result) {
383  throw new RestException(404, 'Shipment not found');
384  }
385 
386  $upload_dir = $conf->expedition->dir_output."/sending/".get_exdir(0, 0, 0, 1, $object, 'shipment');
387  } elseif ($modulepart == 'facture' || $modulepart == 'invoice') {
388  require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
389 
390  if (!DolibarrApiAccess::$user->rights->facture->lire) {
391  throw new RestException(401);
392  }
393 
394  $object = new Facture($this->db);
395  $result = $object->fetch($id, $ref);
396  if (!$result) {
397  throw new RestException(404, 'Invoice not found');
398  }
399 
400  $upload_dir = $conf->facture->dir_output."/".get_exdir(0, 0, 0, 1, $object, 'invoice');
401  } elseif ($modulepart == 'facture_fournisseur' || $modulepart == 'supplier_invoice') {
402  $modulepart = 'supplier_invoice';
403 
404  require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.facture.class.php';
405 
406  if (empty(DolibarrApiAccess::$user->rights->fournisseur->facture->lire) && empty(DolibarrApiAccess::$user->rights->supplier_invoice->lire)) {
407  throw new RestException(401);
408  }
409 
410  $object = new FactureFournisseur($this->db);
411  $result = $object->fetch($id, $ref);
412  if (!$result) {
413  throw new RestException(404, 'Invoice not found');
414  }
415 
416  $upload_dir = $conf->fournisseur->dir_output."/facture/".get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier').dol_sanitizeFileName($object->ref);
417  } elseif ($modulepart == 'produit' || $modulepart == 'product') {
418  require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
419 
420  if (!DolibarrApiAccess::$user->rights->produit->lire) {
421  throw new RestException(401);
422  }
423 
424  $object = new Product($this->db);
425  $result = $object->fetch($id, $ref);
426  if ($result == 0) {
427  throw new RestException(404, 'Product not found');
428  } elseif ($result < 0) {
429  throw new RestException(500, 'Error while fetching object: '.$object->error);
430  }
431 
432  $upload_dir = $conf->product->multidir_output[$object->entity].'/'.get_exdir(0, 0, 0, 1, $object, 'product');
433  } elseif ($modulepart == 'agenda' || $modulepart == 'action' || $modulepart == 'event') {
434  require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php';
435 
436  if (!DolibarrApiAccess::$user->rights->agenda->myactions->read && !DolibarrApiAccess::$user->rights->agenda->allactions->read) {
437  throw new RestException(401);
438  }
439 
440  $object = new ActionComm($this->db);
441  $result = $object->fetch($id, $ref);
442  if (!$result) {
443  throw new RestException(404, 'Event not found');
444  }
445 
446  $upload_dir = $conf->agenda->dir_output.'/'.dol_sanitizeFileName($object->ref);
447  } elseif ($modulepart == 'expensereport') {
448  require_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php';
449 
450  if (!DolibarrApiAccess::$user->rights->expensereport->read && !DolibarrApiAccess::$user->rights->expensereport->read) {
451  throw new RestException(401);
452  }
453 
454  $object = new ExpenseReport($this->db);
455  $result = $object->fetch($id, $ref);
456  if (!$result) {
457  throw new RestException(404, 'Expense report not found');
458  }
459 
460  $upload_dir = $conf->expensereport->dir_output.'/'.dol_sanitizeFileName($object->ref);
461  } elseif ($modulepart == 'knowledgemanagement') {
462  require_once DOL_DOCUMENT_ROOT.'/knowledgemanagement/class/knowledgerecord.class.php';
463 
464  if (!DolibarrApiAccess::$user->rights->knowledgemanagement->knowledgerecord->read && !DolibarrApiAccess::$user->rights->knowledgemanagement->knowledgerecord->read) {
465  throw new RestException(401);
466  }
467 
468  $object = new KnowledgeRecord($this->db);
469  $result = $object->fetch($id, $ref);
470  if (!$result) {
471  throw new RestException(404, 'KM article not found');
472  }
473 
474  $upload_dir = $conf->knowledgemanagement->dir_output.'/knowledgerecord/'.dol_sanitizeFileName($object->ref);
475  } elseif ($modulepart == 'categorie' || $modulepart == 'category') {
476  require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
477 
478  if (!DolibarrApiAccess::$user->rights->categorie->lire) {
479  throw new RestException(401);
480  }
481 
482  $object = new Categorie($this->db);
483  $result = $object->fetch($id, $ref);
484  if (!$result) {
485  throw new RestException(404, 'Category not found');
486  }
487 
488  $upload_dir = $conf->categorie->multidir_output[$object->entity].'/'.get_exdir($object->id, 2, 0, 0, $object, 'category').$object->id."/photos/".dol_sanitizeFileName($object->ref);
489  } elseif ($modulepart == 'ecm') {
490  throw new RestException(500, 'Modulepart Ecm not implemented yet.');
491  // // require_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmdirectory.class.php';
492 
493  // if (!DolibarrApiAccess::$user->rights->ecm->read) {
494  // throw new RestException(401);
495  // }
496 
497  // // $object = new EcmDirectory($this->db);
498  // // $result = $object->fetch($ref);
499  // // if (!$result) {
500  // // throw new RestException(404, 'EcmDirectory not found');
501  // // }
502  // $upload_dir = $conf->ecm->dir_output;
503  // $type = 'all';
504  // $recursive = 0;
505  } else {
506  throw new RestException(500, 'Modulepart '.$modulepart.' not implemented yet.');
507  }
508 
509  $filearray = dol_dir_list($upload_dir, $type, $recursive, '', '(\.meta|_preview.*\.png)$', $sortfield, (strtolower($sortorder) == 'desc' ?SORT_DESC:SORT_ASC), 1);
510  if (empty($filearray)) {
511  throw new RestException(404, 'Search for modulepart '.$modulepart.' with Id '.$object->id.(!empty($object->ref) ? ' or Ref '.$object->ref : '').' does not return any document.');
512  } else {
513  if (($object->id) > 0 && !empty($modulepart)) {
514  require_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
515  $ecmfile = new EcmFiles($this->db);
516  $result = $ecmfile->fetchAll('', '', 0, 0, array('t.src_object_type' => $modulepart, 't.src_object_id' => $object->id));
517  if ($result < 0) {
518  throw new RestException(503, 'Error when retrieve ecm list : '.$this->db->lasterror());
519  } elseif (is_array($ecmfile->lines) && count($ecmfile->lines) > 0) {
520  $filearray['ecmfiles_infos'] = $ecmfile->lines;
521  }
522  }
523  }
524 
525  return $filearray;
526  }
527 
528 
537  /*
538  public function get($id) {
539  return array('note'=>'xxx');
540  }*/
541 
542 
567  public function post($filename, $modulepart, $ref = '', $subdir = '', $filecontent = '', $fileencoding = '', $overwriteifexists = 0, $createdirifnotexists = 1)
568  {
569  global $db, $conf;
570 
571  //var_dump($modulepart);
572  //var_dump($filename);
573  //var_dump($filecontent);exit;
574 
575  if (empty($modulepart)) {
576  throw new RestException(400, 'Modulepart not provided.');
577  }
578 
579  if (!DolibarrApiAccess::$user->rights->ecm->upload) {
580  throw new RestException(401);
581  }
582 
583  $newfilecontent = '';
584  if (empty($fileencoding)) {
585  $newfilecontent = $filecontent;
586  }
587  if ($fileencoding == 'base64') {
588  $newfilecontent = base64_decode($filecontent);
589  }
590 
591  $original_file = dol_sanitizeFileName($filename);
592 
593  // Define $uploadir
594  $object = null;
595  $entity = DolibarrApiAccess::$user->entity;
596  if (empty($entity)) {
597  $entity = 1;
598  }
599 
600  if ($ref) {
601  $tmpreldir = '';
602 
603  if ($modulepart == 'facture' || $modulepart == 'invoice') {
604  $modulepart = 'facture';
605 
606  require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
607  $object = new Facture($this->db);
608  } elseif ($modulepart == 'facture_fournisseur' || $modulepart == 'supplier_invoice') {
609  $modulepart = 'supplier_invoice';
610 
611  require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.facture.class.php';
612  $object = new FactureFournisseur($this->db);
613  } elseif ($modulepart == 'commande' || $modulepart == 'order') {
614  $modulepart = 'commande';
615 
616  require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
617  $object = new Commande($this->db);
618  } elseif ($modulepart == 'commande_fournisseur' || $modulepart == 'supplier_order') {
619  $modulepart = 'supplier_order';
620 
621  require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php';
622  $object = new CommandeFournisseur($this->db);
623  } elseif ($modulepart == 'project') {
624  require_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php';
625  $object = new Project($this->db);
626  } elseif ($modulepart == 'task' || $modulepart == 'project_task') {
627  $modulepart = 'project_task';
628 
629  require_once DOL_DOCUMENT_ROOT.'/projet/class/task.class.php';
630  $object = new Task($this->db);
631 
632  $task_result = $object->fetch('', $ref);
633 
634  // Fetching the tasks project is required because its out_dir might be a sub-directory of the project
635  if ($task_result > 0) {
636  $project_result = $object->fetch_projet();
637 
638  if ($project_result >= 0) {
639  $tmpreldir = dol_sanitizeFileName($object->project->ref).'/';
640  }
641  } else {
642  throw new RestException(500, 'Error while fetching Task '.$ref);
643  }
644  } elseif ($modulepart == 'product' || $modulepart == 'produit' || $modulepart == 'service' || $modulepart == 'produit|service') {
645  require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
646  $object = new Product($this->db);
647  } elseif ($modulepart == 'expensereport') {
648  require_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php';
649  $object = new ExpenseReport($this->db);
650  } elseif ($modulepart == 'fichinter') {
651  require_once DOL_DOCUMENT_ROOT.'/fichinter/class/fichinter.class.php';
652  $object = new Fichinter($this->db);
653  } elseif ($modulepart == 'adherent' || $modulepart == 'member') {
654  $modulepart = 'adherent';
655  require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
656  $object = new Adherent($this->db);
657  } elseif ($modulepart == 'proposal' || $modulepart == 'propal' || $modulepart == 'propale') {
658  $modulepart = 'propale';
659  require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php';
660  $object = new Propal($this->db);
661  } else {
662  // TODO Implement additional moduleparts
663  throw new RestException(500, 'Modulepart '.$modulepart.' not implemented yet.');
664  }
665 
666  if (is_object($object)) {
667  $result = $object->fetch('', $ref);
668 
669  if ($result == 0) {
670  throw new RestException(404, "Object with ref '".$ref."' was not found.");
671  } elseif ($result < 0) {
672  throw new RestException(500, 'Error while fetching object: '.$object->error);
673  }
674  }
675 
676  if (!($object->id > 0)) {
677  throw new RestException(404, 'The object '.$modulepart." with ref '".$ref."' was not found.");
678  }
679 
680  // Special cases that need to use get_exdir to get real dir of object
681  // In future, all object should use this to define path of documents.
682  if ($modulepart == 'supplier_invoice') {
683  $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
684  }
685 
686  $relativefile = $tmpreldir.dol_sanitizeFileName($object->ref);
687 
688  $tmp = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, $ref, 'write');
689  $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
690 
691  if (empty($upload_dir) || $upload_dir == '/') {
692  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.');
693  }
694  } else {
695  if ($modulepart == 'invoice') {
696  $modulepart = 'facture';
697  }
698  if ($modulepart == 'member') {
699  $modulepart = 'adherent';
700  }
701 
702  $relativefile = $subdir;
703  $tmp = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'write');
704  $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
705 
706  if (empty($upload_dir) || $upload_dir == '/') {
707  if (!empty($tmp['error'])) {
708  throw new RestException(401, 'Error returned by dol_check_secure_access_document: '.$tmp['error']);
709  } else {
710  throw new RestException(500, 'This value of modulepart ('.$modulepart.') is not allowed with this value of subdir ('.$relativefile.')');
711  }
712  }
713  }
714  // $original_file here is still value of filename without any dir.
715 
716  $upload_dir = dol_sanitizePathName($upload_dir);
717 
718  if (!empty($createdirifnotexists)) {
719  if (dol_mkdir($upload_dir) < 0) { // needed by products
720  throw new RestException(500, 'Error while trying to create directory '.$upload_dir);
721  }
722  }
723 
724  $destfile = $upload_dir.'/'.$original_file;
725  $destfiletmp = DOL_DATA_ROOT.'/admin/temp/'.$original_file;
726  dol_delete_file($destfiletmp);
727  //var_dump($original_file);exit;
728 
729  if (!dol_is_dir(dirname($destfile))) {
730  throw new RestException(401, 'Directory not exists : '.dirname($destfile));
731  }
732 
733  if (!$overwriteifexists && dol_is_file($destfile)) {
734  throw new RestException(500, "File with name '".$original_file."' already exists.");
735  }
736 
737  $fhandle = @fopen($destfiletmp, 'w');
738  if ($fhandle) {
739  $nbofbyteswrote = fwrite($fhandle, $newfilecontent);
740  fclose($fhandle);
741  @chmod($destfiletmp, octdec($conf->global->MAIN_UMASK));
742  } else {
743  throw new RestException(500, "Failed to open file '".$destfiletmp."' for write");
744  }
745 
746  $result = dol_move($destfiletmp, $destfile, 0, $overwriteifexists, 1);
747  if (!$result) {
748  throw new RestException(500, "Failed to move file into '".$destfile."'");
749  }
750 
751  return dol_basename($destfile);
752  }
753 
767  public function delete($modulepart, $original_file)
768  {
769  global $conf, $langs;
770 
771  if (empty($modulepart)) {
772  throw new RestException(400, 'bad value for parameter modulepart');
773  }
774  if (empty($original_file)) {
775  throw new RestException(400, 'bad value for parameter original_file');
776  }
777 
778  //--- Finds and returns the document
779  $entity = $conf->entity;
780 
781  // Special cases that need to use get_exdir to get real dir of object
782  // If future, all object should use this to define path of documents.
783  /*
784  $tmpreldir = '';
785  if ($modulepart == 'supplier_invoice') {
786  $tmpreldir = get_exdir($object->id, 2, 0, 0, $object, 'invoice_supplier');
787  }
788 
789  $relativefile = $tmpreldir.dol_sanitizeFileName($object->ref); */
790  $relativefile = $original_file;
791 
792  $check_access = dol_check_secure_access_document($modulepart, $relativefile, $entity, DolibarrApiAccess::$user, '', 'read');
793  $accessallowed = $check_access['accessallowed'];
794  $sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
795  $original_file = $check_access['original_file'];
796 
797  if (preg_match('/\.\./', $original_file) || preg_match('/[<>|]/', $original_file)) {
798  throw new RestException(401);
799  }
800  if (!$accessallowed) {
801  throw new RestException(401);
802  }
803 
804  $filename = basename($original_file);
805  $original_file_osencoded = dol_osencode($original_file); // New file name encoded in OS encoding charset
806 
807  if (!file_exists($original_file_osencoded)) {
808  dol_syslog("Try to download not found file ".$original_file_osencoded, LOG_WARNING);
809  throw new RestException(404, 'File not found');
810  }
811 
812  if (@unlink($original_file_osencoded)) {
813  return array(
814  'success' => array(
815  'code' => 200,
816  'message' => 'Document deleted'
817  )
818  );
819  }
820 
821  throw new RestException(401);
822  }
823 
824  // phpcs:disable PEAR.NamingConventions.ValidFunctionName
832  private function _validate_file($data)
833  {
834  // phpcs:enable
835  $result = array();
836  foreach (Documents::$DOCUMENT_FIELDS as $field) {
837  if (!isset($data[$field])) {
838  throw new RestException(400, "$field field missing");
839  }
840  $result[$field] = $data[$field];
841  }
842  return $result;
843  }
844 }
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
index($modulepart, $original_file= '')
Download a document.
dol_sanitizePathName($str, $newstr= '_', $unaccent=1)
Clean a string to use it as a path name.
_validate_file($data)
Validate fields before create or update object.
Class for KnowledgeRecord.
dol_mkdir($dir, $dataroot= '', $newmask= '')
Creation of a directory (this can create recursive subdir)
Class to manage agenda events (actions)
$conf db
API class for accounts.
Definition: inc.php:41
API class for receive files.
Class to manage products or services.
Class to manage interventions.
Class to manage Dolibarr users.
Definition: user.class.php:44
post($filename, $modulepart, $ref= '', $subdir= '', $filecontent= '', $fileencoding= '', $overwriteifexists=0, $createdirifnotexists=1)
Return a document.
dol_is_dir($folder)
Test if filename is a directory.
Definition: files.lib.php:446
Class to manage suppliers invoices.
builddoc($modulepart, $original_file= '', $doctemplate= '', $langcode= '')
Build a document.
dol_move($srcfile, $destfile, $newmask=0, $overwriteifexists=1, $testvirus=0, $indexdatabase=1)
Move a file into another name.
Definition: files.lib.php:854
Class for API REST v1.
Definition: api.class.php:30
getDocumentsListByElement($modulepart, $id=0, $ref= '', $sortfield= '', $sortorder= '')
Return the list of documents of a dedicated element (from its ID or Ref)
Class to manage third parties objects (customers, suppliers, prospects...)
Class to manage categories.
dol_check_secure_access_document($modulepart, $original_file, $entity, $fuser= '', $refname= '', $mode= 'read')
Security check when accessing to a document (used by document.php, viewimage.php and webservices to g...
Definition: files.lib.php:2398
Class to manage projects.
dol_mimetype($file, $default= 'application/octet-stream', $mode=0)
Return MIME type of a file from its name with extension.
Class to manage shipments.
Class to manage customers orders.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename= '', $restricttologhandler= '', $logcontext=null)
Write log message into outputs.
get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart= '')
Return a path to have a the directory according to object where files are stored. ...
Class to manage members of a foundation.
dol_basename($pathfile)
Make a basename working with all page code (default PHP basenamed fails with cyrillic).
Definition: files.lib.php:36
Class to manage translations.
dol_sanitizeFileName($str, $newstr= '_', $unaccent=1)
Clean a string to use it as a file name.
dol_dir_list($path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0)
Scan a directory and return a list of files/directories.
Definition: files.lib.php:60
Class to manage Trips and Expenses.
Class to manage predefined suppliers products.
dol_is_file($pathoffile)
Return if path is a file.
Definition: files.lib.php:476
Class to manage tasks.
Definition: task.class.php:37
__construct()
Constructor.
Class to manage invoices.
Class to manage ECM files.
dol_delete_file($file, $disableglob=0, $nophperrors=0, $nohook=0, $object=null, $allowdotdot=false, $indexdatabase=1, $nolog=0)
Remove a file or several files with a mask.
Definition: files.lib.php:1230
Class to manage proposals.