shell.h 14 KB

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