Clean constants handling (#19684)

* Make the `GLPI_LOG_LVL` constant always defined

* Deprecate the GLPI_FORCE_MAIL constant

* Make SKIP_UPDATES always defined

* Make GLPI_SYSTEM_CRON always defined

* Replace GLPI_KEEP_CSRF_TOKEN by method params

* Add missing GLPI_USE_CSRF_CHECK to PHPStan config

* Use the `GLPI_` prefix for all constants

* Handle PLUGINS_DIRECTORIES deprecation

Author: cedric-anne

CHANGELOG.md

@@ -236,10 +236,12 @@ The present file will list all changes made to the project; according to the
 - `Software::merge()` method is now private.
 - The refusal of the collected emails corresponding to a GLPI notification will now be made based on a default rule.
 - The `$store_path` parameter has been removed from the `Dropdown::dropdownIcons()` method.
+- The `PLUGINS_DIRECTORIES` constant has been renamed to `GLPI_PLUGINS_DIRECTORIES`.
 
 #### Deprecated
 - Usage of the `/marketplace` path for plugins URLs. All plugins URLs should now start with `/plugins`.
 - Usage of `GLPI_PLUGINS_PATH` javascript variable.
+- Usage of the `GLPI_FORCE_MAIL` constant.
 - Usage of `MAIL_SMTPSSL` and `MAIL_SMTPTLS` constants.
 - Usage of `name` and `users_id_validate` parameter in `ajax/dropdownValidator.php`.
 - Usage of `users_id_validate` parameter in `front/commonitilvalidation.form.php`.
@@ -325,7 +327,7 @@ The present file will list all changes made to the project; according to the
 - `Toolbox::stripslashes_deep()`
 
 #### Removed
-- `GLPI_USE_CSRF_CHECK`, `GLPI_USE_IDOR_CHECK`, `GLPI_CSRF_EXPIRES`, `GLPI_CSRF_MAX_TOKENS` and `GLPI_IDOR_EXPIRES` constants.
+- `GLPI_USE_CSRF_CHECK`, `GLPI_USE_IDOR_CHECK`, `GLPI_KEEP_CSRF_TOKEN`, `GLPI_CSRF_EXPIRES`, `GLPI_CSRF_MAX_TOKENS` and `GLPI_IDOR_EXPIRES` constants.
 - `GLPI_DEMO_MODE` constant.
 - `GLPI_DUMP_DIR` constant.
 - `GLPI_SQL_DEBUG` constant.

phpstan.neon.dist

@@ -48,19 +48,22 @@ parameters:
         - GLPI_NETWORK_SERVICES
         - GLPI_PICTURE_DIR
         - GLPI_PLUGIN_DOC_DIR
+        - GLPI_PLUGINS_DIRECTORIES
         - GLPI_RSS_DIR
         - GLPI_SERVERSIDE_URL_ALLOWLIST
         - GLPI_SESSION_DIR
+        - GLPI_SKIP_UPDATES
         - GLPI_STRICT_ENV
+        - GLPI_SYSTEM_CRON
         - GLPI_TELEMETRY_URI
         - GLPI_TEXT_MAXSIZE
         - GLPI_THEMES_DIR
         - GLPI_TMP_DIR
         - GLPI_UPLOAD_DIR
+        - GLPI_USE_CSRF_CHECK
         - GLPI_USER_AGENT_EXTRA_COMMENTS
         - GLPI_VAR_DIR
         - GLPI_WEBHOOK_ALLOW_RESPONSE_SAVING
-        - PLUGINS_DIRECTORIES
         - TU_USER
     ignoreErrors:
         - '~Instantiated class XHProfRuns_Default not found~'

src/CronTask.php

@@ -975,7 +975,7 @@ public static function register($itemtype, $name, $frequency, $options = [])
             }
         }
         if (
-            defined('GLPI_SYSTEM_CRON')
+            GLPI_SYSTEM_CRON
             && ($input['allowmode'] & self::MODE_EXTERNAL)
             && !isset($input['mode'])
         ) {

src/DbUtils.php

@@ -367,7 +367,7 @@ public function getItemTypeForTable($table)
      *
      * @return string
      */
-    public function fixItemtypeCase(string $itemtype, $root_dir = GLPI_ROOT, array $plugins_dirs = PLUGINS_DIRECTORIES)
+    public function fixItemtypeCase(string $itemtype, $root_dir = GLPI_ROOT, array $plugins_dirs = GLPI_PLUGINS_DIRECTORIES)
     {
         /** @var \Psr\SimpleCache\CacheInterface $GLPI_CACHE */
         global $GLPI_CACHE;

src/Glpi/Application/Environment.php

@@ -133,6 +133,7 @@ public function getConstantsOverride(string $root_dir): array
             self::TESTING     => [
                 'GLPI_CONFIG_DIR'               => $root_dir . '/tests/config',
                 'GLPI_VAR_DIR'                  => $root_dir . '/tests/files',
+                'GLPI_LOG_LVL'                  => LogLevel::DEBUG,
                 'GLPI_STRICT_ENV'               => true,
                 'GLPI_SERVERSIDE_URL_ALLOWLIST' => [
                     // default allowlist entries
@@ -143,30 +144,19 @@ public function getConstantsOverride(string $root_dir): array
                     // calendar mockups
                     '/^file:\/\/.*\.ics$/',
                 ],
-                'PLUGINS_DIRECTORIES'           => [
+                'GLPI_PLUGINS_DIRECTORIES'      => [
                     $root_dir . '/plugins',
                     $root_dir . '/tests/fixtures/plugins',
                 ],
             ],
             self::DEVELOPMENT => [
+                'GLPI_LOG_LVL'                       => LogLevel::DEBUG,
                 'GLPI_STRICT_ENV'                    => true,
                 'GLPI_WEBHOOK_ALLOW_RESPONSE_SAVING' => '1',
             ],
         };
     }
 
-    public function getLogLevel(): string
-    {
-        // Do not report debug, info, and notice messages unless in development/testing env.
-        // Notices are errors with no functional impact, so we do not want people to report them as issues.
-        // Suppressing the INFO level will prevent deprecations to be pushed in other environments logs.
-        return match ($this) {
-            default           => LogLevel::WARNING,
-            self::TESTING     => LogLevel::DEBUG,
-            self::DEVELOPMENT => LogLevel::DEBUG,
-        };
-    }
-
     /**
      * Will the files of this environment change ?
      * This may affect which cache we decide to set (twig, http cache on the

src/Glpi/Application/SystemConfigurator.php

@@ -39,6 +39,7 @@
 use Glpi\Log\ErrorLogHandler;
 use Monolog\Logger;
 use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
 
 final class SystemConfigurator
 {
@@ -50,6 +51,9 @@ public function __construct(private string $root_dir, private ?string $env)
         $this->setSessionConfiguration();
         $this->initLogger();
         $this->registerErrorHandler();
+
+        // Keep it after `registerErrorHandler()` call to be sure that messages are correctly handled.
+        $this->checkForObsoleteConstants();
     }
 
     public function getLogger(): LoggerInterface
@@ -99,7 +103,7 @@ private function computeConstants(): void
 
                 // Where to load plugins.
                 // Order in this array is important (priority to first found).
-                'PLUGINS_DIRECTORIES'  => [
+                'GLPI_PLUGINS_DIRECTORIES' => [
                     '{GLPI_MARKETPLACE_DIR}',
                     $this->root_dir . '/plugins',
                 ],
@@ -145,12 +149,15 @@ private function computeConstants(): void
 
                 // Constants dedicated to developers
                 'GLPI_DISABLE_ONLY_FULL_GROUP_BY_SQL_MODE' => '1', // '1' to disable ONLY_FULL_GROUP_BY 'sql_mode'
+                'GLPI_LOG_LVL'                             => LogLevel::WARNING,
+                'GLPI_SKIP_UPDATES'                        => false, // `true` to bypass minor versions DB updates
                 'GLPI_STRICT_ENV'                          => false, // `true` to make environment more strict (strict variables in twig templates, etc)
 
                 // Other constants
                 'GLPI_AJAX_DASHBOARD'         => '1', // 1 for "multi ajax mode" 0 for "single ajax mode" (see Glpi\Dashboard\Grid::getCards)
                 'GLPI_CALDAV_IMPORT_STATE'    => 0, // external events created from a caldav client will take this state by default (0 = Planning::INFO)
                 'GLPI_CENTRAL_WARNINGS'       => '1', // display (1), or not (0), warnings on GLPI Central page
+                'GLPI_SYSTEM_CRON'            => false, // `true` to use the system cron provided by the downstream package
                 'GLPI_TEXT_MAXSIZE'           => '4000', // character threshold for displaying read more button
                 'GLPI_WEBHOOK_ALLOW_RESPONSE_SAVING' => '0', // allow (1) or not (0) to save webhook response in database
             ],
@@ -179,6 +186,11 @@ private function computeConstants(): void
             include_once($this->root_dir . '/inc/downstream.php');
         }
 
+        // Handle deprecated/obsolete constants
+        if (defined('PLUGINS_DIRECTORIES') && !defined('GLPI_PLUGINS_DIRECTORIES')) {
+            define('GLPI_PLUGINS_DIRECTORIES', PLUGINS_DIRECTORIES);
+        }
+
         // Configure environment type if not defined by user.
         if (Environment::isSet()) {
             Environment::validate();
@@ -269,4 +281,21 @@ private function registerErrorHandler(): void
         $errorHandler = new ErrorHandler($this->logger);
         $errorHandler::register($errorHandler);
     }
+
+    private function checkForObsoleteConstants(): void
+    {
+        if (defined('GLPI_USE_CSRF_CHECK')) {
+            trigger_error(
+                'The `GLPI_USE_CSRF_CHECK` constant is now ignored for security reasons.',
+                E_USER_WARNING
+            );
+        }
+
+        if (defined('PLUGINS_DIRECTORIES')) {
+            trigger_error(
+                'The `PLUGINS_DIRECTORIES` constant is deprecated. Use the `GLPI_PLUGINS_DIRECTORIES` constant instead.',
+                E_USER_DEPRECATED
+            );
+        }
+    }
 }

src/Glpi/Console/Application.php

@@ -252,7 +252,7 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI
 
         if (
             $is_db_available
-            && defined('SKIP_UPDATES')
+            && GLPI_SKIP_UPDATES
             && (!($command instanceof GlpiCommandInterface) || $command->requiresUpToDateDb())
             && !Update::isDbUpToDate()
         ) {

src/Glpi/Console/CommandLoader.php

@@ -218,7 +218,7 @@ private function findPluginCommands()
         }
 
         $plugins_directories = new AppendIterator();
-        foreach (PLUGINS_DIRECTORIES as $directory) {
+        foreach (GLPI_PLUGINS_DIRECTORIES as $directory) {
             $directory = str_replace(GLPI_ROOT, $this->rootdir, $directory);
             $plugins_directories->append(new DirectoryIterator($directory));
         }

src/Glpi/Console/Plugin/InstallCommand.php

@@ -185,7 +185,7 @@ protected function getDirectoryChoiceChoices()
 
         // Fetch directory list
         $directories = [];
-        foreach (PLUGINS_DIRECTORIES as $plugins_directory) {
+        foreach (GLPI_PLUGINS_DIRECTORIES as $plugins_directory) {
             $directory_handle  = opendir($plugins_directory);
             while (false !== ($filename = readdir($directory_handle))) {
                 if (

src/Glpi/Error/ErrorHandler.php

@@ -236,8 +236,7 @@ private function configureErrorReporting(): void
         $reporting_level = E_ALL;
 
         // Compute max error level that should be reported
-        $env_psr_level = Environment::get()->getLogLevel();
-        $env_report_value = self::PSR_ERROR_LEVEL_VALUES[$env_psr_level];
+        $env_report_value = self::PSR_ERROR_LEVEL_VALUES[GLPI_LOG_LVL];
 
         foreach (self::ERROR_LEVEL_MAP as $value => $log_level) {
             $psr_level_value = self::PSR_ERROR_LEVEL_VALUES[$log_level];