storage_client.h

/**
* Copyright (C) 2008 Happy Fish / YuQing
*
* FastDFS may be copied only under the terms of the GNU General
* Public License V3, which may be found in the FastDFS source kit.
* Please visit the FastDFS Home Page http://www.csource.org/ for more detail.
**/

#ifndef STORAGE_CLIENT_H
#define STORAGE_CLIENT_H

#include "tracker_types.h"
#include "client_func.h"

#define FDFS_DOWNLOAD_TO_BUFF   	1
#define FDFS_DOWNLOAD_TO_FILE   	2
#define FDFS_DOWNLOAD_TO_CALLBACK   	3

#define FDFS_UPLOAD_BY_BUFF   	1
#define FDFS_UPLOAD_BY_FILE   	2
#define FDFS_UPLOAD_BY_CALLBACK 3

#define FDFS_FILE_ID_SEPERATOR		'/'
#define FDFS_FILE_ID_SEPERATE_STR	"/"

#ifdef __cplusplus
extern "C" {
#endif

#define storage_upload_by_filename(pTrackerServer, \
		pStorageServer, store_path_index, local_filename, \
		file_ext_name, meta_list, meta_count, group_name, \
		remote_filename) \
	storage_upload_by_filename_ex(pTrackerServer, \
		pStorageServer, store_path_index, \
		STORAGE_PROTO_CMD_UPLOAD_FILE, local_filename, \
		file_ext_name, meta_list, meta_count, group_name, \
		remote_filename)

#define storage_upload_appender_by_filename(pTrackerServer, \
		pStorageServer, store_path_index, local_filename, \
		file_ext_name, meta_list, meta_count, group_name, \
		remote_filename) \
	storage_upload_by_filename_ex(pTrackerServer, \
		pStorageServer, store_path_index, \
		STORAGE_PROTO_CMD_UPLOAD_APPENDER_FILE, local_filename, \
		file_ext_name, meta_list, meta_count, group_name, \
		remote_filename)

/**
* upload file to storage server (by file name)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       store_path_index: the index of path on the storage server
*       local_filename: local filename to upload
*       cmd: the protocol command
*       file_ext_name: file ext name, not include dot(.), 
*                      if be NULL will abstract ext name from the local filename
*	meta_list: meta info array
*       meta_count: meta item count
*	group_name: if not empty, specify the group name. 
	 	    return the group name to store the file
*	remote_filename: return the new created filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_upload_by_filename_ex(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const int store_path_index, \
		const char cmd, const char *local_filename, \
		const char *file_ext_name, const FDFSMetaData *meta_list, \
		const int meta_count, char *group_name, char *remote_filename);

/**
* upload file to storage server (by file buff)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       store_path_index: the index of path on the storage server
*       file_buff: file content/buff
*       file_size: file size (bytes)
*       file_ext_name: file ext name, not include dot(.), can be NULL
*	meta_list: meta info array
*       meta_count: meta item count
*	group_name: if not empty, specify the group name. 
		    return the group name to store the file
*	remote_filename: return the new created filename
* return: 0 success, !=0 fail, return the error code
**/
#define storage_upload_by_filebuff(pTrackerServer, pStorageServer, \
		store_path_index, file_buff, \
		file_size, file_ext_name, meta_list, meta_count, \
		group_name, remote_filename) \
	storage_do_upload_file(pTrackerServer, pStorageServer, \
		store_path_index, STORAGE_PROTO_CMD_UPLOAD_FILE, \
		FDFS_UPLOAD_BY_BUFF, file_buff, NULL, \
		file_size, NULL, NULL, file_ext_name, meta_list, meta_count, \
		group_name, remote_filename)

#define storage_upload_appender_by_filebuff(pTrackerServer, pStorageServer, \
		store_path_index, file_buff, \
		file_size, file_ext_name, meta_list, meta_count, \
		group_name, remote_filename) \
	storage_do_upload_file(pTrackerServer, pStorageServer, \
		store_path_index, STORAGE_PROTO_CMD_UPLOAD_APPENDER_FILE, \
		FDFS_UPLOAD_BY_BUFF, file_buff, NULL, \
		file_size, NULL, NULL, file_ext_name, meta_list, meta_count, \
		group_name, remote_filename)

/**
* Upload file callback function prototype
* params:
*	arg: callback extra arguement
*       sock: connected storage socket for sending file content
* return: 0 success, !=0 fail, should return the error code
**/
typedef int (*UploadCallback) (void *arg, const int64_t file_size, int sock);

