shell_execute.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  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 int clish_close(clish_context_t *context, const lub_argv_t * argv)
  40. {
  41. /* the exception proves the rule... */
  42. clish_shell_t *this = (clish_shell_t *)context->shell;
  43. argv = argv; /* not used */
  44. this->state = SHELL_STATE_CLOSING;
  45. return 0;
  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 int clish_source_internal(clish_context_t *context,
  54. const lub_argv_t * argv, bool_t stop_on_error)
  55. {
  56. int result = -1;
  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 *)context->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 ? -1 : 0;
  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 int clish_source(clish_context_t *context, const lub_argv_t * argv)
  83. {
  84. return (clish_source_internal(context, 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 int clish_source_nostop(clish_context_t *context, const lub_argv_t * argv)
  93. {
  94. return (clish_source_internal(context, argv, BOOL_FALSE));
  95. }
  96. /*----------------------------------------------------------- */
  97. /*
  98. Show the shell overview
  99. */
  100. static int clish_overview(clish_context_t *context, const lub_argv_t * argv)
  101. {
  102. clish_shell_t *this = context->shell;
  103. argv = argv; /* not used */
  104. tinyrl_printf(this->tinyrl, "%s\n", context->shell->overview);
  105. return 0;
  106. }
  107. /*----------------------------------------------------------- */
  108. static int clish_history(clish_context_t *context, const lub_argv_t * argv)
  109. {
  110. clish_shell_t *this = context->shell;
  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 0;
  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. int 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_action_t *action;
  163. int result = 0;
  164. char *lock_path = clish_shell__get_lockfile(this);
  165. int lock_fd = -1;
  166. sigset_t old_sigs;
  167. struct sigaction old_sigint, old_sigquit;
  168. clish_view_t *cur_view = clish_shell__get_view(this);
  169. assert(cmd);
  170. action = clish_command__get_action(cmd);
  171. /* Pre-change view if the command is from another depth/view */
  172. {
  173. clish_view_restore_t restore = clish_command__get_restore(cmd);
  174. if ((CLISH_RESTORE_VIEW == restore) &&
  175. (clish_command__get_pview(cmd) != cur_view)) {
  176. clish_view_t *view = clish_command__get_pview(cmd);
  177. clish_shell__set_pwd(this, NULL, view, NULL, context);
  178. } else if ((CLISH_RESTORE_DEPTH == restore) &&
  179. (clish_command__get_depth(cmd) < this->depth)) {
  180. this->depth = clish_command__get_depth(cmd);
  181. }
  182. }
  183. /* Lock the lockfile */
  184. if (lock_path && clish_command__get_lock(cmd)) {
  185. int i;
  186. int res;
  187. lock_fd = open(lock_path, O_RDONLY | O_CREAT, 00644);
  188. if (-1 == lock_fd) {
  189. fprintf(stderr, "Can't open lockfile %s.\n",
  190. lock_path);
  191. result = -1;
  192. goto error; /* can't open file */
  193. }
  194. for (i = 0; i < CLISH_LOCK_WAIT; i++) {
  195. res = flock(lock_fd, LOCK_EX | LOCK_NB);
  196. if (!res)
  197. break;
  198. if ((EBADF == errno) ||
  199. (EINVAL == errno) ||
  200. (ENOLCK == errno))
  201. break;
  202. if (EINTR == errno)
  203. continue;
  204. if (0 == i)
  205. fprintf(stderr,
  206. "Try to get lock. Please wait...\n");
  207. sleep(1);
  208. }
  209. if (res) {
  210. fprintf(stderr, "Can't get lock.\n");
  211. result = -1;
  212. goto error; /* can't get the lock */
  213. }
  214. }
  215. /* Ignore and block SIGINT and SIGQUIT */
  216. if (!clish_command__get_interrupt(cmd)) {
  217. struct sigaction sa;
  218. sigset_t sigs;
  219. sa.sa_flags = 0;
  220. sigemptyset(&sa.sa_mask);
  221. sa.sa_handler = SIG_IGN;
  222. sigaction(SIGINT, &sa, &old_sigint);
  223. sigaction(SIGQUIT, &sa, &old_sigquit);
  224. sigemptyset(&sigs);
  225. sigaddset(&sigs, SIGINT);
  226. sigaddset(&sigs, SIGQUIT);
  227. sigprocmask(SIG_BLOCK, &sigs, &old_sigs);
  228. }
  229. /* Execute ACTION */
  230. result = clish_shell_exec_action(action, context, out);
  231. /* Restore SIGINT and SIGQUIT */
  232. if (!clish_command__get_interrupt(cmd)) {
  233. sigprocmask(SIG_SETMASK, &old_sigs, NULL);
  234. /* Is the signals delivery guaranteed here (before
  235. sigaction restore) for previously blocked and
  236. pending signals? The simple test is working well.
  237. I don't want to use sigtimedwait() function bacause
  238. it needs a realtime extensions. The sigpending() with
  239. the sleep() is not nice too. Report bug if clish will
  240. get the SIGINT after non-interruptable action.
  241. */
  242. sigaction(SIGINT, &old_sigint, NULL);
  243. sigaction(SIGQUIT, &old_sigquit, NULL);
  244. }
  245. /* Call config callback */
  246. if (!result && this->client_hooks->config_fn)
  247. this->client_hooks->config_fn(context);
  248. /* Call logging callback */
  249. if (clish_shell__get_log(this) && this->client_hooks->log_fn) {
  250. char *full_line = clish_shell__get_full_line(context);
  251. this->client_hooks->log_fn(context, full_line, result);
  252. lub_string_free(full_line);
  253. }
  254. /* Unlock the lockfile */
  255. if (lock_fd != -1) {
  256. flock(lock_fd, LOCK_UN);
  257. close(lock_fd);
  258. }
  259. /* Move into the new view */
  260. if (!result) {
  261. clish_view_t *view = clish_command__get_view(cmd);
  262. /* Save the PWD */
  263. if (view) {
  264. char *line = clish_shell__get_line(context);
  265. clish_shell__set_pwd(this, line, view,
  266. clish_command__get_viewid(cmd), context);
  267. lub_string_free(line);
  268. }
  269. }
  270. error:
  271. return result;
  272. }
  273. /*----------------------------------------------------------- */
  274. int clish_shell_exec_action(clish_action_t *action,
  275. clish_context_t *context, char **out)
  276. {
  277. clish_shell_t *this = context->shell;
  278. int result = 0;
  279. const char *builtin;
  280. char *script;
  281. builtin = clish_action__get_builtin(action);
  282. script = clish_shell_expand(clish_action__get_script(action), SHELL_VAR_ACTION, context);
  283. if (builtin) {
  284. clish_shell_builtin_fn_t *callback;
  285. lub_argv_t *argv = script ? lub_argv_new(script, 0) : NULL;
  286. result = -1;
  287. /* search for an internal command */
  288. callback = find_builtin_callback(clish_cmd_list, builtin);
  289. if (!callback) {
  290. /* search for a client command */
  291. callback = find_builtin_callback(
  292. this->client_hooks->cmd_list, builtin);
  293. }
  294. /* invoke the builtin callback */
  295. if (callback)
  296. result = callback(context, argv);
  297. if (argv)
  298. lub_argv_delete(argv);
  299. } else if (script) {
  300. /* now get the client to interpret the resulting script */
  301. result = this->client_hooks->script_fn(context, script, out);
  302. }
  303. lub_string_free(script);
  304. return result;
  305. }
  306. /*----------------------------------------------------------- */
  307. /*
  308. * Find out the previous view in the stack and go to it
  309. */
  310. static int clish_nested_up(clish_context_t *context, const lub_argv_t * argv)
  311. {
  312. clish_shell_t *this = context->shell;
  313. if (!this)
  314. return -1;
  315. argv = argv; /* not used */
  316. /* If depth=0 than exit */
  317. if (0 == this->depth) {
  318. this->state = SHELL_STATE_CLOSING;
  319. return 0;
  320. }
  321. this->depth--;
  322. return 0;
  323. }
  324. /*----------------------------------------------------------- */
  325. /*
  326. * Builtin: NOP function
  327. */
  328. static int clish_nop(clish_context_t *context, const lub_argv_t * argv)
  329. {
  330. return 0;
  331. }
  332. /*----------------------------------------------------------- */
  333. const char *clish_shell__get_fifo(clish_shell_t * this)
  334. {
  335. char *name;
  336. int res;
  337. if (this->fifo_name) {
  338. if (0 == access(this->fifo_name, R_OK | W_OK))
  339. return this->fifo_name;
  340. unlink(this->fifo_name);
  341. lub_string_free(this->fifo_name);
  342. this->fifo_name = NULL;
  343. }
  344. do {
  345. char template[] = "/tmp/klish.fifo.XXXXXX";
  346. name = mktemp(template);
  347. if (name[0] == '\0')
  348. return NULL;
  349. res = mkfifo(name, 0600);
  350. if (res == 0)
  351. this->fifo_name = lub_string_dup(name);
  352. } while ((res < 0) && (EEXIST == errno));
  353. return this->fifo_name;
  354. }
  355. /*--------------------------------------------------------- */
  356. void *clish_shell__get_client_cookie(const clish_shell_t * this)
  357. {
  358. return this->client_cookie;
  359. }
  360. /*-------------------------------------------------------- */
  361. void clish_shell__set_log(clish_shell_t *this, bool_t log)
  362. {
  363. assert(this);
  364. this->log = log;
  365. }
  366. /*-------------------------------------------------------- */
  367. bool_t clish_shell__get_log(const clish_shell_t *this)
  368. {
  369. assert(this);
  370. return this->log;
  371. }
  372. /*----------------------------------------------------------- */