PresenceSubscribeHandler.java 18.2 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
Matt Tucker's avatar
Matt Tucker committed
6
 * Copyright (C) 2004 Jive Software. All rights reserved.
Matt Tucker's avatar
Matt Tucker committed
7
 *
Matt Tucker's avatar
Matt Tucker committed
8 9
 * This software is published under the terms of the GNU Public License (GPL),
 * a copy of which is included in this distribution.
Matt Tucker's avatar
Matt Tucker committed
10
 */
Matt Tucker's avatar
Matt Tucker committed
11

Matt Tucker's avatar
Matt Tucker committed
12 13 14 15 16 17 18
package org.jivesoftware.messenger.handler;

import org.jivesoftware.util.CacheManager;
import org.jivesoftware.messenger.container.BasicModule;
import org.jivesoftware.util.LocaleUtils;
import org.jivesoftware.util.Log;
import org.jivesoftware.messenger.*;
Matt Tucker's avatar
Matt Tucker committed
19 20
import org.jivesoftware.messenger.roster.Roster;
import org.jivesoftware.messenger.roster.RosterItem;
Matt Tucker's avatar
Matt Tucker committed
21 22
import org.jivesoftware.messenger.auth.UnauthorizedException;
import org.jivesoftware.messenger.user.*;
Matt Tucker's avatar
Matt Tucker committed
23 24 25
import org.xmpp.packet.Presence;
import org.xmpp.packet.Packet;
import org.xmpp.packet.JID;
26
import org.xmpp.packet.PacketError;
Matt Tucker's avatar
Matt Tucker committed
27

Matt Tucker's avatar
Matt Tucker committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
import java.util.Hashtable;
import java.util.Map;

/**
 * Implements the presence protocol. Clients use this protocol to
 * update presence and roster information.
 * <p/>
 * The handler must properly detect the presence type, update the user's roster,
 * and inform presence subscribers of the session's updated presence
 * status. Presence serves many purposes in Jabber so this handler will
 * likely be the most complex of all handlers in the server.
 * <p/>
 * There are four basic types of presence updates:
 * <ul>
 * <li>Simple presence updates - addressed to the server (or to address), these updates
 * are properly addressed by the server, and multicast to
 * interested subscribers on the user's roster. An empty, missing,
 * or "unavailable" type attribute indicates a simple update (there
 * is no "available" type although it should be accepted by the server.
 * <li>Directed presence updates - addressed to particular jabber entities,
 * these presence updates are properly addressed and directly delivered
 * to the entity without broadcast to roster subscribers. Any update type
 * is possible except those reserved for subscription requests.
 * <li>Subscription requests - these updates request presence subscription
 * status changes. Such requests always affect the roster.  The server must:
 * <ul>
 * <li>update the roster with the proper subscriber info
 * <li>push the roster changes to the user
 * <li>forward the update to the correct parties.
 * </ul>
 * The valid types include "subscribe", "subscribed", "unsubscribed",
 * and "unsubscribe".
60
 * <li>XMPPServer probes - Provides a mechanism for servers to query the presence
Matt Tucker's avatar
Matt Tucker committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
 * status of users on another server. This allows users to immediately
 * know the presence status of users when they come online rather than way
 * for a presence update broadcast from the other server or tracking them
 * as they are received.  Requires S2S capabilities.
 * </ul>
 * <p/>
 * <h2>Warning</h2>
 * There should be a way of determining whether a session has
 * authorization to access this feature. I'm not sure it is a good
 * idea to do authorization in each handler. It would be nice if
 * the framework could assert authorization policies across channels.
 *
 * @author Iain Shigeoka
 */
