dolibarr 25.0.0-alpha
doc_generic_stock_odt.modules.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2010-2012 Laurent Destailleur <eldy@stocks.sourceforge.net>
3 * Copyright (C) 2012 Juanjo Menent <jmenent@2byte.es>
4 * Copyright (C) 2018-2024 Frédéric France <frederic.france@free.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
28require_once DOL_DOCUMENT_ROOT.'/core/modules/stock/modules_stock.php';
29require_once DOL_DOCUMENT_ROOT.'/product/stock/class/entrepot.class.php';
30require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
31require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
32require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
33require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
34
35
40{
44 public $version = 'dolibarr';
45
46
52 public function __construct($db)
53 {
54 global $conf, $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 = 'STOCK_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 STOCK_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 if ($mysoc === null) {
85 dol_syslog(get_class($this).'::__construct() Global $mysoc should not be null.'. getCallerInfoString(), LOG_ERR);
86 return;
87 }
88
89 // Get source company
90 $this->emetteur = $mysoc;
91 if (!$this->emetteur->country_code) {
92 $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
93 }
94 }
95
96
103 public function info($langs)
104 {
105 global $conf, $langs;
106
107 // Load translation files required by the page
108 $langs->loadLangs(array("errors", "companies"));
109
110 $form = new Form($this->db);
111
112 $texte = $this->description.".<br>\n";
113 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
114 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
115 $texte .= '<input type="hidden" name="page_y" value="">';
116 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
117 $texte .= '<input type="hidden" name="param1" value="STOCK_ADDON_PDF_ODT_PATH">';
118 $texte .= '<table class="nobordernopadding" width="100%">';
119
120 // List of directories area
121 $texte .= '<tr><td>';
122 $texttitle = $langs->trans("ListOfDirectories");
123 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim(getDolGlobalString('STOCK_ADDON_PDF_ODT_PATH'))));
124 $listoffiles = array();
125 foreach ($listofdir as $key => $tmpdir) {
126 $tmpdir = trim($tmpdir);
127 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
128 if (!$tmpdir) {
129 unset($listofdir[$key]);
130 continue;
131 }
132 if (!is_dir($tmpdir)) {
133 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), '');
134 } else {
135 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
136 if (count($tmpfiles)) {
137 $listoffiles = array_merge($listoffiles, $tmpfiles);
138 }
139 }
140 }
141 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
142 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
143 // Add list of substitution keys
144 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
145 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
146
147 // Scan directories
148 $nbofiles = count($listoffiles);
149 if (getDolGlobalString('STOCK_ADDON_PDF_ODT_PATH')) {
150 $texte .= '<span class="opacitylow">'.$langs->trans("NumberOfModelFilesFound").': <b>';
151 //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
152 $texte .= count($listoffiles);
153 //$texte.=$nbofiles?'</a>':'';
154 $texte .= '</b></span><br>';
155 }
156
157 if ($nbofiles) {
158 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx opacitylow">';
159 // Show list of found files
160 foreach ($listoffiles as $file) {
161 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=stocks/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
162 $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=STOCK_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
163 $texte .= '<br>';
164 }
165 $texte .= '</div>';
166 }
167 $texte .= '<br>';
168 // Link to show/hide the area to manage directories of ODT models and template files
169 $texte .= '<span class="classlink cursorpointer" onclick="javascript: jQuery(\'.div_odtmodelsof'.get_class($this).'\').toggle();">'.img_picto('', 'add').' '.$langs->trans("UploadNewTemplate").'...</span>';
170 $texte .= '<div class="div_odtmodelsof'.get_class($this).'" style="display: none; margin-top: 6px;">';
171 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
172 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
173 $texte .= '<textarea class="flat textareafordir" spellcheck="false" cols="60" name="value1">';
174 $texte .= getDolGlobalString('STOCK_ADDON_PDF_ODT_PATH');
175 $texte .= '</textarea>';
176 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
177 $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
178 $texte .= '<br></div></div>';
179 $texte .= '</div>';
180
181 // Add input to upload a new template file.
182 $texte .= '<div class="div_odtmodelsof'.get_class($this).'" style="display: none;">';
183 $maxfilesizearray = getMaxFileSizeArray();
184 $maxmin = $maxfilesizearray['maxmin'];
185 if ($maxmin > 0) {
186 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
187 }
188 $texte .= ' <input type="file" name="uploadfile">';
189 $texte .= '<input type="hidden" value="STOCK_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
190 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
191 $texte .= '</div>';
192
193 $texte .= '</td>';
194
195 $texte .= '</tr>';
196
197 $texte .= '</table>';
198 $texte .= '</form>';
199
200 return $texte;
201 }
202
203 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
215 public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
216 {
217 // phpcs:enable
218 global $stock, $langs, $conf, $mysoc, $hookmanager, $user;
219
220 if (empty($srctemplatepath)) {
221 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
222 return -1;
223 }
224
225 // Add odtgeneration hook
226 if (!is_object($hookmanager)) {
227 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
228 $hookmanager = new HookManager($this->db);
229 }
230 $hookmanager->initHooks(array('odtgeneration'));
231 global $action;
232
233 if (!is_object($outputlangs)) {
234 $outputlangs = $langs;
235 }
236 $sav_charset_output = $outputlangs->charset_output;
237 $outputlangs->charset_output = 'UTF-8';
238
239 // Load translation files required by the page
240 $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
241
242 if ($conf->product->dir_output) {
243 // If $object is id instead of object
244 if (!is_object($object)) {
245 $id = $object;
246 $object = new Entrepot($this->db);
247 $result = $object->fetch($id);
248 if ($result < 0) {
249 dol_print_error($this->db, $object->error);
250 return -1;
251 }
252 }
253
254 $stockFournisseur = new ProductFournisseur($this->db);
255 $supplierprices = $stockFournisseur->list_stock_fournisseur_price($object->id);
256
257 $dir = $conf->product->dir_output;
258 $objectref = dol_sanitizeFileName($object->ref);
259 if (!preg_match('/specimen/i', $objectref)) {
260 $dir .= "/".$objectref;
261 }
262 $file = $dir."/".$objectref.".odt";
263
264 if (!file_exists($dir)) {
265 if (dol_mkdir($dir) < 0) {
266 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
267 return -1;
268 }
269 }
270
271 if (file_exists($dir)) {
272 //print "srctemplatepath=".$srctemplatepath; // Src filename
273 $newfile = basename($srctemplatepath);
274 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
275 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
276 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
277
278 $newfiletmp = $objectref . '_' . $newfiletmp;
279
280 // Get extension (ods or odt)
281 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
282 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
283 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
284 if ($format == '1') {
285 $format = '%Y%m%d%H%M%S';
286 }
287 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
288 } else {
289 $filename = $newfiletmp . '.' . $newfileformat;
290 }
291 $file = $dir . '/' . $filename;
292
293 dol_mkdir($conf->product->dir_temp);
294 if (!is_writable($conf->product->dir_temp)) {
295 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->product->dir_temp);
296 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
297 return -1;
298 }
299
300 // If CUSTOMER contact defined on stock, we use it
301 $usecontact = false;
302 $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
303 if (count($arrayidcontact) > 0) {
304 $usecontact = true;
305 $result = $object->fetch_contact($arrayidcontact[0]);
306 }
307
308 // Recipient name
309 $contactobject = null;
310 if (!empty($usecontact)) {
311 // We can use the company of contact instead of thirdparty company
312 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
313 $object->contact->fetch_thirdparty();
314 $socobject = $object->contact->thirdparty;
315 $contactobject = $object->contact;
316 } else {
317 $socobject = $object->thirdparty;
318 // if we have a CUSTOMER contact and we don't use it as thirdparty recipient we store the contact object for later use
319 $contactobject = $object->contact;
320 }
321 } else {
322 $socobject = $object->thirdparty;
323 }
324 // Make substitution
325 $substitutionarray = array(
326 '__FROM_NAME__' => $this->emetteur->name,
327 '__FROM_EMAIL__' => $this->emetteur->email,
328 '__TOTAL_TTC__' => $object->total_ttc,
329 '__TOTAL_HT__' => $object->total_ht,
330 '__TOTAL_VAT__' => $object->total_tva
331 );
332 complete_substitutions_array($substitutionarray, $langs, $object);
333 // Call the ODTSubstitution hook
334 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$substitutionarray);
335 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
336
337 // Line of free text
338 $newfreetext = '';
339 $paramfreetext = 'stock_FREE_TEXT';
340 if (getDolGlobalString($paramfreetext)) {
341 $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
342 }
343
344 // Open and load template
345 require_once ODTPHP_PATH.'odf.php';
346 try {
347 $odfHandler = new Odf(
348 $srctemplatepath,
349 array(
350 'PATH_TO_TMP' => $conf->product->dir_temp,
351 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
352 'DELIMITER_LEFT' => '{',
353 'DELIMITER_RIGHT' => '}'
354 )
355 );
356 } catch (Exception $e) {
357 $this->error = $e->getMessage();
358 dol_syslog($e->getMessage(), LOG_INFO);
359 return -1;
360 }
361 // After construction $odfHandler->contentXml contains content and
362 // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
363 // [!-- BEGIN lines --]*[!-- END lines --]
364
365 $object->fetch_optionals();
366
367 // Make substitutions into odt of freetext
368 try {
369 $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
370 } catch (OdfException $e) {
371 dol_syslog($e->getMessage(), LOG_INFO);
372 }
373
374 // Define substitution array
375 $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object);
376 $array_object_from_properties = $this->get_substitutionarray_each_var_object($object, $outputlangs);
377 //$array_objet = $this->get_substitutionarray_object($object,$outputlangs);
378 $array_user = $this->get_substitutionarray_user($user, $outputlangs);
379 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
380 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
381 $array_other = $this->get_substitutionarray_other($outputlangs);
382 // retrieve contact information for use in stock as contact_xxx tags
383 $array_thirdparty_contact = array();
384 if ($usecontact && is_object($contactobject)) {
385 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
386 }
387
388 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_other, $array_thirdparty_contact);
389 complete_substitutions_array($tmparray, $outputlangs, $object);
390
391 // Call the ODTSubstitution hook
392 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
393 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
394
395 // retrieve the constant to apply a ratio for image size or set the ratio to 1
396 if (getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO')) {
397 $ratio = (float) getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO');
398 } else {
399 $ratio = 1;
400 }
401
402 foreach ($tmparray as $key => $value) {
403 try {
404 if (preg_match('/logo$/', $key)) { // Image
405 if (file_exists($value)) {
406 $odfHandler->setImage($key, $value, $ratio);
407 } else {
408 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
409 }
410 } else { // Text
411 $odfHandler->setVars($key, $value, true, 'UTF-8');
412 }
413 } catch (OdfException $e) {
414 dol_syslog($e->getMessage(), LOG_INFO);
415 }
416 }
417 // Replace tags of lines
418 $foundtagforlines = 1;
419 try {
420 $listlines = $odfHandler->setSegment('supplierprices');
421 } catch (OdfExceptionSegmentNotFound $e) {
422 // We may arrive here if tags for lines not present into template
423 $foundtagforlines = 0;
424 dol_syslog($e->getMessage(), LOG_INFO);
425 }
426 if ($foundtagforlines && !empty($supplierprices)) {
427 foreach ($supplierprices as $supplierprice) {
428 $array_lines = $this->get_substitutionarray_each_var_object($supplierprice, $outputlangs);
429 complete_substitutions_array($array_lines, $outputlangs, $object, $supplierprice, "completesubstitutionarray_lines");
430 // Call the ODTSubstitutionLine hook
431 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$array_lines, 'line' => $supplierprice);
432 $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
433 foreach ($array_lines as $key => $val) {
434 try {
435 $listlines->setVars($key, $val, true, 'UTF-8');
436 } catch (SegmentException $e) {
437 dol_syslog($e->getMessage(), LOG_INFO);
438 }
439 }
440 $listlines->merge();
441 }
442 try {
443 $odfHandler->mergeSegment($listlines);
444 } catch (OdfException $e) {
445 $this->error = $e->getMessage();
446 dol_syslog($this->error, LOG_WARNING);
447 return -1;
448 }
449 }
450
451 // Replace labels translated
452 $tmparray = $outputlangs->get_translations_for_substitutions();
453 foreach ($tmparray as $key => $value) {
454 try {
455 $odfHandler->setVars($key, $value, true, 'UTF-8');
456 } catch (OdfException $e) {
457 dol_syslog($e->getMessage(), LOG_INFO);
458 }
459 }
460
461 // Call the beforeODTSave hook
462 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs);
463 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
464
465 // Write new file
466 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
467 try {
468 $odfHandler->exportAsAttachedPDF($file);
469 } catch (Exception $e) {
470 $this->error = $e->getMessage();
471 dol_syslog($e->getMessage(), LOG_INFO);
472 return -1;
473 }
474 } else {
475 try {
476 $odfHandler->saveToDisk($file);
477 } catch (Exception $e) {
478 $this->error = $e->getMessage();
479 dol_syslog($e->getMessage(), LOG_INFO);
480 return -1;
481 }
482 }
483
484 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
485
486 dolChmod($file);
487
488 $odfHandler = null; // Destroy object
489
490 $this->result = array('fullpath' => $file);
491
492 return 1; // Success
493 } else {
494 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
495 return -1;
496 }
497 }
498
499 return -1;
500 }
501}
$propal type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition propal.php:281
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
Class to manage generation of HTML components Only common components must be here.
Parent class for stock models of doc generators.
write_file($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk using the generic odt module.
Class to build documents using ODF templates generator.
info($langs)
Return description of a 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