portmanager: Add luacheck annotations
[prosody.git] / core / rostermanager.lua
index 506cf20593aa7da447d09ca5836517bbda1bab3b..a9b26f23892d5b5b1079b309e149fc980992feb0 100644 (file)
@@ -1,7 +1,7 @@
 -- Prosody IM
 -- 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 log = require "util.logger".init("rostermanager");
 
-local setmetatable = setmetatable;
-local format = string.format;
-local loadfile, setfenv, pcall = loadfile, setfenv, pcall;
-local pairs, ipairs = pairs, ipairs;
+local pairs = pairs;
 local tostring = tostring;
+local type = type;
 
 local hosts = hosts;
-local bare_sessions = bare_sessions;
+local bare_sessions = prosody.bare_sessions;
 
 local datamanager = require "util.datamanager"
+local um_user_exists = require "core.usermanager".user_exists;
 local st = require "util.stanza";
 
 module "rostermanager"
@@ -56,7 +55,7 @@ function remove_from_roster(session, jid)
 end
 
 function roster_push(username, host, jid)
-       local roster = jid and jid ~= "pending" and hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster;
+       local roster = jid and hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster;
        if roster then
                local item = hosts[host].sessions[username].roster[jid];
                local stanza = st.iq({type="set"});
@@ -81,34 +80,54 @@ function roster_push(username, host, jid)
        end
 end
 
+local function roster_metadata(roster, err)
+       local metadata = roster[false];
+       if not metadata then
+               metadata = { broken = err or nil };
+               roster[false] = metadata;
+       end
+       if roster.pending and type(roster.pending.subscription) ~= "string" then
+               metadata.pending = roster.pending;
+               roster.pending = nil;
+       elseif not metadata.pending then
+               metadata.pending = {};
+       end
+       return metadata;
+end
+
 function load_roster(username, host)
        local jid = username.."@"..host;
-       log("debug", "load_roster: asked for: "..jid);
+       log("debug", "load_roster: asked for: %s", jid);
        local user = bare_sessions[jid];
        local roster;
        if user then
                roster = user.roster;
                if roster then return roster; end
-               log("debug", "load_roster: loading for new user: "..username.."@"..host);
+               log("debug", "load_roster: loading for new user: %s@%s", username, host);
        else -- Attempt to load roster for non-loaded user
-               log("debug", "load_roster: loading for offline user: "..username.."@"..host);
+               log("debug", "load_roster: loading for offline user: %s@%s", username, host);
        end
        local data, err = datamanager.load(username, host, "roster");
        roster = data or {};
        if user then user.roster = roster; end
-       if not roster[false] then roster[false] = { broken = err or nil }; end
+       roster_metadata(roster, err);
        if roster[jid] then
                roster[jid] = nil;
-               log("warn", "roster for "..jid.." has a self-contact");
+               log("warn", "roster for %s has a self-contact", jid);
        end
        if not err then
-               hosts[host].events.fire_event("roster-load", username, host, roster);
+               hosts[host].events.fire_event("roster-load", { username = username, host = host, roster = roster });
        end
        return roster, err;
 end
 
 function save_roster(username, host, roster)
-       log("debug", "save_roster: saving roster for "..username.."@"..host);
+       if not um_user_exists(username, host) then
+               log("debug", "not saving roster for %s@%s: the user doesn't exist", username, host);
+               return nil;
+       end
+
+       log("debug", "save_roster: saving roster for %s@%s", username, host);
        if not roster then
                roster = hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster;
                --if not roster then
@@ -117,15 +136,11 @@ function save_roster(username, host, roster)
                --end
        end
        if roster then
-               local metadata = roster[false];
-               if not metadata then
-                       metadata = {};
-                       roster[false] = metadata;
-               end
+               local metadata = roster_metadata(roster);
                if metadata.version ~= true then
                        metadata.version = (metadata.version or 0) + 1;
                end
-               if roster[false].broken then return nil, "Not saving broken roster" end
+               if metadata.broken then return nil, "Not saving broken roster" end
                return datamanager.store(username, host, "roster", roster);
        end
        log("warn", "save_roster: user had no roster to save");
