shell_xml.c 28 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015
  1. /*
  2. * ------------------------------------------------------
  3. * shell_xml.c
  4. *
  5. * This file implements the means to read an XML encoded file and populate the
  6. * CLI tree based on the contents.
  7. * ------------------------------------------------------
  8. */
  9. #include "private.h"
  10. #include "xmlapi.h"
  11. #include "lub/string.h"
  12. #include "lub/ctype.h"
  13. #include "lub/system.h"
  14. #include <stdlib.h>
  15. #include <string.h>
  16. #include <assert.h>
  17. #include <errno.h>
  18. #include <sys/types.h>
  19. #include <dirent.h>
  20. typedef void (PROCESS_FN) (clish_shell_t * instance,
  21. clish_xmlnode_t * element, void *parent);
  22. /* Define a control block for handling the decode of an XML file */
  23. typedef struct clish_xml_cb_s clish_xml_cb_t;
  24. struct clish_xml_cb_s {
  25. const char *element;
  26. PROCESS_FN *handler;
  27. };
  28. /* forward declare the handler functions */
  29. static PROCESS_FN
  30. process_clish_module,
  31. process_startup,
  32. process_view,
  33. process_command,
  34. process_param,
  35. process_action,
  36. process_ptype,
  37. process_overview,
  38. process_detail,
  39. process_namespace,
  40. process_config,
  41. process_var,
  42. process_wdog,
  43. process_hotkey;
  44. static clish_xml_cb_t xml_elements[] = {
  45. {"CLISH_MODULE", process_clish_module},
  46. {"STARTUP", process_startup},
  47. {"VIEW", process_view},
  48. {"COMMAND", process_command},
  49. {"PARAM", process_param},
  50. {"ACTION", process_action},
  51. {"PTYPE", process_ptype},
  52. {"OVERVIEW", process_overview},
  53. {"DETAIL", process_detail},
  54. {"NAMESPACE", process_namespace},
  55. {"CONFIG", process_config},
  56. {"VAR", process_var},
  57. {"WATCHDOG", process_wdog},
  58. {"HOTKEY", process_hotkey},
  59. {NULL, NULL}
  60. };
  61. /*
  62. * if CLISH_PATH is unset in the environment then this is the value used.
  63. */
  64. const char *default_path = "/etc/clish;~/.clish";
  65. /*-------------------------------------------------------- */
  66. void clish_shell_load_scheme(clish_shell_t *this, const char *xml_path)
  67. {
  68. const char *path = xml_path;
  69. char *buffer;
  70. char *dirname;
  71. char *saveptr;
  72. /* use the default path */
  73. if (!path)
  74. path = default_path;
  75. /* take a copy of the path */
  76. buffer = lub_system_tilde_expand(path);
  77. /* now loop though each directory */
  78. for (dirname = strtok_r(buffer, ";", &saveptr);
  79. dirname; dirname = strtok_r(NULL, ";", &saveptr)) {
  80. DIR *dir;
  81. struct dirent *entry;
  82. /* search this directory for any XML files */
  83. dir = opendir(dirname);
  84. if (NULL == dir) {
  85. #ifdef DEBUG
  86. tinyrl_printf(this->tinyrl,
  87. "*** Failed to open '%s' directory\n",
  88. dirname);
  89. #endif
  90. continue;
  91. }
  92. for (entry = readdir(dir); entry; entry = readdir(dir)) {
  93. const char *extension = strrchr(entry->d_name, '.');
  94. /* check the filename */
  95. if ((NULL != extension) &&
  96. (0 == strcmp(".xml", extension))) {
  97. char *filename = NULL;
  98. /* build the filename */
  99. lub_string_cat(&filename, dirname);
  100. lub_string_cat(&filename, "/");
  101. lub_string_cat(&filename, entry->d_name);
  102. #ifdef DEBUG
  103. fprintf(stderr, "Parse XML-file: %s\n", filename);
  104. #endif
  105. /* load this file */
  106. (void)clish_shell_xml_read(this, filename);
  107. /* release the resource */
  108. lub_string_free(filename);
  109. }
  110. }
  111. /* all done for this directory */
  112. closedir(dir);
  113. }
  114. /* tidy up */
  115. lub_string_free(buffer);
  116. #ifdef DEBUG
  117. clish_shell_dump(this);
  118. #endif
  119. }
  120. /*
  121. * ------------------------------------------------------
  122. * This function reads an element from the XML stream and processes it.
  123. * ------------------------------------------------------
  124. */
  125. static void process_node(clish_shell_t * shell, clish_xmlnode_t * node, void *parent)
  126. {
  127. switch (clish_xmlnode_get_type(node)) {
  128. case CLISH_XMLNODE_ELM: {
  129. clish_xml_cb_t * cb;
  130. char name[128];
  131. unsigned int namelen = sizeof(name);
  132. if (clish_xmlnode_get_name(node, name, &namelen) == 0) {
  133. for (cb = &xml_elements[0]; cb->element; cb++) {
  134. if (0 == strcmp(name, cb->element)) {
  135. #ifdef DEBUG
  136. fprintf(stderr, "NODE:");
  137. clish_xmlnode_print(node, stderr);
  138. fprintf(stderr, "\n");
  139. #endif
  140. /* process the elements at this level */
  141. cb->handler(shell, node, parent);
  142. break;
  143. }
  144. }
  145. }
  146. break;
  147. }
  148. case CLISH_XMLNODE_DOC:
  149. case CLISH_XMLNODE_TEXT:
  150. case CLISH_XMLNODE_ATTR:
  151. case CLISH_XMLNODE_PI:
  152. case CLISH_XMLNODE_COMMENT:
  153. case CLISH_XMLNODE_DECL:
  154. case CLISH_XMLNODE_UNKNOWN:
  155. default:
  156. break;
  157. }
  158. }
  159. /* ------------------------------------------------------ */
  160. static void process_children(clish_shell_t * shell,
  161. clish_xmlnode_t * element, void *parent)
  162. {
  163. clish_xmlnode_t *node = NULL;
  164. while ((node = clish_xmlnode_next_child(element, node)) != NULL) {
  165. /* Now deal with all the contained elements */
  166. process_node(shell, node, parent);
  167. }
  168. }
  169. /* ------------------------------------------------------ */
  170. static void
  171. process_clish_module(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
  172. {
  173. // create the global view
  174. if (!shell->global)
  175. shell->global = clish_shell_find_create_view(shell,
  176. "global", "");
  177. process_children(shell, element, shell->global);
  178. parent = parent; /* Happy compiler */
  179. }
  180. /* ------------------------------------------------------ */
  181. static void process_view(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
  182. {
  183. clish_view_t *view;
  184. int allowed = 1;
  185. char *name = clish_xmlnode_fetch_attr(element, "name");
  186. char *prompt = clish_xmlnode_fetch_attr(element, "prompt");
  187. char *depth = clish_xmlnode_fetch_attr(element, "depth");
  188. char *restore = clish_xmlnode_fetch_attr(element, "restore");
  189. char *access = clish_xmlnode_fetch_attr(element, "access");
  190. /* Check permissions */
  191. if (access) {
  192. allowed = 0;
  193. if (shell->client_hooks->access_fn)
  194. allowed = shell->client_hooks->access_fn(shell, access);
  195. }
  196. if (!allowed)
  197. goto process_view_end;
  198. assert(name);
  199. /* re-use a view if it already exists */
  200. view = clish_shell_find_create_view(shell, name, prompt);
  201. if (depth && (lub_ctype_isdigit(*depth))) {
  202. unsigned res = atoi(depth);
  203. clish_view__set_depth(view, res);
  204. }
  205. if (restore) {
  206. if (!lub_string_nocasecmp(restore, "depth"))
  207. clish_view__set_restore(view, CLISH_RESTORE_DEPTH);
  208. else if (!lub_string_nocasecmp(restore, "view"))
  209. clish_view__set_restore(view, CLISH_RESTORE_VIEW);
  210. else
  211. clish_view__set_restore(view, CLISH_RESTORE_NONE);
  212. }
  213. process_children(shell, element, view);
  214. process_view_end:
  215. clish_xml_release(name);
  216. clish_xml_release(prompt);
  217. clish_xml_release(depth);
  218. clish_xml_release(restore);
  219. clish_xml_release(access);
  220. parent = parent; /* Happy compiler */
  221. }
  222. /* ------------------------------------------------------ */
  223. static void process_ptype(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
  224. {
  225. clish_ptype_method_e method;
  226. clish_ptype_preprocess_e preprocess;
  227. clish_ptype_t *ptype;
  228. char *name = clish_xmlnode_fetch_attr(element, "name");
  229. char *help = clish_xmlnode_fetch_attr(element, "help");
  230. char *pattern = clish_xmlnode_fetch_attr(element, "pattern");
  231. char *method_name = clish_xmlnode_fetch_attr(element, "method");
  232. char *preprocess_name = clish_xmlnode_fetch_attr(element, "preprocess");
  233. assert(name);
  234. assert(pattern);
  235. method = clish_ptype_method_resolve(method_name);
  236. preprocess = clish_ptype_preprocess_resolve(preprocess_name);
  237. ptype = clish_shell_find_create_ptype(shell,
  238. name, help, pattern, method, preprocess);
  239. assert(ptype);
  240. clish_xml_release(name);
  241. clish_xml_release(help);
  242. clish_xml_release(pattern);
  243. clish_xml_release(method_name);
  244. clish_xml_release(preprocess_name);
  245. parent = parent; /* Happy compiler */
  246. }
  247. /* ------------------------------------------------------ */
  248. static void process_overview(clish_shell_t *shell, clish_xmlnode_t *element,
  249. void *parent)
  250. {
  251. char *content = NULL;
  252. unsigned int content_len = 2048;
  253. int result;
  254. /*
  255. * the code below faithfully assume that we'll be able fully store
  256. * the content of the node. If it's really, really big, we may have
  257. * an issue (but then, if it's that big, how the hell does it
  258. * already fits in allocated memory?)
  259. * Ergo, it -should- be safe.
  260. */
  261. do {
  262. content = (char*)realloc(content, content_len);
  263. result = clish_xmlnode_get_content(element, content,
  264. &content_len);
  265. } while (result == -E2BIG);
  266. if (result == 0 && content) {
  267. /* set the overview text for this view */
  268. assert(NULL == shell->overview);
  269. /* store the overview */
  270. shell->overview = lub_string_dup(content);
  271. }
  272. if (content)
  273. free(content);
  274. parent = parent; /* Happy compiler */
  275. }
  276. /* ------------------------------------------------------ */
  277. static void
  278. process_command(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
  279. {
  280. clish_view_t *v = (clish_view_t *) parent;
  281. clish_command_t *cmd = NULL;
  282. clish_command_t *old;
  283. char *alias_name = NULL;
  284. clish_view_t *alias_view = NULL;
  285. int allowed = 1;
  286. char *access = clish_xmlnode_fetch_attr(element, "access");
  287. char *name = clish_xmlnode_fetch_attr(element, "name");
  288. char *help = clish_xmlnode_fetch_attr(element, "help");
  289. char *view = clish_xmlnode_fetch_attr(element, "view");
  290. char *viewid = clish_xmlnode_fetch_attr(element, "viewid");
  291. char *escape_chars = clish_xmlnode_fetch_attr(element, "escape_chars");
  292. char *args_name = clish_xmlnode_fetch_attr(element, "args");
  293. char *args_help = clish_xmlnode_fetch_attr(element, "args_help");
  294. char *lock = clish_xmlnode_fetch_attr(element, "lock");
  295. char *interrupt = clish_xmlnode_fetch_attr(element, "interrupt");
  296. char *ref = clish_xmlnode_fetch_attr(element, "ref");
  297. /* Check permissions */
  298. if (access) {
  299. allowed = 0;
  300. if (shell->client_hooks->access_fn)
  301. allowed = shell->client_hooks->access_fn(shell, access);
  302. }
  303. if (!allowed)
  304. goto process_command_end;
  305. assert(name);
  306. /* check this command doesn't already exist */
  307. old = clish_view_find_command(v, name, BOOL_FALSE);
  308. if (old) {
  309. /* flag the duplication then ignore further definition */
  310. printf("DUPLICATE COMMAND: %s\n",
  311. clish_command__get_name(old));
  312. goto process_command_end;
  313. }
  314. assert(help);
  315. /* Reference 'ref' field */
  316. if (ref) {
  317. char *saveptr;
  318. const char *delim = "@";
  319. char *view_name = NULL;
  320. char *cmdn = NULL;
  321. char *str = lub_string_dup(ref);
  322. cmdn = strtok_r(str, delim, &saveptr);
  323. if (!cmdn) {
  324. printf("EMPTY REFERENCE COMMAND: %s\n", name);
  325. lub_string_free(str);
  326. goto process_command_end;
  327. }
  328. alias_name = lub_string_dup(cmdn);
  329. view_name = strtok_r(NULL, delim, &saveptr);
  330. if (!view_name)
  331. alias_view = v;
  332. else
  333. alias_view = clish_shell_find_create_view(shell,
  334. view_name, NULL);
  335. lub_string_free(str);
  336. }
  337. /* create a command */
  338. cmd = clish_view_new_command(v, name, help);
  339. assert(cmd);
  340. clish_command__set_pview(cmd, v);
  341. /* define some specialist escape characters */
  342. if (escape_chars)
  343. clish_command__set_escape_chars(cmd, escape_chars);
  344. if (args_name) {
  345. /* define a "rest of line" argument */
  346. clish_param_t *param;
  347. clish_ptype_t *tmp = NULL;
  348. assert(args_help);
  349. tmp = clish_shell_find_ptype(shell, "internal_ARGS");
  350. assert(tmp);
  351. param = clish_param_new(args_name, args_help, tmp);
  352. clish_command__set_args(cmd, param);
  353. }
  354. /* Define the view which this command changes to */
  355. if (view)
  356. clish_command__set_view(cmd, view);
  357. /* define the view id which this command changes to */
  358. if (viewid)
  359. clish_command__set_viewid(cmd, viewid);
  360. /* lock field */
  361. if (lock && lub_string_nocasecmp(lock, "false") == 0)
  362. clish_command__set_lock(cmd, BOOL_FALSE);
  363. else
  364. clish_command__set_lock(cmd, BOOL_TRUE);
  365. /* interrupt field */
  366. if (interrupt && lub_string_nocasecmp(interrupt, "true") == 0)
  367. clish_command__set_interrupt(cmd, BOOL_TRUE);
  368. else
  369. clish_command__set_interrupt(cmd, BOOL_FALSE);
  370. /* Set alias */
  371. if (alias_name) {
  372. assert(!((alias_view == v) && (!strcmp(alias_name, name))));
  373. clish_command__set_alias(cmd, alias_name);
  374. assert(alias_view);
  375. clish_command__set_alias_view(cmd, alias_view);
  376. lub_string_free(alias_name);
  377. }
  378. process_children(shell, element, cmd);
  379. process_command_end:
  380. clish_xml_release(access);
  381. clish_xml_release(name);
  382. clish_xml_release(help);
  383. clish_xml_release(view);
  384. clish_xml_release(viewid);
  385. clish_xml_release(escape_chars);
  386. clish_xml_release(args_name);
  387. clish_xml_release(args_help);
  388. clish_xml_release(lock);
  389. clish_xml_release(interrupt);
  390. clish_xml_release(ref);
  391. }
  392. /* ------------------------------------------------------ */
  393. static void
  394. process_startup(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
  395. {
  396. clish_view_t *v = (clish_view_t *) parent;
  397. clish_command_t *cmd = NULL;
  398. char *view = clish_xmlnode_fetch_attr(element, "view");
  399. char *viewid = clish_xmlnode_fetch_attr(element, "viewid");
  400. char *default_shebang =
  401. clish_xmlnode_fetch_attr(element, "default_shebang");
  402. char *timeout = clish_xmlnode_fetch_attr(element, "timeout");
  403. char *lock = clish_xmlnode_fetch_attr(element, "lock");
  404. char *interrupt = clish_xmlnode_fetch_attr(element, "interrupt");
  405. assert(!shell->startup);
  406. assert(view);
  407. /* create a command with NULL help */
  408. cmd = clish_view_new_command(v, "startup", NULL);
  409. clish_command__set_lock(cmd, BOOL_FALSE);
  410. /* define the view which this command changes to */
  411. clish_command__set_view(cmd, view);
  412. /* define the view id which this command changes to */
  413. if (viewid)
  414. clish_command__set_viewid(cmd, viewid);
  415. if (default_shebang)
  416. clish_shell__set_default_shebang(shell, default_shebang);
  417. if (timeout)
  418. clish_shell__set_timeout(shell, atoi(timeout));
  419. /* lock field */
  420. if (lock && lub_string_nocasecmp(lock, "false") == 0)
  421. clish_command__set_lock(cmd, BOOL_FALSE);
  422. else
  423. clish_command__set_lock(cmd, BOOL_TRUE);
  424. /* interrupt field */
  425. if (interrupt && lub_string_nocasecmp(interrupt, "true") == 0)
  426. clish_command__set_interrupt(cmd, BOOL_TRUE);
  427. else
  428. clish_command__set_interrupt(cmd, BOOL_FALSE);
  429. /* remember this command */
  430. shell->startup = cmd;
  431. clish_xml_release(view);
  432. clish_xml_release(viewid);
  433. clish_xml_release(default_shebang);
  434. clish_xml_release(timeout);
  435. clish_xml_release(lock);
  436. clish_xml_release(interrupt);
  437. process_children(shell, element, cmd);
  438. }
  439. /* ------------------------------------------------------ */
  440. static void
  441. process_param(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
  442. {
  443. clish_command_t *cmd = NULL;
  444. clish_param_t *p_param = NULL;
  445. clish_xmlnode_t *pelement;
  446. char *pname;
  447. pelement = clish_xmlnode_parent(element);
  448. pname = clish_xmlnode_get_all_name(pelement);
  449. if (pname && lub_string_nocasecmp(pname, "PARAM") == 0)
  450. p_param = (clish_param_t *)parent;
  451. else
  452. cmd = (clish_command_t *)parent;
  453. if (pname)
  454. free(pname);
  455. if (cmd || p_param) {
  456. char *name = clish_xmlnode_fetch_attr(element, "name");
  457. char *help = clish_xmlnode_fetch_attr(element, "help");
  458. char *ptype = clish_xmlnode_fetch_attr(element, "ptype");
  459. char *prefix = clish_xmlnode_fetch_attr(element, "prefix");
  460. char *defval = clish_xmlnode_fetch_attr(element, "default");
  461. char *mode = clish_xmlnode_fetch_attr(element, "mode");
  462. char *optional = clish_xmlnode_fetch_attr(element, "optional");
  463. char *order = clish_xmlnode_fetch_attr(element, "order");
  464. char *value = clish_xmlnode_fetch_attr(element, "value");
  465. char *hidden = clish_xmlnode_fetch_attr(element, "hidden");
  466. char *test = clish_xmlnode_fetch_attr(element, "test");
  467. char *completion = clish_xmlnode_fetch_attr(element, "completion");
  468. clish_param_t *param;
  469. clish_ptype_t *tmp = NULL;
  470. assert((!cmd) || (cmd != shell->startup));
  471. /* create a command */
  472. assert(name);
  473. assert(help);
  474. assert(ptype);
  475. if (*ptype) {
  476. tmp = clish_shell_find_create_ptype(shell, ptype,
  477. NULL, NULL,
  478. CLISH_PTYPE_REGEXP,
  479. CLISH_PTYPE_NONE);
  480. assert(tmp);
  481. }
  482. param = clish_param_new(name, help, tmp);
  483. /* If prefix is set clish will emulate old optional
  484. * command syntax over newer optional command mechanism.
  485. * It will create nested PARAM.
  486. */
  487. if (prefix) {
  488. const char *ptype_name = "__SUBCOMMAND";
  489. clish_param_t *opt_param = NULL;
  490. char *str = NULL;
  491. /* Create a ptype for prefix-named subcommand that
  492. * will contain the nested optional parameter. The
  493. * name of ptype is hardcoded. It's not good but
  494. * it's only the service ptype.
  495. */
  496. tmp = (clish_ptype_t *)lub_bintree_find(
  497. &shell->ptype_tree, ptype_name);
  498. if (!tmp)
  499. tmp = clish_shell_find_create_ptype(shell,
  500. ptype_name, "Option", "[^\\\\]+",
  501. CLISH_PTYPE_REGEXP, CLISH_PTYPE_NONE);
  502. assert(tmp);
  503. lub_string_cat(&str, "_prefix_");
  504. lub_string_cat(&str, name);
  505. opt_param = clish_param_new(str, help, tmp);
  506. lub_string_free(str);
  507. clish_param__set_mode(opt_param,
  508. CLISH_PARAM_SUBCOMMAND);
  509. clish_param__set_value(opt_param, prefix);
  510. clish_param__set_optional(opt_param, BOOL_TRUE);
  511. if (test)
  512. clish_param__set_test(opt_param, test);
  513. /* add the parameter to the command */
  514. if (cmd)
  515. clish_command_insert_param(cmd, opt_param);
  516. /* add the parameter to the param */
  517. if (p_param)
  518. clish_param_insert_param(p_param, opt_param);
  519. /* Unset cmd and set parent param to opt_param */
  520. cmd = NULL;
  521. p_param = opt_param;
  522. }
  523. if (defval)
  524. clish_param__set_default(param, defval);
  525. if (hidden && lub_string_nocasecmp(hidden, "true") == 0)
  526. clish_param__set_hidden(param, BOOL_TRUE);
  527. else
  528. clish_param__set_hidden(param, BOOL_FALSE);
  529. if (mode) {
  530. if (lub_string_nocasecmp(mode, "switch") == 0) {
  531. clish_param__set_mode(param,
  532. CLISH_PARAM_SWITCH);
  533. /* Force hidden attribute */
  534. clish_param__set_hidden(param, BOOL_TRUE);
  535. } else if (lub_string_nocasecmp(mode, "subcommand") == 0)
  536. clish_param__set_mode(param,
  537. CLISH_PARAM_SUBCOMMAND);
  538. else
  539. clish_param__set_mode(param,
  540. CLISH_PARAM_COMMON);
  541. }
  542. if (optional && lub_string_nocasecmp(optional, "true") == 0)
  543. clish_param__set_optional(param, BOOL_TRUE);
  544. else
  545. clish_param__set_optional(param, BOOL_FALSE);
  546. if (order && lub_string_nocasecmp(order, "true") == 0)
  547. clish_param__set_order(param, BOOL_TRUE);
  548. else
  549. clish_param__set_order(param, BOOL_FALSE);
  550. if (value) {
  551. clish_param__set_value(param, value);
  552. /* Force mode to subcommand */
  553. clish_param__set_mode(param,
  554. CLISH_PARAM_SUBCOMMAND);
  555. }
  556. if (test && !prefix)
  557. clish_param__set_test(param, test);
  558. if (completion)
  559. clish_param__set_completion(param, completion);
  560. /* add the parameter to the command */
  561. if (cmd)
  562. clish_command_insert_param(cmd, param);
  563. /* add the parameter to the param */
  564. if (p_param)
  565. clish_param_insert_param(p_param, param);
  566. clish_xml_release(name);
  567. clish_xml_release(help);
  568. clish_xml_release(ptype);
  569. clish_xml_release(prefix);
  570. clish_xml_release(defval);
  571. clish_xml_release(mode);
  572. clish_xml_release(optional);
  573. clish_xml_release(order);
  574. clish_xml_release(value);
  575. clish_xml_release(hidden);
  576. clish_xml_release(test);
  577. clish_xml_release(completion);
  578. process_children(shell, element, param);
  579. }
  580. }
  581. /* ------------------------------------------------------ */
  582. static void process_action(clish_shell_t *shell, clish_xmlnode_t *element,
  583. void *parent)
  584. {
  585. clish_action_t *action = NULL;
  586. char *builtin = clish_xmlnode_fetch_attr(element, "builtin");
  587. char *shebang = clish_xmlnode_fetch_attr(element, "shebang");
  588. clish_xmlnode_t *pelement = clish_xmlnode_parent(element);
  589. char *pname = clish_xmlnode_get_all_name(pelement);
  590. char *text;
  591. if (pname && lub_string_nocasecmp(pname, "VAR") == 0)
  592. action = clish_var__get_action((clish_var_t *)parent);
  593. else
  594. action = clish_command__get_action((clish_command_t *)parent);
  595. assert(action);
  596. if (pname)
  597. free(pname);
  598. text = clish_xmlnode_get_all_content(element);
  599. if (text && *text) {
  600. /* store the action */
  601. clish_action__set_script(action, text);
  602. }
  603. if (text)
  604. free(text);
  605. if (builtin)
  606. clish_action__set_builtin(action, builtin);
  607. if (shebang)
  608. clish_action__set_shebang(action, shebang);
  609. clish_xml_release(builtin);
  610. clish_xml_release(shebang);
  611. shell = shell; /* Happy compiler */
  612. }
  613. /* ------------------------------------------------------ */
  614. static void process_detail(clish_shell_t *shell, clish_xmlnode_t *element,
  615. void *parent)
  616. {
  617. clish_command_t *cmd = (clish_command_t *) parent;
  618. /* read the following text element */
  619. char *text = clish_xmlnode_get_all_content(element);
  620. if (text && *text) {
  621. /* store the action */
  622. clish_command__set_detail(cmd, text);
  623. }
  624. if (text)
  625. free(text);
  626. shell = shell; /* Happy compiler */
  627. }
  628. /* ------------------------------------------------------ */
  629. static void
  630. process_namespace(clish_shell_t * shell, clish_xmlnode_t * element, void *parent)
  631. {
  632. clish_view_t *v = (clish_view_t *) parent;
  633. clish_nspace_t *nspace = NULL;
  634. char *view = clish_xmlnode_fetch_attr(element, "ref");
  635. char *prefix = clish_xmlnode_fetch_attr(element, "prefix");
  636. char *prefix_help = clish_xmlnode_fetch_attr(element, "prefix_help");
  637. char *help = clish_xmlnode_fetch_attr(element, "help");
  638. char *completion = clish_xmlnode_fetch_attr(element, "completion");
  639. char *context_help = clish_xmlnode_fetch_attr(element, "context_help");
  640. char *inherit = clish_xmlnode_fetch_attr(element, "inherit");
  641. char *access = clish_xmlnode_fetch_attr(element, "access");
  642. int allowed = 1;
  643. if (access) {
  644. allowed = 0;
  645. if (shell->client_hooks->access_fn)
  646. allowed = shell->client_hooks->access_fn(shell, access);
  647. }
  648. if (!allowed)
  649. goto process_namespace_end;
  650. assert(view);
  651. clish_view_t *ref_view = clish_shell_find_create_view(shell,
  652. view, NULL);
  653. assert(ref_view);
  654. /* Don't include itself without prefix */
  655. if ((ref_view == v) && !prefix)
  656. goto process_namespace_end;
  657. nspace = clish_nspace_new(ref_view);
  658. assert(nspace);
  659. clish_view_insert_nspace(v, nspace);
  660. if (prefix) {
  661. clish_nspace__set_prefix(nspace, prefix);
  662. if (prefix_help)
  663. clish_nspace_create_prefix_cmd(nspace,
  664. "prefix",
  665. prefix_help);
  666. else
  667. clish_nspace_create_prefix_cmd(nspace,
  668. "prefix",
  669. "Prefix for the imported commands.");
  670. }
  671. if (help && lub_string_nocasecmp(help, "true") == 0)
  672. clish_nspace__set_help(nspace, BOOL_TRUE);
  673. else
  674. clish_nspace__set_help(nspace, BOOL_FALSE);
  675. if (completion && lub_string_nocasecmp(completion, "false") == 0)
  676. clish_nspace__set_completion(nspace, BOOL_FALSE);
  677. else
  678. clish_nspace__set_completion(nspace, BOOL_TRUE);
  679. if (context_help && lub_string_nocasecmp(context_help, "true") == 0)
  680. clish_nspace__set_context_help(nspace, BOOL_TRUE);
  681. else
  682. clish_nspace__set_context_help(nspace, BOOL_FALSE);
  683. if (inherit && lub_string_nocasecmp(inherit, "false") == 0)
  684. clish_nspace__set_inherit(nspace, BOOL_FALSE);
  685. else
  686. clish_nspace__set_inherit(nspace, BOOL_TRUE);
  687. process_namespace_end:
  688. clish_xml_release(view);
  689. clish_xml_release(prefix);
  690. clish_xml_release(prefix_help);
  691. clish_xml_release(help);
  692. clish_xml_release(completion);
  693. clish_xml_release(context_help);
  694. clish_xml_release(inherit);
  695. clish_xml_release(access);
  696. }
  697. /* ------------------------------------------------------ */
  698. static void process_config(clish_shell_t *shell, clish_xmlnode_t *element,
  699. void *parent)
  700. {
  701. clish_command_t *cmd = (clish_command_t *)parent;
  702. clish_config_t *config;
  703. if (!cmd)
  704. return;
  705. config = clish_command__get_config(cmd);
  706. /* read the following text element */
  707. char *operation = clish_xmlnode_fetch_attr(element, "operation");
  708. char *priority = clish_xmlnode_fetch_attr(element, "priority");
  709. char *pattern = clish_xmlnode_fetch_attr(element, "pattern");
  710. char *file = clish_xmlnode_fetch_attr(element, "file");
  711. char *splitter = clish_xmlnode_fetch_attr(element, "splitter");
  712. char *seq = clish_xmlnode_fetch_attr(element, "sequence");
  713. char *unique = clish_xmlnode_fetch_attr(element, "unique");
  714. char *depth = clish_xmlnode_fetch_attr(element, "depth");
  715. if (operation && !lub_string_nocasecmp(operation, "unset"))
  716. clish_config__set_op(config, CLISH_CONFIG_UNSET);
  717. else if (operation && !lub_string_nocasecmp(operation, "none"))
  718. clish_config__set_op(config, CLISH_CONFIG_NONE);
  719. else if (operation && !lub_string_nocasecmp(operation, "dump"))
  720. clish_config__set_op(config, CLISH_CONFIG_DUMP);
  721. else {
  722. clish_config__set_op(config, CLISH_CONFIG_SET);
  723. /* The priority if no clearly specified */
  724. clish_config__set_priority(config, 0x7f00);
  725. }
  726. if (priority) {
  727. long val = 0;
  728. char *endptr;
  729. unsigned short pri;
  730. val = strtol(priority, &endptr, 0);
  731. if (endptr == priority)
  732. pri = 0;
  733. else if (val > 0xffff)
  734. pri = 0xffff;
  735. else if (val < 0)
  736. pri = 0;
  737. else
  738. pri = (unsigned short)val;
  739. clish_config__set_priority(config, pri);
  740. }
  741. if (pattern)
  742. clish_config__set_pattern(config, pattern);
  743. else
  744. clish_config__set_pattern(config, "^${__cmd}");
  745. if (file)
  746. clish_config__set_file(config, file);
  747. if (splitter && lub_string_nocasecmp(splitter, "false") == 0)
  748. clish_config__set_splitter(config, BOOL_FALSE);
  749. else
  750. clish_config__set_splitter(config, BOOL_TRUE);
  751. if (unique && lub_string_nocasecmp(unique, "false") == 0)
  752. clish_config__set_unique(config, BOOL_FALSE);
  753. else
  754. clish_config__set_unique(config, BOOL_TRUE);
  755. if (seq)
  756. clish_config__set_seq(config, seq);
  757. else
  758. /* The entries without sequence cannot be non-unique */
  759. clish_config__set_unique(config, BOOL_TRUE);
  760. if (depth)
  761. clish_config__set_depth(config, depth);
  762. clish_xml_release(operation);
  763. clish_xml_release(priority);
  764. clish_xml_release(pattern);
  765. clish_xml_release(file);
  766. clish_xml_release(splitter);
  767. clish_xml_release(seq);
  768. clish_xml_release(unique);
  769. clish_xml_release(depth);
  770. shell = shell; /* Happy compiler */
  771. }
  772. /* ------------------------------------------------------ */
  773. static void process_var(clish_shell_t *shell, clish_xmlnode_t *element,
  774. void *parent)
  775. {
  776. clish_var_t *var = NULL;
  777. char *name = clish_xmlnode_fetch_attr(element, "name");
  778. char *dynamic = clish_xmlnode_fetch_attr(element, "dynamic");
  779. char *value = clish_xmlnode_fetch_attr(element, "value");
  780. assert(name);
  781. /* Check if this var doesn't already exist */
  782. var = (clish_var_t *)lub_bintree_find(&shell->var_tree, name);
  783. if (var) {
  784. printf("DUPLICATE VAR: %s\n", name);
  785. assert(!var);
  786. }
  787. /* Create var instance */
  788. var = clish_var_new(name);
  789. lub_bintree_insert(&shell->var_tree, var);
  790. if (dynamic && lub_string_nocasecmp(dynamic, "true") == 0)
  791. clish_var__set_dynamic(var, BOOL_TRUE);
  792. if (value)
  793. clish_var__set_value(var, value);
  794. clish_xml_release(name);
  795. clish_xml_release(dynamic);
  796. clish_xml_release(value);
  797. process_children(shell, element, var);
  798. parent = parent; /* Happy compiler */
  799. }
  800. /* ------------------------------------------------------ */
  801. static void process_wdog(clish_shell_t *shell,
  802. clish_xmlnode_t *element, void *parent)
  803. {
  804. clish_view_t *v = (clish_view_t *)parent;
  805. clish_command_t *cmd = NULL;
  806. assert(!shell->wdog);
  807. /* create a command with NULL help */
  808. cmd = clish_view_new_command(v, "watchdog", NULL);
  809. clish_command__set_lock(cmd, BOOL_FALSE);
  810. /* Remember this command */
  811. shell->wdog = cmd;
  812. process_children(shell, element, cmd);
  813. }
  814. /* ------------------------------------------------------ */
  815. static void
  816. process_hotkey(clish_shell_t *shell, clish_xmlnode_t* element, void *parent)
  817. {
  818. clish_view_t *v = (clish_view_t *)parent;
  819. char *key = clish_xmlnode_fetch_attr(element, "key");
  820. char *cmd = clish_xmlnode_fetch_attr(element, "cmd");
  821. assert(key);
  822. assert(cmd);
  823. assert (!clish_view_insert_hotkey(v, key, cmd));
  824. clish_xml_release(key);
  825. clish_xml_release(cmd);
  826. shell = shell; /* Happy compiler */
  827. }
  828. /* ------------------------------------------------------ */
  829. int clish_shell_xml_read(clish_shell_t * shell, const char *filename)
  830. {
  831. int ret = -1;
  832. clish_xmldoc_t *doc;
  833. doc = clish_xmldoc_read(filename);
  834. if (clish_xmldoc_is_valid(doc)) {
  835. clish_xmlnode_t *root = clish_xmldoc_get_root(doc);
  836. process_node(shell, root, NULL);
  837. ret = 0;
  838. } else {
  839. int errcaps = clish_xmldoc_error_caps(doc);
  840. printf("Unable to open file '%s'", filename);
  841. if ((errcaps & CLISH_XMLERR_LINE) == CLISH_XMLERR_LINE)
  842. printf(", at line %d", clish_xmldoc_get_err_line(doc));
  843. if ((errcaps & CLISH_XMLERR_COL) == CLISH_XMLERR_COL)
  844. printf(", at column %d", clish_xmldoc_get_err_col(doc));
  845. if ((errcaps & CLISH_XMLERR_DESC) == CLISH_XMLERR_DESC)
  846. printf(", message is %s", clish_xmldoc_get_err_msg(doc));
  847. printf("\n");
  848. }
  849. clish_xmldoc_release(doc);
  850. return ret;
  851. }
  852. /* ------------------------------------------------------ */