FreshRSS/tests/app/Models/FeedTest.php

<?php
declare(strict_types=1);

use PHPUnit\Framework\Attributes\DataProvider;

final class FeedTest extends \PHPUnit\Framework\TestCase {

	#[\Override]
	protected function setUp(): void {
		FreshRSS_Context::initSystem(reload: true);
	}

	#[\Override]
	protected function tearDown(): void {
		FreshRSS_Context::initSystem(reload: true);	// Restore the default curl_options
	}

	#[DataProvider('provideStoredAndRequestedUrls')]
	public function test_load_obeysRetryAfter(string $storedUrl, string $requestedUrl, string $systemProxy = ''): void {
		if ($systemProxy !== '') {
			FreshRSS_Context::systemConf()->_attribute('curl_options', [CURLOPT_PROXY => $systemProxy]);
		}
		$getRetryAfterFile = new ReflectionMethod(FreshRSS_http_Util::class, 'getRetryAfterFile');
		$file = $getRetryAfterFile->invoke(null, $requestedUrl, $systemProxy);
		self::assertIsString($file);
		self::assertTrue(touch($file, time() + 600));
		try {
			(new FreshRSS_Feed($storedUrl, validate: false))->load();
			self::fail('The feed was loaded during its Retry-After');
		} catch (FreshRSS_Feed_Exception $e) {
			self::assertStringContainsString('will first retry after', $e->getMessage());
		} finally {
			unlink($file);
		}
	}

	/** @return array<string,array{0:string,1:string,2?:string}> */
	public static function provideStoredAndRequestedUrls(): array {
		// On a local network, where Retry-After is per URL
		return [
			'HTML-encoded' => ['http://192.168.1.2/?action=display&amp;bridge=Example', 'http://192.168.1.2/?action=display&bridge=Example'],
			'force_feed' => ['http://192.168.1.2/feed#force_feed', 'http://192.168.1.2/feed'],
			'system proxy' => ['http://192.168.1.2/feed', 'http://192.168.1.2/feed', 'proxy.example.test:3128'],
		];
	}

	public function test_hashFavicon_isKeyedBySalt(): void {
		FreshRSS_Context::initSystem();
		$systemConf = FreshRSS_Context::systemConf();
		$originalSalt = $systemConf->salt;
		$systemConf->_attribute('salt', 'test-instance-salt');

		try {
			$feed = new FreshRSS_Feed('http://example.net/feed.xml', validate: false);
			$feed->_website('https://example.com/', validate: false);

			$hash = $feed->hashFavicon();
			self::assertMatchesRegularExpression('/^[A-Za-z0-9_-]{11}$/', $hash);
			$hmac = substr(hash_hmac('sha256', 'https://example.com/' . $feed->proxyParam(), 'test-instance-salt', true), 0, 8);
			self::assertSame(rtrim(strtr(base64_encode($hmac), '+/', '-_'), '='), $hash);
			$feed->_website('https://example.org/', validate: false);
			self::assertNotSame($hash, $feed->hashFavicon());
			$hash = $feed->hashFavicon();

			$systemConf->_attribute('salt', 'another-instance-salt');
			self::assertNotSame($hash, $feed->hashFavicon(skipCache: true));
		} finally {
			$systemConf->_attribute('salt', $originalSalt);
		}
	}

	public function test_favicon_migratesLegacyCustomIconWithoutDeletingSharedSource(): void {
		FreshRSS_Context::initSystem();
		require_once LIB_PATH . '/favicons.php';
		$feed = new FreshRSS_Feed('http://example.net/feed.xml', validate: false);
		$feed->_id(987654);
		$contents = file_get_contents(DEFAULT_FAVICON);
		self::assertIsString($contents);
		$newPath = $feed->setCustomFavicon($contents, updateFeed: false);
		self::assertIsString($newPath);
		unlink($newPath);
		$legacyPath = FAVICONS_DIR . hash('crc32b', FreshRSS_Context::systemConf()->salt . $feed->id() . Minz_User::name()) . '.ico';
		file_put_contents($legacyPath, $contents);

		$feed->favicon();

		self::assertSame($contents, file_get_contents($newPath));
		self::assertSame($contents, file_get_contents($legacyPath));
		unlink($legacyPath);
		unlink($newPath);
	}

	public function test_favicon_migrationDoesNotOverwriteDestination(): void {
		FreshRSS_Context::initSystem();
		require_once LIB_PATH . '/favicons.php';
		$feed = new FreshRSS_Feed('http://example.net/feed.xml', validate: false);
		$feed->_id(987655);
		$contents = file_get_contents(DEFAULT_FAVICON);
		self::assertIsString($contents);
		$newPath = $feed->setCustomFavicon($contents, updateFeed: false);
		self::assertIsString($newPath);
		$destination = 'destination-icon';
		file_put_contents($newPath, $destination);
		$legacyPath = FAVICONS_DIR . hash('crc32b', FreshRSS_Context::systemConf()->salt . $feed->id() . Minz_User::name()) . '.ico';
		file_put_contents($legacyPath, $contents);

		$feed->favicon();

		self::assertSame($destination, file_get_contents($newPath));
		self::assertSame($contents, file_get_contents($legacyPath));
		unlink($legacyPath);
		unlink($newPath);
	}
}