IQDiscoItemsHandler.java 12.1 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
package org.jivesoftware.messenger.disco;

14 15
import java.util.*;

Matt Tucker's avatar
Matt Tucker committed
16 17
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
18
import org.dom4j.QName;
Derek DeMoro's avatar
Derek DeMoro committed
19 20
import org.jivesoftware.messenger.IQHandlerInfo;
import org.jivesoftware.messenger.XMPPServer;
21 22 23 24 25 26
import org.jivesoftware.messenger.SessionManager;
import org.jivesoftware.messenger.Session;
import org.jivesoftware.messenger.roster.RosterItem;
import org.jivesoftware.messenger.user.UserManager;
import org.jivesoftware.messenger.user.User;
import org.jivesoftware.messenger.user.UserNotFoundException;
27
import org.jivesoftware.messenger.handler.IQHandler;
Derek DeMoro's avatar
Derek DeMoro committed
28 29 30 31
import org.jivesoftware.messenger.auth.UnauthorizedException;
import org.xmpp.packet.IQ;
import org.xmpp.packet.JID;
import org.xmpp.packet.PacketError;
Matt Tucker's avatar
Matt Tucker committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

/**
 * IQDiscoItemsHandler is responsible for handling disco#items requests. This class holds a map with
 * the main entities and the associated DiscoItemsProvider. We are considering the host of the
 * recipient JIDs as main entities. It's the DiscoItemsProvider responsibility to provide the items
 * associated with the JID's name together with any possible requested node.<p>
 * <p/>
 * For example, let's have in the entities map the following entries: "localhost" and
 * "conference.localhost". Associated with each entry we have different DiscoItemsProvider. Now we
 * receive a disco#items request for the following JID: "room@conference.localhost" which is a disco
 * request for a MUC room. So IQDiscoItemsHandler will look for the DiscoItemsProvider associated
 * with the JID's host which in this case is "conference.localhost". Once we have located the
 * provider we will delegate to the provider the responsibility to provide the items specific to
 * the JID's name which in this case is "room". Depending on the implementation, the items could be
 * the list of existing occupants if that information is publicly available. Finally, after we have
 * collected all the items provided by the provider we will add them to the reply. On the other
 * hand, if no provider was found or the provider has no information for the requested name/node
 * then a not-found error will be returned.<p>
 * <p/>
 * Publishing of client items is still not supported.
 *
 * @author Gaston Dombiak
 */
55
public class IQDiscoItemsHandler extends IQHandler implements ServerFeaturesProvider {
Matt Tucker's avatar
Matt Tucker committed
56 57

    private HashMap entities = new HashMap();
58
    private List<Element> serverItems = new ArrayList<Element>();
Matt Tucker's avatar
Matt Tucker committed
59
    private IQHandlerInfo info;
60
    private IQDiscoInfoHandler infoHandler;
Matt Tucker's avatar
Matt Tucker committed
61 62 63

    public IQDiscoItemsHandler() {
        super("XMPP Disco Items Handler");
64
        info = new IQHandlerInfo("query", "http://jabber.org/protocol/disco#items");
Matt Tucker's avatar
Matt Tucker committed
65 66 67 68 69 70
    }

