Config::getDolibarrConfigFilename() - Code Metrics - Inspection of "We progress until the creation of the first user." - alxarafe/alixar - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( e2b3b9...324b47 )

by Rafael
created 2024-06-14 19:49 UTC
Config::getDolibarrConfigFilename() A

↳ Parent: Config
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

/* Copyright (C) 2024       Rafael San José         <[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
 * 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/>.
 */

namespace DoliCore\Base;

use Conf;
use DoliCore\Lib\TraceableDB;
use DoliCore\Tools\Debug;
use DoliDB;
use DoliModules\User\Model\User;
use MenuManager;
use HookManager;
use stdClass;
use Alxarafe\Base\Config as ConfigBase;

require_once BASE_PATH . '/core/class/conf.class.php';
require_once BASE_PATH . '/core/class/hookmanager.class.php';
require_once BASE_PATH . '/../Dolibarr/Core/Menu/standard/eldy_menu.php';

/**
 * Generate an object with the configuration of the Dolibarr conf.php file.
 *
 * @info https://wiki.dolibarr.org/index.php/Configuration_file
 *
 * This class is only needed for compatibility with Dolibarr.
 *
 * @package DoliCore\Base
 */
abstract class Config extends ConfigBase
{
    const DEFAULT_DB_PREFIX = 'alx_';

    /**
     * Contains the information of the old $conf global var.
     *
     * Config::getConf() can be used at any point to retrieve the contents of the
     * $conf variable used globally by Dolibarr.
     *
     * The content of the variable is saved with the first call and this copy is
     * returned. If it is necessary to regenerate it, the parameter true can be
     * passed to it.
     *
     * @var null|Conf
     *
     * @deprecated Use $config instead
     */
    private static $dolibarrConfig = null;

    /**
     * Contains the information from the conf.php file in a normalized stdClass.
     *
     * The objective is to move what is really needed to this object and update the
     * configuration file to a data file outside of public space.
     *
     * @var null|stdClass
     */
    private static $config = null;

    /**
     * Contains a DoliDB connection.
     *
     * @var DoliDB, null
     */
    private static $db;

    /**
     * Contains a HookManager class.
     *
     * @var $hookManager

     */
    private static $hookManager;

    /**
     * Contains a Translate class
     *
     * @var Translate
     */
    private static $langs;

    /**
     * Contains a User class instance.
     *
     * @var User
     */
    private static $user;

    private static $menumanager;

    /**
     * Load the Dolibarr configuration file and enter the content for the Dolibarr global
     * variable $conf.
     *
     * The result is cached for future queries. If we want to reload the configuration file
     * we will have to pass the parameter true.
     *
     * @param $reload
     *
     * @return stdClass|null
     */
    public static function getConf($reload = false): ?stdClass
    {
        if ($reload || !isset(static::$dolibarrConfig)) {

            static::$dolibarrConfig = static::loadConf();
            static::$dolibarrConfig = /** @scrutinizer ignore-deprecated */ static::loadConf();
        }

        return static::$dolibarrConfig;
    }

