From 865ecc87963dc3b26e66296616eef2a1cc41ac3f Mon Sep 17 00:00:00 2001 From: Andrew Dolgov Date: Wed, 25 Oct 2023 12:55:09 +0300 Subject: move to psr-4 autoloader --- classes/pref/prefs.php | 1603 ------------------------------------------------ 1 file changed, 1603 deletions(-) delete mode 100644 classes/pref/prefs.php (limited to 'classes/pref/prefs.php') diff --git a/classes/pref/prefs.php b/classes/pref/prefs.php deleted file mode 100644 index 2ce5f061b..000000000 --- a/classes/pref/prefs.php +++ /dev/null @@ -1,1603 +0,0 @@ -> */ - private array $pref_help = []; - - /** @var array> pref items are Prefs::*|Pref_Prefs::BLOCK_SEPARATOR (PHPStan was complaining) */ - private array $pref_item_map = []; - - /** @var array */ - private array $pref_help_bottom = []; - - /** @var array */ - private array $pref_blacklist = []; - - private const BLOCK_SEPARATOR = 'BLOCK_SEPARATOR'; - - const PI_RES_ALREADY_INSTALLED = "PI_RES_ALREADY_INSTALLED"; - const PI_RES_SUCCESS = "PI_RES_SUCCESS"; - const PI_ERR_NO_CLASS = "PI_ERR_NO_CLASS"; - const PI_ERR_NO_INIT_PHP = "PI_ERR_NO_INIT_PHP"; - const PI_ERR_EXEC_FAILED = "PI_ERR_EXEC_FAILED"; - const PI_ERR_NO_TEMPDIR = "PI_ERR_NO_TEMPDIR"; - const PI_ERR_PLUGIN_NOT_FOUND = "PI_ERR_PLUGIN_NOT_FOUND"; - const PI_ERR_NO_WORKDIR = "PI_ERR_NO_WORKDIR"; - - function csrf_ignore(string $method) : bool { - $csrf_ignored = array("index", "updateself", "otpqrcode"); - - return array_search($method, $csrf_ignored) !== false; - } - - function __construct($args) { - parent::__construct($args); - - $this->pref_item_map = [ - __('General') => [ - Prefs::USER_LANGUAGE, - Prefs::USER_TIMEZONE, - self::BLOCK_SEPARATOR, - Prefs::USER_CSS_THEME, - self::BLOCK_SEPARATOR, - Prefs::ENABLE_API_ACCESS, - ], - __('Feeds') => [ - Prefs::DEFAULT_UPDATE_INTERVAL, - Prefs::FRESH_ARTICLE_MAX_AGE, - Prefs::DEFAULT_SEARCH_LANGUAGE, - self::BLOCK_SEPARATOR, - Prefs::ENABLE_FEED_CATS, - self::BLOCK_SEPARATOR, - Prefs::CONFIRM_FEED_CATCHUP, - Prefs::ON_CATCHUP_SHOW_NEXT_FEED, - self::BLOCK_SEPARATOR, - Prefs::HIDE_READ_FEEDS, - Prefs::HIDE_READ_SHOWS_SPECIAL, - ], - __('Articles') => [ - Prefs::PURGE_OLD_DAYS, - Prefs::PURGE_UNREAD_ARTICLES, - self::BLOCK_SEPARATOR, - Prefs::COMBINED_DISPLAY_MODE, - Prefs::CDM_EXPANDED, - Prefs::CDM_ENABLE_GRID, - self::BLOCK_SEPARATOR, - Prefs::CDM_AUTO_CATCHUP, - Prefs::VFEED_GROUP_BY_FEED, - self::BLOCK_SEPARATOR, - Prefs::SHOW_CONTENT_PREVIEW, - Prefs::STRIP_IMAGES, - ], - __('Digest') => [ - Prefs::DIGEST_ENABLE, - Prefs::DIGEST_CATCHUP, - Prefs::DIGEST_PREFERRED_TIME, - ], - __('Advanced') => [ - Prefs::BLACKLISTED_TAGS, - self::BLOCK_SEPARATOR, - Prefs::LONG_DATE_FORMAT, - Prefs::SHORT_DATE_FORMAT, - self::BLOCK_SEPARATOR, - Prefs::SSL_CERT_SERIAL, - self::BLOCK_SEPARATOR, - Prefs::DISABLE_CONDITIONAL_COUNTERS, - Prefs::HEADLINES_NO_DISTINCT, - ], - __('Debugging') => [ - Prefs::DEBUG_HEADLINE_IDS, - ], - ]; - - $this->pref_help_bottom = [ - Prefs::BLACKLISTED_TAGS => __("Never apply these tags automatically (comma-separated list)."), - ]; - - $this->pref_help = [ - Prefs::BLACKLISTED_TAGS => array(__("Blacklisted tags"), ""), - Prefs::DEFAULT_SEARCH_LANGUAGE => array(__("Default language"), __("Used for full-text search")), - Prefs::CDM_AUTO_CATCHUP => array(__("Mark read on scroll"), __("Mark articles as read as you scroll past them")), - Prefs::CDM_EXPANDED => array(__("Always expand articles")), - Prefs::COMBINED_DISPLAY_MODE => array(__("Combined mode"), __("Show flat list of articles instead of separate panels")), - Prefs::CONFIRM_FEED_CATCHUP => array(__("Confirm marking feeds as read")), - Prefs::DEFAULT_UPDATE_INTERVAL => array(__("Default update interval")), - Prefs::DIGEST_CATCHUP => array(__("Mark sent articles as read")), - Prefs::DIGEST_ENABLE => array(__("Enable digest"), __("Send daily digest of new (and unread) headlines to your e-mail address")), - Prefs::DIGEST_PREFERRED_TIME => array(__("Try to send around this time"), __("Time in UTC")), - Prefs::ENABLE_API_ACCESS => array(__("Enable API"), __("Allows accessing this account through the API")), - Prefs::ENABLE_FEED_CATS => array(__("Enable categories")), - Prefs::FRESH_ARTICLE_MAX_AGE => array(__("Maximum age of fresh articles"), "" . __("hours") . ""), - Prefs::HIDE_READ_FEEDS => array(__("Hide read feeds")), - Prefs::HIDE_READ_SHOWS_SPECIAL => array(__("Always show special feeds"), __("While hiding read feeds")), - Prefs::LONG_DATE_FORMAT => array(__("Long date format"), __("Syntax is identical to PHP date() function.")), - Prefs::ON_CATCHUP_SHOW_NEXT_FEED => array(__("Automatically show next feed"), __("After marking one as read")), - Prefs::PURGE_OLD_DAYS => array(__("Purge articles older than"), __("days (0 disables)")), - Prefs::PURGE_UNREAD_ARTICLES => array(__("Purge unread articles")), - Prefs::SHORT_DATE_FORMAT => array(__("Short date format")), - Prefs::SHOW_CONTENT_PREVIEW => array(__("Show content preview in headlines")), - Prefs::SSL_CERT_SERIAL => array(__("SSL client certificate")), - Prefs::STRIP_IMAGES => array(__("Do not embed media")), - Prefs::USER_TIMEZONE => array(__("Time zone")), - Prefs::VFEED_GROUP_BY_FEED => array(__("Group by feed"), __("Group multiple-feed output by originating feed")), - Prefs::USER_LANGUAGE => array(__("Language")), - Prefs::USER_CSS_THEME => array(__("Theme")), - Prefs::HEADLINES_NO_DISTINCT => array(__("Don't enforce DISTINCT headlines"), __("May produce duplicate entries")), - Prefs::DEBUG_HEADLINE_IDS => array(__("Show article and feed IDs"), __("In the headlines buffer")), - Prefs::DISABLE_CONDITIONAL_COUNTERS => array(__("Disable conditional counter updates"), __("May increase server load")), - Prefs::CDM_ENABLE_GRID => array(__("Grid view"), __("On wider screens, if always expanded")), - ]; - - // hidden in the main prefs UI (use to hide things that have description set above) - $this->pref_blacklist = [ - // - ]; - } - - function changepassword(): void { - - if (Config::get(Config::FORBID_PASSWORD_CHANGES)) { - print "ERROR: ".format_error("Access forbidden."); - return; - } - - $old_pw = clean($_POST["old_password"]); - $new_pw = clean($_POST["new_password"]); - $new_unclean_pw = $_POST["new_password"]; - $con_pw = clean($_POST["confirm_password"]); - - if ($new_unclean_pw != $new_pw) { - print "ERROR: ".format_error("New password contains disallowed characters."); - return; - } - - if ($old_pw == $new_pw) { - print "ERROR: ".format_error("New password must be different from the old one."); - return; - } - - if ($old_pw == "") { - print "ERROR: ".format_error("Old password cannot be blank."); - return; - } - - if ($new_pw == "") { - print "ERROR: ".format_error("New password cannot be blank."); - return; - } - - if ($new_pw != $con_pw) { - print "ERROR: ".format_error("Entered passwords do not match."); - return; - } - - $authenticator = PluginHost::getInstance()->get_plugin($_SESSION["auth_module"]); - - if (method_exists($authenticator, "change_password")) { - print format_notice($authenticator->change_password($_SESSION["uid"], $old_pw, $new_pw)); - } else { - print "ERROR: ".format_error("Function not supported by authentication module."); - } - } - - function saveconfig(): void { - $boolean_prefs = explode(",", clean($_POST["boolean_prefs"])); - - foreach ($boolean_prefs as $pref) { - $_POST[$pref] ??= 'false'; - } - - $need_reload = false; - - foreach (array_keys($_POST) as $pref_name) { - - $value = $_POST[$pref_name]; - - switch ($pref_name) { - case Prefs::DIGEST_PREFERRED_TIME: - if (get_pref(Prefs::DIGEST_PREFERRED_TIME) != $value) { - - $sth = $this->pdo->prepare("UPDATE ttrss_users SET - last_digest_sent = NULL WHERE id = ?"); - $sth->execute([$_SESSION['uid']]); - - } - break; - case Prefs::USER_LANGUAGE: - if (!$need_reload) $need_reload = $_SESSION["language"] != $value; - break; - - case Prefs::USER_CSS_THEME: - if (!$need_reload) $need_reload = get_pref($pref_name) != $value; - break; - - case Prefs::BLACKLISTED_TAGS: - $cats = FeedItem_Common::normalize_categories(explode(",", $value)); - asort($cats); - $value = implode(", ", $cats); - break; - } - - if (Prefs::is_valid($pref_name)) { - Prefs::set($pref_name, $value, $_SESSION["uid"], $_SESSION["profile"] ?? null); - } - } - - if ($need_reload) { - print "PREFS_NEED_RELOAD"; - } else { - print __("The configuration was saved."); - } - } - - function changePersonalData(): void { - - $user = ORM::for_table('ttrss_users')->find_one($_SESSION['uid']); - $new_email = clean($_POST['email']); - - if ($user) { - $user->full_name = clean($_POST['full_name']); - - if ($user->email != $new_email) { - Logger::log(E_USER_NOTICE, "Email address of user {$user->login} has been changed to {$new_email}."); - - if ($user->email) { - $mailer = new Mailer(); - - $tpl = new Templator(); - - $tpl->readTemplateFromFile("mail_change_template.txt"); - - $tpl->setVariable('LOGIN', $user->login); - $tpl->setVariable('NEWMAIL', $new_email); - $tpl->setVariable('TTRSS_HOST', Config::get_self_url()); - - $tpl->addBlock('message'); - - $tpl->generateOutputToString($message); - - $mailer->mail(["to_name" => $user->login, - "to_address" => $user->email, - "subject" => "[tt-rss] Email address change notification", - "message" => $message]); - } - - $user->email = $new_email; - } - - $user->save(); - } - - print __("Your personal data has been saved."); - } - - function resetconfig(): void { - Prefs::reset($_SESSION["uid"], $_SESSION["profile"] ?? null); - - print "PREFS_NEED_RELOAD"; - } - - private function index_auth_personal(): void { - - $user = ORM::for_table('ttrss_users')->find_one($_SESSION['uid']); - - ?> -
- - - - - - -
- - -
- -
- - -
- -
- - -
- get_plugin($_SESSION["auth_module"]); - } else { - $authenticator = false; - } - - $otp_enabled = UserHelper::is_otp_enabled($_SESSION["uid"]); - - if ($authenticator && method_exists($authenticator, "change_password")) { - ?> - - - -
- - - - - - - -
- - -
- -
- - -
- -
- - -
- -
- - -
- - %s) does not provide an ability to set passwords.", - $_SESSION["auth_module"])); - } - } - - private function index_auth_app_passwords(): void { - print_notice("Separate passwords used for API clients. Required if you enable OTP."); - ?> - -
- appPasswordList() ?> -
- -
- - - - - - - -
- - - - - - -
- - -
- -
- - - -
- - _get_otp_qrcode_img()).">"; - - print_notice("You will need to generate app passwords for API clients if you enable OTP."); - - $otp_secret = UserHelper::get_otp_secret($_SESSION["uid"]); - ?> - -
- - - - -
- - format_otp_secret($otp_secret) ?> -
- - - - -
- - -
- -
- - -
- -
- - - -
- auth_internal authentication module."); - } - } - - function index_auth(): void { - ?> -
-
- index_auth_personal() ?> -
-
- index_auth_password() ?> -
-
- get_plugin('auth_internal')) { ?> - index_auth_app_passwords() ?> - - auth_internal plugin is enabled."); ?> - -
-
- index_auth_2fa() ?> -
-
- */ - $prefs_available = []; - - /** @var array */ - $listed_boolean_prefs = []; - - foreach (Prefs::get_all($_SESSION["uid"], $profile) as $pref) { - - if (in_array($pref["pref_name"], $this->pref_blacklist)) { - continue; - } - - if ($profile && in_array($pref["pref_name"], Prefs::_PROFILE_BLACKLIST)) { - continue; - } - - $pref_name = $pref["pref_name"]; - $short_desc = $this->_get_short_desc($pref_name); - - if (!$short_desc) - continue; - - $prefs_available[$pref_name] = [ - 'type_hint' => $pref['type_hint'], - 'value' => $pref['value'], - 'help_text' => $this->_get_help_text($pref_name), - 'short_desc' => $short_desc - ]; - } - - foreach (array_keys($this->pref_item_map) as $section) { - - print "

$section

"; - - foreach ($this->pref_item_map[$section] as $pref_name) { - - if ($pref_name == self::BLOCK_SEPARATOR && !$profile) { - print "
"; - continue; - } - - if ($pref_name == Prefs::DEFAULT_SEARCH_LANGUAGE && Config::get(Config::DB_TYPE) != "pgsql") { - continue; - } - - if (isset($prefs_available[$pref_name])) { - - $item = $prefs_available[$pref_name]; - - print "
"; - - print ""; - - $value = $item['value']; - $type_hint = $item['type_hint']; - - if ($pref_name == Prefs::USER_LANGUAGE) { - print \Controls\select_hash($pref_name, $value, get_translations(), - ["style" => 'width : 220px; margin : 0px']); - - } else if ($pref_name == Prefs::USER_TIMEZONE) { - - $timezones = explode("\n", file_get_contents("lib/timezones.txt")); - - print \Controls\select_tag($pref_name, $value, $timezones, ["dojoType" => "dijit.form.FilteringSelect"]); - - } else if ($pref_name == Prefs::BLACKLISTED_TAGS) { # TODO: other possible
"; - - print "
" . $this->pref_help_bottom[$pref_name] . "
"; - - print ""; - - } else if ($pref_name == Prefs::USER_CSS_THEME) { - - $theme_files = array_map("basename", [ - ...glob("themes/*.php") ?: [], - ...glob("themes/*.css") ?: [], - ...glob("themes.local/*.css") ?: [], - ]); - - asort($theme_files); - - $themes = [ "" => __("default") ]; - - foreach ($theme_files as $file) { - $themes[$file] = basename($file, ".css"); - } - ?> - - - "Helpers.Prefs.customizeCSS()"]) ?> - "alt-info", "onclick" => "window.open(\"https://tt-rss.org/wiki/Themes\")"]) ?> - - $is_disabled], "CB_$pref_name"); - - if ($pref_name == Prefs::DIGEST_ENABLE) { - print \Controls\button_tag(\Controls\icon("info") . " " . __('Preview'), '', - ['onclick' => 'Helpers.Digest.preview()', 'style' => 'margin-left : 10px']); - } - - } else if (in_array($pref_name, [Prefs::FRESH_ARTICLE_MAX_AGE, - Prefs::PURGE_OLD_DAYS, Prefs::LONG_DATE_FORMAT, Prefs::SHORT_DATE_FORMAT])) { - - if ($pref_name == Prefs::PURGE_OLD_DAYS && Config::get(Config::FORCE_ARTICLE_PURGE) != 0) { - $attributes = ["disabled" => true, "required" => true]; - $value = Config::get(Config::FORCE_ARTICLE_PURGE); - } else { - $attributes = ["required" => true]; - } - - if ($type_hint == Config::T_INT) - print \Controls\number_spinner_tag($pref_name, $value, $attributes); - else - print \Controls\input_tag($pref_name, $value, "text", $attributes); - - } else if ($pref_name == Prefs::SSL_CERT_SERIAL) { - - print \Controls\input_tag($pref_name, $value, "text", ["readonly" => true], "SSL_CERT_SERIAL"); - - $cert_serial = htmlspecialchars(self::_get_ssl_certificate_id()); - $has_serial = ($cert_serial) ? true : false; - - print \Controls\button_tag(\Controls\icon("security") . " " . __('Register'), "", [ - "disabled" => !$has_serial, - "onclick" => "dijit.byId('SSL_CERT_SERIAL').attr('value', '$cert_serial')"]); - - print \Controls\button_tag(\Controls\icon("clear") . " " . __('Clear'), "", [ - "class" => "alt-danger", - "onclick" => "dijit.byId('SSL_CERT_SERIAL').attr('value', '')"]); - - print \Controls\button_tag(\Controls\icon("help") . " " . __("More info..."), "", [ - "class" => "alt-info", - "onclick" => "window.open('https://tt-rss.org/wiki/SSL%20Certificate%20Authentication')"]); - - } else if ($pref_name == Prefs::DIGEST_PREFERRED_TIME) { - print ""; - $item['help_text'] .= ". " . T_sprintf("Current server time: %s", date("H:i")); - } else { - $regexp = ($type_hint == Config::T_INT) ? 'regexp="^\d*$"' : ''; - - print ""; - } - - if ($item['help_text']) - print "
"; - - print "
"; - } - } - } - print \Controls\hidden_tag("boolean_prefs", htmlspecialchars(join(",", $listed_boolean_prefs))); - } - - private function index_prefs(): void { - ?> -
- - - - - -
-
- index_prefs_list() ?> - run_hooks(PluginHost::HOOK_PREFS_TAB_SECTION, "prefPrefsPrefsInside") ?> -
-
- -
- -
-
- -
-
-
- - - - - - run_hooks(PluginHost::HOOK_PREFS_TAB_SECTION, "prefPrefsPrefsOutside") ?> -
-
-
- load_all($tmppluginhost::KIND_ALL, $_SESSION["uid"], true); - - $rv = []; - - foreach ($tmppluginhost->get_plugins() as $name => $plugin) { - $about = $plugin->about(); - $is_local = $tmppluginhost->is_local($plugin); - $version = htmlspecialchars($this->_get_plugin_version($plugin)); - - array_push($rv, [ - "name" => $name, - "is_local" => $is_local, - "system_enabled" => in_array($name, $system_enabled), - "user_enabled" => in_array($name, $user_enabled), - "has_data" => count($tmppluginhost->get_all($plugin)) > 0, - "is_system" => (bool)($about[3] ?? false), - "version" => $version, - "author" => $about[2] ?? "", - "description" => $about[1] ?? "", - "more_info" => $about[4] ?? "", - ]); - } - - usort($rv, function($a, $b) { return strcmp($a["name"], $b["name"]); }); - - print json_encode(['plugins' => $rv, 'is_admin' => $_SESSION['access_level'] >= UserHelper::ACCESS_LEVEL_ADMIN]); - } - - function index_plugins(): void { - ?> -
- - - - -
-
-
- - -
- -
- -
-
-
-
-
-
- -
- - - - - -
    -
  • -
- -
-
- - - - "alt-primary", - "onclick" => "Helpers.Plugins.enableSelected()"]) ?> - - __("Reload"), "onclick" => "Helpers.Plugins.reload()"]) ?> - - = UserHelper::ACCESS_LEVEL_ADMIN) { ?> - - - - - - - - - -
-
-
- -
-
- - -
-
- index_prefs() ?> -
-
- index_plugins() ?> -
- run_hooks(PluginHost::HOOK_PREFS_TAB, "prefPrefs") ?> -
- render($otpurl); - } - - return null; - } - - function otpenable(): void { - $password = clean($_REQUEST["password"]); - $otp_check = clean($_REQUEST["otp"]); - - $authenticator = PluginHost::getInstance()->get_plugin($_SESSION["auth_module"]); - - /** @var Auth_Internal|false $authenticator -- this is only here to make check_password() visible to static analyzer */ - if ($authenticator->check_password($_SESSION["uid"], $password)) { - if (UserHelper::enable_otp($_SESSION["uid"], $otp_check)) { - print "OK"; - } else { - print "ERROR:".__("Incorrect one time password"); - } - } else { - print "ERROR:".__("Incorrect password"); - } - } - - function otpdisable(): void { - $password = clean($_REQUEST["password"]); - - /** @var Auth_Internal|false $authenticator -- this is only here to make check_password() visible to static analyzer */ - $authenticator = PluginHost::getInstance()->get_plugin($_SESSION["auth_module"]); - - if ($authenticator->check_password($_SESSION["uid"], $password)) { - - $sth = $this->pdo->prepare("SELECT email, login FROM ttrss_users WHERE id = ?"); - $sth->execute([$_SESSION['uid']]); - - if ($row = $sth->fetch()) { - $mailer = new Mailer(); - - $tpl = new Templator(); - - $tpl->readTemplateFromFile("otp_disabled_template.txt"); - - $tpl->setVariable('LOGIN', $row["login"]); - $tpl->setVariable('TTRSS_HOST', Config::get_self_url()); - - $tpl->addBlock('message'); - - $tpl->generateOutputToString($message); - - $mailer->mail(["to_name" => $row["login"], - "to_address" => $row["email"], - "subject" => "[tt-rss] OTP change notification", - "message" => $message]); - } - - UserHelper::disable_otp($_SESSION["uid"]); - - print "OK"; - } else { - print "ERROR: ".__("Incorrect password"); - } - - } - - function setplugins(): void { - $plugins = array_filter($_REQUEST["plugins"] ?? [], 'clean'); - - set_pref(Prefs::_ENABLED_PLUGINS, implode(",", $plugins)); - } - - function _get_plugin_version(Plugin $plugin): string { - $about = $plugin->about(); - - if (!empty($about[0])) { - return T_sprintf("v%.2f, by %s", $about[0], $about[2]); - } - - $ref = new ReflectionClass(get_class($plugin)); - - $plugin_dir = dirname($ref->getFileName()); - - if (basename($plugin_dir) == "plugins") { - return ""; - } - - if (is_dir("$plugin_dir/.git")) { - $ver = Config::get_version_from_git($plugin_dir); - - return $ver["status"] == 0 ? T_sprintf("v%s, by %s", $ver["version"], $about[2]) : $ver["version"]; - } - - return ""; - } - - /** - * @return array - */ - static function _get_updated_plugins(): array { - $root_dir = dirname(dirname(__DIR__)); # we're in classes/pref/ - $plugin_dirs = array_filter(glob("$root_dir/plugins.local/*"), "is_dir"); - $rv = []; - - foreach ($plugin_dirs as $dir) { - if (is_dir("$dir/.git")) { - $plugin_name = basename($dir); - - array_push($rv, ["plugin" => $plugin_name, "rv" => self::_plugin_needs_update($root_dir, $plugin_name)]); - } - } - - $rv = array_values(array_filter($rv, fn($item) => $item["rv"]["need_update"])); - - return $rv; - } - - /** - * @return array{'stdout': false|string, 'stderr': false|string, 'git_status': int, 'need_update': bool}|null - */ - private static function _plugin_needs_update(string $root_dir, string $plugin_name): ?array { - $plugin_dir = "$root_dir/plugins.local/" . basename($plugin_name); - $rv = null; - - if (is_dir($plugin_dir) && is_dir("$plugin_dir/.git")) { - $pipes = []; - - $descriptorspec = [ - //0 => ["pipe", "r"], // STDIN - 1 => ["pipe", "w"], // STDOUT - 2 => ["pipe", "w"], // STDERR - ]; - - $proc = proc_open("git fetch -q origin -a && git log HEAD..origin/master --oneline", $descriptorspec, $pipes, $plugin_dir); - - if (is_resource($proc)) { - $rv = [ - "stdout" => stream_get_contents($pipes[1]), - "stderr" => stream_get_contents($pipes[2]), - "git_status" => proc_close($proc), - ]; - $rv["need_update"] = !empty($rv["stdout"]); - } - } - - return $rv; - } - - - /** - * @return array{'stdout': false|string, 'stderr': false|string, 'git_status': int} - */ - private function _update_plugin(string $root_dir, string $plugin_name): array { - $plugin_dir = "$root_dir/plugins.local/" . basename($plugin_name); - $rv = []; - - if (is_dir($plugin_dir) && is_dir("$plugin_dir/.git")) { - $pipes = []; - - $descriptorspec = [ - //0 => ["pipe", "r"], // STDIN - 1 => ["pipe", "w"], // STDOUT - 2 => ["pipe", "w"], // STDERR - ]; - - $proc = proc_open("git fetch origin -a && git log HEAD..origin/master --oneline && git pull --ff-only origin master", $descriptorspec, $pipes, $plugin_dir); - - if (is_resource($proc)) { - $rv["stdout"] = stream_get_contents($pipes[1]); - $rv["stderr"] = stream_get_contents($pipes[2]); - $rv["git_status"] = proc_close($proc); - } - } - - return $rv; - } - - // https://gist.github.com/mindplay-dk/a4aad91f5a4f1283a5e2#gistcomment-2036828 - private function _recursive_rmdir(string $dir, bool $keep_root = false): bool { - // Handle bad arguments. - if (empty($dir) || !file_exists($dir)) { - return true; // No such file/dir$dir exists. - } elseif (is_file($dir) || is_link($dir)) { - return unlink($dir); // Delete file/link. - } - - // Delete all children. - $files = new \RecursiveIteratorIterator( - new \RecursiveDirectoryIterator($dir, \RecursiveDirectoryIterator::SKIP_DOTS), - \RecursiveIteratorIterator::CHILD_FIRST - ); - - foreach ($files as $fileinfo) { - $action = $fileinfo->isDir() ? 'rmdir' : 'unlink'; - if (!$action($fileinfo->getRealPath())) { - return false; // Abort due to the failure. - } - } - - return $keep_root ? true : rmdir($dir); - } - - // https://stackoverflow.com/questions/7153000/get-class-name-from-file - private function _get_class_name_from_file(string $file): string { - $tokens = token_get_all(file_get_contents($file)); - - for ($i = 0; $i < count($tokens); $i++) { - if (isset($tokens[$i][0]) && $tokens[$i][0] == T_CLASS) { - for ($j = $i+1; $j < count($tokens); $j++) { - if (isset($tokens[$j][1]) && $tokens[$j][1] != " ") { - return $tokens[$j][1]; - } - } - } - } - - return ""; - } - - function uninstallPlugin(): void { - if ($_SESSION["access_level"] >= UserHelper::ACCESS_LEVEL_ADMIN) { - $plugin_name = basename(clean($_REQUEST['plugin'])); - $status = 0; - - $plugin_dir = dirname(dirname(__DIR__)) . "/plugins.local/$plugin_name"; - - if (is_dir($plugin_dir)) { - $status = $this->_recursive_rmdir($plugin_dir); - } - - print json_encode(['status' => $status]); - } - } - - function installPlugin(): void { - if ($_SESSION["access_level"] >= UserHelper::ACCESS_LEVEL_ADMIN && Config::get(Config::ENABLE_PLUGIN_INSTALLER)) { - $plugin_name = basename(clean($_REQUEST['plugin'])); - $all_plugins = $this->_get_available_plugins(); - $plugin_dir = dirname(dirname(__DIR__)) . "/plugins.local"; - - $work_dir = "$plugin_dir/plugin-installer"; - - $rv = [ ]; - - if (is_dir($work_dir) || mkdir($work_dir)) { - foreach ($all_plugins as $plugin) { - if ($plugin['name'] == $plugin_name) { - - $tmp_dir = tempnam($work_dir, $plugin_name); - - if (file_exists($tmp_dir)) { - unlink($tmp_dir); - - $pipes = []; - - $descriptorspec = [ - 1 => ["pipe", "w"], // STDOUT - 2 => ["pipe", "w"], // STDERR - ]; - - $proc = proc_open("git clone " . escapeshellarg($plugin['clone_url']) . " " . $tmp_dir, - $descriptorspec, $pipes, sys_get_temp_dir()); - - $status = 0; - - if (is_resource($proc)) { - $rv["stdout"] = stream_get_contents($pipes[1]); - $rv["stderr"] = stream_get_contents($pipes[2]); - $status = proc_close($proc); - $rv["git_status"] = $status; - - // yeah I know about mysterious RC = -1 - if (file_exists("$tmp_dir/init.php")) { - $class_name = strtolower(basename($this->_get_class_name_from_file("$tmp_dir/init.php"))); - - if ($class_name) { - $dst_dir = "$plugin_dir/$class_name"; - - if (is_dir($dst_dir)) { - $rv['result'] = self::PI_RES_ALREADY_INSTALLED; - } else { - if (rename($tmp_dir, "$plugin_dir/$class_name")) { - $rv['result'] = self::PI_RES_SUCCESS; - } - } - } else { - $rv['result'] = self::PI_ERR_NO_CLASS; - } - } else { - $rv['result'] = self::PI_ERR_NO_INIT_PHP; - } - - } else { - $rv['result'] = self::PI_ERR_EXEC_FAILED; - } - } else { - $rv['result'] = self::PI_ERR_NO_TEMPDIR; - } - - // cleanup after failure - if ($tmp_dir && is_dir($tmp_dir)) { - $this->_recursive_rmdir($tmp_dir); - } - - break; - } - } - - if (empty($rv['result'])) - $rv['result'] = self::PI_ERR_PLUGIN_NOT_FOUND; - - } else { - $rv["result"] = self::PI_ERR_NO_WORKDIR; - } - - print json_encode($rv); - } - } - - /** - * @return array, 'html_url': string, 'clone_url': string, 'last_update': string}> - */ - private function _get_available_plugins(): array { - if ($_SESSION["access_level"] >= UserHelper::ACCESS_LEVEL_ADMIN && Config::get(Config::ENABLE_PLUGIN_INSTALLER)) { - $content = json_decode(UrlHelper::fetch(['url' => 'https://tt-rss.org/plugins.json']), true); - - if ($content) { - return $content; - } - } - - return []; - } - - function getAvailablePlugins(): void { - if ($_SESSION["access_level"] >= UserHelper::ACCESS_LEVEL_ADMIN) { - print json_encode($this->_get_available_plugins()); - } else { - print "[]"; - } - } - - function checkForPluginUpdates(): void { - if ($_SESSION["access_level"] >= UserHelper::ACCESS_LEVEL_ADMIN && Config::get(Config::CHECK_FOR_UPDATES) && Config::get(Config::CHECK_FOR_PLUGIN_UPDATES)) { - $plugin_name = $_REQUEST["name"] ?? ""; - $root_dir = dirname(dirname(__DIR__)); # we're in classes/pref/ - - $rv = empty($plugin_name) ? self::_get_updated_plugins() : [ - ["plugin" => $plugin_name, "rv" => self::_plugin_needs_update($root_dir, $plugin_name)], - ]; - - print json_encode($rv); - } - } - - function updateLocalPlugins(): void { - if ($_SESSION["access_level"] >= UserHelper::ACCESS_LEVEL_ADMIN) { - $plugins = explode(",", $_REQUEST["plugins"] ?? ""); - - if ($plugins !== false) { - $plugins = array_filter($plugins, 'strlen'); - } - - # we're in classes/pref/ - $root_dir = dirname(dirname(__DIR__)); - - $rv = []; - - if ($plugins) { - foreach ($plugins as $plugin_name) { - array_push($rv, ["plugin" => $plugin_name, "rv" => $this->_update_plugin($root_dir, $plugin_name)]); - } - } else { - $plugin_dirs = array_filter(glob("$root_dir/plugins.local/*"), "is_dir"); - - foreach ($plugin_dirs as $dir) { - if (is_dir("$dir/.git")) { - $plugin_name = basename($dir); - - $test = self::_plugin_needs_update($root_dir, $plugin_name); - - if (!empty($test["stdout"])) - array_push($rv, ["plugin" => $plugin_name, "rv" => $this->_update_plugin($root_dir, $plugin_name)]); - } - } - } - - print json_encode($rv); - } - } - - function clearplugindata(): void { - $name = clean($_REQUEST["name"]); - - PluginHost::getInstance()->clear_data(PluginHost::getInstance()->get_plugin($name)); - } - - function customizeCSS(): void { - $value = get_pref(Prefs::USER_STYLESHEET); - $value = str_replace("
", "\n", $value); - - print json_encode(["value" => $value]); - } - - function activateprofile(): void { - $id = (int) ($_REQUEST['id'] ?? 0); - - $profile = ORM::for_table('ttrss_settings_profiles') - ->where('owner_uid', $_SESSION['uid']) - ->find_one($id); - - if ($profile) { - $_SESSION["profile"] = $id; - } else { - $_SESSION["profile"] = null; - } - } - - function cloneprofile(): void { - $old_profile = $_REQUEST["old_profile"] ?? 0; - $new_title = clean($_REQUEST["new_title"]); - - if ($old_profile && $new_title) { - $new_profile = ORM::for_table('ttrss_settings_profiles')->create(); - $new_profile->title = $new_title; - $new_profile->owner_uid = $_SESSION['uid']; - - if ($new_profile->save()) { - $sth = $this->pdo->prepare("INSERT INTO ttrss_user_prefs - (owner_uid, pref_name, profile, value) - SELECT - :uid, - pref_name, - :new_profile, - value - FROM ttrss_user_prefs - WHERE owner_uid = :uid AND profile = :old_profile"); - - $sth->execute([ - "uid" => $_SESSION["uid"], - "new_profile" => $new_profile->id, - "old_profile" => $old_profile, - ]); - } - } - } - - function remprofiles(): void { - $ids = $_REQUEST["ids"] ?? []; - - ORM::for_table('ttrss_settings_profiles') - ->where('owner_uid', $_SESSION['uid']) - ->where_in('id', $ids) - ->where_not_equal('id', $_SESSION['profile'] ?? 0) - ->delete_many(); - } - - function addprofile(): void { - $title = clean($_REQUEST["title"]); - - if ($title) { - $profile = ORM::for_table('ttrss_settings_profiles') - ->where('owner_uid', $_SESSION['uid']) - ->where('title', $title) - ->find_one(); - - if (!$profile) { - $profile = ORM::for_table('ttrss_settings_profiles')->create(); - - $profile->title = $title; - $profile->owner_uid = $_SESSION['uid']; - $profile->save(); - } - } - } - - function saveprofile(): void { - $id = (int)$_REQUEST["id"]; - $title = clean($_REQUEST["value"]); - - if ($title && $id) { - $profile = ORM::for_table('ttrss_settings_profiles') - ->where('owner_uid', $_SESSION['uid']) - ->find_one($id); - - if ($profile) { - $profile->title = $title; - $profile->save(); - } - } - } - - // TODO: this maybe needs to be unified with Public::getProfiles() - function getProfiles(): void { - $rv = []; - - $profiles = ORM::for_table('ttrss_settings_profiles') - ->where('owner_uid', $_SESSION['uid']) - ->order_by_expr('title') - ->find_many(); - - array_push($rv, ["title" => __("Default profile"), - "id" => 0, - "initialized" => true, - "active" => empty($_SESSION["profile"]) - ]); - - foreach ($profiles as $profile) { - $profile['active'] = ($_SESSION["profile"] ?? 0) == $profile->id; - - $num_settings = ORM::for_table('ttrss_user_prefs') - ->where('profile', $profile->id) - ->count(); - - $profile['initialized'] = $num_settings > 0; - - array_push($rv, $profile->as_array()); - }; - - print json_encode($rv); - } - - private function _get_short_desc(string $pref_name): string { - if (isset($this->pref_help[$pref_name][0])) { - return $this->pref_help[$pref_name][0]; - } - return ""; - } - - private function _get_help_text(string $pref_name): string { - if (isset($this->pref_help[$pref_name][1])) { - return $this->pref_help[$pref_name][1]; - } - return ""; - } - - private function appPasswordList(): void { - ?> -
-
- -
-
-
-
-
-
- -
- - - - - - - - where('owner_uid', $_SESSION['uid']) - ->order_by_asc('title') - ->find_many(); - - foreach ($passwords as $pass) { ?> - '> - - - - - - -
- - - - - - - -
-
- where('owner_uid', $_SESSION['uid']) - ->where_in('id', $_REQUEST['ids'] ?? []) - ->delete_many(); - - $this->appPasswordList(); - } - - function generateAppPassword(): void { - $title = clean($_REQUEST['title']); - $new_password = make_password(16); - $new_salt = UserHelper::get_salt(); - $new_password_hash = UserHelper::hash_password($new_password, $new_salt, UserHelper::HASH_ALGOS[0]); - - print_warning(T_sprintf("Generated password %s for %s. Please remember it for future reference.", $new_password, $title)); - - $password = ORM::for_table('ttrss_app_passwords')->create(); - - $password->title = $title; - $password->owner_uid = $_SESSION['uid']; - $password->pwd_hash = "$new_password_hash:$new_salt"; - $password->service = Auth_Base::AUTH_SERVICE_API; - $password->created = Db::NOW(); - - $password->save(); - - $this->appPasswordList(); - } - - function previewDigest(): void { - print json_encode(Digest::prepare_headlines_digest($_SESSION["uid"], 1, 16)); - } - - static function _get_ssl_certificate_id(): string { - if ($_SERVER["REDIRECT_SSL_CLIENT_M_SERIAL"] ?? false) { - return sha1($_SERVER["REDIRECT_SSL_CLIENT_M_SERIAL"] . - $_SERVER["REDIRECT_SSL_CLIENT_V_START"] . - $_SERVER["REDIRECT_SSL_CLIENT_V_END"] . - $_SERVER["REDIRECT_SSL_CLIENT_S_DN"]); - } - if ($_SERVER["SSL_CLIENT_M_SERIAL"] ?? false) { - return sha1($_SERVER["SSL_CLIENT_M_SERIAL"] . - $_SERVER["SSL_CLIENT_V_START"] . - $_SERVER["SSL_CLIENT_V_END"] . - $_SERVER["SSL_CLIENT_S_DN"]); - } - return ""; - } - - private function format_otp_secret(string $secret): string { - return implode(" ", str_split($secret, 4)); - } -} -- cgit v1.2.3-54-g00ecf