public class PresenceSubscribeHandler extends BasicModule implements ChannelHandler {

77 78 79 80
    private RoutingTable routingTable;
    private XMPPServer localServer;
    private PacketDeliverer deliverer;

Matt Tucker's avatar
Matt Tucker committed
81 82 83 84
    public PresenceSubscribeHandler() {
        super("Presence subscription handler");
    }

Matt Tucker's avatar
Matt Tucker committed
85
    public void process(Packet xmppPacket) throws UnauthorizedException, PacketException {
Matt Tucker's avatar
Matt Tucker committed
86 87
        Presence presence = (Presence)xmppPacket;
        try {
Matt Tucker's avatar
Matt Tucker committed
88 89 90
            JID senderJID = presence.getFrom();
            JID recipientJID = presence.getTo();
            Presence.Type type = presence.getType();
Matt Tucker's avatar
Matt Tucker committed
91
            Roster roster = getRoster(senderJID);
92
            try {
93 94 95 96 97 98 99
                if (roster != null) {
                    manageSub(recipientJID, true, type, roster);
                }
                roster = getRoster(recipientJID);
                if (roster != null) {
                    manageSub(senderJID, false, type, roster);
                }
100 101 102 103 104
                // Try to obtain a handler for the packet based on the routes. If the handler is
                // a module, the module will be able to handle the packet. If the handler is a
                // Session the packet will be routed to the client. If a route cannot be found
                // then the packet will be delivered based on its recipient and sender.
                ChannelHandler handler = routingTable.getRoute(recipientJID);
Matt Tucker's avatar
Matt Tucker committed
105
                handler.process(presence.createCopy());
Matt Tucker's avatar
Matt Tucker committed
106
            }
107
            catch (NoSuchRouteException e) {
Matt Tucker's avatar
Matt Tucker committed
108
                deliverer.deliver(presence.createCopy());
Matt Tucker's avatar
Matt Tucker committed
109
            }
110 111 112 113 114 115 116 117
            catch (SharedGroupException e) {
                Presence result = presence.createCopy();
                JID sender = result.getFrom();
                result.setFrom(presence.getTo());
                result.setTo(sender);
                result.setError(PacketError.Condition.not_acceptable);
                deliverer.deliver(result);
            }
Matt Tucker's avatar
Matt Tucker committed
118 119 120 121 122 123 124 125 126 127 128 129
        }
        catch (Exception e) {
            Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
        }
    }

    /**
     * <p>Obtain the roster for the given address or null if the address doesn't have a roster.</p>
     *
     * @param address The address to check
     * @return The roster or null if the address is not managed on the server
     */
Matt Tucker's avatar
Matt Tucker committed
130
    private Roster getRoster(JID address) {
131
        String username = null;
Matt Tucker's avatar
Matt Tucker committed
132
        Roster roster = null;
Matt Tucker's avatar
Matt Tucker committed
133 134
        if (localServer.isLocal(address) && !"".equals(address.getNode())) {
            username = address.getNode();
135 136 137
            // Check for a cached roster:
            roster = (Roster)CacheManager.getCache("username2roster").get(username);
            if (roster == null) {
138 139 140 141 142 143 144 145
                synchronized(address.toString().intern()) {
                    roster = (Roster)CacheManager.getCache("username2roster").get(username);
                    if (roster == null) {
                        // Not in cache so load a new one:
                        roster = new Roster(username);
                        CacheManager.getCache("username2roster").put(username, roster);
                    }
                }
Matt Tucker's avatar
Matt Tucker committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159
            }
        }
        return roster;
    }

    /**
     * Manage the subscription request. This method retrieves a user's roster
     * and updates it's state, storing any changes made, and updating the roster
     * owner if changes occured.
     *
     * @param target    The roster target's jid (the item's jid to be changed)
     * @param isSending True if the request is being sent by the owner
     * @param type      The subscription change type (subscribe, unsubscribe, etc.)
     */
160 161
    private void manageSub(JID target, boolean isSending, Presence.Type type, Roster roster)
            throws UserAlreadyExistsException, SharedGroupException
162
    {
Matt Tucker's avatar
Matt Tucker committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
        try {
            RosterItem item;
            if (roster.isRosterItem(target)) {
                item = roster.getRosterItem(target);
            }
            else {
                item = roster.createRosterItem(target);
            }
            updateState(item, type, isSending);
            roster.updateRosterItem(item);
        }
        catch (UserNotFoundException e) {
            // Should be there because we just checked that it's an item
            Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
        }
    }

    /**
     * <p>The transition state table.</p>
     * <p>The root 'old state' transition table is a Map of RosterItem.SubType keys to match
     * to the old state of the item. Each key returns a Map containing the next
     * transition table. Transitions are defined as:</p>
     * <ul>
     * <li>'send/receive' table: Lookup whether this updates was sent or received: obtain 'action' table - key: Presence.Type subcribe action, value: Map (transition table).</li>
     * <li>'new state' table: the changed item values</li>
     * </ul>
     */
    private static Hashtable stateTable = new Hashtable();

