aboutsummaryrefslogtreecommitdiffhomepage
path: root/application/LinkDB.php
diff options
context:
space:
mode:
authorVirtualTam <virtualtam@flibidi.org>2015-03-12 00:43:02 +0100
committerVirtualTam <virtualtam@flibidi.net>2015-06-11 00:45:45 +0200
commitca74886f30da323f42aa4bd70461003f46ef299b (patch)
tree3714895c25d80bdb472211a564f83d3744d90f34 /application/LinkDB.php
parentcbecab773526b0c39f3cffa1d4595b5caa781bda (diff)
downloadShaarli-ca74886f30da323f42aa4bd70461003f46ef299b.tar.gz
Shaarli-ca74886f30da323f42aa4bd70461003f46ef299b.tar.zst
Shaarli-ca74886f30da323f42aa4bd70461003f46ef299b.zip
LinkDB: move to a proper file, add test coverage
Relates to #71 LinkDB - move to application/LinkDB.php - code cleanup - indentation - whitespaces - formatting - comment cleanup - add missing documentation - unify formatting Test coverage for LinkDB - constructor - public / private access - link-related methods Shaarli utilities (LinkDB dependencies) - move startsWith() and endsWith() functions to application/Utils.php - add test coverage Dev utilities - Composer: add PHPUnit to dev dependencies - Makefile: - update lint targets - add test targets - generate coverage reports Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'application/LinkDB.php')
-rw-r--r--application/LinkDB.php412
1 files changed, 412 insertions, 0 deletions
diff --git a/application/LinkDB.php b/application/LinkDB.php
new file mode 100644
index 00000000..388002f6
--- /dev/null
+++ b/application/LinkDB.php
@@ -0,0 +1,412 @@
1<?php
2/**
3 * Data storage for links.
4 *
5 * This object behaves like an associative array.
6 *
7 * Example:
8 * $myLinks = new LinkDB();
9 * echo $myLinks['20110826_161819']['title'];
10 * foreach ($myLinks as $link)
11 * echo $link['title'].' at url '.$link['url'].'; description:'.$link['description'];
12 *
13 * Available keys:
14 * - description: description of the entry
15 * - linkdate: date of the creation of this entry, in the form YYYYMMDD_HHMMSS
16 * (e.g.'20110914_192317')
17 * - private: Is this link private? 0=no, other value=yes
18 * - tags: tags attached to this entry (separated by spaces)
19 * - title Title of the link
20 * - url URL of the link. Can be absolute or relative.
21 * Relative URLs are permalinks (e.g.'?m-ukcw')
22 *
23 * Implements 3 interfaces:
24 * - ArrayAccess: behaves like an associative array;
25 * - Countable: there is a count() method;
26 * - Iterator: usable in foreach () loops.
27 */
28class LinkDB implements Iterator, Countable, ArrayAccess
29{
30 // List of links (associative array)
31 // - key: link date (e.g. "20110823_124546"),
32 // - value: associative array (keys: title, description...)
33 private $links;
34
35 // List of all recorded URLs (key=url, value=linkdate)
36 // for fast reserve search (url-->linkdate)
37 private $urls;
38
39 // List of linkdate keys (for the Iterator interface implementation)
40 private $keys;
41
42 // Position in the $this->keys array (for the Iterator interface)
43 private $position;
44
45 // Is the user logged in? (used to filter private links)
46 private $loggedIn;
47
48 /**
49 * Creates a new LinkDB
50 *
51 * Checks if the datastore exists; else, attempts to create a dummy one.
52 *
53 * @param $isLoggedIn is the user logged in?
54 */
55 function __construct($isLoggedIn)
56 {
57 // FIXME: do not access $GLOBALS, pass the datastore instead
58 $this->loggedIn = $isLoggedIn;
59 $this->checkDB();
60 $this->readdb();
61 }
62
63 /**
64 * Countable - Counts elements of an object
65 */
66 public function count()
67 {
68 return count($this->links);
69 }
70
71 /**
72 * ArrayAccess - Assigns a value to the specified offset
73 */
74 public function offsetSet($offset, $value)
75 {
76 // TODO: use exceptions instead of "die"
77 if (!$this->loggedIn) {
78 die('You are not authorized to add a link.');
79 }
80 if (empty($value['linkdate']) || empty($value['url'])) {
81 die('Internal Error: A link should always have a linkdate and URL.');
82 }
83 if (empty($offset)) {
84 die('You must specify a key.');
85 }
86 $this->links[$offset] = $value;
87 $this->urls[$value['url']]=$offset;
88 }
89
90 /**
91 * ArrayAccess - Whether or not an offset exists
92 */
93 public function offsetExists($offset)
94 {
95 return array_key_exists($offset, $this->links);
96 }
97
98 /**
99 * ArrayAccess - Unsets an offset
100 */
101 public function offsetUnset($offset)
102 {
103 if (!$this->loggedIn) {
104 // TODO: raise an exception
105 die('You are not authorized to delete a link.');
106 }
107 $url = $this->links[$offset]['url'];
108 unset($this->urls[$url]);
109 unset($this->links[$offset]);
110 }
111
112 /**
113 * ArrayAccess - Returns the value at specified offset
114 */
115 public function offsetGet($offset)
116 {
117 return isset($this->links[$offset]) ? $this->links[$offset] : null;
118 }
119
120 /**
121 * Iterator - Returns the current element
122 */
123 function current()
124 {
125 return $this->links[$this->keys[$this->position]];
126 }
127
128 /**
129 * Iterator - Returns the key of the current element
130 */
131 function key()
132 {
133 return $this->keys[$this->position];
134 }
135
136 /**
137 * Iterator - Moves forward to next element
138 */
139 function next()
140 {
141 ++$this->position;
142 }
143
144 /**
145 * Iterator - Rewinds the Iterator to the first element
146 *
147 * Entries are sorted by date (latest first)
148 */
149 function rewind()
150 {
151 $this->keys = array_keys($this->links);
152 rsort($this->keys);
153 $this->position = 0;
154 }
155
156 /**
157 * Iterator - Checks if current position is valid
158 */
159 function valid()
160 {
161 return isset($this->keys[$this->position]);
162 }
163
164 /**
165 * Checks if the DB directory and file exist
166 *
167 * If no DB file is found, creates a dummy DB.
168 */
169 private function checkDB()
170 {
171 if (file_exists($GLOBALS['config']['DATASTORE'])) {
172 return;
173 }
174
175 // Create a dummy database for example
176 $this->links = array();
177 $link = array(
178 'title'=>'Shaarli - sebsauvage.net',
179 'url'=>'http://sebsauvage.net/wiki/doku.php?id=php:shaarli',
180 'description'=>'Welcome to Shaarli! This is a bookmark. To edit or delete me, you must first login.',
181 'private'=>0,
182 'linkdate'=>'20110914_190000',
183 'tags'=>'opensource software'
184 );
185 $this->links[$link['linkdate']] = $link;
186
187 $link = array(
188 'title'=>'My secret stuff... - Pastebin.com',
189 'url'=>'http://sebsauvage.net/paste/?8434b27936c09649#bR7XsXhoTiLcqCpQbmOpBi3rq2zzQUC5hBI7ZT1O3x8=',
190 'description'=>'SShhhh!! I\'m a private link only YOU can see. You can delete me too.',
191 'private'=>1,
192 'linkdate'=>'20110914_074522',
193 'tags'=>'secretstuff'
194 );
195 $this->links[$link['linkdate']] = $link;
196
197 // Write database to disk
198 // TODO: raise an exception if the file is not write-able
199 file_put_contents(
200 // FIXME: do not use $GLOBALS
201 $GLOBALS['config']['DATASTORE'],
202 PHPPREFIX.base64_encode(gzdeflate(serialize($this->links))).PHPSUFFIX
203 );
204 }
205
206 /**
207 * Reads database from disk to memory
208 */
209 private function readdb()
210 {
211 // Read data
212 // Note that gzinflate is faster than gzuncompress.
213 // See: http://www.php.net/manual/en/function.gzdeflate.php#96439
214 // FIXME: do not use $GLOBALS
215 $this->links = array();
216
217 if (file_exists($GLOBALS['config']['DATASTORE'])) {
218 $this->links = unserialize(gzinflate(base64_decode(
219 substr(file_get_contents($GLOBALS['config']['DATASTORE']),
220 strlen(PHPPREFIX), -strlen(PHPSUFFIX)))));
221 }
222
223 // If user is not logged in, filter private links.
224 if (!$this->loggedIn) {
225 $toremove = array();
226 foreach ($this->links as $link) {
227 if ($link['private'] != 0) {
228 $toremove[] = $link['linkdate'];
229 }
230 }
231 foreach ($toremove as $linkdate) {
232 unset($this->links[$linkdate]);
233 }
234 }
235
236 // Keep the list of the mapping URLs-->linkdate up-to-date.
237 $this->urls = array();
238 foreach ($this->links as $link) {
239 $this->urls[$link['url']] = $link['linkdate'];
240 }
241 }
242
243 /**
244 * Saves the database from memory to disk
245 */
246 public function savedb()
247 {
248 if (!$this->loggedIn) {
249 // TODO: raise an Exception instead
250 die('You are not authorized to change the database.');
251 }
252 file_put_contents(
253 $GLOBALS['config']['DATASTORE'],
254 PHPPREFIX.base64_encode(gzdeflate(serialize($this->links))).PHPSUFFIX
255 );
256 invalidateCaches();
257 }
258
259 /**
260 * Returns the link for a given URL, or False if it does not exist.
261 */
262 public function getLinkFromUrl($url)
263 {
264 if (isset($this->urls[$url])) {
265 return $this->links[$this->urls[$url]];
266 }
267 return false;
268 }
269
270 /**
271 * Returns the list of links corresponding to a full-text search
272 *
273 * Searches:
274 * - in the URLs, title and description;
275 * - are case-insensitive.
276 *
277 * Example:
278 * print_r($mydb->filterFulltext('hollandais'));
279 *
280 * mb_convert_case($val, MB_CASE_LOWER, 'UTF-8')
281 * - allows to perform searches on Unicode text
282 * - see https://github.com/shaarli/Shaarli/issues/75 for examples
283 */
284 public function filterFulltext($searchterms)
285 {
286 // FIXME: explode(' ',$searchterms) and perform a AND search.
287 // FIXME: accept double-quotes to search for a string "as is"?
288 $filtered = array();
289 $search = mb_convert_case($searchterms, MB_CASE_LOWER, 'UTF-8');
290 $keys = ['title', 'description', 'url', 'tags'];
291
292 foreach ($this->links as $link) {
293 $found = false;
294
295 foreach ($keys as $key) {
296 if (strpos(mb_convert_case($link[$key], MB_CASE_LOWER, 'UTF-8'),
297 $search) !== false) {
298 $found = true;
299 }
300 }
301
302 if ($found) {
303 $filtered[$link['linkdate']] = $link;
304 }
305 }
306 krsort($filtered);
307 return $filtered;
308 }
309
310 /**
311 * Returns the list of links associated with a given list of tags
312 *
313 * You can specify one or more tags, separated by space or a comma, e.g.
314 * print_r($mydb->filterTags('linux programming'));
315 */
316 public function filterTags($tags, $casesensitive=false)
317 {
318 // Same as above, we use UTF-8 conversion to handle various graphemes (i.e. cyrillic, or greek)
319 // FIXME: is $casesensitive ever true?
320 $t = str_replace(
321 ',', ' ',
322 ($casesensitive ? $tags : mb_convert_case($tags, MB_CASE_LOWER, 'UTF-8'))
323 );
324
325 $searchtags = explode(' ', $t);
326 $filtered = array();
327
328 foreach ($this->links as $l) {
329 $linktags = explode(
330 ' ',
331 ($casesensitive ? $l['tags']:mb_convert_case($l['tags'], MB_CASE_LOWER, 'UTF-8'))
332 );
333
334 if (count(array_intersect($linktags, $searchtags)) == count($searchtags)) {
335 $filtered[$l['linkdate']] = $l;
336 }
337 }
338 krsort($filtered);
339 return $filtered;
340 }
341
342
343 /**
344 * Returns the list of articles for a given day, chronologically sorted
345 *
346 * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g.
347 * print_r($mydb->filterDay('20120125'));
348 */
349 public function filterDay($day)
350 {
351 // TODO: check input format
352 $filtered = array();
353 foreach ($this->links as $l) {
354 if (startsWith($l['linkdate'], $day)) {
355 $filtered[$l['linkdate']] = $l;
356 }
357 }
358 ksort($filtered);
359 return $filtered;
360 }
361
362 /**
363 * Returns the article corresponding to a smallHash
364 */
365 public function filterSmallHash($smallHash)
366 {
367 $filtered = array();
368 foreach ($this->links as $l) {
369 if ($smallHash == smallHash($l['linkdate'])) {
370 // Yes, this is ugly and slow
371 $filtered[$l['linkdate']] = $l;
372 return $filtered;
373 }
374 }
375 return $filtered;
376 }
377
378 /**
379 * Returns the list of all tags
380 * Output: associative array key=tags, value=0
381 */
382 public function allTags()
383 {
384 $tags = array();
385 foreach ($this->links as $link) {
386 foreach (explode(' ', $link['tags']) as $tag) {
387 if (!empty($tag)) {
388 $tags[$tag] = (empty($tags[$tag]) ? 1 : $tags[$tag] + 1);
389 }
390 }
391 }
392 // Sort tags by usage (most used tag first)
393 arsort($tags);
394 return $tags;
395 }
396
397 /**
398 * Returns the list of days containing articles (oldest first)
399 * Output: An array containing days (in format YYYYMMDD).
400 */
401 public function days()
402 {
403 $linkDays = array();
404 foreach (array_keys($this->links) as $day) {
405 $linkDays[substr($day, 0, 8)] = 0;
406 }
407 $linkDays = array_keys($linkDays);
408 sort($linkDays);
409 return $linkDays;
410 }
411}
412?>