    public IQHandlerInfo getInfo() {
        return info;
    }

Derek DeMoro's avatar
Derek DeMoro committed
71
    public IQ handleIQ(IQ packet) throws UnauthorizedException {
Matt Tucker's avatar
Matt Tucker committed
72 73 74 75 76
        // TODO Let configure an authorization policy (ACL?). Currently anyone can discover items.
        
        // Create a copy of the sent pack that will be used as the reply
        // we only need to add the requested items to the reply if any otherwise add 
        // a not found error
Derek DeMoro's avatar
Derek DeMoro committed
77
        IQ reply = IQ.createResultIQ(packet);
Matt Tucker's avatar
Matt Tucker committed
78 79
        
        // TODO Implement publishing client items
Derek DeMoro's avatar
Derek DeMoro committed
80
        if (IQ.Type.set == packet.getType()) {
81
            reply.setChildElement(packet.getChildElement().createCopy());
Derek DeMoro's avatar
Derek DeMoro committed
82
            reply.setError(PacketError.Condition.feature_not_implemented);
Matt Tucker's avatar
Matt Tucker committed
83 84 85 86 87 88 89
            return reply;
        }

        // Look for a DiscoItemsProvider associated with the requested entity.
        // We consider the host of the recipient JID of the packet as the entity. It's the 
        // DiscoItemsProvider responsibility to provide the items associated with the JID's name  
        // together with any possible requested node.  
90
        DiscoItemsProvider itemsProvider = getProvider(packet.getTo() == null ?
91
                XMPPServer.getInstance().getServerInfo().getName() : packet.getTo().getDomain());
Matt Tucker's avatar
Matt Tucker committed
92 93
        if (itemsProvider != null) {
            // Get the JID's name
94
            String name = packet.getTo() == null ? null : packet.getTo().getNode();
Matt Tucker's avatar
Matt Tucker committed
95 96 97 98
            if (name == null || name.trim().length() == 0) {
                name = null;
            }
            // Get the requested node
Derek DeMoro's avatar
Derek DeMoro committed
99 100
            Element iq = packet.getChildElement();
            String node = iq.attributeValue("node");
101

Matt Tucker's avatar
Matt Tucker committed
102
            // Check if we have items associated with the requested name and node
103
            Iterator<Element> itemsItr = itemsProvider.getItems(name, node, packet.getFrom());
Matt Tucker's avatar
Matt Tucker committed
104
            if (itemsItr != null) {
105
                reply.setChildElement(iq.createCopy());
Derek DeMoro's avatar
Derek DeMoro committed
106
                Element queryElement = reply.getChildElement();
Matt Tucker's avatar
Matt Tucker committed
107 108 109 110

                // Add to the reply all the items provided by the DiscoItemsProvider
                Element item;
                while (itemsItr.hasNext()) {
111 112 113
                    item = itemsItr.next();
                    item.setQName(new QName(item.getName(), queryElement.getNamespace()));
                    queryElement.add(item.createCopy());
Matt Tucker's avatar
Matt Tucker committed
114 115 116 117 118 119
                }
                ;
            }
            else {
                // If the DiscoItemsProvider has no items for the requested name and node 
                // then answer a not found error
120
                reply.setChildElement(packet.getChildElement().createCopy());
Derek DeMoro's avatar
Derek DeMoro committed
121
                reply.setError(PacketError.Condition.item_not_found);
Matt Tucker's avatar
Matt Tucker committed
122 123 124 125
            }
        }
        else {
            // If we didn't find a DiscoItemsProvider then answer a not found error
126 127
            reply.setChildElement(packet.getChildElement().createCopy());
            reply.setError(PacketError.Condition.item_not_found);
Matt Tucker's avatar
Matt Tucker committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
        }

        return reply;
    }

    /**
     * Returns the DiscoItemsProvider responsible for providing the items related to a given entity
     * or null if none was found.
     *
     * @param name the name of the identity.
     * @return the DiscoItemsProvider responsible for providing the items related to a given entity
     *         or null if none was found.
     */
    private DiscoItemsProvider getProvider(String name) {
        return (DiscoItemsProvider)entities.get(name);
    }

    /**
     * Sets that a given DiscoItemsProvider will provide the items related to a given entity. This
     * message must be used when new modules (e.g. MUC) are implemented and need to provide
     * the items related to them.
     *
     * @param name     the name of the entity.
     * @param provider the DiscoItemsProvider that will provide the entity's items.
     */
    protected void setProvider(String name, DiscoItemsProvider provider) {
        entities.put(name, provider);
    }

    /**
     * Removes the DiscoItemsProvider related to a given entity.
     *
     * @param name the name of the entity.
     */
    protected void removeProvider(String name) {
        entities.remove(name);
    }

