configureController.php 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * Controller to handle every configuration options.
  5. */
  6. class FreshRSS_configure_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. Minz_Error::error(403);
  16. }
  17. }
  18. /**
  19. * This action handles the display configuration page.
  20. *
  21. * It displays the display configuration page.
  22. * If this action is reached through a POST request, it stores all new
  23. * configuration values then sends a notification to the user.
  24. *
  25. * The options available on the page are:
  26. * - language (default: en)
  27. * - theme (default: Origin)
  28. * - darkMode (default: auto)
  29. * - content width (default: thin)
  30. * - display of read action in header
  31. * - display of favorite action in header
  32. * - display of date in header
  33. * - display of open action in header
  34. * - display of read action in footer
  35. * - display of favorite action in footer
  36. * - display of sharing action in footer
  37. * - display of article tags in footer
  38. * - display of my Labels in footer
  39. * - display of date in footer
  40. * - display of open action in footer
  41. * - html5 notification timeout (default: 0)
  42. * Default values are false unless specified.
  43. */
  44. public function displayAction(): void {
  45. if (Minz_Request::isPost()) {
  46. $language = Minz_Request::paramString('language') ?: Minz_Translate::DEFAULT_LANGUAGE;
  47. if (Minz_Translate::exists($language)) {
  48. FreshRSS_Context::userConf()->language = $language;
  49. }
  50. FreshRSS_Context::userConf()->timezone = Minz_Request::paramString('timezone');
  51. $theme = Minz_Request::paramString('theme') ?: FreshRSS_Themes::$defaultTheme;
  52. if (FreshRSS_Themes::exists($theme)) {
  53. FreshRSS_Context::userConf()->theme = $theme;
  54. }
  55. FreshRSS_Context::userConf()->darkMode = Minz_Request::paramString('darkMode') ?: 'auto';
  56. FreshRSS_Context::userConf()->content_width = Minz_Request::paramString('content_width') ?: 'thin';
  57. FreshRSS_Context::userConf()->topline_read = Minz_Request::paramBoolean('topline_read');
  58. FreshRSS_Context::userConf()->topline_favorite = Minz_Request::paramBoolean('topline_favorite');
  59. FreshRSS_Context::userConf()->topline_myLabels = Minz_Request::paramBoolean('topline_myLabels');
  60. FreshRSS_Context::userConf()->topline_sharing = Minz_Request::paramBoolean('topline_sharing');
  61. FreshRSS_Context::userConf()->topline_date = Minz_Request::paramBoolean('topline_date');
  62. FreshRSS_Context::userConf()->topline_link = Minz_Request::paramBoolean('topline_link');
  63. FreshRSS_Context::userConf()->topline_website = Minz_Request::paramString('topline_website');
  64. FreshRSS_Context::userConf()->topline_thumbnail = Minz_Request::paramString('topline_thumbnail');
  65. FreshRSS_Context::userConf()->topline_summary = Minz_Request::paramBoolean('topline_summary');
  66. FreshRSS_Context::userConf()->topline_display_authors = Minz_Request::paramBoolean('topline_display_authors');
  67. FreshRSS_Context::userConf()->bottomline_read = Minz_Request::paramBoolean('bottomline_read');
  68. FreshRSS_Context::userConf()->bottomline_favorite = Minz_Request::paramBoolean('bottomline_favorite');
  69. FreshRSS_Context::userConf()->bottomline_sharing = Minz_Request::paramBoolean('bottomline_sharing');
  70. FreshRSS_Context::userConf()->bottomline_tags = Minz_Request::paramBoolean('bottomline_tags');
  71. FreshRSS_Context::userConf()->bottomline_myLabels = Minz_Request::paramBoolean('bottomline_myLabels');
  72. FreshRSS_Context::userConf()->bottomline_date = Minz_Request::paramBoolean('bottomline_date');
  73. FreshRSS_Context::userConf()->bottomline_link = Minz_Request::paramBoolean('bottomline_link');
  74. FreshRSS_Context::userConf()->show_nav_buttons = Minz_Request::paramBoolean('show_nav_buttons');
  75. FreshRSS_Context::userConf()->html5_notif_timeout = max(0, Minz_Request::paramInt('html5_notif_timeout'));
  76. FreshRSS_Context::userConf()->good_notification_timeout = max(0, Minz_Request::paramInt('good_notification_timeout'));
  77. FreshRSS_Context::userConf()->bad_notification_timeout = max(1, Minz_Request::paramInt('bad_notification_timeout'));
  78. FreshRSS_Context::userConf()->save();
  79. Minz_Session::_param('language', FreshRSS_Context::userConf()->language);
  80. Minz_Translate::reset(FreshRSS_Context::userConf()->language);
  81. invalidateHttpCache();
  82. Minz_Request::good(
  83. _t('feedback.conf.updated'),
  84. [ 'c' => 'configure', 'a' => 'display' ],
  85. notificationName: 'displayAction',
  86. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0);
  87. }
  88. $this->view->themes = FreshRSS_Themes::get();
  89. FreshRSS_View::prependTitle(_t('conf.display.title') . ' · ');
  90. }
  91. /**
  92. * This action handles the reading configuration page.
  93. *
  94. * It displays the reading configuration page.
  95. * If this action is reached through a POST request, it stores all new
  96. * configuration values then sends a notification to the user.
  97. *
  98. * The options available on the page are:
  99. * - number of posts per page (default: 10)
  100. * - view mode (default: normal)
  101. * - default article view (default: all)
  102. * - load automatically articles
  103. * - display expanded articles
  104. * - display expanded categories
  105. * - hide categories and feeds without unread articles
  106. * - jump on next category or feed when marked as read
  107. * - image lazy loading
  108. * - stick open articles to the top
  109. * - display a confirmation when reading all articles
  110. * - auto remove article after reading
  111. * - article order (default: DESC)
  112. * - mark articles as read when:
  113. * - displayed
  114. * - opened on site
  115. * - scrolled
  116. * - received
  117. * - focus
  118. * Default values are false unless specified.
  119. */
  120. public function readingAction(): void {
  121. if (Minz_Request::isPost()) {
  122. FreshRSS_Context::userConf()->posts_per_page = Minz_Request::paramInt('posts_per_page') ?: 10;
  123. FreshRSS_Context::userConf()->view_mode = Minz_Request::paramStringNull('view_mode', true) ?? 'normal';
  124. FreshRSS_Context::userConf()->default_view = Minz_Request::paramStringNull('default_view') ?? 'adaptive';
  125. FreshRSS_Context::userConf()->show_fav_unread = Minz_Request::paramBoolean('show_fav_unread');
  126. FreshRSS_Context::userConf()->auto_load_more = Minz_Request::paramBoolean('auto_load_more');
  127. FreshRSS_Context::userConf()->display_posts = Minz_Request::paramBoolean('display_posts');
  128. FreshRSS_Context::userConf()->display_categories = Minz_Request::paramStringNull('display_categories') ?? 'active';
  129. FreshRSS_Context::userConf()->show_tags = Minz_Request::paramStringNull('show_tags') ?? '0';
  130. FreshRSS_Context::userConf()->show_tags_max = Minz_Request::paramInt('show_tags_max');
  131. FreshRSS_Context::userConf()->show_author_date = Minz_Request::paramStringNull('show_author_date') ?? '0';
  132. FreshRSS_Context::userConf()->show_feed_name = Minz_Request::paramStringNull('show_feed_name') ?? 't';
  133. FreshRSS_Context::userConf()->show_article_icons = Minz_Request::paramStringNull('show_article_icons') ?? 't';
  134. FreshRSS_Context::userConf()->hide_read_feeds = Minz_Request::paramBoolean('hide_read_feeds');
  135. FreshRSS_Context::userConf()->onread_jump_next = Minz_Request::paramBoolean('onread_jump_next');
  136. FreshRSS_Context::userConf()->lazyload = Minz_Request::paramBoolean('lazyload');
  137. FreshRSS_Context::userConf()->sides_close_article = Minz_Request::paramBoolean('sides_close_article');
  138. FreshRSS_Context::userConf()->sticky_post = Minz_Request::paramBoolean('sticky_post');
  139. $markReadButton = Minz_Request::paramStringNull('mark_read_button', plaintext: true);
  140. FreshRSS_Context::userConf()->mark_read_button = in_array($markReadButton, ['big', 'small', 'none'], true) ? $markReadButton : 'big';
  141. FreshRSS_Context::userConf()->reading_confirm = Minz_Request::paramBoolean('reading_confirm');
  142. FreshRSS_Context::userConf()->auto_remove_article = Minz_Request::paramBoolean('auto_remove_article');
  143. FreshRSS_Context::userConf()->mark_updated_article_unread = Minz_Request::paramBoolean('mark_updated_article_unread');
  144. if (in_array(Minz_Request::paramString('sort_order'), ['ASC', 'DESC'], true)) {
  145. FreshRSS_Context::userConf()->sort_order = Minz_Request::paramString('sort_order');
  146. } else {
  147. FreshRSS_Context::userConf()->sort_order = 'DESC';
  148. }
  149. FreshRSS_Context::userConf()->mark_when = [
  150. 'article' => Minz_Request::paramBoolean('mark_open_article'),
  151. 'gone' => Minz_Request::paramBoolean('read_upon_gone'),
  152. 'max_n_unread' => Minz_Request::paramBoolean('enable_keep_max_n_unread') ? Minz_Request::paramInt('keep_max_n_unread') : false,
  153. 'reception' => Minz_Request::paramBoolean('mark_upon_reception'),
  154. 'same_title_in_feed' => Minz_Request::paramBoolean('enable_read_when_same_title_in_feed') ?
  155. Minz_Request::paramInt('read_when_same_title_in_feed') : false,
  156. 'scroll' => Minz_Request::paramBoolean('mark_scroll'),
  157. 'site' => Minz_Request::paramBoolean('mark_open_site'),
  158. 'focus' => Minz_Request::paramBoolean('mark_focus'),
  159. ];
  160. FreshRSS_Context::userConf()->_filtersAction('read', Minz_Request::paramTextToArray('filteractions_read', plaintext: true));
  161. FreshRSS_Context::userConf()->_filtersAction('star', Minz_Request::paramTextToArray('filteractions_star', plaintext: true));
  162. FreshRSS_Context::userConf()->save();
  163. invalidateHttpCache();
  164. Minz_Request::good(
  165. _t('feedback.conf.updated'),
  166. [ 'c' => 'configure', 'a' => 'reading' ],
  167. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  168. );
  169. }
  170. $this->view->viewModes = FreshRSS_ViewMode::getAllModes();
  171. FreshRSS_View::prependTitle(_t('conf.reading.title') . ' · ');
  172. }
  173. public function viewFilterAction(): void {
  174. $search = '';
  175. $filters_name = Minz_Request::paramString('filters_name', plaintext: true);
  176. $filteractions = Minz_Request::paramTextToArray($filters_name, plaintext: true);
  177. $filteractions = array_map(fn(string $action): string => trim($action), $filteractions);
  178. $filteractions = array_filter($filteractions, fn(string $action): bool => $action !== '');
  179. foreach ($filteractions as $action) {
  180. $search .= "($action) OR ";
  181. }
  182. $search = preg_replace('/ OR $/', '', $search);
  183. Minz_Request::forward([
  184. 'c' => 'index',
  185. 'a' => 'index',
  186. 'params' => [
  187. 'search' => $search,
  188. ],
  189. ], redirect: true);
  190. }
  191. /**
  192. * This action handles the integration configuration page.
  193. *
  194. * It displays the integration configuration page.
  195. * If this action is reached through a POST request, it stores all
  196. * configuration values then sends a notification to the user.
  197. *
  198. * Before v1.16, we used sharing instead of integration. This has
  199. * some unwanted behavior when the end-user was using an ad-blocker.
  200. */
  201. public function integrationAction(): void {
  202. FreshRSS_View::appendScript(Minz_Url::display('/scripts/integration.js?' . @filemtime(PUBLIC_PATH . '/scripts/integration.js')));
  203. FreshRSS_View::appendScript(Minz_Url::display('/scripts/draggable.js?' . @filemtime(PUBLIC_PATH . '/scripts/draggable.js')));
  204. if (Minz_Request::isPost()) {
  205. $share = $_POST['share'] ?? [];
  206. if (is_array($share)) {
  207. $share = array_filter($share, fn($value, $key): bool =>
  208. is_int($key) && is_array($value) &&
  209. is_array_values_string($value),
  210. ARRAY_FILTER_USE_BOTH);
  211. /** @var array<int,array<string,string>> $share */
  212. FreshRSS_Context::userConf()->sharing = $share;
  213. FreshRSS_Context::userConf()->save();
  214. invalidateHttpCache();
  215. }
  216. Minz_Request::good(
  217. _t('feedback.conf.updated'),
  218. [ 'c' => 'configure', 'a' => 'integration' ],
  219. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  220. );
  221. }
  222. FreshRSS_View::prependTitle(_t('conf.sharing.title') . ' · ');
  223. }
  224. private const SHORTCUT_KEYS = [
  225. '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
  226. 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
  227. 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
  228. 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'F10', 'F11', 'F12',
  229. 'ArrowDown', 'ArrowLeft', 'ArrowRight', 'ArrowUp', 'Backspace', 'Delete',
  230. 'End', 'Enter', 'Escape', 'Home', 'Insert', 'PageDown', 'PageUp', 'Space', 'Tab',
  231. ];
  232. /**
  233. * @param array<string> $shortcuts
  234. * @return list<string>
  235. */
  236. public static function getNonStandardShortcuts(array $shortcuts): array {
  237. $standard = strtolower(implode(' ', self::SHORTCUT_KEYS));
  238. $nonStandard = array_filter($shortcuts, static function (string $shortcut) use ($standard) {
  239. $shortcut = trim($shortcut);
  240. return $shortcut !== '' && stripos($standard, $shortcut) === false;
  241. });
  242. return array_values($nonStandard);
  243. }
  244. /**
  245. * This action handles the shortcut configuration page.
  246. *
  247. * It displays the shortcut configuration page.
  248. * If this action is reached through a POST request, it stores all new
  249. * configuration values then sends a notification to the user.
  250. *
  251. * The authorized values for shortcuts are letters (a to z), numbers (0
  252. * to 9), function keys (f1 to f12), backspace, delete, down, end, enter,
  253. * escape, home, insert, left, page down, page up, return, right, space,
  254. * tab and up.
  255. */
  256. public function shortcutAction(): void {
  257. $this->view->list_keys = self::SHORTCUT_KEYS;
  258. if (Minz_Request::isPost()) {
  259. $shortcuts = Minz_Request::paramArray('shortcuts', plaintext: true);
  260. if (Minz_Request::paramBoolean('load_default_shortcuts')) {
  261. $default = Minz_Configuration::load(FRESHRSS_PATH . '/config-user.default.php');
  262. $shortcuts = $default['shortcuts'];
  263. }
  264. /** @var array<string,string> $shortcuts */
  265. FreshRSS_Context::userConf()->shortcuts = array_map('trim', $shortcuts);
  266. FreshRSS_Context::userConf()->save();
  267. invalidateHttpCache();
  268. Minz_Request::good(
  269. _t('feedback.conf.shortcuts_updated'),
  270. ['c' => 'configure', 'a' => 'shortcut'],
  271. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  272. );
  273. }
  274. FreshRSS_View::prependTitle(_t('conf.shortcut.title') . ' · ');
  275. }
  276. /**
  277. * This action handles the archive configuration page.
  278. *
  279. * It displays the archive configuration page.
  280. * If this action is reached through a POST request, it stores all new
  281. * configuration values then sends a notification to the user.
  282. *
  283. * The options available on that page are:
  284. * - duration to retain old article (default: 3)
  285. * - number of article to retain per feed (default: 0)
  286. * - refresh frequency (default: 0)
  287. */
  288. public function archivingAction(): void {
  289. if (Minz_Request::isPost()) {
  290. if (Minz_Request::paramBoolean('enable_keep_max')) {
  291. $keepMax = Minz_Request::paramInt('keep_max') ?: FreshRSS_Feed::ARCHIVING_RETENTION_COUNT_LIMIT;
  292. } else {
  293. $keepMax = false;
  294. }
  295. if (Minz_Request::paramBoolean('enable_keep_period')) {
  296. $keepPeriod = FreshRSS_Feed::ARCHIVING_RETENTION_PERIOD;
  297. if (is_numeric(Minz_Request::paramString('keep_period_count')) && preg_match('/^PT?1[YMWDH]$/', Minz_Request::paramString('keep_period_unit'))) {
  298. $keepPeriod = str_replace('1', Minz_Request::paramString('keep_period_count'), Minz_Request::paramString('keep_period_unit'));
  299. }
  300. } else {
  301. $keepPeriod = false;
  302. }
  303. FreshRSS_Context::userConf()->ttl_default = Minz_Request::paramInt('ttl_default') ?: FreshRSS_Feed::TTL_DEFAULT;
  304. FreshRSS_Context::userConf()->archiving = [
  305. 'keep_period' => $keepPeriod,
  306. 'keep_max' => $keepMax,
  307. 'keep_min' => Minz_Request::paramInt('keep_min_default'),
  308. 'keep_favourites' => Minz_Request::paramBoolean('keep_favourites'),
  309. 'keep_labels' => Minz_Request::paramBoolean('keep_labels'),
  310. 'keep_unreads' => Minz_Request::paramBoolean('keep_unreads'),
  311. ];
  312. FreshRSS_Context::userConf()->keep_history_default = null; //Legacy < FreshRSS 1.15
  313. FreshRSS_Context::userConf()->old_entries = null; //Legacy < FreshRSS 1.15
  314. FreshRSS_Context::userConf()->save();
  315. invalidateHttpCache();
  316. Minz_Request::good(
  317. _t('feedback.conf.updated'),
  318. [ 'c' => 'configure', 'a' => 'archiving' ],
  319. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  320. );
  321. }
  322. $volatile = [
  323. 'enable_keep_period' => false,
  324. 'keep_period_count' => '3',
  325. 'keep_period_unit' => 'P1M',
  326. ];
  327. if (!empty(FreshRSS_Context::userConf()->archiving['keep_period'])) {
  328. $keepPeriod = FreshRSS_Context::userConf()->archiving['keep_period'];
  329. if (preg_match('/^PT?(?P<count>\d+)[YMWDH]$/', $keepPeriod, $matches)) {
  330. $volatile = [
  331. 'enable_keep_period' => true,
  332. 'keep_period_count' => $matches['count'],
  333. 'keep_period_unit' => str_replace($matches['count'], '1', $keepPeriod),
  334. ];
  335. }
  336. }
  337. FreshRSS_Context::userConf()->volatile = $volatile;
  338. $entryDAO = FreshRSS_Factory::createEntryDao();
  339. $this->view->nb_total = $entryDAO->count();
  340. $databaseDAO = FreshRSS_Factory::createDatabaseDAO();
  341. $this->view->size_user = $databaseDAO->size();
  342. if (FreshRSS_Auth::hasAccess('admin')) {
  343. $this->view->size_total = $databaseDAO->size(all: true);
  344. }
  345. FreshRSS_View::prependTitle(_t('conf.archiving.title') . ' · ');
  346. }
  347. /**
  348. * This action handles the user queries configuration page.
  349. *
  350. * If this action is reached through a POST request, it stores all new
  351. * configuration values then sends a notification to the user then
  352. * redirect to the same page.
  353. * If this action is not reached through a POST request, it displays the
  354. * configuration page and verifies that every user query is runnable by
  355. * checking if categories and feeds are still in use.
  356. */
  357. public function queriesAction(): void {
  358. FreshRSS_View::appendScript(Minz_Url::display('/scripts/draggable.js?' . @filemtime(PUBLIC_PATH . '/scripts/draggable.js')));
  359. if (Minz_Request::isPost()) {
  360. /** @var array<int,array{get?:string,name?:string,order?:string,search?:string,state?:int,url?:string,token?:string,
  361. * shareRss?:bool|numeric-string,shareOpml?:bool|numeric-string,description?:string,imageUrl?:string}> $params */
  362. $params = Minz_Request::paramArray('queries');
  363. $queries = [];
  364. foreach ($params as $key => $query) {
  365. $key = (int)$key;
  366. if (empty($query['name'])) {
  367. $query['name'] = _t('conf.query.number', $key + 1);
  368. }
  369. if (!empty($query['search'])) {
  370. $query['search'] = urldecode($query['search']);
  371. }
  372. $shareRss = $query['shareRss'] ?? null;
  373. $query['shareRss'] = (is_string($shareRss) && ctype_digit($shareRss)) ? (bool)$shareRss : false;
  374. $shareOpml = $query['shareOpml'] ?? null;
  375. $query['shareOpml'] = (is_string($shareOpml) && ctype_digit($shareOpml)) ? (bool)$shareOpml : false;
  376. $queries[$key] = (new FreshRSS_UserQuery($query, FreshRSS_Context::categories(), FreshRSS_Context::labels()))->toArray();
  377. }
  378. FreshRSS_Context::userConf()->queries = $queries;
  379. FreshRSS_Context::userConf()->save();
  380. Minz_Request::good(
  381. _t('feedback.conf.updated'),
  382. [ 'c' => 'configure', 'a' => 'queries' ],
  383. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  384. );
  385. } else {
  386. $this->view->queries = [];
  387. foreach (FreshRSS_Context::userConf()->queries as $key => $query) {
  388. $this->view->queries[intval($key)] = new FreshRSS_UserQuery($query, FreshRSS_Context::categories(), FreshRSS_Context::labels());
  389. }
  390. }
  391. $this->view->categories = FreshRSS_Context::categories();
  392. $this->view->feeds = FreshRSS_Context::feeds();
  393. $this->view->tags = FreshRSS_Context::labels();
  394. if (Minz_Request::paramTernary('id') !== null) {
  395. $id = Minz_Request::paramInt('id');
  396. $this->view->query = $this->view->queries[$id];
  397. $this->view->queryId = $id;
  398. $this->view->displaySlider = true;
  399. } else {
  400. $this->view->displaySlider = false;
  401. }
  402. FreshRSS_View::prependTitle(_t('conf.query.title') . ' · ');
  403. }
  404. /**
  405. * Handles query configuration.
  406. * It displays the query configuration page and handles modifications
  407. * applied to the selected query.
  408. */
  409. public function queryAction(): void {
  410. if (Minz_Request::paramBoolean('ajax')) {
  411. $this->view->_layout(null);
  412. }
  413. $id = Minz_Request::paramInt('id');
  414. if (Minz_Request::paramTernary('id') === null || empty(FreshRSS_Context::userConf()->queries[$id])) {
  415. Minz_Error::error(404);
  416. return;
  417. }
  418. $query = new FreshRSS_UserQuery(FreshRSS_Context::userConf()->queries[$id], FreshRSS_Context::categories(), FreshRSS_Context::labels());
  419. $this->view->query = $query;
  420. $this->view->queryId = $id;
  421. $this->view->categories = FreshRSS_Context::categories();
  422. $this->view->feeds = FreshRSS_Context::feeds();
  423. $this->view->tags = FreshRSS_Context::labels();
  424. if (Minz_Request::isPost()) {
  425. $params = Minz_Request::paramArray('query');
  426. $queryParams = [];
  427. $name = Minz_Request::paramString('name') ?: _t('conf.query.number', $id + 1);
  428. if ('' === $name) {
  429. $name = _t('conf.query.number', $id + 1);
  430. }
  431. if (!empty($params['get']) && is_string($params['get'])) {
  432. $queryParams['get'] = $params['get'];
  433. }
  434. if (!empty($params['order']) && is_string($params['order'])) {
  435. $queryParams['order'] = $params['order'];
  436. }
  437. if (!empty($params['search']) && is_string($params['search'])) {
  438. // Search must be as plain text to be XML-encoded or URL-encoded depending on the situation
  439. $queryParams['search'] = htmlspecialchars_decode($params['search'], ENT_QUOTES);
  440. }
  441. if (!empty($params['state']) && is_array($params['state'])) {
  442. $queryParams['state'] = (int)array_sum(array_map('intval', $params['state']));
  443. }
  444. if (empty($params['token']) || !is_string($params['token'])) {
  445. $queryParams['token'] = FreshRSS_UserQuery::generateToken($name);
  446. } else {
  447. $queryParams['token'] = $params['token'];
  448. }
  449. $queryParams['url'] = Minz_Url::display(['params' => $queryParams]);
  450. $queryParams['name'] = $name;
  451. if (!empty($params['description']) && is_string($params['description'])) {
  452. $queryParams['description'] = $params['description'];
  453. }
  454. if (!empty($params['imageUrl']) && is_string($params['imageUrl'])) {
  455. $queryParams['imageUrl'] = $params['imageUrl'];
  456. }
  457. if (!empty($params['shareOpml']) && ctype_digit($params['shareOpml'])) {
  458. $queryParams['shareOpml'] = (bool)$params['shareOpml'];
  459. }
  460. if (!empty($params['shareRss']) && ctype_digit($params['shareRss'])) {
  461. $queryParams['shareRss'] = (bool)$params['shareRss'];
  462. }
  463. if (!empty($params['publishLabelsInsteadOfTags']) && ctype_digit($params['publishLabelsInsteadOfTags'])) {
  464. $queryParams['publishLabelsInsteadOfTags'] = (bool)$params['publishLabelsInsteadOfTags'];
  465. }
  466. $queries = FreshRSS_Context::userConf()->queries;
  467. $queries[$id] = (new FreshRSS_UserQuery($queryParams, FreshRSS_Context::categories(), FreshRSS_Context::labels()))->toArray();
  468. FreshRSS_Context::userConf()->queries = $queries;
  469. FreshRSS_Context::userConf()->save();
  470. Minz_Request::good(
  471. _t('feedback.conf.updated'),
  472. [ 'c' => 'configure', 'a' => 'queries', 'params' => ['id' => (string)$id] ],
  473. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0);
  474. }
  475. FreshRSS_View::prependTitle($query->getName() . ' · ' . _t('conf.query.title') . ' · ');
  476. }
  477. /**
  478. * Handles query deletion
  479. */
  480. public function deleteQueryAction(): void {
  481. if (!Minz_Request::isPost()) {
  482. Minz_Error::error(403);
  483. return;
  484. }
  485. $id = Minz_Request::paramInt('id');
  486. if (Minz_Request::paramTernary('id') === null || empty(FreshRSS_Context::userConf()->queries[$id])) {
  487. Minz_Error::error(404);
  488. return;
  489. }
  490. $queries = FreshRSS_Context::userConf()->queries;
  491. unset($queries[$id]);
  492. FreshRSS_Context::userConf()->queries = $queries;
  493. FreshRSS_Context::userConf()->save();
  494. Minz_Request::good(
  495. _t('feedback.conf.updated'),
  496. [ 'c' => 'configure', 'a' => 'queries' ],
  497. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  498. );
  499. }
  500. /**
  501. * This action handles the creation of a user query.
  502. *
  503. * It gets the GET parameters and stores them in the configuration query
  504. * storage. Before it is saved, the unwanted parameters are unset to keep
  505. * lean data.
  506. */
  507. public function bookmarkQueryAction(): void {
  508. if (!Minz_Request::isPost()) {
  509. Minz_Error::error(403);
  510. return;
  511. }
  512. $queries = [];
  513. foreach (FreshRSS_Context::userConf()->queries as $key => $query) {
  514. $queries[$key] = (new FreshRSS_UserQuery($query, FreshRSS_Context::categories(), FreshRSS_Context::labels()))->toArray();
  515. }
  516. $params = array_filter($_GET, 'is_string', ARRAY_FILTER_USE_KEY);
  517. unset($params['name']);
  518. unset($params['rid']);
  519. /** @var array{get?:string,name?:string,order?:string,search?:string,state?:int,url?:string,token?:string,shareRss?:bool,shareOpml?:bool,publishLabelsInsteadOfTags?:bool,description?:string,imageUrl?:string} $params */
  520. $params['url'] = Minz_Url::display(['params' => $params]);
  521. $params['name'] = _t('conf.query.number', count($queries) + 1);
  522. $queries[] = (new FreshRSS_UserQuery($params, FreshRSS_Context::categories(), FreshRSS_Context::labels()))->toArray();
  523. FreshRSS_Context::userConf()->queries = $queries;
  524. FreshRSS_Context::userConf()->save();
  525. Minz_Request::good(
  526. _t('feedback.conf.query_created', $params['name']),
  527. [ 'c' => 'configure', 'a' => 'queries' ],
  528. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  529. );
  530. }
  531. /**
  532. * This action handles the system configuration page.
  533. *
  534. * It displays the system configuration page.
  535. * If this action is reach through a POST request, it stores all new
  536. * configuration values then sends a notification to the user.
  537. *
  538. * The options available on the page are:
  539. * - instance name (default: FreshRSS)
  540. * - auto update URL (default: false)
  541. * - force emails validation (default: false)
  542. * - user limit (default: 1)
  543. * - user category limit (default: 16384)
  544. * - user feed limit (default: 16384)
  545. * - user login duration for form auth (default: FreshRSS_Auth::DEFAULT_COOKIE_DURATION)
  546. */
  547. public function systemAction(): void {
  548. if (!FreshRSS_Auth::hasAccess('admin')) {
  549. Minz_Error::error(403);
  550. }
  551. if (Minz_Request::isPost()) {
  552. $limits = FreshRSS_Context::systemConf()->limits;
  553. $limits['max_registrations'] = Minz_Request::paramIntNull('max-registrations') ?? 1;
  554. $limits['max_feeds'] = Minz_Request::paramInt('max-feeds') ?: 16384;
  555. $limits['max_categories'] = Minz_Request::paramInt('max-categories') ?: 16384;
  556. $limits['cookie_duration'] = Minz_Request::paramInt('cookie-duration') ?: FreshRSS_Auth::DEFAULT_COOKIE_DURATION;
  557. FreshRSS_Context::systemConf()->limits = $limits;
  558. FreshRSS_Context::systemConf()->title = Minz_Request::paramString('instance-name') ?: 'FreshRSS';
  559. FreshRSS_Context::systemConf()->force_email_validation = Minz_Request::paramBoolean('force-email-validation');
  560. FreshRSS_Context::systemConf()->closed_registration_message = Minz_Request::paramString('closed_registration_message') ?: '';
  561. FreshRSS_Context::systemConf()->save();
  562. invalidateHttpCache();
  563. Minz_Request::good(
  564. _t('feedback.conf.updated'),
  565. [ 'c' => 'configure', 'a' => 'system' ],
  566. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  567. );
  568. }
  569. }
  570. public function privacyAction(): void {
  571. if (Minz_Request::isPost()) {
  572. FreshRSS_Context::userConf()->retrieve_extension_list = Minz_Request::paramBoolean('retrieve_extension_list');
  573. FreshRSS_Context::userConf()->save();
  574. invalidateHttpCache();
  575. Minz_Request::good(
  576. _t('feedback.conf.updated'),
  577. ['c' => 'configure', 'a' => 'privacy'],
  578. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  579. );
  580. }
  581. FreshRSS_View::prependTitle(_t('conf.privacy') . ' · ');
  582. }
  583. }