protocolTypes.h

/*
 * protocolTypes.h
 *
 *  Created on: May 10, 2021
 *      Author: rony
 */

#ifndef PROTOCOLTYPES_H_
#define PROTOCOLTYPES_H_

#define VERSION_MAJOR 1
#define VERSION_MINOR 4
#define VERSION_REVISION 0
#define VERSION_STRING "1.4.0"
#define RELEASE_TYPE 'U'
#define MAIN_LISTEN_PORTNUMBER 30302
#define BROADCAST_PORTNUMBER 30301


#define COMMAND_SEND_FILE	0x00000000
#define COMMAND_RUN			0x00000001
#define COMMAND_CLOSE		0x00000002
#define COMMAND_MKDIR		0x00000003
#define COMMAND_DIR			0x00000004
#define COMMAND_GET_FILE	0x00000005

#define MAGIC_TOKEN		0xAABBCCDD
#define MAX_MESSAGE_LENGTH 0x8800
#define FILE_CHUNK_SIZE 0x8000
#define MAX_FILEPATH_LENGTH 256

typedef enum
{
	//New Connection Signalling
    PMT_NEW_CLIENT_PORT     = 0x00000001,
    PMT_VERSION             = 0x00000002,
    PMT_GET_VERSION         = 0x00000003,
    PMT_SHUTDOWN_SERVER     = 0x00000004,
    PMT_ACK                 = 0x00000005,
    PMT_CANCEL_OPERATION    = 0x00000006,
	PMT_FAILED				= 0x00000007,
	PMT_CLOSING				= 0x00000008,

	//File operations
    PMT_START_OF_SEND_FILE  = 0x00000010,
    PMT_FILE_CHUNK          = 0x00000011,
    PMT_CLOSE               = 0x00000012,
    PMT_MKDIR               = 0x00000013,
    PMT_GET_DIR_LIST        = 0x00000014,
    PMT_DIR_LIST            = 0x00000015,
    PMT_GET_FILE            = 0x00000016,
	PMT_PUT_FILE			= 0x00000017,
	PMT_DELETE_PATH			= 0x00000018,
	PMT_GET_VOLUMES			= 0x00000019,
	PMT_VOLUME_LIST			= 0x0000001A,
	PMT_RENAME_FILE			= 0x0000001B,
	PMT_FILE_CHUNK_CONF		= 0x0000001C,
	PMT_FILE_PUT_CONF		= 0x0000001D,
	PMT_PATH_DELETED		= 0x0000001E,

	//Device Discovery
	PMT_DEVICE_DISCOVERY	= 0x00000020,
	PMT_DEVICE_ANNOUNCE		= 0x00000021,
	PMT_PING				= 0x00000022,
	PMT_PONG				= 0x00000023,

	//remote commands
    PMT_RUN                 = 0x00000021,
	PMT_REBOOT				= 0x00000022,

	//Remote shell
	PMT_SHELL_EXEC			= 0x00000030,	// Client→Server: execute a command
	PMT_SHELL_OUTPUT		= 0x00000031,	// Server→Client: stdout/stderr chunk
	PMT_SHELL_DONE			= 0x00000032,	// Server→Client: command finished + exit code
	PMT_SHELL_COMPLETE_REQ	= 0x00000033,	// Client→Server: tab-completion request
	PMT_SHELL_COMPLETE_RSP	= 0x00000034,	// Server→Client: completion candidates

    PMT_INVALID             = 0x00000035
} ProtocolMessageType_t;

typedef struct
{
	unsigned int token;				//This token must be present at the begining of every message
	unsigned int type;				//The ProtocolMessageType_t
	unsigned int length;			//The length of this message including the payload
} ProtocolMessage_t;

typedef enum
{
	AT_NOK = 0,
	AT_OK = 1,
	AT_DEST_EXISTS_AS_FILE = 2,
	AT_DEST_EXISTS_AS_DIR = 3,
	AT_UNKNOWN = 255
} AckTypes_t;

typedef struct
{
    ProtocolMessage_t header;
	char response;					//User defined by 0 reject and !0 is accepted generally speaking
	char padding[ 3 ];
} ProtocolMessage_Ack_t;


//This is a signal from the server informing the client to reconnect on a new port
typedef struct
{
	ProtocolMessage_t header;
	unsigned short port;			//The new port for this client.
} ProtocolMessageNewClientPort_t;

typedef struct
{
	ProtocolMessage_t header;
	char message[128];
} ProtocolMessageDisconnect_t;


typedef enum
{
	DET_ROOT 	= 0x00000001,
	DET_USERDIR	= 0x00000002,
	DET_SOFTLINK= 0x00000003,
	DET_LINKDIR	= 0x00000004,
	DET_FILE	= 0xFFFFFFFD,
	DET_LINKFILE= 0xFFFFFFFC,
	DET_PIPEFILE= 0xFFFFFFFB
} DirEntType_t;