    /**
     * Load the configuration file and return the content that the $conf variable
     * used globally by Dolibarr should have.
     *
     * @return Conf|null
     *
     * @deprecated Use loadConfig() instead!
     */
    private static function loadConf()
    {
        $filename = static::getDolibarrConfigFilename();
        $exists = file_exists($filename) && is_readable($filename);
        if ($exists) {
            include $filename;
        }

        /*
         * Create $conf object
         */
        $conf = new Conf();

        // Set properties specific to database
        $conf->db->host = empty($dolibarr_main_db_host) ? '' : $dolibarr_main_db_host;

        $conf->db->port = empty($dolibarr_main_db_port) ? '' : $dolibarr_main_db_port;

        $conf->db->name = empty($dolibarr_main_db_name) ? '' : $dolibarr_main_db_name;

        $conf->db->user = empty($dolibarr_main_db_user) ? '' : $dolibarr_main_db_user;

        $conf->db->pass = empty($dolibarr_main_db_pass) ? '' : $dolibarr_main_db_pass;

        $conf->db->type = $dolibarr_main_db_type ?? 'mysqli';

        $conf->db->prefix = $dolibarr_main_db_prefix ?? self::DEFAULT_DB_PREFIX;

        $conf->db->charset = $dolibarr_main_db_character_set ?? 'utf8';

        $conf->db->collation = $dolibarr_main_db_collation ?? 'utf8_general_ci';

        $conf->db->encryption = $dolibarr_main_db_encryption ?? 0;

        $conf->db->cryptkey = $dolibarr_main_db_cryptkey ?? '';

        if (defined('TEST_DB_FORCE_TYPE')) {
            $conf->db->type = constant('TEST_DB_FORCE_TYPE'); // Force db type (for test purpose, by PHP unit for example)
        }

        // Set properties specific to conf file
        $conf->file->main_limit_users = $dolibarr_main_limit_users ?? null;

        $conf->file->mailing_limit_sendbyweb = empty($dolibarr_mailing_limit_sendbyweb) ? 0 : $dolibarr_mailing_limit_sendbyweb;

        $conf->file->mailing_limit_sendbycli = empty($dolibarr_mailing_limit_sendbycli) ? 0 : $dolibarr_mailing_limit_sendbycli;

        $conf->file->mailing_limit_sendbyday = empty($dolibarr_mailing_limit_sendbyday) ? 0 : $dolibarr_mailing_limit_sendbyday;

        $conf->file->main_authentication = empty($dolibarr_main_authentication) ? 'dolibarr' : $dolibarr_main_authentication; // Identification mode

        $conf->file->main_force_https = empty($dolibarr_main_force_https) ? '' : $dolibarr_main_force_https; // Force https

        $conf->file->strict_mode = empty($dolibarr_strict_mode) ? '' : $dolibarr_strict_mode; // Force php strict mode (for debug)

        $conf->file->instance_unique_id = empty($dolibarr_main_instance_unique_id) ? (empty($dolibarr_main_cookie_cryptkey) ? '' : $dolibarr_main_cookie_cryptkey) : $dolibarr_main_instance_unique_id; // Unique id of instance

        $conf->file->main_path = empty($dolibarr_main_document_root ?? '') ? BASE_PATH : $dolibarr_main_document_root;  // Define htdocs path inside the config file

        $conf->file->main_url = empty($dolibarr_main_url_root ?? '') ? BASE_URL : $dolibarr_main_url_root;    // Define url inside the config file

        $conf->file->main_doc = empty($dolibarr_main_data_root ?? '') ? static::getDataDir($conf->file->main_path) : $dolibarr_main_data_root;

        $conf->file->path = ['main' => $conf->file->main_path];
        $conf->file->url = ['main' => '/'];
        if (!empty($dolibarr_main_document_root_alt)) {

            $path = preg_split('/[;,]/', $dolibarr_main_document_root_alt);
            $url = preg_split('/[;,]/', $dolibarr_main_url_root_alt);


            if (count($path) !== count($url)) {
                print '<b>Error:</b><br>$dolibarr_main_document_root_alt and $dolibarr_main_url_root_alt must contain the same number of elements.<br>';
                die();

            }

            $i = 0;
            foreach ($path as $value) {
                $conf->file->path['alt' . ($i++)] = (string)$value;
            }
            $values = preg_split('/[;,]/', $dolibarr_main_url_root_alt);
            $i = 0;
            foreach ($url as $value) {
                if (preg_match('/^http(s)?:/', $value)) {
                    // Show error message
                    $correct_value = str_replace($conf->file->url, '', $value);
                    print '<b>Error:</b><br>' . "\n";
                    print 'Wrong <b>$dolibarr_main_url_root_alt</b> value in <b>conf.php</b> file.<br>' . "\n";
                    print 'We now use a relative path to $dolibarr_main_url_root to build alternate URLs.<br>' . "\n";
                    print 'Value found: ' . $value . '<br>' . "\n";
                    print 'Should be replaced by: ' . $correct_value . '<br>' . "\n";
                    print "Or something like following examples:<br>\n";
                    print "\"/extensions\"<br>\n";
                    print "\"/extensions1,/extensions2,...\"<br>\n";
                    print "\"/../extensions\"<br>\n";
                    print "\"/custom\"<br>\n";
                    exit;

                }
                $conf->file->url['alt' . ($i++)] = (string)$value;
            }
        }

        $conf->file->theme = $dolibarr_main_theme ?? 'eldy';

        $conf->file->dol_main_stream_to_disable = $dolibarr_main_stream_to_disable ?? null;

        $conf->debug = intval($dolibarr_main_prod ?? 1) === 0;


        // Load the main includes of common libraries
        if (!defined('NOREQUIRETRAN')) {
            require_once DOL_DOCUMENT_ROOT . '/core/class/translate.class.php';
        }

        static::$dolibarrConfig = $conf;

        return $conf;
    }

    /**
     * Returns the Dolibarr conf.php complete path.
     *
     * @return string
     */
    public static function getDolibarrConfigFilename()
    {
        return BASE_PATH . '/conf/conf.php';
    }

