summaryrefslogtreecommitdiffstats
blob: 43b990de388127b5e7fd64e7bd8f2fe4ede21906 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
154
155
156
157
158
159
160
161
162
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
/*  Copyright (c) 2016, Isode Limited, London, England.
 *  All rights reserved.
 *
 *  Acquisition and use of this software and related materials for any
 *  purpose requires a written license agreement from Isode Limited,
 *  or a written license from an organisation licensed by Isode Limited
 *  to grant such a license.
 *
 */
package com.isode.stroke.network;

import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import com.isode.stroke.base.ByteArray;
import com.isode.stroke.base.Error;
import com.isode.stroke.base.SafeByteArray;
import com.isode.stroke.base.URL;
import com.isode.stroke.network.BOSHConnection.BOSHError.Type;
import com.isode.stroke.parser.BOSHBodyExtractor;
import com.isode.stroke.parser.BOSHBodyExtractor.BOSHBody;
import com.isode.stroke.parser.XMLParserFactory;
import com.isode.stroke.session.SessionStream.SessionStreamError;
import com.isode.stroke.signals.Signal1;
import com.isode.stroke.signals.Signal2;
import com.isode.stroke.signals.SignalConnection;
import com.isode.stroke.signals.Slot;
import com.isode.stroke.signals.Slot1;
import com.isode.stroke.signals.Slot2;
import com.isode.stroke.streamstack.DummyStreamLayer;
import com.isode.stroke.streamstack.HighLayer;
import com.isode.stroke.streamstack.TLSLayer;
import com.isode.stroke.tls.Certificate;
import com.isode.stroke.tls.CertificateVerificationError;
import com.isode.stroke.tls.CertificateWithKey;
import com.isode.stroke.tls.TLSContextFactory;
import com.isode.stroke.tls.TLSError;
import com.isode.stroke.tls.TLSOptions;

public class BOSHConnection {

    private final URL boshURL_;
    private Connector connector_;
    private final XMLParserFactory parserFactory_;
    private Connection connection_;
    private final HighLayer dummyLayer_;
    private final TLSLayer tlsLayer_;
    private String sid_ = "";
    private boolean waitingForStartResponse_ = false;
    private long rid_ = 0;
    private final SafeByteArray buffer_ = new SafeByteArray();
    private boolean pending_ = false;
    private boolean connectionReady_ = false;
    
    public final Signal1<Boolean> onConnectionFinished = new Signal1<Boolean>();
    public final Signal1<Boolean> onDisconnected = new Signal1<Boolean>();
    public final Signal1<BOSHError> onSessionTerminated = new Signal1<BOSHError>();
    public final Signal2<String, Integer> onSessionStarted = new Signal2<String, Integer>();
    public final Signal1<SafeByteArray> onXMPPDataRead = new Signal1<SafeByteArray>();
    public final Signal1<SafeByteArray> onBOSHDataRead = new Signal1<SafeByteArray>();
    public final Signal1<SafeByteArray> onBOSHDataWritten = new Signal1<SafeByteArray>();
    public final Signal1<String> onHTTPError = new Signal1<String>();
    
    private final Logger logger = Logger.getLogger(this.getClass().getName());
    private SignalConnection onConnectFinishedConnection;
    
    public static class BOSHError extends com.isode.stroke.session.SessionStream.SessionStreamError {
        
        public enum Type {
            BadRequest, HostGone, HostUnknown, ImproperAddressing,
            InternalServerError, ItemNotFound, OtherRequest, PolicyViolation,
            RemoteConnectionFailed,RemoteStreamError,SeeOtherURI,SystemShutdown,
            UndefinedCondition,NoError;
        }
        
        public BOSHError(Type type) {
            super(SessionStreamError.Type.ConnectionReadError);
            type_ = type;
        }
        
        public Type getType() {
            return type_;
        }
        
        private final Type type_;
        
    }
    
    public static class Pair<T1,T2> {
        public final T1 first;
        public final T2 second;
        
        public Pair(T1 first,T2 second) {
           this.first = first;
           this.second = second;
        }
    }
    
    private BOSHConnection(URL url,Connector connector,XMLParserFactory parserFactory,
            TLSContextFactory tlsContextFactory,TLSOptions tlsOptions) {
        boshURL_ = url;
        connector_ = connector;
        parserFactory_ = parserFactory;
        if ("https".equals(boshURL_.getScheme())) {
            tlsLayer_ = new TLSLayer(tlsContextFactory, tlsOptions);
            dummyLayer_ = new DummyStreamLayer(tlsLayer_);
        }
        else {
            tlsLayer_ = null;
            dummyLayer_ = null;
        }
    }
    
