]>
Commit | Line | Data |
---|---|---|
1 | <?php | |
2 | ||
3 | namespace Shaarli\Bookmark; | |
4 | ||
5 | use malkusch\lock\mutex\NoMutex; | |
6 | use ReferenceLinkDB; | |
7 | use Shaarli\Config\ConfigManager; | |
8 | use Shaarli\History; | |
9 | use Shaarli\TestCase; | |
10 | ||
11 | /** | |
12 | * Class BookmarkFilterTest. | |
13 | */ | |
14 | class BookmarkFilterTest extends TestCase | |
15 | { | |
16 | /** | |
17 | * @var string Test datastore path. | |
18 | */ | |
19 | protected static $testDatastore = 'sandbox/datastore.php'; | |
20 | /** | |
21 | * @var BookmarkFilter instance. | |
22 | */ | |
23 | protected static $linkFilter; | |
24 | ||
25 | /** | |
26 | * @var ReferenceLinkDB instance | |
27 | */ | |
28 | protected static $refDB; | |
29 | ||
30 | /** | |
31 | * @var BookmarkFileService instance | |
32 | */ | |
33 | protected static $bookmarkService; | |
34 | ||
35 | /** | |
36 | * Instantiate linkFilter with ReferenceLinkDB data. | |
37 | */ | |
38 | public static function setUpBeforeClass(): void | |
39 | { | |
40 | $mutex = new NoMutex(); | |
41 | $conf = new ConfigManager('tests/utils/config/configJson'); | |
42 | $conf->set('resource.datastore', self::$testDatastore); | |
43 | self::$refDB = new \ReferenceLinkDB(); | |
44 | self::$refDB->write(self::$testDatastore); | |
45 | $history = new History('sandbox/history.php'); | |
46 | self::$bookmarkService = new \FakeBookmarkService($conf, $history, $mutex, true); | |
47 | self::$linkFilter = new BookmarkFilter(self::$bookmarkService->getBookmarks(), $conf); | |
48 | } | |
49 | ||
50 | /** | |
51 | * Blank filter. | |
52 | */ | |
53 | public function testFilter() | |
54 | { | |
55 | $this->assertEquals( | |
56 | self::$refDB->countLinks(), | |
57 | count(self::$linkFilter->filter('', '')) | |
58 | ); | |
59 | ||
60 | $this->assertEquals( | |
61 | self::$refDB->countLinks(), | |
62 | count(self::$linkFilter->filter('', '', 'all')) | |
63 | ); | |
64 | ||
65 | $this->assertEquals( | |
66 | self::$refDB->countLinks(), | |
67 | count(self::$linkFilter->filter('', '', 'randomstr')) | |
68 | ); | |
69 | ||
70 | // Private only. | |
71 | $this->assertEquals( | |
72 | self::$refDB->countPrivateLinks(), | |
73 | count(self::$linkFilter->filter('', '', false, 'private')) | |
74 | ); | |
75 | ||
76 | // Public only. | |
77 | $this->assertEquals( | |
78 | self::$refDB->countPublicLinks(), | |
79 | count(self::$linkFilter->filter('', '', false, 'public')) | |
80 | ); | |
81 | ||
82 | $this->assertEquals( | |
83 | ReferenceLinkDB::$NB_LINKS_TOTAL, | |
84 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, '')) | |
85 | ); | |
86 | ||
87 | $this->assertEquals( | |
88 | self::$refDB->countUntaggedLinks(), | |
89 | count( | |
90 | self::$linkFilter->filter( | |
91 | BookmarkFilter::$FILTER_TAG, | |
92 | /*$request=*/ | |
93 | '', | |
94 | /*$casesensitive=*/ | |
95 | false, | |
96 | /*$visibility=*/ | |
97 | 'all', | |
98 | /*$untaggedonly=*/ | |
99 | true | |
100 | ) | |
101 | ) | |
102 | ); | |
103 | ||
104 | $this->assertEquals( | |
105 | ReferenceLinkDB::$NB_LINKS_TOTAL, | |
106 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, '')) | |
107 | ); | |
108 | } | |
109 | ||
110 | /** | |
111 | * Filter bookmarks using a tag | |
112 | */ | |
113 | public function testFilterOneTag() | |
114 | { | |
115 | $this->assertEquals( | |
116 | 4, | |
117 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'web', false)) | |
118 | ); | |
119 | ||
120 | $this->assertEquals( | |
121 | 4, | |
122 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'web', false, 'all')) | |
123 | ); | |
124 | ||
125 | $this->assertEquals( | |
126 | 4, | |
127 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'web', false, 'default-blabla')) | |
128 | ); | |
129 | ||
130 | // Private only. | |
131 | $this->assertEquals( | |
132 | 1, | |
133 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'web', false, 'private')) | |
134 | ); | |
135 | ||
136 | // Public only. | |
137 | $this->assertEquals( | |
138 | 3, | |
139 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'web', false, 'public')) | |
140 | ); | |
141 | } | |
142 | ||
143 | /** | |
144 | * Filter bookmarks using a tag - case-sensitive | |
145 | */ | |
146 | public function testFilterCaseSensitiveTag() | |
147 | { | |
148 | $this->assertEquals( | |
149 | 0, | |
150 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'mercurial', true)) | |
151 | ); | |
152 | ||
153 | $this->assertEquals( | |
154 | 1, | |
155 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'Mercurial', true)) | |
156 | ); | |
157 | } | |
158 | ||
159 | /** | |
160 | * Filter bookmarks using a tag combination | |
161 | */ | |
162 | public function testFilterMultipleTags() | |
163 | { | |
164 | $this->assertEquals( | |
165 | 2, | |
166 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'dev cartoon', false)) | |
167 | ); | |
168 | } | |
169 | ||
170 | /** | |
171 | * Filter bookmarks using a non-existent tag | |
172 | */ | |
173 | public function testFilterUnknownTag() | |
174 | { | |
175 | $this->assertEquals( | |
176 | 0, | |
177 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'null', false)) | |
178 | ); | |
179 | } | |
180 | ||
181 | /** | |
182 | * Return bookmarks for a given day | |
183 | */ | |
184 | public function testFilterDay() | |
185 | { | |
186 | $this->assertEquals( | |
187 | 4, | |
188 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '20121206')) | |
189 | ); | |
190 | } | |
191 | ||
192 | /** | |
193 | * Return bookmarks for a given day | |
194 | */ | |
195 | public function testFilterDayRestrictedVisibility(): void | |
196 | { | |
197 | $this->assertEquals( | |
198 | 3, | |
199 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '20121206', false, BookmarkFilter::$PUBLIC)) | |
200 | ); | |
201 | } | |
202 | ||
203 | /** | |
204 | * 404 - day not found | |
205 | */ | |
206 | public function testFilterUnknownDay() | |
207 | { | |
208 | $this->assertEquals( | |
209 | 0, | |
210 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '19700101')) | |
211 | ); | |
212 | } | |
213 | ||
214 | /** | |
215 | * Use an invalid date format | |
216 | */ | |
217 | public function testFilterInvalidDayWithChars() | |
218 | { | |
219 | $this->expectException(\Exception::class); | |
220 | $this->expectExceptionMessageRegExp('/Invalid date format/'); | |
221 | ||
222 | self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, 'Rainy day, dream away'); | |
223 | } | |
224 | ||
225 | /** | |
226 | * Use an invalid date format | |
227 | */ | |
228 | public function testFilterInvalidDayDigits() | |
229 | { | |
230 | $this->expectException(\Exception::class); | |
231 | $this->expectExceptionMessageRegExp('/Invalid date format/'); | |
232 | ||
233 | self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '20'); | |
234 | } | |
235 | ||
236 | /** | |
237 | * Retrieve a link entry with its hash | |
238 | */ | |
239 | public function testFilterSmallHash() | |
240 | { | |
241 | $links = self::$linkFilter->filter(BookmarkFilter::$FILTER_HASH, 'IuWvgA'); | |
242 | ||
243 | $this->assertEquals( | |
244 | 1, | |
245 | count($links) | |
246 | ); | |
247 | ||
248 | $this->assertEquals( | |
249 | 'MediaGoblin', | |
250 | $links[7]->getTitle() | |
251 | ); | |
252 | } | |
253 | ||
254 | /** | |
255 | * No link for this hash | |
256 | */ | |
257 | public function testFilterUnknownSmallHash() | |
258 | { | |
259 | $this->expectException(\Shaarli\Bookmark\Exception\BookmarkNotFoundException::class); | |
260 | ||
261 | self::$linkFilter->filter(BookmarkFilter::$FILTER_HASH, 'Iblaah'); | |
262 | } | |
263 | ||
264 | /** | |
265 | * Full-text search - no result found. | |
266 | */ | |
267 | public function testFilterFullTextNoResult() | |
268 | { | |
269 | $this->assertEquals( | |
270 | 0, | |
271 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'azertyuiop')) | |
272 | ); | |
273 | } | |
274 | ||
275 | /** | |
276 | * Full-text search - result from a link's URL | |
277 | */ | |
278 | public function testFilterFullTextURL() | |
279 | { | |
280 | $this->assertEquals( | |
281 | 2, | |
282 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'ars.userfriendly.org')) | |
283 | ); | |
284 | ||
285 | $this->assertEquals( | |
286 | 2, | |
287 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'ars org')) | |
288 | ); | |
289 | } | |
290 | ||
291 | /** | |
292 | * Full-text search - result from a link's title only | |
293 | */ | |
294 | public function testFilterFullTextTitle() | |
295 | { | |
296 | // use miscellaneous cases | |
297 | $this->assertEquals( | |
298 | 2, | |
299 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'userfriendly -')) | |
300 | ); | |
301 | $this->assertEquals( | |
302 | 2, | |
303 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'UserFriendly -')) | |
304 | ); | |
305 | $this->assertEquals( | |
306 | 2, | |
307 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'uSeRFrIendlY -')) | |
308 | ); | |
309 | ||
310 | // use miscellaneous case and offset | |
311 | $this->assertEquals( | |
312 | 2, | |
313 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'RFrIendL')) | |
314 | ); | |
315 | } | |
316 | ||
317 | /** | |
318 | * Full-text search - result from the link's description only | |
319 | */ | |
320 | public function testFilterFullTextDescription() | |
321 | { | |
322 | $this->assertEquals( | |
323 | 1, | |
324 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'publishing media')) | |
325 | ); | |
326 | ||
327 | $this->assertEquals( | |
328 | 1, | |
329 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'mercurial w3c')) | |
330 | ); | |
331 | ||
332 | $this->assertEquals( | |
333 | 3, | |
334 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, '"free software"')) | |
335 | ); | |
336 | } | |
337 | ||
338 | /** | |
339 | * Full-text search - result from the link's tags only | |
340 | */ | |
341 | public function testFilterFullTextTags() | |
342 | { | |
343 | $this->assertEquals( | |
344 | 6, | |
345 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'web')) | |
346 | ); | |
347 | ||
348 | $this->assertEquals( | |
349 | 6, | |
350 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'web', 'all')) | |
351 | ); | |
352 | ||
353 | $this->assertEquals( | |
354 | 6, | |
355 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'web', 'bla')) | |
356 | ); | |
357 | ||
358 | // Private only. | |
359 | $this->assertEquals( | |
360 | 1, | |
361 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'web', false, 'private')) | |
362 | ); | |
363 | ||
364 | // Public only. | |
365 | $this->assertEquals( | |
366 | 5, | |
367 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'web', false, 'public')) | |
368 | ); | |
369 | } | |
370 | ||
371 | /** | |
372 | * Full-text search - result set from mixed sources | |
373 | */ | |
374 | public function testFilterFullTextMixed() | |
375 | { | |
376 | $this->assertEquals( | |
377 | 3, | |
378 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'free software')) | |
379 | ); | |
380 | } | |
381 | ||
382 | /** | |
383 | * Full-text search - test exclusion with '-'. | |
384 | */ | |
385 | public function testExcludeSearch() | |
386 | { | |
387 | $this->assertEquals( | |
388 | 1, | |
389 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, 'free -gnu')) | |
390 | ); | |
391 | ||
392 | $this->assertEquals( | |
393 | ReferenceLinkDB::$NB_LINKS_TOTAL - 1, | |
394 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TEXT, '-revolution')) | |
395 | ); | |
396 | } | |
397 | ||
398 | /** | |
399 | * Full-text search - test AND, exact terms and exclusion combined, across fields. | |
400 | */ | |
401 | public function testMultiSearch() | |
402 | { | |
403 | $this->assertEquals( | |
404 | 2, | |
405 | count(self::$linkFilter->filter( | |
406 | BookmarkFilter::$FILTER_TEXT, | |
407 | '"Free Software " stallman "read this" @website stuff' | |
408 | )) | |
409 | ); | |
410 | ||
411 | $this->assertEquals( | |
412 | 1, | |
413 | count(self::$linkFilter->filter( | |
414 | BookmarkFilter::$FILTER_TEXT, | |
415 | '"free software " stallman "read this" -beard @website stuff' | |
416 | )) | |
417 | ); | |
418 | } | |
419 | ||
420 | /** | |
421 | * Full-text search - make sure that exact search won't work across fields. | |
422 | */ | |
423 | public function testSearchExactTermMultiFieldsKo() | |
424 | { | |
425 | $this->assertEquals( | |
426 | 0, | |
427 | count(self::$linkFilter->filter( | |
428 | BookmarkFilter::$FILTER_TEXT, | |
429 | '"designer naming"' | |
430 | )) | |
431 | ); | |
432 | ||
433 | $this->assertEquals( | |
434 | 0, | |
435 | count(self::$linkFilter->filter( | |
436 | BookmarkFilter::$FILTER_TEXT, | |
437 | '"designernaming"' | |
438 | )) | |
439 | ); | |
440 | } | |
441 | ||
442 | /** | |
443 | * Tag search with exclusion. | |
444 | */ | |
445 | public function testTagFilterWithExclusion() | |
446 | { | |
447 | $this->assertEquals( | |
448 | 1, | |
449 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, 'gnu -free')) | |
450 | ); | |
451 | ||
452 | $this->assertEquals( | |
453 | ReferenceLinkDB::$NB_LINKS_TOTAL - 1, | |
454 | count(self::$linkFilter->filter(BookmarkFilter::$FILTER_TAG, '-free')) | |
455 | ); | |
456 | } | |
457 | ||
458 | /** | |
459 | * Test crossed search (terms + tags). | |
460 | */ | |
461 | public function testFilterCrossedSearch() | |
462 | { | |
463 | $terms = '"Free Software " stallman "read this" @website stuff'; | |
464 | $tags = 'free'; | |
465 | $this->assertEquals( | |
466 | 1, | |
467 | count(self::$linkFilter->filter( | |
468 | BookmarkFilter::$FILTER_TAG | BookmarkFilter::$FILTER_TEXT, | |
469 | array($tags, $terms) | |
470 | )) | |
471 | ); | |
472 | $this->assertEquals( | |
473 | 2, | |
474 | count(self::$linkFilter->filter( | |
475 | BookmarkFilter::$FILTER_TAG | BookmarkFilter::$FILTER_TEXT, | |
476 | array('', $terms) | |
477 | )) | |
478 | ); | |
479 | $this->assertEquals( | |
480 | 1, | |
481 | count(self::$linkFilter->filter( | |
482 | BookmarkFilter::$FILTER_TAG | BookmarkFilter::$FILTER_TEXT, | |
483 | array(false, 'PSR-2') | |
484 | )) | |
485 | ); | |
486 | $this->assertEquals( | |
487 | 1, | |
488 | count(self::$linkFilter->filter( | |
489 | BookmarkFilter::$FILTER_TAG | BookmarkFilter::$FILTER_TEXT, | |
490 | array($tags, '') | |
491 | )) | |
492 | ); | |
493 | $this->assertEquals( | |
494 | ReferenceLinkDB::$NB_LINKS_TOTAL, | |
495 | count(self::$linkFilter->filter( | |
496 | BookmarkFilter::$FILTER_TAG | BookmarkFilter::$FILTER_TEXT, | |
497 | '' | |
498 | )) | |
499 | ); | |
500 | } | |
501 | ||
502 | /** | |
503 | * Filter bookmarks by #hashtag. | |
504 | */ | |
505 | public function testFilterByHashtag() | |
506 | { | |
507 | $hashtag = 'hashtag'; | |
508 | $this->assertEquals( | |
509 | 3, | |
510 | count(self::$linkFilter->filter( | |
511 | BookmarkFilter::$FILTER_TAG, | |
512 | $hashtag | |
513 | )) | |
514 | ); | |
515 | ||
516 | $hashtag = 'private'; | |
517 | $this->assertEquals( | |
518 | 1, | |
519 | count(self::$linkFilter->filter( | |
520 | BookmarkFilter::$FILTER_TAG, | |
521 | $hashtag, | |
522 | false, | |
523 | 'private' | |
524 | )) | |
525 | ); | |
526 | } | |
527 | ||
528 | /** | |
529 | * Test search result highlights in every field of bookmark reference #9. | |
530 | */ | |
531 | public function testFullTextSearchHighlight(): void | |
532 | { | |
533 | $bookmarks = self::$linkFilter->filter( | |
534 | BookmarkFilter::$FILTER_TEXT, | |
535 | '"psr-2" coding guide http fig "psr-2/" "This guide" basic standard. coding-style quality assurance' | |
536 | ); | |
537 | ||
538 | static::assertCount(1, $bookmarks); | |
539 | static::assertArrayHasKey(9, $bookmarks); | |
540 | ||
541 | $bookmark = $bookmarks[9]; | |
542 | $expectedHighlights = [ | |
543 | 'title' => [ | |
544 | ['start' => 0, 'end' => 5], // "psr-2" | |
545 | ['start' => 7, 'end' => 13], // coding | |
546 | ['start' => 20, 'end' => 25], // guide | |
547 | ], | |
548 | 'description' => [ | |
549 | ['start' => 0, 'end' => 10], // "This guide" | |
550 | ['start' => 45, 'end' => 50], // basic | |
551 | ['start' => 58, 'end' => 67], // standard. | |
552 | ], | |
553 | 'url' => [ | |
554 | ['start' => 0, 'end' => 4], // http | |
555 | ['start' => 15, 'end' => 18], // fig | |
556 | ['start' => 27, 'end' => 33], // "psr-2/" | |
557 | ], | |
558 | 'tags' => [ | |
559 | ['start' => 0, 'end' => 12], // coding-style | |
560 | ['start' => 23, 'end' => 30], // quality | |
561 | ['start' => 31, 'end' => 40], // assurance | |
562 | ], | |
563 | ]; | |
564 | static::assertSame($expectedHighlights, $bookmark->getAdditionalContentEntry('search_highlight')); | |
565 | } | |
566 | } |