dolibarr 19.0.4
doc_generic_product_odt.modules.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2010-2012 Laurent Destailleur <eldy@products.sourceforge.net>
3 * Copyright (C) 2012 Juanjo Menent <jmenent@2byte.es>
4 * Copyright (C) 2018 Frédéric France <frederic.france@netlogic.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* or see https://www.gnu.org/
19*/
20
27require_once DOL_DOCUMENT_ROOT.'/core/modules/product/modules_product.class.php';
28require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
29require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
30require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
31require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
32require_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 $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 = 'PRODUCT_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 PRODUCT_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("errors", "companies"));
104
105 $form = new Form($this->db);
106
107 $texte = $this->description.".<br>\n";
108 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
109 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
110 $texte .= '<input type="hidden" name="page_y" value="">';
111 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
112 $texte .= '<input type="hidden" name="param1" value="PRODUCT_ADDON_PDF_ODT_PATH">';
113 $texte .= '<table class="nobordernopadding" width="100%">';
114
115 // List of directories area
116 $texte .= '<tr><td>';
117 $texttitle = $langs->trans("ListOfDirectories");
118 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim($conf->global->PRODUCT_ADDON_PDF_ODT_PATH)));
119 $listoffiles = array();
120 foreach ($listofdir as $key => $tmpdir) {
121 $tmpdir = trim($tmpdir);
122 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
123 if (!$tmpdir) {
124 unset($listofdir[$key]);
125 continue;
126 }
127 if (!is_dir($tmpdir)) {
128 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), 0);
129 } else {
130 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
131 if (count($tmpfiles)) {
132 $listoffiles = array_merge($listoffiles, $tmpfiles);
133 }
134 }
135 }
136 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
137 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
138 // Add list of substitution keys
139 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
140 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
141
142 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
143 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
144 $texte .= '<textarea class="flat" cols="60" name="value1">';
145 $texte .= getDolGlobalString('PRODUCT_ADDON_PDF_ODT_PATH');
146 $texte .= '</textarea>';
147 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
148 $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
149 $texte .= '<br></div></div>';
150
151 // Scan directories
152 $nbofiles = count($listoffiles);
153 if (getDolGlobalString('PRODUCT_ADDON_PDF_ODT_PATH')) {
154 $texte .= $langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b>';
155 }
156
157 if ($nbofiles) {
158 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
159 // Show list of found files
160 foreach ($listoffiles as $file) {
161 $texte .= '- '.$file['name'];
162 $texte .= ' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=products/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
163 $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=PRODUCT_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
164 $texte .= '<br>';
165 }
166 $texte .= '</div>';
167 }
168 // Add input to upload a new template file.
169 $texte .= '<div>'.$langs->trans("UploadNewTemplate");
170 $maxfilesizearray = getMaxFileSizeArray();
171 $maxmin = $maxfilesizearray['maxmin'];
172 if ($maxmin > 0) {
173 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
174 }
175 $texte .= ' <input type="file" name="uploadfile">';
176 $texte .= '<input type="hidden" value="PRODUCT_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
177 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
178 $texte .= '</div>';
179
180 $texte .= '</td>';
181
182 $texte .= '</tr>';
183
184 $texte .= '</table>';
185 $texte .= '</form>';
186
187 return $texte;
188 }
189
190 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
202 public function write_file($object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
203 {
204 // phpcs:enable
205 global $product, $langs, $conf, $mysoc, $hookmanager, $user;
206
207 if (empty($srctemplatepath)) {
208 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
209 return -1;
210 }
211
212 // Add odtgeneration hook
213 if (!is_object($hookmanager)) {
214 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
215 $hookmanager = new HookManager($this->db);
216 }
217 $hookmanager->initHooks(array('odtgeneration'));
218 global $action;
219
220 if (!is_object($outputlangs)) {
221 $outputlangs = $langs;
222 }
223 $sav_charset_output = $outputlangs->charset_output;
224 $outputlangs->charset_output = 'UTF-8';
225
226 // Load translation files required by the page
227 $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
228
229 if ($conf->product->dir_output) {
230 // If $object is id instead of object
231 if (!is_object($object)) {
232 $id = $object;
233 $object = new Product($this->db);
234 $result = $object->fetch($id);
235 if ($result < 0) {
236 dol_print_error($this->db, $object->error);
237 return -1;
238 }
239 }
240 $productFournisseur = new ProductFournisseur($this->db);
241 $supplierprices = $productFournisseur->list_product_fournisseur_price($object->id);
242 $object->supplierprices = $supplierprices;
243
244 $dir = $conf->product->dir_output;
245 $objectref = dol_sanitizeFileName($object->ref);
246 if (!preg_match('/specimen/i', $objectref)) {
247 $dir .= "/".$objectref;
248 }
249 $file = $dir."/".$objectref.".odt";
250
251 if (!file_exists($dir)) {
252 if (dol_mkdir($dir) < 0) {
253 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
254 return -1;
255 }
256 }
257
258 if (file_exists($dir)) {
259 //print "srctemplatepath=".$srctemplatepath; // Src filename
260 $newfile = basename($srctemplatepath);
261 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
262 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
263 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
264
265 $newfiletmp = $objectref . '_' . $newfiletmp;
266
267 // Get extension (ods or odt)
268 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
269 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
270 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
271 if ($format == '1') {
272 $format = '%Y%m%d%H%M%S';
273 }
274 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
275 } else {
276 $filename = $newfiletmp . '.' . $newfileformat;
277 }
278 $file = $dir . '/' . $filename;
279 //print "newdir=".$dir;
280 //print "newfile=".$newfile;
281 //print "file=".$file;
282 //print "conf->product->dir_temp=".$conf->product->dir_temp;
283
284 dol_mkdir($conf->product->dir_temp);
285 if (!is_writable($conf->product->dir_temp)) {
286 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->product->dir_temp);
287 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
288 return -1;
289 }
290
291 // If CUSTOMER contact defined on product, we use it
292 $usecontact = false;
293 $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
294 if (count($arrayidcontact) > 0) {
295 $usecontact = true;
296 $result = $object->fetch_contact($arrayidcontact[0]);
297 }
298
299 // Recipient name
300 $contactobject = null;
301 if (!empty($usecontact)) {
302 // We can use the company of contact instead of thirdparty company
303 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
304 $object->contact->fetch_thirdparty();
305 $socobject = $object->contact->thirdparty;
306 $contactobject = $object->contact;
307 } else {
308 $socobject = $object->thirdparty;
309 // if we have a CUSTOMER contact and we dont use it as thirdparty recipient we store the contact object for later use
310 $contactobject = $object->contact;
311 }
312 } else {
313 $socobject = $object->thirdparty;
314 }
315 // Make substitution
316 $substitutionarray = array(
317 '__FROM_NAME__' => $this->emetteur->name,
318 '__FROM_EMAIL__' => $this->emetteur->email,
319 '__TOTAL_TTC__' => $object->total_ttc,
320 '__TOTAL_HT__' => $object->total_ht,
321 '__TOTAL_VAT__' => $object->total_tva
322 );
323 complete_substitutions_array($substitutionarray, $langs, $object);
324 // Call the ODTSubstitution hook
325 $parameters = array('file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$substitutionarray);
326 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
327
328 // Line of free text
329 $newfreetext = '';
330 $paramfreetext = 'PRODUCT_FREE_TEXT';
331 if (!empty($conf->global->$paramfreetext)) {
332 $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
333 }
334
335 // Open and load template
336 require_once ODTPHP_PATH.'odf.php';
337 try {
338 $odfHandler = new Odf(
339 $srctemplatepath,
340 array(
341 'PATH_TO_TMP' => $conf->product->dir_temp,
342 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
343 'DELIMITER_LEFT' => '{',
344 'DELIMITER_RIGHT' => '}'
345 )
346 );
347 } catch (Exception $e) {
348 $this->error = $e->getMessage();
349 dol_syslog($e->getMessage(), LOG_INFO);
350 return -1;
351 }
352 // After construction $odfHandler->contentXml contains content and
353 // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
354 // [!-- BEGIN lines --]*[!-- END lines --]
355 //print html_entity_decode($odfHandler->__toString());
356 //print exit;
357
358
359 // Make substitutions into odt of freetext
360 try {
361 $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
362 } catch (OdfException $e) {
363 dol_syslog($e->getMessage(), LOG_INFO);
364 }
365
366 // Define substitution array
367 $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object);
368 $array_object_from_properties = $this->get_substitutionarray_each_var_object($object, $outputlangs);
369 //$array_objet=$this->get_substitutionarray_object($object,$outputlangs);
370 $array_user = $this->get_substitutionarray_user($user, $outputlangs);
371 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
372 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
373 $array_other = $this->get_substitutionarray_other($outputlangs);
374 // retrieve contact information for use in object as contact_xxx tags
375 $array_thirdparty_contact = array();
376 if ($usecontact && is_object($contactobject)) {
377 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
378 }
379
380 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_other, $array_thirdparty_contact);
381 complete_substitutions_array($tmparray, $outputlangs, $object);
382
383 // Call the ODTSubstitution hook
384 $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
385 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
386
387 foreach ($tmparray as $key => $value) {
388 try {
389 if (preg_match('/logo$/', $key)) { // Image
390 if (file_exists($value)) {
391 $odfHandler->setImage($key, $value);
392 } else {
393 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
394 }
395 } else { // Text
396 $odfHandler->setVars($key, $value, true, 'UTF-8');
397 }
398 } catch (OdfException $e) {
399 dol_syslog($e->getMessage(), LOG_INFO);
400 }
401 }
402 // Replace tags of lines
403 try {
404 $listlines = $odfHandler->setSegment('supplierprices');
405 if (!empty($object->supplierprices)) {
406 foreach ($object->supplierprices as $supplierprice) {
407 $array_lines = $this->get_substitutionarray_each_var_object($supplierprice, $outputlangs);
408 complete_substitutions_array($array_lines, $outputlangs, $object, $supplierprice, "completesubstitutionarray_lines");
409 // Call the ODTSubstitutionLine hook
410 $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$array_lines, 'line'=>$supplierprice);
411 $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
412 foreach ($array_lines as $key => $val) {
413 try {
414 $listlines->setVars($key, $val, true, 'UTF-8');
415 } catch (OdfException $e) {
416 dol_syslog($e->getMessage(), LOG_INFO);
417 } catch (SegmentException $e) {
418 dol_syslog($e->getMessage(), LOG_INFO);
419 }
420 }
421 $listlines->merge();
422 }
423 }
424 $odfHandler->mergeSegment($listlines);
425 } catch (OdfException $e) {
426 $this->error = $e->getMessage();
427 dol_syslog($this->error, LOG_WARNING);
428 return -1;
429 }
430
431 // Replace labels translated
432 $tmparray = $outputlangs->get_translations_for_substitutions();
433 foreach ($tmparray as $key => $value) {
434 try {
435 $odfHandler->setVars($key, $value, true, 'UTF-8');
436 } catch (OdfException $e) {
437 dol_syslog($e->getMessage(), LOG_INFO);
438 }
439 }
440
441 // Call the beforeODTSave hook
442 $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs);
443 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
444
445 // Write new file
446 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
447 try {
448 $odfHandler->exportAsAttachedPDF($file);
449 } catch (Exception $e) {
450 $this->error = $e->getMessage();
451 dol_syslog($e->getMessage(), LOG_INFO);
452 return -1;
453 }
454 } else {
455 try {
456 $odfHandler->saveToDisk($file);
457 } catch (Exception $e) {
458 $this->error = $e->getMessage();
459 dol_syslog($e->getMessage(), LOG_INFO);
460 return -1;
461 }
462 }
463
464 $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
465 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
466
467 dolChmod($file);
468
469 $odfHandler = null; // Destroy object
470
471 $this->result = array('fullpath'=>$file);
472
473 return 1; // Success
474 } else {
475 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
476 return -1;
477 }
478 }
479
480 return -1;
481 }
482}
get_substitutionarray_each_var_object(&$object, $outputlangs, $recursive=1)
Define array with couple substitution key => substitution value.
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.
Class to manage predefined suppliers products.
Class to manage products or services.
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.
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($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:62
img_warning($titlealt='default', $moreatt='', $morecss='pictowarning')
Show warning logo.
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs='', $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
dolChmod($filepath, $newmask='')
Change mod of a file.
dol_now($mode='auto')
Return date for now.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
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...
make_substitutions($text, $substitutionarray, $outputlangs=null, $converttextinhtmlifnecessary=0)
Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newva...
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
getCommonSubstitutionArray($outputlangs, $onlykey=0, $exclude=null, $object=null, $include=null)
Return array of possible common substitutions.
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:121
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:124
getMaxFileSizeArray()
Return the max allowed for file upload.