26 require_once DOL_DOCUMENT_ROOT.
'/core/modules/reception/modules_reception.php';
27 require_once DOL_DOCUMENT_ROOT.
'/product/class/product.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';
42 public $version =
'dolibarr';
52 global $conf, $langs, $mysoc;
54 $langs->loadLangs(array(
"main",
"companies"));
57 $this->
name =
"ODT templates";
58 $this->
description = $langs->trans(
"DocumentModelOdt");
59 $this->scandir =
'RECEPTION_ADDON_PDF_ODT_PATH';
63 $this->page_largeur = 0;
64 $this->page_hauteur = 0;
65 $this->format = array($this->page_largeur, $this->page_hauteur);
66 $this->marge_gauche = 0;
67 $this->marge_droite = 0;
68 $this->marge_haute = 0;
69 $this->marge_basse = 0;
71 $this->option_logo = 1;
72 $this->option_tva = 0;
73 $this->option_modereg = 0;
74 $this->option_condreg = 0;
75 $this->option_multilang = 1;
76 $this->option_escompte = 0;
77 $this->option_credit_note = 0;
78 $this->option_freetext = 1;
79 $this->option_draft_watermark = 0;
82 $this->emetteur = $mysoc;
83 if (!$this->emetteur->country_code) {
84 $this->emetteur->country_code = substr($langs->defaultlang, -2);
95 public function info($langs)
99 $langs->load(
"companies");
100 $langs->load(
"errors");
102 $form =
new Form($this->db);
105 $texte .=
'<form action="'.$_SERVER[
"PHP_SELF"].
'" method="POST">';
106 $texte .=
'<input type="hidden" name="token" value="'.newToken().
'">';
107 $texte .=
'<input type="hidden" name="page_y" value="">';
108 $texte .=
'<input type="hidden" name="action" value="setModuleOptions">';
109 $texte .=
'<input type="hidden" name="param1" value="RECEPTION_ADDON_PDF_ODT_PATH">';
110 $texte .=
'<table class="nobordernopadding centpercent">';
113 $texte .=
'<tr><td>';
114 $texttitle = $langs->trans(
"ListOfDirectories");
115 $listofdir = explode(
',', preg_replace(
'/[\r\n]+/',
',', trim($conf->global->RECEPTION_ADDON_PDF_ODT_PATH)));
116 $listoffiles = array();
117 foreach ($listofdir as $key => $tmpdir) {
118 $tmpdir = trim($tmpdir);
119 $tmpdir = preg_replace(
'/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
121 unset($listofdir[$key]);
124 if (!is_dir($tmpdir)) {
125 $texttitle .=
img_warning($langs->trans(
"ErrorDirNotFound", $tmpdir), 0);
127 $tmpfiles =
dol_dir_list($tmpdir,
'files', 0,
'\.(ods|odt)');
128 if (count($tmpfiles)) {
129 $listoffiles = array_merge($listoffiles, $tmpfiles);
133 $texthelp = $langs->trans(
"ListOfDirectoriesForModelGenODT");
134 $texthelp .=
'<br><br><span class="opacitymedium">'.$langs->trans(
"ExampleOfDirectoriesForModelGen").
'</span>';
136 $texthelp .=
'<br>'.$langs->trans(
"FollowingSubstitutionKeysCanBeUsed").
'<br>';
137 $texthelp .= $langs->transnoentitiesnoconv(
"FullListOnOnlineDocumentation");
139 $texte .= $form->textwithpicto($texttitle, $texthelp, 1,
'help',
'', 1, 3, $this->
name);
140 $texte .=
'<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
141 $texte .=
'<textarea class="flat" cols="60" name="value1">';
143 $texte .=
'</textarea>';
144 $texte .=
'</div><div style="display: inline-block; vertical-align: middle;">';
145 $texte .=
'<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.$langs->trans(
"Modify").
'">';
146 $texte .=
'<br></div></div>';
149 $nbofiles = count($listoffiles);
151 $texte .= $langs->trans(
"NumberOfModelFilesFound").
': <b>';
153 $texte .= count($listoffiles);
158 $texte .=
'<div id="div_'.get_class($this).
'" class="hiddenx">';
160 foreach ($listoffiles as $file) {
161 $texte .=
'- '.$file[
'name'].
' <a href="'.DOL_URL_ROOT.
'/document.php?modulepart=doctemplates&file=receptions/'.urlencode(basename($file[
'name'])).
'">'.
img_picto(
'',
'listlight').
'</a>';
162 $texte .=
' <a class="reposition" href="'.$_SERVER[
"PHP_SELF"].
'?modulepart=doctemplates&keyforuploaddir=RECEPTION_ADDON_PDF_ODT_PATH&action=deletefile&token='.
newToken().
'&file='.urlencode(basename($file[
'name'])).
'">'.
img_picto(
'',
'delete').
'</a>';
168 $texte .=
'<div>'.$langs->trans(
"UploadNewTemplate");
170 $maxmin = $maxfilesizearray[
'maxmin'];
172 $texte .=
'<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).
'">';
174 $texte .=
' <input type="file" name="uploadfile">';
175 $texte .=
'<input type="hidden" value="RECEPTION_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
176 $texte .=
'<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans(
"Upload")).
'" name="upload">';
183 $texte .=
'</table>';
201 public function write_file(
$object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
204 global $user, $langs, $conf, $mysoc, $hookmanager;
206 if (empty($srctemplatepath)) {
207 dol_syslog(
"doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
212 if (!is_object($hookmanager)) {
213 include_once DOL_DOCUMENT_ROOT.
'/core/class/hookmanager.class.php';
216 $hookmanager->initHooks(array(
'odtgeneration'));
219 if (!is_object($outputlangs)) {
220 $outputlangs = $langs;
222 $sav_charset_output = $outputlangs->charset_output;
223 $outputlangs->charset_output =
'UTF-8';
225 $outputlangs->loadLangs(array(
"main",
"dict",
"companies",
"bills"));
227 if ($conf->reception->dir_output) {
241 $dir = !empty($conf->reception->multidir_output[
$object->entity]) ? $conf->reception->multidir_output[
$object->entity] : $conf->reception->dir_output;
243 if (!preg_match(
'/specimen/i', $objectref)) {
244 $dir .=
"/".$objectref;
246 $file = $dir.
"/".$objectref.
".odt";
248 if (!file_exists($dir)) {
250 $this->error = $langs->transnoentities(
"ErrorCanNotCreateDir", $dir);
255 if (file_exists($dir)) {
257 $newfile = basename($srctemplatepath);
258 $newfiletmp = preg_replace(
'/\.od[ts]/i',
'', $newfile);
259 $newfiletmp = preg_replace(
'/template_/i',
'', $newfiletmp);
260 $newfiletmp = preg_replace(
'/modele_/i',
'', $newfiletmp);
261 $newfiletmp = $objectref .
'_' . $newfiletmp;
264 $newfileformat = substr($newfile, strrpos($newfile,
'.') + 1);
267 if ($format ==
'1') {
268 $format =
'%Y%m%d%H%M%S';
272 $filename = $newfiletmp .
'.' . $newfileformat;
274 $file = $dir .
'/' . $filename;
281 if (!is_writable($conf->reception->dir_temp)) {
282 $this->error = $langs->transnoentities(
"ErrorFailedToWriteInTempDirectory", $conf->reception->dir_temp);
283 dol_syslog(
'Error in write_file: ' . $this->error, LOG_ERR);
289 $arrayidcontact =
$object->getIdContact(
'external',
'CUSTOMER');
290 if (count($arrayidcontact) > 0) {
292 $result =
$object->fetch_contact($arrayidcontact[0]);
296 $contactobject =
null;
297 if (!empty($usecontact)) {
299 if (
$object->contact->socid !=
$object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) ||
getDolGlobalString(
'MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
300 $object->contact->fetch_thirdparty();
301 $socobject =
$object->contact->thirdparty;
302 $contactobject =
$object->contact;
304 $socobject =
$object->thirdparty;
306 $contactobject =
$object->contact;
309 $socobject =
$object->thirdparty;
313 $substitutionarray = array(
314 '__FROM_NAME__' => $this->emetteur->name,
315 '__FROM_EMAIL__' => $this->emetteur->email,
316 '__TOTAL_TTC__' =>
$object->total_ttc,
317 '__TOTAL_HT__' =>
$object->total_ht,
318 '__TOTAL_VAT__' =>
$object->total_tva
323 $parameters = array(
'file'=>$file,
'object'=>
$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$substitutionarray);
324 $reshook = $hookmanager->executeHooks(
'ODTSubstitution', $parameters, $this, $action);
328 $paramfreetext =
'RECEPTION_FREE_TEXT';
329 if (!empty($conf->global->$paramfreetext)) {
334 require_once ODTPHP_PATH.
'odf.php';
336 $odfHandler =
new Odf(
339 'PATH_TO_TMP' => $conf->reception->dir_temp,
340 'ZIP_PROXY' =>
'PclZipProxy',
341 'DELIMITER_LEFT' =>
'{',
342 'DELIMITER_RIGHT' =>
'}'
346 $this->error = $e->getMessage();
359 $odfHandler->setVars(
'free_text', $newfreetext,
true,
'UTF-8');
360 }
catch (OdfException $e) {
367 $array_objet = $this->get_substitutionarray_object(
$object, $outputlangs);
373 $array_thirdparty_contact = array();
374 if ($usecontact && is_object($contactobject)) {
378 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_other, $array_thirdparty_contact);
382 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>
$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray);
383 $reshook = $hookmanager->executeHooks(
'ODTSubstitution', $parameters, $this, $action);
384 foreach ($tmparray as $key => $value) {
386 if (preg_match(
'/logo$/', $key)) {
387 if (file_exists($value)) {
388 $odfHandler->setImage($key, $value);
390 $odfHandler->setVars($key,
'ErrorFileNotFound',
true,
'UTF-8');
393 $odfHandler->setVars($key, $value,
true,
'UTF-8');
395 }
catch (OdfException $e) {
401 $foundtagforlines = 1;
403 $listlines = $odfHandler->setSegment(
'lines');
404 }
catch (OdfExceptionSegmentNotFound $e) {
406 $foundtagforlines = 0;
408 }
catch (OdfException $e) {
409 $foundtagforlines = 0;
412 if ($foundtagforlines) {
414 foreach (
$object->lines as $line) {
419 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>
$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray,
'line'=>$line);
420 $reshook = $hookmanager->executeHooks(
'ODTSubstitutionLine', $parameters, $this, $action);
421 foreach ($tmparray as $key => $val) {
423 $listlines->setVars($key, $val,
true,
'UTF-8');
424 }
catch (OdfException $e) {
426 }
catch (SegmentException $e) {
432 $odfHandler->mergeSegment($listlines);
434 }
catch (OdfException $e) {
435 $this->error = $e->getMessage();
441 $tmparray = $outputlangs->get_translations_for_substitutions();
442 foreach ($tmparray as $key => $value) {
444 $odfHandler->setVars($key, $value,
true,
'UTF-8');
445 }
catch (OdfException $e) {
451 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>
$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray);
452 $reshook = $hookmanager->executeHooks(
'beforeODTSave', $parameters, $this, $action);
457 $odfHandler->exportAsAttachedPDF($file);
459 $this->error = $e->getMessage();
465 $odfHandler->saveToDisk($file);
467 $this->error = $e->getMessage();
472 $parameters = array(
'odfHandler'=>&$odfHandler,
'file'=>$file,
'object'=>
$object,
'outputlangs'=>$outputlangs,
'substitutionarray'=>&$tmparray);
473 $reshook = $hookmanager->executeHooks(
'afterODTCreation', $parameters, $this, $action);
479 $this->result = array(
'fullpath'=>$file);
483 $this->error = $langs->transnoentities(
"ErrorCanNotCreateDir", $dir);
if($user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
get_substitutionarray_each_var_object(&$object, $outputlangs, $recursive=1)
Define array with couple substitution key => substitution value.
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.
Parent class of sending receipts models.
Class to manage receptions.
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.
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.
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)
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...
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.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getCommonSubstitutionArray($outputlangs, $onlykey=0, $exclude=null, $object=null, $include=null)
Return array of possible common substitutions.
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
$conf db name
Only used if Module[ID]Name translation string is not found.
getMaxFileSizeArray()
Return the max allowed for file upload.