valvin
/
ttrss
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pref-prefs: use constants instead of hardcoded strings

This commit is contained in:
Andrew Dolgov 2021-02-25 14:45:11 +03:00
parent 011e318947
commit 5aa05c90e1
3 changed files with 73 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
classes/feeds.php
View File

@ -1975,7 +1975,7 @@ class Feeds extends Handler_Protected {
$purge_unread = true; $purge_unread = true;
$purge_interval = Config::get(Config::FORCE_ARTICLE_PURGE); $purge_interval = Config::get(Config::FORCE_ARTICLE_PURGE);
} else { } else {
$purge_unread = get_pref("PURGE_UNREAD_ARTICLES", $owner_uid, false); $purge_unread = get_pref(Prefs::PURGE_UNREAD_ARTICLES, $owner_uid);
} }
$purge_interval = (int) $purge_interval; $purge_interval = (int) $purge_interval;
@ -2038,7 +2038,7 @@ class Feeds extends Handler_Protected {
$owner_uid = $row["owner_uid"]; $owner_uid = $row["owner_uid"];
if ($purge_interval == 0) if ($purge_interval == 0)
$purge_interval = get_pref('PURGE_OLD_DAYS', $owner_uid, false); $purge_interval = get_pref(Prefs::PURGE_OLD_DAYS, $owner_uid);
return $purge_interval; return $purge_interval;
} else { } else {

148
classes/pref/prefs.php
View File

@ -6,7 +6,6 @@ class Pref_Prefs extends Handler_Protected {
private $pref_item_map = []; private $pref_item_map = [];
private $pref_help_bottom = []; private $pref_help_bottom = [];
private $pref_blacklist = []; private $pref_blacklist = [];
private $profile_blacklist = [];
function csrf_ignore($method) { function csrf_ignore($method) {
$csrf_ignored = array("index", "updateself", "otpqrcode"); $csrf_ignored = array("index", "updateself", "otpqrcode");
@ -19,106 +18,97 @@ class Pref_Prefs extends Handler_Protected {
$this->pref_item_map = [ $this->pref_item_map = [
__('General') => [ __('General') => [
'USER_LANGUAGE', Prefs::USER_LANGUAGE,
'USER_TIMEZONE', Prefs::USER_TIMEZONE,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'USER_CSS_THEME', Prefs::USER_CSS_THEME,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'ENABLE_API_ACCESS', Prefs::ENABLE_API_ACCESS,
], ],
__('Feeds') => [ __('Feeds') => [
'DEFAULT_UPDATE_INTERVAL', Prefs::DEFAULT_UPDATE_INTERVAL,
'FRESH_ARTICLE_MAX_AGE', Prefs::FRESH_ARTICLE_MAX_AGE,
'DEFAULT_SEARCH_LANGUAGE', Prefs::DEFAULT_SEARCH_LANGUAGE,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'ENABLE_FEED_CATS', Prefs::ENABLE_FEED_CATS,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'CONFIRM_FEED_CATCHUP', Prefs::CONFIRM_FEED_CATCHUP,
'ON_CATCHUP_SHOW_NEXT_FEED', Prefs::ON_CATCHUP_SHOW_NEXT_FEED,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'HIDE_READ_FEEDS', Prefs::HIDE_READ_FEEDS,
'HIDE_READ_SHOWS_SPECIAL', Prefs::HIDE_READ_SHOWS_SPECIAL,
], ],
__('Articles') => [ __('Articles') => [
'PURGE_OLD_DAYS', Prefs::PURGE_OLD_DAYS,
'PURGE_UNREAD_ARTICLES', Prefs::PURGE_UNREAD_ARTICLES,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'COMBINED_DISPLAY_MODE', Prefs::COMBINED_DISPLAY_MODE,
'CDM_EXPANDED', Prefs::CDM_EXPANDED,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'CDM_AUTO_CATCHUP', Prefs::CDM_AUTO_CATCHUP,
'VFEED_GROUP_BY_FEED', Prefs::VFEED_GROUP_BY_FEED,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'SHOW_CONTENT_PREVIEW', Prefs::SHOW_CONTENT_PREVIEW,
'STRIP_IMAGES', Prefs::STRIP_IMAGES,
], ],
__('Digest') => [ __('Digest') => [
'DIGEST_ENABLE', Prefs::DIGEST_ENABLE,
'DIGEST_CATCHUP', Prefs::DIGEST_CATCHUP,
'DIGEST_PREFERRED_TIME', Prefs::DIGEST_PREFERRED_TIME,
], ],
__('Advanced') => [ __('Advanced') => [
'BLACKLISTED_TAGS', Prefs::BLACKLISTED_TAGS,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'LONG_DATE_FORMAT', Prefs::LONG_DATE_FORMAT,
'SHORT_DATE_FORMAT', Prefs::SHORT_DATE_FORMAT,
'BLOCK_SEPARATOR', 'BLOCK_SEPARATOR',
'SSL_CERT_SERIAL', Prefs::SSL_CERT_SERIAL,
] ]
]; ];
$this->pref_help_bottom = [ $this->pref_help_bottom = [
"BLACKLISTED_TAGS" => __("Never apply these tags automatically (comma-separated list)."), Prefs::BLACKLISTED_TAGS => __("Never apply these tags automatically (comma-separated list)."),
]; ];
$this->pref_help = [ $this->pref_help = [
"ALLOW_DUPLICATE_POSTS" => array(__("Allow duplicate articles"), ""), Prefs::ALLOW_DUPLICATE_POSTS => array(__("Allow duplicate articles"), ""),
"BLACKLISTED_TAGS" => array(__("Blacklisted tags"), ""), Prefs::BLACKLISTED_TAGS => array(__("Blacklisted tags"), ""),
"DEFAULT_SEARCH_LANGUAGE" => array(__("Default language"), __("Used for full-text search")), Prefs::DEFAULT_SEARCH_LANGUAGE => array(__("Default language"), __("Used for full-text search")),
"CDM_AUTO_CATCHUP" => array(__("Mark read on scroll"), __("Mark articles as read as you scroll past them")), Prefs::CDM_AUTO_CATCHUP => array(__("Mark read on scroll"), __("Mark articles as read as you scroll past them")),
"CDM_EXPANDED" => array(__("Always expand articles")), Prefs::CDM_EXPANDED => array(__("Always expand articles")),
"COMBINED_DISPLAY_MODE" => array(__("Combined mode"), __("Show flat list of articles instead of separate panels")), Prefs::COMBINED_DISPLAY_MODE => array(__("Combined mode"), __("Show flat list of articles instead of separate panels")),
"CONFIRM_FEED_CATCHUP" => array(__("Confirm marking feeds as read")), Prefs::CONFIRM_FEED_CATCHUP => array(__("Confirm marking feeds as read")),
"DEFAULT_ARTICLE_LIMIT" => array(__("Amount of articles to display at once")), Prefs::DEFAULT_ARTICLE_LIMIT => array(__("Amount of articles to display at once")),
"DEFAULT_UPDATE_INTERVAL" => array(__("Default update interval")), Prefs::DEFAULT_UPDATE_INTERVAL => array(__("Default update interval")),
"DIGEST_CATCHUP" => array(__("Mark sent articles as read")), Prefs::DIGEST_CATCHUP => array(__("Mark sent articles as read")),
"DIGEST_ENABLE" => array(__("Enable digest"), __("Send daily digest of new (and unread) headlines to your e-mail address")), Prefs::DIGEST_ENABLE => array(__("Enable digest"), __("Send daily digest of new (and unread) headlines to your e-mail address")),
"DIGEST_PREFERRED_TIME" => array(__("Try to send around this time"), __("Time in UTC")), Prefs::DIGEST_PREFERRED_TIME => array(__("Try to send around this time"), __("Time in UTC")),
"ENABLE_API_ACCESS" => array(__("Enable API"), __("Allows accessing this account through the API")), Prefs::ENABLE_API_ACCESS => array(__("Enable API"), __("Allows accessing this account through the API")),
"ENABLE_FEED_CATS" => array(__("Enable categories")), Prefs::ENABLE_FEED_CATS => array(__("Enable categories")),
"FEEDS_SORT_BY_UNREAD" => array(__("Sort feeds by unread articles count"), ""), Prefs::FEEDS_SORT_BY_UNREAD => array(__("Sort feeds by unread articles count"), ""),
"FRESH_ARTICLE_MAX_AGE" => array(__("Maximum age of fresh articles"), "<strong>" . __("hours") . "</strong>"), Prefs::FRESH_ARTICLE_MAX_AGE => array(__("Maximum age of fresh articles"), "<strong>" . __("hours") . "</strong>"),
"HIDE_READ_FEEDS" => array(__("Hide read feeds")), Prefs::HIDE_READ_FEEDS => array(__("Hide read feeds")),
"HIDE_READ_SHOWS_SPECIAL" => array(__("Always show special feeds"), __("While hiding read feeds")), Prefs::HIDE_READ_SHOWS_SPECIAL => array(__("Always show special feeds"), __("While hiding read feeds")),
"LONG_DATE_FORMAT" => array(__("Long date format"), __("Syntax is identical to PHP <a href='http://php.net/manual/function.date.php'>date()</a> function.")), Prefs::LONG_DATE_FORMAT => array(__("Long date format"), __("Syntax is identical to PHP <a href='http://php.net/manual/function.date.php'>date()</a> function.")),
"ON_CATCHUP_SHOW_NEXT_FEED" => array(__("Automatically show next feed"), __("After marking one as read")), Prefs::ON_CATCHUP_SHOW_NEXT_FEED => array(__("Automatically show next feed"), __("After marking one as read")),
"PURGE_OLD_DAYS" => array(__("Purge articles older than"), __("<strong>days</strong> (0 disables)")), Prefs::PURGE_OLD_DAYS => array(__("Purge articles older than"), __("<strong>days</strong> (0 disables)")),
"PURGE_UNREAD_ARTICLES" => array(__("Purge unread articles")), Prefs::PURGE_UNREAD_ARTICLES => array(__("Purge unread articles")),
"REVERSE_HEADLINES" => array(__("Reverse headline order (oldest first)")), Prefs::REVERSE_HEADLINES => array(__("Reverse headline order (oldest first)")),
"SHORT_DATE_FORMAT" => array(__("Short date format")), Prefs::SHORT_DATE_FORMAT => array(__("Short date format")),
"SHOW_CONTENT_PREVIEW" => array(__("Show content preview in headlines")), Prefs::SHOW_CONTENT_PREVIEW => array(__("Show content preview in headlines")),
"SORT_HEADLINES_BY_FEED_DATE" => array(__("Sort headlines by feed date"), __("Use feed-specified date to sort headlines instead of local import date.")), Prefs::SORT_HEADLINES_BY_FEED_DATE => array(__("Sort headlines by feed date"), __("Use feed-specified date to sort headlines instead of local import date.")),
"SSL_CERT_SERIAL" => array(__("SSL client certificate")), Prefs::SSL_CERT_SERIAL => array(__("SSL client certificate")),
"STRIP_IMAGES" => array(__("Do not embed media")), Prefs::STRIP_IMAGES => array(__("Do not embed media")),
"STRIP_UNSAFE_TAGS" => array(__("Strip unsafe tags from articles"), __("Strip all but most common HTML tags when reading articles.")), Prefs::USER_STYLESHEET => array(__("Customize stylesheet")),
"USER_STYLESHEET" => array(__("Customize stylesheet")), Prefs::USER_TIMEZONE => array(__("Time zone")),
"USER_TIMEZONE" => array(__("Time zone")), Prefs::VFEED_GROUP_BY_FEED => array(__("Group by feed"), __("Group multiple-feed output by originating feed")),
"VFEED_GROUP_BY_FEED" => array(__("Group by feed"), __("Group multiple-feed output by originating feed")), Prefs::USER_LANGUAGE => array(__("Language")),
"USER_LANGUAGE" => array(__("Language")), Prefs::USER_CSS_THEME => array(__("Theme"))
"USER_CSS_THEME" => array(__("Theme"))
]; ];
$this->pref_blacklist = ["ALLOW_DUPLICATE_POSTS", "STRIP_UNSAFE_TAGS", "REVERSE_HEADLINES", $this->pref_blacklist = [Prefs::ALLOW_DUPLICATE_POSTS, Prefs::REVERSE_HEADLINES,
"SORT_HEADLINES_BY_FEED_DATE", "DEFAULT_ARTICLE_LIMIT", Prefs::SORT_HEADLINES_BY_FEED_DATE, Prefs::DEFAULT_ARTICLE_LIMIT,
"FEEDS_SORT_BY_UNREAD", "USER_STYLESHEET"]; Prefs::FEEDS_SORT_BY_UNREAD, Prefs::USER_STYLESHEET];
/* "FEEDS_SORT_BY_UNREAD", "HIDE_READ_FEEDS", "REVERSE_HEADLINES" */
$this->profile_blacklist = ["ALLOW_DUPLICATE_POSTS", "PURGE_OLD_DAYS",
"PURGE_UNREAD_ARTICLES", "DIGEST_ENABLE", "DIGEST_CATCHUP",
"BLACKLISTED_TAGS", "ENABLE_API_ACCESS", "UPDATE_POST_ON_CHECKSUM_CHANGE",
"DEFAULT_UPDATE_INTERVAL", "USER_TIMEZONE", "SORT_HEADLINES_BY_FEED_DATE",
"SSL_CERT_SERIAL", "DIGEST_PREFERRED_TIME"];
} }
function changepassword() { function changepassword() {
@ -181,8 +171,8 @@ class Pref_Prefs extends Handler_Protected {
$value = $_POST[$pref_name]; $value = $_POST[$pref_name];
switch ($pref_name) { switch ($pref_name) {
case 'DIGEST_PREFERRED_TIME': case Prefs::DIGEST_PREFERRED_TIME:
if (get_pref('DIGEST_PREFERRED_TIME') != $value) { if (get_pref(Prefs::DIGEST_PREFERRED_TIME) != $value) {
$sth = $this->pdo->prepare("UPDATE ttrss_users SET $sth = $this->pdo->prepare("UPDATE ttrss_users SET
last_digest_sent = NULL WHERE id = ?"); last_digest_sent = NULL WHERE id = ?");
@ -190,15 +180,15 @@ class Pref_Prefs extends Handler_Protected {
} }
break; break;
case 'USER_LANGUAGE': case Prefs::USER_LANGUAGE:
if (!$need_reload) $need_reload = $_SESSION["language"] != $value; if (!$need_reload) $need_reload = $_SESSION["language"] != $value;
break; break;
case 'USER_CSS_THEME': case Prefs::USER_CSS_THEME:
if (!$need_reload) $need_reload = get_pref($pref_name) != $value; if (!$need_reload) $need_reload = get_pref($pref_name) != $value;
break; break;
case 'BLACKLISTED_TAGS': case Prefs::BLACKLISTED_TAGS:
$cats = FeedItem_Common::normalize_categories(explode(",", $value)); $cats = FeedItem_Common::normalize_categories(explode(",", $value));
asort($cats); asort($cats);
$value = implode(", ", $cats); $value = implode(", ", $cats);

4
classes/prefs.php
View File

@ -21,7 +21,7 @@ class Prefs {
const _DEFAULT_VIEW_MODE = "_DEFAULT_VIEW_MODE"; const _DEFAULT_VIEW_MODE = "_DEFAULT_VIEW_MODE";
const _DEFAULT_VIEW_LIMIT = "_DEFAULT_VIEW_LIMIT"; const _DEFAULT_VIEW_LIMIT = "_DEFAULT_VIEW_LIMIT";
//const _PREFS_ACTIVE_TAB = "_PREFS_ACTIVE_TAB"; //const _PREFS_ACTIVE_TAB = "_PREFS_ACTIVE_TAB";
const STRIP_UNSAFE_TAGS = "STRIP_UNSAFE_TAGS"; //const STRIP_UNSAFE_TAGS = "STRIP_UNSAFE_TAGS";
const BLACKLISTED_TAGS = "BLACKLISTED_TAGS"; const BLACKLISTED_TAGS = "BLACKLISTED_TAGS";
const FRESH_ARTICLE_MAX_AGE = "FRESH_ARTICLE_MAX_AGE"; const FRESH_ARTICLE_MAX_AGE = "FRESH_ARTICLE_MAX_AGE";
const DIGEST_CATCHUP = "DIGEST_CATCHUP"; const DIGEST_CATCHUP = "DIGEST_CATCHUP";
@ -77,7 +77,7 @@ class Prefs {
Prefs::_DEFAULT_VIEW_MODE => [ "adaptive", Config::T_BOOL ], Prefs::_DEFAULT_VIEW_MODE => [ "adaptive", Config::T_BOOL ],
Prefs::_DEFAULT_VIEW_LIMIT => [ 30, Config::T_INT ], Prefs::_DEFAULT_VIEW_LIMIT => [ 30, Config::T_INT ],
//Prefs::_PREFS_ACTIVE_TAB => [ "", Config::T_STRING ], //Prefs::_PREFS_ACTIVE_TAB => [ "", Config::T_STRING ],
Prefs::STRIP_UNSAFE_TAGS => [ true, Config::T_BOOL ], //Prefs::STRIP_UNSAFE_TAGS => [ true, Config::T_BOOL ],
Prefs::BLACKLISTED_TAGS => [ 'main, generic, misc, uncategorized, blog, blogroll, general, news', Config::T_STRING ], Prefs::BLACKLISTED_TAGS => [ 'main, generic, misc, uncategorized, blog, blogroll, general, news', Config::T_STRING ],
Prefs::FRESH_ARTICLE_MAX_AGE => [ 24, Config::T_INT ], Prefs::FRESH_ARTICLE_MAX_AGE => [ 24, Config::T_INT ],
Prefs::DIGEST_CATCHUP => [ false, Config::T_BOOL ], Prefs::DIGEST_CATCHUP => [ false, Config::T_BOOL ],