dolibarr 25.0.0-alpha
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-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/member/modules_member.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 = 'MEMBER_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 FACTURE_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 // Retrieves issuer
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 $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 $texte = $this->description.".<br>\n";
113 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
114 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
115 $texte .= '<input type="hidden" name="page_y" value="">';
116 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
117 $texte .= '<input type="hidden" name="param1" value="MEMBER_ADDON_PDF_ODT_PATH">';
118 $texte .= '<table class="nobordernopadding" width="100%">';
119
120 // List of directories area
121 $texte .= '<tr><td>';
122 $texttitle = $langs->trans("ListOfDirectories");
123 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim(getDolGlobalString('MEMBER_ADDON_PDF_ODT_PATH'))));
124 $listoffiles = array();
125 foreach ($listofdir as $key => $tmpdir) {
126 $tmpdir = trim($tmpdir);
127 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
128 if (!$tmpdir) {
129 unset($listofdir[$key]);
130 continue;
131 }
132 if (!is_dir($tmpdir)) {
133 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), '');
134 } else {
135 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
136 if (count($tmpfiles)) {
137 $listoffiles = array_merge($listoffiles, $tmpfiles);
138 }
139 }
140 }
141 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
142 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
143 // Add list of substitution keys
144 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
145 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
146
147 // Scan directories
148 if (count($listofdir)) {
149 $texte .= '<span class="opacitylow">'.$langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b></span><br>';
150
151 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx opacitylow">';
152 // Show list of found files
153 foreach ($listoffiles as $file) {
154 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=members/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
155 $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>';
156 $texte .= '<br>';
157 }
158 $texte .= '</div>';
159 }
160 $texte .= '<br>';
161 // Link to show/hide the area to manage directories of ODT models and template files
162 $texte .= '<span class="classlink cursorpointer" onclick="javascript: jQuery(\'.div_odtmodelsof'.get_class($this).'\').toggle();">'.img_picto('', 'add').' '.$langs->trans("UploadNewTemplate").'...</span>';
163 $texte .= '<div class="div_odtmodelsof'.get_class($this).'" style="display: none; margin-top: 6px;">';
164 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
165 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
166 $texte .= '<textarea class="flat textareafordir" spellcheck="false" cols="60" name="value1">';
167 $texte .= getDolGlobalString('MEMBER_ADDON_PDF_ODT_PATH');
168 $texte .= '</textarea>';
169 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
170 $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
171 $texte .= '<br></div></div>';
172 $texte .= '</div>';
173
174 // Add input to upload a new template file.
175 $texte .= '<div class="div_odtmodelsof'.get_class($this).'" style="display: none;">';
176 $maxfilesizearray = getMaxFileSizeArray();
177 $maxmin = $maxfilesizearray['maxmin'];
178 if ($maxmin > 0) {
179 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
180 }
181 $texte .= ' <input type="file" name="uploadfile">';
182 $texte .= '<input type="hidden" value="MEMBER_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
183 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
184 $texte .= '</div>';
185 $texte .= '</td>';
186
187 $texte .= '</tr>';
188
189 $texte .= '</table>';
190 $texte .= '</form>';
191
192 return $texte;
193 }
194
195 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
207 public function write_file($object, $outputlangs, $srctemplatepath = '', $mode = 'member', $nooutput = 0, $filename = 'tmp_cards')
208 {
209 // phpcs:enable
210 global $langs, $conf, $mysoc, $hookmanager;
211
212 if (empty($srctemplatepath)) {
213 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
214 return -1;
215 }
216
217 // Add odtgeneration hook
218 if (!is_object($hookmanager)) {
219 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
220 $hookmanager = new HookManager($this->db);
221 }
222 $hookmanager->initHooks(array('odtgeneration'));
223 global $action;
224
225 if (!is_object($outputlangs)) {
226 $outputlangs = $langs;
227 }
228 $sav_charset_output = $outputlangs->charset_output;
229 $outputlangs->charset_output = 'UTF-8';
230
231 // Load translation files required by the page
232 $outputlangs->loadLangs(array("main", "companies", "bills", "dict"));
233
234 if ($conf->adherent->dir_output) {
235 // If $object is id instead of object
236 if (!is_object($object)) {
237 $id = $object;
238 $object = new User($this->db);
239 $result = $object->fetch($id);
240 if ($result < 0) {
241 dol_print_error($this->db, $object->error);
242 return -1;
243 }
244 }
245
246 $object->fetch_thirdparty();
247
248 $dir = $conf->adherent->dir_output;
249 $objectref = dol_sanitizeFileName($object->ref);
250 if (!preg_match('/specimen/i', $objectref)) {
251 $dir .= "/".$objectref;
252 }
253 $file = $dir."/".$objectref.".odt";
254
255 if (!file_exists($dir)) {
256 if (dol_mkdir($dir) < 0) {
257 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
258 return -1;
259 }
260 }
261
262 if (file_exists($dir)) {
263 //print "srctemplatepath=".$srctemplatepath; // Src filename
264 $newfile = basename($srctemplatepath);
265 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
266 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
267 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
268
269 $newfiletmp = $objectref . '_' . $newfiletmp;
270
271 // Get extension (ods or odt)
272 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
273 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
274 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
275 if ($format == '1') {
276 $format = '%Y%m%d%H%M%S';
277 }
278 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
279 } else {
280 $filename = $newfiletmp . '.' . $newfileformat;
281 }
282 $file = $dir . '/' . $filename;
283 //print "newdir=".$dir;
284 //print "newfile=".$newfile;
285 //print "file=".$file;
286 //print "conf->adherent->dir_temp=".$conf->adherent->dir_temp;
287
288 dol_mkdir($conf->adherent->dir_temp);
289 if (!is_writable($conf->adherent->dir_temp)) {
290 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->adherent->dir_temp);
291 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
292 return -1;
293 }
294
295 // If CUSTOMER contact defined on member, we use it
296 $usecontact = false;
297 $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
298 if (count($arrayidcontact) > 0) {
299 $usecontact = true;
300 $result = $object->fetch_contact($arrayidcontact[0]);
301 }
302
303 $contactobject = null;
304 // Recipient name
305 if (!empty($usecontact)) {
306 // We can use the company of contact instead of thirdparty company
307 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
308 $object->contact->fetch_thirdparty();
309 $socobject = $object->contact->thirdparty;
310 $contactobject = $object->contact;
311 } else {
312 $socobject = $object->thirdparty;
313 // if we have a CUSTOMER contact and we don't use it as thirdparty recipient we store the contact object for later use
314 $contactobject = $object->contact;
315 }
316 } else {
317 $socobject = $object->thirdparty;
318 }
319
320 // Open and load template
321 require_once ODTPHP_PATH.'odf.php';
322 try {
323 $odfHandler = new Odf(
324 $srctemplatepath,
325 array(
326 'PATH_TO_TMP' => $conf->adherent->dir_temp,
327 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
328 'DELIMITER_LEFT' => '{',
329 'DELIMITER_RIGHT' => '}'
330 )
331 );
332 } catch (Exception $e) {
333 $this->error = $e->getMessage();
334 dol_syslog($e->getMessage(), LOG_WARNING);
335 return -1;
336 }
337
338 // Make substitutions into odt
339 $array_member = $this->getSubstitutionarrayMember($object, $outputlangs);
340 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
341 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
342 $array_other = $this->get_substitutionarray_other($outputlangs);
343 // retrieve contact information for use in object as contact_xxx tags
344 $array_thirdparty_contact = array();
345 if ($usecontact && is_object($contactobject)) {
346 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
347 }
348
349 $tmparray = array_merge($array_member, $array_soc, $array_thirdparty, $array_other, $array_thirdparty_contact);
350 complete_substitutions_array($tmparray, $outputlangs, $object);
351
352 // Call the ODTSubstitution hook
353 $parameters = array(
354 'file' => $file,
355 'object' => $object,
356 'outputlangs' => $outputlangs,
357 'substitutionarray' => &$tmparray
358 );
359 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
360
361 // retrieve the constant to apply a ratio for image size or set the ratio to 1
362 if (getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO')) {
363 $ratio = (float) getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO');
364 } else {
365 $ratio = 1;
366 }
367
368 foreach ($tmparray as $key => $value) {
369 try {
370 if (preg_match('/logo$/', $key)) {
371 // Image
372 if (file_exists($value)) {
373 $odfHandler->setImage($key, $value, $ratio);
374 } else {
375 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
376 }
377 } else {
378 // Text
379 $odfHandler->setVars($key, $value, true, 'UTF-8');
380 }
381 } catch (OdfException $e) {
382 dol_syslog($e->getMessage(), LOG_WARNING);
383 }
384 }
385
386 // Replace labels translated
387 $tmparray = $outputlangs->get_translations_for_substitutions();
388 foreach ($tmparray as $key => $value) {
389 try {
390 $odfHandler->setVars($key, $value, true, 'UTF-8');
391 } catch (OdfException $e) {
392 dol_syslog($e->getMessage(), LOG_WARNING);
393 }
394 }
395
396 // Call the beforeODTSave hook
397 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs);
398 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
399
400 // Write new file
401 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
402 try {
403 $odfHandler->exportAsAttachedPDF($file);
404 } catch (Exception $e) {
405 $this->error = $e->getMessage();
406 dol_syslog($e->getMessage(), LOG_WARNING);
407 return -1;
408 }
409 } else {
410 try {
411 $odfHandler->saveToDisk($file);
412 } catch (Exception $e) {
413 $this->error = $e->getMessage();
414 dol_syslog($e->getMessage(), LOG_WARNING);
415 return -1;
416 }
417 }
418
419 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
420
421 dolChmod($file);
422
423 $odfHandler = null; // Destroy object
424
425 $this->result = array('fullpath' => $file);
426
427 return 1; // Success
428 } else {
429 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
430 return -1;
431 }
432 }
433
434 return -1;
435 }
436
437 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
446 public function get_substitutionarray_object($object, $outputlangs, $array_key = 'object')
447 {
448 // phpcs:enable
449 if (!$object instanceof Adherent) {
450 dol_syslog("Expected Adherent object, got ".gettype($object), LOG_ERR);
451 return array();
452 }
453
454 $array_other = array();
455 foreach ($object as $key => $value) {
456 if (!is_array($value) && !is_object($value)) {
457 $array_other[$array_key.'_'.$key] = $value;
458 }
459 }
460 return $array_other;
461 }
462}
$propal type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition propal.php:281
Class to manage members of a foundation.
Class to manage generation of HTML components Only common components must be here.
Parent class to manage intervention document templates.
Class to build documents using ODF templates generator.
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.
global $mysoc
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:66
getCallerInfoString()
Get caller info as a string that can be appended to a log message.
newToken()
Return the value of token currently saved into session with name 'newtoken'.
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.
conf($dolibarr_main_document_root, $realpathconf=null)
Load conf file (file must exists)
Definition inc.php:431
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:165
multi select button
0 = Do not include form tag and submit button -1 = Do not include form tag but include submit button