dolibarr 25.0.0-alpha
doc_generic_bom_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) 2014 Marcos García <marcosgdf@gmail.com>
5 * Copyright (C) 2016 Charlie Benke <charlie@patas-monkey.com>
6 * Copyright (C) 2018-2019 Philippe Grand <philippe.grand@atoo-net.com>
7 * Copyright (C) 2018-2024 Frédéric France <frederic.france@free.fr>
8 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 * or see https://www.gnu.org/
23 */
24
31require_once DOL_DOCUMENT_ROOT.'/core/modules/bom/modules_bom.php';
32require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
33require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
34require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
35require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
36require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
37
38
43{
48 public $phpmin = array(7, 0);
49
53 public $version = 'dolibarr';
54
55
61 public function __construct($db)
62 {
63 global $langs, $mysoc;
64
65 // Load translation files required by the page
66 $langs->loadLangs(array("main", "companies"));
67
68 $this->db = $db;
69 $this->name = "ODT templates";
70 $this->description = $langs->trans("DocumentModelOdt");
71 $this->scandir = 'BOM_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
72
73 // Page size for A4 format
74 $this->type = 'odt';
75 $this->page_largeur = 0;
76 $this->page_hauteur = 0;
77 $this->format = array($this->page_largeur, $this->page_hauteur);
78 $this->marge_gauche = 0;
79 $this->marge_droite = 0;
80 $this->marge_haute = 0;
81 $this->marge_basse = 0;
82
83 $this->option_multilang = 1; // Available in several languages
84 $this->option_freetext = 1; // Support add of a personalised text
85 $this->option_draft_watermark = 0; // Support add of a watermark on drafts
86
87 if ($mysoc === null) {
88 dol_syslog(get_class($this).'::__construct() Global $mysoc should not be null.'. getCallerInfoString(), LOG_ERR);
89 return;
90 }
91 // Get source company
92 $this->emetteur = $mysoc;
93 if (!$this->emetteur->country_code) {
94 $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
95 }
96 }
97
98
105 public function info($langs)
106 {
107 global $langs;
108
109 // Load translation files required by the page
110 $langs->loadLangs(array("errors", "companies"));
111
112 $form = new Form($this->db);
113
114 $odtPath = trim(getDolGlobalString('BOM_ADDON_PDF_ODT_PATH'));
115
116 $texte = $this->description.".<br>\n";
117 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
118 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
119 $texte .= '<input type="hidden" name="page_y" value="">';
120 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
121 $texte .= '<input type="hidden" name="param1" value="BOM_ADDON_PDF_ODT_PATH">';
122
123 $texte .= '<table class="nobordernopadding centpercent">';
124
125 // List of directories area
126 $texte .= '<tr><td>';
127 $texttitle = $langs->trans("ListOfDirectories");
128 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', $odtPath));
129 $listoffiles = array();
130 foreach ($listofdir as $key => $tmpdir) {
131 $tmpdir = trim($tmpdir);
132 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
133 if (!$tmpdir) {
134 unset($listofdir[$key]);
135 continue;
136 }
137 if (!is_dir($tmpdir)) {
138 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), '');
139 } else {
140 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
141 if (count($tmpfiles)) {
142 $listoffiles = array_merge($listoffiles, $tmpfiles);
143 }
144 }
145 }
146 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
147 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
148 // Add list of substitution keys
149 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
150 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
151
152 // Scan directories
153 $nbofiles = count($listoffiles);
154 if ($odtPath) {
155 $texte .= '<span class="opacitylow">'.$langs->trans("NumberOfModelFilesFound").': <b>';
156 //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
157 $texte .= count($listoffiles);
158 //$texte.=$nbofiles?'</a>':'';
159 $texte .= '</b></span><br>';
160 }
161
162 if ($nbofiles) {
163 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx opacitylow">';
164 // Show list of found files
165 foreach ($listoffiles as $file) {
166 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=boms/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
167 $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=BOM_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
168 $texte .= '<br>';
169 }
170 $texte .= '</div>';
171 }
172
173 $texte .= '<br>';
174 // Link to show/hide the area to manage directories of ODT models and template files
175 $texte .= '<span class="classlink cursorpointer" onclick="javascript: jQuery(\'.div_odtmodelsof'.get_class($this).'\').toggle();">'.img_picto('', 'add').' '.$langs->trans("UploadNewTemplate").'...</span>';
176 $texte .= '<div class="div_odtmodelsof'.get_class($this).'" style="display: none; margin-top: 6px;">';
177 if (!getDolGlobalString('MAIN_NO_MULTIDIR_FOR_ODT')) {
178 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
179 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
180 $texte .= '<textarea class="flat textareafordir" spellcheck="false" cols="60" name="value1">';
181 $texte .= $odtPath;
182 $texte .= '</textarea>';
183 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
184 $texte .= '<input type="submit" class="button button-edit smallpaddingimp reposition" name="modify" value="'.dolPrintHTMLForAttribute($langs->trans("Modify")).'">';
185 $texte .= '<br></div></div>';
186 } else {
187 $texte .= '<br>';
188 $texte .= '<input type="hidden" name="value1" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH">';
189 }
190
191 // Add input to upload a new template file.
192 $texte .= '<div>';
193 $maxfilesizearray = getMaxFileSizeArray();
194 $maxmin = $maxfilesizearray['maxmin'];
195 if ($maxmin > 0) {
196 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
197 }
198 $texte .= ' <input type="file" name="uploadfile">';
199 $texte .= '<input type="hidden" value="BOM_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
200 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
201 $texte .= '</div>';
202 $texte .= '</div>';
203
204 $texte .= '</td>';
205
206 $texte .= '</tr>';
207
208 $texte .= '</table>';
209 $texte .= '</form>';
210
211 return $texte;
212 }
213
214 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
226 public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
227 {
228 // phpcs:enable
229 global $user, $langs, $conf, $mysoc, $hookmanager;
230 global $action;
231
232 if (empty($srctemplatepath)) {
233 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
234 return -1;
235 }
236
237 // Add odtgeneration hook
238 if (!is_object($hookmanager)) {
239 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
240 $hookmanager = new HookManager($this->db);
241 }
242 $hookmanager->initHooks(array('odtgeneration'));
243 global $action;
244
245 if (!is_object($outputlangs)) {
246 $outputlangs = $langs;
247 }
248 $sav_charset_output = $outputlangs->charset_output;
249 $outputlangs->charset_output = 'UTF-8';
250
251 $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
252
253 if ($conf->bom->dir_output) {
254 // If $object is id instead of object
255 if (!is_object($object)) {
256 $id = $object;
257 $object = new BOM($this->db);
258 $result = $object->fetch($id);
259 if ($result < 0) {
260 dol_print_error($this->db, $object->error);
261 return -1;
262 }
263 }
264
265 $object->fetch_thirdparty();
266 $object->fetch_product();
267 $object->calculateCosts();
268
269 $dir = $conf->bom->multidir_output[isset($object->entity) ? $object->entity : 1];
270 $objectref = dol_sanitizeFileName($object->ref);
271 if (!preg_match('/specimen/i', $objectref)) {
272 $dir .= "/".$objectref;
273 }
274 $file = $dir."/".$objectref.".odt";
275
276 if (!file_exists($dir)) {
277 if (dol_mkdir($dir) < 0) {
278 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
279 return -1;
280 }
281 }
282
283 if (file_exists($dir)) {
284 // print "srctemplatepath=".$srctemplatepath; // Src filename
285 $newfile = basename($srctemplatepath);
286 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
287 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
288 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
289 $newfiletmp = $objectref . '_' . $newfiletmp;
290 // $file=$dir.'/'.$newfiletmp.'.'.dol_print_date(dol_now(),'%Y%m%d%H%M%S').'.odt';
291 // Get extension (ods or odt)
292 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
293 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
294 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
295 if ($format == '1') {
296 $format = '%Y%m%d%H%M%S';
297 }
298 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
299 } else {
300 $filename = $newfiletmp . '.' . $newfileformat;
301 }
302 $file = $dir . '/' . $filename;
303
304 dol_mkdir($conf->bom->dir_temp);
305 if (!is_writable($conf->bom->dir_temp)) {
306 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->bom->dir_temp);
307 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
308 return -1;
309 }
310
311 // If CUSTOMER contact defined on object, we use it
312 $usecontact = false;
313 $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
314 if (count($arrayidcontact) > 0) {
315 $usecontact = true;
316 $result = $object->fetch_contact($arrayidcontact[0]);
317 }
318
319 // Recipient name
320 $contactobject = null;
321 if (!empty($usecontact)) {
322 // We can use the company of contact instead of thirdparty company
323 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
324 $object->contact->fetch_thirdparty();
325 $socobject = $object->contact->thirdparty;
326 $contactobject = $object->contact;
327 } else {
328 $socobject = $object->thirdparty;
329 // if we have a CUSTOMER contact and we don't use it as thirdparty recipient we store the contact object for later use
330 $contactobject = $object->contact;
331 }
332 } else {
333 $socobject = $object->thirdparty;
334 }
335
336 // Make substitution
337 $substitutionarray = array(
338 '__QTY_TO_PRODUCE__' => $object->qty,
339 );
340 complete_substitutions_array($substitutionarray, $langs, $object);
341 // Call the ODTSubstitution hook
342 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$substitutionarray);
343 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
344
345 // Line of free text
346 $newfreetext = '';
347 $paramfreetext = 'BOM_FREE_TEXT';
348 if (getDolGlobalString($paramfreetext)) {
349 $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
350 }
351
352 // Open and load template
353 require_once ODTPHP_PATH.'odf.php';
354 try {
355 $odfHandler = new Odf(
356 $srctemplatepath,
357 array(
358 'PATH_TO_TMP' => $conf->bom->dir_temp,
359 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
360 'DELIMITER_LEFT' => '{',
361 'DELIMITER_RIGHT' => '}'
362 )
363 );
364 } catch (Exception $e) {
365 $this->error = $e->getMessage();
366 dol_syslog($e->getMessage(), LOG_INFO);
367 return -1;
368 }
369 // After construction $odfHandler->contentXml contains content and
370 // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
371 // [!-- BEGIN lines --]*[!-- END lines --]
372
373 // Make substitutions into odt of freetext
374 try {
375 $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
376 } catch (OdfException $e) {
377 dol_syslog($e->getMessage(), LOG_INFO);
378 }
379
380 // Define substitution array
381 $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object);
382 $array_object_from_properties = $this->get_substitutionarray_each_var_object($object, $outputlangs);
383 $array_objet = $this->get_substitutionarray_object($object, $outputlangs);
384 $array_user = $this->get_substitutionarray_user($user, $outputlangs);
385 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
386 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
387 $array_other = $this->get_substitutionarray_other($outputlangs);
388 // retrieve contact information for use in object as contact_xxx tags
389 $array_thirdparty_contact = array();
390 if ($usecontact && is_object($contactobject)) {
391 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
392 }
393
394 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_other, $array_thirdparty_contact);
395 complete_substitutions_array($tmparray, $outputlangs, $object);
396
397 // Call the ODTSubstitution hook
398 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
399 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
400
401 // retrieve the constant to apply a ratio for image size or set the ratio to 1
402 if (getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO')) {
403 $ratio = (float) getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO');
404 } else {
405 $ratio = 1;
406 }
407
408 foreach ($tmparray as $key => $value) {
409 try {
410 if (preg_match('/logo$/', $key)) {
411 // Image
412 if (file_exists($value)) {
413 $odfHandler->setImage($key, $value, $ratio);
414 } else {
415 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
416 }
417 } else {
418 // Text
419 $odfHandler->setVars($key, $value, true, 'UTF-8');
420 }
421 } catch (OdfException $e) {
422 dol_syslog($e->getMessage(), LOG_INFO);
423 }
424 }
425 // Replace tags of lines
426 $foundtagforlines = 1;
427 try {
428 $listlines = $odfHandler->setSegment('lines');
429 } catch (OdfExceptionSegmentNotFound $e) {
430 // We may arrive here if tags for lines not present into template
431 $foundtagforlines = 0;
432 dol_syslog($e->getMessage(), LOG_INFO);
433 }
434 if ($foundtagforlines) {
435 $linenumber = 0;
436 foreach ($object->lines as $line) {
438 $linenumber++;
439
440 if ($line->fk_product > 0) {
441 $line->fetch_product();
442
443 $line->product_ref = $line->product->ref;
444 $line->product_desc = $line->product->description;
445 $line->product_label = $line->product->label;
446 $line->product_type = $line->product->type;
447 $line->product_barcode = $line->product->barcode;
448 }
449
450 $tmparray = $this->get_substitutionarray_lines($line, $outputlangs, $linenumber);
451 complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
452 // Call the ODTSubstitutionLine hook
453 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray, 'line' => $line);
454 $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
455 foreach ($tmparray as $key => $val) {
456 try {
457 $listlines->setVars($key, $val, true, 'UTF-8');
458 } catch (SegmentException $e) {
459 dol_syslog($e->getMessage(), LOG_INFO);
460 }
461 }
462 $listlines->merge();
463 }
464 try {
465 $odfHandler->mergeSegment($listlines);
466 } catch (OdfException $e) {
467 $this->error = $e->getMessage();
468 dol_syslog($this->error, LOG_WARNING);
469 return -1;
470 }
471 }
472
473 // Replace labels translated
474 $tmparray = $outputlangs->get_translations_for_substitutions();
475 foreach ($tmparray as $key => $value) {
476 try {
477 $odfHandler->setVars($key, $value, true, 'UTF-8');
478 } catch (OdfException $e) {
479 dol_syslog($e->getMessage(), LOG_INFO);
480 }
481 }
482
483 // Call the beforeODTSave hook
484 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
485 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
486
487 // Write new file
488 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
489 try {
490 $odfHandler->exportAsAttachedPDF($file);
491 } catch (Exception $e) {
492 $this->error = $e->getMessage();
493 dol_syslog($e->getMessage(), LOG_INFO);
494 return -1;
495 }
496 } else {
497 try {
498 $odfHandler->saveToDisk($file);
499 } catch (Exception $e) {
500 $this->error = $e->getMessage();
501 dol_syslog($e->getMessage(), LOG_INFO);
502 return -1;
503 }
504 }
505
506 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
507 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
508
509 dolChmod($file);
510
511 $odfHandler = null; // Destroy object
512
513 $this->result = array('fullpath' => $file);
514
515 return 1; // Success
516 } else {
517 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
518 return -1;
519 }
520 }
521
522 return -1;
523 }
524}
$propal type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition propal.php:281
Class to manage generation of HTML components Only common components must be here.
Parent class for boms models.
Class to build documents using ODF templates generator.
info($langs)
Return description of a module.
write_file($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk using the generic odt module.
global $mysoc
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after 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:66
getCallerInfoString()
Get caller info as a string that can be appended to a log message.
newToken()
Return the value of token currently saved into session with name 'newtoken'.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:165
multi select button
0 = Do not include form tag and submit button -1 = Do not include form tag but include submit button