ksession_parse.c 23 KB

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