    public static BOSHConnection create(URL url,Connector connector,
            XMLParserFactory parserFactory,TLSContextFactory tlsContextFactory,TLSOptions tlsOptions) {
        return new BOSHConnection(url, connector, parserFactory, tlsContextFactory, tlsOptions);
    }
    
    public void connect() {
        onConnectFinishedConnection = connector_.onConnectFinished.connect(new Slot2<Connection, Error>() {
            
            @Override
            public void call(Connection connection, Error error) {
                handleConnectFinished(connection);
            }
            
        });
        connector_.start();
    }
    
    public void disconnect() {
        if (connection_ != null) {
            connection_.disconnect();
            sid_ = "";
        }
        else {
            handleDisconnected(null);
        }
    }
    
    public void write(SafeByteArray data) {
        write(data,false,false);
    }
    
    private void write(SafeByteArray data, boolean streamRestart, boolean terminate) {
        assert(connectionReady_);
        assert(!sid_.isEmpty());

        SafeByteArray safeHeader =
                createHTTPRequest(data, streamRestart, terminate, rid_, sid_, boshURL_).first;

        onBOSHDataWritten.emit(safeHeader);
        writeData(safeHeader);
        pending_ = true;

        String logMessage = "write data: " + safeHeader.toString() + "\n";
        logger.log(Level.FINE,logMessage);
    }

    public String getSID() {
        return sid_;
    }
    
    public void setRID(long rid) {
        rid_ = rid;
    }
    
    public void setSID(String sid) {
        sid_ = sid;
    }
    
    public void startStream(String to,long rid) {
        assert(connectionReady_);
        
        String content = "<body content='text/xml; charset=utf-8'"
                + " hold='1'"
                + " to='" + to + "'"
                + " rid='" + rid + "'"
                + " ver='1.6'"
                + " wait='60'" 
                + " xml:lang='en'"
                + " xmlns:xmpp='urn:xmpp:bosh'"
                + " xmpp:version='1.0'"
                + " xmlns='http://jabber.org/protocol/httpbind' />";

        StringBuilder headerBuilder = new StringBuilder("POST " + boshURL_.getPath() + " HTTP/1.1\r\n"
                + "Host: " + boshURL_.getHost());
        Integer boshPort = boshURL_.getPort();
        if (boshPort != null) {
            headerBuilder.append(":");
            headerBuilder.append(boshPort);
        }
        headerBuilder.append("\r\n");
        headerBuilder.append("Accept-Encoding: deflate\r\n");
        headerBuilder.append("Content-Type: text/xml; charset=utf-8\r\n");
        headerBuilder.append("Content-Length: ");
        headerBuilder.append(content.length());
        headerBuilder.append("\r\n\r\n");
        headerBuilder.append(content);
        
        waitingForStartResponse_ = true;
        SafeByteArray safeHeader = new SafeByteArray(headerBuilder.toString());
        onBOSHDataWritten.emit(safeHeader);
        writeData(safeHeader);
        logger.fine("write stream header: "+safeHeader.toString()+"\n");
    }
    
    public void terminateStream() {
        write(new SafeByteArray(),false,true);
    }
    
    public boolean isReadyToSend() {
        // Without pipelining you need to not send more without first receiving the response
        // With pipelining you can. Assuming we can't, here
        return connectionReady_ && !pending_ && !waitingForStartResponse_ && !sid_.isEmpty();
    }
    
    public void restartStream() {
        write(new SafeByteArray(),true,false);
    }
    
    public boolean setClientCertificate(CertificateWithKey cert) {
        if (tlsLayer_ != null) {
            logger.fine("set client certificate\n");
            return tlsLayer_.setClientCertificate(cert);
        }
        else {
            return false;
        }
    }
    
    public Certificate getPeerCertificate() {
        if (tlsLayer_ != null) {
            return tlsLayer_.getPeerCertificate();
        }
        return null;
    }
    
    public CertificateVerificationError getPeerCertificateVerficationError() {
        if (tlsLayer_ != null) {
            return tlsLayer_.getPeerCertificateVerificationError();
        }
        return null;
    }
    
