1 files changed, 239 insertions, 0 deletions
diff --git a/lib/server/Protocol.h b/lib/server/Protocol.h
new file mode 100644
index 00000000..7781ac7c
--- /dev/null
+++ b/lib/server/Protocol.h
@@ -0,0 +1,239 @@
+// distribution boxbackup-0.10 (svn version: 494)
+//  
+// Copyright (c) 2003 - 2006
+//      Ben Summers and contributors.  All rights reserved.
+//  
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions
+// are met:
+// 1. Redistributions of source code must retain the above copyright
+//    notice, this list of conditions and the following disclaimer.
+// 2. Redistributions in binary form must reproduce the above copyright
+//    notice, this list of conditions and the following disclaimer in the
+//    documentation and/or other materials provided with the distribution.
+// 3. All use of this software and associated advertising materials must 
+//    display the following acknowledgment:
+//        This product includes software developed by Ben Summers.
+// 4. The names of the Authors may not be used to endorse or promote
+//    products derived from this software without specific prior written
+//    permission.
+// 
+// [Where legally impermissible the Authors do not disclaim liability for 
+// direct physical injury or death caused solely by defects in the software 
+// unless it is modified by a third party.]
+// 
+// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
+// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+// DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT,
+// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//  
+//  
+//  
+// --------------------------------------------------------------------------
+//
+// File
+//		Name:    Protocol.h
+//		Purpose: Generic protocol support
+//		Created: 2003/08/19
+//
+// --------------------------------------------------------------------------
+
+#ifndef PROTOCOL__H
+#define PROTOCOL__H
+
+#include <sys/types.h>
+
+class IOStream;
+#include "ProtocolObject.h"
+#include <memory>
+#include <vector>
+#include <string>
+
+// default timeout is 15 minutes
+#define PROTOCOL_DEFAULT_TIMEOUT	(15*60*1000)
+// 16 default maximum object size -- should be enough
+#define PROTOCOL_DEFAULT_MAXOBJSIZE	(16*1024)
+
+// --------------------------------------------------------------------------
+//
+// Class
+//		Name:    Protocol
+//		Purpose: Generic command / response protocol support
+//		Created: 2003/08/19
+//
+// --------------------------------------------------------------------------
+class Protocol
+{
+public:
+	Protocol(IOStream &rStream);
+	virtual ~Protocol();
+	
+private:
+	Protocol(const Protocol &rToCopy);
+
+public:
+	void Handshake();
+	std::auto_ptr<ProtocolObject> Receive();
+	void Send(const ProtocolObject &rObject);
+	
+	std::auto_ptr<IOStream> ReceiveStream();
+	void SendStream(IOStream &rStream);
+	
+	enum
+	{
+		NoError = -1,
+		UnknownError = 0
+	};
+
+	bool GetLastError(int &rTypeOut, int &rSubTypeOut);
+
+	// --------------------------------------------------------------------------
+	//
+	// Function
+	//		Name:    Protocol::SetTimeout(int)
+	//		Purpose: Sets the timeout for sending and reciving
+	//		Created: 2003/08/19
+	//
+	// --------------------------------------------------------------------------	
+	void SetTimeout(int NewTimeout) {mTimeout = NewTimeout;}
+	
+	
+	// --------------------------------------------------------------------------
+	//
+	// Function
+	//		Name:    Protocol::GetTimeout() 
+	//		Purpose: Get current timeout for sending and receiving
+	//		Created: 2003/09/06
+	//
+	// --------------------------------------------------------------------------
+	int GetTimeout() {return mTimeout;}
+
+	// --------------------------------------------------------------------------
+	//
+	// Function
+	//		Name:    Protocol::SetMaxObjectSize(int)
+	//		Purpose: Sets the maximum size of an object which will be accepted
+	//		Created: 2003/08/19
+	//
+	// --------------------------------------------------------------------------	
+	void SetMaxObjectSize(unsigned int NewMaxObjSize) {mMaxObjectSize = NewMaxObjSize;}
+
+	// For ProtocolObject derived classes
+	void Read(void *Buffer, int Size);
+	void Read(std::string &rOut, int Size);
+	void Read(int64_t &rOut);
+	void Read(int32_t &rOut);
+	void Read(int16_t &rOut);
+	void Read(int8_t &rOut);
+	void Read(bool &rOut) {int8_t read; Read(read); rOut = (read == true);}
+	void Read(std::string &rOut);
+	template<typename type>
+	void Read(type &rOut)
+	{
+		rOut.ReadFromProtocol(*this);
+	}
+	// --------------------------------------------------------------------------
+	//
+	// Function
+	//		Name:    Protocol::ReadVector(std::vector<> &)
+	//		Purpose: Reads a vector/list of items from the stream
+	//		Created: 2003/08/19
+	//
+	// --------------------------------------------------------------------------
+	template<typename type>
+	void ReadVector(std::vector<type> &rOut)
+	{
+		rOut.clear();
+		int16_t num = 0;
+		Read(num);
+		for(int16_t n = 0; n < num; ++n)
+		{
+			type v;
+			Read(v);
+			rOut.push_back(v);
+		}
+	}
+	
+	void Write(const void *Buffer, int Size);
+	void Write(int64_t Value);
+	void Write(int32_t Value);
+	void Write(int16_t Value);
+	void Write(int8_t Value);
+	void Write(bool Value) {int8_t write = Value; Write(write);}
+	void Write(const std::string &rValue);
+	template<typename type>
+	void Write(const type &rValue)
+	{
+		rValue.WriteToProtocol(*this);
+	}
+	template<typename type>
+	// --------------------------------------------------------------------------
+	//
+	// Function
+	//		Name:    Protocol::WriteVector(const std::vector<> &)
+	//		Purpose: Writes a vector/list of items from the stream
+	//		Created: 2003/08/19
+	//
+	// --------------------------------------------------------------------------
+	void WriteVector(const std::vector<type> &rValue)
+	{
+		int16_t num = rValue.size();
+		Write(num);
+		for(int16_t n = 0; n < num; ++n)
+		{
+			Write(rValue[n]);
+		}
+	}
+
+public:
+	static const uint16_t sProtocolStreamHeaderLengths[256];
+	enum
+	{
+		ProtocolStreamHeader_EndOfStream = 0,
+		ProtocolStreamHeader_MaxEncodedSizeValue = 252,
+		ProtocolStreamHeader_SizeIs64k = 253,
+		ProtocolStreamHeader_Reserved1 = 254,
+		ProtocolStreamHeader_Reserved2 = 255
+	};
+	enum
+	{
+		ProtocolStream_SizeUncertain = 0xffffffff
+	};
+
+protected:	
+	virtual std::auto_ptr<ProtocolObject> MakeProtocolObject(int ObjType) = 0;
+	virtual const char *GetIdentString() = 0;
+	void SetError(int Type, int SubType) {mLastErrorType = Type; mLastErrorSubType = SubType;}
+	void CheckAndReadHdr(void *hdr);	// don't use type here to avoid dependency
+	
+	// Will be used for logging
+	virtual void InformStreamReceiving(u_int32_t Size);
+	virtual void InformStreamSending(u_int32_t Size);
+	
+private:
+	void EnsureBufferAllocated(int Size);
+	int SendStreamSendBlock(uint8_t *Block, int BytesInBlock);
+
+private:
+	IOStream &mrStream;
+	bool mHandshakeDone;
+	unsigned int mMaxObjectSize;
+	int mTimeout;
+	char *mpBuffer;
+	int mBufferSize;
+	int mReadOffset;
+	int mWriteOffset;
+	int mValidDataSize;
+	int mLastErrorType;
+	int mLastErrorSubType;
+};
+
+#endif // PROTOCOL__H
+