shell_execute.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. /*
  2. * shell_execute.c
  3. */
  4. #include "private.h"
  5. #include "lub/string.h"
  6. #include "lub/argv.h"
  7. #include <assert.h>
  8. #include <stdio.h>
  9. #include <unistd.h>
  10. #include <string.h>
  11. #include <stdlib.h>
  12. #include <errno.h>
  13. #include <sys/stat.h>
  14. #include <sys/file.h>
  15. #include <signal.h>
  16. /*
  17. * These are the internal commands for this framework.
  18. */
  19. static clish_shell_builtin_fn_t
  20. clish_close,
  21. clish_overview,
  22. clish_source,
  23. clish_source_nostop,
  24. clish_history,
  25. clish_nested_up,
  26. clish_nop;
  27. static clish_shell_builtin_t clish_cmd_list[] = {
  28. {"clish_close", clish_close},
  29. {"clish_overview", clish_overview},
  30. {"clish_source", clish_source},
  31. {"clish_source_nostop", clish_source_nostop},
  32. {"clish_history", clish_history},
  33. {"clish_nested_up", clish_nested_up},
  34. {"clish_nop", clish_nop},
  35. {NULL, NULL}
  36. };
  37. /*----------------------------------------------------------- */
  38. /* Terminate the current shell session */
  39. static bool_t clish_close(const clish_shell_t * shell, const lub_argv_t * argv)
  40. {
  41. /* the exception proves the rule... */
  42. clish_shell_t *this = (clish_shell_t *) shell;
  43. argv = argv; /* not used */
  44. this->state = SHELL_STATE_CLOSING;
  45. return BOOL_TRUE;
  46. }
  47. /*----------------------------------------------------------- */
  48. /*
  49. Open a file and interpret it as a script in the context of a new
  50. thread. Whether the script continues after command, but not script,
  51. errors depends on the value of the stop_on_error flag.
  52. */
  53. static bool_t clish_source_internal(const clish_shell_t * shell,
  54. const lub_argv_t * argv, bool_t stop_on_error)
  55. {
  56. bool_t result = BOOL_FALSE;
  57. const char *filename = lub_argv__get_arg(argv, 0);
  58. struct stat fileStat;
  59. /* the exception proves the rule... */
  60. clish_shell_t *this = (clish_shell_t *) shell;
  61. /*
  62. * Check file specified is not a directory
  63. */
  64. if ((0 == stat((char *)filename, &fileStat)) &&
  65. (!S_ISDIR(fileStat.st_mode))) {
  66. /*
  67. * push this file onto the file stack associated with this
  68. * session. This will be closed by clish_shell_pop_file()
  69. * when it is finished with.
  70. */
  71. result = clish_shell_push_file(this, filename,
  72. stop_on_error);
  73. }
  74. return result;
  75. }
  76. /*----------------------------------------------------------- */
  77. /*
  78. Open a file and interpret it as a script in the context of a new
  79. thread. Invoking a script in this way will cause the script to
  80. stop on the first error
  81. */
  82. static bool_t clish_source(const clish_shell_t * shell, const lub_argv_t * argv)
  83. {
  84. return (clish_source_internal(shell, argv, BOOL_TRUE));
  85. }
  86. /*----------------------------------------------------------- */
  87. /*
  88. Open a file and interpret it as a script in the context of a new
  89. thread. Invoking a script in this way will cause the script to
  90. continue after command, but not script, errors.
  91. */
  92. static bool_t
  93. clish_source_nostop(const clish_shell_t * shell, const lub_argv_t * argv)
  94. {
  95. return (clish_source_internal(shell, argv, BOOL_FALSE));
  96. }
  97. /*----------------------------------------------------------- */
  98. /*
  99. Show the shell overview
  100. */
  101. static bool_t
  102. clish_overview(const clish_shell_t * this, const lub_argv_t * argv)
  103. {
  104. argv = argv; /* not used */
  105. tinyrl_printf(this->tinyrl, "%s\n", this->overview);
  106. return BOOL_TRUE;
  107. }
  108. /*----------------------------------------------------------- */
  109. static bool_t clish_history(const clish_shell_t * this, const lub_argv_t * argv)
  110. {
  111. tinyrl_history_t *history = tinyrl__get_history(this->tinyrl);
  112. tinyrl_history_iterator_t iter;
  113. const tinyrl_history_entry_t *entry;
  114. unsigned limit = 0;
  115. const char *arg = lub_argv__get_arg(argv, 0);
  116. if (arg && ('\0' != *arg)) {
  117. limit = (unsigned)atoi(arg);
  118. if (0 == limit) {
  119. /* unlimit the history list */
  120. (void)tinyrl_history_unstifle(history);
  121. } else {
  122. /* limit the scope of the history list */
  123. tinyrl_history_stifle(history, limit);
  124. }
  125. }
  126. for (entry = tinyrl_history_getfirst(history, &iter);
  127. entry; entry = tinyrl_history_getnext(&iter)) {
  128. /* dump the details of this entry */
  129. tinyrl_printf(this->tinyrl,
  130. "%5d %s\n",
  131. tinyrl_history_entry__get_index(entry),
  132. tinyrl_history_entry__get_line(entry));
  133. }
  134. return BOOL_TRUE;
  135. }
  136. /*----------------------------------------------------------- */
  137. /*
  138. * Searches for a builtin command to execute
  139. */
  140. static clish_shell_builtin_fn_t *find_builtin_callback(const
  141. clish_shell_builtin_t * cmd_list, const char *name)
  142. {
  143. const clish_shell_builtin_t *result;
  144. /* search a list of commands */
  145. for (result = cmd_list; result && result->name; result++) {
  146. if (0 == strcmp(name, result->name))
  147. break;
  148. }
  149. return (result && result->name) ? result->callback : NULL;
  150. }
  151. /*----------------------------------------------------------- */
  152. void clish_shell_cleanup_script(void *script)
  153. {
  154. /* simply release the memory */
  155. lub_string_free(script);
  156. }
  157. /*----------------------------------------------------------- */
  158. bool_t clish_shell_execute(clish_context_t *context, char **out)
  159. {
  160. clish_shell_t *this = context->shell;
  161. const clish_command_t *cmd = context->cmd;
  162. clish_pargv_t *pargv = context->pargv;
  163. bool_t result = BOOL_TRUE;
  164. const char *builtin;
  165. char *script;
  166. char *lock_path = clish_shell__get_lockfile(this);
  167. int lock_fd = -1;
  168. sigset_t old_sigs;
  169. struct sigaction old_sigint, old_sigquit;
  170. assert(cmd);
  171. /* Pre-change view if the command is from another depth/view */
  172. {
  173. clish_view_t *view = NULL;
  174. char *viewid = NULL;
  175. clish_view_restore_t restore = clish_command__get_restore(cmd);
  176. if ((CLISH_RESTORE_VIEW == restore) &&
  177. (clish_command__get_pview(cmd) != this->view))
  178. view = clish_command__get_pview(cmd);
  179. else if ((CLISH_RESTORE_DEPTH == restore) &&
  180. (clish_command__get_depth(cmd) <
  181. clish_view__get_depth(this->view))) {
  182. view = clish_shell__get_pwd_view(this,
  183. clish_command__get_depth(cmd));
  184. viewid = clish_shell__get_pwd_viewid(this,
  185. clish_command__get_depth(cmd));
  186. }
  187. if (view) {
  188. this->view = view;
  189. /* cleanup */
  190. lub_string_free(this->viewid);
  191. this->viewid = lub_string_dup(viewid);
  192. }
  193. }
  194. /* Lock the lockfile */
  195. if (lock_path && clish_command__get_lock(cmd)) {
  196. int i;
  197. int res;
  198. lock_fd = open(lock_path, O_RDONLY | O_CREAT, 00644);
  199. if (-1 == lock_fd) {
  200. fprintf(stderr, "Can't open lockfile %s.\n",
  201. lock_path);
  202. return BOOL_FALSE; /* can't open file */
  203. }
  204. for (i = 0; i < CLISH_LOCK_WAIT; i++) {
  205. res = flock(lock_fd, LOCK_EX | LOCK_NB);
  206. if (!res)
  207. break;
  208. if ((EBADF == errno) ||
  209. (EINVAL == errno) ||
  210. (ENOLCK == errno))
  211. break;
  212. if (EINTR == errno)
  213. continue;
  214. if (0 == i)
  215. fprintf(stderr,
  216. "Try to get lock. Please wait...\n");
  217. sleep(1);
  218. }
  219. if (res) {
  220. fprintf(stderr, "Can't get lock.\n");
  221. return BOOL_FALSE; /* can't get the lock */
  222. }
  223. }
  224. /* Ignore and block SIGINT and SIGQUIT */
  225. if (!clish_command__get_interrupt(cmd)) {
  226. struct sigaction sa;
  227. sigset_t sigs;
  228. sa.sa_flags = 0;
  229. sigemptyset(&sa.sa_mask);
  230. sa.sa_handler = SIG_IGN;
  231. sigaction(SIGINT, &sa, &old_sigint);
  232. sigaction(SIGQUIT, &sa, &old_sigquit);
  233. sigemptyset(&sigs);
  234. sigaddset(&sigs, SIGINT);
  235. sigaddset(&sigs, SIGQUIT);
  236. sigprocmask(SIG_BLOCK, &sigs, &old_sigs);
  237. }
  238. /* Execute ACTION */
  239. builtin = clish_command__get_builtin(cmd);
  240. script = clish_command__expand_action(cmd, context);
  241. /* account for thread cancellation whilst running a script */
  242. pthread_cleanup_push((void (*)(void *))clish_shell_cleanup_script,
  243. script);
  244. if (builtin) {
  245. clish_shell_builtin_fn_t *callback;
  246. lub_argv_t *argv = script ? lub_argv_new(script, 0) : NULL;
  247. result = BOOL_FALSE;
  248. /* search for an internal command */
  249. callback = find_builtin_callback(clish_cmd_list, builtin);
  250. if (!callback) {
  251. /* search for a client command */
  252. callback = find_builtin_callback(
  253. this->client_hooks->cmd_list, builtin);
  254. }
  255. /* invoke the builtin callback */
  256. if (callback)
  257. result = callback(this, argv);
  258. if (argv)
  259. lub_argv_delete(argv);
  260. } else if (script) {
  261. /* now get the client to interpret the resulting script */
  262. result = this->client_hooks->script_fn(context, script, out);
  263. }
  264. pthread_cleanup_pop(1);
  265. /* Restore SIGINT and SIGQUIT */
  266. if (!clish_command__get_interrupt(cmd)) {
  267. sigprocmask(SIG_SETMASK, &old_sigs, NULL);
  268. /* Is the signals delivery guaranteed here (before
  269. sigaction restore) for previously blocked and
  270. pending signals? The simple test is working well.
  271. I don't want to use sigtimedwait() function bacause
  272. it needs a realtime extensions. The sigpending() with
  273. the sleep() is not nice too. Report bug if clish will
  274. get the SIGINT after non-interruptable action.
  275. */
  276. sigaction(SIGINT, &old_sigint, NULL);
  277. sigaction(SIGQUIT, &old_sigquit, NULL);
  278. }
  279. /* Call config callback */
  280. if ((BOOL_TRUE == result) && this->client_hooks->config_fn)
  281. this->client_hooks->config_fn(context);
  282. /* Unlock the lockfile */
  283. if (lock_fd != -1) {
  284. flock(lock_fd, LOCK_UN);
  285. close(lock_fd);
  286. }
  287. /* Move into the new view */
  288. if (BOOL_TRUE == result) {
  289. clish_view_t *view = clish_command__get_view(cmd);
  290. char *viewid = clish_command__get_viewid(cmd, context);
  291. if (view) {
  292. /* Save the current config PWD */
  293. char *line = clish_shell__get_line(cmd, pargv);
  294. clish_shell__set_pwd(this,
  295. clish_command__get_depth(cmd),
  296. line, this->view, this->viewid);
  297. lub_string_free(line);
  298. /* Change view */
  299. this->view = view;
  300. }
  301. if (viewid || view) {
  302. /* cleanup */
  303. lub_string_free(this->viewid);
  304. this->viewid = viewid;
  305. }
  306. }
  307. return result;
  308. }
  309. /*----------------------------------------------------------- */
  310. /*
  311. * Find out the previous view in the stack and go to it
  312. */
  313. static bool_t clish_nested_up(const clish_shell_t * shell, const lub_argv_t * argv)
  314. {
  315. clish_shell_t *this = (clish_shell_t *) shell;
  316. clish_view_t *view = NULL;
  317. char *viewid = NULL;
  318. int depth = 0;
  319. if (!shell)
  320. return BOOL_FALSE;
  321. argv = argv; /* not used */
  322. depth = clish_view__get_depth(this->view);
  323. /* If depth=0 than exit */
  324. if (0 == depth) {
  325. this->state = SHELL_STATE_CLOSING;
  326. return BOOL_TRUE;
  327. }
  328. depth--;
  329. view = clish_shell__get_pwd_view(this, depth);
  330. viewid = clish_shell__get_pwd_viewid(this, depth);
  331. if (!view)
  332. return BOOL_FALSE;
  333. this->view = view;
  334. lub_string_free(this->viewid);
  335. this->viewid = viewid ? lub_string_dup(viewid) : NULL;
  336. return BOOL_TRUE;
  337. }
  338. /*----------------------------------------------------------- */
  339. /*
  340. * Builtin: NOP function
  341. */
  342. static bool_t clish_nop(const clish_shell_t * shell, const lub_argv_t * argv)
  343. {
  344. return BOOL_TRUE;
  345. }
  346. /*----------------------------------------------------------- */
  347. const char * clish_shell__get_fifo(clish_shell_t * this)
  348. {
  349. char *name;
  350. int res;
  351. if (this->fifo_name) {
  352. if (0 == access(this->fifo_name, R_OK | W_OK))
  353. return this->fifo_name;
  354. unlink(this->fifo_name);
  355. lub_string_free(this->fifo_name);
  356. this->fifo_name = NULL;
  357. }
  358. do {
  359. char template[] = "/tmp/klish.fifo.XXXXXX";
  360. name = mktemp(template);
  361. if (name[0] == '\0')
  362. return NULL;
  363. res = mkfifo(name, 0600);
  364. if (res == 0)
  365. this->fifo_name = lub_string_dup(name);
  366. } while ((res < 0) && (EEXIST == errno));
  367. return this->fifo_name;
  368. }
  369. /*--------------------------------------------------------- */
  370. void *clish_shell__get_client_cookie(const clish_shell_t * this)
  371. {
  372. return this->client_cookie;
  373. }
  374. /*----------------------------------------------------------- */