ProFTPD Developer's Guide: Handler Macros

ProFTPD Version 1.2

Configuration Macros

• CHECK_ARGS(cmd_rec *cmd, int argc)

  
  checks the number of arguments passed to the directive against what we want. Note that this is one less than cmd_rec->argc, because cmd_rec->argc includes cmd_rec->argv[0] (the directive itself). This check also ensures only that there is an equal or greater number of arguments than the number requested. If this check fails, a generic error is sent to the user.
  
  Example: CHECK_ARGS(cmd, 1);



• CHECK_HASARGS(cmd_rec *cmd, int argc)

  
  performs a boolean check, to see if the number of arguments passed to the directive are of the given number.
  
  Example: if (!CHECK_HASARGS(cmd, 3)) {



• CHECK_VARARGS(cmd_rec *cmd, int argc_min, int argc_max)

  
  If this check fails, a generic error is sent to the user.
  
  Example: CHECK_VARARGS(cmd, 1, 5);



• CHECK_CONF(cmd_rec *cmd, int flags)

  
  makes sure that this directive is not being "used" in the wrong context (i.e. if the directive is only available or applicable inside certain contexts). In this case, we are allowing the directive inside of <Anonymous> and <Limit>, but nowhere else. If this macro fails a generic error is logged and the handler aborts.
  
  Example: CHECK_CONF(cmd, CONF_ANON|CONF_LIMIT);



• CONF_ERROR(cmd_rec *cmd, char *message)

  
  
  Example: CONF_ERROR(cmd, "syntax: expected numbers, not letters");

Command Macros

• CHECK_CMD_ARGS(cmd_rec *cmd, int argc)

  
  checks that the number of arguments passed to the directive is exactly the indicated count. If this check fails, an R_501 error code, with a message stating the problem, is issued to the client.
  
  Example: CHECK_CMD_ARGS(cmd, 2);



• CHECK_CMD_MIN_ARGS(cmd_rec *cmd, int argc)

  
  checks that the command has received at least the indicated number of arguments. If this check fails, an R_501 error code is issued to the client.
  
  Example: CHECK_CMD_MIN_ARGS(cmd, 2);

Authentication Macros