123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239 |
- /*
- * ------------------------------------------------------
- * shell_xml.c
- *
- * This file implements the means to read an XML encoded file and populate the
- * CLI tree based on the contents.
- * ------------------------------------------------------
- */
- #include "private.h"
- #include "xmlapi.h"
- #include "lub/string.h"
- #include "lub/ctype.h"
- #include "lub/system.h"
- #include <stdlib.h>
- #include <string.h>
- #include <assert.h>
- #include <errno.h>
- #include <sys/types.h>
- #include <dirent.h>
- #define CLISH_XML_ERROR_STR "Error parsing XML: "
- #define CLISH_XML_ERROR_ATTR(attr) CLISH_XML_ERROR_STR"The \""attr"\" attribute is required.\n"
- typedef int (PROCESS_FN) (clish_shell_t * instance,
- clish_xmlnode_t * element, void *parent);
- /* Define a control block for handling the decode of an XML file */
- typedef struct clish_xml_cb_s clish_xml_cb_t;
- struct clish_xml_cb_s {
- const char *element;
- PROCESS_FN *handler;
- };
- /* forward declare the handler functions */
- static PROCESS_FN
- process_clish_module,
- process_startup,
- process_view,
- process_command,
- process_param,
- process_action,
- process_ptype,
- process_overview,
- process_detail,
- process_namespace,
- process_config,
- process_var,
- process_wdog,
- process_hotkey,
- process_plugin,
- process_hook;
- static clish_xml_cb_t xml_elements[] = {
- {"CLISH_MODULE", process_clish_module},
- {"STARTUP", process_startup},
- {"VIEW", process_view},
- {"COMMAND", process_command},
- {"PARAM", process_param},
- {"ACTION", process_action},
- {"PTYPE", process_ptype},
- {"OVERVIEW", process_overview},
- {"DETAIL", process_detail},
- {"NAMESPACE", process_namespace},
- {"CONFIG", process_config},
- {"VAR", process_var},
- {"WATCHDOG", process_wdog},
- {"HOTKEY", process_hotkey},
- {"PLUGIN", process_plugin},
- {"HOOK", process_hook},
- {NULL, NULL}
- };
- /*
- * if CLISH_PATH is unset in the environment then this is the value used.
- */
- const char *default_path = "/etc/clish;~/.clish";
- /*-------------------------------------------------------- */
- int clish_shell_load_scheme(clish_shell_t *this, const char *xml_path)
- {
- const char *path = xml_path;
- char *buffer;
- char *dirname;
- char *saveptr;
- int res = 0;
- int i = 0;
- /* use the default path */
- if (!path)
- path = default_path;
- /* take a copy of the path */
- buffer = lub_system_tilde_expand(path);
- /* now loop though each directory */
- for (dirname = strtok_r(buffer, ";", &saveptr);
- dirname; dirname = strtok_r(NULL, ";", &saveptr)) {
- DIR *dir;
- struct dirent *entry;
- /* search this directory for any XML files */
- dir = opendir(dirname);
- if (NULL == dir) {
- #ifdef DEBUG
- tinyrl_printf(this->tinyrl,
- "*** Failed to open '%s' directory\n",
- dirname);
- #endif
- continue;
- }
- for (entry = readdir(dir); entry; entry = readdir(dir)) {
- const char *extension = strrchr(entry->d_name, '.');
- /* check the filename */
- if ((NULL != extension) &&
- (0 == strcmp(".xml", extension))) {
- char *filename = NULL;
- /* build the filename */
- lub_string_cat(&filename, dirname);
- lub_string_cat(&filename, "/");
- lub_string_cat(&filename, entry->d_name);
- #ifdef DEBUG
- fprintf(stderr, "Parse XML-file: %s\n", filename);
- #endif
- /* load this file */
- res = clish_shell_xml_read(this, filename);
- /* Error message */
- if (res)
- fprintf(stderr, CLISH_XML_ERROR_STR"File %s\n",
- filename);
- /* release the resource */
- lub_string_free(filename);
- }
- if (res)
- break;
- }
- /* all done for this directory */
- closedir(dir);
- if (res)
- break;
- }
- /* tidy up */
- lub_string_free(buffer);
- /* Add default syms to unresolved table */
- for (i = 0; i < CLISH_SYM_TYPE_MAX; i++) {
- if (this->hooks[i])
- lub_list_add(this->syms, this->hooks[i]);
- }
- #ifdef DEBUG
- clish_shell_dump(this);
- #endif
- return res;
- }
- /*
- * ------------------------------------------------------
- * This function reads an element from the XML stream and processes it.
- * ------------------------------------------------------
- */
- static int process_node(clish_shell_t * shell, clish_xmlnode_t * node, void *parent)
- {
- int res = 0;
- switch (clish_xmlnode_get_type(node)) {
- case CLISH_XMLNODE_ELM: {
- clish_xml_cb_t * cb;
- char name[128];
- unsigned int namelen = sizeof(name);
- if (clish_xmlnode_get_name(node, name, &namelen) == 0) {
- for (cb = &xml_elements[0]; cb->element; cb++) {
- if (0 == strcmp(name, cb->element)) {
- #ifdef DEBUG
- fprintf(stderr, "NODE:");
- clish_xmlnode_print(node, stderr);
- fprintf(stderr, "\n");
- #endif
- /* process the elements at this level */
- res = cb->handler(shell, node, parent);
- /* Error message */
- if (res) {
- char *ename = clish_xmlnode_fetch_attr(node, "name");
- char *eref = clish_xmlnode_fetch_attr(node, "ref");
- char *ekey = clish_xmlnode_fetch_attr(node, "key");
- char *efile = clish_xmlnode_fetch_attr(node, "file");
- fprintf(stderr, CLISH_XML_ERROR_STR"Node %s", name);
- if (ename)
- fprintf(stderr, ", name=\"%s\"", ename);
- if (eref)
- fprintf(stderr, ", ref=\"%s\"", eref);
- if (ekey)
- fprintf(stderr, ", key=\"%s\"", ekey);
- if (efile)
- fprintf(stderr, ", file=\"%s\"", efile);
- fprintf(stderr, "\n");
- clish_xml_release(ename);
- clish_xml_release(eref);
- clish_xml_release(ekey);
- clish_xml_release(efile);
- }
- break;
- }
- }
- }
- break;
- }
- case CLISH_XMLNODE_DOC:
- case CLISH_XMLNODE_TEXT:
- case CLISH_XMLNODE_ATTR:
- case CLISH_XMLNODE_PI:
- case CLISH_XMLNODE_COMMENT:
- case CLISH_XMLNODE_DECL:
- case CLISH_XMLNODE_UNKNOWN:
- default:
- break;
- }
- return res;
- }
- /* ------------------------------------------------------ */
- static int process_children(clish_shell_t *shell,
- clish_xmlnode_t *element, void *parent)
- {
- clish_xmlnode_t *node = NULL;
- int res;
- while ((node = clish_xmlnode_next_child(element, node)) != NULL) {
- /* Now deal with all the contained elements */
- res = process_node(shell, node, parent);
- if (res)
- return res;
- }
- return 0;
- }
- /* ------------------------------------------------------ */
- int clish_shell_xml_read(clish_shell_t * shell, const char *filename)
- {
- int ret = -1;
- clish_xmldoc_t *doc;
- doc = clish_xmldoc_read(filename);
- if (clish_xmldoc_is_valid(doc)) {
- clish_xmlnode_t *root = clish_xmldoc_get_root(doc);
- ret = process_node(shell, root, NULL);
- } else {
- int errcaps = clish_xmldoc_error_caps(doc);
- printf("Unable to open file '%s'", filename);
- if ((errcaps & CLISH_XMLERR_LINE) == CLISH_XMLERR_LINE)
- printf(", at line %d", clish_xmldoc_get_err_line(doc));
- if ((errcaps & CLISH_XMLERR_COL) == CLISH_XMLERR_COL)
- printf(", at column %d", clish_xmldoc_get_err_col(doc));
- if ((errcaps & CLISH_XMLERR_DESC) == CLISH_XMLERR_DESC)
- printf(", message is %s", clish_xmldoc_get_err_msg(doc));
- printf("\n");
- }
- clish_xmldoc_release(doc);
- return ret;
- }
- /* ------------------------------------------------------ */
- static int
- process_clish_module(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- /* Create the global view */
- if (!shell->global)
- shell->global = clish_shell_find_create_view(shell,
- "global", "");
- return process_children(shell, element, shell->global);
- }
- /* ------------------------------------------------------ */
- static int process_view(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_view_t *view;
- // int allowed = 1;
- int res = -1;
- char *name = clish_xmlnode_fetch_attr(element, "name");
- char *prompt = clish_xmlnode_fetch_attr(element, "prompt");
- char *depth = clish_xmlnode_fetch_attr(element, "depth");
- char *restore = clish_xmlnode_fetch_attr(element, "restore");
- char *access = clish_xmlnode_fetch_attr(element, "access");
- /* Check permissions */
- // if (access) {
- // allowed = 0;
- // if (shell->hooks->access_fn)
- // allowed = shell->hooks->access_fn(shell, access);
- // }
- // if (!allowed)
- // goto process_view_end;
- /* Check syntax */
- if (!name) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
- goto error;
- }
- /* re-use a view if it already exists */
- view = clish_shell_find_create_view(shell, name, prompt);
- if (depth && (lub_ctype_isdigit(*depth))) {
- unsigned res = atoi(depth);
- clish_view__set_depth(view, res);
- }
- if (restore) {
- if (!lub_string_nocasecmp(restore, "depth"))
- clish_view__set_restore(view, CLISH_RESTORE_DEPTH);
- else if (!lub_string_nocasecmp(restore, "view"))
- clish_view__set_restore(view, CLISH_RESTORE_VIEW);
- else
- clish_view__set_restore(view, CLISH_RESTORE_NONE);
- }
- //process_view_end:
- res = process_children(shell, element, view);
- error:
- clish_xml_release(name);
- clish_xml_release(prompt);
- clish_xml_release(depth);
- clish_xml_release(restore);
- clish_xml_release(access);
- return res;
- ;
- }
- /* ------------------------------------------------------ */
- static int process_ptype(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_ptype_method_e method;
- clish_ptype_preprocess_e preprocess;
- int res = -1;
- char *name = clish_xmlnode_fetch_attr(element, "name");
- char *help = clish_xmlnode_fetch_attr(element, "help");
- char *pattern = clish_xmlnode_fetch_attr(element, "pattern");
- char *method_name = clish_xmlnode_fetch_attr(element, "method");
- char *preprocess_name = clish_xmlnode_fetch_attr(element, "preprocess");
- /* Check syntax */
- if (!name) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
- goto error;
- }
- if (!pattern) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("pattern"));
- goto error;
- }
- method = clish_ptype_method_resolve(method_name);
- preprocess = clish_ptype_preprocess_resolve(preprocess_name);
- clish_shell_find_create_ptype(shell,
- name, help, pattern, method, preprocess);
- res = 0;
- error:
- clish_xml_release(name);
- clish_xml_release(help);
- clish_xml_release(pattern);
- clish_xml_release(method_name);
- clish_xml_release(preprocess_name);
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_overview(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- char *content = NULL;
- unsigned int content_len = 2048;
- int result;
- /*
- * the code below faithfully assume that we'll be able fully store
- * the content of the node. If it's really, really big, we may have
- * an issue (but then, if it's that big, how the hell does it
- * already fits in allocated memory?)
- * Ergo, it -should- be safe.
- */
- do {
- content = (char*)realloc(content, content_len);
- result = clish_xmlnode_get_content(element, content,
- &content_len);
- } while (result == -E2BIG);
- if (result == 0 && content) {
- /* set the overview text for this view */
- assert(NULL == shell->overview);
- /* store the overview */
- shell->overview = lub_string_dup(content);
- }
- if (content)
- free(content);
- return 0;
- }
- /* ------------------------------------------------------ */
- static int
- process_command(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_view_t *v = (clish_view_t *) parent;
- clish_command_t *cmd = NULL;
- clish_command_t *old;
- char *alias_name = NULL;
- clish_view_t *alias_view = NULL;
- // int allowed = 1;
- int res = -1;
- char *access = clish_xmlnode_fetch_attr(element, "access");
- char *name = clish_xmlnode_fetch_attr(element, "name");
- char *help = clish_xmlnode_fetch_attr(element, "help");
- char *view = clish_xmlnode_fetch_attr(element, "view");
- char *viewid = clish_xmlnode_fetch_attr(element, "viewid");
- char *escape_chars = clish_xmlnode_fetch_attr(element, "escape_chars");
- char *args_name = clish_xmlnode_fetch_attr(element, "args");
- char *args_help = clish_xmlnode_fetch_attr(element, "args_help");
- char *lock = clish_xmlnode_fetch_attr(element, "lock");
- char *interrupt = clish_xmlnode_fetch_attr(element, "interrupt");
- char *ref = clish_xmlnode_fetch_attr(element, "ref");
- /* Check syntax */
- if (!name) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
- goto error;
- }
- if (!help) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("help"));
- goto error;
- }
- /* Check permissions */
- // if (access) {
- // allowed = 0;
- // if (shell->hooks->access_fn)
- // allowed = shell->hooks->access_fn(shell, access);
- // }
- // if (!allowed)
- // goto process_command_end;
- /* check this command doesn't already exist */
- old = clish_view_find_command(v, name, BOOL_FALSE);
- if (old) {
- fprintf(stderr, CLISH_XML_ERROR_STR"Duplicate COMMAND name=\"%s\".\n", name);
- goto error;
- }
- /* Reference 'ref' field */
- if (ref) {
- char *saveptr;
- const char *delim = "@";
- char *view_name = NULL;
- char *cmdn = NULL;
- char *str = lub_string_dup(ref);
- cmdn = strtok_r(str, delim, &saveptr);
- if (!cmdn) {
- fprintf(stderr, CLISH_XML_ERROR_STR"Invalid \"ref\" attribute value.\n");
- lub_string_free(str);
- goto error;
- }
- alias_name = lub_string_dup(cmdn);
- view_name = strtok_r(NULL, delim, &saveptr);
- if (!view_name)
- alias_view = v;
- else
- alias_view = clish_shell_find_create_view(shell,
- view_name, NULL);
- lub_string_free(str);
- }
- /* create a command */
- cmd = clish_view_new_command(v, name, help);
- clish_command__set_pview(cmd, v);
- /* define some specialist escape characters */
- if (escape_chars)
- clish_command__set_escape_chars(cmd, escape_chars);
- if (args_name) {
- /* define a "rest of line" argument */
- clish_param_t *param;
- clish_ptype_t *tmp = NULL;
- /* Check syntax */
- if (!args_help) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("args_help"));
- goto error;
- }
- tmp = clish_shell_find_ptype(shell, "internal_ARGS");
- assert(tmp);
- param = clish_param_new(args_name, args_help, tmp);
- clish_command__set_args(cmd, param);
- }
- /* define the view which this command changes to */
- if (view) {
- clish_view_t *next = clish_shell_find_create_view(shell, view,
- NULL);
- /* reference the next view */
- clish_command__set_view(cmd, next);
- }
- /* define the view id which this command changes to */
- if (viewid)
- clish_command__set_viewid(cmd, viewid);
- /* lock field */
- if (lock && lub_string_nocasecmp(lock, "false") == 0)
- clish_command__set_lock(cmd, BOOL_FALSE);
- else
- clish_command__set_lock(cmd, BOOL_TRUE);
- /* interrupt field */
- if (interrupt && lub_string_nocasecmp(interrupt, "true") == 0)
- clish_command__set_interrupt(cmd, BOOL_TRUE);
- else
- clish_command__set_interrupt(cmd, BOOL_FALSE);
- /* Set alias */
- if (alias_name) {
- /* Check syntax */
- if (!alias_view) {
- fprintf(stderr, CLISH_XML_ERROR_STR"Can't find reference VIEW.\n");
- lub_string_free(alias_name);
- goto error;
- }
- if ((alias_view == v) && (!strcmp(alias_name, name))) {
- fprintf(stderr, CLISH_XML_ERROR_STR"The COMMAND with reference to itself.\n");
- lub_string_free(alias_name);
- goto error;
- }
- clish_command__set_alias(cmd, alias_name);
- clish_command__set_alias_view(cmd, alias_view);
- lub_string_free(alias_name);
- }
- //process_command_end:
- res = process_children(shell, element, cmd);
- error:
- clish_xml_release(access);
- clish_xml_release(name);
- clish_xml_release(help);
- clish_xml_release(view);
- clish_xml_release(viewid);
- clish_xml_release(escape_chars);
- clish_xml_release(args_name);
- clish_xml_release(args_help);
- clish_xml_release(lock);
- clish_xml_release(interrupt);
- clish_xml_release(ref);
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_startup(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_view_t *v = (clish_view_t *) parent;
- clish_command_t *cmd = NULL;
- int res = -1;
- char *view = clish_xmlnode_fetch_attr(element, "view");
- char *viewid = clish_xmlnode_fetch_attr(element, "viewid");
- char *default_shebang =
- clish_xmlnode_fetch_attr(element, "default_shebang");
- char *default_builtin =
- clish_xmlnode_fetch_attr(element, "default_builtin");
- char *timeout = clish_xmlnode_fetch_attr(element, "timeout");
- char *lock = clish_xmlnode_fetch_attr(element, "lock");
- char *interrupt = clish_xmlnode_fetch_attr(element, "interrupt");
- /* Check syntax */
- if (!view) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("view"));
- goto error;
- }
- if (shell->startup) {
- fprintf(stderr, CLISH_XML_ERROR_STR"STARTUP tag duplication.\n");
- goto error;
- }
- /* create a command with NULL help */
- cmd = clish_view_new_command(v, "startup", NULL);
- clish_command__set_lock(cmd, BOOL_FALSE);
- /* define the view which this command changes to */
- clish_view_t *next = clish_shell_find_create_view(shell, view, NULL);
- /* reference the next view */
- clish_command__set_view(cmd, next);
- /* define the view id which this command changes to */
- if (viewid)
- clish_command__set_viewid(cmd, viewid);
- if (default_shebang)
- clish_shell__set_default_shebang(shell, default_shebang);
- if (default_builtin)
- clish_sym__set_name(shell->hooks[CLISH_SYM_TYPE_ACTION],
- default_builtin);
- if (timeout)
- clish_shell__set_timeout(shell, atoi(timeout));
- /* lock field */
- if (lock && lub_string_nocasecmp(lock, "false") == 0)
- clish_command__set_lock(cmd, BOOL_FALSE);
- else
- clish_command__set_lock(cmd, BOOL_TRUE);
- /* interrupt field */
- if (interrupt && lub_string_nocasecmp(interrupt, "true") == 0)
- clish_command__set_interrupt(cmd, BOOL_TRUE);
- else
- clish_command__set_interrupt(cmd, BOOL_FALSE);
- /* remember this command */
- shell->startup = cmd;
- res = process_children(shell, element, cmd);
- error:
- clish_xml_release(view);
- clish_xml_release(viewid);
- clish_xml_release(default_shebang);
- clish_xml_release(default_builtin);
- clish_xml_release(timeout);
- clish_xml_release(lock);
- clish_xml_release(interrupt);
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_param(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_command_t *cmd = NULL;
- clish_param_t *p_param = NULL;
- clish_xmlnode_t *pelement;
- char *pname;
- int res = -1;
- pelement = clish_xmlnode_parent(element);
- pname = clish_xmlnode_get_all_name(pelement);
- if (pname && lub_string_nocasecmp(pname, "PARAM") == 0)
- p_param = (clish_param_t *)parent;
- else
- cmd = (clish_command_t *)parent;
- if (pname)
- free(pname);
- if (cmd || p_param) {
- char *name = clish_xmlnode_fetch_attr(element, "name");
- char *help = clish_xmlnode_fetch_attr(element, "help");
- char *ptype = clish_xmlnode_fetch_attr(element, "ptype");
- char *prefix = clish_xmlnode_fetch_attr(element, "prefix");
- char *defval = clish_xmlnode_fetch_attr(element, "default");
- char *mode = clish_xmlnode_fetch_attr(element, "mode");
- char *optional = clish_xmlnode_fetch_attr(element, "optional");
- char *order = clish_xmlnode_fetch_attr(element, "order");
- char *value = clish_xmlnode_fetch_attr(element, "value");
- char *hidden = clish_xmlnode_fetch_attr(element, "hidden");
- char *test = clish_xmlnode_fetch_attr(element, "test");
- char *completion = clish_xmlnode_fetch_attr(element, "completion");
- clish_param_t *param;
- clish_ptype_t *tmp = NULL;
- /* Check syntax */
- if (cmd && (cmd == shell->startup)) {
- fprintf(stderr, CLISH_XML_ERROR_STR"STARTUP can't contain PARAMs.\n");
- goto error;
- }
- if (!name) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
- goto error;
- }
- if (!help) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("help"));
- goto error;
- }
- if (!ptype) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("ptype"));
- goto error;
- }
- if (*ptype) {
- tmp = clish_shell_find_create_ptype(shell, ptype,
- NULL, NULL,
- CLISH_PTYPE_REGEXP,
- CLISH_PTYPE_NONE);
- }
- param = clish_param_new(name, help, tmp);
- /* If prefix is set clish will emulate old optional
- * command syntax over newer optional command mechanism.
- * It will create nested PARAM.
- */
- if (prefix) {
- const char *ptype_name = "__SUBCOMMAND";
- clish_param_t *opt_param = NULL;
- /* Create a ptype for prefix-named subcommand that
- * will contain the nested optional parameter. The
- * name of ptype is hardcoded. It's not good but
- * it's only the service ptype.
- */
- tmp = (clish_ptype_t *)lub_bintree_find(
- &shell->ptype_tree, ptype_name);
- if (!tmp)
- tmp = clish_shell_find_create_ptype(shell,
- ptype_name, "Option", "[^\\\\]+",
- CLISH_PTYPE_REGEXP, CLISH_PTYPE_NONE);
- opt_param = clish_param_new(prefix, help, tmp);
- clish_param__set_mode(opt_param,
- CLISH_PARAM_SUBCOMMAND);
- clish_param__set_optional(opt_param, BOOL_TRUE);
- if (test)
- clish_param__set_test(opt_param, test);
- /* add the parameter to the command */
- if (cmd)
- clish_command_insert_param(cmd, opt_param);
- /* add the parameter to the param */
- if (p_param)
- clish_param_insert_param(p_param, opt_param);
- /* Unset cmd and set parent param to opt_param */
- cmd = NULL;
- p_param = opt_param;
- }
- if (defval)
- clish_param__set_default(param, defval);
- if (hidden && lub_string_nocasecmp(hidden, "true") == 0)
- clish_param__set_hidden(param, BOOL_TRUE);
- else
- clish_param__set_hidden(param, BOOL_FALSE);
- if (mode) {
- if (lub_string_nocasecmp(mode, "switch") == 0) {
- clish_param__set_mode(param,
- CLISH_PARAM_SWITCH);
- /* Force hidden attribute */
- clish_param__set_hidden(param, BOOL_TRUE);
- } else if (lub_string_nocasecmp(mode, "subcommand") == 0)
- clish_param__set_mode(param,
- CLISH_PARAM_SUBCOMMAND);
- else
- clish_param__set_mode(param,
- CLISH_PARAM_COMMON);
- }
- if (optional && lub_string_nocasecmp(optional, "true") == 0)
- clish_param__set_optional(param, BOOL_TRUE);
- else
- clish_param__set_optional(param, BOOL_FALSE);
- if (order && lub_string_nocasecmp(order, "true") == 0)
- clish_param__set_order(param, BOOL_TRUE);
- else
- clish_param__set_order(param, BOOL_FALSE);
- if (value) {
- clish_param__set_value(param, value);
- /* Force mode to subcommand */
- clish_param__set_mode(param,
- CLISH_PARAM_SUBCOMMAND);
- }
- if (test && !prefix)
- clish_param__set_test(param, test);
- if (completion)
- clish_param__set_completion(param, completion);
- /* add the parameter to the command */
- if (cmd)
- clish_command_insert_param(cmd, param);
- /* add the parameter to the param */
- if (p_param)
- clish_param_insert_param(p_param, param);
- res = process_children(shell, element, param);
- error:
- clish_xml_release(name);
- clish_xml_release(help);
- clish_xml_release(ptype);
- clish_xml_release(prefix);
- clish_xml_release(defval);
- clish_xml_release(mode);
- clish_xml_release(optional);
- clish_xml_release(order);
- clish_xml_release(value);
- clish_xml_release(hidden);
- clish_xml_release(test);
- clish_xml_release(completion);
- }
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_action(clish_shell_t *shell, clish_xmlnode_t *element, void *parent)
- {
- clish_action_t *action = NULL;
- char *builtin = clish_xmlnode_fetch_attr(element, "builtin");
- char *shebang = clish_xmlnode_fetch_attr(element, "shebang");
- clish_xmlnode_t *pelement = clish_xmlnode_parent(element);
- char *pname = clish_xmlnode_get_all_name(pelement);
- char *text;
- clish_sym_t *sym = NULL;
- if (pname && lub_string_nocasecmp(pname, "VAR") == 0)
- action = clish_var__get_action((clish_var_t *)parent);
- else
- action = clish_command__get_action((clish_command_t *)parent);
- if (pname)
- free(pname);
- text = clish_xmlnode_get_all_content(element);
- if (text && *text) {
- /* store the action */
- clish_action__set_script(action, text);
- }
- if (text)
- free(text);
- if (builtin)
- sym = clish_shell_add_unresolved_sym(shell, builtin,
- CLISH_SYM_TYPE_ACTION);
- else
- sym = shell->hooks[CLISH_SYM_TYPE_ACTION];
- clish_action__set_builtin(action, sym);
- if (shebang)
- clish_action__set_shebang(action, shebang);
- clish_xml_release(builtin);
- clish_xml_release(shebang);
- return 0;
- }
- /* ------------------------------------------------------ */
- static int
- process_detail(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_command_t *cmd = (clish_command_t *) parent;
- /* read the following text element */
- char *text = clish_xmlnode_get_all_content(element);
- if (text && *text) {
- /* store the action */
- clish_command__set_detail(cmd, text);
- }
- if (text)
- free(text);
- return 0;
- }
- /* ------------------------------------------------------ */
- static int
- process_namespace(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_view_t *v = (clish_view_t *) parent;
- clish_nspace_t *nspace = NULL;
- int res = -1;
- char *view = clish_xmlnode_fetch_attr(element, "ref");
- char *prefix = clish_xmlnode_fetch_attr(element, "prefix");
- char *prefix_help = clish_xmlnode_fetch_attr(element, "prefix_help");
- char *help = clish_xmlnode_fetch_attr(element, "help");
- char *completion = clish_xmlnode_fetch_attr(element, "completion");
- char *context_help = clish_xmlnode_fetch_attr(element, "context_help");
- char *inherit = clish_xmlnode_fetch_attr(element, "inherit");
- char *access = clish_xmlnode_fetch_attr(element, "access");
- // int allowed = 1;
- // if (access) {
- // allowed = 0;
- // if (shell->hooks->access_fn)
- // allowed = shell->hooks->access_fn(shell, access);
- // }
- // if (!allowed)
- // goto process_namespace_end;
- /* Check syntax */
- if (!view) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("ref"));
- goto error;
- }
- clish_view_t *ref_view = clish_shell_find_create_view(shell,
- view, NULL);
- /* Don't include itself without prefix */
- if ((ref_view == v) && !prefix)
- goto process_namespace_end;
- nspace = clish_nspace_new(ref_view);
- clish_view_insert_nspace(v, nspace);
- if (prefix) {
- clish_nspace__set_prefix(nspace, prefix);
- if (prefix_help)
- clish_nspace_create_prefix_cmd(nspace,
- "prefix",
- prefix_help);
- else
- clish_nspace_create_prefix_cmd(nspace,
- "prefix",
- "Prefix for the imported commands.");
- }
- if (help && lub_string_nocasecmp(help, "true") == 0)
- clish_nspace__set_help(nspace, BOOL_TRUE);
- else
- clish_nspace__set_help(nspace, BOOL_FALSE);
- if (completion && lub_string_nocasecmp(completion, "false") == 0)
- clish_nspace__set_completion(nspace, BOOL_FALSE);
- else
- clish_nspace__set_completion(nspace, BOOL_TRUE);
- if (context_help && lub_string_nocasecmp(context_help, "true") == 0)
- clish_nspace__set_context_help(nspace, BOOL_TRUE);
- else
- clish_nspace__set_context_help(nspace, BOOL_FALSE);
- if (inherit && lub_string_nocasecmp(inherit, "false") == 0)
- clish_nspace__set_inherit(nspace, BOOL_FALSE);
- else
- clish_nspace__set_inherit(nspace, BOOL_TRUE);
- process_namespace_end:
- res = 0;
- error:
- clish_xml_release(view);
- clish_xml_release(prefix);
- clish_xml_release(prefix_help);
- clish_xml_release(help);
- clish_xml_release(completion);
- clish_xml_release(context_help);
- clish_xml_release(inherit);
- clish_xml_release(access);
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_config(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_command_t *cmd = (clish_command_t *)parent;
- clish_config_t *config;
- if (!cmd)
- return 0;
- config = clish_command__get_config(cmd);
- /* read the following text element */
- char *operation = clish_xmlnode_fetch_attr(element, "operation");
- char *priority = clish_xmlnode_fetch_attr(element, "priority");
- char *pattern = clish_xmlnode_fetch_attr(element, "pattern");
- char *file = clish_xmlnode_fetch_attr(element, "file");
- char *splitter = clish_xmlnode_fetch_attr(element, "splitter");
- char *seq = clish_xmlnode_fetch_attr(element, "sequence");
- char *unique = clish_xmlnode_fetch_attr(element, "unique");
- char *depth = clish_xmlnode_fetch_attr(element, "depth");
- if (operation && !lub_string_nocasecmp(operation, "unset"))
- clish_config__set_op(config, CLISH_CONFIG_UNSET);
- else if (operation && !lub_string_nocasecmp(operation, "none"))
- clish_config__set_op(config, CLISH_CONFIG_NONE);
- else if (operation && !lub_string_nocasecmp(operation, "dump"))
- clish_config__set_op(config, CLISH_CONFIG_DUMP);
- else {
- clish_config__set_op(config, CLISH_CONFIG_SET);
- /* The priority if no clearly specified */
- clish_config__set_priority(config, 0x7f00);
- }
- if (priority) {
- long val = 0;
- char *endptr;
- unsigned short pri;
- val = strtol(priority, &endptr, 0);
- if (endptr == priority)
- pri = 0;
- else if (val > 0xffff)
- pri = 0xffff;
- else if (val < 0)
- pri = 0;
- else
- pri = (unsigned short)val;
- clish_config__set_priority(config, pri);
- }
- if (pattern)
- clish_config__set_pattern(config, pattern);
- else
- clish_config__set_pattern(config, "^${__cmd}");
- if (file)
- clish_config__set_file(config, file);
- if (splitter && lub_string_nocasecmp(splitter, "false") == 0)
- clish_config__set_splitter(config, BOOL_FALSE);
- else
- clish_config__set_splitter(config, BOOL_TRUE);
- if (unique && lub_string_nocasecmp(unique, "false") == 0)
- clish_config__set_unique(config, BOOL_FALSE);
- else
- clish_config__set_unique(config, BOOL_TRUE);
- if (seq)
- clish_config__set_seq(config, seq);
- else
- /* The entries without sequence cannot be non-unique */
- clish_config__set_unique(config, BOOL_TRUE);
- if (depth)
- clish_config__set_depth(config, depth);
- clish_xml_release(operation);
- clish_xml_release(priority);
- clish_xml_release(pattern);
- clish_xml_release(file);
- clish_xml_release(splitter);
- clish_xml_release(seq);
- clish_xml_release(unique);
- clish_xml_release(depth);
- return 0;
- }
- /* ------------------------------------------------------ */
- static int
- process_var(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
- {
- clish_var_t *var = NULL;
- int res = -1;
- char *name = clish_xmlnode_fetch_attr(element, "name");
- char *dynamic = clish_xmlnode_fetch_attr(element, "dynamic");
- char *value = clish_xmlnode_fetch_attr(element, "value");
- /* Check syntax */
- if (!name) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
- goto error;
- }
- /* Check if this var doesn't already exist */
- var = (clish_var_t *)lub_bintree_find(&shell->var_tree, name);
- if (var) {
- fprintf(stderr, CLISH_XML_ERROR_STR"Duplicate VAR name=\"%s\".\n", name);
- goto error;
- }
- /* Create var instance */
- var = clish_var_new(name);
- lub_bintree_insert(&shell->var_tree, var);
- if (dynamic && lub_string_nocasecmp(dynamic, "true") == 0)
- clish_var__set_dynamic(var, BOOL_TRUE);
- if (value)
- clish_var__set_value(var, value);
- res = process_children(shell, element, var);
- error:
- clish_xml_release(name);
- clish_xml_release(dynamic);
- clish_xml_release(value);
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_wdog(clish_shell_t *shell,
- clish_xmlnode_t *element, void *parent)
- {
- clish_view_t *v = (clish_view_t *)parent;
- clish_command_t *cmd = NULL;
- int res = -1;
- /* Check syntax */
- if (shell->wdog) {
- fprintf(stderr, CLISH_XML_ERROR_STR"WATCHDOG tag duplication.\n");
- goto error;
- }
- /* Create a command with NULL help */
- cmd = clish_view_new_command(v, "watchdog", NULL);
- clish_command__set_lock(cmd, BOOL_FALSE);
- /* Remember this command */
- shell->wdog = cmd;
- res = process_children(shell, element, cmd);
- error:
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_hotkey(clish_shell_t *shell, clish_xmlnode_t* element, void *parent)
- {
- clish_view_t *v = (clish_view_t *)parent;
- int res = -1;
- char *key = clish_xmlnode_fetch_attr(element, "key");
- char *cmd = clish_xmlnode_fetch_attr(element, "cmd");
- /* Check syntax */
- if (!key) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("key"));
- goto error;
- }
- if (!cmd) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("cmd"));
- goto error;
- }
- clish_view_insert_hotkey(v, key, cmd);
- res = 0;
- error:
- clish_xml_release(key);
- clish_xml_release(cmd);
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_plugin(clish_shell_t *shell, clish_xmlnode_t* element, void *parent)
- {
- clish_plugin_t *plugin;
- char *file = clish_xmlnode_fetch_attr(element, "file");
- char *name = clish_xmlnode_fetch_attr(element, "name");
- int res = -1;
- /* Check syntax */
- if (!file) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("file"));
- goto error;
- }
- plugin = clish_plugin_new(name, file);
- lub_list_add(shell->plugins, plugin);
- res = 0;
- error:
- clish_xml_release(file);
- clish_xml_release(name);
- return res;
- }
- /* ------------------------------------------------------ */
- static int
- process_hook(clish_shell_t *shell, clish_xmlnode_t* element, void *parent)
- {
- char *name = clish_xmlnode_fetch_attr(element, "name");
- char *builtin = clish_xmlnode_fetch_attr(element, "builtin");
- int res = -1;
- int type = CLISH_SYM_TYPE_NONE;
- /* Check syntax */
- if (!name) {
- fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
- goto error;
- }
- /* Find out HOOK type */
- if (!strcmp(name, "init"))
- type = CLISH_SYM_TYPE_INIT;
- else if (!strcmp(name, "fini"))
- type = CLISH_SYM_TYPE_FINI;
- else if (!strcmp(name, "access"))
- type = CLISH_SYM_TYPE_ACCESS;
- else if (!strcmp(name, "config"))
- type = CLISH_SYM_TYPE_CONFIG;
- else if (!strcmp(name, "log"))
- type = CLISH_SYM_TYPE_LOG;
- if (CLISH_SYM_TYPE_NONE == type) {
- fprintf(stderr, CLISH_XML_ERROR_STR"Unknown HOOK name %s.\n", name);
- goto error;
- }
- if (builtin) {
- if (shell->hooks[type])
- clish_sym__set_name(shell->hooks[type], builtin);
- else
- shell->hooks[type] = clish_sym_new(builtin, NULL, type);
- } else {
- if (shell->hooks[type])
- clish_sym_free(shell->hooks[type]);
- shell->hooks[type] = NULL;
- }
- res = 0;
- error:
- clish_xml_release(name);
- clish_xml_release(builtin);
- return res;
- }
- /* ------------------------------------------------------ */
|