dolibarr  20.0.0-alpha
doc_generic_user_odt.modules.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2010-2012 Laurent Destailleur <eldy@users.sourceforge.net>
3  * Copyright (C) 2012 Juanjo Menent <jmenent@2byte.es>
4  * Copyright (C) 2018-2021 Frédéric France <frederic.france@netlogic.fr>
5  * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 * or see https://www.gnu.org/
20 */
21 
28 require_once DOL_DOCUMENT_ROOT.'/core/modules/user/modules_user.class.php';
29 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
30 require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
31 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
32 require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
33 
34 
39 {
44  public $version = 'dolibarr';
45 
46 
52  public function __construct($db)
53  {
54  global $langs, $mysoc;
55 
56  // Load translation files required by the page
57  $langs->loadLangs(array("main", "companies"));
58 
59  $this->db = $db;
60  $this->name = "ODT templates";
61  $this->description = $langs->trans("DocumentModelOdt");
62  $this->scandir = 'USER_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
63 
64  // Page size for A4 format
65  $this->type = 'odt';
66  $this->page_largeur = 0;
67  $this->page_hauteur = 0;
68  $this->format = array($this->page_largeur, $this->page_hauteur);
69  $this->marge_gauche = 0;
70  $this->marge_droite = 0;
71  $this->marge_haute = 0;
72  $this->marge_basse = 0;
73 
74  $this->option_logo = 1; // Display logo
75  $this->option_tva = 0; // Manage the vat option USER_TVAOPTION
76  $this->option_modereg = 0; // Display payment mode
77  $this->option_condreg = 0; // Display payment terms
78  $this->option_multilang = 1; // Available in several languages
79  $this->option_escompte = 0; // Displays if there has been a discount
80  $this->option_credit_note = 0; // Support credit notes
81  $this->option_freetext = 1; // Support add of a personalised text
82  $this->option_draft_watermark = 0; // Support add of a watermark on drafts
83 
84  // Get source company
85  $this->emetteur = $mysoc;
86  if (!$this->emetteur->country_code) {
87  $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
88  }
89  }
90 
91 
98  public function info($langs)
99  {
100  global $conf, $langs;
101 
102  // Load translation files required by the page
103  $langs->loadLangs(array('companies', 'errors'));
104 
105  $form = new Form($this->db);
106 
107  $odtChosen = getDolGlobalInt('MAIN_PROPAL_CHOOSE_ODT_DOCUMENT') > 0;
108  $odtPath = trim(getDolGlobalString('USER_ADDON_PDF_ODT_PATH'));
109 
110  $texte = $this->description.".<br>\n";
111  $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
112  $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
113  $texte .= '<input type="hidden" name="page_y" value="">';
114  $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
115  $texte .= '<input type="hidden" name="param1" value="USER_ADDON_PDF_ODT_PATH">';
116  if ($odtChosen) {
117  $texte .= '<input type="hidden" name="param2" value="USER_ADDON_PDF_ODT_DEFAULT">';
118  $texte .= '<input type="hidden" name="param3" value="USER_ADDON_PDF_ODT_TOBILL">';
119  $texte .= '<input type="hidden" name="param4" value="USER_ADDON_PDF_ODT_CLOSED">';
120  }
121  $texte .= '<table class="nobordernopadding" width="100%">';
122 
123  // List of directories area
124  $texte .= '<tr><td>';
125  $texttitle = $langs->trans("ListOfDirectories");
126  $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', $odtPath));
127  $listoffiles = array();
128  foreach ($listofdir as $key => $tmpdir) {
129  $tmpdir = trim($tmpdir);
130  $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
131  if (!$tmpdir) {
132  unset($listofdir[$key]);
133  continue;
134  }
135  if (!is_dir($tmpdir)) {
136  $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), 0);
137  } else {
138  $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
139  if (count($tmpfiles)) {
140  $listoffiles = array_merge($listoffiles, $tmpfiles);
141  }
142  }
143  }
144  $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
145  $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
146  // Add list of substitution keys
147  $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
148  $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
149 
150  $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
151  $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
152  $texte .= '<textarea class="flat" cols="60" name="value1">';
153  $texte .= $odtPath;
154  $texte .= '</textarea>';
155  $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
156  $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
157  $texte .= '<br></div></div>';
158 
159  // Scan directories
160  if (count($listofdir)) {
161  $texte .= $langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b>';
162 
163  if ($odtChosen) {
164  // Model for creation
165  $list = ModelePDFUser::liste_modeles($this->db);
166  $texte .= '<table width="50%;">';
167  $texte .= '<tr>';
168  $texte .= '<td width="60%;">'.$langs->trans("DefaultModelPropalCreate").'</td>';
169  $texte .= '<td colspan="">';
170  $texte .= $form->selectarray('value2', $list, getDolGlobalString('USER_ADDON_PDF_ODT_DEFAULT'));
171  $texte .= "</td></tr>";
172 
173  $texte .= '<tr>';
174  $texte .= '<td width="60%;">'.$langs->trans("DefaultModelPropalToBill").'</td>';
175  $texte .= '<td colspan="">';
176  $texte .= $form->selectarray('value3', $list, getDolGlobalString('USER_ADDON_PDF_ODT_TOBILL'));
177  $texte .= "</td></tr>";
178  $texte .= '<tr>';
179 
180  $texte .= '<td width="60%;">'.$langs->trans("DefaultModelPropalClosed").'</td>';
181  $texte .= '<td colspan="">';
182  $texte .= $form->selectarray('value4', $list, getDolGlobalString('USER_ADDON_PDF_ODT_CLOSED'));
183  $texte .= "</td></tr>";
184  $texte .= '</table>';
185  }
186  $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
187  // Show list of found files
188  foreach ($listoffiles as $file) {
189  $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=users/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
190  $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=USER_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
191  $texte .= '<br>';
192  }
193  $texte .= '</div>';
194  }
195  // Add input to upload a new template file.
196  $texte .= '<div>'.$langs->trans("UploadNewTemplate");
197  $maxfilesizearray = getMaxFileSizeArray();
198  $maxmin = $maxfilesizearray['maxmin'];
199  if ($maxmin > 0) {
200  $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
201  }
202  $texte .= ' <input type="file" name="uploadfile">';
203  $texte .= '<input type="hidden" value="USER_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
204  $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
205  $texte .= '</div>';
206 
207  $texte .= '</td>';
208 
209  $texte .= '</tr>';
210 
211  $texte .= '</table>';
212  $texte .= '</form>';
213 
214  return $texte;
215  }
216 
217  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
229  public function write_file($object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
230  {
231  // phpcs:enable
232  global $user, $langs, $conf, $mysoc, $hookmanager;
233 
234  if (empty($srctemplatepath)) {
235  dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
236  return -1;
237  }
238 
239  // Add odtgeneration hook
240  if (!is_object($hookmanager)) {
241  include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
242  $hookmanager = new HookManager($this->db);
243  }
244  $hookmanager->initHooks(array('odtgeneration'));
245  global $action;
246 
247  if (!is_object($outputlangs)) {
248  $outputlangs = $langs;
249  }
250  $sav_charset_output = $outputlangs->charset_output;
251  $outputlangs->charset_output = 'UTF-8';
252 
253  // Load translation files required by the page
254  $outputlangs->loadLangs(array("main", "companies", "bills", "dict"));
255 
256  if ($conf->user->dir_output) {
257  // If $object is id instead of object
258  if (!is_object($object)) {
259  $id = $object;
260  $object = new User($this->db);
261  $result = $object->fetch($id);
262  if ($result < 0) {
263  dol_print_error($this->db, $object->error);
264  return -1;
265  }
266  }
267 
268  $object->fetch_thirdparty();
269 
270  $dir = $conf->user->dir_output;
271  $objectref = dol_sanitizeFileName($object->ref);
272  if (!preg_match('/specimen/i', $objectref)) {
273  $dir .= "/".$objectref;
274  }
275  $file = $dir."/".$objectref.".odt";
276 
277  if (!file_exists($dir)) {
278  if (dol_mkdir($dir) < 0) {
279  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
280  return -1;
281  }
282  }
283 
284  if (file_exists($dir)) {
285  //print "srctemplatepath=".$srctemplatepath; // Src filename
286  $newfile = basename($srctemplatepath);
287  $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
288  $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
289  $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
290 
291  $newfiletmp = $objectref . '_' . $newfiletmp;
292 
293  // Get extension (ods or odt)
294  $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
295  if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
296  $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
297  if ($format == '1') {
298  $format = '%Y%m%d%H%M%S';
299  }
300  $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
301  } else {
302  $filename = $newfiletmp . '.' . $newfileformat;
303  }
304  $file = $dir . '/' . $filename;
305  //print "newdir=".$dir;
306  //print "newfile=".$newfile;
307  //print "file=".$file;
308  //print "conf->user->dir_temp=".$conf->user->dir_temp;
309 
310  dol_mkdir($conf->user->dir_temp);
311  if (!is_writable($conf->user->dir_temp)) {
312  $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->user->dir_temp);
313  dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
314  return -1;
315  }
316 
317  // If CUSTOMER contact defined on user, we use it
318  $usecontact = false;
319  $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
320  if (count($arrayidcontact) > 0) {
321  $usecontact = true;
322  $result = $object->fetch_contact($arrayidcontact[0]);
323  }
324 
325  // Recipient name
326  if (!empty($usecontact)) {
327  if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
328  $socobject = $object->contact;
329  } else {
330  $socobject = $object->thirdparty;
331  // if we have a CUSTOMER contact and we don't use it as recipient we store the contact object for later use
332  $contactobject = $object->contact;
333  }
334  } else {
335  $socobject = $object->thirdparty;
336  }
337 
338  // Open and load template
339  require_once ODTPHP_PATH.'odf.php';
340  try {
341  $odfHandler = new Odf(
342  $srctemplatepath,
343  array(
344  'PATH_TO_TMP' => $conf->user->dir_temp,
345  'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
346  'DELIMITER_LEFT' => '{',
347  'DELIMITER_RIGHT' => '}'
348  )
349  );
350  } catch (Exception $e) {
351  $this->error = $e->getMessage();
352  dol_syslog($e->getMessage(), LOG_WARNING);
353  return -1;
354  }
355 
356  // Make substitutions into odt
357  $array_user = $this->get_substitutionarray_user($object, $outputlangs);
358  $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
359  $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
360  $array_other = $this->get_substitutionarray_other($outputlangs);
361  // retrieve contact information for use in object as contact_xxx tags
362  $array_thirdparty_contact = array();
363  if ($usecontact && is_object($contactobject)) {
364  $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
365  }
366 
367  $tmparray = array_merge($array_user, $array_soc, $array_thirdparty, $array_other, $array_thirdparty_contact);
368  complete_substitutions_array($tmparray, $outputlangs, $object);
369  $object->fetch_optionals();
370  // Call the ODTSubstitution hook
371  $parameters = array('file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
372  $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
373  foreach ($tmparray as $key => $value) {
374  try {
375  if (preg_match('/logo$/', $key)) { // Image
376  if (file_exists($value)) {
377  $odfHandler->setImage($key, $value);
378  } else {
379  $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
380  }
381  } else { // Text
382  $odfHandler->setVars($key, $value, true, 'UTF-8');
383  }
384  } catch (OdfException $e) {
385  dol_syslog($e->getMessage(), LOG_WARNING);
386  }
387  }
388 
389  // Replace labels translated
390  $tmparray = $outputlangs->get_translations_for_substitutions();
391  foreach ($tmparray as $key => $value) {
392  try {
393  $odfHandler->setVars($key, $value, true, 'UTF-8');
394  } catch (OdfException $e) {
395  dol_syslog($e->getMessage(), LOG_WARNING);
396  }
397  }
398 
399  // Call the beforeODTSave hook
400  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs);
401  $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
402 
403  // Write new file
404  if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
405  try {
406  $odfHandler->exportAsAttachedPDF($file);
407  } catch (Exception $e) {
408  $this->error = $e->getMessage();
409  dol_syslog($e->getMessage(), LOG_WARNING);
410  return -1;
411  }
412  } else {
413  try {
414  $odfHandler->saveToDisk($file);
415  } catch (Exception $e) {
416  $this->error = $e->getMessage();
417  dol_syslog($e->getMessage(), LOG_WARNING);
418  return -1;
419  }
420  }
421 
422  $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
423 
424  dolChmod($file);
425 
426  $odfHandler = null; // Destroy object
427 
428  $this->result = array('fullpath'=>$file);
429 
430  return 1; // Success
431  } else {
432  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
433  return -1;
434  }
435  }
436 
437  return -1;
438  }
439 
440  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
449  public function get_substitutionarray_object($object, $outputlangs, $array_key = 'object')
450  {
451  // phpcs:enable
452  if (!$object instanceof User) {
453  dol_syslog("Expected User object, got ".gettype($object), LOG_ERR);
454  return array();
455  }
456 
457  $array_other = array();
458  foreach ($object as $key => $value) {
459  if (!is_array($value) && !is_object($value)) {
460  $array_other[$array_key.'_'.$key] = $value;
461  }
462  }
463 
464  return $array_other;
465  }
466 }
if($user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition: card.php:58
get_substitutionarray_mysoc($mysoc, $outputlangs)
Define array with couple substitution key => substitution value.
get_substitutionarray_contact($object, $outputlangs, $array_key='object')
Define array with couple substitution key => substitution value.
get_substitutionarray_other($outputlangs)
Define array with couple substitution key => substitution value.
get_substitutionarray_thirdparty($object, $outputlangs, $array_key='company')
Define array with couple substitution key => substitution value For example {company_name},...
get_substitutionarray_user($user, $outputlangs)
Define array with couple substitution key => substitution value.
Class to manage generation of HTML components Only common components must be here.
Class to manage hooks.
Parent class to manage intervention document templates.
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Class to manage Dolibarr users.
Definition: user.class.php:50
Class to build documents using ODF templates generator.
write_file($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk using the generic odt module.
get_substitutionarray_object($object, $outputlangs, $array_key='object')
get substitution array for object
info($langs)
Return description of a module.
if($cancel &&! $id) if($action=='add' &&! $cancel) if($action=='delete') if($id) $form
Actions.
Definition: card.php:143
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition: files.lib.php:63
img_warning($titlealt='default', $moreatt='', $morecss='pictowarning')
Show warning logo.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
dolChmod($filepath, $newmask='')
Change mod of a file.
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
newToken()
Return the value of token currently saved into session with name 'newtoken'.
complete_substitutions_array(&$substitutionarray, $outputlangs, $object=null, $parameters=null, $callfunc="completesubstitutionarray")
Complete the $substitutionarray with more entries coming from external module that had set the "subst...
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition: repair.php:122
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:125
getMaxFileSizeArray()
Return the max allowed for file upload.