Configure Joomla with environment variables

Author: voronkovich

administrator/includes/framework.php

@@ -11,6 +11,7 @@
 
 use Joomla\CMS\Version;
 use Joomla\Utilities\IpHelper;
+use Symfony\Component\Dotenv\Dotenv;
 
 // System includes
 require_once JPATH_LIBRARIES . '/bootstrap.php';
@@ -38,13 +39,30 @@
     exit;
 }
 
+// Load .env files
+if (file_exists(JPATH_ROOT . '/.env.local.php') || file_exists(JPATH_ROOT . '/.env')) {
+    (new Dotenv('JOOMLA_ENV', 'JOOMLA_DEBUG'))->bootEnv(JPATH_ROOT . '/.env', 'prod');
+}
+
 // Pre-Load configuration. Don't remove the Output Buffering due to BOM issues, see JCode 26026
 ob_start();
 require_once JPATH_CONFIGURATION . '/configuration.php';
 ob_end_clean();
 
+// getenv() is not thread-safe and it can cause segmentaion fault, so we should try $_SERVER first
+$envs = !empty($_SERVER) ? $_SERVER : getenv();
+
 // System configuration.
-$config = new JConfig();
+$config                  = new JConfig();
+$config->error_reporting = $envs['JOOMLA_ERROR_REPORTING'] ?? $config->error_reporting;
+$config->debug           = (bool) ($envs['JOOMLA_DEBUG'] ?? $config->debug);
+if (isset($envs['JOOMLA_LOG_DEPRECATED'])) {
+    $config->log_deprecated = (int) $envs['JOOMLA_LOG_DEPRECATED'];
+}
+if (isset($envs['JOOMLA_BEHIND_LOADBALANCER'])) {
+    $config->behind_loadbalancer = (bool) $envs['JOOMLA_BEHIND_LOADBALANCER'];
+}
+unset($envs);
 
 // Set the error_reporting, and adjust a global Error Handler
 switch ($config->error_reporting) {

api/includes/framework.php

@@ -11,6 +11,7 @@
 
 use Joomla\CMS\Version;
 use Joomla\Utilities\IpHelper;
+use Symfony\Component\Dotenv\Dotenv;
 
 // System includes
 require_once JPATH_LIBRARIES . '/bootstrap.php';
@@ -38,13 +39,30 @@
     exit;
 }
 
+// Load .env files
+if (file_exists(JPATH_ROOT . '/.env.local.php') || file_exists(JPATH_ROOT . '/.env')) {
+    (new Dotenv('JOOMLA_ENV', 'JOOMLA_DEBUG'))->bootEnv(JPATH_ROOT . '/.env', 'prod');
+}
+
 // Pre-Load configuration. Don't remove the Output Buffering due to BOM issues, see JCode 26026
 ob_start();
 require_once JPATH_CONFIGURATION . '/configuration.php';
 ob_end_clean();
 
+// getenv() is not thread-safe and it can cause segmentaion fault, so we should try $_SERVER first
+$envs = !empty($_SERVER) ? $_SERVER : getenv();
+
 // System configuration.
-$config = new JConfig();
+$config                  = new JConfig();
+$config->error_reporting = $envs['JOOMLA_ERROR_REPORTING'] ?? $config->error_reporting;
+$config->debug           = (bool) ($envs['JOOMLA_DEBUG'] ?? $config->debug);
+if (isset($envs['JOOMLA_LOG_DEPRECATED'])) {
+    $config->log_deprecated = (int) $envs['JOOMLA_LOG_DEPRECATED'];
+}
+if (isset($envs['JOOMLA_BEHIND_LOADBALANCER'])) {
+    $config->behind_loadbalancer = (bool) $envs['JOOMLA_BEHIND_LOADBALANCER'];
+}
+unset($envs);
 
 // Set the error_reporting
 switch ($config->error_reporting) {

composer.json

@@ -14,7 +14,9 @@
       "php": "8.1.0"
     },
     "vendor-dir": "libraries/vendor",
-    "github-protocols": ["https"]
+    "github-protocols": [
+      "https"
+    ]
   },
   "support": {
     "issues": "https://issues.joomla.org/",
@@ -26,7 +28,7 @@
     {
       "type": "vcs",
       "url": "https://github.com/joomla-backports/json-api-php.git",
-      "no-api":  true
+      "no-api": true
     },
     {
       "type": "vcs",
@@ -109,7 +111,8 @@
     "jfcherng/php-diff": "^6.16.2",
     "voku/portable-utf8": "dev-joomla-5.3 as 6.0.13",
     "php-tuf/php-tuf": "^1.0.2",
-    "php-debugbar/php-debugbar": "^2.1"
+    "php-debugbar/php-debugbar": "^2.1",
+    "symfony/dotenv": "^6.4"
   },
   "require-dev": {
     "phpunit/phpunit": "^9.6.22",
@@ -135,7 +138,7 @@
   },
   "scripts": {
     "post-install-cmd": [
-    "php build/update_fido_cache.php"
+      "php build/update_fido_cache.php"
     ]
   }
 }

composer.lock

@@ -0,0 +1,6 @@
+JOOMLA_DEBUG=1
+JOOMLA_DEBUG_LANG=0
+JOOMLA_DEBUG_LANG_CONST=0
+JOOMLA_ERROR_REPORTING='maximum'
+JOOMLA_LOG_DEPRECATED=1
+JOOMLA_LOG_EVERYTHING=1

env.dev.dist

@@ -0,0 +1,29 @@
+# In all environments, the following files are loaded if they exist,
+# the latter taking precedence over the former:
+#
+#  * .env                   contains default values for the environment variables needed by the app
+#  * .env.local             uncommitted file with local overrides
+#  * .env.$JOOMLA_ENV       committed environment-specific defaults
+#  * .env.$JOOMLA_ENV.local uncommitted environment-specific overrides
+#
+# Real environment variables win over .env files.
+#
+# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
+#
+# To set a configuration value use format JOOMLA_$KEY:
+#
+# JOOMLA_OFFLINE=1
+# JOOMLA_SITENAME='Joomla!'
+#
+# All available configuration values are listed in installation/configuration.php-dist.
+
+JOOMLA_ENV=dev
+
+# Database configuration
+#
+# JOOMLA_DBTYPE='mysqli'
+# JOOMLA_DBHOST='localhost'
+# JOOMLA_DBNAME='db'
+# JOOMLA_DBUSER='db'
+# JOOMLA_DBPASSWORD='db'
+# JOOMLA_DBPREFIX='jos_'

env.dist

@@ -12,6 +12,7 @@
 use Joomla\CMS\Uri\Uri;
 use Joomla\CMS\Version;
 use Joomla\Utilities\IpHelper;
+use Symfony\Component\Dotenv\Dotenv;
 
 // System includes
 require_once JPATH_LIBRARIES . '/bootstrap.php';
@@ -39,13 +40,30 @@
     exit;
 }
 
+// Load .env files
+if (file_exists(JPATH_ROOT . '/.env.local.php') || file_exists(JPATH_ROOT . '/.env')) {
+    (new Dotenv('JOOMLA_ENV', 'JOOMLA_DEBUG'))->bootEnv(JPATH_ROOT . '/.env', 'prod');
+}
+
 // Pre-Load configuration. Don't remove the Output Buffering due to BOM issues, see JCode 26026
 ob_start();
 require_once JPATH_CONFIGURATION . '/configuration.php';
 ob_end_clean();
 
+// getenv() is not thread-safe and it can cause segmentaion fault, so we should try $_SERVER first
+$envs = !empty($_SERVER) ? $_SERVER : getenv();
+
 // System configuration.
-$config = new JConfig();
+$config                  = new JConfig();
+$config->error_reporting = $envs['JOOMLA_ERROR_REPORTING'] ?? $config->error_reporting;
+$config->debug           = (bool) ($envs['JOOMLA_DEBUG'] ?? $config->debug);
+if (isset($envs['JOOMLA_LOG_DEPRECATED'])) {
+    $config->log_deprecated = (int) $envs['JOOMLA_LOG_DEPRECATED'];
+}
+if (isset($envs['JOOMLA_BEHIND_LOADBALANCER'])) {
+    $config->behind_loadbalancer = (bool) $envs['JOOMLA_BEHIND_LOADBALANCER'];
+}
+unset($envs);
 
 // Set the error_reporting, and adjust a global Error Handler
 switch ($config->error_reporting) {

includes/framework.php

@@ -10,8 +10,7 @@
 
 \defined('_JEXEC') or die;
 
-// Ensure sensible default for JDEBUG is set.
-const JDEBUG = false;
+use Symfony\Component\Dotenv\Dotenv;
 
 // Check if a configuration file already exists.
 if (
@@ -26,6 +25,14 @@
 // Import the Joomla Platform.
 require_once JPATH_LIBRARIES . '/bootstrap.php';
 
+// Load .env files
+if (file_exists(JPATH_ROOT . '/.env.local.php') || file_exists(JPATH_ROOT . '/.env')) {
+    (new Dotenv('JOOMLA_ENV', 'JOOMLA_DEBUG'))->bootEnv(JPATH_ROOT . '/.env', 'prod');
+}
+
+// Ensure sensible default for JDEBUG is set.
+\define('JDEBUG', (bool) ($_SERVER['JOOMLA_DEBUG'] ?? getenv('JOOMLA_DEBUG')));
+
 // If debug mode enabled, set new Exception handler with debug enabled.
 if (JDEBUG) {
     $errorHandler->setExceptionHandler(