{
$linkDb = new BookmarkFileService(
$conf,
+ $this->container->get('pluginManager'),
$this->container->get('history'),
new FlockMutex(fopen(SHAARLI_MUTEX_FILE, 'r'), 2),
true
use Shaarli\History;
use Shaarli\Legacy\LegacyLinkDB;
use Shaarli\Legacy\LegacyUpdater;
+use Shaarli\Plugin\PluginManager;
use Shaarli\Render\PageCacheManager;
use Shaarli\Updater\UpdaterUtils;
/** @var ConfigManager instance */
protected $conf;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/** @var History instance */
protected $history;
*/
public function __construct(
ConfigManager $conf,
+ PluginManager $pluginManager,
History $history,
Mutex $mutex,
bool $isLoggedIn
}
}
- $this->bookmarkFilter = new BookmarkFilter($this->bookmarks, $this->conf);
+ $this->pluginManager = $pluginManager;
+ $this->bookmarkFilter = new BookmarkFilter($this->bookmarks, $this->conf, $this->pluginManager);
}
/**
namespace Shaarli\Bookmark;
-use Exception;
use Shaarli\Bookmark\Exception\BookmarkNotFoundException;
use Shaarli\Config\ConfigManager;
+use Shaarli\Plugin\PluginManager;
/**
* Class LinkFilter.
*/
public static $FILTER_TAG = 'tags';
- /**
- * @var string filter by day.
- */
- public static $FILTER_DAY = 'FILTER_DAY';
-
/**
* @var string filter by day.
*/
/** @var ConfigManager */
protected $conf;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* @param Bookmark[] $bookmarks initialization.
*/
- public function __construct($bookmarks, ConfigManager $conf)
+ public function __construct($bookmarks, ConfigManager $conf, PluginManager $pluginManager)
{
$this->bookmarks = $bookmarks;
$this->conf = $conf;
+ $this->pluginManager = $pluginManager;
}
/**
$filtered = $this->bookmarks;
}
if (!empty($request[0])) {
- $filtered = (new BookmarkFilter($filtered, $this->conf))
+ $filtered = (new BookmarkFilter($filtered, $this->conf, $this->pluginManager))
->filterTags($request[0], $casesensitive, $visibility)
;
}
if (!empty($request[1])) {
- $filtered = (new BookmarkFilter($filtered, $this->conf))
+ $filtered = (new BookmarkFilter($filtered, $this->conf, $this->pluginManager))
->filterFulltext($request[1], $visibility)
;
}
} else {
return $this->filterTags($request, $casesensitive, $visibility);
}
- case self::$FILTER_DAY:
- return $this->filterDay($request, $visibility);
default:
return $this->noFilter($visibility);
}
*/
private function noFilter(string $visibility = 'all')
{
- if ($visibility === 'all') {
- return $this->bookmarks;
- }
-
$out = [];
foreach ($this->bookmarks as $key => $value) {
- if ($value->isPrivate() && $visibility === 'private') {
+ if (
+ !$this->pluginManager->filterSearchEntry(
+ $value,
+ ['source' => 'no_filter', 'visibility' => $visibility]
+ )
+ ) {
+ continue;
+ }
+
+ if ($visibility === 'all') {
+ $out[$key] = $value;
+ } elseif ($value->isPrivate() && $visibility === 'private') {
$out[$key] = $value;
} elseif (!$value->isPrivate() && $visibility === 'public') {
$out[$key] = $value;
}
// Iterate over every stored link.
- foreach ($this->bookmarks as $id => $link) {
+ foreach ($this->bookmarks as $id => $bookmark) {
+ if (
+ !$this->pluginManager->filterSearchEntry(
+ $bookmark,
+ [
+ 'source' => 'fulltext',
+ 'searchterms' => $searchterms,
+ 'andSearch' => $andSearch,
+ 'exactSearch' => $exactSearch,
+ 'excludeSearch' => $excludeSearch,
+ 'visibility' => $visibility
+ ]
+ )
+ ) {
+ continue;
+ }
+
// ignore non private bookmarks when 'privatonly' is on.
if ($visibility !== 'all') {
- if (!$link->isPrivate() && $visibility === 'private') {
+ if (!$bookmark->isPrivate() && $visibility === 'private') {
continue;
- } elseif ($link->isPrivate() && $visibility === 'public') {
+ } elseif ($bookmark->isPrivate() && $visibility === 'public') {
continue;
}
}
$lengths = [];
- $content = $this->buildFullTextSearchableLink($link, $lengths);
+ $content = $this->buildFullTextSearchableLink($bookmark, $lengths);
// Be optimistic
$found = true;
}
if ($found !== false) {
- $link->addAdditionalContentEntry(
+ $bookmark->addAdditionalContentEntry(
'search_highlight',
$this->postProcessFoundPositions($lengths, $foundPositions)
);
- $filtered[$id] = $link;
+ $filtered[$id] = $bookmark;
}
}
return $filtered;
}
- /**
- * generate a regex fragment out of a tag
- *
- * @param string $tag to to generate regexs from. may start with '-' to negate, contain '*' as wildcard
- *
- * @return string generated regex fragment
- */
- protected function tag2regex(string $tag): string
- {
- $tagsSeparator = $this->conf->get('general.tags_separator', ' ');
- $len = strlen($tag);
- if (!$len || $tag === "-" || $tag === "*") {
- // nothing to search, return empty regex
- return '';
- }
- if ($tag[0] === "-") {
- // query is negated
- $i = 1; // use offset to start after '-' character
- $regex = '(?!'; // create negative lookahead
- } else {
- $i = 0; // start at first character
- $regex = '(?='; // use positive lookahead
- }
- // before tag may only be the separator or the beginning
- $regex .= '.*(?:^|' . $tagsSeparator . ')';
- // iterate over string, separating it into placeholder and content
- for (; $i < $len; $i++) {
- if ($tag[$i] === '*') {
- // placeholder found
- $regex .= '[^' . $tagsSeparator . ']*?';
- } else {
- // regular characters
- $offset = strpos($tag, '*', $i);
- if ($offset === false) {
- // no placeholder found, set offset to end of string
- $offset = $len;
- }
- // subtract one, as we want to get before the placeholder or end of string
- $offset -= 1;
- // we got a tag name that we want to search for. escape any regex characters to prevent conflicts.
- $regex .= preg_quote(substr($tag, $i, $offset - $i + 1), '/');
- // move $i on
- $i = $offset;
- }
- }
- // after the tag may only be the separator or the end
- $regex .= '(?:$|' . $tagsSeparator . '))';
- return $regex;
- }
-
/**
* Returns the list of bookmarks associated with a given list of tags
*
$filtered = [];
// iterate over each link
- foreach ($this->bookmarks as $key => $link) {
+ foreach ($this->bookmarks as $key => $bookmark) {
+ if (
+ !$this->pluginManager->filterSearchEntry(
+ $bookmark,
+ [
+ 'source' => 'tags',
+ 'tags' => $tags,
+ 'casesensitive' => $casesensitive,
+ 'visibility' => $visibility
+ ]
+ )
+ ) {
+ continue;
+ }
+
// check level of visibility
// ignore non private bookmarks when 'privateonly' is on.
if ($visibility !== 'all') {
- if (!$link->isPrivate() && $visibility === 'private') {
+ if (!$bookmark->isPrivate() && $visibility === 'private') {
continue;
- } elseif ($link->isPrivate() && $visibility === 'public') {
+ } elseif ($bookmark->isPrivate() && $visibility === 'public') {
continue;
}
}
// build search string, start with tags of current link
- $search = $link->getTagsString($tagsSeparator);
- if (strlen(trim($link->getDescription())) && strpos($link->getDescription(), '#') !== false) {
+ $search = $bookmark->getTagsString($tagsSeparator);
+ if (strlen(trim($bookmark->getDescription())) && strpos($bookmark->getDescription(), '#') !== false) {
// description given and at least one possible tag found
$descTags = [];
// find all tags in the form of #tag in the description
preg_match_all(
'/(?<![' . self::$HASHTAG_CHARS . '])#([' . self::$HASHTAG_CHARS . ']+?)\b/sm',
- $link->getDescription(),
+ $bookmark->getDescription(),
$descTags
);
if (count($descTags[1])) {
// this entry does _not_ match our regex
continue;
}
- $filtered[$key] = $link;
+ $filtered[$key] = $bookmark;
}
+
return $filtered;
}
public function filterUntagged(string $visibility)
{
$filtered = [];
- foreach ($this->bookmarks as $key => $link) {
+ foreach ($this->bookmarks as $key => $bookmark) {
+ if (
+ !$this->pluginManager->filterSearchEntry(
+ $bookmark,
+ ['source' => 'untagged', 'visibility' => $visibility]
+ )
+ ) {
+ continue;
+ }
+
if ($visibility !== 'all') {
- if (!$link->isPrivate() && $visibility === 'private') {
+ if (!$bookmark->isPrivate() && $visibility === 'private') {
continue;
- } elseif ($link->isPrivate() && $visibility === 'public') {
+ } elseif ($bookmark->isPrivate() && $visibility === 'public') {
continue;
}
}
- if (empty($link->getTags())) {
- $filtered[$key] = $link;
- }
- }
-
- return $filtered;
- }
-
- /**
- * Returns the list of articles for a given day, chronologically sorted
- *
- * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g.
- * print_r($mydb->filterDay('20120125'));
- *
- * @param string $day day to filter.
- * @param string $visibility return only all/private/public bookmarks.
-
- * @return Bookmark[] all link matching given day.
- *
- * @throws Exception if date format is invalid.
- */
- public function filterDay(string $day, string $visibility)
- {
- if (!checkDateFormat('Ymd', $day)) {
- throw new Exception('Invalid date format');
- }
-
- $filtered = [];
- foreach ($this->bookmarks as $key => $bookmark) {
- if ($visibility === static::$PUBLIC && $bookmark->isPrivate()) {
- continue;
- }
-
- if ($bookmark->getCreated()->format('Ymd') == $day) {
+ if (empty($bookmark->getTags())) {
$filtered[$key] = $bookmark;
}
}
- // sort by date ASC
- return array_reverse($filtered, true);
+ return $filtered;
}
/**
return preg_split('/\s+/', $tagsOut, -1, PREG_SPLIT_NO_EMPTY);
}
+ /**
+ * generate a regex fragment out of a tag
+ *
+ * @param string $tag to to generate regexs from. may start with '-' to negate, contain '*' as wildcard
+ *
+ * @return string generated regex fragment
+ */
+ protected function tag2regex(string $tag): string
+ {
+ $tagsSeparator = $this->conf->get('general.tags_separator', ' ');
+ $len = strlen($tag);
+ if (!$len || $tag === "-" || $tag === "*") {
+ // nothing to search, return empty regex
+ return '';
+ }
+ if ($tag[0] === "-") {
+ // query is negated
+ $i = 1; // use offset to start after '-' character
+ $regex = '(?!'; // create negative lookahead
+ } else {
+ $i = 0; // start at first character
+ $regex = '(?='; // use positive lookahead
+ }
+ // before tag may only be the separator or the beginning
+ $regex .= '.*(?:^|' . $tagsSeparator . ')';
+ // iterate over string, separating it into placeholder and content
+ for (; $i < $len; $i++) {
+ if ($tag[$i] === '*') {
+ // placeholder found
+ $regex .= '[^' . $tagsSeparator . ']*?';
+ } else {
+ // regular characters
+ $offset = strpos($tag, '*', $i);
+ if ($offset === false) {
+ // no placeholder found, set offset to end of string
+ $offset = $len;
+ }
+ // subtract one, as we want to get before the placeholder or end of string
+ $offset -= 1;
+ // we got a tag name that we want to search for. escape any regex characters to prevent conflicts.
+ $regex .= preg_quote(substr($tag, $i, $offset - $i + 1), '/');
+ // move $i on
+ $i = $offset;
+ }
+ }
+ // after the tag may only be the separator or the end
+ $regex .= '(?:$|' . $tagsSeparator . '))';
+ return $regex;
+ }
+
/**
* This method finalize the content of the foundPositions array,
* by associated all search results to their associated bookmark field,
$container['bookmarkService'] = function (ShaarliContainer $container): BookmarkServiceInterface {
return new BookmarkFileService(
$container->conf,
+ $container->pluginManager,
$container->history,
new FlockMutex(fopen(SHAARLI_MUTEX_FILE, 'r'), 2),
$container->loginManager->isLoggedIn()
namespace Shaarli\Plugin;
+use Shaarli\Bookmark\Bookmark;
use Shaarli\Config\ConfigManager;
use Shaarli\Plugin\Exception\PluginFileNotFoundException;
use Shaarli\Plugin\Exception\PluginInvalidRouteException;
*/
protected $errors;
+ /** @var callable[]|null Preloaded list of hook function for filterSearchEntry() */
+ protected $filterSearchEntryHooks = null;
+
/**
* Plugins subdirectory.
*
return $this->registeredRoutes;
}
+ /**
+ * @return array List of registered filter_search_entry hooks
+ */
+ public function getFilterSearchEntryHooks(): ?array
+ {
+ return $this->filterSearchEntryHooks;
+ }
+
/**
* Return the list of encountered errors.
*
return $this->errors;
}
+ /**
+ * Apply additional filter on every search result of BookmarkFilter calling plugins hooks.
+ *
+ * @param Bookmark $bookmark To check.
+ * @param array $context Additional info about search context, depends on the search source.
+ *
+ * @return bool True if the result must be kept in search results, false otherwise.
+ */
+ public function filterSearchEntry(Bookmark $bookmark, array $context): bool
+ {
+ if ($this->filterSearchEntryHooks === null) {
+ $this->loadFilterSearchEntryHooks();
+ }
+
+ if ($this->filterSearchEntryHooks === []) {
+ return true;
+ }
+
+ foreach ($this->filterSearchEntryHooks as $filterSearchEntryHook) {
+ if ($filterSearchEntryHook($bookmark, $context) === false) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * filterSearchEntry() method will be called for every search result,
+ * so for performances we preload existing functions to invoke them directly.
+ */
+ protected function loadFilterSearchEntryHooks(): void
+ {
+ $this->filterSearchEntryHooks = [];
+
+ foreach ($this->loadedPlugins as $plugin) {
+ $hookFunction = $this->buildHookName('filter_search_entry', $plugin);
+
+ if (function_exists($hookFunction)) {
+ $this->filterSearchEntryHooks[] = $hookFunction;
+ }
+ }
+ }
+
/**
* Checks whether provided input is valid to register a new route.
* It must contain keys `method`, `route`, `callable` (all strings).
| |---| demo_plugin.php
```
-
### Plugin initialization
At the beginning of Shaarli execution, all enabled plugins are loaded. At this point, the plugin system looks for an `init()` function in the <plugin_name>.php to execute and run it if it exists. This function must be named this way, and takes the `ConfigManager` as parameter.
| [save_link](#save_link) | Allow to alter the link being saved in the datastore. |
| [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. |
| [save_plugin_parameters](#save_plugin_parameters) | Allow to manipulate plugin parameters before they're saved. |
+| [filter_search_entry](#filter_search_entry) | Add custom filters to Shaarli search engine |
#### render_header
Also [special data](#special-data).
+#### filter_search_entry
+
+Triggered for *every* bookmark when Shaarli's BookmarkService method `search()` is used.
+Any custom filter can be added to filter out bookmarks from search results.
+
+The hook **must** return either:
+ - `true` to keep bookmark entry in search result set
+ - `false` to discard bookmark entry in result set
+
+> Note: custom filters are called *before* default filters are applied.
+
+##### Parameters
+
+- `Shaarli\Bookmark\Bookmark` object: entry to evaluate
+- $context `array`: additional information provided depending on what search is currently used,
+the user request, etc.
+
## Guide for template designers
### Plugin administration
* and check user status with _LOGGEDIN_.
*/
+use Shaarli\Bookmark\Bookmark;
use Shaarli\Config\ConfigManager;
use Shaarli\Plugin\PluginManager;
use Shaarli\Render\TemplatePage;
}
$data['action_plugin'][] = $action;
+ // Action to trigger custom filter hiding bookmarks not containing 'e' letter in their description
+ $action = [
+ 'attr' => [
+ 'href' => '?e',
+ 'title' => 'Hide bookmarks without "e" in their description.',
+ ],
+ 'html' => 'e',
+ 'on' => isset($_GET['e'])
+ ];
+ $data['action_plugin'][] = $action;
+
// link_plugin (for each link)
foreach ($data['links'] as &$value) {
$value['link_plugin'][] = ' DEMO \o/';
return $data;
}
+/**
+ * This hook is called when a search is performed, on every search entry.
+ * It allows to add custom filters, and filter out additional link.
+ *
+ * For exemple here, we hide all bookmarks not containing the letter 'e' in their description.
+ *
+ * @param Bookmark $bookmark Search entry. Note that this is a Bookmark object, and not a link array.
+ * It should NOT be altered.
+ * @param array $context Additional info on the search performed.
+ *
+ * @return bool True if the bookmark should be kept in the search result, false to discard it.
+ */
+function hook_demo_plugin_filter_search_entry(Bookmark $bookmark, array $context): bool
+{
+ if (isset($_GET['e'])) {
+ return strpos($bookmark->getDescription(), 'e') !== false;
+ }
+
+ return true;
+}
+
/**
* This function is never called, but contains translation calls for GNU gettext extraction.
*/
namespace Shaarli\Plugin;
+use Shaarli\Bookmark\Bookmark;
use Shaarli\Config\ConfigManager;
/**
$errors = $this->pluginManager->getErrors();
static::assertSame(['test_route_invalid [plugin incompatibility]: trying to register invalid route.'], $errors);
}
+
+ public function testSearchFilterPlugin(): void
+ {
+ PluginManager::$PLUGINS_PATH = self::$pluginPath;
+ $this->pluginManager->load([self::$pluginName]);
+
+ static::assertNull($this->pluginManager->getFilterSearchEntryHooks());
+
+ static::assertTrue($this->pluginManager->filterSearchEntry(new Bookmark(), ['_result' => true]));
+
+ static::assertCount(1, $this->pluginManager->getFilterSearchEntryHooks());
+ static::assertSame('hook_test_filter_search_entry', $this->pluginManager->getFilterSearchEntryHooks()[0]);
+
+ static::assertFalse($this->pluginManager->filterSearchEntry(new Bookmark(), ['_result' => false]));
+ }
}
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
$this->container = new Container();
$this->container['conf'] = $this->conf;
$this->container['history'] = $history;
+ $this->container['pluginManager'] = new PluginManager($this->conf);
}
/**
use Shaarli\Bookmark\BookmarkFileService;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
use Slim\Container;
use Slim\Http\Environment;
$this->conf->set('resource.datastore', self::$testDatastore);
$this->refDB = new \ReferenceLinkDB();
$this->refDB->write(self::$testDatastore);
-
+ $this->pluginManager = new PluginManager($this->conf);
$history = new History('sandbox/history.php');
$this->container = new Container();
$this->container['conf'] = $this->conf;
- $this->container['db'] = new BookmarkFileService($this->conf, $history, $mutex, true);
+ $this->container['db'] = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $history,
+ $mutex,
+ true
+ );
$this->container['history'] = null;
$this->controller = new Info($this->container);
use Shaarli\Bookmark\BookmarkFileService;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
/** @var NoMutex */
protected $mutex;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* Before each test, instantiate a new Api with its config, plugins and bookmarks.
*/
$refHistory = new \ReferenceHistory();
$refHistory->write(self::$testHistory);
$this->history = new History(self::$testHistory);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->pluginManager = new PluginManager($this->conf);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->container = new Container();
$this->container['conf'] = $this->conf;
$this->assertEquals(204, $response->getStatusCode());
$this->assertEmpty((string) $response->getBody());
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->assertFalse($this->bookmarkService->exists($id));
$historyEntry = $this->history->getHistory()[0];
use Shaarli\Bookmark\BookmarkFileService;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
$this->container = new Container();
$this->container['conf'] = $this->conf;
- $this->container['db'] = new BookmarkFileService($this->conf, $history, $mutex, true);
+ $pluginManager = new PluginManager($this->conf);
+ $this->container['db'] = new BookmarkFileService(
+ $this->conf,
+ $pluginManager,
+ $history,
+ $mutex,
+ true
+ );
$this->container['history'] = null;
$this->controller = new Links($this->container);
use Shaarli\Bookmark\LinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
$this->container = new Container();
$this->container['conf'] = $this->conf;
- $this->container['db'] = new BookmarkFileService($this->conf, $history, $mutex, true);
+ $pluginManager = new PluginManager($this->conf);
+ $this->container['db'] = new BookmarkFileService(
+ $this->conf,
+ $pluginManager,
+ $history,
+ $mutex,
+ true
+ );
$this->container['history'] = null;
$this->controller = new Links($this->container);
use Shaarli\Bookmark\BookmarkFileService;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
use Slim\Container;
use Slim\Http\Environment;
$refHistory = new \ReferenceHistory();
$refHistory->write(self::$testHistory);
$this->history = new History(self::$testHistory);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $mutex, true);
-
+ $pluginManager = new PluginManager($this->conf);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $pluginManager,
+ $this->history,
+ $mutex,
+ true
+ );
$this->container = new Container();
$this->container['conf'] = $this->conf;
$this->container['db'] = $this->bookmarkService;
use Shaarli\Bookmark\BookmarkFileService;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
$refHistory = new \ReferenceHistory();
$refHistory->write(self::$testHistory);
$this->history = new History(self::$testHistory);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $mutex, true);
-
+ $pluginManager = new PluginManager($this->conf);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $pluginManager,
+ $this->history,
+ $mutex,
+ true
+ );
$this->container = new Container();
$this->container['conf'] = $this->conf;
$this->container['db'] = $this->bookmarkService;
use Shaarli\Bookmark\LinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
*/
protected $controller;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/** @var NoMutex */
protected $mutex;
$refHistory = new \ReferenceHistory();
$refHistory->write(self::$testHistory);
$this->history = new History(self::$testHistory);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->pluginManager = new PluginManager($this->conf);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->container = new Container();
$this->container['conf'] = $this->conf;
$this->assertEquals(204, $response->getStatusCode());
$this->assertEmpty((string) $response->getBody());
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$tags = $this->bookmarkService->bookmarksCountPerTag();
$this->assertFalse(isset($tags[$tagName]));
$this->assertEquals(204, $response->getStatusCode());
$this->assertEmpty((string) $response->getBody());
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$tags = $this->bookmarkService->bookmarksCountPerTag();
$this->assertFalse(isset($tags[$tagName]));
$this->assertTrue($tags[strtolower($tagName)] > 0);
use Shaarli\Bookmark\LinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
*/
protected $controller;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* Number of JSON fields per link.
*/
$this->container = new Container();
$this->container['conf'] = $this->conf;
- $this->container['db'] = new BookmarkFileService($this->conf, $history, $mutex, true);
+ $this->pluginManager = new PluginManager($this->conf);
+ $this->container['db'] = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $history,
+ $mutex,
+ true
+ );
$this->container['history'] = null;
$this->controller = new Tags($this->container);
use Shaarli\Bookmark\LinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
*/
protected $controller;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* Number of JSON field per link.
*/
$this->refDB = new \ReferenceLinkDB();
$this->refDB->write(self::$testDatastore);
$history = new History('sandbox/history.php');
-
- $this->bookmarkService = new BookmarkFileService($this->conf, $history, $mutex, true);
-
+ $this->pluginManager = new PluginManager($this->conf);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $history,
+ $mutex,
+ true
+ );
$this->container = new Container();
$this->container['conf'] = $this->conf;
$this->container['db'] = $this->bookmarkService;
use Shaarli\Bookmark\LinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
*/
protected $controller;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* Number of JSON field per link.
*/
$refHistory = new \ReferenceHistory();
$refHistory->write(self::$testHistory);
$this->history = new History(self::$testHistory);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $mutex, true);
+ $this->pluginManager = new PluginManager($this->conf);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $mutex,
+ true
+ );
$this->container = new Container();
$this->container['conf'] = $this->conf;
use Shaarli\Config\ConfigManager;
use Shaarli\Formatter\BookmarkMarkdownFormatter;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
/**
/** @var NoMutex */
protected $mutex;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* Instantiates public and private LinkDBs with test data
*
$this->refDB = new \ReferenceLinkDB();
$this->refDB->write(self::$testDatastore);
$this->history = new History('sandbox/history.php');
- $this->publicLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, false);
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->pluginManager = new PluginManager($this->conf);
+ $this->publicLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ false
+ );
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
}
/**
$db = self::getMethod('migrate');
$db->invokeArgs($this->privateLinkDB, []);
- $db = new \FakeBookmarkService($this->conf, $this->history, $this->mutex, true);
+ $db = new \FakeBookmarkService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->assertInstanceOf(BookmarkArray::class, $db->getBookmarks());
$this->assertEquals($this->refDB->countLinks(), $db->count());
}
$this->assertEquals($updated, $bookmark->getUpdated());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new \FakeBookmarkService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(43);
$this->assertEquals(43, $bookmark->getId());
$this->assertNull($bookmark->getUpdated());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(43);
$this->assertEquals(43, $bookmark->getId());
$this->assertEquals(43, $bookmark->getId());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->privateLinkDB->get(43);
}
$this->assertTrue(new \DateTime('5 seconds ago') < $bookmark->getUpdated());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(42);
$this->assertEquals(42, $bookmark->getId());
$this->assertTrue(new \DateTime('5 seconds ago') < $bookmark->getUpdated());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(42);
$this->assertEquals(42, $bookmark->getId());
$this->assertEquals($title, $bookmark->getTitle());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(42);
$this->assertEquals(42, $bookmark->getId());
$this->assertEquals(43, $bookmark->getId());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(43);
$this->assertEquals(43, $bookmark->getId());
$this->assertEquals($title, $bookmark->getTitle());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(42);
$this->assertEquals(42, $bookmark->getId());
$this->assertEquals($title, $bookmark->getTitle());
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$bookmark = $this->privateLinkDB->get(42);
$this->assertEquals(42, $bookmark->getId());
$this->assertInstanceOf(BookmarkNotFoundException::class, $exception);
// reload from file
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->privateLinkDB->get(42);
}
$conf = new ConfigManager('tests/utils/config/configJson');
$conf->set('resource.datastore', 'null/store.db');
- new BookmarkFileService($conf, $this->history, $this->mutex, true);
+ new BookmarkFileService($conf, $this->pluginManager, $this->history, $this->mutex, true);
}
/**
{
unlink(self::$testDatastore);
$this->assertFileNotExists(self::$testDatastore);
- new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ new BookmarkFileService($this->conf, $this->pluginManager, $this->history, $this->mutex, true);
$this->assertFileExists(self::$testDatastore);
// ensure the correct data has been written
{
unlink(self::$testDatastore);
$this->assertFileNotExists(self::$testDatastore);
- $db = new \FakeBookmarkService($this->conf, $this->history, $this->mutex, false);
+ $db = new \FakeBookmarkService($this->conf, $this->pluginManager, $this->history, $this->mutex, false);
$this->assertFileNotExists(self::$testDatastore);
$this->assertInstanceOf(BookmarkArray::class, $db->getBookmarks());
$this->assertCount(0, $db->getBookmarks());
*/
public function testSave()
{
- $testDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $testDB = new BookmarkFileService($this->conf, $this->pluginManager, $this->history, $this->mutex, true);
$dbSize = $testDB->count();
$bookmark = new Bookmark();
$testDB->add($bookmark);
- $testDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $testDB = new BookmarkFileService($this->conf, $this->pluginManager, $this->history, $this->mutex, true);
$this->assertEquals($dbSize + 1, $testDB->count());
}
public function testCountHiddenPublic()
{
$this->conf->set('privacy.hide_public_links', true);
- $linkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, false);
+ $linkDB = new BookmarkFileService($this->conf, $this->pluginManager, $this->history, $this->mutex, false);
$this->assertEquals(0, $linkDB->count());
}
$bookmark->addAdditionalContentEntry('private_key', $privateKey);
$this->privateLinkDB->save();
- $this->privateLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, false);
+ $this->privateLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ false
+ );
$bookmark = $this->privateLinkDB->findByHash($hash, $privateKey);
static::assertSame(6, $bookmark->getId());
public function testGetLatestEmptyDatastore(): void
{
unlink($this->conf->get('resource.datastore'));
- $this->publicLinkDB = new BookmarkFileService($this->conf, $this->history, $this->mutex, false);
+ $this->publicLinkDB = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ false
+ );
$bookmark = $this->publicLinkDB->getLatest();
use ReferenceLinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
/**
*/
protected static $bookmarkService;
+ /** @var PluginManager */
+ protected static $pluginManager;
+
/**
* Instantiate linkFilter with ReferenceLinkDB data.
*/
public static function setUpBeforeClass(): void
{
+
$mutex = new NoMutex();
$conf = new ConfigManager('tests/utils/config/configJson');
$conf->set('resource.datastore', self::$testDatastore);
+ static::$pluginManager = new PluginManager($conf);
self::$refDB = new \ReferenceLinkDB();
self::$refDB->write(self::$testDatastore);
$history = new History('sandbox/history.php');
- self::$bookmarkService = new \FakeBookmarkService($conf, $history, $mutex, true);
- self::$linkFilter = new BookmarkFilter(self::$bookmarkService->getBookmarks(), $conf);
+ self::$bookmarkService = new \FakeBookmarkService($conf, static::$pluginManager, $history, $mutex, true);
+ self::$linkFilter = new BookmarkFilter(self::$bookmarkService->getBookmarks(), $conf, static::$pluginManager);
}
/**
);
}
- /**
- * Return bookmarks for a given day
- */
- public function testFilterDay()
- {
- $this->assertEquals(
- 4,
- count(self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '20121206'))
- );
- }
-
- /**
- * Return bookmarks for a given day
- */
- public function testFilterDayRestrictedVisibility(): void
- {
- $this->assertEquals(
- 3,
- count(self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '20121206', false, BookmarkFilter::$PUBLIC))
- );
- }
-
- /**
- * 404 - day not found
- */
- public function testFilterUnknownDay()
- {
- $this->assertEquals(
- 0,
- count(self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '19700101'))
- );
- }
-
- /**
- * Use an invalid date format
- */
- public function testFilterInvalidDayWithChars()
- {
- $this->expectException(\Exception::class);
- $this->expectExceptionMessageRegExp('/Invalid date format/');
-
- self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, 'Rainy day, dream away');
- }
-
- /**
- * Use an invalid date format
- */
- public function testFilterInvalidDayDigits()
- {
- $this->expectException(\Exception::class);
- $this->expectExceptionMessageRegExp('/Invalid date format/');
-
- self::$linkFilter->filter(BookmarkFilter::$FILTER_DAY, '20');
- }
-
/**
* Retrieve a link entry with its hash
*/
use malkusch\lock\mutex\NoMutex;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
/**
/** @var NoMutex */
protected $mutex;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* Initialize an empty BookmarkFileService
*/
copy('tests/utils/config/configJson.json.php', self::$testConf .'.json.php');
$this->conf = new ConfigManager(self::$testConf);
$this->conf->set('resource.datastore', self::$testDatastore);
+ $this->pluginManager = new PluginManager($this->conf);
$this->history = new History('sandbox/history.php');
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->initializer = new BookmarkInitializer($this->bookmarkService);
}
{
$refDB = new \ReferenceLinkDB();
$refDB->write(self::$testDatastore);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->initializer = new BookmarkInitializer($this->bookmarkService);
$this->initializer->initialize();
$this->bookmarkService->save();
// Reload from file
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->assertEquals($refDB->countLinks() + 3, $this->bookmarkService->count());
$bookmark = $this->bookmarkService->get(43);
public function testInitializeNonExistentDataStore(): void
{
$this->conf->set('resource.datastore', static::$testDatastore . '_empty');
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $this->mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $this->mutex,
+ true
+ );
$this->initializer->initialize();
use Shaarli\Config\ConfigManager;
use Shaarli\Formatter\FormatterFactory;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
/**
$refLinkDB->write(self::$testDatastore);
$history = new History('sandbox/history.php');
$factory = new FormatterFactory($conf, true);
+ $pluginManager = new PluginManager($conf);
self::$formatter = $factory->getFormatter();
- self::$bookmarkService = new BookmarkFileService($conf, $history, $mutex, true);
+ self::$bookmarkService = new BookmarkFileService(
+ $conf,
+ $pluginManager,
+ $history,
+ $mutex,
+ true
+ );
self::$serverInfo = array(
'HTTPS' => 'Off',
use Shaarli\Formatter\BookmarkFormatter;
use Shaarli\Formatter\FormatterFactory;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
require_once 'tests/utils/ReferenceLinkDB.php';
*/
protected static $history;
+ /** @var PluginManager */
+ protected static $pluginManager;
+
/**
* @var NetscapeBookmarkUtils
*/
static::$refDb = new \ReferenceLinkDB();
static::$refDb->write(static::$testDatastore);
static::$history = new History('sandbox/history.php');
- static::$bookmarkService = new BookmarkFileService(static::$conf, static::$history, $mutex, true);
+ static::$pluginManager = new PluginManager(static::$conf);
+ static::$bookmarkService = new BookmarkFileService(
+ static::$conf,
+ static::$pluginManager,
+ static::$history,
+ $mutex,
+ true
+ );
$factory = new FormatterFactory(static::$conf, true);
static::$formatter = $factory->getFormatter('raw');
}
use Shaarli\Bookmark\BookmarkFilter;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
use Slim\Http\UploadedFile;
*/
protected $netscapeBookmarkUtils;
+ /** @var PluginManager */
+ protected $pluginManager;
+
/**
* @var string Save the current timezone.
*/
$this->conf->set('resource.page_cache', $this->pagecache);
$this->conf->set('resource.datastore', self::$testDatastore);
$this->history = new History(self::$historyFilePath);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $mutex, true);
+ $this->pluginManager = new PluginManager($this->conf);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->pluginManager,
+ $this->history,
+ $mutex,
+ true
+ );
$this->netscapeBookmarkUtils = new NetscapeBookmarkUtils($this->bookmarkService, $this->conf, $this->history);
}
<?php
+use Shaarli\Bookmark\Bookmark;
+
/**
* Hook for test.
*
],
];
}
+
+function hook_test_filter_search_entry(Bookmark $bookmark, array $context): bool
+{
+ return $context['_result'];
+}
use Shaarli\Bookmark\BookmarkServiceInterface;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
+use Shaarli\Plugin\PluginManager;
use Shaarli\TestCase;
copy('tests/utils/config/configJson.json.php', self::$configFile .'.json.php');
$this->conf = new ConfigManager(self::$configFile);
- $this->bookmarkService = new BookmarkFileService($this->conf, $this->createMock(History::class), $mutex, true);
+ $this->bookmarkService = new BookmarkFileService(
+ $this->conf,
+ $this->createMock(PluginManager::class),
+ $this->createMock(History::class),
+ $mutex,
+ true
+ );
$this->updater = new Updater([], $this->bookmarkService, $this->conf, true);
}
projects / github / shaarli / Shaarli.git / commitdiff
