From b74b96bfbd0b778ac50fd17f5e107c51435b1678 Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Sun, 29 May 2016 12:32:14 +0200
Subject: Adds ConfigJson which handle the configuration in JSON format.

Also use the Updater to make the transition
---
 application/config/ConfigJson.php | 66 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 application/config/ConfigJson.php

(limited to 'application/config/ConfigJson.php')

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';
+    }
+}
-- 
cgit v1.2.3


From da10377b3c263d96a46cf9101c202554343d2cd0 Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Sun, 29 May 2016 16:10:32 +0200
Subject: Rename configuration keys and fix GLOBALS in templates

---
 application/config/ConfigJson.php | 33 ++++++++++++++++-----------------
 1 file changed, 16 insertions(+), 17 deletions(-)

(limited to 'application/config/ConfigJson.php')

diff --git a/application/config/ConfigJson.php b/application/config/ConfigJson.php
index cbafbf6d..94693c86 100644
--- a/application/config/ConfigJson.php
+++ b/application/config/ConfigJson.php
@@ -7,30 +7,16 @@
  */
 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)) {
+        if (! is_readable($filepath)) {
             return array();
         }
         $data = file_get_contents($filepath);
-        $data = str_replace(self::$PHP_HEADER, '', $data);
+        $data = str_replace(self::getPhpHeaders(), '', $data);
         $data = json_decode($data, true);
         if ($data === null) {
             $error = json_last_error();
@@ -46,7 +32,7 @@ class ConfigJson implements ConfigIO
     {
         // 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);
+        $data = self::getPhpHeaders() . json_encode($conf, $print);
         if (!file_put_contents($filepath, $data)) {
             throw new IOException(
                 $filepath,
@@ -63,4 +49,17 @@ class ConfigJson implements ConfigIO
     {
         return '.json.php';
     }
+
+    /**
+     * 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.
+     *
+     * Note: this isn't a static field because concatenation isn't supported in field declaration before PHP 5.6.
+     *
+     * @return string PHP start tag and comment tag.
+     */
+    public static function getPhpHeaders()
+    {
+        return '<?php /*'. PHP_EOL;
+    }
 }
-- 
cgit v1.2.3


From 5ff23f02b80ec6ddee28dee869171ee8e3656b7c Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Mon, 20 Jun 2016 18:30:37 +0200
Subject: Add closing PHP tags to JSON config files

---
 application/config/ConfigJson.php | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'application/config/ConfigJson.php')

diff --git a/application/config/ConfigJson.php b/application/config/ConfigJson.php
index 94693c86..d07fefee 100644
--- a/application/config/ConfigJson.php
+++ b/application/config/ConfigJson.php
@@ -17,6 +17,7 @@ class ConfigJson implements ConfigIO
         }
         $data = file_get_contents($filepath);
         $data = str_replace(self::getPhpHeaders(), '', $data);
+        $data = str_replace(self::getPhpSuffix(), '', $data);
         $data = json_decode($data, true);
         if ($data === null) {
             $error = json_last_error();
@@ -32,7 +33,7 @@ class ConfigJson implements ConfigIO
     {
         // JSON_PRETTY_PRINT is available from PHP 5.4.
         $print = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0;
-        $data = self::getPhpHeaders() . json_encode($conf, $print);
+        $data = self::getPhpHeaders() . json_encode($conf, $print) . self::getPhpSuffix();
         if (!file_put_contents($filepath, $data)) {
             throw new IOException(
                 $filepath,
@@ -62,4 +63,16 @@ class ConfigJson implements ConfigIO
     {
         return '<?php /*'. PHP_EOL;
     }
+
+    /**
+     * Get PHP comment closing tags.
+     *
+     * Static method for consistency with getPhpHeaders.
+     *
+     * @return string PHP comment closing.
+     */
+    public static function getPhpSuffix()
+    {
+        return PHP_EOL . '*/ ?>';
+    }
 }
-- 
cgit v1.2.3