feedController.php 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869
  1. <?php
  2. /**
  3. * Controller to handle every feed actions.
  4. */
  5. class FreshRSS_feed_Controller extends Minz_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() {
  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::param('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 $url
  29. * @param string $title
  30. * @param int $cat_id
  31. * @param string $new_cat_name
  32. * @param string $http_auth
  33. * @return FreshRSS_Feed|the
  34. * @throws FreshRSS_AlreadySubscribed_Exception
  35. * @throws FreshRSS_FeedNotAdded_Exception
  36. * @throws FreshRSS_Feed_Exception
  37. * @throws Minz_FileNotExistException
  38. */
  39. public static function addFeed($url, $title = '', $cat_id = 0, $new_cat_name = '', $http_auth = '', $attributes = array()) {
  40. FreshRSS_UserDAO::touch();
  41. @set_time_limit(300);
  42. $catDAO = FreshRSS_Factory::createCategoryDao();
  43. $url = trim($url);
  44. /** @var $url */
  45. $url = Minz_ExtensionManager::callHook('check_url_before_add', $url);
  46. if (null === $url) {
  47. throw new FreshRSS_FeedNotAdded_Exception($url, $title);
  48. }
  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(array('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. $cat_id = $cat == null ? FreshRSS_CategoryDAO::DEFAULTCATEGORYID : $cat->id();
  62. $feed = new FreshRSS_Feed($url); //Throws FreshRSS_BadUrl_Exception
  63. $feed->_attributes('', $attributes);
  64. $feed->_httpAuth($http_auth);
  65. $feed->load(true); //Throws FreshRSS_Feed_Exception, Minz_FileNotExistException
  66. $feed->_category($cat_id);
  67. $feedDAO = FreshRSS_Factory::createFeedDao();
  68. if ($feedDAO->searchByUrl($feed->url())) {
  69. throw new FreshRSS_AlreadySubscribed_Exception($url, $feed->name());
  70. }
  71. /** @var FreshRSS_Feed $feed */
  72. $feed = Minz_ExtensionManager::callHook('feed_before_insert', $feed);
  73. if ($feed === null) {
  74. throw new FreshRSS_FeedNotAdded_Exception($url, $feed->name());
  75. }
  76. $values = array(
  77. 'url' => $feed->url(),
  78. 'category' => $feed->category(),
  79. 'name' => $title != '' ? $title : $feed->name(),
  80. 'website' => $feed->website(),
  81. 'description' => $feed->description(),
  82. 'lastUpdate' => 0,
  83. 'httpAuth' => $feed->httpAuth(),
  84. 'attributes' => $feed->attributes(),
  85. );
  86. $id = $feedDAO->addFeed($values);
  87. if (!$id) {
  88. // There was an error in database... we cannot say what here.
  89. throw new FreshRSS_FeedNotAdded_Exception($url, $feed->name());
  90. }
  91. $feed->_id($id);
  92. // Ok, feed has been added in database. Now we have to refresh entries.
  93. self::actualizeFeed($id, $url, false, null);
  94. return $feed;
  95. }
  96. /**
  97. * This action subscribes to a feed.
  98. *
  99. * It can be reached by both GET and POST requests.
  100. *
  101. * GET request displays a form to add and configure a feed.
  102. * Request parameter is:
  103. * - url_rss (default: false)
  104. *
  105. * POST request adds a feed in database.
  106. * Parameters are:
  107. * - url_rss (default: false)
  108. * - category (default: false)
  109. * - new_category (required if category == 'nc')
  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() {
  118. $url = Minz_Request::param('url_rss');
  119. if ($url === false) {
  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::param('category');
  139. // HTTP information are useful if feed is protected behind a
  140. // HTTP authentication
  141. $user = trim(Minz_Request::param('http_user', ''));
  142. $pass = trim(Minz_Request::param('http_pass', ''));
  143. $http_auth = '';
  144. if ($user != '' && $pass != '') { //TODO: Sanitize
  145. $http_auth = $user . ':' . $pass;
  146. }
  147. $useragent = Minz_Request::param('curl_params_useragent', '');
  148. $proxy_address = Minz_Request::param('curl_params', '');
  149. $proxy_type = Minz_Request::param('proxy_type', '');
  150. $opts = [];
  151. if ($proxy_address !== '' && $proxy_type !== '' && in_array($proxy_type, [0, 2, 4, 5, 6, 7])) {
  152. $opts[CURLOPT_PROXY] = $proxy_address;
  153. $opts[CURLOPT_PROXYTYPE] = intval($proxy_type);
  154. }
  155. if ($useragent !== '') {
  156. $opts[CURLOPT_USERAGENT] = $useragent;
  157. }
  158. $attributes = array(
  159. 'ssl_verify' => null,
  160. 'timeout' => null,
  161. 'curl_params' => empty($opts) ? null : $opts,
  162. );
  163. if (FreshRSS_Auth::hasAccess('admin')) {
  164. $attributes['ssl_verify'] = Minz_Request::paramTernary('ssl_verify');
  165. $timeout = intval(Minz_Request::param('timeout', 0));
  166. $attributes['timeout'] = $timeout > 0 ? $timeout : null;
  167. }
  168. try {
  169. $feed = self::addFeed($url, '', $cat, null, $http_auth, $attributes);
  170. } catch (FreshRSS_BadUrl_Exception $e) {
  171. // Given url was not a valid url!
  172. Minz_Log::warning($e->getMessage());
  173. Minz_Request::bad(_t('feedback.sub.feed.invalid_url', $url), $url_redirect);
  174. } catch (FreshRSS_Feed_Exception $e) {
  175. // Something went bad (timeout, server not found, etc.)
  176. Minz_Log::warning($e->getMessage());
  177. Minz_Request::bad(_t('feedback.sub.feed.internal_problem', _url('index', 'logs')), $url_redirect);
  178. } catch (Minz_FileNotExistException $e) {
  179. // Cache directory doesn't exist!
  180. Minz_Log::error($e->getMessage());
  181. Minz_Request::bad(_t('feedback.sub.feed.internal_problem', _url('index', 'logs')), $url_redirect);
  182. } catch (FreshRSS_AlreadySubscribed_Exception $e) {
  183. Minz_Request::bad(_t('feedback.sub.feed.already_subscribed', $e->feedName()), $url_redirect);
  184. } catch (FreshRSS_FeedNotAdded_Exception $e) {
  185. Minz_Request::bad(_t('feedback.sub.feed.not_added', $e->feedName()), $url_redirect);
  186. }
  187. // Entries are in DB, we redirect to feed configuration page.
  188. $url_redirect['a'] = 'index';
  189. $url_redirect['params']['id'] = $feed->id();
  190. Minz_Request::good(_t('feedback.sub.feed.added', $feed->name()), $url_redirect);
  191. } else {
  192. // GET request: we must ask confirmation to user before adding feed.
  193. Minz_View::prependTitle(_t('sub.feed.title_add') . ' · ');
  194. $this->catDAO = FreshRSS_Factory::createCategoryDao();
  195. $this->view->categories = $this->catDAO->listCategories(false);
  196. $this->view->feed = new FreshRSS_Feed($url);
  197. try {
  198. // We try to get more information about the feed.
  199. $this->view->feed->load(true);
  200. $this->view->load_ok = true;
  201. } catch (Exception $e) {
  202. $this->view->load_ok = false;
  203. }
  204. $feed = $feedDAO->searchByUrl($this->view->feed->url());
  205. if ($feed) {
  206. // Already subscribe so we redirect to the feed configuration page.
  207. $url_redirect['a'] = 'index';
  208. $url_redirect['params']['id'] = $feed->id();
  209. Minz_Request::good(_t('feedback.sub.feed.already_subscribed', $feed->name()), $url_redirect);
  210. }
  211. }
  212. }
  213. /**
  214. * This action remove entries from a given feed.
  215. *
  216. * It should be reached by a POST action.
  217. *
  218. * Parameter is:
  219. * - id (default: false)
  220. */
  221. public function truncateAction() {
  222. $id = Minz_Request::param('id');
  223. $url_redirect = array(
  224. 'c' => 'subscription',
  225. 'a' => 'index',
  226. 'params' => array('id' => $id)
  227. );
  228. if (!Minz_Request::isPost()) {
  229. Minz_Request::forward($url_redirect, true);
  230. }
  231. $feedDAO = FreshRSS_Factory::createFeedDao();
  232. $n = $feedDAO->truncate($id);
  233. invalidateHttpCache();
  234. if ($n === false) {
  235. Minz_Request::bad(_t('feedback.sub.feed.error'), $url_redirect);
  236. } else {
  237. Minz_Request::good(_t('feedback.sub.feed.n_entries_deleted', $n), $url_redirect);
  238. }
  239. }
  240. public static function actualizeFeed($feed_id, $feed_url, $force, $simplePiePush = null, $noCommit = false, $maxFeeds = 10) {
  241. @set_time_limit(300);
  242. $feedDAO = FreshRSS_Factory::createFeedDao();
  243. $entryDAO = FreshRSS_Factory::createEntryDao();
  244. // Create a list of feeds to actualize.
  245. // If feed_id is set and valid, corresponding feed is added to the list but
  246. // alone in order to automatize further process.
  247. $feeds = array();
  248. if ($feed_id > 0 || $feed_url) {
  249. $feed = $feed_id > 0 ? $feedDAO->searchById($feed_id) : $feedDAO->searchByUrl($feed_url);
  250. if ($feed) {
  251. $feeds[] = $feed;
  252. }
  253. } else {
  254. $feeds = $feedDAO->listFeedsOrderUpdate(-1);
  255. }
  256. // Set maxFeeds to a minimum of 10
  257. if (!is_int($maxFeeds) || $maxFeeds < 10) {
  258. $maxFeeds = 10;
  259. }
  260. // WebSub (PubSubHubbub) support
  261. $pubsubhubbubEnabledGeneral = FreshRSS_Context::$system_conf->pubsubhubbub_enabled;
  262. $pshbMinAge = time() - (3600 * 24); //TODO: Make a configuration.
  263. $updated_feeds = 0;
  264. $nb_new_articles = 0;
  265. foreach ($feeds as $feed) {
  266. /** @var FreshRSS_Feed $feed */
  267. $feed = Minz_ExtensionManager::callHook('feed_before_actualize', $feed);
  268. if (null === $feed) {
  269. continue;
  270. }
  271. $url = $feed->url(); //For detection of HTTP 301
  272. $pubSubHubbubEnabled = $pubsubhubbubEnabledGeneral && $feed->pubSubHubbubEnabled();
  273. if ((!$simplePiePush) && (!$feed_id) && $pubSubHubbubEnabled && ($feed->lastUpdate() > $pshbMinAge)) {
  274. //$text = 'Skip pull of feed using PubSubHubbub: ' . $url;
  275. //Minz_Log::debug($text);
  276. //Minz_Log::debug($text, PSHB_LOG);
  277. continue; //When PubSubHubbub is used, do not pull refresh so often
  278. }
  279. $mtime = 0;
  280. if ($feed->mute()) {
  281. continue; //Feed refresh is disabled
  282. }
  283. $ttl = $feed->ttl();
  284. if ((!$simplePiePush) && (!$feed_id) &&
  285. ($feed->lastUpdate() + 10 >= time() - (
  286. $ttl == FreshRSS_Feed::TTL_DEFAULT ? FreshRSS_Context::$user_conf->ttl_default : $ttl))) {
  287. //Too early to refresh from source, but check whether the feed was updated by another user
  288. $mtime = $feed->cacheModifiedTime();
  289. if ($feed->lastUpdate() + 10 >= $mtime) {
  290. continue; //Nothing newer from other users
  291. }
  292. //Minz_Log::debug($feed->url(false) . ' was updated at ' . date('c', $mtime) . ' by another user');
  293. //Will take advantage of the newer cache
  294. }
  295. if (!$feed->lock()) {
  296. Minz_Log::notice('Feed already being actualized: ' . $feed->url(false));
  297. continue;
  298. }
  299. $isNewFeed = $feed->lastUpdate() <= 0;
  300. try {
  301. if ($simplePiePush) {
  302. $simplePie = $simplePiePush; //Used by WebSub
  303. } else {
  304. $simplePie = $feed->load(false, $isNewFeed);
  305. }
  306. $newGuids = $simplePie == null ? [] : $feed->loadGuids($simplePie);
  307. $entries = $simplePie == null ? [] : $feed->loadEntries($simplePie);
  308. } catch (FreshRSS_Feed_Exception $e) {
  309. Minz_Log::warning($e->getMessage());
  310. $feedDAO->updateLastUpdate($feed->id(), true);
  311. if ($e->getCode() === 410) {
  312. // HTTP 410 Gone
  313. Minz_Log::warning('Muting gone feed: ' . $feed->url(false));
  314. $feedDAO->mute($feed->id(), true);
  315. }
  316. $feed->unlock();
  317. continue;
  318. }
  319. $needFeedCacheRefresh = false;
  320. if (count($newGuids) > 0) {
  321. // For this feed, check existing GUIDs already in database.
  322. $existingHashForGuids = $entryDAO->listHashForFeedGuids($feed->id(), $newGuids);
  323. $newGuids = array();
  324. $oldGuids = array();
  325. // Add entries in database if possible.
  326. foreach ($entries as $entry) {
  327. if (isset($newGuids[$entry->guid()])) {
  328. continue; //Skip subsequent articles with same GUID
  329. }
  330. $newGuids[$entry->guid()] = true;
  331. if (isset($existingHashForGuids[$entry->guid()])) {
  332. $existingHash = $existingHashForGuids[$entry->guid()];
  333. if (strcasecmp($existingHash, $entry->hash()) === 0) {
  334. //This entry already exists and is unchanged.
  335. $oldGuids[] = $entry->guid();
  336. } else { //This entry already exists but has been updated
  337. //Minz_Log::debug('Entry with GUID `' . $entry->guid() . '` updated in feed ' . $feed->url(false) .
  338. //', old hash ' . $existingHash . ', new hash ' . $entry->hash());
  339. $mark_updated_article_unread = $feed->attributes('mark_updated_article_unread') !== null ?
  340. $feed->attributes('mark_updated_article_unread') :
  341. FreshRSS_Context::$user_conf->mark_updated_article_unread;
  342. $needFeedCacheRefresh = $mark_updated_article_unread;
  343. $entry->_isRead($mark_updated_article_unread ? false : null); //Change is_read according to policy.
  344. $entry = Minz_ExtensionManager::callHook('entry_before_insert', $entry);
  345. if ($entry === null) {
  346. // An extension has returned a null value, there is nothing to insert.
  347. continue;
  348. }
  349. // If the entry has changed, there is a good chance for the full content to have changed as well.
  350. $entry->loadCompleteContent(true);
  351. if (!$entryDAO->inTransaction()) {
  352. $entryDAO->beginTransaction();
  353. }
  354. $entryDAO->updateEntry($entry->toArray());
  355. }
  356. } else {
  357. $id = uTimeString();
  358. $entry->_id($id);
  359. $entry->applyFilterActions();
  360. $entry = Minz_ExtensionManager::callHook('entry_before_insert', $entry);
  361. if ($entry === null) {
  362. // An extension has returned a null value, there is nothing to insert.
  363. continue;
  364. }
  365. if ($pubSubHubbubEnabled && !$simplePiePush) { //We use push, but have discovered an article by pull!
  366. $text = 'An article was discovered by pull although we use PubSubHubbub!: Feed ' . $url .
  367. ' GUID ' . $entry->guid();
  368. Minz_Log::warning($text, PSHB_LOG);
  369. Minz_Log::warning($text);
  370. $pubSubHubbubEnabled = false;
  371. $feed->pubSubHubbubError(true);
  372. }
  373. if (!$entryDAO->inTransaction()) {
  374. $entryDAO->beginTransaction();
  375. }
  376. $entryDAO->addEntry($entry->toArray());
  377. $nb_new_articles++;
  378. }
  379. }
  380. $entryDAO->updateLastSeen($feed->id(), $oldGuids, $mtime);
  381. }
  382. unset($entries);
  383. if (mt_rand(0, 30) === 1) { // Remove old entries once in 30.
  384. if (!$entryDAO->inTransaction()) {
  385. $entryDAO->beginTransaction();
  386. }
  387. $nb = $feed->cleanOldEntries();
  388. if ($nb > 0) {
  389. $needFeedCacheRefresh = true;
  390. }
  391. }
  392. $feedDAO->updateLastUpdate($feed->id(), false, $mtime);
  393. if ($needFeedCacheRefresh) {
  394. $feedDAO->updateCachedValues($feed->id());
  395. }
  396. if ($entryDAO->inTransaction()) {
  397. $entryDAO->commit();
  398. }
  399. $feedProperties = [];
  400. if ($pubsubhubbubEnabledGeneral && $feed->hubUrl() && $feed->selfUrl()) { //selfUrl has priority for WebSub
  401. if ($feed->selfUrl() !== $url) { // https://github.com/pubsubhubbub/PubSubHubbub/wiki/Moving-Feeds-or-changing-Hubs
  402. $selfUrl = checkUrl($feed->selfUrl());
  403. if ($selfUrl) {
  404. Minz_Log::debug('WebSub unsubscribe ' . $feed->url(false));
  405. if (!$feed->pubSubHubbubSubscribe(false)) { //Unsubscribe
  406. Minz_Log::warning('Error while WebSub unsubscribing from ' . $feed->url(false));
  407. }
  408. $feed->_url($selfUrl, false);
  409. Minz_Log::notice('Feed ' . $url . ' canonical address moved to ' . $feed->url(false));
  410. $feedDAO->updateFeed($feed->id(), array('url' => $feed->url()));
  411. }
  412. }
  413. } elseif ($feed->url() !== $url) { // HTTP 301 Moved Permanently
  414. Minz_Log::notice('Feed ' . $url . ' moved permanently to ' . $feed->url(false));
  415. $feedProperties['url'] = $feed->url();
  416. }
  417. if ($simplePie != null) {
  418. if (trim($feed->name()) == '') {
  419. //HTML to HTML-PRE //ENT_COMPAT except '&'
  420. $name = strtr(html_only_entity_decode($simplePie->get_title()), array('<' => '&lt;', '>' => '&gt;', '"' => '&quot;'));
  421. $feedProperties['name'] = $name == '' ? $feed->url() : $name;
  422. }
  423. if (trim($feed->website()) == '') {
  424. $website = html_only_entity_decode($simplePie->get_link());
  425. $feedProperties['website'] = $website == '' ? $feed->url() : $website;
  426. }
  427. if (trim($feed->description()) == '') {
  428. $description = html_only_entity_decode($simplePie->get_description());
  429. if ($description != '') {
  430. $feedProperties['description'] = $description;
  431. }
  432. }
  433. }
  434. if (!empty($feedProperties)) {
  435. $ok = $feedDAO->updateFeed($feed->id(), $feedProperties);
  436. if (!$ok && $isNewFeed) {
  437. //Cancel adding new feed in case of database error at first actualize
  438. $feedDAO->deleteFeed($feed->id());
  439. $feed->unlock();
  440. break;
  441. }
  442. }
  443. $feed->faviconPrepare();
  444. if ($pubsubhubbubEnabledGeneral && $feed->pubSubHubbubPrepare()) {
  445. Minz_Log::notice('WebSub subscribe ' . $feed->url(false));
  446. if (!$feed->pubSubHubbubSubscribe(true)) { //Subscribe
  447. Minz_Log::warning('Error while WebSub subscribing to ' . $feed->url(false));
  448. }
  449. }
  450. $feed->unlock();
  451. $updated_feeds++;
  452. unset($feed);
  453. gc_collect_cycles();
  454. // No more than $maxFeeds feeds unless $force is true to avoid overloading
  455. // the server.
  456. if ($updated_feeds >= $maxFeeds && !$force) {
  457. break;
  458. }
  459. }
  460. if (!$noCommit && ($nb_new_articles > 0 || $updated_feeds > 0)) {
  461. if (!$entryDAO->inTransaction()) {
  462. $entryDAO->beginTransaction();
  463. }
  464. $entryDAO->commitNewEntries();
  465. $feedDAO->updateCachedValues();
  466. if ($entryDAO->inTransaction()) {
  467. $entryDAO->commit();
  468. }
  469. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  470. $databaseDAO->minorDbMaintenance();
  471. }
  472. return array($updated_feeds, reset($feeds), $nb_new_articles);
  473. }
  474. /**
  475. * This action actualizes entries from one or several feeds.
  476. *
  477. * Parameters are:
  478. * - id (default: false): Feed ID
  479. * - url (default: false): Feed URL
  480. * - force (default: false)
  481. * - noCommit (default: 0): Set to 1 to prevent committing the new articles to the main database
  482. * If id and url are not specified, all the feeds are actualized. But if force is
  483. * false, process stops at 10 feeds to avoid time execution problem.
  484. */
  485. public function actualizeAction() {
  486. Minz_Session::_param('actualize_feeds', false);
  487. $id = Minz_Request::param('id');
  488. $url = Minz_Request::param('url');
  489. $force = Minz_Request::param('force');
  490. $maxFeeds = (int)Minz_Request::param('maxFeeds');
  491. $noCommit = Minz_Request::fetchPOST('noCommit', 0) == 1;
  492. if ($id == -1 && !$noCommit) { //Special request only to commit & refresh DB cache
  493. $updated_feeds = 0;
  494. $entryDAO = FreshRSS_Factory::createEntryDao();
  495. $feedDAO = FreshRSS_Factory::createFeedDao();
  496. $entryDAO->beginTransaction();
  497. $entryDAO->commitNewEntries();
  498. $feedDAO->updateCachedValues();
  499. $entryDAO->commit();
  500. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  501. $databaseDAO->minorDbMaintenance();
  502. } else {
  503. list($updated_feeds, $feed, $nb_new_articles) = self::actualizeFeed($id, $url, $force, null, $noCommit, $maxFeeds);
  504. }
  505. if (Minz_Request::param('ajax')) {
  506. // Most of the time, ajax request is for only one feed. But since
  507. // there are several parallel requests, we should return that there
  508. // are several updated feeds.
  509. Minz_Request::setGoodNotification(_t('feedback.sub.feed.actualizeds'));
  510. // No layout in ajax request.
  511. $this->view->_layout(false);
  512. } else {
  513. // Redirect to the main page with correct notification.
  514. if ($updated_feeds === 1) {
  515. Minz_Request::good(_t('feedback.sub.feed.actualized', $feed->name()), array(
  516. 'params' => array('get' => 'f_' . $feed->id())
  517. ));
  518. } elseif ($updated_feeds > 1) {
  519. Minz_Request::good(_t('feedback.sub.feed.n_actualized', $updated_feeds), array());
  520. } else {
  521. Minz_Request::good(_t('feedback.sub.feed.no_refresh'), array());
  522. }
  523. }
  524. return $updated_feeds;
  525. }
  526. public static function renameFeed($feed_id, $feed_name) {
  527. if ($feed_id <= 0 || $feed_name == '') {
  528. return false;
  529. }
  530. FreshRSS_UserDAO::touch();
  531. $feedDAO = FreshRSS_Factory::createFeedDao();
  532. return $feedDAO->updateFeed($feed_id, array('name' => $feed_name));
  533. }
  534. public static function moveFeed($feed_id, $cat_id, $new_cat_name = '') {
  535. if ($feed_id <= 0 || ($cat_id <= 0 && $new_cat_name == '')) {
  536. return false;
  537. }
  538. FreshRSS_UserDAO::touch();
  539. $catDAO = FreshRSS_Factory::createCategoryDao();
  540. if ($cat_id > 0) {
  541. $cat = $catDAO->searchById($cat_id);
  542. $cat_id = $cat == null ? 0 : $cat->id();
  543. }
  544. if ($cat_id <= 1 && $new_cat_name != '') {
  545. $cat_id = $catDAO->addCategory(array('name' => $new_cat_name));
  546. }
  547. if ($cat_id <= 1) {
  548. $catDAO->checkDefault();
  549. $cat_id = FreshRSS_CategoryDAO::DEFAULTCATEGORYID;
  550. }
  551. $feedDAO = FreshRSS_Factory::createFeedDao();
  552. return $feedDAO->updateFeed($feed_id, array('category' => $cat_id));
  553. }
  554. /**
  555. * This action changes the category of a feed.
  556. *
  557. * This page must be reached by a POST request.
  558. *
  559. * Parameters are:
  560. * - f_id (default: false)
  561. * - c_id (default: false)
  562. * If c_id is false, default category is used.
  563. *
  564. * @todo should handle order of the feed inside the category.
  565. */
  566. public function moveAction() {
  567. if (!Minz_Request::isPost()) {
  568. Minz_Request::forward(array('c' => 'subscription'), true);
  569. }
  570. $feed_id = Minz_Request::param('f_id');
  571. $cat_id = Minz_Request::param('c_id');
  572. if (self::moveFeed($feed_id, $cat_id)) {
  573. // TODO: return something useful
  574. // Log a notice to prevent "Empty IF statement" warning in PHP_CodeSniffer
  575. Minz_Log::notice('Moved feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  576. } else {
  577. Minz_Log::warning('Cannot move feed `' . $feed_id . '` in the category `' . $cat_id . '`');
  578. Minz_Error::error(404);
  579. }
  580. }
  581. public static function deleteFeed($feed_id) {
  582. FreshRSS_UserDAO::touch();
  583. $feedDAO = FreshRSS_Factory::createFeedDao();
  584. if ($feedDAO->deleteFeed($feed_id)) {
  585. // TODO: Delete old favicon
  586. // Remove related queries
  587. FreshRSS_Context::$user_conf->queries = remove_query_by_get(
  588. 'f_' . $feed_id, FreshRSS_Context::$user_conf->queries);
  589. FreshRSS_Context::$user_conf->save();
  590. return true;
  591. }
  592. return false;
  593. }
  594. /**
  595. * This action deletes a feed.
  596. *
  597. * This page must be reached by a POST request.
  598. * If there are related queries, they are deleted too.
  599. *
  600. * Parameters are:
  601. * - id (default: false)
  602. * - r (default: false)
  603. * r permits to redirect to a given page at the end of this action.
  604. *
  605. * @todo handle "r" redirection in Minz_Request::forward()?
  606. */
  607. public function deleteAction() {
  608. $redirect_url = Minz_Request::param('r', false, true);
  609. if (!$redirect_url) {
  610. $redirect_url = array('c' => 'subscription', 'a' => 'index');
  611. }
  612. if (!Minz_Request::isPost()) {
  613. Minz_Request::forward($redirect_url, true);
  614. }
  615. $id = Minz_Request::param('id');
  616. if (self::deleteFeed($id)) {
  617. Minz_Request::good(_t('feedback.sub.feed.deleted'), $redirect_url);
  618. } else {
  619. Minz_Request::bad(_t('feedback.sub.feed.error'), $redirect_url);
  620. }
  621. }
  622. /**
  623. * This action force clears the cache of a feed.
  624. *
  625. * Parameters are:
  626. * - id (mandatory - no default): Feed ID
  627. *
  628. */
  629. public function clearCacheAction() {
  630. //Get Feed.
  631. $id = Minz_Request::param('id');
  632. $feedDAO = FreshRSS_Factory::createFeedDao();
  633. $feed = $feedDAO->searchById($id);
  634. if (!$feed) {
  635. Minz_Request::bad(_t('feedback.sub.feed.not_found'), array());
  636. return;
  637. }
  638. $feed->clearCache();
  639. Minz_Request::good(_t('feedback.sub.feed.cache_cleared', $feed->name()), array(
  640. 'params' => array('get' => 'f_' . $feed->id())
  641. ));
  642. }
  643. /**
  644. * This action forces reloading the articles of a feed.
  645. *
  646. * Parameters are:
  647. * - id (mandatory - no default): Feed ID
  648. *
  649. */
  650. public function reloadAction() {
  651. @set_time_limit(300);
  652. //Get Feed ID.
  653. $feed_id = Minz_Request::param('id');
  654. $feedDAO = FreshRSS_Factory::createFeedDao();
  655. $entryDAO = FreshRSS_Factory::createEntryDao();
  656. $feed = $feedDAO->searchById($feed_id);
  657. if (!$feed) {
  658. Minz_Request::bad(_t('feedback.sub.feed.not_found'), array());
  659. return;
  660. }
  661. //Re-fetch articles as if the feed was new.
  662. $feedDAO->updateFeed($feed->id(), [ 'lastUpdate' => 0 ]);
  663. self::actualizeFeed($feed_id, null, false, null, true);
  664. //Extract all feed entries from database, load complete content and store them back in database.
  665. $entries = $entryDAO->listWhere('f', $feed_id, FreshRSS_Entry::STATE_ALL, 'DESC', 0);
  666. //TODO: Parameter to limit the number of articles to reload
  667. //We need another DB connection in parallel for unbuffered streaming
  668. Minz_ModelPdo::$usesSharedPdo = false;
  669. if (FreshRSS_Context::$system_conf->db['type'] === 'mysql') {
  670. // Second parallel connection for unbuffered streaming: MySQL
  671. $entryDAO2 = FreshRSS_Factory::createEntryDao();
  672. } else {
  673. // Single connection for buffered queries (in memory): SQLite, PostgreSQL
  674. //TODO: Consider an unbuffered query for PostgreSQL
  675. $entryDAO2 = $entryDAO;
  676. }
  677. foreach ($entries as $entry) {
  678. if ($entry->loadCompleteContent(true)) {
  679. $entryDAO2->updateEntry($entry->toArray());
  680. }
  681. }
  682. Minz_ModelPdo::$usesSharedPdo = true;
  683. //Give feedback to user.
  684. Minz_Request::good(_t('feedback.sub.feed.reloaded', $feed->name()), array(
  685. 'params' => array('get' => 'f_' . $feed->id())
  686. ));
  687. }
  688. /**
  689. * This action creates a preview of a content-selector.
  690. *
  691. * Parameters are:
  692. * - id (mandatory - no default): Feed ID
  693. * - selector (mandatory - no default): Selector to preview
  694. *
  695. */
  696. public function contentSelectorPreviewAction() {
  697. //Configure.
  698. $this->view->fatalError = '';
  699. $this->view->selectorSuccess = false;
  700. $this->view->htmlContent = '';
  701. $this->view->_layout(false);
  702. $this->_csp([
  703. 'default-src' => "'self'",
  704. 'frame-src' => '*',
  705. 'img-src' => '* data:',
  706. 'media-src' => '*',
  707. ]);
  708. //Get parameters.
  709. $feed_id = Minz_Request::param('id');
  710. $content_selector = trim(Minz_Request::param('selector'));
  711. if (!$content_selector) {
  712. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.selector_empty');
  713. return;
  714. }
  715. //Check Feed ID validity.
  716. $entryDAO = FreshRSS_Factory::createEntryDao();
  717. $entries = $entryDAO->listWhere('f', $feed_id);
  718. $entry = null;
  719. //Get first entry (syntax robust for Generator or Array)
  720. foreach ($entries as $myEntry) {
  721. if ($entry == null) {
  722. $entry = $myEntry;
  723. }
  724. }
  725. if ($entry == null) {
  726. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_entries');
  727. return;
  728. }
  729. //Get feed.
  730. $feed = $entry->feed(true);
  731. if (!$feed) {
  732. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.no_feed');
  733. return;
  734. }
  735. //Fetch & select content.
  736. try {
  737. $fullContent = FreshRSS_Entry::getContentByParsing(
  738. htmlspecialchars_decode($entry->link(), ENT_QUOTES),
  739. $content_selector,
  740. $feed->attributes()
  741. );
  742. if ($fullContent != '') {
  743. $this->view->selectorSuccess = true;
  744. $this->view->htmlContent = $fullContent;
  745. } else {
  746. $this->view->selectorSuccess = false;
  747. $this->view->htmlContent = $entry->content();
  748. }
  749. } catch (Exception $e) {
  750. $this->view->fatalError = _t('feedback.sub.feed.selector_preview.http_error');
  751. }
  752. }
  753. /**
  754. * This method update TTL values for feeds if needed.
  755. * It changes the old default value (-2) to the new default value (0).
  756. * It changes the old disabled value (-1) to the default disabled value.
  757. */
  758. private function updateTTL() {
  759. $feedDAO = FreshRSS_Factory::createFeedDao();
  760. $feedDAO->updateTTL();
  761. }
  762. }