dolibarr 20.0.0
master.inc.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2002-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2003 Xavier Dutoit <doli@sydesy.com>
4 * Copyright (C) 2004-2012 Laurent Destailleur <eldy@users.sourceforge.net>
5 * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
6 * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
7 * Copyright (C) 2005-2017 Regis Houssin <regis.houssin@inodbox.com>
8 * Copyright (C) 2005 Simon Tosser <simon@kornog-computing.com>
9 * Copyright (C) 2006 Andre Cianfarani <andre.cianfarani@acdeveloppement.net>
10 * Copyright (C) 2010 Juanjo Menent <jmenent@2byte.es>
11 * Copyright (C) 2011 Philippe Grand <philippe.grand@atoo-net.com>
12 * Copyright (C) 2014 Teddy Andreotti <125155@supinfo.com>
13 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
14 *
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 3 of the License, or
18 * (at your option) any later version.
19 *
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * You should have received a copy of the GNU General Public License
26 * along with this program. If not, see <https://www.gnu.org/licenses/>.
27 */
28
36// Include the conf.php and functions.lib.php and security.lib.php. This defined the constants like DOL_DOCUMENT_ROOT, DOL_DATA_ROOT, DOL_URL_ROOT...
37// This file may have been already required by main.inc.php. But may not by scripts. So, here the require_once must be kept.
38require_once 'filefunc.inc.php';
39require_once DOL_DOCUMENT_ROOT.'/core/class/conf.class.php';
40require_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
41
42
43if (!function_exists('is_countable')) {
50 function is_countable($c)
51 {
52 return is_array($c) || $c instanceof Countable;
53 }
54}
55
56/*
57 * Create $conf object
58 */
59
60$conf = new Conf();
61
62// Set properties specific to database
63$conf->db->host = empty($dolibarr_main_db_host) ? '' : $dolibarr_main_db_host;
64$conf->db->port = empty($dolibarr_main_db_port) ? '' : $dolibarr_main_db_port;
65$conf->db->name = empty($dolibarr_main_db_name) ? '' : $dolibarr_main_db_name;
66$conf->db->user = empty($dolibarr_main_db_user) ? '' : $dolibarr_main_db_user;
67$conf->db->pass = empty($dolibarr_main_db_pass) ? '' : $dolibarr_main_db_pass;
68$conf->db->type = $dolibarr_main_db_type;
69$conf->db->prefix = $dolibarr_main_db_prefix;
70$conf->db->character_set = $dolibarr_main_db_character_set;
71$conf->db->dolibarr_main_db_collation = $dolibarr_main_db_collation;
72$conf->db->dolibarr_main_db_encryption = $dolibarr_main_db_encryption;
73$conf->db->dolibarr_main_db_cryptkey = $dolibarr_main_db_cryptkey;
74if (defined('TEST_DB_FORCE_TYPE')) {
75 $conf->db->type = constant('TEST_DB_FORCE_TYPE'); // Force db type (for test purpose, by PHP unit for example)
76}
77
78// Set properties specific to conf file
79$conf->file->main_limit_users = $dolibarr_main_limit_users;
80$conf->file->mailing_limit_sendbyweb = empty($dolibarr_mailing_limit_sendbyweb) ? 0 : $dolibarr_mailing_limit_sendbyweb;
81$conf->file->mailing_limit_sendbycli = empty($dolibarr_mailing_limit_sendbycli) ? 0 : $dolibarr_mailing_limit_sendbycli;
82$conf->file->mailing_limit_sendbyday = empty($dolibarr_mailing_limit_sendbyday) ? 0 : $dolibarr_mailing_limit_sendbyday;
83$conf->file->main_authentication = empty($dolibarr_main_authentication) ? 'dolibarr' : $dolibarr_main_authentication; // Identification mode
84$conf->file->main_force_https = empty($dolibarr_main_force_https) ? '' : $dolibarr_main_force_https; // Force https
85$conf->file->strict_mode = empty($dolibarr_strict_mode) ? '' : $dolibarr_strict_mode; // Force php strict mode (for debug)
86$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
87$conf->file->dol_main_url_root = $dolibarr_main_url_root; // Define url inside the config file
88$conf->file->dol_document_root = array('main' => (string) DOL_DOCUMENT_ROOT); // Define array of document root directories ('/home/htdocs')
89$conf->file->dol_url_root = array('main' => (string) DOL_URL_ROOT); // Define array of url root path ('' or '/dolibarr')
90if (!empty($dolibarr_main_document_root_alt)) {
91 // dolibarr_main_document_root_alt can contains several directories
92 $values = preg_split('/[;,]/', $dolibarr_main_document_root_alt);
93 $i = 0;
94 foreach ($values as $value) {
95 $conf->file->dol_document_root['alt'.($i++)] = (string) $value;
96 }
97 $values = preg_split('/[;,]/', $dolibarr_main_url_root_alt);
98 $i = 0;
99 foreach ($values as $value) {
100 if (preg_match('/^http(s)?:/', $value)) {
101 // Show error message
102 $correct_value = str_replace($dolibarr_main_url_root, '', $value);
103 print '<b>Error:</b><br>'."\n";
104 print 'Wrong <b>$dolibarr_main_url_root_alt</b> value in <b>conf.php</b> file.<br>'."\n";
105 print 'We now use a relative path to $dolibarr_main_url_root to build alternate URLs.<br>'."\n";
106 print 'Value found: '.$value.'<br>'."\n";
107 print 'Should be replaced by: '.$correct_value.'<br>'."\n";
108 print "Or something like following examples:<br>\n";
109 print "\"/extensions\"<br>\n";
110 print "\"/extensions1,/extensions2,...\"<br>\n";
111 print "\"/../extensions\"<br>\n";
112 print "\"/custom\"<br>\n";
113 exit;
114 }
115 $conf->file->dol_url_root['alt'.($i++)] = (string) $value;
116 }
117}
118
119// Load the main includes of common libraries
120if (!defined('NOREQUIREUSER')) {
121 require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php'; // Need 500ko memory
122}
123if (!defined('NOREQUIRETRAN')) {
124 require_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
125}
126if (!defined('NOREQUIRESOC')) {
127 require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
128}
129
130
131/*
132 * Create object $langs (must be before all other code)
133 */
134if (!defined('NOREQUIRETRAN')) {
135 $langs = new Translate('', $conf); // Must be after reading conf
136}
137
138/*
139 * Object $db
140 */
141$db = null;
142if (!defined('NOREQUIREDB')) {
143 $db = getDoliDBInstance($conf->db->type, $conf->db->host, $conf->db->user, $conf->db->pass, $conf->db->name, (int) $conf->db->port);
144
145 if ($db->error) {
146 // If we were into a website context
147 if (!defined('USEDOLIBARREDITOR') && !defined('USEDOLIBARRSERVER') && !empty($_SERVER['SCRIPT_FILENAME']) && (strpos($_SERVER['SCRIPT_FILENAME'], DOL_DATA_ROOT.'/website') === 0)) {
148 $sapi_type = php_sapi_name();
149 if (substr($sapi_type, 0, 3) != 'cgi') {
150 http_response_code(503); // To tel search engine this is a temporary error
151 }
152 print '<div class="center" style="text-align: center; margin: 100px;">';
153 if (is_object($langs)) {
154 $langs->setDefaultLang('auto');
155 $langs->load("website");
156 print $langs->trans("SorryWebsiteIsCurrentlyOffLine");
157 } else {
158 print "SorryWebsiteIsCurrentlyOffLine";
159 }
160 print '</div>';
161 exit(1);
162 }
163 dol_print_error($db, "host=".$conf->db->host.", port=".$conf->db->port.", user=".$conf->db->user.", databasename=".$conf->db->name.", ".$db->error);
164 exit(1);
165 }
166}
167
168// Now database connection is known, so we can forget password
169//unset($dolibarr_main_db_pass); // We comment this because this constant is used in some other pages
170unset($conf->db->pass); // This is to avoid password to be shown in memory/swap dump
171
172
173/*
174 * Object $user
175 */
176if (!defined('NOREQUIREUSER')) {
177 $user = new User($db);
178}
179
180/*
181 * Create the global $hookmanager object
182 */
183$hookmanager = new HookManager($db);
184
185
186/*
187 * Load object $conf
188 */
189
190// By default conf->entity is 1, but we change this if we ask another value.
191if (session_id() && !empty($_SESSION["dol_entity"])) {
192 // Entity inside an opened session
193 $conf->entity = $_SESSION["dol_entity"];
194} elseif (!empty($_ENV["dol_entity"])) {
195 // Entity inside a CLI script
196 $conf->entity = $_ENV["dol_entity"];
197} elseif (GETPOSTISSET("loginfunction") && (GETPOSTINT("entity") || GETPOSTINT("switchentity"))) {
198 // Just after a login page
199 $conf->entity = (GETPOSTISSET("entity") ? GETPOSTINT("entity") : GETPOSTINT("switchentity"));
200} elseif (defined('DOLENTITY') && is_numeric(constant('DOLENTITY'))) {
201 // For public page with MultiCompany module
202 $conf->entity = constant('DOLENTITY');
203}
204// Sanitize entity
205if (!is_numeric($conf->entity)) {
206 $conf->entity = 1;
207}
208// Here we read database (llx_const table) and define conf var $conf->global->XXX.
209//print "We work with data into entity instance number '".$conf->entity."'";
210$conf->setValues($db);
211
212// Create object $mysoc (A thirdparty object that contains properties of companies managed by Dolibarr.
213if (!defined('NOREQUIREDB') && !defined('NOREQUIRESOC')) {
214 require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
215
216 $mysoc = new Societe($db);
217 $mysoc->setMysoc($conf);
218
219 // We set some specific default values according to country
220
221 if ($mysoc->country_code == 'DE' && !isset($conf->global->MAIN_INVERT_SENDER_RECIPIENT)) {
222 // For DE, we need to invert our address with customer address
223 $conf->global->MAIN_INVERT_SENDER_RECIPIENT = 1;
224 }
225 if ($mysoc->country_code == 'FR' && !isset($conf->global->INVOICE_CATEGORY_OF_OPERATION)) {
226 // For FR, default value of option to show category of operations is on by default. Decret n°2099-1299 2022-10-07
227 $conf->global->INVOICE_CATEGORY_OF_OPERATION = 1;
228 }
229 if ($mysoc->country_code == 'FR' && !isset($conf->global->INVOICE_DISABLE_REPLACEMENT)) {
230 // For FR, the replacement invoice type is not allowed.
231 // From an accounting point of view, this creates holes in the numbering of the invoice.
232 // This is very problematic during a fiscal control.
233 $conf->global->INVOICE_DISABLE_REPLACEMENT = 1;
234 }
235 if ($mysoc->country_code == 'GR' && !isset($conf->global->INVOICE_DISABLE_REPLACEMENT)) {
236 // The replacement invoice type is not allowed in Greece.
237 $conf->global->INVOICE_DISABLE_REPLACEMENT = 1;
238 }
239 if ($mysoc->country_code == 'GR' && !isset($conf->global->INVOICE_DISABLE_DEPOSIT)) {
240 // The deposit invoice type is not allowed in Greece.
241 $conf->global->INVOICE_DISABLE_DEPOSIT = 1;
242 }
243 if ($mysoc->country_code == 'GR' && !isset($conf->global->INVOICE_CREDIT_NOTE_STANDALONE)) {
244 // Standalone credit note is compulsory in Greece.
245 $conf->global->INVOICE_CREDIT_NOTE_STANDALONE = 1;
246 }
247 if ($mysoc->country_code == 'GR' && !isset($conf->global->INVOICE_SUBTYPE_ENABLED)) {
248 // Invoice subtype is a requirement for Greece.
249 $conf->global->INVOICE_SUBTYPE_ENABLED = 1;
250 }
251
252 if (($mysoc->localtax1_assuj || $mysoc->localtax2_assuj) && !isset($conf->global->MAIN_NO_INPUT_PRICE_WITH_TAX)) {
253 // For countries using the 2nd or 3rd tax, we disable input/edit of lines using the price including tax (because 2nb and 3rd tax not yet taken into account).
254 // Work In Progress to support all taxes into unit price entry when MAIN_UNIT_PRICE_WITH_TAX_IS_FOR_ALL_TAXES is set.
255 $conf->global->MAIN_NO_INPUT_PRICE_WITH_TAX = 1;
256 }
257}
258
259
260// Set default language (must be after the setValues setting global conf 'MAIN_LANG_DEFAULT'. Page main.inc.php will overwrite langs->defaultlang with user value later)
261if (!defined('NOREQUIRETRAN')) {
262 $langcode = (GETPOST('lang', 'aZ09') ? GETPOST('lang', 'aZ09', 1) : getDolGlobalString('MAIN_LANG_DEFAULT', 'auto'));
263 if (defined('MAIN_LANG_DEFAULT')) { // So a page can force the language whatever is setup and parameters in URL
264 $langcode = constant('MAIN_LANG_DEFAULT');
265 }
266 $langs->setDefaultLang($langcode);
267}
268
269
270
271if (!defined('MAIN_LABEL_MENTION_NPR')) {
272 define('MAIN_LABEL_MENTION_NPR', 'NPR');
273}
Class to stock current configuration.
Class to manage hooks.
Class to manage third parties objects (customers, suppliers, prospects...)
Class to manage translations.
Class to manage Dolibarr users.
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
getDoliDBInstance($type, $host, $user, $pass, $name, $port)
Return a DoliDB instance (database handler).