mirror of
https://code.mensbeam.com/MensBeam/Arsse.git
synced 2024-12-23 09:02:41 +00:00
421 lines
17 KiB
PHP
421 lines
17 KiB
PHP
<?php
|
|
/** @license MIT
|
|
* Copyright 2017 J. King, Dustin Wilson et al.
|
|
* See LICENSE and AUTHORS files for details */
|
|
|
|
declare(strict_types=1);
|
|
namespace JKingWeb\Arsse\REST\Fever;
|
|
|
|
use JKingWeb\Arsse\Arsse;
|
|
use JKingWeb\Arsse\Context\Context;
|
|
use JKingWeb\Arsse\Misc\ValueInfo as V;
|
|
use JKingWeb\Arsse\Misc\Date;
|
|
use JKingWeb\Arsse\Db\ExceptionInput;
|
|
use JKingWeb\Arsse\Misc\HTTP;
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
use Psr\Http\Message\ResponseInterface;
|
|
use Laminas\Diactoros\Response\JsonResponse;
|
|
use Laminas\Diactoros\Response\XmlResponse;
|
|
use Laminas\Diactoros\Response\EmptyResponse;
|
|
|
|
class API extends \JKingWeb\Arsse\REST\AbstractHandler {
|
|
public const LEVEL = 3;
|
|
protected const GENERIC_ICON_TYPE = "image/png;base64";
|
|
protected const GENERIC_ICON_DATA = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMjHxIGmVAAAADUlEQVQYV2NgYGBgAAAABQABijPjAAAAAABJRU5ErkJggg==";
|
|
protected const ACCEPTED_TYPES = ["application/x-www-form-urlencoded", "multipart/form-data"];
|
|
|
|
// GET parameters for which we only check presence: these will be converted to booleans
|
|
protected const PARAM_BOOL = ["groups", "feeds", "items", "favicons", "links", "unread_item_ids", "saved_item_ids"];
|
|
// GET parameters which contain meaningful values
|
|
protected const PARAM_GET = [
|
|
'api' => V::T_STRING, // this parameter requires special handling
|
|
'page' => V::T_INT, // parameter for hot links
|
|
'range' => V::T_INT, // parameter for hot links
|
|
'offset' => V::T_INT, // parameter for hot links
|
|
'since_id' => V::T_INT,
|
|
'max_id' => V::T_INT,
|
|
'with_ids' => V::T_STRING,
|
|
'group_ids' => V::T_STRING, // undocumented parameter for 'items' lookup
|
|
'feed_ids' => V::T_STRING, // undocumented parameter for 'items' lookup
|
|
// these should be POST parameters only, but some clients misbehave
|
|
'mark' => V::T_STRING,
|
|
'as' => V::T_STRING,
|
|
'id' => V::T_INT,
|
|
'before' => V::T_DATE,
|
|
'unread_recently_read' => V::T_BOOL,
|
|
];
|
|
// POST parameters, all of which contain meaningful values
|
|
protected const PARAM_POST = [
|
|
'api_key' => V::T_STRING,
|
|
'mark' => V::T_STRING,
|
|
'as' => V::T_STRING,
|
|
'id' => V::T_INT,
|
|
'before' => V::T_DATE,
|
|
'unread_recently_read' => V::T_BOOL,
|
|
];
|
|
|
|
public function __construct() {
|
|
}
|
|
|
|
public function dispatch(ServerRequestInterface $req): ResponseInterface {
|
|
$G = $this->normalizeInputGet($req->getQueryParams() ?? []);
|
|
$P = $this->normalizeInputPost($req->getParsedBody() ?? []);
|
|
if (!isset($G['api'])) {
|
|
// the original would have shown the Fever UI in the absence of the "api" parameter, but we'll return 404
|
|
return new EmptyResponse(404);
|
|
}
|
|
switch ($req->getMethod()) {
|
|
case "OPTIONS":
|
|
return new EmptyResponse(204, [
|
|
'Allow' => "POST",
|
|
'Accept' => implode(", ", self::ACCEPTED_TYPES),
|
|
]);
|
|
case "GET": // HTTP violation required for client "Unread" on iOS
|
|
case "POST":
|
|
if (!HTTP::matchType($req, "", ...self::ACCEPTED_TYPES)) {
|
|
return new EmptyResponse(415, ['Accept' => implode(", ", self::ACCEPTED_TYPES)]);
|
|
}
|
|
$out = [
|
|
'api_version' => self::LEVEL,
|
|
'auth' => 0,
|
|
];
|
|
if ($req->getAttribute("authenticated", false)) {
|
|
// if HTTP authentication was successfully used, set the expected user ID
|
|
Arsse::$user->id = $req->getAttribute("authenticatedUser");
|
|
$out['auth'] = 1;
|
|
} elseif (Arsse::$conf->userHTTPAuthRequired || Arsse::$conf->userPreAuth || $req->getAttribute("authenticationFailed", false)) {
|
|
// otherwise if HTTP authentication failed or is required, deny access at the HTTP level
|
|
return new EmptyResponse(401);
|
|
}
|
|
// produce a full response if authenticated or a basic response otherwise
|
|
if ($this->logIn(strtolower($P['api_key'] ?? ""))) {
|
|
$out = $this->processRequest($this->baseResponse(true), $G, $P);
|
|
} else {
|
|
$out = $this->baseResponse(false);
|
|
}
|
|
// return the result, possibly formatted as XML
|
|
return $this->formatResponse($out, ($G['api'] === "xml"));
|
|
default:
|
|
return new EmptyResponse(405, ['Allow' => "OPTIONS,POST"]);
|
|
}
|
|
}
|
|
|
|
protected function normalizeInputGet(array $data): array {
|
|
$out = [];
|
|
if (array_key_exists("api", $data)) {
|
|
// the "api" parameter must be handled specially as it a string, but null has special meaning
|
|
$data['api'] = $data['api'] ?? "json";
|
|
}
|
|
foreach (self::PARAM_BOOL as $p) {
|
|
// first handle all the boolean parameters
|
|
$out[$p] = array_key_exists($p, $data);
|
|
}
|
|
foreach (self::PARAM_GET as $p => $t) {
|
|
$out[$p] = V::normalize($data[$p] ?? null, $t | V::M_DROP, "unix");
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function normalizeInputPost(array $data): array {
|
|
$out = [];
|
|
foreach (self::PARAM_POST as $p => $t) {
|
|
$out[$p] = V::normalize($data[$p] ?? null, $t | V::M_DROP, "unix");
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function processRequest(array $out, array $G, array $P): array {
|
|
$listUnread = false;
|
|
$listSaved = false;
|
|
if ($P['unread_recently_read']) {
|
|
$this->setUnread();
|
|
$listUnread = true;
|
|
}
|
|
if ($P['mark'] && $P['as'] && is_int($P['id'])) {
|
|
// depending on which mark are being made,
|
|
// either an 'unread_item_ids' or a
|
|
// 'saved_item_ids' entry will be added later
|
|
$listSaved = $this->setMarks($P, $listUnread);
|
|
} elseif ($G['mark'] && $G['as'] && is_int($G['id'])) {
|
|
// some clients send GET rather than POST parameters for marking
|
|
$listSaved = $this->setMarks($G, $listUnread);
|
|
}
|
|
if ($G['feeds'] || $G['groups']) {
|
|
if ($G['groups']) {
|
|
$out['groups'] = $this->getGroups();
|
|
}
|
|
if ($G['feeds']) {
|
|
$out['feeds'] = $this->getFeeds();
|
|
}
|
|
$out['feeds_groups'] = $this->getRelationships();
|
|
}
|
|
if ($G['favicons']) {
|
|
// TODO: implement favicons properly
|
|
// we provide a single blank favicon for now
|
|
$out['favicons'] = [
|
|
[
|
|
'id' => 0,
|
|
'data' => self::GENERIC_ICON_TYPE.",".self::GENERIC_ICON_DATA,
|
|
],
|
|
];
|
|
}
|
|
if ($G['items']) {
|
|
$out['items'] = $this->getItems($G);
|
|
$out['total_items'] = Arsse::$db->articleCount(Arsse::$user->id, (new Context)->hidden(false));
|
|
}
|
|
if ($G['links']) {
|
|
// TODO: implement hot links
|
|
$out['links'] = [];
|
|
}
|
|
if ($G['unread_item_ids'] || $listUnread) {
|
|
$out['unread_item_ids'] = $this->getItemIds((new Context)->unread(true)->hidden(false));
|
|
}
|
|
if ($G['saved_item_ids'] || $listSaved) {
|
|
$out['saved_item_ids'] = $this->getItemIds((new Context)->starred(true)->hidden(false));
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function baseResponse(bool $authenticated): array {
|
|
$out = [
|
|
'api_version' => self::LEVEL,
|
|
'auth' => (int) $authenticated,
|
|
];
|
|
if ($authenticated) {
|
|
// authenticated requests always include the most recent feed refresh
|
|
$out['last_refreshed_on_time'] = $this->getRefreshTime();
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function formatResponse(array $data, bool $xml): ResponseInterface {
|
|
if ($xml) {
|
|
$d = new \DOMDocument("1.0", "utf-8");
|
|
$d->appendChild($this->makeXMLAssoc($data, $d->createElement("response")));
|
|
return new XmlResponse($d->saveXML());
|
|
} else {
|
|
return new JsonResponse($data, 200, [], \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE);
|
|
}
|
|
}
|
|
|
|
protected function makeXMLAssoc(array $data, \DOMElement $p): \DOMElement {
|
|
$d = $p->ownerDocument;
|
|
foreach ($data as $k => $v) {
|
|
if (!is_array($v)) {
|
|
$p->appendChild($d->createElement($k, (string) $v));
|
|
} elseif (isset($v[0])) {
|
|
// this is a very simplistic check for an indexed array
|
|
// it would not pass muster in the face of generic data,
|
|
// but we'll assume our code produces only well-ordered
|
|
// indexed arrays
|
|
$p->appendChild($this->makeXMLIndexed($v, $d->createElement($k), substr($k, 0, strlen($k) - 1)));
|
|
} else {
|
|
// this case is never encountered with Fever's output
|
|
$p->appendChild($this->makeXMLAssoc($v, $d->createElement($k))); // @codeCoverageIgnore
|
|
}
|
|
}
|
|
return $p;
|
|
}
|
|
|
|
protected function makeXMLIndexed(array $data, \DOMElement $p, string $k): \DOMElement {
|
|
$d = $p->ownerDocument;
|
|
foreach ($data as $v) {
|
|
if (!is_array($v)) {
|
|
// this case is never encountered with Fever's output
|
|
$p->appendChild($d->createElement($k, (string) $v)); // @codeCoverageIgnore
|
|
} elseif (isset($v[0])) {
|
|
// this case is never encountered with Fever's output
|
|
$p->appendChild($this->makeXMLIndexed($v, $d->createElement($k), substr($k, 0, strlen($k) - 1))); // @codeCoverageIgnore
|
|
} else {
|
|
$p->appendChild($this->makeXMLAssoc($v, $d->createElement($k)));
|
|
}
|
|
}
|
|
return $p;
|
|
}
|
|
|
|
protected function logIn(string $hash): bool {
|
|
// if HTTP authentication was successful and sessions are not enforced, proceed unconditionally
|
|
if (isset(Arsse::$user->id) && !Arsse::$conf->userSessionEnforced) {
|
|
return true;
|
|
}
|
|
try {
|
|
// verify the supplied hash is valid
|
|
$s = Arsse::$db->TokenLookup("fever.login", $hash);
|
|
} catch (ExceptionInput $e) {
|
|
return false;
|
|
}
|
|
// set the user name
|
|
Arsse::$user->id = $s['user'];
|
|
return true;
|
|
}
|
|
|
|
protected function setMarks(array $P, &$listUnread): bool {
|
|
$listSaved = false;
|
|
$c = new Context;
|
|
$id = $P['id'];
|
|
if ($P['before']) {
|
|
$c->notMarkedSince($P['before']);
|
|
}
|
|
switch ($P['mark']) {
|
|
case "item":
|
|
$c->article($id);
|
|
break;
|
|
case "group":
|
|
if ($id > 0) {
|
|
// concrete groups
|
|
$c->tag($id)->hidden(false);
|
|
} elseif ($id < 0) {
|
|
// group negative-one is the "Sparks" supergroup i.e. no feeds
|
|
$c->not->folder(0);
|
|
} else {
|
|
// group zero is the "Kindling" supergroup i.e. all feeds
|
|
// only exclude hidden articles
|
|
$c->hidden(false);
|
|
}
|
|
break;
|
|
case "feed":
|
|
$c->subscription($id)->hidden(false);
|
|
break;
|
|
default:
|
|
return $listSaved;
|
|
}
|
|
switch ($P['as']) {
|
|
case "read":
|
|
$data = ['read' => true];
|
|
$listUnread = true;
|
|
break;
|
|
case "unread":
|
|
// this option is undocumented, but valid
|
|
$data = ['read' => false];
|
|
$listUnread = true;
|
|
break;
|
|
case "saved":
|
|
$data = ['starred' => true];
|
|
$listSaved = true;
|
|
break;
|
|
case "unsaved":
|
|
$data = ['starred' => false];
|
|
$listSaved = true;
|
|
break;
|
|
default:
|
|
return $listSaved;
|
|
}
|
|
try {
|
|
Arsse::$db->articleMark(Arsse::$user->id, $data, $c);
|
|
} catch (ExceptionInput $e) {
|
|
// ignore any errors
|
|
}
|
|
return $listSaved;
|
|
}
|
|
|
|
protected function setUnread(): void {
|
|
$lastUnread = Arsse::$db->articleList(Arsse::$user->id, (new Context)->hidden(false)->limit(1), ["marked_date"], ["marked_date desc"])->getValue();
|
|
if (!$lastUnread) {
|
|
// there are no articles
|
|
return;
|
|
}
|
|
// Fever takes the date of the last read article less fifteen seconds as a cut-off.
|
|
// We take the date of last mark (whether it be read, unread, saved, unsaved), which
|
|
// may not actually signify a mark, but we'll otherwise also count back fifteen seconds
|
|
$c = (new Context)->hidden(false);
|
|
$lastUnread = Date::normalize($lastUnread, "sql");
|
|
$since = Date::sub("PT15S", $lastUnread);
|
|
$c->unread(false)->markedSince($since);
|
|
Arsse::$db->articleMark(Arsse::$user->id, ['read' => false], $c);
|
|
}
|
|
|
|
protected function getRefreshTime(): ?int {
|
|
return Date::transform(Arsse::$db->subscriptionRefreshed(Arsse::$user->id), "unix");
|
|
}
|
|
|
|
protected function getFeeds(): array {
|
|
$out = [];
|
|
foreach (arsse::$db->subscriptionList(Arsse::$user->id) as $sub) {
|
|
$out[] = [
|
|
'id' => (int) $sub['id'],
|
|
'favicon_id' => 0, // TODO: implement favicons
|
|
'title' => (string) $sub['title'],
|
|
'url' => $sub['url'],
|
|
'site_url' => $sub['source'],
|
|
'is_spark' => 0,
|
|
'last_updated_on_time' => Date::transform($sub['edited'], "unix", "sql"),
|
|
];
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function getGroups(): array {
|
|
$out = [];
|
|
foreach (Arsse::$db->tagList(Arsse::$user->id) as $member) {
|
|
$out[] = [
|
|
'id' => (int) $member['id'],
|
|
'title' => $member['name'],
|
|
];
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function getRelationships(): array {
|
|
$out = [];
|
|
$sets = [];
|
|
foreach (Arsse::$db->tagSummarize(Arsse::$user->id) as $member) {
|
|
if (!isset($sets[$member['id']])) {
|
|
$sets[$member['id']] = [];
|
|
}
|
|
$sets[$member['id']][] = (int) $member['subscription'];
|
|
}
|
|
foreach ($sets as $id => $subs) {
|
|
$out[] = [
|
|
'group_id' => (int) $id,
|
|
'feed_ids' => implode(",", $subs),
|
|
];
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function getItems(array $G): array {
|
|
$c = (new Context)->hidden(false)->limit(50);
|
|
$reverse = false;
|
|
// handle the standard options
|
|
if ($G['with_ids']) {
|
|
$c->articles(explode(",", $G['with_ids']))->hidden(null);
|
|
} elseif ($G['max_id']) {
|
|
$c->latestArticle($G['max_id'] - 1);
|
|
$reverse = true;
|
|
} elseif ($G['since_id']) {
|
|
$c->oldestArticle($G['since_id'] + 1);
|
|
}
|
|
// handle the undocumented options
|
|
if ($G['group_ids']) {
|
|
$c->tags(explode(",", $G['group_ids']));
|
|
}
|
|
if ($G['feed_ids']) {
|
|
$c->subscriptions(explode(",", $G['feed_ids']));
|
|
}
|
|
// get results
|
|
$out = [];
|
|
$order = $reverse ? "id desc" : "id";
|
|
foreach (Arsse::$db->articleList(Arsse::$user->id, $c, ["id", "subscription", "title", "author", "content", "url", "starred", "unread", "published_date"], [$order]) as $r) {
|
|
$out[] = [
|
|
'id' => (int) $r['id'],
|
|
'feed_id' => (int) $r['subscription'],
|
|
'title' => (string) $r['title'],
|
|
'author' => (string) $r['author'],
|
|
'html' => (string) $r['content'],
|
|
'url' => (string) $r['url'],
|
|
'is_saved' => (int) $r['starred'],
|
|
'is_read' => (int) !$r['unread'],
|
|
'created_on_time' => Date::transform($r['published_date'], "unix", "sql"),
|
|
];
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
protected function getItemIds(Context $c): string {
|
|
$out = [];
|
|
foreach (Arsse::$db->articleList(Arsse::$user->id, $c) as $r) {
|
|
$out[] = (int) $r['id'];
|
|
}
|
|
return implode(",", $out);
|
|
}
|
|
}
|