* - 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;
// 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 = '<?php /* ';
// 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 $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($datastore, $isLoggedIn, $hidePublicLinks)
+ function __construct($datastore, $isLoggedIn, $hidePublicLinks, $redirector = '')
{
$this->_datastore = $datastore;
$this->_loggedIn = $isLoggedIn;
$this->_hidePublicLinks = $hidePublicLinks;
+ $this->_redirector = $redirector;
$this->_checkDB();
$this->_readDB();
}
$this->_links[$link['linkdate']] = $link;
// Write database to disk
- // TODO: raise an exception if the file is not write-able
- file_put_contents(
- $this->_datastore,
- self::$phpPrefix.base64_encode(gzdeflate(serialize($this->_links))).self::$phpSuffix
- );
+ $this->writeDB();
}
/**
}
}
- // Keep the list of the mapping URLs-->linkdate up-to-date.
$this->_urls = array();
- foreach ($this->_links as $link) {
+ foreach ($this->_links as &$link) {
+ // Keep the list of the mapping URLs-->linkdate up-to-date.
$this->_urls[$link['url']] = $link['linkdate'];
- }
- // Escape links data
- foreach($this->_links as &$link) {
- sanitizeLink($link);
+ // Sanitize data fields.
+ sanitizeLink($link);
+
+ // Remove private tags if the user is not logged in.
+ if (! $this->_loggedIn) {
+ $link['tags'] = preg_replace('/(^| )\.[^($| )]+/', '', $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 . urlencode($link['url']);
+ }
+ else {
+ $link['real_url'] = $link['url'];
+ }
}
}
/**
* Saves the database from memory to disk
*
- * @param string $pageCacheDir page cache directory
+ * @throws IOException the datastore is not writable
*/
- public function savedb($pageCacheDir)
+ 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(
$this->_datastore,
self::$phpPrefix.base64_encode(gzdeflate(serialize($this->_links))).self::$phpSuffix
);
- invalidateCaches($pageCacheDir);
- }
- /**
- * 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();
+ $this->writeDB();
- 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;
+ 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.
+ *
+ * @param string $url URL to search for
*
- * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g.
- * print_r($mydb->filterDay('20120125'));
+ * @return mixed the existing link if it exists, else 'false'
*/
- public function filterDay($day)
+ public function getLinkFromUrl($url)
{
- if (! checkDateFormat('Ymd', $day)) {
- throw new Exception('Invalid date 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);
}
/**
}
$linkDays = array_keys($linkDays);
sort($linkDays);
+
return $linkDays;
}
}
projects / github / shaarli / Shaarli.git / blobdiff