ProFTPD Developer's Guide: API Macros

ProFTPD Version 1.2

 #define ANY_MODULE ((module*)0xffffffff)

 #define ASSERT(x) assert(x)

 #define BLOCK_MINFREE TUNABLE_NEW_POOL_SIZE

 #define BUFSIZ 8192

 #define CALLBACK_FRAME LPARAM p1, LPARAM p2,i LPARAM p3, void *data

 #define CF_DEFER (1 << 2)

 #define CF_DYNAMIC (1 << 1)

 #define CF_MERGEDOWN (1 << 0)

 #define CHECK_ARGS(x, n) if ((x)->argc-1 < n) CONF_ERROR(x, "missing arguments")

 #define CHECK_CMD_ARGS(x, n) if ((x)->argc != (n)) { \
           add_response_err(R_501, "Invalid number of arguments."); \
           return ERROR((x)); \
         }

 #define CHECK_CMD_MIN_ARGS(x, n) if((x)->argc < (n)) { \
           add_response_err(R_501, "Invalid number of arguments."); \
           return ERROR((x)); \
         }

 #define CHECK_CONF(x, p) if (!check_conf((x), (p))) \
           CONF_ERROR((x), \
           pstrcat((x)->tmp_pool, "directive not allowed in ", \
           get_section_name((x)), \
           " section.", NULL))

 #define CHECK_HASARGS(x, n) ((x)->argc - 1) == n

 #define CHECK_INET_POOL if(!inet_pool) _create_inet_pool()

 #define CHECK_VARARGS(x, n, m) if((x)->argc - 1 < n || \
         (x)->argc - 1 > m) CONF_ERROR(x, "missing arguments")

 #define CHOP(s) strip_end((s), "\r\n")

 #define CLASS_USER

 #define CLICK_SZ (sizeof(union align))

 #define CL_ALL (CL_AUTH|CL_INFO|CL_DIRS|CL_READ|CL_WRITE|CL_MISC)

 #define CL_AUTH (1 << 0)

 #define CL_DIRS (1 << 2)

 #define CL_INFO (1 << 1)

 #define CL_MISC (1 << 5)

 #define CL_NONE 0x0

 #define CL_READ (1 << 3)

 #define CL_WRITE (1 << 4)

 #define CMD 2

 #define CM_ACCEPT 3

 #define CM_CLOSED 5

 #define CM_CONNECT 4

 #define CM_ERROR 6

 #define CM_LISTEN 1

 #define CM_NONE 0

 #define CM_OPEN 2

 #define CONF_ANON (1 << 2)

 #define CONF_DIR (1 << 1)

 #define CONF_DYNDIR (1 << 5)

 #define CONF_ERROR(x, s) return \
           ERROR_MSG((x), NULL, pstrcat((x)->tmp_pool, \
           (x)->argv[0], ": ", (s), NULL));

 #define CONF_GLOBAL (1 << 6)

 #define CONF_LIMIT (1 << 3)

 #define CONF_PARAM (1 << 15)

 #define CONF_ROOT (1 << 0)

 #define CONF_USERDATA (1 << 14)

 #define CONF_VIRTUAL (1 << 4)

 #define CORE_DIR RUN_DIR

 #define CURRENT_CONF (session.dir_config ? session.dir_config->subset \
           : (session.anon_config ? session.anon_config->subset \
           : main_server->conf))

 #define C_ABOR "ABOR"

 #define C_ACCT "ACCT"

 #define C_ADAT "ADAT"

 #define C_ALLO "ALLO"

 #define C_ANY "*"

 #define C_APPE "APPE"

 #define C_AUTH "AUTH"

 #define C_CCC "CCC"

 #define C_CDUP "CDUP"

 #define C_CONF "CONF"

 #define C_CWD "CWD"

 #define C_DELE "DELE"

 #define C_ENC "ENC"

 #define C_HELP "HELP"

 #define C_LIST "LIST"

 #define C_MDTM "MDTM"

 #define C_MIC "MIC"

 #define C_MKD "MKD"

 #define C_MODE "MODE"

 #define C_NLST "NLST"

 #define C_NOOP "NOOP"

 #define C_PASS "PASS"

 #define C_PASV "PASV"

 #define C_PBSZ "PBSZ"

 #define C_PORT "PORT"

 #define C_PROT "PROT"

 #define C_PWD "PWD"

 #define C_QUIT "QUIT"

 #define C_REIN "REIN"

 #define C_REST "REST"

 #define C_RETR "RETR"

 #define C_RMD "RMD"

 #define C_RNFR "RNFR"

 #define C_RNTO "RNTO"

 #define C_SITE "SITE"

 #define C_SIZE "SIZE"

 #define C_SMNT "SMNT"

 #define C_STAT "STAT"

 #define C_STOR "STOR"

 #define C_STOU "STOU"

 #define C_STRU "STRU"

 #define C_SYST "SYST"

 #define C_TYPE "TYPE"

 #define C_USER "USER"

 #define C_XCUP "XCUP"

 #define C_XCWD "XCWD"

 #define C_XMKD "XMKD"

 #define C_XPWD "XPWD"

 #define C_XRMD "XRMD"

 #define DEBUG0 0

 #define DEBUG1 1

 #define DEBUG2 2

 #define DEBUG3 3

 #define DEBUG4 4

 #define DEBUG5 5

 #define DEBUG6 6

 #define DEBUG7 7

 #define DEBUG8 8

 #define DEBUG9 9

 # define DECIMAL_STRING_LENGTH 512

 #define DECLINED(cmd) (modret_t *) NULL

 #define DO 253

 #define DONT 254

 #define ERROR(cmd) mod_create_ret((cmd), 1, NULL, NULL)

 #define ERROR_INT(cmd, n) mod_create_error((cmd), (n))

 #define ERROR_MSG(cmd, n, m) mod_create_ret((cmd), 1, (n), (m))

 #define EXTLOG_PATH "/var/log/proftpd-log"

 #define FALSE 0

 #define FSIO_DIR_CHDIR (1 << 1)

 #define FSIO_DIR_CHROOT (1 << 0)

 #define FSIO_DIR_CLOSEDIR (1 << 3)

 #define FSIO_DIR_MKDIR (1 << 5)

 #define FSIO_DIR_OPENDIR (1 << 2)

 #define FSIO_DIR_READDIR (1 << 4)

 #define FSIO_DIR_RMDIR (1 << 6)

 #define FSIO_FILE_CHMOD (1 << 13)

 #define FSIO_FILE_CHOWN (1 << 14)

 #define FSIO_FILE_CLOSE (1 << 6)

 #define FSIO_FILE_COMMON (FSIO_FILE_OPEN|FSIO_FILE_READ|FSIO_FILE_WRITE|FSIO_FILE_CLOSE|FSIO_FILE_CREAT)

 #define FSIO_FILE_CREAT (1 << 5)

 #define FSIO_FILE_LINK (1 << 9)

 #define FSIO_FILE_LSTAT (1 << 1)

 #define FSIO_FILE_OPEN (1 << 4)

 #define FSIO_FILE_READ (1 << 7)

 #define FSIO_FILE_READLINK (1 << 11)

 #define FSIO_FILE_RENAME (1 << 2)

 #define FSIO_FILE_STAT (1 << 0)

 #define FSIO_FILE_SYMLINK (1 << 10)

 #define FSIO_FILE_TRUNC (1 << 12)

 #define FSIO_FILE_UNLINK (1 << 3)

 #define FSIO_FILE_WRITE (1 << 8)

 #define FTPUSERS_PATH "/etc/ftpusers"

 #define GROUP grpfname

 #define G_DIRS "DIRS"

 #define G_NONE NULL

 #define G_READ "READ"

 #define G_WRITE "WRITE"

 #define HANDLED(cmd) mod_create_ret((cmd), 0, NULL, NULL)

 #define HASH_TABLE_SIZE 40

 #define IAC 255

 #define INADDR_ANY ((unsigned long int) 0x00000000)

 #define INPORT_ANY 0

 #define LARGE 64

 #define LEFT 16

 #define LOGBUFFER_SIZE 2048

 #define LOGBUF_SIZE 1025

 #define LOG_AUTHPRIV LOG_AUTH

 #define LOG_CMD 4

 #define LOG_CMD_ERR 5

 #define LOG_EXTENDED_MODE 0644

 #define LOG_SYMLINK -3

 #define LOG_SYSTEM_MODE 0640

 #define LOG_WRITEABLE_DIR -2

 #define LOG_XFER_MODE 0644

 #define LOOPBACK_MASK "255.255.255.0"

 #define LOOPBACK_NET "127.0.0.0"

 #define MAP_GID(x) (fakegroup ? fakegroup : auth_gid_name(cmd->tmp_pool, (x)))

 #define MAP_UID(x) (fakeuser ? fakeuser : auth_uid_name(cmd->tmp_pool, (x)))

 #define MAXMEMBERS 4096

 #define MAX_CLASSES 100

 #define MAX_PATH_LEN 256

 #define META_ANON_PASS 17

 #define META_ARG 1

 #define META_ARG_END 0xfe

 #define META_BYTES_SENT 2

 #define META_CLASS 16

 #define META_COMMAND 12

 #define META_ENV_VAR 4

 #define META_FILENAME 3

 #define META_IDENT_USER 7

 #define META_LOCAL_FQDN 15

 #define META_LOCAL_IP 14

 #define META_LOCAL_NAME 12

 #define META_LOCAL_PORT 13

 #define META_METHOD 18

 #define META_PID 9

 #define META_REMOTE_HOST 5

 #define META_REMOTE_IP 6

 #define META_RESPONSE_CODE 15

 #define META_SECONDS 11

 #define META_START 0xff

 #define META_TIME 10

 #define META_USER 14

 #define META_XFER_PATH 19

 #define MODE_STRING (session.flags &
         (SF_ASCII|SF_ASCII_OVERRIDE) ? "ASCII" : "BINARY")

 #define MODRET static modret_t*

 #define MODRET_ERRMSG(x) ((x) ? (x)->mr_message : NULL)

 #define MODRET_ERRNUM(x) ((x) ? (x)->mr_numeric : NULL)

 #define MODRET_ERROR(x) ((x) ? (x)->mr_error : 0)

 #define MODRET_HASDATA(x) ((x) ? ((x)->data ? TRUE : FALSE) : FALSE)

 #define MODRET_HASMSG(x) ((x) && (x)->mr_message)

 #define MODRET_HASNUM(x) ((x) && (x)->mr_numeric)

 #define MODRET_ISDECLINED(x) ((x) == NULL)

 #define MODRET_ISERROR(x) ((x) && (x)->mr_error)

 #define MODRET_ISHANDLED(x) ((x) && !(x)->mr_error)

 # define NAME_MAX_GUESS (255)

 # define NEED_PERSISTENT_PASSWD

 #define NGRPFIELDS 4

 #define NPWDFIELDS 7

 #define OP_COMMAND 2

 #define OP_HIDE 1

 #define ORDER_ALLOWDENY 0

 #define ORDER_DENYALLOW 1

 #define PASSWD pwdfname

 #define PERSISTENT_GROUP (persistent || persistent_group)

 #define PERSISTENT_PASSWD (persistent || persistent_passwd)

 #define PLUS 4

 #define POOL(x) ((x) ? (x) : permanent_pool)

 #define POOL_HDR_BYTES (POOL_HDR_CLICKS * CLICK_SZ)

 #define POOL_HDR_CLICKS (1 + ((sizeof(struct pool) - 1) / CLICK_SZ))

 #define POST_CMD 3

 #define POST_CMD_ERR 4

 #define PRE_CMD 1

 #define PRIVS_RELINQUISH { log_debug(DEBUG4,"NONROOT %s %d", \
           __FILE__, __LINE__); \
           if(!session.disable_id_switching) { \
             if (geteuid()!=0) { \
               setreuid(session.uid,0); } \
             setreuid(session.uid,session.uid); } \
         }

 #define PRIVS_REVOKE { setreuid(0,0); setgid(session.gid); \
         setuid(session.uid); }

 #define PRIVS_ROOT { log_debug(DEBUG4,"ROOT %s %d", \
           __FILE__, __LINE__); \
           if (!session.disable_id_switching) { \
             setreuid(session.uid,0); } \
         }

 #define PRIVS_SETUP(u,g) { if(getuid()) { \
           session.ouid = session.uid = (int)getuid(); \
           session.gid = (int)getgid(); \
           setgid(session.gid); \
           setreuid(session.uid,session.uid); \
         } else {  \
           session.ouid = (int)getuid(); \
           session.uid = (u); session.gid = (g); \
           setgid(session.gid); \
           setreuid(0,session.uid); \
         } }

 #define PRIVS_USER { log_debug(DEBUG4,"USER %d %s %d", \
           session.login_uid,__FILE__, __LINE__); \
           if (!session.disable_id_switching) { \
             setreuid(session.uid,0); \
             setreuid(session.uid,session.login_uid); } \
         }

 #define PROFTPD_VERSION_NUMBER

 #define PROFTPD_VERSION_TEXT

 #define PR_AUTH_AGEPWD -3

 #define PR_AUTH_BADPWD -2

 #define PR_AUTH_DISABLEDPWD -4

 #define PR_AUTH_NOPWD -1

  #define PR_BYTES_BAD_FORMAT	-2

  #define PR_BYTES_BAD_UNITS	-1

 #define PR_LOG_ALERT 1

 #define PR_LOG_CRIT 2

 #define PR_LOG_DEBUG LOG_DEBUG

 #define PR_LOG_EMERG 0

 #define PR_LOG_ERR 3

 #define PR_LOG_INFO 6

 #define PR_LOG_NOTICE 5

 #define PR_LOG_PRIMASK LOG_PRIMASK

 #define PR_LOG_WARNING 4

 #define PR_NETIO_IO_RD 0

 #define PR_NETIO_IO_WR 1

 #define PR_NETIO_SESS_ABORT (1 << 3)

 #define PR_NETIO_SESS_INTR (1 << 1)

   #define PR_TUNABLE_BUFFER_SIZE       1024

 #define PR_TUNABLE_DEFAULT_BACKLOG 5

 #define PR_TUNABLE_DEFAULT_RWIN 8192

 #define PR_TUNABLE_DEFAULT_SWIN 8192

 #define PR_TUNABLE_NEW_POOL_SIZE 512

 #define PR_TUNABLE_TIMEOUTIDENT 10

 #define PR_TUNABLE_TIMEOUTIDLE 600

 #define PR_TUNABLE_TIMEOUTLOGIN 300

 #define PR_TUNABLE_TIMEOUTNOXFER 300

 #define PR_TUNABLE_TIMEOUTSTALLED 3600

 #define R_110 "110"

 #define R_120 "120"

 #define R_125 "125"

 #define R_150 "150"

 #define R_200 "200"

 #define R_202 "202"

 #define R_211 "211"

 #define R_212 "212"

 #define R_213 "213"

 #define R_214 "214"

 #define R_215 "215"

 #define R_220 "220"

 #define R_221 "221"

 #define R_225 "225"

 #define R_226 "226"

 #define R_227 "227"

 #define R_230 "230"

 #define R_232 "232"

 #define R_234 "234"

 #define R_235 "235"

 #define R_250 "250"

 #define R_257 "257"

 #define R_331 "331"

 #define R_332 "332"

 #define R_334 "334"

 #define R_335 "335"

 #define R_336 "336"

 #define R_350 "350"

 #define R_421 "421"

 #define R_425 "425"

 #define R_426 "426"

 #define R_431 "431"

 #define R_450 "450"

 #define R_451 "451"

 #define R_452 "452"

 #define R_500 "500"

 #define R_501 "501"

 #define R_502 "502"

 #define R_503 "503"

 #define R_504 "504"

 #define R_530 "530"

 #define R_532 "532"

 #define R_533 "533"

 #define R_534 "534"

 #define R_535 "535"

 #define R_536 "536"

 #define R_537 "537"

 #define R_550 "550"

 #define R_551 "551"

 #define R_552 "552"

 #define R_553 "553"

 #define R_554 "554"

 #define R_631 "631"

 #define R_632 "632"

 #define R_633 "633"

 #define R_DUP NULL

 #define SERVER_INETD 0

 #define SERVER_STANDALONE 1

 #define SF_ABORT (1 << 1)

 #define SF_ALL (SF_PASSIVE|SF_ABORT|SF_XFER|SF_ASCII| \
           SF_ASCII_OVERRIDE|SF_ANON|SF_POST_ABORT|SF_PORT)

 #define SF_ANON (1 << 5)

 #define SF_ASCII (1 << 3)

 #define SF_ASCII_OVERRIDE (1 << 4)

 #define SF_PASSIVE (1 << 0)

 #define SF_PORT (1 << 7)

 #define SF_POST_ABORT (1 << 6)

 #define SF_XFER (1 << 2)

 #define SHUTMSG_PATH "/etc/shutmsg"

  #define SP_CCC (1 << 0)

  #define SP_CONF (1 << 3)

 #define SP_CVT_DAYS(x) ((x) == (time_t)-1 ? (x) : ((x) * 86400))

  #define SP_ENC (1 << 1)

  #define SP_MIC (1 << 2)

 #define STOR_APPEND 1

 #define STOR_DEFAULT 0

 #define STOR_HIDDEN 2

 #define TIMER_IDLE 2

 #define TIMER_LOGIN 1

 #define TIMER_NOXFER 3

 #define TIMER_STALLED 4

 #define TOPLEVEL_CONF (session.anon_config ?
           session.anon_config->subset : main_server->conf)

 #define TRUE 1

 #define U32BITS 0xffffffff

 #define VALID_SHELL_PATH "/etc/shells"

 #define WILL 251

 #define WONT 252

 #define WTMP_FILE _PATH_WTMP

 #define XFERLOG_PATH "/var/log/xferlog"

 #define XFER_ABORTED (session.flags & SF_ABORT)