    /**
     * Simply replace /htdocs with /documents in $pathDir
     *
     * @param $pathDir
     *
     * @return string
     */
    public static function getDataDir($pathDir)
    {
        return preg_replace("/\/htdocs$/", "", $pathDir) . '/documents';
    }

    /**
     * Returns a stdClass with the information contained in the conf.php file.
     *
     * @param $reload
     *
     * @return stdClass|null
     */
    public static function getConfig($reload = false): ?stdClass
    {
        if ($reload || !isset(static::$config)) {

            static::$config = static::loadConfig();
        }

        return static::$config;
    }

    /**
     * Returns a normalized config file.
     *
     * @param bool $reload
     * @return stdClass|null
     */
    public static function loadConfig(bool $reload = false): stdClass
    {
        $conf = parent::loadConfig($reload);
        if ($conf) {
            return $conf;
        }

        $conf = static::loadConf();
        if (empty($conf)) {
            return null;
        }

        $config = new stdClass();

        // 'main' section
        $config->main = new stdClass();
        $config->main->path = $conf->file->main_path ?? constant('BASE_PATH');
        $config->main->url = $conf->file->main_url ?? constant('BASE_URL');
        $config->main->data_path = $conf->file->main_doc ?? '';
        $config->main->alt_base_path = $conf->file->path;
        $config->main->alt_base_url = $conf->file->url;
        $config->main->theme = $conf->file->theme;

        // 'db' section
        $config->db = $conf->db;
        $config->db->charset = $conf->db->charset;
        $config->db->collation = $conf->db->collation;
        $config->db->encryption = $conf->db->encryption;
        $config->db->cryptkey = $conf->db->cryptkey;

        // 'security' section
        $config->security = new stdClass();
        $config->security->authentication_type = $conf->file->main_authentication;
        $config->security->force_https = $conf->file->main_force_https;
        $config->security->unique_id = $conf->file->instance_unique_id;
        $config->security->stream_to_disable = null;
        if (is_array($conf->file->dol_main_stream_to_disable)) {
            $config->security->stream_to_disable = $conf->file->dol_main_stream_to_disable;
        }

        $config->file = $conf->file;

        // Others
        $demo = $dolibarr_main_demo ?? false;

        if ($demo !== false) {
            $credentials = explode(',', $demo);
            if (count($credentials) === 2) {
                $config->demo->user = trim($credentials[0]);
                $config->demo->pass = trim($credentials[1]);
            }
        }

        $config->debug = $conf->debug;

        // 'Server' section
        $config->server = new stdClass();
        $config->server->detailed_info = !empty($_SERVER['MAIN_SHOW_TUNING_INFO']);

        static::$config = $config;

        return $config;
    }

    /**
     * Returns a DoliDB connection instance.
     *
     * @return DoliDB|null
     */
    public static function getDb(): ?DoliDB
    {
        return static::$db;

    }

    /**
     * Fills in the additional data of the $conf variable, taken once the database
     * is initialized
     *
     * @param $conf
     */
    public static function setConfigValues($conf)
    {
        // Here we read database (llx_const table) and define conf var $conf->global->XXX.
        // print "We work with data into entity instance number '".$conf->entity."'";
        $conf->setValues(static::$db);

    }

    /**
     * Returns a TraceableDB connection instance.
     *
     * @return TraceableDB|null
     */
    public static function debugDb(): ?TraceableDB
    {
        if (isModEnabled('debugbar')) {
            static::$db = new TraceableDB(static::$db);

        }
        return static::$db;

    }

    /**
     * Returns a HookManager class instance.
     *
     * @return HookManager|null
     */
    public static function getHookManager(): ?HookManager
    {
        if (empty(static::$hookManager)) {

            static::$hookManager = static::loadHookManager();
        }
        return static::$hookManager;
    }

    /**
     * Returns a HookManager class instance.
     *
     * @return mixed
     */
    private static function loadHookManager()
    {
        static::$hookManager = new HookManager(static::$db);

        return static::$hookManager;
    }

    /**
     * Returns a Translate class instance.
     *
     * @return Translate|null
     */
    public static function getLangs(): ?Translate
    {
        if (empty(static::$langs)) {

            static::$langs = static::loadLangs();
        }
        return static::$langs;
    }

    /**
     * Returns a Translate class instance.
     *
     * @return Translate
     */
    private static function loadLangs()
    {
        static::$langs = new Translate('', static::$dolibarrConfig);

        return static::$langs;
    }

