4
0

feedController.php 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305
  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->updateLastError($feed->id());
  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. if ($simplePiePush === null) { // Not WebSub
  656. $feedDAO->updateLastUpdate($feed->id(), $mtime);
  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. } elseif ($feed->inError()) {
  660. // Reset feed error state in case of successful WebSub push
  661. $feedDAO->updateLastError($feed->id(), 0);
  662. }
  663. if ($needFeedCacheRefresh) {
  664. $feedsCacheToRefresh[] = $feed;
  665. }
  666. $feedProperties = [];
  667. if ($oldSimplePieHash !== $feed->attributeString('SimplePieHash')) {
  668. $feedProperties['attributes'] = $feed->attributes();
  669. }
  670. if ($feed->url() !== $url) { // HTTP 301 Moved Permanently
  671. Minz_Log::warning('Feed ' . \SimplePie\Misc::url_remove_credentials($url) .
  672. ' moved permanently to ' . $feed->url(includeCredentials: false));
  673. $feedProperties['url'] = $feed->url();
  674. } elseif ($simplePiePush !== null && $selfUrl !== '' && $selfUrl !== $feed->url()) { // selfUrl has priority for WebSub
  675. // https://github.com/pubsubhubbub/PubSubHubbub/wiki/Moving-Feeds-or-changing-Hubs
  676. Minz_Log::debug('WebSub unsubscribe ' . $feed->url(includeCredentials: false));
  677. if (!$feed->pubSubHubbubSubscribe(false)) { //Unsubscribe
  678. Minz_Log::warning('Error while WebSub unsubscribing from ' . $feed->url(includeCredentials: false));
  679. }
  680. $feed->_url($selfUrl);
  681. Minz_Log::warning('Feed ' . \SimplePie\Misc::url_remove_credentials($url) .
  682. ' canonical address moved to ' . $feed->url(includeCredentials: false));
  683. $feedProperties['url'] = $feed->url();
  684. }
  685. if ($simplePie != null) {
  686. $feedImageUrl = htmlspecialchars_decode($simplePie->get_icon_url() ?? '', ENT_QUOTES);
  687. $feedImageUrl = $feedImageUrl !== '' ? (FreshRSS_http_Util::checkUrl($feedImageUrl) ?: '') : '';
  688. if ($feedImageUrl !== ($feed->attributeString('feedIconUrl') ?? '')) {
  689. $feed->_attribute('feedIconUrl', $feedImageUrl !== '' ? $feedImageUrl : null);
  690. $feed->resetFaviconHash();
  691. $feedProperties['attributes'] = $feed->attributes();
  692. }
  693. if ($feed->name(true) === '') {
  694. //HTML to HTML-PRE //ENT_COMPAT except '&'
  695. $name = strtr(html_only_entity_decode($simplePie->get_title()), ['<' => '&lt;', '>' => '&gt;', '"' => '&quot;']);
  696. $feed->_name($name);
  697. $feedProperties['name'] = $feed->name(false);
  698. }
  699. if ($feed->website() === '' || $feed->website() === $feed->url()) {
  700. $website = html_only_entity_decode($simplePie->get_link());
  701. if ($website !== $feed->website()) {
  702. $feed->_website($website);
  703. $feedProperties['website'] = $feed->website();
  704. $feed->faviconPrepare();
  705. }
  706. }
  707. if (trim($feed->description()) === '') {
  708. $description = html_only_entity_decode($simplePie->get_description());
  709. if ($description !== '') {
  710. $feed->_description($description);
  711. $feedProperties['description'] = $feed->description();
  712. }
  713. }
  714. }
  715. if (!empty($feedProperties) || $feedIsNew) {
  716. $feedProperties['attributes'] = $feed->attributes();
  717. $ok = $feedDAO->updateFeed($feed->id(), $feedProperties);
  718. if (!$ok && $feedIsNew) {
  719. //Cancel adding new feed in case of database error at first actualize
  720. $feedDAO->deleteFeed($feed->id());
  721. $feed->unlock();
  722. break;
  723. }
  724. }
  725. $feed->faviconPrepare();
  726. if ($pubsubhubbubEnabledGeneral && $feed->pubSubHubbubPrepare() != false) {
  727. Minz_Log::notice('WebSub subscribe ' . $feed->url(false));
  728. if (!$feed->pubSubHubbubSubscribe(true)) { //Subscribe
  729. Minz_Log::warning('Error while WebSub subscribing to ' . $feed->url(false));
  730. }
  731. }
  732. $feed->unlock();
  733. $nbUpdatedFeeds++;
  734. unset($feed);
  735. gc_collect_cycles();
  736. if ($nbUpdatedFeeds >= $maxFeeds) {
  737. break;
  738. }
  739. }
  740. return [$nbUpdatedFeeds, reset($feeds) ?: null, $nbNewArticles, $feedsCacheToRefresh];
  741. }
  742. /**
  743. * Feeds on which to apply a the keep max unreads policy, or all feeds if none specified.
  744. * @return int The number of articles marked as read
  745. */
  746. private static function keepMaxUnreads(FreshRSS_Feed ...$feeds): int {
  747. $affected = 0;
  748. if (empty($feeds)) {
  749. $feedDAO = FreshRSS_Factory::createFeedDao();
  750. $feeds = $feedDAO->listFeedsOrderUpdate(-1);
  751. }
  752. foreach ($feeds as $feed) {
  753. $n = $feed->markAsReadMaxUnread();
  754. if ($n !== false && $n > 0) {
  755. Minz_Log::debug($n . ' unread entries exceeding max number of ' . $feed->keepMaxUnread() . ' for [' . $feed->url(false) . ']');
  756. $affected += $n;
  757. }
  758. }
  759. return $affected;
  760. }
  761. /**
  762. * Auto-add labels to new articles.
  763. * @param int $nbNewEntries The number of top recent entries to process.
  764. * @return int|false The number of new labels added, or false in case of error.
  765. */
  766. private static function applyLabelActions(int $nbNewEntries): int|false {
  767. $tagDAO = FreshRSS_Factory::createTagDao();
  768. $labels = FreshRSS_Context::labels();
  769. $labels = array_filter($labels, static fn(FreshRSS_Tag $label) => !empty($label->filtersAction('label')));
  770. if (count($labels) <= 0) {
  771. return 0;
  772. }
  773. $entryDAO = FreshRSS_Factory::createEntryDao();
  774. $applyLabels = [];
  775. foreach (FreshRSS_Entry::fromTraversable($entryDAO->selectAll(order: 'DESC', limit: $nbNewEntries)) as $entry) {
  776. foreach ($labels as $label) {
  777. $label->applyFilterActions($entry, $applyLabel);
  778. if ($applyLabel) {
  779. $applyLabels[] = [
  780. 'id_tag' => $label->id(),
  781. 'id_entry' => $entry->id(),
  782. ];
  783. }
  784. }
  785. }
  786. return $tagDAO->tagEntries($applyLabels);
  787. }
  788. public static function commitNewEntries(): int {
  789. $entryDAO = FreshRSS_Factory::createEntryDao();
  790. $nbNewEntries = $entryDAO->countNewEntries();
  791. if ($nbNewEntries > 0) {
  792. if ($entryDAO->commitNewEntries()) {
  793. self::applyLabelActions($nbNewEntries);
  794. }
  795. }
  796. return $nbNewEntries;
  797. }
  798. /**
  799. * @param FreshRSS_SimplePieCustom|null $simplePiePush Used by WebSub (PubSubHubbub) to push updates
  800. * @param string $selfUrl Used by WebSub (PubSubHubbub) to override the feed URL
  801. * @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,
  802. * list of feeds for which a cache refresh is needed
  803. * @throws FreshRSS_BadUrl_Exception
  804. */
  805. public static function actualizeFeedsAndCommit(?int $feed_id = null, ?string $feed_url = null, ?int $maxFeeds = null,
  806. ?FreshRSS_SimplePieCustom $simplePiePush = null, string $selfUrl = ''): array {
  807. $entryDAO = FreshRSS_Factory::createEntryDao();
  808. [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh] =
  809. FreshRSS_feed_Controller::actualizeFeeds($feed_id, $feed_url, $maxFeeds, $simplePiePush, $selfUrl);
  810. if ($nbNewArticles > 0) {
  811. $entryDAO->beginTransaction();
  812. FreshRSS_feed_Controller::commitNewEntries();
  813. }
  814. if (count($feedsCacheToRefresh) > 0) {
  815. $feedDAO = FreshRSS_Factory::createFeedDao();
  816. self::keepMaxUnreads(...$feedsCacheToRefresh);
  817. $feedDAO->updateCachedValues(...array_map(fn(FreshRSS_Feed $f) => $f->id(), $feedsCacheToRefresh));
  818. }
  819. if ($entryDAO->inTransaction()) {
  820. $entryDAO->commit();
  821. }
  822. if (rand(0, 30) === 1) { // Remove old cache once in a while
  823. cleanCache(CLEANCACHE_HOURS);
  824. }
  825. return [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh];
  826. }
  827. /**
  828. * This action actualizes entries from one or several feeds.
  829. *
  830. * Parameters are:
  831. * - id (default: null): Feed ID, or set to -1 to commit new articles to the main database
  832. * - url (default: null): Feed URL (instead of feed ID)
  833. * - maxFeeds (default: 10): Max number of feeds to refresh
  834. * - noCommit (default: 0): Set to 1 to prevent committing the new articles to the main database
  835. * If id and url are not specified, all the feeds are actualized, within the limits of maxFeeds.
  836. */
  837. public function actualizeAction(): int {
  838. Minz_Session::_param('actualize_feeds', false);
  839. $id = Minz_Request::paramInt('id');
  840. $url = Minz_Request::paramString('url');
  841. $maxFeeds = Minz_Request::paramInt('maxFeeds') ?: 10;
  842. $noCommit = ($_POST['noCommit'] ?? 0) == 1;
  843. if ($id === -1 && !$noCommit) { //Special request only to commit & refresh DB cache
  844. $nbUpdatedFeeds = 0;
  845. $feed = null;
  846. FreshRSS_feed_Controller::commitNewEntries();
  847. $feedDAO = FreshRSS_Factory::createFeedDao();
  848. $feedDAO->updateCachedValues();
  849. } else {
  850. if (!$noCommit) {
  851. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  852. $databaseDAO->minorDbMaintenance();
  853. Minz_ExtensionManager::callHookVoid(Minz_HookType::FreshrssUserMaintenance);
  854. }
  855. if ($id === 0 && $url === '') {
  856. // Case of a batch refresh (e.g. cron)
  857. FreshRSS_feed_Controller::commitNewEntries();
  858. $feedDAO = FreshRSS_Factory::createFeedDao();
  859. $feedDAO->updateCachedValues();
  860. FreshRSS_category_Controller::refreshDynamicOpmls();
  861. }
  862. $entryDAO = FreshRSS_Factory::createEntryDao();
  863. [$nbUpdatedFeeds, $feed, $nbNewArticles, $feedsCacheToRefresh] = self::actualizeFeeds($id, $url, $maxFeeds);
  864. if (!$noCommit) {
  865. if ($nbNewArticles > 0) {
  866. $entryDAO->beginTransaction();
  867. FreshRSS_feed_Controller::commitNewEntries();
  868. }
  869. $feedDAO = FreshRSS_Factory::createFeedDao();
  870. if ($id !== 0 && $id !== -1) {
  871. if ($feed instanceof FreshRSS_Feed) {
  872. self::keepMaxUnreads($feed);
  873. }
  874. // Case of single feed refreshed, always update its cache
  875. $feedDAO->updateCachedValues($id);
  876. } elseif (count($feedsCacheToRefresh) > 0) {
  877. self::keepMaxUnreads(...$feedsCacheToRefresh);
  878. // Case of multiple feeds refreshed, only update cache of affected feeds
  879. $feedDAO->updateCachedValues(...array_map(fn(FreshRSS_Feed $f) => $f->id(), $feedsCacheToRefresh));
  880. }
  881. }
  882. if ($entryDAO->inTransaction()) {
  883. $entryDAO->commit();
  884. }
  885. }
  886. if (Minz_Request::paramBoolean('ajax')) {
  887. // Most of the time, ajax request is for only one feed. But since
  888. // there are several parallel requests, we should return that there
  889. // are several updated feeds.
  890. Minz_Request::setGoodNotification(_t('feedback.sub.feed.actualizeds'));
  891. // No layout in ajax request.
  892. $this->view->_layout(null);
  893. } elseif ($feed instanceof FreshRSS_Feed && $id > 0) {
  894. // Redirect to the main page with correct notification.
  895. Minz_Request::good(
  896. _t('feedback.sub.feed.actualized', $feed->name()),
  897. ['params' => ['get' => 'f_' . $id]],
  898. notificationName: 'actualizeAction',
  899. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0);
  900. } elseif ($nbUpdatedFeeds >= 1) {
  901. Minz_Request::good(
  902. _t('feedback.sub.feed.n_actualized', $nbUpdatedFeeds),
  903. [],
  904. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  905. );
  906. } else {
  907. Minz_Request::good(
  908. _t('feedback.sub.feed.no_refresh'),
  909. [],
  910. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  911. );
  912. }
  913. return $nbUpdatedFeeds;
  914. }
  915. /**
  916. * @throws Minz_ConfigurationNamespaceException
  917. * @throws Minz_PDOConnectionException
  918. */
  919. public static function renameFeed(int $feed_id, string $feed_name): bool {
  920. if ($feed_id <= 0 || $feed_name === '') {
  921. return false;
  922. }
  923. FreshRSS_UserDAO::touch();
  924. $feedDAO = FreshRSS_Factory::createFeedDao();
  925. return $feedDAO->updateFeed($feed_id, ['name' => $feed_name]);
  926. }
  927. public static function moveFeed(int $feed_id, int $cat_id, string $new_cat_name = ''): bool {
  928. if ($feed_id <= 0 || ($cat_id <= 0 && $new_cat_name === '')) {
  929. return false;
  930. }
  931. FreshRSS_UserDAO::touch();
  932. $catDAO = FreshRSS_Factory::createCategoryDao();
  933. if ($cat_id > 0) {
  934. $cat = $catDAO->searchById($cat_id);
  935. $cat_id = $cat === null ? 0 : $cat->id();
  936. }
  937. if ($cat_id <= 1 && $new_cat_name != '') {
  938. $cat_id = $catDAO->addCategory(['name' => $new_cat_name]);
  939. }
  940. if ($cat_id <= 1) {
  941. $catDAO->checkDefault();
  942. $cat_id = FreshRSS_CategoryDAO::DEFAULTCATEGORYID;
  943. }
  944. $feedDAO = FreshRSS_Factory::createFeedDao();
  945. return $feedDAO->updateFeed($feed_id, ['category' => $cat_id]);
  946. }
  947. /**
  948. * This action changes the category of a feed.
  949. *
  950. * This page must be reached by a POST request.
  951. *
  952. * Parameters are:
  953. * - f_id (default: false)
  954. * - c_id (default: false)
  955. * If c_id is false, default category is used.
  956. *
  957. * @todo should handle order of the feed inside the category.
  958. */
  959. public function moveAction(): void {
  960. if (!Minz_Request::isPost()) {
  961. Minz_Request::forward(['c' => 'subscription'], true);
  962. }
  963. $feed_id = Minz_Request::paramInt('f_id');
  964. $cat_id = Minz_Request::paramInt('c_id');
  965. if (self::moveFeed($feed_id, $cat_id)) {
  966. // TODO: return something useful
  967. // Log a notice to prevent "Empty IF statement" warning in PHP_CodeSniffer
  968. Minz_Log::notice('Moved feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  969. } else {
  970. Minz_Log::warning('Cannot move feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  971. Minz_Error::error(404);
  972. }
  973. }
  974. public static function deleteFeed(int $feed_id): bool {
  975. FreshRSS_UserDAO::touch();
  976. $feedDAO = FreshRSS_Factory::createFeedDao();
  977. $feed = $feedDAO->searchById($feed_id);
  978. if ($feed === null) {
  979. return false;
  980. }
  981. if ($feedDAO->deleteFeed($feed_id)) {
  982. // TODO: Delete old favicon (non-custom)
  983. if ($feed->customFavicon() && !$feed->attributeBoolean('customFaviconDisallowDel')) {
  984. FreshRSS_Feed::faviconDelete($feed->hashFavicon());
  985. }
  986. // Remove related queries
  987. $queries = FreshRSS_UserQuery::remove_query_by_get('f_' . $feed_id, FreshRSS_Context::userConf()->queries);
  988. FreshRSS_Context::userConf()->queries = $queries;
  989. FreshRSS_Context::userConf()->save();
  990. return true;
  991. }
  992. return false;
  993. }
  994. /**
  995. * This action deletes a feed.
  996. *
  997. * This page must be reached by a POST request.
  998. * If there are related queries, they are deleted too.
  999. *
  1000. * Parameters are:
  1001. * - id (default: false)
  1002. */
  1003. public function deleteAction(): void {
  1004. if (!Minz_Request::isPost()) {
  1005. Minz_Request::forward(['c' => 'subscription'], true);
  1006. }
  1007. $from = Minz_Request::paramString('from');
  1008. $id = Minz_Request::paramInt('id');
  1009. switch ($from) {
  1010. case 'stats':
  1011. $redirect_url = ['c' => 'stats', 'a' => 'idle'];
  1012. break;
  1013. case 'normal':
  1014. $get = Minz_Request::paramString('get');
  1015. if ($get !== '') {
  1016. $redirect_url = ['c' => 'index', 'a' => 'normal', 'params' => ['get' => $get]];
  1017. } else {
  1018. $redirect_url = ['c' => 'index', 'a' => 'normal'];
  1019. }
  1020. break;
  1021. default:
  1022. $redirect_url = ['c' => 'subscription', 'a' => 'index'];
  1023. if (!Minz_Request::isPost()) {
  1024. Minz_Request::forward($redirect_url, true);
  1025. }
  1026. }
  1027. if (self::deleteFeed($id)) {
  1028. Minz_Request::good(
  1029. _t('feedback.sub.feed.deleted'),
  1030. $redirect_url,
  1031. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1032. );
  1033. } else {
  1034. Minz_Request::bad(_t('feedback.sub.feed.error'), $redirect_url);
  1035. }
  1036. }
  1037. /**
  1038. * This action force clears the cache of a feed.
  1039. *
  1040. * Parameters are:
  1041. * - id (mandatory - no default): Feed ID
  1042. *
  1043. */
  1044. public function clearCacheAction(): void {
  1045. if (!Minz_Request::isPost()) {
  1046. Minz_Request::forward(['c' => 'subscription'], true);
  1047. }
  1048. //Get Feed.
  1049. $id = Minz_Request::paramInt('id');
  1050. $feedDAO = FreshRSS_Factory::createFeedDao();
  1051. $feed = $feedDAO->searchById($id);
  1052. if ($feed === null) {
  1053. Minz_Request::bad(_t('feedback.sub.feed.not_found'), []);
  1054. return;
  1055. }
  1056. $feed->clearCache();
  1057. Minz_Request::good(
  1058. _t('feedback.sub.feed.cache_cleared', $feed->name()),
  1059. ['params' => ['get' => 'f_' . $feed->id()]],
  1060. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1061. );
  1062. }
  1063. /**
  1064. * This action forces reloading the articles of a feed.
  1065. *
  1066. * Parameters are:
  1067. * - id (mandatory - no default): Feed ID
  1068. *
  1069. * @throws FreshRSS_BadUrl_Exception
  1070. */
  1071. public function reloadAction(): void {
  1072. if (!Minz_Request::isPost()) {
  1073. Minz_Request::forward(['c' => 'subscription'], true);
  1074. }
  1075. if (function_exists('set_time_limit')) {
  1076. @set_time_limit(300);
  1077. }
  1078. //Get Feed ID.
  1079. $feed_id = Minz_Request::paramInt('id');
  1080. $limit = Minz_Request::paramInt('reload_limit') ?: 10;
  1081. $feedDAO = FreshRSS_Factory::createFeedDao();
  1082. $feed = $feedDAO->searchById($feed_id);
  1083. if ($feed === null) {
  1084. Minz_Request::bad(_t('feedback.sub.feed.not_found'), []);
  1085. return;
  1086. }
  1087. //Re-fetch articles as if the feed was new.
  1088. $feedDAO->updateFeed($feed->id(), [ 'lastUpdate' => 0 ]);
  1089. self::actualizeFeedsAndCommit($feed_id);
  1090. //Extract all feed entries from database, load complete content and store them back in database.
  1091. $entryDAO = FreshRSS_Factory::createEntryDao();
  1092. $entries = $entryDAO->listWhere('f', $feed_id, FreshRSS_Entry::STATE_ALL, order: 'DESC', limit: $limit);
  1093. //We need another DB connection in parallel for unbuffered streaming
  1094. Minz_ModelPdo::$usesSharedPdo = false;
  1095. if (FreshRSS_Context::systemConf()->db['type'] === 'mysql') {
  1096. // Second parallel connection for unbuffered streaming: MySQL
  1097. $entryDAO2 = FreshRSS_Factory::createEntryDao();
  1098. } else {
  1099. // Single connection for buffered queries (in memory): SQLite, PostgreSQL
  1100. //TODO: Consider an unbuffered query for PostgreSQL
  1101. $entryDAO2 = $entryDAO;
  1102. }
  1103. foreach ($entries as $entry) {
  1104. $oldContent = $entry->content(withEnclosures: false);
  1105. if ($entry->loadCompleteContent(true)) {
  1106. $entry->_lastModified(time());
  1107. if ($entry->content(withEnclosures: false) !== $oldContent) {
  1108. $entryDAO2->updateEntry($entry->toArray());
  1109. }
  1110. }
  1111. }
  1112. Minz_ModelPdo::$usesSharedPdo = true;
  1113. //Give feedback to user.
  1114. Minz_Request::good(
  1115. _t('feedback.sub.feed.reloaded', $feed->name()),
  1116. ['params' => ['get' => 'f_' . $feed->id()]],
  1117. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  1118. );
  1119. }
  1120. /**
  1121. * This action creates a preview of a content-selector.
  1122. *
  1123. * Parameters are:
  1124. * - id (mandatory - no default): Feed ID
  1125. * - selector (mandatory - no default): Selector to preview
  1126. *
  1127. */
  1128. public function contentSelectorPreviewAction(): void {
  1129. //Configure.
  1130. $this->view->fatalError = '';
  1131. $this->view->selectorSuccess = false;
  1132. $this->view->htmlContent = '';
  1133. $this->view->_layout(null);
  1134. $this->_csp([
  1135. 'default-src' => "'self'",
  1136. 'frame-ancestors' => "'self'",
  1137. 'frame-src' => '*',
  1138. 'img-src' => '* data:',
  1139. 'media-src' => '*',
  1140. ]);
  1141. //Get parameters.
  1142. $feed_id = Minz_Request::paramInt('id');
  1143. $content_selector = Minz_Request::paramString('selector');
  1144. if ($content_selector === '') {
  1145. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.selector_empty');
  1146. return;
  1147. }
  1148. //Check Feed ID validity.
  1149. $entryDAO = FreshRSS_Factory::createEntryDao();
  1150. $entries = $entryDAO->listWhere('f', $feed_id);
  1151. $entry = null;
  1152. //Get first entry (syntax robust for Generator or Array)
  1153. foreach ($entries as $myEntry) {
  1154. $entry = $myEntry;
  1155. }
  1156. if ($entry == null) {
  1157. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_entries');
  1158. return;
  1159. }
  1160. //Get feed.
  1161. $feed = $entry->feed();
  1162. if ($feed === null) {
  1163. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_feed');
  1164. return;
  1165. }
  1166. $feed->_pathEntries($content_selector);
  1167. $feed->_attribute('path_entries_filter', Minz_Request::paramString('selector_filter', true));
  1168. //Fetch & select content.
  1169. try {
  1170. $fullContent = $entry->getContentByParsing();
  1171. if ($fullContent != '') {
  1172. $this->view->selectorSuccess = true;
  1173. $this->view->htmlContent = $fullContent;
  1174. } else {
  1175. $this->view->selectorSuccess = false;
  1176. $this->view->htmlContent = $entry->content(false);
  1177. }
  1178. } catch (Exception) {
  1179. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.http_error');
  1180. }
  1181. }
  1182. }