Merge pull request 'Alpha 7' (#22) from alpha-7 into main

Reviewed-on: #22

src/app-config.php

@@ -1,7 +1,7 @@
 <?php
 
 /** The current Feed Reader Central version */
-const FRC_VERSION = '1.0.0-alpha6';
+const FRC_VERSION = '1.0.0-alpha7';
 
 spl_autoload_register(function ($class) {
     $file = implode(DIRECTORY_SEPARATOR, [__DIR__, 'lib', "$class.php"]);
@@ -18,3 +18,17 @@ Data::ensureDb();
 
 /** @var string The date the world wide web was created */
 const WWW_EPOCH = '1993-04-30T00:00:00+00:00';
+
+/**
+ * Capitalize the first letter of the given string
+ *
+ * @param string $value The string to be capitalized
+ * @return string The given string with the first letter capitalized
+ */
+function init_cap(string $value): string {
+    return match (strlen($value)) {
+        0       => "",
+        1       => strtoupper($value),
+        default => strtoupper(substr($value, 0, 1)) . substr($value, 1),
+    };
+}

src/cli-start.php

@@ -28,17 +28,3 @@ function cli_title(string $title): void {
     printfn('  | %s | %s |', $title, $appTitle);
     printfn($dashes . PHP_EOL);
 }
-
-/**
- * Capitalize the first letter of the given string
- *
- * @param string $value The string to be capitalized
- * @return string The given string with the first letter capitalized
- */
-function init_cap(string $value): string {
-    return match (strlen($value)) {
-        0       => "",
-        1       => strtoupper($value),
-        default => strtoupper(substr($value, 0, 1)) . substr($value, 1),
-    };
-}

src/lib/Data.php

@@ -14,6 +14,31 @@ class Data {
         return $db;
     }
 
+    /**
+     * Create the search index and synchronization triggers for the item table
+     *
+     * @param SQLite3 $db The database connection on which these will be created
+     */
+    public static function createSearchIndex(SQLite3 $db): void {
+        $db->exec("CREATE VIRTUAL TABLE item_search USING fts5(content, content='item', content_rowid='id')");
+        $db->exec(<<<'SQL'
+                CREATE TRIGGER item_ai AFTER INSERT ON item BEGIN
+                    INSERT INTO item_search (rowid, content) VALUES (new.id, new.content);
+                END;
+                SQL);
+        $db->exec(<<<'SQL'
+                CREATE TRIGGER item_au AFTER UPDATE ON item BEGIN
+                    INSERT INTO item_search (item_search, rowid, content) VALUES ('delete', old.id, old.content);
+                    INSERT INTO item_search (rowid, content) VALUES (new.id, new.content);
+                END;
+                SQL);
+        $db->exec(<<<'SQL'
+                CREATE TRIGGER item_ad AFTER DELETE ON item BEGIN
+                    INSERT INTO item_search (item_search, rowid, content) VALUES ('delete', old.id, old.content);
+                END;
+                SQL);
+    }
+
     /**
      * Make sure the expected tables exist
      */
@@ -23,17 +48,16 @@ class Data {
         $tableQuery = $db->query("SELECT name FROM sqlite_master WHERE type = 'table'");
         while ($table = $tableQuery->fetchArray(SQLITE3_NUM)) $tables[] = $table[0];
         if (!in_array('frc_user', $tables)) {
-            $query = <<<'SQL'
+            $db->exec(<<<'SQL'
                 CREATE TABLE frc_user (
                     id       INTEGER NOT NULL PRIMARY KEY,
                     email    TEXT    NOT NULL,
                     password TEXT    NOT NULL)
-                SQL;
+                SQL);
-            $db->exec($query);
             $db->exec('CREATE INDEX idx_user_email ON frc_user (email)');
         }
         if (!in_array('feed', $tables)) {
-            $query = <<<'SQL'
+            $db->exec(<<<'SQL'
                 CREATE TABLE feed (
                     id         INTEGER NOT NULL PRIMARY KEY,
                     user_id    INTEGER NOT NULL,
@@ -42,11 +66,10 @@ class Data {
                     updated_on TEXT,
                     checked_on TEXT,
                     FOREIGN KEY (user_id) REFERENCES frc_user (id))
-                SQL;
+                SQL);
-            $db->exec($query);
         }
         if (!in_array('item', $tables)) {
-            $query = <<<'SQL'
+            $db->exec(<<<'SQL'
                 CREATE TABLE item (
                     id            INTEGER NOT NULL PRIMARY KEY,
                     feed_id       INTEGER NOT NULL,
@@ -59,8 +82,8 @@ class Data {
                     is_read       BOOLEAN NOT NULL DEFAULT 0,
                     is_bookmarked BOOLEAN NOT NULL DEFAULT 0,
                     FOREIGN KEY (feed_id) REFERENCES feed (id))
-                SQL;
+                SQL);
-            $db->exec($query);
+            self::createSearchIndex($db);
         }
         $db->close();
     }

src/lib/Feed.php

@@ -239,19 +239,19 @@ class Feed {
         $start = strtolower(strlen($doc['content']) >= 9 ? substr($doc['content'], 0, 9) : $doc['content']);
         if ($start == '<!doctype' || str_starts_with($start, '<html')) {
             $derivedURL = self::deriveFeedFromHTML($doc['content']);
-            if (array_key_exists('error', $derivedURL)) return ['error' => $derivedURL['error']];
+            if (key_exists('error', $derivedURL)) return ['error' => $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']}" : '';
+                $port     = 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']];
+        if (key_exists('error', $parsed)) return ['error' => $parsed['error']];
 
         $extract = $parsed['ok']->getElementsByTagNameNS(self::ATOM_NS, 'feed')->length > 0
             ? self::fromAtom(...) : self::fromRSS(...);
@@ -388,7 +388,7 @@ class Feed {
      */
     public static function refreshFeed(int $feedId, string $url, SQLite3 $db): array {
         $feedRetrieval = self::retrieveFeed($url);
-        if (array_key_exists('error', $feedRetrieval)) return $feedRetrieval;
+        if (key_exists('error', $feedRetrieval)) return $feedRetrieval;
         $feed = $feedRetrieval['ok'];
 
         $lastCheckedQuery = $db->prepare('SELECT checked_on FROM feed where id = :id');
@@ -399,7 +399,7 @@ class Feed {
         }
 
         $itemUpdate = self::updateItems($feedId, $feed, $lastChecked, $db);
-        if (array_key_exists('error', $itemUpdate)) return $itemUpdate;
+        if (key_exists('error', $itemUpdate)) return $itemUpdate;
 
         $urlUpdate = $url == $feed->url ? '' : ', url = :url';
         $feedUpdate = $db->prepare(<<<SQL
@@ -428,7 +428,7 @@ class Feed {
      */
     public static function add(string $url, SQLite3 $db): array {
         $feedExtract = self::retrieveFeed($url);
-        if (array_key_exists('error', $feedExtract)) return $feedExtract;
+        if (key_exists('error', $feedExtract)) return $feedExtract;
 
         $feed = $feedExtract['ok'];
 
@@ -454,7 +454,7 @@ class Feed {
 
         $feedId = $db->lastInsertRowID();
         $result = self::updateItems($feedId, $feed, date_create_immutable(WWW_EPOCH), $db);
-        if (array_key_exists('error', $result)) return $result;
+        if (key_exists('error', $result)) return $result;
 
         return ['ok' => $feedId];
     }
@@ -504,12 +504,12 @@ class Feed {
      */
     public static function refreshAll(SQLite3 $db): array {
         $feeds = self::retrieveAll($db, $_SESSION[Key::USER_ID]);
-        if (array_key_exists('error', $feeds)) return $feeds;
+        if (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'];
+            if (key_exists('error', $result)) $errors[] = $result['error'];
         });
 
         return sizeof($errors) == 0 ? ['ok' => true] : ['error' => implode("\n", $errors)];

src/lib/ItemList.php

@@ -0,0 +1,191 @@
+<?php
+
+/**
+ * A list of items to be displayed
+ *
+ * This is a wrapper for retrieval and display of arbitrary lists of items based on a SQLite result.
+ */
+class ItemList {
+
+    /** @var SQLite3Result The list of items to be displayed */
+    private SQLite3Result $items;
+
+    /** @var string The error message generated by executing a query */
+    public string $error = '';
+
+    /**
+     * Is there an error condition associated with this list?
+     *
+     * @return bool True if there is an error condition associated with this list, false if not
+     */
+    public function isError(): bool {
+        return $this->error != '';
+    }
+
+    /** @var bool Whether to render a link to the feed to which the item belongs */
+    public bool $linkFeed = false;
+
+    /** @var bool Whether to display the feed to which the item belongs */
+    public bool $displayFeed = false;
+
+    /** @var bool Whether to show read / bookmarked indicators on posts */
+    public bool $showIndicators = false;
+
+    /**
+     * Constructor
+     *
+     * @param SQLite3 $db The database connection (used to retrieve error information if the query fails)
+     * @param SQLite3Stmt $query The query to retrieve the items for this list
+     * @param string $itemType The type of item being displayed (unread, bookmark, etc.)
+     * @param string $returnURL The URL to which the item page should return once the item has been viewed
+     */
+    private function __construct(SQLite3 $db, SQLite3Stmt $query, public string $itemType, public string $returnURL = '') {
+        $result = $query->execute();
+        if (!$result) {
+            $this->error = Data::error($db)['error'];
+        } else {
+            $this->items = $result;
+        }
+    }
+
+    /**
+     * Create an item list query
+     *
+     * @param SQLite3 $db The database connection to use to obtain items
+     * @param array $criteria One or more SQL WHERE conditions (will be combined with AND)
+     * @param array $parameters Parameters to be added to the query (key index 0, value index 1; optional)
+     * @return SQLite3Stmt The query, ready to be executed
+     */
+    private static function makeQuery(SQLite3 $db, array $criteria, array $parameters = []): SQLite3Stmt {
+        $where = empty($criteria) ? '' : 'AND ' . implode(' AND ', $criteria);
+        $sql   = <<<SQL
+        SELECT item.id, item.feed_id, item.title AS item_title, coalesce(item.updated_on, item.published_on) AS as_of,
+               item.is_read, item.is_bookmarked, feed.title AS feed_title
+        FROM item INNER JOIN feed ON feed.id = item.feed_id
+        WHERE feed.user_id = :userId $where
+        ORDER BY coalesce(item.updated_on, item.published_on) DESC
+        SQL;
+        $query = $db->prepare($sql);
+        $query->bindValue(':userId', $_SESSION[Key::USER_ID]);
+        foreach ($parameters as $param) $query->bindValue($param[0], $param[1]);
+        return $query;
+    }
+
+    /**
+     * Create an item list with all the current user's bookmarked items
+     *
+     * @param SQLite3 $db The database connection to use to obtain items
+     * @return static An item list with all bookmarked items
+     */
+    public static function allBookmarked(SQLite3 $db): static {
+        $list = new static($db, self::makeQuery($db, ['item.is_bookmarked = 1']), 'Bookmarked', '/?bookmarked');
+        $list->linkFeed = true;
+        return $list;
+    }
+
+    /**
+     * Create an item list with all the current user's unread items
+     *
+     * @param SQLite3 $db The database connection to use to obtain items
+     * @return static An item list with all unread items
+     */
+    public static function allUnread(SQLite3 $db): static {
+        $list = new static($db, self::makeQuery($db, ['item.is_read = 0']), 'Unread');
+        $list->linkFeed = true;
+        return $list;
+    }
+
+    /**
+     * Create an item list with all items for the given feed
+     *
+     * @param int $feedId The ID of the feed for which items should be retrieved
+     * @param SQLite3 $db The database connection to use to obtain items
+     * @return static An item list with all items for the given feed
+     */
+    public static function allForFeed(int $feedId, SQLite3 $db): static {
+        $list = new static($db, self::makeQuery($db, ['feed.id = :feed'], [[':feed', $feedId]]), '',
+            "/feed/items?id=$feedId");
+        $list->showIndicators = true;
+        return $list;
+    }
+
+    /**
+     * Create an item list with unread items for the given feed
+     *
+     * @param int $feedId The ID of the feed for which items should be retrieved
+     * @param SQLite3 $db The database connection to use to obtain items
+     * @return static An item list with unread items for the given feed
+     */
+    public static function unreadForFeed(int $feedId, SQLite3 $db): static {
+        return new static($db, self::makeQuery($db, ['feed.id = :feed', 'item.is_read = 0'], [[':feed', $feedId]]),
+            'Unread', "/feed/items?id=$feedId&unread");
+    }
+
+    /**
+     * Create an item list with bookmarked items for the given feed
+     *
+     * @param int $feedId The ID of the feed for which items should be retrieved
+     * @param SQLite3 $db The database connection to use to obtain items
+     * @return static An item list with bookmarked items for the given feed
+     */
+    public static function bookmarkedForFeed(int $feedId, SQLite3 $db): static {
+        return new static($db,
+            self::makeQuery($db, ['feed.id = :feed', 'item.is_bookmarked = 1'], [[':feed', $feedId]]), 'Bookmarked',
+            "/feed/items?id=$feedId&bookmarked");
+    }
+
+    /**
+     * Create an item list with items matching given search terms
+     *
+     * @param string $search The item search terms / query
+     * @param bool $isBookmarked Whether to restrict the search to bookmarked items
+     * @param SQLite3 $db The database connection to use to obtain items
+     * @return static An item list match the given search terms
+     */
+    public static function matchingSearch(string $search, bool $isBookmarked, SQLite3 $db): static {
+        $where   = $isBookmarked ? ['item.is_bookmarked = 1'] : [];
+        $where[] = 'item.id IN (SELECT ROWID FROM item_search WHERE content MATCH :search)';
+        $list = new static($db, self::makeQuery($db, $where, [[':search', $search]]),
+            'Matching' . ($isBookmarked ? ' Bookmarked' : ''),
+            "/search?search=$search&items=" . ($isBookmarked ? 'bookmarked' : 'all'));
+        $list->showIndicators = true;
+        $list->displayFeed    = true;
+        return $list;
+    }
+
+    /**
+     * Render this item list
+     */
+    public function render(): void {
+        if ($this->isError()) { ?>
+            <p>Error retrieving list:<br><?=$this->error?><?php
+            return;
+        }
+        $item = $this->items->fetchArray(SQLITE3_ASSOC);
+        $return = $this->returnURL == '' ? '' : '&from=' . urlencode($this->returnURL);
+        echo '<article>';
+        if ($item) {
+            while ($item) { ?>
+                <p><?=hx_get("/item?id={$item['id']}$return", strip_tags($item['item_title']))?><br>
+                <small><?php
+                    if ($this->showIndicators) {
+                        if (!$item['is_read']) echo '<strong>Unread</strong> &nbsp; ';
+                        if ($item['is_bookmarked']) echo '<strong>Bookmarked</strong> &nbsp; ';
+                    }
+                    echo '<em>' . date_time($item['as_of']) . '</em>';
+                    if ($this->linkFeed) {
+                        echo ' &bull; ' .
+                            hx_get("/feed/items?id={$item['feed_id']}&" . strtolower($this->itemType),
+                                htmlentities($item['feed_title']));
+                    } elseif ($this->displayFeed) {
+                        echo ' &bull; ' . htmlentities($item['feed_title']);
+                    } ?>
+                </small><?php
+                $item = $this->items->fetchArray(SQLITE3_ASSOC);
+            }
+        } else { ?>
+            <p><em>There are no <?=strtolower($this->itemType)?> items</em><?php
+        }
+        echo '</article>';
+    }
+}

src/lib/Security.php

@@ -131,7 +131,7 @@ class Security {
      * @param bool $redirectIfAnonymous Whether to redirect the request if there is no user logged on
      */
     public static function verifyUser(SQLite3 $db, bool $redirectIfAnonymous = true): void {
-        if (array_key_exists(Key::USER_ID, $_SESSION)) return;
+        if (key_exists(Key::USER_ID, $_SESSION)) return;
 
         if (SECURITY_MODEL == self::SINGLE_USER) self::logOnSingleUser($db);
 

src/public/assets/style.css

@@ -25,28 +25,28 @@ header {
     flex-flow: row wrap;
     justify-content: space-between;
     align-items: baseline;
-
+    div, nav {
-    div {
         margin-bottom: .25rem;
     }
-
     .title {
         font-size: 1.5rem;
     }
-
     .version {
         font-size: .85rem;
         padding-left: .5rem;
         color: rgba(255, 255, 255, .75);
     }
-
     a:link, a:visited {
         color: white;
     }
+    nav {
+        display: flex;
+        flex-flow: row wrap;
+        gap: 0 .4rem;
+    }
 }
 main {
     padding: 0 .5rem;
-
     .refresh, .loading {
         font-style: italic;
         font-size: .9rem;
@@ -54,14 +54,12 @@ main {
     .htmx-request .refresh {
         display: none;
     }
-
     .loading {
         display: none;
     }
     .htmx-request .loading {
         display: inline;
     }
-
     .user_messages {
         display: flex;
         flex-flow: column;
@@ -74,15 +72,9 @@ main {
         background-color: rgba(255, 255, 255, .75);
         padding: .25rem;
     }
-
     .user_messages + h1 {
         margin-top: .25rem;
     }
-
-    .item_heading {
-        margin-bottom: 0;
-    }
-
     .item_published {
         margin-bottom: 1rem;
         line-height: 1.2;
@@ -91,37 +83,73 @@ main {
 article {
     max-width: 60rem;
     margin: auto;
-
     .item_content {
         border: solid 1px navy;
         border-radius: .5rem;
         background-color: white;
         padding: .5rem;
-
         img {
             max-width: 100%;
             object-fit: contain;
-            height: unset;
-            width: unset;
         }
     }
-
     .meta {
         font-size: .9rem;
     }
+    &.docs {
+        line-height: 1.4rem;
+    }
 }
-article.docs {
+form {
-    line-height: 1.4rem;
+    display: flex;
+    flex-flow: row wrap;
+    justify-content: center;
+    gap: 0 2rem;
+    label {
+        font-size: .9rem;
+        font-weight: bold;
+        input, select {
+            display: block;
+        }
+    }
+    .break {
+        flex-basis: 100%;
+        height: 1rem;
+        width: 0;
+    }
+    input[type=url],
+    input[type=text],
+    input[type=email],
+    input[type=password],
+    select {
+        min-width: 12rem;
+        max-width: 100%;
+        font-size: 1rem;
+        padding: .25rem;
+        border-radius: .25rem;
+        background-color: white;
+        border: solid 2px navy;
+    }
+    select {
+        min-width: unset;
+        max-width: unset;
+    }
 }
-
+@media all and (min-width: 60rem) {
-input[type=url],
+    form {
-input[type=text],
+        input[type=url],
-input[type=email],
+        input[type=text],
-input[type=password] {
+        input[type=email],
-    width: 40%;
+        input[type=password] {
-    font-size: 1rem;
+            min-width: 25rem;
-    padding: .25rem;
+        }
-    border-radius: .25rem;
+    }
+}
+.action_buttons {
+    margin: 1rem 0;
+    display: flex;
+    flex-flow: row nowrap;
+    justify-content: space-evenly;
 }
 button,
 .action_buttons a:link,
@@ -134,18 +162,11 @@ button,
     border-radius: .25rem;
     cursor: pointer;
     border: none;
-}
+    &:hover {
-button:hover,
+        text-decoration: none;
-.action_buttons a:hover {
+        cursor: pointer;
-    text-decoration: none;
+        background: linear-gradient(navy, #000032);
-    cursor: pointer;
+    }
-    background: linear-gradient(navy, #000032);
-}
-.action_buttons {
-    margin: 1rem 0;
-    display: flex;
-    flex-flow: row nowrap;
-    justify-content: space-evenly;
 }
 code {
     font-size: .9rem;
@@ -153,3 +174,28 @@ code {
 p.back-link {
     margin-top: -1rem;
 }
+.item_heading {
+    margin-bottom: 0;
+    .bookmark {
+        padding: 0;
+        border: solid 1px black;
+        border-radius: .5rem;
+        &.add {
+            background-color: lightgray;
+            &:hover {
+                background: linear-gradient(lightgreen, gray);
+            }
+        }
+        &.remove {
+            background: linear-gradient(lightgreen, green);
+            &:hover {
+                background: linear-gradient(gray, lightgreen);
+            }
+        }
+        img {
+            max-width: 1.5rem;
+            max-height: 1.5rem;
+            padding: .5rem;
+        }
+    }
+}

src/public/bookmark.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Bookmark Partial Handler
+ *
+ * This will display a button which will either add or remove a bookmark for a given item.
+ */
+
+include '../start.php';
+
+$db = Data::getConnection();
+Security::verifyUser($db);
+
+$id = $_GET['id'];
+
+$existsQuery = $db->prepare(
+    'SELECT item.id FROM item INNER JOIN feed ON feed.id = item.feed_id WHERE item.id = :id AND feed.user_id = :user');
+$existsQuery->bindValue(':id',   $id);
+$existsQuery->bindValue(':user', $_SESSION[Key::USER_ID]);
+$existsResult = $existsQuery->execute();
+$exists = $existsResult ? $existsResult->fetchArray(SQLITE3_ASSOC) : false;
+
+if (!$exists) not_found();
+
+if (key_exists('action', $_GET)) {
+    if ($_GET['action'] == 'add') {
+        $flag = 1;
+    } elseif ($_GET['action'] == 'remove') {
+        $flag = 0;
+    }
+    if (isset($flag)) {
+        $update = $db->prepare('UPDATE item SET is_bookmarked = :flag WHERE id = :id');
+        $update->bindValue(':id',   $id);
+        $update->bindValue(':flag', $flag);
+        if (!$update->execute()) die(Data::error($db)['error']);
+    }
+}
+
+$bookQuery = $db->prepare('SELECT id, is_bookmarked FROM item WHERE id = :id');
+$bookQuery->bindValue(':id', $id);
+$bookResult = $bookQuery->execute();
+$bookmark = $bookResult ? $bookResult->fetchArray(SQLITE3_ASSOC) : ['id' => $id, 'is_bookmarked' => 0];
+
+$action = $bookmark['is_bookmarked'] ? 'remove' : 'add';
+$icon   = $bookmark['is_bookmarked'] ? 'added'  : 'add'; ?>
+<button class="bookmark <?=$action?>" type=button role=button hx-patch="/bookmark?id=<?=$id?>&action=<?=$action?>"
+        hx-target=this hx-swap=outerHTML hx-push-url=false title="<?=init_cap($action)?> Bookmark">
+    <img src=/assets/bookmark-<?=$icon?>.png alt="<?=$action?> bookmark">
+</button><?php

src/public/feed/index.php

@@ -35,7 +35,7 @@ if ($_SERVER['REQUEST_METHOD'] == 'POST') {
         $toEdit = Feed::retrieveById($_POST['id'], $db);
         $result = $toEdit ? Feed::update($toEdit, $_POST['url'], $db) : ['error' => "Feed {$_POST['id']} not found"];
     }
-    if (array_key_exists('ok', $result)) {
+    if (key_exists('ok', $result)) {
         add_info('Feed saved successfully');
         frc_redirect('/feeds');
     }
@@ -61,7 +61,8 @@ page_head($title); ?>
         <label>
             Feed URL
             <input type=url name=url required autofocus value="<?=$feed['url']?>">
-        </label><br>
+        </label>
+        <span class=break></span>
         <button type=submit>Save</button>
     </form>
 </article><?php

src/public/feed/items.php

@@ -12,68 +12,19 @@ Security::verifyUser($db);
 
 if (!($feed = Feed::retrieveById($_GET['id'], $db))) not_found();
 
-/** Display a list of unread items for this feed */
+$list = match (true) {
-const TYPE_UNREAD = 0;
+    key_exists('unread',     $_GET) => ItemList::unreadForFeed($feed['id'], $db),
-
+    key_exists('bookmarked', $_GET) => ItemList::bookmarkedForFeed($feed['id'], $db),
-/** Display a list of bookmarked items for this feed */
+    default                         => ItemList::allForFeed($feed['id'], $db)
-const TYPE_BOOKMARKED = 1;
-
-/** Display all items for this feed */
-const TYPE_ALL = 2;
-
-$type = match (true) {
-    array_key_exists('unread', $_GET)     => TYPE_UNREAD,
-    array_key_exists('bookmarked', $_GET) => TYPE_BOOKMARKED,
-    default                               => TYPE_ALL
 };
 
-$extraSQL = match ($type) {
+page_head(($list->itemType != '' ? "$list->itemType Items | " : '') . strip_tags($feed['title']));
-    TYPE_UNREAD     => ' AND is_read = 0',
+if ($list->itemType == '') {
-    TYPE_BOOKMARKED => ' AND is_bookmarked = 1',
+    echo '<h1>' . htmlentities($feed['title']) . '</h1>';
-    default         => ''
+} else {
-};
+    echo '<h1 class=item_heading>' . htmlentities($feed['title']) . '</h1>';
-$itemQuery = $db->prepare(<<<SQL
+    echo "<div class=item_published>$list->itemType Items</div>";
-    SELECT id, title, coalesce(updated_on, published_on) AS as_of, is_read, is_bookmarked
+}
-      FROM item
+$list->render();
-     WHERE feed_id = :feed$extraSQL
-     ORDER BY date(coalesce(updated_on, published_on)) DESC
-    SQL);
-$itemQuery->bindValue(':feed', $feed['id']);
-if (!($itemResult = $itemQuery->execute())) add_error(Data::error($db)['error']);
-$item = $itemResult ? $itemResult->fetchArray(SQLITE3_ASSOC) : false;
-
-$queryParam = match ($type) {
-    TYPE_UNREAD     => '&unread',
-    TYPE_BOOKMARKED => '&bookmarked',
-    default         => ''
-};
-$thisURL = urlencode("/feed/items?id={$feed['id']}$queryParam");
-
-$listType = match ($type) {
-    TYPE_UNREAD     => 'Unread',
-    TYPE_BOOKMARKED => 'Bookmarked',
-    default         => ''
-};
-
-page_head(($type != TYPE_ALL ? "$listType Items | " : '') . strip_tags($feed['title']));
-if ($type == TYPE_ALL) { ?>
-    <h1><?=htmlentities($feed['title'])?></h1><?php
-} else { ?>
-    <h1 class=item_heading><?=htmlentities($feed['title'])?></h1>
-    <div class=item_published><?=$listType?> Items</div><?php
-} ?>
-<article><?php
-    if ($item) {
-        while ($item) { ?>
-            <p><?=hx_get("/item?id={$item['id']}&from=$thisURL", strip_tags($item['title']))?><br>
-                <small><?=$item['is_read'] == 0 ? '<strong>New</strong> &nbsp; ' : ''?>
-                    <em><?=date_time($item['as_of'])?></em></small><?php
-            $item = $itemResult->fetchArray(SQLITE3_ASSOC);
-        }
-    } else { ?>
-        <p><em>There are no <?=strtolower($listType)?> items</em><?php
-    } ?>
-</article>
-<?php
 page_foot();
 $db->close();

src/public/index.php

@@ -2,7 +2,7 @@
 /**
  * Home Page
  *
- * Displays a list of unread feed items for the current user
+ * Displays a list of unread or bookmarked items for the current user
  */
 
 include '../start.php';
@@ -10,46 +10,28 @@ include '../start.php';
 $db = Data::getConnection();
 Security::verifyUser($db);
 
-if (array_key_exists('refresh', $_GET)) {
+if (key_exists('refresh', $_GET)) {
     $refreshResult = Feed::refreshAll($db);
-    if (array_key_exists('ok', $refreshResult)) {
+    if (key_exists('ok', $refreshResult)) {
         add_info('All feeds refreshed successfully');
     } else {
         add_error(nl2br($refreshResult['error']));
     }
 }
 
-$query = $db->prepare(<<<'SQL'
+$list = match (true) {
-    SELECT item.id, item.feed_id, item.title AS item_title, coalesce(item.updated_on, item.published_on) AS as_of,
+    key_exists('bookmarked', $_GET) => ItemList::allBookmarked($db),
-           feed.title AS feed_title
+    default                         => ItemList::allUnread($db)
-      FROM item
+};
-           INNER JOIN feed ON feed.id = item.feed_id
+$title = "Your $list->itemType Items";
-     WHERE feed.user_id = :userId 
-       AND item.is_read = 0
-     ORDER BY coalesce(item.updated_on, item.published_on) DESC
-    SQL);
-$query->bindValue(':userId', $_SESSION[Key::USER_ID]);
-$result = $query->execute();
-$item   = $result ? $result->fetchArray(SQLITE3_ASSOC) : false;
-
-page_head('Your Unread Items'); ?>
-<h1>
-    Your Unread Items &nbsp;
-    <a class=refresh href=/?refresh hx-get=/?refresh hx-indicator="closest h1">(Refresh All Feeds)</a>
-    <span class=loading>Refreshing&hellip;</span>
-</h1>
-<article><?php
-if ($item) {
-    while ($item) { ?>
-        <p><?=hx_get("/item?id={$item['id']}", strip_tags($item['item_title']))?><br>
-            <small><?=date_time($item['as_of'])?> &bull;
-                <?=hx_get("/feed/items?id={$item['feed_id']}&unread", htmlentities($item['feed_title']))?></small><?php
-        $item = $result->fetchArray(SQLITE3_ASSOC);
-    }
-} else { ?>
-    <p>There are no unread items</p><?php
-} ?>
-</article><?php
 
+page_head($title);
+echo "<h1>$title";
+if ($list->itemType == 'Unread') {
+    echo ' &nbsp; ' . hx_get('/?refresh', '(Refresh All Feeds)', 'class=refresh hx-indicator="closest h1"')
+        . '<span class=loading>Refreshing&hellip;</span>';
+}
+echo '</h1>';
+$list->render();
 page_foot();
 $db->close();

src/public/item.php

@@ -75,6 +75,8 @@ $updated   = isset($item['updated_on']) ? date_time($item['updated_on']) : null;
 
 page_head(htmlentities("{$item['item_title']} | {$item['feed_title']}")); ?>
 <h1 class=item_heading>
+    <span class=bookmark hx-get="/bookmark?id=<?=$_GET['id']?>" hx-trigger=load hx-target=this hx-swap=outerHTML
+          hx-push-url=false></span>
     <a href="<?=$item['item_link']?>" target=_blank rel=noopener><?=strip_tags($item['item_title'])?></a><br>
 </h1>
 <div class=item_published>

src/public/search.php

@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * Item Search Page
+ *
+ * Search for items across all feeds
+ */
+
+include '../start.php';
+
+$db = Data::getConnection();
+Security::verifyUser($db);
+
+$search = $_GET['search'] ?? '';
+$items  = $_GET['items']  ?? 'all';
+
+if ($search != '') {
+    $list = ItemList::matchingSearch($search, $items == 'bookmarked', $db);
+}
+
+page_head('Item Search'); ?>
+<h1>Item Search</h1>
+<article>
+    <form method=GET action=/search>
+        <label>
+            Search Criteria
+            <input type=text name=search required autofocus value="<?=htmlspecialchars($search)?>">
+        </label>
+        <label>
+            Items to Search
+            <select name=items>
+                <option value=all <?=$items == 'all' ? ' selected' : ''?>>All</option>
+                <option value=bookmarked <?=$items == 'bookmarked' ? ' selected' : ''?>>Bookmarked</option>
+            </select>
+        </label>
+        <span class=break></span>
+        <button type=submit>Search</button>
+    </form><?php
+    if (isset($list)) { ?>
+        <hr><?php
+        $list->render();
+    } ?>
+</article><?php
+page_foot();
+$db->close();

src/public/user/log-off.php

@@ -5,6 +5,6 @@
 
 include '../../start.php';
 
-if (array_key_exists(Key::USER_ID, $_SESSION)) session_destroy();
+if (key_exists(Key::USER_ID, $_SESSION)) session_destroy();
 
 frc_redirect('/');

src/public/user/log-on.php

@@ -5,7 +5,7 @@ $db = Data::getConnection();
 Security::verifyUser($db, redirectIfAnonymous: false);
 
 // Users already logged on have no need of this page
-if (array_key_exists(Key::USER_ID, $_SESSION)) frc_redirect('/');
+if (key_exists(Key::USER_ID, $_SESSION)) frc_redirect('/');
 
 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
     Security::logOnUser($_POST['email'] ?? '', $_POST['password'], $_POST['returnTo'] ?? null, $db);
@@ -26,12 +26,13 @@ page_head('Log On'); ?>
             <label>
                 E-mail Address
                 <input type=email name=email required autofocus>
-            </label><br><?php
+            </label><?php
         } ?>
         <label>
             Password
             <input type=password name=password required<?=$isSingle ? ' autofocus' : ''?>>
-        </label><br>
+        </label>
+        <span class=break></span>
         <button type=submit>Log On</button>
     </form>
 </article><?php

src/start.php

@@ -16,7 +16,7 @@ session_start([
  * @param string $message The message itself
  */
 function add_message(string $level, string $message): void {
-    if (!array_key_exists(Key::USER_MSG, $_SESSION)) $_SESSION[Key::USER_MSG] = array();
+    if (!key_exists(Key::USER_MSG, $_SESSION)) $_SESSION[Key::USER_MSG] = array();
     $_SESSION[Key::USER_MSG][] = ['level' => $level, 'message' => $message];
 }
 
@@ -39,8 +39,12 @@ function add_info(string $message): void {
 }
 
 /** @var bool $is_htmx True if this request was initiated by htmx, false if not */
-$is_htmx = array_key_exists('HTTP_HX_REQUEST', $_SERVER)
+$is_htmx = key_exists('HTTP_HX_REQUEST', $_SERVER) && !key_exists('HTTP_HX_HISTORY_RESTORE_REQUEST', $_SERVER);
-    && !array_key_exists('HTTP_HX_HISTORY_RESTORE_REQUEST', $_SERVER);
+
+function nav_link(string $link, bool $isFirst = false) {
+    $sep = $isFirst ? '' : ' | ';
+    echo "<span>$sep$link</span>";
+}
 
 /**
  * Render the title bar for the page
@@ -52,18 +56,36 @@ function title_bar(): void {
         default                            => FRC_VERSION
     }; ?>
     <header hx-target=#main hx-push-url=true>
-        <div><?=hx_get('/', 'Feed Reader Central', 'class=title')?><span class=version>v<?=$version?></span></div>
+        <div><a href=/ class=title>Feed Reader Central</a><span class=version>v<?=$version?></span></div>
-        <div><?php
+        <nav><?php
-            if (array_key_exists(Key::USER_ID, $_SESSION)) { ?>
+            if (key_exists(Key::USER_ID, $_SESSION)) {
-                <?=hx_get('/feeds', 'Feeds')?> | <?=hx_get('/docs/', 'Docs')?> |
+                $db = Data::getConnection();
-                <a href=/user/log-off>Log Off</a><?php
+                try {
-                if ($_SESSION[Key::USER_EMAIL] != Security::SINGLE_USER_EMAIL) { ?>
+                    $bookQuery = $db->prepare(<<<'SQL'
-                    | <?=$_SESSION[Key::USER_EMAIL]?><?php
+                        SELECT EXISTS(
+                            SELECT 1
+                              FROM item INNER JOIN feed ON item.feed_id = feed.id
+                             WHERE feed.user_id = :id AND item.is_bookmarked = 1)
+                        SQL);
+                    $bookQuery->bindValue(':id', $_SESSION[Key::USER_ID]);
+                    $bookResult   = $bookQuery->execute();
+                    $hasBookmarks = $bookResult && $bookResult->fetchArray(SQLITE3_NUM)[0];
+                    nav_link(hx_get('/feeds', 'Feeds'), true);
+                    if ($hasBookmarks) nav_link(hx_get('/?bookmarked', 'Bookmarked'));
+                    nav_link(hx_get('/search', 'Search'));
+                    nav_link(hx_get('/docs/', 'Docs'));
+                    nav_link('<a href=/user/log-off>Log Off</a>');
+                    if ($_SESSION[Key::USER_EMAIL] != Security::SINGLE_USER_EMAIL) {
+                        nav_link($_SESSION[Key::USER_EMAIL]);
+                    }
+                } finally {
+                    $db->close();
                 }
-            } else { ?>
+            } else {
-                <?=hx_get('/user/log-on', 'Log On')?> | <?=hx_get('/docs/', 'Docs')?><?php
+                nav_link(hx_get('/user/log-on', 'Log On'), true);
+                nav_link(hx_get('/docs/', 'Docs'));
             } ?>
-        </div>
+        </nav>
     </header>
     <main id=main hx-target=this hx-push-url=true hx-swap="innerHTML show:window:top"><?php
 }
@@ -106,9 +128,7 @@ function page_head(string $title): void {
 function page_foot(): void {
     global $is_htmx; ?>
     </main><?php
-    if (!$is_htmx) { ?>
+    if (!$is_htmx) echo '<script src=/assets/htmx.min.js></script>'; ?>
-        <script src=/assets/htmx.min.js></script><?php
-    } ?>
 </body>
 </html><?php
     session_commit();

src/util/search.php

@@ -0,0 +1,49 @@
+<?php
+use JetBrains\PhpStorm\NoReturn;
+
+require __DIR__ . '/../cli-start.php';
+
+cli_title('SEARCH MAINTENANCE');
+
+if ($argc < 2) display_help();
+
+switch ($argv[1]) {
+    case 'rebuild':
+        rebuild_index();
+        break;
+    default:
+        printfn('Unrecognized option "%s"', $argv[1]);
+        display_help();
+}
+
+
+/**
+ * Display the options for this utility and exit
+ */
+#[NoReturn]
+function display_help(): void {
+    printfn('Options:');
+    printfn(' - rebuild');
+    printfn('     Rebuilds search index');
+    exit(0);
+}
+
+/**
+ * Rebuild the search index, creating it if it does not already exist
+ */
+function rebuild_index(): void {
+    $db = Data::getConnection();
+
+    try {
+        $hasIndex = $db->query("SELECT COUNT(*) FROM sqlite_master WHERE name = 'item_ai'");
+        if ($hasIndex->fetchArray(SQLITE3_NUM)[0] == 0) {
+            printfn('Creating search index....');
+            Data::createSearchIndex($db);
+        }
+        printfn('Rebuilding search index...');
+        $db->exec("INSERT INTO item_search (item_search) VALUES ('rebuild')");
+        printfn(PHP_EOL . 'Search index rebuilt');
+    } finally {
+        $db->close();
+    }
+}