codysnider / tt-rss

plugins/af_comics/init.php

<?php
class Af_Comics extends Plugin {

    private $host;
    private $filters = array();

    public function about() {
        return array(2.0,
            "Fixes RSS feeds of assorted comic strips",
            "fox");
    }

    public function init($host) {
        $this->host = $host;

        $host->add_hook($host::HOOK_FETCH_FEED, $this);
        $host->add_hook($host::HOOK_FEED_BASIC_INFO, $this);
        $host->add_hook($host::HOOK_SUBSCRIBE_FEED, $this);
        $host->add_hook($host::HOOK_ARTICLE_FILTER, $this);
        $host->add_hook($host::HOOK_PREFS_TAB, $this);

        require_once __DIR__."/filter_base.php";

        $filters = array_merge(glob(__DIR__."/filters.local/*.php"), glob(__DIR__."/filters/*.php"));

It seems like glob(__DIR__ . '/filters/*.php') can also be of type false; however, parameter $array2 of array_merge() does only seem to accept array|null, maybe add an additional type check?

It seems like glob(__DIR__ . '/filters.local/*.php') can also be of type false; however, parameter $array1 of array_merge() does only seem to accept array, maybe add an additional type check?

        $names = [];

        foreach ($filters as $file) {
            $filter_name = preg_replace("/\..*$/", "", basename($file));

            if (array_search($filter_name, $names) === false) {
                if (!class_exists($filter_name)) {
                    require_once $file;
                }

                array_push($names, $filter_name);

                $filter = new $filter_name();

                if (is_subclass_of($filter, "Af_ComicFilter")) {
                    array_push($this->filters, $filter);
                    array_push($names, $filter_name);
                }
            }
        }
    }

    public function hook_prefs_tab($args) {
        if ($args != "prefFeeds") {
            return;
        }

        print "<div dojoType=\"dijit.layout.AccordionPane\"
			title=\"<i class='material-icons'>photo</i> ".__('Feeds supported by af_comics')."\">";

        print "<p>".__("The following comics are currently supported:")."</p>";

        $comics = array("GoComics");

        foreach ($this->filters as $f) {
            foreach ($f->supported() as $comic) {
                array_push($comics, $comic);
            }
        }

        asort($comics);

        print "<ul class='panel panel-scrollable list list-unstyled'>";
        foreach ($comics as $comic) {
            print "<li>$comic</li>";
        }
        print "</ul>";

        print "<p>".__("To subscribe to GoComics use the comic's regular web page as the feed URL (e.g. for the <em>Garfield</em> comic use <code>http://www.gocomics.com/garfield</code>).")."</p>";

        print "<p>".__('Drop any updated filters into <code>filters.local</code> in plugin directory.')."</p>";

        print "</div>";
    }

    public function hook_article_filter($article) {
        foreach ($this->filters as $f) {
            if ($f->process($article)) {
                            break;
            }
        }

        return $article;
    }

    // GoComics dropped feed support so it needs to be handled when fetching the feed.
    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function hook_fetch_feed($feed_data, $fetch_url, $owner_uid, $feed, $last_article_timestamp, $auth_login, $auth_pass) {

The parameter $last_article_timestamp is not used and could be removed.

The parameter $feed is not used and could be removed.

The parameter $owner_uid is not used and could be removed.

        if ($auth_login || $auth_pass) {
                    return $feed_data;
        }

        if (preg_match('#^https?://(?:feeds\.feedburner\.com/uclick|www\.gocomics\.com)/([-a-z0-9]+)$#i', $fetch_url, $comic)) {
            $site_url = 'https://www.gocomics.com/'.$comic[1];

            $article_link = $site_url.date('/Y/m/d');

            $body = fetch_file_contents(array('url' => $article_link, 'type' => 'text/html', 'followlocation' => false));

            require_once 'lib/MiniTemplator.class.php';

            $feed_title = htmlspecialchars($comic[1]);
            $site_url = htmlspecialchars($site_url);
            $article_link = htmlspecialchars($article_link);

            $tpl = new MiniTemplator();

            $tpl->readTemplateFromFile('templates/generated_feed.txt');

            $tpl->setVariable('FEED_TITLE', $feed_title, true);
            $tpl->setVariable('VERSION', get_version(), true);
            $tpl->setVariable('FEED_URL', htmlspecialchars($fetch_url), true);
            $tpl->setVariable('SELF_URL', $site_url, true);

            if ($body) {
                $doc = new DOMDocument();

                if (@$doc->loadHTML($body)) {

It seems like $body can also be of type true; however, parameter $source of DOMDocument::loadHTML() does only seem to accept string, maybe add an additional type check?

                    $xpath = new DOMXPath($doc);

                    $node = $xpath->query('//picture[contains(@class, "item-comic-image")]/img')->item(0);

                    if ($node) {
                        $title = $xpath->query('//h1')->item(0);

                        if ($title) {
                            $title = clean(trim($title->nodeValue));
                        } else {
                            $title = date('l, F d, Y');
                        }

                        foreach (['srcset', 'sizes', 'data-srcset', 'width'] as $attr) {
                            $node->removeAttribute($attr);
                        }

                        $tpl->setVariable('ARTICLE_ID', $article_link, true);
                        $tpl->setVariable('ARTICLE_LINK', $article_link, true);
                        $tpl->setVariable('ARTICLE_UPDATED_ATOM', date('c', mktime(11, 0, 0)), true);
                        $tpl->setVariable('ARTICLE_TITLE', htmlspecialchars($title), true);
                        $tpl->setVariable('ARTICLE_EXCERPT', '', true);
                        $tpl->setVariable('ARTICLE_CONTENT', $doc->saveHTML($node), true);

                        $tpl->setVariable('ARTICLE_AUTHOR', '', true);
                        $tpl->setVariable('ARTICLE_SOURCE_LINK', $site_url, true);
                        $tpl->setVariable('ARTICLE_SOURCE_TITLE', $feed_title, true);

                        $tpl->addBlock('entry');
                    }
                }
            }

            $tpl->addBlock('feed');

            if ($tpl->generateOutputToString($tmp_data)) {
                            $feed_data = $tmp_data;
            }
        }

        return $feed_data;
    }

    public function hook_subscribe_feed($contents, $url, $auth_login, $auth_pass) {
        if ($auth_login || $auth_pass) {
                    return $contents;
        }

        if (preg_match('#^https?://www\.gocomics\.com/([-a-z0-9]+)$#i', $url)) {
                    return '<?xml version="1.0" encoding="utf-8"?>';
        }
        // Get is_html() to return false.

        return $contents;
    }

    public function hook_feed_basic_info($basic_info, $fetch_url, $owner_uid, $feed, $auth_login, $auth_pass) {

The parameter $feed is not used and could be removed.

The parameter $owner_uid is not used and could be removed.

        if ($auth_login || $auth_pass) {
                    return $basic_info;
        }

        if (preg_match('#^https?://www\.gocomics\.com/([-a-z0-9]+)$#i', $fetch_url, $matches)) {
                    $basic_info = array('title' => ucfirst($matches[1]), 'site_url' => $matches[0]);
        }

        return $basic_info;
    }

    public function api_version() {
        return 2;
    }

}