ISSUE-345: add env

Author: tatevikg1

.env.example

@@ -0,0 +1,27 @@
+# This is an example .env file for phpList
+# Copy this file to .env and customize it for your environment
+
+# Application environment (dev, test, prod)
+APP_ENV=dev
+
+# Debug mode (1 for enabled, 0 for disabled)
+APP_DEBUG=1
+
+# Database configuration
+PHPLIST_DATABASE_DRIVER=pdo_mysql
+PHPLIST_DATABASE_PATH=
+PHPLIST_DATABASE_HOST='127.0.0.1'
+PHPLIST_DATABASE_PORT=3306
+PHPLIST_DATABASE_NAME='phplistdb'
+PHPLIST_DATABASE_USER='phplist'
+PHPLIST_DATABASE_PASSWORD='phplist'
+
+# Mailer configuration
+MAILER_DSN=smtp://user:[email protected]:25
+#MAILER_DSN=gmail://username:password@default
+#MAILER_DSN=ses://ACCESS_KEY:SECRET_KEY@default?region=eu-west-1
+#MAILER_DSN=sendgrid://KEY@default
+#MAILER_DSN=mandrill://KEY@default
+
+# Secret key for security
+PHPLIST_SECRET=bd21d72faef90cdb9c4e99e82f5edd089bfb0c5a

.gitignore

@@ -16,3 +16,5 @@
 .vagrant
 .phpdoc/
 .phpunit.result.cache
+/.env
+/.env.local

README.md

@@ -63,7 +63,40 @@ this code.
 The phpList application is configured so that the built-in PHP web server can
 run in development and testing mode, while Apache can run in production mode.
 
-Please first set the database credentials in `config/parameters.yml`.
+Please first set the database credentials in `config/parameters.yml` or in the `.env` file (see below).
+
+## Environment Variables
+
+phpList now supports loading environment variables from `.env` files. This allows you to configure your application without modifying any code or configuration files.
+
+### Usage
+
+1. Copy the `.env.example` file to `.env` in the project root:
+   ```bash
+   cp .env.example .env
+   ```
+
+2. Edit the `.env` file and customize the variables according to your environment:
+   ```
+   # Application environment (dev, test, prod)
+   APP_ENV=dev
+
+   # Debug mode (1 for enabled, 0 for disabled)
+   APP_DEBUG=1
+
+   # Database configuration
+   DATABASE_URL=mysql://db_user:db_password@localhost:3306/db_name
+
+   # Mailer configuration
+   MAILER_DSN=smtp://localhost:25
+
+   # Secret key for security
+   APP_SECRET=change_this_to_a_secret_value
+   ```
+
+3. For local overrides, you can create a `.env.local` file which will be loaded after `.env`.
+
+Note: The `.env` and `.env.local` files are excluded from version control to prevent sensitive information from being committed.
 
 ### Development
 

bin/console

@@ -7,15 +7,28 @@ use PhpList\Core\Core\Bootstrap;
 use PhpList\Core\Core\Environment;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\ErrorHandler\ErrorHandler;
 
 set_time_limit(0);
 
 require __DIR__ . '/../vendor/autoload.php';
 
+// Load environment variables from .env file
+$dotenv = new Dotenv();
+$rootDir = dirname(__DIR__);
+if (file_exists($rootDir . '/.env')) {
+    $dotenv->load($rootDir . '/.env');
+    // Load .env.local if it exists (for local overrides)
+    if (file_exists($rootDir . '/.env.local')) {
+        $dotenv->load($rootDir . '/.env.local');
+    }
+}
+
 $input = new ArgvInput();
-$environment = $input->getParameterOption(['--env', '-e'], getenv('SYMFONY_ENV') ?: Environment::DEVELOPMENT);
-$debug = getenv('SYMFONY_DEBUG') !== '0' && !$input->hasParameterOption(['--no-debug', ''])
+$environment = $input->getParameterOption(['--env', '-e'], $_ENV['APP_ENV'] ?? getenv('SYMFONY_ENV') ?: Environment::DEVELOPMENT);
+$debug = (isset($_ENV['APP_DEBUG']) ? $_ENV['APP_DEBUG'] !== '0' : getenv('SYMFONY_DEBUG') !== '0') 
+    && !$input->hasParameterOption(['--no-debug', ''])
     && $environment !== Environment::PRODUCTION;
 
 if ($debug) {

composer.json

@@ -63,7 +63,8 @@
         "symfony/google-mailer": "^6.4",
         "symfony/amazon-mailer": "^6.4",
         "symfony/mailchimp-mailer": "^6.4",
-        "symfony/sendgrid-mailer": "^6.4"
+        "symfony/sendgrid-mailer": "^6.4",
+        "symfony/dotenv": "^6.4"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

src/Core/Bootstrap.php

@@ -7,6 +7,7 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Exception;
 use RuntimeException;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\ErrorHandler\ErrorHandler;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -35,6 +36,7 @@ class Bootstrap
     private ?ApplicationKernel $applicationKernel = null;
     private ApplicationStructure $applicationStructure;
     private ErrorHandler $errorHandler;
+    private bool $envLoaded = false;
 
     /**
      * Protected constructor to avoid direct instantiation of this class.
@@ -45,6 +47,33 @@ protected function __construct()
     {
         $this->applicationStructure = new ApplicationStructure();
         $this->errorHandler = new ErrorHandler();
+        $this->loadEnvironmentVariables();
+    }
+
+    /**
+     * Loads environment variables from .env files.
+     *
+     * @return void fluent interface
+     */
+    private function loadEnvironmentVariables(): void
+    {
+        if ($this->envLoaded) {
+            return;
+        }
+
+        $dotenv = new Dotenv();
+        $rootDir = $this->getApplicationRoot();
+
+        if (file_exists($rootDir . '/.env')) {
+            $dotenv->load($rootDir . '/.env');
+
+            if (file_exists($rootDir . '/.env.local')) {
+                $dotenv->load($rootDir . '/.env.local');
+            }
+
+            $this->envLoaded = true;
+        }
+
     }
 
     /**
@@ -89,6 +118,10 @@ public static function purgeInstance(): void
      */
     public function setEnvironment(string $environment): Bootstrap
     {
+        if ($environment === Environment::DEFAULT_ENVIRONMENT && isset($_ENV['APP_ENV'])) {
+            $environment = $_ENV['APP_ENV'];
+        }
+
         Environment::validateEnvironment($environment);
         $this->environment = $environment;
 
@@ -102,11 +135,19 @@ public function getEnvironment(): string
 
     private function isSymfonyDebugModeEnabled(): bool
     {
+        if (isset($_ENV['APP_DEBUG'])) {
+            return $_ENV['APP_DEBUG'] === '1' || $_ENV['APP_DEBUG'] === 'true';
+        }
+
         return $this->environment !== Environment::PRODUCTION;
     }
 
     private function isDebugEnabled(): bool
     {
+        if (isset($_ENV['APP_DEBUG'])) {
+            return $_ENV['APP_DEBUG'] === '1' || $_ENV['APP_DEBUG'] === 'true';
+        }
+
         return $this->environment !== Environment::PRODUCTION;
     }
 
@@ -138,7 +179,7 @@ public function ensureDevelopmentOrTestingEnvironment(): self
     }
 
     /**
-     * Main entry point called at every request usually from global scope. Checks if everything is correct
+     * The main entry point called at every request usually from global scope. Checks if everything is correct
      * and loads the configuration.
      *
      * @return Bootstrap fluent interface