doc_generic_asset_odt::info() - Code Metrics - Inspection of "All errors detected after a general review are cor..." - alxarafe/alixar - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( f1540e...02d90d )

by Rafael
created 2024-05-29 18:34 UTC
doc_generic_asset_odt::info() B

↳ Parent: doc_generic_asset_odt
Complexity

Conditions	8
Paths	20
Size

Total Lines	80
Code Lines	54
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	8
eloc	54
nc	20
nop	1
dl	0
loc	80
rs	7.7591
c	0
b	0
f	0
How to fix Long Method

<?php

/* Copyright (C) 2010-2012  Laurent Destailleur <[email protected]>
 * Copyright (C) 2012		Juanjo Menent		<[email protected]>
 * Copyright (C) 2014		Marcos García		<[email protected]>
 * Copyright (C) 2016		Charlie Benke		<[email protected]>
 * Copyright (C) 2018-2021  Philippe Grand      <[email protected]>
 * Copyright (C) 2018-2024  Frédéric France     <[email protected]>
 *
 * 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 <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */

/**
 *  \file       htdocs/core/modules/asset/doc/doc_generic_asset_odt.modules.php
 *  \ingroup    asset
 *  \brief      File of class to build ODT documents for assets
 */

require_once DOL_DOCUMENT_ROOT . '/asset/core/modules/asset/modules_asset.php';
require_once BASE_PATH . '/../Dolibarr/Lib/Company.php';
require_once BASE_PATH . '/../Dolibarr/Lib/Functions2.php';
require_once BASE_PATH . '/../Dolibarr/Lib/Files.php';
require_once BASE_PATH . '/../Dolibarr/Lib/Doc.php';


/**
 *  Class to build documents using ODF templates generator
 */
class doc_generic_asset_odt extends ModelePDFAsset
{
    /**
     * @var string Dolibarr version of the loaded document
     */
    public $version = 'dolibarr';

    /**
     *  Constructor
     *
     *  @param      DoliDB      $db      Database handler
     */
    public 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 = 'ASSET_ASSET_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan

        // Page size for A4 format
        $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; // Display logo
        $this->option_tva = 0; // Manage the vat option FACTURE_TVAOPTION
        $this->option_modereg = 0; // Display payment mode
        $this->option_condreg = 0; // Display payment terms
        $this->option_multilang = 1; // Available in several languages
        $this->option_escompte = 0; // Displays if there has been a discount
        $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

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


    /**
     *  Return description of a module
     *
     *  @param  Translate   $langs      Lang object to use for output
     *  @return string                  Description
     */
    public function info($langs)
    {
        global $conf, $langs;

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

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

        $texte = $this->description . ".<br>\n";
        $texte .= '<form action="' . $_SERVER['PHP_SELF'] . '" method="POST">';
        $texte .= '<input type="hidden" name="token" value="' . newToken() . '">';
        $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
        $texte .= '<input type="hidden" name="param1" value="ASSET_ASSET_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->ASSET_ASSET_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");
        $texthelp .= '<br><br><span class="opacitymedium">' . $langs->trans("ExampleOfDirectoriesForModelGen") . '</span>';
        // 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, 3, $this->name);
        $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
        $texte .= '<textarea class="flat" cols="60" name="value1">';
        $texte .= getDolGlobalString('ASSET_ASSET_ADDON_PDF_ODT_PATH');
        $texte .= '</textarea>';
        $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
        $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="Button"value="' . $langs->trans("Modify") . '">';
        $texte .= '<br></div></div>';

        // Scan directories
        $nbofiles = count($listoffiles);
        if (getDolGlobalString('ASSET_ASSET_ADDON_PDF_ODT_PATH')) {
            $texte .= $langs->trans("NumberOfModelFilesFound") . ': <b>';
            //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
            $texte .= count($listoffiles);
            //$texte.=$nbofiles?'</a>':'';
            $texte .= '</b>';
        }

        if ($nbofiles) {
            $texte .= '<div id="div_' . get_class($this) . '" class="hidden">';
            foreach ($listoffiles as $file) {
                $texte .= '- ' . $file['name'] . ' <a href="' . DOL_URL_ROOT . '/document.php?modulepart=doctemplates&file=asset_asset/' . urlencode(basename($file['name'])) . '">' . img_picto('', 'listlight') . '</a>';
                $texte .= ' &nbsp; <a class="reposition" href="' . $_SERVER['PHP_SELF'] . '?modulepart=doctemplates&keyforuploaddir=ASSET_ASSET_ADDON_PDF_ODT_PATH&action=deletefile&token=' . newToken() . '&file=' . urlencode(basename($file['name'])) . '">' . img_picto('', 'delete') . '</a>';
                $texte .= '<br>';
            }
            $texte .= '</div>';
        }

        $texte .= '</td>';

        $texte .= '</tr>';

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

        return $texte;
    }

	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
    /**
     *  Function to build a document on disk using the generic odt module.
     *
     *  @param      Asset   $object             Object source to build document
     *  @param      Translate   $outputlangs        Lang output object
     *  @param      string      $srctemplatepath    Full path of source filename for generator using a template file
     *  @param      int         $hidedetails        Do not show line details
     *  @param      int         $hidedesc           Do not show desc
     *  @param      int         $hideref            Do not show ref
     *  @return     int                             1 if OK, <=0 if KO
     */
    public 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';