    /**
     * Adds the items provided by the new service that implements the ServerItemsProvider
     * interface. This information will be used whenever a disco for items is made against
     * the server (i.e. the packet's target is the server).
     * Example of item is: &lt;item jid='conference.localhost' name='Public chatrooms'/&gt;
     *
     * @param provider the ServerItemsProvider that provides new server items.
     */
174
    private void addServerItemsProvider(ServerItemsProvider provider) {
Matt Tucker's avatar
Matt Tucker committed
175 176 177 178 179 180 181 182 183 184 185 186
        DiscoServerItem discoItem;
        for (Iterator it = provider.getItems(); it.hasNext();) {
            discoItem = (DiscoServerItem)it.next();
            // Create a new element based on the provided DiscoItem
            Element element = DocumentHelper.createElement("item");
            element.addAttribute("jid", discoItem.getJID());
            element.addAttribute("node", discoItem.getNode());
            element.addAttribute("name", discoItem.getName());
            // Add the element to the list of items related to the server
            serverItems.add(element);
            
            // Add the new item as a valid entity that could receive info and items disco requests
Matt Tucker's avatar
Matt Tucker committed
187
            String host = new JID(discoItem.getJID()).getDomain();
Matt Tucker's avatar
Matt Tucker committed
188 189 190 191 192
            infoHandler.setProvider(host, discoItem.getDiscoInfoProvider());
            setProvider(host, discoItem.getDiscoItemsProvider());
        }
    }

193 194 195 196 197 198 199 200
    /**
     * Registers a new disco item for a component. The jid attribute of the item will match the jid
     * of the component and the name should be the name of the component discovered using disco.
     *
     * @param jid the jid of the component.
     * @param name the discovered name of the component.
     */
    public void addComponentItem(String jid, String name) {
201 202 203 204
        // A component may send his disco#info many times and we only want to have one item
        // for the component so remove any element under the requested jid
        removeComponentItem(jid);

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
        // Create a new element based on the provided DiscoItem
        Element element = DocumentHelper.createElement("item");
        element.addAttribute("jid", jid);
        element.addAttribute("name", name);
        // Add the element to the list of items related to the server
        serverItems.add(element);
    }

    /**
     * Removes a disco item for a component that has been removed from the server.
     *
     * @param jid the jid of the component being removed.
     */
    public void removeComponentItem(String jid) {
        for (Iterator<Element> it = serverItems.iterator(); it.hasNext();) {
            if (jid.equals(it.next().attributeValue("jid"))) {
                it.remove();
            }
        }
    }

226 227
    public void initialize(XMPPServer server) {
        super.initialize(server);
Matt Tucker's avatar
Matt Tucker committed
228 229
        // Track the implementors of ServerItemsProvider so that we can collect the items
        // provided by the server
230
        infoHandler = server.getIQDiscoInfoHandler();
231 232 233 234 235
        setProvider(server.getServerInfo().getName(), getServerItemsProvider());
    }

    public void start() throws IllegalStateException {
        super.start();
236
        for (ServerItemsProvider provider : XMPPServer.getInstance().getServerItemsProviders()) {
237
            addServerItemsProvider(provider);
Matt Tucker's avatar
Matt Tucker committed
238 239 240 241 242 243 244 245 246 247 248 249 250
        }
    }

    public Iterator getFeatures() {
        ArrayList features = new ArrayList();
        features.add("http://jabber.org/protocol/disco#items");
        // TODO Comment out this line when publishing of client items is implemented
        //features.add("http://jabber.org/protocol/disco#publish");
        return features.iterator();
    }

    private DiscoItemsProvider getServerItemsProvider() {
        DiscoItemsProvider discoItemsProvider = new DiscoItemsProvider() {
Matt Tucker's avatar
Matt Tucker committed
251
            public Iterator<Element> getItems(String name, String node, JID senderJID) {
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
                if (name == null) {
                    return serverItems.iterator();
                }
                else {
                    List<Element> answer = new ArrayList<Element>();
                    try {
                        User user = UserManager.getInstance().getUser(name);
                        RosterItem item = user.getRoster().getRosterItem(senderJID);
                        // If the requesting entity is subscribed to the account's presence then
                        // answer the user's "available resources"
                        if (item.getSubStatus() == RosterItem.SUB_FROM ||
                                item.getSubStatus() == RosterItem.SUB_BOTH) {
                            for (Session session : SessionManager.getInstance().getSessions(name)) {
                                Element element = DocumentHelper.createElement("item");
                                element.addAttribute("jid", session.getAddress().toString());
                                answer.add(element);
                            }
                        }
                        return answer.iterator();
                    }
                    catch (UserNotFoundException e) {
                        return answer.iterator();
                    }
                }
Matt Tucker's avatar
Matt Tucker committed
276 277 278 279
            }
        };
        return discoItemsProvider;
    }
280
}