feedController.php 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301
  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. $allow_anonymous_refresh = FreshRSS_Context::systemConf()->allow_anonymous_refresh;
  17. // Likely coming from bookmarklet, redirect to the login page
  18. if ($action === 'add') {
  19. Minz_Request::forward(['c' => 'auth', 'a' => 'login']);
  20. return;
  21. }
  22. if ($action !== 'actualize' || (!$allow_anonymous_refresh && !Minz_Request::tokenIsOk())) {
  23. Minz_Error::error(403);
  24. }
  25. }
  26. }
  27. /**
  28. * @param array<string,mixed> $attributes
  29. * @throws FreshRSS_AlreadySubscribed_Exception
  30. * @throws FreshRSS_BadUrl_Exception
  31. * @throws FreshRSS_Feed_Exception
  32. * @throws FreshRSS_FeedNotAdded_Exception
  33. * @throws Minz_FileNotExistException
  34. */
  35. public static function addFeed(string $url, string $title = '', int $cat_id = 0, string $new_cat_name = '',
  36. string $http_auth = '', array $attributes = [], int $kind = FreshRSS_Feed::KIND_RSS): FreshRSS_Feed {
  37. FreshRSS_UserDAO::touch();
  38. if (function_exists('set_time_limit')) {
  39. @set_time_limit(300);
  40. }
  41. $catDAO = FreshRSS_Factory::createCategoryDao();
  42. $url = trim($url);
  43. /** @var string|null $urlHooked */
  44. $urlHooked = Minz_ExtensionManager::callHook(Minz_HookType::CheckUrlBeforeAdd, $url);
  45. if ($urlHooked === null) {
  46. throw new FreshRSS_FeedNotAdded_Exception($url);
  47. }
  48. $url = $urlHooked;
  49. $cat = null;
  50. if ($cat_id > 0) {
  51. $cat = $catDAO->searchById($cat_id);
  52. }
  53. if ($cat === null && $new_cat_name != '') {
  54. $new_cat_id = $catDAO->addCategory(['name' => $new_cat_name]);
  55. $cat_id = $new_cat_id > 0 ? $new_cat_id : $cat_id;
  56. $cat = $catDAO->searchById($cat_id);
  57. }
  58. if ($cat === null) {
  59. $catDAO->checkDefault();
  60. }
  61. $feed = new FreshRSS_Feed($url); //Throws FreshRSS_BadUrl_Exception
  62. $title = trim($title);
  63. if ($title !== '') {
  64. $feed->_name($title);
  65. }
  66. $feed->_kind($kind);
  67. $feed->_attributes($attributes);
  68. $feed->_httpAuth($http_auth);
  69. if ($cat === null) {
  70. $feed->_categoryId(FreshRSS_CategoryDAO::DEFAULTCATEGORYID);
  71. } else {
  72. $feed->_category($cat);
  73. }
  74. switch ($kind) {
  75. case FreshRSS_Feed::KIND_RSS:
  76. case FreshRSS_Feed::KIND_RSS_FORCED:
  77. if ($feed->load(loadDetails: true) === null) { // Throws FreshRSS_Feed_Exception, Minz_FileNotExistException
  78. throw new FreshRSS_FeedNotAdded_Exception($url);
  79. }
  80. break;
  81. case FreshRSS_Feed::KIND_HTML_XPATH:
  82. case FreshRSS_Feed::KIND_XML_XPATH:
  83. $feed->_website($url);
  84. break;
  85. }
  86. $feedDAO = FreshRSS_Factory::createFeedDao();
  87. if ($feedDAO->searchByUrl($feed->url()) !== null) {
  88. throw new FreshRSS_AlreadySubscribed_Exception($url, $feed->name());
  89. }
  90. /** @var FreshRSS_Feed|null $feed */
  91. $feed = Minz_ExtensionManager::callHook(Minz_HookType::FeedBeforeInsert, $feed);
  92. if ($feed === null) {
  93. throw new FreshRSS_FeedNotAdded_Exception($url);
  94. }
  95. $id = $feedDAO->addFeedObject($feed);
  96. if (!$id) {
  97. // There was an error in database… we cannot say what here.
  98. throw new FreshRSS_FeedNotAdded_Exception($url);
  99. }
  100. $feed->_id($id);
  101. // Ok, feed has been added in database. Now we have to refresh entries.
  102. self::actualizeFeedsAndCommit($id, $url);
  103. return $feed;
  104. }
  105. /**
  106. * This action subscribes to a feed.
  107. *
  108. * It can be reached by both GET and POST requests.
  109. *
  110. * GET request displays a form to add and configure a feed.
  111. * Request parameter is:
  112. * - url_rss (default: false)
  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] = 1;
  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 : $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, we redirect to feed configuration page.
  312. $url_redirect['a'] = 'feed';
  313. $url_redirect['params']['id'] = '' . $feed->id();
  314. Minz_Request::good(
  315. _t('feedback.sub.feed.added', $feed->name()),
  316. $url_redirect,
  317. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  318. );
  319. } else {
  320. // GET request: we must ask confirmation to user before adding feed.
  321. FreshRSS_View::prependTitle(_t('sub.feed.title_add') . ' · ');
  322. $catDAO = FreshRSS_Factory::createCategoryDao();
  323. $this->view->categories = $catDAO->listCategories(prePopulateFeeds: false);
  324. $this->view->feed = new FreshRSS_Feed($url);
  325. try {
  326. // We try to get more information about the feed.
  327. $this->view->feed->load(loadDetails: true);
  328. $this->view->load_ok = true;
  329. } catch (Exception) {
  330. $this->view->load_ok = false;
  331. }
  332. $feed = $feedDAO->searchByUrl($this->view->feed->url());
  333. if ($feed !== null) {
  334. // Already subscribe so we redirect to the feed configuration page.
  335. $url_redirect['a'] = 'feed';
  336. $url_redirect['params']['id'] = $feed->id();
  337. Minz_Request::good(
  338. _t('feedback.sub.feed.already_subscribed', $feed->name()),
  339. $url_redirect,
  340. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  341. );
  342. }
  343. }
  344. }
  345. /**
  346. * This action remove entries from a given feed.
  347. *
  348. * It should be reached by a POST action.
  349. *
  350. * Parameter is:
  351. * - id (default: false)
  352. */
  353. public function truncateAction(): void {
  354. if (!Minz_Request::isPost()) {
  355. Minz_Request::forward(['c' => 'subscription'], true);
  356. }
  357. $id = Minz_Request::paramInt('id');
  358. $url_redirect = [
  359. 'c' => 'subscription',
  360. 'a' => 'index',
  361. 'params' => ['id' => $id],
  362. ];
  363. if (!Minz_Request::isPost()) {
  364. Minz_Request::forward($url_redirect, true);
  365. }
  366. $feedDAO = FreshRSS_Factory::createFeedDao();
  367. $n = $feedDAO->truncate($id);
  368. invalidateHttpCache();
  369. if ($n === false) {
  370. Minz_Request::bad(_t('feedback.sub.feed.error'), $url_redirect);
  371. } else {
  372. Minz_Request::good(
  373. _t('feedback.sub.feed.n_entries_deleted', $n),
  374. $url_redirect,
  375. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  376. );
  377. }
  378. }
  379. /**
  380. * @param FreshRSS_SimplePieCustom|null $simplePiePush Used by WebSub (PubSubHubbub) to push updates
  381. * @param string $selfUrl Used by WebSub (PubSubHubbub) to override the feed URL
  382. * @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,
  383. * list of feeds for which a cache refresh is needed
  384. * @throws FreshRSS_BadUrl_Exception
  385. */
  386. public static function actualizeFeeds(?int $feed_id = null, ?string $feed_url = null, ?int $maxFeeds = null,
  387. ?FreshRSS_SimplePieCustom $simplePiePush = null, string $selfUrl = ''): array {
  388. if (function_exists('set_time_limit')) {
  389. @set_time_limit(300);
  390. }
  391. if (!is_int($feed_id) || $feed_id <= 0) {
  392. $feed_id = null;
  393. }
  394. if (!is_string($feed_url) || trim($feed_url) === '') {
  395. $feed_url = null;
  396. }
  397. if (!is_int($maxFeeds) || $maxFeeds <= 0) {
  398. $maxFeeds = PHP_INT_MAX;
  399. }
  400. $catDAO = FreshRSS_Factory::createCategoryDao();
  401. $feedDAO = FreshRSS_Factory::createFeedDao();
  402. $entryDAO = FreshRSS_Factory::createEntryDao();
  403. // Create a list of feeds to actualize.
  404. $feeds = [];
  405. if ($feed_id !== null || $feed_url !== null) {
  406. $feed = $feed_id !== null ? $feedDAO->searchById($feed_id) : $feedDAO->searchByUrl($feed_url);
  407. if ($feed !== null && $feed->id() > 0) {
  408. if ($selfUrl !== '') {
  409. $feed->_selfUrl($selfUrl);
  410. }
  411. $feeds[] = $feed;
  412. $feed_id = $feed->id();
  413. }
  414. } else {
  415. $feeds = $feedDAO->listFeedsOrderUpdate(-1);
  416. // Hydrate category for each feed to avoid that each feed has to make an SQL request
  417. $categories = $catDAO->listCategories(prePopulateFeeds: false, details: false);
  418. foreach ($feeds as $feed) {
  419. $category = $categories[$feed->categoryId()] ?? null;
  420. if ($category !== null) {
  421. $feed->_category($category);
  422. }
  423. }
  424. }
  425. // WebSub (PubSubHubbub) support
  426. $pubsubhubbubEnabledGeneral = FreshRSS_Context::systemConf()->pubsubhubbub_enabled;
  427. $pshbMinAge = time() - (3600 * 24); //TODO: Make a configuration.
  428. $nbUpdatedFeeds = 0;
  429. $nbNewArticles = 0;
  430. $feedsCacheToRefresh = [];
  431. /** @var array<int,array<string,true>> */
  432. $categoriesEntriesTitle = [];
  433. $feeds = Minz_ExtensionManager::callHook(Minz_HookType::FeedsListBeforeActualize, $feeds);
  434. if (is_array($feeds)) {
  435. $feeds = array_filter($feeds, static fn($feed): bool => $feed instanceof FreshRSS_Feed);
  436. } else {
  437. $feeds = [];
  438. }
  439. foreach ($feeds as $feed) {
  440. $feed = Minz_ExtensionManager::callHook(Minz_HookType::FeedBeforeActualize, $feed);
  441. if (!($feed instanceof FreshRSS_Feed)) {
  442. continue;
  443. }
  444. $url = $feed->url(); //For detection of HTTP 301
  445. $oldSimplePieHash = $feed->attributeString('SimplePieHash');
  446. $pubSubHubbubEnabled = $pubsubhubbubEnabledGeneral && $feed->pubSubHubbubEnabled();
  447. if ($simplePiePush === null && $feed_id === null && $pubSubHubbubEnabled && ($feed->lastUpdate() > $pshbMinAge)) {
  448. //$text = 'Skip pull of feed using PubSubHubbub: ' . $url;
  449. //Minz_Log::debug($text);
  450. //Minz_Log::debug($text, PSHB_LOG);
  451. continue; //When PubSubHubbub is used, do not pull refresh so often
  452. }
  453. if ($feed->mute() && ($feed_id === null || $simplePiePush !== null)) {
  454. continue; // If the feed is disabled, only allow refresh if manually requested for that specific feed
  455. }
  456. $mtime = $feed->cacheModifiedTime() ?: 0;
  457. $ttl = $feed->ttl();
  458. if ($ttl === FreshRSS_Feed::TTL_DEFAULT) {
  459. $ttl = FreshRSS_Context::userConf()->ttl_default;
  460. }
  461. if ($simplePiePush === null && $feed_id === null && (time() <= $feed->lastUpdate() + $ttl)) {
  462. //Too early to refresh from source, but check whether the feed was updated by another user
  463. $ε = 10; // negligible offset errors in seconds
  464. if ($mtime <= 0 ||
  465. $feed->lastUpdate() + $ε >= $mtime ||
  466. time() + $ε >= $mtime + FreshRSS_Context::systemConf()->limits['cache_duration']) { // is cache still valid?
  467. continue; //Nothing newer from other users
  468. }
  469. Minz_Log::debug('Feed ' . $feed->url(false) . ' was updated at ' . date('c', $feed->lastUpdate()) .
  470. ', and at ' . date('c', $mtime) . ' by another user; take advantage of newer cache.');
  471. }
  472. if (!$feed->lock()) {
  473. Minz_Log::notice('Feed already being actualized: ' . $feed->url(false));
  474. continue;
  475. }
  476. $feedIsNew = $feed->lastUpdate() <= 0;
  477. try {
  478. if ($simplePiePush !== null) {
  479. $simplePie = $simplePiePush; //Used by WebSub
  480. } elseif ($feed->kind() === FreshRSS_Feed::KIND_HTML_XPATH) {
  481. $simplePie = $feed->loadHtmlXpath();
  482. if ($simplePie === null) {
  483. throw new FreshRSS_Feed_Exception('HTML+XPath Web scraping failed for [' . $feed->url(false) . ']');
  484. }
  485. } elseif ($feed->kind() === FreshRSS_Feed::KIND_XML_XPATH) {
  486. $simplePie = $feed->loadHtmlXpath();
  487. if ($simplePie === null) {
  488. throw new FreshRSS_Feed_Exception('XML+XPath parsing failed for [' . $feed->url(false) . ']');
  489. }
  490. } elseif ($feed->kind() === FreshRSS_Feed::KIND_JSON_DOTNOTATION) {
  491. $simplePie = $feed->loadJson();
  492. if ($simplePie === null) {
  493. throw new FreshRSS_Feed_Exception('JSON dot notation parsing failed for [' . $feed->url(false) . ']');
  494. }
  495. } elseif ($feed->kind() === FreshRSS_Feed::KIND_JSONFEED) {
  496. $simplePie = $feed->loadJson();
  497. if ($simplePie === null) {
  498. throw new FreshRSS_Feed_Exception('JSON Feed parsing failed for [' . $feed->url(false) . ']');
  499. }
  500. } elseif ($feed->kind() === FreshRSS_Feed::KIND_HTML_XPATH_JSON_DOTNOTATION) {
  501. $simplePie = $feed->loadJson();
  502. if ($simplePie === null) {
  503. throw new FreshRSS_Feed_Exception('HTML+XPath+JSON parsing failed for [' . $feed->url(false) . ']');
  504. }
  505. } else {
  506. $simplePie = $feed->load(false, $feedIsNew);
  507. }
  508. if ($simplePie === null) {
  509. // Feed is cached and unchanged
  510. $newGuids = [];
  511. $entries = [];
  512. $feedIsEmpty = false; // We do not know
  513. $feedIsUnchanged = true;
  514. } else {
  515. $newGuids = $feed->loadGuids($simplePie);
  516. $entries = $feed->loadEntries($simplePie);
  517. $feedIsEmpty = $simplePiePush === null && empty($newGuids);
  518. $feedIsUnchanged = false;
  519. }
  520. $mtime = $feed->cacheModifiedTime() ?: time();
  521. } catch (FreshRSS_Feed_Exception $e) {
  522. Minz_Log::warning($e->getMessage());
  523. $feedDAO->updateLastUpdate($feed->id(), true);
  524. if ($e->getCode() === 410) {
  525. // HTTP 410 Gone
  526. Minz_Log::warning('Muting gone feed: ' . $feed->url(false));
  527. $feedDAO->mute($feed->id(), true);
  528. }
  529. $feed->unlock();
  530. continue;
  531. }
  532. $needFeedCacheRefresh = false;
  533. $nbMarkedUnread = 0;
  534. if (count($newGuids) > 0) {
  535. if (!$feed->hasAttribute('read_when_same_title_in_feed')) {
  536. $readWhenSameTitleInFeed = (int)FreshRSS_Context::userConf()->mark_when['same_title_in_feed'];
  537. } elseif ($feed->attributeBoolean('read_when_same_title_in_feed') === false) {
  538. $readWhenSameTitleInFeed = 0;
  539. } else {
  540. $readWhenSameTitleInFeed = $feed->attributeInt('read_when_same_title_in_feed') ?? 0;
  541. }
  542. if ($readWhenSameTitleInFeed > 0) {
  543. $titlesAsRead = array_fill_keys($feedDAO->listTitles($feed->id(), $readWhenSameTitleInFeed), true);
  544. } else {
  545. $titlesAsRead = [];
  546. }
  547. $category = $feed->category();
  548. if (!isset($categoriesEntriesTitle[$feed->categoryId()]) && $category !== null && $category->hasAttribute('read_when_same_title_in_category')) {
  549. $categoriesEntriesTitle[$feed->categoryId()] = array_fill_keys(
  550. $catDAO->listTitles($feed->categoryId(), $category->attributeInt('read_when_same_title_in_category') ?? 0),
  551. true
  552. );
  553. }
  554. $mark_updated_article_unread = $feed->attributeBoolean('mark_updated_article_unread') ?? FreshRSS_Context::userConf()->mark_updated_article_unread;
  555. // For this feed, check existing GUIDs already in database.
  556. $existingHashForGuids = $entryDAO->listHashForFeedGuids($feed->id(), $newGuids);
  557. /** @var array<string,bool> $newGuids */
  558. $newGuids = [];
  559. // Add entries in database if possible.
  560. /** @var FreshRSS_Entry $entry */
  561. foreach ($entries as $entry) {
  562. if (isset($newGuids[$entry->guid()])) {
  563. continue; //Skip subsequent articles with same GUID
  564. }
  565. $newGuids[$entry->guid()] = true;
  566. $entry->_lastSeen($mtime);
  567. if (isset($existingHashForGuids[$entry->guid()])) {
  568. $existingHash = $existingHashForGuids[$entry->guid()];
  569. if (strcasecmp($existingHash, $entry->hash()) !== 0) {
  570. //This entry already exists but has been updated
  571. $entry->_isUpdated(true);
  572. $entry->_lastModified($mtime);
  573. //Minz_Log::debug('Entry with GUID `' . $entry->guid() . '` updated in feed ' . $feed->url(false) .
  574. //', old hash ' . $existingHash . ', new hash ' . $entry->hash());
  575. $entry->_isFavorite(null); // Do not change favourite state
  576. $entry->_isRead($mark_updated_article_unread ? false : null); //Change is_read according to policy.
  577. if ($mark_updated_article_unread) {
  578. Minz_ExtensionManager::callHook(Minz_HookType::EntryAutoUnread, $entry, 'updated_article');
  579. }
  580. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeInsert, $entry);
  581. if (!($entry instanceof FreshRSS_Entry)) {
  582. // An extension has returned a null value, there is nothing to insert.
  583. continue;
  584. }
  585. // NB: Do not mark updated articles as read based on their title, as the duplicate title maybe be from the same article.
  586. $entry->applyFilterActions([]);
  587. if ($readWhenSameTitleInFeed > 0) {
  588. $titlesAsRead[$entry->title()] = true;
  589. }
  590. if (isset($categoriesEntriesTitle[$feed->categoryId()])) {
  591. $categoriesEntriesTitle[$feed->categoryId()][$entry->title()] = true;
  592. }
  593. if (!$entry->isRead()) {
  594. $needFeedCacheRefresh = true; //Maybe
  595. $nbMarkedUnread++;
  596. }
  597. // If the entry has changed, there is a good chance for the full content to have changed as well.
  598. $entry->loadCompleteContent(true);
  599. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeUpdate, $entry);
  600. if (!($entry instanceof FreshRSS_Entry)) {
  601. // An extension has returned a null value, there is nothing to insert.
  602. continue;
  603. }
  604. $entryDAO->updateEntry($entry->toArray());
  605. }
  606. } else {
  607. $entry->_isUpdated(false);
  608. $id = uTimeString();
  609. $entry->_id($id);
  610. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeInsert, $entry);
  611. if (!($entry instanceof FreshRSS_Entry)) {
  612. // An extension has returned a null value, there is nothing to insert.
  613. continue;
  614. }
  615. $entry->applyFilterActions(array_merge($titlesAsRead, $categoriesEntriesTitle[$feed->categoryId()] ?? []));
  616. if ($readWhenSameTitleInFeed > 0) {
  617. $titlesAsRead[$entry->title()] = true;
  618. }
  619. if (isset($categoriesEntriesTitle[$feed->categoryId()])) {
  620. $categoriesEntriesTitle[$feed->categoryId()][$entry->title()] = true;
  621. }
  622. $needFeedCacheRefresh = true;
  623. if ($pubSubHubbubEnabled && $simplePiePush === null) { //We use push, but have discovered an article by pull!
  624. $text = 'An article was discovered by pull although we use PubSubHubbub!: Feed ' .
  625. \SimplePie\Misc::url_remove_credentials($url) .
  626. ' GUID ' . $entry->guid();
  627. Minz_Log::warning($text, PSHB_LOG);
  628. Minz_Log::warning($text);
  629. $pubSubHubbubEnabled = false;
  630. $feed->pubSubHubbubError(true);
  631. }
  632. $entry = Minz_ExtensionManager::callHook(Minz_HookType::EntryBeforeAdd, $entry);
  633. if (!($entry instanceof FreshRSS_Entry)) {
  634. // An extension has returned a null value, there is nothing to insert.
  635. continue;
  636. }
  637. if ($entryDAO->addEntry($entry->toArray(), true)) {
  638. $nbNewArticles++;
  639. }
  640. }
  641. }
  642. // N.B.: Applies to _entry table and not _entrytmp:
  643. $entryDAO->updateLastSeen($feed->id(), array_keys($newGuids), $mtime);
  644. } elseif ($feedIsUnchanged) {
  645. // Feed cache was unchanged, so mark as seen the same entries as last time
  646. $entryDAO->updateLastSeenUnchanged($feed->id(), $mtime);
  647. }
  648. unset($entries);
  649. if (rand(0, 30) === 1) { // Remove old entries once in 30.
  650. $nb = $feed->cleanOldEntries();
  651. if ($nb > 0) {
  652. $needFeedCacheRefresh = true;
  653. }
  654. }
  655. $feedDAO->updateLastUpdate($feed->id(), false, $mtime);
  656. if ($simplePiePush === null) {
  657. // Do not call for WebSub events, as we do not know the list of articles still on the upstream feed.
  658. $needFeedCacheRefresh |= ($feed->markAsReadUponGone($feedIsEmpty, $mtime) != false);
  659. }
  660. if ($needFeedCacheRefresh) {
  661. $feedsCacheToRefresh[] = $feed;
  662. }
  663. $feedProperties = [];
  664. if ($oldSimplePieHash !== $feed->attributeString('SimplePieHash')) {
  665. $feedProperties['attributes'] = $feed->attributes();
  666. }
  667. if ($feed->url() !== $url) { // HTTP 301 Moved Permanently
  668. Minz_Log::warning('Feed ' . \SimplePie\Misc::url_remove_credentials($url) .
  669. ' moved permanently to ' . $feed->url(includeCredentials: false));
  670. $feedProperties['url'] = $feed->url();
  671. } elseif ($simplePiePush !== null && $selfUrl !== '' && $selfUrl !== $feed->url()) { // selfUrl has priority for WebSub
  672. // https://github.com/pubsubhubbub/PubSubHubbub/wiki/Moving-Feeds-or-changing-Hubs
  673. Minz_Log::debug('WebSub unsubscribe ' . $feed->url(includeCredentials: false));
  674. if (!$feed->pubSubHubbubSubscribe(false)) { //Unsubscribe
  675. Minz_Log::warning('Error while WebSub unsubscribing from ' . $feed->url(includeCredentials: false));
  676. }
  677. $feed->_url($selfUrl);
  678. Minz_Log::warning('Feed ' . \SimplePie\Misc::url_remove_credentials($url) .
  679. ' canonical address moved to ' . $feed->url(includeCredentials: false));
  680. $feedProperties['url'] = $feed->url();
  681. }
  682. if ($simplePie != null) {
  683. $feedImageUrl = htmlspecialchars_decode($simplePie->get_icon_url() ?? '', ENT_QUOTES);
  684. $feedImageUrl = $feedImageUrl !== '' ? (FreshRSS_http_Util::checkUrl($feedImageUrl) ?: '') : '';
  685. if ($feedImageUrl !== ($feed->attributeString('feedIconUrl') ?? '')) {
  686. $feed->_attribute('feedIconUrl', $feedImageUrl !== '' ? $feedImageUrl : null);
  687. $feed->resetFaviconHash();
  688. $feedProperties['attributes'] = $feed->attributes();
  689. }
  690. if ($feed->name(true) === '') {
  691. //HTML to HTML-PRE //ENT_COMPAT except '&'
  692. $name = strtr(html_only_entity_decode($simplePie->get_title()), ['<' => '&lt;', '>' => '&gt;', '"' => '&quot;']);
  693. $feed->_name($name);
  694. $feedProperties['name'] = $feed->name(false);
  695. }
  696. if ($feed->website() === '' || $feed->website() === $feed->url()) {
  697. $website = html_only_entity_decode($simplePie->get_link());
  698. if ($website !== $feed->website()) {
  699. $feed->_website($website);
  700. $feedProperties['website'] = $feed->website();
  701. $feed->faviconPrepare();
  702. }
  703. }
  704. if (trim($feed->description()) === '') {
  705. $description = html_only_entity_decode($simplePie->get_description());
  706. if ($description !== '') {
  707. $feed->_description($description);
  708. $feedProperties['description'] = $feed->description();
  709. }
  710. }
  711. }
  712. if (!empty($feedProperties) || $feedIsNew) {
  713. $feedProperties['attributes'] = $feed->attributes();
  714. $ok = $feedDAO->updateFeed($feed->id(), $feedProperties);
  715. if (!$ok && $feedIsNew) {
  716. //Cancel adding new feed in case of database error at first actualize
  717. $feedDAO->deleteFeed($feed->id());
  718. $feed->unlock();
  719. break;
  720. }
  721. }
  722. $feed->faviconPrepare();
  723. if ($pubsubhubbubEnabledGeneral && $feed->pubSubHubbubPrepare() != false) {
  724. Minz_Log::notice('WebSub subscribe ' . $feed->url(false));
  725. if (!$feed->pubSubHubbubSubscribe(true)) { //Subscribe
  726. Minz_Log::warning('Error while WebSub subscribing to ' . $feed->url(false));
  727. }
  728. }
  729. $feed->unlock();
  730. $nbUpdatedFeeds++;
  731. unset($feed);
  732. gc_collect_cycles();
  733. if ($nbUpdatedFeeds >= $maxFeeds) {
  734. break;
  735. }
  736. }
  737. return [$nbUpdatedFeeds, reset($feeds) ?: null, $nbNewArticles, $feedsCacheToRefresh];
  738. }
  739. /**
  740. * Feeds on which to apply a the keep max unreads policy, or all feeds if none specified.
  741. * @return int The number of articles marked as read
  742. */
  743. private static function keepMaxUnreads(FreshRSS_Feed ...$feeds): int {
  744. $affected = 0;
  745. if (empty($feeds)) {
  746. $feedDAO = FreshRSS_Factory::createFeedDao();
  747. $feeds = $feedDAO->listFeedsOrderUpdate(-1);
  748. }
  749. foreach ($feeds as $feed) {
  750. $n = $feed->markAsReadMaxUnread();
  751. if ($n !== false && $n > 0) {
  752. Minz_Log::debug($n . ' unread entries exceeding max number of ' . $feed->keepMaxUnread() . ' for [' . $feed->url(false) . ']');
  753. $affected += $n;
  754. }
  755. }
  756. return $affected;
  757. }
  758. /**
  759. * Auto-add labels to new articles.
  760. * @param int $nbNewEntries The number of top recent entries to process.
  761. * @return int|false The number of new labels added, or false in case of error.
  762. */
  763. private static function applyLabelActions(int $nbNewEntries): int|false {
  764. $tagDAO = FreshRSS_Factory::createTagDao();
  765. $labels = FreshRSS_Context::labels();
  766. $labels = array_filter($labels, static fn(FreshRSS_Tag $label) => !empty($label->filtersAction('label')));
  767. if (count($labels) <= 0) {
  768. return 0;
  769. }
  770. $entryDAO = FreshRSS_Factory::createEntryDao();
  771. $applyLabels = [];
  772. foreach (FreshRSS_Entry::fromTraversable($entryDAO->selectAll(order: 'DESC', limit: $nbNewEntries)) as $entry) {
  773. foreach ($labels as $label) {
  774. $label->applyFilterActions($entry, $applyLabel);
  775. if ($applyLabel) {
  776. $applyLabels[] = [
  777. 'id_tag' => $label->id(),
  778. 'id_entry' => $entry->id(),
  779. ];
  780. }
  781. }
  782. }
  783. return $tagDAO->tagEntries($applyLabels);
  784. }
  785. public static function commitNewEntries(): int {
  786. $entryDAO = FreshRSS_Factory::createEntryDao();
  787. $nbNewEntries = $entryDAO->countNewEntries();
  788. if ($nbNewEntries > 0) {
  789. if ($entryDAO->commitNewEntries()) {
  790. self::applyLabelActions($nbNewEntries);
  791. }
  792. }
  793. return $nbNewEntries;
  794. }
  795. /**
  796. * @param FreshRSS_SimplePieCustom|null $simplePiePush Used by WebSub (PubSubHubbub) to push updates
  797. * @param string $selfUrl Used by WebSub (PubSubHubbub) to override the feed URL
  798. * @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,
  799. * list of feeds for which a cache refresh is needed
  800. * @throws FreshRSS_BadUrl_Exception
  801. */
  802. public static function actualizeFeedsAndCommit(?int $feed_id = null, ?string $feed_url = null, ?int $maxFeeds = null,
  803. ?FreshRSS_SimplePieCustom $simplePiePush = null, string $selfUrl = ''): array {
  804. $entryDAO = FreshRSS_Factory::createEntryDao();
  805. [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh] =
  806. FreshRSS_feed_Controller::actualizeFeeds($feed_id, $feed_url, $maxFeeds, $simplePiePush, $selfUrl);
  807. if ($nbNewArticles > 0) {
  808. $entryDAO->beginTransaction();
  809. FreshRSS_feed_Controller::commitNewEntries();
  810. }
  811. if (count($feedsCacheToRefresh) > 0) {
  812. $feedDAO = FreshRSS_Factory::createFeedDao();
  813. self::keepMaxUnreads(...$feedsCacheToRefresh);
  814. $feedDAO->updateCachedValues(...array_map(fn(FreshRSS_Feed $f) => $f->id(), $feedsCacheToRefresh));
  815. }
  816. if ($entryDAO->inTransaction()) {
  817. $entryDAO->commit();
  818. }
  819. if (rand(0, 30) === 1) { // Remove old cache once in a while
  820. cleanCache(CLEANCACHE_HOURS);
  821. }
  822. return [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh];
  823. }
  824. /**
  825. * This action actualizes entries from one or several feeds.
  826. *
  827. * Parameters are:
  828. * - id (default: null): Feed ID, or set to -1 to commit new articles to the main database
  829. * - url (default: null): Feed URL (instead of feed ID)
  830. * - maxFeeds (default: 10): Max number of feeds to refresh
  831. * - noCommit (default: 0): Set to 1 to prevent committing the new articles to the main database
  832. * If id and url are not specified, all the feeds are actualized, within the limits of maxFeeds.
  833. */
  834. public function actualizeAction(): int {
  835. Minz_Session::_param('actualize_feeds', false);
  836. $id = Minz_Request::paramInt('id');
  837. $url = Minz_Request::paramString('url');
  838. $maxFeeds = Minz_Request::paramInt('maxFeeds') ?: 10;
  839. $noCommit = ($_POST['noCommit'] ?? 0) == 1;
  840. if ($id === -1 && !$noCommit) { //Special request only to commit & refresh DB cache
  841. $nbUpdatedFeeds = 0;
  842. $feed = null;
  843. FreshRSS_feed_Controller::commitNewEntries();
  844. $feedDAO = FreshRSS_Factory::createFeedDao();
  845. $feedDAO->updateCachedValues();
  846. } else {
  847. if ($id === 0 && $url === '') {
  848. // Case of a batch refresh (e.g. cron)
  849. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  850. $databaseDAO->minorDbMaintenance();
  851. Minz_ExtensionManager::callHookVoid(Minz_HookType::FreshrssUserMaintenance);
  852. FreshRSS_feed_Controller::commitNewEntries();
  853. $feedDAO = FreshRSS_Factory::createFeedDao();
  854. $feedDAO->updateCachedValues();
  855. FreshRSS_category_Controller::refreshDynamicOpmls();
  856. }
  857. $entryDAO = FreshRSS_Factory::createEntryDao();
  858. [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh] = self::actualizeFeeds($id, $url, $maxFeeds);
  859. if (!$noCommit) {
  860. if ($nbNewArticles > 0) {
  861. $entryDAO->beginTransaction();
  862. FreshRSS_feed_Controller::commitNewEntries();
  863. }
  864. $feedDAO = FreshRSS_Factory::createFeedDao();
  865. if ($id !== 0 && $id !== -1) {
  866. if ($feed instanceof FreshRSS_Feed) {
  867. self::keepMaxUnreads($feed);
  868. }
  869. // Case of single feed refreshed, always update its cache
  870. $feedDAO->updateCachedValues($id);
  871. } elseif (count($feedsCacheToRefresh) > 0) {
  872. self::keepMaxUnreads(...$feedsCacheToRefresh);
  873. // Case of multiple feeds refreshed, only update cache of affected feeds
  874. $feedDAO->updateCachedValues(...array_map(fn(FreshRSS_Feed $f) => $f->id(), $feedsCacheToRefresh));
  875. }
  876. }
  877. if ($entryDAO->inTransaction()) {
  878. $entryDAO->commit();
  879. }
  880. }
  881. if (Minz_Request::paramBoolean('ajax')) {
  882. // Most of the time, ajax request is for only one feed. But since
  883. // there are several parallel requests, we should return that there
  884. // are several updated feeds.
  885. Minz_Request::setGoodNotification(_t('feedback.sub.feed.actualizeds'));
  886. // No layout in ajax request.
  887. $this->view->_layout(null);
  888. } elseif ($feed instanceof FreshRSS_Feed && $id > 0) {
  889. // Redirect to the main page with correct notification.
  890. Minz_Request::good(
  891. _t('feedback.sub.feed.actualized', $feed->name()),
  892. ['params' => ['get' => 'f_' . $id]],
  893. notificationName: 'actualizeAction',
  894. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0);
  895. } elseif ($nbUpdatedFeeds >= 1) {
  896. Minz_Request::good(
  897. _t('feedback.sub.feed.n_actualized', $nbUpdatedFeeds),
  898. [],
  899. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  900. );
  901. } else {
  902. Minz_Request::good(
  903. _t('feedback.sub.feed.no_refresh'),
  904. [],
  905. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  906. );
  907. }
  908. return $nbUpdatedFeeds;
  909. }
  910. /**
  911. * @throws Minz_ConfigurationNamespaceException
  912. * @throws Minz_PDOConnectionException
  913. */
  914. public static function renameFeed(int $feed_id, string $feed_name): bool {
  915. if ($feed_id <= 0 || $feed_name === '') {
  916. return false;
  917. }
  918. FreshRSS_UserDAO::touch();
  919. $feedDAO = FreshRSS_Factory::createFeedDao();
  920. return $feedDAO->updateFeed($feed_id, ['name' => $feed_name]);
  921. }
  922. public static function moveFeed(int $feed_id, int $cat_id, string $new_cat_name = ''): bool {
  923. if ($feed_id <= 0 || ($cat_id <= 0 && $new_cat_name === '')) {
  924. return false;
  925. }
  926. FreshRSS_UserDAO::touch();
  927. $catDAO = FreshRSS_Factory::createCategoryDao();
  928. if ($cat_id > 0) {
  929. $cat = $catDAO->searchById($cat_id);
  930. $cat_id = $cat === null ? 0 : $cat->id();
  931. }
  932. if ($cat_id <= 1 && $new_cat_name != '') {
  933. $cat_id = $catDAO->addCategory(['name' => $new_cat_name]);
  934. }
  935. if ($cat_id <= 1) {
  936. $catDAO->checkDefault();
  937. $cat_id = FreshRSS_CategoryDAO::DEFAULTCATEGORYID;
  938. }
  939. $feedDAO = FreshRSS_Factory::createFeedDao();
  940. return $feedDAO->updateFeed($feed_id, ['category' => $cat_id]);
  941. }
  942. /**
  943. * This action changes the category of a feed.
  944. *
  945. * This page must be reached by a POST request.
  946. *
  947. * Parameters are:
  948. * - f_id (default: false)
  949. * - c_id (default: false)
  950. * If c_id is false, default category is used.
  951. *
  952. * @todo should handle order of the feed inside the category.
  953. */
  954. public function moveAction(): void {
  955. if (!Minz_Request::isPost()) {
  956. Minz_Request::forward(['c' => 'subscription'], true);
  957. }
  958. $feed_id = Minz_Request::paramInt('f_id');
  959. $cat_id = Minz_Request::paramInt('c_id');
  960. if (self::moveFeed($feed_id, $cat_id)) {
  961. // TODO: return something useful
  962. // Log a notice to prevent "Empty IF statement" warning in PHP_CodeSniffer
  963. Minz_Log::notice('Moved feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  964. } else {
  965. Minz_Log::warning('Cannot move feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  966. Minz_Error::error(404);
  967. }
  968. }
  969. public static function deleteFeed(int $feed_id): bool {
  970. FreshRSS_UserDAO::touch();
  971. $feedDAO = FreshRSS_Factory::createFeedDao();
  972. $feed = $feedDAO->searchById($feed_id);
  973. if ($feed === null) {
  974. return false;
  975. }
  976. if ($feedDAO->deleteFeed($feed_id)) {
  977. // TODO: Delete old favicon (non-custom)
  978. if ($feed->customFavicon() && !$feed->attributeBoolean('customFaviconDisallowDel')) {
  979. FreshRSS_Feed::faviconDelete($feed->hashFavicon());
  980. }
  981. // Remove related queries
  982. $queries = FreshRSS_UserQuery::remove_query_by_get('f_' . $feed_id, FreshRSS_Context::userConf()->queries);
  983. FreshRSS_Context::userConf()->queries = $queries;
  984. FreshRSS_Context::userConf()->save();
  985. return true;
  986. }
  987. return false;
  988. }
  989. /**
  990. * This action deletes a feed.
  991. *
  992. * This page must be reached by a POST request.
  993. * If there are related queries, they are deleted too.
  994. *
  995. * Parameters are:
  996. * - id (default: false)
  997. */
  998. public function deleteAction(): void {
  999. if (!Minz_Request::isPost()) {
  1000. Minz_Request::forward(['c' => 'subscription'], true);
  1001. }
  1002. $from = Minz_Request::paramString('from');
  1003. $id = Minz_Request::paramInt('id');
  1004. switch ($from) {
  1005. case 'stats':
  1006. $redirect_url = ['c' => 'stats', 'a' => 'idle'];
  1007. break;
  1008. case 'normal':
  1009. $get = Minz_Request::paramString('get');
  1010. if ($get !== '') {
  1011. $redirect_url = ['c' => 'index', 'a' => 'normal', 'params' => ['get' => $get]];
  1012. } else {
  1013. $redirect_url = ['c' => 'index', 'a' => 'normal'];
  1014. }
  1015. break;
  1016. default:
  1017. $redirect_url = ['c' => 'subscription', 'a' => 'index'];
  1018. if (!Minz_Request::isPost()) {
  1019. Minz_Request::forward($redirect_url, true);
  1020. }
  1021. }
  1022. if (self::deleteFeed($id)) {
  1023. Minz_Request::good(
  1024. _t('feedback.sub.feed.deleted'),
  1025. $redirect_url,
  1026. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1027. );
  1028. } else {
  1029. Minz_Request::bad(_t('feedback.sub.feed.error'), $redirect_url);
  1030. }
  1031. }
  1032. /**
  1033. * This action force clears the cache of a feed.
  1034. *
  1035. * Parameters are:
  1036. * - id (mandatory - no default): Feed ID
  1037. *
  1038. */
  1039. public function clearCacheAction(): void {
  1040. if (!Minz_Request::isPost()) {
  1041. Minz_Request::forward(['c' => 'subscription'], true);
  1042. }
  1043. //Get Feed.
  1044. $id = Minz_Request::paramInt('id');
  1045. $feedDAO = FreshRSS_Factory::createFeedDao();
  1046. $feed = $feedDAO->searchById($id);
  1047. if ($feed === null) {
  1048. Minz_Request::bad(_t('feedback.sub.feed.not_found'), []);
  1049. return;
  1050. }
  1051. $feed->clearCache();
  1052. Minz_Request::good(
  1053. _t('feedback.sub.feed.cache_cleared', $feed->name()),
  1054. ['params' => ['get' => 'f_' . $feed->id()]],
  1055. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1056. );
  1057. }
  1058. /**
  1059. * This action forces reloading the articles of a feed.
  1060. *
  1061. * Parameters are:
  1062. * - id (mandatory - no default): Feed ID
  1063. *
  1064. * @throws FreshRSS_BadUrl_Exception
  1065. */
  1066. public function reloadAction(): void {
  1067. if (!Minz_Request::isPost()) {
  1068. Minz_Request::forward(['c' => 'subscription'], true);
  1069. }
  1070. if (function_exists('set_time_limit')) {
  1071. @set_time_limit(300);
  1072. }
  1073. //Get Feed ID.
  1074. $feed_id = Minz_Request::paramInt('id');
  1075. $limit = Minz_Request::paramInt('reload_limit') ?: 10;
  1076. $feedDAO = FreshRSS_Factory::createFeedDao();
  1077. $feed = $feedDAO->searchById($feed_id);
  1078. if ($feed === null) {
  1079. Minz_Request::bad(_t('feedback.sub.feed.not_found'), []);
  1080. return;
  1081. }
  1082. //Re-fetch articles as if the feed was new.
  1083. $feedDAO->updateFeed($feed->id(), [ 'lastUpdate' => 0 ]);
  1084. self::actualizeFeedsAndCommit($feed_id);
  1085. //Extract all feed entries from database, load complete content and store them back in database.
  1086. $entryDAO = FreshRSS_Factory::createEntryDao();
  1087. $entries = $entryDAO->listWhere('f', $feed_id, FreshRSS_Entry::STATE_ALL, order: 'DESC', limit: $limit);
  1088. //We need another DB connection in parallel for unbuffered streaming
  1089. Minz_ModelPdo::$usesSharedPdo = false;
  1090. if (FreshRSS_Context::systemConf()->db['type'] === 'mysql') {
  1091. // Second parallel connection for unbuffered streaming: MySQL
  1092. $entryDAO2 = FreshRSS_Factory::createEntryDao();
  1093. } else {
  1094. // Single connection for buffered queries (in memory): SQLite, PostgreSQL
  1095. //TODO: Consider an unbuffered query for PostgreSQL
  1096. $entryDAO2 = $entryDAO;
  1097. }
  1098. foreach ($entries as $entry) {
  1099. $oldContent = $entry->content(withEnclosures: false);
  1100. if ($entry->loadCompleteContent(true)) {
  1101. $entry->_lastModified(time());
  1102. if ($entry->content(withEnclosures: false) !== $oldContent) {
  1103. $entryDAO2->updateEntry($entry->toArray());
  1104. }
  1105. }
  1106. }
  1107. Minz_ModelPdo::$usesSharedPdo = true;
  1108. //Give feedback to user.
  1109. Minz_Request::good(
  1110. _t('feedback.sub.feed.reloaded', $feed->name()),
  1111. ['params' => ['get' => 'f_' . $feed->id()]],
  1112. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1113. );
  1114. }
  1115. /**
  1116. * This action creates a preview of a content-selector.
  1117. *
  1118. * Parameters are:
  1119. * - id (mandatory - no default): Feed ID
  1120. * - selector (mandatory - no default): Selector to preview
  1121. *
  1122. */
  1123. public function contentSelectorPreviewAction(): void {
  1124. //Configure.
  1125. $this->view->fatalError = '';
  1126. $this->view->selectorSuccess = false;
  1127. $this->view->htmlContent = '';
  1128. $this->view->_layout(null);
  1129. $this->_csp([
  1130. 'default-src' => "'self'",
  1131. 'frame-ancestors' => "'self'",
  1132. 'frame-src' => '*',
  1133. 'img-src' => '* data:',
  1134. 'media-src' => '*',
  1135. ]);
  1136. //Get parameters.
  1137. $feed_id = Minz_Request::paramInt('id');
  1138. $content_selector = Minz_Request::paramString('selector');
  1139. if ($content_selector === '') {
  1140. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.selector_empty');
  1141. return;
  1142. }
  1143. //Check Feed ID validity.
  1144. $entryDAO = FreshRSS_Factory::createEntryDao();
  1145. $entries = $entryDAO->listWhere('f', $feed_id);
  1146. $entry = null;
  1147. //Get first entry (syntax robust for Generator or Array)
  1148. foreach ($entries as $myEntry) {
  1149. $entry = $myEntry;
  1150. }
  1151. if ($entry == null) {
  1152. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_entries');
  1153. return;
  1154. }
  1155. //Get feed.
  1156. $feed = $entry->feed();
  1157. if ($feed === null) {
  1158. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_feed');
  1159. return;
  1160. }
  1161. $feed->_pathEntries($content_selector);
  1162. $feed->_attribute('path_entries_filter', Minz_Request::paramString('selector_filter', true));
  1163. //Fetch & select content.
  1164. try {
  1165. $fullContent = $entry->getContentByParsing();
  1166. if ($fullContent != '') {
  1167. $this->view->selectorSuccess = true;
  1168. $this->view->htmlContent = $fullContent;
  1169. } else {
  1170. $this->view->selectorSuccess = false;
  1171. $this->view->htmlContent = $entry->content(false);
  1172. }
  1173. } catch (Exception) {
  1174. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.http_error');
  1175. }
  1176. }
  1177. }