4
0

feedController.php 42 KB

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