32 require_once DOL_DOCUMENT_ROOT.
'/product/class/product.class.php';
33 require_once DOL_DOCUMENT_ROOT.
'/core/lib/company.lib.php';
34 require_once DOL_DOCUMENT_ROOT.
'/core/lib/functions2.lib.php';
35 require_once DOL_DOCUMENT_ROOT.
'/core/lib/files.lib.php';
36 require_once DOL_DOCUMENT_ROOT.
'/core/lib/doc.lib.php';
54 public $phpmin = array(7, 0);
59 public $version =
'dolibarr';
69 global $langs, $mysoc;
72 $langs->loadLangs(array(
"main",
"companies"));
75 $this->
name =
"ODT templates";
76 $this->
description = $langs->trans(
"DocumentModelOdt");
77 $this->scandir =
'MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH';
81 $this->page_largeur = 0;
82 $this->page_hauteur = 0;
83 $this->format = array($this->page_largeur, $this->page_hauteur);
84 $this->marge_gauche = 0;
85 $this->marge_droite = 0;
86 $this->marge_haute = 0;
87 $this->marge_basse = 0;
89 $this->option_logo = 1;
90 $this->option_tva = 0;
91 $this->option_modereg = 0;
92 $this->option_condreg = 0;
93 $this->option_multilang = 1;
94 $this->option_escompte = 0;
95 $this->option_credit_note = 0;
96 $this->option_freetext = 1;
97 $this->option_draft_watermark = 0;
100 $this->emetteur = $mysoc;
101 if (!$this->emetteur->country_code) {
102 $this->emetteur->country_code = substr($langs->defaultlang, -2);
115 global $conf, $langs;
118 $langs->loadLangs(array(
"errors",
"companies"));
120 $form =
new Form($this->db);
123 $texte .=
'<form action="'.$_SERVER[
"PHP_SELF"].
'" method="POST" enctype="multipart/form-data">';
124 $texte .=
'<input type="hidden" name="token" value="'.newToken().
'">';
125 $texte .=
'<input type="hidden" name="page_y" value="">';
126 $texte .=
'<input type="hidden" name="action" value="setModuleOptions">';
127 $texte .=
'<input type="hidden" name="param1" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH">';
128 $texte .=
'<table class="nobordernopadding centpercent">';
131 $texte .=
'<tr><td>';
132 $texttitle = $langs->trans(
"ListOfDirectories");
133 $listofdir = explode(
',', preg_replace(
'/[\r\n]+/',
',', trim(
getDolGlobalString(
'MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH'))));
134 $listoffiles = array();
135 foreach ($listofdir as $key => $tmpdir) {
136 $tmpdir = trim($tmpdir);
137 $tmpdir = preg_replace(
'/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
139 unset($listofdir[$key]);
142 if (!is_dir($tmpdir)) {
143 $texttitle .=
img_warning($langs->trans(
"ErrorDirNotFound", $tmpdir), 0);
145 $tmpfiles =
dol_dir_list($tmpdir,
'files', 0,
'\.(ods|odt)');
146 if (count($tmpfiles)) {
147 $listoffiles = array_merge($listoffiles, $tmpfiles);
151 $texthelp = $langs->trans(
"ListOfDirectoriesForModelGenODT");
152 $texthelp .=
'<br><br><span class="opacitymedium">'.$langs->trans(
"ExampleOfDirectoriesForModelGen").
'</span>';
154 $texthelp .=
'<br>'.$langs->trans(
"FollowingSubstitutionKeysCanBeUsed").
'<br>';
155 $texthelp .= $langs->transnoentitiesnoconv(
"FullListOnOnlineDocumentation");
158 $texte .= $form->textwithpicto($texttitle, $texthelp, 1,
'help',
'', 1, 3, $this->
name);
159 $texte .=
'<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
160 $texte .=
'<textarea class="flat" cols="60" name="value1">';
162 $texte .=
'</textarea>';
163 $texte .=
'</div><div style="display: inline-block; vertical-align: middle;">';
164 $texte .=
'<input type="submit" class="button smallpaddingimp reposition" name="modify" value="'.dol_escape_htmltag($langs->trans(
"Modify")).
'">';
165 $texte .=
'<br></div></div>';
168 $texte .=
'<input type="hidden" name="value1" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH">';
172 $nbofiles = count($listoffiles);
174 $texte .= $langs->trans(
"NumberOfModelFilesFound").
': <b>';
176 $texte .= count($listoffiles);
182 $texte .=
'<div id="div_'.get_class($this).
'" class="hiddenx">';
184 foreach ($listoffiles as $file) {
185 $texte .=
'- '.$file[
'name'].
' <a href="'.DOL_URL_ROOT.
'/document.php?modulepart=doctemplates&file=mymodule_myobject/'.urlencode(basename($file[
'name'])).
'">'.
img_picto(
'',
'listlight').
'</a>';
186 $texte .=
' <a class="reposition" href="'.$_SERVER[
"PHP_SELF"].
'?modulepart=doctemplates&keyforuploaddir=MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH&action=deletefile&token='.
newToken().
'&file='.urlencode(basename($file[
'name'])).
'">'.
img_picto(
'',
'delete').
'</a>';
193 $texte .=
'<div>'.$langs->trans(
"UploadNewTemplate");
195 $maxmin = $maxfilesizearray[
'maxmin'];
197 $texte .=
'<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).
'">';
199 $texte .=
' <input type="file" name="uploadfile">';
200 $texte .=
'<input type="hidden" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
201 $texte .=
'<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans(
"Upload")).
'" name="upload">';
208 $texte .=
'</table>';
226 public function write_file(
$object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
229 global $user, $langs, $conf, $mysoc, $hookmanager;
232 if (empty($srctemplatepath)) {
233 dol_syslog(
"doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
238 $hookmanager->initHooks(array(
'odtgeneration'));
240 if (!is_object($outputlangs)) {
241 $outputlangs = $langs;
243 $sav_charset_output = $outputlangs->charset_output;
244 $outputlangs->charset_output =
'UTF-8';
246 $outputlangs->loadLangs(array(
"main",
"dict",
"companies",
"bills"));
248 if ($conf->mymodule->dir_output) {
262 $dir = $conf->mymodule->multidir_output[isset(
$object->entity) ?
$object->entity : 1];
264 if (!preg_match(
'/specimen/i', $objectref)) {
265 $dir .=
"/".$objectref;
267 $file = $dir.
"/".$objectref.
".odt";
269 if (!file_exists($dir)) {
271 $this->error = $langs->transnoentities(
"ErrorCanNotCreateDir", $dir);
276 if (file_exists($dir)) {
278 $newfile = basename($srctemplatepath);
279 $newfiletmp = preg_replace(
'/\.od[ts]/i',
'', $newfile);
280 $newfiletmp = preg_replace(
'/template_/i',
'', $newfiletmp);
281 $newfiletmp = preg_replace(
'/modele_/i',
'', $newfiletmp);
283 $newfiletmp = $objectref .
'_' . $newfiletmp;
287 $newfileformat = substr($newfile, strrpos($newfile,
'.') + 1);
290 if ($format ==
'1') {
291 $format =
'%Y%m%d%H%M%S';
295 $filename = $newfiletmp .
'.' . $newfileformat;
297 $file = $dir .
'/' . $filename;
304 if (!is_writable($conf->mymodule->dir_temp)) {
305 $this->error = $langs->transnoentities(
"ErrorFailedToWriteInTempDirectory", $conf->mymodule->dir_temp);
306 dol_syslog(
'Error in write_file: ' . $this->error, LOG_ERR);
312 $arrayidcontact =
$object->getIdContact(
'external',
'CUSTOMER');
313 if (count($arrayidcontact) > 0) {
315 $result =
$object->fetch_contact($arrayidcontact[0]);
319 $contactobject =
null;
320 if (!empty($usecontact)) {
322 if (
$object->contact->socid !=
$object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) ||
getDolGlobalInt(
'MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
323 $object->contact->fetch_thirdparty();
324 $socobject =
$object->contact->thirdparty;
325 $contactobject =
$object->contact;
327 $socobject =
$object->thirdparty;
329 $contactobject =
$object->contact;
332 $socobject =
$object->thirdparty;
336 $substitutionarray = array(
337 '__FROM_NAME__' => $this->emetteur->name,
338 '__FROM_EMAIL__' => $this->emetteur->email,
339 '__TOTAL_TTC__' =>
$object->total_ttc,
340 '__TOTAL_HT__' =>
$object->total_ht,
341 '__TOTAL_VAT__' =>
$object->total_tva
345 $parameters = array(
'file' => $file,
'object' =>
$object,
'outputlangs' => $outputlangs,
'substitutionarray' => &$substitutionarray);
346 $reshook = $hookmanager->executeHooks(
'ODTSubstitution', $parameters, $this, $action);
350 $paramfreetext =
'MYMODULE_MYOBJECT_FREE_TEXT';
356 require_once ODTPHP_PATH.
'odf.php';
358 $odfHandler =
new Odf(
361 'PATH_TO_TMP' => $conf->mymodule->dir_temp,
362 'ZIP_PROXY' =>
'PclZipProxy',
363 'DELIMITER_LEFT' =>
'{',
364 'DELIMITER_RIGHT' =>
'}'
368 $this->error = $e->getMessage();
381 $odfHandler->setVars(
'free_text', $newfreetext,
true,
'UTF-8');
382 }
catch (OdfException $e) {
389 $array_objet = $this->get_substitutionarray_object(
$object, $outputlangs);
395 $array_thirdparty_contact = array();
396 if ($usecontact && is_object($contactobject)) {
400 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_other, $array_thirdparty_contact);
404 $parameters = array(
'odfHandler' => &$odfHandler,
'file' => $file,
'object' =>
$object,
'outputlangs' => $outputlangs,
'substitutionarray' => &$tmparray);
405 $reshook = $hookmanager->executeHooks(
'ODTSubstitution', $parameters, $this, $action);
407 foreach ($tmparray as $key => $value) {
409 if (preg_match(
'/logo$/', $key)) {
411 if (file_exists($value)) {
412 $odfHandler->setImage($key, $value);
414 $odfHandler->setVars($key,
'ErrorFileNotFound',
true,
'UTF-8');
418 $odfHandler->setVars($key, $value,
true,
'UTF-8');
420 }
catch (OdfException $e) {
426 $foundtagforlines = 1;
428 $listlines = $odfHandler->setSegment(
'lines');
429 }
catch (OdfExceptionSegmentNotFound $e) {
431 $foundtagforlines = 0;
433 }
catch (OdfException $e) {
434 $foundtagforlines = 0;
438 if ($foundtagforlines) {
440 foreach (
$object->lines as $line) {
445 $parameters = array(
'odfHandler' => &$odfHandler,
'file' => $file,
'object' =>
$object,
'outputlangs' => $outputlangs,
'substitutionarray' => &$tmparray,
'line' => $line);
446 $reshook = $hookmanager->executeHooks(
'ODTSubstitutionLine', $parameters, $this, $action);
447 foreach ($tmparray as $key => $val) {
449 $listlines->setVars($key, $val,
true,
'UTF-8');
450 }
catch (OdfException $e) {
452 }
catch (SegmentException $e) {
458 $odfHandler->mergeSegment($listlines);
460 }
catch (OdfException $e) {
461 $this->error = $e->getMessage();
467 $tmparray = $outputlangs->get_translations_for_substitutions();
468 foreach ($tmparray as $key => $value) {
470 $odfHandler->setVars($key, $value,
true,
'UTF-8');
471 }
catch (OdfException $e) {
478 $parameters = array(
'odfHandler' => &$odfHandler,
'file' => $file,
'object' =>
$object,
'outputlangs' => $outputlangs,
'substitutionarray' => &$tmparray);
479 $reshook = $hookmanager->executeHooks(
'beforeODTSave', $parameters, $this, $action);
484 $odfHandler->exportAsAttachedPDF($file);
486 $this->error = $e->getMessage();
492 $odfHandler->saveToDisk($file);
494 $this->error = $e->getMessage();
500 $parameters = array(
'odfHandler' => &$odfHandler,
'file' => $file,
'object' =>
$object,
'outputlangs' => $outputlangs,
'substitutionarray' => &$tmparray);
501 $reshook = $hookmanager->executeHooks(
'afterODTCreation', $parameters, $this, $action);
507 $this->result = array(
'fullpath' => $file);
511 $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 for documents models.
Class to build documents using ODF templates generator.
write_file($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk using the generic odt module.
__construct($db)
Constructor.
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)
if(!function_exists('dol_getprefix')) dol_include_once($relpath, $classname='')
Make an include_once using default root and alternate root if it fails.
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...
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.