/**
* upload file to storage server (by callback)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       store_path_index: the index of path on the storage server
*       callback: callback function to send file content to storage server
*       arg: callback extra arguement
*       file_size: the file size
*       file_ext_name: file ext name, not include dot(.), can be NULL
*	meta_list: meta info array
*       meta_count: meta item count
*	group_name: if not empty, specify the group name. 
	 	    return the group name to store the file
*	remote_filename: return the new created filename
* return: 0 success, !=0 fail, return the error code
**/
#define storage_upload_by_callback(pTrackerServer, pStorageServer, \
		store_path_index, callback, arg, file_size, file_ext_name, \
		meta_list, meta_count, group_name, remote_filename) \
	storage_upload_by_callback_ex(pTrackerServer, pStorageServer, \
		store_path_index, STORAGE_PROTO_CMD_UPLOAD_FILE, \
		callback, arg, file_size, file_ext_name, meta_list, \
		meta_count, group_name, remote_filename)

#define storage_upload_appender_by_callback(pTrackerServer, pStorageServer, \
		store_path_index, callback, arg, file_size, file_ext_name, \
		meta_list, meta_count, group_name, remote_filename) \
	storage_upload_by_callback_ex(pTrackerServer, pStorageServer, \
		store_path_index, STORAGE_PROTO_CMD_UPLOAD_APPENDER_FILE, \
		callback, arg, file_size, file_ext_name, meta_list, \
		meta_count, group_name, remote_filename)

int storage_upload_by_callback_ex(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const int store_path_index, \
		const char cmd, UploadCallback callback, void *arg, \
		const int64_t file_size, const char *file_ext_name, \
		const FDFSMetaData *meta_list, const int meta_count, \
		char *group_name, char *remote_filename);

int storage_do_upload_file(ConnectionInfo *pTrackerServer, \
	ConnectionInfo *pStorageServer, const int store_path_index, \
	const char cmd, const int upload_type, const char *file_buff, \
	void *arg, const int64_t file_size, const char *master_filename, \
	const char *prefix_name, const char *file_ext_name, \
	const FDFSMetaData *meta_list, const int meta_count, \
	char *group_name, char *remote_filename);

/**
* delete file from storage server
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	filename: filename on storage server
* return: 0 success, !=0 fail, return the error code
**/
int storage_delete_file(ConnectionInfo *pTrackerServer, \
			ConnectionInfo *pStorageServer, \
			const char *group_name, const char *filename);

/**
* download file from storage server
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	remote_filename: filename on storage server
*       file_buff: return file content/buff, must be freed
*       file_size: return file size (bytes)
* return: 0 success, !=0 fail, return the error code
**/
#define storage_download_file(pTrackerServer, pStorageServer, group_name, \
			remote_filename, file_buff, file_size)  \
	storage_do_download_file_ex(pTrackerServer, pStorageServer, \
			FDFS_DOWNLOAD_TO_BUFF, group_name, remote_filename, \
			0, 0, file_buff, NULL, file_size)

#define storage_download_file_to_buff(pTrackerServer, pStorageServer, \
			group_name, remote_filename, file_buff, file_size)  \
	storage_do_download_file_ex(pTrackerServer, pStorageServer, \
			FDFS_DOWNLOAD_TO_BUFF, group_name, remote_filename, \
			0, 0, file_buff, NULL, file_size)

#define storage_do_download_file(pTrackerServer, pStorageServer, \
		download_type, group_name, remote_filename, \
		file_buff, arg, file_size) \
	storage_do_download_file_ex(pTrackerServer, pStorageServer, \
		download_type, group_name, remote_filename, \
		0, 0, file_buff, arg, file_size);

/**
* download file from storage server
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       download_type: FDFS_DOWNLOAD_TO_BUFF or FDFS_DOWNLOAD_TO_FILE 
*                      or FDFS_DOWNLOAD_TO_CALLBACK
*	group_name: the group name of storage server
*	remote_filename: filename on storage server
*       file_offset: the start offset to download
*       download_bytes: download bytes, 0 means from start offset to the file end
*       file_buff: return file content/buff, must be freed
*       arg: additional argument for callback(valid only when download_tyee
*                       is FDFS_DOWNLOAD_TO_CALLBACK), can be NULL
*       file_size: return file size (bytes)
* return: 0 success, !=0 fail, return the error code
**/
int storage_do_download_file_ex(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, \
		const int download_type, \
		const char *group_name, const char *remote_filename, \
		const int64_t file_offset, const int64_t download_bytes, \
		char **file_buff, void *arg, int64_t *file_size);

