dolibarr 21.0.0-beta
doc_generic_user_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-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/user/modules_user.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 $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 = 'USER_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 USER_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('companies', 'errors'));
109
110 $form = new Form($this->db);
111
112 $odtChosen = getDolGlobalInt('MAIN_PROPAL_CHOOSE_ODT_DOCUMENT') > 0;
113 $odtPath = trim(getDolGlobalString('USER_ADDON_PDF_ODT_PATH'));
114
115 $texte = $this->description.".<br>\n";
116 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
117 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
118 $texte .= '<input type="hidden" name="page_y" value="">';
119 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
120 $texte .= '<input type="hidden" name="param1" value="USER_ADDON_PDF_ODT_PATH">';
121 if ($odtChosen) {
122 $texte .= '<input type="hidden" name="param2" value="USER_ADDON_PDF_ODT_DEFAULT">';
123 $texte .= '<input type="hidden" name="param3" value="USER_ADDON_PDF_ODT_TOBILL">';
124 $texte .= '<input type="hidden" name="param4" value="USER_ADDON_PDF_ODT_CLOSED">';
125 }
126 $texte .= '<table class="nobordernopadding" width="100%">';
127
128 // List of directories area
129 $texte .= '<tr><td>';
130 $texttitle = $langs->trans("ListOfDirectories");
131 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', $odtPath));
132 $listoffiles = array();
133 foreach ($listofdir as $key => $tmpdir) {
134 $tmpdir = trim($tmpdir);
135 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
136 if (!$tmpdir) {
137 unset($listofdir[$key]);
138 continue;
139 }
140 if (!is_dir($tmpdir)) {
141 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), '');
142 } else {
143 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
144 if (count($tmpfiles)) {
145 $listoffiles = array_merge($listoffiles, $tmpfiles);
146 }
147 }
148 }
149 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
150 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
151 // Add list of substitution keys
152 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
153 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
154
155 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
156 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
157 $texte .= '<textarea class="flat" cols="60" name="value1">';
158 $texte .= $odtPath;
159 $texte .= '</textarea>';
160 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
161 $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
162 $texte .= '<br></div></div>';
163
164 // Scan directories
165 if (count($listofdir)) {
166 $texte .= $langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b>';
167
168 if ($odtChosen) {
169 // Model for creation
170 $list = ModelePDFUser::liste_modeles($this->db);
171 $texte .= '<table width="50%;">';
172 $texte .= '<tr>';
173 $texte .= '<td width="60%;">'.$langs->trans("DefaultModelPropalCreate").'</td>';
174 $texte .= '<td colspan="">';
175 $texte .= $form->selectarray('value2', $list, getDolGlobalString('USER_ADDON_PDF_ODT_DEFAULT'));
176 $texte .= "</td></tr>";
177
178 $texte .= '<tr>';
179 $texte .= '<td width="60%;">'.$langs->trans("DefaultModelPropalToBill").'</td>';
180 $texte .= '<td colspan="">';
181 $texte .= $form->selectarray('value3', $list, getDolGlobalString('USER_ADDON_PDF_ODT_TOBILL'));
182 $texte .= "</td></tr>";
183 $texte .= '<tr>';
184
185 $texte .= '<td width="60%;">'.$langs->trans("DefaultModelPropalClosed").'</td>';
186 $texte .= '<td colspan="">';
187 $texte .= $form->selectarray('value4', $list, getDolGlobalString('USER_ADDON_PDF_ODT_CLOSED'));
188 $texte .= "</td></tr>";
189 $texte .= '</table>';
190 }
191 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
192 // Show list of found files
193 foreach ($listoffiles as $file) {
194 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=users/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
195 $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=USER_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
196 $texte .= '<br>';
197 }
198 $texte .= '</div>';
199 }
200 // Add input to upload a new template file.
201 $texte .= '<div>'.$langs->trans("UploadNewTemplate");
202 $maxfilesizearray = getMaxFileSizeArray();
203 $maxmin = $maxfilesizearray['maxmin'];
204 if ($maxmin > 0) {
205 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
206 }
207 $texte .= ' <input type="file" name="uploadfile">';
208 $texte .= '<input type="hidden" value="USER_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
209 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
210 $texte .= '</div>';
211
212 $texte .= '</td>';
213
214 $texte .= '</tr>';
215
216 $texte .= '</table>';
217 $texte .= '</form>';
218
219 return $texte;
220 }
221
222 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
234 public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
235 {
236 // phpcs:enable
237 global $user, $langs, $conf, $mysoc, $hookmanager;
238
239 if (empty($srctemplatepath)) {
240 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
241 return -1;
242 }
243
244 // Add odtgeneration hook
245 if (!is_object($hookmanager)) {
246 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
247 $hookmanager = new HookManager($this->db);
248 }
249 $hookmanager->initHooks(array('odtgeneration'));
250 global $action;
251
252 if (!is_object($outputlangs)) {
253 $outputlangs = $langs;
254 }
255 $sav_charset_output = $outputlangs->charset_output;
256 $outputlangs->charset_output = 'UTF-8';
257
258 // Load translation files required by the page
259 $outputlangs->loadLangs(array("main", "companies", "bills", "dict"));
260
261 if ($conf->user->dir_output) {
262 // If $object is id instead of object
263 if (!is_object($object)) {
264 $id = $object;
265 $object = new User($this->db);
266 $result = $object->fetch($id);
267 if ($result < 0) {
268 dol_print_error($this->db, $object->error);
269 return -1;
270 }
271 }
272
273 $object->fetch_thirdparty();
274
275 $dir = $conf->user->dir_output;
276 $objectref = dol_sanitizeFileName($object->ref);
277 if (!preg_match('/specimen/i', $objectref)) {
278 $dir .= "/".$objectref;
279 }
280 $file = $dir."/".$objectref.".odt";
281
282 if (!file_exists($dir)) {
283 if (dol_mkdir($dir) < 0) {
284 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
285 return -1;
286 }
287 }
288
289 if (file_exists($dir)) {
290 //print "srctemplatepath=".$srctemplatepath; // Src filename
291 $newfile = basename($srctemplatepath);
292 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
293 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
294 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
295
296 $newfiletmp = $objectref . '_' . $newfiletmp;
297
298 // Get extension (ods or odt)
299 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
300 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
301 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
302 if ($format == '1') {
303 $format = '%Y%m%d%H%M%S';
304 }
305 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
306 } else {
307 $filename = $newfiletmp . '.' . $newfileformat;
308 }
309 $file = $dir . '/' . $filename;
310 //print "newdir=".$dir;
311 //print "newfile=".$newfile;
312 //print "file=".$file;
313 //print "conf->user->dir_temp=".$conf->user->dir_temp;
314
315 dol_mkdir($conf->user->dir_temp);
316 if (!is_writable($conf->user->dir_temp)) {
317 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->user->dir_temp);
318 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
319 return -1;
320 }
321
322 // If CUSTOMER contact defined on user, we use it
323 $usecontact = false;
324 $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
325 if (count($arrayidcontact) > 0) {
326 $usecontact = true;
327 $result = $object->fetch_contact($arrayidcontact[0]);
328 }
329
330 // Recipient name
331 if (!empty($usecontact)) {
332 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
333 $socobject = $object->contact;
334 } else {
335 $socobject = $object->thirdparty;
336 // if we have a CUSTOMER contact and we don't use it as recipient we store the contact object for later use
337 $contactobject = $object->contact;
338 }
339 } else {
340 $socobject = $object->thirdparty;
341 }
342
343 // Open and load template
344 require_once ODTPHP_PATH.'odf.php';
345 try {
346 $odfHandler = new Odf(
347 $srctemplatepath,
348 array(
349 'PATH_TO_TMP' => $conf->user->dir_temp,
350 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
351 'DELIMITER_LEFT' => '{',
352 'DELIMITER_RIGHT' => '}'
353 )
354 );
355 } catch (Exception $e) {
356 $this->error = $e->getMessage();
357 dol_syslog($e->getMessage(), LOG_WARNING);
358 return -1;
359 }
360
361 // Make substitutions into odt
362 $array_user = $this->get_substitutionarray_user($object, $outputlangs);
363 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
364 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
365 $array_other = $this->get_substitutionarray_other($outputlangs);
366 // retrieve contact information for use in object as contact_xxx tags
367 $array_thirdparty_contact = array();
368 if ($usecontact && is_object($contactobject)) {
369 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
370 }
371
372 $tmparray = array_merge($array_user, $array_soc, $array_thirdparty, $array_other, $array_thirdparty_contact);
373 complete_substitutions_array($tmparray, $outputlangs, $object);
374 $object->fetch_optionals();
375 // Call the ODTSubstitution hook
376 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
377 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
378 foreach ($tmparray as $key => $value) {
379 try {
380 if (preg_match('/logo$/', $key)) { // Image
381 if (file_exists($value)) {
382 $odfHandler->setImage($key, $value);
383 } else {
384 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
385 }
386 } else { // Text
387 $odfHandler->setVars($key, $value, true, 'UTF-8');
388 }
389 } catch (OdfException $e) {
390 dol_syslog($e->getMessage(), LOG_WARNING);
391 }
392 }
393
394 // Replace labels translated
395 $tmparray = $outputlangs->get_translations_for_substitutions();
396 foreach ($tmparray as $key => $value) {
397 try {
398 $odfHandler->setVars($key, $value, true, 'UTF-8');
399 } catch (OdfException $e) {
400 dol_syslog($e->getMessage(), LOG_WARNING);
401 }
402 }
403
404 // Call the beforeODTSave hook
405 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs);
406 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
407
408 // Write new file
409 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
410 try {
411 $odfHandler->exportAsAttachedPDF($file);
412 } catch (Exception $e) {
413 $this->error = $e->getMessage();
414 dol_syslog($e->getMessage(), LOG_WARNING);
415 return -1;
416 }
417 } else {
418 try {
419 $odfHandler->saveToDisk($file);
420 } catch (Exception $e) {
421 $this->error = $e->getMessage();
422 dol_syslog($e->getMessage(), LOG_WARNING);
423 return -1;
424 }
425 }
426
427 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
428
429 dolChmod($file);
430
431 $odfHandler = null; // Destroy object
432
433 $this->result = array('fullpath' => $file);
434
435 return 1; // Success
436 } else {
437 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
438 return -1;
439 }
440 }
441
442 return -1;
443 }
444
445 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
454 public function get_substitutionarray_object($object, $outputlangs, $array_key = 'object')
455 {
456 // phpcs:enable
457 if (!$object instanceof User) {
458 dol_syslog("Expected User object, got ".gettype($object), LOG_ERR);
459 return array();
460 }
461
462 $array_other = array();
463 foreach ($object as $key => $value) {
464 if (!is_array($value) && !is_object($value)) {
465 $array_other[$array_key.'_'.$key] = $value;
466 }
467 }
468
469 return $array_other;
470 }
471}
$id
Definition account.php:48
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:66
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.
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Class to manage Dolibarr users.
Class to build documents using ODF templates generator.
get_substitutionarray_object($object, $outputlangs, $array_key='object')
get substitution array for object
info($langs)
Return description of a module.
write_file($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk using the generic odt 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($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)
getCallerInfoString()
Get caller info as a string that can be appended to a log message.
dolChmod($filepath, $newmask='')
Change mod of a file.
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
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.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
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.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
global $conf
The following vars must be defined: $type2label $form $conf, $lang, The following vars may also be de...
Definition member.php:79
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition repair.php:149
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:152
getMaxFileSizeArray()
Return the max allowed for file upload.