        $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));

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

            $object->fetch_thirdparty();

            $dir = $conf->asset->multidir_output[isset($object->entity) ? $object->entity : 1];
            $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[ts]/i', '', $newfile);
                $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
                $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
                $newfiletmp = $objectref . '_' . $newfiletmp;
                //$file=$dir.'/'.$newfiletmp.'.'.dol_print_date(dol_now(),'%Y%m%d%H%M%S').'.odt';
                // Get extension (ods or odt)
                $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
                if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
                    $format = getDolGlobalString('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->societe->dir_temp=".$conf->societe->dir_temp;

                dol_mkdir($conf->asset->dir_temp);
                if (!is_writable($conf->asset->dir_temp)) {
                    $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->asset->dir_temp);
                    dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
                    return -1;
                }

                // If CUSTOMER contact defined on order, 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)) {
                    // We can use the company of contact instead of thirdparty company
                    if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
                        $object->contact->fetch_thirdparty();
                                          fetch_thirdparty();
                        $socobject = $object->contact->thirdparty;
                        $contactobject = $object->contact;
                    } else {
                        $socobject = $object->thirdparty;
                        // if we have a CUSTOMER contact and we don't use it as thirdparty recipient we store the contact object for later use
                        $contactobject = $object->contact;
                    }
                } else {
                    $socobject = $object->thirdparty;
                }

                // Make substitution
                $substitutionarray = array(
                    '__FROM_NAME__' => $this->emetteur->name,
                    '__FROM_EMAIL__' => $this->emetteur->email,
                    '__TOTAL_TTC__' => $object->total_ttc,
                    '__TOTAL_HT__' => $object->total_ht,
                    '__TOTAL_VAT__' => $object->total_tva
                );
                complete_substitutions_array($substitutionarray, $langs, $object);
                // Call the ODTSubstitution hook
                $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$substitutionarray);
                $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 = 'ORDER_FREE_TEXT';
                if (!empty($conf->global->$paramfreetext)) {
                    $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
                }

                // Open and load template
                require_once ODTPHP_PATH . 'odf.php';

                try {
                    $odfHandler = new Odf(
                        $srctemplatepath,
                        array(
                        'PATH_TO_TMP'     => $conf->asset->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);
                }

                // 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);
                $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 object as contact_xxx tags
                $array_thirdparty_contact = array();
                if ($usecontact && is_object($contactobject)) {
                    $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
                }

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

                // Call the ODTSubstitution hook
                $parameters = array('odfHandler' => &$odfHandler, '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

                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 (OdfExceptionSegmentNotFound $e) {
                        // We may arrive here if tags for lines not present into template
                        $foundtagforlines = 0;
                        dol_syslog($e->getMessage(), LOG_INFO);
                    } catch (OdfException $e) {
                        $foundtagforlines = 0;
                        dol_syslog($e->getMessage(), LOG_INFO);
                    }
                    if ($foundtagforlines) {
                        $linenumber = 0;
                        foreach ($object->lines as $line) {
                            $linenumber++;
                            $tmparray = $this->get_substitutionarray_lines($line, $outputlangs, $linenumber);
                            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, 'substitutionarray' => &$tmparray);
                $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks

                // Write new file
                if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
                    try {
                        $odfHandler->exportAsAttachedPDF($file);
                    } catch (Exception $e) {
                        $this->error = $e->getMessage();
                        dol_syslog($e->getMessage(), LOG_INFO);
                        return -1;
                    }
                } else {
                    try {
                        $odfHandler->saveToDisk($file);
                    } catch (Exception $e) {
                        $this->error = $e->getMessage();
                        dol_syslog($e->getMessage(), LOG_INFO);
                        return -1;
                    }
                }

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

                dolChmod($file);

                $odfHandler = null; // Destroy object

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

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

        return -1;
    }
}

alxarafe / alixar

Push — main ( f1540e...02d90d )

doc_generic_asset_odt::info() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
