From 7a0c423357818b19eb431775452b1357bc7fd3eb Mon Sep 17 00:00:00 2001
From: Alexandre Alapetite <alexandre@alapetite.fr>
Date: Thu, 31 Jul 2025 09:17:42 +0200
Subject: Implement support for HTTP 429 Too Many Requests (#7760)

* Implement support for HTTP 429 Too Many Requests
Will obey the corresponding HTTP `Retry-After` header at domain level.

* Implement 503 Service Unavailable

* Sanitize Retry-After

* Reduce default value when Retry-After is absent
And make configuration parameter

* Retry-After also for favicons
---
 app/Utils/httpUtil.php | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 app/Utils/httpUtil.php

(limited to 'app/Utils/httpUtil.php')

diff --git a/app/Utils/httpUtil.php b/app/Utils/httpUtil.php
new file mode 100644
index 000000000..12ebc3d07
--- /dev/null
+++ b/app/Utils/httpUtil.php
@@ -0,0 +1,74 @@
+<?php
+declare(strict_types=1);
+
+final class FreshRSS_http_Util {
+
+	private const RETRY_AFTER_PATH = DATA_PATH . '/Retry-After/';
+
+	/**
+	 * Clean up old Retry-After files
+	 */
+	private static function cleanRetryAfters(): void {
+		if (!is_dir(self::RETRY_AFTER_PATH)) {
+			return;
+		}
+		$files = glob(self::RETRY_AFTER_PATH . '*.txt', GLOB_NOSORT);
+		if ($files === false) {
+			return;
+		}
+		foreach ($files as $file) {
+			if (@filemtime($file) < time()) {
+				@unlink($file);
+			}
+		}
+	}
+
+	/**
+	 * Check whether the URL needs to wait for a Retry-After period.
+	 * @return int The timestamp of when the Retry-After expires, or 0 if not set.
+	 */
+	public static function getRetryAfter(string $url): int {
+		if (rand(0, 30) === 1) {	// Remove old files once in a while
+			self::cleanRetryAfters();
+		}
+		$domain = parse_url($url, PHP_URL_HOST);
+		if (!is_string($domain) || $domain === '') {
+			return 0;
+		}
+		$retryAfter = @filemtime(self::RETRY_AFTER_PATH . $domain . '.txt') ?: 0;
+		if ($retryAfter <= 0) {
+			return 0;
+		}
+		if ($retryAfter < time()) {
+			@unlink(self::RETRY_AFTER_PATH . $domain . '.txt');
+			return 0;
+		}
+		return $retryAfter;
+	}
+
+	/**
+	 * Store the HTTP Retry-After header value of an HTTP `429 Too Many Requests` or `503 Service Unavailable` response.
+	 */
+	public static function setRetryAfter(string $url, string $retryAfter): int {
+		$domain = parse_url($url, PHP_URL_HOST);
+		if (!is_string($domain) || $domain === '') {
+			return 0;
+		}
+
+		$limits = FreshRSS_Context::systemConf()->limits;
+		if (ctype_digit($retryAfter)) {
+			$retryAfter = time() + (int)$retryAfter;
+		} else {
+			$retryAfter = \SimplePie\Misc::parse_date($retryAfter) ?:
+				(time() + max(600, $limits['retry_after_default'] ?? 0));
+		}
+		$retryAfter = min($retryAfter, time() + max(3600, $limits['retry_after_max'] ?? 0));
+
+		@mkdir(self::RETRY_AFTER_PATH);
+		if (!touch(self::RETRY_AFTER_PATH . $domain . '.txt', $retryAfter)) {
+			Minz_Log::error('Failed to set Retry-After for ' . $domain);
+			return 0;
+		}
+		return $retryAfter;
+	}
+}
-- 
cgit v1.2.3