SocketReadThread.java 9.73 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
package org.jivesoftware.messenger.net;

import java.io.EOFException;
Derek DeMoro's avatar
Derek DeMoro committed
15
import java.io.IOException;
Matt Tucker's avatar
Matt Tucker committed
16
import java.io.InputStreamReader;
Derek DeMoro's avatar
Derek DeMoro committed
17
import java.io.Writer;
Matt Tucker's avatar
Matt Tucker committed
18
import java.net.Socket;
19 20
import java.net.SocketException;

Derek DeMoro's avatar
Derek DeMoro committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
import org.dom4j.Element;
import org.dom4j.io.XPPPacketReader;
import org.jivesoftware.messenger.Connection;
import org.jivesoftware.messenger.PacketRouter;
import org.jivesoftware.messenger.Session;
import org.jivesoftware.messenger.audit.Auditor;
import org.jivesoftware.messenger.auth.UnauthorizedException;
import org.jivesoftware.util.LocaleUtils;
import org.jivesoftware.util.Log;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
import org.xmlpull.v1.XmlPullParserFactory;
import org.xmpp.packet.IQ;
import org.xmpp.packet.Message;
import org.xmpp.packet.Presence;
Gaston Dombiak's avatar
Gaston Dombiak committed
36
import org.xmpp.packet.Roster;
Matt Tucker's avatar
Matt Tucker committed
37 38

/**
Matt Tucker's avatar
Matt Tucker committed
39 40
 * Reads XMPP XML from a socket.
 *
Derek DeMoro's avatar
Derek DeMoro committed
41
 * @author Derek DeMoro
Matt Tucker's avatar
Matt Tucker committed
42 43 44
 */
public class SocketReadThread extends Thread {

45 46 47
    /**
     * The utf-8 charset for decoding and encoding Jabber packet streams.
     */
Matt Tucker's avatar
Matt Tucker committed
48
    private static String CHARSET = "UTF-8";
Matt Tucker's avatar
Matt Tucker committed
49

Derek DeMoro's avatar
Derek DeMoro committed
50
    private static final String ETHERX_NAMESPACE = "http://etherx.jabber.org/streams";
Matt Tucker's avatar
Matt Tucker committed
51

Matt Tucker's avatar
Matt Tucker committed
52 53 54
    private Socket sock;
    private Session session;
    private Connection connection;
Matt Tucker's avatar
Matt Tucker committed
55 56 57 58 59 60 61 62 63 64
    private String serverName;
    /**
     * Router used to route incoming packets to the correct channels.
     */
    private PacketRouter router;
    /**
     * Audits incoming data
     */
    private Auditor auditor;
    private boolean clearSignout = false;
Derek DeMoro's avatar
Derek DeMoro committed
65 66 67
    XmlPullParserFactory factory = null;
    XPPPacketReader reader = null;

Matt Tucker's avatar
Matt Tucker committed
68 69 70 71 72 73 74 75 76
    /**
     * Create dedicated read thread for this socket.
     *
     * @param router     The router for sending packets that were read
     * @param serverName The name of the server this socket is working for
     * @param auditor    The audit manager that will audit incoming packets
     * @param sock       The socket to read from
     * @param session    The session being read
     */
Derek DeMoro's avatar
Derek DeMoro committed
77
    public SocketReadThread(PacketRouter router, String serverName, Auditor auditor, Socket sock,
Matt Tucker's avatar
Matt Tucker committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
                            Session session) {
        super("SRT reader");
        this.serverName = serverName;
        this.router = router;
        this.auditor = auditor;
        this.session = session;
        connection = session.getConnection();
        this.sock = sock;
    }

    /**
     * A dedicated thread loop for reading the stream and sending incoming
     * packets to the appropriate router.
     */
    public void run() {
        try {
Derek DeMoro's avatar
Derek DeMoro committed
94 95 96 97 98 99 100
            factory = XmlPullParserFactory.newInstance();
            // factory.setNamespaceAware(true);

            reader = new XPPPacketReader();
            reader.setXPPFactory(factory);

            reader.getXPPParser().setInput(new InputStreamReader(sock.getInputStream(),
Matt Tucker's avatar
Matt Tucker committed
101
                    CHARSET));
Matt Tucker's avatar
Matt Tucker committed
102 103 104 105 106 107 108 109 110 111 112 113 114

            // Read in the opening tag and prepare for packet stream
            createSession();

            // Read the packet stream until it ends
            if (session != null) {
                readStream();
            }

        }
        catch (EOFException eof) {
            // Normal disconnect
        }
115 116 117 118
        catch (SocketException se) {
            // The socket was closed. The server may close the connection for several reasons (e.g.
            // user requested to remove his account). Do nothing here. 
        }
Derek DeMoro's avatar
Derek DeMoro committed
119 120
        catch (XmlPullParserException ie) {
            // Check if the user abruptly cut the connection without sending previously an
Matt Tucker's avatar
Matt Tucker committed
121 122 123 124 125 126
            // unavailable presence
            if (clearSignout == false) {
                if (session != null && session.getStatus() == Session.STATUS_AUTHENTICATED) {
                    Presence presence = session.getPresence();
                    if (presence != null) {
                        // Simulate an unavailable presence sent by the user.
127 128 129
                        Presence packet = presence.createCopy();
                        packet.setType(Presence.Type.unavailable);
                        packet.setFrom(session.getAddress());
130
                        router.route(packet);
Matt Tucker's avatar
Matt Tucker committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
                        clearSignout = true;
                    }
                }
            }
            // It is normal for clients to abruptly cut a connection
            // rather than closing the stream document
            // Since this is normal behavior, we won't log it as an error
//            Log.error(LocaleUtils.getLocalizedString("admin.disconnect"),ie);
        }
        catch (Exception e) {
            if (session != null) {
                Log.warn(LocaleUtils.getLocalizedString("admin.error.stream"), e);
            }
        }
        finally {
            if (session != null) {
147
                Log.debug("Logging off " + session.getAddress() + " on " + connection);
Matt Tucker's avatar
Matt Tucker committed
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 174
                try {
                    // Allow everything to settle down after a disconnect
                    // e.g. presence updates to avoid sending double
                    // presence unavailable's
                    sleep(3000);
                    session.getConnection().close();
                }
                catch (Exception e) {
                    Log.warn(LocaleUtils.getLocalizedString("admin.error.connection")
                            + "\n" + sock.toString());
                }
            }
            else {
                Log.error(LocaleUtils.getLocalizedString("admin.error.connection")
                        + "\n" + sock.toString());
            }
        }
    }