/**
* download file from storage server
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	remote_filename: filename on storage server
*	local_filename: local filename to write
*       file_size: return file size (bytes)
* return: 0 success, !=0 fail, return the error code
**/
int storage_download_file_to_file(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, \
		const char *group_name, const char *remote_filename, \
		const char *local_filename, int64_t *file_size);

/**
* Download file callback function prototype
* params:
*	arg: callback extra arguement
*       file_size: file size
*       data: temp buff, should not keep persistently
*	current_size: current data size
* return: 0 success, !=0 fail, should return the error code
**/
typedef int (*DownloadCallback) (void *arg, const int64_t file_size, \
		const char *data, const int current_size);

/**
* download file from storage server
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	remote_filename: filename on storage server
*       file_offset: the start offset to download
*       download_bytes: download bytes, 0 means from start offset to the file end
*	callback: callback function
*	arg: callback extra arguement
*       file_size: return file size (bytes)
* return: 0 success, !=0 fail, return the error code
**/
int storage_download_file_ex(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, \
		const char *group_name, const char *remote_filename, \
		const int64_t file_offset, const int64_t download_bytes, \
		DownloadCallback callback, void *arg, int64_t *file_size);

/**
* set metadata items to storage server
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	filename: filename on storage server
*	meta_list: meta item array
*       meta_count: meta item count
*       op_flag:
*            # STORAGE_SET_METADATA_FLAG_OVERWRITE('O'): overwrite all old 
*				metadata items
*            # STORAGE_SET_METADATA_FLAG_MERGE ('M'): merge, insert when
*				the metadata item not exist, otherwise update it
* return: 0 success, !=0 fail, return the error code
**/
int storage_set_metadata(ConnectionInfo *pTrackerServer, \
			ConnectionInfo *pStorageServer, \
			const char *group_name, const char *filename, \
			const FDFSMetaData *meta_list, const int meta_count, \
			const char op_flag);

/**
* get all metadata items from storage server
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	filename: filename on storage server
*	meta_list: return meta info array, must be freed
*       meta_count: return meta item count
* return: 0 success, !=0 fail, return the error code
**/
int storage_get_metadata(ConnectionInfo *pTrackerServer, \
			ConnectionInfo *pStorageServer,  \
			const char *group_name, const char *filename, \
			FDFSMetaData **meta_list, \
			int *meta_count);

