From 1826ecd58875a9ca35080a4db84402ebdc2fc824 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sat, 27 Apr 2024 22:05:39 -0400 Subject: [PATCH 1/5] Derive feed from HTML (#10) - Prevent duplicate feed subscriptions - Move FeedItem to its own file --- src/app-config.php | 2 +- src/lib/Feed.php | 203 ++++++++++++++++++++----------------------- src/lib/FeedItem.php | 80 +++++++++++++++++ 3 files changed, 177 insertions(+), 108 deletions(-) create mode 100644 src/lib/FeedItem.php diff --git a/src/app-config.php b/src/app-config.php index d5e34c9..8e8751d 100644 --- a/src/app-config.php +++ b/src/app-config.php @@ -1,7 +1,7 @@ ` tag - * - * @param DOMNode $node The XML node from which a feed item should be constructed - * @return FeedItem A feed item constructed from the given node - */ - public static function fromAtom(DOMNode $node): FeedItem { - $guid = Feed::atomValue($node, 'id'); - $link = ''; - foreach ($node->getElementsByTagName('link') as $linkElt) { - if ($linkElt->hasAttributes()) { - $relAttr = $linkElt->attributes->getNamedItem('rel'); - if ($relAttr && $relAttr->value == 'alternate') { - $link = $linkElt->attributes->getNamedItem('href')->value; - break; - } - } - } - if ($link == '' && str_starts_with($guid, 'http')) $link = $guid; - - $item = new FeedItem(); - $item->guid = $guid; - $item->title = Feed::atomValue($node, 'title'); - $item->link = $link; - $item->publishedOn = Data::formatDate(Feed::atomValue($node, 'published')); - $item->updatedOn = Data::formatDate(Feed::atomValue($node, 'updated')); - $item->content = Feed::atomValue($node, 'content'); - - return $item; - } - - /** - * Construct a feed item from an RSS feed's `` tag - * - * @param DOMNode $node The XML node from which a feed item should be constructed - * @return FeedItem A feed item constructed from the given node - */ - public static function fromRSS(DOMNode $node): FeedItem { - $itemGuid = Feed::rssValue($node, 'guid'); - $updNodes = $node->getElementsByTagNameNS(Feed::ATOM_NS, 'updated'); - $encNodes = $node->getElementsByTagNameNS(Feed::CONTENT_NS, 'encoded'); - - $item = new FeedItem(); - $item->guid = $itemGuid == 'guid not found' ? Feed::rssValue($node, 'link') : $itemGuid; - $item->title = Feed::rssValue($node, 'title'); - $item->link = Feed::rssValue($node, 'link'); - $item->publishedOn = Data::formatDate(Feed::rssValue($node, 'pubDate')); - $item->updatedOn = Data::formatDate($updNodes->length > 0 ? $updNodes->item(0)->textContent : null); - $item->content = $encNodes->length > 0 - ? $encNodes->item(0)->textContent - : Feed::rssValue($node, 'description'); - - return $item; - } -} - /** * Feed retrieval, parsing, and manipulation */ @@ -114,7 +35,7 @@ class Feed { * @throws DOMException If the error is a warning */ private static function xmlParseError(int $errno, string $errstr): bool { - if ($errno == E_WARNING && substr_count($errstr, 'DOMDocument::loadXml()') > 0) { + if ($errno == E_WARNING && substr_count($errstr, 'DOMDocument::loadXML()') > 0) { throw new DOMException($errstr, $errno); } return false; @@ -181,6 +102,17 @@ class Feed { return ['ok' => $feed]; } + /** + * Get an attribute value from a DOM node + * + * @param DOMNode $node The node with an attribute value to obtain + * @param string $name The name of the attribute whose value should be obtained + * @return string The attribute value if it exists, an empty string if not + */ + private static function attrValue(DOMNode $node, string $name): string { + return ($node->hasAttributes() ? $node->attributes->getNamedItem($name)?->value : null) ?? ''; + + } /** * Get the value of a child element by its tag name for an Atom feed * @@ -196,7 +128,7 @@ class Feed { if ($tags->length == 0) return "$tagName not found"; $tag = $tags->item(0); if (!($tag instanceof DOMElement)) return $tag->textContent; - if ($tag->hasAttributes() && $tag->attributes->getNamedItem('type') == 'xhtml') { + if (self::attrValue($tag, 'type') == 'xhtml') { $div = $tag->getElementsByTagNameNS(Feed::XHTML_NS, 'div'); if ($div->length == 0) return "-- invalid XHTML content --"; return $div->item(0)->textContent; @@ -225,6 +157,54 @@ class Feed { return ['ok' => $feed]; } + /** + * Retrieve a document (http/https) + * + * @param string $url The URL of the document to retrieve + * @return array ['content' => document content, 'error' => error message, 'code' => HTTP response code, + * 'url' => effective URL] + */ + private static function retrieveDocument(string $url): array { + $docReq = curl_init($url); + curl_setopt($docReq, CURLOPT_FOLLOWLOCATION, true); + curl_setopt($docReq, CURLOPT_RETURNTRANSFER, true); + curl_setopt($docReq, CURLOPT_CONNECTTIMEOUT, 5); + curl_setopt($docReq, CURLOPT_TIMEOUT, 15); + + $result = [ + 'content' => curl_exec($docReq), + 'error' => curl_error($docReq), + 'code' => curl_getinfo($docReq, CURLINFO_RESPONSE_CODE), + 'url' => curl_getinfo($docReq, CURLINFO_EFFECTIVE_URL) + ]; + + curl_close($docReq); + return $result; + } + + /** + * Derive a feed URL from an HTML document + * + * @param string $content The HTML document content from which to derive a feed URL + * @return array|string[] ['ok' => feed URL] if successful, ['error' => message] if not + */ + private static function deriveFeedFromHTML(string $content): array { + $html = new DOMDocument(); + $html->loadHTML(substr($content, 0, strpos($content, '') + 7)); + $headTags = $html->getElementsByTagName('head'); + if ($headTags->length < 1) return ['error' => 'Cannot find feed at this URL']; + $head = $headTags->item(0); + foreach ($head->getElementsByTagName('link') as $link) { + if (self::attrValue($link, 'rel') == 'alternate') { + $type = self::attrValue($link, 'type'); + if ($type == 'application/rss+xml' || $type == 'application/atom+xml') { + return ['ok' => self::attrValue($link, 'href')]; + } + } + } + return ['error' => 'Cannot find feed at this URL']; + } + /** * Retrieve the feed * @@ -232,34 +212,33 @@ class Feed { * @return array|Feed[]|string[] ['ok' => feed] if successful, ['error' => message] if not */ public static function retrieveFeed(string $url): array { - $feedReq = curl_init($url); - curl_setopt($feedReq, CURLOPT_FOLLOWLOCATION, true); - curl_setopt($feedReq, CURLOPT_RETURNTRANSFER, true); - curl_setopt($feedReq, CURLOPT_CONNECTTIMEOUT, 5); - curl_setopt($feedReq, CURLOPT_TIMEOUT, 15); + $doc = self::retrieveDocument($url); - $feedContent = curl_exec($feedReq); - - $result = array(); - $error = curl_error($feedReq); - $code = curl_getinfo($feedReq, CURLINFO_RESPONSE_CODE); - if ($error) { - $result['error'] = $error; - } elseif ($code == 200) { - $parsed = self::parseFeed($feedContent); - if (array_key_exists('error', $parsed)) { - $result['error'] = $parsed['error']; - } else { - $extract = $parsed['ok']->getElementsByTagNameNS(self::ATOM_NS, 'feed')->length > 0 - ? self::fromAtom(...) : self::fromRSS(...); - $result = $extract($parsed['ok'], curl_getinfo($feedReq, CURLINFO_EFFECTIVE_URL)); - } - } else { - $result['error'] = "Prospective feed URL $url returned HTTP Code $code: $feedContent"; + if ($doc['error'] != '') return ['error' => $doc['error']]; + if ($doc['code'] != 200) { + return ['error' => "Prospective feed URL $url returned HTTP Code {$doc['code']}: {$doc['content']}"]; } - curl_close($feedReq); - return $result; + $start = strtolower(strlen($doc['content']) >= 9 ? substr($doc['content'], 0, 9) : $doc['content']); + if ($start == ' $derivedURL['error']]; + $feedURL = $derivedURL['ok']; + if (!str_starts_with($feedURL, 'http')) { + // Relative URL; feed should be retrieved in the context of the original URL + $original = parse_url($url); + $port = array_key_exists('port', $original) ? ":{$original['port']}" : ''; + $feedURL = "{$original['scheme']}://{$original['host']}$port$feedURL"; + } + $doc = self::retrieveDocument($feedURL); + } + + $parsed = self::parseFeed($doc['content']); + if (array_key_exists('error', $parsed)) return ['error' => $parsed['error']]; + + $extract = $parsed['ok']->getElementsByTagNameNS(self::ATOM_NS, 'feed')->length > 0 + ? self::fromAtom(...) : self::fromRSS(...); + return $extract($parsed['ok'], $doc['url']); } /** @@ -398,7 +377,17 @@ class Feed { $feedExtract = self::retrieveFeed($url); if (array_key_exists('error', $feedExtract)) return $feedExtract; - $feed = $feedExtract['ok']; + $feed = $feedExtract['ok']; + + $existsQuery = $db->prepare('SELECT COUNT(*) FROM feed WHERE user_id = :user AND url = :url'); + $existsQuery->bindValue(':user', $_SESSION[Key::USER_ID]); + $existsQuery->bindValue(':url', $feed->url); + $existsResult = $existsQuery->execute(); + if (!$existsResult) return ['error' => 'SQLite error: ' . $db->lastErrorMsg()]; + + $exists = $existsResult->fetchArray(SQLITE3_NUM); + if ($exists[0] != 0) return ['error' => "Already subscribed to feed $feed->url"]; + $query = $db->prepare(<<<'SQL' INSERT INTO feed (user_id, url, title, updated_on, checked_on) VALUES (:user, :url, :title, :updated, :checked) diff --git a/src/lib/FeedItem.php b/src/lib/FeedItem.php new file mode 100644 index 0000000..ab6aa04 --- /dev/null +++ b/src/lib/FeedItem.php @@ -0,0 +1,80 @@ +` tag + * + * @param DOMNode $node The XML node from which a feed item should be constructed + * @return FeedItem A feed item constructed from the given node + */ + public static function fromAtom(DOMNode $node): FeedItem { + $guid = Feed::atomValue($node, 'id'); + $link = ''; + foreach ($node->getElementsByTagName('link') as $linkElt) { + if ($linkElt->hasAttributes()) { + $relAttr = $linkElt->attributes->getNamedItem('rel'); + if ($relAttr && $relAttr->value == 'alternate') { + $link = $linkElt->attributes->getNamedItem('href')->value; + break; + } + } + } + if ($link == '' && str_starts_with($guid, 'http')) $link = $guid; + + $item = new FeedItem(); + $item->guid = $guid; + $item->title = Feed::atomValue($node, 'title'); + $item->link = $link; + $item->publishedOn = Data::formatDate(Feed::atomValue($node, 'published')); + $item->updatedOn = Data::formatDate(Feed::atomValue($node, 'updated')); + $item->content = Feed::atomValue($node, 'content'); + + return $item; + } + + /** + * Construct a feed item from an RSS feed's `` tag + * + * @param DOMNode $node The XML node from which a feed item should be constructed + * @return FeedItem A feed item constructed from the given node + */ + public static function fromRSS(DOMNode $node): FeedItem { + $itemGuid = Feed::rssValue($node, 'guid'); + $updNodes = $node->getElementsByTagNameNS(Feed::ATOM_NS, 'updated'); + $encNodes = $node->getElementsByTagNameNS(Feed::CONTENT_NS, 'encoded'); + + $item = new FeedItem(); + $item->guid = $itemGuid == 'guid not found' ? Feed::rssValue($node, 'link') : $itemGuid; + $item->title = Feed::rssValue($node, 'title'); + $item->link = Feed::rssValue($node, 'link'); + $item->publishedOn = Data::formatDate(Feed::rssValue($node, 'pubDate')); + $item->updatedOn = Data::formatDate($updNodes->length > 0 ? $updNodes->item(0)->textContent : null); + $item->content = $encNodes->length > 0 + ? $encNodes->item(0)->textContent + : Feed::rssValue($node, 'description'); + + return $item; + } +} From 10638101d326f5ebe6902435091bb233d981ab19 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sun, 28 Apr 2024 14:09:53 -0400 Subject: [PATCH 2/5] Add refresh utility script (#11) --- src/lib/Feed.php | 56 ++++++++++++++++++++++++++------------------ src/util/refresh.php | 53 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+), 23 deletions(-) create mode 100644 src/util/refresh.php diff --git a/src/lib/Feed.php b/src/lib/Feed.php index 08c21f2..459fc83 100644 --- a/src/lib/Feed.php +++ b/src/lib/Feed.php @@ -228,7 +228,7 @@ class Feed { // Relative URL; feed should be retrieved in the context of the original URL $original = parse_url($url); $port = array_key_exists('port', $original) ? ":{$original['port']}" : ''; - $feedURL = "{$original['scheme']}://{$original['host']}$port$feedURL"; + $feedURL = $original['scheme'] . '://' . $original['host'] . $port . $feedURL; } $doc = self::retrieveDocument($feedURL); } @@ -329,17 +329,12 @@ class Feed { /** * Refresh a feed * + * @param int $feedId The ID of the feed to be refreshed * @param string $url The URL of the feed to be refreshed * @param SQLite3 $db A database connection to use to refresh the feed * @return array|string[]|true[] ['ok' => true] if successful, ['error' => message] if not */ - private static function refreshFeed(string $url, SQLite3 $db): array { - $feedQuery = $db->prepare('SELECT id FROM feed WHERE url = :url AND user_id = :user'); - $feedQuery->bindValue(':url', $url); - $feedQuery->bindValue(':user', $_SESSION[Key::USER_ID]); - $feedResult = $feedQuery->execute(); - $feedId = $feedResult ? $feedResult->fetchArray(SQLITE3_NUM)[0] : -1; - if ($feedId < 0) return ['error' => "No feed for URL $url found"]; + public static function refreshFeed(int $feedId, string $url, SQLite3 $db): array { $feedExtract = self::retrieveFeed($url); if (array_key_exists('error', $feedExtract)) return $feedExtract; @@ -423,7 +418,26 @@ class Feed { $query->bindValue(':user', $_SESSION[Key::USER_ID]); $query->execute(); - return self::refreshFeed($url, $db); + return self::refreshFeed($existing['id'], $url, $db); + } + + /** + * Retrieve all feeds, optionally for a specific user + * + * @param SQLite3 $db The database connection to use to retrieve the feeds + * @param int $user The ID of the user whose feeds should be retrieved (optional, defaults to all feeds) + * @return array An array of arrays with ['id', 'url', 'email'] keys + */ + public static function retrieveAll(SQLite3 $db, int $user = 0): array { + $extraSQL = $user > 0 ? ' WHERE u.id = :user' : ''; + $query = $db->prepare( + "SELECT f.id, f.url, u.email FROM feed f INNER JOIN frc_user u ON u.id = f.user_id$extraSQL"); + if ($user > 0) $query->bindValue(':user', $user); + $result = $query->execute(); + if (!$result) return ['error', $db->lastErrorMsg()]; + $feeds = []; + while ($feed = $result->fetchArray(SQLITE3_ASSOC)) $feeds[] = $feed; + return $feeds; } /** @@ -433,19 +447,15 @@ class Feed { * @return array|true[] ['ok => true] if successful, ['error' => message] if not (may have multiple error lines) */ public static function refreshAll(SQLite3 $db): array { - $query = $db->prepare('SELECT url FROM feed WHERE user_id = :user'); - $query->bindValue(':user', $_SESSION[Key::USER_ID]); - $result = $query->execute(); - $url = $result ? $result->fetchArray(SQLITE3_NUM) : false; - if ($url) { - $errors = array(); - while ($url) { - $updateResult = self::refreshFeed($url[0], $db); - if (array_key_exists('error', $updateResult)) $errors[] = $updateResult['error']; - $url = $result->fetchArray(SQLITE3_NUM); - } - return sizeof($errors) == 0 ? ['ok' => true] : ['error' => implode("\n", $errors)]; - } - return ['error' => $db->lastErrorMsg()]; + $feeds = self::retrieveAll($db, $_SESSION[Key::USER_ID]); + if (array_key_exists('error', $feeds)) return $feeds; + + $errors = []; + array_walk($feeds, function ($feed) use ($db, &$errors) { + $result = self::refreshFeed($feed['id'], $feed['url'], $db); + if (array_key_exists('error', $result)) $errors[] = $result['error']; + }); + + return sizeof($errors) == 0 ? ['ok' => true] : ['error' => implode("\n", $errors)]; } } diff --git a/src/util/refresh.php b/src/util/refresh.php new file mode 100644 index 0000000..0f77868 --- /dev/null +++ b/src/util/refresh.php @@ -0,0 +1,53 @@ +close(); + } +} From 473dded4f9c857257a499a49e7287b7c96d541af Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sun, 28 Apr 2024 21:16:42 -0400 Subject: [PATCH 3/5] Add docs for scheduled refresh (#11) - Add user agent for feed requests --- src/lib/Feed.php | 5 +++ src/public/docs/index.php | 1 + src/public/docs/refresh-feeds.php | 52 +++++++++++++++++++++++++++++++ 3 files changed, 58 insertions(+) create mode 100644 src/public/docs/refresh-feeds.php diff --git a/src/lib/Feed.php b/src/lib/Feed.php index 459fc83..c5900c7 100644 --- a/src/lib/Feed.php +++ b/src/lib/Feed.php @@ -26,6 +26,10 @@ class Feed { /** @var string The XML namespace for XHTML */ public const string XHTML_NS = 'http://www.w3.org/1999/xhtml'; + /** @var string The user agent for Feed Reader Central's refresh requests */ + private const string USER_AGENT = + 'FeedReaderCentral/' . FRC_VERSION . ' +https://bitbadger.solutions/open-source/feed-reader-central'; + /** * When parsing XML into a DOMDocument, errors are presented as warnings; this creates an exception for them * @@ -170,6 +174,7 @@ class Feed { curl_setopt($docReq, CURLOPT_RETURNTRANSFER, true); curl_setopt($docReq, CURLOPT_CONNECTTIMEOUT, 5); curl_setopt($docReq, CURLOPT_TIMEOUT, 15); + curl_setopt($docReq, CURLOPT_USERAGENT, self::USER_AGENT); $result = [ 'content' => curl_exec($docReq), diff --git a/src/public/docs/index.php b/src/public/docs/index.php index 13ad8c9..37278bf 100644 --- a/src/public/docs/index.php +++ b/src/public/docs/index.php @@ -10,6 +10,7 @@ page_head('Documentation'); ?>

About the CLI provides orientation on Feed Reader Central’s command line interface

Configuring Security Modes describes the three security modes and how to manage each of them +

Refresh Feeds has instructions on how feeds can be refreshed on a schedule close(); diff --git a/src/public/docs/refresh-feeds.php b/src/public/docs/refresh-feeds.php new file mode 100644 index 0000000..1407e83 --- /dev/null +++ b/src/public/docs/refresh-feeds.php @@ -0,0 +1,52 @@ + +

Refresh Feeds

+

⟨⟨ Documentation Home +

+

Manual Feed Refresh

+

Next to the “Your Unread Items” heading on the main page, there is a link labeled “Refresh All + Feeds”. Clicking this link will reload the main page once the feeds have been refreshed. Depending on the + number and size of feeds, this may take a bit of time; each feed is refreshed individually. +

Automatic Refreshing

+

The refresh utility script will perform this refresh from the CLI. As it runs, it will list the + feeds as it processes them, and if it encounters any errors, that is noted as well. This process can be + automated via cron on Linux or Mac systems. This is most easily implemented by writing a small + shell script to provide some environment settings, then telling cron to run that script. + 

+#!/bin/bash
+exec 1> >(logger -t feed-reader-central) 2>&1
+cd /path/to/frc
+php-cli util/refresh.php all
+

Save this (frc-refresh.sh might be a good name) and be sure it is executable + (chmod +x ./frc-refresh.sh). Before we put it in crontab, though, let’s understand what each + line does: +

    +
  • Line 1 tells the operating system to use the bash shell. +
  • Line 2 directs all output to the system log (/var/log/syslog), labeling each entry with + feed-reader-central. This lets you review the output for its runs in a log that is already + maintained and rotated by the operating system. +
  • Line 3 changes the current directory to the one where Feed Reader Central is installed; modify it for where + you have installed it. Since we are setting up for a CLI execution, this should place + us one directory up from /public. +
  • Line 4 executes the refresh script. +
+

Finally, we are ready to add this to our crontab. Enter crontab -e to edit the file, then add a row + at the bottom that looks like this: + 

+0 */6 * * *  /path/to/job/frc-refresh.sh
+

The items before the path specify when it should run. This example will run at the top of the hour every six + hours. Crontab schedules can be tricky to create; a full treatment is outside the scope of this documentation. + However, this site + lets you put values in each position and it translates that to words; this lets you see if what you put is what + you meant. +

This should not require many resources; the majority of its time will be spent waiting for the websites to return + their feeds so it can process them. However, if you want it to yield to everything else happening on the server, + add nice -n 1 (with a trailing space) before the path to the script. +

close(); From d8ba178c5551682771fa03852d7691a13b420d33 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Mon, 29 Apr 2024 23:01:49 -0400 Subject: [PATCH 4/5] Add pruning support (#12) --- INSTALLING.md | 10 ++- src/lib/Data.php | 10 +++ src/lib/Feed.php | 140 ++++++++++++++++++++++++++------------- src/user-config.dist.php | 13 ++++ 4 files changed, 126 insertions(+), 47 deletions(-) diff --git a/INSTALLING.md b/INSTALLING.md index bcfcb3a..d2e88e0 100644 --- a/INSTALLING.md +++ b/INSTALLING.md @@ -42,4 +42,12 @@ Data is stored under the `/src/data` directory, and the default database name is ### Date/Time Format -The default format for dates and times look like "May 28, 2023 at 3:15pm". Changing the string there will alter the display on the main page and when reading an item. Any [supported PHP date or time token](https://www.php.net/manual/en/datetime.format.php) is supported. \ No newline at end of file +The default format for dates and times look like "May 28, 2023 at 3:15pm". Changing the string there will alter the display on the main page and when reading an item. Any [supported PHP date or time token](https://www.php.net/manual/en/datetime.format.php) is supported. + +### Item Purging + +Feed Reader Central tries to keep the database tidy by purging items that have been read and are no longer required. There are three variants: +- `Feed::PURGE_READ` purges non-bookmarked read items for a feed whenever it is refreshed. This is the most aggressive purging strategy, but it is also the only one that will not purge unread items. +- `Feed::PURGE_BY_DAYS` purges non-bookmarked items that are older than `PURGE_NUMBER` days old. This is the default value, and `PURGE_NUMBER`'s default value is 30; items will be kept for 30 days, read or unread. +- `Feed::PURGE_BY_COUNT` purges items to preserve at most `PURGE_NUMBER` non-bookmarked items for each feed. + \ No newline at end of file diff --git a/src/lib/Data.php b/src/lib/Data.php index 6713767..2922186 100644 --- a/src/lib/Data.php +++ b/src/lib/Data.php @@ -98,4 +98,14 @@ class Data { if (is_null($dbConn)) $db->close(); } } + + /** + * Return the last SQLite error message as a result array + * + * @param SQLite3 $db The database connection on which the error has occurred + * @return string[] ['error' => message] for last SQLite error message + */ + public static function error(SQLite3 $db): array { + return ['error' => 'SQLite error: ' . $db->lastErrorMsg()]; + } } diff --git a/src/lib/Feed.php b/src/lib/Feed.php index c5900c7..498200f 100644 --- a/src/lib/Feed.php +++ b/src/lib/Feed.php @@ -30,6 +30,15 @@ class Feed { private const string USER_AGENT = 'FeedReaderCentral/' . FRC_VERSION . ' +https://bitbadger.solutions/open-source/feed-reader-central'; + /** @var int Purge all read items (will not purge unread items) */ + public const int PURGE_READ = 1; + + /** @var int Purge items older than the specified number of days */ + public const int PURGE_BY_DAYS = 2; + + /** @var int Purge items in number greater than the specified number of items to keep */ + public const int PURGE_BY_COUNT = 3; + /** * When parsing XML into a DOMDocument, errors are presented as warnings; this creates an exception for them * @@ -86,15 +95,16 @@ class Feed { private static function fromRSS(DOMDocument $xml, string $url): array { $channel = $xml->getElementsByTagName('channel')->item(0); if (!($channel instanceof DOMElement)) { - return ['error' => "Channel element not found ($channel->nodeType)"]; + $type = $channel?->nodeType ?? -1; + return ['error' => "Channel element not found ($type)"]; } // The Atom namespace provides a lastBuildDate, which contains the last time an item in the feed was updated; if // that is not present, use the pubDate element instead - $updatedOn = self::rssValue($channel, 'lastBuildDate'); - if ($updatedOn == 'lastBuildDate not found') { - $updatedOn = self::rssValue($channel, 'pubDate'); - if ($updatedOn == 'pubDate not found') $updatedOn = null; + if (($updatedOn = self::rssValue($channel, 'lastBuildDate')) == 'lastBuildDate not found') { + if (($updatedOn = self::rssValue($channel, 'pubDate')) == 'pubDate not found') { + $updatedOn = null; + } } $feed = new Feed(); @@ -148,9 +158,8 @@ class Feed { * @return array|Feed[] ['ok' => feed] */ private static function fromAtom(DOMDocument $xml, string $url): array { - $root = $xml->getElementsByTagNameNS(self::ATOM_NS, 'feed')->item(0); - $updatedOn = self::atomValue($root, 'updated'); - if ($updatedOn == 'pubDate not found') $updatedOn = null; + $root = $xml->getElementsByTagNameNS(self::ATOM_NS, 'feed')->item(0); + if (($updatedOn = self::atomValue($root, 'updated')) == 'pubDate not found') $updatedOn = null; $feed = new Feed(); $feed->title = self::atomValue($root, 'title'); @@ -252,8 +261,9 @@ class Feed { * @param int $itemId The ID of the item to be updated * @param FeedItem $item The item to be updated * @param SQLite3 $db A database connection to use for the update + * @return bool|SQLite3Result The result if the update is successful, false if it failed */ - private static function updateItem(int $itemId, FeedItem $item, SQLite3 $db): void { + private static function updateItem(int $itemId, FeedItem $item, SQLite3 $db): bool|SQLite3Result { $query = $db->prepare(<<<'SQL' UPDATE item SET title = :title, @@ -268,7 +278,7 @@ class Feed { $query->bindValue(':updated', $item->updatedOn); $query->bindValue(':content', $item->content); $query->bindValue(':id', $itemId); - $query->execute(); + return $query->execute(); } /** @@ -277,8 +287,9 @@ class Feed { * @param int $feedId The ID of the feed to which the item should be added * @param FeedItem $item The item to be added * @param SQLite3 $db A database connection to use for the addition + * @return bool|SQLite3Result The result if the update is successful, false if it failed */ - private static function addItem(int $feedId, FeedItem $item, SQLite3 $db): void { + private static function addItem(int $feedId, FeedItem $item, SQLite3 $db): bool|SQLite3Result { $query = $db->prepare(<<<'SQL' INSERT INTO item ( feed_id, item_guid, item_link, title, published_on, updated_on, content @@ -293,7 +304,7 @@ class Feed { $query->bindValue(':published', $item->publishedOn); $query->bindValue(':updated', $item->updatedOn); $query->bindValue(':content', $item->content); - $query->execute(); + return $query->execute(); } /** @@ -304,31 +315,71 @@ class Feed { * @return array ['ok' => true] if successful, ['error' => message] if not */ public static function updateItems(int $feedId, Feed $feed, SQLite3 $db): array { - try { - foreach ($feed->items as $item) { - $existsQuery = $db->prepare( - 'SELECT id, published_on, updated_on FROM item WHERE feed_id = :feed AND item_guid = :guid'); - $existsQuery->bindValue(':feed', $feedId); - $existsQuery->bindValue(':guid', $item->guid); - $exists = $existsQuery->execute(); - if ($exists) { - $existing = $exists->fetchArray(SQLITE3_ASSOC); - if ($existing) { - if ( $existing['published_on'] != $item->publishedOn - || ($existing['updated_on'] ?? '') != ($item->updatedOn ?? '')) { - self::updateItem($existing['id'], $item, $db); - } - } else { - self::addItem($feedId, $item, $db); + + // Do not add items that are older than the oldest we currently have; this keeps us from re-adding items that + // have been purged already + $oldestQuery = $db->prepare( + 'SELECT MIN(coalesce(updated_on, published_on)) FROM item where feed_id = :feed AND is_bookmarked = 0'); + $oldestQuery->bindValue(':feed', $feedId); + if (!($oldest = $oldestQuery->execute())) return Data::error($db); + $minDate = date_create_immutable($oldest->fetchArray(SQLITE3_NUM)[0] ?? '1993-04-30T00:00:00+00:00'); + + foreach ($feed->items as $item) { + if (date_create_immutable($item->updatedOn ?? $item->publishedOn) < $minDate) continue; + $existsQuery = $db->prepare( + 'SELECT id, published_on, updated_on FROM item WHERE feed_id = :feed AND item_guid = :guid'); + $existsQuery->bindValue(':feed', $feedId); + $existsQuery->bindValue(':guid', $item->guid); + if ($exists = $existsQuery->execute()) { + if ($existing = $exists->fetchArray(SQLITE3_ASSOC)) { + if ( $existing['published_on'] != $item->publishedOn + || ($existing['updated_on'] ?? '') != ($item->updatedOn ?? '')) { + if (!self::updateItem($existing['id'], $item, $db)) return Data::error($db); } } else { - throw new Exception($db->lastErrorMsg()); + if (!self::addItem($feedId, $item, $db)) return Data::error($db); } + } else { + return Data::error($db); } + } + return ['ok', true]; + } + + /** + * Purge items for a feed + * + * @param int $feedId The ID of the feed to be purged + * @param SQLite3 $db The database connection on which items should be purged + * @return array|string[]|true[] ['ok' => true] if purging was successful, ['error' => message] if not + */ + private static function purgeItems(int $feedId, SQLite3 $db): array { + + if (!array_search(PURGE_TYPE, [self::PURGE_READ, self::PURGE_BY_DAYS, self::PURGE_BY_COUNT])) { + return ['error' => 'Unrecognized purge type ' . PURGE_TYPE]; + } + + try { + $sql = match (PURGE_TYPE) { + self::PURGE_READ => 'AND is_read = 1', + self::PURGE_BY_DAYS => 'AND date(coalesce(updated_on, published_on)) < date(:oldest)', + self::PURGE_BY_COUNT => 'AND id IN (SELECT id FROM item WHERE feed_id = :feed + ORDER BY date(coalesce(updated_on, published_on)) DESC + LIMIT -1 OFFSET :keep)', + default => 'AND 1 = 0' + }; + + $purge = $db->prepare("DELETE FROM item WHERE feed_id = :feed AND is_bookmarked = 0 $sql"); + $purge->bindValue(':feed', $feedId); + if (PURGE_TYPE == self::PURGE_BY_DAYS) { + $purge->bindValue(':oldest', Data::formatDate('-' . PURGE_NUMBER . ' day')); + } elseif (PURGE_TYPE == self::PURGE_BY_COUNT) { + $purge->bindValue(':keep', PURGE_NUMBER); + } + return $purge->execute() ? ['ok' => true] : Data::error($db); } catch (Exception $ex) { return ['error' => $ex->getMessage()]; } - return ['ok', true]; } /** @@ -362,9 +413,9 @@ class Feed { $feedUpdate->bindValue(':checked', Data::formatDate('now')); $feedUpdate->bindValue(':id', $feedId); if ($urlUpdate != '') $feedUpdate->bindValue(':url', $feed->url); - $feedUpdate->execute(); + if (!$feedUpdate->execute()) return Data::error($db); - return ['ok' => true]; + return self::purgeItems($feedId, $db); } /** @@ -382,26 +433,24 @@ class Feed { $existsQuery = $db->prepare('SELECT COUNT(*) FROM feed WHERE user_id = :user AND url = :url'); $existsQuery->bindValue(':user', $_SESSION[Key::USER_ID]); $existsQuery->bindValue(':url', $feed->url); - $existsResult = $existsQuery->execute(); - if (!$existsResult) return ['error' => 'SQLite error: ' . $db->lastErrorMsg()]; - - $exists = $existsResult->fetchArray(SQLITE3_NUM); - if ($exists[0] != 0) return ['error' => "Already subscribed to feed $feed->url"]; + if (!($exists = $existsQuery->execute())) return Data::error($db); + if ($exists->fetchArray(SQLITE3_NUM)[0] > 0) return ['error' => "Already subscribed to feed $feed->url"]; $query = $db->prepare(<<<'SQL' - INSERT INTO feed (user_id, url, title, updated_on, checked_on) - VALUES (:user, :url, :title, :updated, :checked) + INSERT INTO feed ( + user_id, url, title, updated_on, checked_on + ) VALUES ( + :user, :url, :title, :updated, :checked + ) SQL); $query->bindValue(':user', $_SESSION[Key::USER_ID]); $query->bindValue(':url', $feed->url); $query->bindValue(':title', $feed->title); $query->bindValue(':updated', $feed->updatedOn); $query->bindValue(':checked', Data::formatDate('now')); - $result = $query->execute(); - - $feedId = $result ? $db->lastInsertRowID() : -1; - if ($feedId < 0) return ['error' => $db->lastErrorMsg()]; + if (!$query->execute()) return Data::error($db); + $feedId = $db->lastInsertRowID(); $result = self::updateItems($feedId, $feed, $db); if (array_key_exists('error', $result)) return $result; @@ -421,7 +470,7 @@ class Feed { $query->bindValue(':url', $url); $query->bindValue(':id', $existing['id']); $query->bindValue(':user', $_SESSION[Key::USER_ID]); - $query->execute(); + if (!$query->execute()) return Data::error($db); return self::refreshFeed($existing['id'], $url, $db); } @@ -438,8 +487,7 @@ class Feed { $query = $db->prepare( "SELECT f.id, f.url, u.email FROM feed f INNER JOIN frc_user u ON u.id = f.user_id$extraSQL"); if ($user > 0) $query->bindValue(':user', $user); - $result = $query->execute(); - if (!$result) return ['error', $db->lastErrorMsg()]; + if (!($result = $query->execute())) return Data::error($db); $feeds = []; while ($feed = $result->fetchArray(SQLITE3_ASSOC)) $feeds[] = $feed; return $feeds; diff --git a/src/user-config.dist.php b/src/user-config.dist.php index 7b3f824..a68d095 100644 --- a/src/user-config.dist.php +++ b/src/user-config.dist.php @@ -25,3 +25,16 @@ const DATABASE_NAME = 'frc.db'; * The default, 'F j, Y \a\t g:ia', equates to "August 17, 2023 at 4:45pm" */ const DATE_TIME_FORMAT = 'F j, Y \a\t g:ia'; + +/** + * How should item purging be done? (Purging never applies to bookmarked items.) Options are: + * - Feed::PURGE_READ - Purge all read items whenever purging is run (will not purge unread items) + * - Feed::PURGE_BY_DAYS - Purge read and unread items older than a number of days (PURGE_NUMBER below) + * - Feed::PURGE_BY_COUNT - Purge read and unread items beyond the number to keep (PURGE_NUMBER below) + */ +const PURGE_TYPE = Feed::PURGE_BY_DAYS; + +/** + * For purge-by-days, how many days of items should be kept; for purge-by-count, how many items should be kept + */ +const PURGE_NUMBER = 30; From b14399deb875686fd9a781ccad56968ea9f15707 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Tue, 30 Apr 2024 18:51:09 -0400 Subject: [PATCH 5/5] Add no purge, manual delete options (#12) - Add htmx, hx attributes - Only add/update items since last check - Move messages to session to persist across redirects - Polish styles a bit (still WIP) --- INSTALLING.md | 3 +- src/app-config.php | 3 ++ src/lib/Feed.php | 77 ++++++++++++++++++----------------- src/public/assets/htmx.min.js | 1 + src/public/assets/style.css | 34 +++++++++++++++- src/public/index.php | 12 ++++-- src/public/item.php | 25 +++++++++++- src/public/user/log-on.php | 2 +- src/start.php | 76 ++++++++++++++++++++++------------ src/user-config.dist.php | 1 + 10 files changed, 163 insertions(+), 71 deletions(-) create mode 100644 src/public/assets/htmx.min.js diff --git a/INSTALLING.md b/INSTALLING.md index d2e88e0..047f8ea 100644 --- a/INSTALLING.md +++ b/INSTALLING.md @@ -46,7 +46,8 @@ The default format for dates and times look like "May 28, 2023 at 3:15pm". Chang ### Item Purging -Feed Reader Central tries to keep the database tidy by purging items that have been read and are no longer required. There are three variants: +Feed Reader Central tries to keep the database tidy by purging items that have been read and are no longer required. There are four variants: +- `Feed::PURGE_NONE` does no purging (items have a "Delete" button, so they may be deleted manually) - `Feed::PURGE_READ` purges non-bookmarked read items for a feed whenever it is refreshed. This is the most aggressive purging strategy, but it is also the only one that will not purge unread items. - `Feed::PURGE_BY_DAYS` purges non-bookmarked items that are older than `PURGE_NUMBER` days old. This is the default value, and `PURGE_NUMBER`'s default value is 30; items will be kept for 30 days, read or unread. - `Feed::PURGE_BY_COUNT` purges items to preserve at most `PURGE_NUMBER` non-bookmarked items for each feed. diff --git a/src/app-config.php b/src/app-config.php index 8e8751d..0862dab 100644 --- a/src/app-config.php +++ b/src/app-config.php @@ -15,3 +15,6 @@ spl_autoload_register(function ($class) { require 'user-config.php'; Data::ensureDb(); + +/** @var string The date the world wide web was created */ +const WWW_EPOCH = '1993-04-30T00:00:00+00:00'; diff --git a/src/lib/Feed.php b/src/lib/Feed.php index 498200f..c6e9191 100644 --- a/src/lib/Feed.php +++ b/src/lib/Feed.php @@ -30,6 +30,9 @@ class Feed { private const string USER_AGENT = 'FeedReaderCentral/' . FRC_VERSION . ' +https://bitbadger.solutions/open-source/feed-reader-central'; + /** @var int Do not purge items */ + public const int PURGE_NONE = 0; + /** @var int Purge all read items (will not purge unread items) */ public const int PURGE_READ = 1; @@ -312,38 +315,33 @@ class Feed { * * @param int $feedId The ID of the feed to which these items belong * @param Feed $feed The extracted Atom or RSS feed items + * @param DateTimeInterface $lastChecked When this feed was last checked (only new items will be added) * @return array ['ok' => true] if successful, ['error' => message] if not */ - public static function updateItems(int $feedId, Feed $feed, SQLite3 $db): array { - - // Do not add items that are older than the oldest we currently have; this keeps us from re-adding items that - // have been purged already - $oldestQuery = $db->prepare( - 'SELECT MIN(coalesce(updated_on, published_on)) FROM item where feed_id = :feed AND is_bookmarked = 0'); - $oldestQuery->bindValue(':feed', $feedId); - if (!($oldest = $oldestQuery->execute())) return Data::error($db); - $minDate = date_create_immutable($oldest->fetchArray(SQLITE3_NUM)[0] ?? '1993-04-30T00:00:00+00:00'); - - foreach ($feed->items as $item) { - if (date_create_immutable($item->updatedOn ?? $item->publishedOn) < $minDate) continue; - $existsQuery = $db->prepare( - 'SELECT id, published_on, updated_on FROM item WHERE feed_id = :feed AND item_guid = :guid'); - $existsQuery->bindValue(':feed', $feedId); - $existsQuery->bindValue(':guid', $item->guid); - if ($exists = $existsQuery->execute()) { - if ($existing = $exists->fetchArray(SQLITE3_ASSOC)) { - if ( $existing['published_on'] != $item->publishedOn - || ($existing['updated_on'] ?? '') != ($item->updatedOn ?? '')) { - if (!self::updateItem($existing['id'], $item, $db)) return Data::error($db); + public static function updateItems(int $feedId, Feed $feed, DateTimeInterface $lastChecked, SQLite3 $db): array { + $results = + array_map(function ($item) use ($db, $feedId) { + $existsQuery = $db->prepare( + 'SELECT id, published_on, updated_on FROM item WHERE feed_id = :feed AND item_guid = :guid'); + $existsQuery->bindValue(':feed', $feedId); + $existsQuery->bindValue(':guid', $item->guid); + if ($exists = $existsQuery->execute()) { + if ($existing = $exists->fetchArray(SQLITE3_ASSOC)) { + if ( $existing['published_on'] != $item->publishedOn + || ($existing['updated_on'] ?? '') != ($item->updatedOn ?? '')) { + if (!self::updateItem($existing['id'], $item, $db)) return Data::error($db); + } + } else { + if (!self::addItem($feedId, $item, $db)) return Data::error($db); } } else { - if (!self::addItem($feedId, $item, $db)) return Data::error($db); + return Data::error($db); } - } else { - return Data::error($db); - } - } - return ['ok', true]; + return ['ok' => true]; + }, array_filter($feed->items, + fn($it) => date_create_immutable($it->updatedOn ?? $it->publishedOn) >= $lastChecked)); + $errors = array_map(fn($it) => $it['error'], array_filter($results, fn($it) => array_key_exists('error', $it))); + return sizeof($errors) > 0 ? ['error' => implode("\n", $errors)] : ['ok' => true]; } /** @@ -354,7 +352,6 @@ class Feed { * @return array|string[]|true[] ['ok' => true] if purging was successful, ['error' => message] if not */ private static function purgeItems(int $feedId, SQLite3 $db): array { - if (!array_search(PURGE_TYPE, [self::PURGE_READ, self::PURGE_BY_DAYS, self::PURGE_BY_COUNT])) { return ['error' => 'Unrecognized purge type ' . PURGE_TYPE]; } @@ -365,8 +362,7 @@ class Feed { self::PURGE_BY_DAYS => 'AND date(coalesce(updated_on, published_on)) < date(:oldest)', self::PURGE_BY_COUNT => 'AND id IN (SELECT id FROM item WHERE feed_id = :feed ORDER BY date(coalesce(updated_on, published_on)) DESC - LIMIT -1 OFFSET :keep)', - default => 'AND 1 = 0' + LIMIT -1 OFFSET :keep)' }; $purge = $db->prepare("DELETE FROM item WHERE feed_id = :feed AND is_bookmarked = 0 $sql"); @@ -391,12 +387,18 @@ class Feed { * @return array|string[]|true[] ['ok' => true] if successful, ['error' => message] if not */ public static function refreshFeed(int $feedId, string $url, SQLite3 $db): array { + $feedRetrieval = self::retrieveFeed($url); + if (array_key_exists('error', $feedRetrieval)) return $feedRetrieval; + $feed = $feedRetrieval['ok']; - $feedExtract = self::retrieveFeed($url); - if (array_key_exists('error', $feedExtract)) return $feedExtract; + $lastCheckedQuery = $db->prepare('SELECT checked_on FROM feed where id = :id'); + $lastCheckedQuery->bindValue(':id', $feedId); + if (!($lastCheckedResult = $lastCheckedQuery->execute())) return Data::error($db); + if (!($lastChecked = date_create_immutable($lastCheckedResult->fetchArray(SQLITE3_NUM)[0] ?? WWW_EPOCH))) { + return ['error' => 'Could not derive date last checked for feed']; + } - $feed = $feedExtract['ok']; - $itemUpdate = self::updateItems($feedId, $feed, $db); + $itemUpdate = self::updateItems($feedId, $feed, $lastChecked, $db); if (array_key_exists('error', $itemUpdate)) return $itemUpdate; $urlUpdate = $url == $feed->url ? '' : ', url = :url'; @@ -415,7 +417,7 @@ class Feed { if ($urlUpdate != '') $feedUpdate->bindValue(':url', $feed->url); if (!$feedUpdate->execute()) return Data::error($db); - return self::purgeItems($feedId, $db); + return PURGE_TYPE == self::PURGE_NONE ? ['ok' => true] : self::purgeItems($feedId, $db); } /** @@ -451,7 +453,7 @@ class Feed { if (!$query->execute()) return Data::error($db); $feedId = $db->lastInsertRowID(); - $result = self::updateItems($feedId, $feed, $db); + $result = self::updateItems($feedId, $feed, date_create_immutable(WWW_EPOCH), $db); if (array_key_exists('error', $result)) return $result; return ['ok' => $feedId]; @@ -497,7 +499,8 @@ class Feed { * Refresh all feeds * * @param SQLite3 $db The database connection to use for refreshing feeds - * @return array|true[] ['ok => true] if successful, ['error' => message] if not (may have multiple error lines) + * @return array|true[]|string[] ['ok' => true] if successful, + * ['error' => message] if not (may have multiple error lines) */ public static function refreshAll(SQLite3 $db): array { $feeds = self::retrieveAll($db, $_SESSION[Key::USER_ID]); diff --git a/src/public/assets/htmx.min.js b/src/public/assets/htmx.min.js new file mode 100644 index 0000000..648bef8 --- /dev/null +++ b/src/public/assets/htmx.min.js @@ -0,0 +1 @@ +var htmx=function(){"use strict";const Q={onLoad:null,process:null,on:null,off:null,trigger:null,ajax:null,find:null,findAll:null,closest:null,values:function(e,t){const n=un(e,t||"post");return n.values},remove:null,addClass:null,removeClass:null,toggleClass:null,takeClass:null,swap:null,defineExtension:null,removeExtension:null,logAll:null,logNone:null,logger:null,config:{historyEnabled:true,historyCacheSize:10,refreshOnHistoryMiss:false,defaultSwapStyle:"innerHTML",defaultSwapDelay:0,defaultSettleDelay:20,includeIndicatorStyles:true,indicatorClass:"htmx-indicator",requestClass:"htmx-request",addedClass:"htmx-added",settlingClass:"htmx-settling",swappingClass:"htmx-swapping",allowEval:true,allowScriptTags:true,inlineScriptNonce:"",attributesToSettle:["class","style","width","height"],withCredentials:false,timeout:0,wsReconnectDelay:"full-jitter",wsBinaryType:"blob",disableSelector:"[hx-disable], [data-hx-disable]",scrollBehavior:"instant",defaultFocusScroll:false,getCacheBusterParam:false,globalViewTransitions:false,methodsThatUseUrlParams:["get","delete"],selfRequestsOnly:true,ignoreTitle:false,scrollIntoViewOnBoost:true,triggerSpecsCache:null,disableInheritance:false,responseHandling:[{code:"204",swap:false},{code:"[23]..",swap:true},{code:"[45]..",swap:false,error:true}],allowNestedOobSwaps:true},parseInterval:null,_:null,version:"2.0.0-beta3"};Q.onLoad=z;Q.process=kt;Q.on=be;Q.off=we;Q.trigger=he;Q.ajax=On;Q.find=r;Q.findAll=p;Q.closest=g;Q.remove=K;Q.addClass=W;Q.removeClass=o;Q.toggleClass=Y;Q.takeClass=ge;Q.swap=$e;Q.defineExtension=Fn;Q.removeExtension=Un;Q.logAll=$;Q.logNone=J;Q.parseInterval=d;Q._=_;const n={addTriggerHandler:St,bodyContains:le,canAccessLocalStorage:V,findThisElement:Ee,filterValues:hn,swap:$e,hasAttribute:s,getAttributeValue:te,getClosestAttributeValue:re,getClosestMatch:T,getExpressionVars:En,getHeaders:fn,getInputValues:un,getInternalData:ie,getSwapSpecification:gn,getTriggerSpecs:lt,getTarget:Ce,makeFragment:D,mergeObjects:ue,makeSettleInfo:xn,oobSwap:Te,querySelectorExt:ae,settleImmediately:Kt,shouldCancel:ht,triggerEvent:he,triggerErrorEvent:fe,withExtensions:Ft};const v=["get","post","put","delete","patch"];const R=v.map(function(e){return"[hx-"+e+"], [data-hx-"+e+"]"}).join(", ");const O=e("head");function e(e,t=false){return new RegExp(`<${e}(\\s[^>]*>|>)([\\s\\S]*?)<\\/${e}>`,t?"gim":"im")}function d(e){if(e==undefined){return undefined}let t=NaN;if(e.slice(-2)=="ms"){t=parseFloat(e.slice(0,-2))}else if(e.slice(-1)=="s"){t=parseFloat(e.slice(0,-1))*1e3}else if(e.slice(-1)=="m"){t=parseFloat(e.slice(0,-1))*1e3*60}else{t=parseFloat(e)}return isNaN(t)?undefined:t}function ee(e,t){return e instanceof Element&&e.getAttribute(t)}function s(e,t){return!!e.hasAttribute&&(e.hasAttribute(t)||e.hasAttribute("data-"+t))}function te(e,t){return ee(e,t)||ee(e,"data-"+t)}function u(e){const t=e.parentElement;if(!t&&e.parentNode instanceof ShadowRoot)return e.parentNode;return t}function ne(){return document}function H(e,t){return e.getRootNode?e.getRootNode({composed:t}):ne()}function T(e,t){while(e&&!t(e)){e=u(e)}return e||null}function q(e,t,n){const r=te(t,n);const o=te(t,"hx-disinherit");var i=te(t,"hx-inherit");if(e!==t){if(Q.config.disableInheritance){if(i&&(i==="*"||i.split(" ").indexOf(n)>=0)){return r}else{return null}}if(o&&(o==="*"||o.split(" ").indexOf(n)>=0)){return"unset"}}return r}function re(t,n){let r=null;T(t,function(e){return!!(r=q(t,ce(e),n))});if(r!=="unset"){return r}}function f(e,t){const n=e instanceof Element&&(e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.webkitMatchesSelector||e.oMatchesSelector);return!!n&&n.call(e,t)}function L(e){const t=/<([a-z][^\/\0>\x20\t\r\n\f]*)/i;const n=t.exec(e);if(n){return n[1].toLowerCase()}else{return""}}function A(e){const t=new DOMParser;return t.parseFromString(e,"text/html")}function N(e,t){while(t.childNodes.length>0){e.append(t.childNodes[0])}}function I(e){const t=ne().createElement("script");se(e.attributes,function(e){t.setAttribute(e.name,e.value)});t.textContent=e.textContent;t.async=false;if(Q.config.inlineScriptNonce){t.nonce=Q.config.inlineScriptNonce}return t}function P(e){return e.matches("script")&&(e.type==="text/javascript"||e.type==="module"||e.type==="")}function k(e){Array.from(e.querySelectorAll("script")).forEach(e=>{if(P(e)){const t=I(e);const n=e.parentNode;try{n.insertBefore(t,e)}catch(e){w(e)}finally{e.remove()}}})}function D(e){const t=e.replace(O,"");const n=L(t);let r;if(n==="html"){r=new DocumentFragment;const i=A(e);N(r,i.body);r.title=i.title}else if(n==="body"){r=new DocumentFragment;const i=A(t);N(r,i.body);r.title=i.title}else{const i=A('");r=i.querySelector("template").content;r.title=i.title;var o=r.querySelector("title");if(o&&o.parentNode===r){o.remove();r.title=o.innerText}}if(r){if(Q.config.allowScriptTags){k(r)}else{r.querySelectorAll("script").forEach(e=>e.remove())}}return r}function oe(e){if(e){e()}}function t(e,t){return Object.prototype.toString.call(e)==="[object "+t+"]"}function M(e){return typeof e==="function"}function X(e){return t(e,"Object")}function ie(e){const t="htmx-internal-data";let n=e[t];if(!n){n=e[t]={}}return n}function F(t){const n=[];if(t){for(let e=0;e=0}function le(e){const t=e.getRootNode&&e.getRootNode();if(t&&t instanceof window.ShadowRoot){return ne().body.contains(t.host)}else{return ne().body.contains(e)}}function B(e){return e.trim().split(/\s+/)}function ue(e,t){for(const n in t){if(t.hasOwnProperty(n)){e[n]=t[n]}}return e}function S(e){try{return JSON.parse(e)}catch(e){w(e);return null}}function V(){const e="htmx:localStorageTest";try{localStorage.setItem(e,e);localStorage.removeItem(e);return true}catch(e){return false}}function j(t){try{const e=new URL(t);if(e){t=e.pathname+e.search}if(!/^\/$/.test(t)){t=t.replace(/\/+$/,"")}return t}catch(e){return t}}function _(e){return wn(ne().body,function(){return eval(e)})}function z(t){const e=Q.on("htmx:load",function(e){t(e.detail.elt)});return e}function $(){Q.logger=function(e,t,n){if(console){console.log(t,e,n)}}}function J(){Q.logger=null}function r(e,t){if(typeof e!=="string"){return e.querySelector(t)}else{return r(ne(),e)}}function p(e,t){if(typeof e!=="string"){return e.querySelectorAll(t)}else{return p(ne(),e)}}function E(){return window}function K(e,t){e=x(e);if(t){E().setTimeout(function(){K(e);e=null},t)}else{u(e).removeChild(e)}}function ce(e){return e instanceof Element?e:null}function G(e){return e instanceof HTMLElement?e:null}function Z(e){return typeof e==="string"?e:null}function h(e){return e instanceof Element||e instanceof Document||e instanceof DocumentFragment?e:null}function W(e,t,n){e=ce(x(e));if(!e){return}if(n){E().setTimeout(function(){W(e,t);e=null},n)}else{e.classList&&e.classList.add(t)}}function o(e,t,n){let r=ce(x(e));if(!r){return}if(n){E().setTimeout(function(){o(r,t);r=null},n)}else{if(r.classList){r.classList.remove(t);if(r.classList.length===0){r.removeAttribute("class")}}}}function Y(e,t){e=x(e);e.classList.toggle(t)}function ge(e,t){e=x(e);se(e.parentElement.children,function(e){o(e,t)});W(ce(e),t)}function g(e,t){e=ce(x(e));if(e&&e.closest){return e.closest(t)}else{do{if(e==null||f(e,t)){return e}}while(e=e&&ce(u(e)));return null}}function l(e,t){return e.substring(0,t.length)===t}function pe(e,t){return e.substring(e.length-t.length)===t}function i(e){const t=e.trim();if(l(t,"<")&&pe(t,"/>")){return t.substring(1,t.length-2)}else{return t}}function m(e,t,n){e=x(e);if(t.indexOf("closest ")===0){return[g(ce(e),i(t.substr(8)))]}else if(t.indexOf("find ")===0){return[r(h(e),i(t.substr(5)))]}else if(t==="next"){return[ce(e).nextElementSibling]}else if(t.indexOf("next ")===0){return[me(e,i(t.substr(5)),!!n)]}else if(t==="previous"){return[ce(e).previousElementSibling]}else if(t.indexOf("previous ")===0){return[xe(e,i(t.substr(9)),!!n)]}else if(t==="document"){return[document]}else if(t==="window"){return[window]}else if(t==="body"){return[document.body]}else if(t==="root"){return[H(e,!!n)]}else if(t.indexOf("global ")===0){return m(e,t.slice(7),true)}else{return F(h(H(e,!!n)).querySelectorAll(i(t)))}}var me=function(t,e,n){const r=h(H(t,n)).querySelectorAll(e);for(let e=0;e=0;e--){const o=r[e];if(o.compareDocumentPosition(t)===Node.DOCUMENT_POSITION_FOLLOWING){return o}}};function ae(e,t){if(typeof e!=="string"){return m(e,t)[0]}else{return m(ne().body,e)[0]}}function x(e,t){if(typeof e==="string"){return r(h(t)||document,e)}else{return e}}function ye(e,t,n){if(M(t)){return{target:ne().body,event:Z(e),listener:t}}else{return{target:x(e),event:Z(t),listener:n}}}function be(t,n,r){jn(function(){const e=ye(t,n,r);e.target.addEventListener(e.event,e.listener)});const e=M(n);return e?n:r}function we(t,n,r){jn(function(){const e=ye(t,n,r);e.target.removeEventListener(e.event,e.listener)});return M(n)?n:r}const ve=ne().createElement("output");function Se(e,t){const n=re(e,t);if(n){if(n==="this"){return[Ee(e,t)]}else{const r=m(e,n);if(r.length===0){w('The selector "'+n+'" on '+t+" returned no matches!");return[ve]}else{return r}}}}function Ee(e,t){return ce(T(e,function(e){return te(ce(e),t)!=null}))}function Ce(e){const t=re(e,"hx-target");if(t){if(t==="this"){return Ee(e,"hx-target")}else{return ae(e,t)}}else{const n=ie(e);if(n.boosted){return ne().body}else{return e}}}function Re(t){const n=Q.config.attributesToSettle;for(let e=0;e0){s=e.substr(0,e.indexOf(":"));t=e.substr(e.indexOf(":")+1,e.length)}else{s=e}const n=ne().querySelectorAll(t);if(n){se(n,function(e){let t;const n=o.cloneNode(true);t=ne().createDocumentFragment();t.appendChild(n);if(!He(s,e)){t=h(n)}const r={shouldSwap:true,target:e,fragment:t};if(!he(e,"htmx:oobBeforeSwap",r))return;e=r.target;if(r.shouldSwap){_e(s,e,e,t,i)}se(i.elts,function(e){he(e,"htmx:oobAfterSwap",r)})});o.parentNode.removeChild(o)}else{o.parentNode.removeChild(o);fe(ne().body,"htmx:oobErrorNoTarget",{content:o})}return e}function qe(e){se(p(e,"[hx-preserve], [data-hx-preserve]"),function(e){const t=te(e,"id");const n=ne().getElementById(t);if(n!=null){e.parentNode.replaceChild(n,e)}})}function Le(l,e,u){se(e.querySelectorAll("[id]"),function(t){const n=ee(t,"id");if(n&&n.length>0){const r=n.replace("'","\\'");const o=t.tagName.replace(":","\\:");const e=h(l);const i=e&&e.querySelector(o+"[id='"+r+"']");if(i&&i!==e){const s=t.cloneNode();Oe(t,i);u.tasks.push(function(){Oe(t,s)})}}})}function Ae(e){return function(){o(e,Q.config.addedClass);kt(ce(e));Ne(h(e));he(e,"htmx:load")}}function Ne(e){const t="[autofocus]";const n=G(f(e,t)?e:e.querySelector(t));if(n!=null){n.focus()}}function c(e,t,n,r){Le(e,n,r);while(n.childNodes.length>0){const o=n.firstChild;W(ce(o),Q.config.addedClass);e.insertBefore(o,t);if(o.nodeType!==Node.TEXT_NODE&&o.nodeType!==Node.COMMENT_NODE){r.tasks.push(Ae(o))}}}function Ie(e,t){let n=0;while(n0){E().setTimeout(l,r.settleDelay)}else{l()}}function Je(e,t,n){const r=e.getResponseHeader(t);if(r.indexOf("{")===0){const o=S(r);for(const i in o){if(o.hasOwnProperty(i)){let e=o[i];if(!X(e)){e={value:e}}he(n,i,e)}}}else{const s=r.split(",");for(let e=0;e0){const s=o[0];if(s==="]"){e--;if(e===0){if(n===null){t=t+"true"}o.shift();t+=")})";try{const l=wn(r,function(){return Function(t)()},function(){return true});l.source=t;return l}catch(e){fe(ne().body,"htmx:syntax:error",{error:e,source:t});return null}}}else if(s==="["){e++}if(nt(s,n,i)){t+="(("+i+"."+s+") ? ("+i+"."+s+") : (window."+s+"))"}else{t=t+s}n=o.shift()}}}function b(e,t){let n="";while(e.length>0&&!t.test(e[0])){n+=e.shift()}return n}function ot(e){let t;if(e.length>0&&Qe.test(e[0])){e.shift();t=b(e,et).trim();e.shift()}else{t=b(e,y)}return t}const it="input, textarea, select";function st(e,t,n){const r=[];const o=tt(t);do{b(o,Ye);const l=o.length;const u=b(o,/[,\[\s]/);if(u!==""){if(u==="every"){const c={trigger:"every"};b(o,Ye);c.pollInterval=d(b(o,/[,\[\s]/));b(o,Ye);var i=rt(e,o,"event");if(i){c.eventFilter=i}r.push(c)}else{const a={trigger:u};var i=rt(e,o,"event");if(i){a.eventFilter=i}while(o.length>0&&o[0]!==","){b(o,Ye);const f=o.shift();if(f==="changed"){a.changed=true}else if(f==="once"){a.once=true}else if(f==="consume"){a.consume=true}else if(f==="delay"&&o[0]===":"){o.shift();a.delay=d(b(o,y))}else if(f==="from"&&o[0]===":"){o.shift();if(Qe.test(o[0])){var s=ot(o)}else{var s=b(o,y);if(s==="closest"||s==="find"||s==="next"||s==="previous"){o.shift();const h=ot(o);if(h.length>0){s+=" "+h}}}a.from=s}else if(f==="target"&&o[0]===":"){o.shift();a.target=ot(o)}else if(f==="throttle"&&o[0]===":"){o.shift();a.throttle=d(b(o,y))}else if(f==="queue"&&o[0]===":"){o.shift();a.queue=b(o,y)}else if(f==="root"&&o[0]===":"){o.shift();a[f]=ot(o)}else if(f==="threshold"&&o[0]===":"){o.shift();a[f]=b(o,y)}else{fe(e,"htmx:syntax:error",{token:o.shift()})}}r.push(a)}}if(o.length===l){fe(e,"htmx:syntax:error",{token:o.shift()})}b(o,Ye)}while(o[0]===","&&o.shift());if(n){n[t]=r}return r}function lt(e){const t=te(e,"hx-trigger");let n=[];if(t){const r=Q.config.triggerSpecsCache;n=r&&r[t]||st(e,t,r)}if(n.length>0){return n}else if(f(e,"form")){return[{trigger:"submit"}]}else if(f(e,'input[type="button"], input[type="submit"]')){return[{trigger:"click"}]}else if(f(e,it)){return[{trigger:"change"}]}else{return[{trigger:"click"}]}}function ut(e){ie(e).cancelled=true}function ct(e,t,n){const r=ie(e);r.timeout=E().setTimeout(function(){if(le(e)&&r.cancelled!==true){if(!gt(n,e,Mt("hx:poll:trigger",{triggerSpec:n,target:e}))){t(e)}ct(e,t,n)}},n.pollInterval)}function at(e){return location.hostname===e.hostname&&ee(e,"href")&&ee(e,"href").indexOf("#")!==0}function ft(t,n,e){if(t instanceof HTMLAnchorElement&&at(t)&&(t.target===""||t.target==="_self")||t.tagName==="FORM"){n.boosted=true;let r,o;if(t.tagName==="A"){r="get";o=ee(t,"href")}else{const i=ee(t,"method");r=i?i.toLowerCase():"get";if(r==="get"){}o=ee(t,"action")}e.forEach(function(e){pt(t,function(e,t){const n=ce(e);if(g(n,Q.config.disableSelector)){a(n);return}de(r,o,n,t)},n,e,true)})}}function ht(e,t){const n=ce(t);if(!n){return false}if(e.type==="submit"||e.type==="click"){if(n.tagName==="FORM"){return true}if(f(n,'input[type="submit"], button')&&g(n,"form")!==null){return true}if(n instanceof HTMLAnchorElement&&n.href&&(n.getAttribute("href")==="#"||n.getAttribute("href").indexOf("#")!==0)){return true}}return false}function dt(e,t){return ie(e).boosted&&e instanceof HTMLAnchorElement&&t.type==="click"&&(t.ctrlKey||t.metaKey)}function gt(e,t,n){const r=e.eventFilter;if(r){try{return r.call(t,n)!==true}catch(e){const o=r.source;fe(ne().body,"htmx:eventFilter:error",{error:e,source:o});return true}}return false}function pt(s,l,e,u,c){const a=ie(s);let t;if(u.from){t=m(s,u.from)}else{t=[s]}if(u.changed){t.forEach(function(e){const t=ie(e);t.lastValue=e.value})}se(t,function(o){const i=function(e){if(!le(s)){o.removeEventListener(u.trigger,i);return}if(dt(s,e)){return}if(c||ht(e,s)){e.preventDefault()}if(gt(u,s,e)){return}const t=ie(e);t.triggerSpec=u;if(t.handledFor==null){t.handledFor=[]}if(t.handledFor.indexOf(s)<0){t.handledFor.push(s);if(u.consume){e.stopPropagation()}if(u.target&&e.target){if(!f(ce(e.target),u.target)){return}}if(u.once){if(a.triggeredOnce){return}else{a.triggeredOnce=true}}if(u.changed){const n=ie(o);const r=o.value;if(n.lastValue===r){return}n.lastValue=r}if(a.delayed){clearTimeout(a.delayed)}if(a.throttle){return}if(u.throttle>0){if(!a.throttle){l(s,e);a.throttle=E().setTimeout(function(){a.throttle=null},u.throttle)}}else if(u.delay>0){a.delayed=E().setTimeout(function(){l(s,e)},u.delay)}else{he(s,"htmx:trigger");l(s,e)}}};if(e.listenerInfos==null){e.listenerInfos=[]}e.listenerInfos.push({trigger:u.trigger,listener:i,on:o});o.addEventListener(u.trigger,i)})}let mt=false;let xt=null;function yt(){if(!xt){xt=function(){mt=true};window.addEventListener("scroll",xt);setInterval(function(){if(mt){mt=false;se(ne().querySelectorAll("[hx-trigger*='revealed'],[data-hx-trigger*='revealed']"),function(e){bt(e)})}},200)}}function bt(e){if(!s(e,"data-hx-revealed")&&U(e)){e.setAttribute("data-hx-revealed","true");const t=ie(e);if(t.initHash){he(e,"revealed")}else{e.addEventListener("htmx:afterProcessNode",function(){he(e,"revealed")},{once:true})}}}function wt(e,t,n,r){const o=function(){if(!n.loaded){n.loaded=true;t(e)}};if(r>0){E().setTimeout(o,r)}else{o()}}function vt(t,n,e){let i=false;se(v,function(r){if(s(t,"hx-"+r)){const o=te(t,"hx-"+r);i=true;n.path=o;n.verb=r;e.forEach(function(e){St(t,e,n,function(e,t){const n=ce(e);if(g(n,Q.config.disableSelector)){a(n);return}de(r,o,n,t)})})}});return i}function St(r,e,t,n){if(e.trigger==="revealed"){yt();pt(r,n,t,e);bt(ce(r))}else if(e.trigger==="intersect"){const o={};if(e.root){o.root=ae(r,e.root)}if(e.threshold){o.threshold=parseFloat(e.threshold)}const i=new IntersectionObserver(function(t){for(let e=0;e0){t.polling=true;ct(ce(r),n,e)}else{pt(r,n,t,e)}}function Et(e){const t=ce(e);if(!t){return false}const n=t.attributes;for(let e=0;eQ.config.historyCacheSize){i.shift()}while(i.length>0){try{localStorage.setItem("htmx-history-cache",JSON.stringify(i));break}catch(e){fe(ne().body,"htmx:historyCacheError",{cause:e,cache:i});i.shift()}}}function jt(t){if(!V()){return null}t=j(t);const n=S(localStorage.getItem("htmx-history-cache"))||[];for(let e=0;e=200&&this.status<400){he(ne().body,"htmx:historyCacheMissLoad",i);const e=D(this.response);const t=e.querySelector("[hx-history-elt],[data-hx-history-elt]")||e;const n=Bt();const r=xn(n);kn(e.title);je(n,t,r);Kt(r.tasks);Ut=o;he(ne().body,"htmx:historyRestore",{path:o,cacheMiss:true,serverResponse:this.response})}else{fe(ne().body,"htmx:historyCacheMissLoadError",i)}};e.send()}function Zt(e){zt();e=e||location.pathname+location.search;const t=jt(e);if(t){const n=D(t.content);const r=Bt();const o=xn(r);kn(n.title);je(r,n,o);Kt(o.tasks);E().setTimeout(function(){window.scrollTo(0,t.scroll)},0);Ut=e;he(ne().body,"htmx:historyRestore",{path:e,item:t})}else{if(Q.config.refreshOnHistoryMiss){window.location.reload(true)}else{Gt(e)}}}function Wt(e){let t=Se(e,"hx-indicator");if(t==null){t=[e]}se(t,function(e){const t=ie(e);t.requestCount=(t.requestCount||0)+1;e.classList.add.call(e.classList,Q.config.requestClass)});return t}function Yt(e){let t=Se(e,"hx-disabled-elt");if(t==null){t=[]}se(t,function(e){const t=ie(e);t.requestCount=(t.requestCount||0)+1;e.setAttribute("disabled","")});return t}function Qt(e,t){se(e,function(e){const t=ie(e);t.requestCount=(t.requestCount||0)-1;if(t.requestCount===0){e.classList.remove.call(e.classList,Q.config.requestClass)}});se(t,function(e){const t=ie(e);t.requestCount=(t.requestCount||0)-1;if(t.requestCount===0){e.removeAttribute("disabled")}})}function en(t,n){for(let e=0;en.indexOf(e)<0)}else{e=e.filter(e=>e!==n)}r.delete(t);se(e,e=>r.append(t,e))}}function on(t,n,r,o,i){if(o==null||en(t,o)){return}else{t.push(o)}if(tn(o)){const s=ee(o,"name");let e=o.value;if(o instanceof HTMLSelectElement&&o.multiple){e=F(o.querySelectorAll("option:checked")).map(function(e){return e.value})}if(o instanceof HTMLInputElement&&o.files){e=F(o.files)}nn(s,e,n);if(i){sn(o,r)}}if(o instanceof HTMLFormElement){se(o.elements,function(e){if(t.indexOf(e)>=0){rn(e.name,e.value,n)}else{t.push(e)}if(i){sn(e,r)}});new FormData(o).forEach(function(e,t){nn(t,e,n)})}}function sn(e,t){const n=e;if(n.willValidate){he(n,"htmx:validation:validate");if(!n.checkValidity()){t.push({elt:n,message:n.validationMessage,validity:n.validity});he(n,"htmx:validation:failed",{message:n.validationMessage,validity:n.validity})}}}function ln(t,e){for(const n of e.keys()){t.delete(n);e.getAll(n).forEach(function(e){t.append(n,e)})}return t}function un(e,t){const n=[];const r=new FormData;const o=new FormData;const i=[];const s=ie(e);if(s.lastButtonClicked&&!le(s.lastButtonClicked)){s.lastButtonClicked=null}let l=e instanceof HTMLFormElement&&e.noValidate!==true||te(e,"hx-validate")==="true";if(s.lastButtonClicked){l=l&&s.lastButtonClicked.formNoValidate!==true}if(t!=="get"){on(n,o,i,g(e,"form"),l)}on(n,r,i,e,l);if(s.lastButtonClicked||e.tagName==="BUTTON"||e.tagName==="INPUT"&&ee(e,"type")==="submit"){const c=s.lastButtonClicked||e;const a=ee(c,"name");nn(a,c.value,o)}const u=Se(e,"hx-include");se(u,function(e){on(n,r,i,ce(e),l);if(!f(e,"form")){se(h(e).querySelectorAll(it),function(e){on(n,r,i,e,l)})}});ln(r,o);return{errors:i,formData:r,values:An(r)}}function cn(e,t,n){if(e!==""){e+="&"}if(String(n)==="[object Object]"){n=JSON.stringify(n)}const r=encodeURIComponent(n);e+=encodeURIComponent(t)+"="+r;return e}function an(e){e=qn(e);let n="";e.forEach(function(e,t){n=cn(n,t,e)});return n}function fn(e,t,n){const r={"HX-Request":"true","HX-Trigger":ee(e,"id"),"HX-Trigger-Name":ee(e,"name"),"HX-Target":te(t,"id"),"HX-Current-URL":ne().location.href};bn(e,"hx-headers",false,r);if(n!==undefined){r["HX-Prompt"]=n}if(ie(e).boosted){r["HX-Boosted"]="true"}return r}function hn(n,e){const t=re(e,"hx-params");if(t){if(t==="none"){return new FormData}else if(t==="*"){return n}else if(t.indexOf("not ")===0){se(t.substr(4).split(","),function(e){e=e.trim();n.delete(e)});return n}else{const r=new FormData;se(t.split(","),function(t){t=t.trim();if(n.has(t)){n.getAll(t).forEach(function(e){r.append(t,e)})}});return r}}else{return n}}function dn(e){return!!ee(e,"href")&&ee(e,"href").indexOf("#")>=0}function gn(e,t){const n=t||re(e,"hx-swap");const r={swapStyle:ie(e).boosted?"innerHTML":Q.config.defaultSwapStyle,swapDelay:Q.config.defaultSwapDelay,settleDelay:Q.config.defaultSettleDelay};if(Q.config.scrollIntoViewOnBoost&&ie(e).boosted&&!dn(e)){r.show="top"}if(n){const s=B(n);if(s.length>0){for(let e=0;e0?o.join(":"):null;r.scroll=c;r.scrollTarget=i}else if(l.indexOf("show:")===0){const a=l.substr(5);var o=a.split(":");const f=o.pop();var i=o.length>0?o.join(":"):null;r.show=f;r.showTarget=i}else if(l.indexOf("focus-scroll:")===0){const h=l.substr("focus-scroll:".length);r.focusScroll=h=="true"}else if(e==0){r.swapStyle=l}else{w("Unknown modifier in hx-swap: "+l)}}}}return r}function pn(e){return re(e,"hx-encoding")==="multipart/form-data"||f(e,"form")&&ee(e,"enctype")==="multipart/form-data"}function mn(t,n,r){let o=null;Ft(n,function(e){if(o==null){o=e.encodeParameters(t,r,n)}});if(o!=null){return o}else{if(pn(n)){return ln(new FormData,qn(r))}else{return an(r)}}}function xn(e){return{tasks:[],elts:[e]}}function yn(e,t){const n=e[0];const r=e[e.length-1];if(t.scroll){var o=null;if(t.scrollTarget){o=ce(ae(n,t.scrollTarget))}if(t.scroll==="top"&&(n||o)){o=o||n;o.scrollTop=0}if(t.scroll==="bottom"&&(r||o)){o=o||r;o.scrollTop=o.scrollHeight}}if(t.show){var o=null;if(t.showTarget){let e=t.showTarget;if(t.showTarget==="window"){e="body"}o=ce(ae(n,e))}if(t.show==="top"&&(n||o)){o=o||n;o.scrollIntoView({block:"start",behavior:Q.config.scrollBehavior})}if(t.show==="bottom"&&(r||o)){o=o||r;o.scrollIntoView({block:"end",behavior:Q.config.scrollBehavior})}}}function bn(r,e,o,i){if(i==null){i={}}if(r==null){return i}const s=te(r,e);if(s){let e=s.trim();let t=o;if(e==="unset"){return null}if(e.indexOf("javascript:")===0){e=e.substr(11);t=true}else if(e.indexOf("js:")===0){e=e.substr(3);t=true}if(e.indexOf("{")!==0){e="{"+e+"}"}let n;if(t){n=wn(r,function(){return Function("return ("+e+")")()},{})}else{n=S(e)}for(const l in n){if(n.hasOwnProperty(l)){if(i[l]==null){i[l]=n[l]}}}}return bn(ce(u(r)),e,o,i)}function wn(e,t,n){if(Q.config.allowEval){return t()}else{fe(e,"htmx:evalDisallowedError");return n}}function vn(e,t){return bn(e,"hx-vars",true,t)}function Sn(e,t){return bn(e,"hx-vals",false,t)}function En(e){return ue(vn(e),Sn(e))}function Cn(t,n,r){if(r!==null){try{t.setRequestHeader(n,r)}catch(e){t.setRequestHeader(n,encodeURIComponent(r));t.setRequestHeader(n+"-URI-AutoEncoded","true")}}}function Rn(t){if(t.responseURL&&typeof URL!=="undefined"){try{const e=new URL(t.responseURL);return e.pathname+e.search}catch(e){fe(ne().body,"htmx:badResponseUrl",{url:t.responseURL})}}}function C(e,t){return t.test(e.getAllResponseHeaders())}function On(e,t,n){e=e.toLowerCase();if(n){if(n instanceof Element||typeof n==="string"){return de(e,t,null,null,{targetOverride:x(n),returnPromise:true})}else{return de(e,t,x(n.source),n.event,{handler:n.handler,headers:n.headers,values:n.values,targetOverride:x(n.target),swapOverride:n.swap,select:n.select,returnPromise:true})}}else{return de(e,t,null,null,{returnPromise:true})}}function Hn(e){const t=[];while(e){t.push(e);e=e.parentElement}return t}function Tn(e,t,n){let r;let o;if(typeof URL==="function"){o=new URL(t,document.location.href);const i=document.location.origin;r=i===o.origin}else{o=t;r=l(t,document.location.origin)}if(Q.config.selfRequestsOnly){if(!r){return false}}return he(e,"htmx:validateUrl",ue({url:o,sameHost:r},n))}function qn(e){if(e instanceof FormData)return e;const t=new FormData;for(const n in e){if(e.hasOwnProperty(n)){if(typeof e[n].forEach==="function"){e[n].forEach(function(e){t.append(n,e)})}else if(typeof e[n]==="object"){t.append(n,JSON.stringify(e[n]))}else{t.append(n,e[n])}}}return t}function Ln(r,o,e){return new Proxy(e,{get:function(t,e){if(typeof e==="number")return t[e];if(e==="length")return t.length;if(e==="push"){return function(e){t.push(e);r.append(o,e)}}if(typeof t[e]==="function"){return function(){t[e].apply(t,arguments);r.delete(o);t.forEach(function(e){r.append(o,e)})}}if(t[e]&&t[e].length===1){return t[e][0]}else{return t[e]}},set:function(e,t,n){e[t]=n;r.delete(o);e.forEach(function(e){r.append(o,e)});return true}})}function An(r){return new Proxy(r,{get:function(e,t){if(typeof t==="symbol"){return Reflect.get(e,t)}if(t==="toJSON"){return()=>Object.fromEntries(r)}if(t in e){if(typeof e[t]==="function"){return function(){return r[t].apply(r,arguments)}}else{return e[t]}}const n=r.getAll(t);if(n.length===0){return undefined}else if(n.length===1){return n[0]}else{return Ln(e,t,n)}},set:function(t,n,e){if(typeof n!=="string"){return false}t.delete(n);if(typeof e.forEach==="function"){e.forEach(function(e){t.append(n,e)})}else{t.append(n,e)}return true},deleteProperty:function(e,t){if(typeof t==="string"){e.delete(t)}return true},ownKeys:function(e){return Reflect.ownKeys(Object.fromEntries(e))},getOwnPropertyDescriptor:function(e,t){return Reflect.getOwnPropertyDescriptor(Object.fromEntries(e),t)}})}function de(t,n,r,o,i,D){let s=null;let l=null;i=i!=null?i:{};if(i.returnPromise&&typeof Promise!=="undefined"){var e=new Promise(function(e,t){s=e;l=t})}if(r==null){r=ne().body}const M=i.handler||Dn;const X=i.select||null;if(!le(r)){oe(s);return e}const u=i.targetOverride||ce(Ce(r));if(u==null||u==ve){fe(r,"htmx:targetError",{target:te(r,"hx-target")});oe(l);return e}let c=ie(r);const a=c.lastButtonClicked;if(a){const L=ee(a,"formaction");if(L!=null){n=L}const A=ee(a,"formmethod");if(A!=null){if(A.toLowerCase()!=="dialog"){t=A}}}const f=re(r,"hx-confirm");if(D===undefined){const K=function(e){return de(t,n,r,o,i,!!e)};const G={target:u,elt:r,path:n,verb:t,triggeringEvent:o,etc:i,issueRequest:K,question:f};if(he(r,"htmx:confirm",G)===false){oe(s);return e}}let h=r;let d=re(r,"hx-sync");let g=null;let F=false;if(d){const N=d.split(":");const I=N[0].trim();if(I==="this"){h=Ee(r,"hx-sync")}else{h=ce(ae(r,I))}d=(N[1]||"drop").trim();c=ie(h);if(d==="drop"&&c.xhr&&c.abortable!==true){oe(s);return e}else if(d==="abort"){if(c.xhr){oe(s);return e}else{F=true}}else if(d==="replace"){he(h,"htmx:abort")}else if(d.indexOf("queue")===0){const Z=d.split(" ");g=(Z[1]||"last").trim()}}if(c.xhr){if(c.abortable){he(h,"htmx:abort")}else{if(g==null){if(o){const P=ie(o);if(P&&P.triggerSpec&&P.triggerSpec.queue){g=P.triggerSpec.queue}}if(g==null){g="last"}}if(c.queuedRequests==null){c.queuedRequests=[]}if(g==="first"&&c.queuedRequests.length===0){c.queuedRequests.push(function(){de(t,n,r,o,i)})}else if(g==="all"){c.queuedRequests.push(function(){de(t,n,r,o,i)})}else if(g==="last"){c.queuedRequests=[];c.queuedRequests.push(function(){de(t,n,r,o,i)})}oe(s);return e}}const p=new XMLHttpRequest;c.xhr=p;c.abortable=F;const m=function(){c.xhr=null;c.abortable=false;if(c.queuedRequests!=null&&c.queuedRequests.length>0){const e=c.queuedRequests.shift();e()}};const U=re(r,"hx-prompt");if(U){var x=prompt(U);if(x===null||!he(r,"htmx:prompt",{prompt:x,target:u})){oe(s);m();return e}}if(f&&!D){if(!confirm(f)){oe(s);m();return e}}let y=fn(r,u,x);if(t!=="get"&&!pn(r)){y["Content-Type"]="application/x-www-form-urlencoded"}if(i.headers){y=ue(y,i.headers)}const B=un(r,t);let b=B.errors;const V=B.formData;if(i.values){ln(V,qn(i.values))}const j=qn(En(r));const w=ln(V,j);let v=hn(w,r);if(Q.config.getCacheBusterParam&&t==="get"){v.set("org.htmx.cache-buster",ee(u,"id")||"true")}if(n==null||n===""){n=ne().location.href}const S=bn(r,"hx-request");const _=ie(r).boosted;let E=Q.config.methodsThatUseUrlParams.indexOf(t)>=0;const C={boosted:_,useUrlParams:E,formData:v,parameters:An(v),unfilteredFormData:w,unfilteredParameters:An(w),headers:y,target:u,verb:t,errors:b,withCredentials:i.credentials||S.credentials||Q.config.withCredentials,timeout:i.timeout||S.timeout||Q.config.timeout,path:n,triggeringEvent:o};if(!he(r,"htmx:configRequest",C)){oe(s);m();return e}n=C.path;t=C.verb;y=C.headers;v=qn(C.parameters);b=C.errors;E=C.useUrlParams;if(b&&b.length>0){he(r,"htmx:validation:halted",C);oe(s);m();return e}const z=n.split("#");const $=z[0];const R=z[1];let O=n;if(E){O=$;const W=!v.keys().next().done;if(W){if(O.indexOf("?")<0){O+="?"}else{O+="&"}O+=an(v);if(R){O+="#"+R}}}if(!Tn(r,O,C)){fe(r,"htmx:invalidPath",C);oe(l);return e}p.open(t.toUpperCase(),O,true);p.overrideMimeType("text/html");p.withCredentials=C.withCredentials;p.timeout=C.timeout;if(S.noHeaders){}else{for(const k in y){if(y.hasOwnProperty(k)){const Y=y[k];Cn(p,k,Y)}}}const H={xhr:p,target:u,requestConfig:C,etc:i,boosted:_,select:X,pathInfo:{requestPath:n,finalRequestPath:O,responsePath:null,anchor:R}};p.onload=function(){try{const t=Hn(r);H.pathInfo.responsePath=Rn(p);M(r,H);Qt(T,q);he(r,"htmx:afterRequest",H);he(r,"htmx:afterOnLoad",H);if(!le(r)){let e=null;while(t.length>0&&e==null){const n=t.shift();if(le(n)){e=n}}if(e){he(e,"htmx:afterRequest",H);he(e,"htmx:afterOnLoad",H)}}oe(s);m()}catch(e){fe(r,"htmx:onLoadError",ue({error:e},H));throw e}};p.onerror=function(){Qt(T,q);fe(r,"htmx:afterRequest",H);fe(r,"htmx:sendError",H);oe(l);m()};p.onabort=function(){Qt(T,q);fe(r,"htmx:afterRequest",H);fe(r,"htmx:sendAbort",H);oe(l);m()};p.ontimeout=function(){Qt(T,q);fe(r,"htmx:afterRequest",H);fe(r,"htmx:timeout",H);oe(l);m()};if(!he(r,"htmx:beforeRequest",H)){oe(s);m();return e}var T=Wt(r);var q=Yt(r);se(["loadstart","loadend","progress","abort"],function(t){se([p,p.upload],function(e){e.addEventListener(t,function(e){he(r,"htmx:xhr:"+t,{lengthComputable:e.lengthComputable,loaded:e.loaded,total:e.total})})})});he(r,"htmx:beforeSend",H);const J=E?null:mn(p,r,v);p.send(J);return e}function Nn(e,t){const n=t.xhr;let r=null;let o=null;if(C(n,/HX-Push:/i)){r=n.getResponseHeader("HX-Push");o="push"}else if(C(n,/HX-Push-Url:/i)){r=n.getResponseHeader("HX-Push-Url");o="push"}else if(C(n,/HX-Replace-Url:/i)){r=n.getResponseHeader("HX-Replace-Url");o="replace"}if(r){if(r==="false"){return{}}else{return{type:o,path:r}}}const i=t.pathInfo.finalRequestPath;const s=t.pathInfo.responsePath;const l=re(e,"hx-push-url");const u=re(e,"hx-replace-url");const c=ie(e).boosted;let a=null;let f=null;if(l){a="push";f=l}else if(u){a="replace";f=u}else if(c){a="push";f=s||i}if(f){if(f==="false"){return{}}if(f==="true"){f=s||i}if(t.pathInfo.anchor&&f.indexOf("#")===-1){f=f+"#"+t.pathInfo.anchor}return{type:a,path:f}}else{return{}}}function In(e,t){var n=new RegExp(e.code);return n.test(t.toString(10))}function Pn(e){for(var t=0;t0){E().setTimeout(e,x.swapDelay)}else{e()}}if(f){fe(o,"htmx:responseError",ue({error:"Response Status Error Code "+s.status+" from "+i.pathInfo.requestPath},i))}}const Mn={};function Xn(){return{init:function(e){return null},onEvent:function(e,t){return true},transformResponse:function(e,t,n){return e},isInlineSwap:function(e){return false},handleSwap:function(e,t,n,r){return false},encodeParameters:function(e,t,n){return null}}}function Fn(e,t){if(t.init){t.init(n)}Mn[e]=ue(Xn(),t)}function Un(e){delete Mn[e]}function Bn(e,n,r){if(n==undefined){n=[]}if(e==undefined){return n}if(r==undefined){r=[]}const t=te(e,"hx-ext");if(t){se(t.split(","),function(e){e=e.replace(/ /g,"");if(e.slice(0,7)=="ignore:"){r.push(e.slice(7));return}if(r.indexOf(e)<0){const t=Mn[e];if(t&&n.indexOf(t)<0){n.push(t)}}})}return Bn(ce(u(e)),n,r)}var Vn=false;ne().addEventListener("DOMContentLoaded",function(){Vn=true});function jn(e){if(Vn||ne().readyState==="complete"){e()}else{ne().addEventListener("DOMContentLoaded",e)}}function _n(){if(Q.config.includeIndicatorStyles!==false){ne().head.insertAdjacentHTML("beforeend","")}}function zn(){const e=ne().querySelector('meta[name="htmx-config"]');if(e){return S(e.content)}else{return null}}function $n(){const e=zn();if(e){Q.config=ue(Q.config,e)}}jn(function(){$n();_n();let e=ne().body;kt(e);const t=ne().querySelectorAll("[hx-trigger='restored'],[data-hx-trigger='restored']");e.addEventListener("htmx:abort",function(e){const t=e.target;const n=ie(t);if(n&&n.xhr){n.xhr.abort()}});const n=window.onpopstate?window.onpopstate.bind(window):null;window.onpopstate=function(e){if(e.state&&e.state.htmx){Zt();se(t,function(e){he(e,"htmx:restored",{document:ne(),triggerEvent:he})})}else{if(n){n(e)}}};E().setTimeout(function(){he(e,"htmx:load",{});e=null},0)});return Q}(); \ No newline at end of file diff --git a/src/public/assets/style.css b/src/public/assets/style.css index 9ce2647..14747cc 100644 --- a/src/public/assets/style.css +++ b/src/public/assets/style.css @@ -43,6 +43,38 @@ header { main { padding: 0 .5rem; + .refresh, .loading { + font-style: italic; + font-size: .9rem; + } + .htmx-request .refresh { + display: none; + } + + .loading { + display: none; + } + .htmx-request .loading { + display: inline; + } + + .user_messages { + display: flex; + flex-flow: column; + justify-content: center; + } + .user_message { + margin: .25rem auto; + border: solid 1px navy; + border-radius: .5rem; + background-color: rgba(255, 255, 255, .75); + padding: .25rem; + } + + .user_messages + h1 { + margin-top: .25rem; + } + .item_heading { margin-bottom: 0; } @@ -78,7 +110,7 @@ input[type=url], input[type=text], input[type=email], input[type=password] { - width: 50%; + width: 40%; font-size: 1rem; padding: .25rem; border-radius: .25rem; diff --git a/src/public/index.php b/src/public/index.php index 7b8de61..63c32f8 100644 --- a/src/public/index.php +++ b/src/public/index.php @@ -32,13 +32,17 @@ $query->bindValue(':userId', $_SESSION[Key::USER_ID]); $result = $query->execute(); $item = $result ? $result->fetchArray(SQLITE3_ASSOC) : false; -page_head('Welcome'); ?> -

Your Unread Items   (Refresh All Feeds)

+page_head('Your Unread Items'); ?> +

+ Your Unread Items   + (Refresh All Feeds) + Refreshing… +

-

>
-
hx-get=/item?id=> +

fetchArray(SQLITE3_ASSOC); } } else { ?> diff --git a/src/public/item.php b/src/public/item.php index b7a2cfb..37b5436 100644 --- a/src/public/item.php +++ b/src/public/item.php @@ -30,6 +30,26 @@ if ($_SERVER['REQUEST_METHOD'] == 'POST') { frc_redirect('/'); } +if ($_SERVER['REQUEST_METHOD'] == 'DELETE') { + $deleteQuery = $db->prepare(<<<'SQL' + DELETE FROM item + WHERE id IN ( + SELECT item.id + FROM item INNER JOIN feed ON feed.id = item.feed_id + WHERE item.id = :id + AND feed.user_id = :user) + SQL); + $deleteQuery->bindValue(':id', $_GET['id']); + $deleteQuery->bindValue(':user', $_SESSION[Key::USER_ID]); + if ($deleteQuery->execute()) { + add_info('Item deleted'); + } else { + add_error(Data::error($db)['error']); + } + $db->close(); + frc_redirect('/'); +} + $query = $db->prepare(<<<'SQL' SELECT item.title AS item_title, item.item_link, item.published_on, item.updated_on, item.content, feed.title AS feed_title @@ -61,10 +81,11 @@ page_head(htmlentities("{$item['item_title']} | {$item['feed_title']}")); ?>

-
+ > - Done + Done +

Log On

-
$level, 'message' => $message]; + if (!array_key_exists(Key::USER_MSG, $_SESSION)) $_SESSION[Key::USER_MSG] = array(); + $_SESSION[Key::USER_MSG][] = ['level' => $level, 'message' => $message]; } /** @@ -38,49 +38,75 @@ function add_info(string $message): void { add_message('INFO', $message); } +/** @var bool $is_htmx True if this request was initiated by htmx, false if not */ +$is_htmx = array_key_exists('HTTP_HX_REQUEST', $_SERVER) + && !array_key_exists('HTTP_HX_HISTORY_RESTORE_REQUEST', $_SERVER); + /** * Render the page title * @param string $title The title of the page being displayed */ function page_head(string $title): void { + global $is_htmx; $version = match (true) { str_ends_with(FRC_VERSION, '.0.0') => substr(FRC_VERSION, 0, strlen(FRC_VERSION) - 4), str_ends_with(FRC_VERSION, '.0') => substr(FRC_VERSION, 0, strlen(FRC_VERSION) - 2), default => FRC_VERSION - } ?> + }; + //if ($is_htmx) header('HX-Push-Url: true'); + ?> - - <?=$title?> | Feed Reader Central - + <?=$title?> | Feed Reader Central + + - -
- -
Add Feed | Docs | Log Off'; - if ($_SESSION[Key::USER_EMAIL] != Security::SINGLE_USER_EMAIL) echo " | {$_SESSION[Key::USER_EMAIL]}"; - } else { - echo 'Log On | Docs'; - } ?> -
-
-
-
- {$msg['level']}
"?> - -
+
+ +
+ Add Feed | + Docs | + Log Off + | + Log On | Docs +
+
+
0) { ?> +
+
+ {$msg['level']}
"?> + +
+
'; + global $is_htmx; ?> +
+ + +