    static {
        Hashtable subrTable;
        Hashtable subsTable;
        Hashtable sr;

        sr = new Hashtable();
        subrTable = new Hashtable();
        subsTable = new Hashtable();
        sr.put("recv", subrTable);
        sr.put("send", subsTable);
        stateTable.put(RosterItem.SUB_NONE, sr);
        // Item wishes to subscribe from owner
        // Set flag and update roster if this is a new state, this is the normal way to begin
        // a roster subscription negotiation.
Matt Tucker's avatar
Matt Tucker committed
206
        subrTable.put(Presence.Type.subscribe, new Change(RosterItem.RECV_SUBSCRIBE, null, null)); // no transition
Matt Tucker's avatar
Matt Tucker committed
207 208
        // Item granted subscription to owner
        // The item's state immediately goes from NONE to TO and ask is reset
Matt Tucker's avatar
Matt Tucker committed
209
        subrTable.put(Presence.Type.subscribed, new Change(null, RosterItem.SUB_TO, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
210 211
        // Item wishes to unsubscribe from owner
        // This makes no sense, there is no subscription to remove
Matt Tucker's avatar
Matt Tucker committed
212
        subrTable.put(Presence.Type.unsubscribe, new Change(null, null, null));
Matt Tucker's avatar
Matt Tucker committed
213 214
        // Owner has subscription to item revoked
        // Valid response if item requested subscription and we're denying request
Matt Tucker's avatar
Matt Tucker committed
215
        subrTable.put(Presence.Type.unsubscribed, new Change(null, null, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
216 217
        // Owner asking to subscribe to item this is the normal way to begin
        // a roster subscription negotiation.
Matt Tucker's avatar
Matt Tucker committed
218
        subsTable.put(Presence.Type.subscribe, new Change(null, null, RosterItem.ASK_SUBSCRIBE));
Matt Tucker's avatar
Matt Tucker committed
219
        // Item granted a subscription from owner
Matt Tucker's avatar
Matt Tucker committed
220
        subsTable.put(Presence.Type.subscribed, new Change(RosterItem.RECV_NONE, RosterItem.SUB_FROM, null));
Matt Tucker's avatar
Matt Tucker committed
221 222
        // Owner asking to unsubscribe to item
        // This makes no sense (there is no subscription to unsubscribe from)
Matt Tucker's avatar
Matt Tucker committed
223
        subsTable.put(Presence.Type.unsubscribe, new Change(null, null, null));
Matt Tucker's avatar
Matt Tucker committed
224 225
        // Item has subscription from owner revoked
        // Valid response if item requested subscription and we're denying request
Matt Tucker's avatar
Matt Tucker committed
226
        subsTable.put(Presence.Type.unsubscribed, new Change(RosterItem.RECV_NONE, null, null));
Matt Tucker's avatar
Matt Tucker committed
227 228 229 230 231 232 233 234 235 236

        sr = new Hashtable();
        subrTable = new Hashtable();
        subsTable = new Hashtable();
        sr.put("recv", subrTable);
        sr.put("send", subsTable);
        stateTable.put(RosterItem.SUB_FROM, sr);
        // Owner asking to subscribe to item
        // Set flag and update roster if this is a new state, this is the normal way to begin
        // a mutual roster subscription negotiation.
Matt Tucker's avatar
Matt Tucker committed
237
        subsTable.put(Presence.Type.subscribe, new Change(null, null, RosterItem.ASK_SUBSCRIBE));
Matt Tucker's avatar
Matt Tucker committed
238 239 240
        // Item granted a subscription from owner
        // This may be necessary if the recipient didn't get an earlier subscribed grant
        // or as a denial of an unsubscribe request
Matt Tucker's avatar
Matt Tucker committed
241
        subsTable.put(Presence.Type.subscribed, new Change(RosterItem.RECV_NONE, null, null));
Matt Tucker's avatar
Matt Tucker committed
242 243
        // Owner asking to unsubscribe to item
        // This makes no sense (there is no subscription to unsubscribe from)
Matt Tucker's avatar
Matt Tucker committed
244
        subsTable.put(Presence.Type.unsubscribe, new Change(null, null, null));
Matt Tucker's avatar
Matt Tucker committed
245 246
        // Item has subscription from owner revoked
        // Immediately transition to NONE state
Matt Tucker's avatar
Matt Tucker committed
247
        subsTable.put(Presence.Type.unsubscribed, new Change(RosterItem.RECV_NONE, RosterItem.SUB_NONE, null));
Matt Tucker's avatar
Matt Tucker committed
248 249 250 251
        // Item wishes to subscribe from owner
        // Item already has a subscription so only interesting if item had requested unsubscribe
        // Set flag and update roster if this is a new state, this is the normal way to begin
        // a mutual roster subscription negotiation.
Matt Tucker's avatar
Matt Tucker committed
252
        subrTable.put(Presence.Type.subscribe, new Change(RosterItem.RECV_NONE, null, null));
Matt Tucker's avatar
Matt Tucker committed
253 254
        // Item granted subscription to owner
        // The item's state immediately goes from FROM to BOTH and ask is reset
Matt Tucker's avatar
Matt Tucker committed
255
        subrTable.put(Presence.Type.subscribed, new Change(null, RosterItem.SUB_BOTH, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
256 257
        // Item wishes to unsubscribe from owner
        // This is the normal mechanism of removing subscription
Matt Tucker's avatar
Matt Tucker committed
258
        subrTable.put(Presence.Type.unsubscribe, new Change(RosterItem.RECV_UNSUBSCRIBE, null, null));
Matt Tucker's avatar
Matt Tucker committed
259 260
        // Owner has subscription to item revoked
        // Valid response if owner requested subscription and item is denying request
Matt Tucker's avatar
Matt Tucker committed
261
        subrTable.put(Presence.Type.unsubscribed, new Change(null, null, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
262 263 264 265 266 267 268 269 270

        sr = new Hashtable();
        subrTable = new Hashtable();
        subsTable = new Hashtable();
        sr.put("recv", subrTable);
        sr.put("send", subsTable);
        stateTable.put(RosterItem.SUB_TO, sr);
        // Owner asking to subscribe to item
        // We're already subscribed, may be trying to unset a unsub request
Matt Tucker's avatar
Matt Tucker committed
271
        subsTable.put(Presence.Type.subscribe, new Change(null, null, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
272 273
        // Item granted a subscription from owner
        // Sets mutual subscription
Matt Tucker's avatar
Matt Tucker committed
274
        subsTable.put(Presence.Type.subscribed, new Change(RosterItem.RECV_NONE, RosterItem.SUB_BOTH, null));
Matt Tucker's avatar
Matt Tucker committed
275 276
        // Owner asking to unsubscribe to item
        // Normal method of removing subscription
Matt Tucker's avatar
Matt Tucker committed
277
        subsTable.put(Presence.Type.unsubscribe, new Change(null, null, RosterItem.ASK_UNSUBSCRIBE));
Matt Tucker's avatar
Matt Tucker committed
278 279 280
        // Item has subscription from owner revoked
        // No subscription to unsub, makes sense if denying subscription request or for
        // situations where the original unsubscribed got lost
Matt Tucker's avatar
Matt Tucker committed
281
        subsTable.put(Presence.Type.unsubscribed, new Change(RosterItem.RECV_NONE, null, null));
Matt Tucker's avatar
Matt Tucker committed
282 283
        // Item wishes to subscribe from owner
        // This is the normal way to negotiate a mutual subscription
Matt Tucker's avatar
Matt Tucker committed
284
        subrTable.put(Presence.Type.subscribe, new Change(RosterItem.RECV_SUBSCRIBE, null, null));
Matt Tucker's avatar
Matt Tucker committed
285 286
        // Item granted subscription to owner
        // Owner already subscribed to item, could be a unsub denial or a lost packet
Matt Tucker's avatar
Matt Tucker committed
287
        subrTable.put(Presence.Type.subscribed, new Change(null, null, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
288 289
        // Item wishes to unsubscribe from owner
        // There is no subscription. May be trying to cancel earlier subscribe request.
Matt Tucker's avatar
Matt Tucker committed
290
        subrTable.put(Presence.Type.unsubscribe, new Change(RosterItem.RECV_NONE, null, null));
Matt Tucker's avatar
Matt Tucker committed
291 292
        // Owner has subscription to item revoked
        // Setting subscription to none
Matt Tucker's avatar
Matt Tucker committed
293
        subrTable.put(Presence.Type.unsubscribed, new Change(null, RosterItem.SUB_NONE, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
294 295 296 297 298 299 300 301 302

        sr = new Hashtable();
        subrTable = new Hashtable();
        subsTable = new Hashtable();
        sr.put("recv", subrTable);
        sr.put("send", subsTable);
        stateTable.put(RosterItem.SUB_BOTH, sr);
        // Owner asking to subscribe to item
        // Makes sense if trying to cancel previous unsub request
Matt Tucker's avatar
Matt Tucker committed
303
        subsTable.put(Presence.Type.subscribe, new Change(null, null, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
304 305 306
        // Item granted a subscription from owner
        // This may be necessary if the recipient didn't get an earlier subscribed grant
        // or as a denial of an unsubscribe request
Matt Tucker's avatar
Matt Tucker committed
307
        subsTable.put(Presence.Type.subscribed, new Change(RosterItem.RECV_NONE, null, null));
Matt Tucker's avatar
Matt Tucker committed
308 309
        // Owner asking to unsubscribe to item
        // Set flags
Matt Tucker's avatar
Matt Tucker committed
310
        subsTable.put(Presence.Type.unsubscribe, new Change(null, null, RosterItem.ASK_UNSUBSCRIBE));
Matt Tucker's avatar
Matt Tucker committed
311 312
        // Item has subscription from owner revoked
        // Immediately transition them to TO state
Matt Tucker's avatar
Matt Tucker committed
313
        subsTable.put(Presence.Type.unsubscribed, new Change(RosterItem.RECV_NONE, RosterItem.SUB_TO, null));
Matt Tucker's avatar
Matt Tucker committed
314 315 316 317
        // Item wishes to subscribe to owner
        // Item already has a subscription so only interesting if item had requested unsubscribe
        // Set flag and update roster if this is a new state, this is the normal way to begin
        // a mutual roster subscription negotiation.
Matt Tucker's avatar
Matt Tucker committed
318
        subrTable.put(Presence.Type.subscribe, new Change(RosterItem.RECV_NONE, null, null));
Matt Tucker's avatar
Matt Tucker committed
319 320
        // Item granted subscription to owner
        // Redundant unless denying unsub request
Matt Tucker's avatar
Matt Tucker committed
321
        subrTable.put(Presence.Type.subscribed, new Change(null, null, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
322 323
        // Item wishes to unsubscribe from owner
        // This is the normal mechanism of removing subscription
Matt Tucker's avatar
Matt Tucker committed
324
        subrTable.put(Presence.Type.unsubscribe, new Change(RosterItem.RECV_UNSUBSCRIBE, null, null));
Matt Tucker's avatar
Matt Tucker committed
325 326
        // Owner has subscription to item revoked
        // Immediately downgrade state to FROM
Matt Tucker's avatar
Matt Tucker committed
327
        subrTable.put(Presence.Type.unsubscribed, new Change(RosterItem.RECV_NONE, RosterItem.SUB_FROM, RosterItem.ASK_NONE));
Matt Tucker's avatar
Matt Tucker committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
    }

    /**
     * <p>Indicate a state change.</p>
     * <p>Use nulls to indicate fields that should not be changed.</p>
     */
    private static class Change {
        public Change(RosterItem.RecvType recv, RosterItem.SubType sub, RosterItem.AskType ask) {
            newRecv = recv;
            newSub = sub;
            newAsk = ask;
        }

        public RosterItem.RecvType newRecv;
        public RosterItem.SubType newSub;
        public RosterItem.AskType newAsk;
    }

    /**
     * Determine and call the update method based on the item's subscription state.
     * The method also turns the action and sending status into an integer code
     * for easier processing (switch statements).
     * <p/>
     * Code relies on states being in numerical order without skipping.
     * In addition, the receive states must parallel the send states
     * so that (send state X) + STATE_RECV_SUBSCRIBE == (receive state X)
     * where X is subscribe, subscribed, etc.
     * </p>
     *
     * @param item      The item to be updated
     * @param action    The new state change request
     * @param isSending True if the roster owner of the item is sending the new state change request
     */
361
    private static void updateState(RosterItem item, Presence.Type action, boolean isSending) {
Matt Tucker's avatar
Matt Tucker committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375
        Map srTable = (Map)stateTable.get(item.getSubStatus());
        Map changeTable = (Map)srTable.get(isSending ? "send" : "recv");
        Change change = (Change)changeTable.get(action);
        if (change.newAsk != null) {
            item.setAskStatus(change.newAsk);
        }
        if (change.newSub != null) {
            item.setSubStatus(change.newSub);
        }
        if (change.newRecv != null) {
            item.setRecvStatus(change.newRecv);
        }
    }

376 377 378 379 380
    public void initialize(XMPPServer server) {
        super.initialize(server);
        localServer = server;
        routingTable = server.getRoutingTable();
        deliverer = server.getPacketDeliverer();
Matt Tucker's avatar
Matt Tucker committed
381 382
    }
}