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';
50 public $version =
'dolibarr';
60 global $conf, $langs, $mysoc;
63 $langs->loadLangs(array(
"main",
"companies"));
66 $this->
name =
"ODT templates";
67 $this->
description = $langs->trans(
"DocumentModelOdt");
68 $this->scandir =
'CONTRACT_ADDON_PDF_ODT_PATH';
72 $this->page_largeur = 0;
73 $this->page_hauteur = 0;
74 $this->format = array($this->page_largeur, $this->page_hauteur);
75 $this->marge_gauche = 0;
76 $this->marge_droite = 0;
77 $this->marge_haute = 0;
78 $this->marge_basse = 0;
80 $this->option_logo = 1;
81 $this->option_tva = 0;
82 $this->option_modereg = 0;
83 $this->option_condreg = 0;
84 $this->option_multilang = 1;
85 $this->option_escompte = 0;
86 $this->option_credit_note = 0;
87 $this->option_freetext = 1;
88 $this->option_draft_watermark = 0;
91 $this->emetteur = $mysoc;
92 if (!$this->emetteur->country_code) {
93 $this->emetteur->country_code = substr($langs->defaultlang, -2);
106 global $conf, $langs;
109 $langs->loadLangs(array(
'companies',
'errors'));
114 $texte .=
'<form action="'.$_SERVER[
"PHP_SELF"].
'" method="POST" enctype="multipart/form-data">';
115 $texte .=
'<input type="hidden" name="token" value="'.newToken().
'">';
116 $texte .=
'<input type="hidden" name="page_y" value="">';
117 $texte .=
'<input type="hidden" name="action" value="setModuleOptions">';
118 $texte .=
'<input type="hidden" name="param1" value="CONTRACT_ADDON_PDF_ODT_PATH">';
119 $texte .=
'<table class="nobordernopadding centpercent">';
122 $texte .=
'<tr><td>';
123 $texttitle = $langs->trans(
"ListOfDirectories");
124 $listofdir = explode(
',', preg_replace(
'/[\r\n]+/',
',', trim($conf->global->CONTRACT_ADDON_PDF_ODT_PATH)));
125 $listoffiles = array();
126 foreach ($listofdir as $key => $tmpdir) {
127 $tmpdir = trim($tmpdir);
128 $tmpdir = preg_replace(
'/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
130 unset($listofdir[$key]);
133 if (!is_dir($tmpdir)) {
134 $texttitle .=
img_warning($langs->trans(
"ErrorDirNotFound", $tmpdir), 0);
136 $tmpfiles =
dol_dir_list($tmpdir,
'files', 0,
'\.(ods|odt)');
137 if (count($tmpfiles)) {
138 $listoffiles = array_merge($listoffiles, $tmpfiles);
142 $texthelp = $langs->trans(
"ListOfDirectoriesForModelGenODT");
144 $texthelp .=
'<br>'.$langs->trans(
"FollowingSubstitutionKeysCanBeUsed").
'<br>';
145 $texthelp .= $langs->transnoentitiesnoconv(
"FullListOnOnlineDocumentation");
147 $texte .=
$form->textwithpicto($texttitle, $texthelp, 1,
'help',
'', 1);
148 $texte .=
'<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
149 $texte .=
'<textarea class="flat" cols="60" name="value1">';
150 $texte .= $conf->global->CONTRACT_ADDON_PDF_ODT_PATH;
151 $texte .=
'</textarea>';
152 $texte .=
'</div><div style="display: inline-block; vertical-align: middle;">';
153 $texte .=
'<input type="submit" class="button small reposition" value="'.dol_escape_htmltag($langs->trans(
"Modify")).
'" name="Button">';
154 $texte .=
'<br></div></div>';
157 $nbofiles = count($listoffiles);
158 if (!empty($conf->global->CONTRACT_ADDON_PDF_ODT_PATH)) {
159 $texte .= $langs->trans(
"NumberOfModelFilesFound").
': <b>';
161 $texte .= count($listoffiles);
167 $texte .=
'<div id="div_'.get_class($this).
'" class="hiddenx">';
169 foreach ($listoffiles as $file) {
170 $texte .=
'- '.$file[
'name'].
' <a href="'.DOL_URL_ROOT.
'/document.php?modulepart=doctemplates&file=contracts/'.urlencode(basename($file[
'name'])).
'">'.
img_picto(
'',
'listlight').
'</a>';
171 $texte .=
' <a class="reposition" href="'.$_SERVER[
"PHP_SELF"].
'?modulepart=doctemplates&keyforuploaddir=CONTRACT_ADDON_PDF_ODT_PATH&action=deletefile&token='.
newToken().
'&file='.urlencode(basename($file[
'name'])).
'">'.
img_picto(
'',
'delete').
'</a>';
177 $texte .=
'<div>'.$langs->trans(
"UploadNewTemplate");
179 $maxmin = $maxfilesizearray[
'maxmin'];
181 $texte .=
'<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).
'">';
183 $texte .=
' <input type="file" name="uploadfile">';
184 $texte .=
'<input type="hidden" value="CONTRACT_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
185 $texte .=
'<input type="submit" class="button small reposition" value="'.dol_escape_htmltag($langs->trans(
"Upload")).
'" name="upload">';
190 $texte .=
'<td rowspan="2" class="tdtop hideonsmartphone">';
191 $texte .=
'<span class="opacitymedium">';
192 $texte .= $langs->trans(
"ExampleOfDirectoriesForModelGen");
197 $texte .=
'</table>';
215 public function write_file($object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
218 global $user, $langs, $conf, $mysoc, $hookmanager;
220 if (empty($srctemplatepath)) {
221 dol_syslog(
"doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
226 if (!is_object($hookmanager)) {
227 include_once DOL_DOCUMENT_ROOT.
'/core/class/hookmanager.class.php';
230 $hookmanager->initHooks(array(
'odtgeneration'));
233 if (!is_object($outputlangs)) {
234 $outputlangs = $langs;
236 $sav_charset_output = $outputlangs->charset_output;
237 $outputlangs->charset_output =
'UTF-8';
240 $outputlangs->loadLangs(array(
"main",
"dict",
"companies",
"bills"));
242 if ($conf->contrat->multidir_output[$object->entity]) {
244 if (!is_object($object)) {
246 $object =
new Contrat($this->db);
247 $result = $object->fetch($id);
254 $object->fetch_thirdparty();
256 $dir = $conf->contrat->multidir_output[$object->entity];
258 if (!preg_match(
'/specimen/i', $objectref)) {
259 $dir .=
"/".$objectref;
261 $file = $dir.
"/".$objectref.
".odt";
263 if (!file_exists($dir)) {
265 $this->error = $langs->transnoentities(
"ErrorCanNotCreateDir", $dir);
270 if (file_exists($dir)) {
272 $newfile = basename($srctemplatepath);
273 $newfiletmp = preg_replace(
'/\.od[ts]/i',
'', $newfile);
274 $newfiletmp = preg_replace(
'/template_/i',
'', $newfiletmp);
275 $newfiletmp = preg_replace(
'/modele_/i',
'', $newfiletmp);
277 $newfiletmp = $objectref .
'_' . $newfiletmp;
280 $newfileformat = substr($newfile, strrpos($newfile,
'.') + 1);
283 if ($format ==
'1') {
284 $format =
'%Y%m%d%H%M%S';
288 $filename = $newfiletmp .
'.' . $newfileformat;
290 $file = $dir .
'/' . $filename;
297 if (!is_writable($conf->contrat->dir_temp)) {
298 $this->error = $langs->transnoentities(
"ErrorFailedToWriteInTempDirectory", $conf->contrat->dir_temp);
299 dol_syslog(
'Error in write_file: ' . $this->error, LOG_ERR);
305 $arrayidcontact = $object->getIdContact(
'external',
'CUSTOMER');
306 if (count($arrayidcontact) > 0) {
308 $result = $object->fetch_contact($arrayidcontact[0]);
312 $contactobject =
null;
313 if (!empty($usecontact)) {
315 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))) {
316 $object->contact->fetch_thirdparty();
317 $socobject = $object->contact->thirdparty;
318 $contactobject = $object->contact;
320 $socobject = $object->thirdparty;
322 $contactobject = $object->contact;
325 $socobject = $object->thirdparty;
328 $object->fetch_optionals();
340 $array_thirdparty_contact = array();
341 if ($usecontact && is_object($contactobject)) {
345 $substitutionarray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_other, $array_thirdparty_contact);
348 $tmparray = $substitutionarray;
351 $parameters = array(
'file'=>$file,
'object'=>$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray);
352 $reshook = $hookmanager->executeHooks(
'ODTSubstitution', $parameters, $this, $action);
356 $paramfreetext =
'CONTRACT_FREE_TEXT';
357 if (!empty($conf->global->$paramfreetext)) {
363 require_once ODTPHP_PATH.
'odf.php';
365 $odfHandler =
new Odf(
368 'PATH_TO_TMP' => $conf->contrat->dir_temp,
369 'ZIP_PROXY' =>
'PclZipProxy',
370 'DELIMITER_LEFT' =>
'{',
371 'DELIMITER_RIGHT' =>
'}'
375 $this->error = $e->getMessage();
388 $odfHandler->setVars(
'free_text', $newfreetext,
true,
'UTF-8');
389 }
catch (OdfException $e) {
394 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray);
395 $reshook = $hookmanager->executeHooks(
'ODTSubstitution', $parameters, $this, $action);
397 foreach ($tmparray as $key => $value) {
399 if (preg_match(
'/logo$/', $key)) {
401 if (file_exists($value)) {
402 $odfHandler->setImage($key, $value);
404 $odfHandler->setVars($key,
'ErrorFileNotFound',
true,
'UTF-8');
408 $odfHandler->setVars($key, $value,
true,
'UTF-8');
410 }
catch (OdfException $e) {
417 $foundtagforlines = 1;
419 $listlines = $odfHandler->setSegment(
'lines');
420 }
catch (OdfException $e) {
422 $foundtagforlines = 0;
425 if ($foundtagforlines) {
427 foreach ($object->lines as $line) {
432 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray,
'line'=>$line);
433 $reshook = $hookmanager->executeHooks(
'ODTSubstitutionLine', $parameters, $this, $action);
434 foreach ($tmparray as $key => $val) {
436 $listlines->setVars($key, $val,
true,
'UTF-8');
437 }
catch (OdfException $e) {
439 }
catch (SegmentException $e) {
445 $odfHandler->mergeSegment($listlines);
447 }
catch (OdfException $e) {
448 $this->error = $e->getMessage();
454 $tmparray = $outputlangs->get_translations_for_substitutions();
455 foreach ($tmparray as $key => $value) {
457 $odfHandler->setVars($key, $value,
true,
'UTF-8');
458 }
catch (OdfException $e) {
464 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray);
465 $reshook = $hookmanager->executeHooks(
'beforeODTSave', $parameters, $this, $action);
468 if (!empty($conf->global->MAIN_ODT_AS_PDF)) {
470 $odfHandler->exportAsAttachedPDF($file);
472 $this->error = $e->getMessage();
478 $odfHandler->saveToDisk($file);
480 $this->error = $e->getMessage();
486 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray);
487 $reshook = $hookmanager->executeHooks(
'afterODTCreation', $parameters, $this, $action);
493 $this->result = array(
'fullpath'=>$file);
497 $this->error = $langs->transnoentities(
"ErrorCanNotCreateDir", $dir);
get_substitutionarray_each_var_object(&$object, $outputlangs, $recursive=1)
Define array with couple substitution key => substitution value.
get_substitutionarray_object($object, $outputlangs, $array_key='object')
Define array with couple substitution key => substitution value Note that vars into substitutions arr...
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_lines($line, $outputlangs, $linenumber=0)
Define array with couple substitution key => substitution value Note that vars into substitutions arr...
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 contracts.
Parent class to manage intervention document templates.
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($cancel &&! $id) if($action=='add' &&! $cancel) if($action=='delete') if($id) $form
Actions.
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($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.
img_warning($titlealt='default', $moreatt='', $morecss='pictowarning')
Show warning logo.
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs='', $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
dolChmod($filepath, $newmask='')
Change mod of a file.
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return dolibarr global constant int value.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
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...
make_substitutions($text, $substitutionarray, $outputlangs=null, $converttextinhtmlifnecessary=0)
Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newva...
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
getCommonSubstitutionArray($outputlangs, $onlykey=0, $exclude=null, $object=null, $include=null)
Return array of possible common substitutions.
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
$conf db name
Only used if Module[ID]Name translation string is not found.
getMaxFileSizeArray()
Return the max allowed for file upload.