X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=application%2FLinkDB.php;h=416aa0d3051a92e6f092ce3314612d0f811d3d5e;hb=21979ff11ceee0042642ac17147858a4155d54c5;hp=cf91ad481ddb84db88da8ed312b3c9ba0a7b3858;hpb=ddfc400465d7f3bef8fce83ccca755df58a79ea0;p=github%2Fshaarli%2FShaarli.git diff --git a/application/LinkDB.php b/application/LinkDB.php index cf91ad48..416aa0d3 100644 --- a/application/LinkDB.php +++ b/application/LinkDB.php @@ -17,8 +17,10 @@ * - private: Is this link private? 0=no, other value=yes * - tags: tags attached to this entry (separated by spaces) * - title Title of the link - * - url URL of the link. Can be absolute or relative. + * - url URL of the link. Used for displayable links (no redirector, relative, etc.). + * Can be absolute or relative. * Relative URLs are permalinks (e.g.'?m-ukcw') + * - real_url Absolute processed URL. * * Implements 3 interfaces: * - ArrayAccess: behaves like an associative array; @@ -27,41 +29,57 @@ */ class LinkDB implements Iterator, Countable, ArrayAccess { + // Links are stored as a PHP serialized string + private $_datastore; + + // Datastore PHP prefix + protected static $phpPrefix = ''; + // 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; + private $_hidePublicLinks; + + // link redirector set in user settings. + private $_redirector; /** * Creates a new LinkDB * * Checks if the datastore exists; else, attempts to create a dummy one. * - * @param $isLoggedIn is the user logged in? + * @param string $datastore datastore file path. + * @param boolean $isLoggedIn is the user logged in? + * @param boolean $hidePublicLinks if true all links are private. + * @param string $redirector link redirector set in user settings. */ - function __construct($isLoggedIn, $hidePublicLinks) + function __construct($datastore, $isLoggedIn, $hidePublicLinks, $redirector = '') { - // FIXME: do not access $GLOBALS, pass the datastore instead - $this->loggedIn = $isLoggedIn; - $this->hidePublicLinks = $hidePublicLinks; - $this->checkDB(); - $this->readdb(); + $this->_datastore = $datastore; + $this->_loggedIn = $isLoggedIn; + $this->_hidePublicLinks = $hidePublicLinks; + $this->_redirector = $redirector; + $this->_checkDB(); + $this->_readDB(); } /** @@ -69,7 +87,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ public function count() { - return count($this->links); + return count($this->_links); } /** @@ -78,7 +96,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess 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'])) { @@ -87,8 +105,8 @@ class LinkDB implements Iterator, Countable, ArrayAccess 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; } /** @@ -96,7 +114,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ public function offsetExists($offset) { - return array_key_exists($offset, $this->links); + return array_key_exists($offset, $this->_links); } /** @@ -104,13 +122,13 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ 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]); } /** @@ -118,7 +136,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ public function offsetGet($offset) { - return isset($this->links[$offset]) ? $this->links[$offset] : null; + return isset($this->_links[$offset]) ? $this->_links[$offset] : null; } /** @@ -126,7 +144,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function current() { - return $this->links[$this->keys[$this->position]]; + return $this->_links[$this->_keys[$this->_position]]; } /** @@ -134,7 +152,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function key() { - return $this->keys[$this->position]; + return $this->_keys[$this->_position]; } /** @@ -142,7 +160,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function next() { - ++$this->position; + ++$this->_position; } /** @@ -152,9 +170,9 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ 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; } /** @@ -162,7 +180,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function valid() { - return isset($this->keys[$this->position]); + return isset($this->_keys[$this->_position]); } /** @@ -170,225 +188,163 @@ class LinkDB implements Iterator, Countable, ArrayAccess * * 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->writeDB(); } /** * 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 ($this->hidePublicLinks && !$this->loggedIn) { - $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']; - } - - // Escape links data - foreach($this->links as &$link) { - sanitizeLink($link); + $this->_urls = array(); + foreach ($this->_links as &$link) { + // Keep the list of the mapping URLs-->linkdate up-to-date. + $this->_urls[$link['url']] = $link['linkdate']; + // Sanitize data fields. + sanitizeLink($link); + // Do not use the redirector for internal links (Shaarli note URL starting with a '?'). + if (!empty($this->_redirector) && !startsWith($link['url'], '?')) { + $link['real_url'] = $this->_redirector . urlencode($link['url']); + } + else { + $link['real_url'] = $link['url']; + } } } /** * Saves the database from memory to disk + * + * @throws IOException the datastore is not writable */ - public function savedb() + private function writeDB() { - if (!$this->loggedIn) { - // TODO: raise an Exception instead - die('You are not authorized to change the database.'); + if (is_file($this->_datastore) && !is_writeable($this->_datastore)) { + // The datastore exists but is not writeable + throw new IOException($this->_datastore); + } else if (!is_file($this->_datastore) && !is_writeable(dirname($this->_datastore))) { + // The datastore does not exist and its parent directory is not writeable + throw new IOException(dirname($this->_datastore)); } + 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(); - } - /** - * Returns the link for a given URL, or False if it does not exist. - */ - public function getLinkFromUrl($url) - { - if (isset($this->urls[$url])) { - return $this->links[$this->urls[$url]]; - } - return false; } /** - * Returns the list of links corresponding to a full-text search - * - * Searches: - * - in the URLs, title and description; - * - are case-insensitive. - * - * Example: - * print_r($mydb->filterFulltext('hollandais')); + * Saves the database from memory to disk * - * mb_convert_case($val, MB_CASE_LOWER, 'UTF-8') - * - allows to perform searches on Unicode text - * - see https://github.com/shaarli/Shaarli/issues/75 for examples + * @param string $pageCacheDir page cache directory */ - public function filterFulltext($searchterms) + public function savedb($pageCacheDir) { - // FIXME: explode(' ',$searchterms) and perform a AND search. - // FIXME: accept double-quotes to search for a string "as is"? - $filtered = array(); - $search = mb_convert_case($searchterms, MB_CASE_LOWER, 'UTF-8'); - $keys = array('title', 'description', 'url', 'tags'); - - foreach ($this->links as $link) { - $found = false; - - foreach ($keys as $key) { - if (strpos(mb_convert_case($link[$key], MB_CASE_LOWER, 'UTF-8'), - $search) !== false) { - $found = true; - } - } - - if ($found) { - $filtered[$link['linkdate']] = $link; - } + if (!$this->_loggedIn) { + // TODO: raise an Exception instead + die('You are not authorized to change the database.'); } - krsort($filtered); - return $filtered; - } - - /** - * Returns the list of links associated with a given list of tags - * - * You can specify one or more tags, separated by space or a comma, e.g. - * print_r($mydb->filterTags('linux programming')); - */ - public function filterTags($tags, $casesensitive=false) - { - // Same as above, we use UTF-8 conversion to handle various graphemes (i.e. cyrillic, or greek) - // FIXME: is $casesensitive ever true? - $t = str_replace( - ',', ' ', - ($casesensitive ? $tags : mb_convert_case($tags, MB_CASE_LOWER, 'UTF-8')) - ); - - $searchtags = explode(' ', $t); - $filtered = array(); - foreach ($this->links as $l) { - $linktags = explode( - ' ', - ($casesensitive ? $l['tags']:mb_convert_case($l['tags'], MB_CASE_LOWER, 'UTF-8')) - ); + $this->writeDB(); - if (count(array_intersect($linktags, $searchtags)) == count($searchtags)) { - $filtered[$l['linkdate']] = $l; - } - } - krsort($filtered); - return $filtered; + invalidateCaches($pageCacheDir); } - /** - * Returns the list of articles for a given day, chronologically sorted + * Returns the link for a given URL, or False if it does not exist. * - * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g. - * print_r($mydb->filterDay('20120125')); + * @param string $url URL to search for + * + * @return mixed the existing link if it exists, else 'false' */ - public function filterDay($day) + public function getLinkFromUrl($url) { - // TODO: check input format - $filtered = array(); - foreach ($this->links as $l) { - if (startsWith($l['linkdate'], $day)) { - $filtered[$l['linkdate']] = $l; - } + if (isset($this->_urls[$url])) { + return $this->_links[$this->_urls[$url]]; } - ksort($filtered); - return $filtered; + return false; } /** - * Returns the article corresponding to a smallHash + * Filter links. + * + * @param string $type Type of filter. + * @param mixed $request Search request, string or array. + * @param bool $casesensitive Optional: Perform case sensitive filter + * @param bool $privateonly Optional: Returns private links only if true. + * + * @return array filtered links */ - public function filterSmallHash($smallHash) + public function filter($type = '', $request = '', $casesensitive = false, $privateonly = false) { - $filtered = array(); - foreach ($this->links as $l) { - if ($smallHash == smallHash($l['linkdate'])) { - // Yes, this is ugly and slow - $filtered[$l['linkdate']] = $l; - return $filtered; - } - } - return $filtered; + $linkFilter = new LinkFilter($this->_links); + $requestFilter = is_array($request) ? implode(' ', $request) : $request; + return $linkFilter->filter($type, trim($requestFilter), $casesensitive, $privateonly); } /** @@ -398,7 +354,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess 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); @@ -417,12 +373,12 @@ class LinkDB implements Iterator, Countable, ArrayAccess 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); sort($linkDays); + return $linkDays; } } -?>