RetroShare/libretroshare/src/serialiser/rsbaseitems.h

#ifndef RS_BASE_ITEMS_H
#define RS_BASE_ITEMS_H

/*
 * libretroshare/src/serialiser: rsbaseitems.h
 *
 * RetroShare Serialiser.
 *
 * Copyright 2007-2008 by Robert Fernie.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License Version 2 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 *
 * Please report all bugs and problems to "retroshare@lunamutt.com".
 *
 */

#include <map>

#include "retroshare/rstypes.h"
#include "serialiser/rsserial.h"
#include "serialiser/rstlvtypes.h"

const uint8_t RS_PKT_TYPE_FILE          = 0x01;
const uint8_t RS_PKT_TYPE_CACHE         = 0x02;

const uint8_t RS_PKT_SUBTYPE_FI_REQUEST            = 0x01;
const uint8_t RS_PKT_SUBTYPE_FI_DATA               = 0x02;
const uint8_t RS_PKT_SUBTYPE_FI_TRANSFER           = 0x03;
const uint8_t RS_PKT_SUBTYPE_FI_CHUNK_MAP_REQUEST  = 0x04;
const uint8_t RS_PKT_SUBTYPE_FI_CHUNK_MAP          = 0x05;
const uint8_t RS_PKT_SUBTYPE_FI_CRC32_MAP_REQUEST  = 0x06;
const uint8_t RS_PKT_SUBTYPE_FI_CRC32_MAP          = 0x07;
const uint8_t RS_PKT_SUBTYPE_FI_CHUNK_CRC_REQUEST  = 0x08;
const uint8_t RS_PKT_SUBTYPE_FI_CHUNK_CRC          = 0x09;

const uint8_t RS_PKT_SUBTYPE_CACHE_ITEM    = 0x01;
const uint8_t RS_PKT_SUBTYPE_CACHE_REQUEST = 0x02;

/**************************************************************************/

class RsFileRequest: public RsItem
{
	public:
	RsFileRequest() 
	:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, 
		RS_PKT_TYPE_FILE,
		RS_PKT_SUBTYPE_FI_REQUEST)
	{ 
		setPriorityLevel(QOS_PRIORITY_RS_FILE_REQUEST) ;
	}
virtual ~RsFileRequest();
virtual void clear();
std::ostream &print(std::ostream &out, uint16_t indent = 0);

	uint64_t fileoffset;  /* start of data requested */
	uint32_t chunksize;   /* size of data requested */
	RsTlvFileItem file;   /* file information */
};

/**************************************************************************/

class RsFileData: public RsItem
{
	public:
	RsFileData() 
	:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, 
		RS_PKT_TYPE_FILE, 
		RS_PKT_SUBTYPE_FI_DATA)
	{ 
		setPriorityLevel(QOS_PRIORITY_RS_FILE_DATA) ;	
	}
virtual ~RsFileData();
virtual void clear();
std::ostream &print(std::ostream &out, uint16_t indent = 0);

	RsTlvFileData fd;
};

class RsFileChunkMapRequest: public RsItem
{
	public:
		RsFileChunkMapRequest() 
			:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, RS_PKT_TYPE_FILE, RS_PKT_SUBTYPE_FI_CHUNK_MAP_REQUEST)
		{
			setPriorityLevel(QOS_PRIORITY_RS_FILE_MAP_REQUEST) ;
		}
		virtual ~RsFileChunkMapRequest() {}
		virtual void clear() {}

		bool is_client ; 		// is the request for a client, or a server ? 
		std::string hash ;	// hash of the file for which we request the chunk map

		std::ostream &print(std::ostream &out, uint16_t indent = 0);
};

class RsFileChunkMap: public RsItem
{
	public:
		RsFileChunkMap() 
			:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, RS_PKT_TYPE_FILE, RS_PKT_SUBTYPE_FI_CHUNK_MAP)
		{
			setPriorityLevel(QOS_PRIORITY_RS_FILE_MAP) ;
		}
		virtual ~RsFileChunkMap() {}
		virtual void clear() {}

		bool is_client ; 		// is the request for a client, or a server ? 
		std::string hash ;	// hash of the file for which we request the chunk map
		CompressedChunkMap compressed_map ; // Chunk map of the file.

		std::ostream &print(std::ostream &out, uint16_t indent = 0);
};

