From d85988f09d2dc8d564ee7b15c5199f5e40c8e18f Mon Sep 17 00:00:00 2001 From: "J. King" Date: Tue, 8 Dec 2020 15:34:31 -0500 Subject: [PATCH] Prototype Miniflux user querying --- lib/Misc/Date.php | 2 +- lib/REST/Miniflux/V1.php | 94 +++++++++++++++++++++++++++++++++++----- locale/en.php | 2 + 3 files changed, 85 insertions(+), 13 deletions(-) diff --git a/lib/Misc/Date.php b/lib/Misc/Date.php index 6972ea5..6384f4f 100644 --- a/lib/Misc/Date.php +++ b/lib/Misc/Date.php @@ -6,7 +6,7 @@ declare(strict_types=1); namespace JKingWeb\Arsse\Misc; -class Date { +abstract class Date { public static function transform($date, string $outFormat = null, string $inFormat = null) { $date = ValueInfo::normalize($date, ValueInfo::T_DATE, $inFormat); if (!$date) { diff --git a/lib/REST/Miniflux/V1.php b/lib/REST/Miniflux/V1.php index 321716d..2f2685f 100644 --- a/lib/REST/Miniflux/V1.php +++ b/lib/REST/Miniflux/V1.php @@ -12,6 +12,7 @@ use JKingWeb\Arsse\Feed\Exception as FeedException; use JKingWeb\Arsse\AbstractException; use JKingWeb\Arsse\Db\ExceptionInput; use JKingWeb\Arsse\Misc\HTTP; +use JKingWeb\Arsse\Misc\Date; use JKingWeb\Arsse\Misc\ValueInfo as V; use JKingWeb\Arsse\REST\Exception; use JKingWeb\Arsse\User\ExceptionConflict as UserException; @@ -32,8 +33,7 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { 'password' => "string", 'user_agent' => "string", ]; - - protected $paths = [ + protected const PATHS = [ '/categories' => ['GET' => "getCategories", 'POST' => "createCategory"], '/categories/1' => ['PUT' => "updateCategory", 'DELETE' => "deleteCategory"], '/discover' => ['POST' => "discoverSubscriptions"], @@ -42,7 +42,7 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { '/entries/1/bookmark' => ['PUT' => "toggleEntryBookmark"], '/export' => ['GET' => "opmlExport"], '/feeds' => ['GET' => "getFeeds", 'POST' => "createFeed"], - '/feeds/1' => ['GET' => "getFeed", 'PUT' => "updateFeed", 'DELETE' => "removeFeed"], + '/feeds/1' => ['GET' => "getFeed", 'PUT' => "updateFeed", 'DELETE' => "removeFeed"], '/feeds/1/entries/1' => ['GET' => "getFeedEntry"], '/feeds/1/entries' => ['GET' => "getFeedEntries"], '/feeds/1/icon' => ['GET' => "getFeedIcon"], @@ -51,8 +51,16 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { '/import' => ['POST' => "opmlImport"], '/me' => ['GET' => "getCurrentUser"], '/users' => ['GET' => "getUsers", 'POST' => "createUser"], - '/users/1' => ['GET' => "getUser", 'PUT' => "updateUser", 'DELETE' => "deleteUser"], - '/users/*' => ['GET' => "getUser"], + '/users/1' => ['GET' => "getUserByNum", 'PUT' => "updateUserByNum", 'DELETE' => "deleteUser"], + '/users/*' => ['GET' => "getUserById"], + ]; + protected const ADMIN_FUNCTIONS = [ + 'getUsers' => true, + 'getUserByNum' => true, + 'getUserById' => true, + 'createUser' => true, + 'updateUserByNum' => true, + 'deleteUser' => true, ]; public function __construct() { @@ -80,6 +88,11 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { return false; } + protected function isAdmin(): bool { + return (bool) Arsse::$user->propertiesGet(Arsse::$user->id, false)['admin']; + } + + public function dispatch(ServerRequestInterface $req): ResponseInterface { // try to authenticate if (!$this->authenticate($req)) { @@ -96,6 +109,9 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { if ($func instanceof ResponseInterface) { return $func; } + if ((self::ADMIN_FUNCTIONS[$func] ?? false) && !$this->isAdmin()) { + return new ErrorResponse("403", 403); + } $data = []; $query = []; if ($func === "opmlImport") { @@ -148,9 +164,9 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { protected function handleHTTPOptions(string $url): ResponseInterface { // normalize the URL path: change any IDs to 1 for easier comparison $url = $this->normalizePathIDs($url); - if (isset($this->paths[$url])) { + if (isset(self::PATHS[$url])) { // if the path is supported, respond with the allowed methods and other metadata - $allowed = array_keys($this->paths[$url]); + $allowed = array_keys(self::PATHS[$url]); // if GET is allowed, so is HEAD if (in_array("GET", $allowed)) { array_unshift($allowed, "HEAD"); @@ -172,15 +188,15 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { $method = strtoupper($method); // we now evaluate the supplied URL against every supported path for the selected scope // the URL is evaluated as an array so as to avoid decoded escapes turning invalid URLs into valid ones - if (isset($this->paths[$url])) { + if (isset(self::PATHS[$url])) { // if the path is supported, make sure the method is allowed - if (isset($this->paths[$url][$method])) { + if (isset(self::PATHS[$url][$method])) { // if it is allowed, return the object method to run, assuming the method exists - assert(method_exists($this, $this->paths[$url][$method]), new \Exception("Method is not implemented")); - return $this->paths[$url][$method]; + assert(method_exists($this, self::PATHS[$url][$method]), new \Exception("Method is not implemented")); + return self::PATHS[$url][$method]; } else { // otherwise return 405 - return new EmptyResponse(405, ['Allow' => implode(", ", array_keys($this->paths[$url]))]); + return new EmptyResponse(405, ['Allow' => implode(", ", array_keys(self::PATHS[$url]))]); } } else { // if the path is not supported, return 404 @@ -200,6 +216,40 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { return $body; } + protected function listUsers(array $users, bool $reportMissing): array { + $out = []; + $now = Date::transform("now", "iso8601m"); + foreach ($users as $u) { + try { + $info = Arsse::$user->propertiesGet($u, true); + } catch (UserException $e) { + if ($reportMissing) { + throw $e; + } else { + continue; + } + } + $out[] = [ + 'id' => $info['num'], + 'username' => $u, + 'is_admin' => $info['admin'] ?? false, + 'theme' => $info['theme'] ?? "light_serif", + 'language' => $info['lang'] ?? "en_US", + 'timezone' => $info['tz'] ?? "UTC", + 'entry_sorting_direction' => ($info['sort_asc'] ?? false) ? "asc" : "desc", + 'entries_per_page' => $info['page_size'] ?? 100, + 'keyboard_shortcuts' => $info['shortcuts'] ?? true, + 'show_reading_time' => $info['reading_time'] ?? true, + 'last_login_at' => $now, + 'entry_swipe' => $info['swipe'] ?? true, + 'extra' => [ + 'custom_css' => $info['stylesheet'] ?? "", + ], + ]; + } + return $out; + } + protected function discoverSubscriptions(array $path, array $query, array $data) { try { $list = Feed::discoverAll((string) $data['url'], (string) $data['username'], (string) $data['password']); @@ -219,6 +269,26 @@ class V1 extends \JKingWeb\Arsse\REST\AbstractHandler { return new Response($out); } + protected function getUsers(array $path, array $query, array $data) { + return new Response($this->listUsers(Arsse::$user->list(), false)); + } + + protected function getUserById(array $path, array $query, array $data) { + try { + return $this->listUsers([$path[1]], true)[0] ?? []; + } catch (UserException $e) { + return new ErrorResponse("404", 404); + } + } + + protected function getUserByNum(array $path, array $query, array $data) { + return $this->listUsers([Arsse::$user->id], false)[0] ?? []; + } + + protected function getCurrentUser(array $path, array $query, array $data) { + return new Response($this->listUsers([Arsse::$user->id], false)[0] ?? new \stdClass); + } + 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))); diff --git a/locale/en.php b/locale/en.php index cbf3d79..75b52e5 100644 --- a/locale/en.php +++ b/locale/en.php @@ -8,6 +8,8 @@ return [ 'CLI.Auth.Failure' => 'Authentication failed', 'API.Miniflux.Error.401' => 'Access Unauthorized', + 'API.Miniflux.Error.403' => 'Access Forbidden', + 'API.Miniflux.Error.404' => 'Resource Not Found', 'API.Miniflux.Error.invalidBodyJSON' => 'Invalid JSON payload: {0}', 'API.Miniflux.Error.invalidInputType' => 'Input key "{field}" of type {actual} was expected as {expected}', 'API.Miniflux.Error.fetch404' => 'Resource not found (404), this feed doesn\'t exists anymore, check the feed URL',