Changeset 3231 for pjproject/branches/projects/cli/pjlib-util/src/pjlib-util/cli.c

Timestamp:

Jun 30, 2010 5:29:59 AM (14 years ago)

Author:

ming

Message:

Implemented CLI (re #1098)

• pjlib-util:
  • implement telnet CLI
• pjsip-apps/samples:
  • sample CLI demo application
• build:
  • VS6 and Makefile

File:

• pjproject/branches/projects/cli/pjlib-util/src/pjlib-util/cli.c (modified) (18 diffs)

pjproject/branches/projects/cli/pjlib-util/src/pjlib-util/cli.c

@@ -30 +30 @@
 #include <pjlib-util/xml.h>
 
+#define CMD_HASH_TABLE_SIZE 63  /* Hash table size */
+
+#define CLI_CMD_CHANGE_LOG  30000
+#define CLI_CMD_EXIT        30001
+
 #if 1
     /* Enable some tracing */
@@ -38 +43 @@
 #endif
 
-#define CMD_HASH_TABLE_SIZE 63          /* Hash table size */
-
 struct pj_cli_t
 {
-    pj_pool_t          *pool;          /* Pool to allocate memory from */
+    pj_pool_t          *pool;           /* Pool to allocate memory from */
     pj_cli_cfg          cfg;            /* CLI configuration */
     pj_cli_cmd_spec     root;           /* Root of command tree structure */
     pj_cli_front_end    fe_head;        /* List of front-ends */
-    pj_hash_table_t    *hash;          /* Command hash table */
+    pj_hash_table_t    *hash;           /* Command hash table */
 
     pj_bool_t           is_quitting;
@@ -68 +71 @@
 }
 
+PJ_DEF(void) pj_cli_write_log(pj_cli_t *cli,
+                              int level,
+                              const char *buffer,
+                              int len)
+{
+    struct pj_cli_front_end *fe;
+
+    pj_assert(cli);
+
+    fe = cli->fe_head.next;
+    while (fe != &cli->fe_head) {
+        if (fe->op && fe->op->on_write_log)
+            (*fe->op->on_write_log)(fe, level, buffer, len);
+        fe = fe->next;
+    }
+}
+
+/* Command handler */
+static pj_status_t cmd_handler(pj_cli_cmd_val *cval)
+{
+    unsigned level;
+
+    switch(cval->cmd->id) {
+    case CLI_CMD_CHANGE_LOG:
+        level = pj_strtoul(&cval->argv[1]);
+        if (!level && cval->argv[1].slen > 0 && (cval->argv[1].ptr[0] < '0' ||
+            cval->argv[1].ptr[0] > '9'))
+            return PJ_CLI_EINVARG;
+        cval->sess->log_level = level;
+        return PJ_SUCCESS;
+    case CLI_CMD_EXIT:
+        pj_cli_end_session(cval->sess);
+        return PJ_CLI_EEXIT;
+    default:
+        return PJ_SUCCESS;
+    }
+}
+
 PJ_DEF(pj_status_t) pj_cli_create(pj_cli_cfg *cfg,
                                   pj_cli_t **p_cli)
@@ -73 +114 @@
     pj_pool_t *pool;
     pj_cli_t *cli;
+    unsigned i;
+    char* cmd_xmls[] = {
+     "<CMD name='log' id='30000' sc='' desc='Change log level'>"
+     "  <ARGS>"
+     "    <ARG name='level' type='int' desc='Log level'/>"
+     "  </ARGS>"
+     "</CMD>",
+     "<CMD name='exit' id='30001' sc='' desc='Exit session'>"
+     "</CMD>",
+    };
 
     PJ_ASSERT_RETURN(cfg && cfg->pf && p_cli, PJ_EINVAL);
 
-    pool = pj_pool_create(cfg->pf, "cli", 1024, 1024, NULL);
+    pool = pj_pool_create(cfg->pf, "cli", PJ_CLI_POOL_SIZE, 
+                          PJ_CLI_POOL_INC, NULL);
+    if (!pool)
+        return PJ_ENOMEM;
     cli = PJ_POOL_ZALLOC_T(pool, struct pj_cli_t);
-    if (!cli)
-        return PJ_ENOMEM;
 
     pj_memcpy(&cli->cfg, cfg, sizeof(*cfg));
@@ -89 +141 @@
     cli->root.sub_cmd = PJ_POOL_ZALLOC_T(pool, pj_cli_cmd_spec);
     pj_list_init(cli->root.sub_cmd);
+
+    /* Register some standard commands. */
+    for (i = 0; i < sizeof(cmd_xmls)/sizeof(cmd_xmls[0]); i++) {
+        pj_str_t xml = pj_str(cmd_xmls[i]);
+
+        if (pj_cli_add_cmd_from_xml(cli, NULL, &xml, &cmd_handler, NULL) !=
+            PJ_SUCCESS)
+            TRACE_((THIS_FILE, "Failed to add command #%d", i));
+    }
 
     *p_cli = cli;
@@ -167 +228 @@
     pj_assert(sess);
 
-    if (sess->op->destroy)
+    if (sess->op && sess->op->destroy)
         (*sess->op->destroy)(sess);
 }