    public List<Certificate> getPeerCertificateChain() {
        if (tlsLayer_ != null) {
            return tlsLayer_.getPeerCertificateChain();
        }
        return new ArrayList<Certificate>();
    }
    
    protected static Pair<SafeByteArray,Integer> createHTTPRequest(SafeByteArray data,
            boolean streamRestart,boolean terminate,long rid,String sid,URL boshURL) {
        int size = 0;
        StringBuilder contentBuilder = new StringBuilder();
        SafeByteArray contentTail = new SafeByteArray("</body>");
        StringBuilder headerBuilder = new StringBuilder();
        
        contentBuilder.append("<body rid='");
        contentBuilder.append(rid);
        contentBuilder.append("' sid='");
        contentBuilder.append(sid);
        contentBuilder.append("'");
        if (streamRestart) {
            contentBuilder.append(" xmpp:restart='true' xmlns:xmpp='urn:xmpp:xbosh'");
        }
        if (terminate) {
            contentBuilder.append(" type='terminate'");
        }
        contentBuilder.append(" xmlns='http://jabber.org/protocol/httpbind'>");
        
        SafeByteArray safeContent = new SafeByteArray(contentBuilder.toString());
        safeContent.append(data);
        safeContent.append(contentTail);
        
        size = safeContent.getSize();
        
        headerBuilder.append("POST " + boshURL.getPath() + " HTTP/1.1\r\n"
                + "Host: " + boshURL.getHost());
        Integer boshPort = boshURL.getPort();
        if (boshPort != null) {
            headerBuilder.append(":");
            headerBuilder.append(boshPort);
        }
        headerBuilder.append("\r\n");
        headerBuilder.append("Accept-Encoding: deflate\r\n");
        headerBuilder.append("Content-Type: text/xml; charset=utf-8\r\n");
        headerBuilder.append("Content-Length: ");
        headerBuilder.append(size);
        headerBuilder.append("\r\n\r\n");
        
        SafeByteArray safeHeader = new SafeByteArray(headerBuilder.toString());
        safeHeader.append(safeContent);
        
        return new Pair<SafeByteArray, Integer>(safeHeader, size);
    }
    
    private void handleConnectFinished(Connection connection) {
        cancelConnector();
        connectionReady_ = (connection != null);
        if (connectionReady_) {
            connection_ = connection;
            if (tlsLayer_ != null) {
                connection_.onDataRead.connect(new Slot1<SafeByteArray>() {

                    @Override
                    public void call(SafeByteArray data) {
                        handleRawDataRead(data);
                    }

                });
                connection_.onDisconnected.connect(new Slot1<Connection.Error>() {

                    @Override
                    public void call(
                            com.isode.stroke.network.Connection.Error error) {
                        handleDisconnected(error);
                    }

                });

                tlsLayer_.getContext().onDataForNetwork.connect(new Slot1<SafeByteArray>() {

                    @Override
                    public void call(SafeByteArray data) {
                        handleTLSNetworkDataWriteRequest(data);
                    }

                });
                tlsLayer_.getContext().onDataForApplication.connect(new Slot1<SafeByteArray>() {

                    @Override
                    public void call(SafeByteArray data) {
                        handleTLSApplicationDataRead(data);
                    }

                });

                tlsLayer_.onConnected.connect(new Slot() {

                    @Override
                    public void call() {
                        handleTLSConnected();
                    }

                });

                tlsLayer_.onError.connect(new Slot1<TLSError>() {

                    @Override
                    public void call(TLSError error) {
                        handleTLSError(error);
                    }

                });
                tlsLayer_.connect();
            }
            else {
                connection_.onDataRead.connect(new Slot1<SafeByteArray>() {

                    @Override
                    public void call(SafeByteArray data) {
                        handleDataRead(data);
                    }

                });
                connection_.onDisconnected.connect(new Slot1<Connection.Error>() {

                    @Override
                    public void call(Connection.Error error) {
                        handleDisconnected(error);
                    }

                });
            }

            if (!connectionReady_ || tlsLayer_ == null) {
                onConnectionFinished.emit(!connectionReady_);
            }
        }
    }
    
