Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

ConfigManager no longer uses singleton pattern

Browse source
This commit is contained in:
ArthurHoaro 2016-06-09 20:04:02 +02:00
parent 7f179985b4
commit 278d9ee283
9 changed files with 342 additions and 275 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
application/ApplicationUtils.php
View file

@ -132,12 +132,13 @@ public static function checkPHPVersion($minVersion, $curVersion)
/**
* Checks Shaarli has the proper access permissions to its resources
*
* @param ConfigManager $conf Configuration Manager instance.
*
* @return array A list of the detected configuration issues
*/
public static function checkResourcePermissions()
public static function checkResourcePermissions($conf)
{
$errors = array();
$conf = ConfigManager::getInstance();
// Check script and template directories are readable
foreach (array(
@ -168,7 +169,7 @@ public static function checkResourcePermissions()
// Check configuration files are readable and writeable
foreach (array(
$conf->getConfigFile(),
$conf->getConfigFileExt(),
$conf->get('path.datastore'),
$conf->get('path.ban_file'),
$conf->get('path.log'),

48
application/PageBuilder.php
View file

@ -14,13 +14,21 @@ class PageBuilder
*/
private $tpl;
/**
* @var ConfigManager $conf Configuration Manager instance.
*/
protected $conf;
/**
* PageBuilder constructor.
* $tpl is initialized at false for lazy loading.
*
* @param ConfigManager $conf Configuration Manager instance (reference).
*/
function __construct()
function __construct(&$conf)
{
$this->tpl = false;
$this->conf = $conf;
}
/**
@ -29,22 +37,21 @@ function __construct()
private function initialize()
{
$this->tpl = new RainTPL();
$conf = ConfigManager::getInstance();
try {
$version = ApplicationUtils::checkUpdate(
shaarli_version,
$conf->get('path.update_check'),
$conf->get('general.check_updates_interval'),
$conf->get('general.check_updates'),
$this->conf->get('path.update_check'),
$this->conf->get('general.check_updates_interval'),
$this->conf->get('general.check_updates'),
isLoggedIn(),
$conf->get('general.check_updates_branch')
$this->conf->get('general.check_updates_branch')
);
$this->tpl->assign('newVersion', escape($version));
$this->tpl->assign('versionError', '');
} catch (Exception $exc) {
logm($conf->get('path.log'), $_SERVER['REMOTE_ADDR'], $exc->getMessage());
logm($this->conf->get('path.log'), $_SERVER['REMOTE_ADDR'], $exc->getMessage());
$this->tpl->assign('newVersion', '');
$this->tpl->assign('versionError', escape($exc->getMessage()));
}
@ -63,19 +70,19 @@ private function initialize()
$this->tpl->assign('scripturl', index_url($_SERVER));
$this->tpl->assign('pagetitle', 'Shaarli');
$this->tpl->assign('privateonly', !empty($_SESSION['privateonly'])); // Show only private links?
if ($conf->exists('general.title')) {
$this->tpl->assign('pagetitle', $conf->get('general.title'));
if ($this->conf->exists('general.title')) {
$this->tpl->assign('pagetitle', $this->conf->get('general.title'));
}
if ($conf->exists('general.header_link')) {
$this->tpl->assign('titleLink', $conf->get('general.header_link'));
if ($this->conf->exists('general.header_link')) {
$this->tpl->assign('titleLink', $this->conf->get('general.header_link'));
}
if ($conf->exists('pagetitle')) {
$this->tpl->assign('pagetitle', $conf->get('pagetitle'));
if ($this->conf->exists('pagetitle')) {
$this->tpl->assign('pagetitle', $this->conf->get('pagetitle'));
}
$this->tpl->assign('shaarlititle', $conf->get('title', 'Shaarli'));
$this->tpl->assign('openshaarli', $conf->get('extras.open_shaarli', false));
$this->tpl->assign('showatom', $conf->get('extras.show_atom', false));
$this->tpl->assign('hide_timestamps', $conf->get('extras.hide_timestamps', false));
$this->tpl->assign('shaarlititle', $this->conf->get('title', 'Shaarli'));
$this->tpl->assign('openshaarli', $this->conf->get('extras.open_shaarli', false));
$this->tpl->assign('showatom', $this->conf->get('extras.show_atom', false));
$this->tpl->assign('hide_timestamps', $this->conf->get('extras.hide_timestamps', false));
if (!empty($GLOBALS['plugin_errors'])) {
$this->tpl->assign('plugin_errors', $GLOBALS['plugin_errors']);
}
@ -89,7 +96,6 @@ private function initialize()
*/
public function assign($placeholder, $value)
{
// Lazy initialization
if ($this->tpl === false) {
$this->initialize();
}
@ -105,7 +111,6 @@ public function assign($placeholder, $value)
*/
public function assignAll($data)
{
// Lazy initialization
if ($this->tpl === false) {
$this->initialize();
}
@ -117,6 +122,7 @@ public function assignAll($data)
foreach ($data as $key => $value) {
$this->assign($key, $value);
}
return true;
}
/**
@ -127,10 +133,10 @@ public function assignAll($data)
*/
public function renderPage($page)
{
// Lazy initialization
if ($this->tpl===false) {
if ($this->tpl === false) {
$this->initialize();
}
$this->tpl->draw($page);
}

57
application/Updater.php
View file

@ -17,6 +17,11 @@ class Updater
*/
protected $linkDB;
/**
* @var ConfigManager $conf Configuration Manager instance.
*/
protected $conf;
/**
* @var bool True if the user is logged in, false otherwise.
*/
@ -30,14 +35,16 @@ class Updater
/**
* Object constructor.
*
* @param array $doneUpdates Updates which are already done.
* @param LinkDB $linkDB LinkDB instance.
* @param boolean $isLoggedIn True if the user is logged in.
* @param array $doneUpdates Updates which are already done.
* @param LinkDB $linkDB LinkDB instance.
* @oaram ConfigManager $conf Configuration Manager instance.
* @param boolean $isLoggedIn True if the user is logged in.
*/
public function __construct($doneUpdates, $linkDB, $isLoggedIn)
public function __construct($doneUpdates, $linkDB, $conf, $isLoggedIn)
{
$this->doneUpdates = $doneUpdates;
$this->linkDB = $linkDB;
$this->conf = $conf;
$this->isLoggedIn = $isLoggedIn;
// Retrieve all update methods.
@ -107,21 +114,19 @@ public function getDoneUpdates()
*/
public function updateMethodMergeDeprecatedConfigFile()
{
$conf = ConfigManager::getInstance();
if (is_file($conf->get('path.data_dir') . '/options.php')) {
include $conf->get('path.data_dir') . '/options.php';
if (is_file($this->conf->get('path.data_dir') . '/options.php')) {
include $this->conf->get('path.data_dir') . '/options.php';
// Load GLOBALS into config
$allowedKeys = array_merge(ConfigPhp::$ROOT_KEYS);
$allowedKeys[] = 'config';
foreach ($GLOBALS as $key => $value) {
if (in_array($key, $allowedKeys)) {
$conf->set($key, $value);
$this->conf->set($key, $value);
}
}
$conf->write($this->isLoggedIn);
unlink($conf->get('path.data_dir').'/options.php');
$this->conf->write($this->isLoggedIn);
unlink($this->conf->get('path.data_dir').'/options.php');
}
return true;
@ -132,14 +137,13 @@ public function updateMethodMergeDeprecatedConfigFile()
*/
public function updateMethodRenameDashTags()
{
$conf = ConfigManager::getInstance();
$linklist = $this->linkDB->filterSearch();
foreach ($linklist as $link) {
$link['tags'] = preg_replace('/(^| )\-/', '$1', $link['tags']);
$link['tags'] = implode(' ', array_unique(LinkFilter::tagsStrToArray($link['tags'], true)));
$this->linkDB[$link['linkdate']] = $link;
}
$this->linkDB->savedb($conf->get('path.page_cache'));
$this->linkDB->savedb($this->conf->get('path.page_cache'));
return true;
}
@ -151,23 +155,21 @@ public function updateMethodRenameDashTags()
*/
public function updateMethodConfigToJson()
{
$conf = ConfigManager::getInstance();
// JSON config already exists, nothing to do.
if ($conf->getConfigIO() instanceof ConfigJson) {
if ($this->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();
$oldConfig = $configPhp->read($this->conf->getConfigFile() . '.php');
rename($this->conf->getConfigFileExt(), $this->conf->getConfigFile() . '.save.php');
$this->conf->setConfigIO($configJson);
$this->conf->reload();
$legacyMap = array_flip(ConfigPhp::$LEGACY_KEYS_MAPPING);
foreach (ConfigPhp::$ROOT_KEYS as $key) {
$conf->set($legacyMap[$key], $oldConfig[$key]);
$this->conf->set($legacyMap[$key], $oldConfig[$key]);
}
// Set sub config keys (config and plugins)
@ -179,12 +181,12 @@ public function updateMethodConfigToJson()
} else {
$configKey = $sub .'.'. $key;
}
$conf->set($configKey, $value);
$this->conf->set($configKey, $value);
}
}
try{
$conf->write($this->isLoggedIn);
$this->conf->write($this->isLoggedIn);
return true;
} catch (IOException $e) {
error_log($e->getMessage());
@ -202,12 +204,11 @@ public function updateMethodConfigToJson()
*/
public function escapeUnescapedConfig()
{
$conf = ConfigManager::getInstance();
try {
$conf->set('general.title', escape($conf->get('general.title')));
$conf->set('general.header_link', escape($conf->get('general.header_link')));
$conf->set('extras.redirector', escape($conf->get('extras.redirector')));
$conf->write($this->isLoggedIn);
$this->conf->set('general.title', escape($this->conf->get('general.title')));
$this->conf->set('general.header_link', escape($this->conf->get('general.header_link')));
$this->conf->set('extras.redirector', escape($this->conf->get('extras.redirector')));
$this->conf->write($this->isLoggedIn);
} catch (Exception $e) {
error_log($e->getMessage());
return false;

84
application/config/ConfigManager.php
View file

@ -2,13 +2,13 @@
// FIXME! Namespaces...
require_once 'ConfigIO.php';
require_once 'ConfigPhp.php';
require_once 'ConfigJson.php';
require_once 'ConfigPhp.php';
/**
* Class ConfigManager
*
* Singleton, manages all Shaarli's settings.
* Manages all Shaarli's settings.
* See the documentation for more information on settings:
* - doc/Shaarli-configuration.html
* - https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration
@ -16,19 +16,14 @@
class ConfigManager
{
/**
* @var ConfigManager instance.
* @var string Flag telling a setting is not found.
*/
protected static $instance = null;
protected static $NOT_FOUND = 'NOT_FOUND';
/**
* @var string Config folder.
*/
public static $CONFIG_FILE = 'data/config';
/**
* @var string Flag telling a setting is not found.
*/
protected static $NOT_FOUND = 'NOT_FOUND';
protected $configFile;
/**
* @var array Loaded config array.
@ -41,37 +36,20 @@ class ConfigManager
protected $configIO;
/**
* Private constructor: new instances not allowed.
* Constructor.
*/
private function __construct() {}
/**
* Cloning isn't allowed either.
*/
private function __clone() {}
/**
* Return existing instance of PluginManager, or create it.
*
* @return ConfigManager instance.
*/
public static function getInstance()
public function __construct($configFile = 'data/config')
{
if (!(self::$instance instanceof self)) {
self::$instance = new self();
self::$instance->initialize();
}
return self::$instance;
$this->configFile = $configFile;
$this->initialize();
}
/**
* Reset the ConfigManager instance.
*/
public static function reset()
public function reset()
{
self::$instance = null;
return self::getInstance();
$this->initialize();
}
/**
@ -87,10 +65,10 @@ public function reload()
*/
protected function initialize()
{
if (! file_exists(self::$CONFIG_FILE .'.php')) {
$this->configIO = new ConfigJson();
} else {
if (file_exists($this->configFile . '.php')) {
$this->configIO = new ConfigPhp();
} else {
$this->configIO = new ConfigJson();
}
$this->load();
}
@ -100,7 +78,7 @@ protected function initialize()
*/
protected function load()
{
$this->loadedConfig = $this->configIO->read($this->getConfigFile());
$this->loadedConfig = $this->configIO->read($this->getConfigFileExt());
$this->setDefaultValues();
}
@ -213,7 +191,7 @@ public function write($isLoggedIn)
);
// Only logged in user can alter config.
if (is_file(self::$CONFIG_FILE) && !$isLoggedIn) {
if (is_file($this->getConfigFileExt()) && !$isLoggedIn) {
throw new UnauthorizedConfigException();
}
@ -224,17 +202,37 @@ public function write($isLoggedIn)
}
}
return $this->configIO->write($this->getConfigFile(), $this->loadedConfig);
return $this->configIO->write($this->getConfigFileExt(), $this->loadedConfig);
}
/**
* Get the configuration file path.
* Set the config file path (without extension).
*
* @return string Config file path.
* @param string $configFile File path.
*/
public function setConfigFile($configFile)
{
$this->configFile = $configFile;
}
/**
* Return the configuration file path (without extension).
*
* @return string Config path.
*/
public function getConfigFile()
{
return self::$CONFIG_FILE . $this->configIO->getExtension();
return $this->configFile;
}
/**
* Get the configuration file path with its extension.
*
* @return string Config file path.
*/
public function getConfigFileExt()
{
return $this->configFile . $this->configIO->getExtension();
}
/**
@ -302,7 +300,7 @@ protected function setDefaultValues()
$this->setEmpty('path.page_cache', 'pagecache');
$this->setEmpty('security.ban_after', 4);
$this->setEmpty('security.ban_after', 1800);
$this->setEmpty('security.ban_duration', 1800);
$this->setEmpty('security.session_protection_disabled', false);
$this->setEmpty('general.check_updates', false);

317
index.php
View file

@ -48,6 +48,8 @@
require_once 'application/ApplicationUtils.php';
require_once 'application/Cache.php';
require_once 'application/CachedPage.php';
require_once 'application/config/ConfigManager.php';
require_once 'application/config/ConfigPlugin.php';
require_once 'application/FeedBuilder.php';
require_once 'application/FileUtils.php';
require_once 'application/HttpUtils.php';
@ -59,8 +61,6 @@
require_once 'application/TimeZone.php';
require_once 'application/Url.php';
require_once 'application/Utils.php';
require_once 'application/config/ConfigManager.php';
require_once 'application/config/ConfigPlugin.php';
require_once 'application/PluginManager.php';
require_once 'application/Router.php';
require_once 'application/Updater.php';
@ -105,13 +105,13 @@
$_COOKIE['shaarli'] = session_id();
}
$conf = ConfigManager::getInstance();
$conf = new ConfigManager();
$conf->setEmpty('general.timezone', date_default_timezone_get());
$conf->setEmpty('general.title', 'Shared links on '. escape(index_url($_SERVER)));
RainTPL::$tpl_dir = $conf->get('path.raintpl_tpl'); // template directory
RainTPL::$cache_dir = $conf->get('path.raintpl_tmp'); // cache directory
$pluginManager = PluginManager::getInstance();
$pluginManager = new PluginManager($conf);
$pluginManager->load($conf->get('general.enabled_plugins'));
date_default_timezone_set($conf->get('general.timezone', 'UTC'));
@ -133,9 +133,9 @@ function stripslashes_deep($value) { $value = is_array($value) ? array_map('stri
header("Cache-Control: post-check=0, pre-check=0", false);
header("Pragma: no-cache");
if (! is_file($conf->getConfigFile())) {
if (! is_file($conf->getConfigFileExt())) {
// Ensure Shaarli has proper access to its resources
$errors = ApplicationUtils::checkResourcePermissions();
$errors = ApplicationUtils::checkResourcePermissions($conf);
if ($errors != array()) {
$message = '<p>Insufficient permissions:</p><ul>';
@ -151,7 +151,7 @@ function stripslashes_deep($value) { $value = is_array($value) ? array_map('stri
}
// Display the installation form if no existing config is found
install();
install($conf);
}
// a token depending of deployment salt, user password, and the current ip
@ -163,13 +163,15 @@ function stripslashes_deep($value) { $value = is_array($value) ? array_map('stri
}
header('Content-Type: text/html; charset=utf-8'); // We use UTF-8 for proper international characters handling.
//==================================================================================================
// Checking session state (i.e. is the user still logged in)
//==================================================================================================
function setup_login_state() {
$conf = ConfigManager::getInstance();
/**
* Checking session state (i.e. is the user still logged in)
*
* @param ConfigManager $conf The configuration manager.
*
* @return bool: true if the user is logged in, false otherwise.
*/
function setup_login_state($conf)
{
if ($conf->get('extras.open_shaarli')) {
return true;
}
@ -183,7 +185,7 @@ function setup_login_state() {
$_COOKIE['shaarli_staySignedIn']===STAY_SIGNED_IN_TOKEN &&
!$loginFailure)
{
fillSessionInfo();
fillSessionInfo($conf);
$userIsLoggedIn = true;
}
// If session does not exist on server side, or IP address has changed, or session has expired, logout.
@ -207,14 +209,16 @@ function setup_login_state() {
return $userIsLoggedIn;
}
$userIsLoggedIn = setup_login_state();
$userIsLoggedIn = setup_login_state($conf);
// ------------------------------------------------------------------------------------------
// PubSubHubbub protocol support (if enabled) [UNTESTED]
// (Source: http://aldarone.fr/les-flux-rss-shaarli-et-pubsubhubbub/ )
function pubsubhub()
/**
* PubSubHubbub protocol support (if enabled) [UNTESTED]
* (Source: http://aldarone.fr/les-flux-rss-shaarli-et-pubsubhubbub/ )
*
* @param ConfigManager $conf Configuration Manager instance.
*/
function pubsubhub($conf)
{
$conf = ConfigManager::getInstance();
$pshUrl = $conf->get('config.PUBSUBHUB_URL');
if (!empty($pshUrl))
{
@ -241,27 +245,39 @@ function allIPs()
return $ip;
}
function fillSessionInfo() {
$conf = ConfigManager::getInstance();
/**
* Load user session.
*
* @param ConfigManager $conf Configuration Manager instance.
*/
function fillSessionInfo($conf)
{
$_SESSION['uid'] = sha1(uniqid('',true).'_'.mt_rand()); // Generate unique random number (different than phpsessionid)
$_SESSION['ip']=allIPs(); // We store IP address(es) of the client to make sure session is not hijacked.
$_SESSION['username']= $conf->get('credentials.login');
$_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT; // Set session expiration.
}
// Check that user/password is correct.
function check_auth($login,$password)
/**
* Check that user/password is correct.
*
* @param string $login Username
* @param string $password User password
* @param ConfigManager $conf Configuration Manager instance.
*
* @return bool: authentication successful or not.
*/
function check_auth($login, $password, $conf)
{
$conf = ConfigManager::getInstance();
$hash = sha1($password . $login . $conf->get('credentials.salt'));
if ($login == $conf->get('credentials.login') && $hash == $conf->get('credentials.hash'))
{ // Login/password is correct.
fillSessionInfo();
fillSessionInfo($conf);
logm($conf->get('path.log'), $_SERVER['REMOTE_ADDR'], 'Login successful');
return True;
return true;
}
logm($conf->get('path.log'), $_SERVER['REMOTE_ADDR'], 'Login failed for user '.$login);
return False;
return false;
}
// Returns true if the user is logged in.
@ -294,10 +310,13 @@ function logout() {
);
}
include $conf->get('path.ban_file', 'data/ipbans.php');
// Signal a failed login. Will ban the IP if too many failures:
function ban_loginFailed()
/**
* Signal a failed login. Will ban the IP if too many failures:
*
* @param ConfigManager $conf Configuration Manager instance.
*/
function ban_loginFailed($conf)
{
$conf = ConfigManager::getInstance();
$ip = $_SERVER['REMOTE_ADDR'];
$gb = $GLOBALS['IPBANS'];
if (!isset($gb['FAILURES'][$ip])) $gb['FAILURES'][$ip]=0;
@ -314,10 +333,13 @@ function ban_loginFailed()
);
}
// Signals a successful login. Resets failed login counter.
function ban_loginOk()
/**
* Signals a successful login. Resets failed login counter.
*
* @param ConfigManager $conf Configuration Manager instance.
*/
function ban_loginOk($conf)
{
$conf = ConfigManager::getInstance();
$ip = $_SERVER['REMOTE_ADDR'];
$gb = $GLOBALS['IPBANS'];
unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]);
@ -328,10 +350,15 @@ function ban_loginOk()
);
}
// Checks if the user CAN login. If 'true', the user can try to login.
function ban_canLogin()
/**
* Checks if the user CAN login. If 'true', the user can try to login.
*
* @param ConfigManager $conf Configuration Manager instance.
*
* @return bool: true if the user is allowed to login.
*/
function ban_canLogin($conf)
{
$conf = ConfigManager::getInstance();
$ip=$_SERVER["REMOTE_ADDR"]; $gb=$GLOBALS['IPBANS'];
if (isset($gb['BANS'][$ip]))
{
@ -355,10 +382,12 @@ function ban_canLogin()
// Process login form: Check if login/password is correct.
if (isset($_POST['login']))
{
if (!ban_canLogin()) die('I said: NO. You are banned for the moment. Go away.');
if (isset($_POST['password']) && tokenOk($_POST['token']) && (check_auth($_POST['login'], $_POST['password'])))
{ // Login/password is OK.
ban_loginOk();
if (!ban_canLogin($conf)) die('I said: NO. You are banned for the moment. Go away.');
if (isset($_POST['password'])
&& tokenOk($_POST['token'])
&& (check_auth($_POST['login'], $_POST['password'], $conf))
) { // Login/password is OK.
ban_loginOk($conf);
// If user wants to keep the session cookie even after the browser closes:
if (!empty($_POST['longlastingsession']))
{
@ -406,7 +435,7 @@ function ban_canLogin()
}
else
{
ban_loginFailed();
ban_loginFailed($conf);
$redir = '&username='. $_POST['login'];
if (isset($_GET['post'])) {
$redir .= '&post=' . urlencode($_GET['post']);
@ -454,10 +483,15 @@ function getMaxFileSize()
// Token should be used in any form which acts on data (create,update,delete,import...).
if (!isset($_SESSION['tokens'])) $_SESSION['tokens']=array(); // Token are attached to the session.
// Returns a token.
function getToken()
/**
* Returns a token.
*
* @param ConfigManager $conf Configuration Manager instance.
*
* @return string token.
*/
function getToken($conf)
{
$conf = ConfigManager::getInstance();
$rnd = sha1(uniqid('', true) .'_'. mt_rand() . $conf->get('credentials.salt')); // We generate a random string.
$_SESSION['tokens'][$rnd]=1; // Store it on the server side.
return $rnd;
@ -475,12 +509,14 @@ function tokenOk($token)
return false; // Wrong token, or already used.
}
// ------------------------------------------------------------------------------------------
// Daily RSS feed: 1 RSS entry per day giving all the links on that day.
// Gives the last 7 days (which have links).
// This RSS feed cannot be filtered.
function showDailyRSS() {
$conf = ConfigManager::getInstance();
/**
* Daily RSS feed: 1 RSS entry per day giving all the links on that day.
* Gives the last 7 days (which have links).
* This RSS feed cannot be filtered.
*
* @param ConfigManager $conf Configuration Manager instance.
*/
function showDailyRSS($conf) {
// Cache system
$query = $_SERVER['QUERY_STRING'];
$cache = new CachedPage(
@ -555,7 +591,7 @@ function showDailyRSS() {
foreach ($linkdates as $linkdate) {
$l = $LINKSDB[$linkdate];
$l['formatedDescription'] = format_description($l['description'], $conf->get('extras.redirector'));
$l['thumbnail'] = thumbnail($l['url']);
$l['thumbnail'] = thumbnail($conf, $l['url']);
$l_date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $l['linkdate']);
$l['timestamp'] = $l_date->getTimestamp();
if (startsWith($l['url'], '?')) {
@ -586,12 +622,13 @@ function showDailyRSS() {
/**
* Show the 'Daily' page.
*
* @param PageBuilder $pageBuilder Template engine wrapper.
* @param LinkDB $LINKSDB LinkDB instance.
* @param PageBuilder $pageBuilder Template engine wrapper.
* @param LinkDB $LINKSDB LinkDB instance.
* @param ConfigManager $conf Configuration Manager instance.
* @param PluginManager $pluginManager Plugin Manager instane.
*/
function showDaily($pageBuilder, $LINKSDB)
function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager)
{
$conf = ConfigManager::getInstance();
$day=date('Ymd',strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
if (isset($_GET['day'])) $day=$_GET['day'];
@ -621,7 +658,7 @@ function showDaily($pageBuilder, $LINKSDB)
uasort($taglist, 'strcasecmp');
$linksToDisplay[$key]['taglist']=$taglist;
$linksToDisplay[$key]['formatedDescription'] = format_description($link['description'], $conf->get('extras.redirector'));
$linksToDisplay[$key]['thumbnail'] = thumbnail($link['url']);
$linksToDisplay[$key]['thumbnail'] = thumbnail($conf, $link['url']);
$date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
$linksToDisplay[$key]['timestamp'] = $date->getTimestamp();
}
@ -656,7 +693,7 @@ function showDaily($pageBuilder, $LINKSDB)
'previousday' => $previousday,
'nextday' => $nextday,
);
$pluginManager = PluginManager::getInstance();
$pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
foreach ($data as $key => $value) {
@ -667,18 +704,27 @@ function showDaily($pageBuilder, $LINKSDB)
exit;
}
// Renders the linklist
function showLinkList($PAGE, $LINKSDB) {
buildLinkList($PAGE,$LINKSDB); // Compute list of links to display
/**
* Renders the linklist
*
* @param pageBuilder $PAGE pageBuilder instance.
* @param LinkDB $LINKSDB LinkDB instance.
* @param ConfigManager $conf Configuration Manager instance.
* @param PluginManager $pluginManager Plugin Manager instance.
*/
function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) {
buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager); // Compute list of links to display
$PAGE->renderPage('linklist');
}
// ------------------------------------------------------------------------------------------
// Render HTML page (according to URL parameters and user rights)
function renderPage()
/**
* Render HTML page (according to URL parameters and user rights)
*
* @param ConfigManager $conf Configuration Manager instance.
* @param PluginManager $pluginManager Plugin Manager instance,
*/
function renderPage($conf, $pluginManager)
{
$conf = ConfigManager::getInstance();
$LINKSDB = new LinkDB(
$conf->get('path.datastore'),
isLoggedIn(),
@ -690,6 +736,7 @@ function renderPage()
$updater = new Updater(
read_updates_file($conf->get('path.updates')),
$LINKSDB,
$conf,
isLoggedIn()
);
try {
@ -705,7 +752,7 @@ function renderPage()
die($e->getMessage());
}
$PAGE = new PageBuilder();
$PAGE = new PageBuilder($conf);
$PAGE->assign('linkcount', count($LINKSDB));
$PAGE->assign('privateLinkcount', count_private($LINKSDB));
@ -720,7 +767,7 @@ function renderPage()
'header',
'footer',
);
$pluginManager = PluginManager::getInstance();
foreach($common_hooks as $name) {
$plugin_data = array();
$pluginManager->executeHooks('render_' . $name, $plugin_data,
@ -736,7 +783,7 @@ function renderPage()
if ($targetPage == Router::$PAGE_LOGIN)
{
if ($conf->get('extras.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli
$token=''; if (ban_canLogin()) $token=getToken(); // Do not waste token generation if not useful.
$token=''; if (ban_canLogin($conf)) $token=getToken($conf); // Do not waste token generation if not useful.
$PAGE->assign('token',$token);
if (isset($_GET['username'])) {
$PAGE->assign('username', escape($_GET['username']));
@ -765,7 +812,7 @@ function renderPage()
foreach($links as $link)
{
$permalink='?'.escape(smallhash($link['linkdate']));
$thumb=lazyThumbnail($link['url'],$permalink);
$thumb=lazyThumbnail($conf, $link['url'],$permalink);
if ($thumb!='') // Only output links which have a thumbnail.
{
$link['thumbnail']=$thumb; // Thumbnail HTML code.
@ -837,7 +884,7 @@ function renderPage()
// Daily page.
if ($targetPage == Router::$PAGE_DAILY) {
showDaily($PAGE, $LINKSDB);
showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
}
// ATOM and RSS feed.
@ -870,7 +917,6 @@ function renderPage()
$data = $feedGenerator->buildData();
// Process plugin hook.
$pluginManager = PluginManager::getInstance();
$pluginManager->executeHooks('render_feed', $data, array(
'loggedin' => isLoggedIn(),
'target' => $targetPage,
@ -996,7 +1042,7 @@ function renderPage()
exit;
}
showLinkList($PAGE, $LINKSDB);
showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
if (isset($_GET['edit_link'])) {
header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
exit;
@ -1059,7 +1105,7 @@ function renderPage()
}
else // show the change password form.
{
$PAGE->assign('token',getToken());
$PAGE->assign('token',getToken($conf));
$PAGE->renderPage('changepassword');
exit;
}
@ -1106,7 +1152,7 @@ function renderPage()
}
else // Show the configuration form.
{
$PAGE->assign('token',getToken());
$PAGE->assign('token',getToken($conf));
$PAGE->assign('title', $conf->get('general.title'));
$PAGE->assign('redirector', $conf->get('extras.redirector'));
list($timezone_form, $timezone_js) = generateTimeZoneForm($conf->get('general.timezone'));
@ -1125,7 +1171,7 @@ function renderPage()
if ($targetPage == Router::$PAGE_CHANGETAG)
{
if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
$PAGE->assign('token', getToken());
$PAGE->assign('token', getToken($conf));
$PAGE->assign('tags', $LINKSDB->allTags());
$PAGE->renderPage('changetag');
exit;
@ -1216,7 +1262,7 @@ function renderPage()
$LINKSDB[$linkdate] = $link;
$LINKSDB->savedb($conf->get('path.page_cache'));
pubsubhub();
pubsubhub($conf);
// If we are called from the bookmarklet, we must close the popup:
if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
@ -1300,7 +1346,7 @@ function renderPage()
$data = array(
'link' => $link,
'link_is_new' => false,
'token' => getToken(),
'token' => getToken($conf),
'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
'tags' => $LINKSDB->allTags(),
);
@ -1367,7 +1413,7 @@ function renderPage()
$data = array(
'link' => $link,
'link_is_new' => $link_is_new,
'token' => getToken(), // XSRF protection.
'token' => getToken($conf), // XSRF protection.
'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
'tags' => $LINKSDB->allTags(),
@ -1445,7 +1491,7 @@ function renderPage()
// -------- Show upload/import dialog:
if ($targetPage == Router::$PAGE_IMPORT)
{
$PAGE->assign('token',getToken());
$PAGE->assign('token',getToken($conf));
$PAGE->assign('maxfilesize',getMaxFileSize());
$PAGE->renderPage('import');
exit;
@ -1500,16 +1546,19 @@ function($a, $b) { return $a['order'] - $b['order']; }
}
// -------- Otherwise, simply display search form and links:
showLinkList($PAGE, $LINKSDB);
showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
exit;
}
// -----------------------------------------------------------------------------------------------
// Process the import file form.
function importFile($LINKSDB)
/**
* Process the import file form.
*
* @param LinkDB $LINKSDB Loaded LinkDB instance.
* @param ConfigManager $conf Configuration Manager instance.
*/
function importFile($LINKSDB, $conf)
{
if (!isLoggedIn()) { die('Not allowed.'); }
$conf = ConfigManager::getInstance();
$filename=$_FILES['filetoupload']['name'];
$filesize=$_FILES['filetoupload']['size'];
@ -1594,12 +1643,13 @@ function importFile($LINKSDB)
* Template for the list of links (<div id="linklist">)
* This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
*
* @param pageBuilder $PAGE pageBuilder instance.
* @param LinkDB $LINKSDB LinkDB instance.
* @param pageBuilder $PAGE pageBuilder instance.
* @param LinkDB $LINKSDB LinkDB instance.
* @param ConfigManager $conf Configuration Manager instance.
* @param PluginManager $pluginManager Plugin Manager instance.
*/
function buildLinkList($PAGE,$LINKSDB)
function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager)
{
$conf = ConfigManager::getInstance();
// Used in templates
$searchtags = !empty($_GET['searchtags']) ? escape($_GET['searchtags']) : '';
$searchterm = !empty($_GET['searchterm']) ? escape($_GET['searchterm']) : '';
@ -1674,7 +1724,7 @@ function buildLinkList($PAGE,$LINKSDB)
$next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
}
$token = isLoggedIn() ? getToken() : '';
$token = isLoggedIn() ? getToken($conf) : '';
// Fill all template fields.
$data = array(
@ -1695,7 +1745,6 @@ function buildLinkList($PAGE,$LINKSDB)
$data['pagetitle'] = $conf->get('pagetitle');
}
$pluginManager = PluginManager::getInstance();
$pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
foreach ($data as $key => $value) {
@ -1705,18 +1754,25 @@ function buildLinkList($PAGE,$LINKSDB)
return;
}
// Compute the thumbnail for a link.
//
// With a link to the original URL.
// Understands various services (youtube.com...)
// Input: $url = URL for which the thumbnail must be found.
// $href = if provided, this URL will be followed instead of $url
// Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
// Some of them may be missing.
// Return an empty array if no thumbnail available.
function computeThumbnail($url,$href=false)
/**
* Compute the thumbnail for a link.
*
* With a link to the original URL.
* Understands various services (youtube.com...)
* Input: $url = URL for which the thumbnail must be found.
* $href = if provided, this URL will be followed instead of $url
* Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
* Some of them may be missing.
* Return an empty array if no thumbnail available.
*
* @param ConfigManager $conf Configuration Manager instance.
* @param string $url
* @param string|bool $href
*
* @return array
*/
function computeThumbnail($conf, $url, $href = false)
{
$conf = ConfigManager::getInstance();
if (!$conf->get('general.enable_thumbnails')) return array();
if ($href==false) $href=$url;
@ -1836,7 +1892,9 @@ function computeThumbnail($url,$href=false)
// Returns '' if no thumbnail available.
function thumbnail($url,$href=false)
{
$t = computeThumbnail($url,$href);
// FIXME!
global $conf;
$t = computeThumbnail($conf, $url,$href);
if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
$html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"';
@ -1854,9 +1912,11 @@ function thumbnail($url,$href=false)
// Input: $url = URL for which the thumbnail must be found.
// $href = if provided, this URL will be followed instead of $url
// Returns '' if no thumbnail available.
function lazyThumbnail($url,$href=false)
function lazyThumbnail($conf, $url,$href=false)
{
$t = computeThumbnail($url,$href);
// FIXME!
global $conf;
$t = computeThumbnail($conf, $url,$href);
if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
$html='<a href="'.escape($t['href']).'">';
@ -1882,10 +1942,13 @@ function lazyThumbnail($url,$href=false)
}
// -----------------------------------------------------------------------------------------------
// Installation
// This function should NEVER be called if the file data/config.php exists.
function install()
/**
* Installation
* This function should NEVER be called if the file data/config.php exists.
*
* @param ConfigManager $conf Configuration Manager instance.
*/
function install($conf)
{
// On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
if (endsWith($_SERVER['HTTP_HOST'],'.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions',0705);
@ -1916,7 +1979,6 @@ function install()
if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
{
$conf = ConfigManager::getInstance();
$tz = 'UTC';
if (!empty($_POST['continent']) && !empty($_POST['city'])
&& isTimeZoneValid($_POST['continent'], $_POST['city'])
@ -1960,25 +2022,27 @@ function install()
$timezone_html = '<tr><td><b>Timezone:</b></td><td>'.$timezone_form.'</td></tr>';
}
$PAGE = new PageBuilder();
$PAGE = new PageBuilder($conf);
$PAGE->assign('timezone_html',$timezone_html);
$PAGE->assign('timezone_js',$timezone_js);
$PAGE->renderPage('install');
exit;
}
/* Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
This function is called by passing the URL:
http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
[URL] is the URL of the link (e.g. a flickr page)
[HMAC] is the signature for the [URL] (so that these URL cannot be forged).
The function below will fetch the image from the webservice and store it in the cache.
*/
function genThumbnail()
/**
* Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
* I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
* The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
* This function is called by passing the URL:
* http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
* [URL] is the URL of the link (e.g. a flickr page)
* [HMAC] is the signature for the [URL] (so that these URL cannot be forged).
* The function below will fetch the image from the webservice and store it in the cache.
*
* @param ConfigManager $conf Configuration Manager instance,
*/
function genThumbnail($conf)
{
$conf = ConfigManager::getInstance();
// Make sure the parameters in the URL were generated by us.
$sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
if ($sign!=$_GET['hmac']) die('Naughty boy!');
@ -2190,10 +2254,9 @@ function resizeImage($filepath)
return true;
}
if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail(); exit; } // Thumbnail generation/cache does not need the link database.
if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS(); exit; }
if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=genthumbnail')) { genThumbnail($conf); exit; } // Thumbnail generation/cache does not need the link database.
if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf); exit; }
if (!isset($_SESSION['LINKS_PER_PAGE'])) {
$_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
}
renderPage();
?>
renderPage($conf, $pluginManager);

8
tests/ApplicationUtilsTest.php
View file

@ -276,7 +276,7 @@ public function testCheckSupportedPHPVersion52()
*/
public function testCheckCurrentResourcePermissions()
{
$conf = ConfigManager::getInstance();
$conf = new ConfigManager('');
$conf->set('path.thumbnails_cache', 'cache');
$conf->set('path.config', 'data/config.php');
$conf->set('path.data_dir', 'data');
@ -290,7 +290,7 @@ public function testCheckCurrentResourcePermissions()
$this->assertEquals(
array(),
ApplicationUtils::checkResourcePermissions()
ApplicationUtils::checkResourcePermissions($conf)
);
}
@ -299,7 +299,7 @@ public function testCheckCurrentResourcePermissions()
*/
public function testCheckCurrentResourcePermissionsErrors()
{
$conf = ConfigManager::getInstance();
$conf = new ConfigManager('');
$conf->set('path.thumbnails_cache', 'null/cache');
$conf->set('path.config', 'null/data/config.php');
$conf->set('path.data_dir', 'null/data');
@ -322,7 +322,7 @@ public function testCheckCurrentResourcePermissionsErrors()
'"null/tmp" directory is not readable',
'"null/tmp" directory is not writable'
),
ApplicationUtils::checkResourcePermissions()
ApplicationUtils::checkResourcePermissions($conf)
);
}
}

11
tests/Updater/DummyUpdater.php
View file

@ -11,13 +11,14 @@ class DummyUpdater extends Updater
/**
* Object constructor.
*
* @param array $doneUpdates Updates which are already done.
* @param LinkDB $linkDB LinkDB instance.
* @param boolean $isLoggedIn True if the user is logged in.
* @param array $doneUpdates Updates which are already done.
* @param LinkDB $linkDB LinkDB instance.
* @param ConfigManager $conf Configuration Manager instance.
* @param boolean $isLoggedIn True if the user is logged in.
*/
public function __construct($doneUpdates, $linkDB, $isLoggedIn)
public function __construct($doneUpdates, $linkDB, $conf, $isLoggedIn)
{
parent::__construct($doneUpdates, $linkDB, $isLoggedIn);
parent::__construct($doneUpdates, $linkDB, $conf, $isLoggedIn);
// Retrieve all update methods.
// For unit test, only retrieve final methods,

57
tests/Updater/UpdaterTest.php
View file

@ -29,8 +29,7 @@ class UpdaterTest extends PHPUnit_Framework_TestCase
*/
public function setUp()
{
ConfigManager::$CONFIG_FILE = self::$configFile;
$this->conf = ConfigManager::reset();
$this->conf = new ConfigManager(self::$configFile);
}
/**
@ -108,10 +107,10 @@ public function testNoUpdates()
'updateMethodDummy3',
'updateMethodException',
);
$updater = new DummyUpdater($updates, array(), true);
$updater = new DummyUpdater($updates, array(), $this->conf, true);
$this->assertEquals(array(), $updater->update());
$updater = new DummyUpdater(array(), array(), false);
$updater = new DummyUpdater(array(), array(), $this->conf, false);
$this->assertEquals(array(), $updater->update());
}
@ -126,7 +125,7 @@ public function testUpdatesFirstTime()
'updateMethodDummy2',
'updateMethodDummy3',
);
$updater = new DummyUpdater($updates, array(), true);
$updater = new DummyUpdater($updates, array(), $this->conf, true);
$this->assertEquals($expectedUpdates, $updater->update());
}
@ -142,7 +141,7 @@ public function testOneUpdate()
);
$expectedUpdate = array('updateMethodDummy2');
$updater = new DummyUpdater($updates, array(), true);
$updater = new DummyUpdater($updates, array(), $this->conf, true);
$this->assertEquals($expectedUpdate, $updater->update());
}
@ -159,7 +158,7 @@ public function testUpdateFailed()
'updateMethodDummy3',
);
$updater = new DummyUpdater($updates, array(), true);
$updater = new DummyUpdater($updates, array(), $this->conf, true);
$updater->update();
}
@ -172,8 +171,8 @@ public function testUpdateFailed()
*/
public function testUpdateMergeDeprecatedConfig()
{
ConfigManager::$CONFIG_FILE = 'tests/utils/config/configPhp';
$this->conf = $this->conf->reset();
$this->conf->setConfigFile('tests/utils/config/configPhp');
$this->conf->reset();
$optionsFile = 'tests/Updater/options.php';
$options = '<?php
@ -181,10 +180,10 @@ public function testUpdateMergeDeprecatedConfig()
file_put_contents($optionsFile, $options);
// tmp config file.
ConfigManager::$CONFIG_FILE = 'tests/Updater/config';
$this->conf->setConfigFile('tests/Updater/config');
// merge configs
$updater = new Updater(array(), array(), true);
$updater = new Updater(array(), array(), $this->conf, true);
// This writes a new config file in tests/Updater/config.php
$updater->updateMethodMergeDeprecatedConfigFile();
@ -193,7 +192,7 @@ public function testUpdateMergeDeprecatedConfig()
$this->assertTrue($this->conf->get('general.default_private_links'));
$this->assertFalse(is_file($optionsFile));
// Delete the generated file.
unlink($this->conf->getConfigFile());
unlink($this->conf->getConfigFileExt());
}
/**
@ -201,7 +200,7 @@ public function testUpdateMergeDeprecatedConfig()
*/
public function testMergeDeprecatedConfigNoFile()
{
$updater = new Updater(array(), array(), true);
$updater = new Updater(array(), array(), $this->conf, true);
$updater->updateMethodMergeDeprecatedConfigFile();
$this->assertEquals('root', $this->conf->get('credentials.login'));
@ -216,7 +215,7 @@ public function testRenameDashTags()
$refDB->write(self::$testDatastore);
$linkDB = new LinkDB(self::$testDatastore, true, false);
$this->assertEmpty($linkDB->filterSearch(array('searchtags' => 'exclude')));
$updater = new Updater(array(), $linkDB, true);
$updater = new Updater(array(), $linkDB, $this->conf, true);
$updater->updateMethodRenameDashTags();
$this->assertNotEmpty($linkDB->filterSearch(array('searchtags' => 'exclude')));
}
@ -227,29 +226,29 @@ public function testRenameDashTags()
public function testConfigToJson()
{
$configFile = 'tests/utils/config/configPhp';
ConfigManager::$CONFIG_FILE = $configFile;
$conf = ConfigManager::reset();
$this->conf->setConfigFile($configFile);
$this->conf->reset();
// The ConfigIO is initialized with ConfigPhp.
$this->assertTrue($conf->getConfigIO() instanceof ConfigPhp);
$this->assertTrue($this->conf->getConfigIO() instanceof ConfigPhp);
$updater = new Updater(array(), array(), false);
$updater = new Updater(array(), array(), $this->conf, false);
$done = $updater->updateMethodConfigToJson();
$this->assertTrue($done);
// The ConfigIO has been updated to ConfigJson.
$this->assertTrue($conf->getConfigIO() instanceof ConfigJson);
$this->assertTrue(file_exists($conf->getConfigFile()));
$this->assertTrue($this->conf->getConfigIO() instanceof ConfigJson);
$this->assertTrue(file_exists($this->conf->getConfigFileExt()));
// Check JSON config data.
$conf->reload();
$this->assertEquals('root', $conf->get('credentials.login'));
$this->assertEquals('lala', $conf->get('extras.redirector'));
$this->assertEquals('data/datastore.php', $conf->get('path.datastore'));
$this->assertEquals('1', $conf->get('plugins.WALLABAG_VERSION'));
$this->conf->reload();
$this->assertEquals('root', $this->conf->get('credentials.login'));
$this->assertEquals('lala', $this->conf->get('extras.redirector'));
$this->assertEquals('data/datastore.php', $this->conf->get('path.datastore'));
$this->assertEquals('1', $this->conf->get('plugins.WALLABAG_VERSION'));
rename($configFile . '.save.php', $configFile . '.php');
unlink($conf->getConfigFile());
unlink($this->conf->getConfigFileExt());
}
/**
@ -257,11 +256,11 @@ public function testConfigToJson()
*/
public function testConfigToJsonNothingToDo()
{
$filetime = filemtime($this->conf->getConfigFile());
$updater = new Updater(array(), array(), false);
$filetime = filemtime($this->conf->getConfigFileExt());
$updater = new Updater(array(), array(), $this->conf, false);
$done = $updater->updateMethodConfigToJson();
$this->assertTrue($done);
$expected = filemtime($this->conf->getConfigFile());
$expected = filemtime($this->conf->getConfigFileExt());
$this->assertEquals($expected, $filetime);
}
}

28
tests/config/ConfigManagerTest.php
View file

@ -15,8 +15,7 @@ class ConfigManagerTest extends PHPUnit_Framework_TestCase
public function setUp()
{
ConfigManager::$CONFIG_FILE = 'tests/utils/config/configJson';
$this->conf = ConfigManager::reset();
$this->conf = new ConfigManager('tests/utils/config/configJson');
}
/**
@ -54,10 +53,10 @@ public function testSetWriteGet()
$this->conf->set('paramArray', array('foo' => 'bar'));
$this->conf->set('paramNull', null);
ConfigManager::$CONFIG_FILE = 'tests/utils/config/configTmp';
$this->conf->setConfigFile('tests/utils/config/configTmp');
$this->conf->write(true);
$this->conf->reload();
unlink($this->conf->getConfigFile());
unlink($this->conf->getConfigFileExt());
$this->assertEquals(42, $this->conf->get('paramInt'));
$this->assertEquals('value1', $this->conf->get('paramString'));
@ -73,10 +72,10 @@ public function testSetWriteGetNested()
{
$this->conf->set('foo.bar.key.stuff', 'testSetWriteGetNested');
ConfigManager::$CONFIG_FILE = 'tests/utils/config/configTmp';
$this->conf->setConfigFile('tests/utils/config/configTmp');
$this->conf->write(true);
$this->conf->reload();
unlink($this->conf->getConfigFile());
unlink($this->conf->getConfigFileExt());
$this->assertEquals('testSetWriteGetNested', $this->conf->get('foo.bar.key.stuff'));
}
@ -110,8 +109,8 @@ public function testSetArrayKey()
*/
public function testWriteMissingParameter()
{
ConfigManager::$CONFIG_FILE = 'tests/utils/config/configTmp';
$this->assertFalse(file_exists($this->conf->getConfigFile()));
$this->conf->setConfigFile('tests/utils/config/configTmp');
$this->assertFalse(file_exists($this->conf->getConfigFileExt()));
$this->conf->reload();
$this->conf->write(true);
@ -151,10 +150,9 @@ public function testExistsKo()
*/
public function testReset()
{
$conf = $this->conf;
$this->assertTrue($conf === ConfigManager::getInstance());
$this->assertFalse($conf === $this->conf->reset());
$this->assertFalse($conf === ConfigManager::getInstance());
$confIO = $this->conf->getConfigIO();
$this->conf->reset();
$this->assertFalse($confIO === $this->conf->getConfigIO());
}
/**
@ -162,11 +160,11 @@ public function testReset()
*/
public function testReload()
{
ConfigManager::$CONFIG_FILE = 'tests/utils/config/configTmp';
$this->conf->setConfigFile('tests/utils/config/configTmp');
$newConf = ConfigJson::getPhpHeaders() . '{ "key": "value" }';
file_put_contents($this->conf->getConfigFile(), $newConf);
file_put_contents($this->conf->getConfigFileExt(), $newConf);
$this->conf->reload();
unlink($this->conf->getConfigFile());
unlink($this->conf->getConfigFileExt());
// Previous conf no longer exists, and new values have been loaded.
$this->assertFalse($this->conf->exists('credentials.login'));
$this->assertEquals('value', $this->conf->get('key'));