IQvCardHandler.java 5.72 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 19 20 21 22 23
package org.jivesoftware.messenger.handler;

import org.jivesoftware.messenger.*;
import org.jivesoftware.messenger.auth.UnauthorizedException;
import org.jivesoftware.messenger.user.User;
import org.jivesoftware.messenger.user.UserManager;
import org.jivesoftware.messenger.user.UserNotFoundException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
24
import org.dom4j.QName;
Matt Tucker's avatar
Matt Tucker committed
25 26 27
import org.xmpp.packet.IQ;
import org.xmpp.packet.JID;
import org.xmpp.packet.PacketError;
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 60 61 62 63

/**
 * Implements the TYPE_IQ vcard-temp protocol. Clients
 * use this protocol to set and retrieve the vCard information
 * associated with someone's account.
 * <p/>
 * A 'get' query retrieves the vcard for the addressee.
 * A 'set' query sets the vcard information for the sender's account.
 * <p/>
 * Currently an empty implementation to allow usage with normal
 * clients. Future implementation needed.
 * <p/>
 * <h2>Assumptions</h2>
 * This handler assumes that the request is addressed to the server.
 * An appropriate TYPE_IQ tag matcher should be placed in front of this
 * one to route TYPE_IQ requests not addressed to the server to
 * another channel (probably for direct delivery to the recipient).
 * <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.
 * <p/>
 * <h2>Warning</h2>
 * I have noticed incompatibility between vCard XML used by Exodus and Psi.
 * There is a new vCard standard going through the JSF JEP process. We might
 * want to start either standardizing on clients (probably the most practical),
 * sending notices for non-conformance (useful),
 * or attempting to translate between client versions (not likely).
 *
 * @author Iain Shigeoka
 */
public class IQvCardHandler extends IQHandler {

    private IQHandlerInfo info;
64
    private UserManager userManager;
Matt Tucker's avatar
Matt Tucker committed
65 66 67

    public IQvCardHandler() {
        super("XMPP vCard Handler");
68
        info = new IQHandlerInfo("vcard", "vcard-temp");
Matt Tucker's avatar
Matt Tucker committed
69 70 71 72 73
    }

    public synchronized IQ handleIQ(IQ packet) throws UnauthorizedException, PacketException {
        IQ result = null;
        try {
Matt Tucker's avatar
Matt Tucker committed
74 75 76 77
            JID recipient = packet.getTo();
            IQ.Type type = packet.getType();
            if (type.equals(IQ.Type.set)) {
                User user = userManager.getUser(packet.getFrom().getNode());
Matt Tucker's avatar
Matt Tucker committed
78
                // Proper format
Matt Tucker's avatar
Matt Tucker committed
79
                Element vcard = packet.getChildElement();
Matt Tucker's avatar
Matt Tucker committed
80 81 82 83
                if (vcard != null) {
                    List nameStack = new ArrayList(5);
                    readVCard(vcard, nameStack, user);
                }
Matt Tucker's avatar
Matt Tucker committed
84
                result = IQ.createResultIQ(packet);
Matt Tucker's avatar
Matt Tucker committed
85
            }
Matt Tucker's avatar
Matt Tucker committed
86 87 88
            else if (type.equals(IQ.Type.get)) {
                User user = userManager.getUser(recipient.getNode());
                result = IQ.createResultIQ(packet);
Matt Tucker's avatar
Matt Tucker committed
89

90
                Element vcard = DocumentHelper.createElement(QName.get("VCARD", "vcard-temp"));
Matt Tucker's avatar
Matt Tucker committed
91
                result.setChildElement(vcard);
Matt Tucker's avatar
Matt Tucker committed
92 93 94 95 96 97 98 99 100 101

                Iterator names = user.getVCardPropertyNames();
                while (names.hasNext()) {
                    String name = (String)names.next();
                    String path = name.replace(':', '/');
                    Element node = DocumentHelper.makeElement(vcard, path);
                    node.setText(user.getVCardProperty(name));
                }
            }
            else {
Matt Tucker's avatar
Matt Tucker committed
102 103
                result = IQ.createResultIQ(packet);
                result.setError(PacketError.Condition.not_acceptable);
Matt Tucker's avatar
Matt Tucker committed
104 105 106
            }
        }
        catch (UserNotFoundException e) {
Matt Tucker's avatar
Matt Tucker committed
107 108
            result = IQ.createResultIQ(packet);
                result.setError(PacketError.Condition.item_not_found);
Matt Tucker's avatar
Matt Tucker committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 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
        }
        return result;
    }

    /**
     * We need to build names from heirarchical position in the DOM tree.
     *
     * @param element   The element to interrogate for text nodes
     * @param nameStack The current name of the vcard property (list as a stack)
     * @param user      the user getting their vcard set
     */
    private void readVCard(Element element, List nameStack, User user) throws UnauthorizedException {
        Iterator children = element.elementIterator();
        while (children.hasNext()) {
            Element child = (Element)children.next();
            nameStack.add(child.getName());
            String value = child.getTextTrim();
            if (value != null) {
                if (!"".equals(value)) {
                    user.setVCardProperty(createName(nameStack), value);
                }
            }
            readVCard(child, nameStack, user);
            nameStack.remove(nameStack.size() - 1);
        }
    }

    /**
     * Generate a name for the given name stack values
     *
     * @param nameStack
     * @return The name concatenating the values with the ':' character
     */
    private String createName(List nameStack) {
        StringBuffer buf = new StringBuffer();
        Iterator iter = nameStack.iterator();
        while (iter.hasNext()) {
            if (buf.length() > 0) {
                buf.append(':');
            }
            buf.append(iter.next());
        }
        return buf.toString();
    }

154 155 156
    public void initialize(XMPPServer server) {
        super.initialize(server);
        userManager = server.getUserManager();
Matt Tucker's avatar
Matt Tucker committed
157 158 159 160 161 162
    }

    public IQHandlerInfo getInfo() {
        return info;
    }
}