1
0

shell.h 14 KB

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