mirror of
https://github.com/RetroShare/RetroShare.git
synced 2024-10-01 02:35:48 -04:00
cfaaec31c7
- exchange of chunk availability maps from different peers
- correct handling of what is available to which source before asking the data
- correct display of chunks in the progress bars
- generalised the use of compressed chunk maps
- removed the size parameters from the hash search functions
- In addition:
- suppressed a number of per-value transfers of std::string
- improved the FileTransferInfo Widget, to show some additional info
Still to be done:
- chunk map exchange for non anonymous traffic (easy)
- improve accuracy of completion for uploads (for now it's a integer number of chunks)
- check compilation on windows
git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@1993 b45a01b8-16f6-495d-af2f-9b41ad6348cc
289 lines
11 KiB
C++
289 lines
11 KiB
C++
#pragma once
|
|
|
|
#include "serialiser/rsserial.h"
|
|
#include "serialiser/rstlvbase.h"
|
|
#include "serialiser/rsbaseserial.h"
|
|
#include "rsiface/rsturtle.h"
|
|
#include "rsiface/rsexpr.h"
|
|
#include "rsiface/rstypes.h"
|
|
#include "serialiser/rsserviceids.h"
|
|
#include "turtle/turtletypes.h"
|
|
|
|
const uint8_t RS_TURTLE_SUBTYPE_STRING_SEARCH_REQUEST = 0x01 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_SEARCH_RESULT = 0x02 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_OPEN_TUNNEL = 0x03 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_TUNNEL_OK = 0x04 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_CLOSE_TUNNEL = 0x05 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_TUNNEL_CLOSED = 0x06 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_FILE_REQUEST = 0x07 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_FILE_DATA = 0x08 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_REGEXP_SEARCH_REQUEST = 0x09 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_FILE_MAP = 0x10 ;
|
|
const uint8_t RS_TURTLE_SUBTYPE_FILE_MAP_REQUEST = 0x11 ;
|
|
|
|
/***********************************************************************************/
|
|
/* Basic Turtle Item Class */
|
|
/***********************************************************************************/
|
|
|
|
class RsTurtleItem: public RsItem
|
|
{
|
|
public:
|
|
RsTurtleItem(uint8_t turtle_subtype) : RsItem(RS_PKT_VERSION_SERVICE,RS_SERVICE_TYPE_TURTLE,turtle_subtype) {}
|
|
|
|
virtual bool serialize(void *data,uint32_t& size) = 0 ; // Isn't it better that items can serialize themselves ?
|
|
virtual uint32_t serial_size() = 0 ; // deserialise is handled using a constructor
|
|
|
|
virtual void clear() {}
|
|
};
|
|
|
|
/***********************************************************************************/
|
|
/* Turtle Search Item classes */
|
|
/* Specific packets */
|
|
/***********************************************************************************/
|
|
|
|
class RsTurtleSearchResultItem: public RsTurtleItem
|
|
{
|
|
public:
|
|
RsTurtleSearchResultItem() : RsTurtleItem(RS_TURTLE_SUBTYPE_SEARCH_RESULT) {}
|
|
RsTurtleSearchResultItem(void *data,uint32_t size) ; // deserialization
|
|
|
|
TurtleSearchRequestId request_id ; // Randomly generated request id.
|
|
|
|
uint16_t depth ; // The depth of a search result is obfuscated in this way:
|
|
// If the actual depth is 1, this field will be 1.
|
|
// If the actual depth is > 1, this field is a larger arbitrary integer.
|
|
|
|
std::list<TurtleFileInfo> result ;
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
|
|
protected:
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
class RsTurtleSearchRequestItem: public RsTurtleItem
|
|
{
|
|
public:
|
|
RsTurtleSearchRequestItem(uint32_t subtype) : RsTurtleItem(subtype) {}
|
|
|
|
virtual RsTurtleSearchRequestItem *clone() const = 0 ; // used for cloning in routing methods
|
|
virtual void performLocalSearch(std::list<TurtleFileInfo>&) const = 0 ; // abstracts the search method
|
|
|
|
uint32_t request_id ; // randomly generated request id.
|
|
uint16_t depth ; // Used for limiting search depth.
|
|
};
|
|
|
|
class RsTurtleStringSearchRequestItem: public RsTurtleSearchRequestItem
|
|
{
|
|
public:
|
|
RsTurtleStringSearchRequestItem() : RsTurtleSearchRequestItem(RS_TURTLE_SUBTYPE_STRING_SEARCH_REQUEST) {}
|
|
RsTurtleStringSearchRequestItem(void *data,uint32_t size) ;
|
|
|
|
std::string match_string ; // string to match
|
|
|
|
virtual RsTurtleSearchRequestItem *clone() const { return new RsTurtleStringSearchRequestItem(*this) ; }
|
|
virtual void performLocalSearch(std::list<TurtleFileInfo>&) const ;
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
protected:
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
class RsTurtleRegExpSearchRequestItem: public RsTurtleSearchRequestItem
|
|
{
|
|
public:
|
|
RsTurtleRegExpSearchRequestItem() : RsTurtleSearchRequestItem(RS_TURTLE_SUBTYPE_REGEXP_SEARCH_REQUEST) {}
|
|
RsTurtleRegExpSearchRequestItem(void *data,uint32_t size) ;
|
|
|
|
LinearizedExpression expr ; // Reg Exp in linearised mode
|
|
|
|
virtual RsTurtleSearchRequestItem *clone() const { return new RsTurtleRegExpSearchRequestItem(*this) ; }
|
|
virtual void performLocalSearch(std::list<TurtleFileInfo>&) const ;
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
protected:
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
/***********************************************************************************/
|
|
/* Turtle Tunnel Item classes */
|
|
/***********************************************************************************/
|
|
|
|
class RsTurtleOpenTunnelItem: public RsTurtleItem
|
|
{
|
|
public:
|
|
RsTurtleOpenTunnelItem() : RsTurtleItem(RS_TURTLE_SUBTYPE_OPEN_TUNNEL) {}
|
|
RsTurtleOpenTunnelItem(void *data,uint32_t size) ; // deserialization
|
|
|
|
TurtleFileHash file_hash ; // hash to match
|
|
uint32_t request_id ; // randomly generated request id.
|
|
uint32_t partial_tunnel_id ; // uncomplete tunnel id. Will be completed at destination.
|
|
uint16_t depth ; // Used for limiting search depth.
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
|
|
protected:
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
class RsTurtleTunnelOkItem: public RsTurtleItem
|
|
{
|
|
public:
|
|
RsTurtleTunnelOkItem() : RsTurtleItem(RS_TURTLE_SUBTYPE_TUNNEL_OK) {}
|
|
RsTurtleTunnelOkItem(void *data,uint32_t size) ; // deserialization
|
|
|
|
uint32_t tunnel_id ; // id of the tunnel. Should be identical for a tunnel between two same peers for the same hash.
|
|
uint32_t request_id ; // randomly generated request id corresponding to the intial request.
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
|
|
protected:
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
/***********************************************************************************/
|
|
/* Generic turtle packets for tunnels */
|
|
/***********************************************************************************/
|
|
|
|
class RsTurtleGenericTunnelItem: public RsTurtleItem
|
|
{
|
|
public:
|
|
RsTurtleGenericTunnelItem(uint8_t sub_packet_id) : RsTurtleItem(sub_packet_id) {}
|
|
|
|
typedef uint32_t Direction ;
|
|
static const Direction DIRECTION_CLIENT = 0x001 ;
|
|
static const Direction DIRECTION_SERVER = 0x002 ;
|
|
|
|
/// Does this packet stamps tunnels when it passes through ?
|
|
/// This is used for keeping trace weither tunnels are active or not.
|
|
|
|
virtual bool shouldStampTunnel() const = 0 ;
|
|
|
|
/// All tunnels derived from RsTurtleGenericTunnelItem should have a tunnel id to
|
|
/// indicate which tunnel they are travelling through.
|
|
|
|
virtual TurtleTunnelId tunnelId() const = 0 ;
|
|
|
|
/// Indicate weither the packet is a client packet (goign back to the
|
|
/// client) or a server packet (going to the server. Typically file
|
|
/// requests are server packets, whereas file data are client packets.
|
|
|
|
virtual Direction travelingDirection() const = 0 ;
|
|
};
|
|
|
|
/***********************************************************************************/
|
|
/* Turtle File Transfer item classes */
|
|
/***********************************************************************************/
|
|
|
|
class RsTurtleFileRequestItem: public RsTurtleGenericTunnelItem
|
|
{
|
|
public:
|
|
RsTurtleFileRequestItem() : RsTurtleGenericTunnelItem(RS_TURTLE_SUBTYPE_FILE_REQUEST) {}
|
|
RsTurtleFileRequestItem(void *data,uint32_t size) ; // deserialization
|
|
|
|
virtual bool shouldStampTunnel() const { return false ; }
|
|
virtual TurtleTunnelId tunnelId() const { return tunnel_id ; }
|
|
virtual Direction travelingDirection() const { return DIRECTION_SERVER ; }
|
|
|
|
uint32_t tunnel_id ; // id of the tunnel to travel through
|
|
uint64_t chunk_offset ;
|
|
uint32_t chunk_size ;
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
protected:
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
class RsTurtleFileDataItem: public RsTurtleGenericTunnelItem
|
|
{
|
|
public:
|
|
RsTurtleFileDataItem() : RsTurtleGenericTunnelItem(RS_TURTLE_SUBTYPE_FILE_DATA) {}
|
|
~RsTurtleFileDataItem() ;
|
|
RsTurtleFileDataItem(void *data,uint32_t size) ; // deserialization
|
|
|
|
virtual bool shouldStampTunnel() const { return true ; }
|
|
virtual TurtleTunnelId tunnelId() const { return tunnel_id ; }
|
|
virtual Direction travelingDirection() const { return DIRECTION_CLIENT ; }
|
|
|
|
uint32_t tunnel_id ; // id of the tunnel to travel through
|
|
uint64_t chunk_offset ; // offset in the file
|
|
uint32_t chunk_size ; // size of the file chunk
|
|
void *chunk_data ; // actual data.
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
class RsTurtleFileMapRequestItem: public RsTurtleGenericTunnelItem
|
|
{
|
|
public:
|
|
RsTurtleFileMapRequestItem() : RsTurtleGenericTunnelItem(RS_TURTLE_SUBTYPE_FILE_MAP_REQUEST) {}
|
|
RsTurtleFileMapRequestItem(void *data,uint32_t size) ; // deserialization
|
|
|
|
virtual bool shouldStampTunnel() const { return false ; }
|
|
virtual TurtleTunnelId tunnelId() const { return tunnel_id ; }
|
|
virtual Direction travelingDirection() const { return direction ; }
|
|
|
|
Direction direction ; // travel direction for this packet (server/client)
|
|
uint32_t tunnel_id ; // id of the tunnel to travel through. Also used for identifying the file source
|
|
// this info from the file size, but this allows a security check.
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
class RsTurtleFileMapItem: public RsTurtleGenericTunnelItem
|
|
{
|
|
public:
|
|
RsTurtleFileMapItem() : RsTurtleGenericTunnelItem(RS_TURTLE_SUBTYPE_FILE_MAP) {}
|
|
RsTurtleFileMapItem(void *data,uint32_t size) ; // deserialization
|
|
|
|
virtual bool shouldStampTunnel() const { return false ; }
|
|
virtual TurtleTunnelId tunnelId() const { return tunnel_id ; }
|
|
virtual Direction travelingDirection() const { return direction ; }
|
|
|
|
Direction direction ; // travel direction for this packet (server/client)
|
|
uint32_t tunnel_id ; // id of the tunnel to travel through. Also used for identifying the file source
|
|
// this info from the file size, but this allows a security check.
|
|
|
|
CompressedChunkMap compressed_map ; // Map info for the file in compressed format. Each *bit* in the array uint's says "I have" or "I don't have"
|
|
// by default, we suppose the peer has all the chunks. This info will thus be and-ed
|
|
// with the default file map for this source.
|
|
|
|
virtual std::ostream& print(std::ostream& o, uint16_t) ;
|
|
|
|
virtual bool serialize(void *data,uint32_t& size) ;
|
|
virtual uint32_t serial_size() ;
|
|
};
|
|
|
|
/***********************************************************************************/
|
|
/* Turtle Serialiser class */
|
|
/***********************************************************************************/
|
|
|
|
class RsTurtleSerialiser: public RsSerialType
|
|
{
|
|
public:
|
|
RsTurtleSerialiser() : RsSerialType(RS_PKT_VERSION_SERVICE, RS_SERVICE_TYPE_TURTLE) {}
|
|
|
|
virtual uint32_t size (RsItem *item)
|
|
{
|
|
return dynamic_cast<RsTurtleItem *>(item)->serial_size() ;
|
|
}
|
|
virtual bool serialise(RsItem *item, void *data, uint32_t *size)
|
|
{
|
|
return dynamic_cast<RsTurtleItem *>(item)->serialize(data,*size) ;
|
|
}
|
|
virtual RsItem *deserialise (void *data, uint32_t *size) ;
|
|
};
|
|
|