Config::getDataDir() - Code Metrics - Inspection of "fda8382605d56a0c6bd780d6ebde0c9175ddbfcc" - alxarafe/alixar - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Branch — main (fda838)

by Rafael

created 2024-04-01 18:59 UTC

Config::getDataDir() 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	1
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 Alxarafe\Base\Globals;
use Conf;
use MenuManager;
use stdClass;

require_once BASE_PATH . '/core/class/conf.class.php';

/**
 * Generate an object with the configuration of the Dolibarr conf.php file.
 *
 * @info https://wiki.dolibarr.org/index.php/Configuration_file
 *
 * @deprecated This class is only needed for compatibility with Dolibarr.
 */
abstract class Config
{
    /**
     * Contains the information from the conf.php file.
     *
     * @var null|stdClass
     */
    protected static $config = null;

    /**
     * Contains the information of the old conf global var.
     *
     * @var null|stdClass
     */
    protected static $conf = null;

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

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

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

        $filename = static::getDolibarrConfigFilename();
        if (!file_exists($filename) || !is_readable($filename)) {
            return null;
        }

        include $filename;

        $config = new stdClass();

        // 'main' section
        $config->main = new stdClass();
        $config->main->base_path = trim($dolibarr_main_document_root ?? constant('BASE_PATH'));

        $config->main->base_url = trim($dolibarr_main_url_root ?? constant('BASE_URL'));

        $config->main->data_path = trim($dolibarr_main_data_root ?? static::getDataDir($config->main->base_path));


        $alt_base_path = $dolibarr_main_document_root_alt ?? false;

        if ($alt_base_path !== false) {
            $config->main->alt_base_path = trim($dolibarr_main_document_root_alt);

        }

        $alt_base_url = $dolibarr_main_url_root_alt ?? false;

        if ($alt_base_url !== false) {
            $config->main->alt_base_url = trim($dolibarr_main_url_root_alt);

        }

        $alt_data_path = $dolibarr_main_data_root_alt ?? false;

        if ($alt_data_path !== false) {
            $config->main->alt_data_path = trim($dolibarr_main_data_root_alt);

        }

        // 'db' section
        $config->db = new stdClass();
        $config->db->type = trim($dolibarr_main_db_type ?? 'mysql');

        $config->db->host = trim($dolibarr_main_db_host ?? 'localhost');

        $config->db->port = trim($dolibarr_main_db_port ?? '');

        $config->db->name = trim($dolibarr_main_db_name ?? 'dolibarr');

        $config->db->user = trim($dolibarr_main_db_user ?? 'dolibarr');

        $config->db->pass = trim($dolibarr_main_db_pass ?? '');

        $config->db->prefix = trim($dolibarr_main_db_prefix ?? '');

        $config->db->charset = trim($dolibarr_main_db_character_set ?? 'utf8');

        $config->db->collation = trim($dolibarr_main_db_collation ?? 'utf8mb4_unicode_ci');


        // 'security' section
        $config->security = new stdClass();
        $config->security->authentication_type = $dolibarr_main_authentication ?? 'dolibarr';

        $config->security->force_https = intval($dolibarr_main_force_https ?? 1);

        $config->security->unique_id = $dolibarr_main_instance_unique_id ?? null;


        $config->file = new stdClass();
        $config->file->instance_unique_id = $config->security->unique_id;

        // 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 = intval($dolibarr_main_prod ?? 1) === 0;


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

        return $config;
    }

    /**
     * Create the Dolibarr conf variable.
     *
     * @param $reload
     *
     * @return stdClass|null
     */
    public static function loadConf($reload = false): ?stdClass
    {
        if (isset(static::$conf) && !$reload) {
            return static::$conf;
        }

        $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 ?? 'alx_';

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

        $conf->db->dolibarr_main_db_collation = $dolibarr_main_db_collation ?? 'utf8-unicode-ci';

        $conf->db->dolibarr_main_db_encryption = $dolibarr_main_db_encryption ?? null;

        $conf->db->dolibarr_main_db_cryptkey = $dolibarr_main_db_cryptkey ?? null;

        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->dol_main_url_root = $dolibarr_main_url_root ?? BASE_URL;   // Define url inside the config file

        $conf->file->dol_document_root = ['main' => (string) DOL_DOCUMENT_ROOT]; // Define array of document root directories ('/home/htdocs')
        $conf->file->dol_url_root = ['main' => (string) DOL_URL_ROOT]; // Define array of url root path ('' or '/dolibarr')
        if (!empty($dolibarr_main_document_root_alt)) {

            // dolibarr_main_document_root_alt can contains several directories
            $values = preg_split('/[;,]/', $dolibarr_main_document_root_alt);
            $i = 0;
            foreach ($values as $value) {
                $conf->file->dol_document_root['alt' . ($i++)] = (string) $value;
            }
            $values = preg_split('/[;,]/', $dolibarr_main_url_root_alt);

            $i = 0;
            foreach ($values as $value) {
                if (preg_match('/^http(s)?:/', $value)) {
                    // Show error message
                    $correct_value = str_replace($dolibarr_main_url_root, '', $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->dol_url_root['alt' . ($i++)] = (string) $value;
            }
        }

        // Load the main includes of common libraries
        if (!defined('NOREQUIREUSER')) {
            require_once DOL_DOCUMENT_ROOT . '/user/class/user.class.php'; // Need 500ko memory
        }
        if (!defined('NOREQUIRETRAN')) {
            require_once DOL_DOCUMENT_ROOT . '/core/class/translate.class.php';
        }
        if (!defined('NOREQUIRESOC')) {
            require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
        }

        return $conf;
    }

    /**
     * Create the content for the menumanager variable.
     *
     * @param $conf
     *
     * @return MenuManager
     * @throws \Exception
     */
    public static function getMenuManager($conf)
    {
        // Init menu manager
        $db = Globals::getDb($conf);

        $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();
        }
        return $menumanager;
    }
}


1			<?php
2
3			/* Copyright (C) 2024 Rafael San José <[email protected]>
4			*
5			* This program is free software; you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation; either version 3 of the License, or
8			* any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License
16			* along with this program. If not, see <https://www.gnu.org/licenses/>.
17			*/
18
19			namespace DoliCore\Base;
20
21			use Alxarafe\Base\Globals;
22			use Conf;
23			use MenuManager;
24			use stdClass;
25
26			require_once BASE_PATH . '/core/class/conf.class.php';
27
28			/**
29			* Generate an object with the configuration of the Dolibarr conf.php file.
30			*
31			* @info https://wiki.dolibarr.org/index.php/Configuration_file
32			*
33			* @deprecated This class is only needed for compatibility with Dolibarr.
34			*/
35			abstract class Config
36			{
37			/**
38			* Contains the information from the conf.php file.
39			*
40			* @var null\|stdClass

alxarafe / alixar

Branch — main (fda838)

Config::getDataDir() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like