shell_var.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540
  1. /*
  2. * shell_var.c
  3. */
  4. #include <stdlib.h>
  5. #include <assert.h>
  6. #include <string.h>
  7. #include <ctype.h>
  8. #include <sys/types.h>
  9. #include <unistd.h>
  10. #include "lub/string.h"
  11. #include "lub/conv.h"
  12. #include "private.h"
  13. /*----------------------------------------------------------- */
  14. /*
  15. * search the current viewid string for a variable
  16. */
  17. void clish_shell__expand_viewid(const char *viewid, lub_list_t *vars,
  18. clish_context_t *context)
  19. {
  20. char *expanded;
  21. char *q;
  22. char *saveptr = NULL;
  23. expanded = clish_shell_expand(viewid, SHELL_VAR_NONE, context);
  24. if (!expanded)
  25. return;
  26. for (q = strtok_r(expanded, ";", &saveptr);
  27. q; q = strtok_r(NULL, ";", &saveptr)) {
  28. char *value;
  29. clish_var_t *var;
  30. value = strchr(q, '=');
  31. if (!value)
  32. continue;
  33. *value = '\0';
  34. value++;
  35. /* Create var instance */
  36. var = clish_var_new(q);
  37. lub_list_add(vars, var);
  38. clish_var__set_value(var, value);
  39. }
  40. lub_string_free(expanded);
  41. }
  42. /*----------------------------------------------------------- */
  43. /*
  44. * expand context dependent fixed-name variables
  45. */
  46. static char *find_context_var(const char *name, clish_context_t *this)
  47. {
  48. char *result = NULL;
  49. clish_shell_t *shell = this->shell;
  50. if (!lub_string_nocasecmp(name, "_width")) {
  51. char tmp[5];
  52. snprintf(tmp, sizeof(tmp), "%u",
  53. tinyrl__get_width(shell->tinyrl));
  54. tmp[sizeof(tmp) - 1] = '\0';
  55. result = strdup(tmp);
  56. } else if (!lub_string_nocasecmp(name, "_height")) {
  57. char tmp[5];
  58. snprintf(tmp, sizeof(tmp), "%u",
  59. tinyrl__get_height(shell->tinyrl));
  60. tmp[sizeof(tmp) - 1] = '\0';
  61. result = strdup(tmp);
  62. } else if (!lub_string_nocasecmp(name, "_watchdog_timeout")) {
  63. char tmp[5];
  64. snprintf(tmp, sizeof(tmp), "%u", shell->wdog_timeout);
  65. tmp[sizeof(tmp) - 1] = '\0';
  66. result = strdup(tmp);
  67. } else if (!this->cmd) { /* The vars dependent on command */
  68. return NULL;
  69. } else if (!lub_string_nocasecmp(name, "_full_cmd")) {
  70. result = lub_string_dup(clish_command__get_name(this->cmd));
  71. } else if (!lub_string_nocasecmp(name, "_cmd")) {
  72. result = lub_string_dup(clish_command__get_name(
  73. clish_command__get_cmd(this->cmd)));
  74. } else if (!lub_string_nocasecmp(name, "_orig_cmd")) {
  75. result = lub_string_dup(clish_command__get_name(
  76. clish_command__get_orig(this->cmd)));
  77. } else if (!lub_string_nocasecmp(name, "_line")) {
  78. result = clish_shell__get_line(this);
  79. } else if (!lub_string_nocasecmp(name, "_full_line")) {
  80. result = clish_shell__get_full_line(this);
  81. } else if (!lub_string_nocasecmp(name, "_params")) {
  82. if (this->pargv)
  83. result = clish_shell__get_params(this);
  84. } else if (!lub_string_nocasecmp(name, "_interactive")) {
  85. if (clish_shell__get_interactive(this->shell) &&
  86. tinyrl__get_isatty(this->shell->tinyrl))
  87. result = strdup("1");
  88. else
  89. result = strdup("0");
  90. } else if (!lub_string_nocasecmp(name, "_isatty")) {
  91. if (tinyrl__get_isatty(this->shell->tinyrl))
  92. result = strdup("1");
  93. else
  94. result = strdup("0");
  95. } else if (!lub_string_nocasecmp(name, "_pid")) {
  96. char tmp[10];
  97. snprintf(tmp, sizeof(tmp), "%u", getpid());
  98. tmp[sizeof(tmp) - 1] = '\0';
  99. result = strdup(tmp);
  100. } else if (lub_string_nocasestr(name, "_prefix") == name) {
  101. unsigned int idx = 0;
  102. unsigned int pnum = 0;
  103. pnum = lub_string_wordcount(clish_command__get_name(this->cmd)) -
  104. lub_string_wordcount(clish_command__get_name(
  105. clish_command__get_cmd(this->cmd)));
  106. lub_conv_atoui(name + strlen("_prefix"), &idx, 0);
  107. if (idx < pnum) {
  108. lub_argv_t *argv = lub_argv_new(
  109. clish_command__get_name(this->cmd), 0);
  110. result = lub_string_dup(lub_argv__get_arg(argv, idx));
  111. lub_argv_delete(argv);
  112. }
  113. } else if (!lub_string_nocasecmp(name, "_cur_depth")) {
  114. char tmp[10];
  115. int depth = clish_shell__get_depth(shell);
  116. snprintf(tmp, sizeof(tmp), "%u", depth);
  117. tmp[sizeof(tmp) - 1] = '\0';
  118. result = strdup(tmp);
  119. } else if (!lub_string_nocasecmp(name, "_cur_pwd") ||
  120. !lub_string_nocasecmp(name, "_cwd")) {
  121. int depth = clish_shell__get_depth(shell);
  122. result = clish_shell__get_cwd_full(shell, depth);
  123. }
  124. return result;
  125. }
  126. /*--------------------------------------------------------- */
  127. static char *find_var(const char *name, lub_list_t *vars, clish_context_t *context)
  128. {
  129. clish_var_t *var = lub_list_find(vars, clish_var_fn_find_by_name, name);
  130. const char *value;
  131. bool_t dynamic;
  132. char *res = NULL;
  133. if (!var)
  134. return NULL;
  135. /* Try to get saved value for static var */
  136. dynamic = clish_var__get_dynamic(var);
  137. if (!dynamic) {
  138. const char *saved = clish_var__get_saved(var);
  139. if (saved)
  140. return lub_string_dup(saved);
  141. }
  142. /* Try to expand value field */
  143. value = clish_var__get_value(var);
  144. if (value)
  145. res = clish_shell_expand(value, SHELL_VAR_NONE, context);
  146. /* Try to execute ACTION */
  147. if (!res) {
  148. char *out = NULL;
  149. clish_context_t ctx;
  150. clish_context_dup(&ctx, context);
  151. clish_context__set_action(&ctx, clish_var__get_action(var));
  152. if (clish_shell_exec_action(&ctx, &out)) {
  153. lub_string_free(out);
  154. return NULL;
  155. }
  156. res = out;
  157. }
  158. /* Save value for static var */
  159. if (!dynamic && res)
  160. clish_var__set_saved(var, res);
  161. return res;
  162. }
  163. /*--------------------------------------------------------- */
  164. static char *find_global_var(const char *name, clish_context_t *context)
  165. {
  166. clish_shell_t *shell = clish_context__get_shell(context);
  167. return find_var(name, clish_view__get_vars(shell->global), context);
  168. }
  169. /*--------------------------------------------------------- */
  170. static char *find_viewid_var(const char *name, clish_context_t *context)
  171. {
  172. clish_shell_t *shell = clish_context__get_shell(context);
  173. int depth = clish_shell__get_depth(shell);
  174. if (depth < 0)
  175. return NULL;
  176. return find_var(name, shell->cwdv[depth]->vars, context);
  177. }
  178. static char * chardiff(const char *syms, const char *minus)
  179. {
  180. char *dst = malloc(strlen(syms) + 1);
  181. char *p = dst;
  182. const char *src;
  183. for (src = syms; *src; src++) {
  184. if (!strchr(minus, *src))
  185. *(p++) = *src;
  186. }
  187. *p = '\0';
  188. return dst;
  189. }
  190. /*--------------------------------------------------------- */
  191. /*
  192. * return the next segment of text from the provided string
  193. * segments are delimited by variables within the string.
  194. */
  195. static char *expand_nextsegment(const char **string, const char *escape_chars,
  196. clish_context_t *this)
  197. {
  198. const char *p = *string;
  199. char *result = NULL;
  200. size_t len = 0;
  201. if (!p)
  202. return NULL;
  203. if (*p && (p[0] == '$') && (p[1] == '{')) {
  204. /* start of a variable */
  205. const char *tmp;
  206. p += 2;
  207. tmp = p;
  208. /*
  209. * find the end of the variable
  210. */
  211. while (*p && p++[0] != '}')
  212. len++;
  213. /* ignore non-terminated variables */
  214. if (p[-1] == '}') {
  215. bool_t valid = BOOL_FALSE;
  216. char *text, *q;
  217. char *saveptr = NULL;
  218. /* get the variable text */
  219. text = lub_string_dupn(tmp, len);
  220. /*
  221. * tokenise this INTO ':' separated words
  222. * and either expand or duplicate into the result string.
  223. * Only return a result if at least
  224. * of the words is an expandable variable
  225. */
  226. for (q = strtok_r(text, ":", &saveptr);
  227. q; q = strtok_r(NULL, ":", &saveptr)) {
  228. char *var;
  229. int mod_quote = 0; /* quote modifier */
  230. int mod_esc = 0; /* internal escape modifier */
  231. int mod_esc_chars = 1; /* escaping */
  232. int mod_esc_dec = 0; /* remove internal chars from escaping */
  233. char *space;
  234. char *all_esc = NULL;
  235. /* Search for modifiers */
  236. while (*q && !isalpha(*q)) {
  237. if ('#' == *q) {
  238. mod_quote = 1;
  239. mod_esc = 1;
  240. } else if ('\\' == *q) {
  241. mod_esc = 1;
  242. } else if ('!' == *q) {
  243. mod_quote = 1;
  244. mod_esc = 1;
  245. mod_esc_chars = 0;
  246. } else if ('~' == *q) {
  247. mod_esc = 1;
  248. mod_esc_chars = 0;
  249. /* Internal automatic variable like ${__line} */
  250. } else if (('_' == *q) && ('_' == *(q+1))) {
  251. mod_esc_dec = 1;
  252. q++;
  253. break;
  254. /* No escaping at all. Usefull for macros VAR */
  255. } else if ('^' == *q) {
  256. mod_quote = 0;
  257. mod_esc = 0;
  258. mod_esc_chars = 0;
  259. } else
  260. break;
  261. q++;
  262. }
  263. /* Get clean variable value */
  264. var = clish_shell_expand_var(q, this);
  265. if (!var) {
  266. lub_string_cat(&result, q);
  267. continue;
  268. }
  269. valid = BOOL_TRUE;
  270. /* Quoting */
  271. if (mod_quote)
  272. space = strchr(var, ' ');
  273. if (mod_quote && space)
  274. lub_string_cat(&result, "\"");
  275. /* Escape special chars */
  276. if (escape_chars && mod_esc_chars) {
  277. /* Remove internal esc from escape chars */
  278. if (mod_esc_dec)
  279. all_esc = chardiff(escape_chars,
  280. lub_string_esc_quoted);
  281. else
  282. all_esc = lub_string_dup(escape_chars);
  283. }
  284. /* Internal escaping */
  285. if (mod_esc)
  286. lub_string_cat(&all_esc,
  287. lub_string_esc_quoted);
  288. /* Real escaping */
  289. if (all_esc) {
  290. char *tstr = lub_string_encode(var,
  291. all_esc);
  292. lub_string_free(var);
  293. var = tstr;
  294. lub_string_free(all_esc);
  295. }
  296. /* copy the expansion or the raw word */
  297. lub_string_cat(&result, var);
  298. /* Quoting */
  299. if (mod_quote && space)
  300. lub_string_cat(&result, "\"");
  301. lub_string_free(var);
  302. }
  303. if (!valid) {
  304. /* not a valid variable expansion */
  305. lub_string_free(result);
  306. result = lub_string_dup("");
  307. }
  308. /* finished with the variable text */
  309. lub_string_free(text);
  310. }
  311. } else {
  312. /* find the start of a variable */
  313. while (*p) {
  314. if ((p[0] == '$') && (p[1] == '{'))
  315. break;
  316. len++;
  317. p++;
  318. }
  319. if (len > 0)
  320. result = lub_string_dupn(*string, len);
  321. }
  322. /* move the string pointer on for next time... */
  323. *string = p;
  324. return result;
  325. }
  326. /*--------------------------------------------------------- */
  327. /*
  328. * This function builds a dynamic string based on that provided
  329. * subtituting each occurance of a "${FRED}" type variable sub-string
  330. * with the appropriate value.
  331. */
  332. char *clish_shell_expand(const char *str, clish_shell_var_e vtype, clish_context_t *context)
  333. {
  334. char *seg, *result = NULL;
  335. const char *escape_chars = NULL;
  336. const clish_command_t *cmd = clish_context__get_cmd(context);
  337. /* Escape special characters */
  338. if (SHELL_VAR_REGEX == vtype) {
  339. if (cmd)
  340. escape_chars = clish_command__get_regex_chars(cmd);
  341. if (!escape_chars)
  342. escape_chars = lub_string_esc_regex;
  343. } else if (SHELL_VAR_ACTION == vtype) {
  344. if (cmd)
  345. escape_chars = clish_command__get_escape_chars(cmd);
  346. if (!escape_chars)
  347. escape_chars = lub_string_esc_default;
  348. }
  349. /* read each segment and extend the result */
  350. while ((seg = expand_nextsegment(&str, escape_chars, context))) {
  351. lub_string_cat(&result, seg);
  352. lub_string_free(seg);
  353. }
  354. return result;
  355. }
  356. /*--------------------------------------------------------- */
  357. char *clish_shell__get_params(clish_context_t *context)
  358. {
  359. clish_pargv_t *pargv = clish_context__get_pargv(context);
  360. char *line = NULL;
  361. unsigned i, cnt;
  362. const clish_param_t *param;
  363. const clish_parg_t *parg;
  364. char *request = NULL;
  365. if (!pargv)
  366. return NULL;
  367. cnt = clish_pargv__get_count(pargv);
  368. for (i = 0; i < cnt; i++) {
  369. param = clish_pargv__get_param(pargv, i);
  370. if (clish_param__get_hidden(param))
  371. continue;
  372. parg = clish_pargv__get_parg(pargv, i);
  373. if (request)
  374. lub_string_cat(&request, " ");
  375. lub_string_cat(&request, "${!");
  376. lub_string_cat(&request, clish_parg__get_name(parg));
  377. lub_string_cat(&request, "}");
  378. }
  379. line = clish_shell_expand(request, SHELL_VAR_NONE, context);
  380. lub_string_free(request);
  381. return line;
  382. }
  383. /*--------------------------------------------------------- */
  384. static char *internal_get_line(clish_context_t *context, int cmd_type)
  385. {
  386. const clish_command_t *cmd = clish_context__get_cmd(context);
  387. clish_pargv_t *pargv = clish_context__get_pargv(context);
  388. char *line = NULL;
  389. char *params = NULL;
  390. if (0 == cmd_type) /* __cmd */
  391. lub_string_cat(&line, clish_command__get_name(
  392. clish_command__get_cmd(cmd)));
  393. else /* __full_cmd */
  394. lub_string_cat(&line, clish_command__get_name(cmd));
  395. if (!pargv)
  396. return line;
  397. params = clish_shell__get_params(context);
  398. if (params) {
  399. lub_string_cat(&line, " ");
  400. lub_string_cat(&line, params);
  401. }
  402. lub_string_free(params);
  403. return line;
  404. }
  405. /*--------------------------------------------------------- */
  406. char *clish_shell__get_line(clish_context_t *context)
  407. {
  408. return internal_get_line(context, 0); /* __cmd */
  409. }
  410. /*--------------------------------------------------------- */
  411. char *clish_shell__get_full_line(clish_context_t *context)
  412. {
  413. return internal_get_line(context, 1); /* __full_cmd */
  414. }
  415. /*--------------------------------------------------------- */
  416. char *clish_shell_expand_var(const char *name, clish_context_t *context)
  417. {
  418. return clish_shell_expand_var_ex(name, context, SHELL_EXPAND_ALL);
  419. }
  420. /*----------------------------------------------------------- */
  421. char *clish_shell_expand_var_ex(const char *name, clish_context_t *context, clish_shell_expand_e flags)
  422. {
  423. clish_shell_t *this;
  424. const clish_command_t *cmd;
  425. clish_pargv_t *pargv;
  426. const char *tmp = NULL;
  427. char *string = NULL;
  428. assert(name);
  429. if (!context)
  430. return NULL;
  431. this = clish_context__get_shell(context);
  432. cmd = clish_context__get_cmd(context);
  433. pargv = clish_context__get_pargv(context);
  434. /* try and substitute a parameter value */
  435. if (pargv && (flags & SHELL_EXPAND_PARAM)) {
  436. const clish_parg_t *parg = clish_pargv_find_arg(pargv, name);
  437. if (parg)
  438. tmp = clish_parg__get_value(parg);
  439. }
  440. /* try and substitute the param's default */
  441. if (!tmp && cmd && (flags & SHELL_EXPAND_PARAM))
  442. tmp = clish_paramv_find_default(
  443. clish_command__get_paramv(cmd), name);
  444. /* try and substitute a viewId variable */
  445. if (!tmp && this && (flags & SHELL_EXPAND_VIEW))
  446. tmp = string = find_viewid_var(name, context);
  447. /* try and substitute context fixed variable */
  448. if (!tmp && (flags & SHELL_EXPAND_CONTEXT))
  449. tmp = string = find_context_var(name, context);
  450. /* try and substitute a global var value */
  451. if (!tmp && this && (flags & SHELL_EXPAND_VAR))
  452. tmp = string = find_global_var(name, context);
  453. /* get the contents of an environment variable */
  454. if (!tmp && (flags & SHELL_EXPAND_ENV))
  455. tmp = getenv(name);
  456. if (string)
  457. return string;
  458. return lub_string_dup(tmp);
  459. }
  460. /*----------------------------------------------------------- */