mirror of
https://codeberg.org/Mercury-IM/Smack
synced 2024-11-23 06:42:05 +01:00
File transfer fault tolerance
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@3406 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
parent
d807155a29
commit
586e3a1604
8 changed files with 440 additions and 181 deletions
|
@ -0,0 +1,130 @@
|
|||
/**
|
||||
* $RCSfile$
|
||||
* $Revision: $
|
||||
* $Date: $
|
||||
*
|
||||
* Copyright 2003-2006 Jive Software.
|
||||
*
|
||||
* All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.filetransfer;
|
||||
|
||||
import org.jivesoftware.smack.PacketCollector;
|
||||
import org.jivesoftware.smack.SmackConfiguration;
|
||||
import org.jivesoftware.smack.XMPPConnection;
|
||||
import org.jivesoftware.smack.XMPPException;
|
||||
import org.jivesoftware.smack.filter.OrFilter;
|
||||
import org.jivesoftware.smack.filter.PacketFilter;
|
||||
import org.jivesoftware.smack.packet.Packet;
|
||||
import org.jivesoftware.smackx.packet.StreamInitiation;
|
||||
|
||||
import java.io.InputStream;
|
||||
import java.io.OutputStream;
|
||||
|
||||
/**
|
||||
* The fault tolerant negotiator takes two stream negotiators, the primary and the secondary negotiator.
|
||||
* If the primary negotiator fails during the stream negotiaton process, the second negotiator is used.
|
||||
*/
|
||||
public class FaultTolerantNegotiator extends StreamNegotiator {
|
||||
|
||||
private StreamNegotiator primaryNegotiator;
|
||||
private StreamNegotiator secondaryNegotiator;
|
||||
private XMPPConnection connection;
|
||||
private PacketFilter primaryFilter;
|
||||
private PacketFilter secondaryFilter;
|
||||
|
||||
public FaultTolerantNegotiator(XMPPConnection connection, StreamNegotiator primary, StreamNegotiator secondary) {
|
||||
this.primaryNegotiator = primary;
|
||||
this.secondaryNegotiator = secondary;
|
||||
this.connection = connection;
|
||||
}
|
||||
|
||||
public PacketFilter getInitiationPacketFilter(String from, String streamID) {
|
||||
if (primaryFilter == null || secondaryFilter == null) {
|
||||
primaryFilter = primaryNegotiator.getInitiationPacketFilter(from, streamID);
|
||||
secondaryFilter = secondaryNegotiator.getInitiationPacketFilter(from, streamID);
|
||||
}
|
||||
return new OrFilter(primaryFilter, secondaryFilter);
|
||||
}
|
||||
|
||||
InputStream negotiateIncomingStream(Packet streamInitiation) throws XMPPException {
|
||||
throw new UnsupportedOperationException("Negotiation only handled by create incoming stream method.");
|
||||
}
|
||||
|
||||
final Packet initiateIncomingStream(XMPPConnection connection, StreamInitiation initiation) throws XMPPException {
|
||||
throw new UnsupportedOperationException("Initiation handled by createIncomingStream method");
|
||||
}
|
||||
|
||||
public InputStream createIncomingStream(StreamInitiation initiation) throws XMPPException {
|
||||
PacketFilter filter = getInitiationPacketFilter(initiation.getFrom(), initiation.getSessionID());
|
||||
PacketCollector collector = connection.createPacketCollector(filter);
|
||||
|
||||
StreamInitiation response = super.createInitiationAccept(initiation, getNamespaces());
|
||||
connection.sendPacket(response);
|
||||
|
||||
InputStream stream;
|
||||
try {
|
||||
Packet streamInitiation = collector.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
||||
if (streamInitiation == null) {
|
||||
throw new XMPPException("No response from remote client");
|
||||
}
|
||||
StreamNegotiator negotiator = determineNegotiator(streamInitiation);
|
||||
stream = negotiator.negotiateIncomingStream(streamInitiation);
|
||||
}
|
||||
catch (XMPPException ex) {
|
||||
ex.printStackTrace();
|
||||
Packet streamInitiation = collector.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
||||
collector.cancel();
|
||||
if (streamInitiation == null) {
|
||||
throw new XMPPException("No response from remote client");
|
||||
}
|
||||
StreamNegotiator negotiator = determineNegotiator(streamInitiation);
|
||||
stream = negotiator.negotiateIncomingStream(streamInitiation);
|
||||
} finally {
|
||||
collector.cancel();
|
||||
}
|
||||
|
||||
return stream;
|
||||
}
|
||||
|
||||
private StreamNegotiator determineNegotiator(Packet streamInitiation) {
|
||||
return primaryFilter.accept(streamInitiation) ? primaryNegotiator : secondaryNegotiator;
|
||||
}
|
||||
|
||||
public OutputStream createOutgoingStream(String streamID, String initiator, String target) throws XMPPException {
|
||||
OutputStream stream;
|
||||
try {
|
||||
stream = primaryNegotiator.createOutgoingStream(streamID, initiator, target);
|
||||
}
|
||||
catch (XMPPException ex) {
|
||||
stream = secondaryNegotiator.createOutgoingStream(streamID, initiator, target);
|
||||
}
|
||||
|
||||
return stream;
|
||||
}
|
||||
|
||||
public String[] getNamespaces() {
|
||||
String [] primary = primaryNegotiator.getNamespaces();
|
||||
String [] secondary = secondaryNegotiator.getNamespaces();
|
||||
|
||||
String [] namespaces = new String[primary.length + secondary.length];
|
||||
System.arraycopy(primary, 0, namespaces, 0, primary.length);
|
||||
System.arraycopy(secondary, 0, namespaces, primary.length, secondary.length);
|
||||
|
||||
return namespaces;
|
||||
}
|
||||
|
||||
public void cleanup() {
|
||||
}
|
||||
|
||||
}
|
|
@ -115,8 +115,11 @@ public abstract class FileTransfer {
|
|||
* and 1.
|
||||
*/
|
||||
public double getProgress() {
|
||||
if(amountWritten == 0) {
|
||||
return 0;
|
||||
}
|
||||
return amountWritten / fileSize;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the transfer has been cancled, if it has stopped because
|
||||
|
|
|
@ -72,6 +72,8 @@ public class FileTransferNegotiator {
|
|||
|
||||
private static final Random randomGenerator = new Random();
|
||||
|
||||
public static boolean IBB_ONLY = false;
|
||||
|
||||
/**
|
||||
* Returns the file transfer negotiator related to a particular connection.
|
||||
* When this class is requested on a particular connection the file transfer
|
||||
|
@ -82,6 +84,9 @@ public class FileTransferNegotiator {
|
|||
*/
|
||||
public static FileTransferNegotiator getInstanceFor(
|
||||
final XMPPConnection connection) {
|
||||
if (connection == null) {
|
||||
throw new IllegalArgumentException("Connection cannot be null");
|
||||
}
|
||||
if (!connection.isConnected()) {
|
||||
return null;
|
||||
}
|
||||
|
@ -227,7 +232,7 @@ public class FileTransferNegotiator {
|
|||
|
||||
StreamNegotiator selectedStreamNegotiator;
|
||||
try {
|
||||
selectedStreamNegotiator = selectProtocol(streamMethodField);
|
||||
selectedStreamNegotiator = getNegotiator(streamMethodField);
|
||||
}
|
||||
catch (XMPPException e) {
|
||||
IQ iqPacket = createIQ(si.getPacketID(), si.getFrom(), si.getTo(),
|
||||
|
@ -254,14 +259,14 @@ public class FileTransferNegotiator {
|
|||
return field;
|
||||
}
|
||||
|
||||
private StreamNegotiator selectProtocol(final FormField field)
|
||||
private StreamNegotiator getNegotiator(final FormField field)
|
||||
throws XMPPException {
|
||||
String variable = null;
|
||||
String variable;
|
||||
boolean isByteStream = false;
|
||||
boolean isIBB = false;
|
||||
for (Iterator it = field.getOptions(); it.hasNext();) {
|
||||
variable = ((FormField.Option) it.next()).getValue();
|
||||
if (variable.equals(BYTE_STREAM)) {
|
||||
if (variable.equals(BYTE_STREAM) && !IBB_ONLY) {
|
||||
isByteStream = true;
|
||||
}
|
||||
else if (variable.equals(INBAND_BYTE_STREAM)) {
|
||||
|
@ -274,8 +279,15 @@ public class FileTransferNegotiator {
|
|||
throw new XMPPException("No acceptable transfer mechanism", error);
|
||||
}
|
||||
|
||||
return (isByteStream ? byteStreamTransferManager
|
||||
: inbandTransferManager);
|
||||
if (isByteStream && isIBB && field.getType().equals(FormField.TYPE_LIST_MULTI)) {
|
||||
return new FaultTolerantNegotiator(connection, byteStreamTransferManager, inbandTransferManager);
|
||||
}
|
||||
else if (isByteStream) {
|
||||
return byteStreamTransferManager;
|
||||
}
|
||||
else {
|
||||
return inbandTransferManager;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -362,9 +374,8 @@ public class FileTransferNegotiator {
|
|||
IQ iqResponse = (IQ) siResponse;
|
||||
if (iqResponse.getType().equals(IQ.Type.RESULT)) {
|
||||
StreamInitiation response = (StreamInitiation) siResponse;
|
||||
return getUploadNegotiator((((FormField) response
|
||||
.getFeatureNegotiationForm().getFields().next())
|
||||
.getValues().next()).toString());
|
||||
return getOutgoingNegotiator(getStreamMethodField(response
|
||||
.getFeatureNegotiationForm()));
|
||||
|
||||
}
|
||||
else if (iqResponse.getType().equals(IQ.Type.ERROR)) {
|
||||
|
@ -379,23 +390,44 @@ public class FileTransferNegotiator {
|
|||
}
|
||||
}
|
||||
|
||||
private StreamNegotiator getUploadNegotiator(String selectedProtocol) {
|
||||
if (selectedProtocol.equals(BYTE_STREAM)) {
|
||||
private StreamNegotiator getOutgoingNegotiator(final FormField field)
|
||||
throws XMPPException {
|
||||
String variable;
|
||||
boolean isByteStream = false;
|
||||
boolean isIBB = false;
|
||||
for (Iterator it = field.getValues(); it.hasNext();) {
|
||||
variable = (it.next().toString());
|
||||
if (variable.equals(BYTE_STREAM) && !IBB_ONLY) {
|
||||
isByteStream = true;
|
||||
}
|
||||
else if (variable.equals(INBAND_BYTE_STREAM)) {
|
||||
isIBB = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (!isByteStream && !isIBB) {
|
||||
XMPPError error = new XMPPError(400);
|
||||
throw new XMPPException("No acceptable transfer mechanism", error);
|
||||
}
|
||||
|
||||
if (isByteStream && isIBB) {
|
||||
return new FaultTolerantNegotiator(connection, byteStreamTransferManager, inbandTransferManager);
|
||||
}
|
||||
else if (isByteStream) {
|
||||
return byteStreamTransferManager;
|
||||
}
|
||||
else if (selectedProtocol.equals(INBAND_BYTE_STREAM)) {
|
||||
return inbandTransferManager;
|
||||
}
|
||||
else {
|
||||
return null;
|
||||
return inbandTransferManager;
|
||||
}
|
||||
}
|
||||
|
||||
private DataForm createDefaultInitiationForm() {
|
||||
DataForm form = new DataForm(Form.TYPE_FORM);
|
||||
FormField field = new FormField(STREAM_DATA_FIELD_NAME);
|
||||
field.setType(FormField.TYPE_LIST_SINGLE);
|
||||
field.setType(FormField.TYPE_LIST_MULTI);
|
||||
if (!IBB_ONLY) {
|
||||
field.addOption(new FormField.Option(BYTE_STREAM));
|
||||
}
|
||||
field.addOption(new FormField.Option(INBAND_BYTE_STREAM));
|
||||
form.addField(field);
|
||||
return form;
|
||||
|
|
|
@ -19,7 +19,10 @@
|
|||
*/
|
||||
package org.jivesoftware.smackx.filetransfer;
|
||||
|
||||
import org.jivesoftware.smack.*;
|
||||
import org.jivesoftware.smack.PacketCollector;
|
||||
import org.jivesoftware.smack.PacketListener;
|
||||
import org.jivesoftware.smack.XMPPConnection;
|
||||
import org.jivesoftware.smack.XMPPException;
|
||||
import org.jivesoftware.smack.filter.*;
|
||||
import org.jivesoftware.smack.packet.IQ;
|
||||
import org.jivesoftware.smack.packet.Message;
|
||||
|
@ -58,38 +61,22 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
this.connection = connection;
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
*
|
||||
* @see org.jivesoftware.smackx.filetransfer.StreamNegotiator#initiateDownload(org.jivesoftware.smackx.packet.StreamInitiation,
|
||||
* java.io.File)
|
||||
*/
|
||||
public InputStream initiateIncomingStream(StreamInitiation initiation)
|
||||
throws XMPPException {
|
||||
StreamInitiation response = super.createInitiationAccept(initiation,
|
||||
NAMESPACE);
|
||||
|
||||
// establish collector to await response
|
||||
PacketCollector collector = connection
|
||||
.createPacketCollector(new AndFilter(new FromContainsFilter(
|
||||
initiation.getFrom()), new IBBSidFilter(initiation.getSessionID())));
|
||||
connection.sendPacket(response);
|
||||
|
||||
IBBExtensions.Open openRequest = (IBBExtensions.Open) collector
|
||||
.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
||||
if (openRequest == null) {
|
||||
throw new XMPPException("No response from file transfer initiator");
|
||||
public PacketFilter getInitiationPacketFilter(String from, String streamID) {
|
||||
return new AndFilter(new FromContainsFilter(
|
||||
from), new IBBOpenSidFilter(streamID));
|
||||
}
|
||||
else if (openRequest.getType().equals(IQ.Type.ERROR)) {
|
||||
|
||||
InputStream negotiateIncomingStream(Packet streamInitiation) throws XMPPException {
|
||||
Open openRequest = (Open) streamInitiation;
|
||||
|
||||
if (openRequest.getType().equals(IQ.Type.ERROR)) {
|
||||
throw new XMPPException(openRequest.getError());
|
||||
}
|
||||
collector.cancel();
|
||||
|
||||
PacketFilter dataFilter = new AndFilter(new PacketExtensionFilter(
|
||||
IBBExtensions.Data.ELEMENT_NAME, IBBExtensions.NAMESPACE),
|
||||
new FromMatchesFilter(initiation.getFrom()));
|
||||
PacketFilter dataFilter = new IBBMessageSidFilter(openRequest.getFrom(),
|
||||
openRequest.getSessionID());
|
||||
PacketFilter closeFilter = new AndFilter(new PacketTypeFilter(
|
||||
IBBExtensions.Close.class), new FromMatchesFilter(initiation
|
||||
IBBExtensions.Close.class), new FromMatchesFilter(openRequest
|
||||
.getFrom()));
|
||||
|
||||
InputStream stream = new IBBInputStream(openRequest.getSessionID(),
|
||||
|
@ -100,6 +87,11 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
return stream;
|
||||
}
|
||||
|
||||
public InputStream createIncomingStream(StreamInitiation initiation) throws XMPPException {
|
||||
Packet openRequest = initiateIncomingStream(connection, initiation);
|
||||
return negotiateIncomingStream(openRequest);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates and sends the response for the open request.
|
||||
*
|
||||
|
@ -111,7 +103,7 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
IQ.Type.RESULT));
|
||||
}
|
||||
|
||||
public OutputStream initiateOutgoingStream(String streamID, String initiator,
|
||||
public OutputStream createOutgoingStream(String streamID, String initiator,
|
||||
String target) throws XMPPException {
|
||||
Open openIQ = new Open(streamID, DEFAULT_BLOCK_SIZE);
|
||||
openIQ.setTo(target);
|
||||
|
@ -143,8 +135,11 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
return new IBBOutputStream(target, streamID, DEFAULT_BLOCK_SIZE);
|
||||
}
|
||||
|
||||
public String getNamespace() {
|
||||
return NAMESPACE;
|
||||
public String[] getNamespaces() {
|
||||
return new String[]{NAMESPACE};
|
||||
}
|
||||
|
||||
public void cleanup() {
|
||||
}
|
||||
|
||||
private class IBBOutputStream extends OutputStream {
|
||||
|
@ -155,22 +150,25 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
|
||||
protected int seq = 0;
|
||||
|
||||
private final Message template;
|
||||
final String userID;
|
||||
|
||||
private final int options = Base64.DONT_BREAK_LINES;
|
||||
|
||||
private IQ closePacket;
|
||||
final private IQ closePacket;
|
||||
|
||||
private String messageID;
|
||||
private String sid;
|
||||
|
||||
IBBOutputStream(String userID, String sid, int blockSize) {
|
||||
if (blockSize <= 0) {
|
||||
throw new IllegalArgumentException("Buffer size <= 0");
|
||||
}
|
||||
buffer = new byte[blockSize];
|
||||
template = new Message(userID);
|
||||
this.userID = userID;
|
||||
|
||||
Message template = new Message(userID);
|
||||
messageID = template.getPacketID();
|
||||
template.addExtension(new IBBExtensions.Data(sid));
|
||||
this.sid = sid;
|
||||
closePacket = createClosePacket(userID, sid);
|
||||
}
|
||||
|
||||
|
@ -209,12 +207,11 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
}
|
||||
|
||||
private void writeToXML(byte[] buffer, int offset, int len) {
|
||||
template.setPacketID(messageID + "_" + seq);
|
||||
IBBExtensions.Data ext = (IBBExtensions.Data) template
|
||||
.getExtension(IBBExtensions.Data.ELEMENT_NAME,
|
||||
IBBExtensions.NAMESPACE);
|
||||
Message template = createTemplate(messageID + "_" + seq);
|
||||
IBBExtensions.Data ext = new IBBExtensions.Data(sid);
|
||||
template.addExtension(ext);
|
||||
|
||||
String enc = Base64.encodeBytes(buffer, offset, count, options);
|
||||
String enc = Base64.encodeBytes(buffer, offset, len, options);
|
||||
|
||||
ext.setData(enc);
|
||||
ext.setSeq(seq);
|
||||
|
@ -236,6 +233,11 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
write(b, 0, b.length);
|
||||
}
|
||||
|
||||
public Message createTemplate(String messageID) {
|
||||
Message template = new Message(userID);
|
||||
template.setPacketID(messageID);
|
||||
return template;
|
||||
}
|
||||
}
|
||||
|
||||
private class IBBInputStream extends InputStream implements PacketListener {
|
||||
|
@ -304,7 +306,7 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
|
||||
private boolean loadBufferWait() throws IOException {
|
||||
IBBExtensions.Data data;
|
||||
do {
|
||||
|
||||
Message mess = null;
|
||||
while (mess == null) {
|
||||
if (isDone) {
|
||||
|
@ -320,8 +322,7 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
data = (IBBExtensions.Data) mess.getExtension(
|
||||
IBBExtensions.Data.ELEMENT_NAME,
|
||||
IBBExtensions.NAMESPACE);
|
||||
}
|
||||
while (!data.getSessionID().equals(streamID));
|
||||
|
||||
checkSequence((int) data.getSeq());
|
||||
buffer = Base64.decode(data.getData());
|
||||
bufferPointer = 0;
|
||||
|
@ -389,11 +390,11 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
}
|
||||
}
|
||||
|
||||
private static class IBBSidFilter implements PacketFilter {
|
||||
private static class IBBOpenSidFilter implements PacketFilter {
|
||||
|
||||
private String sessionID;
|
||||
|
||||
public IBBSidFilter(String sessionID) {
|
||||
public IBBOpenSidFilter(String sessionID) {
|
||||
if (sessionID == null) {
|
||||
throw new IllegalArgumentException("StreamID cannot be null");
|
||||
}
|
||||
|
@ -411,4 +412,31 @@ public class IBBTransferNegotiator extends StreamNegotiator {
|
|||
}
|
||||
}
|
||||
|
||||
private static class IBBMessageSidFilter implements PacketFilter {
|
||||
|
||||
private final String sessionID;
|
||||
private String from;
|
||||
|
||||
public IBBMessageSidFilter(String from, String sessionID) {
|
||||
this.from = from;
|
||||
this.sessionID = sessionID;
|
||||
}
|
||||
|
||||
public boolean accept(Packet packet) {
|
||||
if (!(packet instanceof Message)) {
|
||||
return false;
|
||||
}
|
||||
if (!packet.getFrom().equalsIgnoreCase(from)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
IBBExtensions.Data data = (IBBExtensions.Data) packet.
|
||||
getExtension(IBBExtensions.Data.ELEMENT_NAME, IBBExtensions.NAMESPACE);
|
||||
if (data == null) {
|
||||
return false;
|
||||
}
|
||||
return data.getSessionID() != null && data.getSessionID().equalsIgnoreCase(sessionID);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -175,7 +175,7 @@ public class IncomingFileTransfer extends FileTransfer {
|
|||
.selectStreamNegotiator(recieveRequest);
|
||||
setStatus(Status.NEGOTIATING_STREAM);
|
||||
InputStream inputStream = streamNegotiator
|
||||
.initiateIncomingStream(recieveRequest.getStreamInitiation());
|
||||
.createIncomingStream(recieveRequest.getStreamInitiation());
|
||||
setStatus(Status.NEGOTIATED);
|
||||
return inputStream;
|
||||
}
|
||||
|
|
|
@ -309,7 +309,7 @@ public class OutgoingFileTransfer extends FileTransfer {
|
|||
// Negotiate the stream
|
||||
|
||||
setStatus(Status.NEGOTIATING_STREAM);
|
||||
outputStream = streamNegotiator.initiateOutgoingStream(streamID,
|
||||
outputStream = streamNegotiator.createOutgoingStream(streamID,
|
||||
initiator, getPeer());
|
||||
if (!getStatus().equals(Status.NEGOTIATING_STREAM)) {
|
||||
return null;
|
||||
|
|
|
@ -29,6 +29,7 @@ import org.jivesoftware.smack.filter.PacketFilter;
|
|||
import org.jivesoftware.smack.filter.PacketIDFilter;
|
||||
import org.jivesoftware.smack.packet.IQ;
|
||||
import org.jivesoftware.smack.packet.Packet;
|
||||
import org.jivesoftware.smack.packet.XMPPError;
|
||||
import org.jivesoftware.smack.util.StringUtils;
|
||||
import org.jivesoftware.smackx.ServiceDiscoveryManager;
|
||||
import org.jivesoftware.smackx.packet.Bytestream;
|
||||
|
@ -84,35 +85,40 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
this.connection = connection;
|
||||
}
|
||||
|
||||
public PacketFilter getInitiationPacketFilter(String from, String sessionID) {
|
||||
return new AndFilter(new FromMatchesFilter(from),
|
||||
new BytestreamSIDFilter(sessionID));
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
*
|
||||
* @see org.jivesoftware.smackx.filetransfer.StreamNegotiator#initiateDownload(org.jivesoftware.smackx.packet.StreamInitiation,
|
||||
* java.io.File)
|
||||
*/
|
||||
public InputStream initiateIncomingStream(StreamInitiation initiation)
|
||||
InputStream negotiateIncomingStream(Packet streamInitiation)
|
||||
throws XMPPException {
|
||||
StreamInitiation response = super.createInitiationAccept(initiation,
|
||||
NAMESPACE);
|
||||
|
||||
// establish collector to await response
|
||||
PacketCollector collector = connection
|
||||
.createPacketCollector(new AndFilter(new FromMatchesFilter(initiation.getFrom()),
|
||||
new BytestreamSIDFilter(initiation.getSessionID())));
|
||||
connection.sendPacket(response);
|
||||
Bytestream streamHostsInfo = (Bytestream) streamInitiation;
|
||||
|
||||
Bytestream streamHostsInfo = (Bytestream) collector
|
||||
.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
||||
if (streamHostsInfo == null) {
|
||||
throw new XMPPException("No response from file transfer initiator");
|
||||
}
|
||||
else if (streamHostsInfo.getType().equals(IQ.Type.ERROR)) {
|
||||
|
||||
if (streamHostsInfo.getType().equals(IQ.Type.ERROR)) {
|
||||
throw new XMPPException(streamHostsInfo.getError());
|
||||
}
|
||||
collector.cancel();
|
||||
|
||||
SelectedHostInfo selectedHost;
|
||||
try {
|
||||
// select appropriate host
|
||||
SelectedHostInfo selectedHost = selectHost(streamHostsInfo);
|
||||
selectedHost = selectHost(streamHostsInfo);
|
||||
}
|
||||
catch (XMPPException ex) {
|
||||
if (ex.getXMPPError() != null) {
|
||||
IQ errorPacket = super.createError(streamHostsInfo.getTo(),
|
||||
streamHostsInfo.getFrom(), streamHostsInfo.getPacketID(),
|
||||
ex.getXMPPError());
|
||||
connection.sendPacket(errorPacket);
|
||||
}
|
||||
throw(ex);
|
||||
}
|
||||
|
||||
// send used-host confirmation
|
||||
Bytestream streamResponse = createUsedHostConfirmation(
|
||||
|
@ -126,6 +132,12 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
catch (IOException e) {
|
||||
throw new XMPPException("Error establishing input stream", e);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public InputStream createIncomingStream(StreamInitiation initiation) throws XMPPException {
|
||||
Packet streamInitiation = initiateIncomingStream(connection, initiation);
|
||||
return negotiateIncomingStream(streamInitiation);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -176,12 +188,11 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
e.printStackTrace();
|
||||
selectedHost = null;
|
||||
socket = null;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
if (selectedHost == null || socket == null) {
|
||||
throw new XMPPException(
|
||||
"Could not establish socket with any provided host");
|
||||
"Could not establish socket with any provided host", new XMPPError(406));
|
||||
}
|
||||
|
||||
return new SelectedHostInfo(selectedHost, socket);
|
||||
|
@ -212,7 +223,7 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
* @see org.jivesoftware.smackx.filetransfer.StreamNegotiator#initiateUpload(java.lang.String,
|
||||
* org.jivesoftware.smackx.packet.StreamInitiation, java.io.File)
|
||||
*/
|
||||
public OutputStream initiateOutgoingStream(String streamID, String initiator,
|
||||
public OutputStream createOutgoingStream(String streamID, String initiator,
|
||||
String target) throws XMPPException {
|
||||
Socket socket;
|
||||
try {
|
||||
|
@ -294,6 +305,12 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
throw new XMPPException("Unexpected response from remote user");
|
||||
}
|
||||
|
||||
// check for an error
|
||||
if (response.getType().equals(IQ.Type.ERROR)) {
|
||||
throw new XMPPException("Remote client returned error, stream hosts expected",
|
||||
response.getError());
|
||||
}
|
||||
|
||||
StreamHostUsed used = response.getUsedHost();
|
||||
StreamHost usedHost = query.getStreamHost(used.getJID());
|
||||
if (usedHost == null) {
|
||||
|
@ -546,8 +563,8 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
return responseDigest;
|
||||
}
|
||||
|
||||
public String getNamespace() {
|
||||
return NAMESPACE;
|
||||
public String[] getNamespaces() {
|
||||
return new String[]{NAMESPACE};
|
||||
}
|
||||
|
||||
private void establishSOCKS5ConnectionToProxy(Socket socket, String digest)
|
||||
|
@ -603,7 +620,10 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
return data;
|
||||
}
|
||||
|
||||
private class SelectedHostInfo {
|
||||
public void cleanup() {
|
||||
}
|
||||
|
||||
private static class SelectedHostInfo {
|
||||
|
||||
protected XMPPException exception;
|
||||
|
||||
|
@ -684,6 +704,9 @@ public class Socks5TransferNegotiator extends StreamNegotiator {
|
|||
|
||||
public void stop() {
|
||||
done = true;
|
||||
synchronized(this) {
|
||||
this.notify();
|
||||
}
|
||||
}
|
||||
|
||||
public int getPort() {
|
||||
|
|
|
@ -19,25 +19,29 @@
|
|||
*/
|
||||
package org.jivesoftware.smackx.filetransfer;
|
||||
|
||||
import java.io.InputStream;
|
||||
import java.io.OutputStream;
|
||||
|
||||
import org.jivesoftware.smack.PacketCollector;
|
||||
import org.jivesoftware.smack.SmackConfiguration;
|
||||
import org.jivesoftware.smack.XMPPConnection;
|
||||
import org.jivesoftware.smack.XMPPException;
|
||||
import org.jivesoftware.smack.filter.PacketFilter;
|
||||
import org.jivesoftware.smack.packet.IQ;
|
||||
import org.jivesoftware.smack.packet.Packet;
|
||||
import org.jivesoftware.smack.packet.XMPPError;
|
||||
import org.jivesoftware.smackx.Form;
|
||||
import org.jivesoftware.smackx.FormField;
|
||||
import org.jivesoftware.smackx.packet.DataForm;
|
||||
import org.jivesoftware.smackx.packet.StreamInitiation;
|
||||
|
||||
import java.io.InputStream;
|
||||
import java.io.OutputStream;
|
||||
|
||||
/**
|
||||
* After the file transfer negotiation process is completed according to
|
||||
* JEP-0096, the negotation process is passed off to a particular stream
|
||||
* negotiator. The stream negotiator will then negotiate the chosen stream and
|
||||
* return the stream to transfer the file.
|
||||
*
|
||||
*
|
||||
* @author Alexander Wenckus
|
||||
*
|
||||
*/
|
||||
public abstract class StreamNegotiator {
|
||||
|
||||
|
@ -45,14 +49,12 @@ public abstract class StreamNegotiator {
|
|||
* Creates the initiation acceptance packet to forward to the stream
|
||||
* initiator.
|
||||
*
|
||||
* @param streamInitiationOffer
|
||||
* The offer from the stream initatior to connect for a stream.
|
||||
* @param namespace
|
||||
* The namespace that relates to the accepted means of transfer.
|
||||
* @param streamInitiationOffer The offer from the stream initatior to connect for a stream.
|
||||
* @param namespaces The namespace that relates to the accepted means of transfer.
|
||||
* @return The response to be forwarded to the initator.
|
||||
*/
|
||||
public StreamInitiation createInitiationAccept(
|
||||
StreamInitiation streamInitiationOffer, String namespace) {
|
||||
StreamInitiation streamInitiationOffer, String [] namespaces) {
|
||||
StreamInitiation response = new StreamInitiation();
|
||||
response.setTo(streamInitiationOffer.getFrom());
|
||||
response.setFrom(streamInitiationOffer.getTo());
|
||||
|
@ -62,13 +64,55 @@ public abstract class StreamNegotiator {
|
|||
DataForm form = new DataForm(Form.TYPE_SUBMIT);
|
||||
FormField field = new FormField(
|
||||
FileTransferNegotiator.STREAM_DATA_FIELD_NAME);
|
||||
field.addValue(namespace);
|
||||
for (int i = 0; i < namespaces.length; i++) {
|
||||
field.addValue(namespaces[i]);
|
||||
}
|
||||
form.addField(field);
|
||||
|
||||
response.setFeatureNegotiationForm(form);
|
||||
return response;
|
||||
}
|
||||
|
||||
|
||||
public IQ createError(String from, String to, String packetID, XMPPError xmppError) {
|
||||
IQ iq = FileTransferNegotiator.createIQ(packetID, to, from, IQ.Type.ERROR);
|
||||
iq.setError(xmppError);
|
||||
return iq;
|
||||
}
|
||||
|
||||
Packet initiateIncomingStream(XMPPConnection connection, StreamInitiation initiation) throws XMPPException {
|
||||
StreamInitiation response = createInitiationAccept(initiation,
|
||||
getNamespaces());
|
||||
|
||||
// establish collector to await response
|
||||
PacketCollector collector = connection
|
||||
.createPacketCollector(getInitiationPacketFilter(initiation.getFrom(), initiation.getSessionID()));
|
||||
connection.sendPacket(response);
|
||||
|
||||
Packet streamMethodInitiation = collector
|
||||
.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
||||
collector.cancel();
|
||||
if (streamMethodInitiation == null) {
|
||||
throw new XMPPException("No response from file transfer initiator");
|
||||
}
|
||||
|
||||
return streamMethodInitiation;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the packet filter that will return the initiation packet for the appropriate stream
|
||||
* initiation.
|
||||
*
|
||||
* @param from The initiatior of the file transfer.
|
||||
* @param streamID The stream ID related to the transfer.
|
||||
* @return The <b><i>PacketFilter</b></i> that will return the packet relatable to the stream
|
||||
* initiation.
|
||||
*/
|
||||
public abstract PacketFilter getInitiationPacketFilter(String from, String streamID);
|
||||
|
||||
|
||||
abstract InputStream negotiateIncomingStream(Packet streamInitiation) throws XMPPException;
|
||||
|
||||
/**
|
||||
* This method handles the file stream download negotiation process. The
|
||||
* appropriate stream negotiator's initiate incoming stream is called after
|
||||
|
@ -77,16 +121,13 @@ public abstract class StreamNegotiator {
|
|||
* any negotation specific to the particular transfer method. This method
|
||||
* returns the InputStream, ready to transfer the file.
|
||||
*
|
||||
* @param initiation
|
||||
* The initation that triggered this download.
|
||||
* @param initiation The initation that triggered this download.
|
||||
* @return After the negotation process is complete, the InputStream to
|
||||
* write a file to is returned.
|
||||
* @throws XMPPException
|
||||
* If an error occurs during this process an XMPPException is
|
||||
* @throws XMPPException If an error occurs during this process an XMPPException is
|
||||
* thrown.
|
||||
*/
|
||||
public abstract InputStream initiateIncomingStream(
|
||||
StreamInitiation initiation) throws XMPPException;
|
||||
public abstract InputStream createIncomingStream(StreamInitiation initiation) throws XMPPException;
|
||||
|
||||
/**
|
||||
* This method handles the file upload stream negotiation process. The
|
||||
|
@ -94,19 +135,15 @@ public abstract class StreamNegotiator {
|
|||
* negotiation process. This method returns the OutputStream to transmit the
|
||||
* file to the remote user.
|
||||
*
|
||||
* @param streamID
|
||||
* The streamID that uniquely identifies the file transfer.
|
||||
* @param initiator
|
||||
* The fully-qualified JID of the initiator of the file transfer.
|
||||
* @param target
|
||||
* The fully-qualified JID of the target or reciever of the file
|
||||
* @param streamID The streamID that uniquely identifies the file transfer.
|
||||
* @param initiator The fully-qualified JID of the initiator of the file transfer.
|
||||
* @param target The fully-qualified JID of the target or reciever of the file
|
||||
* transfer.
|
||||
* @return The negotiated stream ready for data.
|
||||
* @throws XMPPException
|
||||
* If an error occurs during the negotiation process an
|
||||
* @throws XMPPException If an error occurs during the negotiation process an
|
||||
* exception will be thrown.
|
||||
*/
|
||||
public abstract OutputStream initiateOutgoingStream(String streamID,
|
||||
public abstract OutputStream createOutgoingStream(String streamID,
|
||||
String initiator, String target) throws XMPPException;
|
||||
|
||||
/**
|
||||
|
@ -116,6 +153,12 @@ public abstract class StreamNegotiator {
|
|||
* @return Returns the XMPP namespace reserved for this particular type of
|
||||
* file transfer.
|
||||
*/
|
||||
public abstract String getNamespace();
|
||||
public abstract String[] getNamespaces();
|
||||
|
||||
/**
|
||||
* Cleanup any and all resources associated with this negotiator.
|
||||
*/
|
||||
public abstract void cleanup();
|
||||
|
||||
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue