From 9f50add34e7730686c8d07c6ee576ac51eb25c71 Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Thu, 13 Mar 2025 11:32:22 +0000 Subject: [PATCH 1/4] prosodyctl check features: Add descriptions to features Also shuffles mod_pep check to multi-device sync, as I think that's a better fit. --- util/prosodyctl/check.lua | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/util/prosodyctl/check.lua b/util/prosodyctl/check.lua index 554a64ef8..48ba6de0b 100644 --- a/util/prosodyctl/check.lua +++ b/util/prosodyctl/check.lua @@ -1493,6 +1493,10 @@ local function check(arg) local function print_feature_status(feature, host) if quiet then return; end print("", feature.ok and "OK" or "(!)", feature.name); + if feature.desc then + print("", "", feature.desc); + print(""); + end if not feature.ok then if feature.lacking_modules then table.sort(feature.lacking_modules); @@ -1643,24 +1647,27 @@ local function check(arg) local features = { { name = "Basic functionality"; + desc = "Support for secure connections, authentication and messaging"; check = function () check_module("disco"); check_module("roster"); check_module("saslauth"); check_module("tls"); - check_module("pep"); end; }; { - name = "Multi-device sync"; + name = "Multi-device messaging and data synchronization"; + desc = "Multiple clients connected to the same account stay in sync"; check = function () check_module("carbons"); check_module("mam"); check_module("bookmarks"); + check_module("pep"); end; }; { name = "Mobile optimizations"; + desc = "Help mobile clients reduce battery and data usage"; check = function () check_module("smacks"); check_module("csi_simple", "csi_battery_saver"); @@ -1668,6 +1675,7 @@ local function check(arg) }; { name = "Web connections"; + desc = "Allow connections from browser-based web clients"; check = function () check_module("bosh"); check_module("websocket"); @@ -1675,24 +1683,28 @@ local function check(arg) }; { name = "User profiles"; + desc = "Enable users to publish profile information"; check = function () check_module("vcard_legacy", "vcard"); end; }; { name = "Blocking"; + desc = "Block communication with chosen entities"; check = function () check_module("blocklist"); end; }; { name = "Push notifications"; + desc = "Receive notifications on platforms that don't support persistent connections"; check = function () check_module("cloud_notify"); end; }; { - name = "Audio/video calls"; + name = "Audio/video calls and P2P"; + desc = "Assist clients in setting up connections between each other"; check = function () check_module( "turn_external", @@ -1706,10 +1718,12 @@ local function check(arg) name = "File sharing"; check = function () check_component("http_file_share", "http_upload", "http_upload_external"); + desc = "Sharing of files to groups and offline users"; end; }; { name = "Group chats"; + desc = "Create group chats and channels"; check = function () check_component("muc"); end; From 04bd8258ef77fae3a1d1f68d6408b9f7f1cf9c12 Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Thu, 13 Mar 2025 11:33:08 +0000 Subject: [PATCH 2/4] prosodyctl check features: Report size limit for HTTP upload This also adds a generic "meta" mechanism where checks can return annotations. --- util/prosodyctl/check.lua | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/util/prosodyctl/check.lua b/util/prosodyctl/check.lua index 48ba6de0b..0a0ab8788 100644 --- a/util/prosodyctl/check.lua +++ b/util/prosodyctl/check.lua @@ -11,6 +11,7 @@ local jid_split = require "prosody.util.jid".prepped_split; local modulemanager = require "prosody.core.modulemanager"; local async = require "prosody.util.async"; local httputil = require "prosody.util.http"; +local human_units = require "prosody.util.human.units"; local function api(host) return setmetatable({ name = "prosodyctl.check"; host = host; log = prosody.log }, { __index = moduleapi }) @@ -1556,6 +1557,11 @@ local function check(arg) end end end + if feature.meta then + for k, v in it.sorted_pairs(feature.meta) do + print("", "", (" - %s: %s"):format(k, v)); + end + end print(""); end @@ -1642,6 +1648,7 @@ local function check(arg) current_feature.lacking_components = current_feature.lacking_components or {}; table.insert(current_feature.lacking_components, suggested); end + return found; end local features = { @@ -1716,9 +1723,20 @@ local function check(arg) }; { name = "File sharing"; - check = function () - check_component("http_file_share", "http_upload", "http_upload_external"); desc = "Sharing of files to groups and offline users"; + check = function (self) + local service = check_component("http_file_share", "http_upload", "http_upload_external"); + if service then + local size_limit; + if api(service):get_option("component_module") == "http_file_share" then + size_limit = api(service):get_option_number("http_file_share_size_limit", 10*1024*1024); + end + if size_limit then + self.meta = { + ["Size limit"] = human_units.format(size_limit, "b", "b"); + }; + end + end end; }; { @@ -1736,7 +1754,7 @@ local function check(arg) for _, feature in ipairs(features) do current_feature = feature; - feature.check(); + feature:check(); feature.ok = ( not feature.lacking_modules and not feature.lacking_components and From 384e3dbea2738e2c9b0c515fb865f1d07fda179e Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Thu, 13 Mar 2025 11:35:39 +0000 Subject: [PATCH 3/4] mod_admin_shell: Remove outdated help text (fixes #1898) The ! commands have been broken for some time, and we're not going to implement them right now. If we want fancier editing, we can now do that on the client side (with readline and stuff). Also removes mention of telnet! --- plugins/mod_admin_shell.lua | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/plugins/mod_admin_shell.lua b/plugins/mod_admin_shell.lua index b88b53168..892844ff9 100644 --- a/plugins/mod_admin_shell.lua +++ b/plugins/mod_admin_shell.lua @@ -92,13 +92,8 @@ end -- Seed with default sections and their description text help_topic "console" "Help regarding the console itself" [[ Hey! Welcome to Prosody's admin console. -First thing, if you're ever wondering how to get out, simply type 'quit'. -Secondly, note that we don't support the full telnet protocol yet (it's coming) -so you may have trouble using the arrow keys, etc. depending on your system. - -For now we offer a couple of handy shortcuts: -!! - Repeat the last command -!old!new! - repeat the last command, but with 'old' replaced by 'new' +If you're ever wondering how to get out, simply type 'quit' (ctrl+d should also +work). For those well-versed in Prosody's internals, or taking instruction from those who are, you can prefix a command with > to escape the console sandbox, and access everything in From 57d168dd5e2684522df3c268be482430f3682e2b Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Thu, 13 Mar 2025 11:37:11 +0000 Subject: [PATCH 4/4] prosodyctl shell: More reliable detection of REPL/interactive mode (fixes #1895) --- plugins/mod_admin_shell.lua | 6 ++---- util/prosodyctl/shell.lua | 6 +++--- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/plugins/mod_admin_shell.lua b/plugins/mod_admin_shell.lua index 892844ff9..28d758d07 100644 --- a/plugins/mod_admin_shell.lua +++ b/plugins/mod_admin_shell.lua @@ -342,6 +342,8 @@ local function handle_line(event) local line = event.stanza:get_text(); local useglobalenv; + session.repl = event.stanza.attr.repl ~= "0"; + local result = st.stanza("repl-result"); if line:match("^>") then @@ -422,10 +424,6 @@ local function handle_line(event) end end - if not source then - session.repl = true; - end - taskok, message = chunk(flags); if promise.is_promise(taskok) then diff --git a/util/prosodyctl/shell.lua b/util/prosodyctl/shell.lua index d72cf2943..31936989d 100644 --- a/util/prosodyctl/shell.lua +++ b/util/prosodyctl/shell.lua @@ -29,8 +29,8 @@ local function read_line(prompt_string) end end -local function send_line(client, line) - client.send(st.stanza("repl-input", { width = tostring(term_width()) }):text(line)); +local function send_line(client, line, interactive) + client.send(st.stanza("repl-input", { width = tostring(term_width()), repl = interactive == false and "0" or "1" }):text(line)); end local function repl(client) @@ -91,7 +91,7 @@ local function start(arg) --luacheck: ignore 212/arg end client.events.add_handler("connected", function() - send_line(client, arg[1]); + send_line(client, arg[1], false); return true; end, 1);