Adds ConfigJson which handle the configuration in JSON format.

Also use the Updater to make the transition

5 files changed, 112 insertions, 7 deletions

diff --git a/application/PageBuilder.php b/application/PageBuilder.php
index cf13c714..1d3ba9e8 100644
--- a/application/PageBuilder.php
+++ b/application/PageBuilder.php
@@ -75,6 +75,7 @@ class PageBuilder
         $this->tpl->assign('shaarlititle', $conf->get('title', 'Shaarli'));
         $this->tpl->assign('openshaarli', $conf->get('config.OPEN_SHAARLI', false));
         $this->tpl->assign('showatom', $conf->get('config.SHOW_ATOM', false));
+        $this->tpl->assign('hide_timestamps', $conf->get('config.HIDE_TIMESTAMPS', false));
         // FIXME! Globals
         if (!empty($GLOBALS['plugin_errors'])) {
             $this->tpl->assign('plugin_errors', $GLOBALS['plugin_errors']);
diff --git a/application/Updater.php b/application/Updater.php
index 6b92af3d..8552850c 100644
--- a/application/Updater.php
+++ b/application/Updater.php
@@ -142,6 +142,48 @@ class Updater
         $this->linkDB->savedb($conf->get('config.PAGECACHE'));
         return true;
     }
+
+    /**
+     * Move old configuration in PHP to the new config system in JSON format.
+     *
+     * Will rename 'config.php' into 'config.save.php' and create 'config.json'.
+     */
+    public function updateMethodConfigToJson()
+    {
+        $conf = ConfigManager::getInstance();
+
+        // JSON config already exists, nothing to do.
+        if ($conf->getConfigIO() instanceof ConfigJson) {
+            return true;
+        }
+
+        $configPhp = new ConfigPhp();
+        $configJson = new ConfigJson();
+        $oldConfig = $configPhp->read($conf::$CONFIG_FILE . '.php');
+        rename($conf->getConfigFile(), $conf::$CONFIG_FILE . '.save.php');
+        $conf->setConfigIO($configJson);
+        $conf->reload();
+
+        foreach (ConfigPhp::$ROOT_KEYS as $key) {
+            $conf->set($key, $oldConfig[$key]);
+        }
+
+        // Set sub config keys (config and plugins)
+        $subConfig = array('config', 'plugins');
+        foreach ($subConfig as $sub) {
+            foreach ($oldConfig[$sub] as $key => $value) {
+                $conf->set($sub .'.'. $key, $value);
+            }
+        }
+
+        try{
+            $conf->write($this->isLoggedIn);
+            return true;
+        } catch (IOException $e) {
+            error_log($e->getMessage());
+            return false;
+        }
+    }
 }
 
 /**
@@ -199,7 +241,6 @@ class UpdaterException extends Exception
     }
 }
 
-
 /**
  * Read the updates file, and return already done updates.
  *
diff --git a/application/config/ConfigIO.php b/application/config/ConfigIO.php
index 4b1c9901..2b68fe6a 100644
--- a/application/config/ConfigIO.php
+++ b/application/config/ConfigIO.php
@@ -21,8 +21,6 @@ interface ConfigIO
      *
      * @param string $filepath Config file absolute path.
      * @param array  $conf   All configuration in an array.
-     *
-     * @return bool True if the configuration has been successfully written, false otherwise.
      */
     function write($filepath, $conf);
 
diff --git a/application/config/ConfigJson.php b/application/config/ConfigJson.php
new file mode 100644
index 00000000..cbafbf6d
--- /dev/null
+++ b/application/config/ConfigJson.php
@@ -0,0 +1,66 @@
+<?php
+
+/**
+ * Class ConfigJson (ConfigIO implementation)
+ *
+ * Handle Shaarli's JSON configuration file.
+ */
+class ConfigJson implements ConfigIO
+{
+    /**
+     * The JSON data is wrapped in a PHP file for security purpose.
+     * This way, even if the file is accessible, credentials and configuration won't be exposed.
+     *
+     * @var string PHP start tag and comment tag.
+     */
+    public static $PHP_HEADER;
+
+    public function __construct()
+    {
+        // The field can't be initialized directly with concatenation before PHP 5.6.
+        self::$PHP_HEADER = '<?php /*'. PHP_EOL;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function read($filepath)
+    {
+        if (! file_exists($filepath) || ! is_readable($filepath)) {
+            return array();
+        }
+        $data = file_get_contents($filepath);
+        $data = str_replace(self::$PHP_HEADER, '', $data);
+        $data = json_decode($data, true);
+        if ($data === null) {
+            $error = json_last_error();
+            throw new Exception('An error occured while parsing JSON file: error code #'. $error);
+        }
+        return $data;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function write($filepath, $conf)
+    {
+        // JSON_PRETTY_PRINT is available from PHP 5.4.
+        $print = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0;
+        $data = self::$PHP_HEADER . json_encode($conf, $print);
+        if (!file_put_contents($filepath, $data)) {
+            throw new IOException(
+                $filepath,
+                'Shaarli could not create the config file.
+                Please make sure Shaarli has the right to write in the folder is it installed in.'
+            );
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function getExtension()
+    {
+        return '.json.php';
+    }
+}
diff --git a/application/config/ConfigManager.php b/application/config/ConfigManager.php
index 212aac05..70456737 100644
--- a/application/config/ConfigManager.php
+++ b/application/config/ConfigManager.php
@@ -3,7 +3,7 @@
 // FIXME! Namespaces...
 require_once 'ConfigIO.php';
 require_once 'ConfigPhp.php';
-#require_once 'ConfigJson.php';
+require_once 'ConfigJson.php';
 
 /**
  * Class ConfigManager
@@ -84,12 +84,11 @@ class ConfigManager
      */
     protected function initialize()
     {
-        /*if (! file_exists(self::$CONFIG_FILE .'.php')) {
+        if (! file_exists(self::$CONFIG_FILE .'.php')) {
             $this->configIO = new ConfigJson();
         } else {
             $this->configIO = new ConfigPhp();
-        }*/
-        $this->configIO = new ConfigPhp();
+        }
         $this->load();
     }