*
* 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
class LinkDB implements Iterator, Countable, ArrayAccess
{
// Links are stored as a PHP serialized string
- private $_datastore;
+ private $datastore;
+
+ // Link date storage format
+ const LINK_DATE_FORMAT = 'Ymd_His';
// Datastore PHP prefix
protected static $phpPrefix = '<?php /* ';
// 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;
+ 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 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 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, $redirector = '')
+ public function __construct(
+ $datastore,
+ $isLoggedIn,
+ $hidePublicLinks,
+ $redirector = '',
+ $redirectorEncode = true
+ )
{
- $this->_datastore = $datastore;
- $this->_loggedIn = $isLoggedIn;
- $this->_hidePublicLinks = $hidePublicLinks;
- $this->_redirector = $redirector;
- $this->_checkDB();
- $this->_readDB();
+ $this->datastore = $datastore;
+ $this->loggedIn = $isLoggedIn;
+ $this->hidePublicLinks = $hidePublicLinks;
+ $this->redirector = $redirector;
+ $this->redirectorEncode = $redirectorEncode === true;
+ $this->check();
+ $this->read();
}
/**
*/
public function count()
{
- return count($this->_links);
+ return count($this->links);
}
/**
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'])) {
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;
}
/**
*/
public function offsetExists($offset)
{
- return array_key_exists($offset, $this->_links);
+ return array_key_exists($offset, $this->links);
}
/**
*/
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]);
}
/**
*/
public function offsetGet($offset)
{
- return isset($this->_links[$offset]) ? $this->_links[$offset] : null;
+ return isset($this->links[$offset]) ? $this->links[$offset] : null;
}
/**
* Iterator - Returns the current element
*/
- function current()
+ public function current()
{
- return $this->_links[$this->_keys[$this->_position]];
+ return $this->links[$this->keys[$this->position]];
}
/**
* Iterator - Returns the key of the current element
*/
- function key()
+ public function key()
{
- return $this->_keys[$this->_position];
+ return $this->keys[$this->position];
}
/**
* Iterator - Moves forward to next element
*/
- function next()
+ public function next()
{
- ++$this->_position;
+ ++$this->position;
}
/**
*
* Entries are sorted by date (latest first)
*/
- function rewind()
+ public 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;
}
/**
* Iterator - Checks if current position is valid
*/
- function valid()
+ public function valid()
{
- return isset($this->_keys[$this->_position]);
+ return isset($this->keys[$this->position]);
}
/**
*
* If no DB file is found, creates a dummy DB.
*/
- private function _checkDB()
+ private function check()
{
- if (file_exists($this->_datastore)) {
+ if (file_exists($this->datastore)) {
return;
}
// Create a dummy database for example
- $this->_links = array();
+ $this->links = array();
$link = array(
'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone',
'url'=>'https://github.com/shaarli/Shaarli/wiki',
'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',
'linkdate'=> date('Ymd_His', strtotime('-1 minute')),
'tags'=>'secretstuff'
);
- $this->_links[$link['linkdate']] = $link;
+ $this->links[$link['linkdate']] = $link;
// Write database to disk
- $this->writeDB();
+ $this->write();
}
/**
* Reads database from disk to memory
*/
- private function _readDB()
+ private function read()
{
// 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
- $this->_links = array();
+ $this->links = array();
- if (file_exists($this->_datastore)) {
- $this->_links = unserialize(gzinflate(base64_decode(
- substr(file_get_contents($this->_datastore),
+ 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]);
}
}
- $this->_urls = array();
- foreach ($this->_links as &$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'];
+ $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 . urlencode($link['url']);
+ 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'];
*
* @throws IOException the datastore is not writable
*/
- private function writeDB()
+ private function write()
{
- if (is_file($this->_datastore) && !is_writeable($this->_datastore)) {
+ 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))) {
+ 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));
+ throw new IOException(dirname($this->datastore));
}
file_put_contents(
- $this->_datastore,
- self::$phpPrefix.base64_encode(gzdeflate(serialize($this->_links))).self::$phpSuffix
+ $this->datastore,
+ self::$phpPrefix.base64_encode(gzdeflate(serialize($this->links))).self::$phpSuffix
);
}
*
* @param string $pageCacheDir page cache directory
*/
- public function savedb($pageCacheDir)
+ public function save($pageCacheDir)
{
- if (!$this->_loggedIn) {
+ if (!$this->loggedIn) {
// TODO: raise an Exception instead
die('You are not authorized to change the database.');
}
- $this->writeDB();
+ $this->write();
invalidateCaches($pageCacheDir);
}
*/
public function getLinkFromUrl($url)
{
- if (isset($this->_urls[$url])) {
- return $this->_links[$this->_urls[$url]];
+ if (isset($this->urls[$url])) {
+ return $this->links[$this->urls[$url]];
}
return false;
}
/**
- * Filter links.
+ * Returns the shaare corresponding to a smallHash.
+ *
+ * @param string $request QUERY_STRING server parameter.
*
- * @param string $type Type of filter.
- * @param mixed $request Search request, string or array.
+ * @return array $filtered array containing permalink data.
+ *
+ * @throws LinkNotFoundException if the smallhash is malformed or doesn't match any link.
+ */
+ public function filterHash($request)
+ {
+ $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.
+ *
+ * @param string $request day to filter. Format: YYYYMMDD.
+ *
+ * @return array list of shaare found.
+ */
+ public function filterDay($request) {
+ $linkFilter = new LinkFilter($this->links);
+ return $linkFilter->filter(LinkFilter::$FILTER_DAY, $request);
+ }
+
+ /**
+ * 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
+ * @return array filtered links, all links if no suitable filter was provided.
*/
- public function filter($type = '', $request = '', $casesensitive = false, $privateonly = false)
+ public function filterSearch($filterRequest = array(), $casesensitive = false, $privateonly = false)
{
- $linkFilter = new LinkFilter($this->_links);
- $requestFilter = is_array($request) ? implode(' ', $request) : $request;
- return $linkFilter->filter($type, trim($requestFilter), $casesensitive, $privateonly);
+ // 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;
+ }
+ // Otherwise, display without filtering.
+ else {
+ $type = '';
+ $request = '';
+ }
+
+ $linkFilter = new LinkFilter($this->links);
+ return $linkFilter->filter($type, $request, $casesensitive, $privateonly);
}
/**
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)
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);
projects / github / shaarli / Shaarli.git / blobdiff