class RsFileCRC32MapRequest: public RsItem
{
	public:
		RsFileCRC32MapRequest() 
			:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, RS_PKT_TYPE_FILE, RS_PKT_SUBTYPE_FI_CRC32_MAP_REQUEST)
		{
			setPriorityLevel(QOS_PRIORITY_RS_FILE_CRC_REQUEST) ;
		}
		virtual ~RsFileCRC32MapRequest() {}
		virtual void clear() {}

		std::string hash ;	// hash of the file for which we request the chunk map

		std::ostream &print(std::ostream &out, uint16_t indent = 0);
};

class RsFileSingleChunkCrcRequest: public RsItem
{
	public:
		RsFileSingleChunkCrcRequest() 
			:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, RS_PKT_TYPE_FILE, RS_PKT_SUBTYPE_FI_CHUNK_CRC_REQUEST)
		{
			setPriorityLevel(QOS_PRIORITY_RS_CHUNK_CRC_REQUEST) ;
		}
		virtual ~RsFileSingleChunkCrcRequest() {}
		virtual void clear() {}

		std::string hash ;		// hash of the file for which we request the crc 
		uint32_t chunk_number ;	// chunk number

		std::ostream &print(std::ostream &out, uint16_t indent = 0);
};


class RsFileCRC32Map: public RsItem
{
	public:
		RsFileCRC32Map() 
			:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, RS_PKT_TYPE_FILE, RS_PKT_SUBTYPE_FI_CRC32_MAP)
		{
			setPriorityLevel(QOS_PRIORITY_RS_FILE_CRC) ;
		}
		virtual ~RsFileCRC32Map() {}
		virtual void clear() {}

		std::string hash ; // hash of the file for which we request the chunk map
		CRC32Map crc_map ; // CRC32 map of the file.

		std::ostream &print(std::ostream &out, uint16_t indent = 0);
};

class RsFileSingleChunkCrc: public RsItem
{
	public:
		RsFileSingleChunkCrc() 
			:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, RS_PKT_TYPE_FILE, RS_PKT_SUBTYPE_FI_CHUNK_CRC)
		{
			setPriorityLevel(QOS_PRIORITY_RS_CHUNK_CRC) ;
		}
		virtual ~RsFileSingleChunkCrc() {}
		virtual void clear() {}

		std::string hash ; // hash of the file for which we request the chunk map
		uint32_t chunk_number ;
		Sha1CheckSum check_sum ; // CRC32 map of the file.

		std::ostream &print(std::ostream &out, uint16_t indent = 0);
};

/**************************************************************************/

class RsFileItemSerialiser: public RsSerialType
{
	public:
		RsFileItemSerialiser()
			:RsSerialType(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, 
					RS_PKT_TYPE_FILE)
	{ return; }
		virtual     ~RsFileItemSerialiser() { return; }

		virtual	uint32_t    size(RsItem *);
		virtual	bool        serialise  (RsItem *item, void *data, uint32_t *size);
		virtual	RsItem *    deserialise(void *data, uint32_t *size);

	private:

		/* sub types */
		virtual	uint32_t    sizeReq(RsFileRequest *);
		virtual	uint32_t    sizeData(RsFileData *);
		virtual	uint32_t    sizeChunkMapReq(RsFileChunkMapRequest *);
		virtual	uint32_t    sizeChunkMap(RsFileChunkMap *);
		virtual	uint32_t    sizeChunkCrcReq(RsFileSingleChunkCrcRequest *);
		virtual	uint32_t    sizeChunkCrc(RsFileSingleChunkCrc *);
		virtual	uint32_t    sizeCRC32MapReq(RsFileCRC32MapRequest *);
		virtual	uint32_t    sizeCRC32Map(RsFileCRC32Map *);

