123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386 |
- <?php
- /**
- * Data storage for links.
- *
- * This object behaves like an associative array.
- *
- * Example:
- * $myLinks = new LinkDB();
- * echo $myLinks['20110826_161819']['title'];
- * foreach ($myLinks as $link)
- * echo $link['title'].' at url '.$link['url'].'; description:'.$link['description'];
- *
- * Available keys:
- * - description: description of the entry
- * - linkdate: date of the creation of this entry, in the form YYYYMMDD_HHMMSS
- * (e.g.'20110914_192317')
- * - 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. 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;
- * - Countable: there is a count() method;
- * - Iterator: usable in foreach () loops.
- */
- 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;
- // List of all recorded URLs (key=url, value=linkdate)
- // for fast reserve search (url-->linkdate)
- private $_urls;
- // List of linkdate keys (for the Iterator interface implementation)
- private $_keys;
- // Position in the $this->_keys array (for the Iterator interface)
- private $_position;
- // Is the user logged in? (used to filter private links)
- private $_loggedIn;
- // Hide public links
- 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 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($datastore, $isLoggedIn, $hidePublicLinks, $redirector = '')
- {
- $this->_datastore = $datastore;
- $this->_loggedIn = $isLoggedIn;
- $this->_hidePublicLinks = $hidePublicLinks;
- $this->_redirector = $redirector;
- $this->_checkDB();
- $this->_readDB();
- }
- /**
- * Countable - Counts elements of an object
- */
- public function count()
- {
- return count($this->_links);
- }
- /**
- * ArrayAccess - Assigns a value to the specified offset
- */
- public function offsetSet($offset, $value)
- {
- // TODO: use exceptions instead of "die"
- if (!$this->_loggedIn) {
- die('You are not authorized to add a link.');
- }
- if (empty($value['linkdate']) || empty($value['url'])) {
- die('Internal Error: A link should always have a linkdate and URL.');
- }
- if (empty($offset)) {
- die('You must specify a key.');
- }
- $this->_links[$offset] = $value;
- $this->_urls[$value['url']]=$offset;
- }
- /**
- * ArrayAccess - Whether or not an offset exists
- */
- public function offsetExists($offset)
- {
- return array_key_exists($offset, $this->_links);
- }
- /**
- * ArrayAccess - Unsets an offset
- */
- public function offsetUnset($offset)
- {
- 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]);
- }
- /**
- * ArrayAccess - Returns the value at specified offset
- */
- public function offsetGet($offset)
- {
- return isset($this->_links[$offset]) ? $this->_links[$offset] : null;
- }
- /**
- * Iterator - Returns the current element
- */
- function current()
- {
- return $this->_links[$this->_keys[$this->_position]];
- }
- /**
- * Iterator - Returns the key of the current element
- */
- function key()
- {
- return $this->_keys[$this->_position];
- }
- /**
- * Iterator - Moves forward to next element
- */
- function next()
- {
- ++$this->_position;
- }
- /**
- * Iterator - Rewinds the Iterator to the first element
- *
- * Entries are sorted by date (latest first)
- */
- function rewind()
- {
- $this->_keys = array_keys($this->_links);
- rsort($this->_keys);
- $this->_position = 0;
- }
- /**
- * Iterator - Checks if current position is valid
- */
- function valid()
- {
- return isset($this->_keys[$this->_position]);
- }
- /**
- * Checks if the DB directory and file exist
- *
- * If no DB file is found, creates a dummy DB.
- */
- private function _checkDB()
- {
- if (file_exists($this->_datastore)) {
- return;
- }
- // Create a dummy database for example
- $this->_links = array();
- $link = array(
- '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'=> date('Ymd_His'),
- 'tags'=>'opensource software'
- );
- $this->_links[$link['linkdate']] = $link;
- $link = array(
- 'title'=>'My secret stuff... - Pastebin.com',
- 'url'=>'http://sebsauvage.net/paste/?8434b27936c09649#bR7XsXhoTiLcqCpQbmOpBi3rq2zzQUC5hBI7ZT1O3x8=',
- 'description'=>'Shhhh! I\'m a private link only YOU can see. You can delete me too.',
- 'private'=>1,
- 'linkdate'=> date('Ymd_His', strtotime('-1 minute')),
- 'tags'=>'secretstuff'
- );
- $this->_links[$link['linkdate']] = $link;
- // Write database to disk
- $this->writeDB();
- }
- /**
- * Reads database from disk to memory
- */
- 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
- $this->_links = array();
- 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) {
- $toremove = array();
- foreach ($this->_links as $link) {
- if ($link['private'] != 0) {
- $toremove[] = $link['linkdate'];
- }
- }
- foreach ($toremove as $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);
- // 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
- */
- private function writeDB()
- {
- 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(
- $this->_datastore,
- self::$phpPrefix.base64_encode(gzdeflate(serialize($this->_links))).self::$phpSuffix
- );
- }
- /**
- * Saves the database from memory to disk
- *
- * @param string $pageCacheDir page cache directory
- */
- public function savedb($pageCacheDir)
- {
- if (!$this->_loggedIn) {
- // TODO: raise an Exception instead
- die('You are not authorized to change the database.');
- }
- $this->writeDB();
- invalidateCaches($pageCacheDir);
- }
- /**
- * Returns the link for a given URL, or False if it does not exist.
- *
- * @param string $url URL to search for
- *
- * @return mixed the existing link if it exists, else 'false'
- */
- public function getLinkFromUrl($url)
- {
- if (isset($this->_urls[$url])) {
- return $this->_links[$this->_urls[$url]];
- }
- return false;
- }
- /**
- * 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 filter($type, $request, $casesensitive = false, $privateonly = false)
- {
- $linkFilter = new LinkFilter($this->_links);
- $requestFilter = is_array($request) ? implode(' ', $request) : $request;
- return $linkFilter->filter($type, trim($requestFilter), $casesensitive, $privateonly);
- }
- /**
- * Returns the list of all tags
- * Output: associative array key=tags, value=0
- */
- 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);
- }
- }
- }
- // Sort tags by usage (most used tag first)
- arsort($tags);
- return $tags;
- }
- /**
- * Returns the list of days containing articles (oldest first)
- * Output: An array containing days (in format YYYYMMDD).
- */
- public function days()
- {
- $linkDays = array();
- foreach (array_keys($this->_links) as $day) {
- $linkDays[substr($day, 0, 8)] = 0;
- }
- $linkDays = array_keys($linkDays);
- sort($linkDays);
- return $linkDays;
- }
- }
|