Google Summer of Code 2011 Project: Adding support for Jingle File Transfers (XEP-0234), Jingle SOCKS5 Bytestreams Transport Method (XEP-0260), Jingle In-Band Bytestreams Transport Method (XEP-0261) and SOCKS5 Bytestreams (XEP-0065).

License: This patch is BSD-licensed, see http://www.opensource.org/licenses/bsd-license.php
author: Tobias Markmann <tm@ayena.de> 2011-05-26 18:46:49 (GMT)
committer: Remko Tronçon <git@el-tramo.be> 2011-09-25 17:42:32 (GMT)
commit: 4f62e5ec4b42929fe3c1a68667e63cb1b7a35509 (patch)
tree: 0d19fac3f578dec00ccf3e58930312951e38de89 /Swiften/Elements
parent: de660b763459cdd707876ec244b6866abca07fa2 (diff)
download: swift-contrib-4f62e5ec4b42929fe3c1a68667e63cb1b7a35509.zip
swift-contrib-4f62e5ec4b42929fe3c1a68667e63cb1b7a35509.tar.bz2
13 files changed, 401 insertions, 35 deletions
diff --git a/Swiften/Elements/DiscoInfo.cpp b/Swiften/Elements/DiscoInfo.cpp
index f54b6bf..35d4d04 100644
--- a/Swiften/Elements/DiscoInfo.cpp
+++ b/Swiften/Elements/DiscoInfo.cpp
@@ -16,7 +16,11 @@ const std::string DiscoInfo::SecurityLabelsCatalogFeature = std::string("urn:xmp
 const std::string DiscoInfo::JabberSearchFeature = std::string("jabber:iq:search");
 const std::string DiscoInfo::CommandsFeature = std::string("http://jabber.org/protocol/commands");
 const std::string DiscoInfo::MessageCorrectionFeature = std::string("urn:xmpp:message-correct:0");
-
+const std::string DiscoInfo::JingleFeature = std::string("urn:xmpp:jingle:1");
+const std::string DiscoInfo::JingleFTFeature = std::string("urn:xmpp:jingle:apps:file-transfer:3");
+const std::string DiscoInfo::JingleTransportsIBBFeature = std::string("urn:xmpp:jingle:transports:ibb:1");
+const std::string DiscoInfo::JingleTransportsS5BFeature = std::string("urn:xmpp:jingle:transports:s5b:1");
+const std::string DiscoInfo::Bytestream = std::string("http://jabber.org/protocol/bytestreams");
 
 
 bool DiscoInfo::Identity::operator<(const Identity& other) const {
diff --git a/Swiften/Elements/DiscoInfo.h b/Swiften/Elements/DiscoInfo.h
index c5c9e1c..6d6e722 100644
--- a/Swiften/Elements/DiscoInfo.h
+++ b/Swiften/Elements/DiscoInfo.h
@@ -23,6 +23,11 @@ namespace Swift {
 			static const std::string JabberSearchFeature;
 			static const std::string CommandsFeature;
 			static const std::string MessageCorrectionFeature;
+			static const std::string JingleFeature;
+			static const std::string JingleFTFeature;
+			static const std::string JingleTransportsIBBFeature;
+			static const std::string JingleTransportsS5BFeature;
+			static const std::string Bytestream;
 
 			class Identity {
 				public:
diff --git a/Swiften/Elements/JingleContentPayload.h b/Swiften/Elements/JingleContentPayload.h
index c44a806..183b8eb 100644
--- a/Swiften/Elements/JingleContentPayload.h
+++ b/Swiften/Elements/JingleContentPayload.h
@@ -21,6 +21,7 @@ namespace Swift {
 			typedef boost::shared_ptr<JingleContentPayload> ref;
 
 			enum Creator {
+				UnknownCreator,
 				InitiatorCreator,
 				ResponderCreator,
 			};
diff --git a/Swiften/Elements/JingleFileTransferDescription.h b/Swiften/Elements/JingleFileTransferDescription.h
index 19644bd..04f3f1f 100644
--- a/Swiften/Elements/JingleFileTransferDescription.h
+++ b/Swiften/Elements/JingleFileTransferDescription.h
@@ -7,7 +7,7 @@
 #pragma once
 
 #include <boost/shared_ptr.hpp>
-#include <boost/optional.hpp>
+#include <vector>
 
 #include <Swiften/Elements/JingleDescription.h>
 #include <Swiften/Elements/StreamInitiationFileInfo.h>
@@ -17,15 +17,25 @@ namespace Swift {
 		public:
 			typedef boost::shared_ptr<JingleFileTransferDescription> ref;
 
-			void setOffer(const StreamInitiationFileInfo& offer) {
-				this->offer = offer;
+			void addOffer(const StreamInitiationFileInfo& offer) {
+				offers.push_back(offer);
 			}
+			
 
-			const boost::optional<StreamInitiationFileInfo>& getOffer() const {
-				return offer;
+			const std::vector<StreamInitiationFileInfo>& getOffers() const {
+				return offers;
+			}
+			
+			void addRequest(const StreamInitiationFileInfo& request) {
+				reqeusts.push_back(request);
+			}
+			
+			const std::vector<StreamInitiationFileInfo>& getRequests() const {
+				return reqeusts;
 			}
 
 		private:
-			boost::optional<StreamInitiationFileInfo> offer;
+			std::vector<StreamInitiationFileInfo> offers;
+			std::vector<StreamInitiationFileInfo> reqeusts;
 	};
 }
diff --git a/Swiften/Elements/JingleFileTransferHash.h b/Swiften/Elements/JingleFileTransferHash.h
new file mode 100644
index 0000000..5603531
--- /dev/null
+++ b/Swiften/Elements/JingleFileTransferHash.h
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2011 Tobias Markmann
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#pragma once
+
+#include <boost/shared_ptr.hpp>
+#include <map>
+#include <string>
+
+#include <Swiften/Elements/JingleDescription.h>
+
+namespace Swift {
+
+class JingleFileTransferHash : public Payload {
+public:
+	typedef std::map<std::string, std::string> HashesMap;
+public:
+	typedef boost::shared_ptr<JingleFileTransferHash> ref;
+
+	void setHash(const std::string& algo, const std::string& hash) {
+		hashes[algo] = hash;
+	}
+
+	const HashesMap& getHashes() const {
+		return hashes;
+	}
+
+private:
+	HashesMap hashes;
+};
+	
+}
diff --git a/Swiften/Elements/JingleFileTransferReceived.h b/Swiften/Elements/JingleFileTransferReceived.h
new file mode 100644
index 0000000..75c95d9
--- /dev/null
+++ b/Swiften/Elements/JingleFileTransferReceived.h
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2011 Tobias Markmann
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#pragma once
+
+#include <boost/shared_ptr.hpp>
+#include <vector>
+
+#include <Swiften/Elements/StreamInitiationFileInfo.h>
+#include <Swiften/Elements/Payload.h>
+
+namespace Swift {
+
+class JingleFileTransferReceived : public Payload {
+	public:
+		typedef boost::shared_ptr<JingleFileTransferReceived> ref;
+
+		void setFileInfo(const StreamInitiationFileInfo& fileInfo) {
+			this->fileInfo = fileInfo;
+		}
+
+		const StreamInitiationFileInfo& getFileInfo() const {
+			return this->fileInfo;
+		}
+	private:
+		StreamInitiationFileInfo fileInfo;
+
+};
+
+}
diff --git a/Swiften/Elements/JingleIBBTransportPayload.h b/Swiften/Elements/JingleIBBTransportPayload.h
index 67aab09..8c174f0 100644
--- a/Swiften/Elements/JingleIBBTransportPayload.h
+++ b/Swiften/Elements/JingleIBBTransportPayload.h
@@ -29,14 +29,6 @@ namespace Swift {
 				return stanzaType;
 			}
 
-			void setSessionID(const std::string& id) {
-				sessionID = id;
-			}
-
-			const std::string& getSessionID() const {
-				return sessionID;
-			}
-
 			int getBlockSize() const {
 				return blockSize;
 			}
@@ -46,7 +38,6 @@ namespace Swift {
 			}
 
 		private:
-			std::string sessionID;
 			int blockSize;
 			StanzaType stanzaType;
 	};
diff --git a/Swiften/Elements/JinglePayload.h b/Swiften/Elements/JinglePayload.h
index 5c766b8..31d4448 100644
--- a/Swiften/Elements/JinglePayload.h
+++ b/Swiften/Elements/JinglePayload.h
@@ -7,6 +7,7 @@
 #pragma once
 
 #include <vector>
+#include <boost/shared_ptr.hpp>
 #include <boost/optional.hpp>
 
 #include <string>
@@ -14,13 +15,15 @@
 #include <Swiften/Elements/Payload.h>
 #include <Swiften/Elements/JingleContentPayload.h>
 
+#include <Swiften/Base/Log.h>
 
 namespace Swift {
 	class JinglePayload : public Payload {
 		public:
 			typedef boost::shared_ptr<JinglePayload> ref;
-			struct Reason {
+			struct Reason : public Payload {
 					enum Type {
+						UnknownType,
 						AlternativeSession,
 						Busy,
 						Cancel,
@@ -39,13 +42,15 @@ namespace Swift {
 						UnsupportedApplications,
 						UnsupportedTransports
 					};
-					
+					Reason() : type(UnknownType), text("") {}
 					Reason(Type type, const std::string& text = "") : type(type), text(text) {}
+					~Reason() {}
 					Type type;
 					std::string text;
 			};
 
 			enum Action {
+				UnknownAction,
 				ContentAccept,
 				ContentAdd,
 				ContentModify,
@@ -62,8 +67,11 @@ namespace Swift {
 				TransportReject,
 				TransportReplace
 			};
-
+			JinglePayload() : action(SessionTerminate), sessionID("") {
+			}
+			
 			JinglePayload(Action action, const std::string& sessionID) : action(action), sessionID(sessionID) {
+			
 			}
 
 			void setAction(Action action) {
@@ -99,11 +107,46 @@ namespace Swift {
 			}
 
 			void addContent(JingleContentPayload::ref content) {
-				this->contents.push_back(content);
+				this->payloads.push_back(content);
+			}
+			
+			void addPayload(boost::shared_ptr<Payload> payload) {
+				this->payloads.push_back(payload);
+			}
+			
+			const std::vector<JingleContentPayload::ref> getContents() const {
+				return getPayloads<JingleContentPayload>();
+			}
+			
+			const std::vector<boost::shared_ptr<Payload> > getPayloads() const {
+				return payloads;
+			}
+			
+			template<typename T>
+			const std::vector<boost::shared_ptr<T> > getPayloads() const {
+				std::vector<boost::shared_ptr<T> > matched_payloads;
+				for (std::vector<boost::shared_ptr<Payload> >::const_iterator i = payloads.begin(); i != payloads.end(); ++i) {
+					boost::shared_ptr<T> result = boost::dynamic_pointer_cast<T>(*i);
+					if (result) {
+						matched_payloads.push_back(result);
+					}
+				}
+				
+				return matched_payloads;
+				
 			}
 
-			const std::vector<JingleContentPayload::ref>& getContents() const {
-				return contents;
+			template<typename T>
+			const boost::shared_ptr<T> getPayload() const {
+				boost::shared_ptr<T> result;
+				for (std::vector<boost::shared_ptr<Payload> >::const_iterator i = payloads.begin(); i != payloads.end(); ++i) {
+					result = boost::dynamic_pointer_cast<T>(*i);
+					if (result) {
+						return result;
+					}
+				}
+				
+				return result;
 			}
 
 			void setReason(const Reason& reason) {
@@ -119,7 +162,7 @@ namespace Swift {
 			JID initiator;
 			JID responder;
 			std::string sessionID;
-			std::vector<JingleContentPayload::ref> contents;
+			std::vector<boost::shared_ptr<Payload> > payloads;
 			boost::optional<Reason> reason;
 	};
 }
diff --git a/Swiften/Elements/JingleS5BTransportPayload.h b/Swiften/Elements/JingleS5BTransportPayload.h
index 7b3089f..980af27 100644
--- a/Swiften/Elements/JingleS5BTransportPayload.h
+++ b/Swiften/Elements/JingleS5BTransportPayload.h
@@ -6,23 +6,107 @@
 
 #pragma once
 
+#include <vector>
+
+#include <boost/shared_ptr.hpp>
+
 #include <Swiften/Elements/JingleTransportPayload.h>
 #include <Swiften/Elements/Bytestreams.h>
+#include <Swiften/Network/HostAddressPort.h>
 
-// FIXME: Remove Bytestreams, and replace by our own candidate
 
 namespace Swift {
 	class JingleS5BTransportPayload : public JingleTransportPayload {
 		public:
-			const Bytestreams& getInfo() const {
-				return info;
+			enum Mode {
+				TCPMode, // default case
+				UDPMode,
+			};
+
+			struct Candidate {
+				enum Type {
+					DirectType, // default case
+					AssistedType,
+					TunnelType,
+					ProxyType,
+				};
+
+				Candidate() : priority(0), type(DirectType) {}
+
+				std::string cid;
+				JID jid;
+				HostAddressPort hostPort;
+				int priority;
+				Type type;
+			};
+
+			struct CompareCandidate {
+				bool operator() (const JingleS5BTransportPayload::Candidate& c1, const JingleS5BTransportPayload::Candidate& c2) const {
+					if (c1.priority < c2.priority) return true;
+					return false;
+				}
+			};
+
+		public:
+			JingleS5BTransportPayload() : mode(TCPMode), candidateError(false), proxyError(false) {}
+
+			Mode getMode() const {
+				return mode;
+			}
+
+			void setMode(Mode mode) {
+				this->mode = mode;
+			}
+
+			const std::vector<Candidate>& getCandidates() {
+				return candidates;
+			}
+
+			void addCandidate(const Candidate& candidate) {
+				candidates.push_back(candidate);
+			}
+
+			void setCandidateUsed(const std::string& cid) {
+				candidateUsedCID = cid;
+			}
+
+			const std::string& getCandidateUsed() const {
+				return candidateUsedCID;
+			}
+
+			void setActivated(const std::string& cid) {
+				activatedCID = cid;
 			}
 
-			void setInfo(const Bytestreams& info) {
-				this->info = info;
+			const std::string& getActivated() const {
+				return activatedCID;
 			}
 
+			void setCandidateError(bool hasError) {
+				candidateError = hasError;
+			}
+			
+			bool hasCandidateError() const {
+				return candidateError;
+			}
+			
+			void setProxyError(bool hasError) {
+				proxyError = hasError;
+			}
+
+			bool hasProxyError() const {
+				return proxyError;
+			}
+		public:
+			typedef boost::shared_ptr<JingleS5BTransportPayload> ref;
+
 		private:
-			Bytestreams info;
+			Mode mode;
+			std::vector<Candidate> candidates;
+			
+			std::string candidateUsedCID;
+			std::string activatedCID;
+			bool candidateError;
+			bool proxyError;
 	};
 }
diff --git a/Swiften/Elements/JingleTransportPayload.h b/Swiften/Elements/JingleTransportPayload.h
index 7a9ea29..b870be9 100644
--- a/Swiften/Elements/JingleTransportPayload.h
+++ b/Swiften/Elements/JingleTransportPayload.h
@@ -13,6 +13,18 @@
 namespace Swift {
 	class JingleTransportPayload : public Payload {
 		public:
+			void setSessionID(const std::string& id) {
+				sessionID = id;
+			}
+
+			const std::string& getSessionID() const {
+				return sessionID;
+			}
+
+		public:
 			typedef boost::shared_ptr<JingleTransportPayload> ref;
+
+		private:
+			std::string sessionID;
 	};
 }
diff --git a/Swiften/Elements/Payload.h b/Swiften/Elements/Payload.h
index 8b6d44a..f994ebc 100644
--- a/Swiften/Elements/Payload.h
+++ b/Swiften/Elements/Payload.h
@@ -6,9 +6,13 @@
 
 #pragma once
 
+#include <boost/shared_ptr.hpp>
+
 namespace Swift {
 	class Payload {
 		public:
+			typedef boost::shared_ptr<Payload> ref;
+		public:
 			virtual ~Payload();
 	};
 }
diff --git a/Swiften/Elements/S5BProxyRequest.h b/Swiften/Elements/S5BProxyRequest.h
new file mode 100644
index 0000000..fcd0cb2
--- /dev/null
+++ b/Swiften/Elements/S5BProxyRequest.h
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2011 Tobias Markmann
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#pragma once
+
+#include <string>
+
+#include <boost/optional.hpp>
+
+#include <Swiften/Elements/Payload.h>
+#include <Swiften/JID/JID.h>
+#include <Swiften/Network/HostAddressPort.h>
+
+namespace Swift {
+
+class S5BProxyRequest : public Payload {
+public:
+	typedef boost::shared_ptr<S5BProxyRequest> ref;
+
+public:
+	struct StreamHost {
+		HostAddressPort addressPort;
+		JID jid;
+	};
+
+public:
+	const boost::optional<StreamHost>& getStreamHost() const {
+		return streamHost;
+	}
+
+	void setStreamHost(const StreamHost& streamHost) {
+		this->streamHost = boost::optional<StreamHost>(streamHost);
+	}
+
+	const std::string& getSID() const {
+		return sid;
+	}
+
+	void setSID(const std::string& sid) {
+		this->sid = sid;
+	}
+
+	const boost::optional<JID>& getActivate() const {
+		return activate;
+	}
+
+	void setActivate(const JID& activate) {
+		this->activate = activate;
+	}
+
+private:
+	boost::optional<StreamHost> streamHost;
+
+	std::string sid;
+	boost::optional<JID> activate;
+};
+
+}
diff --git a/Swiften/Elements/StreamInitiationFileInfo.h b/Swiften/Elements/StreamInitiationFileInfo.h
index 92b9824..9484bc0 100644
--- a/Swiften/Elements/StreamInitiationFileInfo.h
+++ b/Swiften/Elements/StreamInitiationFileInfo.h
@@ -6,14 +6,97 @@
 
 #pragma once
 
+#include <Swiften/Elements/Payload.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/date_time/posix_time/posix_time_types.hpp>
+
 #include <string>
 
 namespace Swift {
-	struct StreamInitiationFileInfo {
-		StreamInitiationFileInfo(const std::string& name = "", const std::string& description = "", int size = -1) : name(name), description(description), size(size) {}
 
-		std::string name;
-		std::string description;
-		int size;
-	};
+class StreamInitiationFileInfo : public Payload {
+public:
+	typedef boost::shared_ptr<StreamInitiationFileInfo> ref;
+	
+public:
+	StreamInitiationFileInfo(const std::string& name = "", const std::string& description = "", int size = 0,
+				 const std::string& hash = "", const boost::posix_time::ptime &date = boost::posix_time::ptime(), const std::string& algo="md5") : 
+		name(name), description(description), size(size), hash(hash), date(date), algo(algo), supportsRangeRequests(false), rangeOffset(0) {}
+	
+	void setName(const std::string& name) {
+		this->name = name;;
+	}
+	
+	const std::string& getName() const {
+		return this->name;
+	}
+	
+	void setDescription(const std::string& description) {
+		this->description = description;
+	}
+	
+	const std::string& getDescription() const {
+		return this->description;
+	}
+	
+	void setSize(const boost::uintmax_t size) {
+		this->size = size;
+	}
+	
+	boost::uintmax_t getSize() const {
+		return this->size;
+	}
+	
+	void setHash(const std::string& hash) {
+		this->hash = hash;
+	}
+	
+	const std::string& getHash() const {
+		return this->hash;
+	}
+	
+	void setDate(const boost::posix_time::ptime& date) {
+		this->date = date;
+	}
+	
+	const boost::posix_time::ptime& getDate() const {
+		return this->date;
+	}
+	
+	void setAlgo(const std::string& algo) {
+		this->algo = algo;
+	}
+	
+	const std::string& getAlgo() const {
+		return this->algo;
+	}
+	
+	void setSupportsRangeRequests(const bool supportsIt) {
+		supportsRangeRequests = supportsIt;
+	}
+	
+	bool getSupportsRangeRequests() const {
+		return supportsRangeRequests;
+	}
+	
+	void setRangeOffset(const int offset) {
+		supportsRangeRequests = offset >= 0 ? true : false;
+		rangeOffset = offset;
+	}
+	
+	int getRangeOffset() const {
+		return rangeOffset;
+	}
+
+private:
+	std::string name;
+	std::string description;
+	boost::uintmax_t size;
+	std::string hash;
+	boost::posix_time::ptime date;
+	std::string algo;
+	bool supportsRangeRequests;
+	boost::uintmax_t rangeOffset;
+};
+
 }
author	Tobias Markmann <tm@ayena.de>	2011-05-26 18:46:49 (GMT)
committer	Remko Tronçon <git@el-tramo.be>	2011-09-25 17:42:32 (GMT)
commit	4f62e5ec4b42929fe3c1a68667e63cb1b7a35509 (patch)
tree	0d19fac3f578dec00ccf3e58930312951e38de89 /Swiften/Elements
parent	de660b763459cdd707876ec244b6866abca07fa2 (diff)
download	swift-contrib-4f62e5ec4b42929fe3c1a68667e63cb1b7a35509.zip swift-contrib-4f62e5ec4b42929fe3c1a68667e63cb1b7a35509.tar.bz2