Allow to load config files for different environments (#1487311); keep (non-default) filename in URLs throughout the webmail app

2 files changed, 44 insertions, 14 deletions

diff --git a/program/lib/Roundcube/rcube.php b/program/lib/Roundcube/rcube.php
index 05a94f3be..ce97cd0a5 100644
--- a/program/lib/Roundcube/rcube.php
+++ b/program/lib/Roundcube/rcube.php
@@ -105,13 +105,14 @@ class rcube
      * This implements the 'singleton' design pattern
      *
      * @param integer Options to initialize with this instance. See rcube::INIT_WITH_* constants
+     * @param string Environment name to run (e.g. live, dev, test)
      *
      * @return rcube The one and only instance
      */
-    static function get_instance($mode = 0)
+    static function get_instance($mode = 0, $env = '')
     {
         if (!self::$instance) {
-            self::$instance = new rcube();
+            self::$instance = new rcube($env);
             self::$instance->init($mode);
         }
 
@@ -122,10 +123,10 @@ class rcube
     /**
      * Private constructor
      */
-    protected function __construct()
+    protected function __construct($env = '')
     {
         // load configuration
-        $this->config  = new rcube_config;
+        $this->config  = new rcube_config($env);
         $this->plugins = new rcube_dummy_plugin_api;
 
         register_shutdown_function(array($this, 'shutdown'));
diff --git a/program/lib/Roundcube/rcube_config.php b/program/lib/Roundcube/rcube_config.php
index 90bb85348..62567a0e0 100644
--- a/program/lib/Roundcube/rcube_config.php
+++ b/program/lib/Roundcube/rcube_config.php
@@ -26,6 +26,8 @@ class rcube_config
 {
     const DEFAULT_SKIN = 'larry';
 
+    private $env = '';
+    private $basedir = 'config/';
     private $prop = array();
     private $errors = array();
     private $userprefs = array();
@@ -50,9 +52,14 @@ class rcube_config
 
     /**
      * Object constructor
+     *
+     * @param string Environment suffix for config files to load
      */
-    public function __construct()
+    public function __construct($env = '')
     {
+        $this->env = $env;
+        $this->basedir = RCUBE_CONFIG_DIR;
+
         $this->load();
 
         // Defaults, that we do not require you to configure,
@@ -70,15 +77,15 @@ class rcube_config
     private function load()
     {
         // Load default settings
-        if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'defaults.inc.php')) {
+        if (!$this->load_from_file('defaults.inc.php')) {
             $this->errors[] = 'defaults.inc.php was not found.';
         }
 
         // load main config file
-        if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'config.inc.php')) {
+        if (!$this->load_from_file('config.inc.php')) {
             // Old configuration files
-            if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'main.inc.php') ||
-                !$this->load_from_file(RCUBE_CONFIG_DIR . 'db.inc.php')) {
+            if (!$this->load_from_file('main.inc.php') ||
+                !$this->load_from_file('db.inc.php')) {
                 $this->errors[] = 'config.inc.php was not found.';
             }
             else if (rand(1,100) == 10) {  // log warning on every 100th request (average)
@@ -87,7 +94,8 @@ class rcube_config
         }
 
         // load host-specific configuration
-        $this->load_host_config();
+        if (!empty($_SERVER['HTTP_HOST']))
+            $this->load_host_config();
 
         // set skin (with fallback to old 'skin_path' property)
         if (empty($this->prop['skin'])) {
@@ -164,7 +172,7 @@ class rcube_config
         }
 
         if ($fname) {
-            $this->load_from_file(RCUBE_CONFIG_DIR . $fname);
+            $this->load_from_file($fname);
         }
     }
 
@@ -173,12 +181,13 @@ class rcube_config
      * Read configuration from a file
      * and merge with the already stored config values
      *
-     * @param string $fpath Full path to the config file to be loaded
+     * @param string $file Name of the config file to be loaded
      * @return booelan True on success, false on failure
      */
-    public function load_from_file($fpath)
+    public function load_from_file($file)
     {
-        if (is_file($fpath) && is_readable($fpath)) {
+        $fpath = $this->resolve_path($file);
+        if ($fpath && is_file($fpath) && is_readable($fpath)) {
             // use output buffering, we don't need any output here 
             ob_start();
             include($fpath);
@@ -198,6 +207,26 @@ class rcube_config
         return false;
     }
 
+    /**
+     * Helper method to resolve the absolute path to the given config file.
+     * This also takes the 'env' property into account.
+     */
+    public function resolve_path($file, $use_env = true)
+    {
+        if (strpos($file, '/') === false) {
+            $file = realpath($this->basedir . '/' . $file);
+        }
+
+        // check if <file>-env.ini exists
+        if ($file && $use_env && !empty($this->env)) {
+            $envfile = preg_replace('/\.(inc.php)$/', '-' . $this->env . '.\\1', $file);
+            if (is_file($envfile))
+                return $envfile;
+        }
+
+        return $file;
+    }
+
 
     /**
      * Getter for a specific config parameter