dolibarr  9.0.0
doc_generic_contract_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 Ferran Marcet <fmarcet@2byte.es>
5  * Copyright (C) 2018 Frédéric France <frederic.france@netlogic.fr>
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 <http://www.gnu.org/licenses/>.
19 * or see http://www.gnu.org/
20 */
21 
28 require_once DOL_DOCUMENT_ROOT.'/core/modules/contract/modules_contract.php';
29 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
30 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
31 require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
32 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
33 require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
34 
35 
40 {
45  public $emetteur;
46 
51  public $phpmin = array(5, 4);
52 
57  public $version = 'dolibarr';
58 
59 
65  function __construct($db)
66  {
67  global $conf, $langs, $mysoc;
68 
69  // Load translation files required by the page
70  $langs->loadLangs(array("main","companies"));
71 
72  $this->db = $db;
73  $this->name = "ODT templates";
74  $this->description = $langs->trans("DocumentModelOdt");
75  $this->scandir = 'CONTRACT_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
76 
77  // Dimension page pour format A4
78  $this->type = 'odt';
79  $this->page_largeur = 0;
80  $this->page_hauteur = 0;
81  $this->format = array($this->page_largeur,$this->page_hauteur);
82  $this->marge_gauche=0;
83  $this->marge_droite=0;
84  $this->marge_haute=0;
85  $this->marge_basse=0;
86 
87  $this->option_logo = 1; // Affiche logo
88  $this->option_tva = 0; // Gere option tva CONTRACT_TVAOPTION
89  $this->option_modereg = 0; // Affiche mode reglement
90  $this->option_condreg = 0; // Affiche conditions reglement
91  $this->option_codeproduitservice = 0; // Affiche code produit-service
92  $this->option_multilang = 1; // Dispo en plusieurs langues
93  $this->option_escompte = 0; // Affiche si il y a eu escompte
94  $this->option_credit_note = 0; // Support credit notes
95  $this->option_freetext = 1; // Support add of a personalised text
96  $this->option_draft_watermark = 0; // Support add of a watermark on drafts
97 
98  // Recupere emetteur
99  $this->emetteur=$mysoc;
100  if (! $this->emetteur->country_code) $this->emetteur->country_code=substr($langs->defaultlang,-2); // By default if not defined
101  }
102 
103 
110  function info($langs)
111  {
112  global $conf,$langs;
113 
114  // Load translation files required by the page
115  $langs->loadLangs(array('companies', 'errors'));
116 
117  $form = new Form($this->db);
118 
119  $texte = $this->description.".<br>\n";
120  $texte.= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
121  $texte.= '<input type="hidden" name="token" value="'.$_SESSION['newtoken'].'">';
122  $texte.= '<input type="hidden" name="action" value="setModuleOptions">';
123  $texte.= '<input type="hidden" name="param1" value="CONTRACT_ADDON_PDF_ODT_PATH">';
124  $texte.= '<table class="nobordernopadding" width="100%">';
125 
126  // List of directories area
127  $texte.= '<tr><td>';
128  $texttitle=$langs->trans("ListOfDirectories");
129  $listofdir=explode(',',preg_replace('/[\r\n]+/',',',trim($conf->global->CONTRACT_ADDON_PDF_ODT_PATH)));
130  $listoffiles=array();
131  foreach($listofdir as $key=>$tmpdir)
132  {
133  $tmpdir=trim($tmpdir);
134  $tmpdir=preg_replace('/DOL_DATA_ROOT/',DOL_DATA_ROOT,$tmpdir);
135  if (! $tmpdir) {
136  unset($listofdir[$key]); continue;
137  }
138  if (! is_dir($tmpdir)) $texttitle.=img_warning($langs->trans("ErrorDirNotFound",$tmpdir),0);
139  else
140  {
141  $tmpfiles=dol_dir_list($tmpdir,'files',0,'\.(ods|odt)');
142  if (count($tmpfiles)) $listoffiles=array_merge($listoffiles,$tmpfiles);
143  }
144  }
145  $texthelp=$langs->trans("ListOfDirectoriesForModelGenODT");
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);
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.=$conf->global->CONTRACT_ADDON_PDF_ODT_PATH;
154  $texte.= '</textarea>';
155  $texte.= '</div><div style="display: inline-block; vertical-align: middle;">';
156  $texte.= '<input type="submit" class="button" value="'.dol_escape_htmltag($langs->trans("Modify")).'" name="Button">';
157  $texte.= '<br></div></div>';
158 
159  // Scan directories
160  if (count($listofdir))
161  {
162  $texte.=$langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b>';
163  }
164 
165  // Add select to upload a new template file. TODO Copy this feature on other admin pages.
166  $texte.= '<div>'.$langs->trans("UploadNewTemplate").' <input type="file" name="uploadfile">';
167  $texte.= '<input type="hidden" value="CONTRACT_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
168  $texte.= '<input type="submit" class="button" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
169  $texte.= '</div>';
170 
171  $texte.= '</td>';
172 
173  $texte.= '<td valign="top" rowspan="2" class="hideonsmartphone">';
174  $texte.= $langs->trans("ExampleOfDirectoriesForModelGen");
175  $texte.= '</td>';
176  $texte.= '</tr>';
177 
178  $texte.= '</table>';
179  $texte.= '</form>';
180 
181  return $texte;
182  }
183 
184  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps
196  function write_file($object,$outputlangs,$srctemplatepath,$hidedetails=0,$hidedesc=0,$hideref=0)
197  {
198  // phpcs:enable
199  global $user,$langs,$conf,$mysoc,$hookmanager;
200 
201  if (empty($srctemplatepath))
202  {
203  dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
204  return -1;
205  }
206 
207  // Add odtgeneration hook
208  if (! is_object($hookmanager))
209  {
210  include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
211  $hookmanager=new HookManager($this->db);
212  }
213  $hookmanager->initHooks(array('odtgeneration'));
214  global $action;
215 
216  if (! is_object($outputlangs)) $outputlangs=$langs;
217  $sav_charset_output=$outputlangs->charset_output;
218  $outputlangs->charset_output='UTF-8';
219 
220  // Load traductions files requiredby by page
221  $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
222 
223  if ($conf->contrat->dir_output)
224  {
225  // If $object is id instead of object
226  if (! is_object($object))
227  {
228  $id = $object;
229  $object = new Contrat($this->db);
230  $result=$object->fetch($id);
231  if ($result < 0)
232  {
233  dol_print_error($this->db,$object->error);
234  return -1;
235  }
236  }
237 
238  $dir = $conf->contrat->dir_output;
239  $objectref = dol_sanitizeFileName($object->ref);
240  if (! preg_match('/specimen/i',$objectref)) $dir.= "/" . $objectref;
241  $file = $dir . "/" . $objectref . ".odt";
242 
243  if (! file_exists($dir))
244  {
245  if (dol_mkdir($dir) < 0)
246  {
247  $this->error=$langs->transnoentities("ErrorCanNotCreateDir",$dir);
248  return -1;
249  }
250  }
251 
252  if (file_exists($dir))
253  {
254  //print "srctemplatepath=".$srctemplatepath; // Src filename
255  $newfile=basename($srctemplatepath);
256  $newfiletmp=preg_replace('/\.od(t|s)/i','',$newfile);
257  $newfiletmp=preg_replace('/template_/i','',$newfiletmp);
258  $newfiletmp=preg_replace('/modele_/i','',$newfiletmp);
259 
260  $newfiletmp=$objectref.'_'.$newfiletmp;
261 
262  // Get extension (ods or odt)
263  $newfileformat=substr($newfile, strrpos($newfile, '.')+1);
264  if ( ! empty($conf->global->MAIN_DOC_USE_TIMING))
265  {
266  $format=$conf->global->MAIN_DOC_USE_TIMING;
267  if ($format == '1') $format='%Y%m%d%H%M%S';
268  $filename=$newfiletmp.'-'.dol_print_date(dol_now(),$format).'.'.$newfileformat;
269  }
270  else
271  {
272  $filename=$newfiletmp.'.'.$newfileformat;
273  }
274  $file=$dir.'/'.$filename;
275  //print "newdir=".$dir;
276  //print "newfile=".$newfile;
277  //print "file=".$file;
278  //print "conf->contrat->dir_temp=".$conf->contrat->dir_temp;
279 
280  dol_mkdir($conf->contrat->dir_temp);
281 
282 
283  // If CUSTOMER contact defined on contract, we use it
284  $usecontact=false;
285  $arrayidcontact=$object->getIdContact('external','CUSTOMER');
286  if (count($arrayidcontact) > 0)
287  {
288  $usecontact=true;
289  $result=$object->fetch_contact($arrayidcontact[0]);
290  }
291 
292  // Recipient name
293  $contactobject=null;
294  if (! empty($usecontact))
295  {
296  // On peut utiliser le nom de la societe du contact
297  if (! empty($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT)) $socobject = $object->contact;
298  else {
299  $socobject = $object->thirdparty;
300  // if we have a CUSTOMER contact and we dont use it as recipient we store the contact object for later use
301  $contactobject = $object->contact;
302  }
303  }
304  else
305  {
306  $socobject=$object->thirdparty;
307  }
308 
309  $object->fetch_optionals();
310 
311 
312  // Define substitution array
313  $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object);
314  $array_object_from_properties=$this->get_substitutionarray_each_var_object($object, $outputlangs);
315  $array_objet=$this->get_substitutionarray_object($object,$outputlangs); // complete with vars not set as properties by get_substitutionarray_each_var_object
316  $array_user=$this->get_substitutionarray_user($user,$outputlangs);
317  $array_soc=$this->get_substitutionarray_mysoc($mysoc,$outputlangs);
318  $array_thirdparty=$this->get_substitutionarray_thirdparty($socobject,$outputlangs);
319  $array_other=$this->get_substitutionarray_other($outputlangs);
320  // retrieve contact information for use in order as contact_xxx tags
321  $array_thirdparty_contact = array();
322  if ($usecontact && is_object($contactobject)) $array_thirdparty_contact=$this->get_substitutionarray_contact($contactobject,$outputlangs,'contact');
323 
324  $substitutionarray = array_merge($substitutionarray,$array_object_from_properties,$array_user,$array_soc,$array_thirdparty,$array_objet,$array_other,$array_thirdparty_contact);
325  complete_substitutions_array($substitutionarray, $outputlangs, $object);
326 
327  $tmparray = $substitutionarray;
328 
329  // Call the ODTSubstitution hook
330  $parameters=array('file'=>$file,'object'=>$object,'outputlangs'=>$outputlangs,'substitutionarray'=>&$tmparray);
331  $reshook=$hookmanager->executeHooks('ODTSubstitution',$parameters,$this,$action); // Note that $action and $object may have been modified by some hooks
332 
333  // Line of free text
334  $newfreetext='';
335  $paramfreetext='CONTRACT_FREE_TEXT';
336  if (! empty($conf->global->$paramfreetext))
337  {
338  $newfreetext=make_substitutions($conf->global->$paramfreetext,$tmparray);
339  }
340 
341 
342  // Open and load template
343  require_once ODTPHP_PATH.'odf.php';
344  try {
345  $odfHandler = new odf(
346  $srctemplatepath,
347  array(
348  'PATH_TO_TMP' => $conf->contrat->dir_temp,
349  'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
350  'DELIMITER_LEFT' => '{',
351  'DELIMITER_RIGHT' => '}'
352  )
353  );
354  }
355  catch(Exception $e)
356  {
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  //print html_entity_decode($odfHandler->__toString());
365  //print exit;
366 
367 
368  // Make substitutions into odt of freetext
369  try {
370  $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
371  }
372  catch (OdfException $e)
373  {
374  dol_syslog($e->getMessage(), LOG_INFO);
375  }
376 
377  foreach($tmparray as $key=>$value)
378  {
379  try {
380  if (preg_match('/logo$/',$key)) // Image
381  {
382  if (file_exists($value)) $odfHandler->setImage($key, $value);
383  else $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
384  }
385  else // Text
386  {
387  $odfHandler->setVars($key, $value, true, 'UTF-8');
388  }
389  }
390  catch (OdfException $e)
391  {
392  dol_syslog($e->getMessage(), LOG_INFO);
393  }
394  }
395 
396  // Replace tags of lines
397  try
398  {
399  $foundtagforlines = 1;
400  try {
401  $listlines = $odfHandler->setSegment('lines');
402  }
403  catch(OdfException $e)
404  {
405  // We may arrive here if tags for lines not present into template
406  $foundtagforlines = 0;
407  dol_syslog($e->getMessage(), LOG_INFO);
408  }
409  if ($foundtagforlines)
410  {
411  foreach ($object->lines as $line)
412  {
413  $tmparray=$this->get_substitutionarray_lines($line,$outputlangs);
414  complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
415  // Call the ODTSubstitutionLine hook
416  $parameters=array('odfHandler'=>&$odfHandler,'file'=>$file,'object'=>$object,'outputlangs'=>$outputlangs,'substitutionarray'=>&$tmparray,'line'=>$line);
417  $reshook=$hookmanager->executeHooks('ODTSubstitutionLine',$parameters,$this,$action); // Note that $action and $object may have been modified by some hooks
418  foreach($tmparray as $key => $val)
419  {
420  try
421  {
422  $listlines->setVars($key, $val, true, 'UTF-8');
423  }
424  catch(OdfException $e)
425  {
426  dol_syslog($e->getMessage(), LOG_INFO);
427  }
428  catch(SegmentException $e)
429  {
430  dol_syslog($e->getMessage(), LOG_INFO);
431  }
432  }
433  $listlines->merge();
434  }
435  $odfHandler->mergeSegment($listlines);
436  }
437  }
438  catch(OdfException $e)
439  {
440  $this->error=$e->getMessage();
441  dol_syslog($this->error, LOG_WARNING);
442  return -1;
443  }
444 
445  // Replace labels translated
446  $tmparray=$outputlangs->get_translations_for_substitutions();
447  foreach($tmparray as $key=>$value)
448  {
449  try {
450  $odfHandler->setVars($key, $value, true, 'UTF-8');
451  }
452  catch(OdfException $e)
453  {
454  dol_syslog($e->getMessage(), LOG_INFO);
455  }
456  }
457 
458  // Call the beforeODTSave hook
459  $parameters=array('odfHandler'=>&$odfHandler,'file'=>$file,'object'=>$object,'outputlangs'=>$outputlangs);
460  $reshook=$hookmanager->executeHooks('beforeODTSave',$parameters,$this,$action); // Note that $action and $object may have been modified by some hooks
461 
462  // Write new file
463  if (!empty($conf->global->MAIN_ODT_AS_PDF)) {
464  try {
465  $odfHandler->exportAsAttachedPDF($file);
466  } catch (Exception $e) {
467  $this->error=$e->getMessage();
468  return -1;
469  }
470  }
471  else {
472  try {
473  $odfHandler->saveToDisk($file);
474  } catch (Exception $e) {
475  $this->error=$e->getMessage();
476  return -1;
477  }
478  }
479 
480  $reshook=$hookmanager->executeHooks('afterODTCreation',$parameters,$this,$action); // Note that $action and $object may have been modified by some hooks
481 
482  if (! empty($conf->global->MAIN_UMASK))
483  @chmod($file, octdec($conf->global->MAIN_UMASK));
484 
485  $odfHandler=null; // Destroy object
486 
487  $this->result = array('fullpath'=>$file);
488 
489  return 1; // Success
490  }
491  else
492  {
493  $this->error=$langs->transnoentities("ErrorCanNotCreateDir",$dir);
494  return -1;
495  }
496  }
497 
498  return -1;
499  }
500 }
info($langs)
Return description of a module.
img_warning($titlealt='default', $moreatt='')
Show warning logo.
Parent class to manage intervention document templates.
$version
Dolibarr version of the loaded document string.
get_substitutionarray_lines($line, $outputlangs)
Define array with couple substitution key => substitution value.
</td >< td class="liste_titre" align="right"></td ></tr >< tr class="liste_titre">< input type="checkbox" onClick="toggle(this)"/> Ref p ref Label p label Duration p duration warehouseinternal SELECT description FROM product_lang WHERE qty< br > qty qty qty StockTooLow img yes disabled img no img no< tr class="oddeven">< td >< input type="checkbox" class="check" name="' . $i . '"' . $disabled . '></td >< td >< input type="checkbox" class="check" name="choose'.$i.'"></td >< td class="nowrap"></td >< td >< input type="hidden" name="desc' . $i . '" value="' . dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:573
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
get_substitutionarray_each_var_object(&$object, $outputlangs, $recursive=true)
Define array with couple subtitution key => subtitution value.
get_substitutionarray_object($object, $outputlangs, $array_key='object')
Define array with couple substitution key => substitution value.
get_substitutionarray_user($user, $outputlangs)
Define array with couple subtitution key => subtitution value.
Class to manage contracts.
dol_print_error($db='', $error='', $errors=null)
Affiche message erreur system avec toutes les informations pour faciliter le diagnostic et la remonte...
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
write_file($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk using the generic odt module.
getCommonSubstitutionArray($outputlangs, $onlykey=0, $exclude=null, $object=null)
Return array of possible common substitutions.
Class to manage hooks.
Class to manage generation of HTML components Only common components must be here.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='')
Write log message into outputs.
type
Definition: viewcat.php:284
get_substitutionarray_mysoc($mysoc, $outputlangs)
Define array with couple subtitution key => subtitution value.
Class to build documents using ODF templates generator.
dol_dir_list($path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0)
Scan a directory and return a list of files/directories.
Definition: files.lib.php:59
dol_now($mode='gmt')
Return date for now.
dol_print_date($time, $format='', $tzoutput='tzserver', $outputlangs='', $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
get_substitutionarray_contact($object, $outputlangs, $array_key='object')
Define array with couple subtitution key => subtitution value.
get_substitutionarray_thirdparty($object, $outputlangs)
Define array with couple subtitution key => subtitution value.
dol_mkdir($dir, $dataroot='', $newmask=null)
Creation of a directory (this can create recursive subdir)
make_substitutions($text, $substitutionarray, $outputlangs=null)
Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newva...
get_substitutionarray_other($outputlangs)
Define array with couple subtitution key => subtitution value.
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...