shell.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  1. /*
  2. * shell.h
  3. */
  4. /**
  5. \ingroup clish
  6. \defgroup clish_shell shell
  7. @{
  8. \brief This class represents the top level container for a CLI session.
  9. */
  10. #ifndef _clish_shell_h
  11. #define _clish_shell_h
  12. #include <stdio.h>
  13. #include "lub/c_decl.h"
  14. #include "lub/types.h"
  15. #include "lub/argv.h"
  16. #include "tinyrl/tinyrl.h"
  17. #include "clish/view.h"
  18. #include "clish/ptype.h"
  19. #include "clish/var.h"
  20. #include "konf/net.h"
  21. #define CLISH_LOCK_PATH "/tmp/clish.lock"
  22. #define CLISH_LOCK_WAIT 20
  23. typedef struct clish_shell_s clish_shell_t;
  24. /* This is used to hold context during callbacks */
  25. struct clish_context_s {
  26. clish_shell_t *shell;
  27. const clish_command_t *cmd;
  28. clish_pargv_t *pargv;
  29. };
  30. typedef struct clish_context_s clish_context_t;
  31. typedef enum {
  32. SHELL_STATE_OK = 0,
  33. SHELL_STATE_UNKNOWN = 1,
  34. SHELL_STATE_IO_ERROR = 2,
  35. SHELL_STATE_SCRIPT_ERROR = 3,/* Script execution error */
  36. SHELL_STATE_SYNTAX_ERROR = 4, /* Illegal line entered */
  37. SHELL_STATE_SYSTEM_ERROR = 5, /* Some internal system error */
  38. SHELL_STATE_INITIALISING = 6,
  39. SHELL_STATE_HELPING = 7,
  40. SHELL_STATE_EOF = 8, /* EOF of input stream */
  41. SHELL_STATE_CLOSING = 9
  42. } clish_shell_state_t;
  43. typedef enum {
  44. SHELL_VAR_NONE, /* Nothing to escape */
  45. SHELL_VAR_ACTION, /* Variable expanding for ACTION script */
  46. SHELL_VAR_REGEX /* Variable expanding for regex usage */
  47. } clish_shell_var_t;
  48. _BEGIN_C_DECL
  49. /*=====================================
  50. * SHELL INTERFACE
  51. *===================================== */
  52. /**
  53. * A hook function used during the spawning of a new shell.
  54. *
  55. * This will be invoked from the context of the spawned shell's thread
  56. * and will be invoked just after the shell instance is created.
  57. *
  58. * This enables the client-specific initialisation of the spawned shell's
  59. * thread
  60. * e.g. to map the I/O streams, authenticate a user.
  61. *
  62. * N.B. It is possible for a client to have this invoked multiple times
  63. * if the user is spawning new shells using a commmand which uses the
  64. * "clish_spawn" builtin function. Hence the client should remember the
  65. * shell which first calls this function, and only assign resource (e.g.
  66. * setting up a script interpreter) for that call.
  67. *
  68. * \return
  69. * - BOOL_TRUE if everything is OK
  70. * - BOOL_FALSE if the shell should be immediately shut down.
  71. *
  72. */
  73. typedef bool_t clish_shell_init_fn_t(
  74. /**
  75. * The shell instance which invoked this call
  76. */
  77. const clish_shell_t * shell);
  78. /**
  79. * A hook function used during the shutting down of a spawned shell
  80. *
  81. * This will be invoked from the context of the spawned shell's thread
  82. * and will be invoked just before the shell is destroyed.
  83. *
  84. * This enables the client-specific finalisation to occur.
  85. * e.g. releasing any resource held by the cookie,
  86. * shutting down telnet connections
  87. *
  88. * NB. This function may be called multiple times if a user is spawning
  89. * new commands (via the "clish_spawn" builtin command), hence should use
  90. * the reference to the root shell (remembered by the first call to clish_shell_init_fn_t callback)
  91. * to signal when the cleanup should occur.
  92. */
  93. typedef void clish_shell_fini_fn_t(
  94. /**
  95. * The shell instance which invoked this call
  96. */
  97. const clish_shell_t * shell);
  98. /**
  99. * A hook function used to indicate a command line has been executed and the
  100. * shell is about to prompt for the next command.
  101. *
  102. * This will be invoked from the context of the spawned shell's thread
  103. * and will be called once an ACTION has been performed.
  104. *
  105. * A client may use this as a periodic indicator of CLI activity,
  106. * e.g. to manage session timeouts. In addition any required logging of
  107. * commands may be performed.
  108. */
  109. typedef void clish_shell_cmd_line_fn_t(
  110. /**
  111. * The shell instance which invoked this call
  112. */
  113. clish_context_t *context,
  114. /**
  115. * The text of the command line entered
  116. */
  117. const char *cmd_line);
  118. /**
  119. * A hook function used to invoke the script associated with a command
  120. *
  121. * This will be invoked from the context of the spawned shell's thread
  122. * and will be invoked with the ACTION script which is to be performed.
  123. *
  124. * The clish component will only pass down a call when a command has been
  125. * correctly input.
  126. *
  127. * The client may choose to implement invocation of the script in a number of
  128. * ways, which may include forking a sub-process or thread. It is important
  129. * that the call doesn't return until the script has been fully evaluated.
  130. *
  131. * \return
  132. * - Retval (int)
  133. *
  134. * \post
  135. * - If the script executes successfully then any "view" tag associated with the
  136. * command will be honored. i.e. the CLI will switch to the new view
  137. */
  138. typedef int clish_shell_script_fn_t(
  139. clish_context_t *context,
  140. clish_action_t *action,
  141. const char *script,
  142. char **out);
  143. /**
  144. * A hook function used to control config file write
  145. *
  146. */
  147. typedef bool_t clish_shell_config_fn_t(
  148. clish_context_t *context);
  149. /**
  150. * A hook function used to control access for the current user.
  151. *
  152. * This will be invoked from the context of the spawned shell's thread
  153. * and will be called during the parsing of the XML files.
  154. *
  155. * The clish component will only insert a command into a view if the access
  156. * call is sucessfull.
  157. *
  158. * The client may choose to implement invocation of the script in a number of
  159. * ways, which may include forking a sub-process or thread. It is important
  160. * that the call doesn't return until the script has been fully evaluated.
  161. *
  162. * \return
  163. * - BOOL_TRUE - if the user of the current CLISH session is permitted access
  164. * - BOOL_FALSE - if the user of the current CLISH session is not permitted access
  165. *
  166. * \post
  167. * - If access is granted then the associated command will be inserted into the
  168. * appropriate view.
  169. */
  170. typedef bool_t clish_shell_access_fn_t(
  171. /**
  172. * The shell instance which invoked this call
  173. */
  174. const clish_shell_t * instance,
  175. /**
  176. * A textual string which describes a limitation for a command. This
  177. * string typically may be the name of a user group, of which the
  178. * current user must be a member to grant access to a command.
  179. */
  180. const char *access);
  181. typedef int clish_shell_log_fn_t(
  182. clish_context_t *context,
  183. const char *line, int retcode);
  184. /**
  185. * A hook function used as a built in command callback
  186. *
  187. * This will be invoked from the context of the spawned shell's thread
  188. * and will be called during the execution of a builting command.
  189. *
  190. * A client may register any number of these callbacks in its
  191. * clish_shell_builtin_cmds_t structure.
  192. *
  193. * \return
  194. * - Retval (int)
  195. *
  196. */
  197. typedef int clish_shell_builtin_fn_t(
  198. /**
  199. * The shell instance which invoked this call
  200. */
  201. clish_context_t *context,
  202. /**
  203. * A vector of textual command line arguments.
  204. */
  205. const lub_argv_t * argv);
  206. /**
  207. * A client of libclish may provide some builtin commands which will be
  208. * interpreted by the framework, instead of the client's script engine.
  209. */
  210. typedef struct {
  211. const char *name; /**< The textual name to be used in
  212. * the 'builtin' XML attribute"
  213. */
  214. clish_shell_builtin_fn_t *callback;
  215. /**< The function to be invoked */
  216. } clish_shell_builtin_t;
  217. /**
  218. * A client of libclish will provide hooks for the control of the CLI within
  219. * a particular system.
  220. * They will populate an instance of this structure and pass it into the
  221. */
  222. typedef struct {
  223. clish_shell_init_fn_t *init_fn; /* Initialisation call */
  224. clish_shell_access_fn_t *access_fn; /* Access control call */
  225. clish_shell_cmd_line_fn_t *cmd_line_fn; /* Command line logging call */
  226. clish_shell_script_fn_t *script_fn; /* script evaluation call */
  227. clish_shell_fini_fn_t *fini_fn; /* Finalisation call */
  228. clish_shell_config_fn_t *config_fn; /* Config call */
  229. clish_shell_log_fn_t *log_fn; /* Logging call */
  230. const clish_shell_builtin_t *cmd_list; /* NULL terminated list */
  231. } clish_shell_hooks_t;
  232. /*-----------------
  233. * meta functions
  234. *----------------- */
  235. clish_shell_t *clish_shell_new(const clish_shell_hooks_t * hooks,
  236. void *cookie,
  237. FILE * istream,
  238. FILE * ostream,
  239. bool_t stop_on_error);
  240. /*-----------------
  241. * methods
  242. *----------------- */
  243. /*
  244. * Called to invoke the startup command for this shell
  245. */
  246. int clish_shell_startup(clish_shell_t * instance);
  247. void clish_shell_delete(clish_shell_t * instance);
  248. clish_view_t *clish_shell_find_create_view(clish_shell_t * instance,
  249. const char *name,
  250. const char *prompt);
  251. clish_ptype_t *clish_shell_find_create_ptype(clish_shell_t * instance,
  252. const char *name,
  253. const char *text,
  254. const char *pattern,
  255. clish_ptype_method_e method,
  256. clish_ptype_preprocess_e preprocess);
  257. clish_ptype_t *clish_shell_find_ptype(clish_shell_t *instance,
  258. const char *name);
  259. int clish_shell_xml_read(clish_shell_t * instance, const char *filename);
  260. void clish_shell_help(clish_shell_t * instance, const char *line);
  261. int clish_shell_exec_action(clish_action_t *action,
  262. clish_context_t *context, char **out);
  263. int clish_shell_execute(clish_context_t *context, char **out);
  264. int clish_shell_forceline(clish_shell_t *instance, const char *line, char ** out);
  265. int clish_shell_readline(clish_shell_t *instance, char ** out);
  266. void clish_shell_dump(clish_shell_t * instance);
  267. void clish_shell_close(clish_shell_t * instance);
  268. /**
  269. * Push the specified file handle on to the stack of file handles
  270. * for this shell. The specified file will become the source of
  271. * commands, until it is exhausted.
  272. *
  273. * \return
  274. * BOOL_TRUE - the file was successfully associated with the shell.
  275. * BOOL_FALSE - there was insufficient resource to associate this file.
  276. */
  277. int clish_shell_push_file(clish_shell_t * instance, const char * fname,
  278. bool_t stop_on_error);
  279. int clish_shell_push_fd(clish_shell_t * instance, FILE * file,
  280. bool_t stop_on_error);
  281. void clish_shell_insert_var(clish_shell_t *instance, clish_var_t *var);
  282. clish_var_t *clish_shell_find_var(clish_shell_t *instance, const char *name);
  283. char *clish_shell_expand_var(const char *name, clish_context_t *context);
  284. char *clish_shell_expand(const char *str, clish_shell_var_t vtype, clish_context_t *context);
  285. /*-----------------
  286. * attributes
  287. *----------------- */
  288. clish_view_t *clish_shell__get_view(const clish_shell_t * instance);
  289. unsigned clish_shell__get_depth(const clish_shell_t * instance);
  290. const char *clish_shell__get_viewid(const clish_shell_t * instance);
  291. const char *clish_shell__get_overview(const clish_shell_t * instance);
  292. tinyrl_t *clish_shell__get_tinyrl(const clish_shell_t * instance);
  293. void *clish_shell__get_client_cookie(const clish_shell_t * instance);
  294. void
  295. clish_shell__set_pwd(clish_shell_t *instance, const char * line,
  296. clish_view_t * view, char * viewid, clish_context_t *context);
  297. char *clish_shell__get_pwd_line(const clish_shell_t * instance,
  298. unsigned int index);
  299. char *clish_shell__get_pwd_full(const clish_shell_t * instance, unsigned depth);
  300. clish_view_t *clish_shell__get_pwd_view(const clish_shell_t * instance,
  301. unsigned int index);
  302. konf_client_t *clish_shell__get_client(const clish_shell_t * instance);
  303. FILE *clish_shell__get_istream(const clish_shell_t * instance);
  304. FILE *clish_shell__get_ostream(const clish_shell_t * instance);
  305. void clish_shell__set_lockfile(clish_shell_t * instance, const char * path);
  306. char * clish_shell__get_lockfile(clish_shell_t * instance);
  307. int clish_shell__set_socket(clish_shell_t * instance, const char * path);
  308. void clish_shell_load_scheme(clish_shell_t * instance, const char * xml_path);
  309. int clish_shell_loop(clish_shell_t * instance);
  310. clish_shell_state_t clish_shell__get_state(const clish_shell_t * instance);
  311. void clish_shell__set_state(clish_shell_t * instance,
  312. clish_shell_state_t state);
  313. void clish_shell__set_startup_view(clish_shell_t * instance, const char * viewname);
  314. void clish_shell__set_startup_viewid(clish_shell_t * instance, const char * viewid);
  315. void clish_shell__set_default_shebang(clish_shell_t * instance, const char * shebang);
  316. const char * clish_shell__get_default_shebang(const clish_shell_t * instance);
  317. const char * clish_shell__get_fifo(clish_shell_t * instance);
  318. void clish_shell__set_interactive(clish_shell_t * instance, bool_t interactive);
  319. bool_t clish_shell__get_interactive(const clish_shell_t * instance);
  320. bool_t clish_shell__get_utf8(const clish_shell_t * instance);
  321. void clish_shell__set_utf8(clish_shell_t * instance, bool_t utf8);
  322. void clish_shell__set_timeout(clish_shell_t *instance, int timeout);
  323. char *clish_shell__get_line(clish_context_t *context);
  324. char *clish_shell__get_full_line(clish_context_t *context);
  325. char *clish_shell__get_params(clish_context_t *context);
  326. void clish_shell__set_log(clish_shell_t *instance, bool_t log);
  327. bool_t clish_shell__get_log(const clish_shell_t *instance);
  328. int clish_shell_wdog(clish_shell_t *instance);
  329. void clish_shell__set_wdog_timeout(clish_shell_t *instance,
  330. unsigned int timeout);
  331. unsigned int clish_shell__get_wdog_timeout(const clish_shell_t *instance);
  332. int clish_shell__save_history(const clish_shell_t *instance, const char *fname);
  333. int clish_shell__restore_history(clish_shell_t *instance, const char *fname);
  334. void clish_shell__stifle_history(clish_shell_t *instance, unsigned int stifle);
  335. _END_C_DECL
  336. #endif /* _clish_shell_h */
  337. /** @} clish_shell */