tools/ejabberd2prosody: Disable generating a config, as the format it generates is...
[prosody.git] / plugins / mod_register.lua
index be1be0aebecb1dca7c28a74df66e74af49ff8c90..141a4997966a7448a4b78f0f9a9b929e5206a354 100644 (file)
 -- Prosody IM
--- Copyright (C) 2008-2009 Matthew Wild
--- Copyright (C) 2008-2009 Waqas Hussain
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
 -- 
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
 --
 
 
-local hosts = _G.hosts;
 local st = require "util.stanza";
-local datamanager = require "util.datamanager";
+local dataform_new = require "util.dataforms".new;
 local usermanager_user_exists = require "core.usermanager".user_exists;
 local usermanager_create_user = require "core.usermanager".create_user;
-local datamanager_store = require "util.datamanager".store;
+local usermanager_set_password = require "core.usermanager".set_password;
+local usermanager_delete_user = require "core.usermanager".delete_user;
 local os_time = os.time;
 local nodeprep = require "util.encodings".stringprep.nodeprep;
+local jid_bare = require "util.jid".bare;
+
+local compat = module:get_option_boolean("registration_compat", true);
+local allow_registration = module:get_option_boolean("allow_registration", false);
+local additional_fields = module:get_option("additional_registration_fields", {});
+
+local account_details = module:open_store("account_details");
+
+local field_map = {
+       username = { name = "username", type = "text-single", label = "Username", required = true };
+       password = { name = "password", type = "text-private", label = "Password", required = true };
+       nick = { name = "nick", type = "text-single", label = "Nickname" };
+       name = { name = "name", type = "text-single", label = "Full Name" };
+       first = { name = "first", type = "text-single", label = "Given Name" };
+       last = { name = "last", type = "text-single", label = "Family Name" };
+       email = { name = "email", type = "text-single", label = "Email" };
+       address = { name = "address", type = "text-single", label = "Street" };
+       city = { name = "city", type = "text-single", label = "City" };
+       state = { name = "state", type = "text-single", label = "State" };
+       zip = { name = "zip", type = "text-single", label = "Postal code" };
+       phone = { name = "phone", type = "text-single", label = "Telephone number" };
+       url = { name = "url", type = "text-single", label = "Webpage" };
+       date = { name = "date", type = "text-single", label = "Birth date" };
+};
+
+local registration_form = dataform_new{
+       title = "Creating a new account";
+       instructions = "Choose a username and password for use with this service.";
+
+       field_map.username;
+       field_map.password;
+};
+
+local registration_query = st.stanza("query", {xmlns = "jabber:iq:register"})
+       :tag("instructions"):text("Choose a username and password for use with this service."):up()
+       :tag("username"):up()
+       :tag("password"):up();
+
+for _, field in ipairs(additional_fields) do
+       if type(field) == "table" then
+               registration_form[#registration_form + 1] = field;
+       else
+               if field:match("%+$") then
+                       field = field:sub(1, #field - 1);
+                       field_map[field].required = true;
+               end
+
+               registration_form[#registration_form + 1] = field_map[field];
+               registration_query:tag(field):up();
+       end
+end
+registration_query:add_child(registration_form:form());
 
 module:add_feature("jabber:iq:register");
 
-module:add_iq_handler("c2s", "jabber:iq:register", function (session, stanza)
-       if stanza.tags[1].name == "query" then
-               local query = stanza.tags[1];
-               if stanza.attr.type == "get" then
-                       local reply = st.reply(stanza);
-                       reply:tag("query", {xmlns = "jabber:iq:register"})
-                               :tag("registered"):up()
-                               :tag("username"):text(session.username):up()
-                               :tag("password"):up();
-                       session.send(reply);
-               elseif stanza.attr.type == "set" then
-                       if query.tags[1] and query.tags[1].name == "remove" then
-                               -- TODO delete user auth data, send iq response, kick all user resources with a <not-authorized/>, delete all user data
-                               local username, host = session.username, session.host;
-                               --session.send(st.error_reply(stanza, "cancel", "not-allowed"));
-                               --return;
-                               usermanager_create_user(username, nil, host); -- Disable account
-                               -- FIXME the disabling currently allows a different user to recreate the account
-                               -- we should add an in-memory account block mode when we have threading
+local register_stream_feature = st.stanza("register", {xmlns="http://jabber.org/features/iq-register"}):up();
+module:hook("stream-features", function(event)
+        local session, features = event.origin, event.features;
+
+       -- Advertise registration to unauthorized clients only.
+       if not(allow_registration) or session.type ~= "c2s_unauthed" then
+               return
+       end
+
+       features:add_child(register_stream_feature);
+end);
+
+local function handle_registration_stanza(event)
+       local session, stanza = event.origin, event.stanza;
+
+       local query = stanza.tags[1];
+       if stanza.attr.type == "get" then
+               local reply = st.reply(stanza);
+               reply:tag("query", {xmlns = "jabber:iq:register"})
+                       :tag("registered"):up()
+                       :tag("username"):text(session.username):up()
+                       :tag("password"):up();
+               session.send(reply);
+       else -- stanza.attr.type == "set"
+               if query.tags[1] and query.tags[1].name == "remove" then
+                       local username, host = session.username, session.host;
+
+                       local old_session_close = session.close;
+                       session.close = function(session, ...)
                                session.send(st.reply(stanza));
-                               local roster = session.roster;
-                               for _, session in pairs(hosts[host].sessions[username].sessions) do -- disconnect all resources
-                                       session:close({condition = "not-authorized", text = "Account deleted"});
-                               end
-                               -- TODO datamanager should be able to delete all user data itself
-                               datamanager.store(username, host, "vcard", nil);
-                               datamanager.store(username, host, "private", nil);
-                               datamanager.store(username, host, "offline", nil);
-                               local bare = username.."@"..host;
-                               for jid, item in pairs(roster) do
-                                       if jid and jid ~= "pending" then
-                                               if item.subscription == "both" or item.subscription == "from" or (roster.pending and roster.pending[jid]) then
-                                                       core_post_stanza(hosts[host], st.presence({type="unsubscribed", from=bare, to=jid}));
-                                               end
-                                               if item.subscription == "both" or item.subscription == "to" or item.ask then
-                                                       core_post_stanza(hosts[host], st.presence({type="unsubscribe", from=bare, to=jid}));
-                                               end
-                                       end
-                               end
-                               datamanager.store(username, host, "roster", nil);
-                               datamanager.store(username, host, "accounts", nil); -- delete accounts datastore at the end
-                               module:log("info", "User removed their account: %s@%s", username, host);
-                               module:fire_event("user-deregistered", { username = username, host = host, source = "mod_register", session = session });
-                       else
-                               local username = query:child_with_name("username");
-                               local password = query:child_with_name("password");
-                               if username and password then
-                                       -- FIXME shouldn't use table.concat
-                                       username = nodeprep(table.concat(username));
-                                       password = table.concat(password);
-                                       if username == session.username then
-                                               if usermanager_create_user(username, password, session.host) then -- password change -- TODO is this the right way?
-                                                       session.send(st.reply(stanza));
-                                               else
-                                                       -- TODO unable to write file, file may be locked, etc, what's the correct error?
-                                                       session.send(st.error_reply(stanza, "wait", "internal-server-error"));
-                                               end
+                               return old_session_close(session, ...);
+                       end
+                       
+                       local ok, err = usermanager_delete_user(username, host);
+                       
+                       if not ok then
+                               module:log("debug", "Removing user account %s@%s failed: %s", username, host, err);
+                               session.close = old_session_close;
+                               session.send(st.error_reply(stanza, "cancel", "service-unavailable", err));
+                               return true;
+                       end
+                       
+                       module:log("info", "User removed their account: %s@%s", username, host);
+                       module:fire_event("user-deregistered", { username = username, host = host, source = "mod_register", session = session });
+               else
+                       local username = nodeprep(query:get_child("username"):get_text());
+                       local password = query:get_child("password"):get_text();
+                       if username and password then
+                               if username == session.username then
+                                       if usermanager_set_password(username, password, session.host) then
+                                               session.send(st.reply(stanza));
                                        else
-                                               session.send(st.error_reply(stanza, "modify", "bad-request"));
+                                               -- TODO unable to write file, file may be locked, etc, what's the correct error?
+                                               session.send(st.error_reply(stanza, "wait", "internal-server-error"));
                                        end
                                else
                                        session.send(st.error_reply(stanza, "modify", "bad-request"));
                                end
+                       else
+                               session.send(st.error_reply(stanza, "modify", "bad-request"));
                        end
                end
+       end
+       return true;
+end
+
+module:hook("iq/self/jabber:iq:register:query", handle_registration_stanza);
+if compat then
+       module:hook("iq/host/jabber:iq:register:query", function (event)
+               local session, stanza = event.origin, event.stanza;
+               if session.type == "c2s" and jid_bare(stanza.attr.to) == session.host then
+                       return handle_registration_stanza(event);
+               end
+       end);
+end
+
+local function parse_response(query)
+       local form = query:get_child("x", "jabber:x:data");
+       if form then
+               return registration_form:data(form);
        else
-               session.send(st.error_reply(stanza, "cancel", "service-unavailable"));
-       end;
-end);
+               local data = {};
+               local errors = {};
+               for _, field in ipairs(registration_form) do
+                       local name, required = field.name, field.required;
+                       if field_map[name] then
+                               data[name] = query:get_child_text(name);
+                               if (not data[name] or #data[name] == 0) and required then
+                                       errors[name] = "Required value missing";
+                               end
+                       end
+               end
+               if next(errors) then
+                       return data, errors;
+               end
+               return data;
+       end
+end
 
 local recent_ips = {};
 local min_seconds_between_registrations = module:get_option("min_seconds_between_registrations");
@@ -97,31 +178,31 @@ local blacklisted_ips = module:get_option("registration_blacklist") or {};
 for _, ip in ipairs(whitelisted_ips) do whitelisted_ips[ip] = true; end
 for _, ip in ipairs(blacklisted_ips) do blacklisted_ips[ip] = true; end
 
-module:add_iq_handler("c2s_unauthed", "jabber:iq:register", function (session, stanza)
-       if module:get_option("allow_registration") == false then
+module:hook("stanza/iq/jabber:iq:register:query", function(event)
+       local session, stanza = event.origin, event.stanza;
+
+       if not(allow_registration) or session.type ~= "c2s_unauthed" then
                session.send(st.error_reply(stanza, "cancel", "service-unavailable"));
-       elseif stanza.tags[1].name == "query" then
+       else
                local query = stanza.tags[1];
                if stanza.attr.type == "get" then
                        local reply = st.reply(stanza);
-                       reply:tag("query", {xmlns = "jabber:iq:register"})
-                               :tag("instructions"):text("Choose a username and password for use with this service."):up()
-                               :tag("username"):up()
-                               :tag("password"):up();
+                       reply:add_child(registration_query);
                        session.send(reply);
                elseif stanza.attr.type == "set" then
                        if query.tags[1] and query.tags[1].name == "remove" then
                                session.send(st.error_reply(stanza, "auth", "registration-required"));
                        else
-                               local username = query:child_with_name("username");
-                               local password = query:child_with_name("password");
-                               if username and password then
+                               local data, errors = parse_response(query);
+                               if errors then
+                                       session.send(st.error_reply(stanza, "modify", "not-acceptable"));
+                               else
                                        -- Check that the user is not blacklisted or registering too often
                                        if not session.ip then
                                                module:log("debug", "User's IP not known; can't apply blacklist/whitelist");
                                        elseif blacklisted_ips[session.ip] or (whitelist_only and not whitelisted_ips[session.ip]) then
                                                session.send(st.error_reply(stanza, "cancel", "not-acceptable", "You are not allowed to register an account."));
-                                               return;
+                                               return true;
                                        elseif min_seconds_between_registrations and not whitelisted_ips[session.ip] then
                                                if not recent_ips[session.ip] then
                                                        recent_ips[session.ip] = { time = os_time(), count = 1 };
@@ -132,38 +213,45 @@ module:add_iq_handler("c2s_unauthed", "jabber:iq:register", function (session, s
                                                        if os_time() - ip.time < min_seconds_between_registrations then
                                                                ip.time = os_time();
                                                                session.send(st.error_reply(stanza, "wait", "not-acceptable"));
-                                                               return;
+                                                               return true;
                                                        end
                                                        ip.time = os_time();
                                                end
                                        end
-                                       -- FIXME shouldn't use table.concat
-                                       username = nodeprep(table.concat(username));
-                                       password = table.concat(password);
+                                       local username, password = nodeprep(data.username), data.password;
+                                       data.username, data.password = nil, nil;
                                        local host = module.host;
                                        if not username or username == "" then
                                                session.send(st.error_reply(stanza, "modify", "not-acceptable", "The requested username is invalid."));
+                                               return true;
+                                       end
+                                       local user = { username = username , host = host, allowed = true }
+                                       module:fire_event("user-registering", user);
+                                       if not user.allowed then
+                                               session.send(st.error_reply(stanza, "modify", "not-acceptable", "The requested username is forbidden."));
                                        elseif usermanager_user_exists(username, host) then
                                                session.send(st.error_reply(stanza, "cancel", "conflict", "The requested username already exists."));
                                        else
+                                               -- TODO unable to write file, file may be locked, etc, what's the correct error?
+                                               local error_reply = st.error_reply(stanza, "wait", "internal-server-error", "Failed to write data to disk.");
                                                if usermanager_create_user(username, password, host) then
+                                                       if next(data) and not account_details:set(username, data) then
+                                                               usermanager_delete_user(username, host);
+                                                               session.send(error_reply);
+                                                               return true;
+                                                       end
                                                        session.send(st.reply(stanza)); -- user created!
                                                        module:log("info", "User account created: %s@%s", username, host);
-                                                       module:fire_event("user-registered", { 
+                                                       module:fire_event("user-registered", {
                                                                username = username, host = host, source = "mod_register",
                                                                session = session });
                                                else
-                                                       -- TODO unable to write file, file may be locked, etc, what's the correct error?
-                                                       session.send(st.error_reply(stanza, "wait", "internal-server-error", "Failed to write data to disk."));
+                                                       session.send(error_reply);
                                                end
                                        end
-                               else
-                                       session.send(st.error_reply(stanza, "modify", "not-acceptable"));
                                end
                        end
                end
-       else
-               session.send(st.error_reply(stanza, "cancel", "service-unavailable"));
-       end;
+       end
+       return true;
 end);
-