/**
* upload slave file to storage server (by file name)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       local_filename: local filename to upload
*       master_filename: the mater filename to generate the slave file id
*       prefix_name: the prefix name to generate the slave file id
*       file_ext_name: file ext name, not include dot(.), 
*                      if be NULL will abstract ext name from the local filename
*	meta_list: meta info array
*       meta_count: meta item count
*	group_name: specify the group name.
	 	    return the group name to store the file
*	remote_filename: return the new created filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_upload_slave_by_filename(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const char *local_filename,\
		const char *master_filename, const char *prefix_name, \
		const char *file_ext_name, \
		const FDFSMetaData *meta_list, const int meta_count, \
		char *group_name, char *remote_filename);

/**
* upload slave file to storage server (by file buff)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       file_buff: file content/buff
*       file_size: file size (bytes)
*       master_filename: the mater filename to generate the slave file id
*       prefix_name: the prefix name to generate the slave file id
*       file_ext_name: file ext name, not include dot(.), can be NULL
*	meta_list: meta info array
*       meta_count: meta item count
*	group_name: specify the group name. 
		    return the group name to store the file
*	remote_filename: return the new created filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_upload_slave_by_filebuff(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const char *file_buff, \
		const int64_t file_size, const char *master_filename, \
		const char *prefix_name, const char *file_ext_name, \
		const FDFSMetaData *meta_list, const int meta_count, \
		char *group_name, char *remote_filename);

/**
* upload slave file to storage server (by callback)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       callback: callback function to send file content to storage server
*       arg: callback extra arguement
*       file_size: the file size
*       master_filename: the mater filename to generate the slave file id
*       prefix_name: the prefix name to generate the slave file id
*       file_ext_name: file ext name, not include dot(.), can be NULL
*	meta_list: meta info array
*       meta_count: meta item count
*	group_name: specify the group name. 
	 	    return the group name to store the file
*	remote_filename: return the new created filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_upload_slave_by_callback(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, \
		UploadCallback callback, void *arg, \
		const int64_t file_size, const char *master_filename, \
		const char *prefix_name, const char *file_ext_name, \
		const FDFSMetaData *meta_list, const int meta_count, \
		char *group_name, char *remote_filename);


/**
* append file to storage server (by local filename)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       local_filename: local filename to upload
*	group_name: the group name 
*	appender_filename: the appender filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_append_by_filename(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const char *local_filename,\
		const char *group_name, const char *appender_filename);


/**
* append file to storage server (by callback)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       callback: callback function to send file content to storage server
*       arg: callback extra arguement
*       file_size: the file size
*	group_name: the group name 
*	appender_filename: the appender filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_append_by_callback(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, \
		UploadCallback callback, void *arg, const int64_t file_size, \
		const char *group_name, const char *appender_filename);


/**
* append file to storage server (by file buff)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       file_buff: file content/buff
*       file_size: file size (bytes)
*	group_name: the group name
*	appender_filename: the appender filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_append_by_filebuff(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const char *file_buff, \
		const int64_t file_size, const char *group_name, \
		const char *appender_filename);


/**
* modify file to storage server (by local filename)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       local_filename: local filename to upload
*       file_offset: the start offset to modify appender file
*	group_name: the group name 
*	appender_filename: the appender filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_modify_by_filename(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const char *local_filename,\
		const int64_t file_offset, const char *group_name, \
		const char *appender_filename);


/**
* modify file to storage server (by callback)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       callback: callback function to send file content to storage server
*       arg: callback extra arguement
*       file_offset: the start offset to modify appender file
*       file_size: the file size
*	group_name: the group name 
*	appender_filename: the appender filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_modify_by_callback(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, \
		UploadCallback callback, void *arg, \
		const int64_t file_offset, const int64_t file_size, \
		const char *group_name, const char *appender_filename);


/**
* modify file to storage server (by file buff)
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*       file_buff: file content/buff
*       file_offset: the start offset to modify appender file
*       file_size: file size (bytes)
*	group_name: the group name
*	appender_filename: the appender filename
* return: 0 success, !=0 fail, return the error code
**/
int storage_modify_by_filebuff(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, const char *file_buff, \
		const int64_t file_offset, const int64_t file_size, \
		const char *group_name, const char *appender_filename);


/**
* truncate file to sepecify size
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name
*	appender_filename: the appender filename
*       truncated_file_size: truncated file size
* return: 0 success, !=0 fail, return the error code
**/
int storage_truncate_file(ConnectionInfo *pTrackerServer, \
		ConnectionInfo *pStorageServer, 
		const char *group_name, const char *appender_filename, \
		const int64_t truncated_file_size);


#define storage_query_file_info(pTrackerServer, pStorageServer, \
		group_name, filename, pFileInfo) \
	storage_query_file_info_ex(pTrackerServer, pStorageServer, \
		group_name, filename, pFileInfo, false)

/**
* query file info
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	filename: filename on storage server
*	pFileInfo: return the file info (file size and create timestamp)
*	bSilence: when this file not exist, do not log error on storage server
* return: 0 success, !=0 fail, return the error code
**/
int storage_query_file_info_ex(ConnectionInfo *pTrackerServer, \
			ConnectionInfo *pStorageServer,  \
			const char *group_name, const char *filename, \
			FDFSFileInfo *pFileInfo, const bool bSilence);


#define fdfs_get_file_info(group_name, remote_filename, pFileInfo) \
	fdfs_get_file_info_ex(group_name, remote_filename, true, pFileInfo)

/**
* check if file exist
* params:
*       pTrackerServer: tracker server
*       pStorageServer: storage server
*	group_name: the group name of storage server
*	remote_filename: filename on storage server
* return: 0 file exist, !=0 not exist, return the error code
**/
int storage_file_exist(ConnectionInfo *pTrackerServer, \
			ConnectionInfo *pStorageServer,  \
			const char *group_name, const char *remote_filename);
/**
* get file info from the filename return by storage server
* params:
*	group_name: the group name of storage server
*	remote_filename: filename on storage server
*       get_from_server: if get slave file info from storage server
*       pFileInfo: return the file info
* return: 0 success, !=0 fail, return the error code
**/
int fdfs_get_file_info_ex(const char *group_name, const char *remote_filename, \
	const bool get_from_server, FDFSFileInfo *pFileInfo);


#ifdef __cplusplus
}
#endif

#endif