*/
class LinkDB implements Iterator, Countable, ArrayAccess
{
+ // Links are stored as a PHP serialized string
+ private $_datastore;
+
+ // Datastore PHP prefix
+ protected static $phpPrefix = '<?php /* ';
+
+ // Datastore PHP suffix
+ protected static $phpSuffix = ' */ ?>';
+
// List of links (associative array)
// - key: link date (e.g. "20110823_124546"),
// - value: associative array (keys: title, description...)
- private $links;
+ private $_links;
// List of all recorded URLs (key=url, value=linkdate)
// for fast reserve search (url-->linkdate)
- private $urls;
+ private $_urls;
// List of linkdate keys (for the Iterator interface implementation)
- private $keys;
+ private $_keys;
- // Position in the $this->keys array (for the Iterator interface)
- private $position;
+ // Position in the $this->_keys array (for the Iterator interface)
+ private $_position;
// Is the user logged in? (used to filter private links)
- private $loggedIn;
+ private $_loggedIn;
+
+ // Hide public links
+ private $_hidePublicLinks;
/**
* Creates a new LinkDB
*
* @param $isLoggedIn is the user logged in?
*/
- function __construct($isLoggedIn)
+ function __construct($datastore, $isLoggedIn, $hidePublicLinks)
{
- // FIXME: do not access $GLOBALS, pass the datastore instead
- $this->loggedIn = $isLoggedIn;
- $this->checkDB();
- $this->readdb();
+ $this->_datastore = $datastore;
+ $this->_loggedIn = $isLoggedIn;
+ $this->_hidePublicLinks = $hidePublicLinks;
+ $this->_checkDB();
+ $this->_readDB();
}
/**
*/
public function count()
{
- return count($this->links);
+ return count($this->_links);
}
/**
public function offsetSet($offset, $value)
{
// TODO: use exceptions instead of "die"
- if (!$this->loggedIn) {
+ if (!$this->_loggedIn) {
die('You are not authorized to add a link.');
}
if (empty($value['linkdate']) || empty($value['url'])) {
if (empty($offset)) {
die('You must specify a key.');
}
- $this->links[$offset] = $value;
- $this->urls[$value['url']]=$offset;
+ $this->_links[$offset] = $value;
+ $this->_urls[$value['url']]=$offset;
}
/**
*/
public function offsetExists($offset)
{
- return array_key_exists($offset, $this->links);
+ return array_key_exists($offset, $this->_links);
}
/**
*/
public function offsetUnset($offset)
{
- if (!$this->loggedIn) {
+ if (!$this->_loggedIn) {
// TODO: raise an exception
die('You are not authorized to delete a link.');
}
- $url = $this->links[$offset]['url'];
- unset($this->urls[$url]);
- unset($this->links[$offset]);
+ $url = $this->_links[$offset]['url'];
+ unset($this->_urls[$url]);
+ unset($this->_links[$offset]);
}
/**
*/
public function offsetGet($offset)
{
- return isset($this->links[$offset]) ? $this->links[$offset] : null;
+ return isset($this->_links[$offset]) ? $this->_links[$offset] : null;
}
/**
*/
function current()
{
- return $this->links[$this->keys[$this->position]];
+ return $this->_links[$this->_keys[$this->_position]];
}
/**
*/
function key()
{
- return $this->keys[$this->position];
+ return $this->_keys[$this->_position];
}
/**
*/
function next()
{
- ++$this->position;
+ ++$this->_position;
}
/**
*/
function rewind()
{
- $this->keys = array_keys($this->links);
- rsort($this->keys);
- $this->position = 0;
+ $this->_keys = array_keys($this->_links);
+ rsort($this->_keys);
+ $this->_position = 0;
}
/**
*/
function valid()
{
- return isset($this->keys[$this->position]);
+ return isset($this->_keys[$this->_position]);
}
/**
*
* If no DB file is found, creates a dummy DB.
*/
- private function checkDB()
+ private function _checkDB()
{
- if (file_exists($GLOBALS['config']['DATASTORE'])) {
+ if (file_exists($this->_datastore)) {
return;
}
// Create a dummy database for example
- $this->links = array();
+ $this->_links = array();
$link = array(
- 'title'=>'Shaarli - sebsauvage.net',
- 'url'=>'http://sebsauvage.net/wiki/doku.php?id=php:shaarli',
- 'description'=>'Welcome to Shaarli! This is a bookmark. To edit or delete me, you must first login.',
+ 'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone',
+ 'url'=>'https://github.com/shaarli/Shaarli/wiki',
+ 'description'=>'Welcome to Shaarli! This is your first public bookmark. To edit or delete me, you must first login.
+
+To learn how to use Shaarli, consult the link "Help/documentation" at the bottom of this page.
+
+You use the community supported version of the original Shaarli project, by Sebastien Sauvage.',
'private'=>0,
- 'linkdate'=>'20110914_190000',
+ 'linkdate'=> date('Ymd_His'),
'tags'=>'opensource software'
);
- $this->links[$link['linkdate']] = $link;
+ $this->_links[$link['linkdate']] = $link;
$link = array(
'title'=>'My secret stuff... - Pastebin.com',
'url'=>'http://sebsauvage.net/paste/?8434b27936c09649#bR7XsXhoTiLcqCpQbmOpBi3rq2zzQUC5hBI7ZT1O3x8=',
- 'description'=>'SShhhh!! I\'m a private link only YOU can see. You can delete me too.',
+ 'description'=>'Shhhh! I\'m a private link only YOU can see. You can delete me too.',
'private'=>1,
- 'linkdate'=>'20110914_074522',
+ 'linkdate'=> date('Ymd_His', strtotime('-1 minute')),
'tags'=>'secretstuff'
);
- $this->links[$link['linkdate']] = $link;
+ $this->_links[$link['linkdate']] = $link;
// Write database to disk
// TODO: raise an exception if the file is not write-able
file_put_contents(
- // FIXME: do not use $GLOBALS
- $GLOBALS['config']['DATASTORE'],
- PHPPREFIX.base64_encode(gzdeflate(serialize($this->links))).PHPSUFFIX
+ $this->_datastore,
+ self::$phpPrefix.base64_encode(gzdeflate(serialize($this->_links))).self::$phpSuffix
);
}
/**
* Reads database from disk to memory
*/
- private function readdb()
+ private function _readDB()
{
// Public links are hidden and user not logged in => nothing to show
- if ($GLOBALS['config']['HIDE_PUBLIC_LINKS'] && !isLoggedIn()) {
- $this->links = array();
+ if ($this->_hidePublicLinks && !$this->_loggedIn) {
+ $this->_links = array();
return;
}
// Read data
// Note that gzinflate is faster than gzuncompress.
// See: http://www.php.net/manual/en/function.gzdeflate.php#96439
- // FIXME: do not use $GLOBALS
- $this->links = array();
+ $this->_links = array();
- if (file_exists($GLOBALS['config']['DATASTORE'])) {
- $this->links = unserialize(gzinflate(base64_decode(
- substr(file_get_contents($GLOBALS['config']['DATASTORE']),
- strlen(PHPPREFIX), -strlen(PHPSUFFIX)))));
+ if (file_exists($this->_datastore)) {
+ $this->_links = unserialize(gzinflate(base64_decode(
+ substr(file_get_contents($this->_datastore),
+ strlen(self::$phpPrefix), -strlen(self::$phpSuffix)))));
}
// If user is not logged in, filter private links.
- if (!$this->loggedIn) {
+ if (!$this->_loggedIn) {
$toremove = array();
- foreach ($this->links as $link) {
+ foreach ($this->_links as $link) {
if ($link['private'] != 0) {
$toremove[] = $link['linkdate'];
}
}
foreach ($toremove as $linkdate) {
- unset($this->links[$linkdate]);
+ unset($this->_links[$linkdate]);
}
}
// Keep the list of the mapping URLs-->linkdate up-to-date.
- $this->urls = array();
- foreach ($this->links as $link) {
- $this->urls[$link['url']] = $link['linkdate'];
+ $this->_urls = array();
+ foreach ($this->_links as $link) {
+ $this->_urls[$link['url']] = $link['linkdate'];
+ }
+
+ // Escape links data
+ foreach($this->_links as &$link) {
+ sanitizeLink($link);
}
}
/**
* Saves the database from memory to disk
+ *
+ * @param string $pageCacheDir page cache directory
*/
- public function savedb()
+ public function savedb($pageCacheDir)
{
- if (!$this->loggedIn) {
+ if (!$this->_loggedIn) {
// TODO: raise an Exception instead
die('You are not authorized to change the database.');
}
file_put_contents(
- $GLOBALS['config']['DATASTORE'],
- PHPPREFIX.base64_encode(gzdeflate(serialize($this->links))).PHPSUFFIX
+ $this->_datastore,
+ self::$phpPrefix.base64_encode(gzdeflate(serialize($this->_links))).self::$phpSuffix
);
- invalidateCaches();
+ invalidateCaches($pageCacheDir);
}
/**
*/
public function getLinkFromUrl($url)
{
- if (isset($this->urls[$url])) {
- return $this->links[$this->urls[$url]];
+ if (isset($this->_urls[$url])) {
+ return $this->_links[$this->_urls[$url]];
}
return false;
}
// FIXME: accept double-quotes to search for a string "as is"?
$filtered = array();
$search = mb_convert_case($searchterms, MB_CASE_LOWER, 'UTF-8');
- $keys = ['title', 'description', 'url', 'tags'];
+ $keys = array('title', 'description', 'url', 'tags');
- foreach ($this->links as $link) {
+ foreach ($this->_links as $link) {
$found = false;
foreach ($keys as $key) {
$searchtags = explode(' ', $t);
$filtered = array();
- foreach ($this->links as $l) {
+ foreach ($this->_links as $l) {
$linktags = explode(
' ',
($casesensitive ? $l['tags']:mb_convert_case($l['tags'], MB_CASE_LOWER, 'UTF-8'))
*/
public function filterDay($day)
{
- // TODO: check input format
+ if (! checkDateFormat('Ymd', $day)) {
+ throw new Exception('Invalid date format');
+ }
+
$filtered = array();
- foreach ($this->links as $l) {
+ foreach ($this->_links as $l) {
if (startsWith($l['linkdate'], $day)) {
$filtered[$l['linkdate']] = $l;
}
public function filterSmallHash($smallHash)
{
$filtered = array();
- foreach ($this->links as $l) {
+ foreach ($this->_links as $l) {
if ($smallHash == smallHash($l['linkdate'])) {
// Yes, this is ugly and slow
$filtered[$l['linkdate']] = $l;
public function allTags()
{
$tags = array();
- foreach ($this->links as $link) {
+ foreach ($this->_links as $link) {
foreach (explode(' ', $link['tags']) as $tag) {
if (!empty($tag)) {
$tags[$tag] = (empty($tags[$tag]) ? 1 : $tags[$tag] + 1);
public function days()
{
$linkDays = array();
- foreach (array_keys($this->links) as $day) {
+ foreach (array_keys($this->_links) as $day) {
$linkDays[substr($day, 0, 8)] = 0;
}
$linkDays = array_keys($linkDays);
return $linkDays;
}
}
-?>
projects / github / shaarli / Shaarli.git / blobdiff