dolibarr  20.0.0-alpha
doc_generic_odt.modules.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2010-2011 Laurent Destailleur <ely@users.sourceforge.net>
3  * Copyright (C) 2016 Charlie Benke <charlie@patas-monkey.com>
4  * Copyright (C) 2018-2019 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 
27 require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php';
28 require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
29 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
30 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
31 require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
32 
33 
38 {
42  public $version = 'dolibarr';
43 
44 
50  public function __construct($db)
51  {
52  global $langs, $mysoc;
53 
54  // Load translation files required by the page
55  $langs->loadLangs(array("main", "companies"));
56 
57  $this->db = $db;
58  $this->name = "ODT templates";
59  $this->description = $langs->trans("DocumentModelOdt");
60  $this->scandir = 'COMPANY_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
61 
62  // Page size for A4 format
63  $this->type = 'odt';
64  $this->page_largeur = 0;
65  $this->page_hauteur = 0;
66  $this->format = array($this->page_largeur, $this->page_hauteur);
67  $this->marge_gauche = 0;
68  $this->marge_droite = 0;
69  $this->marge_haute = 0;
70  $this->marge_basse = 0;
71 
72  $this->option_logo = 1; // Display logo
73 
74  // Retrieves transmitter
75  $this->emetteur = $mysoc;
76  if (!$this->emetteur->country_code) {
77  $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default, if was not defined
78  }
79  }
80 
81 
88  public function info($langs)
89  {
90  global $conf, $langs;
91 
92  // Load traductions files required by page
93  $langs->loadLangs(array("companies", "errors"));
94 
95  $form = new Form($this->db);
96 
97  $texte = $this->description.".<br>\n";
98  $texte .= '<!-- form for option of ODT templates -->';
99  $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
100  $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
101  $texte .= '<input type="hidden" name="page_y" value="">';
102  $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
103  $texte .= '<input type="hidden" name="param1" value="COMPANY_ADDON_PDF_ODT_PATH">';
104  $texte .= '<table class="nobordernopadding centpercent">';
105 
106  // List of directories area
107  $texte .= '<tr><td>';
108  $texttitle = $langs->trans("ListOfDirectories");
109  $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim($conf->global->COMPANY_ADDON_PDF_ODT_PATH)));
110  $listoffiles = array();
111  foreach ($listofdir as $key => $tmpdir) {
112  $tmpdir = trim($tmpdir);
113  $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
114  if (!$tmpdir) {
115  unset($listofdir[$key]);
116  continue;
117  }
118  if (!is_dir($tmpdir)) {
119  $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), 0);
120  } else {
121  $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.od(s|t)$', '', 'name', SORT_ASC, 0, true); // Disable hook for the moment
122  if (count($tmpfiles)) {
123  $listoffiles = array_merge($listoffiles, $tmpfiles);
124  }
125  }
126  }
127  $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
128  $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
129  // Add list of substitution keys
130  $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
131  $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
132 
133  $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
134  $texte .= '<table><tr><td>';
135  $texte .= '<textarea class="flat" cols="60" name="value1">';
136  $texte .= getDolGlobalString('COMPANY_ADDON_PDF_ODT_PATH');
137  $texte .= '</textarea>';
138  $texte .= '</td>';
139  $texte .= '<td class="center">&nbsp; ';
140  $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
141  $texte .= '</td>';
142  $texte .= '</tr>';
143  $texte .= '</table>';
144 
145  // Scan directories
146  $nbofiles = count($listoffiles);
147  if (getDolGlobalString('COMPANY_ADDON_PDF_ODT_PATH')) {
148  $texte .= $langs->trans("NumberOfModelFilesFound").': <b>';
149  //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
150  $texte .= $nbofiles;
151  //$texte.=$nbofiles?'</a>':'';
152  $texte .= '</b>';
153  }
154 
155  if ($nbofiles) {
156  $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
157  // Show list of found files
158  foreach ($listoffiles as $file) {
159  $texte .= '- '.$file['name'].' &nbsp; <a class="reposition" href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=thirdparties/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
160  $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=COMPANY_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
161  $texte .= '<br>';
162  }
163  $texte .= '</div>';
164  }
165  // Add input to upload a new template file.
166  $texte .= '<div>'.$langs->trans("UploadNewTemplate");
167  $maxfilesizearray = getMaxFileSizeArray();
168  $maxmin = $maxfilesizearray['maxmin'];
169  if ($maxmin > 0) {
170  $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
171  }
172  $texte .= ' <input type="file" name="uploadfile">';
173  $texte .= '<input type="hidden" value="COMPANY_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
174  $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
175  $texte .= '</div>';
176  $texte .= '</td>';
177 
178  $texte .= '</tr>';
179 
180  $texte .= '</table>';
181  $texte .= '</form>';
182 
183  return $texte;
184  }
185 
186  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
198  public function write_file($object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
199  {
200  // phpcs:enable
201  global $user, $langs, $conf, $mysoc, $hookmanager;
202  global $action;
203 
204  if (empty($srctemplatepath)) {
205  dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
206  return -1;
207  }
208 
209  // Add odtgeneration hook
210  if (!is_object($hookmanager)) {
211  include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
212  $hookmanager = new HookManager($this->db);
213  }
214  $hookmanager->initHooks(array('odtgeneration'));
215 
216  if (!is_object($outputlangs)) {
217  $outputlangs = $langs;
218  }
219  $sav_charset_output = $outputlangs->charset_output;
220  $outputlangs->charset_output = 'UTF-8';
221 
222  // Load translation files required by the page
223  $outputlangs->loadLangs(array("main", "dict", "companies", "projects"));
224 
225  if ($conf->societe->multidir_output[$object->entity]) {
226  $dir = $conf->societe->multidir_output[$object->entity];
227  $objectref = dol_sanitizeFileName($object->id);
228  if (!preg_match('/specimen/i', $objectref)) {
229  $dir .= "/".$objectref;
230  }
231 
232  if (!file_exists($dir)) {
233  if (dol_mkdir($dir) < 0) {
234  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
235  return -1;
236  }
237  }
238 
239  if (file_exists($dir)) {
240  //print "srctemplatepath=".$srctemplatepath; // Src filename
241  $newfile = basename($srctemplatepath);
242  $newfiletmp = preg_replace('/\.od(s|t)/i', '', $newfile);
243  $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
244  $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
245  // Get extension (ods or odt)
246  $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
247  if (getDolGlobalString('MAIN_DOC_USE_OBJECT_THIRDPARTY_NAME')) {
248  $newfiletmp = dol_sanitizeFileName(dol_string_nospecial($object->name)) . '-' . $newfiletmp;
249  $newfiletmp = preg_replace('/__+/', '_', $newfiletmp); // Replace repeated _ into one _ (to avoid string with substitution syntax)
250  }
251  if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
252  $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
253  if ($format == '1') {
254  $format = '%Y%m%d%H%M%S';
255  }
256  $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
257  } else {
258  $filename = $newfiletmp . '.' . $newfileformat;
259  }
260  $file = $dir . '/' . $filename;
261  $object->builddoc_filename = $filename; // For triggers
262  $object->context['builddoc_filename'] = $filename; // For triggers
263  //print "newfileformat=".$newfileformat;
264  //print "newdir=".$dir;
265  //print "newfile=".$newfile;
266  //print "file=".$file;
267  //print "conf->societe->dir_temp=".$conf->societe->dir_temp;
268  //exit;
269 
270  dol_mkdir($conf->societe->multidir_temp[$object->entity]);
271  if (!is_writable($conf->societe->multidir_temp[$object->entity])) {
272  $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->societe->multidir_temp[$object->entity]);
273  dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
274  return -1;
275  }
276 
277  // Open and load template
278  require_once ODTPHP_PATH.'odf.php';
279  try {
280  $odfHandler = new Odf(
281  $srctemplatepath,
282  array(
283  'PATH_TO_TMP' => $conf->societe->multidir_temp[$object->entity],
284  'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
285  'DELIMITER_LEFT' => '{',
286  'DELIMITER_RIGHT' => '}'
287  )
288  );
289  } catch (Exception $e) {
290  $this->error = $e->getMessage();
291  dol_syslog($e->getMessage(), LOG_INFO);
292  return -1;
293  }
294  //print $odfHandler->__toString()."\n";
295 
296  // Replace tags of lines for contacts
297  $contact_arrray = array();
298 
299  $sql = "SELECT p.rowid";
300  $sql .= " FROM ".MAIN_DB_PREFIX."socpeople as p";
301  $sql .= " WHERE p.fk_soc = ".((int) $object->id);
302 
303  $result = $this->db->query($sql);
304  $num = $this->db->num_rows($result);
305 
306  if ($num) {
307  require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
308 
309  $i = 0;
310  $contactstatic = new Contact($this->db);
311 
312  while ($i < $num) {
313  $obj = $this->db->fetch_object($result);
314 
315  $contact_arrray[$i] = $obj->rowid;
316  $i++;
317  }
318  }
319  if ((is_array($contact_arrray) && count($contact_arrray) > 0)) {
320  try {
321  $listlines = $odfHandler->setSegment('companycontacts');
322 
323  foreach ($contact_arrray as $array_key => $contact_id) {
324  $res_contact = $contactstatic->fetch($contact_id);
325  if ((int) $res_contact > 0) {
326  $tmparray = $this->get_substitutionarray_contact($contactstatic, $outputlangs, 'contact');
327  foreach ($tmparray as $key => $val) {
328  try {
329  $listlines->setVars($key, $val, true, 'UTF-8');
330  } catch (OdfException $e) {
331  dol_syslog($e->getMessage(), LOG_INFO);
332  } catch (SegmentException $e) {
333  dol_syslog($e->getMessage(), LOG_INFO);
334  }
335  }
336  $listlines->merge();
337  } else {
338  $this->error = $contactstatic->error;
339  dol_syslog($this->error, LOG_WARNING);
340  }
341  }
342  $odfHandler->mergeSegment($listlines);
343  } catch (OdfException $e) {
344  $this->error = $e->getMessage();
345  dol_syslog($this->error, LOG_WARNING);
346  //return -1;
347  }
348  }
349 
350  // Make substitutions into odt
351  $array_user = $this->get_substitutionarray_user($user, $outputlangs);
352  $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
353  $array_thirdparty = $this->get_substitutionarray_thirdparty($object, $outputlangs);
354  $array_other = $this->get_substitutionarray_other($outputlangs);
355 
356  $tmparray = array_merge($array_user, $array_soc, $array_thirdparty, $array_other);
357 
358  complete_substitutions_array($tmparray, $outputlangs, $object);
359 
360  // Call the ODTSubstitution hook
361  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
362  $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
363 
364  // Replace variables into document
365  foreach ($tmparray as $key => $value) {
366  try {
367  if (preg_match('/logo$/', $key)) { // Image
368  if (file_exists($value)) {
369  $odfHandler->setImage($key, $value);
370  } else {
371  $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
372  }
373  } else { // Text
374  $odfHandler->setVars($key, $value, true, 'UTF-8');
375  }
376  } catch (OdfException $e) {
377  // setVars failed, probably because key not found
378  dol_syslog($e->getMessage(), LOG_INFO);
379  }
380  }
381 
382  // Replace labels translated
383  $tmparray = $outputlangs->get_translations_for_substitutions();
384  foreach ($tmparray as $key => $value) {
385  try {
386  $odfHandler->setVars($key, $value, true, 'UTF-8');
387  } catch (OdfException $e) {
388  dol_syslog($e->getMessage(), LOG_INFO);
389  }
390  }
391 
392  // Call the beforeODTSave hook
393  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
394  $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
395 
396  // Write new file
397  if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
398  try {
399  $odfHandler->exportAsAttachedPDF($file);
400  } catch (Exception $e) {
401  $this->error = $e->getMessage();
402  dol_syslog($e->getMessage(), LOG_INFO);
403  return -1;
404  }
405  } else {
406  try {
407  $odfHandler->creator = $user->getFullName($outputlangs);
408  $odfHandler->title = $object->builddoc_filename;
409  $odfHandler->subject = $object->builddoc_filename;
410 
411  if (getDolGlobalString('ODT_ADD_DOLIBARR_ID')) {
412  $odfHandler->userdefined['dol_id'] = $object->id;
413  $odfHandler->userdefined['dol_element'] = $object->element;
414  }
415 
416  $odfHandler->saveToDisk($file);
417  } catch (Exception $e) {
418  $this->error = $e->getMessage();
419  dol_syslog($e->getMessage(), LOG_INFO);
420  return -1;
421  }
422  }
423  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
424  $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
425 
426  dolChmod($file);
427 
428  $odfHandler = null; // Destroy object
429 
430  $this->result = array('fullpath'=>$file);
431 
432  return 1; // Success
433  } else {
434  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
435  return -1;
436  }
437  }
438 
439  $this->error = 'UnknownError';
440  return -1;
441  }
442 }
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 contact/addresses.
Class to manage generation of HTML components Only common components must be here.
Class to manage hooks.
Parent class for third parties models of doc generators.
Class to build documents using ODF templates generator.
__construct($db)
Constructor.
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.
if(isModEnabled('invoice') && $user->hasRight('facture', 'lire')) if((isModEnabled('fournisseur') &&!getDolGlobalString('MAIN_USE_NEW_SUPPLIERMOD') && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') && $user->hasRight('don', 'lire')) if(isModEnabled('tax') && $user->hasRight('tax', 'charges', 'lire')) if(isModEnabled('invoice') &&isModEnabled('order') && $user->hasRight("commande", "lire") &&!getDolGlobalString('WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER')) $sql
Social contributions to pay.
Definition: index.php:744
if($cancel &&! $id) if($action=='add' &&! $cancel) if($action=='delete') if($id) $form
Actions.
Definition: card.php:143
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)
dol_string_nospecial($str, $newstr='_', $badcharstoreplace='', $badcharstoremove='', $keepspaces=0)
Clean a string from all punctuation characters to use it as a ref or login.
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.
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:122
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:125
getMaxFileSizeArray()
Return the max allowed for file upload.