123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990 |
- <?php
- namespace Shaarli\Config;
- /**
- * Class ConfigJson (ConfigIO implementation)
- *
- * Handle Shaarli's JSON configuration file.
- */
- class ConfigJson implements ConfigIO
- {
- /**
- * @inheritdoc
- */
- public function read($filepath)
- {
- if (! is_readable($filepath)) {
- return array();
- }
- $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) {
- $errorCode = json_last_error();
- $error = sprintf(
- 'An error occurred while parsing JSON configuration file (%s): error code #%d',
- $filepath,
- $errorCode
- );
- $error .= '<br>➜ <code>' . json_last_error_msg() .'</code>';
- if ($errorCode === JSON_ERROR_SYNTAX) {
- $error .= '<br>';
- $error .= 'Please check your JSON syntax (without PHP comment tags) using a JSON lint tool such as ';
- $error .= '<a href="http://jsonlint.com/">jsonlint.com</a>.';
- }
- throw new \Exception($error);
- }
- return $data;
- }
- /**
- * @inheritdoc
- */
- public function write($filepath, $conf)
- {
- // 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) . self::getPhpSuffix();
- if (!file_put_contents($filepath, $data)) {
- throw new \IOException(
- $filepath,
- t('Shaarli could not create the config file. '.
- 'Please make sure Shaarli has the right to write in the folder is it installed in.')
- );
- }
- }
- /**
- * @inheritdoc
- */
- public function getExtension()
- {
- 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;
- }
- /**
- * Get PHP comment closing tags.
- *
- * Static method for consistency with getPhpHeaders.
- *
- * @return string PHP comment closing.
- */
- public static function getPhpSuffix()
- {
- return PHP_EOL . '*/ ?>';
- }
- }
|