		virtual	bool        serialiseReq (RsFileRequest *item, void *data, uint32_t *size);
		virtual	bool        serialiseData (RsFileData *item, void *data, uint32_t *size);
		virtual	bool        serialiseChunkMapReq(RsFileChunkMapRequest *item, void *data, uint32_t *size);
		virtual	bool        serialiseChunkMap(RsFileChunkMap *item, void *data, uint32_t *size);
		virtual	bool        serialiseCRC32MapReq(RsFileCRC32MapRequest *item, void *data, uint32_t *size);
		virtual	bool        serialiseCRC32Map(RsFileCRC32Map *item, void *data, uint32_t *size);
		virtual	bool        serialiseChunkCrcReq(RsFileSingleChunkCrcRequest *item, void *data, uint32_t *size);
		virtual	bool        serialiseChunkCrc(RsFileSingleChunkCrc *item, void *data, uint32_t *size);

		virtual	RsFileRequest         *deserialiseReq(void *data, uint32_t *size);
		virtual	RsFileData            *deserialiseData(void *data, uint32_t *size);
		virtual	RsFileChunkMapRequest *deserialiseChunkMapReq(void *data, uint32_t *size);
		virtual	RsFileChunkMap        *deserialiseChunkMap(void *data, uint32_t *size);
		virtual	RsFileCRC32MapRequest *deserialiseCRC32MapReq(void *data, uint32_t *size);
		virtual	RsFileCRC32Map        *deserialiseCRC32Map(void *data, uint32_t *size);
		virtual	RsFileSingleChunkCrcRequest     *deserialiseChunkCrcReq(void *data, uint32_t *size);
		virtual	RsFileSingleChunkCrc            *deserialiseChunkCrc(void *data, uint32_t *size);
};

/**************************************************************************/

class RsCacheRequest: public RsItem
{
	public:
	RsCacheRequest() 
	:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, 
		RS_PKT_TYPE_CACHE,
		RS_PKT_SUBTYPE_CACHE_REQUEST)
	{ 
		setPriorityLevel(QOS_PRIORITY_RS_CACHE_REQUEST); 
	}
virtual ~RsCacheRequest();
virtual void clear();
std::ostream &print(std::ostream &out, uint16_t indent = 0);

	uint16_t cacheType;
	uint16_t cacheSubId;
	RsTlvFileItem file;   /* file information */
};

/**************************************************************************/

class RsCacheItem: public RsItem
{
	public:
	RsCacheItem() 
	:RsItem(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, 
		RS_PKT_TYPE_CACHE,
		RS_PKT_SUBTYPE_CACHE_ITEM)
	{ 
		setPriorityLevel(QOS_PRIORITY_RS_CACHE_ITEM); 
	}
virtual ~RsCacheItem();
virtual void clear();
std::ostream &print(std::ostream &out, uint16_t indent = 0);

	uint16_t cacheType;
	uint16_t cacheSubId;
	RsTlvFileItem file;   /* file information */
};

/**************************************************************************/

class RsCacheItemSerialiser: public RsSerialType
{
	public:
	RsCacheItemSerialiser()
	:RsSerialType(RS_PKT_VERSION1, RS_PKT_CLASS_BASE, 
		RS_PKT_TYPE_CACHE)
	{ return; }
virtual     ~RsCacheItemSerialiser() { return; }
	
virtual	uint32_t    size(RsItem *);
virtual	bool        serialise  (RsItem *item, void *data, uint32_t *size);
virtual	RsItem *    deserialise(void *data, uint32_t *size);

	private:

	/* sub types */
virtual	uint32_t    sizeReq(RsCacheRequest *);
virtual	bool        serialiseReq (RsCacheRequest *item, void *data, uint32_t *size);
virtual	RsCacheRequest *  deserialiseReq(void *data, uint32_t *size);

virtual	uint32_t    sizeItem(RsCacheItem *);
virtual	bool        serialiseItem (RsCacheItem *item, void *data, uint32_t *size);
virtual	RsCacheItem *  deserialiseItem(void *data, uint32_t *size);

};

/**************************************************************************/

class RsServiceSerialiser: public RsSerialType
{
	public:
	RsServiceSerialiser()
	:RsSerialType(RS_PKT_VERSION_SERVICE, 0, 0)
	{ return; }
virtual     ~RsServiceSerialiser()
	{ return; }
	
virtual	uint32_t    size(RsItem *);
virtual	bool        serialise  (RsItem *item, void *data, uint32_t *size);
virtual	RsItem *    deserialise(void *data, uint32_t *size);

};

/**************************************************************************/

#endif