ksession_parse.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880
  1. /** @file ksession_parse.c
  2. */
  3. #include <assert.h>
  4. #include <stdio.h>
  5. #include <stdlib.h>
  6. #include <string.h>
  7. #include <signal.h>
  8. #include <sys/types.h>
  9. #include <sys/wait.h>
  10. #include <unistd.h>
  11. #include <syslog.h>
  12. #include <faux/eloop.h>
  13. #include <faux/buf.h>
  14. #include <faux/list.h>
  15. #include <faux/argv.h>
  16. #include <faux/error.h>
  17. #include <klish/khelper.h>
  18. #include <klish/kscheme.h>
  19. #include <klish/kpath.h>
  20. #include <klish/kpargv.h>
  21. #include <klish/kexec.h>
  22. #include <klish/ksession.h>
  23. #include <klish/ksession_parse.h>
  24. #define ARGV_ALT_QUOTES "'"
  25. static bool_t ksession_validate_arg(ksession_t *session, kpargv_t *pargv)
  26. {
  27. char *out = NULL;
  28. int retcode = -1;
  29. const kentry_t *ptype_entry = NULL;
  30. kparg_t *candidate = NULL;
  31. assert(session);
  32. if (!session)
  33. return BOOL_FALSE;
  34. assert(pargv);
  35. if (!pargv)
  36. return BOOL_FALSE;
  37. candidate = kpargv_candidate_parg(pargv);
  38. if (!candidate)
  39. return BOOL_FALSE;
  40. ptype_entry = kentry_nested_by_purpose(kparg_entry(candidate),
  41. KENTRY_PURPOSE_PTYPE);
  42. if (!ptype_entry)
  43. return BOOL_FALSE;
  44. if (!ksession_exec_locally(session, ptype_entry, pargv, NULL, NULL,
  45. &retcode, &out)) {
  46. return BOOL_FALSE;
  47. }
  48. if (retcode != 0)
  49. return BOOL_FALSE;
  50. if (!faux_str_is_empty(out))
  51. kparg_set_value(candidate, out);
  52. return BOOL_TRUE;
  53. }
  54. static kpargv_status_e ksession_parse_arg(ksession_t *session,
  55. const kentry_t *current_entry, faux_argv_node_t **argv_iter,
  56. kpargv_t *pargv, bool_t entry_is_command, bool_t is_filter)
  57. {
  58. const kentry_t *entry = current_entry;
  59. kentry_mode_e mode = KENTRY_MODE_NONE;
  60. kpargv_status_e retcode = KPARSE_NONE; // For ENTRY itself
  61. kpargv_status_e rc = KPARSE_NONE; // For nested ENTRYs
  62. kpargv_purpose_e purpose = KPURPOSE_NONE;
  63. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  64. //fprintf(stderr, "PARSE: name=%s, arg=%s, pargs=%d\n",
  65. //kentry_name(entry), faux_argv_current(*argv_iter),
  66. //kpargv_pargs_len(pargv));
  67. assert(current_entry);
  68. if (!current_entry)
  69. return KPARSE_ERROR;
  70. assert(argv_iter);
  71. if (!argv_iter)
  72. return KPARSE_ERROR;
  73. assert(pargv);
  74. if (!pargv)
  75. return KPARSE_ERROR;
  76. purpose = kpargv_purpose(pargv); // Purpose of parsing
  77. // If we know the entry is a command then don't validate it. This
  78. // behaviour is usefull for special purpose entries like PTYPEs, CONDs,
  79. // etc. These entries are the starting point for parsing their args.
  80. // We don't need to parse command itself. Command is predefined.
  81. if (entry_is_command) {
  82. kparg_t *parg = NULL;
  83. // Command is an ENTRY with ACTIONs
  84. if (kentry_actions_len(entry) <= 0)
  85. return KPARSE_ERROR;
  86. parg = kparg_new(entry, NULL);
  87. kpargv_add_pargs(pargv, parg);
  88. kpargv_set_command(pargv, entry);
  89. retcode = KPARSE_OK;
  90. // Is entry candidate to resolve current arg?
  91. // Container can't be a candidate.
  92. } else if (!kentry_container(entry)) {
  93. const char *current_arg = NULL;
  94. kparg_t *parg = NULL;
  95. kentry_filter_e filter_flag = kentry_filter(entry);
  96. // When purpose is COMPLETION or HELP then fill completion list.
  97. // Additionally if it's last continuable argument then lie to
  98. // engine: make all last arguments NOTFOUND. It's necessary to walk
  99. // through all variants to gather all completions.
  100. // is_filter: When it's a filter then all non-first entries can be
  101. // filters or non-filters
  102. if (((KPURPOSE_COMPLETION == purpose) ||
  103. (KPURPOSE_HELP == purpose)) &&
  104. ((filter_flag == KENTRY_FILTER_DUAL) ||
  105. (is_filter && (filter_flag == KENTRY_FILTER_TRUE)) ||
  106. (!is_filter && (filter_flag == KENTRY_FILTER_FALSE)) ||
  107. (is_filter && kpargv_pargs_len(pargv)))) {
  108. if (!*argv_iter) {
  109. // That's time to add entry to completions list.
  110. if (!kpargv_continuable(pargv))
  111. kpargv_add_completions(pargv, entry);
  112. return KPARSE_NOTFOUND;
  113. // Add entry to completions if it's last incompleted arg.
  114. } else if (faux_argv_is_last(*argv_iter) &&
  115. kpargv_continuable(pargv)) {
  116. kpargv_add_completions(pargv, entry);
  117. return KPARSE_NOTFOUND;
  118. }
  119. }
  120. // If all arguments are resolved already then return INCOMPLETED
  121. if (!*argv_iter)
  122. return KPARSE_NOTFOUND;
  123. // Validate argument
  124. current_arg = faux_argv_current(*argv_iter);
  125. parg = kparg_new(entry, current_arg);
  126. kpargv_set_candidate_parg(pargv, parg);
  127. if (ksession_validate_arg(session, pargv)) {
  128. kpargv_accept_candidate_parg(pargv);
  129. // Command is an ENTRY with ACTIONs or NAVigation
  130. if (kentry_actions_len(entry) > 0)
  131. kpargv_set_command(pargv, entry);
  132. faux_argv_each(argv_iter); // Next argument
  133. retcode = KPARSE_OK;
  134. } else {
  135. // It's not a container and is not validated so
  136. // no chance to find anything here.
  137. kpargv_decline_candidate_parg(pargv);
  138. kparg_free(parg);
  139. return KPARSE_NOTFOUND;
  140. }
  141. }
  142. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  143. //fprintf(stderr, "ITSELF: name=%s, retcode=%s\n",
  144. //kentry_name(entry), kpargv_status_decode(retcode));
  145. // It's not container and suitable entry is not found
  146. if (retcode == KPARSE_NOTFOUND)
  147. return retcode;
  148. // ENTRY has no nested ENTRYs so return
  149. if (kentry_entrys_is_empty(entry))
  150. return retcode;
  151. // EMPTY mode
  152. mode = kentry_mode(entry);
  153. if (KENTRY_MODE_EMPTY == mode)
  154. return retcode;
  155. // SWITCH mode
  156. // Entries within SWITCH can't has 'min'/'max' else than 1.
  157. // So these attributes will be ignored. Note SWITCH itself can have
  158. // 'min'/'max'.
  159. if (KENTRY_MODE_SWITCH == mode) {
  160. kentry_entrys_node_t *iter = kentry_entrys_iter(entry);
  161. const kentry_t *nested = NULL;
  162. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  163. //fprintf(stderr, "SWITCH: name=%s, arg %s\n", kentry_name(entry),
  164. //*argv_iter ? faux_argv_current(*argv_iter) : "<empty>");
  165. while ((nested = kentry_entrys_each(&iter))) {
  166. kpargv_status_e res = KPARSE_NONE;
  167. // Ignore entries with non-COMMON purpose.
  168. if (kentry_purpose(nested) != KENTRY_PURPOSE_COMMON)
  169. continue;
  170. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  171. //fprintf(stderr, "SWITCH-nested name=%s, nested=%s\n",
  172. //kentry_name(entry), kentry_name(nested));
  173. res = ksession_parse_arg(session, nested, argv_iter,
  174. pargv, BOOL_FALSE, is_filter);
  175. if (res == KPARSE_NONE)
  176. rc = KPARSE_NOTFOUND;
  177. else
  178. rc = res;
  179. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  180. //fprintf(stderr, "SWITCH-nested-answer: name=%s, nested=%s, res=%s\n",
  181. //kentry_name(entry), kentry_name(nested), kpargv_status_decode(res));
  182. // Save choosen entry name to container's value
  183. if ((res == KPARSE_OK) && kentry_container(entry)) {
  184. kparg_t *parg = kparg_new(entry, kentry_name(nested));
  185. kpargv_add_pargs(pargv, parg);
  186. }
  187. // Try next entries if current status is NOTFOUND or NONE
  188. if ((res == KPARSE_OK) || (res == KPARSE_ERROR))
  189. break;
  190. }
  191. // SEQUENCE mode
  192. } else if (KENTRY_MODE_SEQUENCE == mode) {
  193. kentry_entrys_node_t *iter = kentry_entrys_iter(entry);
  194. kentry_entrys_node_t *saved_iter = iter;
  195. const kentry_t *nested = NULL;
  196. kpargv_t *cur_level_pargv = kpargv_new();
  197. while ((nested = kentry_entrys_each(&iter))) {
  198. kpargv_status_e res = KPARSE_NONE;
  199. size_t num = 0;
  200. size_t min = kentry_min(nested);
  201. bool_t break_loop = BOOL_FALSE;
  202. bool_t consumed = BOOL_FALSE;
  203. // Ignore entries with non-COMMON purpose.
  204. if (kentry_purpose(nested) != KENTRY_PURPOSE_COMMON)
  205. continue;
  206. // Filter out double parsing for optional entries.
  207. if (kpargv_entry_exists(cur_level_pargv, nested))
  208. continue;
  209. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  210. //fprintf(stderr, "SEQ name=%s, arg=%s\n",
  211. //kentry_name(entry), *argv_iter ? faux_argv_current(*argv_iter) : "<empty>");
  212. // Try to match argument and current entry
  213. // (from 'min' to 'max' times)
  214. for (num = 0; num < kentry_max(nested); num++) {
  215. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  216. //fprintf(stderr, "SEQ-nested: name=%s, nested=%s\n",
  217. //kentry_name(entry), kentry_name(nested));
  218. res = ksession_parse_arg(session, nested,
  219. argv_iter, pargv, BOOL_FALSE, is_filter);
  220. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  221. //fprintf(stderr, "SEQ-nested-answer: name=%s, nested=%s, res=%s, num=%d, min=%d\n",
  222. //kentry_name(entry), kentry_name(nested), kpargv_status_decode(res), num, min);
  223. // It's not an error but there will be not
  224. // additional arguments of the same entry
  225. if ((res == KPARSE_NONE) ||
  226. ((res == KPARSE_NOTFOUND) && (num >= min)))
  227. break;
  228. // Only ERROR, OK or NOTFOUND (with not
  229. // enough arguments) will set rc
  230. rc = res;
  231. // Only OK will continue the loop. Any
  232. // another case will break the loop and ext loop
  233. if (res != KPARSE_OK) {
  234. break_loop = BOOL_TRUE;
  235. break;
  236. }
  237. consumed = BOOL_TRUE;
  238. }
  239. if (break_loop)
  240. break;
  241. if (consumed) {
  242. // Remember if optional parameter was already
  243. // entered
  244. kparg_t *tmp_parg = kparg_new(nested, NULL);
  245. kpargv_add_pargs(cur_level_pargv, tmp_parg);
  246. // SEQ container will get all entered nested
  247. // entry names as value within resulting pargv
  248. if (kentry_container(entry)) {
  249. kparg_t *parg = kparg_new(entry,
  250. kentry_name(nested));
  251. kpargv_add_pargs(pargv, parg);
  252. }
  253. // Mandatory or ordered parameter
  254. if ((min > 0) || kentry_order(nested))
  255. saved_iter = iter;
  256. // If optional entry is found then go back to nearest
  257. // non-optional (or ordered) entry to try to find
  258. // another optional entries.
  259. if ((0 == min) && (num > 0))
  260. iter = saved_iter;
  261. }
  262. }
  263. kpargv_free(cur_level_pargv);
  264. }
  265. if (rc == KPARSE_NONE)
  266. return retcode;
  267. if (retcode == KPARSE_NONE)
  268. return rc;
  269. // If nested result is NOTFOUND but argument was consumed
  270. // by entry itself then whole sequence is ERROR
  271. if ((retcode == KPARSE_OK) && (rc == KPARSE_NOTFOUND))
  272. rc = KPARSE_ERROR;
  273. //if (kentry_purpose(entry) == KENTRY_PURPOSE_COMMON)
  274. //fprintf(stderr, "RET: name=%s, rc=%s\n", kentry_name(entry), kpargv_status_decode(rc));
  275. return rc;
  276. }
  277. kpargv_t *ksession_parse_line(ksession_t *session, const faux_argv_t *argv,
  278. kpargv_purpose_e purpose, bool_t is_filter)
  279. {
  280. faux_argv_node_t *argv_iter = NULL;
  281. kpargv_t *pargv = NULL;
  282. kpargv_status_e pstatus = KPARSE_NONE;
  283. kpath_levels_node_t *levels_iterr = NULL;
  284. klevel_t *level = NULL;
  285. size_t level_found = 0; // Level where command was found
  286. kpath_t *path = NULL;
  287. assert(session);
  288. if (!session)
  289. return NULL;
  290. assert(argv);
  291. if (!argv)
  292. return NULL;
  293. argv_iter = faux_argv_iter(argv);
  294. // Initialize kpargv_t
  295. pargv = kpargv_new();
  296. assert(pargv);
  297. kpargv_set_continuable(pargv, faux_argv_is_continuable(argv));
  298. kpargv_set_purpose(pargv, purpose);
  299. // Iterate levels of path from higher to lower. Note the reversed
  300. // iterator will be used.
  301. path = ksession_path(session);
  302. levels_iterr = kpath_iterr(path);
  303. level_found = kpath_len(path) - 1; // Levels begin with '0'
  304. while ((level = kpath_eachr(&levels_iterr))) {
  305. const kentry_t *current_entry = klevel_entry(level);
  306. // Ignore entries with non-COMMON purpose. These entries are for
  307. // special processing and will be ignored here.
  308. if (kentry_purpose(current_entry) != KENTRY_PURPOSE_COMMON)
  309. continue;
  310. // Parsing
  311. pstatus = ksession_parse_arg(session, current_entry, &argv_iter,
  312. pargv, BOOL_FALSE, is_filter);
  313. if ((pstatus != KPARSE_NOTFOUND) && (pstatus != KPARSE_NONE))
  314. break;
  315. // NOTFOUND but some args were parsed.
  316. // When it's completion for first argument (that can be continued)
  317. // len == 0 and engine will search for completions on higher
  318. // levels of path.
  319. if (kpargv_pargs_len(pargv) > 0)
  320. break;
  321. level_found--;
  322. }
  323. // Save last argument
  324. if (argv_iter)
  325. kpargv_set_last_arg(pargv, faux_argv_current(argv_iter));
  326. // It's a higher level of parsing, so some statuses can have different
  327. // meanings
  328. if (KPARSE_NONE == pstatus) {
  329. pstatus = KPARSE_ERROR;
  330. } else if (KPARSE_OK == pstatus) {
  331. // Not all args are parsed
  332. if (argv_iter != NULL)
  333. pstatus = KPARSE_ERROR; // Additional not parsable args
  334. // If no ACTIONs were found i.e. command was not found
  335. else if (!kpargv_command(pargv))
  336. pstatus = KPARSE_NOACTION;
  337. } else if (KPARSE_NOTFOUND == pstatus) {
  338. pstatus = KPARSE_ERROR; // Unknown command
  339. }
  340. kpargv_set_status(pargv, pstatus);
  341. kpargv_set_level(pargv, level_found);
  342. return pargv;
  343. }
  344. // Delimeter of commands is '|' (pipe)
  345. faux_list_t *ksession_split_pipes(const char *raw_line, faux_error_t *error)
  346. {
  347. faux_list_t *list = NULL;
  348. faux_argv_t *argv = NULL;
  349. faux_argv_node_t *argv_iter = NULL;
  350. faux_argv_t *cur_argv = NULL; // Current argv
  351. const char *delimeter = "|";
  352. const char *arg = NULL;
  353. assert(raw_line);
  354. if (!raw_line)
  355. return NULL;
  356. // Split raw line to arguments
  357. argv = faux_argv_new();
  358. assert(argv);
  359. if (!argv)
  360. return NULL;
  361. faux_argv_set_quotes(argv, ARGV_ALT_QUOTES);
  362. if (faux_argv_parse(argv, raw_line) < 0) {
  363. faux_argv_free(argv);
  364. return NULL;
  365. }
  366. list = faux_list_new(FAUX_LIST_UNSORTED, FAUX_LIST_NONUNIQUE,
  367. NULL, NULL, (void (*)(void *))faux_argv_free);
  368. assert(list);
  369. if (!list) {
  370. faux_argv_free(argv);
  371. return NULL;
  372. }
  373. argv_iter = faux_argv_iter(argv);
  374. cur_argv = faux_argv_new();
  375. assert(cur_argv);
  376. while ((arg = faux_argv_each(&argv_iter))) {
  377. if (strcmp(arg, delimeter) == 0) {
  378. // End of current line (from "|" to "|")
  379. // '|' in a first position is an error
  380. if (faux_argv_len(cur_argv) == 0) {
  381. faux_argv_free(argv);
  382. faux_list_free(list);
  383. faux_error_sprintf(error, "The pipe '|' can't "
  384. "be at the first position");
  385. return NULL;
  386. }
  387. // Add argv to argv's list
  388. faux_list_add(list, cur_argv);
  389. cur_argv = faux_argv_new();
  390. assert(cur_argv);
  391. } else {
  392. faux_argv_add(cur_argv, arg);
  393. }
  394. }
  395. // Continuable flag is usefull for last argv
  396. faux_argv_set_continuable(cur_argv, faux_argv_is_continuable(argv));
  397. // Empty cur_argv is not an error. It's usefull for completion and help.
  398. // But empty cur_argv and continuable is abnormal.
  399. if ((faux_argv_len(cur_argv) == 0) &&
  400. faux_argv_is_continuable(cur_argv)) {
  401. faux_argv_free(argv);
  402. faux_list_free(list);
  403. faux_error_sprintf(error, "The pipe '|' can't "
  404. "be the last argument");
  405. return NULL;
  406. }
  407. faux_list_add(list, cur_argv);
  408. faux_argv_free(argv);
  409. return list;
  410. }
  411. // is_piped means full command contains more than one piped components
  412. static bool_t ksession_check_line(const kpargv_t *pargv, faux_error_t *error,
  413. bool_t is_first, bool_t is_piped)
  414. {
  415. kpargv_purpose_e purpose = KPURPOSE_EXEC;
  416. const kentry_t *cmd = NULL;
  417. if (!pargv)
  418. return BOOL_FALSE;
  419. purpose = kpargv_purpose(pargv);
  420. cmd = kpargv_command(pargv);
  421. // For execution pargv must be fully correct but for completion
  422. // it's not a case
  423. if ((KPURPOSE_EXEC == purpose) && (kpargv_status(pargv) != KPARSE_OK)) {
  424. faux_error_sprintf(error, "%s", kpargv_status_str(pargv));
  425. return BOOL_FALSE;
  426. }
  427. // Can't check following conditions without cmd
  428. if (!cmd)
  429. return BOOL_TRUE;
  430. // First component
  431. if (is_first) {
  432. // First component can't be a filter
  433. if (kentry_filter(cmd) == KENTRY_FILTER_TRUE) {
  434. faux_error_sprintf(error, "The filter \"%s\" "
  435. "can't be used without previous pipeline",
  436. kentry_name(cmd));
  437. return BOOL_FALSE;
  438. }
  439. // Components after pipe "|"
  440. } else {
  441. // Only the first component can be non-filter
  442. if (kentry_filter(cmd) == KENTRY_FILTER_FALSE) {
  443. faux_error_sprintf(error, "The non-filter command \"%s\" "
  444. "can't be destination of pipe",
  445. kentry_name(cmd));
  446. return BOOL_FALSE;
  447. }
  448. // Only the first component can have 'restore=true' attribute
  449. if (kentry_restore(cmd)) {
  450. faux_error_sprintf(error, "The command \"%s\" "
  451. "can't be destination of pipe",
  452. kentry_name(cmd));
  453. return BOOL_FALSE;
  454. }
  455. }
  456. is_piped = is_piped; // Happy compiler
  457. return BOOL_TRUE;
  458. }
  459. // All components except last one must be legal for execution but last
  460. // component must be parsed for completion.
  461. // Completion is a "back-end" operation so it doesn't need detailed error
  462. // reporting.
  463. kpargv_t *ksession_parse_for_completion(ksession_t *session,
  464. const char *raw_line)
  465. {
  466. faux_list_t *split = NULL;
  467. faux_list_node_t *iter = NULL;
  468. kpargv_t *pargv = NULL;
  469. bool_t is_piped = BOOL_FALSE;
  470. assert(session);
  471. if (!session)
  472. return NULL;
  473. assert(raw_line);
  474. if (!raw_line)
  475. return NULL;
  476. // Split raw line (with '|') to components
  477. split = ksession_split_pipes(raw_line, NULL);
  478. if (!split || (faux_list_len(split) < 1)) {
  479. faux_list_free(split);
  480. return NULL;
  481. }
  482. is_piped = (faux_list_len(split) > 1);
  483. iter = faux_list_head(split);
  484. while (iter) {
  485. faux_argv_t *argv = (faux_argv_t *)faux_list_data(iter);
  486. bool_t is_last = (iter == faux_list_tail(split));
  487. bool_t is_first = (iter == faux_list_head(split));
  488. kpargv_purpose_e purpose = is_last ? KPURPOSE_COMPLETION : KPURPOSE_EXEC;
  489. pargv = ksession_parse_line(session, argv, purpose, !is_first);
  490. if (!ksession_check_line(pargv, NULL, is_first, is_piped)) {
  491. kpargv_free(pargv);
  492. pargv = NULL;
  493. break;
  494. }
  495. if (!is_last)
  496. kpargv_free(pargv);
  497. iter = faux_list_next_node(iter);
  498. }
  499. faux_list_free(split);
  500. return pargv;
  501. }
  502. kexec_t *ksession_parse_for_exec(ksession_t *session, const char *raw_line,
  503. faux_error_t *error)
  504. {
  505. faux_list_t *split = NULL;
  506. faux_list_node_t *iter = NULL;
  507. kpargv_t *pargv = NULL;
  508. kexec_t *exec = NULL;
  509. bool_t is_piped = BOOL_FALSE;
  510. size_t index = 0;
  511. assert(session);
  512. if (!session)
  513. return NULL;
  514. assert(raw_line);
  515. if (!raw_line)
  516. return NULL;
  517. // Split raw line (with '|') to components
  518. split = ksession_split_pipes(raw_line, error);
  519. if (!split || (faux_list_len(split) < 1)) {
  520. faux_list_free(split);
  521. return NULL;
  522. }
  523. is_piped = (faux_list_len(split) > 1);
  524. // Create exec list
  525. exec = kexec_new(session, KCONTEXT_TYPE_ACTION);
  526. assert(exec);
  527. if (!exec) {
  528. faux_list_free(split);
  529. return NULL;
  530. }
  531. kexec_set_line(exec, raw_line);
  532. iter = faux_list_head(split);
  533. while (iter) {
  534. faux_argv_t *argv = (faux_argv_t *)faux_list_data(iter);
  535. kcontext_t *context = NULL;
  536. bool_t is_first = (iter == faux_list_head(split));
  537. bool_t is_last = (iter == faux_list_tail(split));
  538. char *context_line = NULL;
  539. pargv = ksession_parse_line(session, argv, KPURPOSE_EXEC, !is_first);
  540. // All components must be ready for execution
  541. if (!ksession_check_line(pargv, error, is_first, is_piped)) {
  542. kpargv_free(pargv);
  543. kexec_free(exec);
  544. faux_list_free(split);
  545. return NULL;
  546. }
  547. // Fill the kexec_t
  548. context = kcontext_new(KCONTEXT_TYPE_ACTION);
  549. assert(context);
  550. kcontext_set_scheme(context, ksession_scheme(session));
  551. kcontext_set_pargv(context, pargv);
  552. // Context for ACTION execution contains session
  553. kcontext_set_session(context, session);
  554. context_line = faux_argv_line(argv);
  555. kcontext_set_line(context, context_line);
  556. faux_str_free(context_line);
  557. kcontext_set_pipeline_stage(context, index);
  558. kcontext_set_is_last_pipeline_stage(context, is_last);
  559. if (is_last) {
  560. kcontext_set_bufout(context, kexec_bufout(exec));
  561. kcontext_set_buferr(context, kexec_buferr(exec));
  562. }
  563. kexec_add_contexts(exec, context);
  564. // Next component
  565. iter = faux_list_next_node(iter);
  566. index++;
  567. }
  568. faux_list_free(split);
  569. return exec;
  570. }
  571. kexec_t *ksession_parse_for_local_exec(ksession_t *session, const kentry_t *entry,
  572. const kpargv_t *parent_pargv, const kcontext_t *parent_context,
  573. const kexec_t *parent_exec)
  574. {
  575. faux_argv_node_t *argv_iter = NULL;
  576. kpargv_t *pargv = NULL;
  577. kexec_t *exec = NULL;
  578. faux_argv_t *argv = NULL;
  579. kcontext_t *context = NULL;
  580. kpargv_status_e pstatus = KPARSE_NONE;
  581. const char *line = NULL; // TODO: Must be 'line' field of ENTRY
  582. assert(session);
  583. if (!session)
  584. return NULL;
  585. assert(entry);
  586. if (!entry)
  587. return NULL;
  588. exec = kexec_new(session, KCONTEXT_TYPE_SERVICE_ACTION);
  589. assert(exec);
  590. argv = faux_argv_new();
  591. assert(argv);
  592. faux_argv_set_quotes(argv, ARGV_ALT_QUOTES);
  593. faux_argv_parse(argv, line);
  594. argv_iter = faux_argv_iter(argv);
  595. pargv = kpargv_new();
  596. assert(pargv);
  597. kpargv_set_continuable(pargv, faux_argv_is_continuable(argv));
  598. kpargv_set_purpose(pargv, KPURPOSE_EXEC);
  599. pstatus = ksession_parse_arg(session, entry, &argv_iter, pargv,
  600. BOOL_TRUE, BOOL_FALSE);
  601. // Parsing problems
  602. if ((pstatus != KPARSE_OK) || (argv_iter != NULL)) {
  603. kexec_free(exec);
  604. faux_argv_free(argv);
  605. kpargv_free(pargv);
  606. return NULL;
  607. }
  608. context = kcontext_new(KCONTEXT_TYPE_SERVICE_ACTION);
  609. assert(context);
  610. kcontext_set_scheme(context, ksession_scheme(session));
  611. kcontext_set_pargv(context, pargv);
  612. kcontext_set_parent_pargv(context, parent_pargv);
  613. kcontext_set_parent_context(context, parent_context);
  614. kcontext_set_parent_exec(context, parent_exec);
  615. kcontext_set_bufout(context, kexec_bufout(exec));
  616. kcontext_set_session(context, session);
  617. kexec_add_contexts(exec, context);
  618. faux_argv_free(argv);
  619. return exec;
  620. }
  621. static bool_t stop_loop_ev(faux_eloop_t *eloop, faux_eloop_type_e type,
  622. void *associated_data, void *user_data)
  623. {
  624. ksession_t *session = (ksession_t *)user_data;
  625. if (!session)
  626. return BOOL_FALSE;
  627. ksession_set_done(session, BOOL_TRUE); // Stop the whole session
  628. // Happy compiler
  629. eloop = eloop;
  630. type = type;
  631. associated_data = associated_data;
  632. return BOOL_FALSE; // Stop Event Loop
  633. }
  634. static bool_t get_stdout(kexec_t *exec)
  635. {
  636. ssize_t r = -1;
  637. faux_buf_t *faux_buf = NULL;
  638. void *linear_buf = NULL;
  639. int fd = -1;
  640. if (!exec)
  641. return BOOL_FALSE;
  642. fd = kexec_stdout(exec);
  643. assert(fd != -1);
  644. faux_buf = kexec_bufout(exec);
  645. assert(faux_buf);
  646. do {
  647. ssize_t really_readed = 0;
  648. ssize_t linear_len =
  649. faux_buf_dwrite_lock_easy(faux_buf, &linear_buf);
  650. // Non-blocked read. The fd became non-blocked while
  651. // kexec_prepare().
  652. r = read(fd, linear_buf, linear_len);
  653. if (r > 0)
  654. really_readed = r;
  655. faux_buf_dwrite_unlock_easy(faux_buf, really_readed);
  656. } while (r > 0);
  657. return BOOL_TRUE;
  658. }
  659. static bool_t action_terminated_ev(faux_eloop_t *eloop, faux_eloop_type_e type,
  660. void *associated_data, void *user_data)
  661. {
  662. int wstatus = 0;
  663. pid_t child_pid = -1;
  664. kexec_t *exec = (kexec_t *)user_data;
  665. if (!exec)
  666. return BOOL_FALSE;
  667. // Wait for any child process. Doesn't block.
  668. while ((child_pid = waitpid(-1, &wstatus, WNOHANG)) > 0)
  669. kexec_continue_command_execution(exec, child_pid, wstatus);
  670. // Check if kexec is done now
  671. if (kexec_done(exec)) {
  672. // May be buffer still contains data
  673. get_stdout(exec);
  674. return BOOL_FALSE; // To break a loop
  675. }
  676. // Happy compiler
  677. eloop = eloop;
  678. type = type;
  679. associated_data = associated_data;
  680. return BOOL_TRUE;
  681. }
  682. static bool_t action_stdout_ev(faux_eloop_t *eloop, faux_eloop_type_e type,
  683. void *associated_data, void *user_data)
  684. {
  685. kexec_t *exec = (kexec_t *)user_data;
  686. // Happy compiler
  687. eloop = eloop;
  688. type = type;
  689. associated_data = associated_data;
  690. return get_stdout(exec);
  691. }
  692. bool_t ksession_exec_locally(ksession_t *session, const kentry_t *entry,
  693. kpargv_t *parent_pargv, const kcontext_t *parent_context,
  694. const kexec_t *parent_exec, int *retcode, char **out)
  695. {
  696. kexec_t *exec = NULL;
  697. faux_eloop_t *eloop = NULL;
  698. faux_buf_t *buf = NULL;
  699. char *cstr = NULL;
  700. ssize_t len = 0;
  701. assert(entry);
  702. if (!entry)
  703. return BOOL_FALSE;
  704. // Parsing
  705. exec = ksession_parse_for_local_exec(session, entry,
  706. parent_pargv, parent_context, parent_exec);
  707. if (!exec)
  708. return BOOL_FALSE;
  709. // Session status can be changed while parsing because it can execute
  710. // nested ksession_exec_locally() to check for PTYPEs, CONDitions etc.
  711. // So check for 'done' flag to propagate it.
  712. // NOTE: Don't interrupt single kexec_t. Let's it to complete.
  713. // if (ksession_done(session)) {
  714. // kexec_free(exec);
  715. // return BOOL_FALSE; // Because action is not completed
  716. // }
  717. // Execute kexec and then wait for completion using local Eloop
  718. if (!kexec_exec(exec)) {
  719. kexec_free(exec);
  720. return BOOL_FALSE; // Something went wrong
  721. }
  722. // If kexec contains only non-exec (for example dry-run) ACTIONs then
  723. // we don't need event loop
  724. if (!kexec_retcode(exec, retcode)) {
  725. // Local service loop
  726. eloop = faux_eloop_new(NULL);
  727. faux_eloop_add_signal(eloop, SIGINT, stop_loop_ev, session);
  728. faux_eloop_add_signal(eloop, SIGTERM, stop_loop_ev, session);
  729. faux_eloop_add_signal(eloop, SIGQUIT, stop_loop_ev, session);
  730. faux_eloop_add_signal(eloop, SIGCHLD, action_terminated_ev, exec);
  731. faux_eloop_add_fd(eloop, kexec_stdout(exec), POLLIN,
  732. action_stdout_ev, exec);
  733. faux_eloop_loop(eloop);
  734. faux_eloop_free(eloop);
  735. kexec_retcode(exec, retcode);
  736. }
  737. if (!out) {
  738. kexec_free(exec);
  739. return BOOL_TRUE;
  740. }
  741. buf = kexec_bufout(exec);
  742. if ((len = faux_buf_len(buf)) <= 0) {
  743. kexec_free(exec);
  744. return BOOL_TRUE;
  745. }
  746. cstr = faux_malloc(len + 1);
  747. faux_buf_read(buf, cstr, len);
  748. cstr[len] = '\0';
  749. *out = cstr;
  750. kexec_free(exec);
  751. return BOOL_TRUE;
  752. }