CLI: Create ast_cli_completion_vector.
[asterisk/asterisk.git] / include / asterisk / cli.h
index 4f5d882..3ed88eb 100644 (file)
 extern "C" {
 #endif
 
 extern "C" {
 #endif
 
-#include <stdarg.h>
-
 #include "asterisk/linkedlists.h"
 #include "asterisk/linkedlists.h"
+#include "asterisk/strings.h"
+
+void ast_cli(int fd, const char *fmt, ...)
+       __attribute__((format(printf, 2, 3)));
 
 
-void ast_cli(int fd, char *fmt, ...)
-       __attribute__ ((format (printf, 2, 3)));
+/* dont check permissions while passing this option as a 'uid'
+ * to the cli_has_permissions() function. */
+#define CLI_NO_PERMS           -1
 
 #define RESULT_SUCCESS         0
 #define RESULT_SHOWUSAGE       1
 
 #define RESULT_SUCCESS         0
 #define RESULT_SHOWUSAGE       1
@@ -48,7 +51,33 @@ void ast_cli(int fd, char *fmt, ...)
 
 #define AST_CLI_COMPLETE_EOF   "_EOF_"
 
 
 #define AST_CLI_COMPLETE_EOF   "_EOF_"
 
-/*! \page CLI_command_api CLI command API
+/*!
+ * In many cases we need to print singular or plural
+ * words depending on a count. This macro helps us e.g.
+ *     printf("we have %d object%s", n, ESS(n));
+ */
+#define ESS(x) ((x) == 1 ? "" : "s")
+
+/*!
+ * \brief Return Yes or No depending on the argument.
+ *
+ * Note that this should probably still be used for CLI commands instead of
+ * AST_YESNO(), in the off chance we someday want to translate the CLI.
+ *
+ * \param x Boolean value
+ * \return "Yes" if x is true (non-zero)
+ * \return "No" if x is false (zero)
+ */
+#define AST_CLI_YESNO(x) AST_YESNO(x)
+
+/*! \brief return On or Off depending on the argument.
+ * This is used in many places in CLI command, having a function to generate
+ * this helps maintaining a consistent output (and possibly emitting the
+ * output in other languages, at some point).
+ */
+#define AST_CLI_ONOFF(x) (x) ? "On" : "Off"
+
+/*! \page CLI_command_API CLI command API
 
    CLI commands are described by a struct ast_cli_entry that contains
    all the components for their implementation.
 
    CLI commands are described by a struct ast_cli_entry that contains
    all the components for their implementation.
@@ -77,7 +106,7 @@ void ast_cli(int fd, char *fmt, ...)
 
        ...
        // this is how we create the entry to register 
 
        ...
        // this is how we create the entry to register 
-       NEW_CLI(new_setdebug, "short description")
+       AST_CLI_DEFINE(new_setdebug, "short description")
        ...
 
    To help the transition, we make the pointer to the struct ast_cli_entry
        ...
 
    To help the transition, we make the pointer to the struct ast_cli_entry
@@ -88,7 +117,7 @@ void ast_cli(int fd, char *fmt, ...)
 \code
 static char *test_new_cli(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
 \code
 static char *test_new_cli(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
-       static char *choices = { "one", "two", "three", NULL };
+       static const char * const choices[] = { "one", "two", "three", NULL };
 
         switch (cmd) {
         case CLI_INIT:
 
         switch (cmd) {
         case CLI_INIT:
@@ -116,10 +145,10 @@ static char *test_new_cli(struct ast_cli_entry *e, int cmd, struct ast_cli_args
  
  */
 
  
  */
 
-/*! \brief calling arguments for new-style handlers 
-       See \ref CLI_command_API
+/*! \brief calling arguments for new-style handlers. 
+* \arg \ref CLI_command_API
 */
 */
-enum ast_cli_fn {
+enum ast_cli_command {
        CLI_INIT = -2,          /* return the usage string */
        CLI_GENERATE = -3,      /* behave as 'generator', remap argv to struct ast_cli_args */
        CLI_HANDLER = -4,       /* run the normal handler */
        CLI_INIT = -2,          /* return the usage string */
        CLI_GENERATE = -3,      /* behave as 'generator', remap argv to struct ast_cli_args */
        CLI_HANDLER = -4,       /* run the normal handler */
@@ -127,70 +156,46 @@ enum ast_cli_fn {
 
 /* argument for new-style CLI handler */
 struct ast_cli_args {
 
 /* argument for new-style CLI handler */
 struct ast_cli_args {
-       int fd;
-       int argc;
-       char **argv;
+       const int fd;
+       const int argc;
+       const char * const *argv;
        const char *line;       /* the current input line */
        const char *word;       /* the word we want to complete */
        const char *line;       /* the current input line */
        const char *word;       /* the word we want to complete */
-       int pos;                /* position of the word to complete */
-       int n;                  /* the iteration count (n-th entry we generate) */
+       const int pos;          /* position of the word to complete */
+       const int n;            /* the iteration count (n-th entry we generate) */
 };
 
 };
 
-struct ast_cli_entry;
-typedef int (*old_cli_fn)(int fd, int argc, char *argv[]);
-typedef char *(*new_cli_fn)(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
-
-/*! \brief descriptor for a cli entry 
-       See \ref CLI_command_API
+/*! \brief descriptor for a cli entry. 
+ * \arg \ref CLI_command_API
  */
 struct ast_cli_entry {
  */
 struct ast_cli_entry {
-       char * const cmda[AST_MAX_CMD_LEN];     /*!< words making up the command.
-               * set the first entry to NULL for a new-style entry. */
-
-       /*! Handler for the command (fd for output, # of args, argument list).
-         Returns RESULT_SHOWUSAGE for improper arguments.
-         argv[] has argc 'useful' entries, and an additional NULL entry
-         at the end so that clients requiring NULL terminated arrays
-         can use it without need for copies.
-         You can overwrite argv or the strings it points to, but remember
-         that this memory is deallocated after the handler returns.
-        */
-       old_cli_fn handler;
-
-       const char *summary; /*!< Summary of the command (< 60 characters) */
-       char *usage; /*!< Detailed usage information */
-
-       /*! Generate the n-th (starting from 0) possible completion
-         for a given 'word' following 'line' in position 'pos'.
-         'line' and 'word' must not be modified.
-         Must return a malloc'ed string with the n-th value when available,
-         or NULL if the n-th completion does not exist.
-         Typically, the function is called with increasing values for n
-         until a NULL is returned.
-        */
-       char *(*generator)(const char *line, const char *word, int pos, int n);
-       struct ast_cli_entry *deprecate_cmd;
+       const char * const cmda[AST_MAX_CMD_LEN];       /*!< words making up the command.
+                                                        * set the first entry to NULL for a new-style entry.
+                                                        */
+
+       const char * const summary;                     /*!< Summary of the command (< 60 characters) */
+       const char * usage;                             /*!< Detailed usage information */
 
 
-       int inuse; /*!< For keeping track of usage */
-       struct module *module;  /*!< module this belongs to */
-       char *_full_cmd;        /*!< built at load time from cmda[] */
-       int cmdlen;             /*!< len up to the first invalid char [<{% */
+       int inuse;                              /*!< For keeping track of usage */
+       struct ast_module *module;                      /*!< module this belongs to */
+       char *_full_cmd;                        /*!< built at load time from cmda[] */
+       int cmdlen;                             /*!< len up to the first invalid char [<{% */
        /*! \brief This gets set in ast_cli_register()
        /*! \brief This gets set in ast_cli_register()
-         It then gets set to something different when the deprecated command
-         is run for the first time (ie; after we warn the user that it's deprecated)
         */
         */
-       int args;               /*!< number of non-null entries in cmda */
-       char *command;          /*!< command, non-null for new-style entries */
-       int deprecated;
-       new_cli_fn new_handler;
-       char *_deprecated_by;   /*!< copied from the "parent" _full_cmd, on deprecated commands */
+       int args;                               /*!< number of non-null entries in cmda */
+       char *command;                          /*!< command, non-null for new-style entries */
+       char *(*handler)(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
        /*! For linking */
        AST_LIST_ENTRY(ast_cli_entry) list;
 };
 
        /*! For linking */
        AST_LIST_ENTRY(ast_cli_entry) list;
 };
 
+#if defined(__cplusplus) || defined(c_plusplus)
+#define AST_CLI_DEFINE(fn, txt) { { "" }, txt, NULL, 0, NULL, NULL, 0, 0, NULL, fn }
+#else
 /* XXX the parser in gcc 2.95 gets confused if you don't put a space
  * between the last arg before VA_ARGS and the comma */
 /* XXX the parser in gcc 2.95 gets confused if you don't put a space
  * between the last arg before VA_ARGS and the comma */
-#define NEW_CLI(fn, txt , ... )        { .new_handler = fn, .summary = txt, ## __VA_ARGS__ }
+#define AST_CLI_DEFINE(fn, txt , ... ) { .handler = fn, .summary = txt, ## __VA_ARGS__ }
+#endif
 
 /*!
  * Helper function to generate cli entries from a NULL-terminated array.
 
 /*!
  * Helper function to generate cli entries from a NULL-terminated array.
@@ -200,7 +205,7 @@ struct ast_cli_entry {
   \code
     char *my_generate(const char *line, const char *word, int pos, int n)
     {
   \code
     char *my_generate(const char *line, const char *word, int pos, int n)
     {
-        static char *choices = { "one", "two", "three", NULL };
+        static const char * const choices[] = { "one", "two", "three", NULL };
        if (pos == 2)
                return ast_cli_complete(word, choices, n);
        else
        if (pos == 2)
                return ast_cli_complete(word, choices, n);
        else
@@ -208,33 +213,65 @@ struct ast_cli_entry {
     }
   \endcode
  */
     }
   \endcode
  */
-char *ast_cli_complete(const char *word, char *const choices[], int pos);
-
-/*! \brief Interprets a command
- * Interpret a command s, sending output to fd
- * Returns 0 on succes, -1 on failure
+char *ast_cli_complete(const char *word, const char * const choices[], int pos);
+
+/*! 
+ * \brief Interprets a command
+ * Interpret a command s, sending output to fd if uid:gid has permissions
+ * to run this command. uid = CLI_NO_PERMS to avoid checking user permissions
+ * gid = CLI_NO_PERMS to avoid checking group permissions.
+ * \param uid User ID that is trying to run the command.
+ * \param gid Group ID that is trying to run the command.
+ * \param fd pipe
+ * \param s incoming string
+ * \retval 0 on success
+ * \retval -1 on failure
+ */
+int ast_cli_command_full(int uid, int gid, int fd, const char *s);
+
+#define ast_cli_command(fd,s) ast_cli_command_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, s) 
+
+/*! 
+ * \brief Executes multiple CLI commands
+ * Interpret strings separated by NULL and execute each one, sending output to fd
+ * if uid has permissions, uid = CLI_NO_PERMS to avoid checking users permissions.
+ * gid = CLI_NO_PERMS to avoid checking group permissions.
+ * \param uid User ID that is trying to run the command.
+ * \param gid Group ID that is trying to run the command.
+ * \param fd pipe
+ * \param size is the total size of the string
+ * \param s incoming string
+ * \retval number of commands executed
  */
  */
-int ast_cli_command(int fd, const char *s);
+int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s);
+
+#define ast_cli_command_multiple(fd,size,s) ast_cli_command_multiple_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, size, s)
 
 /*! \brief Registers a command or an array of commands
 
 /*! \brief Registers a command or an array of commands
- * \param e which cli entry to register
+ * \param e which cli entry to register.
  * Register your own command
  * Register your own command
- * Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
  */
  */
-int ast_cli_register(struct ast_cli_entry *e);
+#define ast_cli_register(e) __ast_cli_register(e, AST_MODULE_SELF)
+
+int __ast_cli_register(struct ast_cli_entry *e, struct ast_module *mod);
 
 /*!
  * \brief Register multiple commands
  * \param e pointer to first cli entry to register
  * \param len number of entries to register
  */
 
 /*!
  * \brief Register multiple commands
  * \param e pointer to first cli entry to register
  * \param len number of entries to register
  */
-void ast_cli_register_multiple(struct ast_cli_entry *e, int len);
+#define ast_cli_register_multiple(e, len) \
+       __ast_cli_register_multiple(e, len, AST_MODULE_SELF)
 
 
-/*! \brief Unregisters a command or an array of commands
- *
+int __ast_cli_register_multiple(struct ast_cli_entry *e, int len, struct ast_module *mod);
+
+/*! 
+ * \brief Unregisters a command or an array of commands
  * \param e which cli entry to unregister
  * Unregister your own command.  You must pass a completed ast_cli_entry structure
  * \param e which cli entry to unregister
  * Unregister your own command.  You must pass a completed ast_cli_entry structure
- * Returns 0.
+ * \return 0
  */
 int ast_cli_unregister(struct ast_cli_entry *e);
 
  */
 int ast_cli_unregister(struct ast_cli_entry *e);
 
@@ -243,11 +280,13 @@ int ast_cli_unregister(struct ast_cli_entry *e);
  * \param e pointer to first cli entry to unregister
  * \param len number of entries to unregister
  */
  * \param e pointer to first cli entry to unregister
  * \param len number of entries to unregister
  */
-void ast_cli_unregister_multiple(struct ast_cli_entry *e, int len);
+int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len);
 
 
-/*! \brief Readline madness
+/*! 
+ * \brief Readline madness
  * Useful for readline, that's about it
  * Useful for readline, that's about it
- * Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
  */
 char *ast_cli_generator(const char *, const char *, int);
 
  */
 char *ast_cli_generator(const char *, const char *, int);
 
@@ -260,14 +299,35 @@ int ast_cli_generatornummatches(const char *, const char *);
  *
  * The first entry (offset 0) of the result is the longest common substring
  * in the results, useful to extend the string that has been completed.
  *
  * The first entry (offset 0) of the result is the longest common substring
  * in the results, useful to extend the string that has been completed.
- * Subsequent entries are all possible values, followe by a NULL.
+ * Subsequent entries are all possible values, followed by a NULL.
  * All strings and the array itself are malloc'ed and must be freed
  * by the caller.
  */
 char **ast_cli_completion_matches(const char *, const char *);
 
 /*!
  * All strings and the array itself are malloc'ed and must be freed
  * by the caller.
  */
 char **ast_cli_completion_matches(const char *, const char *);
 
 /*!
- * \brief Command completion for the list of active channels
+ * \brief Generates a vector of strings for CLI completion.
+ *
+ * \param text Complete input being matched.
+ * \param word Current word being matched
+ *
+ * The results contain strings that both:
+ * 1) Begin with the string in \a word.
+ * 2) Are valid in a command after the string in \a text.
+ *
+ * The first entry (offset 0) of the result is the longest common substring
+ * in the results, useful to extend the string that has been completed.
+ * Subsequent entries are all possible values.
+ *
+ * \note All strings and the vector itself are malloc'ed and must be freed
+ *       by the caller.
+ *
+ * \note The vector is sorted and does not contain any duplicates.
+ */
+struct ast_vector_string *ast_cli_completion_vector(const char *text, const char *word);
+
+/*!
+ * \brief Command completion for the list of active channels.
  *
  * This can be called from a CLI command completion function that wants to
  * complete from the list of active channels.  'rpos' is the required
  *
  * This can be called from a CLI command completion function that wants to
  * complete from the list of active channels.  'rpos' is the required
@@ -276,6 +336,29 @@ char **ast_cli_completion_matches(const char *, const char *);
  */
 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos);
 
  */
 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos);
 
+/*!
+ * \since 13.8
+ * \brief Print on cli a duration in seconds in format
+ * %s year(s), %s week(s), %s day(s), %s hour(s), %s second(s)
+ *
+ * \param ast_cli_args fd to print by ast_cli
+ * \param duration The time (in seconds) to print
+ * \param prefix A Prefix string to add before of duration formatted
+ */
+void ast_cli_print_timestr_fromseconds(int fd, int seconds, const char *prefix);
+
+/*
+ * \brief Allow a CLI command to be executed while Asterisk is shutting down.
+ *
+ * CLI commands by defeault are disabled when Asterisk is shutting down. This is
+ * to ensure the safety of the shutdown since CLI commands may attempt to access
+ * resources that have been freed as a result of the shutdown.
+ *
+ * If a CLI command should be allowed at shutdown, then the best way to enable this
+ * is to call ast_cli_allow_at_shutdown during the CLI_INIT state of the CLI handler.
+ */
+int ast_cli_allow_at_shutdown(struct ast_cli_entry *e);
+
 #if defined(__cplusplus) || defined(c_plusplus)
 }
 #endif
 #if defined(__cplusplus) || defined(c_plusplus)
 }
 #endif