dolibarr  17.0.3
doc_generic_member_odt.class.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-2021 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/member/modules_member.class.php';
28 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
29 require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.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 $emetteur;
43 
48  public $phpmin = array(7, 0);
49 
54  public $version = 'dolibarr';
55 
56 
62  public function __construct($db)
63  {
64  global $conf, $langs, $mysoc;
65 
66  // Load translation files required by the page
67  $langs->loadLangs(array("main", "companies"));
68 
69  $this->db = $db;
70  $this->name = "ODT templates";
71  $this->description = $langs->trans("DocumentModelOdt");
72  $this->scandir = 'MEMBER_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
73 
74  // Page size for A4 format
75  $this->type = 'odt';
76  $this->page_largeur = 0;
77  $this->page_hauteur = 0;
78  $this->format = array($this->page_largeur, $this->page_hauteur);
79  $this->marge_gauche = 0;
80  $this->marge_droite = 0;
81  $this->marge_haute = 0;
82  $this->marge_basse = 0;
83 
84  $this->option_logo = 1; // Display logo
85  $this->option_tva = 0; // Manage the vat option FACTURE_TVAOPTION
86  $this->option_modereg = 0; // Display payment mode
87  $this->option_condreg = 0; // Display payment terms
88  $this->option_multilang = 1; // Available in several languages
89  $this->option_escompte = 0; // Displays if there has been a discount
90  $this->option_credit_note = 0; // Support credit notes
91  $this->option_freetext = 1; // Support add of a personalised text
92  $this->option_draft_watermark = 0; // Support add of a watermark on drafts
93 
94  // Recupere emetteur
95  $this->emetteur = $mysoc;
96  if (!$this->emetteur->country_code) {
97  $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
98  }
99  }
100 
101 
108  public function info($langs)
109  {
110  global $conf, $langs;
111 
112  // Load translation files required by the page
113  $langs->loadLangs(array('companies', 'errors'));
114 
115  $form = new Form($this->db);
116 
117  $texte = $this->description.".<br>\n";
118  $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
119  $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
120  $texte .= '<input type="hidden" name="page_y" value="">';
121  $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
122  $texte .= '<input type="hidden" name="param1" value="MEMBER_ADDON_PDF_ODT_PATH">';
123  $texte .= '<table class="nobordernopadding" width="100%">';
124 
125  // List of directories area
126  $texte .= '<tr><td>';
127  $texttitle = $langs->trans("ListOfDirectories");
128  $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim(getDolGlobalString('MEMBER_ADDON_PDF_ODT_PATH'))));
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), 0);
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  // Add list of substitution keys
148  $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
149  $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
150 
151  $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1);
152  $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
153  $texte .= '<textarea class="flat" cols="60" name="value1">';
154  $texte .= getDolGlobalString('MEMBER_ADDON_PDF_ODT_PATH');
155  $texte .= '</textarea>';
156  $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
157  $texte .= '<input type="submit" class="button small reposition" name="modify" value="'.$langs->trans("Modify").'">';
158  $texte .= '<br></div></div>';
159 
160  // Scan directories
161  if (count($listofdir)) {
162  $texte .= $langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b>';
163 
164  $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
165  // Show list of found files
166  foreach ($listoffiles as $file) {
167  $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=members/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
168  $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=MEMBER_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
169  $texte .= '<br>';
170  }
171  $texte .= '</div>';
172  }
173  // Add input to upload a new template file.
174  $texte .= '<div>'.$langs->trans("UploadNewTemplate");
175  $maxfilesizearray = getMaxFileSizeArray();
176  $maxmin = $maxfilesizearray['maxmin'];
177  if ($maxmin > 0) {
178  $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
179  }
180  $texte .= ' <input type="file" name="uploadfile">';
181  $texte .= '<input type="hidden" value="MEMBER_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
182  $texte .= '<input type="submit" class="button small reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
183  $texte .= '</div>';
184  $texte .= '</td>';
185 
186  $texte .= '<td rowspan="2" class="tdtop hideonsmartphone">';
187  $texte .= '<span class="opacitymedium">';
188  $texte .= $langs->trans("ExampleOfDirectoriesForModelGen");
189  $texte .= '</span>';
190  $texte .= '</td>';
191  $texte .= '</tr>';
192 
193  $texte .= '</table>';
194  $texte .= '</form>';
195 
196  return $texte;
197  }
198 
199  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
211  public function write_file($object, $outputlangs, $srctemplatepath, $mode = 'member', $nooutput = 0, $filename = 'tmp_cards')
212  {
213  // phpcs:enable
214  global $user, $langs, $conf, $mysoc, $hookmanager;
215 
216  if (empty($srctemplatepath)) {
217  dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
218  return -1;
219  }
220 
221  // Add odtgeneration hook
222  if (!is_object($hookmanager)) {
223  include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
224  $hookmanager = new HookManager($this->db);
225  }
226  $hookmanager->initHooks(array('odtgeneration'));
227  global $action;
228 
229  if (!is_object($outputlangs)) {
230  $outputlangs = $langs;
231  }
232  $sav_charset_output = $outputlangs->charset_output;
233  $outputlangs->charset_output = 'UTF-8';
234 
235  // Load translation files required by the page
236  $outputlangs->loadLangs(array("main", "companies", "bills", "dict"));
237 
238  if ($conf->adherent->dir_output) {
239  // If $object is id instead of object
240  if (!is_object($object)) {
241  $id = $object;
242  $object = new User($this->db);
243  $result = $object->fetch($id);
244  if ($result < 0) {
245  dol_print_error($this->db, $object->error);
246  return -1;
247  }
248  }
249 
250  $object->fetch_thirdparty();
251 
252  $dir = $conf->adherent->dir_output;
253  $objectref = dol_sanitizeFileName($object->ref);
254  if (!preg_match('/specimen/i', $objectref)) {
255  $dir .= "/".$objectref;
256  }
257  $file = $dir."/".$objectref.".odt";
258 
259  if (!file_exists($dir)) {
260  if (dol_mkdir($dir) < 0) {
261  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
262  return -1;
263  }
264  }
265 
266  if (file_exists($dir)) {
267  //print "srctemplatepath=".$srctemplatepath; // Src filename
268  $newfile = basename($srctemplatepath);
269  $newfiletmp = preg_replace('/\.od(t|s)/i', '', $newfile);
270  $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
271  $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
272 
273  $newfiletmp = $objectref . '_' . $newfiletmp;
274 
275  // Get extension (ods or odt)
276  $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
277  if (!empty($conf->global->MAIN_DOC_USE_TIMING)) {
278  $format = $conf->global->MAIN_DOC_USE_TIMING;
279  if ($format == '1') {
280  $format = '%Y%m%d%H%M%S';
281  }
282  $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
283  } else {
284  $filename = $newfiletmp . '.' . $newfileformat;
285  }
286  $file = $dir . '/' . $filename;
287  //print "newdir=".$dir;
288  //print "newfile=".$newfile;
289  //print "file=".$file;
290  //print "conf->adherent->dir_temp=".$conf->adherent->dir_temp;
291 
292  dol_mkdir($conf->adherent->dir_temp);
293  if (!is_writable($conf->adherent->dir_temp)) {
294  $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->adherent->dir_temp);
295  dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
296  return -1;
297  }
298 
299  // If CUSTOMER contact defined on member, we use it
300  $usecontact = false;
301  $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
302  if (count($arrayidcontact) > 0) {
303  $usecontact = true;
304  $result = $object->fetch_contact($arrayidcontact[0]);
305  }
306 
307  // Recipient name
308  if (!empty($usecontact)) {
309  // We can use the company of contact instead of thirdparty company
310  if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || !empty($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT))) {
311  $object->contact->fetch_thirdparty();
312  $socobject = $object->contact->thirdparty;
313  $contactobject = $object->contact;
314  } else {
315  $socobject = $object->thirdparty;
316  // if we have a CUSTOMER contact and we dont use it as thirdparty recipient we store the contact object for later use
317  $contactobject = $object->contact;
318  }
319  } else {
320  $socobject = $object->thirdparty;
321  }
322 
323  // Open and load template
324  require_once ODTPHP_PATH.'odf.php';
325  try {
326  $odfHandler = new odf(
327  $srctemplatepath,
328  array(
329  'PATH_TO_TMP' => $conf->adherent->dir_temp,
330  'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
331  'DELIMITER_LEFT' => '{',
332  'DELIMITER_RIGHT' => '}'
333  )
334  );
335  } catch (Exception $e) {
336  $this->error = $e->getMessage();
337  dol_syslog($e->getMessage(), LOG_WARNING);
338  return -1;
339  }
340 
341  // Make substitutions into odt
342  $array_member = $this->getSubstitutionarrayMember($object, $outputlangs);
343  $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
344  $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
345  $array_other = $this->get_substitutionarray_other($outputlangs);
346  // retrieve contact information for use in object as contact_xxx tags
347  $array_thirdparty_contact = array();
348  if ($usecontact && is_object($contactobject)) {
349  $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
350  }
351 
352  $tmparray = array_merge($array_member, $array_soc, $array_thirdparty, $array_other, $array_thirdparty_contact);
353  complete_substitutions_array($tmparray, $outputlangs, $object);
354  // Call the ODTSubstitution hook
355  $parameters = array(
356  'file'=>$file,
357  'object'=>$object,
358  'outputlangs'=>$outputlangs,
359  'substitutionarray'=>&$tmparray
360  );
361  $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
362  foreach ($tmparray as $key => $value) {
363  try {
364  if (preg_match('/logo$/', $key)) {
365  // Image
366  if (file_exists($value)) {
367  $odfHandler->setImage($key, $value);
368  } else {
369  $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
370  }
371  } else {
372  // Text
373  $odfHandler->setVars($key, $value, true, 'UTF-8');
374  }
375  } catch (OdfException $e) {
376  dol_syslog($e->getMessage(), LOG_WARNING);
377  }
378  }
379 
380  // Replace labels translated
381  $tmparray = $outputlangs->get_translations_for_substitutions();
382  foreach ($tmparray as $key => $value) {
383  try {
384  $odfHandler->setVars($key, $value, true, 'UTF-8');
385  } catch (OdfException $e) {
386  dol_syslog($e->getMessage(), LOG_WARNING);
387  }
388  }
389 
390  // Call the beforeODTSave hook
391  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs);
392  $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
393 
394  // Write new file
395  if (!empty($conf->global->MAIN_ODT_AS_PDF)) {
396  try {
397  $odfHandler->exportAsAttachedPDF($file);
398  } catch (Exception $e) {
399  $this->error = $e->getMessage();
400  dol_syslog($e->getMessage(), LOG_WARNING);
401  return -1;
402  }
403  } else {
404  try {
405  $odfHandler->saveToDisk($file);
406  } catch (Exception $e) {
407  $this->error = $e->getMessage();
408  dol_syslog($e->getMessage(), LOG_WARNING);
409  return -1;
410  }
411  }
412 
413  $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
414 
415  if (!empty($conf->global->MAIN_UMASK)) {
416  @chmod($file, octdec($conf->global->MAIN_UMASK));
417  }
418 
419  $odfHandler = null; // Destroy object
420 
421  $this->result = array('fullpath'=>$file);
422 
423  return 1; // Success
424  } else {
425  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
426  return -1;
427  }
428  }
429 
430  return -1;
431  }
432 
433  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
442  public function get_substitutionarray_object($object, $outputlangs, $array_key = 'object')
443  {
444  // phpcs:enable
445  $array_other = array();
446  foreach ($object as $key => $value) {
447  if (!is_array($value) && !is_object($value)) {
448  $array_other[$array_key.'_'.$key] = $value;
449  }
450  }
451  return $array_other;
452  }
453 }
doc_generic_member_odt\write_file
write_file($object, $outputlangs, $srctemplatepath, $mode='member', $nooutput=0, $filename='tmp_cards')
Function to build a document on disk using the generic odt module.
Definition: doc_generic_member_odt.class.php:211
db
$conf db
API class for accounts.
Definition: inc.php:41
dol_sanitizeFileName
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
Definition: functions.lib.php:1225
description
print *****$script_file(".$version.") pid cd cd cd description as description
Definition: email_expire_services_to_customers.php:83
doc_generic_member_odt\info
info($langs)
Return description of a module.
Definition: doc_generic_member_odt.class.php:108
dol_print_error
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
Definition: functions.lib.php:4993
CommonDocGenerator\getSubstitutionarrayMember
getSubstitutionarrayMember($member, $outputlangs)
Define array with couple substitution key => substitution value.
Definition: commondocgenerator.class.php:155
dol_dir_list
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:61
img_warning
img_warning($titlealt='default', $moreatt='', $morecss='pictowarning')
Show warning logo.
Definition: functions.lib.php:4670
doc_generic_member_odt
Class to build documents using ODF templates generator.
Definition: doc_generic_member_odt.class.php:37
$form
if($cancel &&! $id) if($action=='add' &&! $cancel) if($action=='delete') if($id) $form
Actions.
Definition: card.php:143
name
$conf db name
Definition: repair.php:122
ModelePDFMember
Parent class to manage intervention document templates.
Definition: modules_member.class.php:35
dol_print_date
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs='', $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
Definition: functions.lib.php:2550
CommonDocGenerator\get_substitutionarray_contact
get_substitutionarray_contact($object, $outputlangs, $array_key='object')
Define array with couple substitution key => substitution value.
Definition: commondocgenerator.class.php:326
img_picto
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
Definition: functions.lib.php:4024
getMaxFileSizeArray
getMaxFileSizeArray()
Return the max allowed for file upload.
Definition: security.lib.php:1187
Exception
CommonDocGenerator\get_substitutionarray_thirdparty
get_substitutionarray_thirdparty($object, $outputlangs, $array_key='company')
Define array with couple substitution key => substitution value For example {company_name},...
Definition: commondocgenerator.class.php:261
dol_syslog
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
Definition: functions.lib.php:1628
CommonDocGenerator\get_substitutionarray_mysoc
get_substitutionarray_mysoc($mysoc, $outputlangs)
Define array with couple substitution key => substitution value.
Definition: commondocgenerator.class.php:202
getDolGlobalString
if(!function_exists('utf8_encode')) if(!function_exists('utf8_decode')) getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
Definition: functions.lib.php:82
doc_generic_member_odt\__construct
__construct($db)
Constructor.
Definition: doc_generic_member_odt.class.php:62
newToken
newToken()
Return the value of token currently saved into session with name 'newtoken'.
Definition: functions.lib.php:11295
User
Class to manage Dolibarr users.
Definition: user.class.php:46
Form
Class to manage generation of HTML components Only common components must be here.
Definition: html.form.class.php:53
dol_now
dol_now($mode='auto')
Return date for now.
Definition: functions.lib.php:2951
doc_generic_member_odt\get_substitutionarray_object
get_substitutionarray_object($object, $outputlangs, $array_key='object')
get substitution array for object
Definition: doc_generic_member_odt.class.php:442
dol_mkdir
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
Definition: functions.lib.php:6789
type
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition: repair.php:119
HookManager
Class to manage hooks.
Definition: hookmanager.class.php:30
complete_substitutions_array
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...
Definition: functions.lib.php:8290
CommonDocGenerator\get_substitutionarray_other
get_substitutionarray_other($outputlangs)
Define array with couple substitution key => substitution value.
Definition: commondocgenerator.class.php:384