feedController.php 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * Controller to handle every feed actions.
  5. */
  6. class FreshRSS_feed_Controller extends FreshRSS_ActionController {
  7. /**
  8. * This action is called before every other action in that class. It is
  9. * the common boilerplate for every action. It is triggered by the
  10. * underlying framework.
  11. */
  12. #[\Override]
  13. public function firstAction(): void {
  14. if (!FreshRSS_Auth::hasAccess()) {
  15. $action = Minz_Request::actionName();
  16. // Likely coming from bookmarklet, redirect to the login page
  17. if ($action === 'add') {
  18. Minz_Request::forward(['c' => 'auth', 'a' => 'login']);
  19. return;
  20. }
  21. if ($action !== 'actualize' || (!FreshRSS_Auth::allowAnonymousRefresh() && !Minz_Request::tokenIsOk())) {
  22. Minz_Error::error(403);
  23. }
  24. }
  25. }
  26. /**
  27. * @param array<string,mixed> $attributes
  28. * @throws FreshRSS_AlreadySubscribed_Exception
  29. * @throws FreshRSS_BadUrl_Exception
  30. * @throws FreshRSS_Feed_Exception
  31. * @throws FreshRSS_FeedNotAdded_Exception
  32. * @throws Minz_FileNotExistException
  33. */
  34. public static function addFeed(string $url, string $title = '', int $cat_id = 0, string $new_cat_name = '',
  35. string $http_auth = '', array $attributes = [], int $kind = FreshRSS_Feed::KIND_RSS): FreshRSS_Feed {
  36. FreshRSS_UserDAO::touch();
  37. if (function_exists('set_time_limit')) {
  38. @set_time_limit(300);
  39. }
  40. $catDAO = FreshRSS_Factory::createCategoryDao();
  41. $url = trim($url);
  42. /** @var string|null $urlHooked */
  43. $urlHooked = Minz_ExtensionManager::callHook(Minz_HookType::CheckUrlBeforeAdd, $url);
  44. if ($urlHooked === null) {
  45. throw new FreshRSS_FeedNotAdded_Exception($url);
  46. }
  47. $url = $urlHooked;
  48. $cat = null;
  49. if ($cat_id > 0) {
  50. $cat = $catDAO->searchById($cat_id);
  51. }
  52. if ($cat === null && $new_cat_name != '') {
  53. $new_cat_id = $catDAO->addCategory(['name' => $new_cat_name]);
  54. $cat_id = $new_cat_id > 0 ? $new_cat_id : $cat_id;
  55. $cat = $catDAO->searchById($cat_id);
  56. }
  57. if ($cat === null) {
  58. $catDAO->checkDefault();
  59. }
  60. $feed = new FreshRSS_Feed($url); //Throws FreshRSS_BadUrl_Exception
  61. $title = trim($title);
  62. if ($title !== '') {
  63. $feed->_name($title);
  64. }
  65. $feed->_kind($kind);
  66. $feed->_attributes($attributes);
  67. $feed->_httpAuth($http_auth);
  68. if ($cat === null) {
  69. $feed->_categoryId(FreshRSS_CategoryDAO::DEFAULTCATEGORYID);
  70. } else {
  71. $feed->_category($cat);
  72. }
  73. switch ($kind) {
  74. case FreshRSS_Feed::KIND_RSS:
  75. case FreshRSS_Feed::KIND_RSS_FORCED:
  76. if ($feed->load(loadDetails: true) === null) { // Throws FreshRSS_Feed_Exception, Minz_FileNotExistException
  77. throw new FreshRSS_FeedNotAdded_Exception($url);
  78. }
  79. break;
  80. case FreshRSS_Feed::KIND_HTML_XPATH:
  81. case FreshRSS_Feed::KIND_XML_XPATH:
  82. $feed->_website($url);
  83. break;
  84. }
  85. $feedDAO = FreshRSS_Factory::createFeedDao();
  86. if ($feedDAO->searchByUrl($feed->url()) !== null) {
  87. throw new FreshRSS_AlreadySubscribed_Exception($url, $feed->name());
  88. }
  89. /** @var FreshRSS_Feed|null $feed */
  90. $feed = Minz_ExtensionManager::callHook(Minz_HookType::FeedBeforeInsert, $feed);
  91. if ($feed === null) {
  92. throw new FreshRSS_FeedNotAdded_Exception($url);
  93. }
  94. $id = $feedDAO->addFeedObject($feed);
  95. if (!$id) {
  96. // There was an error in database… we cannot say what here.
  97. throw new FreshRSS_FeedNotAdded_Exception($url);
  98. }
  99. $feed->_id($id);
  100. // Ok, feed has been added in database. Now we have to refresh entries.
  101. self::actualizeFeedsAndCommit($id, $url);
  102. return $feed;
  103. }
  104. /**
  105. * This action subscribes to a feed.
  106. *
  107. * It can be reached by both GET and POST requests.
  108. *
  109. * GET request displays a form to add and configure a feed.
  110. * Request parameter is:
  111. * - url_rss (default: false)
  112. * - cat_id (default: 1)
  113. *
  114. * POST request adds a feed in database.
  115. * Parameters are:
  116. * - url_rss (default: false)
  117. * - category (default: false)
  118. * - http_user (default: false)
  119. * - http_pass (default: false)
  120. * It tries to get website information from RSS feed.
  121. * If no category is given, feed is added to the default one.
  122. *
  123. * If url_rss is false, nothing happened.
  124. */
  125. public function addAction(): void {
  126. $url = Minz_Request::paramString('url_rss');
  127. if ($url === '') {
  128. // No url, do nothing
  129. Minz_Request::forward([
  130. 'c' => 'subscription',
  131. 'a' => 'index',
  132. ], true);
  133. }
  134. $feedDAO = FreshRSS_Factory::createFeedDao();
  135. $url_redirect = [
  136. 'c' => 'subscription',
  137. 'a' => 'add',
  138. 'params' => [],
  139. ];
  140. $limits = FreshRSS_Context::systemConf()->limits;
  141. $this->view->feeds = $feedDAO->listFeeds();
  142. if (count($this->view->feeds) >= $limits['max_feeds']) {
  143. Minz_Request::bad(_t('feedback.sub.feed.over_max', $limits['max_feeds']), $url_redirect);
  144. }
  145. if (Minz_Request::isPost()) {
  146. $cat = Minz_Request::paramInt('category');
  147. // HTTP information are useful if feed is protected behind a
  148. // HTTP authentication
  149. $user = Minz_Request::paramString('http_user');
  150. $pass = Minz_Request::paramString('http_pass');
  151. $http_auth = '';
  152. if ($user != '' && $pass != '') { //TODO: Sanitize
  153. $http_auth = $user . ':' . $pass;
  154. }
  155. $cookie = Minz_Request::paramString('curl_params_cookie', plaintext: true);
  156. $cookie_file = Minz_Request::paramBoolean('curl_params_cookiefile');
  157. $max_redirs = Minz_Request::paramInt('curl_params_redirects');
  158. $useragent = Minz_Request::paramString('curl_params_useragent', plaintext: true);
  159. $proxy_address = Minz_Request::paramString('curl_params', plaintext: true);
  160. $proxy_type = Minz_Request::paramIntNull('proxy_type');
  161. $request_method = Minz_Request::paramString('curl_method', plaintext: true);
  162. $request_fields = Minz_Request::paramString('curl_fields', plaintext: true);
  163. $headers = Minz_Request::paramTextToArray('http_headers', plaintext: true);
  164. $opts = [];
  165. if ($proxy_type !== null) {
  166. $opts[CURLOPT_PROXYTYPE] = $proxy_type;
  167. }
  168. if ($proxy_address !== '') {
  169. $opts[CURLOPT_PROXY] = $proxy_address;
  170. }
  171. if ($cookie !== '') {
  172. $opts[CURLOPT_COOKIE] = $cookie;
  173. }
  174. if ($cookie_file) {
  175. // Pass empty cookie file name to enable the libcurl cookie engine
  176. // without reading any existing cookie data.
  177. $opts[CURLOPT_COOKIEFILE] = '';
  178. }
  179. if ($max_redirs !== 0) {
  180. $opts[CURLOPT_MAXREDIRS] = $max_redirs;
  181. $opts[CURLOPT_FOLLOWLOCATION] = true;
  182. }
  183. if ($useragent !== '') {
  184. $opts[CURLOPT_USERAGENT] = $useragent;
  185. }
  186. if ($request_method === 'POST') {
  187. $opts[CURLOPT_POST] = true;
  188. if ($request_fields !== '') {
  189. $opts[CURLOPT_POSTFIELDS] = $request_fields;
  190. if (json_decode($request_fields, true) !== null) {
  191. $opts[CURLOPT_HTTPHEADER] = ['Content-Type: application/json'];
  192. }
  193. }
  194. }
  195. $headers = array_filter($headers, fn(string $header): bool => trim($header) !== '');
  196. if (!empty($headers)) {
  197. $opts[CURLOPT_HTTPHEADER] = array_merge($headers, $opts[CURLOPT_HTTPHEADER] ?? []);
  198. $opts[CURLOPT_HTTPHEADER] = array_unique($opts[CURLOPT_HTTPHEADER]);
  199. }
  200. $attributes = [
  201. 'curl_params' => empty($opts) ? null : FreshRSS_http_Util::sanitizeCurlParams($opts),
  202. ];
  203. $attributes['ssl_verify'] = Minz_Request::paramTernary('ssl_verify');
  204. $timeout = Minz_Request::paramInt('timeout');
  205. $attributes['timeout'] = $timeout > 0 ? $timeout : null;
  206. $feed_kind = Minz_Request::paramInt('feed_kind') ?: FreshRSS_Feed::KIND_RSS;
  207. if ($feed_kind === FreshRSS_Feed::KIND_HTML_XPATH || $feed_kind === FreshRSS_Feed::KIND_XML_XPATH) {
  208. $xPathSettings = [];
  209. if (Minz_Request::paramString('xPathFeedTitle') !== '') {
  210. $xPathSettings['feedTitle'] = Minz_Request::paramString('xPathFeedTitle', true);
  211. }
  212. if (Minz_Request::paramString('xPathItem') !== '') {
  213. $xPathSettings['item'] = Minz_Request::paramString('xPathItem', true);
  214. }
  215. if (Minz_Request::paramString('xPathItemTitle') !== '') {
  216. $xPathSettings['itemTitle'] = Minz_Request::paramString('xPathItemTitle', true);
  217. }
  218. if (Minz_Request::paramString('xPathItemContent') !== '') {
  219. $xPathSettings['itemContent'] = Minz_Request::paramString('xPathItemContent', true);
  220. }
  221. if (Minz_Request::paramString('xPathItemUri') !== '') {
  222. $xPathSettings['itemUri'] = Minz_Request::paramString('xPathItemUri', true);
  223. }
  224. if (Minz_Request::paramString('xPathItemAuthor') !== '') {
  225. $xPathSettings['itemAuthor'] = Minz_Request::paramString('xPathItemAuthor', true);
  226. }
  227. if (Minz_Request::paramString('xPathItemTimestamp') !== '') {
  228. $xPathSettings['itemTimestamp'] = Minz_Request::paramString('xPathItemTimestamp', true);
  229. }
  230. if (Minz_Request::paramString('xPathItemTimeFormat') !== '') {
  231. $xPathSettings['itemTimeFormat'] = Minz_Request::paramString('xPathItemTimeFormat', true);
  232. }
  233. if (Minz_Request::paramString('xPathItemThumbnail') !== '') {
  234. $xPathSettings['itemThumbnail'] = Minz_Request::paramString('xPathItemThumbnail', true);
  235. }
  236. if (Minz_Request::paramString('xPathItemCategories') !== '') {
  237. $xPathSettings['itemCategories'] = Minz_Request::paramString('xPathItemCategories', true);
  238. }
  239. if (Minz_Request::paramString('xPathItemUid') !== '') {
  240. $xPathSettings['itemUid'] = Minz_Request::paramString('xPathItemUid', true);
  241. }
  242. if (!empty($xPathSettings)) {
  243. $attributes['xpath'] = $xPathSettings;
  244. }
  245. } elseif ($feed_kind === FreshRSS_Feed::KIND_JSON_DOTNOTATION || $feed_kind === FreshRSS_Feed::KIND_HTML_XPATH_JSON_DOTNOTATION) {
  246. $jsonSettings = [];
  247. if (Minz_Request::paramString('jsonFeedTitle') !== '') {
  248. $jsonSettings['feedTitle'] = Minz_Request::paramString('jsonFeedTitle', true);
  249. }
  250. if (Minz_Request::paramString('jsonItem') !== '') {
  251. $jsonSettings['item'] = Minz_Request::paramString('jsonItem', true);
  252. }
  253. if (Minz_Request::paramString('jsonItemTitle') !== '') {
  254. $jsonSettings['itemTitle'] = Minz_Request::paramString('jsonItemTitle', true);
  255. }
  256. if (Minz_Request::paramString('jsonItemContent') !== '') {
  257. $jsonSettings['itemContent'] = Minz_Request::paramString('jsonItemContent', true);
  258. }
  259. if (Minz_Request::paramString('jsonItemUri') !== '') {
  260. $jsonSettings['itemUri'] = Minz_Request::paramString('jsonItemUri', true);
  261. }
  262. if (Minz_Request::paramString('jsonItemAuthor') !== '') {
  263. $jsonSettings['itemAuthor'] = Minz_Request::paramString('jsonItemAuthor', true);
  264. }
  265. if (Minz_Request::paramString('jsonItemTimestamp') !== '') {
  266. $jsonSettings['itemTimestamp'] = Minz_Request::paramString('jsonItemTimestamp', true);
  267. }
  268. if (Minz_Request::paramString('jsonItemTimeFormat') !== '') {
  269. $jsonSettings['itemTimeFormat'] = Minz_Request::paramString('jsonItemTimeFormat', true);
  270. }
  271. if (Minz_Request::paramString('jsonItemThumbnail') !== '') {
  272. $jsonSettings['itemThumbnail'] = Minz_Request::paramString('jsonItemThumbnail', true);
  273. }
  274. if (Minz_Request::paramString('jsonItemCategories') !== '') {
  275. $jsonSettings['itemCategories'] = Minz_Request::paramString('jsonItemCategories', true);
  276. }
  277. if (Minz_Request::paramString('jsonItemUid') !== '') {
  278. $jsonSettings['itemUid'] = Minz_Request::paramString('jsonItemUid', true);
  279. }
  280. if (!empty($jsonSettings)) {
  281. $attributes['json_dotnotation'] = $jsonSettings;
  282. }
  283. if (Minz_Request::paramString('xPathToJson', plaintext: true) !== '') {
  284. $attributes['xPathToJson'] = Minz_Request::paramString('xPathToJson', plaintext: true);
  285. }
  286. }
  287. try {
  288. $feed = self::addFeed($url, '', $cat, '', $http_auth, $attributes, $feed_kind);
  289. } catch (FreshRSS_BadUrl_Exception $e) {
  290. // Given url was not a valid url!
  291. Minz_Log::warning($e->getMessage());
  292. Minz_Request::bad(_t('feedback.sub.feed.invalid_url', $url), $url_redirect);
  293. return;
  294. } catch (FreshRSS_Feed_Exception $e) {
  295. // Something went bad (timeout, server not found, etc.)
  296. Minz_Log::warning($e->getMessage());
  297. Minz_Request::bad(_t('feedback.sub.feed.internal_problem', _url('index', 'logs')), $url_redirect);
  298. return;
  299. } catch (Minz_FileNotExistException $e) {
  300. // Cache directory doesn’t exist!
  301. Minz_Log::error($e->getMessage());
  302. Minz_Request::bad(_t('feedback.sub.feed.internal_problem', _url('index', 'logs')), $url_redirect);
  303. return;
  304. } catch (FreshRSS_AlreadySubscribed_Exception $e) {
  305. Minz_Request::bad(_t('feedback.sub.feed.already_subscribed', $e->feedName()), $url_redirect);
  306. return;
  307. } catch (FreshRSS_FeedNotAdded_Exception $e) {
  308. Minz_Request::bad(_t('feedback.sub.feed.not_added', $e->url()), $url_redirect);
  309. return;
  310. }
  311. // Entries are in DB
  312. $keep_adding_feed = Minz_Request::paramBoolean('keep_adding_feed');
  313. if ($keep_adding_feed) {
  314. // We stay in add feed while maintaining some fields
  315. $url_redirect['params']['cat_id'] = $feed->categoryId();
  316. $url_redirect['params']['keep_adding_feed'] = $keep_adding_feed;
  317. } else {
  318. // we redirect to feed configuration page.
  319. $url_redirect['a'] = 'feed';
  320. $url_redirect['params']['id'] = '' . $feed->id();
  321. }
  322. Minz_Request::good(
  323. _t('feedback.sub.feed.added', $feed->name()),
  324. $url_redirect,
  325. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  326. );
  327. } else {
  328. // GET request: we must ask confirmation to user before adding feed.
  329. FreshRSS_View::prependTitle(_t('sub.feed.title_add') . ' · ');
  330. $catDAO = FreshRSS_Factory::createCategoryDao();
  331. $this->view->categories = $catDAO->listCategories(prePopulateFeeds: false);
  332. $this->view->feed = new FreshRSS_Feed($url);
  333. try {
  334. // We try to get more information about the feed.
  335. $this->view->feed->load(loadDetails: true);
  336. $this->view->load_ok = true;
  337. } catch (Exception) {
  338. $this->view->load_ok = false;
  339. }
  340. $feed = $feedDAO->searchByUrl($this->view->feed->url());
  341. if ($feed !== null) {
  342. // Already subscribe so we redirect to the feed configuration page.
  343. $url_redirect['a'] = 'feed';
  344. $url_redirect['params']['id'] = $feed->id();
  345. Minz_Request::good(
  346. _t('feedback.sub.feed.already_subscribed', $feed->name()),
  347. $url_redirect,
  348. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  349. );
  350. }
  351. }
  352. }
  353. /**
  354. * This action remove entries from a given feed.
  355. *
  356. * It should be reached by a POST action.
  357. *
  358. * Parameter is:
  359. * - id (default: false)
  360. */
  361. public function truncateAction(): void {
  362. if (!Minz_Request::isPost()) {
  363. Minz_Request::forward(['c' => 'subscription'], true);
  364. }
  365. $id = Minz_Request::paramInt('id');
  366. $url_redirect = [
  367. 'c' => 'subscription',
  368. 'a' => 'index',
  369. 'params' => ['id' => $id],
  370. ];
  371. if (!Minz_Request::isPost()) {
  372. Minz_Request::forward($url_redirect, true);
  373. }
  374. $feedDAO = FreshRSS_Factory::createFeedDao();
  375. $n = $feedDAO->truncate($id);
  376. invalidateHttpCache();
  377. if ($n === false) {
  378. Minz_Request::bad(_t('feedback.sub.feed.error'), $url_redirect);
  379. } else {
  380. Minz_Request::good(
  381. _t('feedback.sub.feed.n_entries_deleted', $n),
  382. $url_redirect,
  383. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  384. );
  385. }
  386. }
  387. /**
  388. * @param FreshRSS_SimplePieCustom|null $simplePiePush Used by WebSub (PubSubHubbub) to push updates
  389. * @param string $selfUrl Used by WebSub (PubSubHubbub) to override the feed URL
  390. * @return array{0:int,1:FreshRSS_Feed|null,2:int,3:array<FreshRSS_Feed>} Number of updated feeds, first feed or null, number of new articles,
  391. * list of feeds for which a cache refresh is needed
  392. * @throws FreshRSS_BadUrl_Exception
  393. */
  394. public static function actualizeFeeds(?int $feed_id = null, ?string $feed_url = null, ?int $maxFeeds = null,
  395. ?FreshRSS_SimplePieCustom $simplePiePush = null, string $selfUrl = ''): array {
  396. if (function_exists('set_time_limit')) {
  397. @set_time_limit(300);
  398. }
  399. if (!is_int($feed_id) || $feed_id <= 0) {
  400. $feed_id = null;
  401. }
  402. if (!is_string($feed_url) || trim($feed_url) === '') {
  403. $feed_url = null;
  404. }
  405. if (!is_int($maxFeeds) || $maxFeeds <= 0) {
  406. $maxFeeds = PHP_INT_MAX;
  407. }
  408. $catDAO = FreshRSS_Factory::createCategoryDao();
  409. $feedDAO = FreshRSS_Factory::createFeedDao();
  410. $entryDAO = FreshRSS_Factory::createEntryDao();
  411. // Create a list of feeds to actualize.
  412. $feeds = [];
  413. if ($feed_id !== null || $feed_url !== null) {
  414. $feed = $feed_id !== null ? $feedDAO->searchById($feed_id) : $feedDAO->searchByUrl($feed_url);
  415. if ($feed !== null && $feed->id() > 0) {
  416. if ($selfUrl !== '') {
  417. $feed->_selfUrl($selfUrl);
  418. }
  419. $feeds[] = $feed;
  420. $feed_id = $feed->id();
  421. }
  422. } else {
  423. $feeds = $feedDAO->listFeedsOrderUpdate(-1);
  424. // Hydrate category for each feed to avoid that each feed has to make an SQL request
  425. $categories = $catDAO->listCategories(prePopulateFeeds: false, details: false);
  426. foreach ($feeds as $feed) {
  427. $category = $categories[$feed->categoryId()] ?? null;
  428. if ($category !== null) {
  429. $feed->_category($category);
  430. }
  431. }
  432. }
  433. // WebSub (PubSubHubbub) support
  434. $pubsubhubbubEnabledGeneral = FreshRSS_Context::systemConf()->pubsubhubbub_enabled;
  435. $pshbMinAge = time() - (3600 * 24); //TODO: Make a configuration.
  436. $nbUpdatedFeeds = 0;
  437. $nbNewArticles = 0;
  438. $feedsCacheToRefresh = [];
  439. /** @var array<int,array<string,true>> */
  440. $categoriesEntriesTitle = [];
  441. /** @var array<int,array<string,true>> */
  442. $categoriesEntriesGuid = [];
  443. $feeds = Minz_ExtensionManager::callHook(Minz_HookType::FeedsListBeforeActualize, $feeds);
  444. if (!is_iterable($feeds)) {
  445. $feeds = [];
  446. }
  447. $firstFeed = null;
  448. foreach ($feeds as $feed) {
  449. if (!($feed instanceof FreshRSS_Feed)) {
  450. continue;
  451. }
  452. if (null === $firstFeed) {
  453. $firstFeed = $feed;
  454. }
  455. $feed = Minz_ExtensionManager::callHook(Minz_HookType::FeedBeforeActualize, $feed);
  456. if (!($feed instanceof FreshRSS_Feed)) {
  457. continue;
  458. }
  459. $url = $feed->url(); //For detection of HTTP 301
  460. $oldSimplePieHash = $feed->attributeString('SimplePieHash');
  461. $pubSubHubbubEnabled = $pubsubhubbubEnabledGeneral && $feed->pubSubHubbubEnabled();
  462. if ($simplePiePush === null && $feed_id === null && $pubSubHubbubEnabled && ($feed->lastUpdate() > $pshbMinAge)) {
  463. //$text = 'Skip pull of feed using PubSubHubbub: ' . $url;
  464. //Minz_Log::debug($text);
  465. //Minz_Log::debug($text, PSHB_LOG);
  466. continue; //When PubSubHubbub is used, do not pull refresh so often
  467. }
  468. if ($feed->mute() && ($feed_id === null || $simplePiePush !== null)) {
  469. continue; // If the feed is disabled, only allow refresh if manually requested for that specific feed
  470. }
  471. $mtime = $feed->cacheModifiedTime() ?: 0;
  472. $ttl = $feed->ttl();
  473. if ($ttl === FreshRSS_Feed::TTL_DEFAULT) {
  474. $ttl = FreshRSS_Context::userConf()->ttl_default;
  475. }
  476. if ($simplePiePush === null && $feed_id === null && (time() <= $feed->lastUpdate() + $ttl)) {
  477. //Too early to refresh from source, but check whether the feed was updated by another user
  478. $ε = 10; // negligible offset errors in seconds
  479. if ($mtime <= 0 ||
  480. $feed->lastUpdate() + $ε >= $mtime ||
  481. time() + $ε >= $mtime + FreshRSS_Context::systemConf()->limits['cache_duration']) { // is cache still valid?
  482. continue; //Nothing newer from other users
  483. }
  484. Minz_Log::debug('Feed ' . $feed->url(false) . ' was updated at ' . date('c', $feed->lastUpdate()) .
  485. ', and at ' . date('c', $mtime) . ' by another user; take advantage of newer cache.');
  486. }
  487. if (!$feed->lock()) {
  488. Minz_Log::notice('Feed already being actualized: ' . $feed->url(false));
  489. continue;
  490. }
  491. $feedIsNew = $feed->lastUpdate() <= 0;
  492. try {
  493. if ($simplePiePush !== null) {
  494. $simplePie = $simplePiePush; //Used by WebSub
  495. } elseif ($feed->kind() === FreshRSS_Feed::KIND_HTML_XPATH) {
  496. $simplePie = $feed->loadHtmlXpath();
  497. if ($simplePie === null) {
  498. throw new FreshRSS_Feed_Exception('HTML+XPath Web scraping failed for [' . $feed->url(false) . ']');
  499. }
  500. } elseif ($feed->kind() === FreshRSS_Feed::KIND_XML_XPATH) {
  501. $simplePie = $feed->loadHtmlXpath();
  502. if ($simplePie === null) {
  503. throw new FreshRSS_Feed_Exception('XML+XPath parsing failed for [' . $feed->url(false) . ']');
  504. }
  505. } elseif ($feed->kind() === FreshRSS_Feed::KIND_JSON_DOTNOTATION) {
  506. $simplePie = $feed->loadJson();
  507. if ($simplePie === null) {
  508. throw new FreshRSS_Feed_Exception('JSON dot notation parsing failed for [' . $feed->url(false) . ']');
  509. }
  510. } elseif ($feed->kind() === FreshRSS_Feed::KIND_JSONFEED) {
  511. $simplePie = $feed->loadJson();
  512. if ($simplePie === null) {
  513. throw new FreshRSS_Feed_Exception('JSON Feed parsing failed for [' . $feed->url(false) . ']');
  514. }
  515. } elseif ($feed->kind() === FreshRSS_Feed::KIND_HTML_XPATH_JSON_DOTNOTATION) {
  516. $simplePie = $feed->loadJson();
  517. if ($simplePie === null) {
  518. throw new FreshRSS_Feed_Exception('HTML+XPath+JSON parsing failed for [' . $feed->url(false) . ']');
  519. }
  520. } else {
  521. $simplePie = $feed->load(false, $feedIsNew);
  522. }
  523. if ($simplePie === null) {
  524. // Feed is cached and unchanged
  525. $newGuids = [];
  526. $entries = [];
  527. $feedIsEmpty = false; // We do not know
  528. $feedIsUnchanged = true;
  529. } else {
  530. $newGuids = $feed->loadGuids($simplePie);
  531. $entries = $feed->loadEntries($simplePie);
  532. $feedIsEmpty = $simplePiePush === null && empty($newGuids);
  533. $feedIsUnchanged = false;
  534. }
  535. $mtime = $feed->cacheModifiedTime() ?: time();
  536. } catch (FreshRSS_Feed_Exception $e) {
  537. Minz_Log::warning($e->getMessage());
  538. $feedDAO->updateLastError($feed->id());
  539. $feed->_error(time());
  540. if ($e->getCode() === 410) {
  541. // HTTP 410 Gone
  542. Minz_Log::warning('Muting gone feed: ' . $feed->url(false));
  543. $feedDAO->mute($feed->id(), true);
  544. $feed->_ttl(-abs($feed->ttl())); // Replicate behavior of line above which acts directly into the DB
  545. }
  546. $feed->unlock();
  547. continue;
  548. }
  549. $needFeedCacheRefresh = false;
  550. $nbMarkedUnread = 0;
  551. if (count($newGuids) > 0) {
  552. if (!$feed->hasAttribute('read_when_same_title_in_feed')) {
  553. $readWhenSameTitleInFeed = (int)FreshRSS_Context::userConf()->mark_when['same_title_in_feed'];
  554. } elseif ($feed->attributeBoolean('read_when_same_title_in_feed') === false) {
  555. $readWhenSameTitleInFeed = 0;
  556. } else {
  557. $readWhenSameTitleInFeed = $feed->attributeInt('read_when_same_title_in_feed') ?? 0;
  558. }
  559. if ($readWhenSameTitleInFeed > 0) {
  560. $titlesAsRead = array_fill_keys($feedDAO->listTitles($feed->id(), $readWhenSameTitleInFeed), true);
  561. } else {
  562. $titlesAsRead = [];
  563. }
  564. $category = $feed->category();
  565. if (!isset($categoriesEntriesTitle[$feed->categoryId()]) && $category !== null && $category->hasAttribute('read_when_same_title_in_category')) {
  566. $categoriesEntriesTitle[$feed->categoryId()] = array_fill_keys(
  567. $catDAO->listTitles($feed->categoryId(), $category->attributeInt('read_when_same_title_in_category') ?? 0),
  568. true
  569. );
  570. }
  571. if (!isset($categoriesEntriesGuid[$feed->categoryId()]) && $category !== null && $category->hasAttribute('read_when_same_guid_in_category')) {
  572. $categoriesEntriesGuid[$feed->categoryId()] = array_fill_keys(
  573. $catDAO->listGuids($feed->categoryId(), $category->attributeInt('read_when_same_guid_in_category') ?? 0),
  574. true
  575. );
  576. }
  577. $mark_updated_article_unread = $feed->attributeBoolean('mark_updated_article_unread') ?? FreshRSS_Context::userConf()->mark_updated_article_unread;
  578. // For this feed, check existing GUIDs already in database.
  579. $existingHashForGuids = $entryDAO->listHashForFeedGuids($feed->id(), $newGuids);
  580. /** @var array<string,bool> $newGuids */
  581. $newGuids = [];
  582. // Add entries in database if possible.
  583. /** @var FreshRSS_Entry $entry */
  584. foreach ($entries as $entry) {
  585. if (isset($newGuids[$entry->guid()])) {
  586. continue; //Skip subsequent articles with same GUID
  587. }
  588. $newGuids[$entry->guid()] = true;
  589. $entry->_lastSeen($mtime);
  590. if (isset($existingHashForGuids[$entry->guid()])) {
  591. $existingHash = $existingHashForGuids[$entry->guid()];
  592. if (strcasecmp($existingHash, $entry->hash()) !== 0) {
  593. //This entry already exists but has been updated
  594. $entry->_isUpdated(true);
  595. $entry->_lastModified($mtime);
  596. //Minz_Log::debug('Entry with GUID `' . $entry->guid() . '` updated in feed ' . $feed->url(false) .
  597. //', old hash ' . $existingHash . ', new hash ' . $entry->hash());
  598. $entry->_isFavorite(null); // Do not change favourite state
  599. $entry->_isRead($mark_updated_article_unread ? false : null); //Change is_read according to policy.
  600. if ($mark_updated_article_unread) {
  601. Minz_ExtensionManager::callHook(Minz_HookType::EntryAutoUnread, $entry, 'updated_article');
  602. }
  603. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeInsert, $entry);
  604. if (!($entry instanceof FreshRSS_Entry)) {
  605. // An extension has returned a null value, there is nothing to insert.
  606. continue;
  607. }
  608. // NB: Do not mark updated articles as read based on their title, as the duplicate title maybe be from the same article.
  609. $entry->applyFilterActions([]);
  610. if ($readWhenSameTitleInFeed > 0) {
  611. $titlesAsRead[$entry->title()] = true;
  612. }
  613. if (isset($categoriesEntriesTitle[$feed->categoryId()])) {
  614. $categoriesEntriesTitle[$feed->categoryId()][$entry->title()] = true;
  615. }
  616. if (isset($categoriesEntriesGuid[$feed->categoryId()])) {
  617. $categoriesEntriesGuid[$feed->categoryId()][$entry->guid()] = true;
  618. }
  619. if (!$entry->isRead()) {
  620. $needFeedCacheRefresh = true; //Maybe
  621. $nbMarkedUnread++;
  622. }
  623. // If the entry has changed, there is a good chance for the full content to have changed as well.
  624. $entry->loadCompleteContent(true);
  625. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeUpdate, $entry);
  626. if (!($entry instanceof FreshRSS_Entry)) {
  627. // An extension has returned a null value, there is nothing to insert.
  628. continue;
  629. }
  630. $entryDAO->updateEntry($entry->toArray());
  631. }
  632. } else {
  633. $entry->_isUpdated(false);
  634. $id = uTimeString();
  635. $entry->_id($id);
  636. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeInsert, $entry);
  637. if (!($entry instanceof FreshRSS_Entry)) {
  638. // An extension has returned a null value, there is nothing to insert.
  639. continue;
  640. }
  641. $entry->applyFilterActions(array_merge($titlesAsRead, $categoriesEntriesTitle[$feed->categoryId()] ?? []),
  642. $categoriesEntriesGuid[$feed->categoryId()] ?? []);
  643. if ($readWhenSameTitleInFeed > 0) {
  644. $titlesAsRead[$entry->title()] = true;
  645. }
  646. if (isset($categoriesEntriesTitle[$feed->categoryId()])) {
  647. $categoriesEntriesTitle[$feed->categoryId()][$entry->title()] = true;
  648. }
  649. if (isset($categoriesEntriesGuid[$feed->categoryId()])) {
  650. $categoriesEntriesGuid[$feed->categoryId()][$entry->guid()] = true;
  651. }
  652. $needFeedCacheRefresh = true;
  653. if ($pubSubHubbubEnabled && $simplePiePush === null) { //We use push, but have discovered an article by pull!
  654. $text = 'An article was discovered by pull although we use PubSubHubbub!: Feed ' .
  655. \SimplePie\Misc::url_remove_credentials($url) .
  656. ' GUID ' . $entry->guid();
  657. Minz_Log::warning($text, PSHB_LOG);
  658. Minz_Log::warning($text);
  659. $pubSubHubbubEnabled = false;
  660. $feed->pubSubHubbubError(true);
  661. }
  662. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeAdd, $entry);
  663. if (!($entry instanceof FreshRSS_Entry)) {
  664. // An extension has returned a null value, there is nothing to insert.
  665. continue;
  666. }
  667. if ($entryDAO->addEntry($entry->toArray(), true)) {
  668. $nbNewArticles++;
  669. }
  670. }
  671. }
  672. // N.B.: Applies to _entry table and not _entrytmp:
  673. $entryDAO->updateLastSeen($feed->id(), array_keys($newGuids), $mtime);
  674. } elseif ($feedIsUnchanged) {
  675. // Feed cache was unchanged, so mark as seen the same entries as last time
  676. $entryDAO->updateLastSeenUnchanged($feed->id(), $mtime);
  677. }
  678. unset($entries);
  679. if (rand(0, 30) === 1) { // Remove old entries once in 30.
  680. $nb = $feed->cleanOldEntries();
  681. if ($nb > 0) {
  682. $needFeedCacheRefresh = true;
  683. }
  684. }
  685. if ($simplePiePush === null) { // Not WebSub
  686. $feedDAO->updateLastUpdate($feed->id(), $mtime);
  687. $feed->_lastUpdate($mtime);
  688. // Do not call for WebSub events, as we do not know the list of articles still on the upstream feed.
  689. $needFeedCacheRefresh |= ($feed->markAsReadUponGone($feedIsEmpty, $mtime) != false);
  690. } elseif ($feed->inError()) {
  691. // Reset feed error state in case of successful WebSub push
  692. $feedDAO->updateLastError($feed->id(), 0);
  693. $feed->_error(0);
  694. }
  695. if ($needFeedCacheRefresh) {
  696. $feedsCacheToRefresh[] = $feed;
  697. }
  698. $feedProperties = [];
  699. if ($oldSimplePieHash !== $feed->attributeString('SimplePieHash')) {
  700. $feedProperties['attributes'] = $feed->attributes();
  701. }
  702. if ($feed->url() !== $url) { // HTTP 301 Moved Permanently
  703. Minz_Log::warning('Feed ' . \SimplePie\Misc::url_remove_credentials($url) .
  704. ' moved permanently to ' . $feed->url(includeCredentials: false));
  705. $feedProperties['url'] = $feed->url();
  706. } elseif ($simplePiePush !== null && $selfUrl !== '' && $selfUrl !== $feed->url()) { // selfUrl has priority for WebSub
  707. // https://github.com/pubsubhubbub/PubSubHubbub/wiki/Moving-Feeds-or-changing-Hubs
  708. if (str_starts_with($feed->url(), 'https://') && !str_starts_with($selfUrl, 'https://')) {
  709. Minz_Log::debug('WebSub: refusing to downgrade to ' . \SimplePie\Misc::url_remove_credentials($selfUrl));
  710. } else {
  711. Minz_Log::debug('WebSub unsubscribe ' . $feed->url(includeCredentials: false));
  712. if (!$feed->pubSubHubbubSubscribe(false)) { //Unsubscribe
  713. Minz_Log::warning('Error while WebSub unsubscribing from ' . $feed->url(includeCredentials: false));
  714. }
  715. $feed->_url($selfUrl);
  716. Minz_Log::warning('Feed ' . \SimplePie\Misc::url_remove_credentials($url) .
  717. ' canonical address moved to ' . $feed->url(includeCredentials: false));
  718. $feedProperties['url'] = $feed->url();
  719. }
  720. }
  721. if ($simplePie != null) {
  722. $feedImageUrl = htmlspecialchars_decode($simplePie->get_icon_url() ?? '', ENT_QUOTES);
  723. $feedImageUrl = $feedImageUrl !== '' ? (FreshRSS_http_Util::checkUrl($feedImageUrl) ?: '') : '';
  724. if ($feedImageUrl !== ($feed->attributeString('feedIconUrl') ?? '')) {
  725. $feed->_attribute('feedIconUrl', $feedImageUrl !== '' ? $feedImageUrl : null);
  726. $feed->resetFaviconHash();
  727. $feedProperties['attributes'] = $feed->attributes();
  728. }
  729. if ($feed->name(true) === '') {
  730. //HTML to HTML-PRE //ENT_COMPAT except '&'
  731. $name = strtr(html_only_entity_decode($simplePie->get_title()), ['<' => '&lt;', '>' => '&gt;', '"' => '&quot;']);
  732. $feed->_name($name);
  733. $feedProperties['name'] = $feed->name(false);
  734. }
  735. if ($feed->website() === '' || $feed->website() === $feed->url()) {
  736. $website = html_only_entity_decode($simplePie->get_link());
  737. if ($website !== $feed->website()) {
  738. $feed->_website($website);
  739. $feedProperties['website'] = $feed->website();
  740. $feed->faviconPrepare();
  741. }
  742. }
  743. if (trim($feed->description()) === '') {
  744. $description = html_only_entity_decode($simplePie->get_description());
  745. if ($description !== '') {
  746. $feed->_description($description);
  747. $feedProperties['description'] = $feed->description();
  748. }
  749. }
  750. }
  751. if (!empty($feedProperties) || $feedIsNew) {
  752. $feedProperties['attributes'] = $feed->attributes();
  753. $ok = $feedDAO->updateFeed($feed->id(), $feedProperties);
  754. // No need to update $feed object, since $feedProperties are taken from the object itself
  755. if (!$ok && $feedIsNew) {
  756. //Cancel adding new feed in case of database error at first actualize
  757. $feedDAO->deleteFeed($feed->id());
  758. // TODO: Reflect in the $feed object the feed has been deleted.
  759. $feed->unlock();
  760. break;
  761. }
  762. }
  763. $feed->faviconPrepare();
  764. if ($pubsubhubbubEnabledGeneral && $feed->pubSubHubbubPrepare() != false) {
  765. Minz_Log::notice('WebSub subscribe ' . $feed->url(false));
  766. if (!$feed->pubSubHubbubSubscribe(true)) { //Subscribe
  767. Minz_Log::warning('Error while WebSub subscribing to ' . $feed->url(false));
  768. }
  769. }
  770. $feed->unlock();
  771. $nbUpdatedFeeds++;
  772. unset($feed);
  773. gc_collect_cycles();
  774. if ($nbUpdatedFeeds >= $maxFeeds) {
  775. break;
  776. }
  777. }
  778. return [$nbUpdatedFeeds, $firstFeed, $nbNewArticles, $feedsCacheToRefresh];
  779. }
  780. /**
  781. * Feeds on which to apply a the keep max unreads policy, or all feeds if none specified.
  782. * @return int The number of articles marked as read
  783. */
  784. private static function keepMaxUnreads(FreshRSS_Feed ...$feeds): int {
  785. $affected = 0;
  786. if (empty($feeds)) {
  787. $feedDAO = FreshRSS_Factory::createFeedDao();
  788. $feeds = $feedDAO->listFeedsOrderUpdate(-1);
  789. }
  790. foreach ($feeds as $feed) {
  791. $n = $feed->markAsReadMaxUnread();
  792. if ($n !== false && $n > 0) {
  793. Minz_Log::debug($n . ' unread entries exceeding max number of ' . $feed->keepMaxUnread() . ' for [' . $feed->url(false) . ']');
  794. $affected += $n;
  795. }
  796. }
  797. return $affected;
  798. }
  799. /**
  800. * Auto-add labels to new articles.
  801. * @param int $nbNewEntries The number of top recent entries to process.
  802. * @return int|false The number of new labels added, or false in case of error.
  803. */
  804. private static function applyLabelActions(int $nbNewEntries): int|false {
  805. $tagDAO = FreshRSS_Factory::createTagDao();
  806. $labels = FreshRSS_Context::labels();
  807. $labels = array_filter($labels, static fn(FreshRSS_Tag $label) => !empty($label->filtersAction('label')));
  808. if (count($labels) <= 0) {
  809. return 0;
  810. }
  811. $entryDAO = FreshRSS_Factory::createEntryDao();
  812. $applyLabels = [];
  813. foreach (FreshRSS_Entry::fromTraversable($entryDAO->selectAll(order: 'DESC', limit: $nbNewEntries)) as $entry) {
  814. foreach ($labels as $label) {
  815. $label->applyFilterActions($entry, $applyLabel);
  816. if ($applyLabel) {
  817. $applyLabels[] = [
  818. 'id_tag' => $label->id(),
  819. 'id_entry' => $entry->id(),
  820. ];
  821. }
  822. }
  823. }
  824. return $tagDAO->tagEntries($applyLabels);
  825. }
  826. public static function commitNewEntries(): int {
  827. $entryDAO = FreshRSS_Factory::createEntryDao();
  828. $nbNewEntries = $entryDAO->countNewEntries();
  829. if ($nbNewEntries > 0) {
  830. if ($entryDAO->commitNewEntries()) {
  831. self::applyLabelActions($nbNewEntries);
  832. }
  833. }
  834. return $nbNewEntries;
  835. }
  836. /**
  837. * @param FreshRSS_SimplePieCustom|null $simplePiePush Used by WebSub (PubSubHubbub) to push updates
  838. * @param string $selfUrl Used by WebSub (PubSubHubbub) to override the feed URL
  839. * @return array{0:int,1:FreshRSS_Feed|null,2:int,3:array<FreshRSS_Feed>} Number of updated feeds, first feed or null, number of new articles,
  840. * list of feeds for which a cache refresh is needed
  841. * @throws FreshRSS_BadUrl_Exception
  842. */
  843. public static function actualizeFeedsAndCommit(?int $feed_id = null, ?string $feed_url = null, ?int $maxFeeds = null,
  844. ?FreshRSS_SimplePieCustom $simplePiePush = null, string $selfUrl = ''): array {
  845. $entryDAO = FreshRSS_Factory::createEntryDao();
  846. [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh] =
  847. FreshRSS_feed_Controller::actualizeFeeds($feed_id, $feed_url, $maxFeeds, $simplePiePush, $selfUrl);
  848. if ($nbNewArticles > 0) {
  849. $entryDAO->beginTransaction();
  850. FreshRSS_feed_Controller::commitNewEntries();
  851. }
  852. if (count($feedsCacheToRefresh) > 0) {
  853. $feedDAO = FreshRSS_Factory::createFeedDao();
  854. self::keepMaxUnreads(...$feedsCacheToRefresh);
  855. $feedDAO->updateCachedValues(...array_map(fn(FreshRSS_Feed $f) => $f->id(), $feedsCacheToRefresh));
  856. }
  857. if ($entryDAO->inTransaction()) {
  858. $entryDAO->commit();
  859. }
  860. if (rand(0, 30) === 1) { // Remove old cache once in a while
  861. cleanCache(CLEANCACHE_HOURS);
  862. }
  863. return [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh];
  864. }
  865. /**
  866. * This action actualizes entries from one or several feeds.
  867. *
  868. * Parameters are:
  869. * - id (default: null): Feed ID, or set to -1 to commit new articles to the main database
  870. * - url (default: null): Feed URL (instead of feed ID)
  871. * - maxFeeds (default: 10): Max number of feeds to refresh
  872. * - noCommit (default: 0): Set to 1 to prevent committing the new articles to the main database
  873. * If id and url are not specified, all the feeds are actualized, within the limits of maxFeeds.
  874. */
  875. public function actualizeAction(): int {
  876. Minz_Session::_param('actualize_feeds', false);
  877. $id = Minz_Request::paramInt('id');
  878. $url = Minz_Request::paramString('url');
  879. $maxFeeds = Minz_Request::paramInt('maxFeeds') ?: 10;
  880. $noCommit = ($_POST['noCommit'] ?? 0) == 1;
  881. if ($id === -1 && !$noCommit) { //Special request only to commit & refresh DB cache
  882. $nbUpdatedFeeds = 0;
  883. $feed = null;
  884. FreshRSS_feed_Controller::commitNewEntries();
  885. $feedDAO = FreshRSS_Factory::createFeedDao();
  886. $feedDAO->updateCachedValues();
  887. } else {
  888. if (!$noCommit) {
  889. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  890. $databaseDAO->minorDbMaintenance();
  891. Minz_ExtensionManager::callHookVoid(Minz_HookType::FreshrssUserMaintenance);
  892. }
  893. if ($id === 0 && $url === '') {
  894. // Case of a batch refresh (e.g. cron)
  895. FreshRSS_feed_Controller::commitNewEntries();
  896. $feedDAO = FreshRSS_Factory::createFeedDao();
  897. $feedDAO->updateCachedValues();
  898. FreshRSS_category_Controller::refreshDynamicOpmls();
  899. }
  900. $entryDAO = FreshRSS_Factory::createEntryDao();
  901. [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh] = self::actualizeFeeds($id, $url, $maxFeeds);
  902. if (!$noCommit) {
  903. if ($nbNewArticles > 0) {
  904. $entryDAO->beginTransaction();
  905. FreshRSS_feed_Controller::commitNewEntries();
  906. }
  907. $feedDAO = FreshRSS_Factory::createFeedDao();
  908. if ($id !== 0 && $id !== -1) {
  909. if ($feed instanceof FreshRSS_Feed) {
  910. self::keepMaxUnreads($feed);
  911. }
  912. // Case of single feed refreshed, always update its cache
  913. $feedDAO->updateCachedValues($id);
  914. } elseif (count($feedsCacheToRefresh) > 0) {
  915. self::keepMaxUnreads(...$feedsCacheToRefresh);
  916. // Case of multiple feeds refreshed, only update cache of affected feeds
  917. $feedDAO->updateCachedValues(...array_map(fn(FreshRSS_Feed $f) => $f->id(), $feedsCacheToRefresh));
  918. }
  919. }
  920. if ($entryDAO->inTransaction()) {
  921. $entryDAO->commit();
  922. }
  923. }
  924. if (Minz_Request::paramBoolean('ajax')) {
  925. // Most of the time, ajax request is for only one feed. But since
  926. // there are several parallel requests, we should return that there
  927. // are several updated feeds.
  928. Minz_Request::setGoodNotification(_t('feedback.sub.feed.actualizeds'));
  929. // No layout in ajax request.
  930. $this->view->_layout(null);
  931. } elseif ($feed instanceof FreshRSS_Feed && $id > 0) {
  932. // Redirect to the main page with correct notification.
  933. Minz_Request::good(
  934. _t('feedback.sub.feed.actualized', $feed->name()),
  935. ['params' => ['get' => 'f_' . $id, 'id' => $id]],
  936. notificationName: 'actualizeAction',
  937. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0);
  938. } elseif ($nbUpdatedFeeds >= 1) {
  939. Minz_Request::good(
  940. _t('feedback.sub.feed.n_actualized', $nbUpdatedFeeds),
  941. [],
  942. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  943. );
  944. } else {
  945. Minz_Request::good(
  946. _t('feedback.sub.feed.no_refresh'),
  947. [],
  948. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  949. );
  950. }
  951. return $nbUpdatedFeeds;
  952. }
  953. /**
  954. * @throws Minz_ConfigurationNamespaceException
  955. * @throws Minz_PDOConnectionException
  956. */
  957. public static function renameFeed(int $feed_id, string $feed_name): bool {
  958. if ($feed_id <= 0 || $feed_name === '') {
  959. return false;
  960. }
  961. FreshRSS_UserDAO::touch();
  962. $feedDAO = FreshRSS_Factory::createFeedDao();
  963. return $feedDAO->updateFeed($feed_id, ['name' => $feed_name]);
  964. }
  965. public static function moveFeed(int $feed_id, int $cat_id, string $new_cat_name = ''): bool {
  966. if ($feed_id <= 0 || ($cat_id <= 0 && $new_cat_name === '')) {
  967. return false;
  968. }
  969. FreshRSS_UserDAO::touch();
  970. $catDAO = FreshRSS_Factory::createCategoryDao();
  971. if ($cat_id > 0) {
  972. $cat = $catDAO->searchById($cat_id);
  973. $cat_id = $cat === null ? 0 : $cat->id();
  974. }
  975. if ($cat_id <= 1 && $new_cat_name != '') {
  976. $cat_id = $catDAO->addCategory(['name' => $new_cat_name]);
  977. }
  978. if ($cat_id <= 1) {
  979. $catDAO->checkDefault();
  980. $cat_id = FreshRSS_CategoryDAO::DEFAULTCATEGORYID;
  981. }
  982. $feedDAO = FreshRSS_Factory::createFeedDao();
  983. return $feedDAO->updateFeed($feed_id, ['category' => $cat_id]);
  984. }
  985. /**
  986. * This action changes the category of a feed.
  987. *
  988. * This page must be reached by a POST request.
  989. *
  990. * Parameters are:
  991. * - f_id (default: false)
  992. * - c_id (default: false)
  993. * If c_id is false, default category is used.
  994. *
  995. * @todo should handle order of the feed inside the category.
  996. */
  997. public function moveAction(): void {
  998. if (!Minz_Request::isPost()) {
  999. Minz_Request::forward(['c' => 'subscription'], true);
  1000. }
  1001. $feed_id = Minz_Request::paramInt('f_id');
  1002. $cat_id = Minz_Request::paramInt('c_id');
  1003. if (self::moveFeed($feed_id, $cat_id)) {
  1004. // TODO: return something useful
  1005. // Log a notice to prevent "Empty IF statement" warning in PHP_CodeSniffer
  1006. Minz_Log::notice('Moved feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  1007. } else {
  1008. Minz_Log::warning('Cannot move feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  1009. Minz_Error::error(404);
  1010. }
  1011. }
  1012. public static function deleteFeed(int $feed_id): bool {
  1013. FreshRSS_UserDAO::touch();
  1014. $feedDAO = FreshRSS_Factory::createFeedDao();
  1015. $feed = $feedDAO->searchById($feed_id);
  1016. if ($feed === null) {
  1017. return false;
  1018. }
  1019. if ($feedDAO->deleteFeed($feed_id)) {
  1020. // TODO: Delete old favicon (non-custom)
  1021. if ($feed->customFavicon() && !$feed->attributeBoolean('customFaviconDisallowDel')) {
  1022. FreshRSS_Feed::faviconDelete($feed->hashFavicon());
  1023. }
  1024. // Remove related queries
  1025. $queries = FreshRSS_UserQuery::remove_query_by_get('f_' . $feed_id, FreshRSS_Context::userConf()->queries);
  1026. FreshRSS_Context::userConf()->queries = $queries;
  1027. FreshRSS_Context::userConf()->save();
  1028. return true;
  1029. }
  1030. return false;
  1031. }
  1032. /**
  1033. * This action deletes a feed.
  1034. *
  1035. * This page must be reached by a POST request.
  1036. * If there are related queries, they are deleted too.
  1037. *
  1038. * Parameters are:
  1039. * - id (default: false)
  1040. */
  1041. public function deleteAction(): void {
  1042. if (!Minz_Request::isPost()) {
  1043. Minz_Request::forward(['c' => 'subscription'], true);
  1044. }
  1045. $from = Minz_Request::paramString('from');
  1046. $id = Minz_Request::paramInt('id');
  1047. switch ($from) {
  1048. case 'stats':
  1049. $redirect_url = ['c' => 'stats', 'a' => 'idle'];
  1050. break;
  1051. case 'normal':
  1052. $get = Minz_Request::paramString('get');
  1053. if ($get !== '') {
  1054. $redirect_url = ['c' => 'index', 'a' => 'normal', 'params' => ['get' => $get]];
  1055. } else {
  1056. $redirect_url = ['c' => 'index', 'a' => 'normal'];
  1057. }
  1058. break;
  1059. default:
  1060. $redirect_url = ['c' => 'subscription', 'a' => 'index'];
  1061. if (!Minz_Request::isPost()) {
  1062. Minz_Request::forward($redirect_url, true);
  1063. }
  1064. }
  1065. if (self::deleteFeed($id)) {
  1066. Minz_Request::good(
  1067. _t('feedback.sub.feed.deleted'),
  1068. $redirect_url,
  1069. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1070. );
  1071. } else {
  1072. Minz_Request::bad(_t('feedback.sub.feed.error'), $redirect_url);
  1073. }
  1074. }
  1075. /**
  1076. * This action force clears the cache of a feed.
  1077. *
  1078. * Parameters are:
  1079. * - id (mandatory - no default): Feed ID
  1080. *
  1081. */
  1082. public function clearCacheAction(): void {
  1083. if (!Minz_Request::isPost()) {
  1084. Minz_Request::forward(['c' => 'subscription'], true);
  1085. }
  1086. //Get Feed.
  1087. $id = Minz_Request::paramInt('id');
  1088. $feedDAO = FreshRSS_Factory::createFeedDao();
  1089. $feed = $feedDAO->searchById($id);
  1090. if ($feed === null) {
  1091. Minz_Request::bad(_t('feedback.sub.feed.not_found'), []);
  1092. return;
  1093. }
  1094. $feed->clearCache();
  1095. Minz_Request::good(
  1096. _t('feedback.sub.feed.cache_cleared', $feed->name()),
  1097. ['params' => ['get' => 'f_' . $feed->id(), 'id' => $feed->id()]],
  1098. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1099. );
  1100. }
  1101. /**
  1102. * This action forces reloading the articles of a feed.
  1103. *
  1104. * Parameters are:
  1105. * - id (mandatory - no default): Feed ID
  1106. *
  1107. * @throws FreshRSS_BadUrl_Exception
  1108. */
  1109. public function reloadAction(): void {
  1110. if (!Minz_Request::isPost()) {
  1111. Minz_Request::forward(['c' => 'subscription'], true);
  1112. }
  1113. if (function_exists('set_time_limit')) {
  1114. @set_time_limit(300);
  1115. }
  1116. //Get Feed ID.
  1117. $feed_id = Minz_Request::paramInt('id');
  1118. $limit = Minz_Request::paramInt('reload_limit') ?: 10;
  1119. $feedDAO = FreshRSS_Factory::createFeedDao();
  1120. $feed = $feedDAO->searchById($feed_id);
  1121. if ($feed === null) {
  1122. Minz_Request::bad(_t('feedback.sub.feed.not_found'), []);
  1123. return;
  1124. }
  1125. //Re-fetch articles as if the feed was new.
  1126. $feedDAO->updateFeed($feed->id(), [ 'lastUpdate' => 0 ]);
  1127. self::actualizeFeedsAndCommit($feed_id);
  1128. //Extract all feed entries from database, load complete content and store them back in database.
  1129. $entryDAO = FreshRSS_Factory::createEntryDao();
  1130. $entries = $entryDAO->listWhere('f', $feed_id, FreshRSS_Entry::STATE_ALL, order: 'DESC', limit: $limit);
  1131. //We need another DB connection in parallel for unbuffered streaming
  1132. Minz_ModelPdo::$usesSharedPdo = false;
  1133. if (FreshRSS_Context::systemConf()->db['type'] === 'mysql') {
  1134. // Second parallel connection for unbuffered streaming: MySQL
  1135. $entryDAO2 = FreshRSS_Factory::createEntryDao();
  1136. } else {
  1137. // Single connection for buffered queries (in memory): SQLite, PostgreSQL
  1138. //TODO: Consider an unbuffered query for PostgreSQL
  1139. $entryDAO2 = $entryDAO;
  1140. }
  1141. foreach ($entries as $entry) {
  1142. $oldContent = $entry->content(withEnclosures: false);
  1143. if ($entry->loadCompleteContent(true)) {
  1144. $entry->_lastModified(time());
  1145. if ($entry->content(withEnclosures: false) !== $oldContent) {
  1146. $entryDAO2->updateEntry($entry->toArray());
  1147. }
  1148. }
  1149. }
  1150. Minz_ModelPdo::$usesSharedPdo = true;
  1151. //Give feedback to user.
  1152. Minz_Request::good(
  1153. _t('feedback.sub.feed.reloaded', $feed->name()),
  1154. ['params' => ['get' => 'f_' . $feed->id(), 'id' => $feed->id()]],
  1155. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1156. );
  1157. }
  1158. /**
  1159. * This action creates a preview of a content-selector.
  1160. *
  1161. * Parameters are:
  1162. * - id (mandatory - no default): Feed ID
  1163. * - selector (mandatory - no default): Selector to preview
  1164. *
  1165. */
  1166. public function contentSelectorPreviewAction(): void {
  1167. //Configure.
  1168. $this->view->fatalError = '';
  1169. $this->view->selectorSuccess = false;
  1170. $this->view->htmlContent = '';
  1171. $this->view->_layout(null);
  1172. $this->_csp([
  1173. 'default-src' => "'self'",
  1174. 'frame-ancestors' => "'self'",
  1175. 'frame-src' => '*',
  1176. 'img-src' => '* data:',
  1177. 'media-src' => '*',
  1178. ]);
  1179. //Get parameters.
  1180. $feed_id = Minz_Request::paramInt('id');
  1181. $content_selector = Minz_Request::paramString('selector');
  1182. if ($content_selector === '') {
  1183. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.selector_empty');
  1184. return;
  1185. }
  1186. //Check Feed ID validity.
  1187. $entryDAO = FreshRSS_Factory::createEntryDao();
  1188. $entries = $entryDAO->listWhere('f', $feed_id);
  1189. $entry = null;
  1190. //Get first entry (syntax robust for Generator or Array)
  1191. foreach ($entries as $myEntry) {
  1192. $entry = $myEntry;
  1193. }
  1194. if ($entry == null) {
  1195. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_entries');
  1196. return;
  1197. }
  1198. //Get feed.
  1199. $feed = $entry->feed();
  1200. if ($feed === null) {
  1201. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_feed');
  1202. return;
  1203. }
  1204. $feed->_pathEntries($content_selector);
  1205. $feed->_attribute('path_entries_filter', Minz_Request::paramString('selector_filter', true));
  1206. //Fetch & select content.
  1207. try {
  1208. $fullContent = $entry->getContentByParsing();
  1209. if ($fullContent != '') {
  1210. $this->view->selectorSuccess = true;
  1211. $this->view->htmlContent = $fullContent;
  1212. } else {
  1213. $this->view->selectorSuccess = false;
  1214. $this->view->htmlContent = $entry->content(false);
  1215. }
  1216. } catch (Exception) {
  1217. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.http_error');
  1218. }
  1219. }
  1220. }