dolibarr  20.0.0-beta
doc_generic_ticket_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-2020 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/ticket/modules_ticket.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 = 'TICKET_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_multilang = 1; // Available in several languages
77  $this->option_freetext = 0; // Support add of a personalised text
78  $this->option_draft_watermark = 0; // Support add of a watermark on drafts
79 
80  // Get source company
81  $this->emetteur = $mysoc;
82  if (!$this->emetteur->country_code) {
83  $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
84  }
85  }
86 
87 
94  public function info($langs)
95  {
96  global $langs;
97 
98  // Load translation files required by the page
99  $langs->loadLangs(array('companies', 'errors'));
100 
101  $form = new Form($this->db);
102 
103  $texte = $this->description.".<br>\n";
104  $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
105  $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
106  $texte .= '<input type="hidden" name="page_y" value="">';
107  $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
108  $texte .= '<input type="hidden" name="param1" value="TICKET_ADDON_PDF_ODT_PATH">';
109 
110  $texte .= '<table class="nobordernopadding" width="100%">';
111 
112  // List of directories area
113  $texte .= '<tr><td>';
114  $texttitle = $langs->trans("ListOfDirectories");
115  $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim(getDolGlobalString('TICKET_ADDON_PDF_ODT_PATH'))));
116  $listoffiles = array();
117  foreach ($listofdir as $key => $tmpdir) {
118  $tmpdir = trim($tmpdir);
119  $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
120  if (!$tmpdir) {
121  unset($listofdir[$key]);
122  continue;
123  }
124  if (!is_dir($tmpdir)) {
125  $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), 0);
126  } else {
127  $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
128  if (count($tmpfiles)) {
129  $listoffiles = array_merge($listoffiles, $tmpfiles);
130  }
131  }
132  }
133  $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
134  $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
135  // Add list of substitution keys
136  $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
137  $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
138 
139  $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
140  $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
141  $texte .= '<textarea class="flat" cols="60" name="value1">';
142  $texte .= getDolGlobalString('TICKET_ADDON_PDF_ODT_PATH');
143  $texte .= '</textarea>';
144  $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
145  $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
146  $texte .= '<br></div></div>';
147 
148  // Scan directories
149  if (count($listofdir)) {
150  $texte .= $langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b>';
151 
152  $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
153  // Show list of found files
154  foreach ($listoffiles as $file) {
155  $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=tickets/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
156  $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=TICKET_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
157  $texte .= '<br>';
158  }
159  $texte .= '</div>';
160  }
161  // Add input to upload a new template file.
162  $texte .= '<div>'.$langs->trans("UploadNewTemplate");
163  $maxfilesizearray = getMaxFileSizeArray();
164  $maxmin = $maxfilesizearray['maxmin'];
165  if ($maxmin > 0) {
166  $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
167  }
168  $texte .= ' <input type="file" name="uploadfile">';
169  $texte .= '<input type="hidden" value="TICKET_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
170  $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
171  $texte .= '</div>';
172 
173  $texte .= '</td>';
174 
175  $texte .= '</tr>';
176 
177  $texte .= '</table>';
178  $texte .= '</form>';
179 
180  return $texte;
181  }
182 
183  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
195  public function write_file($object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
196  {
197  // phpcs:enable
198  global $user, $langs, $conf, $mysoc, $hookmanager;
199 
200  if (empty($srctemplatepath)) {
201  dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
202  return -1;
203  }
204 
205  // Add odtgeneration hook
206  if (!is_object($hookmanager)) {
207  include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
208  $hookmanager = new HookManager($this->db);
209  }
210  $hookmanager->initHooks(array('odtgeneration'));
211  global $action;
212 
213  if (!is_object($outputlangs)) {
214  $outputlangs = $langs;
215  }
216  $sav_charset_output = $outputlangs->charset_output;
217  $outputlangs->charset_output = 'UTF-8';
218 
219  // Load translation files required by the page
220  $outputlangs->loadLangs(array("main", "companies", "bills", "dict"));
221 
222  if ($conf->ticket->dir_output) {
223  // If $object is id instead of object
224  if (!is_object($object)) {
225  $id = $object;
226  $object = new User($this->db);
227  $result = $object->fetch($id);
228  if ($result < 0) {
229  dol_print_error($this->db, $object->error);
230  return -1;
231  }
232  }
233 
234  $object->fetch_thirdparty();
235 
236  $dir = $conf->ticket->dir_output;
237  $objectref = dol_sanitizeFileName($object->ref);
238  if (!preg_match('/specimen/i', $objectref)) {
239  $dir .= "/".$objectref;
240  }
241  $file = $dir."/".$objectref.".odt";
242 
243  if (!file_exists($dir)) {
244  if (dol_mkdir($dir) < 0) {
245  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
246  return -1;
247  }
248  }
249 
250  if (file_exists($dir)) {
251  //print "srctemplatepath=".$srctemplatepath; // Src filename
252  $newfile = basename($srctemplatepath);
253  $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
254  $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
255  $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
256 
257  $newfiletmp = $objectref . '_' . $newfiletmp;
258 
259  // Get extension (ods or odt)
260  $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
261  if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
262  $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
263  if ($format == '1') {
264  $format = '%Y%m%d%H%M%S';
265  }
266  $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
267  } else {
268  $filename = $newfiletmp . '.' . $newfileformat;
269  }
270  $file = $dir . '/' . $filename;
271  //print "newdir=".$dir;
272  //print "newfile=".$newfile;
273  //print "file=".$file;
274  //print "conf->ticket->dir_temp=".$conf->ticket->dir_temp;
275 
276  dol_mkdir($conf->ticket->dir_temp);
277  if (!is_writable($conf->ticket->dir_temp)) {
278  $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->ticket->dir_temp);
279  dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
280  return -1;
281  }
282 
283  // If CUSTOMER contact defined on user, we use it
284  $usecontact = false;
285  $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
286  if (count($arrayidcontact) > 0) {
287  $usecontact = true;
288  $result = $object->fetch_contact($arrayidcontact[0]);
289  }
290 
291  // Recipient name
292  if (!empty($usecontact)) {
293  // We can use the company of contact instead of thirdparty company
294  if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
295  $object->contact->fetch_thirdparty();
296  $socobject = $object->contact->thirdparty;
297  $contactobject = $object->contact;
298  } else {
299  $socobject = $object->thirdparty;
300  // if we have a CUSTOMER contact and we don't use it as thirdparty recipient we store the contact object for later use
301  $contactobject = $object->contact;
302  }
303  } else {
304  $socobject = $object->thirdparty;
305  }
306 
307  // Open and load template
308  require_once ODTPHP_PATH.'odf.php';
309  try {
310  $odfHandler = new Odf(
311  $srctemplatepath,
312  array(
313  'PATH_TO_TMP' => $conf->ticket->dir_temp,
314  'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
315  'DELIMITER_LEFT' => '{',
316  'DELIMITER_RIGHT' => '}'
317  )
318  );
319  } catch (Exception $e) {
320  $this->error = $e->getMessage();
321  dol_syslog($e->getMessage(), LOG_WARNING);
322  return -1;
323  }
324 
325  // Make substitutions into odt
326  $array_user = $this->get_substitutionarray_user($user, $outputlangs);
327  $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
328  $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
329  $array_other = $this->get_substitutionarray_other($outputlangs);
330  // retrieve contact information for use in object as contact_xxx tags
331  $array_thirdparty_contact = array();
332  if ($usecontact && is_object($contactobject)) {
333  $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
334  }
335 
336  $tmparray = array_merge($array_user, $array_soc, $array_thirdparty, $array_other, $array_thirdparty_contact);
337  complete_substitutions_array($tmparray, $outputlangs, $object);
338  $object->fetch_optionals();
339  // Call the ODTSubstitution hook
340  $parameters = array('file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
341  $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
342  foreach ($tmparray as $key => $value) {
343  try {
344  if (preg_match('/logo$/', $key)) { // Image
345  if (file_exists($value)) {
346  $odfHandler->setImage($key, $value);
347  } else {
348  $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
349  }
350  } else { // Text
351  $odfHandler->setVars($key, $value, true, 'UTF-8');
352  }
353  } catch (OdfException $e) {
354  dol_syslog($e->getMessage(), LOG_WARNING);
355  }
356  }
357 
358  // Replace labels translated
359  $tmparray = $outputlangs->get_translations_for_substitutions();
360  foreach ($tmparray as $key => $value) {
361  try {
362  $odfHandler->setVars($key, $value, true, 'UTF-8');
363  } catch (OdfException $e) {
364  dol_syslog($e->getMessage(), LOG_WARNING);
365  }
366  }
367 
368  // Call the beforeODTSave hook
369  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs);
370  $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
371 
372  // Write new file
373  if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
374  try {
375  $odfHandler->exportAsAttachedPDF($file);
376  } catch (Exception $e) {
377  $this->error = $e->getMessage();
378  dol_syslog($e->getMessage(), LOG_WARNING);
379  return -1;
380  }
381  } else {
382  try {
383  $odfHandler->saveToDisk($file);
384  } catch (Exception $e) {
385  $this->error = $e->getMessage();
386  dol_syslog($e->getMessage(), LOG_WARNING);
387  return -1;
388  }
389  }
390 
391  $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
392 
393  dolChmod($file);
394 
395  $odfHandler = null; // Destroy object
396 
397  $this->result = array('fullpath'=>$file);
398 
399  return 1; // Success
400  } else {
401  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
402  return -1;
403  }
404  }
405 
406  return -1;
407  }
408 
409  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
418  public function get_substitutionarray_object($object, $outputlangs, $array_key = 'object')
419  {
420  // phpcs:enable
421  if (!$object instanceof User) {
422  dol_syslog("Expected Ticket object, got ".gettype($object), LOG_ERR);
423  return array();
424  }
425 
426  $array_other = array();
427  foreach ($object as $key => $value) {
428  if (!is_array($value) && !is_object($value)) {
429  $array_other[$array_key.'_'.$key] = $value;
430  }
431  }
432 
433  return $array_other;
434  }
435 }
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 for documents models.
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.
info($langs)
Return description of a module.
get_substitutionarray_object($object, $outputlangs, $array_key='object')
get substitution array for object
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.
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:123
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:126
getMaxFileSizeArray()
Return the max allowed for file upload.