summaryrefslogtreecommitdiffstats
blob: f7f9c703d5bbc860eb9a90b6641079d7c1386c4d (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
/*
 * Copyright (c) 2010-2016 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */
/*
 * Copyright (c) 2015 Tarun Gupta.
 * Licensed under the simplified BSD license.
 * See Documentation/Licenses/BSD-simplified.txt for more information.
 */

package com.isode.stroke.filetransfer;

import com.isode.stroke.jid.JID;
import com.isode.stroke.jingle.JingleSession;
import com.isode.stroke.network.TimerFactory;
import com.isode.stroke.network.Timer;
import com.isode.stroke.crypto.CryptoProvider;
import com.isode.stroke.base.IDGenerator;
import com.isode.stroke.base. ByteArray;
import com.isode.stroke.elements.JingleFileTransferFileInfo;
import com.isode.stroke.elements.JingleDescription;
import com.isode.stroke.elements.JingleTransportPayload;
import com.isode.stroke.elements.JingleIBBTransportPayload;
import com.isode.stroke.elements.JingleS5BTransportPayload;
import com.isode.stroke.elements.JinglePayload;
import com.isode.stroke.elements.JingleContentPayload;
import com.isode.stroke.elements.JingleFileTransferDescription;
import com.isode.stroke.elements.HashElement;
import com.isode.stroke.elements.JingleFileTransferHash;
import com.isode.stroke.jingle.JingleContentID;
import com.isode.stroke.signals.SignalConnection;
import com.isode.stroke.signals.Slot1;
import com.isode.stroke.signals.Slot;
import java.util.logging.Logger;
import java.util.Vector;
import java.util.Map;
import java.util.HashMap;

public class IncomingJingleFileTransfer extends JingleFileTransfer implements IncomingFileTransfer {

	private long fileSizeInBytes = 0; //FileTransferVariables
	private String filename = ""; //FileTransferVariables

	/**
	* FileTransferMethod.
	*/
	@Override
	public String getFileName() {
		return filename;
	}

	/**
	* FileTransferMethod.
	*/
	@Override
	public long getFileSizeInBytes() {
		return fileSizeInBytes;
	}

	/**
	* FileTransferMethod.
	*/
	@Override
	public void setFileInfo(final String name, long size) {
		this.filename = name;
		this.fileSizeInBytes = size;
	}

	private JingleContentPayload initialContent;
	private CryptoProvider crypto;
	private State internalState;
	private JingleFileTransferDescription description;
	private WriteBytestream stream;
	private long receivedBytes;
	private IncrementalBytestreamHashCalculator hashCalculator;
	private Timer waitOnHashTimer;
	private Map<String, ByteArray> hashes = new HashMap<String, ByteArray>();
	private FileTransferOptions options;

	private SignalConnection writeStreamDataReceivedConnection;
	private SignalConnection waitOnHashTimerTickedConnection;
	private SignalConnection transferFinishedConnection;
	private Logger logger_ = Logger.getLogger(this.getClass().getName());

	public IncomingJingleFileTransfer(
		final JID toJID,
		JingleSession session,
		JingleContentPayload content,
		FileTransferTransporterFactory transporterFactory,
		TimerFactory timerFactory,
		CryptoProvider crypto) {
		super(session, toJID, transporterFactory);
		this.initialContent = content;
		this.crypto = crypto;
		this.internalState = State.Initial;
		this. receivedBytes = 0;
		this.hashCalculator = null;
		this.description = initialContent.getDescription(new JingleFileTransferDescription());
		assert(description != null);
		JingleFileTransferFileInfo fileInfo = description.getFileInfo();
		setFileInfo(fileInfo.getName(), fileInfo.getSize());
		hashes = fileInfo.getHashes();

		waitOnHashTimer = timerFactory.createTimer(5000);
		waitOnHashTimerTickedConnection = waitOnHashTimer.onTick.connect(new Slot() {
			@Override
			public void call() {
				handleWaitOnHashTimerTicked();
			}
		});
	}

	/**
	* IncomingFileTransferMethod.
	*/
	@Override
	public void accept(WriteBytestream stream) {
		accept(stream, new FileTransferOptions());
	}

	/**
	* IncomingFileTransferMethod.
	*/
	@Override
	public void accept(WriteBytestream stream, final FileTransferOptions options) {
		logger_.fine("\n");
		if (!State.Initial.equals(internalState)) { logger_.warning("Incorrect state \n"); return; }

		assert(this.stream == null);
		this.stream = stream;
		this.options = options;

		assert(hashCalculator == null);

		hashCalculator = new IncrementalBytestreamHashCalculator(hashes.containsKey("md5"), hashes.containsKey("sha-1"), crypto);

		writeStreamDataReceivedConnection = stream.onWrite.connect(new Slot1<ByteArray>() {
			@Override
			public void call(ByteArray b) {
				handleWriteStreamDataReceived(b);
			}
		});

		if (initialContent.getTransport(new JingleS5BTransportPayload()) != null) {
			JingleS5BTransportPayload s5bTransport = initialContent.getTransport(new JingleS5BTransportPayload());
			logger_.fine("Got S5B transport as initial payload.\n");
			setTransporter(transporterFactory.createResponderTransporter(getInitiator(), getResponder(), s5bTransport.getSessionID(), options));
			transporter.addRemoteCandidates(s5bTransport.getCandidates(), s5bTransport.getDstAddr());
			setInternalState(State.GeneratingInitialLocalCandidates);
			transporter.startGeneratingLocalCandidates();
		}
		else if(initialContent.getTransport(new JingleIBBTransportPayload()) != null) {
			JingleIBBTransportPayload ibbTransport = initialContent.getTransport(new JingleIBBTransportPayload());
			logger_.fine("Got IBB transport as initial payload.\n");
			setTransporter(transporterFactory.createResponderTransporter(getInitiator(), getResponder(), ibbTransport.getSessionID(), options));

			startTransferring(transporter.createIBBReceiveSession(ibbTransport.getSessionID(), (int)description.getFileInfo().getSize(), stream));

			session.sendAccept(getContentID(), initialContent.getDescriptions().get(0), ibbTransport);
		}
		else {
			// Can't happen, because the transfer would have been rejected automatically
			assert(false);
		}
	}

	/**
	* IncomingFileTransferMethod.
	*/
	@Override
	public JID getSender() {
		return getInitiator();
	}

	/**
	* IncomingFileTransferMethod.
	*/
	@Override
	public JID getRecipient() {
		return getResponder();
	}

	/**
	* JingleFileTransferMethod.
	*/
	@Override
	public void cancel() {
		logger_.fine("\n");
		terminate(State.Initial.equals(internalState) ? JinglePayload.Reason.Type.Decline : JinglePayload.Reason.Type.Cancel);
	}

	protected void startTransferViaRemoteCandidate() {
		logger_.fine("\n");

		if (JingleS5BTransportPayload.Candidate.Type.ProxyType.equals(ourCandidateChoice.type)) {
			setInternalState(State.WaitingForPeerProxyActivate);
		} 
		else {
			startTransferring(createRemoteCandidateSession());
		}
	}

	protected void startTransferViaLocalCandidate() {
		logger_.fine("\n");

		if (JingleS5BTransportPayload.Candidate.Type.ProxyType.equals(theirCandidateChoice.type)) {
			setInternalState(State.WaitingForLocalProxyActivate);
			transporter.startActivatingProxy(theirCandidateChoice.jid);
		} 
		else {
			startTransferring(createLocalCandidateSession());
		}
	}
	
	protected void checkHashAndTerminate() {
		if (verifyData()) {
			terminate(JinglePayload.Reason.Type.Success);
		}
		else {
			logger_.warning("Hash verification failed\n");
			terminate(JinglePayload.Reason.Type.MediaError);
		}
	}

	protected void stopAll() {
		if (!State.Initial.equals(internalState)) {
			writeStreamDataReceivedConnection.disconnect();
			hashCalculator = null;
		}
		switch (internalState) {
			case Initial: break;
			case GeneratingInitialLocalCandidates: transporter.stopGeneratingLocalCandidates(); break;
			case TryingCandidates: transporter.stopTryingRemoteCandidates(); break;
			case WaitingForFallbackOrTerminate: break;
			case WaitingForPeerProxyActivate: break;
			case WaitingForLocalProxyActivate: transporter.stopActivatingProxy(); break;
			case WaitingForHash: // Fallthrough
			case Transferring:
				assert(transportSession != null);
				transferFinishedConnection.disconnect();
				transportSession.stop();
				transportSession = null;
				break;
			case Finished: logger_.warning("Already finished\n"); break;
		}
		if (!State.Initial.equals(internalState)) {
			removeTransporter();
		}
	}

	protected void setInternalState(State state) {
		logger_.fine(state + "\n");
		this.internalState = state;
		onStateChanged.emit(new FileTransfer.State(getExternalState(state)));
	}
	
	@Override
	public com.isode.stroke.filetransfer.FileTransfer.State getState() {
	    return new FileTransfer.State(getExternalState(internalState));
	}

	protected void setFinishedState(FileTransfer.State.Type type, final FileTransferError error) {
		logger_.fine("\n");
		this.internalState = State.Finished;
		onStateChanged.emit(new FileTransfer.State(type));
		onFinished.emit(error);
	}

	protected static FileTransfer.State.Type getExternalState(State state) {
		switch (state) {
			case Initial: return FileTransfer.State.Type.Initial;
			case GeneratingInitialLocalCandidates: return FileTransfer.State.Type.WaitingForStart;
			case TryingCandidates: return FileTransfer.State.Type.Negotiating;
			case WaitingForPeerProxyActivate: return FileTransfer.State.Type.Negotiating;
			case WaitingForLocalProxyActivate: return FileTransfer.State.Type.Negotiating;
			case WaitingForFallbackOrTerminate: return FileTransfer.State.Type.Negotiating;
			case Transferring: return FileTransfer.State.Type.Transferring;
			case WaitingForHash: return FileTransfer.State.Type.Transferring;
			case Finished: return FileTransfer.State.Type.Finished;
		}
		assert(false);
		return FileTransfer.State.Type.Initial;
	}

	protected boolean hasPriorityOnCandidateTie() {
		return false;
	}

	protected void fallback() {
		setInternalState(State.WaitingForFallbackOrTerminate);
	}

	protected void startTransferring(TransportSession transportSession) {
		logger_.fine("\n");

		this.transportSession = transportSession;
		transferFinishedConnection = transportSession.onFinished.connect(new Slot1<FileTransferError>() {
			@Override
			public void call(FileTransferError e) {
				handleTransferFinished(e);
			}
		});
		setInternalState(State.Transferring);
		transportSession.start();
	}

	protected boolean isWaitingForPeerProxyActivate() {
		return State.WaitingForPeerProxyActivate.equals(internalState);
	}

	protected boolean isWaitingForLocalProxyActivate() {
		return State.WaitingForLocalProxyActivate.equals(internalState);
	}

	protected boolean isTryingCandidates() {
		return State.TryingCandidates.equals(internalState);
	}

	protected TransportSession createLocalCandidateSession() {
		return transporter.createLocalCandidateSession(stream, theirCandidateChoice);
	}

	protected TransportSession createRemoteCandidateSession() {
		return transporter.createRemoteCandidateSession(stream, ourCandidateChoice);
	}

	protected void terminate(JinglePayload.Reason.Type reason) {
		logger_.fine(reason + "\n");

		if (!State.Finished.equals(internalState)) {
			session.sendTerminate(reason);
		}
		stopAll();
		setFinishedState(getExternalFinishedState(reason), getFileTransferError(reason));
	}

	private enum State {
		Initial,
		GeneratingInitialLocalCandidates,	
		TryingCandidates,
		WaitingForPeerProxyActivate,
		WaitingForLocalProxyActivate,
		WaitingForFallbackOrTerminate,
		Transferring,
		WaitingForHash,
		Finished
	};

	public void handleSessionTerminateReceived(JinglePayload.Reason reason) {
		logger_.fine("\n");
		if (State.Finished.equals(internalState)) { logger_.warning("Incorrect state\n"); return; }

		if (State.Finished.equals(internalState)) { 
			logger_.fine("Already terminated\n");
			return; 
		}

		stopAll();
		if (reason != null && JinglePayload.Reason.Type.Cancel.equals(reason.type)) {
			setFinishedState(FileTransfer.State.Type.Canceled, new FileTransferError(FileTransferError.Type.PeerError));
		}
		else if (reason != null && JinglePayload.Reason.Type.Success.equals(reason.type)) {
			setFinishedState(FileTransfer.State.Type.Finished, null);
		} 
		else {
			setFinishedState(FileTransfer.State.Type.Failed, new FileTransferError(FileTransferError.Type.PeerError));
		}
	}

	public void handleSessionInfoReceived(JinglePayload jinglePayload) {
		logger_.fine("\n");

		JingleFileTransferHash transferHash = jinglePayload.getPayload(new JingleFileTransferHash());
		if (transferHash != null) {
			logger_.fine("Received hash information.\n");
			waitOnHashTimer.stop();
			if (transferHash.getFileInfo().getHashes().containsKey("sha-1")) {
				hashes.put("sha-1", transferHash.getFileInfo().getHash("sha-1"));
			}
			if (transferHash.getFileInfo().getHashes().containsKey("md5")) {
				hashes.put("md5", transferHash.getFileInfo().getHash("md5"));
			}
			if (State.WaitingForHash.equals(internalState)) {
				checkHashAndTerminate();
			}
		}
		else {
			logger_.fine("Ignoring unknown session info\n");
		}
	}

	public void handleTransportReplaceReceived(final JingleContentID content, JingleTransportPayload transport) {
		logger_.fine("\n");
		if (!State.WaitingForFallbackOrTerminate.equals(internalState)) { 
			logger_.warning("Incorrect state\n"); 
			return; 
		}

		if (options.isInBandAllowed() && transport instanceof JingleIBBTransportPayload) {
			JingleIBBTransportPayload ibbTransport = (JingleIBBTransportPayload)transport;
			logger_.fine("transport replaced with IBB\n");

			startTransferring(transporter.createIBBReceiveSession(ibbTransport.getSessionID(), (int)description.getFileInfo().getSize(), stream));
			session.sendTransportAccept(content, ibbTransport);
		} 
		else {
			logger_.fine("Unknown replace transport\n");
			session.sendTransportReject(content, transport);
		}
	}

	protected void handleLocalTransportCandidatesGenerated(final String s5bSessionID, final Vector<JingleS5BTransportPayload.Candidate> candidates, final String dstAddr) {
		logger_.fine("\n");
		if (!State.GeneratingInitialLocalCandidates.equals(internalState)) { logger_.warning("Incorrect state\n"); return; }

		fillCandidateMap(localCandidates, candidates);

		JingleS5BTransportPayload transport = new JingleS5BTransportPayload();
		transport.setSessionID(s5bSessionID);
		transport.setMode(JingleS5BTransportPayload.Mode.TCPMode);
		transport.setDstAddr(dstAddr);
		for(JingleS5BTransportPayload.Candidate candidate : candidates) {
			transport.addCandidate(candidate);	
		}
		session.sendAccept(getContentID(), initialContent.getDescriptions().get(0), transport);

		setInternalState(State.TryingCandidates);
		transporter.startTryingRemoteCandidates();
	}

	private void handleWriteStreamDataReceived(final ByteArray data) {
		hashCalculator.feedData(data);
		receivedBytes += data.getSize();
		onProcessedBytes.emit(data.getSize());
		checkIfAllDataReceived();
	}

	private void stopActiveTransport() {

	}

	private void checkCandidateSelected() {

	}

	protected JingleContentID getContentID() {
		return new JingleContentID(initialContent.getName(), initialContent.getCreator());
	}

	private void checkIfAllDataReceived() {
		if (receivedBytes == getFileSizeInBytes()) {
			logger_.fine("All data received.\n");
			boolean hashInfoAvailable = false;
			for(final Map.Entry<String, ByteArray> hashElement : hashes.entrySet()) {
				hashInfoAvailable |= !(hashElement.getValue().isEmpty());
			}

			if (!hashInfoAvailable) {
				logger_.fine("No hash information yet. Waiting a while on hash info.\n");
				setInternalState(State.WaitingForHash);
				waitOnHashTimer.start();
			} 
			else {
				checkHashAndTerminate();
			}
		}
		else if (receivedBytes > getFileSizeInBytes()) {
			logger_.fine("We got more than we could handle!\n");
			terminate(JinglePayload.Reason.Type.MediaError);
		}
	}

	private boolean verifyData() {
		if (hashes.isEmpty()) {
			logger_.fine("no verification possible, skipping\n");
			return true;
		} 
		if (hashes.containsKey("sha-1")) {
			logger_.fine("Verify SHA-1 hash: " + (hashes.get("sha-1").equals(hashCalculator.getSHA1Hash())) + "\n");
			return hashes.get("sha-1").equals(hashCalculator.getSHA1Hash());
		}
		else if (hashes.containsKey("md5")) {
			logger_.fine("Verify MD5 hash: " + (hashes.get("md5").equals(hashCalculator.getMD5Hash())) + "\n");
			return hashes.get("md5").equals(hashCalculator.getMD5Hash());
		}
		else {
			logger_.fine("Unknown hash, skipping\n");
			return true;
		}
	}

	private void handleWaitOnHashTimerTicked() {
		logger_.fine("\n");
		waitOnHashTimer.stop();
		terminate(JinglePayload.Reason.Type.Success);
	}

	private void handleTransferFinished(FileTransferError error) {
		if (error != null && !State.WaitingForHash.equals(internalState)) {
			terminate(JinglePayload.Reason.Type.MediaError);
		}
	}
}