summaryrefslogtreecommitdiffstats
blob: 10760a18aa9988c16688d960dc6463504d7123ca (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
/*
 * Copyright (c) 2011 Tobias Markmann
 * Licensed under the simplified BSD license.
 * See Documentation/Licenses/BSD-simplified.txt for more information.
 */
/*
 * Copyright (c) 2013-2015 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;

public class OutgoingJingleFileTransfer extends JingleFileTransfer implements OutgoingFileTransfer {

	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;
	}

	public static final int DEFAULT_BLOCK_SIZE = 4096;
	private IDGenerator idGenerator;
	private ReadBytestream stream;
	private JingleFileTransferFileInfo fileInfo;
	private FileTransferOptions options;
	private JingleContentID contentID;
	private IncrementalBytestreamHashCalculator hashCalculator;
	private State state;
	private boolean candidateAcknowledged;

	private Timer waitForRemoteTermination;

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

	public OutgoingJingleFileTransfer(
		final JID toJID,
		JingleSession session,
		ReadBytestream stream,
		FileTransferTransporterFactory transporterFactory,
		TimerFactory timerFactory,
		IDGenerator idGenerator,
		final JingleFileTransferFileInfo fileInfo,
		final FileTransferOptions options,
		CryptoProvider crypto) {
		super(session, toJID, transporterFactory);
		this.idGenerator = idGenerator;
		this.stream = stream;
		this.fileInfo = fileInfo;
		this.session = session;
		this.contentID = new JingleContentID(idGenerator.generateID(), JingleContentPayload.Creator.InitiatorCreator);
		this.state = State.Initial;
		this.candidateAcknowledged = false;
		setFileInfo(fileInfo.getName(), fileInfo.getSize());

		// calculate both, MD5 and SHA-1 since we don't know which one the other side supports
		hashCalculator = new IncrementalBytestreamHashCalculator(true, true, crypto);
		stream.onRead.connect(new Slot1<ByteArray>() {
			@Override
			public void call(ByteArray b) {
				hashCalculator.feedData(b);
			}
		});
		waitForRemoteTermination = timerFactory.createTimer(5000);
		waitForRemoteTermination.onTick.connect(new Slot() {
			@Override
			public void call() {
				handleWaitForRemoteTerminationTimeout();
			}
		});
	}

	/**
	* OutgoingFileTransferMethod.
	*/
	@Override
	public void start() {
		logger_.fine("\n");
		if (!State.Initial.equals(state)) {
			logger_.warning("Incorrect state\n");
			return;
		}

		setTransporter(transporterFactory.createInitiatorTransporter(getInitiator(), getResponder(), options));
		setState(State.GeneratingInitialLocalCandidates);
		transporter.startGeneratingLocalCandidates();
	}

	/**
	* JingleFileTransferMethod.
	*/
	@Override
	public void cancel() {
		terminate(JinglePayload.Reason.Type.Cancel);
	}

	private enum State {
		Initial,
		GeneratingInitialLocalCandidates,
		WaitingForAccept,
		TryingCandidates,
		WaitingForPeerProxyActivate,
		WaitingForLocalProxyActivate,
		WaitingForCandidateAcknowledge,
		FallbackRequested,
		Transferring,
		WaitForTermination,
		Finished
	};

	public void handleSessionAcceptReceived(final JingleContentID contentID, JingleDescription description, JingleTransportPayload transportPayload) {
		logger_.fine("\n");
		if (!State.WaitingForAccept.equals(state)) { logger_.warning("Incorrect state\n"); return; }

		if (transportPayload instanceof JingleS5BTransportPayload) {
			JingleS5BTransportPayload s5bPayload = (JingleS5BTransportPayload)transportPayload;
			transporter.addRemoteCandidates(s5bPayload.getCandidates(), s5bPayload.getDstAddr());
			setState(State.TryingCandidates);
			transporter.startTryingRemoteCandidates();
		}
		else {
			logger_.fine("Unknown transport payload. Falling back.\n");
			fallback();
		}
	}

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

		stopAll();
		if (State.WaitForTermination.equals(state)) {
			waitForRemoteTermination.stop();
		}
		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.Decline.equals(reason.type)) {
			setFinishedState(FileTransfer.State.Type.Canceled, null);
		}
		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 handleTransportAcceptReceived(final JingleContentID contentID, JingleTransportPayload transport) {
		logger_.fine("\n");
		if (!State.FallbackRequested.equals(state)) { logger_.warning("Incorrect state\n"); return; }

		if (transport instanceof JingleIBBTransportPayload) {
			JingleIBBTransportPayload ibbPayload = (JingleIBBTransportPayload)transport;
			startTransferring(transporter.createIBBSendSession(ibbPayload.getSessionID(), ( ibbPayload.getBlockSize() != null ? ibbPayload.getBlockSize() : DEFAULT_BLOCK_SIZE), stream));
		} 
		else {
			logger_.fine("Unknown transport replacement\n");
			terminate(JinglePayload.Reason.Type.FailedTransport);
		}
	}

	public void handleTransportRejectReceived(final JingleContentID contentID, JingleTransportPayload transport) {
		logger_.fine("\n");

		terminate(JinglePayload.Reason.Type.UnsupportedTransports);
	}

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

		if (JingleS5BTransportPayload.Candidate.Type.ProxyType.equals(ourCandidateChoice.type)) {
			setState(State.WaitingForPeerProxyActivate);
		} 
		else {
			transportSession = createRemoteCandidateSession();
			startTransferringIfCandidateAcknowledged();
		}
	}

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

		if (JingleS5BTransportPayload.Candidate.Type.ProxyType.equals(theirCandidateChoice.type)) {
			setState(State.WaitingForLocalProxyActivate);
			transporter.startActivatingProxy(theirCandidateChoice.jid);
		} 
		else {
			transportSession = createLocalCandidateSession();
			startTransferringIfCandidateAcknowledged();
		}
	}

	private void startTransferringIfCandidateAcknowledged() {
		if (candidateAcknowledged) {
			startTransferring(transportSession);
		}
		else {
			setState(State.WaitingForCandidateAcknowledge);
		}
	}

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

		fillCandidateMap(localCandidates, candidates);

		JingleFileTransferDescription description = new JingleFileTransferDescription();
		fileInfo.addHash(new HashElement("sha-1", new ByteArray()));
		fileInfo.addHash(new HashElement("md5", new ByteArray()));
		description.setFileInfo(fileInfo);

		JingleS5BTransportPayload transport = new JingleS5BTransportPayload();
		transport.setSessionID(s5bSessionID);
		transport.setMode(JingleS5BTransportPayload.Mode.TCPMode);
		transport.setDstAddr(dstAddr);
		for(JingleS5BTransportPayload.Candidate candidate : candidates) {
			transport.addCandidate(candidate);
			logger_.fine("\t" + "S5B candidate: " + candidate.hostPort.toString() + "\n");
		}
		setState(State.WaitingForAccept);
		session.sendInitiate(contentID, description, transport);
	}

	public void handleTransportInfoAcknowledged(final String id) {
		if (id.equals(candidateSelectRequestID)) {
			candidateAcknowledged = true;
		}
		if (State.WaitingForCandidateAcknowledge.equals(state)) {
			startTransferring(transportSession);
		}
	}

	protected JingleContentID getContentID() {
		return contentID;
	}

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

		if (!State.Initial.equals(state) && !State.GeneratingInitialLocalCandidates.equals(state) && !State.Finished.equals(state)) {
			session.sendTerminate(reason);
		}
		stopAll();
		setFinishedState(getExternalFinishedState(reason), getFileTransferError(reason));
	}

	protected void fallback() {
		if (options.isInBandAllowed()) {
			logger_.fine("Trying to fallback to IBB transport.\n");
			JingleIBBTransportPayload ibbTransport = new JingleIBBTransportPayload();
			ibbTransport.setBlockSize(DEFAULT_BLOCK_SIZE);
			ibbTransport.setSessionID(idGenerator.generateID());
			setState(State.FallbackRequested);
			session.sendTransportReplace(contentID, ibbTransport);
		}
		else {
			logger_.fine("Fallback to IBB transport not allowed.\n");
			terminate(JinglePayload.Reason.Type.ConnectivityError);
		}
	}

	private void handleTransferFinished(FileTransferError error) {
		logger_.fine("\n");
		if (!State.Transferring.equals(state)) { logger_.warning("Incorrect state: " + state + "\n"); return; }

		if (error != null) {
			terminate(JinglePayload.Reason.Type.ConnectivityError);
		} 
		else {
			sendSessionInfoHash();

			// wait for other party to terminate session after they have verified the hash
			setState(State.WaitForTermination);
			waitForRemoteTermination.start();
		}
	}

	private void sendSessionInfoHash() {
		logger_.fine("\n");

		JingleFileTransferHash hashElement = new JingleFileTransferHash();
		hashElement.getFileInfo().addHash(new HashElement("sha-1", hashCalculator.getSHA1Hash()));
		hashElement.getFileInfo().addHash(new HashElement("md5", hashCalculator.getMD5Hash()));
		session.sendInfo(hashElement);
	}

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

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

	protected boolean hasPriorityOnCandidateTie() {
		return true;
	}

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

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

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

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

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

	private void handleWaitForRemoteTerminationTimeout() {
		assert(state.equals(State.WaitForTermination));
		logger_.warning("Other party did not terminate session. Terminate it now.\n");
		waitForRemoteTermination.stop();
		terminate(JinglePayload.Reason.Type.MediaError);
	}

	private void stopAll() {
		logger_.fine(state + "\n");
		switch (state) {
			case Initial: logger_.warning("Not yet started\n"); break;
			case GeneratingInitialLocalCandidates: transporter.stopGeneratingLocalCandidates(); break;
			case WaitingForAccept: break;
			case TryingCandidates: transporter.stopTryingRemoteCandidates(); break;
			case FallbackRequested: break;
			case WaitingForPeerProxyActivate: break;
			case WaitingForLocalProxyActivate: transporter.stopActivatingProxy(); break;
			case WaitingForCandidateAcknowledge: // Fallthrough
			case Transferring:
				assert(transportSession != null);
				processedBytesConnection.disconnect();
				transferFinishedConnection.disconnect();
				transportSession.stop();
				transportSession = null;
				break;
			case WaitForTermination:
				break;
			case Finished: logger_.warning("Already finished\n"); break;
		}
		if (!State.Initial.equals(state)) {
			removeTransporter();
		}
	}

	private void setState(State state) {
		logger_.fine(state + "\n");
		this.state = state;
		onStateChanged.emit(new FileTransfer.State(getExternalState(state)));
	}

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

	private static FileTransfer.State.Type getExternalState(State state) {
		switch (state) {
			case Initial: return FileTransfer.State.Type.Initial;
			case GeneratingInitialLocalCandidates: return FileTransfer.State.Type.WaitingForStart;
			case WaitingForAccept: return FileTransfer.State.Type.WaitingForAccept;
			case TryingCandidates: return FileTransfer.State.Type.Negotiating;
			case WaitingForPeerProxyActivate: return FileTransfer.State.Type.Negotiating;
			case WaitingForLocalProxyActivate: return FileTransfer.State.Type.Negotiating;
			case WaitingForCandidateAcknowledge: return FileTransfer.State.Type.Negotiating;
			case FallbackRequested: return FileTransfer.State.Type.Negotiating;
			case Transferring: return FileTransfer.State.Type.Transferring;
			case WaitForTermination: return FileTransfer.State.Type.Transferring;
			case Finished: return FileTransfer.State.Type.Finished;
		}
		assert(false);
		return FileTransfer.State.Type.Initial;
	}

}