    /**
     * Returns a User class instance.
     *
     * @return User|null
     */
    public static function getUser(): ?User
    {
        if (empty(static::$user)) {

            static::$user = static::loadUser();
        }
        return static::$user;
    }

    private static function loadUser()
    {
        static::$user = new User(static::$db);

        return static::$user;
    }

    public static function getMenuManager($conf)
    {
        if (empty(static::$menumanager)) {

            static::$menumanager = static::loadMenuManager();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        }
        return static::$menumanager;
    }

    private static function loadMenuManager()
    {
        $conf = static::$dolibarrConfig;

        $db = static::$db;


        $menumanager = null;
        if (!defined('NOREQUIREMENU')) {
            if (empty($user->socid)) {    // If internal user or not defined

                $conf->standard_menu = (!getDolGlobalString('MAIN_MENU_STANDARD_FORCED') ? (!getDolGlobalString('MAIN_MENU_STANDARD') ? 'eldy_menu.php' : $conf->global->MAIN_MENU_STANDARD) : $conf->global->MAIN_MENU_STANDARD_FORCED);
            } else {
                // If external user
                $conf->standard_menu = (!getDolGlobalString('MAIN_MENUFRONT_STANDARD_FORCED') ? (!getDolGlobalString('MAIN_MENUFRONT_STANDARD') ? 'eldy_menu.php' : $conf->global->MAIN_MENUFRONT_STANDARD) : $conf->global->MAIN_MENUFRONT_STANDARD_FORCED);
            }

            // Load the menu manager (only if not already done)
            $file_menu = $conf->standard_menu;
            if (GETPOST('menu', 'alpha')) {
                $file_menu = GETPOST('menu', 'alpha'); // example: menu=eldy_menu.php
            }
            if (!class_exists('MenuManager')) {
                $menufound = 0;
                $dirmenus = array_merge(["/core/menus/"], (array)$conf->modules_parts['menus']);
                foreach ($dirmenus as $dirmenu) {
                    $menufound = dol_include_once($dirmenu . "standard/" . $file_menu);
                    if (class_exists('MenuManager')) {
                        break;
                    }
                }
                if (!class_exists('MenuManager')) { // If failed to include, we try with standard eldy_menu.php
                    dol_syslog("You define a menu manager '" . $file_menu . "' that can not be loaded.", LOG_WARNING);
                    $file_menu = 'eldy_menu.php';
                    include_once DOL_DOCUMENT_ROOT . "/core/menus/standard/" . $file_menu;
                }
            }
            $menumanager = new MenuManager($db, empty($user->socid) ? 0 : 1);
            $menumanager->loadMenu();
        }

        static::$menumanager = $menumanager;

    }

    /**
     * Load all Dolibar global variables.
     *
     * @return false|void
     * @throws \DebugBar\DebugBarException
     */
    public static function load(): bool
    {
        global $conf;
        global $config;
        global $db;
        global $hookmanager;
        global $langs;
        global $user;
        global $menumanager;

        $config = parent::loadConfig();
        $conf = static::$dolibarrConfig = static::loadConf();
        $conf = static::$dolibarrConfig = /** @scrutinizer ignore-deprecated */ static::loadConf();
        if (!isset($config->db) || empty($conf->db->name ?? '')) {
            return false;
        }

        $config = static::$config = static::loadConfig();
        $db = static::$db = static::loadDb();
        $hookmanager = static::$hookManager = static::loadHookManager();
        $langs = static::$langs = static::loadLangs();
        $user = static::$user = static::loadUser();
        if ($user->id > 0) {
            $menumanager = static::$menumanager = static::loadMenuManager();
        }
        Debug::load();

        new Database($config->db);

        // TODO: Example of calling a SELECT from Eloquent and from Dolibarr
        // DB::select('SELECT * FROM alx_user'); // use Illuminate\Database\Capsule\Manager as DB;
        // $db->query('SELECT * FROM alx_user');

        return true;
    }

    /**
     * Returns a Dolibarr DB connection (DoliDB) instance.
     *
     * @return DoliDb
     * @throws \Exception
     */
    private static function loadDb()
    {
        $conf = static::$dolibarrConfig;

        static::$db = getDoliDBInstance($conf->db->type, $conf->db->host, $conf->db->user, $conf->db->pass, $conf->db->name, (int)$conf->db->port);

        static::$dolibarrConfig->setValues(static::$db);
                                 setValues(static::$db);

        return static::$db;
    }
}

alxarafe / alixar

Push — main ( e2b3b9...324b47 )

Config::getDolibarrConfigFilename() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
