1
0

shell_tinyxml_read.cpp 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629
  1. ////////////////////////////////////////
  2. // shell_tinyxml_read.cpp
  3. //
  4. // This file implements the means to read an XML encoded file and populate the
  5. // CLI tree based on the contents.
  6. ////////////////////////////////////////
  7. extern "C" {
  8. #include "private.h"
  9. #include "lub/string.h"
  10. #include "lub/ctype.h"
  11. }
  12. /*lint +libh(tinyxml/tinyxml.h) Add this to the library file list */
  13. #include "tinyxml/tinyxml.h"
  14. #include <string.h>
  15. #include <assert.h>
  16. typedef void (PROCESS_FN) (clish_shell_t * instance,
  17. TiXmlElement * element, void *parent);
  18. // Define a control block for handling the decode of an XML file
  19. typedef struct clish_xml_cb_s clish_xml_cb_t;
  20. struct clish_xml_cb_s {
  21. const char *element;
  22. PROCESS_FN *handler;
  23. };
  24. // forward declare the handler functions
  25. static PROCESS_FN
  26. process_clish_module,
  27. process_startup,
  28. process_view,
  29. process_command,
  30. process_param,
  31. process_action,
  32. process_ptype,
  33. process_overview, process_detail, process_namespace, process_config;
  34. static clish_xml_cb_t xml_elements[] = {
  35. {"CLISH_MODULE", process_clish_module},
  36. {"STARTUP", process_startup},
  37. {"VIEW", process_view},
  38. {"COMMAND", process_command},
  39. {"PARAM", process_param},
  40. {"ACTION", process_action},
  41. {"PTYPE", process_ptype},
  42. {"OVERVIEW", process_overview},
  43. {"DETAIL", process_detail},
  44. {"NAMESPACE", process_namespace},
  45. {"CONFIG", process_config},
  46. {NULL, NULL}
  47. };
  48. ///////////////////////////////////////
  49. // This function reads an element from the XML stream and processes it.
  50. ///////////////////////////////////////
  51. static void process_node(clish_shell_t * shell, TiXmlNode * node, void *parent)
  52. {
  53. switch (node->Type()) {
  54. case TiXmlNode::DOCUMENT:
  55. break;
  56. case TiXmlNode::ELEMENT:
  57. clish_xml_cb_t * cb;
  58. for (cb = &xml_elements[0]; cb->element; cb++) {
  59. if (0 == strcmp(node->Value(), cb->element)) {
  60. TiXmlElement *element = (TiXmlElement *) node;
  61. #ifdef DEBUG
  62. fprintf(stderr, "NODE:");
  63. element->Print(stderr, 0);
  64. fprintf(stderr, "\n***\n");
  65. #endif
  66. // process the elements at this level
  67. cb->handler(shell, element, parent);
  68. break;
  69. }
  70. }
  71. break;
  72. case TiXmlNode::COMMENT:
  73. case TiXmlNode::TEXT:
  74. case TiXmlNode::DECLARATION:
  75. case TiXmlNode::TYPECOUNT:
  76. case TiXmlNode::UNKNOWN:
  77. default:
  78. break;
  79. }
  80. }
  81. ///////////////////////////////////////
  82. static void
  83. process_children(clish_shell_t * shell,
  84. TiXmlElement * element, void *parent = NULL)
  85. {
  86. for (TiXmlNode * node = element->FirstChild();
  87. NULL != node; node = element->IterateChildren(node)) {
  88. // Now deal with all the contained elements
  89. process_node(shell, node, parent);
  90. }
  91. }
  92. ///////////////////////////////////////
  93. static void
  94. process_clish_module(clish_shell_t * shell, TiXmlElement * element, void *)
  95. {
  96. // create the global view
  97. if (NULL == shell->global) {
  98. shell->global =
  99. clish_shell_find_create_view(shell, "global", "");
  100. }
  101. process_children(shell, element, shell->global);
  102. }
  103. ///////////////////////////////////////
  104. static void process_view(clish_shell_t * shell, TiXmlElement * element, void *)
  105. {
  106. clish_view_t *view;
  107. const char *name = element->Attribute("name");
  108. const char *prompt = element->Attribute("prompt");
  109. const char *depth = element->Attribute("depth");
  110. const char *restore = element->Attribute("restore");
  111. // re-use a view if it already exists
  112. view = clish_shell_find_create_view(shell, name, prompt);
  113. if ((depth != NULL) && (*depth != '\0') && (lub_ctype_isdigit(*depth))) {
  114. unsigned res = atoi(depth);
  115. clish_view__set_depth(view, res);
  116. }
  117. if (restore) {
  118. if (!lub_string_nocasecmp(restore, "depth"))
  119. clish_view__set_restore(view, CLISH_RESTORE_DEPTH);
  120. else if (!lub_string_nocasecmp(restore, "view"))
  121. clish_view__set_restore(view, CLISH_RESTORE_VIEW);
  122. else
  123. clish_view__set_restore(view, CLISH_RESTORE_NONE);
  124. }
  125. process_children(shell, element, view);
  126. }
  127. ///////////////////////////////////////
  128. static void process_ptype(clish_shell_t * shell, TiXmlElement * element, void *)
  129. {
  130. clish_ptype_method_e method;
  131. clish_ptype_preprocess_e preprocess;
  132. clish_ptype_t *ptype;
  133. const char *name = element->Attribute("name");
  134. const char *help = element->Attribute("help");
  135. const char *pattern = element->Attribute("pattern");
  136. const char *method_name = element->Attribute("method");
  137. const char *preprocess_name = element->Attribute("preprocess");
  138. assert(name);
  139. assert(pattern);
  140. method = clish_ptype_method_resolve(method_name);
  141. preprocess = clish_ptype_preprocess_resolve(preprocess_name);
  142. ptype = clish_shell_find_create_ptype(shell,
  143. name,
  144. help,
  145. pattern, method, preprocess);
  146. assert(ptype);
  147. }
  148. ///////////////////////////////////////
  149. static void
  150. process_overview(clish_shell_t * shell, TiXmlElement * element, void *)
  151. {
  152. // read the following text element
  153. TiXmlNode *text = element->FirstChild();
  154. if (NULL != text) {
  155. assert(TiXmlNode::TEXT == text->Type());
  156. // set the overview text for this view
  157. assert(NULL == shell->overview);
  158. // store the overview
  159. shell->overview = lub_string_dup(text->Value());
  160. }
  161. }
  162. ////////////////////////////////////////
  163. static void
  164. process_command(clish_shell_t * shell, TiXmlElement * element, void *parent)
  165. {
  166. clish_view_t *v = (clish_view_t *) parent;
  167. clish_command_t *cmd = NULL;
  168. const char *access = element->Attribute("access");
  169. bool allowed = true;
  170. if (NULL != access) {
  171. allowed = false; // err on the side of caution
  172. if (shell->client_hooks->access_fn) {
  173. // get the client to authenticate
  174. allowed =
  175. shell->client_hooks->access_fn(shell,
  176. access) ? true :
  177. false;
  178. }
  179. }
  180. if (allowed) {
  181. const char *name = element->Attribute("name");
  182. const char *help = element->Attribute("help");
  183. const char *view = element->Attribute("view");
  184. const char *viewid = element->Attribute("viewid");
  185. const char *escape_chars = element->Attribute("escape_chars");
  186. const char *args_name = element->Attribute("args");
  187. const char *args_help = element->Attribute("args_help");
  188. const char *lock = element->Attribute("lock");
  189. clish_command_t *old = clish_view_find_command(v, name, BOOL_FALSE);
  190. // check this command doesn't already exist
  191. if (NULL != old) {
  192. // flag the duplication then ignore further definition
  193. printf("DUPLICATE COMMAND: %s\n",
  194. clish_command__get_name(old));
  195. } else {
  196. assert(name);
  197. assert(help);
  198. /* create a command */
  199. cmd = clish_view_new_command(v, name, help);
  200. assert(cmd);
  201. clish_command__set_pview(cmd, v);
  202. if (NULL != escape_chars) {
  203. /* define some specialist escape characters */
  204. clish_command__set_escape_chars(cmd,
  205. escape_chars);
  206. }
  207. if (NULL != args_name) {
  208. /* define a "rest of line" argument */
  209. clish_param_t *param;
  210. clish_ptype_t *tmp = NULL;
  211. assert(NULL != args_help);
  212. tmp = clish_shell_find_create_ptype(shell,
  213. "internal_ARGS",
  214. "Arguments", "[^\\]+",
  215. CLISH_PTYPE_REGEXP,
  216. CLISH_PTYPE_NONE);
  217. assert(tmp);
  218. param =
  219. clish_param_new(args_name, args_help, tmp);
  220. clish_command__set_args(cmd, param);
  221. }
  222. // define the view which this command changes to
  223. if (NULL != view) {
  224. clish_view_t *next =
  225. clish_shell_find_create_view(shell, view,
  226. NULL);
  227. // reference the next view
  228. clish_command__set_view(cmd, next);
  229. }
  230. // define the view id which this command changes to
  231. if (NULL != viewid) {
  232. clish_command__set_viewid(cmd, viewid);
  233. }
  234. /* lock field */
  235. if (lock && (lub_string_nocasecmp(lock, "false") == 0))
  236. clish_command__set_lock(cmd, BOOL_FALSE);
  237. else
  238. clish_command__set_lock(cmd, BOOL_TRUE);
  239. process_children(shell, element, cmd);
  240. }
  241. }
  242. }
  243. ///////////////////////////////////////
  244. static void
  245. process_startup(clish_shell_t * shell, TiXmlElement * element, void *parent)
  246. {
  247. clish_view_t *v = (clish_view_t *) parent;
  248. clish_command_t *cmd = NULL;
  249. const char *view = element->Attribute("view");
  250. const char *viewid = element->Attribute("viewid");
  251. const char *env_view = getenv("CLISH_VIEW");
  252. const char *env_viewid = getenv("CLISH_VIEWID");
  253. /* Redefine startup view if environment is set. */
  254. if (env_view)
  255. view = env_view;
  256. if (env_viewid)
  257. viewid = env_viewid;
  258. assert(NULL == shell->startup);
  259. assert(view);
  260. /* create a command with NULL help */
  261. cmd = clish_view_new_command(v, "startup", NULL);
  262. clish_command__set_lock(cmd, BOOL_FALSE);
  263. // define the view which this command changes to
  264. clish_view_t *next = clish_shell_find_create_view(shell, view, NULL);
  265. // reference the next view
  266. clish_command__set_view(cmd, next);
  267. // define the view id which this command changes to
  268. if (NULL != viewid) {
  269. clish_command__set_viewid(cmd, viewid);
  270. }
  271. // remember this command
  272. shell->startup = cmd;
  273. process_children(shell, element, cmd);
  274. }
  275. ///////////////////////////////////////
  276. static void
  277. process_param(clish_shell_t * shell, TiXmlElement * element, void *parent)
  278. {
  279. clish_command_t *cmd = NULL;
  280. clish_param_t *p_param = NULL;
  281. if (0 == lub_string_nocasecmp(element->Parent()->Value(), "PARAM"))
  282. p_param = (clish_param_t *) parent;
  283. else
  284. cmd = (clish_command_t *) parent;
  285. if ((NULL != cmd) || (NULL != p_param)) {
  286. assert((!cmd) || (cmd != shell->startup));
  287. const char *name = element->Attribute("name");
  288. const char *help = element->Attribute("help");
  289. const char *ptype = element->Attribute("ptype");
  290. const char *prefix = element->Attribute("prefix");
  291. const char *defval = element->Attribute("default");
  292. const char *mode = element->Attribute("mode");
  293. const char *optional = element->Attribute("optional");
  294. const char *value = element->Attribute("value");
  295. const char *hidden = element->Attribute("hidden");
  296. const char *test = element->Attribute("test");
  297. clish_param_t *param;
  298. clish_ptype_t *tmp = NULL;
  299. // create a command
  300. assert(name);
  301. assert(help);
  302. assert(ptype);
  303. if (ptype && *ptype) {
  304. tmp = clish_shell_find_create_ptype(shell, ptype,
  305. NULL, NULL,
  306. CLISH_PTYPE_REGEXP,
  307. CLISH_PTYPE_NONE);
  308. assert(tmp);
  309. }
  310. param = clish_param_new(name, help, tmp);
  311. /* If prefix is set clish will emulate old optional
  312. * command syntax over newer optional command mechanism.
  313. * It will create nested PARAM.
  314. */
  315. if (NULL != prefix) {
  316. const char *ptype_name = "__SUBCOMMAND";
  317. clish_param_t *opt_param = NULL;
  318. /* Create a ptype for prefix-named subcommand that
  319. * will contain the nested optional parameter. The
  320. * name of ptype is hardcoded. It's not good but
  321. * it's only the service ptype.
  322. */
  323. tmp = (clish_ptype_t *)lub_bintree_find(
  324. &shell->ptype_tree, ptype_name);
  325. if (!tmp)
  326. tmp = clish_shell_find_create_ptype(shell,
  327. ptype_name, "Option", "[^\\]+",
  328. CLISH_PTYPE_REGEXP, CLISH_PTYPE_NONE);
  329. assert(tmp);
  330. opt_param = clish_param_new(prefix, help, tmp);
  331. clish_param__set_mode(opt_param,
  332. CLISH_PARAM_SUBCOMMAND);
  333. clish_param__set_optional(opt_param, BOOL_TRUE);
  334. if (NULL != test)
  335. clish_param__set_test(opt_param, test);
  336. if (cmd)
  337. // add the parameter to the command
  338. clish_command_insert_param(cmd, opt_param);
  339. if (p_param)
  340. // add the parameter to the param
  341. clish_param_insert_param(p_param, opt_param);
  342. /* Unset cmd and set parent param to opt_param */
  343. cmd = NULL;
  344. p_param = opt_param;
  345. }
  346. if (NULL != defval) {
  347. clish_param__set_default(param, defval);
  348. }
  349. if (hidden && (lub_string_nocasecmp(hidden, "true") == 0))
  350. clish_param__set_hidden(param, BOOL_TRUE);
  351. else
  352. clish_param__set_hidden(param, BOOL_FALSE);
  353. if (NULL != mode) {
  354. if (!lub_string_nocasecmp(mode, "switch")) {
  355. clish_param__set_mode(param,
  356. CLISH_PARAM_SWITCH);
  357. /* Force hidden attribute */
  358. clish_param__set_hidden(param, BOOL_TRUE);
  359. } else if (!lub_string_nocasecmp(mode, "subcommand"))
  360. clish_param__set_mode(param,
  361. CLISH_PARAM_SUBCOMMAND);
  362. else
  363. clish_param__set_mode(param,
  364. CLISH_PARAM_COMMON);
  365. }
  366. if (optional && (lub_string_nocasecmp(optional, "true") == 0))
  367. clish_param__set_optional(param, BOOL_TRUE);
  368. else
  369. clish_param__set_optional(param, BOOL_FALSE);
  370. if (NULL != value) {
  371. clish_param__set_value(param, value);
  372. /* Force mode to subcommand */
  373. clish_param__set_mode(param,
  374. CLISH_PARAM_SUBCOMMAND);
  375. }
  376. if ((NULL != test) && (NULL == prefix))
  377. clish_param__set_test(param, test);
  378. if (cmd)
  379. // add the parameter to the command
  380. clish_command_insert_param(cmd, param);
  381. if (p_param)
  382. // add the parameter to the param
  383. clish_param_insert_param(p_param, param);
  384. process_children(shell, element, param);
  385. }
  386. }
  387. ////////////////////////////////////////
  388. static void
  389. process_action(clish_shell_t * shell, TiXmlElement * element, void *parent)
  390. {
  391. clish_command_t *cmd = (clish_command_t *) parent;
  392. if (NULL != cmd) {
  393. // read the following text element
  394. TiXmlNode *text = element->FirstChild();
  395. const char *builtin = element->Attribute("builtin");
  396. if (NULL != text) {
  397. assert(TiXmlNode::TEXT == text->Type());
  398. // store the action
  399. clish_command__set_action(cmd, text->Value());
  400. }
  401. if (NULL != builtin) {
  402. // store the action
  403. clish_command__set_builtin(cmd, builtin);
  404. }
  405. }
  406. }
  407. ////////////////////////////////////////
  408. static void
  409. process_detail(clish_shell_t * shell, TiXmlElement * element, void *parent)
  410. {
  411. clish_command_t *cmd = (clish_command_t *) parent;
  412. // read the following text element
  413. TiXmlNode *text = element->FirstChild();
  414. if ((NULL != cmd) && (NULL != text)) {
  415. assert(TiXmlNode::TEXT == text->Type());
  416. // store the action
  417. clish_command__set_detail(cmd, text->Value());
  418. }
  419. }
  420. ///////////////////////////////////////
  421. static void
  422. process_namespace(clish_shell_t * shell, TiXmlElement * element, void *parent)
  423. {
  424. clish_view_t *v = (clish_view_t *) parent;
  425. clish_nspace_t *nspace = NULL;
  426. const char *view = element->Attribute("ref");
  427. const char *prefix = element->Attribute("prefix");
  428. const char *prefix_help = element->Attribute("prefix_help");
  429. const char *help = element->Attribute("help");
  430. const char *completion = element->Attribute("completion");
  431. const char *context_help = element->Attribute("context_help");
  432. const char *inherit = element->Attribute("inherit");
  433. assert(view);
  434. clish_view_t *ref_view =
  435. clish_shell_find_create_view(shell, view, NULL);
  436. assert(ref_view);
  437. nspace = clish_nspace_new(ref_view);
  438. assert(nspace);
  439. clish_view_insert_nspace(v, nspace);
  440. if (NULL != prefix) {
  441. clish_nspace__set_prefix(nspace, prefix);
  442. if (prefix_help)
  443. clish_nspace_create_prefix_cmd(nspace,
  444. "prefix",
  445. prefix_help);
  446. else
  447. clish_nspace_create_prefix_cmd(nspace,
  448. "prefix",
  449. "Prefix for the imported commands.");
  450. }
  451. if (help && (lub_string_nocasecmp(help, "true") == 0))
  452. clish_nspace__set_help(nspace, BOOL_TRUE);
  453. else
  454. clish_nspace__set_help(nspace, BOOL_FALSE);
  455. if (completion && (lub_string_nocasecmp(completion, "false") == 0))
  456. clish_nspace__set_completion(nspace, BOOL_FALSE);
  457. else
  458. clish_nspace__set_completion(nspace, BOOL_TRUE);
  459. if (context_help && (lub_string_nocasecmp(context_help, "true") == 0))
  460. clish_nspace__set_context_help(nspace, BOOL_TRUE);
  461. else
  462. clish_nspace__set_context_help(nspace, BOOL_FALSE);
  463. if (inherit && (lub_string_nocasecmp(inherit, "false") == 0))
  464. clish_nspace__set_inherit(nspace, BOOL_FALSE);
  465. else
  466. clish_nspace__set_inherit(nspace, BOOL_TRUE);
  467. }
  468. ////////////////////////////////////////
  469. static void
  470. process_config(clish_shell_t * shell, TiXmlElement * element, void *parent)
  471. {
  472. clish_command_t *cmd = (clish_command_t *) parent;
  473. if (NULL == cmd)
  474. return;
  475. // read the following text element
  476. const char *operation = element->Attribute("operation");
  477. const char *priority = element->Attribute("priority");
  478. const char *pattern = element->Attribute("pattern");
  479. const char *file = element->Attribute("file");
  480. const char *splitter = element->Attribute("splitter");
  481. const char *seq = element->Attribute("sequence");
  482. const char *unique = element->Attribute("unique");
  483. const char *cfg_depth = element->Attribute("depth");
  484. if (operation && !lub_string_nocasecmp(operation, "unset"))
  485. clish_command__set_cfg_op(cmd, CLISH_CONFIG_UNSET);
  486. else if (operation && !lub_string_nocasecmp(operation, "none"))
  487. clish_command__set_cfg_op(cmd, CLISH_CONFIG_NONE);
  488. else if (operation && !lub_string_nocasecmp(operation, "dump"))
  489. clish_command__set_cfg_op(cmd, CLISH_CONFIG_DUMP);
  490. else {
  491. clish_command__set_cfg_op(cmd, CLISH_CONFIG_SET);
  492. /* The priority if no clearly specified */
  493. clish_command__set_priority(cmd, 0x7f00);
  494. }
  495. if ((priority != NULL) && (*priority != '\0')) {
  496. long val = 0;
  497. char *endptr;
  498. unsigned short pri;
  499. val = strtol(priority, &endptr, 0);
  500. if (endptr == priority)
  501. pri = 0;
  502. else if (val > 0xffff)
  503. pri = 0xffff;
  504. else if (val < 0)
  505. pri = 0;
  506. else
  507. pri = (unsigned short)val;
  508. clish_command__set_priority(cmd, pri);
  509. }
  510. if (pattern != NULL)
  511. clish_command__set_pattern(cmd, pattern);
  512. else
  513. clish_command__set_pattern(cmd, "^${__cmd}");
  514. if (file != NULL)
  515. clish_command__set_file(cmd, file);
  516. if (splitter && (lub_string_nocasecmp(splitter, "false") == 0))
  517. clish_command__set_splitter(cmd, BOOL_FALSE);
  518. else
  519. clish_command__set_splitter(cmd, BOOL_TRUE);
  520. if (unique && (lub_string_nocasecmp(unique, "false") == 0))
  521. clish_command__set_unique(cmd, BOOL_FALSE);
  522. else
  523. clish_command__set_unique(cmd, BOOL_TRUE);
  524. if (seq != NULL)
  525. clish_command__set_seq(cmd, seq);
  526. else
  527. /* The entries without sequence cannot be non-unique */
  528. clish_command__set_unique(cmd, BOOL_TRUE);
  529. if (cfg_depth != NULL)
  530. clish_command__set_cfg_depth(cmd, cfg_depth);
  531. }
  532. ///////////////////////////////////////
  533. int clish_shell_xml_read(clish_shell_t * shell, const char *filename)
  534. {
  535. int ret = -1;
  536. TiXmlDocument doc;
  537. // keep the white space
  538. TiXmlBase::SetCondenseWhiteSpace(false);
  539. if (doc.LoadFile(filename)) {
  540. TiXmlNode *child = 0;
  541. while ((child = doc.IterateChildren(child))) {
  542. process_node(shell, child, NULL);
  543. }
  544. ret = 0;
  545. } else {
  546. printf("Unable to open %s\n", filename);
  547. }
  548. return ret;
  549. }
  550. ///////////////////////////////////////