Feed.php 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441
  1. <?php
  2. declare(strict_types=1);
  3. class FreshRSS_Feed extends Minz_Model {
  4. use FreshRSS_AttributesTrait, FreshRSS_FilterActionsTrait;
  5. /**
  6. * Normal RSS or Atom feed
  7. * @var int
  8. */
  9. public const KIND_RSS = 0;
  10. /**
  11. * Invalid RSS or Atom feed
  12. * @var int
  13. */
  14. public const KIND_RSS_FORCED = 2;
  15. /**
  16. * Normal HTML with XPath scraping
  17. * @var int
  18. */
  19. public const KIND_HTML_XPATH = 10;
  20. /**
  21. * Normal XML with XPath scraping
  22. * @var int
  23. */
  24. public const KIND_XML_XPATH = 15;
  25. /**
  26. * Normal JSON with XPath scraping
  27. * @var int
  28. */
  29. public const KIND_JSON_XPATH = 20;
  30. public const KIND_JSONFEED = 25;
  31. public const KIND_JSON_DOTNOTATION = 30;
  32. /** JSON embedded in HTML */
  33. public const KIND_HTML_XPATH_JSON_DOTNOTATION = 35;
  34. public const PRIORITY_IMPORTANT = 20;
  35. public const PRIORITY_MAIN_STREAM = 10;
  36. public const PRIORITY_CATEGORY = 0;
  37. public const PRIORITY_FEED = -5;
  38. public const PRIORITY_HIDDEN = -10;
  39. /** @deprecated use PRIORITY_HIDDEN instead */
  40. public const PRIORITY_ARCHIVED = -10;
  41. public const TTL_DEFAULT = 0;
  42. public const ARCHIVING_RETENTION_COUNT_LIMIT = 10000;
  43. public const ARCHIVING_RETENTION_PERIOD = 'P3M';
  44. private int $id = 0;
  45. private string $url = '';
  46. private int $kind = 0;
  47. private int $categoryId = 0;
  48. private ?FreshRSS_Category $category = null;
  49. private int $nbEntries = -1;
  50. private int $nbNotRead = -1;
  51. private string $name = '';
  52. private string $website = '';
  53. private string $description = '';
  54. private int $lastUpdate = 0;
  55. private int $priority = self::PRIORITY_MAIN_STREAM;
  56. private string $pathEntries = '';
  57. private string $httpAuth = '';
  58. private bool $error = false;
  59. private int $ttl = self::TTL_DEFAULT;
  60. private bool $mute = false;
  61. private string $hash = '';
  62. private string $hashFavicon = '';
  63. private string $lockPath = '';
  64. private string $hubUrl = '';
  65. private string $selfUrl = '';
  66. /**
  67. * @throws FreshRSS_BadUrl_Exception
  68. */
  69. public function __construct(string $url, bool $validate = true) {
  70. if ($validate) {
  71. $this->_url($url);
  72. } else {
  73. $this->url = $url;
  74. }
  75. }
  76. public static function default(): FreshRSS_Feed {
  77. $f = new FreshRSS_Feed('http://example.net/', false);
  78. $f->faviconPrepare();
  79. return $f;
  80. }
  81. public function id(): int {
  82. return $this->id;
  83. }
  84. public function hash(): string {
  85. if ($this->hash == '') {
  86. $salt = FreshRSS_Context::systemConf()->salt;
  87. $params = $this->url . $this->proxyParam();
  88. $this->hash = sha1($salt . $params);
  89. }
  90. return $this->hash;
  91. }
  92. public function resetFaviconHash(): void {
  93. $this->hashFavicon(skipCache: true);
  94. }
  95. public function proxyParam(): string {
  96. $curl_params = $this->attributeArray('curl_params');
  97. if (is_array($curl_params)) {
  98. // Content provided through a proxy may be completely different
  99. return is_string($curl_params[CURLOPT_PROXY] ?? null) ? $curl_params[CURLOPT_PROXY] : '';
  100. }
  101. return '';
  102. }
  103. /**
  104. * Resets the custom favicon to the default one. Also deletes the favicon when allowed by extension.
  105. *
  106. * @param array{'url'?:string,'kind'?:int,'category'?:int,'name'?:string,'website'?:string,'description'?:string,'lastUpdate'?:int,'priority'?:int,
  107. * 'pathEntries'?:string,'httpAuth'?:string,'error'?:int,'ttl'?:int,'attributes'?:string|array<string,mixed>} &$values &$values
  108. *
  109. * @param bool $updateFeed Whether `updateFeed()` should be called immediately. If false, it must be handled manually.
  110. *
  111. * @return void
  112. *
  113. * @throws FreshRSS_Feed_Exception
  114. */
  115. public function resetCustomFavicon(?array &$values = null, bool $updateFeed = true) {
  116. if (!$this->customFavicon()) {
  117. return;
  118. }
  119. if (!$this->attributeBoolean('customFaviconDisallowDel')) {
  120. FreshRSS_Feed::faviconDelete($this->hashFavicon());
  121. }
  122. $this->_attribute('customFavicon', false);
  123. $this->_attribute('customFaviconExt', null);
  124. $this->_attribute('customFaviconDisallowDel', false);
  125. if ($values !== null) {
  126. $values['attributes'] = $this->attributes();
  127. $feedDAO = FreshRSS_Factory::createFeedDao();
  128. if ($updateFeed && !$feedDAO->updateFeed($this->id(), $values)) {
  129. throw new FreshRSS_Feed_Exception();
  130. }
  131. }
  132. $this->resetFaviconHash();
  133. }
  134. /**
  135. * Set a custom favicon for the feed.
  136. *
  137. * @param string $contents Contents of the favicon file. Optional if $tmpPath is set.
  138. * @param string $tmpPath Use only when handling file uploads. (value from `tmp_name` goes here)
  139. *
  140. * @param array{'url'?:string,'kind'?:int,'category'?:int,'name'?:string,'website'?:string,'description'?:string,'lastUpdate'?:int,'priority'?:int,
  141. * 'pathEntries'?:string,'httpAuth'?:string,'error'?:int,'ttl'?:int,'attributes'?:string|array<string,mixed>} &$values &$values
  142. *
  143. * @param bool $updateFeed Whether `updateFeed()` should be called immediately. If false, it must be handled manually.
  144. * @param string $extName The extension name of the calling extension.
  145. * @param bool $disallowDelete Whether the icon can be later deleted when it's being reset. Intended for use by extensions.
  146. * @param bool $overrideCustomIcon Whether a custom favicon set by a user can be overridden.
  147. *
  148. * @return string|null Path where the favicon can be found. Useful for checking if the favicon already exists, before downloading it for example.
  149. *
  150. * @throws FreshRSS_UnsupportedImageFormat_Exception
  151. * @throws FreshRSS_Feed_Exception
  152. */
  153. public function setCustomFavicon(
  154. ?string $contents = null,
  155. string $tmpPath = '',
  156. ?array &$values = null,
  157. bool $updateFeed = true,
  158. ?string $extName = null,
  159. bool $disallowDelete = false,
  160. bool $overrideCustomIcon = false
  161. ): ?string {
  162. if ($contents === null && $tmpPath !== '') {
  163. $contents = file_get_contents($tmpPath);
  164. }
  165. $attributesOnly = $contents === null && $tmpPath === '';
  166. require_once LIB_PATH . '/favicons.php';
  167. if (!$attributesOnly && !isImgMime(is_string($contents) ? $contents : '')) {
  168. throw new FreshRSS_UnsupportedImageFormat_Exception();
  169. }
  170. $oldHash = '';
  171. $oldDisallowDelete = false;
  172. if ($this->customFavicon()) {
  173. /* If $overrideCustomFavicon is true, custom favicons set by extensions can be overridden,
  174. * but not ones explicitly set by the user */
  175. if (!$overrideCustomIcon && $this->customFaviconExt() === null) {
  176. return null;
  177. }
  178. $oldHash = $this->hashFavicon(skipCache: true);
  179. $oldDisallowDelete = $this->attributeBoolean('customFaviconDisallowDel');
  180. }
  181. $this->_attribute('customFavicon', true);
  182. $this->_attribute('customFaviconExt', $extName);
  183. $this->_attribute('customFaviconDisallowDel', $disallowDelete);
  184. $newPath = FAVICONS_DIR . $this->hashFavicon(skipCache: true) . '.ico';
  185. if ($attributesOnly && !file_exists($newPath)) {
  186. $updateFeed = false;
  187. }
  188. if ($values !== null) {
  189. $values['attributes'] = $this->attributes();
  190. $feedDAO = FreshRSS_Factory::createFeedDao();
  191. if ($updateFeed && !$feedDAO->updateFeed($this->id(), $values)) {
  192. throw new FreshRSS_Feed_Exception();
  193. }
  194. }
  195. if ($tmpPath !== '') {
  196. move_uploaded_file($tmpPath, $newPath);
  197. } elseif ($contents !== null) {
  198. file_put_contents($newPath, $contents);
  199. }
  200. if ($oldHash !== '' && !$oldDisallowDelete) {
  201. FreshRSS_Feed::faviconDelete($oldHash);
  202. }
  203. return $newPath;
  204. }
  205. /**
  206. * Checks if the feed has a custom favicon set by an extension.
  207. * Additionally, it also checks if the extension that set the icon is still enabled
  208. * And if not, it resets attributes related to custom favicons.
  209. *
  210. * @return string|null The name of the extension that set the icon.
  211. */
  212. public function customFaviconExt(): ?string {
  213. $customFaviconExt = $this->attributeString('customFaviconExt');
  214. if ($customFaviconExt !== null && !Minz_ExtensionManager::isExtensionEnabled($customFaviconExt)) {
  215. $this->_attribute('customFavicon', false);
  216. $this->_attribute('customFaviconExt', null);
  217. $this->_attribute('customFaviconDisallowDel', false);
  218. $customFaviconExt = null;
  219. }
  220. return $customFaviconExt;
  221. }
  222. public function customFavicon(): bool {
  223. $this->customFaviconExt();
  224. return $this->attributeBoolean('customFavicon') ?? false;
  225. }
  226. public function hashFavicon(bool $skipCache = false): string {
  227. if ($this->hashFavicon == '' || $skipCache) {
  228. $salt = FreshRSS_Context::systemConf()->salt;
  229. $params = '';
  230. if ($this->customFavicon()) {
  231. $current = $this->id . Minz_User::name();
  232. $hookParams = Minz_ExtensionManager::callHook(Minz_HookType::CustomFaviconHash, $this);
  233. $params = $hookParams !== null ? $hookParams : $current;
  234. } else {
  235. $params = $this->website(fallback: true) . $this->proxyParam();
  236. }
  237. $this->hashFavicon = hash('crc32b', $salt . (is_string($params) ? $params : ''));
  238. }
  239. return $this->hashFavicon;
  240. }
  241. public function url(bool $includeCredentials = true): string {
  242. return $includeCredentials ? $this->url : \SimplePie\Misc::url_remove_credentials($this->url);
  243. }
  244. public function selfUrl(): string {
  245. return $this->selfUrl;
  246. }
  247. public function kind(): int {
  248. return $this->kind;
  249. }
  250. public function hubUrl(): string {
  251. return $this->hubUrl;
  252. }
  253. public function category(): ?FreshRSS_Category {
  254. if ($this->category === null && $this->categoryId > 0) {
  255. $catDAO = FreshRSS_Factory::createCategoryDao();
  256. $this->category = $catDAO->searchById($this->categoryId);
  257. }
  258. return $this->category;
  259. }
  260. public function categoryId(): int {
  261. return $this->category?->id() ?: $this->categoryId;
  262. }
  263. public function name(bool $raw = false): string {
  264. return $raw || $this->name != '' ? $this->name : (preg_replace('%^https?://(www[.])?%i', '', $this->url) ?? '');
  265. }
  266. /**
  267. * @param bool $fallback true to return the URL of the feed if the Web site is blank
  268. * @return string HTML-encoded URL of the Web site of the feed
  269. */
  270. public function website(bool $fallback = false): string {
  271. $url = $this->website;
  272. if ($fallback && !preg_match('%^https?://.%i', $url)) {
  273. $url = $this->url;
  274. }
  275. return $url;
  276. }
  277. public function description(): string {
  278. return $this->description;
  279. }
  280. public function lastUpdate(): int {
  281. return $this->lastUpdate;
  282. }
  283. public function priority(): int {
  284. return $this->priority;
  285. }
  286. /** @return string HTML-encoded CSS selector */
  287. public function pathEntries(): string {
  288. return $this->pathEntries;
  289. }
  290. /**
  291. * @phpstan-return ($raw is true ? string : array{'username':string,'password':string})
  292. * @return array{'username':string,'password':string}|string
  293. */
  294. public function httpAuth(bool $raw = true): array|string {
  295. if ($raw) {
  296. return $this->httpAuth;
  297. } else {
  298. $pos_colon = strpos($this->httpAuth, ':');
  299. if ($pos_colon !== false) {
  300. $user = substr($this->httpAuth, 0, $pos_colon);
  301. $pass = substr($this->httpAuth, $pos_colon + 1);
  302. } else {
  303. $user = '';
  304. $pass = '';
  305. }
  306. return [
  307. 'username' => $user,
  308. 'password' => $pass,
  309. ];
  310. }
  311. }
  312. /** @return array<int,mixed> */
  313. public function curlOptions(): array {
  314. $curl_options = [];
  315. if ($this->httpAuth !== '') {
  316. $curl_options[CURLOPT_USERPWD] = htmlspecialchars_decode($this->httpAuth, ENT_QUOTES);
  317. }
  318. return $curl_options;
  319. }
  320. public function inError(): bool {
  321. return $this->error;
  322. }
  323. /**
  324. * @param bool $raw true for database version combined with mute information, false otherwise
  325. */
  326. public function ttl(bool $raw = false): int {
  327. if ($raw) {
  328. $ttl = $this->ttl;
  329. if ($this->mute && FreshRSS_Feed::TTL_DEFAULT === $ttl) {
  330. $ttl = FreshRSS_Context::userConf()->ttl_default;
  331. }
  332. return $ttl * ($this->mute ? -1 : 1);
  333. }
  334. if ($this->mute && $this->ttl === FreshRSS_Context::userConf()->ttl_default) {
  335. return FreshRSS_Feed::TTL_DEFAULT;
  336. }
  337. return $this->ttl;
  338. }
  339. public function mute(): bool {
  340. return $this->mute;
  341. }
  342. public function nbEntries(): int {
  343. if ($this->nbEntries < 0) {
  344. $feedDAO = FreshRSS_Factory::createFeedDao();
  345. $this->nbEntries = $feedDAO->countEntries($this->id());
  346. }
  347. return $this->nbEntries;
  348. }
  349. public function nbNotRead(): int {
  350. if ($this->nbNotRead < 0) {
  351. $feedDAO = FreshRSS_Factory::createFeedDao();
  352. $this->nbNotRead = $feedDAO->countNotRead($this->id());
  353. }
  354. return $this->nbNotRead;
  355. }
  356. public function faviconPrepare(bool $force = false): void {
  357. require_once LIB_PATH . '/favicons.php';
  358. if ($this->customFavicon()) {
  359. return;
  360. }
  361. $url = $this->website(fallback: false);
  362. if ($url === '' || $url === $this->url) {
  363. // Get root URL from the feed URL
  364. $url = preg_replace('%^(https?://[^/]+).*$%i', '$1/', $this->url) ?? $this->url;
  365. }
  366. $txt = FAVICONS_DIR . $this->hashFavicon() . '.txt';
  367. if (@file_get_contents($txt) !== $url) {
  368. file_put_contents($txt, $url);
  369. }
  370. if (FreshRSS_Context::$isCli || $force) {
  371. $ico = FAVICONS_DIR . $this->hashFavicon() . '.ico';
  372. $ico_mtime = @filemtime($ico);
  373. $txt_mtime = @filemtime($txt);
  374. if ($txt_mtime != false &&
  375. ($ico_mtime == false || $ico_mtime < $txt_mtime || ($ico_mtime < time() - (14 * 86400)))) {
  376. // no ico file or we should download a new one.
  377. $url = file_get_contents($txt);
  378. if ($url == false || !download_favicon($url, $ico)) {
  379. touch($ico);
  380. }
  381. }
  382. }
  383. }
  384. public static function faviconDelete(string $hash): void {
  385. if (!ctype_xdigit($hash)) {
  386. return;
  387. }
  388. $path = DATA_PATH . '/favicons/' . $hash;
  389. @unlink($path . '.ico');
  390. @unlink($path . '.txt');
  391. }
  392. public function favicon(bool $absolute = false): string {
  393. $hash = $this->hashFavicon();
  394. $url = '/f.php?h=' . $hash;
  395. if ($this->customFavicon()
  396. // when the below attribute is set, icon won't be changing frequently so cache buster is not needed
  397. && !$this->attributeBoolean('customFaviconDisallowDel')) {
  398. $url .= '&t=' . @filemtime(DATA_PATH . '/favicons/' . $hash . '.ico');
  399. }
  400. return Minz_Url::display($url, absolute: $absolute);
  401. }
  402. public function _id(int $value): void {
  403. $this->id = $value;
  404. }
  405. /**
  406. * @throws FreshRSS_BadUrl_Exception
  407. */
  408. public function _url(string $value, bool $validate = true): void {
  409. $this->hash = '';
  410. $this->hashFavicon = '';
  411. $url = $value;
  412. if ($validate) {
  413. $url = FreshRSS_http_Util::checkUrl($url);
  414. }
  415. if ($url == false) {
  416. throw new FreshRSS_BadUrl_Exception($value);
  417. }
  418. $this->url = $url;
  419. }
  420. public function _selfUrl(string $value): void {
  421. $this->selfUrl = $value;
  422. }
  423. public function _kind(int $value): void {
  424. $this->kind = $value;
  425. }
  426. public function _category(?FreshRSS_Category $cat): void {
  427. $this->category = $cat;
  428. $this->categoryId = $this->category == null ? 0 : $this->category->id();
  429. }
  430. /** @param int|numeric-string $id */
  431. public function _categoryId(int|string $id): void {
  432. $this->category = null;
  433. $this->categoryId = (int)$id;
  434. }
  435. public function _name(string $value): void {
  436. $this->name = $value == '' ? '' : trim($value);
  437. }
  438. public function _website(string $value, bool $validate = true): void {
  439. $this->hashFavicon = '';
  440. if ($validate) {
  441. $value = FreshRSS_http_Util::checkUrl($value);
  442. }
  443. if ($value == false) {
  444. $value = '';
  445. }
  446. $this->website = $value;
  447. }
  448. public function _description(string $value): void {
  449. $this->description = $value == '' ? '' : $value;
  450. }
  451. /**
  452. * @param int|numeric-string $value
  453. * 32-bit systems provide a string and will fail in year 2038
  454. */
  455. public function _lastUpdate(int|string $value): void {
  456. $this->lastUpdate = (int)$value;
  457. }
  458. public function _priority(int $value): void {
  459. $this->priority = $value;
  460. }
  461. /** @param string $value HTML-encoded CSS selector */
  462. public function _pathEntries(string $value): void {
  463. $this->pathEntries = $value;
  464. }
  465. public function _httpAuth(string $value): void {
  466. $this->httpAuth = $value;
  467. }
  468. public function _error(bool|int $value): void {
  469. $this->error = (bool)$value;
  470. }
  471. public function _mute(bool $value): void {
  472. $this->mute = $value;
  473. }
  474. public function _ttl(int $value): void {
  475. $value = min($value, 100_000_000);
  476. $this->ttl = abs($value);
  477. $this->mute = $value < self::TTL_DEFAULT;
  478. }
  479. public function _nbNotRead(int $value): void {
  480. $this->nbNotRead = $value;
  481. }
  482. public function _nbEntries(int $value): void {
  483. $this->nbEntries = $value;
  484. }
  485. /**
  486. * @throws Minz_FileNotExistException
  487. * @throws FreshRSS_Feed_Exception
  488. */
  489. public function load(bool $loadDetails = false, bool $noCache = false): ?FreshRSS_SimplePieCustom {
  490. if ($this->url != '') {
  491. /**
  492. * @throws Minz_FileNotExistException
  493. */
  494. if (trim(CACHE_PATH) === '') {
  495. throw new Minz_FileNotExistException(
  496. 'CACHE_PATH',
  497. Minz_Exception::ERROR
  498. );
  499. } else {
  500. if (($retryAfter = FreshRSS_http_Util::getRetryAfter($this->url, $this->proxyParam())) > 0) {
  501. throw new FreshRSS_Feed_Exception('For that domain, will first retry after ' . date('c', $retryAfter) .
  502. '. ' . $this->url(includeCredentials: false), code: 503);
  503. }
  504. $simplePie = new FreshRSS_SimplePieCustom($this->attributes(), $this->curlOptions());
  505. $url = htmlspecialchars_decode($this->url, ENT_QUOTES);
  506. if (str_ends_with($url, '#force_feed')) {
  507. $simplePie->force_feed(true);
  508. $url = substr($url, 0, -11);
  509. }
  510. $simplePie->set_feed_url($url);
  511. if (!$loadDetails) { //Only activates auto-discovery when adding a new feed
  512. $simplePie->set_autodiscovery_level(\SimplePie\SimplePie::LOCATOR_NONE);
  513. }
  514. if ($this->attributeBoolean('clear_cache')) {
  515. // Do not use `$simplePie->enable_cache(false);` as it would prevent caching in multiuser context
  516. $this->clearCache();
  517. }
  518. Minz_ExtensionManager::callHook(Minz_HookType::SimplepieBeforeInit, $simplePie, $this);
  519. $simplePieResult = $simplePie->init();
  520. Minz_ExtensionManager::callHook(Minz_HookType::SimplepieAfterInit, $simplePie, $this, $simplePieResult);
  521. if ($simplePieResult === false || $simplePie->get_hash() === '' || !empty($simplePie->error())) {
  522. if ($simplePie->status_code() === 429) {
  523. $errorMessage = 'HTTP 429 Too Many Requests!';
  524. } elseif ($simplePie->status_code() === 503) {
  525. $errorMessage = 'HTTP 503 Service Unavailable!';
  526. } else {
  527. $errorMessage = $simplePie->error();
  528. if (empty($errorMessage)) {
  529. $errorMessage = '';
  530. } elseif (is_array($errorMessage)) {
  531. $errorMessage = json_encode($errorMessage, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_LINE_TERMINATORS) ?: '';
  532. }
  533. }
  534. throw new FreshRSS_Feed_Exception(
  535. ($errorMessage == '' ? 'Unknown error for feed' : $errorMessage) .
  536. ' [' . $this->url(includeCredentials: false) . ']',
  537. $simplePie->status_code()
  538. );
  539. }
  540. $links = $simplePie->get_links('self');
  541. $this->selfUrl = empty($links[0]) ? '' : (FreshRSS_http_Util::checkUrl($links[0]) ?: '');
  542. $links = $simplePie->get_links('hub');
  543. $this->hubUrl = empty($links[0]) ? '' : (FreshRSS_http_Util::checkUrl($links[0]) ?: '');
  544. if ($loadDetails) {
  545. // si on a utilisé l’auto-discover, notre url va avoir changé
  546. $subscribe_url = $simplePie->subscribe_url(false) ?? '';
  547. if ($this->name(true) === '') {
  548. //HTML to HTML-PRE //ENT_COMPAT except '&'
  549. $title = strtr(html_only_entity_decode($simplePie->get_title()), ['<' => '&lt;', '>' => '&gt;', '"' => '&quot;']);
  550. $this->_name($title == '' ? $this->url : $title);
  551. }
  552. if ($this->website() === '') {
  553. $this->_website(html_only_entity_decode($simplePie->get_link()));
  554. }
  555. if ($this->description() === '') {
  556. $this->_description(html_only_entity_decode($simplePie->get_description()));
  557. }
  558. } else {
  559. //The case of HTTP 301 Moved Permanently
  560. $subscribe_url = $simplePie->subscribe_url(true) ?? '';
  561. }
  562. $clean_url = \SimplePie\Misc::url_remove_credentials($subscribe_url);
  563. if ($subscribe_url !== '' && $subscribe_url !== $url) {
  564. $this->_url($clean_url);
  565. }
  566. if ($noCache || $simplePie->get_hash() !== $this->attributeString('SimplePieHash')) {
  567. // syslog(LOG_DEBUG, 'FreshRSS no cache ' . $simplePie->get_hash() . ' !== ' . $this->attributeString('SimplePieHash') . ' for ' . $clean_url);
  568. $this->_attribute('SimplePieHash', $simplePie->get_hash());
  569. return $simplePie;
  570. }
  571. syslog(LOG_DEBUG, 'FreshRSS SimplePie uses cache for ' . $clean_url);
  572. }
  573. }
  574. return null;
  575. }
  576. /**
  577. * Decide the GUID of an entry based on the feed’s policy.
  578. * @param \SimplePie\Item $item The item to decide the GUID for.
  579. * @param bool $fallback Whether to automatically switch to the next policy in case of blank GUID.
  580. * @return string The decided GUID for the entry.
  581. */
  582. protected function decideEntryGuid(\SimplePie\Item $item, bool $fallback = false): string {
  583. $unicityCriteria = $this->attributeString('unicityCriteria');
  584. if ($this->attributeBoolean('hasBadGuids')) { // Legacy
  585. $unicityCriteria = 'link';
  586. }
  587. $entryId = safe_ascii($item->get_id(false, false));
  588. $guid = match ($unicityCriteria) {
  589. null => $entryId,
  590. 'link' => $item->get_permalink() ?? '',
  591. 'sha1:link_published' => sha1($item->get_permalink() . $item->get_date('U')),
  592. 'sha1:link_published_title' => sha1($item->get_permalink() . $item->get_date('U') . $item->get_title()),
  593. 'sha1:link_published_title_content' => sha1($item->get_permalink() . $item->get_date('U') . $item->get_title() . $item->get_content()),
  594. 'sha1:title' => sha1($item->get_title() ?? ''),
  595. 'sha1:title_published' => sha1($item->get_title() . $item->get_date('U')),
  596. 'sha1:title_published_content' => sha1($item->get_title() . $item->get_date('U') . $item->get_content()),
  597. 'sha1:content' => sha1($item->get_content() ?? ''),
  598. 'sha1:content_published' => sha1($item->get_content() . $item->get_date('U')),
  599. 'sha1:published' => sha1((string)($item->get_date('U') ?? '')),
  600. default => $entryId,
  601. };
  602. $blankHash = 'da39a3ee5e6b4b0d3255bfef95601890afd80709'; // sha1('')
  603. if ($guid === $blankHash) {
  604. $guid = '';
  605. }
  606. if ($fallback && $guid === '') {
  607. if ($entryId !== '') {
  608. $guid = $entryId;
  609. } elseif (($item->get_permalink() ?? '') !== '') {
  610. $guid = sha1($item->get_permalink() . $item->get_date('U'));
  611. } elseif (($item->get_title() ?? '') !== '') {
  612. $guid = sha1($item->get_permalink() . $item->get_date('U') . $item->get_title());
  613. } else {
  614. $guid = sha1($item->get_permalink() . $item->get_date('U') . $item->get_title() . $item->get_content());
  615. }
  616. if ($guid === $blankHash) {
  617. $guid = '';
  618. }
  619. }
  620. return $guid;
  621. }
  622. /**
  623. * @param float $invalidGuidsTolerance (default 0.05) The maximum ratio (rounded) of invalid GUIDs to tolerate before degrading the unicity criteria.
  624. * 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.
  625. * 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.
  626. * @return list<string>
  627. */
  628. public function loadGuids(FreshRSS_SimplePieCustom $simplePie, float $invalidGuidsTolerance = 0.05): array {
  629. $invalidGuids = 0;
  630. $testGuids = [];
  631. $guids = [];
  632. $items = $simplePie->get_items();
  633. if (empty($items)) {
  634. return $guids;
  635. }
  636. for ($i = count($items) - 1; $i >= 0; $i--) {
  637. $item = $items[$i];
  638. if ($item == null) {
  639. continue;
  640. }
  641. $guid = $this->decideEntryGuid($item, fallback: true);
  642. if ($guid === '' || !empty($testGuids['_' . $guid])) {
  643. $invalidGuids++;
  644. Minz_Log::debug('Invalid GUID [' . $guid . '] for feed ' . $this->url);
  645. }
  646. $testGuids['_' . $guid] = true;
  647. $guids[] = $guid;
  648. }
  649. if ($invalidGuids > 0) {
  650. Minz_Log::warning("Feed has {$invalidGuids} invalid GUIDs: " . $this->url(includeCredentials: false));
  651. if (!$this->attributeBoolean('unicityCriteriaForced') && $invalidGuids > round($invalidGuidsTolerance * count($items))) {
  652. $unicityCriteria = $this->attributeString('unicityCriteria');
  653. if ($this->attributeBoolean('hasBadGuids')) { // Legacy
  654. $unicityCriteria = 'link';
  655. }
  656. // Automatic fallback to next (degraded) unicity criteria
  657. $newUnicityCriteria = match ($unicityCriteria) {
  658. null => 'sha1:link_published',
  659. 'link' => 'sha1:link_published',
  660. 'sha1:link_published' => 'sha1:link_published_title',
  661. default => $unicityCriteria,
  662. };
  663. if ($newUnicityCriteria !== $unicityCriteria) {
  664. $this->_attribute('hasBadGuids', null); // Remove legacy
  665. $this->_attribute('unicityCriteria', $newUnicityCriteria);
  666. Minz_Log::warning('Feed unicity policy degraded (' . ($unicityCriteria ?: 'id') . ' → ' . $newUnicityCriteria . '): ' .
  667. $this->url(includeCredentials: false));
  668. return $this->loadGuids($simplePie, $invalidGuidsTolerance);
  669. }
  670. }
  671. $this->_error(true);
  672. }
  673. return $guids;
  674. }
  675. /** @return Traversable<FreshRSS_Entry> */
  676. public function loadEntries(FreshRSS_SimplePieCustom $simplePie): Traversable {
  677. $items = $simplePie->get_items();
  678. if (empty($items)) {
  679. return;
  680. }
  681. // We want chronological order and SimplePie uses reverse order.
  682. for ($i = count($items) - 1; $i >= 0; $i--) {
  683. $item = $items[$i];
  684. if ($item == null) {
  685. continue;
  686. }
  687. $title = html_only_entity_decode(strip_tags($item->get_title() ?? ''));
  688. $authors = $item->get_authors();
  689. $link = $item->get_permalink();
  690. $date = $item->get_date('U');
  691. if (!is_numeric($date)) {
  692. $date = 0;
  693. }
  694. //Tag processing (tag == category)
  695. $categories = $item->get_categories();
  696. $tags = [];
  697. if (is_array($categories)) {
  698. foreach ($categories as $category) {
  699. $text = html_only_entity_decode($category->get_label());
  700. //Some feeds use a single category with comma-separated tags
  701. $labels = explode(',', $text);
  702. if (!empty($labels)) {
  703. foreach ($labels as $label) {
  704. $tags[] = trim($label);
  705. }
  706. }
  707. }
  708. $tags = array_unique($tags);
  709. }
  710. $content = html_only_entity_decode($item->get_content());
  711. $attributeThumbnail = $item->get_thumbnail() ?? [];
  712. if (empty($attributeThumbnail['url'])) {
  713. $attributeThumbnail['url'] = '';
  714. }
  715. $attributeEnclosures = [];
  716. if (!empty($item->get_enclosures())) {
  717. foreach ($item->get_enclosures() as $enclosure) {
  718. $elink = $enclosure->get_link();
  719. if ($elink != '') {
  720. $etitle = $enclosure->get_title() ?? '';
  721. $credits = $enclosure->get_credits() ?? null;
  722. $description = $enclosure->get_description() ?? '';
  723. $mime = strtolower($enclosure->get_type() ?? '');
  724. $medium = strtolower($enclosure->get_medium() ?? '');
  725. $height = $enclosure->get_height();
  726. $width = $enclosure->get_width();
  727. $length = $enclosure->get_length();
  728. $attributeEnclosure = [
  729. 'url' => $elink,
  730. ];
  731. if ($etitle != '') {
  732. $attributeEnclosure['title'] = $etitle;
  733. }
  734. if (is_array($credits)) {
  735. $attributeEnclosure['credit'] = [];
  736. foreach ($credits as $credit) {
  737. $attributeEnclosure['credit'][] = $credit->get_name();
  738. }
  739. }
  740. if ($description != '') {
  741. $attributeEnclosure['description'] = $description;
  742. }
  743. if ($mime != '') {
  744. $attributeEnclosure['type'] = $mime;
  745. }
  746. if ($medium != '') {
  747. $attributeEnclosure['medium'] = $medium;
  748. }
  749. if ($length != '') {
  750. $attributeEnclosure['length'] = (int)$length;
  751. }
  752. if ($height != '') {
  753. $attributeEnclosure['height'] = (int)$height;
  754. }
  755. if ($width != '') {
  756. $attributeEnclosure['width'] = (int)$width;
  757. }
  758. if (!empty($enclosure->get_thumbnails())) {
  759. foreach ($enclosure->get_thumbnails() as $thumbnail) {
  760. if ($thumbnail !== $attributeThumbnail['url']) {
  761. $attributeEnclosure['thumbnails'][] = $thumbnail;
  762. }
  763. }
  764. }
  765. $attributeEnclosures[] = $attributeEnclosure;
  766. }
  767. }
  768. }
  769. $guid = $this->decideEntryGuid($item, fallback: true);
  770. unset($item);
  771. $authorNames = '';
  772. if (is_array($authors)) {
  773. foreach ($authors as $author) {
  774. $authorName = $author->name != '' ? $author->name : $author->email;
  775. if (is_string($authorName) && $authorName !== '') {
  776. $authorNames .= html_only_entity_decode(strip_tags($authorName)) . '; ';
  777. }
  778. }
  779. }
  780. $authorNames = substr($authorNames, 0, -2) ?: '';
  781. $entry = new FreshRSS_Entry(
  782. $this->id(),
  783. $guid,
  784. $title == '' ? '' : $title,
  785. $authorNames,
  786. $content == '' ? '' : $content,
  787. $link == null ? '' : $link,
  788. $date ?: time()
  789. );
  790. $entry->_tags($tags);
  791. $entry->_feed($this);
  792. if (!empty($attributeThumbnail['url'])) {
  793. $entry->_attribute('thumbnail', $attributeThumbnail);
  794. }
  795. $entry->_attribute('enclosures', $attributeEnclosures);
  796. $entry->hash(); //Must be computed before loading full content
  797. $entry->loadCompleteContent(); // Optionally load full content for truncated feeds
  798. yield $entry;
  799. }
  800. }
  801. /**
  802. * Given a feed content generated from a FreshRSS_View
  803. * returns a SimplePie initialized already with that content
  804. * @param string $feedContent the content of the feed, typically generated via FreshRSS_View::renderToString()
  805. */
  806. private function simplePieFromContent(string $feedContent): FreshRSS_SimplePieCustom {
  807. $simplePie = new FreshRSS_SimplePieCustom();
  808. $simplePie->enable_cache(false);
  809. $simplePie->set_raw_data($feedContent);
  810. $simplePie->init();
  811. return $simplePie;
  812. }
  813. /** @return array<string,string> */
  814. private function dotNotationForStandardJsonFeed(): array {
  815. return [
  816. 'feedTitle' => 'title',
  817. 'item' => 'items',
  818. 'itemTitle' => 'title',
  819. 'itemContent' => 'content_text',
  820. 'itemContentHTML' => 'content_html',
  821. 'itemUri' => 'url',
  822. 'itemTimestamp' => 'date_published',
  823. 'itemTimeFormat' => DateTimeInterface::RFC3339_EXTENDED,
  824. 'itemThumbnail' => 'image',
  825. 'itemCategories' => 'tags',
  826. 'itemUid' => 'id',
  827. 'itemAttachment' => 'attachments',
  828. 'itemAttachmentUrl' => 'url',
  829. 'itemAttachmentType' => 'mime_type',
  830. 'itemAttachmentLength' => 'size_in_bytes',
  831. ];
  832. }
  833. private function extractJsonFromHtml(string $html): ?string {
  834. $xPathToJson = $this->attributeString('xPathToJson') ?? '';
  835. if ($xPathToJson === '') {
  836. return null;
  837. }
  838. $doc = new DOMDocument();
  839. $doc->recover = true;
  840. $doc->strictErrorChecking = false;
  841. if (!$doc->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING)) {
  842. return null;
  843. }
  844. $xpath = new DOMXPath($doc);
  845. $jsonFragments = @$xpath->evaluate($xPathToJson);
  846. if ($jsonFragments === false) {
  847. return null;
  848. }
  849. if (is_string($jsonFragments)) {
  850. return $jsonFragments;
  851. }
  852. if ($jsonFragments instanceof DOMNodeList && $jsonFragments->length > 0) {
  853. // If the result is a list, then aggregate as a JSON array
  854. $result = [];
  855. foreach ($jsonFragments as $node) {
  856. if (!($node instanceof DOMNode)) {
  857. continue;
  858. }
  859. $json = json_decode($node->textContent, true);
  860. if (json_last_error() === JSON_ERROR_NONE && is_array($json)) {
  861. $result[] = $json;
  862. }
  863. }
  864. return json_encode($result, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) ?: null;
  865. }
  866. return null;
  867. }
  868. public function loadJson(): ?FreshRSS_SimplePieCustom {
  869. if ($this->url == '') {
  870. return null;
  871. }
  872. $feedSourceUrl = htmlspecialchars_decode($this->url, ENT_QUOTES);
  873. if ($feedSourceUrl == null) {
  874. return null;
  875. }
  876. $httpAccept = $this->kind() === FreshRSS_Feed::KIND_HTML_XPATH_JSON_DOTNOTATION ? 'html' : 'json';
  877. $content = FreshRSS_http_Util::httpGet($feedSourceUrl, $this->cacheFilename(), $httpAccept, $this->attributes(), $this->curlOptions())['body'];
  878. if (strlen($content) <= 0) {
  879. return null;
  880. }
  881. if ($this->kind() === FreshRSS_Feed::KIND_HTML_XPATH_JSON_DOTNOTATION) {
  882. $content = $this->extractJsonFromHtml($content);
  883. if ($content == null) {
  884. return null;
  885. }
  886. }
  887. //check if the content is actual JSON
  888. $jf = json_decode($content, true);
  889. if (json_last_error() !== JSON_ERROR_NONE || !is_array($jf)) {
  890. return null;
  891. }
  892. /** @var array<string,string> $json_dotnotation */
  893. $json_dotnotation = $this->attributeArray('json_dotnotation') ?? [];
  894. $dotnotations = $this->kind() === FreshRSS_Feed::KIND_JSONFEED ? $this->dotNotationForStandardJsonFeed() : $json_dotnotation;
  895. $feedContent = FreshRSS_dotNotation_Util::convertJsonToRss($jf, $feedSourceUrl, $dotnotations, $this->name());
  896. if ($feedContent == null) {
  897. return null;
  898. }
  899. return $this->simplePieFromContent($feedContent);
  900. }
  901. public function loadHtmlXpath(): ?FreshRSS_SimplePieCustom {
  902. if ($this->url == '') {
  903. return null;
  904. }
  905. $feedSourceUrl = htmlspecialchars_decode($this->url, ENT_QUOTES);
  906. if ($feedSourceUrl == null) {
  907. return null;
  908. }
  909. // Same naming conventions than https://rss-bridge.github.io/rss-bridge/Bridge_API/XPathAbstract.html
  910. // https://rss-bridge.github.io/rss-bridge/Bridge_API/BridgeAbstract.html#collectdata
  911. /** @var array<string,string> $xPathSettings */
  912. $xPathSettings = $this->attributeArray('xpath');
  913. $xPathFeedTitle = $xPathSettings['feedTitle'] ?? '';
  914. $xPathItem = $xPathSettings['item'] ?? '';
  915. $xPathItemTitle = $xPathSettings['itemTitle'] ?? '';
  916. $xPathItemContent = $xPathSettings['itemContent'] ?? '';
  917. $xPathItemUri = $xPathSettings['itemUri'] ?? '';
  918. $xPathItemAuthor = $xPathSettings['itemAuthor'] ?? '';
  919. $xPathItemTimestamp = $xPathSettings['itemTimestamp'] ?? '';
  920. $xPathItemTimeFormat = $xPathSettings['itemTimeFormat'] ?? '';
  921. $xPathItemThumbnail = $xPathSettings['itemThumbnail'] ?? '';
  922. $xPathItemCategories = $xPathSettings['itemCategories'] ?? '';
  923. $xPathItemUid = $xPathSettings['itemUid'] ?? '';
  924. if ($xPathItem == '') {
  925. return null;
  926. }
  927. $httpAccept = $this->kind() === FreshRSS_Feed::KIND_XML_XPATH ? 'xml' : 'html';
  928. $html = FreshRSS_http_Util::httpGet($feedSourceUrl, $this->cacheFilename(), $httpAccept, $this->attributes(), $this->curlOptions())['body'];
  929. if (strlen($html) <= 0) {
  930. return null;
  931. }
  932. $view = new FreshRSS_View();
  933. $view->_path('index/rss.phtml');
  934. $view->internal_rendering = true;
  935. $view->rss_url = htmlspecialchars($feedSourceUrl, ENT_COMPAT, 'UTF-8');
  936. $view->html_url = $view->rss_url;
  937. $view->entries = [];
  938. try {
  939. $doc = new DOMDocument();
  940. $doc->recover = true;
  941. $doc->strictErrorChecking = false;
  942. $ok = false;
  943. switch ($this->kind()) {
  944. case FreshRSS_Feed::KIND_HTML_XPATH:
  945. $ok = $doc->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING) !== false;
  946. break;
  947. case FreshRSS_Feed::KIND_XML_XPATH:
  948. $ok = $doc->loadXML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING) !== false;
  949. break;
  950. }
  951. if (!$ok) {
  952. return null;
  953. }
  954. $xpath = new DOMXPath($doc);
  955. $xpathEvaluateString = function (string $expression, ?DOMNode $contextNode = null) use ($xpath): string {
  956. $result = @$xpath->evaluate('normalize-space(' . $expression . ')', $contextNode);
  957. return is_string($result) ? $result : '';
  958. };
  959. $view->rss_title = $xPathFeedTitle == '' ? $this->name() :
  960. htmlspecialchars($xpathEvaluateString($xPathFeedTitle), ENT_COMPAT, 'UTF-8');
  961. $view->rss_base = htmlspecialchars(trim($xpathEvaluateString('//base/@href')), ENT_COMPAT, 'UTF-8');
  962. $nodes = $xpath->query($xPathItem);
  963. if ($nodes === false || $nodes->length === 0) {
  964. return null;
  965. }
  966. foreach ($nodes as $node) {
  967. if (!($node instanceof DOMNode)) {
  968. continue;
  969. }
  970. $item = [];
  971. $item['title'] = $xPathItemTitle == '' ? '' : $xpathEvaluateString($xPathItemTitle, $node);
  972. $item['content'] = '';
  973. if ($xPathItemContent != '') {
  974. $result = @$xpath->evaluate($xPathItemContent, $node);
  975. if ($result instanceof DOMNodeList) {
  976. // List of nodes, save as HTML
  977. $content = '';
  978. foreach ($result as $child) {
  979. if ($child instanceof DOMNode) {
  980. $content .= $doc->saveHTML($child) . "\n";
  981. }
  982. }
  983. $item['content'] = $content;
  984. } elseif (is_string($result) || is_int($result) || is_bool($result)) {
  985. // Typed expression, save as-is
  986. $item['content'] = (string)$result;
  987. }
  988. }
  989. $item['link'] = $xPathItemUri == '' ? '' : $xpathEvaluateString($xPathItemUri, $node);
  990. $item['author'] = $xPathItemAuthor == '' ? '' : $xpathEvaluateString($xPathItemAuthor, $node);
  991. $item['timestamp'] = $xPathItemTimestamp == '' ? '' : $xpathEvaluateString($xPathItemTimestamp, $node);
  992. if ($xPathItemTimeFormat != '') {
  993. $dateTime = DateTime::createFromFormat($xPathItemTimeFormat, $item['timestamp']);
  994. if ($dateTime != false) {
  995. $item['timestamp'] = $dateTime->format(DateTime::ATOM);
  996. }
  997. }
  998. $item['thumbnail'] = $xPathItemThumbnail == '' ? '' : $xpathEvaluateString($xPathItemThumbnail, $node);
  999. if ($xPathItemCategories != '') {
  1000. $itemCategories = @$xpath->evaluate($xPathItemCategories, $node);
  1001. if (is_string($itemCategories) && $itemCategories !== '') {
  1002. $item['tags'] = [$itemCategories];
  1003. } elseif ($itemCategories instanceof DOMNodeList && $itemCategories->length > 0) {
  1004. $item['tags'] = [];
  1005. foreach ($itemCategories as $itemCategory) {
  1006. if ($itemCategory instanceof DOMNode) {
  1007. $item['tags'][] = $itemCategory->textContent;
  1008. }
  1009. }
  1010. }
  1011. }
  1012. if ($xPathItemUid != '') {
  1013. $item['guid'] = $xpathEvaluateString($xPathItemUid, $node);
  1014. }
  1015. if (empty($item['guid'])) {
  1016. $item['guid'] = 'urn:sha1:' . sha1($item['title'] . $item['content'] . $item['link']);
  1017. }
  1018. if ($item['title'] != '' || $item['content'] != '' || $item['link'] != '') {
  1019. // HTML-encoding/escaping of the relevant fields (all except 'content')
  1020. foreach (['author', 'guid', 'link', 'thumbnail', 'timestamp', 'title'] as $key) {
  1021. if (isset($item[$key])) {
  1022. $item[$key] = htmlspecialchars($item[$key], ENT_COMPAT, 'UTF-8');
  1023. }
  1024. }
  1025. if (isset($item['tags'])) {
  1026. $item['tags'] = Minz_Helper::htmlspecialchars_utf8($item['tags']);
  1027. }
  1028. // CDATA protection
  1029. $item['content'] = str_replace(']]>', ']]&gt;', $item['content']);
  1030. $view->entries[] = FreshRSS_Entry::fromArray($item);
  1031. }
  1032. }
  1033. } catch (Exception $ex) {
  1034. Minz_Log::warning($ex->getMessage());
  1035. return null;
  1036. }
  1037. return $this->simplePieFromContent($view->renderToString());
  1038. }
  1039. /**
  1040. * @return int|null The max number of unread articles to keep, or null if disabled.
  1041. */
  1042. public function keepMaxUnread(): ?int {
  1043. $keepMaxUnread = $this->attributeInt('keep_max_n_unread');
  1044. if ($keepMaxUnread === null) {
  1045. $keepMaxUnread = FreshRSS_Context::userConf()->mark_when['max_n_unread'];
  1046. }
  1047. return is_int($keepMaxUnread) && $keepMaxUnread >= 0 ? $keepMaxUnread : null;
  1048. }
  1049. /**
  1050. * @return int|false The number of articles marked as read, of false if error
  1051. */
  1052. public function markAsReadMaxUnread(): int|false {
  1053. $keepMaxUnread = $this->keepMaxUnread();
  1054. if ($keepMaxUnread === null) {
  1055. return false;
  1056. }
  1057. $feedDAO = FreshRSS_Factory::createFeedDao();
  1058. $affected = $feedDAO->markAsReadMaxUnread($this->id(), $keepMaxUnread);
  1059. return $affected;
  1060. }
  1061. /**
  1062. * Applies the *mark as read upon gone* policy, if enabled.
  1063. * Remember to call `updateCachedValues($id_feed)` or `updateCachedValues()` just after.
  1064. * @return int|false the number of lines affected, or false if not applicable
  1065. */
  1066. public function markAsReadUponGone(bool $upstreamIsEmpty, int $minLastSeen = 0): int|false {
  1067. $readUponGone = $this->attributeBoolean('read_upon_gone');
  1068. if ($readUponGone === null) {
  1069. $readUponGone = FreshRSS_Context::userConf()->mark_when['gone'];
  1070. }
  1071. if (!$readUponGone) {
  1072. return false;
  1073. }
  1074. if ($upstreamIsEmpty) {
  1075. if ($minLastSeen <= 0) {
  1076. $minLastSeen = time();
  1077. }
  1078. $entryDAO = FreshRSS_Factory::createEntryDao();
  1079. $affected = $entryDAO->markReadFeed($this->id(), $minLastSeen . '000000');
  1080. } else {
  1081. $feedDAO = FreshRSS_Factory::createFeedDao();
  1082. $affected = $feedDAO->markAsReadNotSeen($this->id(), $minLastSeen);
  1083. }
  1084. if ($affected > 0) {
  1085. Minz_Log::debug(__METHOD__ . " $affected items" . ($upstreamIsEmpty ? ' (all)' : '') . ' [' . $this->url(includeCredentials: false) . ']');
  1086. }
  1087. return $affected;
  1088. }
  1089. /**
  1090. * Remember to call `updateCachedValues($id_feed)` or `updateCachedValues()` just after
  1091. */
  1092. public function cleanOldEntries(): int|false {
  1093. /** @var array<string,bool|int|string>|null $archiving */
  1094. $archiving = $this->attributeArray('archiving');
  1095. if ($archiving === null) {
  1096. $catDAO = FreshRSS_Factory::createCategoryDao();
  1097. $category = $catDAO->searchById($this->categoryId);
  1098. $archiving = $category === null ? null : $category->attributeArray('archiving');
  1099. /** @var array<string,bool|int|string>|null $archiving */
  1100. if ($archiving === null) {
  1101. $archiving = FreshRSS_Context::userConf()->archiving;
  1102. }
  1103. }
  1104. if (is_array($archiving)) {
  1105. $entryDAO = FreshRSS_Factory::createEntryDao();
  1106. $nb = $entryDAO->cleanOldEntries($this->id(), $archiving);
  1107. if ($nb > 0) {
  1108. Minz_Log::debug($nb . ' entries cleaned in feed [' . $this->url(false) . '] with: ' . json_encode($archiving));
  1109. }
  1110. return $nb;
  1111. }
  1112. return false;
  1113. }
  1114. /**
  1115. * @param string $url Overridden URL. Will default to the feed URL.
  1116. * @throws FreshRSS_Context_Exception
  1117. */
  1118. public function cacheFilename(string $url = ''): string {
  1119. $simplePie = new FreshRSS_SimplePieCustom($this->attributes(), $this->curlOptions());
  1120. if ($url !== '') {
  1121. $filename = $simplePie->get_cache_filename($url);
  1122. return CACHE_PATH . '/' . $filename . '.html';
  1123. }
  1124. $url = htmlspecialchars_decode($this->url);
  1125. $filename = $simplePie->get_cache_filename($url);
  1126. switch ($this->kind) {
  1127. case FreshRSS_Feed::KIND_HTML_XPATH:
  1128. return CACHE_PATH . '/' . $filename . '.html';
  1129. case FreshRSS_Feed::KIND_XML_XPATH:
  1130. return CACHE_PATH . '/' . $filename . '.xml';
  1131. case FreshRSS_Feed::KIND_JSON_DOTNOTATION:
  1132. case FreshRSS_Feed::KIND_JSON_XPATH:
  1133. case FreshRSS_Feed::KIND_JSONFEED:
  1134. return CACHE_PATH . '/' . $filename . '.json';
  1135. case FreshRSS_Feed::KIND_RSS:
  1136. case FreshRSS_Feed::KIND_RSS_FORCED:
  1137. default:
  1138. return CACHE_PATH . '/' . $filename . '.spc';
  1139. }
  1140. }
  1141. private function faviconRebuild(): void {
  1142. if ($this->customFavicon()) {
  1143. return;
  1144. }
  1145. FreshRSS_Feed::faviconDelete($this->hashFavicon());
  1146. $this->faviconPrepare(true);
  1147. }
  1148. public function clearCache(): bool {
  1149. $this->faviconRebuild();
  1150. return @unlink($this->cacheFilename());
  1151. }
  1152. /** @return int|false */
  1153. public function cacheModifiedTime(): int|false {
  1154. $filename = $this->cacheFilename();
  1155. clearstatcache(true, $filename);
  1156. return @filemtime($filename);
  1157. }
  1158. public function lock(): bool {
  1159. $this->lockPath = TMP_PATH . '/' . $this->hash() . '.freshrss.lock';
  1160. if (file_exists($this->lockPath) && ((time() - (@filemtime($this->lockPath) ?: 0)) > 3600)) {
  1161. @unlink($this->lockPath);
  1162. }
  1163. if (($handle = @fopen($this->lockPath, 'x')) === false) {
  1164. return false;
  1165. }
  1166. //register_shutdown_function('unlink', $this->lockPath);
  1167. @fclose($handle);
  1168. return true;
  1169. }
  1170. public function unlock(): bool {
  1171. return @unlink($this->lockPath);
  1172. }
  1173. //<WebSub>
  1174. public function pubSubHubbubEnabled(): bool {
  1175. $url = $this->selfUrl ?: $this->url;
  1176. $hubFilename = PSHB_PATH . '/feeds/' . sha1($url) . '/!hub.json';
  1177. if (($hubFile = @file_get_contents($hubFilename)) != false) {
  1178. $hubJson = json_decode($hubFile, true);
  1179. if (is_array($hubJson) && empty($hubJson['error']) &&
  1180. (empty($hubJson['lease_end']) || $hubJson['lease_end'] > time())) {
  1181. return true;
  1182. }
  1183. }
  1184. return false;
  1185. }
  1186. public function pubSubHubbubError(bool $error = true): bool {
  1187. $url = $this->selfUrl ?: $this->url;
  1188. $hubFilename = PSHB_PATH . '/feeds/' . sha1($url) . '/!hub.json';
  1189. $hubFile = @file_get_contents($hubFilename);
  1190. $hubJson = is_string($hubFile) ? json_decode($hubFile, true) : null;
  1191. if (is_array($hubJson) && (!isset($hubJson['error']) || $hubJson['error'] !== $error)) {
  1192. $hubJson['error'] = $error;
  1193. file_put_contents($hubFilename, json_encode($hubJson));
  1194. Minz_Log::warning('Set error to ' . ($error ? 1 : 0) . ' for ' . $url, PSHB_LOG);
  1195. }
  1196. return false;
  1197. }
  1198. public function pubSubHubbubPrepare(): string|false {
  1199. $key = '';
  1200. if (Minz_Request::serverIsPublic(FreshRSS_Context::systemConf()->base_url) &&
  1201. $this->hubUrl !== '' && $this->selfUrl !== '' && @is_dir(PSHB_PATH)) {
  1202. $path = PSHB_PATH . '/feeds/' . sha1($this->selfUrl);
  1203. $hubFilename = $path . '/!hub.json';
  1204. if (($hubFile = @file_get_contents($hubFilename)) != false) {
  1205. $hubJson = json_decode($hubFile, true);
  1206. if (!is_array($hubJson) || empty($hubJson['key']) || !is_string($hubJson['key']) || !ctype_xdigit($hubJson['key'])) {
  1207. $text = 'Invalid JSON for WebSub: ' . $this->url;
  1208. Minz_Log::warning($text);
  1209. Minz_Log::warning($text, PSHB_LOG);
  1210. return false;
  1211. }
  1212. if (!empty($hubJson['lease_end']) && is_int($hubJson['lease_end']) && $hubJson['lease_end'] < (time() + (3600 * 23))) { //TODO: Make a better policy
  1213. $text = 'WebSub lease ends at '
  1214. . date('c', empty($hubJson['lease_end']) ? time() : $hubJson['lease_end'])
  1215. . ' and needs renewal: ' . $this->url;
  1216. Minz_Log::warning($text);
  1217. Minz_Log::warning($text, PSHB_LOG);
  1218. $key = $hubJson['key']; //To renew our lease
  1219. } elseif (((!empty($hubJson['error'])) || empty($hubJson['lease_end'])) &&
  1220. (empty($hubJson['lease_start']) || $hubJson['lease_start'] < time() - (3600 * 23))) { //Do not renew too often
  1221. $key = $hubJson['key']; //To renew our lease
  1222. }
  1223. } else {
  1224. @mkdir($path, 0770, true);
  1225. $key = sha1($path . FreshRSS_Context::systemConf()->salt);
  1226. $hubJson = [
  1227. 'hub' => $this->hubUrl,
  1228. 'key' => $key,
  1229. ];
  1230. file_put_contents($hubFilename, json_encode($hubJson));
  1231. @mkdir(PSHB_PATH . '/keys/', 0770, true);
  1232. file_put_contents(PSHB_PATH . '/keys/' . $key . '.txt', $this->selfUrl);
  1233. $text = 'WebSub prepared for ' . $this->url;
  1234. Minz_Log::debug($text);
  1235. Minz_Log::debug($text, PSHB_LOG);
  1236. }
  1237. $currentUser = Minz_User::name() ?? '';
  1238. if (FreshRSS_user_Controller::checkUsername($currentUser) && !file_exists($path . '/' . $currentUser . '.txt')) {
  1239. touch($path . '/' . $currentUser . '.txt');
  1240. }
  1241. }
  1242. return $key;
  1243. }
  1244. //Parameter true to subscribe, false to unsubscribe.
  1245. public function pubSubHubbubSubscribe(bool $state): bool {
  1246. if ($state) {
  1247. $url = $this->selfUrl ?: $this->url;
  1248. } else {
  1249. $url = $this->url; //Always use current URL during unsubscribe
  1250. }
  1251. if ($url !== '' && (Minz_Request::serverIsPublic(FreshRSS_Context::systemConf()->base_url) || !$state)) {
  1252. $hubFilename = PSHB_PATH . '/feeds/' . sha1($url) . '/!hub.json';
  1253. $hubFile = @file_get_contents($hubFilename);
  1254. if ($hubFile === false) {
  1255. Minz_Log::warning('JSON not found for WebSub: ' . $this->url);
  1256. return false;
  1257. }
  1258. $hubJson = json_decode($hubFile, true);
  1259. if (!is_array($hubJson) || empty($hubJson['key']) || !is_string($hubJson['key']) || !ctype_xdigit($hubJson['key']) ||
  1260. empty($hubJson['hub']) || !is_string($hubJson['hub'])) {
  1261. Minz_Log::warning('Invalid JSON for WebSub: ' . $this->url);
  1262. return false;
  1263. }
  1264. $callbackUrl = FreshRSS_http_Util::checkUrl(Minz_Request::getBaseUrl() . '/api/pshb.php?k=' . $hubJson['key']);
  1265. if ($callbackUrl == '') {
  1266. Minz_Log::warning('Invalid callback for WebSub: ' . $this->url);
  1267. return false;
  1268. }
  1269. if (!$state) { //unsubscribe
  1270. $hubJson['lease_end'] = time() - 60;
  1271. file_put_contents($hubFilename, json_encode($hubJson));
  1272. }
  1273. $ch = curl_init();
  1274. if ($ch === false) {
  1275. Minz_Log::warning('curl_init() failed in ' . __METHOD__);
  1276. return false;
  1277. }
  1278. curl_setopt_array($ch, [
  1279. CURLOPT_URL => $hubJson['hub'],
  1280. CURLOPT_RETURNTRANSFER => true,
  1281. CURLOPT_POSTFIELDS => http_build_query([
  1282. 'hub.verify' => 'sync',
  1283. 'hub.mode' => $state ? 'subscribe' : 'unsubscribe',
  1284. 'hub.topic' => $url,
  1285. 'hub.callback' => $callbackUrl,
  1286. ]),
  1287. CURLOPT_USERAGENT => FRESHRSS_USERAGENT,
  1288. CURLOPT_MAXREDIRS => 10,
  1289. CURLOPT_FOLLOWLOCATION => true,
  1290. CURLOPT_ENCODING => '', //Enable all encodings
  1291. //CURLOPT_VERBOSE => 1, // To debug sent HTTP headers
  1292. ]);
  1293. $response = curl_exec($ch);
  1294. $info = curl_getinfo($ch);
  1295. if (!is_array($info)) {
  1296. Minz_Log::warning('curl_getinfo() failed in ' . __METHOD__);
  1297. return false;
  1298. }
  1299. Minz_Log::warning('WebSub ' . ($state ? 'subscribe' : 'unsubscribe') . ' to ' . $url .
  1300. ' via hub ' . $hubJson['hub'] .
  1301. ' with callback ' . $callbackUrl . ': ' . $info['http_code'] . ' ' . $response, PSHB_LOG);
  1302. if (str_starts_with('' . $info['http_code'], '2')) {
  1303. return true;
  1304. } else {
  1305. $hubJson['lease_start'] = time(); //Prevent trying again too soon
  1306. $hubJson['error'] = true;
  1307. file_put_contents($hubFilename, json_encode($hubJson));
  1308. return false;
  1309. }
  1310. }
  1311. return false;
  1312. }
  1313. //</WebSub>
  1314. }