| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431 |
- <?php
- declare(strict_types=1);
- class FreshRSS_Feed extends Minz_Model {
- use FreshRSS_AttributesTrait, FreshRSS_FilterActionsTrait;
- /**
- * Normal RSS or Atom feed
- * @var int
- */
- public const KIND_RSS = 0;
- /**
- * Invalid RSS or Atom feed
- * @var int
- */
- public const KIND_RSS_FORCED = 2;
- /**
- * Normal HTML with XPath scraping
- * @var int
- */
- public const KIND_HTML_XPATH = 10;
- /**
- * Normal XML with XPath scraping
- * @var int
- */
- public const KIND_XML_XPATH = 15;
- /**
- * Normal JSON with XPath scraping
- * @var int
- */
- public const KIND_JSON_XPATH = 20;
- public const KIND_JSONFEED = 25;
- public const KIND_JSON_DOTNOTATION = 30;
- /** JSON embedded in HTML */
- public const KIND_HTML_XPATH_JSON_DOTNOTATION = 35;
- public const PRIORITY_IMPORTANT = 20;
- public const PRIORITY_MAIN_STREAM = 10;
- public const PRIORITY_CATEGORY = 0;
- public const PRIORITY_ARCHIVED = -10;
- public const TTL_DEFAULT = 0;
- public const ARCHIVING_RETENTION_COUNT_LIMIT = 10000;
- public const ARCHIVING_RETENTION_PERIOD = 'P3M';
- private int $id = 0;
- private string $url = '';
- private int $kind = 0;
- private int $categoryId = 0;
- private ?FreshRSS_Category $category = null;
- private int $nbEntries = -1;
- private int $nbNotRead = -1;
- private string $name = '';
- private string $website = '';
- private string $description = '';
- private int $lastUpdate = 0;
- private int $priority = self::PRIORITY_MAIN_STREAM;
- private string $pathEntries = '';
- private string $httpAuth = '';
- private bool $error = false;
- private int $ttl = self::TTL_DEFAULT;
- private bool $mute = false;
- private string $hash = '';
- private string $hashFavicon = '';
- private string $lockPath = '';
- private string $hubUrl = '';
- private string $selfUrl = '';
- /**
- * @throws FreshRSS_BadUrl_Exception
- */
- public function __construct(string $url, bool $validate = true) {
- if ($validate) {
- $this->_url($url);
- } else {
- $this->url = $url;
- }
- }
- public static function default(): FreshRSS_Feed {
- $f = new FreshRSS_Feed('http://example.net/', false);
- $f->faviconPrepare();
- return $f;
- }
- public function id(): int {
- return $this->id;
- }
- public function hash(): string {
- if ($this->hash == '') {
- $salt = FreshRSS_Context::systemConf()->salt;
- $params = $this->url . $this->proxyParam();
- $this->hash = sha1($salt . $params);
- }
- return $this->hash;
- }
- public function resetFaviconHash(): void {
- $this->hashFavicon(skipCache: true);
- }
- public function proxyParam(): string {
- $curl_params = $this->attributeArray('curl_params');
- if (is_array($curl_params)) {
- // Content provided through a proxy may be completely different
- return is_string($curl_params[CURLOPT_PROXY] ?? null) ? $curl_params[CURLOPT_PROXY] : '';
- }
- return '';
- }
- /**
- * Resets the custom favicon to the default one. Also deletes the favicon when allowed by extension.
- *
- * @param array{'url'?:string,'kind'?:int,'category'?:int,'name'?:string,'website'?:string,'description'?:string,'lastUpdate'?:int,'priority'?:int,
- * 'pathEntries'?:string,'httpAuth'?:string,'error'?:int,'ttl'?:int,'attributes'?:string|array<string,mixed>} &$values &$values
- *
- * @param bool $updateFeed Whether `updateFeed()` should be called immediately. If false, it must be handled manually.
- *
- * @return void
- *
- * @throws FreshRSS_Feed_Exception
- */
- public function resetCustomFavicon(?array &$values = null, bool $updateFeed = true) {
- if (!$this->customFavicon()) {
- return;
- }
- if (!$this->attributeBoolean('customFaviconDisallowDel')) {
- FreshRSS_Feed::faviconDelete($this->hashFavicon());
- }
- $this->_attribute('customFavicon', false);
- $this->_attribute('customFaviconExt', null);
- $this->_attribute('customFaviconDisallowDel', false);
- if ($values !== null) {
- $values['attributes'] = $this->attributes();
- $feedDAO = FreshRSS_Factory::createFeedDao();
- if ($updateFeed && !$feedDAO->updateFeed($this->id(), $values)) {
- throw new FreshRSS_Feed_Exception();
- }
- }
- $this->resetFaviconHash();
- }
- /**
- * Set a custom favicon for the feed.
- *
- * @param string $contents Contents of the favicon file. Optional if $tmpPath is set.
- * @param string $tmpPath Use only when handling file uploads. (value from `tmp_name` goes here)
- *
- * @param array{'url'?:string,'kind'?:int,'category'?:int,'name'?:string,'website'?:string,'description'?:string,'lastUpdate'?:int,'priority'?:int,
- * 'pathEntries'?:string,'httpAuth'?:string,'error'?:int,'ttl'?:int,'attributes'?:string|array<string,mixed>} &$values &$values
- *
- * @param bool $updateFeed Whether `updateFeed()` should be called immediately. If false, it must be handled manually.
- * @param string $extName The extension name of the calling extension.
- * @param bool $disallowDelete Whether the icon can be later deleted when it's being reset. Intended for use by extensions.
- * @param bool $overrideCustomIcon Whether a custom favicon set by a user can be overridden.
- *
- * @return string|null Path where the favicon can be found. Useful for checking if the favicon already exists, before downloading it for example.
- *
- * @throws FreshRSS_UnsupportedImageFormat_Exception
- * @throws FreshRSS_Feed_Exception
- */
- public function setCustomFavicon(
- ?string $contents = null,
- string $tmpPath = '',
- ?array &$values = null,
- bool $updateFeed = true,
- ?string $extName = null,
- bool $disallowDelete = false,
- bool $overrideCustomIcon = false
- ): ?string {
- if ($contents === null && $tmpPath !== '') {
- $contents = file_get_contents($tmpPath);
- }
- $attributesOnly = $contents === null && $tmpPath === '';
- require_once(LIB_PATH . '/favicons.php');
- if (!$attributesOnly && !isImgMime(is_string($contents) ? $contents : '')) {
- throw new FreshRSS_UnsupportedImageFormat_Exception();
- }
- $oldHash = '';
- $oldDisallowDelete = false;
- if ($this->customFavicon()) {
- /* If $overrideCustomFavicon is true, custom favicons set by extensions can be overridden,
- * but not ones explicitly set by the user */
- if (!$overrideCustomIcon && $this->customFaviconExt() === null) {
- return null;
- }
- $oldHash = $this->hashFavicon(skipCache: true);
- $oldDisallowDelete = $this->attributeBoolean('customFaviconDisallowDel');
- }
- $this->_attribute('customFavicon', true);
- $this->_attribute('customFaviconExt', $extName);
- $this->_attribute('customFaviconDisallowDel', $disallowDelete);
- $newPath = FAVICONS_DIR . $this->hashFavicon(skipCache: true) . '.ico';
- if ($attributesOnly && !file_exists($newPath)) {
- $updateFeed = false;
- }
- if ($values !== null) {
- $values['attributes'] = $this->attributes();
- $feedDAO = FreshRSS_Factory::createFeedDao();
- if ($updateFeed && !$feedDAO->updateFeed($this->id(), $values)) {
- throw new FreshRSS_Feed_Exception();
- }
- }
- if ($tmpPath !== '') {
- move_uploaded_file($tmpPath, $newPath);
- } elseif ($contents !== null) {
- file_put_contents($newPath, $contents);
- }
- if ($oldHash !== '' && !$oldDisallowDelete) {
- FreshRSS_Feed::faviconDelete($oldHash);
- }
- return $newPath;
- }
- /**
- * Checks if the feed has a custom favicon set by an extension.
- * Additionally, it also checks if the extension that set the icon is still enabled
- * And if not, it resets attributes related to custom favicons.
- *
- * @return string|null The name of the extension that set the icon.
- */
- public function customFaviconExt(): ?string {
- $customFaviconExt = $this->attributeString('customFaviconExt');
- if ($customFaviconExt !== null && !Minz_ExtensionManager::isExtensionEnabled($customFaviconExt)) {
- $this->_attribute('customFavicon', false);
- $this->_attribute('customFaviconExt', null);
- $this->_attribute('customFaviconDisallowDel', false);
- $customFaviconExt = null;
- }
- return $customFaviconExt;
- }
- public function customFavicon(): bool {
- $this->customFaviconExt();
- return $this->attributeBoolean('customFavicon') ?? false;
- }
- public function hashFavicon(bool $skipCache = false): string {
- if ($this->hashFavicon == '' || $skipCache) {
- $salt = FreshRSS_Context::systemConf()->salt;
- $params = '';
- if ($this->customFavicon()) {
- $current = $this->id . Minz_User::name();
- $hookParams = Minz_ExtensionManager::callHook('custom_favicon_hash', $this);
- $params = $hookParams !== null ? $hookParams : $current;
- } else {
- $params = $this->website(fallback: true) . $this->proxyParam();
- }
- $this->hashFavicon = hash('crc32b', $salt . (is_string($params) ? $params : ''));
- }
- return $this->hashFavicon;
- }
- public function url(bool $includeCredentials = true): string {
- return $includeCredentials ? $this->url : \SimplePie\Misc::url_remove_credentials($this->url);
- }
- public function selfUrl(): string {
- return $this->selfUrl;
- }
- public function kind(): int {
- return $this->kind;
- }
- public function hubUrl(): string {
- return $this->hubUrl;
- }
- public function category(): ?FreshRSS_Category {
- if ($this->category === null && $this->categoryId > 0) {
- $catDAO = FreshRSS_Factory::createCategoryDao();
- $this->category = $catDAO->searchById($this->categoryId);
- }
- return $this->category;
- }
- public function categoryId(): int {
- return $this->category?->id() ?: $this->categoryId;
- }
- /**
- * @return list<FreshRSS_Entry>|null
- * @deprecated
- */
- public function entries(): ?array {
- Minz_Log::warning(__METHOD__ . ' is deprecated since FreshRSS 1.16.1!');
- $simplePie = $this->load(false, true);
- return $simplePie == null ? [] : array_values(iterator_to_array($this->loadEntries($simplePie)));
- }
- public function name(bool $raw = false): string {
- return $raw || $this->name != '' ? $this->name : (preg_replace('%^https?://(www[.])?%i', '', $this->url) ?? '');
- }
- /**
- * @param bool $fallback true to return the URL of the feed if the Web site is blank
- * @return string HTML-encoded URL of the Web site of the feed
- */
- public function website(bool $fallback = false): string {
- $url = $this->website;
- if ($fallback && !preg_match('%^https?://.%i', $url)) {
- $url = $this->url;
- }
- return $url;
- }
- public function description(): string {
- return $this->description;
- }
- public function lastUpdate(): int {
- return $this->lastUpdate;
- }
- public function priority(): int {
- return $this->priority;
- }
- /** @return string HTML-encoded CSS selector */
- public function pathEntries(): string {
- return $this->pathEntries;
- }
- /**
- * @phpstan-return ($raw is true ? string : array{'username':string,'password':string})
- * @return array{'username':string,'password':string}|string
- */
- public function httpAuth(bool $raw = true): array|string {
- if ($raw) {
- return $this->httpAuth;
- } else {
- $pos_colon = strpos($this->httpAuth, ':');
- if ($pos_colon !== false) {
- $user = substr($this->httpAuth, 0, $pos_colon);
- $pass = substr($this->httpAuth, $pos_colon + 1);
- } else {
- $user = '';
- $pass = '';
- }
- return [
- 'username' => $user,
- 'password' => $pass,
- ];
- }
- }
- /** @return array<int,mixed> */
- public function curlOptions(): array {
- $curl_options = [];
- if ($this->httpAuth !== '') {
- $curl_options[CURLOPT_USERPWD] = htmlspecialchars_decode($this->httpAuth, ENT_QUOTES);
- }
- return $curl_options;
- }
- public function inError(): bool {
- return $this->error;
- }
- /**
- * @param bool $raw true for database version combined with mute information, false otherwise
- */
- public function ttl(bool $raw = false): int {
- if ($raw) {
- $ttl = $this->ttl;
- if ($this->mute && FreshRSS_Feed::TTL_DEFAULT === $ttl) {
- $ttl = FreshRSS_Context::userConf()->ttl_default;
- }
- return $ttl * ($this->mute ? -1 : 1);
- }
- if ($this->mute && $this->ttl === FreshRSS_Context::userConf()->ttl_default) {
- return FreshRSS_Feed::TTL_DEFAULT;
- }
- return $this->ttl;
- }
- public function mute(): bool {
- return $this->mute;
- }
- public function nbEntries(): int {
- if ($this->nbEntries < 0) {
- $feedDAO = FreshRSS_Factory::createFeedDao();
- $this->nbEntries = $feedDAO->countEntries($this->id());
- }
- return $this->nbEntries;
- }
- public function nbNotRead(): int {
- if ($this->nbNotRead < 0) {
- $feedDAO = FreshRSS_Factory::createFeedDao();
- $this->nbNotRead = $feedDAO->countNotRead($this->id());
- }
- return $this->nbNotRead;
- }
- public function faviconPrepare(bool $force = false): void {
- require_once(LIB_PATH . '/favicons.php');
- if ($this->customFavicon()) {
- return;
- }
- $url = $this->website(fallback: false);
- if ($url === '' || $url === $this->url) {
- // Get root URL from the feed URL
- $url = preg_replace('%^(https?://[^/]+).*$%i', '$1/', $this->url) ?? $this->url;
- }
- $txt = FAVICONS_DIR . $this->hashFavicon() . '.txt';
- if (@file_get_contents($txt) !== $url) {
- file_put_contents($txt, $url);
- }
- if (FreshRSS_Context::$isCli || $force) {
- $ico = FAVICONS_DIR . $this->hashFavicon() . '.ico';
- $ico_mtime = @filemtime($ico);
- $txt_mtime = @filemtime($txt);
- if ($txt_mtime != false &&
- ($ico_mtime == false || $ico_mtime < $txt_mtime || ($ico_mtime < time() - (14 * 86400)))) {
- // no ico file or we should download a new one.
- $url = file_get_contents($txt);
- if ($url == false || !download_favicon($url, $ico)) {
- touch($ico);
- }
- }
- }
- }
- public static function faviconDelete(string $hash): void {
- if (!ctype_xdigit($hash)) {
- return;
- }
- $path = DATA_PATH . '/favicons/' . $hash;
- @unlink($path . '.ico');
- @unlink($path . '.txt');
- }
- public function favicon(): string {
- $hash = $this->hashFavicon();
- $url = '/f.php?h=' . $hash;
- if ($this->customFavicon()
- // when the below attribute is set, icon won't be changing frequently so cache buster is not needed
- && !$this->attributeBoolean('customFaviconDisallowDel')) {
- $url .= '&t=' . @filemtime(DATA_PATH . '/favicons/' . $hash . '.ico');
- }
- return Minz_Url::display($url);
- }
- public function _id(int $value): void {
- $this->id = $value;
- }
- /**
- * @throws FreshRSS_BadUrl_Exception
- */
- public function _url(string $value, bool $validate = true): void {
- $this->hash = '';
- $this->hashFavicon = '';
- $url = $value;
- if ($validate) {
- $url = checkUrl($url);
- }
- if ($url == false) {
- throw new FreshRSS_BadUrl_Exception($value);
- }
- $this->url = $url;
- }
- public function _selfUrl(string $value): void {
- $this->selfUrl = $value;
- }
- public function _kind(int $value): void {
- $this->kind = $value;
- }
- public function _category(?FreshRSS_Category $cat): void {
- $this->category = $cat;
- $this->categoryId = $this->category == null ? 0 : $this->category->id();
- }
- /** @param int|numeric-string $id */
- public function _categoryId(int|string $id): void {
- $this->category = null;
- $this->categoryId = (int)$id;
- }
- public function _name(string $value): void {
- $this->name = $value == '' ? '' : trim($value);
- }
- public function _website(string $value, bool $validate = true): void {
- $this->hashFavicon = '';
- if ($validate) {
- $value = checkUrl($value);
- }
- if ($value == false) {
- $value = '';
- }
- $this->website = $value;
- }
- public function _description(string $value): void {
- $this->description = $value == '' ? '' : $value;
- }
- /**
- * @param int|numeric-string $value
- * 32-bit systems provide a string and will fail in year 2038
- */
- public function _lastUpdate(int|string $value): void {
- $this->lastUpdate = (int)$value;
- }
- public function _priority(int $value): void {
- $this->priority = $value;
- }
- /** @param string $value HTML-encoded CSS selector */
- public function _pathEntries(string $value): void {
- $this->pathEntries = $value;
- }
- public function _httpAuth(string $value): void {
- $this->httpAuth = $value;
- }
- public function _error(bool|int $value): void {
- $this->error = (bool)$value;
- }
- public function _mute(bool $value): void {
- $this->mute = $value;
- }
- public function _ttl(int $value): void {
- $value = min($value, 100_000_000);
- $this->ttl = abs($value);
- $this->mute = $value < self::TTL_DEFAULT;
- }
- public function _nbNotRead(int $value): void {
- $this->nbNotRead = $value;
- }
- public function _nbEntries(int $value): void {
- $this->nbEntries = $value;
- }
- /**
- * @throws Minz_FileNotExistException
- * @throws FreshRSS_Feed_Exception
- */
- public function load(bool $loadDetails = false, bool $noCache = false): ?\SimplePie\SimplePie {
- if ($this->url != '') {
- /**
- * @throws Minz_FileNotExistException
- */
- if (trim(CACHE_PATH) === '') {
- throw new Minz_FileNotExistException(
- 'CACHE_PATH',
- Minz_Exception::ERROR
- );
- } else {
- if (($retryAfter = FreshRSS_http_Util::getRetryAfter($this->url)) > 0) {
- throw new FreshRSS_Feed_Exception('For that domain, will first retry after ' . date('c', $retryAfter) .
- '. ' . $this->url(includeCredentials: false), code: 503);
- }
- $simplePie = customSimplePie($this->attributes(), $this->curlOptions());
- $url = htmlspecialchars_decode($this->url, ENT_QUOTES);
- if (str_ends_with($url, '#force_feed')) {
- $simplePie->force_feed(true);
- $url = substr($url, 0, -11);
- }
- $simplePie->set_feed_url($url);
- if (!$loadDetails) { //Only activates auto-discovery when adding a new feed
- $simplePie->set_autodiscovery_level(\SimplePie\SimplePie::LOCATOR_NONE);
- }
- if ($this->attributeBoolean('clear_cache')) {
- // Do not use `$simplePie->enable_cache(false);` as it would prevent caching in multiuser context
- $this->clearCache();
- }
- Minz_ExtensionManager::callHook('simplepie_before_init', $simplePie, $this);
- $simplePieResult = $simplePie->init();
- Minz_ExtensionManager::callHook('simplepie_after_init', $simplePie, $this, $simplePieResult);
- if ($simplePieResult === false || $simplePie->get_hash() === '' || !empty($simplePie->error())) {
- if ($simplePie->status_code() === 429) {
- $errorMessage = 'HTTP 429 Too Many Requests!';
- } elseif ($simplePie->status_code() === 503) {
- $errorMessage = 'HTTP 503 Service Unavailable!';
- } else {
- $errorMessage = $simplePie->error();
- if (empty($errorMessage)) {
- $errorMessage = '';
- } elseif (is_array($errorMessage)) {
- $errorMessage = json_encode($errorMessage, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_LINE_TERMINATORS) ?: '';
- }
- }
- throw new FreshRSS_Feed_Exception(
- ($errorMessage == '' ? 'Unknown error for feed' : $errorMessage) .
- ' [' . $this->url(includeCredentials: false) . ']',
- $simplePie->status_code()
- );
- }
- $links = $simplePie->get_links('self');
- $this->selfUrl = empty($links[0]) ? '' : (checkUrl($links[0]) ?: '');
- $links = $simplePie->get_links('hub');
- $this->hubUrl = empty($links[0]) ? '' : (checkUrl($links[0]) ?: '');
- if ($loadDetails) {
- // si on a utilisé l’auto-discover, notre url va avoir changé
- $subscribe_url = $simplePie->subscribe_url(false) ?? '';
- if ($this->name(true) === '') {
- //HTML to HTML-PRE //ENT_COMPAT except '&'
- $title = strtr(html_only_entity_decode($simplePie->get_title()), ['<' => '<', '>' => '>', '"' => '"']);
- $this->_name($title == '' ? $this->url : $title);
- }
- if ($this->website() === '') {
- $this->_website(html_only_entity_decode($simplePie->get_link()));
- }
- if ($this->description() === '') {
- $this->_description(html_only_entity_decode($simplePie->get_description()));
- }
- } else {
- //The case of HTTP 301 Moved Permanently
- $subscribe_url = $simplePie->subscribe_url(true) ?? '';
- }
- $clean_url = \SimplePie\Misc::url_remove_credentials($subscribe_url);
- if ($subscribe_url !== '' && $subscribe_url !== $url) {
- $this->_url($clean_url);
- }
- if ($noCache || $simplePie->get_hash() !== $this->attributeString('SimplePieHash')) {
- // syslog(LOG_DEBUG, 'FreshRSS no cache ' . $simplePie->get_hash() . ' !== ' . $this->attributeString('SimplePieHash') . ' for ' . $clean_url);
- $this->_attribute('SimplePieHash', $simplePie->get_hash());
- return $simplePie;
- }
- syslog(LOG_DEBUG, 'FreshRSS SimplePie uses cache for ' . $clean_url);
- }
- }
- return null;
- }
- /**
- * Decide the GUID of an entry based on the feed’s policy.
- * @param \SimplePie\Item $item The item to decide the GUID for.
- * @param bool $fallback Whether to automatically switch to the next policy in case of blank GUID.
- * @return string The decided GUID for the entry.
- */
- protected function decideEntryGuid(\SimplePie\Item $item, bool $fallback = false): string {
- $unicityCriteria = $this->attributeString('unicityCriteria');
- if ($this->attributeBoolean('hasBadGuids')) { // Legacy
- $unicityCriteria = 'link';
- }
- $entryId = safe_ascii($item->get_id(false, false));
- $guid = match ($unicityCriteria) {
- null => $entryId,
- 'link' => $item->get_permalink() ?? '',
- 'sha1:link_published' => sha1($item->get_permalink() . $item->get_date('U')),
- 'sha1:link_published_title' => sha1($item->get_permalink() . $item->get_date('U') . $item->get_title()),
- 'sha1:link_published_title_content' => sha1($item->get_permalink() . $item->get_date('U') . $item->get_title() . $item->get_content()),
- default => $entryId,
- };
- $blankHash = 'da39a3ee5e6b4b0d3255bfef95601890afd80709'; // sha1('')
- if ($guid === $blankHash) {
- $guid = '';
- }
- if ($fallback && $guid === '') {
- if ($entryId !== '') {
- $guid = $entryId;
- } elseif (($item->get_permalink() ?? '') !== '') {
- $guid = sha1($item->get_permalink() . $item->get_date('U'));
- } elseif (($item->get_title() ?? '') !== '') {
- $guid = sha1($item->get_permalink() . $item->get_date('U') . $item->get_title());
- } else {
- $guid = sha1($item->get_permalink() . $item->get_date('U') . $item->get_title() . $item->get_content());
- }
- if ($guid === $blankHash) {
- $guid = '';
- }
- }
- return $guid;
- }
- /**
- * @param float $invalidGuidsTolerance (default 0.05) The maximum ratio (rounded) of invalid GUIDs to tolerate before degrading the unicity criteria.
- * Example for 0.05 (5% rounded): tolerate 0 invalid GUIDs for up to 9 articles, 1 for 10, 2 for 30, 3 for 50, 4 for 70, 5 for 90, 6 for 110, etc.
- * The default value of 5% rounded was chosen to allow 1 invalid GUID for feeds of 10 articles, which is a frequently observed amount of articles.
- * @return list<string>
- */
- public function loadGuids(\SimplePie\SimplePie $simplePie, float $invalidGuidsTolerance = 0.05): array {
- $invalidGuids = 0;
- $testGuids = [];
- $guids = [];
- $items = $simplePie->get_items();
- if (empty($items)) {
- return $guids;
- }
- for ($i = count($items) - 1; $i >= 0; $i--) {
- $item = $items[$i];
- if ($item == null) {
- continue;
- }
- $guid = $this->decideEntryGuid($item, fallback: true);
- if ($guid === '' || !empty($testGuids['_' . $guid])) {
- $invalidGuids++;
- Minz_Log::debug('Invalid GUID [' . $guid . '] for feed ' . $this->url);
- }
- $testGuids['_' . $guid] = true;
- $guids[] = $guid;
- }
- if ($invalidGuids > 0) {
- Minz_Log::warning("Feed has {$invalidGuids} invalid GUIDs: " . $this->url(includeCredentials: false));
- if (!$this->attributeBoolean('unicityCriteriaForced') && $invalidGuids > round($invalidGuidsTolerance * count($items))) {
- $unicityCriteria = $this->attributeString('unicityCriteria');
- if ($this->attributeBoolean('hasBadGuids')) { // Legacy
- $unicityCriteria = 'link';
- }
- // Automatic fallback to next (degraded) unicity criteria
- $newUnicityCriteria = match ($unicityCriteria) {
- null => 'sha1:link_published',
- 'link' => 'sha1:link_published',
- 'sha1:link_published' => 'sha1:link_published_title',
- default => $unicityCriteria,
- };
- if ($newUnicityCriteria !== $unicityCriteria) {
- $this->_attribute('hasBadGuids', null); // Remove legacy
- $this->_attribute('unicityCriteria', $newUnicityCriteria);
- Minz_Log::warning('Feed unicity policy degraded (' . ($unicityCriteria ?: 'id') . ' → ' . $newUnicityCriteria . '): ' .
- $this->url(includeCredentials: false));
- return $this->loadGuids($simplePie, $invalidGuidsTolerance);
- }
- }
- $this->_error(true);
- }
- return $guids;
- }
- /** @return Traversable<FreshRSS_Entry> */
- public function loadEntries(\SimplePie\SimplePie $simplePie): Traversable {
- $items = $simplePie->get_items();
- if (empty($items)) {
- return;
- }
- // We want chronological order and SimplePie uses reverse order.
- for ($i = count($items) - 1; $i >= 0; $i--) {
- $item = $items[$i];
- if ($item == null) {
- continue;
- }
- $title = html_only_entity_decode(strip_tags($item->get_title() ?? ''));
- $authors = $item->get_authors();
- $link = $item->get_permalink();
- $date = $item->get_date('U');
- if (!is_numeric($date)) {
- $date = 0;
- }
- //Tag processing (tag == category)
- $categories = $item->get_categories();
- $tags = [];
- if (is_array($categories)) {
- foreach ($categories as $category) {
- $text = html_only_entity_decode($category->get_label());
- //Some feeds use a single category with comma-separated tags
- $labels = explode(',', $text);
- if (!empty($labels)) {
- foreach ($labels as $label) {
- $tags[] = trim($label);
- }
- }
- }
- $tags = array_unique($tags);
- }
- $content = html_only_entity_decode($item->get_content());
- $attributeThumbnail = $item->get_thumbnail() ?? [];
- if (empty($attributeThumbnail['url'])) {
- $attributeThumbnail['url'] = '';
- }
- $attributeEnclosures = [];
- if (!empty($item->get_enclosures())) {
- foreach ($item->get_enclosures() as $enclosure) {
- $elink = $enclosure->get_link();
- if ($elink != '') {
- $etitle = $enclosure->get_title() ?? '';
- $credits = $enclosure->get_credits() ?? null;
- $description = $enclosure->get_description() ?? '';
- $mime = strtolower($enclosure->get_type() ?? '');
- $medium = strtolower($enclosure->get_medium() ?? '');
- $height = $enclosure->get_height();
- $width = $enclosure->get_width();
- $length = $enclosure->get_length();
- $attributeEnclosure = [
- 'url' => $elink,
- ];
- if ($etitle != '') {
- $attributeEnclosure['title'] = $etitle;
- }
- if (is_array($credits)) {
- $attributeEnclosure['credit'] = [];
- foreach ($credits as $credit) {
- $attributeEnclosure['credit'][] = $credit->get_name();
- }
- }
- if ($description != '') {
- $attributeEnclosure['description'] = $description;
- }
- if ($mime != '') {
- $attributeEnclosure['type'] = $mime;
- }
- if ($medium != '') {
- $attributeEnclosure['medium'] = $medium;
- }
- if ($length != '') {
- $attributeEnclosure['length'] = (int)$length;
- }
- if ($height != '') {
- $attributeEnclosure['height'] = (int)$height;
- }
- if ($width != '') {
- $attributeEnclosure['width'] = (int)$width;
- }
- if (!empty($enclosure->get_thumbnails())) {
- foreach ($enclosure->get_thumbnails() as $thumbnail) {
- if ($thumbnail !== $attributeThumbnail['url']) {
- $attributeEnclosure['thumbnails'][] = $thumbnail;
- }
- }
- }
- $attributeEnclosures[] = $attributeEnclosure;
- }
- }
- }
- $guid = $this->decideEntryGuid($item, fallback: true);
- unset($item);
- $authorNames = '';
- if (is_array($authors)) {
- foreach ($authors as $author) {
- $authorName = $author->name != '' ? $author->name : $author->email;
- if (is_string($authorName) && $authorName !== '') {
- $authorNames .= html_only_entity_decode(strip_tags($authorName)) . '; ';
- }
- }
- }
- $authorNames = substr($authorNames, 0, -2) ?: '';
- $entry = new FreshRSS_Entry(
- $this->id(),
- $guid,
- $title == '' ? '' : $title,
- $authorNames,
- $content == '' ? '' : $content,
- $link == null ? '' : $link,
- $date ?: time()
- );
- $entry->_tags($tags);
- $entry->_feed($this);
- if (!empty($attributeThumbnail['url'])) {
- $entry->_attribute('thumbnail', $attributeThumbnail);
- }
- $entry->_attribute('enclosures', $attributeEnclosures);
- $entry->hash(); //Must be computed before loading full content
- $entry->loadCompleteContent(); // Optionally load full content for truncated feeds
- yield $entry;
- }
- }
- /**
- * Given a feed content generated from a FreshRSS_View
- * returns a SimplePie initialized already with that content
- * @param string $feedContent the content of the feed, typically generated via FreshRSS_View::renderToString()
- */
- private function simplePieFromContent(string $feedContent): \SimplePie\SimplePie {
- $simplePie = customSimplePie();
- $simplePie->enable_cache(false);
- $simplePie->set_raw_data($feedContent);
- $simplePie->init();
- return $simplePie;
- }
- /** @return array<string,string> */
- private function dotNotationForStandardJsonFeed(): array {
- return [
- 'feedTitle' => 'title',
- 'item' => 'items',
- 'itemTitle' => 'title',
- 'itemContent' => 'content_text',
- 'itemContentHTML' => 'content_html',
- 'itemUri' => 'url',
- 'itemTimestamp' => 'date_published',
- 'itemTimeFormat' => DateTimeInterface::RFC3339_EXTENDED,
- 'itemThumbnail' => 'image',
- 'itemCategories' => 'tags',
- 'itemUid' => 'id',
- 'itemAttachment' => 'attachments',
- 'itemAttachmentUrl' => 'url',
- 'itemAttachmentType' => 'mime_type',
- 'itemAttachmentLength' => 'size_in_bytes',
- ];
- }
- private function extractJsonFromHtml(string $html): ?string {
- $xPathToJson = $this->attributeString('xPathToJson') ?? '';
- if ($xPathToJson === '') {
- return null;
- }
- $doc = new DOMDocument();
- $doc->recover = true;
- $doc->strictErrorChecking = false;
- if (!$doc->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING)) {
- return null;
- }
- $xpath = new DOMXPath($doc);
- $jsonFragments = @$xpath->evaluate($xPathToJson);
- if ($jsonFragments === false) {
- return null;
- }
- if (is_string($jsonFragments)) {
- return $jsonFragments;
- }
- if ($jsonFragments instanceof DOMNodeList && $jsonFragments->length > 0) {
- // If the result is a list, then aggregate as a JSON array
- $result = [];
- foreach ($jsonFragments as $node) {
- $json = json_decode($node->textContent, true);
- if (json_last_error() === JSON_ERROR_NONE && is_array($json)) {
- $result[] = $json;
- }
- }
- return json_encode($result, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) ?: null;
- }
- return null;
- }
- public function loadJson(): ?\SimplePie\SimplePie {
- if ($this->url == '') {
- return null;
- }
- $feedSourceUrl = htmlspecialchars_decode($this->url, ENT_QUOTES);
- if ($feedSourceUrl == null) {
- return null;
- }
- $httpAccept = $this->kind() === FreshRSS_Feed::KIND_HTML_XPATH_JSON_DOTNOTATION ? 'html' : 'json';
- $content = httpGet($feedSourceUrl, $this->cacheFilename(), $httpAccept, $this->attributes(), $this->curlOptions())['body'];
- if (strlen($content) <= 0) {
- return null;
- }
- if ($this->kind() === FreshRSS_Feed::KIND_HTML_XPATH_JSON_DOTNOTATION) {
- $content = $this->extractJsonFromHtml($content);
- if ($content == null) {
- return null;
- }
- }
- //check if the content is actual JSON
- $jf = json_decode($content, true);
- if (json_last_error() !== JSON_ERROR_NONE || !is_array($jf)) {
- return null;
- }
- /** @var array<string,string> $json_dotnotation */
- $json_dotnotation = $this->attributeArray('json_dotnotation') ?? [];
- $dotnotations = $this->kind() === FreshRSS_Feed::KIND_JSONFEED ? $this->dotNotationForStandardJsonFeed() : $json_dotnotation;
- $feedContent = FreshRSS_dotNotation_Util::convertJsonToRss($jf, $feedSourceUrl, $dotnotations, $this->name());
- if ($feedContent == null) {
- return null;
- }
- return $this->simplePieFromContent($feedContent);
- }
- public function loadHtmlXpath(): ?\SimplePie\SimplePie {
- if ($this->url == '') {
- return null;
- }
- $feedSourceUrl = htmlspecialchars_decode($this->url, ENT_QUOTES);
- if ($feedSourceUrl == null) {
- return null;
- }
- // Same naming conventions than https://rss-bridge.github.io/rss-bridge/Bridge_API/XPathAbstract.html
- // https://rss-bridge.github.io/rss-bridge/Bridge_API/BridgeAbstract.html#collectdata
- /** @var array<string,string> $xPathSettings */
- $xPathSettings = $this->attributeArray('xpath');
- $xPathFeedTitle = $xPathSettings['feedTitle'] ?? '';
- $xPathItem = $xPathSettings['item'] ?? '';
- $xPathItemTitle = $xPathSettings['itemTitle'] ?? '';
- $xPathItemContent = $xPathSettings['itemContent'] ?? '';
- $xPathItemUri = $xPathSettings['itemUri'] ?? '';
- $xPathItemAuthor = $xPathSettings['itemAuthor'] ?? '';
- $xPathItemTimestamp = $xPathSettings['itemTimestamp'] ?? '';
- $xPathItemTimeFormat = $xPathSettings['itemTimeFormat'] ?? '';
- $xPathItemThumbnail = $xPathSettings['itemThumbnail'] ?? '';
- $xPathItemCategories = $xPathSettings['itemCategories'] ?? '';
- $xPathItemUid = $xPathSettings['itemUid'] ?? '';
- if ($xPathItem == '') {
- return null;
- }
- $httpAccept = $this->kind() === FreshRSS_Feed::KIND_XML_XPATH ? 'xml' : 'html';
- $html = httpGet($feedSourceUrl, $this->cacheFilename(), $httpAccept, $this->attributes(), $this->curlOptions())['body'];
- if (strlen($html) <= 0) {
- return null;
- }
- $view = new FreshRSS_View();
- $view->_path('index/rss.phtml');
- $view->internal_rendering = true;
- $view->rss_url = htmlspecialchars($feedSourceUrl, ENT_COMPAT, 'UTF-8');
- $view->html_url = $view->rss_url;
- $view->entries = [];
- try {
- $doc = new DOMDocument();
- $doc->recover = true;
- $doc->strictErrorChecking = false;
- $ok = false;
- switch ($this->kind()) {
- case FreshRSS_Feed::KIND_HTML_XPATH:
- $ok = $doc->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING) !== false;
- break;
- case FreshRSS_Feed::KIND_XML_XPATH:
- $ok = $doc->loadXML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING) !== false;
- break;
- }
- if (!$ok) {
- return null;
- }
- $xpath = new DOMXPath($doc);
- $xpathEvaluateString = function (string $expression, ?DOMNode $contextNode = null) use ($xpath): string {
- $result = @$xpath->evaluate('normalize-space(' . $expression . ')', $contextNode);
- return is_string($result) ? $result : '';
- };
- $view->rss_title = $xPathFeedTitle == '' ? $this->name() :
- htmlspecialchars($xpathEvaluateString($xPathFeedTitle), ENT_COMPAT, 'UTF-8');
- $view->rss_base = htmlspecialchars(trim($xpathEvaluateString('//base/@href')), ENT_COMPAT, 'UTF-8');
- $nodes = $xpath->query($xPathItem);
- if ($nodes === false || $nodes->length === 0) {
- return null;
- }
- foreach ($nodes as $node) {
- $item = [];
- $item['title'] = $xPathItemTitle == '' ? '' : $xpathEvaluateString($xPathItemTitle, $node);
- $item['content'] = '';
- if ($xPathItemContent != '') {
- $result = @$xpath->evaluate($xPathItemContent, $node);
- if ($result instanceof DOMNodeList) {
- // List of nodes, save as HTML
- $content = '';
- foreach ($result as $child) {
- $content .= $doc->saveHTML($child) . "\n";
- }
- $item['content'] = $content;
- } elseif (is_string($result) || is_int($result) || is_bool($result)) {
- // Typed expression, save as-is
- $item['content'] = (string)$result;
- }
- }
- $item['link'] = $xPathItemUri == '' ? '' : $xpathEvaluateString($xPathItemUri, $node);
- $item['author'] = $xPathItemAuthor == '' ? '' : $xpathEvaluateString($xPathItemAuthor, $node);
- $item['timestamp'] = $xPathItemTimestamp == '' ? '' : $xpathEvaluateString($xPathItemTimestamp, $node);
- if ($xPathItemTimeFormat != '') {
- $dateTime = DateTime::createFromFormat($xPathItemTimeFormat, $item['timestamp']);
- if ($dateTime != false) {
- $item['timestamp'] = $dateTime->format(DateTime::ATOM);
- }
- }
- $item['thumbnail'] = $xPathItemThumbnail == '' ? '' : $xpathEvaluateString($xPathItemThumbnail, $node);
- if ($xPathItemCategories != '') {
- $itemCategories = @$xpath->evaluate($xPathItemCategories, $node);
- if (is_string($itemCategories) && $itemCategories !== '') {
- $item['tags'] = [$itemCategories];
- } elseif ($itemCategories instanceof DOMNodeList && $itemCategories->length > 0) {
- $item['tags'] = [];
- foreach ($itemCategories as $itemCategory) {
- $item['tags'][] = $itemCategory->textContent;
- }
- }
- }
- if ($xPathItemUid != '') {
- $item['guid'] = $xpathEvaluateString($xPathItemUid, $node);
- }
- if (empty($item['guid'])) {
- $item['guid'] = 'urn:sha1:' . sha1($item['title'] . $item['content'] . $item['link']);
- }
- if ($item['title'] != '' || $item['content'] != '' || $item['link'] != '') {
- // HTML-encoding/escaping of the relevant fields (all except 'content')
- foreach (['author', 'guid', 'link', 'thumbnail', 'timestamp', 'title'] as $key) {
- if (isset($item[$key])) {
- $item[$key] = htmlspecialchars($item[$key], ENT_COMPAT, 'UTF-8');
- }
- }
- if (isset($item['tags'])) {
- $item['tags'] = Minz_Helper::htmlspecialchars_utf8($item['tags']);
- }
- // CDATA protection
- $item['content'] = str_replace(']]>', ']]>', $item['content']);
- $view->entries[] = FreshRSS_Entry::fromArray($item);
- }
- }
- } catch (Exception $ex) {
- Minz_Log::warning($ex->getMessage());
- return null;
- }
- return $this->simplePieFromContent($view->renderToString());
- }
- /**
- * @return int|null The max number of unread articles to keep, or null if disabled.
- */
- public function keepMaxUnread(): ?int {
- $keepMaxUnread = $this->attributeInt('keep_max_n_unread');
- if ($keepMaxUnread === null) {
- $keepMaxUnread = FreshRSS_Context::userConf()->mark_when['max_n_unread'];
- }
- return is_int($keepMaxUnread) && $keepMaxUnread >= 0 ? $keepMaxUnread : null;
- }
- /**
- * @return int|false The number of articles marked as read, of false if error
- */
- public function markAsReadMaxUnread(): int|false {
- $keepMaxUnread = $this->keepMaxUnread();
- if ($keepMaxUnread === null) {
- return false;
- }
- $feedDAO = FreshRSS_Factory::createFeedDao();
- $affected = $feedDAO->markAsReadMaxUnread($this->id(), $keepMaxUnread);
- return $affected;
- }
- /**
- * Applies the *mark as read upon gone* policy, if enabled.
- * Remember to call `updateCachedValues($id_feed)` or `updateCachedValues()` just after.
- * @return int|false the number of lines affected, or false if not applicable
- */
- public function markAsReadUponGone(bool $upstreamIsEmpty, int $minLastSeen = 0): int|false {
- $readUponGone = $this->attributeBoolean('read_upon_gone');
- if ($readUponGone === null) {
- $readUponGone = FreshRSS_Context::userConf()->mark_when['gone'];
- }
- if (!$readUponGone) {
- return false;
- }
- if ($upstreamIsEmpty) {
- if ($minLastSeen <= 0) {
- $minLastSeen = time();
- }
- $entryDAO = FreshRSS_Factory::createEntryDao();
- $affected = $entryDAO->markReadFeed($this->id(), $minLastSeen . '000000');
- } else {
- $feedDAO = FreshRSS_Factory::createFeedDao();
- $affected = $feedDAO->markAsReadNotSeen($this->id(), $minLastSeen);
- }
- if ($affected > 0) {
- Minz_Log::debug(__METHOD__ . " $affected items" . ($upstreamIsEmpty ? ' (all)' : '') . ' [' . $this->url(includeCredentials: false) . ']');
- }
- return $affected;
- }
- /**
- * Remember to call `updateCachedValues($id_feed)` or `updateCachedValues()` just after
- */
- public function cleanOldEntries(): int|false {
- /** @var array<string,bool|int|string>|null $archiving */
- $archiving = $this->attributeArray('archiving');
- if ($archiving === null) {
- $catDAO = FreshRSS_Factory::createCategoryDao();
- $category = $catDAO->searchById($this->categoryId);
- $archiving = $category === null ? null : $category->attributeArray('archiving');
- /** @var array<string,bool|int|string>|null $archiving */
- if ($archiving === null) {
- $archiving = FreshRSS_Context::userConf()->archiving;
- }
- }
- if (is_array($archiving)) {
- $entryDAO = FreshRSS_Factory::createEntryDao();
- $nb = $entryDAO->cleanOldEntries($this->id(), $archiving);
- if ($nb > 0) {
- Minz_Log::debug($nb . ' entries cleaned in feed [' . $this->url(false) . '] with: ' . json_encode($archiving));
- }
- return $nb;
- }
- return false;
- }
- /**
- * @param string $url Overridden URL. Will default to the feed URL.
- * @throws FreshRSS_Context_Exception
- */
- public function cacheFilename(string $url = ''): string {
- $simplePie = customSimplePie($this->attributes(), $this->curlOptions());
- if ($url !== '') {
- $filename = $simplePie->get_cache_filename($url);
- return CACHE_PATH . '/' . $filename . '.html';
- }
- $url = htmlspecialchars_decode($this->url);
- $filename = $simplePie->get_cache_filename($url);
- switch ($this->kind) {
- case FreshRSS_Feed::KIND_HTML_XPATH:
- return CACHE_PATH . '/' . $filename . '.html';
- case FreshRSS_Feed::KIND_XML_XPATH:
- return CACHE_PATH . '/' . $filename . '.xml';
- case FreshRSS_Feed::KIND_JSON_DOTNOTATION:
- case FreshRSS_Feed::KIND_JSON_XPATH:
- case FreshRSS_Feed::KIND_JSONFEED:
- return CACHE_PATH . '/' . $filename . '.json';
- case FreshRSS_Feed::KIND_RSS:
- case FreshRSS_Feed::KIND_RSS_FORCED:
- default:
- return CACHE_PATH . '/' . $filename . '.spc';
- }
- }
- private function faviconRebuild(): void {
- if ($this->customFavicon()) {
- return;
- }
- FreshRSS_Feed::faviconDelete($this->hashFavicon());
- $this->faviconPrepare(true);
- }
- public function clearCache(): bool {
- $this->faviconRebuild();
- return @unlink($this->cacheFilename());
- }
- /** @return int|false */
- public function cacheModifiedTime(): int|false {
- $filename = $this->cacheFilename();
- clearstatcache(true, $filename);
- return @filemtime($filename);
- }
- public function lock(): bool {
- $this->lockPath = TMP_PATH . '/' . $this->hash() . '.freshrss.lock';
- if (file_exists($this->lockPath) && ((time() - (@filemtime($this->lockPath) ?: 0)) > 3600)) {
- @unlink($this->lockPath);
- }
- if (($handle = @fopen($this->lockPath, 'x')) === false) {
- return false;
- }
- //register_shutdown_function('unlink', $this->lockPath);
- @fclose($handle);
- return true;
- }
- public function unlock(): bool {
- return @unlink($this->lockPath);
- }
- //<WebSub>
- public function pubSubHubbubEnabled(): bool {
- $url = $this->selfUrl ?: $this->url;
- $hubFilename = PSHB_PATH . '/feeds/' . sha1($url) . '/!hub.json';
- if (($hubFile = @file_get_contents($hubFilename)) != false) {
- $hubJson = json_decode($hubFile, true);
- if (is_array($hubJson) && empty($hubJson['error']) &&
- (empty($hubJson['lease_end']) || $hubJson['lease_end'] > time())) {
- return true;
- }
- }
- return false;
- }
- public function pubSubHubbubError(bool $error = true): bool {
- $url = $this->selfUrl ?: $this->url;
- $hubFilename = PSHB_PATH . '/feeds/' . sha1($url) . '/!hub.json';
- $hubFile = @file_get_contents($hubFilename);
- $hubJson = is_string($hubFile) ? json_decode($hubFile, true) : null;
- if (is_array($hubJson) && (!isset($hubJson['error']) || $hubJson['error'] !== $error)) {
- $hubJson['error'] = $error;
- file_put_contents($hubFilename, json_encode($hubJson));
- Minz_Log::warning('Set error to ' . ($error ? 1 : 0) . ' for ' . $url, PSHB_LOG);
- }
- return false;
- }
- public function pubSubHubbubPrepare(): string|false {
- $key = '';
- if (Minz_Request::serverIsPublic(FreshRSS_Context::systemConf()->base_url) &&
- $this->hubUrl !== '' && $this->selfUrl !== '' && @is_dir(PSHB_PATH)) {
- $path = PSHB_PATH . '/feeds/' . sha1($this->selfUrl);
- $hubFilename = $path . '/!hub.json';
- if (($hubFile = @file_get_contents($hubFilename)) != false) {
- $hubJson = json_decode($hubFile, true);
- if (!is_array($hubJson) || empty($hubJson['key']) || !is_string($hubJson['key']) || !ctype_xdigit($hubJson['key'])) {
- $text = 'Invalid JSON for WebSub: ' . $this->url;
- Minz_Log::warning($text);
- Minz_Log::warning($text, PSHB_LOG);
- return false;
- }
- if (!empty($hubJson['lease_end']) && is_int($hubJson['lease_end']) && $hubJson['lease_end'] < (time() + (3600 * 23))) { //TODO: Make a better policy
- $text = 'WebSub lease ends at '
- . date('c', empty($hubJson['lease_end']) ? time() : $hubJson['lease_end'])
- . ' and needs renewal: ' . $this->url;
- Minz_Log::warning($text);
- Minz_Log::warning($text, PSHB_LOG);
- $key = $hubJson['key']; //To renew our lease
- } elseif (((!empty($hubJson['error'])) || empty($hubJson['lease_end'])) &&
- (empty($hubJson['lease_start']) || $hubJson['lease_start'] < time() - (3600 * 23))) { //Do not renew too often
- $key = $hubJson['key']; //To renew our lease
- }
- } else {
- @mkdir($path, 0770, true);
- $key = sha1($path . FreshRSS_Context::systemConf()->salt);
- $hubJson = [
- 'hub' => $this->hubUrl,
- 'key' => $key,
- ];
- file_put_contents($hubFilename, json_encode($hubJson));
- @mkdir(PSHB_PATH . '/keys/', 0770, true);
- file_put_contents(PSHB_PATH . '/keys/' . $key . '.txt', $this->selfUrl);
- $text = 'WebSub prepared for ' . $this->url;
- Minz_Log::debug($text);
- Minz_Log::debug($text, PSHB_LOG);
- }
- $currentUser = Minz_User::name() ?? '';
- if (FreshRSS_user_Controller::checkUsername($currentUser) && !file_exists($path . '/' . $currentUser . '.txt')) {
- touch($path . '/' . $currentUser . '.txt');
- }
- }
- return $key;
- }
- //Parameter true to subscribe, false to unsubscribe.
- public function pubSubHubbubSubscribe(bool $state): bool {
- if ($state) {
- $url = $this->selfUrl ?: $this->url;
- } else {
- $url = $this->url; //Always use current URL during unsubscribe
- }
- if ($url !== '' && (Minz_Request::serverIsPublic(FreshRSS_Context::systemConf()->base_url) || !$state)) {
- $hubFilename = PSHB_PATH . '/feeds/' . sha1($url) . '/!hub.json';
- $hubFile = @file_get_contents($hubFilename);
- if ($hubFile === false) {
- Minz_Log::warning('JSON not found for WebSub: ' . $this->url);
- return false;
- }
- $hubJson = json_decode($hubFile, true);
- if (!is_array($hubJson) || empty($hubJson['key']) || !is_string($hubJson['key']) || !ctype_xdigit($hubJson['key']) ||
- empty($hubJson['hub']) || !is_string($hubJson['hub'])) {
- Minz_Log::warning('Invalid JSON for WebSub: ' . $this->url);
- return false;
- }
- $callbackUrl = checkUrl(Minz_Request::getBaseUrl() . '/api/pshb.php?k=' . $hubJson['key']);
- if ($callbackUrl == '') {
- Minz_Log::warning('Invalid callback for WebSub: ' . $this->url);
- return false;
- }
- if (!$state) { //unsubscribe
- $hubJson['lease_end'] = time() - 60;
- file_put_contents($hubFilename, json_encode($hubJson));
- }
- $ch = curl_init();
- if ($ch === false) {
- Minz_Log::warning('curl_init() failed in ' . __METHOD__);
- return false;
- }
- curl_setopt_array($ch, [
- CURLOPT_URL => $hubJson['hub'],
- CURLOPT_RETURNTRANSFER => true,
- CURLOPT_POSTFIELDS => http_build_query([
- 'hub.verify' => 'sync',
- 'hub.mode' => $state ? 'subscribe' : 'unsubscribe',
- 'hub.topic' => $url,
- 'hub.callback' => $callbackUrl,
- ]),
- CURLOPT_USERAGENT => FRESHRSS_USERAGENT,
- CURLOPT_MAXREDIRS => 10,
- CURLOPT_FOLLOWLOCATION => true,
- CURLOPT_ENCODING => '', //Enable all encodings
- //CURLOPT_VERBOSE => 1, // To debug sent HTTP headers
- ]);
- $response = curl_exec($ch);
- $info = curl_getinfo($ch);
- if (!is_array($info)) {
- Minz_Log::warning('curl_getinfo() failed in ' . __METHOD__);
- return false;
- }
- Minz_Log::warning('WebSub ' . ($state ? 'subscribe' : 'unsubscribe') . ' to ' . $url .
- ' via hub ' . $hubJson['hub'] .
- ' with callback ' . $callbackUrl . ': ' . $info['http_code'] . ' ' . $response, PSHB_LOG);
- if (str_starts_with('' . $info['http_code'], '2')) {
- return true;
- } else {
- $hubJson['lease_start'] = time(); //Prevent trying again too soon
- $hubJson['error'] = true;
- file_put_contents($hubFilename, json_encode($hubJson));
- return false;
- }
- }
- return false;
- }
- //</WebSub>
- }
|