*
* 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;
// 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;
+
+ /**
+ * 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($datastore, $isLoggedIn, $hidePublicLinks)
+ function __construct(
+ $datastore,
+ $isLoggedIn,
+ $hidePublicLinks,
+ $redirector = '',
+ $redirectorEncode = true
+ )
{
$this->datastore = $datastore;
$this->loggedIn = $isLoggedIn;
$this->hidePublicLinks = $hidePublicLinks;
+ $this->redirector = $redirector;
+ $this->redirectorEncode = $redirectorEncode === true;
$this->checkDB();
- $this->readdb();
+ $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();
}
/**
* Reads database from disk to memory
*/
- private function readdb()
+ private function readDB()
{
// Public links are hidden and user not logged in => nothing to show
}
}
- // 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('/(^|\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(
$this->datastore,
self::$phpPrefix.base64_encode(gzdeflate(serialize($this->links))).self::$phpSuffix
);
- invalidateCaches();
+
+ }
+
+ /**
+ * 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)
{
}
/**
- * Returns the list of links corresponding to a full-text search
+ * Returns the shaare corresponding to a smallHash.
*
- * Searches:
- * - in the URLs, title and description;
- * - are case-insensitive.
+ * @param string $request QUERY_STRING server parameter.
*
- * Example:
- * print_r($mydb->filterFulltext('hollandais'));
+ * @return array $filtered array containing permalink data.
*
- * 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
+ * @throws LinkNotFoundException if the smallhash is malformed or doesn't match any link.
*/
- public function filterFulltext($searchterms)
+ public function filterHash($request)
{
- // 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;
- }
- }
- 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 links associated with a given list of tags
+ * Returns the list of articles for a given day.
*
- * You can specify one or more tags, separated by space or a comma, e.g.
- * print_r($mydb->filterTags('linux programming'));
+ * @param string $request day to filter. Format: YYYYMMDD.
+ *
+ * @return array list of shaare found.
*/
- 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'))
- );
-
- if (count(array_intersect($linktags, $searchtags)) == count($searchtags)) {
- $filtered[$l['linkdate']] = $l;
- }
- }
- krsort($filtered);
- return $filtered;
+ public function filterDay($request) {
+ $linkFilter = new LinkFilter($this->links);
+ return $linkFilter->filter(LinkFilter::$FILTER_DAY, $request);
}
-
/**
- * Returns the list of articles for a given day, chronologically sorted
+ * Filter links according to search parameters.
*
- * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g.
- * print_r($mydb->filterDay('20120125'));
+ * @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 filterDay($day)
+ public function filterSearch($filterRequest = array(), $casesensitive = false, $privateonly = false)
{
- if (! checkDateFormat('Ymd', $day)) {
- throw new Exception('Invalid date format');
+ // 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);
}
-
- $filtered = array();
- foreach ($this->links as $l) {
- if (startsWith($l['linkdate'], $day)) {
- $filtered[$l['linkdate']] = $l;
- }
+ // Search by tags.
+ elseif (! empty($searchtags)) {
+ $type = LinkFilter::$FILTER_TAG;
+ $request = $searchtags;
}
- ksort($filtered);
- return $filtered;
- }
-
- /**
- * Returns the article corresponding to a smallHash
- */
- public function filterSmallHash($smallHash)
- {
- $filtered = array();
- foreach ($this->links as $l) {
- if ($smallHash == smallHash($l['linkdate'])) {
- // Yes, this is ugly and slow
- $filtered[$l['linkdate']] = $l;
- return $filtered;
- }
+ // 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);
}
/**
public function allTags()
{
$tags = array();
+ $caseMapping = array();
foreach ($this->links as $link) {
- foreach (explode(' ', $link['tags']) as $tag) {
- if (!empty($tag)) {
- $tags[$tag] = (empty($tags[$tag]) ? 1 : $tags[$tag] + 1);
+ 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)
}
$linkDays = array_keys($linkDays);
sort($linkDays);
+
return $linkDays;
}
}
-?>
projects / github / shaarli / Shaarli.git / blobdiff