typedef struct
{
	unsigned int entrySize;			//The size of this entry
	unsigned int type;				//See DirEntType_t
	unsigned int size;				//File size in bytes
	//unsigned int filenameLength;	//The length of the filename
	char filename[1];				//The filename as a null terminated c-string
} ProtocolMessage_DirEntry_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int entryCount;
	ProtocolMessage_DirEntry_t entries[1];
} ProtocolMessageDirectoryList_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int length;
	char path[1];
} ProtocolMessageGetDirectoryList_t;

typedef struct
{
	ProtocolMessage_t header;
    char reason[ 128 ];
} ProtocolMessage_QuitServer_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned char major;
	unsigned char minor;
	unsigned char rev;
	char releaseType;	//R = Released version, U = Unreleased
} ProtocolMessage_Version_t;

typedef struct
{
	ProtocolMessage_t header;
	char filePath[1];
} ProtocolMessage_FilePull_t;

typedef struct
{
	ProtocolMessage_t header;
	char filePath[1];
} ProtocolMessage_FilePut_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int fileSize;
	unsigned int numberOfFileChunks;
	char filePath[1];
} ProtocolMessage_StartOfFileSend_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int chunkNumber;
    unsigned int bytesContained;
    char chunk[ FILE_CHUNK_SIZE ];
} ProtocolMessage_FileChunk_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int chunkNumber;
} ProtocolMessage_FileChunkConfirm_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int chunkCount;
	unsigned int filesize;
	unsigned int checksum;
} ProtocolMessage_FilePutConfirm_t;

typedef struct
{
	ProtocolMessage_t header;
	char filePath[1];
} ProtocolMessage_MakeDir_t;

typedef struct
{
	ProtocolMessage_t header;
    unsigned int entryType;
	char filePath[1];
} ProtocolMessage_DeletePath_t;

typedef enum
{
	DFR_NONE = 0x00,
	DFR_FILE_IN_USE = 0x01,
	DFR_PATH_NOT_FOUND = 0x02,
	DFR_OPERATION_ALREADY_UNDERWAY = 0x03,
	DFR_INVALID_PATH = 0x04,
	DFR_UNKNOWN = 0x05
} DeleteFailureReason;

typedef struct
{
	ProtocolMessage_t header;
	char deleteSucceeded;	//0 = no.  1 = yes
	char deleteCompleted;	//0 = no.  1 = yes.  Only used for recursive deletion
	DeleteFailureReason failureReason;
	char padding;
	char filePath[1];
} ProtocolMessage_PathDeleted_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned short oldNameSize;
	unsigned short newNameSize;
	char filePaths[1];		//The old name shall be encoded first, then a NULL, then the new name and finally a NULL;
} ProtocolMessage_RenamePath_t;

typedef struct
{
	ProtocolMessage_t header;
} ProtocolMessage_GetVolumeList_t;

typedef struct
{
	unsigned int entrySize;
	unsigned int diskType;
    unsigned int id_NumSoftErrors;
    unsigned int id_UnitNumber;
    unsigned int id_DiskState;
    unsigned int id_NumBlocks;
    unsigned int id_NumBlocksUsed;
    unsigned int id_BytesPerBlock;
    unsigned int id_DiskType;
    unsigned int id_InUse;
	char name[1];
} VolumeEntry_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int volumeCount;
	VolumeEntry_t volumes[ 1 ];
} ProtocolMessage_VolumeList_t;

typedef struct
{
	ProtocolMessage_t header;
	char command[1];
} ProtocolMessage_Run_t;

typedef struct
{
	ProtocolMessage_t header;
} ProtocolMessage_DeviceDiscovery_t;

typedef struct
{
	ProtocolMessage_t header;
    char name[32];
    char osName[32];
	char osVersion[32];
    char hardware[32];
} ProtocolMessage_DeviceAnnouncement_t;

typedef struct
{
	ProtocolMessage_t header;
} ProtocolMessage_Reboot_t;

typedef struct
{
	ProtocolMessage_t header;
} ProtocolMessage_CancelOperation_t;

typedef struct
{
	ProtocolMessage_t header;
	char message[1];
} ProtocolMessage_Failed_t;

typedef struct
{
	ProtocolMessage_t header;
	char command[1];
} ProtocolMessage_ShellExec_t;

typedef struct
{
	ProtocolMessage_t header;
	char partial[512];	// partial path token to complete
} ProtocolMessage_ShellCompleteReq_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int entryCount;
	char entries[1];	// entryCount null-terminated strings packed together
} ProtocolMessage_ShellCompleteRsp_t;

typedef struct
{
	ProtocolMessage_t header;
	unsigned int bytesContained;
	char output[FILE_CHUNK_SIZE];
} ProtocolMessage_ShellOutput_t;

typedef struct
{
	ProtocolMessage_t header;
	int returnCode;
	char currentDir[256];	// current directory after command (null-terminated)
} ProtocolMessage_ShellDone_t;

#endif /* PROTOCOLTYPES_H_ */