    /**
     * Read the incoming stream until it ends. Much of the reading
     * will actually be done in the channel handlers as they run the
     * XPP through the data. This method mostly handles the idle waiting
     * for incoming data. To prevent clients from stalling channel handlers,
     * a watch dog timer is used. Packets that take longer than the watch
     * dog limit to read will cause the session to be closed.
     */
Derek DeMoro's avatar
Derek DeMoro committed
175
    private void readStream() throws Exception {
Matt Tucker's avatar
Matt Tucker committed
176
        while (true) {
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 206 207 208 209 210
            Element doc = reader.parseDocument().getRootElement();

            if (doc == null) {
                // Stop reading the stream since the client has sent an end of stream element and
                // probably closed the connection
                return;
            }

            String tag = doc.getName();
            if ("message".equals(tag)) {
                Message packet = new Message(doc);
                packet.setFrom(session.getAddress());
                auditor.audit(packet, session);
                router.route(packet);
                session.incrementClientPacketCount();
            }
            else if ("presence".equals(tag)) {
                Presence packet = new Presence(doc);
                packet.setFrom(session.getAddress());
                auditor.audit(packet, session);
                router.route(packet);
                session.incrementClientPacketCount();
                // Update the flag that indicates if the user made a clean sign out
                clearSignout = (Presence.Type.unavailable == packet.getType() ? true : false);
            }
            else if ("iq".equals(tag)) {
                IQ packet = getIQ(doc);
                packet.setFrom(session.getAddress());
                auditor.audit(packet, session);
                router.route(packet);
                session.incrementClientPacketCount();
            }
            else {
                throw new XmlPullParserException(LocaleUtils.getLocalizedString("admin.error.packet.tag") + tag);
Matt Tucker's avatar
Matt Tucker committed
211 212 213 214
            }
        }
    }

Gaston Dombiak's avatar
Gaston Dombiak committed
215 216 217 218 219 220 221 222 223 224
    private IQ getIQ(Element doc) {
        Element query = doc.element("query");
        if (query != null && "jabber:iq:roster".equals(query.getNamespaceURI())) {
            return new Roster(doc);
        }
        else {
            return new IQ(doc);
        }
    }

Matt Tucker's avatar
Matt Tucker committed
225 226 227 228 229 230 231 232 233 234 235 236
    /**
     * Uses the XPP to grab the opening stream tag and create
     * an active session object. In all cases, the method obtains the
     * opening stream tag, checks for errors, and either creates a session
     * or returns an error and kills the connection. If the connection
     * remains open, the XPP will be set to be ready for the first packet.
     * A call to next() should result in an START_TAG state with the first
     * packet in the stream.
     *
     * @throws UnauthorizedException If the caller did not have permission
     *                               to use this method.
     */
Derek DeMoro's avatar
Derek DeMoro committed
237 238
    private void createSession() throws UnauthorizedException, XmlPullParserException, IOException, Exception {
        XmlPullParser xpp = reader.getXPPParser();
Matt Tucker's avatar
Matt Tucker committed
239
        for (int eventType = xpp.getEventType();
Derek DeMoro's avatar
Derek DeMoro committed
240
             eventType != XmlPullParser.START_TAG;
Matt Tucker's avatar
Matt Tucker committed
241 242 243 244 245
             eventType = xpp.next()) {
        }

        // Conduct error checking, the opening tag should be 'stream'
        // in the 'etherx' namespace
Derek DeMoro's avatar
Derek DeMoro committed
246 247
        if (!xpp.getName().equals("stream")) {
            throw new XmlPullParserException(LocaleUtils.getLocalizedString("admin.error.bad-stream"));
Matt Tucker's avatar
Matt Tucker committed
248
        }
Derek DeMoro's avatar
Derek DeMoro committed
249 250
        if (!xpp.getNamespace(xpp.getPrefix()).equals(ETHERX_NAMESPACE)) {
            throw new XmlPullParserException(LocaleUtils.getLocalizedString("admin.error.bad-namespace"));
Matt Tucker's avatar
Matt Tucker committed
251 252
        }

Derek DeMoro's avatar
Derek DeMoro committed
253
        Writer writer = connection.getWriter();
Matt Tucker's avatar
Matt Tucker committed
254
        String startPacket = "<?xml version='1.0' encoding='"+CHARSET+"'?><stream:stream xmlns:stream=\"http://etherx.jabber.org/streams\" xmlns=\"jabber:client\" from=\""+serverName+"\" id=\""+session.getStreamID().toString()+"\">";
Derek DeMoro's avatar
Derek DeMoro committed
255 256
        writer.write(startPacket);
        writer.flush();
Matt Tucker's avatar
Matt Tucker committed
257 258
        // TODO: check for SASL support in opening stream tag
    }
Derek DeMoro's avatar
Derek DeMoro committed
259 260


Matt Tucker's avatar
Matt Tucker committed
261
}