@@ -173,7 +188,7 @@ function process_inbound_unsubscribe(username, host, jid)
        local item = roster[jid];
        local changed = nil;
        if is_contact_pending_in(username, host, jid) then
-               roster.pending[jid] = nil; -- TODO maybe delete roster.pending if empty?
+               roster[false].pending[jid] = nil;
                changed = true;
        end
        if item then
@@ -190,7 +205,19 @@ function process_inbound_unsubscribe(username, host, jid)
        end
 end
 
+local function _get_online_roster_subscription(jidA, jidB)
+       local user = bare_sessions[jidA];
+       local item = user and (user.roster[jidB] or { subscription = "none" });
+       return item and item.subscription;
+end
 function is_contact_subscribed(username, host, jid)
+       do
+               local selfjid = username.."@"..host;
+               local user_subscription = _get_online_roster_subscription(selfjid, jid);
+               if user_subscription then return (user_subscription == "both" or user_subscription == "from"); end
+               local contact_subscription = _get_online_roster_subscription(jid, selfjid);
+               if contact_subscription then return (contact_subscription == "both" or contact_subscription == "to"); end
+       end
        local roster, err = load_roster(username, host);
        local item = roster[jid];
        return item and (item.subscription == "from" or item.subscription == "both"), err;
@@ -198,16 +225,15 @@ end
 
 function is_contact_pending_in(username, host, jid)
        local roster = load_roster(username, host);
-       return roster.pending and roster.pending[jid];
+       return roster[false].pending[jid];
 end
-function set_contact_pending_in(username, host, jid, pending)
+function set_contact_pending_in(username, host, jid)
        local roster = load_roster(username, host);
        local item = roster[jid];
        if item and (item.subscription == "from" or item.subscription == "both") then
                return; -- false
        end
-       if not roster.pending then roster.pending = {}; end
-       roster.pending[jid] = true;
+       roster[false].pending[jid] = true;
        return save_roster(username, host, roster);
 end
 function is_contact_pending_out(username, host, jid)
@@ -226,7 +252,7 @@ function set_contact_pending_out(username, host, jid) -- subscribe
                roster[jid] = item;
        end
        item.ask = "subscribe";
-       log("debug", "set_contact_pending_out: saving roster; set "..username.."@"..host..".roster["..jid.."].ask=subscribe");
+       log("debug", "set_contact_pending_out: saving roster; set %s@%s.roster[%q].ask=subscribe", username, host, jid);
        return save_roster(username, host, roster);
 end
 function unsubscribe(username, host, jid)
@@ -257,8 +283,7 @@ function subscribed(username, host, jid)
                else -- subscription == to
                        item.subscription = "both";
                end
-               roster.pending[jid] = nil;
-               -- TODO maybe remove roster.pending if empty
+               roster[false].pending[jid] = nil;
                return save_roster(username, host, roster);
        end -- TODO else implement optional feature pre-approval (ask = subscribed)
 end
@@ -266,23 +291,21 @@ function unsubscribed(username, host, jid)
        local roster = load_roster(username, host);
        local item = roster[jid];
        local pending = is_contact_pending_in(username, host, jid);
-       local changed = nil;
-       if is_contact_pending_in(username, host, jid) then
-               roster.pending[jid] = nil; -- TODO maybe delete roster.pending if empty?
-               changed = true;
+       if pending then
+               roster[false].pending[jid] = nil;
        end
+       local subscribed;
        if item then
                if item.subscription == "from" then
                        item.subscription = "none";
-                       changed = true;
+                       subscribed = true;
                elseif item.subscription == "both" then
                        item.subscription = "to";
-                       changed = true;
+                       subscribed = true;
                end
        end
-       if changed then
-               return save_roster(username, host, roster);
-       end
+       local success = (pending or subscribed) and save_roster(username, host, roster);
+       return success, pending, subscribed;
 end
 
 function process_outbound_subscription_request(username, host, jid)