From 2d5603b196047188bb543573cdf725fb10ec0401 Mon Sep 17 00:00:00 2001
From: wn_ <invalid@email.com>
Date: Thu, 11 Nov 2021 22:07:32 +0000
Subject: Address PHPStan warnings in 'classes/diskcache.php'.

---
 classes/diskcache.php | 81 +++++++++++++++++++++++++++++++++------------------
 1 file changed, 52 insertions(+), 29 deletions(-)

(limited to 'classes/diskcache.php')

diff --git a/classes/diskcache.php b/classes/diskcache.php
index d7ea26d3b..9fa043aee 100644
--- a/classes/diskcache.php
+++ b/classes/diskcache.php
@@ -1,9 +1,13 @@
 <?php
 class DiskCache {
-	private $dir;
-
-	// https://stackoverflow.com/a/53662733
-	private $mimeMap = [
+	private string $dir;
+
+	/**
+	 * https://stackoverflow.com/a/53662733
+	 *
+	 * @var array<string, string>
+	 */
+	private array $mimeMap = [
 		'video/3gpp2'                                                               => '3g2',
 		'video/3gp'                                                                 => '3gp',
 		'video/3gpp'                                                                => '3gp',
@@ -190,21 +194,22 @@ class DiskCache {
 		'text/x-scriptzsh'                                                          => 'zsh'
 	];
 
-	public function __construct($dir) {
+	public function __construct(string $dir) {
 		$this->dir = Config::get(Config::CACHE_DIR) . "/" . basename(clean($dir));
 	}
 
-	public function get_dir() {
+	public function get_dir(): string {
 		return $this->dir;
 	}
 
-	public function make_dir() {
+	public function make_dir(): bool {
 		if (!is_dir($this->dir)) {
 			return mkdir($this->dir);
 		}
+		return false;
 	}
 
-	public function is_writable($filename = "") {
+	public function is_writable(?string $filename = null): bool {
 		if ($filename) {
 			if (file_exists($this->get_full_path($filename)))
 				return is_writable($this->get_full_path($filename));
@@ -215,44 +220,55 @@ class DiskCache {
 		}
 	}
 
-	public function exists($filename) {
+	public function exists(string $filename): bool {
 		return file_exists($this->get_full_path($filename));
 	}
 
-	public function get_size($filename) {
+	/**
+	 * @return int|false -1 if the file doesn't exist, false if an error occurred, size in bytes otherwise
+	 */
+	public function get_size(string $filename) {
 		if ($this->exists($filename))
 			return filesize($this->get_full_path($filename));
 		else
 			return -1;
 	}
 
-	public function get_full_path($filename) {
+	public function get_full_path(string $filename): string {
 		return $this->dir . "/" . basename(clean($filename));
 	}
 
-	public function put($filename, $data) {
+	/**
+	 * @param mixed $data
+	 *
+	 * @return int|false Bytes written or false if an error occurred.
+	 */
+	public function put(string $filename, $data) {
 		return file_put_contents($this->get_full_path($filename), $data);
 	}
 
-	public function touch($filename) {
+	public function touch(string $filename): bool {
 		return touch($this->get_full_path($filename));
 	}
 
-	public function get($filename) {
+	public function get(string $filename): ?string {
 		if ($this->exists($filename))
 			return file_get_contents($this->get_full_path($filename));
 		else
 			return null;
 	}
 
-	public function get_mime_type($filename) {
+	/**
+	 * @return false|null|string false if detection failed, null if the file doesn't exist, string mime content type otherwise
+	 */
+	public function get_mime_type(string $filename) {
 		if ($this->exists($filename))
 			return mime_content_type($this->get_full_path($filename));
 		else
 			return null;
 	}
 
-	public function get_fake_extension($filename) {
+	public function get_fake_extension(string $filename): string {
 		$mimetype = $this->get_mime_type($filename);
 
 		if ($mimetype)
@@ -261,7 +277,10 @@ class DiskCache {
 			return "";
 	}
 
-	public function send($filename) {
+	/**
+	 * @return bool|int false if the file doesn't exist (or unreadable) or isn't audio/video, true if a plugin handled, otherwise int of bytes sent
+	 */
+	public function send(string $filename) {
 		$fake_extension = $this->get_fake_extension($filename);
 
 		if ($fake_extension)
@@ -272,7 +291,7 @@ class DiskCache {
 		return $this->send_local_file($this->get_full_path($filename));
 	}
 
-	public function get_url($filename) {
+	public function get_url(string $filename): string {
 		return Config::get_self_url() . "/public.php?op=cached&file=" . basename($this->dir) . "/" . basename($filename);
 	}
 
@@ -280,8 +299,7 @@ class DiskCache {
 	// this is called separately after sanitize() and plugin render article hooks to allow
 	// plugins work on original source URLs used before caching
 	// NOTE: URLs should be already absolutized because this is called after sanitize()
-	static public function rewrite_urls($str)
-	{
+	static public function rewrite_urls(string $str): string {
 		$res = trim($str);
 		if (!$res) return '';
 
@@ -338,7 +356,7 @@ class DiskCache {
 		return $res;
 	}
 
-	static function expire() {
+	static function expire(): void {
 		$dirs = array_filter(glob(Config::get(Config::CACHE_DIR) . "/*"), "is_dir");
 
 		foreach ($dirs as $cache_dir) {
@@ -362,14 +380,19 @@ class DiskCache {
 		}
 	}
 
-	/*	this is essentially a wrapper for readfile() which allows plugins to hook
-		output with httpd-specific "fast" implementation i.e. X-Sendfile or whatever else
-
-		hook function should return true if request was handled (or at least attempted to)
-
-		note that this can be called without user context so the plugin to handle this
-		should be loaded systemwide in config.php */
-	function send_local_file($filename) {
+	/*	 */
+	/**
+	 * this is essentially a wrapper for readfile() which allows plugins to hook
+	 * output with httpd-specific "fast" implementation i.e. X-Sendfile or whatever else
+	 *
+	 * hook function should return true if request was handled (or at least attempted to)
+	 *
+	 * note that this can be called without user context so the plugin to handle this
+	 * should be loaded systemwide in config.php
+	 *
+	 * @return bool|int false if the file doesn't exist (or unreadable) or isn't audio/video, true if a plugin handled, otherwise int of bytes sent
+	 */
+	function send_local_file(string $filename) {
 		if (file_exists($filename)) {
 
 			if (is_writable($filename)) touch($filename);
-- 
cgit v1.2.3-54-g00ecf


From d3a81f598b24d6ae4f98415fac9509df6749eaf8 Mon Sep 17 00:00:00 2001
From: wn_ <invalid@email.com>
Date: Fri, 12 Nov 2021 21:17:31 +0000
Subject: Switch class properties from PHP typing to PHPDoc for compatibility
 with PHP < 7.4.0

---
 classes/db/migrations.php | 37 ++++++++++++++++++++++++++----------
 classes/debug.php         | 48 ++++++++++++++++++++++++++++++++---------------
 classes/diskcache.php     |  4 +++-
 classes/mailer.php        |  4 +++-
 classes/pluginhost.php    | 41 +++++++++++++++++++++++++---------------
 classes/urlhelper.php     | 32 +++++++++++++++++++++++--------
 6 files changed, 116 insertions(+), 50 deletions(-)

(limited to 'classes/diskcache.php')

diff --git a/classes/db/migrations.php b/classes/db/migrations.php
index cb74c247a..6e20ddf7f 100644
--- a/classes/db/migrations.php
+++ b/classes/db/migrations.php
@@ -1,16 +1,33 @@
 <?php
 class Db_Migrations {
 
-	private string $base_filename = "schema.sql";
-	private string $base_path;
-	private string $migrations_path;
-	private string $migrations_table;
-	private bool $base_is_latest;
-	private \PDO $pdo;
-
-	private int $cached_version;
-	private int $cached_max_version;
-	private int $max_version_override;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	private $base_filename = "schema.sql";
+
+	/** @var string */
+	private $base_path;
+
+	/** @var string */
+	private $migrations_path;
+
+	/** @var string */
+	private $migrations_table;
+
+	/** @var bool */
+	private $base_is_latest;
+
+	/** @var PDO */
+	private $pdo;
+
+	/** @var int */
+	private $cached_version;
+
+	/** @var int */
+	private $cached_max_version;
+
+	/** @var int */
+	private $max_version_override;
 
 	function __construct() {
 		$this->pdo = Db::pdo();
diff --git a/classes/debug.php b/classes/debug.php
index 6e8c46ed2..e20126b86 100644
--- a/classes/debug.php
+++ b/classes/debug.php
@@ -1,9 +1,9 @@
 <?php
 class Debug {
 	const LOG_DISABLED = -1;
-    const LOG_NORMAL = 0;
-    const LOG_VERBOSE = 1;
-    const LOG_EXTENDED = 2;
+	const LOG_NORMAL = 0;
+	const LOG_VERBOSE = 1;
+	const LOG_EXTENDED = 2;
 
 	const ALL_LOG_LEVELS = [
 		Debug::LOG_DISABLED,
@@ -12,26 +12,44 @@ class Debug {
 		Debug::LOG_EXTENDED,
 	];
 
-	/** @deprecated */
-	public static int $LOG_DISABLED = self::LOG_DISABLED;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_DISABLED = self::LOG_DISABLED;
+
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_NORMAL = self::LOG_NORMAL;
 
-	/** @deprecated */
-    public static int $LOG_NORMAL = self::LOG_NORMAL;
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_VERBOSE = self::LOG_VERBOSE;
+
+	/**
+	 * @deprecated
+	 * @var int
+	*/
+	public static $LOG_EXTENDED = self::LOG_EXTENDED;
 
-	/** @deprecated */
-    public static int $LOG_VERBOSE = self::LOG_VERBOSE;
+	/** @var bool */
+	private static $enabled = false;
 
-	/** @deprecated */
-    public static int $LOG_EXTENDED = self::LOG_EXTENDED;
+	/** @var bool */
+	private static $quiet = false;
 
-    private static bool $enabled = false;
-    private static bool $quiet = false;
-    private static ?string $logfile = null;
+	/** @var string|null */
+	private static $logfile = null;
 
 	/**
 	 * @var int Debug::LOG_*
 	 */
-    private static int $loglevel = self::LOG_NORMAL;
+    private static $loglevel = self::LOG_NORMAL;
 
 	public static function set_logfile(string $logfile): void {
         self::$logfile = $logfile;
diff --git a/classes/diskcache.php b/classes/diskcache.php
index 9fa043aee..ed334b2d2 100644
--- a/classes/diskcache.php
+++ b/classes/diskcache.php
@@ -1,6 +1,8 @@
 <?php
 class DiskCache {
-	private string $dir;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	private $dir;
 
 	/**
 	 * https://stackoverflow.com/a/53662733
diff --git a/classes/mailer.php b/classes/mailer.php
index 4eb13aec8..a0f232800 100644
--- a/classes/mailer.php
+++ b/classes/mailer.php
@@ -1,6 +1,8 @@
 <?php
 class Mailer {
-	private string $last_error = "";
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	private $last_error = "";
 
 	/**
 	 * @param array<string, mixed> $params
diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index 36e050377..173a75611 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -1,38 +1,49 @@
 <?php
 class PluginHost {
-	private ?\Pdo $pdo = null;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var PDO|null */
+	private $pdo = null;
 
-	/* separate handle for plugin data so transaction while saving wouldn't clash with possible main
-		tt-rss code transactions; only initialized when first needed */
-	private ?\Pdo $pdo_data = null;
+	/**
+	 * separate handle for plugin data so transaction while saving wouldn't clash with possible main
+	 * tt-rss code transactions; only initialized when first needed
+	 *
+	 * @var PDO|null
+	 */
+	private $pdo_data = null;
 
 	/** @var array<string, array<int, array<int, Plugin>>> hook types -> priority levels -> Plugins */
-	private array $hooks = [];
+	private $hooks = [];
 
 	/** @var array<string, Plugin> */
-	private array $plugins = [];
+	private $plugins = [];
 
 	/** @var array<string, array<string, Plugin>> handler type -> method type -> Plugin */
-	private array $handlers = [];
+	private $handlers = [];
 
 	/** @var array<string, array{'description': string, 'suffix': string, 'arghelp': string, 'class': Plugin}> command type -> details array */
-	private array $commands = [];
+	private $commands = [];
 
 	/** @var array<string, array<string, mixed>> plugin name -> (potential profile array) -> key -> value  */
-	private array $storage = [];
+	private $storage = [];
 
 	/** @var array<int, array<int, array{'id': int, 'title': string, 'sender': Plugin, 'icon': string}>> */
-	private array $feeds = [];
+	private $feeds = [];
 
 	/** @var array<string, Plugin> API method name, Plugin sender */
-	private array $api_methods = [];
+	private $api_methods = [];
 
 	/** @var array<string, array<int, array{'action': string, 'description': string, 'sender': Plugin}>> */
-	private array $plugin_actions = [];
+	private $plugin_actions = [];
+
+	/** @var int|null */
+	private $owner_uid = null;
+
+	/** @var bool */
+	private $data_loaded = false;
 
-	private ?int $owner_uid = null;
-	private bool $data_loaded = false;
-	private static ?PluginHost $instance = null;
+	/** @var PluginHost|null */
+	private static $instance = null;
 
 	const API_VERSION = 2;
 	const PUBLIC_METHOD_DELIMITER = "--";
diff --git a/classes/urlhelper.php b/classes/urlhelper.php
index 0592bf28c..351d66b8d 100644
--- a/classes/urlhelper.php
+++ b/classes/urlhelper.php
@@ -6,14 +6,30 @@ class UrlHelper {
 		"tel"
 	];
 
-	static string $fetch_last_error;
-	static int $fetch_last_error_code;
-	static string $fetch_last_error_content;
-	static string $fetch_last_content_type;
-	static string $fetch_last_modified;
-	static string $fetch_effective_url;
-	static string $fetch_effective_ip_addr;
-	static bool $fetch_curl_used;
+	// TODO: class properties can be switched to PHP typing if/when the minimum PHP_VERSION is raised to 7.4.0+
+	/** @var string */
+	static $fetch_last_error;
+
+	/** @var int */
+	static $fetch_last_error_code;
+
+	/** @var string */
+	static $fetch_last_error_content;
+
+	/** @var string */
+	static $fetch_last_content_type;
+
+	/** @var string */
+	static $fetch_last_modified;
+
+	/** @var string */
+	static $fetch_effective_url;
+
+	/** @var string */
+	static $fetch_effective_ip_addr;
+
+	/** @var bool */
+	static $fetch_curl_used;
 
 	/**
 	 * @param array<string, string|int> $parts
-- 
cgit v1.2.3-54-g00ecf


From b2952843f50c7b5d2e8aafd62fadb4674acc59b1 Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Mon, 15 Nov 2021 23:22:21 +0300
Subject:  * DiskCache: add download() helper  * Af_Comics_Gocomics_FarSide:
 cache linked images because it seems to be required anyway

---
 classes/diskcache.php                                | 20 ++++++++++++++++++++
 .../af_comics/filters/af_comics_gocomics_farside.php | 16 +++++++++++++++-
 2 files changed, 35 insertions(+), 1 deletion(-)

(limited to 'classes/diskcache.php')

diff --git a/classes/diskcache.php b/classes/diskcache.php
index ed334b2d2..0df8d7cd4 100644
--- a/classes/diskcache.php
+++ b/classes/diskcache.php
@@ -253,6 +253,26 @@ class DiskCache {
 		return touch($this->get_full_path($filename));
 	}
 
+	/** Downloads $url to cache as $local_filename if its missing (unless $force-ed)
+	 * @param string $url
+	 * @param string $local_filename
+	 * @param array<string,string|int|false> $options (additional params to UrlHelper::fetch())
+	 * @param bool $force
+	 * @return bool
+	 */
+	public function download(string $url, string $local_filename, array $options = [], bool $force = false) : bool {
+		if ($this->exists($local_filename) && !$force)
+			return true;
+
+		$data = UrlHelper::fetch(array_merge(["url" => $url,
+							"max_size" => Config::get(Config::MAX_CACHE_FILE_SIZE)], $options));
+
+		if ($data)
+			return $this->put($local_filename, $data) > 0;
+
+		return false;
+	}
+
 	public function get(string $filename): ?string {
 		if ($this->exists($filename))
 			return file_get_contents($this->get_full_path($filename));
diff --git a/plugins/af_comics/filters/af_comics_gocomics_farside.php b/plugins/af_comics/filters/af_comics_gocomics_farside.php
index 0399015ab..e4e230516 100644
--- a/plugins/af_comics/filters/af_comics_gocomics_farside.php
+++ b/plugins/af_comics/filters/af_comics_gocomics_farside.php
@@ -50,8 +50,22 @@ class Af_Comics_Gocomics_FarSide extends Af_ComicFilter {
 					if ($content_node) {
 						$imgs = $xpath->query('//img[@data-src]', $content_node);
 
+						$cache = new DiskCache("images");
+
 						foreach ($imgs as $img) {
-							$img->setAttribute('src', $img->getAttribute('data-src'));
+							$image_url = $img->getAttribute('data-src');
+							$local_filename = sha1($image_url);
+
+							if ($image_url) {
+								$img->setAttribute('src', $image_url);
+
+								// try to cache image locally because they just 401 us otherwise
+								if (!$cache->exists($local_filename)) {
+									Debug::log("[Af_Comics_Gocomics_FarSide] caching: $image_url", Debug::LOG_VERBOSE);
+									$res = $cache->download($image_url, sha1($image_url), ["http_referrer" => $image_url]);
+									Debug::log("[Af_Comics_Gocomics_FarSide] cache result: $res", Debug::LOG_VERBOSE);
+								}
+							}
 						}
 
 						$junk_elems = $xpath->query("//*[@data-shareable-popover]");
-- 
cgit v1.2.3-54-g00ecf