    private void handleDataRead(SafeByteArray data) {
        onBOSHDataRead.emit(data);
        buffer_.append(data);
        String response = buffer_.toString();
        if (!response.contains("\r\n\r\n")) {
            onBOSHDataRead.emit(new SafeByteArray("[[Previous read incomplete, pending]]"));
            return;
        }
        int httpCodeIndex = response.indexOf(" ")+1;
        String httpCode = response.substring(httpCodeIndex,httpCodeIndex+3);
        if (!"200".equals(httpCode)) {
            onHTTPError.emit(httpCode);
            return;
        }
        ByteArray boshData = new ByteArray(response.substring(response.indexOf("\r\n\r\n")));
        BOSHBodyExtractor parser = new BOSHBodyExtractor(parserFactory_, boshData);
        BOSHBody boshBody = parser.getBody();
        if (boshBody != null) {
            String typeAttribute = boshBody.getAttributes().getAttribute("type");
            if ( "terminate".equals(typeAttribute) ) {
                String conditionAttribute = boshBody.getAttributes().getAttribute("condition");
                BOSHError.Type errorType = parseTerminationCondition(conditionAttribute);
                onSessionTerminated.emit(errorType == BOSHError.Type.NoError ? null : new BOSHError(errorType));
            }
            buffer_.clear();
            if (waitingForStartResponse_) {
                waitingForStartResponse_ = false;
                sid_ = boshBody.getAttributes().getAttribute("sid");
                String requestsString = boshBody.getAttributes().getAttribute("requests");
                Integer requests = Integer.valueOf(2);
                if (requestsString != null && !requestsString.isEmpty()) {
                    try {
                        requests = Integer.valueOf(requestsString);
                    } catch (NumberFormatException e) {
                        requests = Integer.valueOf(2);
                    }
                }
                onSessionStarted.emit(sid_, requests);
            }
            
            SafeByteArray payload = new SafeByteArray(boshBody.getContent());
            /* Say we're good to go again, so don't add anything after here in the method */
            pending_ = false;
            onXMPPDataRead.emit(payload);
        }
    }
    
    private void handleDisconnected(Connection.Error error) {
        cancelConnector();
        onDisconnected.emit(error != null ? Boolean.TRUE : Boolean.FALSE);
        sid_ = "";
        connectionReady_ = false;
    }
    
    private Type parseTerminationCondition(String text) {
        Type condition = Type.UndefinedCondition;
        if ("bad-request".equals(text)) {
            condition = Type.BadRequest;
        }
        else if ("host-gone".equals(text)) {
            condition = Type.HostGone;
        }
        else if ("host-unknown".equals(text)) {
            condition = Type.HostUnknown;
        }
        else if ("improper-addressing".equals(text)) {
            condition = Type.ImproperAddressing;
        }
        else if ("internal-server-error".equals(text)) {
            condition = Type.InternalServerError;
        }
        else if ("item-not-found".equals(text)) {
            condition = Type.ItemNotFound;
        }
        else if ("other-request".equals(text)) {
            condition = Type.OtherRequest;
        }
        else if ("policy-violation".equals(text)) {
            condition = Type.PolicyViolation;
        }
        else if ("remote-connection-failed".equals(text)) {
            condition = Type.RemoteConnectionFailed;
        }
        else if ("remote-stream-error".equals(text)) {
            condition = Type.RemoteStreamError;
        }
        else if ("see-other-uri".equals(text)) {
            condition = Type.SeeOtherURI;
        }
        else if ("system-shutdown".equals(text)) {
            condition = Type.SystemShutdown;
        }
        else if ("".equals(text)) {
            condition = Type.NoError;
        }
        return condition;
    }
    
    private void cancelConnector() {
        if (connector_ != null) {
            if (onConnectFinishedConnection != null) {
                onConnectFinishedConnection.disconnect();
            }
            connector_.stop();
            connector_ = null;
        }
    }

    private void handleTLSConnected() {
        logger.fine("\n");
        onConnectionFinished.emit(Boolean.FALSE);
    }
    
    private void handleTLSApplicationDataRead(SafeByteArray data) {
        logger.fine("\n");
        handleDataRead(new SafeByteArray(data));
    }
    
    private void handleTLSNetworkDataWriteRequest(SafeByteArray data) {
        logger.fine("\n");
        connection_.write(data);
    }
    
    private void handleRawDataRead(SafeByteArray data) {
        logger.fine("\n");
        tlsLayer_.handleDataRead(data);
    }
    
    private void handleTLSError(TLSError error) {
        // Empty Method
    }

    private void writeData(SafeByteArray data) {
        if (tlsLayer_ != null) {
            tlsLayer_.writeData(data);
        }
        else {
            connection_.write(data);
        }
    }

}