conf.class.php | searchcode

/htdocs/core/class/conf.class.php

https://bitbucket.org/speedealing/speedealing
PHP | 499 lines | 303 code | 78 blank | 118 comment | 66 complexity | 53b689e0c625e110e78b64ac897a9ddb MD5 | raw file
Possible License(s): LGPL-3.0, LGPL-2.1, GPL-3.0, MIT

<?php

/* Copyright (C) 2003-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2003      Xavier Dutoit        <doli@sydesy.com>
 * Copyright (C) 2004-2012 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2012 Regis Houssin      	<regis.houssin@capnetworks.com>
 * Copyright (C) 2006 	   Jean Heimburger    	<jean@tiaris.info>
 *
 * 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/>.
 */

/**
 * 	\file       	htdocs/core/class/conf.class.php
 * 	\ingroup		core
 *  \brief      	File of class to manage storage of current setup
 *  				Config is stored into file conf.php
 */
require_once DOL_DOCUMENT_ROOT . '/core/lib/memory.lib.php'; // Lib for memcached
require_once DOL_DOCUMENT_ROOT . '/core/class/nosqlDocument.class.php';
require_once DOL_DOCUMENT_ROOT . '/core/modules/DolibarrModules.class.php';

/**
 *  Class to stock current configuration
 */
class Conf extends nosqlDocument {

    /** \public */
    //! To store properties found in conf file
    var $file;
    //! Object with database handler
    var $db;
    //! To store properties found into database
    var $global;
    //! url of couchdb server
    var $Couchdb;
    //! url of memcached server
    var $memcached;
    //! To store if javascript/ajax is enabked
    public $use_javascript_ajax;
    //! Used to store current currency
    public $currency;
    //! Used to store current css (from theme)
    public $theme;  // Contains current theme ("eldy", "auguria", ...)
    public $css; // Contains full path of css page ("/theme/eldy/style.css.php", ...)
    //! Used to store current menu handlers
    public $top_menu;
    public $smart_menu;
    public $modules = array(); // List of activated modules
    public $modules_parts = array('js' => array(), 'triggers' => array(), 'login' => array(), 'substitutions' => array(), 'menus' => array(), 'theme' => array(), 'tpl' => array(), 'barcode' => array(), 'models' => array(), 'hooks' => array()); // List of modules parts
    // TODO Remove thoose arrays with generic module_parts
    public $tabs_modules = array();
    public $sms_engine_modules = array();
    public $societe_modules = array();
    var $logbuffer = array();
    //! To store properties of multi-company
    public $multicompany;
    //! Used to store running instance for multi-company (default 1)
    public $entity = 1;
    //! Used to store list of entities to use for each element
    public $entities = array();

    /**
     * Constructor
     *
     * @return Conf
     */
    function __construct() {
        // Avoid warnings when filling this->xxx
        $this->file = new stdClass();
        $this->db = new stdClass();
        $this->Couchdb = new stdClass();
        $this->memcached = new stdClass();
        $this->global = new stdClass();
        $this->mycompany = new stdClass();
        $this->admin = new stdClass();
        $this->user = new stdClass();
        $this->syslog = new stdClass();
        $this->browser = new stdClass();
        $this->multicompany = new stdClass();

        // First level object
        $this->expedition_bon = new stdClass();
        $this->livraison_bon = new stdClass();
        $this->fournisseur = new stdClass();
        $this->product = new stdClass();
        $this->service = new stdClass();
        $this->contrat = new stdClass();
        $this->actions = new stdClass();
        $this->commande = new stdClass();
        $this->propal = new stdClass();
        $this->facture = new stdClass();
        $this->contrat = new stdClass();
        $this->adherent = new stdClass();
        $this->bank = new stdClass();
        $this->notification = new stdClass();
        $this->mailing = new stdClass();

        //! Charset for HTML output and for storing data in memory
        $this->file->character_set_client = 'UTF-8';   // UTF-8, ISO-8859-1
        //! Memcached disabled by default
        $this->memcached->enabled = false;
    }

