-
Notifications
You must be signed in to change notification settings - Fork 37
/
cligen_read.c
1096 lines (1040 loc) · 33.3 KB
/
cligen_read.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
CLI generator readline. Do input processing and matching.
***** BEGIN LICENSE BLOCK *****
Copyright (C) 2001-2022 Olof Hagsand
This file is part of CLIgen.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 2 or later (the "GPL"),
in which case the provisions of the GPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of the GPL, and not to allow others to
use your version of this file under the terms of Apache License version 2, indicate
your decision by deleting the provisions above and replace them with the
notice and other provisions required by the GPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the Apache License version 2 or the GPL.
***** END LICENSE BLOCK *****
*/
#include "cligen_config.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <errno.h>
#include <signal.h>
#include <sys/types.h>
#include <sys/stat.h>
#ifdef WIN32
#include <winsock2.h>
#else
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <termios.h>
#include <fcntl.h>
#endif /* WIN32 */
#define __USE_GNU /* isblank() */
#include <ctype.h>
#include <sys/wait.h>
#ifndef isblank
#define isblank(c) (c==' ')
#endif /* isblank */
#include "cligen_buf.h"
#include "cligen_cv.h"
#include "cligen_cvec.h"
#include "cligen_parsetree.h"
#include "cligen_pt_head.h"
#include "cligen_callback.h"
#include "cligen_object.h"
#include "cligen_handle.h"
#include "cligen_print.h"
#include "cligen_result.h"
#include "cligen_read.h"
#include "cligen_match.h"
#include "cligen_io.h"
#include "cligen_expand.h"
#include "cligen_history_internal.h"
#include "cligen_getline.h"
/*
* Local prototypes
*/
static int show_help_columns(cligen_handle h, FILE *fout, char *s, parse_tree *pt, cvec *cvv);
static int show_help_line(cligen_handle h, FILE *fout, char *s, parse_tree *pt, cvec *);
static int cli_complete(cligen_handle h, int *lenp, parse_tree *pt, cvec *cvv);
/*! Show help strings
*
* @param[in] h CLIgen handle Input string to match
* @param[in] string Input string
* @param[in] column If 0: short/ios (column) mode, 1: long/junos (row) mode (cf CLIGEN_TABMODE_COLUMNS)
* @retval 0 OK
* @retval -1 Error
*/
static int
cli_show_help_commands(cligen_handle h,
char *string)
{
int retval = -1;
parse_tree *pt=NULL; /* Orig parse-tree */
parse_tree *ptn = NULL; /* Expanded */
cvec *cvv = NULL;
fputs("\n", stdout);
if ((ptn = pt_new()) == NULL)
goto done;
if ((pt = cligen_pt_active_get(h)) == NULL)
goto ok;
if ((cvv = cvec_start(string)) == NULL)
goto done;
if (pt_expand(h, NULL,
pt,
NULL,
cvv,
1, /* Include hidden commands */
0, /* VARS are not expanded, eg ? <tab> */
NULL, NULL,
ptn) < 0) /* expansion */
goto done;
if (show_help_line(h, stdout, string, ptn, cvv) < 0)
goto done;
ok:
retval = 0;
done:
if (cvv)
cvec_free(cvv);
if (ptn && pt_free(ptn, 0) < 0)
return -1;
if (pt && pt_expand_cleanup(h, pt) < 0)
return -1;
return retval;
}
/*! Callback from getline: '?' has been typed on command line
*
* Just show help by calling long help show function.
* @param[in] h CLIgen handle
* @param[in] string Input string to match
* @retval 0 OK: required by getline
* @retval -1 Error
* @note Flaw related to getline: Errors from sub-functions are ignored
* @see cli_tab_hook
*/
static int
cli_qmark_hook(cligen_handle h,
char *string)
{
return cli_show_help_commands(h, string);
}
/*! Callback from getline: TAB has been typed on keyboard
*
* First try to complete the string if the possibilities
* allow that (at least one unique common character).
* If no completion was made, then show the command alternatives.
* @param[in] h CLIgen handle
* @param[in,out] cursorp Pointer to location of cursor on entry and exit
* @retval -1 Error
* @retval -2 (value != -1 required by getline)
* @note Flaw related to getline: Errors from sub-functions are ignored
* @see cli_qmark_hook
*/
static int
cli_tab_hook(cligen_handle h,
int *cursorp)
{
int retval = -1;
int prev_cursor;
parse_tree *pt = NULL; /* Orig */
parse_tree *ptn = NULL; /* Expanded */
cvec *cvv = NULL;
if ((ptn = pt_new()) == NULL)
goto done;
if ((pt = cligen_pt_active_get(h)) == NULL)
goto ok;
if ((cvv = cvec_start(cligen_buf(h))) == NULL)
goto done;
if (pt_expand(h, NULL,
pt,
NULL,
cvv,
1, /* Include hidden commands */
0, /* VARS are not expanded, eg ? <tab> */
NULL, NULL,
ptn) < 0) /* expansion */
goto done;
/* Note, can change cligen buf pointer (append and increase) */
do {
prev_cursor = *cursorp;
if (cli_complete(h, cursorp, ptn, cvv) < 0) /* XXX expand-cleanup must be done here before show commands */
goto done;
} while (cligen_tabmode(h)&CLIGEN_TABMODE_STEPS && prev_cursor != *cursorp);
if (cvv){
cvec_free(cvv);
if ((cvv = cvec_start(cligen_buf(h))) == NULL)
goto done;
}
fputs("\n", stdout);
if (cligen_tabmode(h) & CLIGEN_TABMODE_COLUMNS){
if (show_help_line(h, stdout, cligen_buf(h), ptn, cvv) <0)
goto done;
}
else if (show_help_columns(h, stdout, cligen_buf(h), ptn, cvv) < 0)
goto done;
ok:
retval = 0;
done:
if (cvv)
cvec_free(cvv);
if (ptn && pt_free(ptn, 0) < 0)
return -1;
if (pt && pt_expand_cleanup(h, pt) < 0)
return -1;
return retval;
}
/*! Initialize this module
*/
void
cliread_init(cligen_handle h)
{
gl_qmark_hook = cli_qmark_hook;
gl_tab_hook = cli_tab_hook; /* XXX globals */
}
/*! Print columns
*
* @param[in] cnr Number of columns.
* @param[in] cw Width of column
*/
static int
column_print(FILE *fout,
int cnr,
int cw,
struct cligen_help *chvec,
int len,
int level)
{
int retval = -1;
int li; /* line number */
int ci; /* column number */
int linenr;
struct cligen_help *ch;
linenr = (len-1)/cnr + 1;
for (ci=0, li = 0; li < linenr; li++) {
while ((ci < cnr) && (li*cnr+ci < len)) {
ch = &chvec[li*cnr+ci];
fprintf(fout, " %*s",
-(cw-1),
ch->ch_cmd);
ci++;
}
ci = 0;
fprintf(fout, "\n");
}
fflush(fout);
retval = 0;
// done:
return retval;
}
/*! Show briefly the commands available (show no help)
*
* Typically called when TAB is pressed and there are multiple options.
* @param[in] fout This is where the output (help text) is shown.
* @param[in] string Input string to match
* @param[in] pt Vector of commands (array of cligen object pointers (cg_obj)
* @param[out] cvv Cligen variable vector containing vars/values pair for completion
* @retval 0 OK
* @retval -1 Error
* @see print_help_lines
*/
static int
show_help_columns(cligen_handle h,
FILE *fout,
char *string,
parse_tree *pt,
cvec *cvv)
{
int retval = -1;
int level;
int i;
int nrcmd = 0;
struct cligen_help *chvec = NULL;
struct cligen_help *ch;
cg_obj *co;
cbuf *cb = NULL;
char *cmd;
int maxlen = 0;
int column_width;
int column_nr;
int rest;
cvec *cvt = NULL; /* Tokenized string: vector of tokens */
cvec *cvr = NULL; /* Rest variant, eg remaining string in each step */
match_result *mr = NULL;
if (string == NULL){
errno = EINVAL;
goto done;
}
if ((cb = cbuf_new()) == NULL){
fprintf(stderr, "cbuf_new: %s\n", strerror(errno));
return -1;
}
/* Tokenize the string and transform it into two CLIgen vectors: tokens and rests */
if (cligen_str2cvv(string, &cvt, &cvr) < 0)
goto done;
if (match_pattern(h, cvt, cvr,
pt,
0, /* best: Return all options, not only best, exclude hidden */
cvv,
&mr) < 0)
goto done;
if ((level = cligen_cvv_levels(cvt)) < 0)
goto done;
if (mr_pt_len_get(mr) > 0){ /* min, max only defined if matchlen > 0 */
/* Go through match vector and collect commands and helps */
if ((chvec = calloc(mr_pt_len_get(mr), sizeof(struct cligen_help))) ==NULL){
fprintf(stderr, "%s calloc: %s\n", __FUNCTION__, strerror(errno));
goto done;
}
nrcmd = 0;
for (i = 0; i<mr_pt_len_get(mr); i++){ // nr-1?
if ((co = mr_pt_i_get(mr, i)) == NULL)
continue;
if (co->co_command == NULL)
continue;
cmd = NULL;
switch (co->co_type){
case CO_VARIABLE:
cbuf_reset(cb);
cov2cbuf(cb, co, 1);
cmd = cbuf_get(cb);
break;
case CO_COMMAND:
cmd = co->co_command;
break;
case CO_REFERENCE:
default:
continue;
}
if (cmd == NULL || strlen(cmd)==0)
continue;
ch = &chvec[nrcmd];
if ((ch->ch_cmd = strdup(cmd)) == NULL){
fprintf(stderr, "%s strdup: %s\n", __FUNCTION__, strerror(errno));
goto done;
}
if (co->co_helpstring && cligen_txt2cvv(co->co_helpstring, &ch->ch_helpvec) < 0)
goto done;
if (nrcmd && cligen_help_eq(&chvec[nrcmd-1], ch, 0) == 1){
cligen_help_clear(ch);
continue;
}
nrcmd++;
maxlen = strlen(cmd)>maxlen?strlen(cmd):maxlen;
}
maxlen++;
column_width = maxlen<COLUMN_MIN_WIDTH?COLUMN_MIN_WIDTH:maxlen;
column_nr = cligen_terminal_width(h)/column_width;
if (column_nr < 1)
column_nr = 1;
rest = cligen_terminal_width(h)%column_width;
column_width += rest/column_nr;
if (column_print(fout,
column_nr,
column_width,
chvec,
nrcmd,
level) < 0)
goto done;
} /* nr>0 */
retval = 0;
done:
if (chvec){
for (i=0; i<nrcmd; i++)
cligen_help_clear(&chvec[i]);
free(chvec);
}
if (cvt)
cvec_free(cvt);
if (cvr)
cvec_free(cvr);
if (cb)
cbuf_free(cb);
if (mr){
mr_free(mr);
}
return retval;
}
/*! Show one row per command with help text for each command
*
* Typically called when a question mark is pressed
* @param[in] h cligen handle
* @param[in] fout This is where the output (help text) is shown.
* @param[in] string Input string to match
* @param[in] pt Parse tree
* @param[out] cvv Cligen variable vector containing vars/values pair for completion
* @retval 0 OK
* @retval -1 Error
*
* Example from JunOS
# set interfaces ?
Possible completions:
<interface_name> Interface name
+ apply-groups Groups from which to inherit configuration data
+ apply-groups-except Don't inherit configuration data from these groups
fe-0/0/1 Interface name
> interface-set Logical interface set configuration
> traceoptions Interface trace options
*/
static int
show_help_line(cligen_handle h,
FILE *fout,
char *string,
parse_tree *pt,
cvec *cvv)
{
int retval = -1;
int level;
cvec *cvt = NULL; /* Tokenized string: vector of tokens */
cvec *cvr = NULL; /* Rest variant, eg remaining string in each step */
cg_var *cvlastt; /* Last element in cvt */
cg_var *cvlastr; /* Last element in cvr */
cligen_result result;
match_result *mr = NULL;
if (string == NULL){
errno = EINVAL;
goto done;
}
/* Tokenize the string and transform it into two CLIgen vectors: tokens and rests */
if (cligen_str2cvv(string, &cvt, &cvr) < 0) /* XXX cvr leaks memory */
goto done;
if (match_pattern(h,
cvt, cvr, /* token string */
pt, /* command vector */
0, /* best: Return all options, not only best, exclude hidden */
cvv,
&mr) < 0)
goto done;
if ((level = cligen_cvv_levels(cvt)) < 0)
goto done;
/* If last char is blank, look for next level in parse-tree
* eg, syntax is x (y|z) and we have typed 'x ' then show
* help for y and z, not x.
*/
/* See if string is not empty and last element is empty/blank
* This means we need to peek in next level and if that provides a unique solution,
* then add a <cr>
*/
cvlastt = cvec_i(cvt, cvec_len(cvt)-1);
if (cvec_len(cvt) > 2 && strcmp(cv_string_get(cvlastt), "")==0){
/* if it is ok to <cr> here (at end of one mode)
Example: x [y|z] and we have typed 'x ', then show
help for y and z and a 'cr' for 'x'.
*/
/* Remove the last elements. Awkward: first free the cv then truncate the cvec */
if (cvlastt)
cv_reset(cvlastt);
cvec_del_i(cvt, cvec_len(cvt)-1); /* We really just want to truncate len-1 */
if ((cvlastr = cvec_i(cvr, cvec_len(cvr)-1)) != NULL)
cv_reset(cvlastr);
cvec_del_i(cvr, cvec_len(cvr)-1);
if (match_pattern_exact(h, cvt, cvr, pt,
cvv,
NULL,
&result,
NULL) < 0)
goto done;
if (result == CG_MATCH){
fprintf(fout, " <cr>\n");
fflush(fout);
}
}
if (mr_pt_len_get(mr) == 0){
retval = 0;
goto done;
}
/* ptmatch points to expanded nodes from first match_pattern call */
if (print_help_lines(h, fout, mr_pt_get(mr)) < 0)
goto done;
retval = 0;
done:
if (cvt)
cvec_free(cvt);
if (cvr)
cvec_free(cvr);
if (mr){
mr_free(mr);
}
return retval;
}
/*! Try to complete a command as much as possible.
*
* @param[in] h CLIgen handle
* @param[in] string Input string to match
* @param[in] cursorp Pointer to the current cursor in string.
* @param[in] pt Vector of commands (array of cligen object pointers)
* @param[out] cvv cligen variable vector containing vars/values pair for completion
* @retval -1 Error
* @retval 0 Success
*/
static int
cli_complete(cligen_handle h,
int *cursorp,
parse_tree *pt,
cvec *cvv)
{
int retval = -1;
char *string;
char *s = NULL;
size_t slen;
int cursor = *cursorp;
int i, n;
int extra;
string = cligen_buf(h);
if (string == NULL){
fprintf(stderr, "%s Input string NULL\n", __FUNCTION__);
goto done;
}
slen = cligen_buf_size(h);
if ((s = malloc(slen)) == NULL){ /* s is a temporary copy */
fprintf(stderr, "%s malloc: %s\n", __FUNCTION__, strerror(errno));
goto done;
}
strncpy(s, string, slen);
s[cursor] = '\0';
if (match_complete(h, pt, &s, &slen, cvv) < 0)
goto done;
extra = strlen(s) - cursor; /* Extra characters added? */
if (extra){
cligen_buf_increase(h, strlen(s));
string = cligen_buf(h);
n = strlen(string) - cursor; /* Nr of chars right of cursor to copy */
cligen_buf_increase(h, strlen(string)+cursor+n);
string = cligen_buf(h);
for (i=cursor+n; i>=cursor; i--) /* Copy right of cursor */
string[i + extra] = string[i];
strncpy(string + cursor, s + cursor, extra); /* Copy the new stuff */
*cursorp += extra; /* Increase cursor */
}
retval = 0;
done:
if (s)
free(s);
return retval;
}
/*! Trim command line. Remove any leading, trailing and multiple whitespace, remove comments
*
* comment is a character (eg '#'), using "bash" comment rule:
# Word beginning with # causes that word and all remaining characters on that line to be ignored
* @param[out] line
* @param[in] comment character
*/
void
cli_trim(char **line,
char comment)
{
size_t point;
int whitespace = 0;
char *s = *line;
char *s1 = s;
char ch;
size_t len;
if (!isascii(comment))
comment = 0;
len = strlen(s);
for (point = 0; point <= len ; point++) {
ch = s[point];
if (comment && ch == comment && (whitespace || point == 0 )){
*s1++ = '\n';
*s1++ = '\0';
break;
}
else
if (isblank(ch)) {
if (whitespace)
continue;
else {
whitespace = 1;
*s1++ = ' ';
}
} else {
whitespace = 0;
*s1++ = ch;
}
}
/* strip heading whites */
while ((strlen(s) > 0) && isblank(*s))
s++;
/* strip trailing whites and newlines */
while ((strlen(s) > 0) && (isblank(*(s+strlen(s)-1)) || *(s+strlen(s)-1) == '\n'))
*(s + strlen(s) - 1) = '\0';
*line = s;
}
/*! Given an input string, return a parse-tree.
*
* Given an input string and a parse-tree, return a matching parse-tree node, a
* CLIgen keyword and CLIgen variable record vector.
* Some complexity in this function is due to variable expansion: if there
* are <expand:> variables, the parse-tree needs to be expanded with current
* values by calling user-supplied callbacks and building a 'shadow' parse-tree
* which is purged after use.
* Use this function if you already have a string but you want it syntax-checked
* and parsed.
*
* @param[in] h Cligen handle
* @param[in] string Input string to match
* @param[in] pt Parse-tree
* @param[out] co_orig Object that matches (if retval == 1). Free with co_free(co, 0)
* @param[out] cvvp Vector of cligen variables present in the input string. (if retval == 1).
* @param[out] result Result, < 0: errors, >=0 number of matches
* @param[out] reason Error reason if result is nomatch. Need to be free:d
* @retval 0 OK
* @retval -1 Error
*
* cvv should be created but empty on entry
* On exit it contains the command string as 0th element, and one entry per element
* Example: "aa <bb:str>" and inut string "aa 22" gives:
* 0 : "aa 22" # initial command has no "name"
* 1 : aa = "aa" # string has keyword itself as value
* 2 : bb = 22 # variable
*/
int
cliread_parse(cligen_handle h,
char *string,
parse_tree *pt, /* Orig */
cg_obj **co_orig,
cvec **cvvp,
cligen_result *result,
char **reason)
{
int retval = -1;
cg_obj *match_obj = NULL;
parse_tree *ptn = NULL; /* Expanded */
cvec *cvt = NULL; /* Tokenized string: vector of tokens */
cvec *cvr = NULL; /* Rest variant, eg remaining string in each step */
cg_var *cv;
cvec *cvv = NULL;
if (cvvp == NULL || *cvvp != NULL){
errno = EINVAL;
goto done;
}
if (cligen_logsyntax(h) > 0){
fprintf(stderr, "%s:\n", __FUNCTION__);
pt_print1(stderr, pt, 0);
}
cli_trim(&string, cligen_comment(h));
/* Tokenize the string and transform it into two CLIgen vectors: tokens and rests */
if (cligen_str2cvv(string, &cvt, &cvr) < 0)
goto done;
if ((cvv = cvec_new(0)) == NULL)
goto done;;
if ((cv = cvec_add(cvv, CGV_REST)) == NULL)
goto done;
cv_name_set(cv, "cmd"); /* the whole command string */
/* The whole command string as user entered. */
cv_string_set(cv, string);
if ((ptn = pt_new()) == NULL)
goto done;
if (pt_expand(h, NULL,
pt, cvt, cvv,
0, /* Do not include hidden commands */
0, /* VARS are not expanded, eg ? <tab> */
NULL, NULL,
ptn) < 0) /* sub-tree expansion, ie choice, expand function */
goto done;
if (match_pattern_exact(h, cvt, cvr,
ptn,
cvv,
&match_obj,
result, reason) < 0)
goto done;
/* Map from ghost object match_obj to real object */
*co_orig = match_obj;
*cvvp = cvv;
cvv = NULL;
retval = 0;
done:
if (cvv)
cvec_free(cvv);
if (cvt)
cvec_free(cvt);
if (cvr)
cvec_free(cvr);
if (ptn)
if (pt_free(ptn, 0) < 0)
return -1;
if (pt_expand_cleanup(h, pt) < 0)
return -1;
return retval;
}
/*! Read line interactively from terminal using getline (completion, etc)
*
* @param[in] h CLIgen handle
* @param[out] stringp Pointer to command buffer or NULL on EOF
* @retval 0 OK
* @retval -1 Error
*/
int
cliread(cligen_handle h,
char **stringp)
{
int retval = -1;
char *buf = NULL;
cligen_hist_fn *fn = NULL;
void *arg = NULL;
if (stringp == NULL){
errno = EINVAL;
goto done;
}
*stringp = NULL;
do {
buf = NULL;
if (gl_getline(h, &buf) < 0)
goto done;
cli_trim(&buf, cligen_comment(h));
} while (strlen(buf) == 0 && !gl_eof());
if (gl_eof())
goto eof;
if (hist_add(h, buf) < 0)
goto done;
/* Check callback: the reason it is separated from hist_add, is that the latter filters
* some commands and is also used in file load
*/
cligen_hist_fn_get(h, &fn, &arg);
if (fn && (*fn)(h, buf, arg) < 0) {
goto done;
}
*stringp = buf;
eof:
retval = 0;
done:
return retval;
}
/*! Read line from terminal, parse the string, and invoke callbacks.
*
* Return both results from parsing (function return), and eventual result
* from callback (if function return =1).
* Use this function if you want the whole enchilada without special operation
*
* @param[in] h CLIgen handle
* @param[out] line Pointer to new string input from terminal
* @param[out] cb_retval Retval of callback (only if functions return value is 1)
* @param[out] result Number of matches
* @param[out] reason Error reason if result is nomatch. Need to be free:d
* @retval 0 OK
* @retval -1 Error
*/
int
cliread_eval(cligen_handle h,
char **line,
int *cb_retval,
cligen_result *result,
char **reason)
{
int retval = -1;
cg_obj *matchobj = NULL; /* matching syntax node */
cvec *cvv = NULL;
parse_tree *pt = NULL; /* Orig */
if (h == NULL){
fprintf(stderr, "Illegal cligen handle\n");
goto done;
}
if (cliread(h, line) < 0)
goto done;
if (*line == NULL){ /* EOF */
*result = CG_EOF;
goto ok;
}
if ((pt = cligen_pt_active_get(h)) == NULL){
fprintf(stderr, "No active parse-tree found\n");
goto done;;
}
if (cliread_parse(h, *line, pt, &matchobj, &cvv, result, reason) < 0)
goto done;
if (*result == CG_MATCH)
*cb_retval = cligen_eval(h, matchobj, cvv);
ok:
retval = 0;
done:
if (matchobj)
co_free(matchobj, 0);
if (cvv)
cvec_free(cvv);
return retval;
}
/*! Poll socket for read
*
* Select is called with timeout set so that the call returns immediately
* @param[in] s Read socket
* @param[in] usec Timeout (0 is "poll")
* @retval 1 Input is available on s
* @retval 0 No input
* @retval -1 Error
*/
static int
cligen_eval_poll(int s,
unsigned int usec)
{
fd_set fdset;
struct timeval tv = {0,};
int ret;
FD_ZERO(&fdset);
FD_SET(s, &fdset);
tv.tv_sec = usec/1000000;
tv.tv_usec = usec%1000000;
if ((ret = select(FD_SETSIZE, &fdset, NULL, NULL, &tv)) < 0)
perror("cligen_eval_poll");
return ret;
}
void
signal_unblock(int sig)
{
sigset_t set;
sigemptyset(&set);
if (sig)
sigaddset(&set, sig);
else
sigfillset(&set);
sigprocmask(SIG_UNBLOCK, &set, NULL);
}
/*! Fork pipe function and return socker and pid, redirect to pipe_output_socket
*
* @param[in] h CLIgen handle
* @param[in] fn Output modifier callback
* @param[in] cvv A vector of cligen variables present in the string.
* @param[out] spipe Socket
* @param[out] pidp Pid of child
* @see cligen_eval_pipe_post
*/
static int
cligen_eval_pipe_pre(cligen_handle h,
cg_callback *cc,
cvec *cvv,
int *spipe,
pid_t *pidp)
{
int retval = -1;
int spair[2] = {-1, -1};
cgv_fnstype_t *fn;
if (socketpair(AF_UNIX, SOCK_STREAM, 0, spair) < 0)
goto done;
if ((*pidp = fork()) < 0)
goto done;
if (*pidp == 0) { /* Child */
close(spair[0]);
close(0);
if (dup2(spair[1], STDIN_FILENO) < 0){
goto done;
}
close(1);
if (dup2(spair[1], STDOUT_FILENO) < 0){
goto done;
}
close(spair[1]);
fn = co_callback_fn_get(cc);
signal_unblock(SIGTERM);
signal_unblock(SIGINT);
if ((retval = (*fn)(cligen_userhandle(h)?cligen_userhandle(h):h, cvv, cc->cc_cvec)) != 0)
fprintf(stderr, "%s child retval:%d\n", __FUNCTION__, retval);
exit(retval);
}
/* parent */
close(spair[1]);
/* for cligen_output */
if (cli_pipe_output_socket_set(spair[0]) < 0)
goto done;
if (spipe)
*spipe = spair[0];
retval = 0;
done:
return retval;
}
/*! Poll for write socket, redirect to cligen-output basic and then close pipe
*
* Given socket to pipe function, close write side, poll/read and redirect to
* basic output function, then wait for child completion
* @param[in] h CLIgen handle
* @param[in] s0 Socket
* @param[in] childpid Pid of child
*/
static int
cligen_eval_pipe_post(cligen_handle h,
int s0,
pid_t childpid)
{
int retval = -1;
int ret;
int status;
char buf[4097];
ssize_t len;
int s;
cli_pipe_output_socket_get(&s);
if (s != -1) {
/* Close write side of socket */
if (shutdown(s, SHUT_WR) < 0){
perror("shutdown");
goto done;
}
/* Block until input is available */
do {
if ((ret = cligen_eval_poll(s, 1000*1000)) < 0){
goto done;
}
}
while (ret == 0);
/* Read until EOF */
while (ret != 0) {
if ((len = read(s, buf, 4096)) < 0){
perror("cli_pipe_exec_cb, read");
goto done;
}
if (len == 0)
break;
buf[len] = '\0';
cligen_output_basic(stdout, buf, len);
/* Immediate poll: possibility if writer is slow that input is dropped due
* to starving of child in (maybe) single process systems
*/
if ((ret = cligen_eval_poll(s, CLI_PIPE_TIMEOUT_US)) < 0)
goto done;
}
if (cli_pipe_output_socket_set(-1) < 0)
goto done;
}
kill(childpid, SIGTERM);
/* On success, returns the process ID of the terminated child */
if(waitpid(childpid, &status, 0) != childpid){
perror("waitpid");
goto done;
}
retval = 0;
if (WIFEXITED(status)){
ret = WEXITSTATUS(status);
if (ret != 0)
retval = -1;
}
done:
return retval;
}
/*! Evaluate a matched cligen-object with an associated variable list
*
* @param[in] h CLIgen handle
* @param[in] co Matched CLIgen object.
* @param[in] cvv A vector of cligen variables present in the string.
* @retval int If there is a callback, the return value of the callback is returned,
* @retval 0 otherwise
* This is the only place where cligen callbacks are invoked
* To understand callbacks0. Assume clispec:
* @fn, foo();
* fn:
* a, bar();
* @see pt_expand_fnv where expand callbacks are invoked
*/
int
cligen_eval(cligen_handle h,
cg_obj *co,
cvec *cvv)
{
int retval = -1;
cg_callback *cc;
cvec *argv;
cvec *cvv1 = NULL; /* Modified */
cgv_fnstype_t *fn;
cligen_eval_wrap_fn *wrapfn = NULL;
void *wraparg = NULL;
void *wh = NULL; /* eval wrap handle */