From 007183450a8a9f868cf914dbca68a0eccfe72287 Mon Sep 17 00:00:00 2001 From: "J. King" Date: Mon, 1 Feb 2021 21:02:46 -0500 Subject: [PATCH] Context and column list for article queries Sorting and transformation still need to be figured out --- .../030_Supported_Protocols/005_Miniflux.md | 2 ++ lib/REST/Miniflux/V1.php | 36 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/docs/en/030_Supported_Protocols/005_Miniflux.md b/docs/en/030_Supported_Protocols/005_Miniflux.md index c098aa1e..da52cb49 100644 --- a/docs/en/030_Supported_Protocols/005_Miniflux.md +++ b/docs/en/030_Supported_Protocols/005_Miniflux.md @@ -36,6 +36,8 @@ Miniflux version 2.0.27 is emulated, though not all features are implemented - Filtering rules may not function identically (see below for details) - The `checked_at` field of feeds indicates when the feed was last updated rather than when it was last checked - Creating a feed with the `scrape` property set to `true` might not return scraped content for the initial synchronization +- Querying articles for both read/unread and removed statuses will not return all removed articles +- Search strings will match partial words # Behaviour of filtering (block and keep) rules diff --git a/lib/REST/Miniflux/V1.php b/lib/REST/Miniflux/V1.php index 23d9e021..57398f88 100644 --- a/lib/REST/Miniflux/V1.php +++ b/lib/REST/Miniflux/V1.php @@ -109,6 +109,7 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { 'keeplist_rules' => "keep_rule", 'blocklist_rules' => "block_rule", ]; + protected const ARTICLE_COLUMNS = ["id", "url", "title", "author", "fingerprint", "subscription", "published_date", "modified_date", "starred", "unread", "content", "media_url", "media_type"]; protected const CALLS = [ // handler method Admin Path Body Query Required fields '/categories' => [ 'GET' => ["getCategories", false, false, false, false, []], @@ -891,6 +892,41 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { ]); } + protected function getEntries(array $query): ResponseInterface { + $c = (new Context) + ->limit($query['limit']) + ->offset($query['offset']) + ->starred($query['starred']) + ->modifiedSince($query['after']) // FIXME: This may not be the correct date field + ->notModifiedSince($query['before']) + ->oldestArticle($query['after_entry_id'] ? $query['after_entry_id'] + 1 : null) // FIXME: This might be edition + ->latestArticle($query['before_entry_id'] ? $query['before_entry_id'] - 1 : null) + ->searchTerms(strlen($query['search'] ?? "") ? preg_split("/\s+/", $query['search']) : null); // NOTE: Miniflux matches only whole words; we match simple substrings + if ($query['category_id']) { + if ($query['category_id'] === 1) { + $c->folderShallow(0); + } else { + $c->folder($query['category_id'] - 1); + } + } + // FIXME: specifying e.g. ?status=read&status=removed should yield all hidden articles and all read articles, but the best we can do is all read articles which are or are not hidden + sort($status = array_unique($query['status'])); + if ($status === ["read", "removed"]) { + $c->unread(false); + } elseif ($status === ["read", "unread"]) { + $c->hidden(false); + } elseif ($status === ["read"]) { + $c->hidden(false)->unread(false); + } elseif ($status === ["removed", "unread"]) { + $c->unread(true); + } elseif ($status === ["removed"]) { + $c->hidden(true); + } elseif ($status === ["unread"]) { + $c->hidden(false)->unread(true); + } + $articles = Arsse::$db->articleList(Arsse::$user->id, $c, self::ARTICLE_COLUMNS); + } + public static function tokenGenerate(string $user, string $label): string { // Miniflux produces tokens in base64url alphabet $t = str_replace(["+", "/"], ["-", "_"], base64_encode(random_bytes(self::TOKEN_LENGTH)));