X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=application%2FLinkDB.php;h=de9e73b02dfc09f350fca0977493b8177a536b3a;hb=954dc2446caade6ccad3ffd1173ef139c1f36ad3;hp=388002f666eff8f80608fd31a4d3423b80da6f57;hpb=ca74886f30da323f42aa4bd70461003f46ef299b;p=github%2Fshaarli%2FShaarli.git diff --git a/application/LinkDB.php b/application/LinkDB.php index 388002f6..de9e73b0 100644 --- a/application/LinkDB.php +++ b/application/LinkDB.php @@ -12,13 +12,16 @@ * * Available keys: * - description: description of the entry - * - linkdate: date of the creation of this entry, in the form YYYYMMDD_HHMMSS + * - linkdate: creation date of this entry, format: YYYYMMDD_HHMMSS * (e.g.'20110914_192317') + * - updated: last modification date of this entry, format: YYYYMMDD_HHMMSS * - 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,37 +30,78 @@ */ class LinkDB implements Iterator, Countable, ArrayAccess { + // Links are stored as a PHP serialized string + private $_datastore; + + // Link date storage format + const LINK_DATE_FORMAT = 'Ymd_His'; + + // 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; + + // link redirector set in user settings. + private $_redirector; + + /** + * Set this to `true` to urlencode link behind redirector link, `false` to leave it untouched. + * + * Example: + * anonym.to needs clean URL while dereferer.org needs urlencoded URL. + * + * @var boolean $redirectorEncode parameter: true or false + */ + private $redirectorEncode; /** * 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. + * @param boolean $redirectorEncode Enable urlencode on redirected urls (default: true). */ - function __construct($isLoggedIn) + function __construct( + $datastore, + $isLoggedIn, + $hidePublicLinks, + $redirector = '', + $redirectorEncode = true + ) { - // 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->_redirector = $redirector; + $this->redirectorEncode = $redirectorEncode === true; + $this->_checkDB(); + $this->_readDB(); } /** @@ -65,7 +109,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ public function count() { - return count($this->links); + return count($this->_links); } /** @@ -74,7 +118,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'])) { @@ -83,8 +127,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; } /** @@ -92,7 +136,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); } /** @@ -100,13 +144,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]); } /** @@ -114,7 +158,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; } /** @@ -122,7 +166,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function current() { - return $this->links[$this->keys[$this->position]]; + return $this->_links[$this->_keys[$this->_position]]; } /** @@ -130,7 +174,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function key() { - return $this->keys[$this->position]; + return $this->_keys[$this->_position]; } /** @@ -138,7 +182,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function next() { - ++$this->position; + ++$this->_position; } /** @@ -148,9 +192,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; } /** @@ -158,7 +202,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess */ function valid() { - return isset($this->keys[$this->position]); + return isset($this->_keys[$this->_position]); } /** @@ -166,213 +210,228 @@ 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(); + 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) { + // Keep the list of the mapping URLs-->linkdate up-to-date. + $this->_urls[$link['url']] = $link['linkdate']; + + // Sanitize data fields. + sanitizeLink($link); + + // Remove private tags if the user is not logged in. + if (! $this->_loggedIn) { + $link['tags'] = preg_replace('/(^|\s+)\.[^($|\s)]+\s*/', ' ', $link['tags']); + } + + // 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; + if ($this->redirectorEncode) { + $link['real_url'] .= urlencode(unescape($link['url'])); + } else { + $link['real_url'] .= $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. + * Saves the database from memory to disk + * + * @param string $pageCacheDir page cache directory */ - public function getLinkFromUrl($url) + public function savedb($pageCacheDir) { - if (isset($this->urls[$url])) { - return $this->links[$this->urls[$url]]; + if (!$this->_loggedIn) { + // TODO: raise an Exception instead + die('You are not authorized to change the database.'); } - return false; + + $this->writeDB(); + + invalidateCaches($pageCacheDir); } /** - * Returns the list of links corresponding to a full-text search - * - * Searches: - * - in the URLs, title and description; - * - are case-insensitive. + * Returns the link for a given URL, or False if it does not exist. * - * Example: - * print_r($mydb->filterFulltext('hollandais')); + * @param string $url URL to search for * - * 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 + * @return mixed the existing link if it exists, else 'false' */ - public function filterFulltext($searchterms) + public function getLinkFromUrl($url) { - // 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 = ['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 (isset($this->_urls[$url])) { + return $this->_links[$this->_urls[$url]]; } - krsort($filtered); - return $filtered; + return false; } /** - * Returns the list of links associated with a given list of tags + * Returns the shaare corresponding to a smallHash. * - * You can specify one or more tags, separated by space or a comma, e.g. - * print_r($mydb->filterTags('linux programming')); + * @param string $request QUERY_STRING server parameter. + * + * @return array $filtered array containing permalink data. + * + * @throws LinkNotFoundException if the smallhash is malformed or doesn't match any link. */ - public function filterTags($tags, $casesensitive=false) + public function filterHash($request) { - // 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')) - ); - - if (count(array_intersect($linktags, $searchtags)) == count($searchtags)) { - $filtered[$l['linkdate']] = $l; - } - } - krsort($filtered); - return $filtered; + $request = substr($request, 0, 6); + $linkFilter = new LinkFilter($this->_links); + return $linkFilter->filter(LinkFilter::$FILTER_HASH, $request); } - /** - * Returns the list of articles for a given day, chronologically sorted + * Returns the list of articles for a given day. * - * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g. - * print_r($mydb->filterDay('20120125')); + * @param string $request day to filter. Format: YYYYMMDD. + * + * @return array list of shaare found. */ - public function filterDay($day) - { - // TODO: check input format - $filtered = array(); - foreach ($this->links as $l) { - if (startsWith($l['linkdate'], $day)) { - $filtered[$l['linkdate']] = $l; - } - } - ksort($filtered); - return $filtered; + public function filterDay($request) { + $linkFilter = new LinkFilter($this->_links); + return $linkFilter->filter(LinkFilter::$FILTER_DAY, $request); } /** - * Returns the article corresponding to a smallHash + * Filter links according to search parameters. + * + * @param array $filterRequest Search request content. Supported keys: + * - searchtags: list of tags + * - searchterm: term search + * @param bool $casesensitive Optional: Perform case sensitive filter + * @param bool $privateonly Optional: Returns private links only if true. + * + * @return array filtered links, all links if no suitable filter was provided. */ - public function filterSmallHash($smallHash) + public function filterSearch($filterRequest = array(), $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; - } + // Filter link database according to parameters. + $searchtags = !empty($filterRequest['searchtags']) ? escape($filterRequest['searchtags']) : ''; + $searchterm = !empty($filterRequest['searchterm']) ? escape($filterRequest['searchterm']) : ''; + + // Search tags + fullsearch. + if (! empty($searchtags) && ! empty($searchterm)) { + $type = LinkFilter::$FILTER_TAG | LinkFilter::$FILTER_TEXT; + $request = array($searchtags, $searchterm); + } + // Search by tags. + elseif (! empty($searchtags)) { + $type = LinkFilter::$FILTER_TAG; + $request = $searchtags; + } + // Fulltext search. + elseif (! empty($searchterm)) { + $type = LinkFilter::$FILTER_TEXT; + $request = $searchterm; } - return $filtered; + // Otherwise, display without filtering. + else { + $type = ''; + $request = ''; + } + + $linkFilter = new LinkFilter($this->_links); + return $linkFilter->filter($type, $request, $casesensitive, $privateonly); } /** @@ -382,11 +441,18 @@ class LinkDB implements Iterator, Countable, ArrayAccess public function allTags() { $tags = array(); - foreach ($this->links as $link) { - foreach (explode(' ', $link['tags']) as $tag) { - if (!empty($tag)) { - $tags[$tag] = (empty($tags[$tag]) ? 1 : $tags[$tag] + 1); + $caseMapping = array(); + foreach ($this->_links as $link) { + foreach (preg_split('/\s+/', $link['tags'], 0, PREG_SPLIT_NO_EMPTY) as $tag) { + if (empty($tag)) { + continue; } + // The first case found will be displayed. + if (!isset($caseMapping[strtolower($tag)])) { + $caseMapping[strtolower($tag)] = $tag; + $tags[$caseMapping[strtolower($tag)]] = 0; + } + $tags[$caseMapping[strtolower($tag)]]++; } } // Sort tags by usage (most used tag first) @@ -401,12 +467,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; } } -?>