doc_generic_contract_odt.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2010-2012  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2012   Juanjo Menent   <jmenent@2byte.es>
 * Copyright (C) 2018   Ferran Marcet   <fmarcet@2byte.es>
 * Copyright (C) 2018       Frédéric France         <frederic.france@netlogic.fr>
 *
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* or see http://www.gnu.org/
*/

require_once DOL_DOCUMENT_ROOT.'/core/modules/contract/modules_contract.php';
require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';


class doc_generic_contract_odt extends ModelePDFContract
{
  public $emetteur;

  public $phpmin = array(5, 4);

  public $version = 'dolibarr';


  function __construct($db)
  {
    global $conf, $langs, $mysoc;

    // Load translation files required by the page
        $langs->loadLangs(array("main","companies"));

    $this->db = $db;
    $this->name = "ODT templates";
    $this->description = $langs->trans("DocumentModelOdt");
    $this->scandir = 'CONTRACT_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan

    // Dimension page pour format A4
    $this->type = 'odt';
    $this->page_largeur = 0;
    $this->page_hauteur = 0;
    $this->format = array($this->page_largeur,$this->page_hauteur);
    $this->marge_gauche=0;
    $this->marge_droite=0;
    $this->marge_haute=0;
    $this->marge_basse=0;

    $this->option_logo = 1;                    // Affiche logo
    $this->option_tva = 0;                     // Gere option tva CONTRACT_TVAOPTION
    $this->option_modereg = 0;                 // Affiche mode reglement
    $this->option_condreg = 0;                 // Affiche conditions reglement
    $this->option_codeproduitservice = 0;      // Affiche code produit-service
    $this->option_multilang = 1;               // Dispo en plusieurs langues
    $this->option_escompte = 0;                // Affiche si il y a eu escompte
    $this->option_credit_note = 0;             // Support credit notes
    $this->option_freetext = 1;          // Support add of a personalised text
    $this->option_draft_watermark = 0;       // Support add of a watermark on drafts

    // Recupere emetteur
    $this->emetteur=$mysoc;
    if (! $this->emetteur->country_code) $this->emetteur->country_code=substr($langs->defaultlang,-2);    // By default if not defined
  }


  function info($langs)
  {
    global $conf,$langs;

    // Load translation files required by the page
        $langs->loadLangs(array('companies', 'errors'));

    $form = new Form($this->db);

    $texte = $this->description.".<br>\n";
    $texte.= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
    $texte.= '<input type="hidden" name="token" value="'.$_SESSION['newtoken'].'">';
    $texte.= '<input type="hidden" name="action" value="setModuleOptions">';
    $texte.= '<input type="hidden" name="param1" value="CONTRACT_ADDON_PDF_ODT_PATH">';
    $texte.= '<table class="nobordernopadding" width="100%">';

    // List of directories area
    $texte.= '<tr><td>';
    $texttitle=$langs->trans("ListOfDirectories");
    $listofdir=explode(',',preg_replace('/[\r\n]+/',',',trim($conf->global->CONTRACT_ADDON_PDF_ODT_PATH)));
    $listoffiles=array();
    foreach($listofdir as $key=>$tmpdir)
    {
      $tmpdir=trim($tmpdir);
      $tmpdir=preg_replace('/DOL_DATA_ROOT/',DOL_DATA_ROOT,$tmpdir);
      if (! $tmpdir) {
        unset($listofdir[$key]); continue;
      }
      if (! is_dir($tmpdir)) $texttitle.=img_warning($langs->trans("ErrorDirNotFound",$tmpdir),0);
      else
      {
        $tmpfiles=dol_dir_list($tmpdir,'files',0,'\.(ods|odt)');
        if (count($tmpfiles)) $listoffiles=array_merge($listoffiles,$tmpfiles);
      }
    }
    $texthelp=$langs->trans("ListOfDirectoriesForModelGenODT");
    // Add list of substitution keys
    $texthelp.='<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
    $texthelp.=$langs->transnoentitiesnoconv("FullListOnOnlineDocumentation");    // This contains an url, we don't modify it

    $texte.= $form->textwithpicto($texttitle,$texthelp,1,'help','',1);
    $texte.= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
    $texte.= '<textarea class="flat" cols="60" name="value1">';
    $texte.=$conf->global->CONTRACT_ADDON_PDF_ODT_PATH;
    $texte.= '</textarea>';
    $texte.= '</div><div style="display: inline-block; vertical-align: middle;">';
    $texte.= '<input type="submit" class="button" value="'.dol_escape_htmltag($langs->trans("Modify")).'" name="Button">';
    $texte.= '<br></div></div>';

    // Scan directories
    if (count($listofdir))
    {
      $texte.=$langs->trans("NumberOfModelFilesFound").': <b>'.count($listoffiles).'</b>';
    }

    // Add select to upload a new template file. TODO Copy this feature on other admin pages.
    $texte.= '<div>'.$langs->trans("UploadNewTemplate").' <input type="file" name="uploadfile">';
    $texte.= '<input type="hidden" value="CONTRACT_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
    $texte.= '<input type="submit" class="button" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
        $texte.= '</div>';

    $texte.= '</td>';

    $texte.= '<td valign="top" rowspan="2" class="hideonsmartphone">';
    $texte.= $langs->trans("ExampleOfDirectoriesForModelGen");
    $texte.= '</td>';
    $texte.= '</tr>';

    $texte.= '</table>';
    $texte.= '</form>';

    return $texte;
  }

    // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps
  function write_file($object,$outputlangs,$srctemplatepath,$hidedetails=0,$hidedesc=0,$hideref=0)
  {
        // phpcs:enable
    global $user,$langs,$conf,$mysoc,$hookmanager;

    if (empty($srctemplatepath))
    {
      dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
      return -1;
    }

    // Add odtgeneration hook
    if (! is_object($hookmanager))
    {
      include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
      $hookmanager=new HookManager($this->db);
    }
    $hookmanager->initHooks(array('odtgeneration'));
    global $action;

    if (! is_object($outputlangs)) $outputlangs=$langs;
    $sav_charset_output=$outputlangs->charset_output;
    $outputlangs->charset_output='UTF-8';

    // Load traductions files requiredby by page
    $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));

    if ($conf->contrat->dir_output)
    {
      // If $object is id instead of object
      if (! is_object($object))
      {
        $id = $object;
        $object = new Contrat($this->db);
        $result=$object->fetch($id);
        if ($result < 0)
        {
          dol_print_error($this->db,$object->error);
          return -1;
        }
      }

      $dir = $conf->contrat->dir_output;
      $objectref = dol_sanitizeFileName($object->ref);
      if (! preg_match('/specimen/i',$objectref)) $dir.= "/" . $objectref;
      $file = $dir . "/" . $objectref . ".odt";

      if (! file_exists($dir))
      {
        if (dol_mkdir($dir) < 0)
        {
          $this->error=$langs->transnoentities("ErrorCanNotCreateDir",$dir);
          return -1;
        }
      }

      if (file_exists($dir))
      {
        //print "srctemplatepath=".$srctemplatepath;  // Src filename
        $newfile=basename($srctemplatepath);
        $newfiletmp=preg_replace('/\.od(t|s)/i','',$newfile);
        $newfiletmp=preg_replace('/template_/i','',$newfiletmp);
        $newfiletmp=preg_replace('/modele_/i','',$newfiletmp);

        $newfiletmp=$objectref.'_'.$newfiletmp;

        // Get extension (ods or odt)
        $newfileformat=substr($newfile, strrpos($newfile, '.')+1);
        if ( ! empty($conf->global->MAIN_DOC_USE_TIMING))
        {
            $format=$conf->global->MAIN_DOC_USE_TIMING;
            if ($format == '1') $format='%Y%m%d%H%M%S';
          $filename=$newfiletmp.'-'.dol_print_date(dol_now(),$format).'.'.$newfileformat;
        }
        else
        {
          $filename=$newfiletmp.'.'.$newfileformat;
        }
        $file=$dir.'/'.$filename;
        //print "newdir=".$dir;
        //print "newfile=".$newfile;
        //print "file=".$file;
        //print "conf->contrat->dir_temp=".$conf->contrat->dir_temp;

        dol_mkdir($conf->contrat->dir_temp);


        // If CUSTOMER contact defined on contract, we use it
        $usecontact=false;
        $arrayidcontact=$object->getIdContact('external','CUSTOMER');
        if (count($arrayidcontact) > 0)
        {
          $usecontact=true;
          $result=$object->fetch_contact($arrayidcontact[0]);
        }

        // Recipient name
        $contactobject=null;
        if (! empty($usecontact))
        {
          // On peut utiliser le nom de la societe du contact
          if (! empty($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT)) $socobject = $object->contact;
          else {
                              $socobject = $object->thirdparty;
                              // if we have a CUSTOMER contact and we dont use it as recipient we store the contact object for later use
                              $contactobject = $object->contact;
                          }
        }
        else
        {
          $socobject=$object->thirdparty;
        }

        $object->fetch_optionals();


        // Define substitution array
        $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object);
        $array_object_from_properties=$this->get_substitutionarray_each_var_object($object, $outputlangs);
        $array_objet=$this->get_substitutionarray_object($object,$outputlangs);   // complete with vars not set as properties by get_substitutionarray_each_var_object
        $array_user=$this->get_substitutionarray_user($user,$outputlangs);
        $array_soc=$this->get_substitutionarray_mysoc($mysoc,$outputlangs);
        $array_thirdparty=$this->get_substitutionarray_thirdparty($socobject,$outputlangs);
        $array_other=$this->get_substitutionarray_other($outputlangs);
        // retrieve contact information for use in order as contact_xxx tags
        $array_thirdparty_contact = array();
        if ($usecontact && is_object($contactobject)) $array_thirdparty_contact=$this->get_substitutionarray_contact($contactobject,$outputlangs,'contact');

        $substitutionarray = array_merge($substitutionarray,$array_object_from_properties,$array_user,$array_soc,$array_thirdparty,$array_objet,$array_other,$array_thirdparty_contact);
        complete_substitutions_array($substitutionarray, $outputlangs, $object);

        $tmparray = $substitutionarray;

        // Call the ODTSubstitution hook
        $parameters=array('file'=>$file,'object'=>$object,'outputlangs'=>$outputlangs,'substitutionarray'=>&$tmparray);
        $reshook=$hookmanager->executeHooks('ODTSubstitution',$parameters,$this,$action);    // Note that $action and $object may have been modified by some hooks

        // Line of free text
        $newfreetext='';
        $paramfreetext='CONTRACT_FREE_TEXT';
        if (! empty($conf->global->$paramfreetext))
        {
          $newfreetext=make_substitutions($conf->global->$paramfreetext,$tmparray);
        }


        // Open and load template
        require_once ODTPHP_PATH.'odf.php';
        try {
          $odfHandler = new odf(
            $srctemplatepath,
            array(
            'PATH_TO_TMP'   => $conf->contrat->dir_temp,
            'ZIP_PROXY'     => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
            'DELIMITER_LEFT'  => '{',
            'DELIMITER_RIGHT' => '}'
            )
          );
        }
        catch(Exception $e)
        {
          $this->error=$e->getMessage();
          dol_syslog($e->getMessage(), LOG_INFO);
          return -1;
        }
        // After construction $odfHandler->contentXml contains content and
        // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
        // [!-- BEGIN lines --]*[!-- END lines --]
        //print html_entity_decode($odfHandler->__toString());
        //print exit;


        // Make substitutions into odt of freetext
        try {
          $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
        }
        catch (OdfException $e)
        {
          dol_syslog($e->getMessage(), LOG_INFO);
        }

        foreach($tmparray as $key=>$value)
        {
          try {
            if (preg_match('/logo$/',$key)) // Image
            {
              if (file_exists($value)) $odfHandler->setImage($key, $value);
              else $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
            }
            else    // Text
            {
              $odfHandler->setVars($key, $value, true, 'UTF-8');
            }
          }
          catch (OdfException $e)
          {
                        dol_syslog($e->getMessage(), LOG_INFO);
          }
        }

        // Replace tags of lines
        try
        {
          $foundtagforlines = 1;
          try {
            $listlines = $odfHandler->setSegment('lines');
          }
          catch(OdfException $e)
          {
            // We may arrive here if tags for lines not present into template
            $foundtagforlines = 0;
            dol_syslog($e->getMessage(), LOG_INFO);
          }
          if ($foundtagforlines)
          {
            foreach ($object->lines as $line)
            {
              $tmparray=$this->get_substitutionarray_lines($line,$outputlangs);
              complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
              // Call the ODTSubstitutionLine hook
              $parameters=array('odfHandler'=>&$odfHandler,'file'=>$file,'object'=>$object,'outputlangs'=>$outputlangs,'substitutionarray'=>&$tmparray,'line'=>$line);
              $reshook=$hookmanager->executeHooks('ODTSubstitutionLine',$parameters,$this,$action);    // Note that $action and $object may have been modified by some hooks
              foreach($tmparray as $key => $val)
              {
                try
                {
                  $listlines->setVars($key, $val, true, 'UTF-8');
                }
                catch(OdfException $e)
                {
                  dol_syslog($e->getMessage(), LOG_INFO);
                }
                catch(SegmentException $e)
                {
                  dol_syslog($e->getMessage(), LOG_INFO);
                }
              }
              $listlines->merge();
            }
            $odfHandler->mergeSegment($listlines);
          }
        }
        catch(OdfException $e)
        {
          $this->error=$e->getMessage();
          dol_syslog($this->error, LOG_WARNING);
          return -1;
        }

        // Replace labels translated
        $tmparray=$outputlangs->get_translations_for_substitutions();
        foreach($tmparray as $key=>$value)
        {
          try {
            $odfHandler->setVars($key, $value, true, 'UTF-8');
          }
          catch(OdfException $e)
          {
                        dol_syslog($e->getMessage(), LOG_INFO);
          }
        }

        // Call the beforeODTSave hook
        $parameters=array('odfHandler'=>&$odfHandler,'file'=>$file,'object'=>$object,'outputlangs'=>$outputlangs);
        $reshook=$hookmanager->executeHooks('beforeODTSave',$parameters,$this,$action);    // Note that $action and $object may have been modified by some hooks

        // Write new file
        if (!empty($conf->global->MAIN_ODT_AS_PDF)) {
          try {
            $odfHandler->exportAsAttachedPDF($file);
          } catch (Exception $e) {
            $this->error=$e->getMessage();
            return -1;
          }
        }
        else {
          try {
          $odfHandler->saveToDisk($file);
          } catch (Exception $e) {
            $this->error=$e->getMessage();
            return -1;
          }
        }

        $reshook=$hookmanager->executeHooks('afterODTCreation',$parameters,$this,$action);    // Note that $action and $object may have been modified by some hooks

        if (! empty($conf->global->MAIN_UMASK))
          @chmod($file, octdec($conf->global->MAIN_UMASK));

        $odfHandler=null; // Destroy object

        $this->result = array('fullpath'=>$file);

        return 1;   // Success
      }
      else
      {
        $this->error=$langs->transnoentities("ErrorCanNotCreateDir",$dir);
        return -1;
      }
    }

    return -1;
  }
}