configureController.php 33 KB

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