prosody-hg: plugins/mod_admin_shell.lua comparison

comparison plugins/mod_admin_shell.lua @ 14115:44a8c8d4146a

Merge 13.0->trunk

author	Matthew Wild <mwild1@gmail.com>
date	Tue, 31 Mar 2026 12:25:20 +0100
parents	f20bb1c53652 b9688ac25255
children	7008869fcce2

comparison

equal deleted inserted replaced

-:59064f0f8b4e
+:44a8c8d4146a
 -- host_commands[section..":"..name][host] = handler
 -- host_commands[section..":"..name][false] = metadata
 local host_commands = {};
+-- Remove command handlers for a host (specify name to clear just one command)
+function clear_host_commands(host, name)
+	for command_name, command_info in pairs(host_commands) do
+		if not name or name == command_name then
+			command_info[host] = nil;
+			local has_any_host_handlers_left;
+			for k in pairs(command_info) do
+				if k ~= false then
+					has_any_host_handlers_left = true;
+					break;
+				end
+			end
+			if not has_any_host_handlers_left then
+				host_commands[command_name] = nil;
+			end
+			if name then
+				break;
+			end
+		end
+	end
+end
+-- This returns a wrapper function which routes to the correct handler for a host
+local function new_host_command_handler(qualified_name, selector_name, selector_index)
+	return function (...)
+		local selected_host = select(2, jid_split((select(selector_index, ...))));
+		if type(selected_host) ~= "string" then
+			return nil, "Invalid or missing argument '"..selector_name.."'";
+		end
+		if not prosody.hosts[selected_host] then
+			return nil, "Unknown host: "..selected_host;
+		end
+		local host_handler = host_commands[qualified_name][selected_host];
+		if not host_handler then
+			return nil, "This command is not available on "..selected_host;
+		end
+		return host_handler(...);
+	end;
+end
 local function new_item_handlers(command_host)
 	local function on_command_added(event)
 		local command = event.item;
 		local mod_name = event.source and ("mod_"..event.source.name) or "<unknown module>";
 		if not schema.validate(command_metadata_schema, command) or type(command.handler) ~= "function" then
 					return;
 				end
 				host_command_info = {
 					[false] = {
 						host_selector = command.host_selector;
-						handler = function (...)
+						handler = new_host_command_handler(qualified_name, command.host_selector, selector_index);
-							local selected_host = select(2, jid_split((select(selector_index, ...))));
-							if type(selected_host) ~= "string" then
-								return nil, "Invalid or missing argument '"..command.host_selector.."'";
-							end
-							if not prosody.hosts[selected_host] then
-								return nil, "Unknown host: "..selected_host;
-							end
-							local host_handler = host_commands[qualified_name][selected_host];
-							if not host_handler then
-								return nil, "This command is not available on "..selected_host;
-							end
-							return host_handler(...);
-						end;
 					};
 				};
 				host_commands[qualified_name] = host_command_info;
 			end
 			if host_command_info[command_host] then
-				module:log("warn", "Command %s() is already registered - overwriting with %s", qualified_name, mod_name);
+				module:log("warn", "Command %s() is already registered on %s - overwriting with %s", qualified_name, command_host, mod_name);
 			end
 			host_command_info[command_host] = handler;
 		end
 		local section_t = def_env[command.section];
 			return;
 		end
 		local section_t = def_env[command.section];
 		if not section_t or section_t[command.name] ~= handler then
-			return;
+			-- Handler doesn't match, but it could be the host-selector wrapper
+			-- Let's try removing a per-host command
+			local qualified_name = command.section..":"..command.name;
+			local host_command_handlers = host_commands[qualified_name];
+			if host_command_handlers then
+				-- Bingo!
+				module:log("debug", "Removing command %s from %s", qualified_name, command_host);
+				clear_host_commands(command_host, qualified_name);
+			elseif section_t then
+				module:log("warn", "Not removing shell command: handler mismatch: %q ~= %q", section_t and section_t[command.name], handler);
+				return;
+			end
 		end
 		section_t[command.name] = nil;
 		if next(section_t) == nil then -- Delete section if empty
 			def_env[command.section] = nil;
 		end
-		if command_host then
-			local host_command_info = host_commands[command.section..":"..command.name];
-			if host_command_info then
-				-- Remove our host handler
-				host_command_info[command_host] = nil;
-				-- Clean up entire command entry if there are no per-host handlers left
-				local any_hosts = false;
-				for k in pairs(host_command_info) do
-					if k then -- metadata is false, ignore it
-						any_hosts = true;
-						break;
-					end
-				end
-				if not any_hosts then
-					host_commands[command.section..":"..command.name] = nil;
-				end
-			end
-		end
 	end
 	return on_command_added, on_command_removed;
 end
 module:handle_items("shell-command", new_item_handlers());
 function module.add_host(host_module)
 	host_module:handle_items("shell-command", new_item_handlers(host_module.host));
+	function host_module.unload()
+		-- Due to non-deterministic unload order, we might not see item
+		-- removal events for all commands before we get unloaded, so
+		-- we clear everything from the host explicitly when we're
+		-- unloaded (also sensible if we are unloaded manually)
+		clear_host_commands(host_module.host);
+	end
 end
 function module.unload()
 	stanza_watchers.cleanup();
 end

Mercurial > prosody-hg

comparison plugins/mod_admin_shell.lua @ 14115:44a8c8d4146a