shell_execute.c 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  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. /*
  16. * These are the internal commands for this framework.
  17. */
  18. static clish_shell_builtin_fn_t
  19. clish_close,
  20. clish_overview,
  21. clish_source,
  22. clish_source_nostop,
  23. clish_history,
  24. clish_nested_up;
  25. static clish_shell_builtin_t clish_cmd_list[] = {
  26. {"clish_close", clish_close},
  27. {"clish_overview", clish_overview},
  28. {"clish_source", clish_source},
  29. {"clish_source_nostop", clish_source_nostop},
  30. {"clish_history", clish_history},
  31. {"clish_nested_up", clish_nested_up},
  32. {NULL, NULL}
  33. };
  34. /*----------------------------------------------------------- */
  35. /*
  36. Terminate the current shell session
  37. */
  38. static bool_t clish_close(const clish_shell_t * shell, const lub_argv_t * argv)
  39. {
  40. /* the exception proves the rule... */
  41. clish_shell_t *this = (clish_shell_t *) shell;
  42. argv = argv; /* not used */
  43. this->state = SHELL_STATE_CLOSING;
  44. return BOOL_TRUE;
  45. }
  46. /*----------------------------------------------------------- */
  47. /*
  48. Open a file and interpret it as a script in the context of a new
  49. thread. Whether the script continues after command, but not script,
  50. errors depends on the value of the stop_on_error flag.
  51. */
  52. static bool_t
  53. 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. FILE *file;
  60. /* the exception proves the rule... */
  61. clish_shell_t *this = (clish_shell_t *) shell;
  62. /*
  63. * Check file specified is not a directory
  64. */
  65. if ((0 == stat((char *)filename, &fileStat)) &&
  66. (!S_ISDIR(fileStat.st_mode))) {
  67. /*
  68. * push this file onto the file stack associated with this
  69. * session. This will be closed by clish_shell_pop_file()
  70. * when it is finished with.
  71. */
  72. result = clish_shell_push_file(this, filename,
  73. stop_on_error);
  74. }
  75. return result;
  76. }
  77. /*----------------------------------------------------------- */
  78. /*
  79. Open a file and interpret it as a script in the context of a new
  80. thread. Invoking a script in this way will cause the script to
  81. stop on the first error
  82. */
  83. static bool_t clish_source(const clish_shell_t * shell, const lub_argv_t * argv)
  84. {
  85. return (clish_source_internal(shell, argv, BOOL_TRUE));
  86. }
  87. /*----------------------------------------------------------- */
  88. /*
  89. Open a file and interpret it as a script in the context of a new
  90. thread. Invoking a script in this way will cause the script to
  91. continue after command, but not script, errors.
  92. */
  93. static bool_t
  94. clish_source_nostop(const clish_shell_t * shell, const lub_argv_t * argv)
  95. {
  96. return (clish_source_internal(shell, argv, BOOL_FALSE));
  97. }
  98. /*----------------------------------------------------------- */
  99. /*
  100. Show the shell overview
  101. */
  102. static bool_t
  103. clish_overview(const clish_shell_t * this, const lub_argv_t * argv)
  104. {
  105. argv = argv; /* not used */
  106. tinyrl_printf(this->tinyrl, "%s\n", this->overview);
  107. return BOOL_TRUE;
  108. }
  109. /*----------------------------------------------------------- */
  110. static bool_t clish_history(const clish_shell_t * this, const lub_argv_t * argv)
  111. {
  112. tinyrl_history_t *history = tinyrl__get_history(this->tinyrl);
  113. tinyrl_history_iterator_t iter;
  114. const tinyrl_history_entry_t *entry;
  115. unsigned limit = 0;
  116. const char *arg = lub_argv__get_arg(argv, 0);
  117. if ((NULL != arg) && ('\0' != *arg)) {
  118. limit = (unsigned)atoi(arg);
  119. if (0 == limit) {
  120. /* unlimit the history list */
  121. (void)tinyrl_history_unstifle(history);
  122. } else {
  123. /* limit the scope of the history list */
  124. tinyrl_history_stifle(history, limit);
  125. }
  126. }
  127. for (entry = tinyrl_history_getfirst(history, &iter);
  128. entry; entry = tinyrl_history_getnext(&iter)) {
  129. /* dump the details of this entry */
  130. tinyrl_printf(this->tinyrl,
  131. "%5d %s\n",
  132. tinyrl_history_entry__get_index(entry),
  133. tinyrl_history_entry__get_line(entry));
  134. }
  135. return BOOL_TRUE;
  136. }
  137. /*----------------------------------------------------------- */
  138. /*
  139. * Searches for a builtin command to execute
  140. */
  141. static clish_shell_builtin_fn_t *find_builtin_callback(const
  142. clish_shell_builtin_t *
  143. cmd_list,
  144. const char *name)
  145. {
  146. const clish_shell_builtin_t *result;
  147. /* search a list of commands */
  148. for (result = cmd_list; result && result->name; result++) {
  149. if (0 == strcmp(name, result->name)) {
  150. break;
  151. }
  152. }
  153. return (result && result->name) ? result->callback : NULL;
  154. }
  155. /*----------------------------------------------------------- */
  156. void clish_shell_cleanup_script(void *script)
  157. {
  158. /* simply release the memory */
  159. lub_string_free(script);
  160. }
  161. /*----------------------------------------------------------- */
  162. bool_t
  163. clish_shell_execute(clish_shell_t * this,
  164. const clish_command_t * cmd, clish_pargv_t * pargv)
  165. {
  166. bool_t result = BOOL_TRUE;
  167. const char *builtin;
  168. char *script;
  169. char *lock_path = clish_shell__get_lockfile(this);
  170. int lock_fd = -1;
  171. assert(NULL != cmd);
  172. /* Pre-change view if the command is from another depth/view */
  173. {
  174. clish_view_t *view = NULL;
  175. char *viewid = NULL;
  176. clish_view_restore_t restore = clish_command__get_restore(cmd);
  177. if ((CLISH_RESTORE_VIEW == restore) &&
  178. (clish_command__get_pview(cmd) != this->view))
  179. view = clish_command__get_pview(cmd);
  180. else if ((CLISH_RESTORE_DEPTH == restore) &&
  181. (clish_command__get_depth(cmd) <
  182. clish_view__get_depth(this->view))) {
  183. view = clish_shell__get_pwd_view(this,
  184. clish_command__get_depth(cmd));
  185. viewid = clish_shell__get_pwd_viewid(this,
  186. clish_command__get_depth(cmd));
  187. }
  188. if (NULL != view) {
  189. this->view = view;
  190. /* cleanup */
  191. lub_string_free(this->viewid);
  192. this->viewid = lub_string_dup(viewid);
  193. }
  194. }
  195. /* Lock the lockfile */
  196. if (lock_path && clish_command__get_lock(cmd)) {
  197. int i;
  198. int res;
  199. lock_fd = open(lock_path, O_RDONLY | O_CREAT, 00644);
  200. if (-1 == lock_fd) {
  201. fprintf(stderr, "Can't open lockfile %s.\n",
  202. lock_path);
  203. return BOOL_FALSE; /* can't open file */
  204. }
  205. for (i = 0; i < CLISH_LOCK_WAIT; i++) {
  206. res = flock(lock_fd, LOCK_EX | LOCK_NB);
  207. if (!res)
  208. break;
  209. if ((EBADF == errno) ||
  210. (EINVAL == errno) ||
  211. (ENOLCK == errno))
  212. break;
  213. if (EINTR == errno)
  214. continue;
  215. if (0 == i)
  216. fprintf(stderr,
  217. "Try to get lock. Please wait...\n");
  218. sleep(1);
  219. }
  220. if (res) {
  221. fprintf(stderr, "Can't get lock.\n");
  222. return BOOL_FALSE; /* can't get the lock */
  223. }
  224. }
  225. /* Execute ACTION */
  226. builtin = clish_command__get_builtin(cmd);
  227. script = clish_command__get_action(cmd, this->viewid, pargv);
  228. /* account for thread cancellation whilst running a script */
  229. pthread_cleanup_push((void (*)(void *))clish_shell_cleanup_script,
  230. script);
  231. if (NULL != builtin) {
  232. clish_shell_builtin_fn_t *callback;
  233. lub_argv_t *argv = script ? lub_argv_new(script, 0) : NULL;
  234. result = BOOL_FALSE;
  235. /* search for an internal command */
  236. callback = find_builtin_callback(clish_cmd_list, builtin);
  237. if (NULL == callback) {
  238. /* search for a client command */
  239. callback =
  240. find_builtin_callback(this->client_hooks->cmd_list,
  241. builtin);
  242. }
  243. if (NULL != callback) {
  244. /* invoke the builtin callback */
  245. result = callback(this, argv);
  246. }
  247. if (NULL != argv) {
  248. lub_argv_delete(argv);
  249. }
  250. } else if (NULL != script) {
  251. /* now get the client to interpret the resulting script */
  252. result = this->client_hooks->script_fn(this, script);
  253. }
  254. pthread_cleanup_pop(1);
  255. /* Call config callback */
  256. if ((BOOL_TRUE == result) && this->client_hooks->config_fn)
  257. this->client_hooks->config_fn(this, cmd, pargv);
  258. /* Unlock the lockfile */
  259. if (lock_fd != -1) {
  260. flock(lock_fd, LOCK_UN);
  261. close(lock_fd);
  262. }
  263. /* Move into the new view */
  264. if (BOOL_TRUE == result) {
  265. clish_view_t *view = clish_command__get_view(cmd);
  266. char *viewid = clish_command__get_viewid(cmd,
  267. this->viewid, pargv);
  268. if (NULL != view) {
  269. /* Save the current config PWD */
  270. char *line = clish_variable__get_line(cmd, pargv);
  271. clish_shell__set_pwd(this,
  272. clish_command__get_depth(cmd),
  273. line, this->view, this->viewid);
  274. lub_string_free(line);
  275. /* Change view */
  276. this->view = view;
  277. }
  278. if (viewid || view) {
  279. /* cleanup */
  280. lub_string_free(this->viewid);
  281. this->viewid = viewid;
  282. }
  283. }
  284. return result;
  285. }
  286. /*----------------------------------------------------------- */
  287. /*
  288. * Find out the previous view in the stack and go to it
  289. */
  290. static bool_t clish_nested_up(const clish_shell_t * shell, const lub_argv_t * argv)
  291. {
  292. clish_shell_t *this = (clish_shell_t *) shell;
  293. clish_view_t *view = NULL;
  294. char *viewid = NULL;
  295. int depth = 0;
  296. if (!shell)
  297. return BOOL_FALSE;
  298. argv = argv; /* not used */
  299. depth = clish_view__get_depth(this->view);
  300. /* If depth=0 than exit */
  301. if (0 == depth) {
  302. this->state = SHELL_STATE_CLOSING;
  303. return BOOL_TRUE;
  304. }
  305. depth--;
  306. view = clish_shell__get_pwd_view(this, depth);
  307. viewid = clish_shell__get_pwd_viewid(this, depth);
  308. if (!view)
  309. return BOOL_FALSE;
  310. this->view = view;
  311. lub_string_free(this->viewid);
  312. this->viewid = viewid ? lub_string_dup(viewid) : NULL;
  313. return BOOL_TRUE;
  314. }
  315. /*----------------------------------------------------------- */