/* Synchronet FTP server */

/****************************************************************************
 * @format.tab-size 4		(Plain Text/Source Code File Header)			*
 * @format.use-tabs true	(see http://www.synchro.net/ptsc_hdr.html)		*
 *																			*
 * Copyright Rob Swindell - http://www.synchro.net/copyright.html			*
 *																			*
 * This program is free software; you can redistribute it and/or			*
 * modify it under the terms of the GNU General Public License				*
 * as published by the Free Software Foundation; either version 2			*
 * of the License, or (at your option) any later version.					*
 * See the GNU General Public License for more details: gpl.txt or			*
 * http://www.fsf.org/copyleft/gpl.html										*
 *																			*
 * For Synchronet coding style and modification guidelines, see				*
 * http://www.synchro.net/source.html										*
 *																			*
 * Note: If this box doesn't appear square, then you need to fix your tabs.	*
 ****************************************************************************/

#ifndef _FTPSRVR_H_
#define _FTPSRVR_H_

#include "startup.h"

typedef struct {

	STARTUP_COMMON_ELEMENTS
	uint16_t port;
	uint16_t max_clients;
#define FTP_DEFAULT_MAX_CLIENTS     100
	uint16_t max_inactivity;
#define FTP_DEFAULT_MAX_INACTIVITY  300
	uint16_t qwk_timeout;
#define FTP_DEFAULT_QWK_TIMEOUT     600
	struct in_addr outgoing4;
	struct in6_addr outgoing6;
	str_list_t interfaces;
	struct in_addr pasv_ip_addr;
	struct in6_addr pasv_ip6_addr;
	uint16_t pasv_port_low;
	uint16_t pasv_port_high;
	int64_t min_fsize;          /* Minimum file size accepted for upload */
	int64_t max_fsize;          /* Maximum file size accepted for upload (0=unlimited) */
	uint max_concurrent_connections;
	uint max_requests_per_period;
	uint request_rate_limit_period;
	struct rate_limit_settings rate_limit;
	char index_file_name[64];
	char login_info_save[INI_MAX_VALUE_LEN];

} ftp_startup_t;

/* startup options that requires re-initialization/recycle when changed */
#if defined(STARTUP_INIT_FIELD_TABLES)
static struct init_field ftp_init_fields[] = {
	OFFSET_AND_SIZE(ftp_startup_t, port)
	, OFFSET_AND_SIZE(ftp_startup_t, interfaces)
	, OFFSET_AND_SIZE(ftp_startup_t, ctrl_dir)
	, OFFSET_AND_SIZE(ftp_startup_t, temp_dir)
	, { 0, 0 }    /* terminator */
};
#endif

#define FTP_OPT_DEBUG_RX            (1 << 0)
#define FTP_OPT_DEBUG_DATA          (1 << 1)
#define FTP_OPT_INDEX_FILE          (1 << 2)  /* Auto-generate ASCII Index files */
#define FTP_OPT_DEBUG_TX            (1 << 3)
#define FTP_OPT_ALLOW_QWK           (1 << 4)
#define FTP_OPT_NO_LOCAL_FSYS       (1 << 5)
#define FTP_OPT_DIR_FILES           (1 << 6)  /* Allow access to files in dir but not in database */
#define FTP_OPT_KEEP_TEMP_FILES     (1 << 7)  /* Don't delete temp files (for debugging) */
#define FTP_OPT_ALLOW_BOUNCE        (1 << 8)
#define FTP_OPT_LOOKUP_PASV_IP      (1 << 9)  /* resolve public IP address for PASV response */
#define FTP_OPT_NO_FTPS             (1 << 10) // Don't support START_TLS
#define FTP_OPT_NO_HOST_LOOKUP      (1 << 11)
#define FTP_OPT_NO_RECYCLE          (1 << 27) /* Disable recycling of server		*/
#define FTP_OPT_MUTE                (1U << 31)

/* ftp_startup_t.options bits that require re-init/recycle when changed */
#define FTP_INIT_OPTS   (0)

#if defined(STARTUP_INI_BITDESC_TABLES)
static ini_bitdesc_t ftp_options[] = {

	{ FTP_OPT_DEBUG_RX, "DEBUG_RX"             },
	{ FTP_OPT_DEBUG_DATA, "DEBUG_DATA"           },
	{ FTP_OPT_INDEX_FILE, "INDEX_FILE"           },
	{ FTP_OPT_DEBUG_TX, "DEBUG_TX"             },
	{ FTP_OPT_ALLOW_QWK, "ALLOW_QWK"            },
	{ FTP_OPT_NO_LOCAL_FSYS, "NO_LOCAL_FSYS"        },
	{ FTP_OPT_DIR_FILES, "DIR_FILES"            },
	{ FTP_OPT_KEEP_TEMP_FILES, "KEEP_TEMP_FILES"      },
	{ FTP_OPT_ALLOW_BOUNCE, "ALLOW_BOUNCE"         },
	{ FTP_OPT_LOOKUP_PASV_IP, "LOOKUP_PASV_IP"       },
	{ FTP_OPT_NO_FTPS, "NO_FTPS"              },
	{ FTP_OPT_NO_HOST_LOOKUP, "NO_HOST_LOOKUP"       },
	{ FTP_OPT_NO_RECYCLE, "NO_RECYCLE"           },
	{ FTP_OPT_MUTE, "MUTE"                 },
	/* terminator */
	{ 0, NULL                   }
};
#endif

#ifdef DLLEXPORT
#undef DLLEXPORT
#endif

#ifdef _WIN32
	#ifdef FTPSRVR_EXPORTS
		#define DLLEXPORT __declspec(dllexport)
	#else
		#define DLLEXPORT __declspec(dllimport)
	#endif
#else
	#define DLLEXPORT
#endif

#ifdef __cplusplus
extern "C" {
#endif
/* arg is pointer to static ftp_startup_t */
DLLEXPORT void          ftp_server(void* arg);
DLLEXPORT void          ftp_terminate(void);
DLLEXPORT const char*   ftp_ver(void);
#ifdef __cplusplus
}
#endif

#endif /* Don't add anything after this line */