@@ -184 +245 @@
                                             pj_cli_cmd_spec *p_cmd)
 {
+    #define ERROR_(STATUS) \
+        do {status = STATUS; goto on_exit;} while(0)
     pj_pool_t *pool;
     pj_xml_node *root;
@@ -197 +260 @@
     /* Parse the xml */
     pool = pj_pool_create(cli->cfg.pf, "xml", 1024, 1024, NULL);
+    if (!pool)
+        return PJ_ENOMEM;
     root = pj_xml_parse(pool, xml->ptr, xml->slen);
     if (!root) {
         TRACE_((THIS_FILE, "Error: unable to parse XML"));
-        status = PJ_EINVAL;
-        goto on_exit;
-    }
-
-    if (pj_stricmp2(&root->name, "CMD")) {
-        status = PJ_EINVAL;
-        goto on_exit;
-    }
+        ERROR_(PJ_CLI_EBADXML);
+    }
+
+    if (pj_stricmp2(&root->name, "CMD"))
+        ERROR_(PJ_EINVAL);
 
     /* Initialize the command spec */
     cmd = PJ_POOL_ZALLOC_T(cli->pool, struct pj_cli_cmd_spec);
-    if (!cmd) {
-        status = PJ_ENOMEM;
-        goto on_exit;
-    }
     
     /* Get the command attributes */
@@ -227 +285 @@
                             attr->value.slen, NULL))
             {
-                status = PJ_CLI_EBADNAME;
-                goto on_exit;
+                ERROR_(PJ_CLI_EBADNAME);
             }
 
@@ -267 +324 @@
             PJ_CATCH_ANY {
                 pj_scan_fini(&scanner);
-                status = PJ_GET_EXCEPTION();
-                goto on_exit;
+                ERROR_(PJ_GET_EXCEPTION());
             }
             PJ_END;
@@ -290 +346 @@
                     pj_cli_arg_spec *arg;
 
-                    if (cmd->arg_cnt >= PJ_CLI_MAX_ARGS) {
-                        status = PJ_CLI_ETOOMANYARGS;
-                        goto on_exit;
-                    }
+                    if (cmd->arg_cnt >= PJ_CLI_MAX_ARGS)
+                        ERROR_(PJ_CLI_ETOOMANYARGS);
                     arg = &args[cmd->arg_cnt];
                     pj_bzero(arg, sizeof(*arg));
@@ -323 +377 @@
     if (cmd->id == PJ_CLI_CMD_ID_GROUP) {
         /* Command group shouldn't have any shortcuts nor arguments */
-        if (!cmd->sc_cnt || !cmd->arg_cnt) {
-            status = PJ_EINVAL;
-            goto on_exit;
-        }
+        if (!cmd->sc_cnt || !cmd->arg_cnt)
+            ERROR_(PJ_EINVAL);
         cmd->sub_cmd = PJ_POOL_ALLOC_T(cli->pool, struct pj_cli_cmd_spec);
         pj_list_init(cmd->sub_cmd);
     }
 
-    if (!cmd->name.slen) {
-        status = PJ_CLI_EBADNAME;
-        goto on_exit;
-    }
+    if (!cmd->name.slen)
+        ERROR_(PJ_CLI_EBADNAME);
 
     if (cmd->arg_cnt) {
@@ -341 +391 @@
         cmd->arg = (pj_cli_arg_spec *)pj_pool_zalloc(cli->pool, cmd->arg_cnt *
                                                      sizeof(pj_cli_arg_spec));
-        if (!cmd->arg) {
-            status = PJ_ENOMEM;
-            goto on_exit;
-        }
         for (i = 0; i < cmd->arg_cnt; i++) {
             pj_strdup(cli->pool, &cmd->arg[i].name, &args[i].name);
@@ -357 +403 @@
         cmd->sc = (pj_str_t *)pj_pool_zalloc(cli->pool, cmd->sc_cnt *
                                              sizeof(pj_str_t));
-        if (!cmd->sc) {
-            status = PJ_ENOMEM;
-            goto on_exit;
-        }
         for (i = 0; i < cmd->sc_cnt; i++) {
             pj_strdup(cli->pool, &cmd->sc[i], &sc[i]);
-            pj_hash_set(cli->pool, cli->hash, cmd->sc[i].ptr, 
-                        cmd->sc[i].slen, 0, cmd);
+            pj_hash_set(cli->pool, cli->hash, sc[i].ptr, 
+                        sc[i].slen, 0, cmd);
         }
     }
@@ -384 +426 @@
 
     return status;
+#undef ERROR_
 }
 
@@ -406 +449 @@
     /* Parse the command line. */
     len = pj_ansi_strlen(cmdline);
+    if (len > 0 && cmdline[len - 1] == '\n') {
+        cmdline[--len] = 0;
+        if (len > 0 && cmdline[len - 1] == '\r')
+            cmdline[--len] = 0;
+    }
     pj_scan_init(&scanner, cmdline, len, PJ_SCAN_AUTOSKIP_WS, 
                  &on_syntax_error);
@@ -441 +489 @@
         
         if (!pj_scan_is_eof(&scanner)) {
-            pj_scan_get_newline(&scanner);
-            if (!pj_scan_is_eof(&scanner))
-                PJ_THROW(PJ_CLI_EINVARG);
+            PJ_THROW(PJ_CLI_EINVARG);
         }
     }
@@ -478 +524 @@
         info = &einfo;
     status = pj_cli_parse(sess, cmdline, &val, info);
-
     if (status != PJ_SUCCESS)
         return status;