1 -- Copyright (C) 2009-2011 Florian Zeitz
3 -- This file is MIT/X11 licensed. Please see the
4 -- COPYING file in the source package for more information.
9 local prosody = _G.prosody;
10 local hosts = prosody.hosts;
11 local t_concat = table.concat;
13 local iterators = require "util.iterators";
14 local keys, values = iterators.keys, iterators.values;
15 local usermanager_user_exists = require "core.usermanager".user_exists;
16 local usermanager_create_user = require "core.usermanager".create_user;
17 local usermanager_get_password = require "core.usermanager".get_password;
18 local usermanager_set_password = require "core.usermanager".set_password;
19 local is_admin = require "core.usermanager".is_admin;
20 local rm_load_roster = require "core.rostermanager".load_roster;
21 local st, jid, uuid = require "util.stanza", require "util.jid", require "util.uuid";
22 local timer_add_task = require "util.timer".add_task;
23 local dataforms_new = require "util.dataforms".new;
24 local array = require "util.array";
25 local modulemanager = require "modulemanager";
26 local core_post_stanza = prosody.core_post_stanza;
28 module:depends("adhoc");
29 local adhoc_new = module:require "adhoc".new;
31 local function generate_error_message(errors)
33 for name, err in pairs(errors) do
34 errmsg[#errmsg + 1] = name .. ": " .. err;
36 return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
39 function add_user_command_handler(self, data, state)
40 local add_user_layout = dataforms_new{
41 title = "Adding a User";
42 instructions = "Fill out this form to add a user.";
44 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
45 { name = "accountjid", type = "jid-single", required = true, label = "The Jabber ID for the account to be added" };
46 { name = "password", type = "text-private", label = "The password for this account" };
47 { name = "password-verify", type = "text-private", label = "Retype password" };
51 if data.action == "cancel" then
52 return { status = "canceled" };
54 local fields, err = add_user_layout:data(data.form);
56 return generate_error_message(err);
58 local username, host, resource = jid.split(fields.accountjid);
59 if data.to ~= host then
60 return { status = "completed", error = { message = "Trying to add a user on " .. host .. " but command was sent to " .. data.to}};
62 if (fields["password"] == fields["password-verify"]) and username and host then
63 if usermanager_user_exists(username, host) then
64 return { status = "completed", error = { message = "Account already exists" } };
66 if usermanager_create_user(username, fields.password, host) then
67 module:log("info", "Created new account %s@%s", username, host);
68 return { status = "completed", info = "Account successfully created" };
70 return { status = "completed", error = { message = "Failed to write data to disk" } };
74 module:log("debug", "Invalid data, password mismatch or empty username while creating account for %s", fields.accountjid or "<nil>");
75 return { status = "completed", error = { message = "Invalid data.\nPassword mismatch, or empty username" } };
78 return { status = "executing", form = add_user_layout }, "executing";
82 function change_user_password_command_handler(self, data, state)
83 local change_user_password_layout = dataforms_new{
84 title = "Changing a User Password";
85 instructions = "Fill out this form to change a user's password.";
87 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
88 { name = "accountjid", type = "jid-single", required = true, label = "The Jabber ID for this account" };
89 { name = "password", type = "text-private", required = true, label = "The password for this account" };
93 if data.action == "cancel" then
94 return { status = "canceled" };
96 local fields, err = change_user_password_layout:data(data.form);
98 return generate_error_message(err);
100 local username, host, resource = jid.split(fields.accountjid);
101 if data.to ~= host then
102 return { status = "completed", error = { message = "Trying to change the password of a user on " .. host .. " but command was sent to " .. data.to}};
104 if usermanager_user_exists(username, host) and usermanager_set_password(username, fields.password, host) then
105 return { status = "completed", info = "Password successfully changed" };
107 return { status = "completed", error = { message = "User does not exist" } };
110 return { status = "executing", form = change_user_password_layout }, "executing";
114 function config_reload_handler(self, data, state)
115 local ok, err = prosody.reload_config();
117 return { status = "completed", info = "Configuration reloaded (modules may need to be reloaded for this to have an effect)" };
119 return { status = "completed", error = { message = "Failed to reload config: " .. tostring(err) } };
124 function delete_user_command_handler(self, data, state)
125 local delete_user_layout = dataforms_new{
126 title = "Deleting a User";
127 instructions = "Fill out this form to delete a user.";
129 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
130 { name = "accountjids", type = "jid-multi", label = "The Jabber ID(s) to delete" };
134 if data.action == "cancel" then
135 return { status = "canceled" };
137 local fields, err = delete_user_layout:data(data.form);
139 return generate_error_message(err);
142 local succeeded = {};
143 for _, aJID in ipairs(fields.accountjids) do
144 local username, host, resource = jid.split(aJID);
145 if (host == data.to) and usermanager_user_exists(username, host) and disconnect_user(aJID) and usermanager_create_user(username, nil, host) then
146 module:log("debug", "User %s has been deleted", aJID);
147 succeeded[#succeeded+1] = aJID;
149 module:log("debug", "Tried to delete non-existant user %s", aJID);
150 failed[#failed+1] = aJID;
153 return {status = "completed", info = (#succeeded ~= 0 and
154 "The following accounts were successfully deleted:\n"..t_concat(succeeded, "\n").."\n" or "")..
156 "The following accounts could not be deleted:\n"..t_concat(failed, "\n") or "") };
158 return { status = "executing", form = delete_user_layout }, "executing";
162 function disconnect_user(match_jid)
163 local node, hostname, givenResource = jid.split(match_jid);
164 local host = hosts[hostname];
165 local sessions = host.sessions[node] and host.sessions[node].sessions;
166 for resource, session in pairs(sessions or {}) do
167 if not givenResource or (resource == givenResource) then
168 module:log("debug", "Disconnecting %s@%s/%s", node, hostname, resource);
175 function end_user_session_handler(self, data, state)
176 local end_user_session_layout = dataforms_new{
177 title = "Ending a User Session";
178 instructions = "Fill out this form to end a user's session.";
180 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
181 { name = "accountjids", type = "jid-multi", label = "The Jabber ID(s) for which to end sessions" };
185 if data.action == "cancel" then
186 return { status = "canceled" };
189 local fields, err = end_user_session_layout:data(data.form);
191 return generate_error_message(err);
194 local succeeded = {};
195 for _, aJID in ipairs(fields.accountjids) do
196 local username, host, resource = jid.split(aJID);
197 if (host == data.to) and usermanager_user_exists(username, host) and disconnect_user(aJID) then
198 succeeded[#succeeded+1] = aJID;
200 failed[#failed+1] = aJID;
203 return {status = "completed", info = (#succeeded ~= 0 and
204 "The following accounts were successfully disconnected:\n"..t_concat(succeeded, "\n").."\n" or "")..
206 "The following accounts could not be disconnected:\n"..t_concat(failed, "\n") or "") };
208 return { status = "executing", form = end_user_session_layout }, "executing";
212 local end_user_session_layout = dataforms_new{
213 title = "Ending a User Session";
214 instructions = "Fill out this form to end a user's session.";
216 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
217 { name = "accountjids", type = "jid-multi", label = "The Jabber ID(s) for which to end sessions" };
221 function get_user_password_handler(self, data, state)
222 local get_user_password_layout = dataforms_new{
223 title = "Getting User's Password";
224 instructions = "Fill out this form to get a user's password.";
226 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
227 { name = "accountjid", type = "jid-single", required = true, label = "The Jabber ID for which to retrieve the password" };
230 local get_user_password_result_layout = dataforms_new{
231 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
232 { name = "accountjid", type = "jid-single", label = "JID" };
233 { name = "password", type = "text-single", label = "Password" };
237 if data.action == "cancel" then
238 return { status = "canceled" };
240 local fields, err = get_user_password_layout:data(data.form);
242 return generate_error_message(err);
244 local user, host, resource = jid.split(fields.accountjid);
245 local accountjid = "";
247 if host ~= data.to then
248 return { status = "completed", error = { message = "Tried to get password for a user on " .. host .. " but command was sent to " .. data.to } };
249 elseif usermanager_user_exists(user, host) then
250 accountjid = fields.accountjid;
251 password = usermanager_get_password(user, host);
253 return { status = "completed", error = { message = "User does not exist" } };
255 return { status = "completed", result = { layout = get_user_password_result_layout, values = {accountjid = accountjid, password = password} } };
257 return { status = "executing", form = get_user_password_layout }, "executing";
261 function get_user_roster_handler(self, data, state)
262 local get_user_roster_layout = dataforms_new{
263 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
264 { name = "accountjid", type = "jid-single", required = true, label = "The Jabber ID for which to retrieve the roster" };
267 local get_user_roster_result_layout = dataforms_new{
268 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
269 { name = "accountjid", type = "jid-single", label = "This is the roster for" };
270 { name = "roster", type = "text-multi", label = "Roster XML" };
274 if data.action == "cancel" then
275 return { status = "canceled" };
278 local fields, err = get_user_roster_layout:data(data.form);
281 return generate_error_message(err);
284 local user, host, resource = jid.split(fields.accountjid);
285 if host ~= data.to then
286 return { status = "completed", error = { message = "Tried to get roster for a user on " .. host .. " but command was sent to " .. data.to } };
287 elseif not usermanager_user_exists(user, host) then
288 return { status = "completed", error = { message = "User does not exist" } };
290 local roster = rm_load_roster(user, host);
292 local query = st.stanza("query", { xmlns = "jabber:iq:roster" });
293 for jid in pairs(roster) do
294 if jid ~= "pending" and jid then
297 subscription = roster[jid].subscription,
298 ask = roster[jid].ask,
299 name = roster[jid].name,
301 for group in pairs(roster[jid].groups) do
302 query:tag("group"):text(group):up();
308 local query_text = query:__tostring(); -- TODO: Use upcoming pretty_print() function
309 query_text = query_text:gsub("><", ">\n<");
311 local result = get_user_roster_result_layout:form({ accountjid = user.."@"..host, roster = query_text }, "result");
312 result:add_child(query);
313 return { status = "completed", other = result };
315 return { status = "executing", form = get_user_roster_layout }, "executing";
319 function get_user_stats_handler(self, data, state)
320 local get_user_stats_layout = dataforms_new{
321 title = "Get User Statistics";
322 instructions = "Fill out this form to gather user statistics.";
324 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
325 { name = "accountjid", type = "jid-single", required = true, label = "The Jabber ID for statistics" };
328 local get_user_stats_result_layout = dataforms_new{
329 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
330 { name = "ipaddresses", type = "text-multi", label = "IP Addresses" };
331 { name = "rostersize", type = "text-single", label = "Roster size" };
332 { name = "onlineresources", type = "text-multi", label = "Online Resources" };
336 if data.action == "cancel" then
337 return { status = "canceled" };
340 local fields, err = get_user_stats_layout:data(data.form);
343 return generate_error_message(err);
346 local user, host, resource = jid.split(fields.accountjid);
347 if host ~= data.to then
348 return { status = "completed", error = { message = "Tried to get stats for a user on " .. host .. " but command was sent to " .. data.to } };
349 elseif not usermanager_user_exists(user, host) then
350 return { status = "completed", error = { message = "User does not exist" } };
352 local roster = rm_load_roster(user, host);
353 local rostersize = 0;
355 local resources = "";
356 for jid in pairs(roster) do
357 if jid ~= "pending" and jid then
358 rostersize = rostersize + 1;
361 for resource, session in pairs((hosts[host].sessions[user] and hosts[host].sessions[user].sessions) or {}) do
362 resources = resources .. "\n" .. resource;
363 IPs = IPs .. "\n" .. session.ip;
365 return { status = "completed", result = {layout = get_user_stats_result_layout, values = {ipaddresses = IPs, rostersize = tostring(rostersize),
366 onlineresources = resources}} };
368 return { status = "executing", form = get_user_stats_layout }, "executing";
372 function get_online_users_command_handler(self, data, state)
373 local get_online_users_layout = dataforms_new{
374 title = "Getting List of Online Users";
375 instructions = "How many users should be returned at most?";
377 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
378 { name = "max_items", type = "list-single", label = "Maximum number of users",
379 value = { "25", "50", "75", "100", "150", "200", "all" } };
380 { name = "details", type = "boolean", label = "Show details" };
383 local get_online_users_result_layout = dataforms_new{
384 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
385 { name = "onlineuserjids", type = "text-multi", label = "The list of all online users" };
389 if data.action == "cancel" then
390 return { status = "canceled" };
393 local fields, err = get_online_users_layout:data(data.form);
396 return generate_error_message(err);
399 local max_items = nil
400 if fields.max_items ~= "all" then
401 max_items = tonumber(fields.max_items);
405 for username, user in pairs(hosts[data.to].sessions or {}) do
406 if (max_items ~= nil) and (count >= max_items) then
409 users[#users+1] = username.."@"..data.to;
411 if fields.details then
412 for resource, session in pairs(user.sessions or {}) do
413 local status, priority = "unavailable", tostring(session.priority or "-");
414 if session.presence then
415 status = session.presence:child_with_name("show");
417 status = status:get_text() or "[invalid!]";
419 status = "available";
422 users[#users+1] = " - "..resource..": "..status.."("..priority..")";
426 return { status = "completed", result = {layout = get_online_users_result_layout, values = {onlineuserjids=t_concat(users, "\n")}} };
428 return { status = "executing", form = get_online_users_layout }, "executing";
432 function list_modules_handler(self, data, state)
433 local result = dataforms_new {
434 title = "List of loaded modules";
436 { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/modules#list" };
437 { name = "modules", type = "text-multi", label = "The following modules are loaded:" };
440 local modules = array.collect(keys(hosts[data.to].modules)):sort():concat("\n");
442 return { status = "completed", result = { layout = result; values = { modules = modules } } };
445 function load_module_handler(self, data, state)
446 local layout = dataforms_new {
447 title = "Load module";
448 instructions = "Specify the module to be loaded";
450 { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/modules#load" };
451 { name = "module", type = "text-single", required = true, label = "Module to be loaded:"};
454 if data.action == "cancel" then
455 return { status = "canceled" };
457 local fields, err = layout:data(data.form);
459 return generate_error_message(err);
461 if modulemanager.is_loaded(data.to, fields.module) then
462 return { status = "completed", info = "Module already loaded" };
464 local ok, err = modulemanager.load(data.to, fields.module);
466 return { status = "completed", info = 'Module "'..fields.module..'" successfully loaded on host "'..data.to..'".' };
468 return { status = "completed", error = { message = 'Failed to load module "'..fields.module..'" on host "'..data.to..
469 '". Error was: "'..tostring(err or "<unspecified>")..'"' } };
472 return { status = "executing", form = layout }, "executing";
476 function reload_modules_handler(self, data, state)
477 local layout = dataforms_new {
478 title = "Reload modules";
479 instructions = "Select the modules to be reloaded";
481 { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/modules#reload" };
482 { name = "modules", type = "list-multi", required = true, label = "Modules to be reloaded:"};
485 if data.action == "cancel" then
486 return { status = "canceled" };
488 local fields, err = layout:data(data.form);
490 return generate_error_message(err);
492 local ok_list, err_list = {}, {};
493 for _, module in ipairs(fields.modules) do
494 local ok, err = modulemanager.reload(data.to, module);
496 ok_list[#ok_list + 1] = module;
498 err_list[#err_list + 1] = module .. "(Error: " .. tostring(err) .. ")";
501 local info = (#ok_list > 0 and ("The following modules were successfully reloaded on host "..data.to..":\n"..t_concat(ok_list, "\n")) or "")..
502 (#err_list > 0 and ("Failed to reload the following modules on host "..data.to..":\n"..t_concat(err_list, "\n")) or "");
503 return { status = "completed", info = info };
505 local modules = array.collect(keys(hosts[data.to].modules)):sort();
506 return { status = "executing", form = { layout = layout; values = { modules = modules } } }, "executing";
510 function send_to_online(message, server)
512 sessions = { [server] = hosts[server] };
518 for domain, session in pairs(sessions) do
519 for user in pairs(session.sessions or {}) do
521 message.attr.from = domain;
522 message.attr.to = user.."@"..domain;
523 core_post_stanza(session, message);
530 function shut_down_service_handler(self, data, state)
531 local shut_down_service_layout = dataforms_new{
532 title = "Shutting Down the Service";
533 instructions = "Fill out this form to shut down the service.";
535 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/admin" };
536 { name = "delay", type = "list-single", label = "Time delay before shutting down",
537 value = { {label = "30 seconds", value = "30"},
538 {label = "60 seconds", value = "60"},
539 {label = "90 seconds", value = "90"},
540 {label = "2 minutes", value = "120"},
541 {label = "3 minutes", value = "180"},
542 {label = "4 minutes", value = "240"},
543 {label = "5 minutes", value = "300"},
546 { name = "announcement", type = "text-multi", label = "Announcement" };
550 if data.action == "cancel" then
551 return { status = "canceled" };
554 local fields, err = shut_down_service_layout:data(data.form);
557 return generate_error_message(err);
560 if fields.announcement and #fields.announcement > 0 then
561 local message = st.message({type = "headline"}, fields.announcement):up()
562 :tag("subject"):text("Server is shutting down");
563 send_to_online(message);
566 timer_add_task(tonumber(fields.delay or "5"), prosody.shutdown);
568 return { status = "completed", info = "Server is about to shut down" };
570 return { status = "executing", form = shut_down_service_layout }, "executing";
574 function unload_modules_handler(self, data, state)
575 local layout = dataforms_new {
576 title = "Unload modules";
577 instructions = "Select the modules to be unloaded";
579 { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/modules#unload" };
580 { name = "modules", type = "list-multi", required = true, label = "Modules to be unloaded:"};
583 if data.action == "cancel" then
584 return { status = "canceled" };
586 local fields, err = layout:data(data.form);
588 return generate_error_message(err);
590 local ok_list, err_list = {}, {};
591 for _, module in ipairs(fields.modules) do
592 local ok, err = modulemanager.unload(data.to, module);
594 ok_list[#ok_list + 1] = module;
596 err_list[#err_list + 1] = module .. "(Error: " .. tostring(err) .. ")";
599 local info = (#ok_list > 0 and ("The following modules were successfully unloaded on host "..data.to..":\n"..t_concat(ok_list, "\n")) or "")..
600 (#err_list > 0 and ("Failed to unload the following modules on host "..data.to..":\n"..t_concat(err_list, "\n")) or "");
601 return { status = "completed", info = info };
603 local modules = array.collect(keys(hosts[data.to].modules)):sort();
604 return { status = "executing", form = { layout = layout; values = { modules = modules } } }, "executing";
608 local add_user_desc = adhoc_new("Add User", "http://jabber.org/protocol/admin#add-user", add_user_command_handler, "admin");
609 local change_user_password_desc = adhoc_new("Change User Password", "http://jabber.org/protocol/admin#change-user-password", change_user_password_command_handler, "admin");
610 local config_reload_desc = adhoc_new("Reload configuration", "http://prosody.im/protocol/config#reload", config_reload_handler, "global_admin");
611 local delete_user_desc = adhoc_new("Delete User", "http://jabber.org/protocol/admin#delete-user", delete_user_command_handler, "admin");
612 local end_user_session_desc = adhoc_new("End User Session", "http://jabber.org/protocol/admin#end-user-session", end_user_session_handler, "admin");
613 local get_user_password_desc = adhoc_new("Get User Password", "http://jabber.org/protocol/admin#get-user-password", get_user_password_handler, "admin");
614 local get_user_roster_desc = adhoc_new("Get User Roster","http://jabber.org/protocol/admin#get-user-roster", get_user_roster_handler, "admin");
615 local get_user_stats_desc = adhoc_new("Get User Statistics","http://jabber.org/protocol/admin#user-stats", get_user_stats_handler, "admin");
616 local get_online_users_desc = adhoc_new("Get List of Online Users", "http://jabber.org/protocol/admin#get-online-users", get_online_users_command_handler, "admin");
617 local list_modules_desc = adhoc_new("List loaded modules", "http://prosody.im/protocol/modules#list", list_modules_handler, "admin");
618 local load_module_desc = adhoc_new("Load module", "http://prosody.im/protocol/modules#load", load_module_handler, "admin");
619 local reload_modules_desc = adhoc_new("Reload modules", "http://prosody.im/protocol/modules#reload", reload_modules_handler, "admin");
620 local shut_down_service_desc = adhoc_new("Shut Down Service", "http://jabber.org/protocol/admin#shutdown", shut_down_service_handler, "global_admin");
621 local unload_modules_desc = adhoc_new("Unload modules", "http://prosody.im/protocol/modules#unload", unload_modules_handler, "admin");
623 module:provides("adhoc", add_user_desc);
624 module:provides("adhoc", change_user_password_desc);
625 module:provides("adhoc", config_reload_desc);
626 module:provides("adhoc", delete_user_desc);
627 module:provides("adhoc", end_user_session_desc);
628 module:provides("adhoc", get_user_password_desc);
629 module:provides("adhoc", get_user_roster_desc);
630 module:provides("adhoc", get_user_stats_desc);
631 module:provides("adhoc", get_online_users_desc);
632 module:provides("adhoc", list_modules_desc);
633 module:provides("adhoc", load_module_desc);
634 module:provides("adhoc", reload_modules_desc);
635 module:provides("adhoc", shut_down_service_desc);
636 module:provides("adhoc", unload_modules_desc);