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 @@ class ApplicationUtils
/** /**
* Checks Shaarli has the proper access permissions to its resources * 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 * @return array A list of the detected configuration issues
*/ */
public static function checkResourcePermissions() public static function checkResourcePermissions($conf)
{ {
$errors = array(); $errors = array();
$conf = ConfigManager::getInstance();
// Check script and template directories are readable // Check script and template directories are readable
foreach (array( foreach (array(
@ -168,7 +169,7 @@ class ApplicationUtils
// Check configuration files are readable and writeable // Check configuration files are readable and writeable
foreach (array( foreach (array(
$conf->getConfigFile(), $conf->getConfigFileExt(),
$conf->get('path.datastore'), $conf->get('path.datastore'),
$conf->get('path.ban_file'), $conf->get('path.ban_file'),
$conf->get('path.log'), $conf->get('path.log'),

48
application/PageBuilder.php
View file

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

57
application/Updater.php
View file

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

84
application/config/ConfigManager.php
View file

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

317
index.php
View file

@ -48,6 +48,8 @@ error_reporting(E_ALL^E_WARNING);
require_once 'application/ApplicationUtils.php'; require_once 'application/ApplicationUtils.php';
require_once 'application/Cache.php'; require_once 'application/Cache.php';
require_once 'application/CachedPage.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/FeedBuilder.php';
require_once 'application/FileUtils.php'; require_once 'application/FileUtils.php';
require_once 'application/HttpUtils.php'; require_once 'application/HttpUtils.php';
@ -59,8 +61,6 @@ require_once 'application/PageBuilder.php';
require_once 'application/TimeZone.php'; require_once 'application/TimeZone.php';
require_once 'application/Url.php'; require_once 'application/Url.php';
require_once 'application/Utils.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/PluginManager.php';
require_once 'application/Router.php'; require_once 'application/Router.php';
require_once 'application/Updater.php'; require_once 'application/Updater.php';
@ -105,13 +105,13 @@ if (isset($_COOKIE['shaarli']) && !is_session_id_valid($_COOKIE['shaarli'])) {
$_COOKIE['shaarli'] = session_id(); $_COOKIE['shaarli'] = session_id();
} }
$conf = ConfigManager::getInstance(); $conf = new ConfigManager();
$conf->setEmpty('general.timezone', date_default_timezone_get()); $conf->setEmpty('general.timezone', date_default_timezone_get());
$conf->setEmpty('general.title', 'Shared links on '. escape(index_url($_SERVER))); $conf->setEmpty('general.title', 'Shared links on '. escape(index_url($_SERVER)));
RainTPL::$tpl_dir = $conf->get('path.raintpl_tpl'); // template directory RainTPL::$tpl_dir = $conf->get('path.raintpl_tpl'); // template directory
RainTPL::$cache_dir = $conf->get('path.raintpl_tmp'); // cache 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')); $pluginManager->load($conf->get('general.enabled_plugins'));
date_default_timezone_set($conf->get('general.timezone', 'UTC')); date_default_timezone_set($conf->get('general.timezone', 'UTC'));
@ -133,9 +133,9 @@ header("Cache-Control: no-store, no-cache, must-revalidate");
header("Cache-Control: post-check=0, pre-check=0", false); header("Cache-Control: post-check=0, pre-check=0", false);
header("Pragma: no-cache"); header("Pragma: no-cache");
if (! is_file($conf->getConfigFile())) { if (! is_file($conf->getConfigFileExt())) {
// Ensure Shaarli has proper access to its resources // Ensure Shaarli has proper access to its resources
$errors = ApplicationUtils::checkResourcePermissions(); $errors = ApplicationUtils::checkResourcePermissions($conf);
if ($errors != array()) { if ($errors != array()) {
$message = '<p>Insufficient permissions:</p><ul>'; $message = '<p>Insufficient permissions:</p><ul>';
@ -151,7 +151,7 @@ if (! is_file($conf->getConfigFile())) {
} }
// Display the installation form if no existing config is found // 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 // a token depending of deployment salt, user password, and the current ip
@ -163,13 +163,15 @@ if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
} }
header('Content-Type: text/html; charset=utf-8'); // We use UTF-8 for proper international characters handling. 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) * Checking session state (i.e. is the user still logged in)
//================================================================================================== *
* @param ConfigManager $conf The configuration manager.
function setup_login_state() { *
$conf = ConfigManager::getInstance(); * @return bool: true if the user is logged in, false otherwise.
*/
function setup_login_state($conf)
{
if ($conf->get('extras.open_shaarli')) { if ($conf->get('extras.open_shaarli')) {
return true; return true;
} }
@ -183,7 +185,7 @@ function setup_login_state() {
$_COOKIE['shaarli_staySignedIn']===STAY_SIGNED_IN_TOKEN && $_COOKIE['shaarli_staySignedIn']===STAY_SIGNED_IN_TOKEN &&
!$loginFailure) !$loginFailure)
{ {
fillSessionInfo(); fillSessionInfo($conf);
$userIsLoggedIn = true; $userIsLoggedIn = true;
} }
// If session does not exist on server side, or IP address has changed, or session has expired, logout. // 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; return $userIsLoggedIn;
} }
$userIsLoggedIn = setup_login_state(); $userIsLoggedIn = setup_login_state($conf);
// ------------------------------------------------------------------------------------------ /**
// PubSubHubbub protocol support (if enabled) [UNTESTED] * PubSubHubbub protocol support (if enabled) [UNTESTED]
// (Source: http://aldarone.fr/les-flux-rss-shaarli-et-pubsubhubbub/ ) * (Source: http://aldarone.fr/les-flux-rss-shaarli-et-pubsubhubbub/ )
function pubsubhub() *
* @param ConfigManager $conf Configuration Manager instance.
*/
function pubsubhub($conf)
{ {
$conf = ConfigManager::getInstance();
$pshUrl = $conf->get('config.PUBSUBHUB_URL'); $pshUrl = $conf->get('config.PUBSUBHUB_URL');
if (!empty($pshUrl)) if (!empty($pshUrl))
{ {
@ -241,27 +245,39 @@ function allIPs()
return $ip; 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['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['ip']=allIPs(); // We store IP address(es) of the client to make sure session is not hijacked.
$_SESSION['username']= $conf->get('credentials.login'); $_SESSION['username']= $conf->get('credentials.login');
$_SESSION['expires_on']=time()+INACTIVITY_TIMEOUT; // Set session expiration. $_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')); $hash = sha1($password . $login . $conf->get('credentials.salt'));
if ($login == $conf->get('credentials.login') && $hash == $conf->get('credentials.hash')) if ($login == $conf->get('credentials.login') && $hash == $conf->get('credentials.hash'))
{ // Login/password is correct. { // Login/password is correct.
fillSessionInfo(); fillSessionInfo($conf);
logm($conf->get('path.log'), $_SERVER['REMOTE_ADDR'], 'Login successful'); 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); 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. // Returns true if the user is logged in.
@ -294,10 +310,13 @@ if (!is_file($conf->get('path.ban_file', 'data/ipbans.php'))) {
); );
} }
include $conf->get('path.ban_file', 'data/ipbans.php'); 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']; $ip = $_SERVER['REMOTE_ADDR'];
$gb = $GLOBALS['IPBANS']; $gb = $GLOBALS['IPBANS'];
if (!isset($gb['FAILURES'][$ip])) $gb['FAILURES'][$ip]=0; 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']; $ip = $_SERVER['REMOTE_ADDR'];
$gb = $GLOBALS['IPBANS']; $gb = $GLOBALS['IPBANS'];
unset($gb['FAILURES'][$ip]); unset($gb['BANS'][$ip]); 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']; $ip=$_SERVER["REMOTE_ADDR"]; $gb=$GLOBALS['IPBANS'];
if (isset($gb['BANS'][$ip])) if (isset($gb['BANS'][$ip]))
{ {
@ -355,10 +382,12 @@ function ban_canLogin()
// Process login form: Check if login/password is correct. // Process login form: Check if login/password is correct.
if (isset($_POST['login'])) if (isset($_POST['login']))
{ {
if (!ban_canLogin()) die('I said: NO. You are banned for the moment. Go away.'); 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']))) if (isset($_POST['password'])
{ // Login/password is OK. && tokenOk($_POST['token'])
ban_loginOk(); && (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 user wants to keep the session cookie even after the browser closes:
if (!empty($_POST['longlastingsession'])) if (!empty($_POST['longlastingsession']))
{ {
@ -406,7 +435,7 @@ if (isset($_POST['login']))
} }
else else
{ {
ban_loginFailed(); ban_loginFailed($conf);
$redir = '&username='. $_POST['login']; $redir = '&username='. $_POST['login'];
if (isset($_GET['post'])) { if (isset($_GET['post'])) {
$redir .= '&post=' . urlencode($_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...). // 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. 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. $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. $_SESSION['tokens'][$rnd]=1; // Store it on the server side.
return $rnd; return $rnd;
@ -475,12 +509,14 @@ function tokenOk($token)
return false; // Wrong token, or already used. return false; // Wrong token, or already used.
} }
// ------------------------------------------------------------------------------------------ /**
// Daily RSS feed: 1 RSS entry per day giving all the links on that day. * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
// Gives the last 7 days (which have links). * Gives the last 7 days (which have links).
// This RSS feed cannot be filtered. * This RSS feed cannot be filtered.
function showDailyRSS() { *
$conf = ConfigManager::getInstance(); * @param ConfigManager $conf Configuration Manager instance.
*/
function showDailyRSS($conf) {
// Cache system // Cache system
$query = $_SERVER['QUERY_STRING']; $query = $_SERVER['QUERY_STRING'];
$cache = new CachedPage( $cache = new CachedPage(
@ -555,7 +591,7 @@ function showDailyRSS() {
foreach ($linkdates as $linkdate) { foreach ($linkdates as $linkdate) {
$l = $LINKSDB[$linkdate]; $l = $LINKSDB[$linkdate];
$l['formatedDescription'] = format_description($l['description'], $conf->get('extras.redirector')); $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_date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $l['linkdate']);
$l['timestamp'] = $l_date->getTimestamp(); $l['timestamp'] = $l_date->getTimestamp();
if (startsWith($l['url'], '?')) { if (startsWith($l['url'], '?')) {
@ -586,12 +622,13 @@ function showDailyRSS() {
/** /**
* Show the 'Daily' page. * Show the 'Daily' page.
* *
* @param PageBuilder $pageBuilder Template engine wrapper. * @param PageBuilder $pageBuilder Template engine wrapper.
* @param LinkDB $LINKSDB LinkDB instance. * @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. $day=date('Ymd',strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
if (isset($_GET['day'])) $day=$_GET['day']; if (isset($_GET['day'])) $day=$_GET['day'];
@ -621,7 +658,7 @@ function showDaily($pageBuilder, $LINKSDB)
uasort($taglist, 'strcasecmp'); uasort($taglist, 'strcasecmp');
$linksToDisplay[$key]['taglist']=$taglist; $linksToDisplay[$key]['taglist']=$taglist;
$linksToDisplay[$key]['formatedDescription'] = format_description($link['description'], $conf->get('extras.redirector')); $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']); $date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
$linksToDisplay[$key]['timestamp'] = $date->getTimestamp(); $linksToDisplay[$key]['timestamp'] = $date->getTimestamp();
} }
@ -656,7 +693,7 @@ function showDaily($pageBuilder, $LINKSDB)
'previousday' => $previousday, 'previousday' => $previousday,
'nextday' => $nextday, 'nextday' => $nextday,
); );
$pluginManager = PluginManager::getInstance();
$pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn())); $pluginManager->executeHooks('render_daily', $data, array('loggedin' => isLoggedIn()));
foreach ($data as $key => $value) { foreach ($data as $key => $value) {
@ -667,18 +704,27 @@ function showDaily($pageBuilder, $LINKSDB)
exit; exit;
} }
// Renders the linklist /**
function showLinkList($PAGE, $LINKSDB) { * Renders the linklist
buildLinkList($PAGE,$LINKSDB); // Compute list of links to display *
* @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'); $PAGE->renderPage('linklist');
} }
/**
// ------------------------------------------------------------------------------------------ * Render HTML page (according to URL parameters and user rights)
// Render HTML page (according to URL parameters and user rights) *
function renderPage() * @param ConfigManager $conf Configuration Manager instance.
* @param PluginManager $pluginManager Plugin Manager instance,
*/
function renderPage($conf, $pluginManager)
{ {
$conf = ConfigManager::getInstance();
$LINKSDB = new LinkDB( $LINKSDB = new LinkDB(
$conf->get('path.datastore'), $conf->get('path.datastore'),
isLoggedIn(), isLoggedIn(),
@ -690,6 +736,7 @@ function renderPage()
$updater = new Updater( $updater = new Updater(
read_updates_file($conf->get('path.updates')), read_updates_file($conf->get('path.updates')),
$LINKSDB, $LINKSDB,
$conf,
isLoggedIn() isLoggedIn()
); );
try { try {
@ -705,7 +752,7 @@ function renderPage()
die($e->getMessage()); die($e->getMessage());
} }
$PAGE = new PageBuilder(); $PAGE = new PageBuilder($conf);
$PAGE->assign('linkcount', count($LINKSDB)); $PAGE->assign('linkcount', count($LINKSDB));
$PAGE->assign('privateLinkcount', count_private($LINKSDB)); $PAGE->assign('privateLinkcount', count_private($LINKSDB));
@ -720,7 +767,7 @@ function renderPage()
'header', 'header',
'footer', 'footer',
); );
$pluginManager = PluginManager::getInstance();
foreach($common_hooks as $name) { foreach($common_hooks as $name) {
$plugin_data = array(); $plugin_data = array();
$pluginManager->executeHooks('render_' . $name, $plugin_data, $pluginManager->executeHooks('render_' . $name, $plugin_data,
@ -736,7 +783,7 @@ function renderPage()
if ($targetPage == Router::$PAGE_LOGIN) if ($targetPage == Router::$PAGE_LOGIN)
{ {
if ($conf->get('extras.open_shaarli')) { header('Location: ?'); exit; } // No need to login for open Shaarli 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); $PAGE->assign('token',$token);
if (isset($_GET['username'])) { if (isset($_GET['username'])) {
$PAGE->assign('username', escape($_GET['username'])); $PAGE->assign('username', escape($_GET['username']));
@ -765,7 +812,7 @@ function renderPage()
foreach($links as $link) foreach($links as $link)
{ {
$permalink='?'.escape(smallhash($link['linkdate'])); $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. if ($thumb!='') // Only output links which have a thumbnail.
{ {
$link['thumbnail']=$thumb; // Thumbnail HTML code. $link['thumbnail']=$thumb; // Thumbnail HTML code.
@ -837,7 +884,7 @@ function renderPage()
// Daily page. // Daily page.
if ($targetPage == Router::$PAGE_DAILY) { if ($targetPage == Router::$PAGE_DAILY) {
showDaily($PAGE, $LINKSDB); showDaily($PAGE, $LINKSDB, $conf, $pluginManager);
} }
// ATOM and RSS feed. // ATOM and RSS feed.
@ -870,7 +917,6 @@ function renderPage()
$data = $feedGenerator->buildData(); $data = $feedGenerator->buildData();
// Process plugin hook. // Process plugin hook.
$pluginManager = PluginManager::getInstance();
$pluginManager->executeHooks('render_feed', $data, array( $pluginManager->executeHooks('render_feed', $data, array(
'loggedin' => isLoggedIn(), 'loggedin' => isLoggedIn(),
'target' => $targetPage, 'target' => $targetPage,
@ -996,7 +1042,7 @@ function renderPage()
exit; exit;
} }
showLinkList($PAGE, $LINKSDB); showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
if (isset($_GET['edit_link'])) { if (isset($_GET['edit_link'])) {
header('Location: ?do=login&edit_link='. escape($_GET['edit_link'])); header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
exit; exit;
@ -1059,7 +1105,7 @@ function renderPage()
} }
else // show the change password form. else // show the change password form.
{ {
$PAGE->assign('token',getToken()); $PAGE->assign('token',getToken($conf));
$PAGE->renderPage('changepassword'); $PAGE->renderPage('changepassword');
exit; exit;
} }
@ -1106,7 +1152,7 @@ function renderPage()
} }
else // Show the configuration form. else // Show the configuration form.
{ {
$PAGE->assign('token',getToken()); $PAGE->assign('token',getToken($conf));
$PAGE->assign('title', $conf->get('general.title')); $PAGE->assign('title', $conf->get('general.title'));
$PAGE->assign('redirector', $conf->get('extras.redirector')); $PAGE->assign('redirector', $conf->get('extras.redirector'));
list($timezone_form, $timezone_js) = generateTimeZoneForm($conf->get('general.timezone')); list($timezone_form, $timezone_js) = generateTimeZoneForm($conf->get('general.timezone'));
@ -1125,7 +1171,7 @@ function renderPage()
if ($targetPage == Router::$PAGE_CHANGETAG) if ($targetPage == Router::$PAGE_CHANGETAG)
{ {
if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) { 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->assign('tags', $LINKSDB->allTags());
$PAGE->renderPage('changetag'); $PAGE->renderPage('changetag');
exit; exit;
@ -1216,7 +1262,7 @@ function renderPage()
$LINKSDB[$linkdate] = $link; $LINKSDB[$linkdate] = $link;
$LINKSDB->savedb($conf->get('path.page_cache')); $LINKSDB->savedb($conf->get('path.page_cache'));
pubsubhub(); pubsubhub($conf);
// If we are called from the bookmarklet, we must close the popup: // If we are called from the bookmarklet, we must close the popup:
if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
@ -1300,7 +1346,7 @@ function renderPage()
$data = array( $data = array(
'link' => $link, 'link' => $link,
'link_is_new' => false, 'link_is_new' => false,
'token' => getToken(), 'token' => getToken($conf),
'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''), 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
'tags' => $LINKSDB->allTags(), 'tags' => $LINKSDB->allTags(),
); );
@ -1367,7 +1413,7 @@ function renderPage()
$data = array( $data = array(
'link' => $link, 'link' => $link,
'link_is_new' => $link_is_new, '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']) : ''), 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
'source' => (isset($_GET['source']) ? $_GET['source'] : ''), 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
'tags' => $LINKSDB->allTags(), 'tags' => $LINKSDB->allTags(),
@ -1445,7 +1491,7 @@ function renderPage()
// -------- Show upload/import dialog: // -------- Show upload/import dialog:
if ($targetPage == Router::$PAGE_IMPORT) if ($targetPage == Router::$PAGE_IMPORT)
{ {
$PAGE->assign('token',getToken()); $PAGE->assign('token',getToken($conf));
$PAGE->assign('maxfilesize',getMaxFileSize()); $PAGE->assign('maxfilesize',getMaxFileSize());
$PAGE->renderPage('import'); $PAGE->renderPage('import');
exit; exit;
@ -1500,16 +1546,19 @@ function renderPage()
} }
// -------- Otherwise, simply display search form and links: // -------- Otherwise, simply display search form and links:
showLinkList($PAGE, $LINKSDB); showLinkList($PAGE, $LINKSDB, $conf, $pluginManager);
exit; exit;
} }
// ----------------------------------------------------------------------------------------------- /**
// Process the import file form. * Process the import file form.
function importFile($LINKSDB) *
* @param LinkDB $LINKSDB Loaded LinkDB instance.
* @param ConfigManager $conf Configuration Manager instance.
*/
function importFile($LINKSDB, $conf)
{ {
if (!isLoggedIn()) { die('Not allowed.'); } if (!isLoggedIn()) { die('Not allowed.'); }
$conf = ConfigManager::getInstance();
$filename=$_FILES['filetoupload']['name']; $filename=$_FILES['filetoupload']['name'];
$filesize=$_FILES['filetoupload']['size']; $filesize=$_FILES['filetoupload']['size'];
@ -1594,12 +1643,13 @@ function importFile($LINKSDB)
* Template for the list of links (<div id="linklist">) * Template for the list of links (<div id="linklist">)
* This function fills all the necessary fields in the $PAGE for the template 'linklist.html' * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
* *
* @param pageBuilder $PAGE pageBuilder instance. * @param pageBuilder $PAGE pageBuilder instance.
* @param LinkDB $LINKSDB LinkDB 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 // Used in templates
$searchtags = !empty($_GET['searchtags']) ? escape($_GET['searchtags']) : ''; $searchtags = !empty($_GET['searchtags']) ? escape($_GET['searchtags']) : '';
$searchterm = !empty($_GET['searchterm']) ? escape($_GET['searchterm']) : ''; $searchterm = !empty($_GET['searchterm']) ? escape($_GET['searchterm']) : '';
@ -1674,7 +1724,7 @@ function buildLinkList($PAGE,$LINKSDB)
$next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl; $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
} }
$token = isLoggedIn() ? getToken() : ''; $token = isLoggedIn() ? getToken($conf) : '';
// Fill all template fields. // Fill all template fields.
$data = array( $data = array(
@ -1695,7 +1745,6 @@ function buildLinkList($PAGE,$LINKSDB)
$data['pagetitle'] = $conf->get('pagetitle'); $data['pagetitle'] = $conf->get('pagetitle');
} }
$pluginManager = PluginManager::getInstance();
$pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn())); $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => isLoggedIn()));
foreach ($data as $key => $value) { foreach ($data as $key => $value) {
@ -1705,18 +1754,25 @@ function buildLinkList($PAGE,$LINKSDB)
return; return;
} }
// Compute the thumbnail for a link. /**
// * Compute the thumbnail for a link.
// With a link to the original URL. *
// Understands various services (youtube.com...) * With a link to the original URL.
// Input: $url = URL for which the thumbnail must be found. * Understands various services (youtube.com...)
// $href = if provided, this URL will be followed instead of $url * Input: $url = URL for which the thumbnail must be found.
// Returns an associative array with thumbnail attributes (src,href,width,height,style,alt) * $href = if provided, this URL will be followed instead of $url
// Some of them may be missing. * Returns an associative array with thumbnail attributes (src,href,width,height,style,alt)
// Return an empty array if no thumbnail available. * Some of them may be missing.
function computeThumbnail($url,$href=false) * 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 (!$conf->get('general.enable_thumbnails')) return array();
if ($href==false) $href=$url; if ($href==false) $href=$url;
@ -1836,7 +1892,9 @@ function computeThumbnail($url,$href=false)
// Returns '' if no thumbnail available. // Returns '' if no thumbnail available.
function thumbnail($url,$href=false) 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. if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
$html='<a href="'.escape($t['href']).'"><img src="'.escape($t['src']).'"'; $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. // Input: $url = URL for which the thumbnail must be found.
// $href = if provided, this URL will be followed instead of $url // $href = if provided, this URL will be followed instead of $url
// Returns '' if no thumbnail available. // 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. if (count($t)==0) return ''; // Empty array = no thumbnail for this URL.
$html='<a href="'.escape($t['href']).'">'; $html='<a href="'.escape($t['href']).'">';
@ -1882,10 +1942,13 @@ function lazyThumbnail($url,$href=false)
} }
// ----------------------------------------------------------------------------------------------- /**
// Installation * Installation
// This function should NEVER be called if the file data/config.php exists. * This function should NEVER be called if the file data/config.php exists.
function install() *
* @param ConfigManager $conf Configuration Manager instance.
*/
function install($conf)
{ {
// On free.fr host, make sure the /sessions directory exists, otherwise login will not work. // 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); 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'])) if (!empty($_POST['setlogin']) && !empty($_POST['setpassword']))
{ {
$conf = ConfigManager::getInstance();
$tz = 'UTC'; $tz = 'UTC';
if (!empty($_POST['continent']) && !empty($_POST['city']) if (!empty($_POST['continent']) && !empty($_POST['city'])
&& isTimeZoneValid($_POST['continent'], $_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>'; $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_html',$timezone_html);
$PAGE->assign('timezone_js',$timezone_js); $PAGE->assign('timezone_js',$timezone_js);
$PAGE->renderPage('install'); $PAGE->renderPage('install');
exit; 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. * Because some f*cking services like flickr require an extra HTTP request to get the thumbnail URL,
The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail. * I have deported the thumbnail URL code generation here, otherwise this would slow down page generation.
This function is called by passing the URL: * The following function takes the URL a link (e.g. a flickr page) and return the proper thumbnail.
http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL] * This function is called by passing the URL:
[URL] is the URL of the link (e.g. a flickr page) * http://mywebsite.com/shaarli/?do=genthumbnail&hmac=[HMAC]&url=[URL]
[HMAC] is the signature for the [URL] (so that these URL cannot be forged). * [URL] is the URL of the link (e.g. a flickr page)
The function below will fetch the image from the webservice and store it in the cache. * [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() *
* @param ConfigManager $conf Configuration Manager instance,
*/
function genThumbnail($conf)
{ {
$conf = ConfigManager::getInstance();
// Make sure the parameters in the URL were generated by us. // Make sure the parameters in the URL were generated by us.
$sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt')); $sign = hash_hmac('sha256', $_GET['url'], $conf->get('credentials.salt'));
if ($sign!=$_GET['hmac']) die('Naughty boy!'); if ($sign!=$_GET['hmac']) die('Naughty boy!');
@ -2190,10 +2254,9 @@ function resizeImage($filepath)
return true; 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=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(); exit; } if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) { showDailyRSS($conf); exit; }
if (!isset($_SESSION['LINKS_PER_PAGE'])) { if (!isset($_SESSION['LINKS_PER_PAGE'])) {
$_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20); $_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 @@ class ApplicationUtilsTest extends PHPUnit_Framework_TestCase
*/ */
public function testCheckCurrentResourcePermissions() public function testCheckCurrentResourcePermissions()
{ {
$conf = ConfigManager::getInstance(); $conf = new ConfigManager('');
$conf->set('path.thumbnails_cache', 'cache'); $conf->set('path.thumbnails_cache', 'cache');
$conf->set('path.config', 'data/config.php'); $conf->set('path.config', 'data/config.php');
$conf->set('path.data_dir', 'data'); $conf->set('path.data_dir', 'data');
@ -290,7 +290,7 @@ class ApplicationUtilsTest extends PHPUnit_Framework_TestCase
$this->assertEquals( $this->assertEquals(
array(), array(),
ApplicationUtils::checkResourcePermissions() ApplicationUtils::checkResourcePermissions($conf)
); );
} }
@ -299,7 +299,7 @@ class ApplicationUtilsTest extends PHPUnit_Framework_TestCase
*/ */
public function testCheckCurrentResourcePermissionsErrors() public function testCheckCurrentResourcePermissionsErrors()
{ {
$conf = ConfigManager::getInstance(); $conf = new ConfigManager('');
$conf->set('path.thumbnails_cache', 'null/cache'); $conf->set('path.thumbnails_cache', 'null/cache');
$conf->set('path.config', 'null/data/config.php'); $conf->set('path.config', 'null/data/config.php');
$conf->set('path.data_dir', 'null/data'); $conf->set('path.data_dir', 'null/data');
@ -322,7 +322,7 @@ class ApplicationUtilsTest extends PHPUnit_Framework_TestCase
'"null/tmp" directory is not readable', '"null/tmp" directory is not readable',
'"null/tmp" directory is not writable' '"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. * Object constructor.
* *
* @param array $doneUpdates Updates which are already done. * @param array $doneUpdates Updates which are already done.
* @param LinkDB $linkDB LinkDB instance. * @param LinkDB $linkDB LinkDB instance.
* @param boolean $isLoggedIn True if the user is logged in. * @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. // Retrieve all update methods.
// For unit test, only retrieve final 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() public function setUp()
{ {
ConfigManager::$CONFIG_FILE = self::$configFile; $this->conf = new ConfigManager(self::$configFile);
$this->conf = ConfigManager::reset();
} }
/** /**
@ -108,10 +107,10 @@ class UpdaterTest extends PHPUnit_Framework_TestCase
'updateMethodDummy3', 'updateMethodDummy3',
'updateMethodException', 'updateMethodException',
); );
$updater = new DummyUpdater($updates, array(), true); $updater = new DummyUpdater($updates, array(), $this->conf, true);
$this->assertEquals(array(), $updater->update()); $this->assertEquals(array(), $updater->update());
$updater = new DummyUpdater(array(), array(), false); $updater = new DummyUpdater(array(), array(), $this->conf, false);
$this->assertEquals(array(), $updater->update()); $this->assertEquals(array(), $updater->update());
} }
@ -126,7 +125,7 @@ class UpdaterTest extends PHPUnit_Framework_TestCase
'updateMethodDummy2', 'updateMethodDummy2',
'updateMethodDummy3', 'updateMethodDummy3',
); );
$updater = new DummyUpdater($updates, array(), true); $updater = new DummyUpdater($updates, array(), $this->conf, true);
$this->assertEquals($expectedUpdates, $updater->update()); $this->assertEquals($expectedUpdates, $updater->update());
} }
@ -142,7 +141,7 @@ class UpdaterTest extends PHPUnit_Framework_TestCase
); );
$expectedUpdate = array('updateMethodDummy2'); $expectedUpdate = array('updateMethodDummy2');
$updater = new DummyUpdater($updates, array(), true); $updater = new DummyUpdater($updates, array(), $this->conf, true);
$this->assertEquals($expectedUpdate, $updater->update()); $this->assertEquals($expectedUpdate, $updater->update());
} }
@ -159,7 +158,7 @@ class UpdaterTest extends PHPUnit_Framework_TestCase
'updateMethodDummy3', 'updateMethodDummy3',
); );
$updater = new DummyUpdater($updates, array(), true); $updater = new DummyUpdater($updates, array(), $this->conf, true);
$updater->update(); $updater->update();
} }
@ -172,8 +171,8 @@ class UpdaterTest extends PHPUnit_Framework_TestCase
*/ */
public function testUpdateMergeDeprecatedConfig() public function testUpdateMergeDeprecatedConfig()
{ {
ConfigManager::$CONFIG_FILE = 'tests/utils/config/configPhp'; $this->conf->setConfigFile('tests/utils/config/configPhp');
$this->conf = $this->conf->reset(); $this->conf->reset();
$optionsFile = 'tests/Updater/options.php'; $optionsFile = 'tests/Updater/options.php';
$options = '<?php $options = '<?php
@ -181,10 +180,10 @@ $GLOBALS[\'privateLinkByDefault\'] = true;';
file_put_contents($optionsFile, $options); file_put_contents($optionsFile, $options);
// tmp config file. // tmp config file.
ConfigManager::$CONFIG_FILE = 'tests/Updater/config'; $this->conf->setConfigFile('tests/Updater/config');
// merge configs // 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 // This writes a new config file in tests/Updater/config.php
$updater->updateMethodMergeDeprecatedConfigFile(); $updater->updateMethodMergeDeprecatedConfigFile();
@ -193,7 +192,7 @@ $GLOBALS[\'privateLinkByDefault\'] = true;';
$this->assertTrue($this->conf->get('general.default_private_links')); $this->assertTrue($this->conf->get('general.default_private_links'));
$this->assertFalse(is_file($optionsFile)); $this->assertFalse(is_file($optionsFile));
// Delete the generated file. // Delete the generated file.
unlink($this->conf->getConfigFile()); unlink($this->conf->getConfigFileExt());
} }
/** /**
@ -201,7 +200,7 @@ $GLOBALS[\'privateLinkByDefault\'] = true;';
*/ */
public function testMergeDeprecatedConfigNoFile() public function testMergeDeprecatedConfigNoFile()
{ {
$updater = new Updater(array(), array(), true); $updater = new Updater(array(), array(), $this->conf, true);
$updater->updateMethodMergeDeprecatedConfigFile(); $updater->updateMethodMergeDeprecatedConfigFile();
$this->assertEquals('root', $this->conf->get('credentials.login')); $this->assertEquals('root', $this->conf->get('credentials.login'));
@ -216,7 +215,7 @@ $GLOBALS[\'privateLinkByDefault\'] = true;';
$refDB->write(self::$testDatastore); $refDB->write(self::$testDatastore);
$linkDB = new LinkDB(self::$testDatastore, true, false); $linkDB = new LinkDB(self::$testDatastore, true, false);
$this->assertEmpty($linkDB->filterSearch(array('searchtags' => 'exclude'))); $this->assertEmpty($linkDB->filterSearch(array('searchtags' => 'exclude')));
$updater = new Updater(array(), $linkDB, true); $updater = new Updater(array(), $linkDB, $this->conf, true);
$updater->updateMethodRenameDashTags(); $updater->updateMethodRenameDashTags();
$this->assertNotEmpty($linkDB->filterSearch(array('searchtags' => 'exclude'))); $this->assertNotEmpty($linkDB->filterSearch(array('searchtags' => 'exclude')));
} }
@ -227,29 +226,29 @@ $GLOBALS[\'privateLinkByDefault\'] = true;';
public function testConfigToJson() public function testConfigToJson()
{ {
$configFile = 'tests/utils/config/configPhp'; $configFile = 'tests/utils/config/configPhp';
ConfigManager::$CONFIG_FILE = $configFile; $this->conf->setConfigFile($configFile);
$conf = ConfigManager::reset(); $this->conf->reset();
// The ConfigIO is initialized with ConfigPhp. // 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(); $done = $updater->updateMethodConfigToJson();
$this->assertTrue($done); $this->assertTrue($done);
// The ConfigIO has been updated to ConfigJson. // The ConfigIO has been updated to ConfigJson.
$this->assertTrue($conf->getConfigIO() instanceof ConfigJson); $this->assertTrue($this->conf->getConfigIO() instanceof ConfigJson);
$this->assertTrue(file_exists($conf->getConfigFile())); $this->assertTrue(file_exists($this->conf->getConfigFileExt()));
// Check JSON config data. // Check JSON config data.
$conf->reload(); $this->conf->reload();
$this->assertEquals('root', $conf->get('credentials.login')); $this->assertEquals('root', $this->conf->get('credentials.login'));
$this->assertEquals('lala', $conf->get('extras.redirector')); $this->assertEquals('lala', $this->conf->get('extras.redirector'));
$this->assertEquals('data/datastore.php', $conf->get('path.datastore')); $this->assertEquals('data/datastore.php', $this->conf->get('path.datastore'));
$this->assertEquals('1', $conf->get('plugins.WALLABAG_VERSION')); $this->assertEquals('1', $this->conf->get('plugins.WALLABAG_VERSION'));
rename($configFile . '.save.php', $configFile . '.php'); rename($configFile . '.save.php', $configFile . '.php');
unlink($conf->getConfigFile()); unlink($this->conf->getConfigFileExt());
} }
/** /**
@ -257,11 +256,11 @@ $GLOBALS[\'privateLinkByDefault\'] = true;';
*/ */
public function testConfigToJsonNothingToDo() public function testConfigToJsonNothingToDo()
{ {
$filetime = filemtime($this->conf->getConfigFile()); $filetime = filemtime($this->conf->getConfigFileExt());
$updater = new Updater(array(), array(), false); $updater = new Updater(array(), array(), $this->conf, false);
$done = $updater->updateMethodConfigToJson(); $done = $updater->updateMethodConfigToJson();
$this->assertTrue($done); $this->assertTrue($done);
$expected = filemtime($this->conf->getConfigFile()); $expected = filemtime($this->conf->getConfigFileExt());
$this->assertEquals($expected, $filetime); $this->assertEquals($expected, $filetime);
} }
} }

28
tests/config/ConfigManagerTest.php
View file

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