Merge pull request #257 from ArthurHoaro/tag-http-referer

[github/shaarli/Shaarli.git] / application / Config.php

<?php\r
/**\r
 * Functions related to configuration management.\r
 */\r
\r
/**\r
 * Re-write configuration file according to given array.\r
 * Requires mandatory fields listed in $MANDATORY_FIELDS.\r
 *\r
 * @param array $config     contains all configuration fields.\r
 * @param bool  $isLoggedIn true if user is logged in.\r
 *\r
 * @return void\r
 *\r
 * @throws MissingFieldConfigException: a mandatory field has not been provided in $config.\r
 * @throws UnauthorizedConfigException: user is not authorize to change configuration.\r
 * @throws Exception: an error occured while writing the new config file.\r
 */\r
function writeConfig($config, $isLoggedIn)\r
{\r
    // These fields are required in configuration.\r
    $MANDATORY_FIELDS = [\r
        'login', 'hash', 'salt', 'timezone', 'title', 'titleLink',\r
        'redirector', 'disablesessionprotection', 'privateLinkByDefault'\r
    ];\r
\r
    if (!isset($config['config']['CONFIG_FILE'])) {\r
        throw new MissingFieldConfigException('CONFIG_FILE');\r
    }\r
\r
    // Only logged in user can alter config.\r
    if (is_file($config['config']['CONFIG_FILE']) && !$isLoggedIn) {\r
        throw new UnauthorizedConfigException();\r
    }\r
\r
    // Check that all mandatory fields are provided in $config.\r
    foreach ($MANDATORY_FIELDS as $field) {\r
        if (!isset($config[$field])) {\r
            throw new MissingFieldConfigException($field);\r
        }\r
    }\r
\r
    $configStr = '<?php '. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'login\'] = '.var_export($config['login'], true).';'. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'hash\'] = '.var_export($config['hash'], true).';'. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'salt\'] = '.var_export($config['salt'], true).'; '. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'timezone\'] = '.var_export($config['timezone'], true).';'. PHP_EOL;\r
    $configStr .= 'date_default_timezone_set('.var_export($config['timezone'], true).');'. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'title\'] = '.var_export($config['title'], true).';'. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'titleLink\'] = '.var_export($config['titleLink'], true).'; '. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'redirector\'] = '.var_export($config['redirector'], true).'; '. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'disablesessionprotection\'] = '.var_export($config['disablesessionprotection'], true).'; '. PHP_EOL;\r
    $configStr .= '$GLOBALS[\'privateLinkByDefault\'] = '.var_export($config['privateLinkByDefault'], true).'; '. PHP_EOL;\r
\r
    // Store all $config['config']\r
    foreach ($config['config'] as $key => $value) {\r
        $configStr .= '$GLOBALS[\'config\'][\''. $key .'\'] = '.var_export($config['config'][$key], true).';'. PHP_EOL;\r
    }\r
    $configStr .= '?>';\r
\r
    if (!file_put_contents($config['config']['CONFIG_FILE'], $configStr)\r
        || strcmp(file_get_contents($config['config']['CONFIG_FILE']), $configStr) != 0\r
    ) {\r
        throw new Exception(\r
            'Shaarli could not create the config file.\r
            Please make sure Shaarli has the right to write in the folder is it installed in.'\r
        );\r
    }\r
}\r
\r
/**\r
 * Milestone 0.9 - shaarli/Shaarli#41: options.php is not supported anymore.\r
 * ==> if user is loggedIn, merge its content with config.php, then delete options.php.\r
 *\r
 * @param array $config     contains all configuration fields.\r
 * @param bool  $isLoggedIn true if user is logged in.\r
 *\r
 * @return void\r
 */\r
function mergeDeprecatedConfig($config, $isLoggedIn)\r
{\r
    $config_file = $config['config']['CONFIG_FILE'];\r
\r
    if (is_file($config['config']['DATADIR'].'/options.php') && $isLoggedIn) {\r
        include $config['config']['DATADIR'].'/options.php';\r
\r
        // Load GLOBALS into config\r
        foreach ($GLOBALS as $key => $value) {\r
            $config[$key] = $value;\r
        }\r
        $config['config']['CONFIG_FILE'] = $config_file;\r
        writeConfig($config, $isLoggedIn);\r
\r
        unlink($config['config']['DATADIR'].'/options.php');\r
    }\r
}\r
\r
/**\r
 * Exception used if a mandatory field is missing in given configuration.\r
 */\r
class MissingFieldConfigException extends Exception\r
{\r
    public $field;\r
\r
    /**\r
     * Construct exception.\r
     *\r
     * @param string $field field name missing.\r
     */\r
    public function __construct($field)\r
    {\r
        $this->field = $field;\r
        $this->message = 'Configuration value is required for '. $this->field;\r
    }\r
}\r
\r
/**\r
 * Exception used if an unauthorized attempt to edit configuration has been made.\r
 */\r
class UnauthorizedConfigException extends Exception\r
{\r
    /**\r
     * Construct exception.\r
     */\r
    public function __construct()\r
    {\r
        $this->message = 'You are not authorized to alter config.';\r
    }\r
}