feedController.php 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985
  1. <?php
  2. /**
  3. * Controller to handle every feed actions.
  4. */
  5. class FreshRSS_feed_Controller extends FreshRSS_ActionController {
  6. /**
  7. * This action is called before every other action in that class. It is
  8. * the common boiler plate for every action. It is triggered by the
  9. * underlying framework.
  10. */
  11. public function firstAction(): void {
  12. if (!FreshRSS_Auth::hasAccess()) {
  13. // Token is useful in the case that anonymous refresh is forbidden
  14. // and CRON task cannot be used with php command so the user can
  15. // set a CRON task to refresh his feeds by using token inside url
  16. $token = FreshRSS_Context::$user_conf->token;
  17. $token_param = Minz_Request::paramString('token');
  18. $token_is_ok = ($token != '' && $token == $token_param);
  19. $action = Minz_Request::actionName();
  20. $allow_anonymous_refresh = FreshRSS_Context::$system_conf->allow_anonymous_refresh;
  21. if ($action !== 'actualize' ||
  22. !($allow_anonymous_refresh || $token_is_ok)) {
  23. Minz_Error::error(403);
  24. }
  25. }
  26. }
  27. /**
  28. * @param array<string,mixed> $attributes
  29. * @throws FreshRSS_AlreadySubscribed_Exception
  30. * @throws FreshRSS_FeedNotAdded_Exception
  31. * @throws FreshRSS_Feed_Exception
  32. * @throws Minz_FileNotExistException
  33. */
  34. public static function addFeed(string $url, string $title = '', int $cat_id = 0, string $new_cat_name = '',
  35. string $http_auth = '', array $attributes = [], int $kind = FreshRSS_Feed::KIND_RSS): FreshRSS_Feed {
  36. FreshRSS_UserDAO::touch();
  37. @set_time_limit(300);
  38. $catDAO = FreshRSS_Factory::createCategoryDao();
  39. $url = trim($url);
  40. /** @var string|null $url */
  41. $urlHooked = Minz_ExtensionManager::callHook('check_url_before_add', $url);
  42. if ($urlHooked === null) {
  43. throw new FreshRSS_FeedNotAdded_Exception($url);
  44. }
  45. $url = $urlHooked;
  46. $cat = null;
  47. if ($cat_id > 0) {
  48. $cat = $catDAO->searchById($cat_id);
  49. }
  50. if ($cat === null && $new_cat_name != '') {
  51. $new_cat_id = $catDAO->addCategory(array('name' => $new_cat_name));
  52. $cat_id = $new_cat_id > 0 ? $new_cat_id : $cat_id;
  53. $cat = $catDAO->searchById($cat_id);
  54. }
  55. if ($cat === null) {
  56. $catDAO->checkDefault();
  57. }
  58. $cat_id = $cat === null ? FreshRSS_CategoryDAO::DEFAULTCATEGORYID : $cat->id();
  59. $feed = new FreshRSS_Feed($url); //Throws FreshRSS_BadUrl_Exception
  60. $title = trim($title);
  61. if ($title !== '') {
  62. $feed->_name($title);
  63. }
  64. $feed->_kind($kind);
  65. $feed->_attributes('', $attributes);
  66. $feed->_httpAuth($http_auth);
  67. $feed->_categoryId($cat_id);
  68. switch ($kind) {
  69. case FreshRSS_Feed::KIND_RSS:
  70. case FreshRSS_Feed::KIND_RSS_FORCED:
  71. $feed->load(true); //Throws FreshRSS_Feed_Exception, Minz_FileNotExistException
  72. break;
  73. case FreshRSS_Feed::KIND_HTML_XPATH:
  74. case FreshRSS_Feed::KIND_XML_XPATH:
  75. $feed->_website($url);
  76. break;
  77. }
  78. $feedDAO = FreshRSS_Factory::createFeedDao();
  79. if ($feedDAO->searchByUrl($feed->url())) {
  80. throw new FreshRSS_AlreadySubscribed_Exception($url, $feed->name());
  81. }
  82. /** @var FreshRSS_Feed|null $feed */
  83. $feed = Minz_ExtensionManager::callHook('feed_before_insert', $feed);
  84. if ($feed === null) {
  85. throw new FreshRSS_FeedNotAdded_Exception($url);
  86. }
  87. $id = $feedDAO->addFeedObject($feed);
  88. if (!$id) {
  89. // There was an error in database… we cannot say what here.
  90. throw new FreshRSS_FeedNotAdded_Exception($url);
  91. }
  92. $feed->_id($id);
  93. // Ok, feed has been added in database. Now we have to refresh entries.
  94. self::actualizeFeed($id, $url, false, null);
  95. return $feed;
  96. }
  97. /**
  98. * This action subscribes to a feed.
  99. *
  100. * It can be reached by both GET and POST requests.
  101. *
  102. * GET request displays a form to add and configure a feed.
  103. * Request parameter is:
  104. * - url_rss (default: false)
  105. *
  106. * POST request adds a feed in database.
  107. * Parameters are:
  108. * - url_rss (default: false)
  109. * - category (default: false)
  110. * - http_user (default: false)
  111. * - http_pass (default: false)
  112. * It tries to get website information from RSS feed.
  113. * If no category is given, feed is added to the default one.
  114. *
  115. * If url_rss is false, nothing happened.
  116. */
  117. public function addAction(): void {
  118. $url = Minz_Request::paramString('url_rss');
  119. if ($url === '') {
  120. // No url, do nothing
  121. Minz_Request::forward(array(
  122. 'c' => 'subscription',
  123. 'a' => 'index'
  124. ), true);
  125. }
  126. $feedDAO = FreshRSS_Factory::createFeedDao();
  127. $url_redirect = array(
  128. 'c' => 'subscription',
  129. 'a' => 'add',
  130. 'params' => array(),
  131. );
  132. $limits = FreshRSS_Context::$system_conf->limits;
  133. $this->view->feeds = $feedDAO->listFeeds();
  134. if (count($this->view->feeds) >= $limits['max_feeds']) {
  135. Minz_Request::bad(_t('feedback.sub.feed.over_max', $limits['max_feeds']), $url_redirect);
  136. }
  137. if (Minz_Request::isPost()) {
  138. $cat = Minz_Request::paramInt('category');
  139. // HTTP information are useful if feed is protected behind a
  140. // HTTP authentication
  141. $user = Minz_Request::paramString('http_user');
  142. $pass = Minz_Request::paramString('http_pass');
  143. $http_auth = '';
  144. if ($user != '' && $pass != '') { //TODO: Sanitize
  145. $http_auth = $user . ':' . $pass;
  146. }
  147. $cookie = Minz_Request::paramString('curl_params_cookie');
  148. $cookie_file = Minz_Request::paramBoolean('curl_params_cookiefile');
  149. $max_redirs = Minz_Request::paramInt('curl_params_redirects');
  150. $useragent = Minz_Request::paramString('curl_params_useragent');
  151. $proxy_address = Minz_Request::paramString('curl_params');
  152. $proxy_type = Minz_Request::paramString('proxy_type');
  153. $opts = [];
  154. if ($proxy_type !== '') {
  155. $opts[CURLOPT_PROXY] = $proxy_address;
  156. $opts[CURLOPT_PROXYTYPE] = (int)$proxy_type;
  157. }
  158. if ($cookie !== '') {
  159. $opts[CURLOPT_COOKIE] = $cookie;
  160. }
  161. if ($cookie_file) {
  162. // Pass empty cookie file name to enable the libcurl cookie engine
  163. // without reading any existing cookie data.
  164. $opts[CURLOPT_COOKIEFILE] = '';
  165. }
  166. if ($max_redirs !== 0) {
  167. $opts[CURLOPT_MAXREDIRS] = $max_redirs;
  168. $opts[CURLOPT_FOLLOWLOCATION] = 1;
  169. }
  170. if ($useragent !== '') {
  171. $opts[CURLOPT_USERAGENT] = $useragent;
  172. }
  173. $attributes = [
  174. 'curl_params' => empty($opts) ? null : $opts,
  175. ];
  176. $attributes['ssl_verify'] = Minz_Request::paramTernary('ssl_verify');
  177. $timeout = Minz_Request::paramInt('timeout');
  178. $attributes['timeout'] = $timeout > 0 ? $timeout : null;
  179. $feed_kind = Minz_Request::paramInt('feed_kind') ?: FreshRSS_Feed::KIND_RSS;
  180. if ($feed_kind === FreshRSS_Feed::KIND_HTML_XPATH || $feed_kind === FreshRSS_Feed::KIND_XML_XPATH) {
  181. $xPathSettings = [];
  182. if (Minz_Request::paramString('xPathFeedTitle') !== '') {
  183. $xPathSettings['feedTitle'] = Minz_Request::paramString('xPathFeedTitle', true);
  184. }
  185. if (Minz_Request::paramString('xPathItem') !== '') {
  186. $xPathSettings['item'] = Minz_Request::paramString('xPathItem', true);
  187. }
  188. if (Minz_Request::paramString('xPathItemTitle') !== '') {
  189. $xPathSettings['itemTitle'] = Minz_Request::paramString('xPathItemTitle', true);
  190. }
  191. if (Minz_Request::paramString('xPathItemContent') !== '') {
  192. $xPathSettings['itemContent'] = Minz_Request::paramString('xPathItemContent', true);
  193. }
  194. if (Minz_Request::paramString('xPathItemUri') !== '') {
  195. $xPathSettings['itemUri'] = Minz_Request::paramString('xPathItemUri', true);
  196. }
  197. if (Minz_Request::paramString('xPathItemAuthor') !== '') {
  198. $xPathSettings['itemAuthor'] = Minz_Request::paramString('xPathItemAuthor', true);
  199. }
  200. if (Minz_Request::paramString('xPathItemTimestamp') !== '') {
  201. $xPathSettings['itemTimestamp'] = Minz_Request::paramString('xPathItemTimestamp', true);
  202. }
  203. if (Minz_Request::paramString('xPathItemTimeFormat') !== '') {
  204. $xPathSettings['itemTimeFormat'] = Minz_Request::paramString('xPathItemTimeFormat', true);
  205. }
  206. if (Minz_Request::paramString('xPathItemThumbnail') !== '') {
  207. $xPathSettings['itemThumbnail'] = Minz_Request::paramString('xPathItemThumbnail', true);
  208. }
  209. if (Minz_Request::paramString('xPathItemCategories') !== '') {
  210. $xPathSettings['itemCategories'] = Minz_Request::paramString('xPathItemCategories', true);
  211. }
  212. if (Minz_Request::paramString('xPathItemUid') !== '') {
  213. $xPathSettings['itemUid'] = Minz_Request::paramString('xPathItemUid', true);
  214. }
  215. if (!empty($xPathSettings)) {
  216. $attributes['xpath'] = $xPathSettings;
  217. }
  218. }
  219. try {
  220. $feed = self::addFeed($url, '', $cat, '', $http_auth, $attributes, $feed_kind);
  221. } catch (FreshRSS_BadUrl_Exception $e) {
  222. // Given url was not a valid url!
  223. Minz_Log::warning($e->getMessage());
  224. Minz_Request::bad(_t('feedback.sub.feed.invalid_url', $url), $url_redirect);
  225. return;
  226. } catch (FreshRSS_Feed_Exception $e) {
  227. // Something went bad (timeout, server not found, etc.)
  228. Minz_Log::warning($e->getMessage());
  229. Minz_Request::bad(_t('feedback.sub.feed.internal_problem', _url('index', 'logs')), $url_redirect);
  230. return;
  231. } catch (Minz_FileNotExistException $e) {
  232. // Cache directory doesn’t exist!
  233. Minz_Log::error($e->getMessage());
  234. Minz_Request::bad(_t('feedback.sub.feed.internal_problem', _url('index', 'logs')), $url_redirect);
  235. return;
  236. } catch (FreshRSS_AlreadySubscribed_Exception $e) {
  237. Minz_Request::bad(_t('feedback.sub.feed.already_subscribed', $e->feedName()), $url_redirect);
  238. return;
  239. } catch (FreshRSS_FeedNotAdded_Exception $e) {
  240. Minz_Request::bad(_t('feedback.sub.feed.not_added', $e->url()), $url_redirect);
  241. return;
  242. }
  243. // Entries are in DB, we redirect to feed configuration page.
  244. $url_redirect['a'] = 'feed';
  245. $url_redirect['params']['id'] = '' . $feed->id();
  246. Minz_Request::good(_t('feedback.sub.feed.added', $feed->name()), $url_redirect);
  247. } else {
  248. // GET request: we must ask confirmation to user before adding feed.
  249. FreshRSS_View::prependTitle(_t('sub.feed.title_add') . ' · ');
  250. $catDAO = FreshRSS_Factory::createCategoryDao();
  251. $this->view->categories = $catDAO->listCategories(false) ?: [];
  252. $this->view->feed = new FreshRSS_Feed($url);
  253. try {
  254. // We try to get more information about the feed.
  255. $this->view->feed->load(true);
  256. $this->view->load_ok = true;
  257. } catch (Exception $e) {
  258. $this->view->load_ok = false;
  259. }
  260. $feed = $feedDAO->searchByUrl($this->view->feed->url());
  261. if ($feed) {
  262. // Already subscribe so we redirect to the feed configuration page.
  263. $url_redirect['a'] = 'feed';
  264. $url_redirect['params']['id'] = $feed->id();
  265. Minz_Request::good(_t('feedback.sub.feed.already_subscribed', $feed->name()), $url_redirect);
  266. }
  267. }
  268. }
  269. /**
  270. * This action remove entries from a given feed.
  271. *
  272. * It should be reached by a POST action.
  273. *
  274. * Parameter is:
  275. * - id (default: false)
  276. */
  277. public function truncateAction(): void {
  278. $id = Minz_Request::paramInt('id');
  279. $url_redirect = array(
  280. 'c' => 'subscription',
  281. 'a' => 'index',
  282. 'params' => array('id' => $id)
  283. );
  284. if (!Minz_Request::isPost()) {
  285. Minz_Request::forward($url_redirect, true);
  286. }
  287. $feedDAO = FreshRSS_Factory::createFeedDao();
  288. $n = $feedDAO->truncate($id);
  289. invalidateHttpCache();
  290. if ($n === false) {
  291. Minz_Request::bad(_t('feedback.sub.feed.error'), $url_redirect);
  292. } else {
  293. Minz_Request::good(_t('feedback.sub.feed.n_entries_deleted', $n), $url_redirect);
  294. }
  295. }
  296. /**
  297. * @return array{0:int,1:FreshRSS_Feed|false,2:int}
  298. * @throws FreshRSS_BadUrl_Exception
  299. */
  300. public static function actualizeFeed(int $feed_id, string $feed_url, bool $force, ?SimplePie $simplePiePush = null,
  301. bool $noCommit = false, int $maxFeeds = 10): array {
  302. @set_time_limit(300);
  303. $feedDAO = FreshRSS_Factory::createFeedDao();
  304. $entryDAO = FreshRSS_Factory::createEntryDao();
  305. // Create a list of feeds to actualize.
  306. // If feed_id is set and valid, corresponding feed is added to the list but
  307. // alone in order to automatize further process.
  308. $feeds = array();
  309. if ($feed_id > 0 || $feed_url) {
  310. $feed = $feed_id > 0 ? $feedDAO->searchById($feed_id) : $feedDAO->searchByUrl($feed_url);
  311. if ($feed) {
  312. $feeds[] = $feed;
  313. }
  314. } else {
  315. $feeds = $feedDAO->listFeedsOrderUpdate(-1);
  316. }
  317. // Set maxFeeds to a minimum of 10
  318. if ($maxFeeds < 10) {
  319. $maxFeeds = 10;
  320. }
  321. // WebSub (PubSubHubbub) support
  322. $pubsubhubbubEnabledGeneral = FreshRSS_Context::$system_conf->pubsubhubbub_enabled;
  323. $pshbMinAge = time() - (3600 * 24); //TODO: Make a configuration.
  324. $updated_feeds = 0;
  325. $nb_new_articles = 0;
  326. foreach ($feeds as $feed) {
  327. /** @var FreshRSS_Feed|null $feed */
  328. $feed = Minz_ExtensionManager::callHook('feed_before_actualize', $feed);
  329. if (null === $feed) {
  330. continue;
  331. }
  332. $url = $feed->url(); //For detection of HTTP 301
  333. $pubSubHubbubEnabled = $pubsubhubbubEnabledGeneral && $feed->pubSubHubbubEnabled();
  334. if ((!$simplePiePush) && (!$feed_id) && $pubSubHubbubEnabled && ($feed->lastUpdate() > $pshbMinAge)) {
  335. //$text = 'Skip pull of feed using PubSubHubbub: ' . $url;
  336. //Minz_Log::debug($text);
  337. //Minz_Log::debug($text, PSHB_LOG);
  338. continue; //When PubSubHubbub is used, do not pull refresh so often
  339. }
  340. $mtime = 0;
  341. if ($feed->mute()) {
  342. continue; //Feed refresh is disabled
  343. }
  344. $ttl = $feed->ttl();
  345. if ((!$simplePiePush) && (!$feed_id) &&
  346. ($feed->lastUpdate() + 10 >= time() - (
  347. $ttl === FreshRSS_Feed::TTL_DEFAULT ? FreshRSS_Context::$user_conf->ttl_default : $ttl))) {
  348. //Too early to refresh from source, but check whether the feed was updated by another user
  349. $mtime = $feed->cacheModifiedTime() ?: 0;
  350. if ($feed->lastUpdate() + 10 >= $mtime) {
  351. continue; //Nothing newer from other users
  352. }
  353. //Minz_Log::debug($feed->url(false) . ' was updated at ' . date('c', $mtime) . ' by another user');
  354. //Will take advantage of the newer cache
  355. } else {
  356. $mtime = time();
  357. }
  358. if (!$feed->lock()) {
  359. Minz_Log::notice('Feed already being actualized: ' . $feed->url(false));
  360. continue;
  361. }
  362. $isNewFeed = $feed->lastUpdate() <= 0;
  363. $feedIsUnchanged = false;
  364. try {
  365. if ($simplePiePush) {
  366. $simplePie = $simplePiePush; //Used by WebSub
  367. } elseif ($feed->kind() === FreshRSS_Feed::KIND_HTML_XPATH) {
  368. $simplePie = $feed->loadHtmlXpath();
  369. if ($simplePie === null) {
  370. throw new FreshRSS_Feed_Exception('HTML+XPath Web scraping failed for [' . $feed->url(false) . ']');
  371. }
  372. } elseif ($feed->kind() === FreshRSS_Feed::KIND_XML_XPATH) {
  373. $simplePie = $feed->loadHtmlXpath();
  374. if ($simplePie === null) {
  375. throw new FreshRSS_Feed_Exception('XML+XPath parsing failed for [' . $feed->url(false) . ']');
  376. }
  377. } else {
  378. $simplePie = $feed->load(false, $isNewFeed);
  379. if ($simplePie === null) {
  380. // Feed is cached and unchanged
  381. $feedIsUnchanged = true;
  382. }
  383. }
  384. $newGuids = $simplePie === null ? [] : $feed->loadGuids($simplePie);
  385. $entries = $simplePie === null ? [] : $feed->loadEntries($simplePie);
  386. } catch (FreshRSS_Feed_Exception $e) {
  387. Minz_Log::warning($e->getMessage());
  388. $feedDAO->updateLastUpdate($feed->id(), true);
  389. if ($e->getCode() === 410) {
  390. // HTTP 410 Gone
  391. Minz_Log::warning('Muting gone feed: ' . $feed->url(false));
  392. $feedDAO->mute($feed->id(), true);
  393. }
  394. $feed->unlock();
  395. continue;
  396. }
  397. $needFeedCacheRefresh = false;
  398. if (count($newGuids) > 0) {
  399. $titlesAsRead = [];
  400. $readWhenSameTitleInFeed = $feed->attributes('read_when_same_title_in_feed');
  401. if ($readWhenSameTitleInFeed == false) {
  402. $readWhenSameTitleInFeed = FreshRSS_Context::$user_conf->mark_when['same_title_in_feed'];
  403. }
  404. if ($readWhenSameTitleInFeed > 0) {
  405. /** @var array<string,bool> $titlesAsRead*/
  406. $titlesAsRead = array_flip($feedDAO->listTitles($feed->id(), (int)$readWhenSameTitleInFeed));
  407. }
  408. $mark_updated_article_unread = $feed->attributes('mark_updated_article_unread') !== null ? (
  409. $feed->attributes('mark_updated_article_unread')
  410. ) : FreshRSS_Context::$user_conf->mark_updated_article_unread;
  411. // For this feed, check existing GUIDs already in database.
  412. $existingHashForGuids = $entryDAO->listHashForFeedGuids($feed->id(), $newGuids) ?: [];
  413. /** @var array<string,bool> $newGuids */
  414. $newGuids = [];
  415. // Add entries in database if possible.
  416. /** @var FreshRSS_Entry $entry */
  417. foreach ($entries as $entry) {
  418. if (isset($newGuids[$entry->guid()])) {
  419. continue; //Skip subsequent articles with same GUID
  420. }
  421. $newGuids[$entry->guid()] = true;
  422. if (isset($existingHashForGuids[$entry->guid()])) {
  423. $existingHash = $existingHashForGuids[$entry->guid()];
  424. if (strcasecmp($existingHash, $entry->hash()) !== 0) {
  425. //This entry already exists but has been updated
  426. //Minz_Log::debug('Entry with GUID `' . $entry->guid() . '` updated in feed ' . $feed->url(false) .
  427. //', old hash ' . $existingHash . ', new hash ' . $entry->hash());
  428. $entry->_isRead($mark_updated_article_unread ? false : null); //Change is_read according to policy.
  429. $entry->_isFavorite(null); // Do not change favourite state
  430. $entry = Minz_ExtensionManager::callHook('entry_before_insert', $entry);
  431. if (!($entry instanceof FreshRSS_Entry)) {
  432. // An extension has returned a null value, there is nothing to insert.
  433. continue;
  434. }
  435. if (!$entry->isRead()) {
  436. $needFeedCacheRefresh = true;
  437. $feed->incPendingUnread(); //Maybe
  438. }
  439. // If the entry has changed, there is a good chance for the full content to have changed as well.
  440. $entry->loadCompleteContent(true);
  441. if (!$entryDAO->inTransaction()) {
  442. $entryDAO->beginTransaction();
  443. }
  444. $entryDAO->updateEntry($entry->toArray());
  445. }
  446. } else {
  447. $id = uTimeString();
  448. $entry->_id($id);
  449. $entry->applyFilterActions($titlesAsRead);
  450. if ($readWhenSameTitleInFeed > 0) {
  451. $titlesAsRead[$entry->title()] = true;
  452. }
  453. $entry = Minz_ExtensionManager::callHook('entry_before_insert', $entry);
  454. if (!($entry instanceof FreshRSS_Entry)) {
  455. // An extension has returned a null value, there is nothing to insert.
  456. continue;
  457. }
  458. if ($pubSubHubbubEnabled && !$simplePiePush) { //We use push, but have discovered an article by pull!
  459. $text = 'An article was discovered by pull although we use PubSubHubbub!: Feed ' .
  460. SimplePie_Misc::url_remove_credentials($url) .
  461. ' GUID ' . $entry->guid();
  462. Minz_Log::warning($text, PSHB_LOG);
  463. Minz_Log::warning($text);
  464. $pubSubHubbubEnabled = false;
  465. $feed->pubSubHubbubError(true);
  466. }
  467. if (!$entryDAO->inTransaction()) {
  468. $entryDAO->beginTransaction();
  469. }
  470. $entryDAO->addEntry($entry->toArray());
  471. if (!$entry->isRead()) {
  472. $feed->incPendingUnread();
  473. }
  474. $nb_new_articles++;
  475. }
  476. }
  477. $entryDAO->updateLastSeen($feed->id(), array_keys($newGuids), $mtime);
  478. } elseif ($feedIsUnchanged) {
  479. // Feed cache was unchanged, so mark as seen the same entries as last time
  480. if (!$entryDAO->inTransaction()) {
  481. $entryDAO->beginTransaction();
  482. }
  483. $entryDAO->updateLastSeenUnchanged($feed->id(), $mtime);
  484. }
  485. unset($entries);
  486. if (mt_rand(0, 30) === 1) { // Remove old entries once in 30.
  487. if (!$entryDAO->inTransaction()) {
  488. $entryDAO->beginTransaction();
  489. }
  490. $nb = $feed->cleanOldEntries();
  491. if ($nb > 0) {
  492. $needFeedCacheRefresh = true;
  493. }
  494. }
  495. $feedDAO->updateLastUpdate($feed->id(), false, $mtime);
  496. $needFeedCacheRefresh |= ($feed->keepMaxUnread() != false);
  497. if (!$simplePiePush) {
  498. // Do not call for WebSub events, as we do not know the list of articles still on the upstream feed.
  499. $needFeedCacheRefresh |= ($feed->markAsReadUponGone() != false);
  500. }
  501. if ($needFeedCacheRefresh) {
  502. $feedDAO->updateCachedValues($feed->id());
  503. }
  504. if ($entryDAO->inTransaction()) {
  505. $entryDAO->commit();
  506. }
  507. $feedProperties = [];
  508. if ($pubsubhubbubEnabledGeneral && $feed->hubUrl() && $feed->selfUrl()) { //selfUrl has priority for WebSub
  509. if ($feed->selfUrl() !== $url) { // https://github.com/pubsubhubbub/PubSubHubbub/wiki/Moving-Feeds-or-changing-Hubs
  510. $selfUrl = checkUrl($feed->selfUrl());
  511. if ($selfUrl) {
  512. Minz_Log::debug('WebSub unsubscribe ' . $feed->url(false));
  513. if (!$feed->pubSubHubbubSubscribe(false)) { //Unsubscribe
  514. Minz_Log::warning('Error while WebSub unsubscribing from ' . $feed->url(false));
  515. }
  516. $feed->_url($selfUrl, false);
  517. Minz_Log::notice('Feed ' . $url . ' canonical address moved to ' . $feed->url(false));
  518. $feedDAO->updateFeed($feed->id(), array('url' => $feed->url()));
  519. }
  520. }
  521. } elseif ($feed->url() !== $url) { // HTTP 301 Moved Permanently
  522. Minz_Log::notice('Feed ' . SimplePie_Misc::url_remove_credentials($url) .
  523. ' moved permanently to ' . SimplePie_Misc::url_remove_credentials($feed->url(false)));
  524. $feedProperties['url'] = $feed->url();
  525. }
  526. if ($simplePie != null) {
  527. if ($feed->name(true) === '') {
  528. //HTML to HTML-PRE //ENT_COMPAT except '&'
  529. $name = strtr(html_only_entity_decode($simplePie->get_title()), array('<' => '&lt;', '>' => '&gt;', '"' => '&quot;'));
  530. $feed->_name($name);
  531. $feedProperties['name'] = $feed->name(false);
  532. }
  533. if (trim($feed->website()) === '') {
  534. $website = html_only_entity_decode($simplePie->get_link());
  535. $feed->_website($website == '' ? $feed->url() : $website);
  536. $feedProperties['website'] = $feed->website();
  537. $feed->faviconPrepare();
  538. }
  539. if (trim($feed->description()) === '') {
  540. $description = html_only_entity_decode($simplePie->get_description());
  541. if ($description !== '') {
  542. $feed->_description($description);
  543. $feedProperties['description'] = $feed->description();
  544. }
  545. }
  546. }
  547. if (!empty($feedProperties)) {
  548. $ok = $feedDAO->updateFeed($feed->id(), $feedProperties);
  549. if (!$ok && $isNewFeed) {
  550. //Cancel adding new feed in case of database error at first actualize
  551. $feedDAO->deleteFeed($feed->id());
  552. $feed->unlock();
  553. break;
  554. }
  555. }
  556. $feed->faviconPrepare();
  557. if ($pubsubhubbubEnabledGeneral && $feed->pubSubHubbubPrepare()) {
  558. Minz_Log::notice('WebSub subscribe ' . $feed->url(false));
  559. if (!$feed->pubSubHubbubSubscribe(true)) { //Subscribe
  560. Minz_Log::warning('Error while WebSub subscribing to ' . $feed->url(false));
  561. }
  562. }
  563. $feed->unlock();
  564. $updated_feeds++;
  565. unset($feed);
  566. gc_collect_cycles();
  567. // No more than $maxFeeds feeds unless $force is true to avoid overloading
  568. // the server.
  569. if ($updated_feeds >= $maxFeeds && !$force) {
  570. break;
  571. }
  572. }
  573. if (!$noCommit && ($nb_new_articles > 0 || $updated_feeds > 0)) {
  574. if (!$entryDAO->inTransaction()) {
  575. $entryDAO->beginTransaction();
  576. }
  577. $entryDAO->commitNewEntries();
  578. $feedDAO->updateCachedValues();
  579. if ($entryDAO->inTransaction()) {
  580. $entryDAO->commit();
  581. }
  582. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  583. $databaseDAO->minorDbMaintenance();
  584. }
  585. return array($updated_feeds, reset($feeds), $nb_new_articles);
  586. }
  587. /**
  588. * This action actualizes entries from one or several feeds.
  589. *
  590. * Parameters are:
  591. * - id (default: false): Feed ID
  592. * - url (default: false): Feed URL
  593. * - force (default: false)
  594. * - noCommit (default: 0): Set to 1 to prevent committing the new articles to the main database
  595. * If id and url are not specified, all the feeds are actualized. But if force is
  596. * false, process stops at 10 feeds to avoid time execution problem.
  597. */
  598. public function actualizeAction(): int {
  599. Minz_Session::_param('actualize_feeds', false);
  600. $id = Minz_Request::paramInt('id');
  601. $url = Minz_Request::paramString('url');
  602. $force = Minz_Request::paramBoolean('force');
  603. $maxFeeds = Minz_Request::paramInt('maxFeeds');
  604. $noCommit = ($_POST['noCommit'] ?? 0) == 1;
  605. $feed = null;
  606. if ($id == -1 && !$noCommit) { //Special request only to commit & refresh DB cache
  607. $updated_feeds = 0;
  608. $entryDAO = FreshRSS_Factory::createEntryDao();
  609. $feedDAO = FreshRSS_Factory::createFeedDao();
  610. $entryDAO->beginTransaction();
  611. $entryDAO->commitNewEntries();
  612. $feedDAO->updateCachedValues();
  613. $entryDAO->commit();
  614. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  615. $databaseDAO->minorDbMaintenance();
  616. } else {
  617. FreshRSS_category_Controller::refreshDynamicOpmls();
  618. [$updated_feeds, $feed] = self::actualizeFeed($id, $url, $force, null, $noCommit, $maxFeeds);
  619. }
  620. if (Minz_Request::paramBoolean('ajax')) {
  621. // Most of the time, ajax request is for only one feed. But since
  622. // there are several parallel requests, we should return that there
  623. // are several updated feeds.
  624. Minz_Request::setGoodNotification(_t('feedback.sub.feed.actualizeds'));
  625. // No layout in ajax request.
  626. $this->view->_layout(null);
  627. } elseif ($feed instanceof FreshRSS_Feed) {
  628. // Redirect to the main page with correct notification.
  629. if ($updated_feeds === 1) {
  630. Minz_Request::good(_t('feedback.sub.feed.actualized', $feed->name()), [
  631. 'params' => ['get' => 'f_' . $feed->id()]
  632. ]);
  633. } elseif ($updated_feeds > 1) {
  634. Minz_Request::good(_t('feedback.sub.feed.n_actualized', $updated_feeds), []);
  635. } else {
  636. Minz_Request::good(_t('feedback.sub.feed.no_refresh'), []);
  637. }
  638. }
  639. return $updated_feeds;
  640. }
  641. public static function renameFeed(int $feed_id, string $feed_name): bool {
  642. if ($feed_id <= 0 || $feed_name === '') {
  643. return false;
  644. }
  645. FreshRSS_UserDAO::touch();
  646. $feedDAO = FreshRSS_Factory::createFeedDao();
  647. return $feedDAO->updateFeed($feed_id, array('name' => $feed_name)) === 1;
  648. }
  649. public static function moveFeed(int $feed_id, int $cat_id, string $new_cat_name = ''): bool {
  650. if ($feed_id <= 0 || ($cat_id <= 0 && $new_cat_name === '')) {
  651. return false;
  652. }
  653. FreshRSS_UserDAO::touch();
  654. $catDAO = FreshRSS_Factory::createCategoryDao();
  655. if ($cat_id > 0) {
  656. $cat = $catDAO->searchById($cat_id);
  657. $cat_id = $cat === null ? 0 : $cat->id();
  658. }
  659. if ($cat_id <= 1 && $new_cat_name != '') {
  660. $cat_id = $catDAO->addCategory(array('name' => $new_cat_name));
  661. }
  662. if ($cat_id <= 1) {
  663. $catDAO->checkDefault();
  664. $cat_id = FreshRSS_CategoryDAO::DEFAULTCATEGORYID;
  665. }
  666. $feedDAO = FreshRSS_Factory::createFeedDao();
  667. return $feedDAO->updateFeed($feed_id, array('category' => $cat_id)) === 1;
  668. }
  669. /**
  670. * This action changes the category of a feed.
  671. *
  672. * This page must be reached by a POST request.
  673. *
  674. * Parameters are:
  675. * - f_id (default: false)
  676. * - c_id (default: false)
  677. * If c_id is false, default category is used.
  678. *
  679. * @todo should handle order of the feed inside the category.
  680. */
  681. public function moveAction(): void {
  682. if (!Minz_Request::isPost()) {
  683. Minz_Request::forward(array('c' => 'subscription'), true);
  684. }
  685. $feed_id = Minz_Request::paramInt('f_id');
  686. $cat_id = Minz_Request::paramInt('c_id');
  687. if (self::moveFeed($feed_id, $cat_id)) {
  688. // TODO: return something useful
  689. // Log a notice to prevent "Empty IF statement" warning in PHP_CodeSniffer
  690. Minz_Log::notice('Moved feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  691. } else {
  692. Minz_Log::warning('Cannot move feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  693. Minz_Error::error(404);
  694. }
  695. }
  696. public static function deleteFeed(int $feed_id): bool {
  697. FreshRSS_UserDAO::touch();
  698. $feedDAO = FreshRSS_Factory::createFeedDao();
  699. if ($feedDAO->deleteFeed($feed_id)) {
  700. // TODO: Delete old favicon
  701. // Remove related queries
  702. FreshRSS_Context::$user_conf->queries = remove_query_by_get(
  703. 'f_' . $feed_id, FreshRSS_Context::$user_conf->queries);
  704. FreshRSS_Context::$user_conf->save();
  705. return true;
  706. }
  707. return false;
  708. }
  709. /**
  710. * This action deletes a feed.
  711. *
  712. * This page must be reached by a POST request.
  713. * If there are related queries, they are deleted too.
  714. *
  715. * Parameters are:
  716. * - id (default: false)
  717. */
  718. public function deleteAction(): void {
  719. $from = Minz_Request::paramString('from');
  720. $id = Minz_Request::paramInt('id');
  721. switch ($from) {
  722. case 'stats':
  723. $redirect_url = array('c' => 'stats', 'a' => 'idle');
  724. break;
  725. case 'normal':
  726. $get = Minz_Request::paramString('get');
  727. if ($get) {
  728. $redirect_url = array('c' => 'index', 'a' => 'normal', 'params' => array('get' => $get));
  729. } else {
  730. $redirect_url = array('c' => 'index', 'a' => 'normal');
  731. }
  732. break;
  733. default:
  734. $redirect_url = ['c' => 'subscription', 'a' => 'index'];
  735. if (!Minz_Request::isPost()) {
  736. Minz_Request::forward($redirect_url, true);
  737. }
  738. }
  739. if (self::deleteFeed($id)) {
  740. Minz_Request::good(_t('feedback.sub.feed.deleted'), $redirect_url);
  741. } else {
  742. Minz_Request::bad(_t('feedback.sub.feed.error'), $redirect_url);
  743. }
  744. }
  745. /**
  746. * This action force clears the cache of a feed.
  747. *
  748. * Parameters are:
  749. * - id (mandatory - no default): Feed ID
  750. *
  751. */
  752. public function clearCacheAction(): void {
  753. //Get Feed.
  754. $id = Minz_Request::paramInt('id');
  755. $feedDAO = FreshRSS_Factory::createFeedDao();
  756. $feed = $feedDAO->searchById($id);
  757. if ($feed === null) {
  758. Minz_Request::bad(_t('feedback.sub.feed.not_found'), array());
  759. return;
  760. }
  761. $feed->clearCache();
  762. Minz_Request::good(_t('feedback.sub.feed.cache_cleared', $feed->name()), array(
  763. 'params' => array('get' => 'f_' . $feed->id())
  764. ));
  765. }
  766. /**
  767. * This action forces reloading the articles of a feed.
  768. *
  769. * Parameters are:
  770. * - id (mandatory - no default): Feed ID
  771. *
  772. * @throws FreshRSS_BadUrl_Exception
  773. */
  774. public function reloadAction(): void {
  775. @set_time_limit(300);
  776. //Get Feed ID.
  777. $feed_id = Minz_Request::paramInt('id');
  778. $limit = Minz_Request::paramInt('reload_limit') ?: 10;
  779. $feedDAO = FreshRSS_Factory::createFeedDao();
  780. $entryDAO = FreshRSS_Factory::createEntryDao();
  781. $feed = $feedDAO->searchById($feed_id);
  782. if ($feed === null) {
  783. Minz_Request::bad(_t('feedback.sub.feed.not_found'), array());
  784. return;
  785. }
  786. //Re-fetch articles as if the feed was new.
  787. $feedDAO->updateFeed($feed->id(), [ 'lastUpdate' => 0 ]);
  788. self::actualizeFeed($feed_id, '', false);
  789. //Extract all feed entries from database, load complete content and store them back in database.
  790. $entries = $entryDAO->listWhere('f', $feed_id, FreshRSS_Entry::STATE_ALL, 'DESC', $limit);
  791. //We need another DB connection in parallel for unbuffered streaming
  792. Minz_ModelPdo::$usesSharedPdo = false;
  793. if (FreshRSS_Context::$system_conf->db['type'] === 'mysql') {
  794. // Second parallel connection for unbuffered streaming: MySQL
  795. $entryDAO2 = FreshRSS_Factory::createEntryDao();
  796. } else {
  797. // Single connection for buffered queries (in memory): SQLite, PostgreSQL
  798. //TODO: Consider an unbuffered query for PostgreSQL
  799. $entryDAO2 = $entryDAO;
  800. }
  801. foreach ($entries as $entry) {
  802. if ($entry->loadCompleteContent(true)) {
  803. $entryDAO2->updateEntry($entry->toArray());
  804. }
  805. }
  806. Minz_ModelPdo::$usesSharedPdo = true;
  807. //Give feedback to user.
  808. Minz_Request::good(_t('feedback.sub.feed.reloaded', $feed->name()), array(
  809. 'params' => array('get' => 'f_' . $feed->id())
  810. ));
  811. }
  812. /**
  813. * This action creates a preview of a content-selector.
  814. *
  815. * Parameters are:
  816. * - id (mandatory - no default): Feed ID
  817. * - selector (mandatory - no default): Selector to preview
  818. *
  819. */
  820. public function contentSelectorPreviewAction(): void {
  821. //Configure.
  822. $this->view->fatalError = '';
  823. $this->view->selectorSuccess = false;
  824. $this->view->htmlContent = '';
  825. $this->view->_layout(null);
  826. $this->_csp([
  827. 'default-src' => "'self'",
  828. 'frame-src' => '*',
  829. 'img-src' => '* data:',
  830. 'media-src' => '*',
  831. ]);
  832. //Get parameters.
  833. $feed_id = Minz_Request::paramInt('id');
  834. $content_selector = Minz_Request::paramString('selector');
  835. if (!$content_selector) {
  836. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.selector_empty');
  837. return;
  838. }
  839. //Check Feed ID validity.
  840. $entryDAO = FreshRSS_Factory::createEntryDao();
  841. $entries = $entryDAO->listWhere('f', $feed_id);
  842. $entry = null;
  843. //Get first entry (syntax robust for Generator or Array)
  844. foreach ($entries as $myEntry) {
  845. $entry = $myEntry;
  846. }
  847. if ($entry == null) {
  848. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_entries');
  849. return;
  850. }
  851. //Get feed.
  852. $feed = $entry->feed();
  853. if ($feed === null) {
  854. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_feed');
  855. return;
  856. }
  857. $attributes = $feed->attributes();
  858. $attributes['path_entries_filter'] = Minz_Request::paramString('selector_filter', true);
  859. //Fetch & select content.
  860. try {
  861. $fullContent = FreshRSS_Entry::getContentByParsing(
  862. htmlspecialchars_decode($entry->link(), ENT_QUOTES),
  863. htmlspecialchars_decode($content_selector, ENT_QUOTES),
  864. $attributes
  865. );
  866. if ($fullContent != '') {
  867. $this->view->selectorSuccess = true;
  868. $this->view->htmlContent = $fullContent;
  869. } else {
  870. $this->view->selectorSuccess = false;
  871. $this->view->htmlContent = $entry->content(false);
  872. }
  873. } catch (Exception $e) {
  874. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.http_error');
  875. }
  876. }
  877. }