1
0

shell_xml.c 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267
  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 "lub/conv.h"
  15. #include <stdlib.h>
  16. #include <string.h>
  17. #include <assert.h>
  18. #include <errno.h>
  19. #include <sys/types.h>
  20. #include <dirent.h>
  21. typedef int (PROCESS_FN) (clish_shell_t *instance,
  22. clish_xmlnode_t *element, void *parent);
  23. /* Define a control block for handling the decode of an XML file */
  24. typedef struct clish_xml_cb_s clish_xml_cb_t;
  25. struct clish_xml_cb_s {
  26. const char *element;
  27. PROCESS_FN *handler;
  28. };
  29. /* forward declare the handler functions */
  30. static PROCESS_FN
  31. process_clish_module,
  32. process_startup,
  33. process_view,
  34. process_command,
  35. process_param,
  36. process_action,
  37. process_ptype,
  38. process_overview,
  39. process_detail,
  40. process_namespace,
  41. process_config,
  42. process_var,
  43. process_wdog,
  44. process_hotkey,
  45. process_plugin,
  46. process_hook;
  47. static clish_xml_cb_t xml_elements[] = {
  48. {"CLISH_MODULE", process_clish_module},
  49. {"STARTUP", process_startup},
  50. {"VIEW", process_view},
  51. {"COMMAND", process_command},
  52. {"PARAM", process_param},
  53. {"ACTION", process_action},
  54. {"PTYPE", process_ptype},
  55. {"OVERVIEW", process_overview},
  56. {"DETAIL", process_detail},
  57. {"NAMESPACE", process_namespace},
  58. {"CONFIG", process_config},
  59. {"VAR", process_var},
  60. {"WATCHDOG", process_wdog},
  61. {"HOTKEY", process_hotkey},
  62. {"PLUGIN", process_plugin},
  63. {"HOOK", process_hook},
  64. {NULL, NULL}
  65. };
  66. /*
  67. * if CLISH_PATH is unset in the environment then this is the value used.
  68. */
  69. const char *default_path = "/etc/clish;~/.clish";
  70. static int process_node(clish_shell_t *shell, clish_xmlnode_t *node,
  71. void *parent);
  72. /*-------------------------------------------------------- */
  73. int clish_shell_load_scheme(clish_shell_t *this, const char *xml_path, const char *xslt_path)
  74. {
  75. const char *path = xml_path;
  76. char *buffer;
  77. char *dirname;
  78. char *saveptr = NULL;
  79. int res = -1;
  80. clish_xmldoc_t *doc = NULL;
  81. DIR *dir;
  82. #ifdef HAVE_LIB_LIBXSLT
  83. clish_xslt_t *xslt = NULL;
  84. /* Load global XSLT stylesheet */
  85. if (xslt_path) {
  86. xslt = clish_xslt_read(xslt_path);
  87. if (!clish_xslt_is_valid(xslt)) {
  88. fprintf(stderr, CLISH_XML_ERROR_STR"Can't load XSLT file %s\n",
  89. xslt_path);
  90. return -1;
  91. }
  92. }
  93. #else
  94. xslt_path = xslt_path; /* Happy compiler */
  95. #endif
  96. /* Use the default path */
  97. if (!path)
  98. path = default_path;
  99. buffer = lub_system_tilde_expand(path);
  100. /* Loop though each directory */
  101. for (dirname = strtok_r(buffer, ";", &saveptr);
  102. dirname; dirname = strtok_r(NULL, ";", &saveptr)) {
  103. struct dirent *entry;
  104. /* Search this directory for any XML files */
  105. dir = opendir(dirname);
  106. if (NULL == dir) {
  107. #ifdef DEBUG
  108. tinyrl_printf(this->tinyrl,
  109. "*** Failed to open '%s' directory\n",
  110. dirname);
  111. #endif
  112. continue;
  113. }
  114. for (entry = readdir(dir); entry; entry = readdir(dir)) {
  115. const char *extension = strrchr(entry->d_name, '.');
  116. char *filename = NULL;
  117. clish_xmlnode_t *root;
  118. int r;
  119. /* Check the filename */
  120. if (!extension || strcmp(".xml", extension))
  121. continue;
  122. /* Build the filename */
  123. lub_string_cat(&filename, dirname);
  124. lub_string_cat(&filename, "/");
  125. lub_string_cat(&filename, entry->d_name);
  126. #ifdef DEBUG
  127. fprintf(stderr, "Parse XML-file: %s\n", filename);
  128. #endif
  129. /* Load current XML file */
  130. doc = clish_xmldoc_read(filename);
  131. if (!clish_xmldoc_is_valid(doc)) {
  132. int errcaps = clish_xmldoc_error_caps(doc);
  133. printf("Unable to open file '%s'", filename);
  134. if ((errcaps & CLISH_XMLERR_LINE) == CLISH_XMLERR_LINE)
  135. printf(", at line %d", clish_xmldoc_get_err_line(doc));
  136. if ((errcaps & CLISH_XMLERR_COL) == CLISH_XMLERR_COL)
  137. printf(", at column %d", clish_xmldoc_get_err_col(doc));
  138. if ((errcaps & CLISH_XMLERR_DESC) == CLISH_XMLERR_DESC)
  139. printf(", message is %s", clish_xmldoc_get_err_msg(doc));
  140. printf("\n");
  141. goto error;
  142. }
  143. #ifdef HAVE_LIB_LIBXSLT
  144. /* Use embedded stylesheet if stylesheet
  145. * filename is not specified.
  146. */
  147. if (!xslt_path)
  148. xslt = clish_xslt_read_embedded(doc);
  149. if (clish_xslt_is_valid(xslt)) {
  150. clish_xmldoc_t *tmp = NULL;
  151. tmp = clish_xslt_apply(doc, xslt);
  152. if (!clish_xmldoc_is_valid(tmp)) {
  153. fprintf(stderr, CLISH_XML_ERROR_STR"Can't load XSLT file %s\n", xslt_path);
  154. goto error;
  155. }
  156. clish_xmldoc_release(doc);
  157. doc = tmp;
  158. }
  159. if (!xslt_path && clish_xslt_is_valid(xslt))
  160. clish_xslt_release(xslt);
  161. #endif
  162. root = clish_xmldoc_get_root(doc);
  163. r = process_node(this, root, NULL);
  164. clish_xmldoc_release(doc);
  165. /* Error message */
  166. if (r) {
  167. fprintf(stderr, CLISH_XML_ERROR_STR"File %s\n",
  168. filename);
  169. lub_string_free(filename);
  170. goto error;
  171. }
  172. lub_string_free(filename);
  173. }
  174. closedir(dir);
  175. }
  176. /* To don't free memory twice on cleanup */
  177. #ifdef HAVE_LIB_LIBXSLT
  178. if (!xslt_path)
  179. xslt = NULL;
  180. #endif
  181. doc = NULL;
  182. dir = NULL;
  183. res = 0; /* Success */
  184. error:
  185. lub_string_free(buffer);
  186. if (dir)
  187. closedir(dir);
  188. if (clish_xmldoc_is_valid(doc))
  189. clish_xmldoc_release(doc);
  190. #ifdef HAVE_LIB_LIBXSLT
  191. if (clish_xslt_is_valid(xslt))
  192. clish_xslt_release(xslt);
  193. #endif
  194. return res;
  195. }
  196. /*
  197. * ------------------------------------------------------
  198. * This function reads an element from the XML stream and processes it.
  199. * ------------------------------------------------------
  200. */
  201. static int process_node(clish_shell_t *shell, clish_xmlnode_t *node,
  202. void *parent)
  203. {
  204. int res = 0;
  205. switch (clish_xmlnode_get_type(node)) {
  206. case CLISH_XMLNODE_ELM: {
  207. clish_xml_cb_t * cb;
  208. char name[128];
  209. unsigned int namelen = sizeof(name);
  210. if (clish_xmlnode_get_name(node, name, &namelen) == 0) {
  211. for (cb = &xml_elements[0]; cb->element; cb++) {
  212. if (0 == strcmp(name, cb->element)) {
  213. #ifdef DEBUG
  214. fprintf(stderr, "NODE:");
  215. clish_xmlnode_print(node, stderr);
  216. fprintf(stderr, "\n");
  217. #endif
  218. /* process the elements at this level */
  219. res = cb->handler(shell, node, parent);
  220. /* Error message */
  221. if (res) {
  222. char *ename = clish_xmlnode_fetch_attr(node, "name");
  223. char *eref = clish_xmlnode_fetch_attr(node, "ref");
  224. char *ekey = clish_xmlnode_fetch_attr(node, "key");
  225. char *efile = clish_xmlnode_fetch_attr(node, "file");
  226. fprintf(stderr, CLISH_XML_ERROR_STR"Node %s", name);
  227. if (ename)
  228. fprintf(stderr, ", name=\"%s\"", ename);
  229. if (eref)
  230. fprintf(stderr, ", ref=\"%s\"", eref);
  231. if (ekey)
  232. fprintf(stderr, ", key=\"%s\"", ekey);
  233. if (efile)
  234. fprintf(stderr, ", file=\"%s\"", efile);
  235. fprintf(stderr, "\n");
  236. clish_xml_release(ename);
  237. clish_xml_release(eref);
  238. clish_xml_release(ekey);
  239. clish_xml_release(efile);
  240. }
  241. break;
  242. }
  243. }
  244. }
  245. break;
  246. }
  247. case CLISH_XMLNODE_DOC:
  248. case CLISH_XMLNODE_TEXT:
  249. case CLISH_XMLNODE_ATTR:
  250. case CLISH_XMLNODE_PI:
  251. case CLISH_XMLNODE_COMMENT:
  252. case CLISH_XMLNODE_DECL:
  253. case CLISH_XMLNODE_UNKNOWN:
  254. default:
  255. break;
  256. }
  257. return res;
  258. }
  259. /* ------------------------------------------------------ */
  260. static int process_children(clish_shell_t *shell,
  261. clish_xmlnode_t *element, void *parent)
  262. {
  263. clish_xmlnode_t *node = NULL;
  264. int res;
  265. while ((node = clish_xmlnode_next_child(element, node)) != NULL) {
  266. /* Now deal with all the contained elements */
  267. res = process_node(shell, node, parent);
  268. if (res)
  269. return res;
  270. }
  271. return 0;
  272. }
  273. /* ------------------------------------------------------ */
  274. static int process_clish_module(clish_shell_t *shell, clish_xmlnode_t *element,
  275. void *parent)
  276. {
  277. /* Create the global view */
  278. if (!shell->global)
  279. shell->global = clish_shell_find_create_view(shell,
  280. "__view_global", "");
  281. parent = parent; /* Happy compiler */
  282. return process_children(shell, element, shell->global);
  283. }
  284. /* ------------------------------------------------------ */
  285. static int process_view(clish_shell_t *shell, clish_xmlnode_t *element,
  286. void *parent)
  287. {
  288. clish_view_t *view;
  289. int res = -1;
  290. char *name = clish_xmlnode_fetch_attr(element, "name");
  291. char *prompt = clish_xmlnode_fetch_attr(element, "prompt");
  292. char *depth = clish_xmlnode_fetch_attr(element, "depth");
  293. char *restore = clish_xmlnode_fetch_attr(element, "restore");
  294. char *access = clish_xmlnode_fetch_attr(element, "access");
  295. /* Check syntax */
  296. if (!name) {
  297. fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
  298. goto error;
  299. }
  300. /* re-use a view if it already exists */
  301. view = clish_shell_find_create_view(shell, name, prompt);
  302. if (depth && (lub_ctype_isdigit(*depth))) {
  303. unsigned int res = 0;
  304. lub_conv_atoui(depth, &res, 0);
  305. clish_view__set_depth(view, res);
  306. }
  307. if (restore) {
  308. if (!lub_string_nocasecmp(restore, "depth"))
  309. clish_view__set_restore(view, CLISH_RESTORE_DEPTH);
  310. else if (!lub_string_nocasecmp(restore, "view"))
  311. clish_view__set_restore(view, CLISH_RESTORE_VIEW);
  312. else
  313. clish_view__set_restore(view, CLISH_RESTORE_NONE);
  314. }
  315. if (access)
  316. clish_view__set_access(view, access);
  317. //process_view_end:
  318. res = process_children(shell, element, view);
  319. error:
  320. clish_xml_release(name);
  321. clish_xml_release(prompt);
  322. clish_xml_release(depth);
  323. clish_xml_release(restore);
  324. clish_xml_release(access);
  325. parent = parent; /* Happy compiler */
  326. return res;
  327. }
  328. /* ------------------------------------------------------ */
  329. static int process_ptype(clish_shell_t *shell, clish_xmlnode_t *element,
  330. void *parent)
  331. {
  332. clish_ptype_method_e method;
  333. clish_ptype_preprocess_e preprocess;
  334. int res = -1;
  335. char *name = clish_xmlnode_fetch_attr(element, "name");
  336. char *help = clish_xmlnode_fetch_attr(element, "help");
  337. char *pattern = clish_xmlnode_fetch_attr(element, "pattern");
  338. char *method_name = clish_xmlnode_fetch_attr(element, "method");
  339. char *preprocess_name = clish_xmlnode_fetch_attr(element, "preprocess");
  340. /* Check syntax */
  341. if (!name) {
  342. fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
  343. goto error;
  344. }
  345. if (!pattern) {
  346. fprintf(stderr, CLISH_XML_ERROR_ATTR("pattern"));
  347. goto error;
  348. }
  349. method = clish_ptype_method_resolve(method_name);
  350. preprocess = clish_ptype_preprocess_resolve(preprocess_name);
  351. clish_shell_find_create_ptype(shell,
  352. name, help, pattern, method, preprocess);
  353. res = 0;
  354. error:
  355. clish_xml_release(name);
  356. clish_xml_release(help);
  357. clish_xml_release(pattern);
  358. clish_xml_release(method_name);
  359. clish_xml_release(preprocess_name);
  360. parent = parent; /* Happy compiler */
  361. return res;
  362. }
  363. /* ------------------------------------------------------ */
  364. static int process_overview(clish_shell_t *shell, clish_xmlnode_t *element,
  365. void *parent)
  366. {
  367. char *content = NULL;
  368. unsigned int content_len = 2048;
  369. int result;
  370. /*
  371. * the code below faithfully assume that we'll be able fully store
  372. * the content of the node. If it's really, really big, we may have
  373. * an issue (but then, if it's that big, how the hell does it
  374. * already fits in allocated memory?)
  375. * Ergo, it -should- be safe.
  376. */
  377. do {
  378. char *new = (char*)realloc(content, content_len);
  379. if (!new) {
  380. if (content)
  381. free(content);
  382. return -1;
  383. }
  384. content = new;
  385. result = clish_xmlnode_get_content(element, content,
  386. &content_len);
  387. } while (result == -E2BIG);
  388. if (result == 0 && content) {
  389. /* set the overview text for this view */
  390. assert(NULL == shell->overview);
  391. /* store the overview */
  392. shell->overview = lub_string_dup(content);
  393. }
  394. if (content)
  395. free(content);
  396. parent = parent; /* Happy compiler */
  397. return 0;
  398. }
  399. /* ------------------------------------------------------ */
  400. static int process_command(clish_shell_t *shell, clish_xmlnode_t *element,
  401. void *parent)
  402. {
  403. clish_view_t *v = (clish_view_t *) parent;
  404. clish_command_t *cmd = NULL;
  405. clish_command_t *old;
  406. int res = -1;
  407. char *access = clish_xmlnode_fetch_attr(element, "access");
  408. char *name = clish_xmlnode_fetch_attr(element, "name");
  409. char *help = clish_xmlnode_fetch_attr(element, "help");
  410. char *view = clish_xmlnode_fetch_attr(element, "view");
  411. char *viewid = clish_xmlnode_fetch_attr(element, "viewid");
  412. char *escape_chars = clish_xmlnode_fetch_attr(element, "escape_chars");
  413. char *args_name = clish_xmlnode_fetch_attr(element, "args");
  414. char *args_help = clish_xmlnode_fetch_attr(element, "args_help");
  415. char *lock = clish_xmlnode_fetch_attr(element, "lock");
  416. char *interrupt = clish_xmlnode_fetch_attr(element, "interrupt");
  417. char *ref = clish_xmlnode_fetch_attr(element, "ref");
  418. /* Check syntax */
  419. if (!name) {
  420. fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
  421. goto error;
  422. }
  423. if (!help) {
  424. fprintf(stderr, CLISH_XML_ERROR_ATTR("help"));
  425. goto error;
  426. }
  427. /* check this command doesn't already exist */
  428. old = clish_view_find_command(v, name, BOOL_FALSE);
  429. if (old) {
  430. fprintf(stderr, CLISH_XML_ERROR_STR"Duplicate COMMAND name=\"%s\".\n", name);
  431. goto error;
  432. }
  433. /* create a command */
  434. cmd = clish_view_new_command(v, name, help);
  435. clish_command__set_pview(cmd, v);
  436. /* Reference 'ref' field */
  437. if (ref) {
  438. char *saveptr = NULL;
  439. const char *delim = "@";
  440. char *view_name = NULL;
  441. char *cmdn = NULL;
  442. char *str = lub_string_dup(ref);
  443. cmdn = strtok_r(str, delim, &saveptr);
  444. if (!cmdn) {
  445. fprintf(stderr, CLISH_XML_ERROR_STR"Invalid \"ref\" attribute value.\n");
  446. lub_string_free(str);
  447. goto error;
  448. }
  449. clish_command__set_alias(cmd, cmdn); /* alias name */
  450. view_name = strtok_r(NULL, delim, &saveptr);
  451. clish_command__set_alias_view(cmd, view_name);
  452. lub_string_free(str);
  453. }
  454. /* define some specialist escape characters */
  455. if (escape_chars)
  456. clish_command__set_escape_chars(cmd, escape_chars);
  457. if (args_name) {
  458. /* define a "rest of line" argument */
  459. clish_param_t *param;
  460. /* Check syntax */
  461. if (!args_help) {
  462. fprintf(stderr, CLISH_XML_ERROR_ATTR("args_help"));
  463. goto error;
  464. }
  465. param = clish_param_new(args_name, args_help, "__ptype_ARGS");
  466. clish_command__set_args(cmd, param);
  467. }
  468. /* define the view which this command changes to */
  469. if (view) {
  470. /* reference the next view */
  471. clish_command__set_viewname(cmd, view);
  472. }
  473. /* define the view id which this command changes to */
  474. if (viewid)
  475. clish_command__set_viewid(cmd, viewid);
  476. /* lock field */
  477. if (lock && lub_string_nocasecmp(lock, "false") == 0)
  478. clish_command__set_lock(cmd, BOOL_FALSE);
  479. else
  480. clish_command__set_lock(cmd, BOOL_TRUE);
  481. /* interrupt field */
  482. if (interrupt && lub_string_nocasecmp(interrupt, "true") == 0)
  483. clish_command__set_interrupt(cmd, BOOL_TRUE);
  484. else
  485. clish_command__set_interrupt(cmd, BOOL_FALSE);
  486. if (access)
  487. clish_command__set_access(cmd, access);
  488. //process_command_end:
  489. res = process_children(shell, element, cmd);
  490. error:
  491. clish_xml_release(access);
  492. clish_xml_release(name);
  493. clish_xml_release(help);
  494. clish_xml_release(view);
  495. clish_xml_release(viewid);
  496. clish_xml_release(escape_chars);
  497. clish_xml_release(args_name);
  498. clish_xml_release(args_help);
  499. clish_xml_release(lock);
  500. clish_xml_release(interrupt);
  501. clish_xml_release(ref);
  502. return res;
  503. }
  504. /* ------------------------------------------------------ */
  505. static int process_startup(clish_shell_t *shell, clish_xmlnode_t *element,
  506. void *parent)
  507. {
  508. clish_view_t *v = (clish_view_t *) parent;
  509. clish_command_t *cmd = NULL;
  510. int res = -1;
  511. char *view = clish_xmlnode_fetch_attr(element, "view");
  512. char *viewid = clish_xmlnode_fetch_attr(element, "viewid");
  513. char *default_shebang =
  514. clish_xmlnode_fetch_attr(element, "default_shebang");
  515. char *timeout = clish_xmlnode_fetch_attr(element, "timeout");
  516. char *lock = clish_xmlnode_fetch_attr(element, "lock");
  517. char *interrupt = clish_xmlnode_fetch_attr(element, "interrupt");
  518. char *default_plugin = clish_xmlnode_fetch_attr(element,
  519. "default_plugin");
  520. /* Check syntax */
  521. if (!view) {
  522. fprintf(stderr, CLISH_XML_ERROR_ATTR("view"));
  523. goto error;
  524. }
  525. if (shell->startup) {
  526. fprintf(stderr, CLISH_XML_ERROR_STR"STARTUP tag duplication.\n");
  527. goto error;
  528. }
  529. /* create a command with NULL help */
  530. cmd = clish_view_new_command(v, "startup", NULL);
  531. clish_command__set_lock(cmd, BOOL_FALSE);
  532. clish_command__set_internal(cmd, BOOL_TRUE);
  533. /* reference the next view */
  534. clish_command__set_viewname(cmd, view);
  535. /* define the view id which this command changes to */
  536. if (viewid)
  537. clish_command__set_viewid(cmd, viewid);
  538. if (default_shebang)
  539. clish_shell__set_default_shebang(shell, default_shebang);
  540. if (timeout) {
  541. unsigned int to = 0;
  542. lub_conv_atoui(timeout, &to, 0);
  543. clish_shell__set_idle_timeout(shell, to);
  544. }
  545. /* lock field */
  546. if (lock && lub_string_nocasecmp(lock, "false") == 0)
  547. clish_command__set_lock(cmd, BOOL_FALSE);
  548. else
  549. clish_command__set_lock(cmd, BOOL_TRUE);
  550. /* interrupt field */
  551. if (interrupt && lub_string_nocasecmp(interrupt, "true") == 0)
  552. clish_command__set_interrupt(cmd, BOOL_TRUE);
  553. else
  554. clish_command__set_interrupt(cmd, BOOL_FALSE);
  555. /* If we need the default plugin */
  556. if (default_plugin && (0 == strcmp(default_plugin, "false")))
  557. shell->default_plugin = BOOL_FALSE;
  558. /* remember this command */
  559. shell->startup = cmd;
  560. res = process_children(shell, element, cmd);
  561. error:
  562. clish_xml_release(view);
  563. clish_xml_release(viewid);
  564. clish_xml_release(default_shebang);
  565. clish_xml_release(timeout);
  566. clish_xml_release(lock);
  567. clish_xml_release(interrupt);
  568. return res;
  569. }
  570. /* ------------------------------------------------------ */
  571. static int process_param(clish_shell_t *shell, clish_xmlnode_t *element,
  572. void *parent)
  573. {
  574. clish_command_t *cmd = NULL;
  575. clish_param_t *p_param = NULL;
  576. clish_xmlnode_t *pelement;
  577. clish_param_t *param;
  578. char *pname;
  579. int res = -1;
  580. char *name = clish_xmlnode_fetch_attr(element, "name");
  581. char *help = clish_xmlnode_fetch_attr(element, "help");
  582. char *ptype = clish_xmlnode_fetch_attr(element, "ptype");
  583. char *prefix = clish_xmlnode_fetch_attr(element, "prefix");
  584. char *defval = clish_xmlnode_fetch_attr(element, "default");
  585. char *mode = clish_xmlnode_fetch_attr(element, "mode");
  586. char *optional = clish_xmlnode_fetch_attr(element, "optional");
  587. char *order = clish_xmlnode_fetch_attr(element, "order");
  588. char *value = clish_xmlnode_fetch_attr(element, "value");
  589. char *hidden = clish_xmlnode_fetch_attr(element, "hidden");
  590. char *test = clish_xmlnode_fetch_attr(element, "test");
  591. char *completion = clish_xmlnode_fetch_attr(element, "completion");
  592. char *access = clish_xmlnode_fetch_attr(element, "access");
  593. /* The PARAM can be child of COMMAND or another PARAM */
  594. pelement = clish_xmlnode_parent(element);
  595. pname = clish_xmlnode_get_all_name(pelement);
  596. if (pname && lub_string_nocasecmp(pname, "PARAM") == 0)
  597. p_param = (clish_param_t *)parent;
  598. else
  599. cmd = (clish_command_t *)parent;
  600. if (pname)
  601. free(pname);
  602. if (!cmd && !p_param)
  603. goto error;
  604. /* Check syntax */
  605. if (cmd && (cmd == shell->startup)) {
  606. fprintf(stderr, CLISH_XML_ERROR_STR"STARTUP can't contain PARAMs.\n");
  607. goto error;
  608. }
  609. if (!name) {
  610. fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
  611. goto error;
  612. }
  613. if (!help) {
  614. fprintf(stderr, CLISH_XML_ERROR_ATTR("help"));
  615. goto error;
  616. }
  617. if (!ptype) {
  618. fprintf(stderr, CLISH_XML_ERROR_ATTR("ptype"));
  619. goto error;
  620. }
  621. param = clish_param_new(name, help, ptype);
  622. /* If prefix is set clish will emulate old optional
  623. * command syntax over newer optional command mechanism.
  624. * It will create nested PARAM.
  625. */
  626. if (prefix) {
  627. const char *ptype_name = "__ptype_SUBCOMMAND";
  628. clish_param_t *opt_param = NULL;
  629. char *str = NULL;
  630. clish_ptype_t *tmp;
  631. /* Create a ptype for prefix-named subcommand that
  632. * will contain the nested optional parameter. The
  633. * name of ptype is hardcoded. It's not good but
  634. * it's only the service ptype.
  635. */
  636. tmp = (clish_ptype_t *)lub_bintree_find(
  637. &shell->ptype_tree, ptype_name);
  638. if (!tmp)
  639. tmp = clish_shell_find_create_ptype(shell,
  640. ptype_name, "Option", "[^\\\\]+",
  641. CLISH_PTYPE_REGEXP, CLISH_PTYPE_NONE);
  642. assert(tmp);
  643. lub_string_cat(&str, "_prefix_");
  644. lub_string_cat(&str, name);
  645. opt_param = clish_param_new(str, help, ptype_name);
  646. lub_string_free(str);
  647. clish_param__set_mode(opt_param,
  648. CLISH_PARAM_SUBCOMMAND);
  649. clish_param__set_value(opt_param, prefix);
  650. clish_param__set_optional(opt_param, BOOL_TRUE);
  651. if (test)
  652. clish_param__set_test(opt_param, test);
  653. /* Add the parameter to the command */
  654. if (cmd)
  655. clish_command_insert_param(cmd, opt_param);
  656. /* Add the parameter to the param */
  657. if (p_param)
  658. clish_param_insert_param(p_param, opt_param);
  659. /* Unset cmd and set parent param to opt_param */
  660. cmd = NULL;
  661. p_param = opt_param;
  662. }
  663. if (defval)
  664. clish_param__set_defval(param, defval);
  665. if (hidden && lub_string_nocasecmp(hidden, "true") == 0)
  666. clish_param__set_hidden(param, BOOL_TRUE);
  667. else
  668. clish_param__set_hidden(param, BOOL_FALSE);
  669. if (mode) {
  670. if (lub_string_nocasecmp(mode, "switch") == 0) {
  671. clish_param__set_mode(param,
  672. CLISH_PARAM_SWITCH);
  673. /* Force hidden attribute */
  674. clish_param__set_hidden(param, BOOL_TRUE);
  675. } else if (lub_string_nocasecmp(mode, "subcommand") == 0)
  676. clish_param__set_mode(param,
  677. CLISH_PARAM_SUBCOMMAND);
  678. else
  679. clish_param__set_mode(param,
  680. CLISH_PARAM_COMMON);
  681. }
  682. if (optional && lub_string_nocasecmp(optional, "true") == 0)
  683. clish_param__set_optional(param, BOOL_TRUE);
  684. else
  685. clish_param__set_optional(param, BOOL_FALSE);
  686. if (order && lub_string_nocasecmp(order, "true") == 0)
  687. clish_param__set_order(param, BOOL_TRUE);
  688. else
  689. clish_param__set_order(param, BOOL_FALSE);
  690. if (value) {
  691. clish_param__set_value(param, value);
  692. /* Force mode to subcommand */
  693. clish_param__set_mode(param,
  694. CLISH_PARAM_SUBCOMMAND);
  695. }
  696. if (test && !prefix)
  697. clish_param__set_test(param, test);
  698. if (completion)
  699. clish_param__set_completion(param, completion);
  700. if (access)
  701. clish_param__set_access(param, access);
  702. /* Add the parameter to the command */
  703. if (cmd)
  704. clish_command_insert_param(cmd, param);
  705. /* Add the parameter to the param */
  706. if (p_param)
  707. clish_param_insert_param(p_param, param);
  708. res = process_children(shell, element, param);
  709. error:
  710. clish_xml_release(name);
  711. clish_xml_release(help);
  712. clish_xml_release(ptype);
  713. clish_xml_release(prefix);
  714. clish_xml_release(defval);
  715. clish_xml_release(mode);
  716. clish_xml_release(optional);
  717. clish_xml_release(order);
  718. clish_xml_release(value);
  719. clish_xml_release(hidden);
  720. clish_xml_release(test);
  721. clish_xml_release(completion);
  722. clish_xml_release(access);
  723. return res;
  724. }
  725. /* ------------------------------------------------------ */
  726. static int process_action(clish_shell_t *shell, clish_xmlnode_t *element,
  727. void *parent)
  728. {
  729. clish_action_t *action = NULL;
  730. char *builtin = clish_xmlnode_fetch_attr(element, "builtin");
  731. char *shebang = clish_xmlnode_fetch_attr(element, "shebang");
  732. clish_xmlnode_t *pelement = clish_xmlnode_parent(element);
  733. char *pname = clish_xmlnode_get_all_name(pelement);
  734. char *text;
  735. clish_sym_t *sym = NULL;
  736. if (pname && lub_string_nocasecmp(pname, "VAR") == 0)
  737. action = clish_var__get_action((clish_var_t *)parent);
  738. else
  739. action = clish_command__get_action((clish_command_t *)parent);
  740. if (pname)
  741. free(pname);
  742. text = clish_xmlnode_get_all_content(element);
  743. if (text && *text) {
  744. /* store the action */
  745. clish_action__set_script(action, text);
  746. }
  747. if (text)
  748. free(text);
  749. if (builtin)
  750. sym = clish_shell_add_unresolved_sym(shell, builtin,
  751. CLISH_SYM_TYPE_ACTION);
  752. else
  753. sym = shell->hooks[CLISH_SYM_TYPE_ACTION];
  754. clish_action__set_builtin(action, sym);
  755. if (shebang)
  756. clish_action__set_shebang(action, shebang);
  757. clish_xml_release(builtin);
  758. clish_xml_release(shebang);
  759. return 0;
  760. }
  761. /* ------------------------------------------------------ */
  762. static int process_detail(clish_shell_t *shell, clish_xmlnode_t *element,
  763. void *parent)
  764. {
  765. clish_command_t *cmd = (clish_command_t *) parent;
  766. /* read the following text element */
  767. char *text = clish_xmlnode_get_all_content(element);
  768. if (text && *text) {
  769. /* store the action */
  770. clish_command__set_detail(cmd, text);
  771. }
  772. if (text)
  773. free(text);
  774. shell = shell; /* Happy compiler */
  775. return 0;
  776. }
  777. /* ------------------------------------------------------ */
  778. static int process_namespace(clish_shell_t *shell, clish_xmlnode_t *element,
  779. void *parent)
  780. {
  781. clish_view_t *v = (clish_view_t *)parent;
  782. clish_nspace_t *nspace = NULL;
  783. int res = -1;
  784. char *view = clish_xmlnode_fetch_attr(element, "ref");
  785. char *prefix = clish_xmlnode_fetch_attr(element, "prefix");
  786. char *prefix_help = clish_xmlnode_fetch_attr(element, "prefix_help");
  787. char *help = clish_xmlnode_fetch_attr(element, "help");
  788. char *completion = clish_xmlnode_fetch_attr(element, "completion");
  789. char *context_help = clish_xmlnode_fetch_attr(element, "context_help");
  790. char *inherit = clish_xmlnode_fetch_attr(element, "inherit");
  791. char *access = clish_xmlnode_fetch_attr(element, "access");
  792. /* Check syntax */
  793. if (!view) {
  794. fprintf(stderr, CLISH_XML_ERROR_ATTR("ref"));
  795. goto error;
  796. }
  797. clish_view_t *ref_view = clish_shell_find_view(shell, view);
  798. /* Don't include itself without prefix */
  799. if ((ref_view == v) && !prefix)
  800. goto process_namespace_end;
  801. nspace = clish_nspace_new(view);
  802. clish_view_insert_nspace(v, nspace);
  803. if (prefix) {
  804. clish_nspace__set_prefix(nspace, prefix);
  805. if (prefix_help)
  806. clish_nspace_create_prefix_cmd(nspace,
  807. "prefix",
  808. prefix_help);
  809. else
  810. clish_nspace_create_prefix_cmd(nspace,
  811. "prefix",
  812. "Prefix for the imported commands.");
  813. }
  814. if (help && lub_string_nocasecmp(help, "true") == 0)
  815. clish_nspace__set_help(nspace, BOOL_TRUE);
  816. else
  817. clish_nspace__set_help(nspace, BOOL_FALSE);
  818. if (completion && lub_string_nocasecmp(completion, "false") == 0)
  819. clish_nspace__set_completion(nspace, BOOL_FALSE);
  820. else
  821. clish_nspace__set_completion(nspace, BOOL_TRUE);
  822. if (context_help && lub_string_nocasecmp(context_help, "true") == 0)
  823. clish_nspace__set_context_help(nspace, BOOL_TRUE);
  824. else
  825. clish_nspace__set_context_help(nspace, BOOL_FALSE);
  826. if (inherit && lub_string_nocasecmp(inherit, "false") == 0)
  827. clish_nspace__set_inherit(nspace, BOOL_FALSE);
  828. else
  829. clish_nspace__set_inherit(nspace, BOOL_TRUE);
  830. if (access)
  831. clish_nspace__set_access(nspace, access);
  832. process_namespace_end:
  833. res = 0;
  834. error:
  835. clish_xml_release(view);
  836. clish_xml_release(prefix);
  837. clish_xml_release(prefix_help);
  838. clish_xml_release(help);
  839. clish_xml_release(completion);
  840. clish_xml_release(context_help);
  841. clish_xml_release(inherit);
  842. clish_xml_release(access);
  843. return res;
  844. }
  845. /* ------------------------------------------------------ */
  846. static int process_config(clish_shell_t *shell, clish_xmlnode_t *element,
  847. void *parent)
  848. {
  849. clish_command_t *cmd = (clish_command_t *)parent;
  850. clish_config_t *config;
  851. if (!cmd)
  852. return 0;
  853. config = clish_command__get_config(cmd);
  854. /* read the following text element */
  855. char *operation = clish_xmlnode_fetch_attr(element, "operation");
  856. char *priority = clish_xmlnode_fetch_attr(element, "priority");
  857. char *pattern = clish_xmlnode_fetch_attr(element, "pattern");
  858. char *file = clish_xmlnode_fetch_attr(element, "file");
  859. char *splitter = clish_xmlnode_fetch_attr(element, "splitter");
  860. char *seq = clish_xmlnode_fetch_attr(element, "sequence");
  861. char *unique = clish_xmlnode_fetch_attr(element, "unique");
  862. char *depth = clish_xmlnode_fetch_attr(element, "depth");
  863. if (operation && !lub_string_nocasecmp(operation, "unset"))
  864. clish_config__set_op(config, CLISH_CONFIG_UNSET);
  865. else if (operation && !lub_string_nocasecmp(operation, "none"))
  866. clish_config__set_op(config, CLISH_CONFIG_NONE);
  867. else if (operation && !lub_string_nocasecmp(operation, "dump"))
  868. clish_config__set_op(config, CLISH_CONFIG_DUMP);
  869. else {
  870. clish_config__set_op(config, CLISH_CONFIG_SET);
  871. /* The priority if no clearly specified */
  872. clish_config__set_priority(config, 0x7f00);
  873. }
  874. if (priority) {
  875. unsigned short pri = 0;
  876. lub_conv_atous(priority, &pri, 0);
  877. clish_config__set_priority(config, pri);
  878. }
  879. if (pattern)
  880. clish_config__set_pattern(config, pattern);
  881. else
  882. clish_config__set_pattern(config, "^${__cmd}");
  883. if (file)
  884. clish_config__set_file(config, file);
  885. if (splitter && lub_string_nocasecmp(splitter, "false") == 0)
  886. clish_config__set_splitter(config, BOOL_FALSE);
  887. else
  888. clish_config__set_splitter(config, BOOL_TRUE);
  889. if (unique && lub_string_nocasecmp(unique, "false") == 0)
  890. clish_config__set_unique(config, BOOL_FALSE);
  891. else
  892. clish_config__set_unique(config, BOOL_TRUE);
  893. if (seq)
  894. clish_config__set_seq(config, seq);
  895. else
  896. /* The entries without sequence cannot be non-unique */
  897. clish_config__set_unique(config, BOOL_TRUE);
  898. if (depth)
  899. clish_config__set_depth(config, depth);
  900. clish_xml_release(operation);
  901. clish_xml_release(priority);
  902. clish_xml_release(pattern);
  903. clish_xml_release(file);
  904. clish_xml_release(splitter);
  905. clish_xml_release(seq);
  906. clish_xml_release(unique);
  907. clish_xml_release(depth);
  908. shell = shell; /* Happy compiler */
  909. return 0;
  910. }
  911. /* ------------------------------------------------------ */
  912. static int process_var(clish_shell_t *shell, clish_xmlnode_t *element,
  913. void *parent)
  914. {
  915. clish_var_t *var = NULL;
  916. int res = -1;
  917. char *name = clish_xmlnode_fetch_attr(element, "name");
  918. char *dynamic = clish_xmlnode_fetch_attr(element, "dynamic");
  919. char *value = clish_xmlnode_fetch_attr(element, "value");
  920. /* Check syntax */
  921. if (!name) {
  922. fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
  923. goto error;
  924. }
  925. /* Check if this var doesn't already exist */
  926. var = (clish_var_t *)lub_bintree_find(&shell->var_tree, name);
  927. if (var) {
  928. fprintf(stderr, CLISH_XML_ERROR_STR"Duplicate VAR name=\"%s\".\n", name);
  929. goto error;
  930. }
  931. /* Create var instance */
  932. var = clish_var_new(name);
  933. lub_bintree_insert(&shell->var_tree, var);
  934. if (dynamic && lub_string_nocasecmp(dynamic, "true") == 0)
  935. clish_var__set_dynamic(var, BOOL_TRUE);
  936. if (value)
  937. clish_var__set_value(var, value);
  938. res = process_children(shell, element, var);
  939. error:
  940. clish_xml_release(name);
  941. clish_xml_release(dynamic);
  942. clish_xml_release(value);
  943. parent = parent; /* Happy compiler */
  944. return res;
  945. }
  946. /* ------------------------------------------------------ */
  947. static int process_wdog(clish_shell_t *shell,
  948. clish_xmlnode_t *element, void *parent)
  949. {
  950. clish_view_t *v = (clish_view_t *)parent;
  951. clish_command_t *cmd = NULL;
  952. int res = -1;
  953. /* Check syntax */
  954. if (shell->wdog) {
  955. fprintf(stderr, CLISH_XML_ERROR_STR"WATCHDOG tag duplication.\n");
  956. goto error;
  957. }
  958. /* Create a command with NULL help */
  959. cmd = clish_view_new_command(v, "watchdog", NULL);
  960. clish_command__set_lock(cmd, BOOL_FALSE);
  961. /* Remember this command */
  962. shell->wdog = cmd;
  963. res = process_children(shell, element, cmd);
  964. error:
  965. return res;
  966. }
  967. /* ------------------------------------------------------ */
  968. static int process_hotkey(clish_shell_t *shell, clish_xmlnode_t *element,
  969. void *parent)
  970. {
  971. clish_view_t *v = (clish_view_t *)parent;
  972. int res = -1;
  973. char *key = clish_xmlnode_fetch_attr(element, "key");
  974. char *cmd = clish_xmlnode_fetch_attr(element, "cmd");
  975. /* Check syntax */
  976. if (!key) {
  977. fprintf(stderr, CLISH_XML_ERROR_ATTR("key"));
  978. goto error;
  979. }
  980. if (!cmd) {
  981. fprintf(stderr, CLISH_XML_ERROR_ATTR("cmd"));
  982. goto error;
  983. }
  984. clish_view_insert_hotkey(v, key, cmd);
  985. res = 0;
  986. error:
  987. clish_xml_release(key);
  988. clish_xml_release(cmd);
  989. shell = shell; /* Happy compiler */
  990. return res;
  991. }
  992. /* ------------------------------------------------------ */
  993. static int process_plugin(clish_shell_t *shell, clish_xmlnode_t *element,
  994. void *parent)
  995. {
  996. clish_plugin_t *plugin;
  997. char *file = clish_xmlnode_fetch_attr(element, "file");
  998. char *name = clish_xmlnode_fetch_attr(element, "name");
  999. char *alias = clish_xmlnode_fetch_attr(element, "alias");
  1000. char *rtld_global = clish_xmlnode_fetch_attr(element, "rtld_global");
  1001. int res = -1;
  1002. char *text;
  1003. /* Check syntax */
  1004. if (!name) {
  1005. fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
  1006. goto error;
  1007. }
  1008. plugin = clish_shell_find_plugin(shell, name);
  1009. if (plugin) {
  1010. fprintf(stderr,
  1011. CLISH_XML_ERROR_STR"PLUGIN %s duplication.\n", name);
  1012. goto error;
  1013. }
  1014. plugin = clish_plugin_new(name);
  1015. lub_list_add(shell->plugins, plugin);
  1016. if (alias && *alias)
  1017. clish_plugin__set_alias(plugin, alias);
  1018. if (file && *file)
  1019. clish_plugin__set_file(plugin, file);
  1020. if (rtld_global && lub_string_nocasecmp(rtld_global, "true") == 0)
  1021. clish_plugin__set_rtld_global(plugin, BOOL_TRUE);
  1022. /* Get PLUGIN body content */
  1023. text = clish_xmlnode_get_all_content(element);
  1024. if (text && *text)
  1025. clish_plugin__set_conf(plugin, text);
  1026. if (text)
  1027. free(text);
  1028. res = 0;
  1029. error:
  1030. clish_xml_release(file);
  1031. clish_xml_release(name);
  1032. clish_xml_release(alias);
  1033. clish_xml_release(rtld_global);
  1034. parent = parent; /* Happy compiler */
  1035. return res;
  1036. }
  1037. /* ------------------------------------------------------ */
  1038. static int process_hook(clish_shell_t *shell, clish_xmlnode_t *element,
  1039. void *parent)
  1040. {
  1041. char *name = clish_xmlnode_fetch_attr(element, "name");
  1042. char *builtin = clish_xmlnode_fetch_attr(element, "builtin");
  1043. int res = -1;
  1044. int type = CLISH_SYM_TYPE_NONE;
  1045. /* Check syntax */
  1046. if (!name) {
  1047. fprintf(stderr, CLISH_XML_ERROR_ATTR("name"));
  1048. goto error;
  1049. }
  1050. /* Find out HOOK type */
  1051. if (!strcmp(name, "action"))
  1052. type = CLISH_SYM_TYPE_ACTION;
  1053. else if (!strcmp(name, "access"))
  1054. type = CLISH_SYM_TYPE_ACCESS;
  1055. else if (!strcmp(name, "config"))
  1056. type = CLISH_SYM_TYPE_CONFIG;
  1057. else if (!strcmp(name, "log"))
  1058. type = CLISH_SYM_TYPE_LOG;
  1059. if (CLISH_SYM_TYPE_NONE == type) {
  1060. fprintf(stderr, CLISH_XML_ERROR_STR"Unknown HOOK name %s.\n", name);
  1061. goto error;
  1062. }
  1063. /* Check duplicate HOOK tag */
  1064. if (shell->hooks_use[type]) {
  1065. fprintf(stderr,
  1066. CLISH_XML_ERROR_STR"HOOK %s duplication.\n", name);
  1067. goto error;
  1068. }
  1069. shell->hooks_use[type] = BOOL_TRUE;
  1070. clish_sym__set_name(shell->hooks[type], builtin);
  1071. res = 0;
  1072. error:
  1073. clish_xml_release(name);
  1074. clish_xml_release(builtin);
  1075. parent = parent; /* Happy compiler */
  1076. return res;
  1077. }
  1078. /* ------------------------------------------------------ */