feed-reader-central/src/lib/Data.php

<?php declare(strict_types=1);

namespace FeedReaderCentral;

use BitBadger\PDODocument\{Configuration, Custom, Definition, DocumentException, Field};
use BitBadger\PDODocument\Mapper\StringMapper;
use DateTimeImmutable;
use DateTimeInterface;
use Exception;

/**
 * A centralized place for data access for the application
 */
class Data
{
    /**
     * Create the search index and synchronization triggers for the item table
     *
     * @throws DocumentException If any is encountered
     */
    public static function createSearchIndex(): void
    {
        Custom::nonQuery("CREATE VIRTUAL TABLE item_search USING fts5(content, content='item', content_rowid='id')",
            []);
        Custom::nonQuery(<<<'SQL'
            CREATE TRIGGER item_ai AFTER INSERT ON item BEGIN
                INSERT INTO item_search (rowid, content) VALUES (new.data->>'id', new.data->>'content');
            END;
            SQL, []);
        Custom::nonQuery(<<<'SQL'
            CREATE TRIGGER item_au AFTER UPDATE ON item BEGIN
                INSERT INTO item_search (
                    item_search, rowid, content
                ) VALUES (
                    'delete', old.data->>'id', old.data->>'content'
                );
                INSERT INTO item_search (rowid, content) VALUES (new.data->>'id', new.data->>'content');
            END;
            SQL, []);
        Custom::nonQuery(<<<'SQL'
            CREATE TRIGGER item_ad AFTER DELETE ON item BEGIN
                INSERT INTO item_search (
                    item_search, rowid, content
                ) VALUES (
                    'delete', old.data->>'id', old.data->>'content'
                );
            END;
            SQL, []);
    }

    /**
     * Make sure the expected tables exist
     *
     * @throws DocumentException If any is encountered
     */
    public static function ensureDb(): void
    {
        $tables = Custom::array("SELECT name FROM sqlite_master WHERE type = 'table'", [], new StringMapper('name'));
        if (!in_array(Table::USER, $tables)) {
            Definition::ensureTable(Table::USER);
            Definition::ensureFieldIndex(Table::USER, 'email', ['email']);
        }
        if (!in_array(Table::FEED, $tables)) {
            Definition::ensureTable(Table::FEED);
            Definition::ensureFieldIndex(Table::FEED, 'user', ['user_id']);
        }
        if (!in_array(Table::ITEM, $tables)) {
            Definition::ensureTable(Table::ITEM);
            Definition::ensureFieldIndex(Table::ITEM, 'feed', ['feed_id', 'item_link']);
            self::createSearchIndex();
        }
        $journalMode = Custom::scalar("PRAGMA journal_mode", [], new StringMapper('journal_mode'));
        if ($journalMode <> 'wal') Custom::nonQuery("PRAGMA journal_mode = 'wal'", []);
    }

    /**
     * Create a JSON field comparison to find bookmarked items
     *
     * @param bool $value The flag to set (optional; defaults to true)
     * @param string $qualifier The table qualifier to include (optional; defaults to no qualifier)
     * @return Field A field that will find bookmarked items
     */
    public static function bookmarkField(bool $value = true, string $qualifier = ''): Field
    {
        $bookField = Field::EQ('is_bookmarked', ($value ? 1 : 0), ':book');
        $bookField->qualifier = $qualifier;
        return $bookField;
    }

    /**
     * Create a JSON field comparison to find items for a given feed
     *
     * @param int $feedId The ID of the feed for which items should be retrieved
     * @param string $qualifier The table qualifier to include (optional; defaults to no qualifier)
     * @return Field A field to find items for the give feed
     */
    public static function feedField(int $feedId, string $qualifier = ''): Field
    {
        $feedField = Field::EQ(Configuration::$idField, $feedId, ':feed');
        $feedField->qualifier = $qualifier;
        return $feedField;
    }

    /**
     * Create a JSON field comparison to find unread items
     *
     * @param string $qualifier The table qualifier to include (optional; defaults to no qualifier)
     * @return Field A field to find unread items
     */
    public static function unreadField(string $qualifier = ''): Field
    {
        $readField = Field::EQ('is_read', 0, ':read');
        $readField->qualifier = $qualifier;
        return $readField;
    }

    /**
     * Create a JSON field comparison to find items belonging to feeds to which the given user is subscribed
     *
     * @param string $qualifier The table qualifier to include (optional; defaults to no qualifier)
     * @return Field A field to find feeds belonging to the given user
     */
    public static function userIdField(string $qualifier = ''): Field
    {
        $userField = Field::EQ('user_id', $_SESSION[Key::USER_ID], ':user');
        $userField->qualifier = $qualifier;
        return $userField;
    }

    /**
     * Parse/format a date/time from a string
     *
     * @param ?string $value The date/time to be parsed and formatted
     * @return string|null The date/time in `DateTimeInterface::ATOM` format, or `null` if the input cannot be parsed
     */
    public static function formatDate(?string $value): ?string
    {
        try {
            return $value ? (new DateTimeImmutable($value))->format(DateTimeInterface::ATOM) : null;
        } catch (Exception) {
            return null;
        }
    }
}