    /**
     * 	Load setup values into conf object (read llx_const)
     *
     * 	@param      DoliDB		$db		Handler d'acces base
     * 	@return     int					< 0 if KO, >= 0 if OK
     */
    function setValues() {
		global $user;
		
		// Avoid warning if not defined
        if (empty($this->db->dolibarr_main_db_encryption))
            $this->db->dolibarr_main_db_encryption = 0;
        if (empty($this->db->dolibarr_main_db_cryptkey))
            $this->db->dolibarr_main_db_cryptkey = '';

        /*
         * Definition de toutes les constantes globales d'environnement
         * - En constante php (TODO a virer)
         * - En $this->global->key=value
         */
        $found = false;

        $result = dol_getcache("const");
        if (is_object($result))
            $found = true;

        if (!$found) {
            $result = array();
            try {
                $result = $this->load('const');
                //print_r($result);

                dol_setcache("const", $result);
            } catch (Exception $e) {
                dol_print_error("", $e->getMessage());
                exit;
            }
        }

        $i = 0;
        if (count($result->values) == 0) {
            dol_print_error("", "Error in const document : values is empty !");
            exit;
        }

        foreach ($result->values as $key => $value) {
            if ($key) {
                if (!defined("$key"))
                    define("$key", $value); // In some cases, the constant might be already forced (Example: SYSLOG_FILE_ON and SYSLOG_FILE during install)
                $this->global->$key = $value;

                if ($value && preg_match('/^MAIN_MODULE_/', $key)) {
                    // If this is constant for a new tab page activated by a module.
                    if (preg_match('/^MAIN_MODULE_([A-Z_]+)_TABS_/i', $key)) {
                        $params = explode(':', $value, 2);
                        $this->tabs_modules[$params[0]][] = $value;
                    }
                    // If this is constant for a sms engine
                    elseif (preg_match('/^MAIN_MODULE_([A-Z_]+)_SMS$/i', $key, $reg)) {
                        $modulename = strtolower($reg[1]);
                        $this->sms_engine_modules[$modulename] = $modulename; // Add this module in list of modules that provide SMS
                    }
                    // If this is constant for all generic part activated by a module
                    elseif (preg_match('/^MAIN_MODULE_([A-Z_]+)_([A-Z]+)$/i', $key, $reg)) {
                        $modulename = strtolower($reg[1]);
                        $partname = strtolower($reg[2]);
                        //$varname = $partname.'_modules';  // TODO deprecated
                        //if (! isset($this->$varname) || ! is_array($this->$varname)) { $this->$varname = array(); } // TODO deprecated
                        if (!isset($this->modules_parts[$partname]) || !is_array($this->modules_parts[$partname])) {
                            $this->modules_parts[$partname] = array();
                        }
                        $arrValue = json_decode($value, true);
                        if (is_array($arrValue) && !empty($arrValue))
                            $value = $arrValue;
                        else if (in_array($partname, array('login', 'menus', 'substitutions', 'triggers', 'tpl', 'theme')))
                            $value = '/' . $modulename . '/core/' . $partname . '/';
                        else if (in_array($partname, array('models')))
                            $value = '/' . $modulename . '/';
                        else if ($value == 1)
                            $value = '/' . $modulename . '/core/modules/' . $partname . '/';
                        //$this->$varname = array_merge($this->$varname, array($modulename => $value));  // TODO deprecated
                        $this->modules_parts[$partname] = array_merge($this->modules_parts[$partname], array($modulename => $value));
                    }
                }
            }
            $i++;
        }
		
		// Load default DB if needed : only after login
		if($this->Couchdb->name == "_users")
			$this->Couchdb->name = $user->entity;
		
        // load configuration module
        $object = new DolibarrModules($this->db);

        $result = $object->getView("list", array(), true);
        foreach ($result->rows as $aRow) {
            $modulename = strtolower($aRow->key);
            $this->$modulename = $aRow->value;
            $this->modules[] = $modulename;
        }

        //print_r($this);exit;
        //var_dump($this->modules);
        //var_dump($this->modules_parts);
        // Second or others levels object
        $this->propal->cloture = new stdClass();
        $this->propal->facturation = new stdClass();
        $this->commande->client = new stdClass();
        $this->commande->fournisseur = new stdClass();
        $this->facture->client = new stdClass();
        $this->facture->fournisseur = new stdClass();
        $this->fournisseur->commande = new stdClass();
        $this->fournisseur->facture = new stdClass();
        $this->contrat->services = new stdClass();
        $this->contrat->services->inactifs = new stdClass();
        $this->contrat->services->expires = new stdClass();
        $this->adherent->cotisation = new stdClass();
        $this->bank->rappro = new stdClass();
        $this->bank->cheque = new stdClass();

        // Clean some variables
        if (empty($this->global->MAIN_MENU_STANDARD))
            $this->global->MAIN_MENU_STANDARD = "eldy_backoffice.php";
        if (empty($this->global->MAIN_MENUFRONT_STANDARD))
            $this->global->MAIN_MENUFRONT_STANDARD = "eldy_frontoffice.php";
        if (empty($this->global->MAIN_MENU_SMARTPHONE))
            $this->global->MAIN_MENU_SMARTPHONE = "eldy_backoffice.php"; // Use eldy by default because smartphone does not work on all phones
        if (empty($this->global->MAIN_MENUFRONT_SMARTPHONE))
            $this->global->MAIN_MENUFRONT_SMARTPHONE = "eldy_frontoffice.php"; // Ue eldy by default because smartphone does not work on all phones







// Variable globales LDAP
        if (empty($this->global->LDAP_FIELD_FULLNAME))
            $this->global->LDAP_FIELD_FULLNAME = '';
        if (!isset($this->global->LDAP_KEY_USERS))
            $this->global->LDAP_KEY_USERS = $this->global->LDAP_FIELD_FULLNAME;
        if (!isset($this->global->LDAP_KEY_GROUPS))
            $this->global->LDAP_KEY_GROUPS = $this->global->LDAP_FIELD_FULLNAME;
        if (!isset($this->global->LDAP_KEY_CONTACTS))
            $this->global->LDAP_KEY_CONTACTS = $this->global->LDAP_FIELD_FULLNAME;
        if (!isset($this->global->LDAP_KEY_MEMBERS))
            $this->global->LDAP_KEY_MEMBERS = $this->global->LDAP_FIELD_FULLNAME;

        // Load translation object with current language
        if (empty($this->global->MAIN_LANG_DEFAULT))
            $this->global->MAIN_LANG_DEFAULT = "en_US";

        // By default, we repeat info on all tabs
        if (!isset($this->global->MAIN_REPEATCONTACTONEACHTAB))
            $this->global->MAIN_REPEATCONTACTONEACHTAB = 1;
        if (!isset($this->global->MAIN_REPEATADDRESSONEACHTAB))
            $this->global->MAIN_REPEATADDRESSONEACHTAB = 1;

        $rootfordata = DOL_DATA_ROOT;
        $rootforuser = DOL_DATA_ROOT;

        // Define default dir_output and dir_temp for directories of modules
        foreach ($this->modules as $module) {
            $this->$module->multidir_output = array($this->entity => $rootfordata . "/" . $module);
            $this->$module->multidir_temp = array($this->entity => $rootfordata . "/" . $module . "/temp");
            // For backward compatibility
            $this->$module->dir_output = $rootfordata . "/" . $module;
            $this->$module->dir_temp = $rootfordata . "/" . $module . "/temp";
        }

        // For mycompany storage
        $this->mycompany->dir_output = $rootfordata . "/mycompany";
        $this->mycompany->dir_temp = $rootfordata . "/mycompany/temp";

        // For admin storage
        $this->admin->dir_output = $rootfordata . '/admin';
        $this->admin->dir_temp = $rootfordata . '/admin/temp';

        // For user storage
        $this->user->multidir_output = array($this->entity => $rootfordata . "/users");
        $this->user->multidir_temp = array($this->entity => $rootfordata . "/users/temp");
        // For backward compatibility
        $this->user->dir_output = $rootforuser . "/users";
        $this->user->dir_temp = $rootforuser . "/users/temp";

        // For propal storage
        $this->propal->dir_output = $rootforuser . "/propal";
        $this->propal->dir_temp = $rootforuser . "/propal/temp";

        // Exception: Some dir are not the name of module. So we keep exception here
        // for backward compatibility.
        // Sous module bons d'expedition
        $this->expedition_bon->enabled = defined("MAIN_SUBMODULE_EXPEDITION") ? MAIN_SUBMODULE_EXPEDITION : 0;
        // Sous module bons de livraison
        $this->livraison_bon->enabled = defined("MAIN_SUBMODULE_LIVRAISON") ? MAIN_SUBMODULE_LIVRAISON : 0;

        // Module fournisseur
        $this->fournisseur->commande->dir_output = $rootfordata . "/fournisseur/commande";
        $this->fournisseur->commande->dir_temp = $rootfordata . "/fournisseur/commande/temp";
        $this->fournisseur->facture->dir_output = $rootfordata . "/fournisseur/facture";
        $this->fournisseur->facture->dir_temp = $rootfordata . "/fournisseur/facture/temp";

        // Module product/service
        $this->product->multidir_output = array($this->entity => $rootfordata . "/produit");
        $this->product->multidir_temp = array($this->entity => $rootfordata . "/produit/temp");
        $this->service->multidir_output = array($this->entity => $rootfordata . "/produit");
        $this->service->multidir_temp = array($this->entity => $rootfordata . "/produit/temp");
        // For backward compatibility
        $this->product->dir_output = $rootfordata . "/produit";
        $this->product->dir_temp = $rootfordata . "/produit/temp";
        $this->service->dir_output = $rootfordata . "/produit";
        $this->service->dir_temp = $rootfordata . "/produit/temp";

        // Module contrat
        $this->contrat->dir_output = $rootfordata . "/contracts";
        $this->contrat->dir_temp = $rootfordata . "/contracts/temp";


        // Set some default values
        // societe
        if (empty($this->global->SOCIETE_CODECLIENT_ADDON))
            $this->global->SOCIETE_CODECLIENT_ADDON = "mod_codeclient_leopard";
        if (empty($this->global->SOCIETE_CODEFOURNISSEUR_ADDON))
            $this->global->SOCIETE_CODEFOURNISSEUR_ADDON = $this->global->SOCIETE_CODECLIENT_ADDON;
        if (empty($this->global->SOCIETE_CODECOMPTA_ADDON))
            $this->global->SOCIETE_CODECOMPTA_ADDON = "mod_codecompta_panicum";

        // Security
        if (empty($this->global->USER_PASSWORD_GENERATED))
            $this->global->USER_PASSWORD_GENERATED = 'standard'; // Default password generator
        if (empty($this->global->MAIN_UMASK))
            $this->global->MAIN_UMASK = '0664';   // Default mask







// conf->use_javascript_ajax
        $this->use_javascript_ajax = 1;

        // conf->currency
        if (empty($this->global->MAIN_MONNAIE))
            $this->global->MAIN_MONNAIE = 'EUR';
        $this->currency = $this->global->MAIN_MONNAIE;

        // conf->global->COMPTA_MODE = Option des modules Comptabilites (simple ou expert). Defini le mode de calcul des etats comptables (CA,...)
        if (empty($this->global->COMPTA_MODE))
            $this->global->COMPTA_MODE = 'RECETTES-DEPENSES';  // By default. Can be 'RECETTES-DEPENSES' ou 'CREANCES-DETTES'







// conf->liste_limit = constante de taille maximale des listes
        if (empty($this->global->MAIN_SIZE_LISTE_LIMIT))
            $this->global->MAIN_SIZE_LISTE_LIMIT = 25;
        $this->liste_limit = $this->global->MAIN_SIZE_LISTE_LIMIT;

        // conf->liste_limit = constante de taille maximale des listes
        if (empty($this->global->MAIN_SIZE_VIEW_LIMIT))
            $this->global->MAIN_SIZE_VIEW_LIMIT = 10000;
        $this->view_limit = $this->global->MAIN_SIZE_VIEW_LIMIT;

        // conf->product->limit_size = constante de taille maximale des select de produit
        if (!isset($this->global->PRODUIT_LIMIT_SIZE))
            $this->global->PRODUIT_LIMIT_SIZE = 100;
        $this->product->limit_size = $this->global->PRODUIT_LIMIT_SIZE;

        // conf->theme et $this->css
        if (empty($this->global->MAIN_THEME))
            $this->global->MAIN_THEME = "eldy";
        $this->theme = $this->global->MAIN_THEME;
        $this->css = "/theme/" . $this->theme . "/style.css.php";

        // conf->email_from = email pour envoi par dolibarr des mails automatiques
        $this->email_from = "dolibarr-robot@domain.com";
        if (!empty($this->global->MAIN_MAIL_EMAIL_FROM))
            $this->email_from = $this->global->MAIN_MAIL_EMAIL_FROM;

        // conf->notification->email_from = email pour envoi par Dolibarr des notifications
        $this->notification->email_from = $this->email_from;
        if (!empty($this->global->NOTIFICATION_EMAIL_FROM))
            $this->notification->email_from = $this->global->NOTIFICATION_EMAIL_FROM;

        // conf->mailing->email_from = email pour envoi par Dolibarr des mailings
        $this->mailing->email_from = $this->email_from;
        if (!empty($this->global->MAILING_EMAIL_FROM))
            $this->mailing->email_from = $this->global->MAILING_EMAIL_FROM;

        // Format for date (used by default when not found or searched in lang)
        $this->format_date_short = "%d/%m/%Y";   // Format of day with PHP/C tags (strftime functions)
        $this->format_date_short_java = "dd/MM/yyyy";  // Format of day with Java tags
        $this->format_hour_short = "%H:%M";
        $this->format_hour_short_duration = "%H:%M";
        $this->format_date_text_short = "%d %b %Y";
        $this->format_date_text = "%d %B %Y";
        $this->format_date_hour_short = "%d/%m/%Y %H:%M";
        $this->format_date_hour_text_short = "%d %b %Y %H:%M";
        $this->format_date_hour_text = "%d %B %Y %H:%M";

        // Limites decimales si non definie (peuvent etre egale a 0)
        if (!isset($this->global->MAIN_MAX_DECIMALS_UNIT))
            $this->global->MAIN_MAX_DECIMALS_UNIT = 5;
        if (!isset($this->global->MAIN_MAX_DECIMALS_TOT))
            $this->global->MAIN_MAX_DECIMALS_TOT = 2;
        if (!isset($this->global->MAIN_MAX_DECIMALS_SHOWN))
            $this->global->MAIN_MAX_DECIMALS_SHOWN = 8;

        // Timeouts
        if (empty($this->global->MAIN_USE_CONNECT_TIMEOUT))
            $this->global->MAIN_USE_CONNECT_TIMEOUT = 10;
        if (empty($this->global->MAIN_USE_RESPONSE_TIMEOUT))
            $this->global->MAIN_USE_RESPONSE_TIMEOUT = 30;

        // Set default variable to calculate VAT as if option tax_mode was 0 (standard)
        if (empty($this->global->TAX_MODE_SELL_PRODUCT))
            $this->global->TAX_MODE_SELL_PRODUCT = 'invoice';
        if (empty($this->global->TAX_MODE_BUY_PRODUCT))
            $this->global->TAX_MODE_BUY_PRODUCT = 'invoice';
        if (empty($this->global->TAX_MODE_SELL_SERVICE))
            $this->global->TAX_MODE_SELL_SERVICE = 'payment';
        if (empty($this->global->TAX_MODE_BUY_SERVICE))
            $this->global->TAX_MODE_BUY_SERVICE = 'payment';

        // Delay before warnings
        $this->actions->warning_delay = (isset($this->global->MAIN_DELAY_ACTIONS_TODO) ? $this->global->MAIN_DELAY_ACTIONS_TODO : 7) * 24 * 60 * 60;
        $this->commande->client->warning_delay = (isset($this->global->MAIN_DELAY_ORDERS_TO_PROCESS) ? $this->global->MAIN_DELAY_ORDERS_TO_PROCESS : 2) * 24 * 60 * 60;
        $this->commande->fournisseur->warning_delay = (isset($this->global->MAIN_DELAY_SUPPLIER_ORDERS_TO_PROCESS) ? $this->global->MAIN_DELAY_SUPPLIER_ORDERS_TO_PROCESS : 7) * 24 * 60 * 60;
        $this->propal->cloture->warning_delay = (isset($this->global->MAIN_DELAY_PROPALS_TO_CLOSE) ? $this->global->MAIN_DELAY_PROPALS_TO_CLOSE : 0) * 24 * 60 * 60;
        $this->propal->facturation->warning_delay = (isset($this->global->MAIN_DELAY_PROPALS_TO_BILL) ? $this->global->MAIN_DELAY_PROPALS_TO_BILL : 0) * 24 * 60 * 60;
        $this->facture->client->warning_delay = (isset($this->global->MAIN_DELAY_CUSTOMER_BILLS_UNPAYED) ? $this->global->MAIN_DELAY_CUSTOMER_BILLS_UNPAYED : 0) * 24 * 60 * 60;
        $this->facture->fournisseur->warning_delay = (isset($this->global->MAIN_DELAY_SUPPLIER_BILLS_TO_PAY) ? $this->global->MAIN_DELAY_SUPPLIER_BILLS_TO_PAY : 0) * 24 * 60 * 60;
        $this->contrat->services->inactifs->warning_delay = (isset($this->global->MAIN_DELAY_NOT_ACTIVATED_SERVICES) ? $this->global->MAIN_DELAY_NOT_ACTIVATED_SERVICES : 0) * 24 * 60 * 60;
        $this->contrat->services->expires->warning_delay = (isset($this->global->MAIN_DELAY_RUNNING_SERVICES) ? $this->global->MAIN_DELAY_RUNNING_SERVICES : 0) * 24 * 60 * 60;
        $this->adherent->cotisation->warning_delay = (isset($this->global->MAIN_DELAY_MEMBERS) ? $this->global->MAIN_DELAY_MEMBERS : 0) * 24 * 60 * 60;
        $this->bank->rappro->warning_delay = (isset($this->global->MAIN_DELAY_TRANSACTIONS_TO_CONCILIATE) ? $this->global->MAIN_DELAY_TRANSACTIONS_TO_CONCILIATE : 0) * 24 * 60 * 60;
        $this->bank->cheque->warning_delay = (isset($this->global->MAIN_DELAY_CHEQUES_TO_DEPOSIT) ? $this->global->MAIN_DELAY_CHEQUES_TO_DEPOSIT : 0) * 24 * 60 * 60;

        // For backward compatibility
        if (isset($this->product))
            $this->produit = $this->product;
        if (isset($this->facture))
            $this->invoice = $this->facture;
        if (isset($this->commande))
            $this->order = $this->commande;
        if (isset($this->contrat))
            $this->contract = $this->contrat;
        if (isset($this->categorie))
            $this->category = $this->categorie;


        // Define menu manager in setup
        if (empty($user->societe_id)) { // If internal user or not defined
            $this->top_menu = (empty($this->global->MAIN_MENU_STANDARD_FORCED) ? $this->global->MAIN_MENU_STANDARD : $this->global->MAIN_MENU_STANDARD_FORCED);
            $this->smart_menu = (empty($this->global->MAIN_MENU_SMARTPHONE_FORCED) ? $this->global->MAIN_MENU_SMARTPHONE : $this->global->MAIN_MENU_SMARTPHONE_FORCED);
        } else {   // If external user
            $this->top_menu = (empty($this->global->MAIN_MENUFRONT_STANDARD_FORCED) ? $this->global->MAIN_MENUFRONT_STANDARD : $this->global->MAIN_MENUFRONT_STANDARD_FORCED);
            $this->smart_menu = (empty($this->global->MAIN_MENUFRONT_SMARTPHONE_FORCED) ? $this->global->MAIN_MENUFRONT_SMARTPHONE : $this->global->MAIN_MENUFRONT_SMARTPHONE_FORCED);
        }
    }

    /**
     * Specific record for conf
     */
    function record() {
        $result = $this->load("const");

        unset($result->values); // reset old values
		$result->values = new stdClass();
        foreach ($this->global as $key => $value)
            $result->values->$key = $value; // Write New Value

        $this->couchdb->storeDoc($result); // record new values
        dol_delcache("const"); //reset cache
        return 1;
    }

}

?>