Af_RedditImgur

Complexity

Total Complexity

102

Size/Duplication

Total Lines	572
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	5	1
A	about()	0	4	1
A	flags()	0	2	1
A	get_location()	0	2	1
A	hook_prefs_tab()	0	51	3
A	api_version()	0	2	1
C	readability()	0	30	12
B	hook_article_filter()	0	54	10
A	get_header()	0	17	3
A	save()	0	8	1
A	handle_as_video()	0	28	2
F	inline_stuff()	0	304	63
A	get_content_type()	0	2	1
A	testurl()	0	25	2

<?php
class Af_RedditImgur extends Plugin {

    /* @var PluginHost $host */
    private $host;

    public function about() {
        return array(1.0,
            "Inline images (and other content) in Reddit RSS feeds",
            "fox");
    }

    public function flags() {
        return array("needs_curl" => true);
    }

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

        $host->add_hook($host::HOOK_ARTICLE_FILTER, $this);
        $host->add_hook($host::HOOK_PREFS_TAB, $this);
    }

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

        print "<div dojoType=\"dijit.layout.AccordionPane\"
			title=\"<i class='material-icons'>extension</i> ".__('Reddit content settings (af_redditimgur)')."\">";

        $enable_readability = $this->host->get($this, "enable_readability");
        $enable_content_dupcheck = $this->host->get($this, "enable_content_dupcheck");

        if (version_compare(PHP_VERSION, '5.6.0', '<')) {
            print_error("Readability requires PHP version 5.6.");

The function print_error() has been deprecated: Use twig function errorMessage

The call to print_error() has too many arguments starting with 'Readability requires PHP version 5.6.'.

        }

        print "<form dojoType='dijit.form.Form'>";

        print "<script type='dojo/method' event='onSubmit' args='evt'>
			evt.preventDefault();
			if (this.validate()) {
				console.log(dojo.objectToQuery(this.getValues()));
				new Ajax.Request('backend.php', {
					parameters: dojo.objectToQuery(this.getValues()),
					onComplete: function(transport) {
						Notify.info(transport.responseText);
					}
				});
				//this.reset();
			}
			</script>";

        print_hidden("op", "pluginhandler");
        print_hidden("method", "save");
        print_hidden("plugin", "af_redditimgur");

        print "<fieldset class='narrow'>";
        print "<label class='checkbox'>";
        print_checkbox("enable_readability", $enable_readability);
        print " ".__("Extract missing content using Readability (requires af_readability)")."</label>";
        print "</fieldset>";

        print "<fieldset class='narrow'>";
        print "<label class='checkbox'>";
        print_checkbox("enable_content_dupcheck", $enable_content_dupcheck);
        print " ".__("Enable additional duplicate checking")."</label>";
        print "</fieldset>";

        print_button("submit", __("Save"), 'class="alt-primary"');
        print "</form>";

        print "</div>";
    }

    public function save() {
        $enable_readability = checkbox_to_sql_bool($_POST["enable_readability"]);
        $enable_content_dupcheck = checkbox_to_sql_bool($_POST["enable_content_dupcheck"]);

        $this->host->set($this, "enable_readability", $enable_readability, false);
        $this->host->set($this, "enable_content_dupcheck", $enable_content_dupcheck);

        echo __("Configuration saved");
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    private function inline_stuff($article, &$doc, $xpath) {

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

        $entries = $xpath->query('(//a[@href]|//img[@src])');
        $img_entries = $xpath->query("(//img[@src])");

        $found = false;
        //$debug = 1;

        foreach ($entries as $entry) {
            if ($entry->hasAttribute("href") && strpos($entry->getAttribute("href"), "reddit.com") === false) {

                Debug::log("processing href: ".$entry->getAttribute("href"), Debug::$LOG_VERBOSE);

                $matches = array();

                if (!$found && preg_match("/^https?:\/\/twitter.com\/(.*?)\/status\/(.*)/", $entry->getAttribute("href"), $matches)) {
                    Debug::log("handling as twitter: ".$matches[1]." ".$matches[2], Debug::$LOG_VERBOSE);

                    $oembed_result = fetch_file_contents("https://publish.twitter.com/oembed?url=".urlencode($entry->getAttribute("href")));

                    if ($oembed_result) {
                        $oembed_result = json_decode($oembed_result, true);

It seems like $oembed_result can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

                        if ($oembed_result && isset($oembed_result["html"])) {

                            $tmp = new DOMDocument();
                            if ($tmp->loadHTML('<?xml encoding="utf-8" ?>'.$oembed_result["html"])) {
                                $p = $doc->createElement("p");

                                $p->appendChild($doc->importNode(
                                    $tmp->getElementsByTagName("blockquote")->item(0), true));

                                $br = $doc->createElement('br');
                                $entry->parentNode->insertBefore($p, $entry);
                                $entry->parentNode->insertBefore($br, $entry);

                                $found = 1;
                            }
                        }
                    }
                }

                if (!$found && preg_match("/\.gfycat.com\/([a-z]+)?(\.[a-z]+)$/i", $entry->getAttribute("href"), $matches)) {
                    $entry->setAttribute("href", "http://www.gfycat.com/".$matches[1]);
                }

                if (!$found && preg_match("/https?:\/\/(www\.)?gfycat.com\/([a-z]+)$/i", $entry->getAttribute("href"), $matches)) {

                    Debug::log("Handling as Gfycat", Debug::$LOG_VERBOSE);

                    $source_stream = 'https://giant.gfycat.com/'.$matches[2].'.mp4';
                    $poster_url = 'https://thumbs.gfycat.com/'.$matches[2].'-mobile.jpg';

                    $content_type = $this->get_content_type($source_stream);

                    if (strpos($content_type, "video/") !== false) {

It seems like $content_type can also be of type false; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check?

                        $this->handle_as_video($doc, $entry, $source_stream, $poster_url);
                        $found = 1;
                    }
                }

                if (!$found && preg_match("/https?:\/\/v\.redd\.it\/(.*)$/i", $entry->getAttribute("href"), $matches)) {

                    Debug::log("Handling as reddit inline video", Debug::$LOG_VERBOSE);

                    $img = $img_entries->item(0);

                    if ($img) {
                        $poster_url = $img->getAttribute("src");
                    } else {
                        $poster_url = false;
                    }

                    // Get original article URL from v.redd.it redirects
                    $source_article_url = $this->get_location($matches[0]);
                    Debug::log("Resolved ".$matches[0]." to ".$source_article_url, Debug::$LOG_VERBOSE);

Are you sure $source_article_url of type false|mixed can be used in concatenation?

                    $source_stream = false;

                    if ($source_article_url) {
                        $j = json_decode(fetch_file_contents($source_article_url.".json"), true);

                        if ($j) {
                            foreach ($j as $listing) {
                                foreach ($listing["data"]["children"] as $child) {
                                    if ($child["data"]["url"] == $matches[0]) {
                                        try {
                                            $source_stream = $child["data"]["media"]["reddit_video"]["fallback_url"];
                                        } catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

                                        }
                                        break 2;
                                    }
                                }
                            }
                        }
                    }

                    if (!$source_stream) {
                        $source_stream = "https://v.redd.it/".$matches[1]."/DASH_600_K";
                    }

                    $this->handle_as_video($doc, $entry, $source_stream, $poster_url);
                    $found = 1;
                }

                if (!$found && preg_match("/https?:\/\/(www\.)?streamable.com\//i", $entry->getAttribute("href"))) {

                    Debug::log("Handling as Streamable", Debug::$LOG_VERBOSE);

                    $tmp = fetch_file_contents($entry->getAttribute("href"));

                    if ($tmp) {
                        $tmpdoc = new DOMDocument();

                        if (@$tmpdoc->loadHTML($tmp)) {

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

                            $tmpxpath = new DOMXPath($tmpdoc);

                            $source_node = $tmpxpath->query("//video[contains(@class,'video-player-tag')]//source[contains(@src, '.mp4')]")->item(0);
                            $poster_node = $tmpxpath->query("//video[contains(@class,'video-player-tag') and @poster]")->item(0);

                            if ($source_node && $poster_node) {
                                $source_stream = $source_node->getAttribute("src");
                                $poster_url = $poster_node->getAttribute("poster");

                                $this->handle_as_video($doc, $entry, $source_stream, $poster_url);
                                $found = 1;
                            }
                        }
                    }
                }

                // imgur .gif -> .gifv
                if (!$found && preg_match("/i\.imgur\.com\/(.*?)\.gif$/i", $entry->getAttribute("href"))) {
                    Debug::log("Handling as imgur gif (->gifv)", Debug::$LOG_VERBOSE);

                    $entry->setAttribute("href",
                        str_replace(".gif", ".gifv", $entry->getAttribute("href")));
                }

                if (!$found && preg_match("/\.(gifv|mp4)$/i", $entry->getAttribute("href"))) {
                    Debug::log("Handling as imgur gifv", Debug::$LOG_VERBOSE);

                    $source_stream = str_replace(".gifv", ".mp4", $entry->getAttribute("href"));

                    if (strpos($source_stream, "imgur.com") !== false) {
                                            $poster_url = str_replace(".mp4", "h.jpg", $source_stream);
                    }

                    $this->handle_as_video($doc, $entry, $source_stream, $poster_url);

The variable $poster_url does not seem to be defined for all execution paths leading up to this point.

                    $found = true;
                }

                $matches = array();
                if (!$found && preg_match("/youtube\.com\/v\/([\w-]+)/", $entry->getAttribute("href"), $matches) ||
                    preg_match("/youtube\.com\/.*?[\&\?]v=([\w-]+)/", $entry->getAttribute("href"), $matches) ||
                    preg_match("/youtube\.com\/watch\?v=([\w-]+)/", $entry->getAttribute("href"), $matches) ||
                    preg_match("/\/\/youtu.be\/([\w-]+)/", $entry->getAttribute("href"), $matches)) {

                    $vid_id = $matches[1];

                    Debug::log("Handling as youtube: $vid_id", Debug::$LOG_VERBOSE);

                    $iframe = $doc->createElement("iframe");
                    $iframe->setAttribute("class", "youtube-player");
                    $iframe->setAttribute("type", "text/html");
                    $iframe->setAttribute("width", "640");
                    $iframe->setAttribute("height", "385");
                    $iframe->setAttribute("src", "https://www.youtube.com/embed/$vid_id");
                    $iframe->setAttribute("allowfullscreen", "1");
                    $iframe->setAttribute("frameborder", "0");

                    $br = $doc->createElement('br');
                    $entry->parentNode->insertBefore($iframe, $entry);
                    $entry->parentNode->insertBefore($br, $entry);

                    $found = true;
                }

                if (!$found && preg_match("/\.(jpg|jpeg|gif|png)(\?[0-9][0-9]*)?$/i", $entry->getAttribute("href")) ||
                    mb_strpos($entry->getAttribute("href"), "i.reddituploads.com") !== false ||
                    mb_strpos($this->get_content_type($entry->getAttribute("href")), "image/") !== false) {

It seems like $this->get_content_type($entry->getAttribute('href')) can also be of type false; however, parameter $haystack of mb_strpos() does only seem to accept string, maybe add an additional type check?

                    Debug::log("Handling as a picture", Debug::$LOG_VERBOSE);

                    $img = $doc->createElement('img');
                    $img->setAttribute("src", $entry->getAttribute("href"));

                    $br = $doc->createElement('br');
                    $entry->parentNode->insertBefore($img, $entry);
                    $entry->parentNode->insertBefore($br, $entry);

                    $found = true;
                }

                // imgur via link rel="image_src" href="..."
                if (!$found && preg_match("/imgur/", $entry->getAttribute("href"))) {

                    Debug::log("handling as imgur page/whatever", Debug::$LOG_VERBOSE);

                    $content = fetch_file_contents(["url" => $entry->getAttribute("href"),
                        "http_accept" => "text/*"]);

                    if ($content) {
                        $cdoc = new DOMDocument();

                        if (@$cdoc->loadHTML($content)) {
                            $cxpath = new DOMXPath($cdoc);

                            $rel_image = $cxpath->query("//link[@rel='image_src']")->item(0);

                            if ($rel_image) {

                                $img = $doc->createElement('img');
                                $img->setAttribute("src", $rel_image->getAttribute("href"));

                                $br = $doc->createElement('br');
                                $entry->parentNode->insertBefore($img, $entry);
                                $entry->parentNode->insertBefore($br, $entry);

                                $found = true;
                            }
                        }
                    }
                }

                // wtf is this even
                if (!$found && preg_match("/^https?:\/\/gyazo\.com\/([^\.\/]+$)/", $entry->getAttribute("href"), $matches)) {
                    $img_id = $matches[1];

                    Debug::log("handling as gyazo: $img_id", Debug::$LOG_VERBOSE);

                    $img = $doc->createElement('img');
                    $img->setAttribute("src", "https://i.gyazo.com/$img_id.jpg");

                    $br = $doc->createElement('br');
                    $entry->parentNode->insertBefore($img, $entry);
                    $entry->parentNode->insertBefore($br, $entry);

                    $found = true;
                }

                // let's try meta properties
                if (!$found) {
                    Debug::log("looking for meta og:image", Debug::$LOG_VERBOSE);

                    $content = fetch_file_contents(["url" => $entry->getAttribute("href"),
                        "http_accept" => "text/*"]);

                    if ($content) {
                        $cdoc = new DOMDocument();

                        if (@$cdoc->loadHTML($content)) {
                            $cxpath = new DOMXPath($cdoc);

                            $og_image = $cxpath->query("//meta[@property='og:image']")->item(0);
                            $og_video = $cxpath->query("//meta[@property='og:video']")->item(0);

                            if ($og_video) {

                                $source_stream = $og_video->getAttribute("content");

                                if ($source_stream) {

                                    if ($og_image) {
                                        $poster_url = $og_image->getAttribute("content");
                                    } else {
                                        $poster_url = false;
                                    }

                                    $this->handle_as_video($doc, $entry, $source_stream, $poster_url);
                                    $found = true;
                                }

                            } else if ($og_image) {

                                $og_src = $og_image->getAttribute("content");

                                if ($og_src) {
                                    $img = $doc->createElement('img');
                                    $img->setAttribute("src", $og_src);

                                    $br = $doc->createElement('br');
                                    $entry->parentNode->insertBefore($img, $entry);
                                    $entry->parentNode->insertBefore($br, $entry);

                                    $found = true;
                                }
                            }
                        }
                    }
                }

            }

            // remove tiny thumbnails
            if ($entry->hasAttribute("src")) {
                if ($entry->parentNode && $entry->parentNode->parentNode) {
                    $entry->parentNode->parentNode->removeChild($entry->parentNode);
                }
            }
        }

        return $found;
    }

    public function hook_article_filter($article) {

        if (strpos($article["link"], "reddit.com/r/") !== false) {
            $doc = new DOMDocument();
            @$doc->loadHTML($article["content"]);

It seems like you do not handle an error condition for loadHTML(). This can introduce security issues, and is generally not recommended.

            $xpath = new DOMXPath($doc);

            $content_link = $xpath->query("(//a[contains(., '[link]')])")->item(0);

            if ($this->host->get($this, "enable_content_dupcheck")) {

                if ($content_link) {
                    $content_href = $content_link->getAttribute("href");
                    $entry_guid = $article["guid_hashed"];
                    $owner_uid = $article["owner_uid"];

                    if (DB_TYPE == "pgsql") {

The constant DB_TYPE was not found. Maybe you did not declare it correctly or list all dependencies?

                        $interval_qpart = "date_entered < NOW() - INTERVAL '1 day'";
                    } else {
                        $interval_qpart = "date_entered < DATE_SUB(NOW(), INTERVAL 1 DAY)";
                    }

                    $sth = $this->pdo->prepare("SELECT COUNT(id) AS cid
						FROM ttrss_entries, ttrss_user_entries WHERE
							ref_id = id AND
							$interval_qpart AND
							guid != ? AND
							owner_uid = ? AND
							content LIKE ?");

                    $sth->execute([$entry_guid, $owner_uid, "%href=\"$content_href\">[link]%"]);

                    if ($row = $sth->fetch()) {
                        $num_found = $row['cid'];

                        if ($num_found > 0) {
                            $article["force_catchup"] = true;
                        }
                    }
                }
            }

            $found = $this->inline_stuff($article, $doc, $xpath);

            $node = $doc->getElementsByTagName('body')->item(0);

            if ($node && $found) {
                $article["content"] = $doc->saveHTML($node);
            } else if ($content_link) {
                $article = $this->readability($article, $content_link->getAttribute("href"), $doc, $xpath);
            }
        }

        return $article;
    }

    public function api_version() {
        return 2;
    }

    private function handle_as_video($doc, $entry, $source_stream, $poster_url = false) {

        Debug::log("handle_as_video: $source_stream", Debug::$LOG_VERBOSE);

        $video = $doc->createElement('video');
        $video->setAttribute("autoplay", "1");
        $video->setAttribute("controls", "1");
        $video->setAttribute("loop", "1");

        if ($poster_url) {
            $video->setAttribute("poster", $poster_url);
        }

        $source = $doc->createElement('source');
        $source->setAttribute("src", $source_stream);
        $source->setAttribute("type", "video/mp4");

        $video->appendChild($source);

        $br = $doc->createElement('br');
        $entry->parentNode->insertBefore($video, $entry);
        $entry->parentNode->insertBefore($br, $entry);

        $img = $doc->createElement('img');
        $img->setAttribute("src",
            "data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs%3D");

        $entry->parentNode->insertBefore($img, $entry);
    }

    public function testurl() {
        $url = htmlspecialchars($_REQUEST["url"]);

        header("Content-type: text/plain");

        print "URL: $url\n";

        $doc = new DOMDocument();
        @$doc->loadHTML("<html><body><a href=\"$url\">[link]</a></body>");

It seems like you do not handle an error condition for loadHTML(). This can introduce security issues, and is generally not recommended.

        $xpath = new DOMXPath($doc);

        $found = $this->inline_stuff([], $doc, $xpath);

        print "Inline result: $found\n";

        if (!$found) {
            print "\nReadability result:\n";

            $article = $this->readability([], $url, $doc, $xpath);

            print_r($article);
        } else {
            print "\nResulting HTML:\n";

            print $doc->saveHTML();
        }
    }

    private function get_header($url, $useragent = SELF_USER_AGENT, $header) {
        $ret = false;

        if (function_exists("curl_init") && !defined("NO_CURL")) {
            $ch = curl_init($url);
            curl_setopt($ch, CURLOPT_TIMEOUT, 5);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
            curl_setopt($ch, CURLOPT_HEADER, true);
            curl_setopt($ch, CURLOPT_NOBODY, true);
            curl_setopt($ch, CURLOPT_FOLLOWLOCATION, !ini_get("open_basedir"));
            curl_setopt($ch, CURLOPT_USERAGENT, $useragent);

            @curl_exec($ch);

It seems like you do not handle an error condition for curl_exec(). This can introduce security issues, and is generally not recommended.

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

            $ret = curl_getinfo($ch, $header);

It seems like $ch can also be of type false; however, parameter $ch of curl_getinfo() does only seem to accept resource, maybe add an additional type check?

        }

        return $ret;
    }

    private function get_content_type($url, $useragent = SELF_USER_AGENT) {
        return $this->get_header($url, $useragent, CURLINFO_CONTENT_TYPE);
    }

    private function get_location($url, $useragent = SELF_USER_AGENT) {
        return $this->get_header($url, $useragent, CURLINFO_EFFECTIVE_URL);
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    private function readability($article, $url, $doc, $xpath, $debug = false) {

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

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

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

        if (!defined('NO_CURL') && function_exists("curl_init") && $this->host->get($this, "enable_readability") &&
            mb_strlen(strip_tags($article["content"])) <= 150) {

            // do not try to embed posts linking back to other reddit posts
            // readability.php requires PHP 5.6
            if ($url && strpos($url, "reddit.com") === false && version_compare(PHP_VERSION, '5.6.0', '>=')) {

                /* link may lead to a huge video file or whatever, we need to check content type before trying to
				parse it which p much requires curl */

                $useragent_compat = "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; WOW64; Trident/6.0)";
                $content_type = $this->get_content_type($url, $useragent_compat);

                if ($content_type && strpos($content_type, "text/html") !== false) {

                    foreach ($this->host->get_hooks(PluginHost::HOOK_GET_FULL_TEXT) as $p) {
                        $extracted_content = $p->hook_get_full_text($url);

                        if ($extracted_content) {
                            $article["content"] = $extracted_content;
                            break;
                        }
                    }
                }
            }
        }

        return $article;
    }
}