]> git.proxmox.com Git - mirror_frr.git/blame - lib/command.c
build: Quagga 0.99.23-rc1
[mirror_frr.git] / lib / command.c
CommitLineData
274a4a44 1/*
274a4a44 2 Command interpreter routine for virtual terminal [aka TeletYpe]
718e3744 3 Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
cd40b329
CF
4 Copyright (C) 2013 by Open Source Routing.
5 Copyright (C) 2013 by Internet Systems Consortium, Inc. ("ISC")
718e3744 6
7This file is part of GNU Zebra.
8
9GNU Zebra is free software; you can redistribute it and/or modify
10it under the terms of the GNU General Public License as published
11by the Free Software Foundation; either version 2, or (at your
12option) any later version.
13
14GNU Zebra is distributed in the hope that it will be useful, but
15WITHOUT ANY WARRANTY; without even the implied warranty of
16MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17General Public License for more details.
18
19You should have received a copy of the GNU General Public License
20along with GNU Zebra; see the file COPYING. If not, write to the
21Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22Boston, MA 02111-1307, USA. */
23
24#include <zebra.h>
25
b21b19c5 26
718e3744 27#include "memory.h"
28#include "log.h"
5e4fa164 29#include <lib/version.h>
9ab6812d 30#include "thread.h"
b21b19c5 31#include "vector.h"
32#include "vty.h"
33#include "command.h"
354d119a 34#include "workqueue.h"
718e3744 35
36/* Command vector which includes some level of command lists. Normally
37 each daemon maintains each own cmdvec. */
eb820afe 38vector cmdvec = NULL;
718e3744 39
cd40b329 40struct cmd_token token_cr;
228da428
CC
41char *command_cr = NULL;
42
cd40b329
CF
43enum filter_type
44{
45 FILTER_RELAXED,
46 FILTER_STRICT
47};
48
49enum matcher_rv
50{
51 MATCHER_OK,
52 MATCHER_COMPLETE,
53 MATCHER_INCOMPLETE,
54 MATCHER_NO_MATCH,
55 MATCHER_AMBIGUOUS,
56 MATCHER_EXCEED_ARGC_MAX
57};
58
59#define MATCHER_ERROR(matcher_rv) \
60 ( (matcher_rv) == MATCHER_INCOMPLETE \
61 || (matcher_rv) == MATCHER_NO_MATCH \
62 || (matcher_rv) == MATCHER_AMBIGUOUS \
63 || (matcher_rv) == MATCHER_EXCEED_ARGC_MAX \
64 )
65
718e3744 66/* Host information structure. */
67struct host host;
68
718e3744 69/* Standard command node structures. */
7fc626de 70static struct cmd_node auth_node =
718e3744 71{
72 AUTH_NODE,
73 "Password: ",
74};
75
7fc626de 76static struct cmd_node view_node =
718e3744 77{
78 VIEW_NODE,
79 "%s> ",
80};
81
7fc626de 82static struct cmd_node restricted_node =
62687ff1
PJ
83{
84 RESTRICTED_NODE,
85 "%s$ ",
86};
87
7fc626de 88static struct cmd_node auth_enable_node =
718e3744 89{
90 AUTH_ENABLE_NODE,
91 "Password: ",
92};
93
7fc626de 94static struct cmd_node enable_node =
718e3744 95{
96 ENABLE_NODE,
97 "%s# ",
98};
99
7fc626de 100static struct cmd_node config_node =
718e3744 101{
102 CONFIG_NODE,
103 "%s(config)# ",
104 1
105};
6590f2c3 106
107/* Default motd string. */
2d362d10 108static const char *default_motd =
6590f2c3 109"\r\n\
110Hello, this is " QUAGGA_PROGNAME " (version " QUAGGA_VERSION ").\r\n\
111" QUAGGA_COPYRIGHT "\r\n\
0be793e6 112" GIT_INFO "\r\n";
6590f2c3 113
274a4a44 114
2d362d10 115static const struct facility_map {
274a4a44 116 int facility;
117 const char *name;
118 size_t match;
119} syslog_facilities[] =
120 {
121 { LOG_KERN, "kern", 1 },
122 { LOG_USER, "user", 2 },
123 { LOG_MAIL, "mail", 1 },
124 { LOG_DAEMON, "daemon", 1 },
125 { LOG_AUTH, "auth", 1 },
126 { LOG_SYSLOG, "syslog", 1 },
127 { LOG_LPR, "lpr", 2 },
128 { LOG_NEWS, "news", 1 },
129 { LOG_UUCP, "uucp", 2 },
130 { LOG_CRON, "cron", 1 },
131#ifdef LOG_FTP
132 { LOG_FTP, "ftp", 1 },
133#endif
134 { LOG_LOCAL0, "local0", 6 },
135 { LOG_LOCAL1, "local1", 6 },
136 { LOG_LOCAL2, "local2", 6 },
137 { LOG_LOCAL3, "local3", 6 },
138 { LOG_LOCAL4, "local4", 6 },
139 { LOG_LOCAL5, "local5", 6 },
140 { LOG_LOCAL6, "local6", 6 },
141 { LOG_LOCAL7, "local7", 6 },
142 { 0, NULL, 0 },
143 };
144
145static const char *
146facility_name(int facility)
147{
2d362d10 148 const struct facility_map *fm;
274a4a44 149
150 for (fm = syslog_facilities; fm->name; fm++)
151 if (fm->facility == facility)
152 return fm->name;
153 return "";
154}
155
156static int
157facility_match(const char *str)
158{
2d362d10 159 const struct facility_map *fm;
274a4a44 160
161 for (fm = syslog_facilities; fm->name; fm++)
162 if (!strncmp(str,fm->name,fm->match))
163 return fm->facility;
164 return -1;
165}
166
167static int
168level_match(const char *s)
169{
170 int level ;
171
172 for ( level = 0 ; zlog_priority [level] != NULL ; level ++ )
173 if (!strncmp (s, zlog_priority[level], 2))
174 return level;
175 return ZLOG_DISABLED;
176}
177
cb585b65 178/* This is called from main when a daemon is invoked with -v or --version. */
6590f2c3 179void
180print_version (const char *progname)
181{
cb585b65 182 printf ("%s version %s\n", progname, QUAGGA_VERSION);
183 printf ("%s\n", QUAGGA_COPYRIGHT);
6590f2c3 184}
185
718e3744 186\f
187/* Utility function to concatenate argv argument into a single string
188 with inserting ' ' character between each argument. */
189char *
42d49865 190argv_concat (const char **argv, int argc, int shift)
718e3744 191{
192 int i;
f6834d4c 193 size_t len;
718e3744 194 char *str;
f6834d4c 195 char *p;
718e3744 196
f6834d4c 197 len = 0;
198 for (i = shift; i < argc; i++)
199 len += strlen(argv[i])+1;
200 if (!len)
201 return NULL;
202 p = str = XMALLOC(MTYPE_TMP, len);
718e3744 203 for (i = shift; i < argc; i++)
204 {
f6834d4c 205 size_t arglen;
206 memcpy(p, argv[i], (arglen = strlen(argv[i])));
207 p += arglen;
208 *p++ = ' ';
718e3744 209 }
f6834d4c 210 *(p-1) = '\0';
718e3744 211 return str;
212}
213
214/* Install top node of command vector. */
215void
216install_node (struct cmd_node *node,
217 int (*func) (struct vty *))
218{
219 vector_set_index (cmdvec, node->node, node);
220 node->func = func;
221 node->cmd_vector = vector_init (VECTOR_MIN_SIZE);
222}
223
718e3744 224/* Breaking up string into each command piece. I assume given
225 character is separated by a space character. Return value is a
226 vector which includes char ** data element. */
227vector
ea8e9d97 228cmd_make_strvec (const char *string)
718e3744 229{
ea8e9d97 230 const char *cp, *start;
231 char *token;
718e3744 232 int strlen;
233 vector strvec;
234
235 if (string == NULL)
236 return NULL;
237
238 cp = string;
239
240 /* Skip white spaces. */
241 while (isspace ((int) *cp) && *cp != '\0')
242 cp++;
243
244 /* Return if there is only white spaces */
245 if (*cp == '\0')
246 return NULL;
247
248 if (*cp == '!' || *cp == '#')
249 return NULL;
250
251 /* Prepare return vector. */
252 strvec = vector_init (VECTOR_MIN_SIZE);
253
254 /* Copy each command piece and set into vector. */
255 while (1)
256 {
257 start = cp;
258 while (!(isspace ((int) *cp) || *cp == '\r' || *cp == '\n') &&
259 *cp != '\0')
260 cp++;
261 strlen = cp - start;
262 token = XMALLOC (MTYPE_STRVEC, strlen + 1);
263 memcpy (token, start, strlen);
264 *(token + strlen) = '\0';
265 vector_set (strvec, token);
266
267 while ((isspace ((int) *cp) || *cp == '\n' || *cp == '\r') &&
268 *cp != '\0')
269 cp++;
270
271 if (*cp == '\0')
272 return strvec;
273 }
274}
275
276/* Free allocated string vector. */
277void
278cmd_free_strvec (vector v)
279{
8c328f11 280 unsigned int i;
718e3744 281 char *cp;
282
283 if (!v)
284 return;
285
55468c86 286 for (i = 0; i < vector_active (v); i++)
718e3744 287 if ((cp = vector_slot (v, i)) != NULL)
288 XFREE (MTYPE_STRVEC, cp);
289
290 vector_free (v);
291}
292
cd40b329
CF
293struct format_parser_state
294{
295 vector topvect; /* Top level vector */
296 vector intvect; /* Intermediate level vector, used when there's
297 * a multiple in a keyword. */
298 vector curvect; /* current vector where read tokens should be
299 appended. */
300
301 const char *string; /* pointer to command string, not modified */
302 const char *cp; /* pointer in command string, moved along while
303 parsing */
304 const char *dp; /* pointer in description string, moved along while
305 parsing */
306
307 int in_keyword; /* flag to remember if we are in a keyword group */
308 int in_multiple; /* flag to remember if we are in a multiple group */
309 int just_read_word; /* flag to remember if the last thing we red was a
310 * real word and not some abstract token */
311};
312
313static void
314format_parser_error(struct format_parser_state *state, const char *message)
315{
316 int offset = state->cp - state->string + 1;
317
318 fprintf(stderr, "\nError parsing command: \"%s\"\n", state->string);
319 fprintf(stderr, " %*c\n", offset, '^');
320 fprintf(stderr, "%s at offset %d.\n", message, offset);
321 fprintf(stderr, "This is a programming error. Check your DEFUNs etc.\n");
322 exit(1);
323}
324
274a4a44 325static char *
cd40b329 326format_parser_desc_str(struct format_parser_state *state)
718e3744 327{
6ad96ea1 328 const char *cp, *start;
329 char *token;
718e3744 330 int strlen;
cd40b329
CF
331
332 cp = state->dp;
718e3744 333
334 if (cp == NULL)
335 return NULL;
336
337 /* Skip white spaces. */
338 while (isspace ((int) *cp) && *cp != '\0')
339 cp++;
340
341 /* Return if there is only white spaces */
342 if (*cp == '\0')
343 return NULL;
344
345 start = cp;
346
347 while (!(*cp == '\r' || *cp == '\n') && *cp != '\0')
348 cp++;
349
350 strlen = cp - start;
cd40b329 351 token = XMALLOC (MTYPE_CMD_TOKENS, strlen + 1);
718e3744 352 memcpy (token, start, strlen);
353 *(token + strlen) = '\0';
354
cd40b329 355 state->dp = cp;
718e3744 356
357 return token;
358}
359
cd40b329
CF
360static void
361format_parser_begin_keyword(struct format_parser_state *state)
718e3744 362{
cd40b329
CF
363 struct cmd_token *token;
364 vector keyword_vect;
718e3744 365
cd40b329
CF
366 if (state->in_keyword
367 || state->in_multiple)
368 format_parser_error(state, "Unexpected '{'");
718e3744 369
cd40b329
CF
370 state->cp++;
371 state->in_keyword = 1;
718e3744 372
cd40b329
CF
373 token = XCALLOC(MTYPE_CMD_TOKENS, sizeof(*token));
374 token->type = TOKEN_KEYWORD;
375 token->keyword = vector_init(VECTOR_MIN_SIZE);
718e3744 376
cd40b329
CF
377 keyword_vect = vector_init(VECTOR_MIN_SIZE);
378 vector_set(token->keyword, keyword_vect);
718e3744 379
cd40b329
CF
380 vector_set(state->curvect, token);
381 state->curvect = keyword_vect;
382}
718e3744 383
cd40b329
CF
384static void
385format_parser_begin_multiple(struct format_parser_state *state)
386{
387 struct cmd_token *token;
718e3744 388
cd40b329
CF
389 if (state->in_keyword == 1)
390 format_parser_error(state, "Keyword starting with '('");
718e3744 391
cd40b329
CF
392 if (state->in_multiple)
393 format_parser_error(state, "Nested group");
718e3744 394
cd40b329
CF
395 state->cp++;
396 state->in_multiple = 1;
397 state->just_read_word = 0;
398
399 token = XCALLOC(MTYPE_CMD_TOKENS, sizeof(*token));
400 token->type = TOKEN_MULTIPLE;
401 token->multiple = vector_init(VECTOR_MIN_SIZE);
718e3744 402
cd40b329
CF
403 vector_set(state->curvect, token);
404 if (state->curvect != state->topvect)
405 state->intvect = state->curvect;
406 state->curvect = token->multiple;
407}
718e3744 408
cd40b329
CF
409static void
410format_parser_end_keyword(struct format_parser_state *state)
411{
412 if (state->in_multiple
413 || !state->in_keyword)
414 format_parser_error(state, "Unexpected '}'");
718e3744 415
cd40b329
CF
416 if (state->in_keyword == 1)
417 format_parser_error(state, "Empty keyword group");
718e3744 418
cd40b329
CF
419 state->cp++;
420 state->in_keyword = 0;
421 state->curvect = state->topvect;
422}
423
424static void
425format_parser_end_multiple(struct format_parser_state *state)
426{
427 char *dummy;
428
429 if (!state->in_multiple)
430 format_parser_error(state, "Unepexted ')'");
431
432 if (vector_active(state->curvect) == 0)
433 format_parser_error(state, "Empty multiple section");
434
435 if (!state->just_read_word)
436 {
437 /* There are constructions like
438 * 'show ip ospf database ... (self-originate|)'
439 * in use.
440 * The old parser reads a description string for the
441 * word '' between |) which will never match.
442 * Simulate this behvaior by dropping the next desc
443 * string in such a case. */
444
445 dummy = format_parser_desc_str(state);
446 XFREE(MTYPE_CMD_TOKENS, dummy);
718e3744 447 }
cd40b329
CF
448
449 state->cp++;
450 state->in_multiple = 0;
451
452 if (state->intvect)
453 state->curvect = state->intvect;
454 else
455 state->curvect = state->topvect;
718e3744 456}
457
cd40b329
CF
458static void
459format_parser_handle_pipe(struct format_parser_state *state)
718e3744 460{
cd40b329
CF
461 struct cmd_token *keyword_token;
462 vector keyword_vect;
718e3744 463
cd40b329 464 if (state->in_multiple)
718e3744 465 {
cd40b329
CF
466 state->just_read_word = 0;
467 state->cp++;
468 }
469 else if (state->in_keyword)
470 {
471 state->in_keyword = 1;
472 state->cp++;
473
474 keyword_token = vector_slot(state->topvect,
475 vector_active(state->topvect) - 1);
476 keyword_vect = vector_init(VECTOR_MIN_SIZE);
477 vector_set(keyword_token->keyword, keyword_vect);
478 state->curvect = keyword_vect;
479 }
480 else
481 {
482 format_parser_error(state, "Unexpected '|'");
483 }
484}
485
486static void
487format_parser_read_word(struct format_parser_state *state)
488{
489 const char *start;
490 int len;
491 char *cmd;
492 struct cmd_token *token;
493
494 start = state->cp;
495
496 while (state->cp[0] != '\0'
497 && !strchr("\r\n(){}|", state->cp[0])
498 && !isspace((int)state->cp[0]))
499 state->cp++;
500
501 len = state->cp - start;
502 cmd = XMALLOC(MTYPE_CMD_TOKENS, len + 1);
503 memcpy(cmd, start, len);
504 cmd[len] = '\0';
505
506 token = XCALLOC(MTYPE_CMD_TOKENS, sizeof(*token));
507 token->type = TOKEN_TERMINAL;
508 token->cmd = cmd;
509 token->desc = format_parser_desc_str(state);
510 vector_set(state->curvect, token);
511
512 if (state->in_keyword == 1)
513 state->in_keyword = 2;
514
515 state->just_read_word = 1;
516}
517
518/**
519 * Parse a given command format string and build a tree of tokens from
520 * it that is suitable to be used by the command subsystem.
521 *
522 * @param string Command format string.
523 * @param descstr Description string.
524 * @return A vector of struct cmd_token representing the given command,
525 * or NULL on error.
526 */
527static vector
528cmd_parse_format(const char *string, const char *descstr)
529{
530 struct format_parser_state state;
531
532 if (string == NULL)
533 return NULL;
534
535 memset(&state, 0, sizeof(state));
536 state.topvect = state.curvect = vector_init(VECTOR_MIN_SIZE);
537 state.cp = state.string = string;
538 state.dp = descstr;
539
540 while (1)
541 {
542 while (isspace((int)state.cp[0]) && state.cp[0] != '\0')
543 state.cp++;
544
545 switch (state.cp[0])
546 {
547 case '\0':
548 if (state.in_keyword
549 || state.in_multiple)
550 format_parser_error(&state, "Unclosed group/keyword");
551 return state.topvect;
552 case '{':
553 format_parser_begin_keyword(&state);
554 break;
555 case '(':
556 format_parser_begin_multiple(&state);
557 break;
558 case '}':
559 format_parser_end_keyword(&state);
560 break;
561 case ')':
562 format_parser_end_multiple(&state);
563 break;
564 case '|':
565 format_parser_handle_pipe(&state);
566 break;
567 default:
568 format_parser_read_word(&state);
569 }
718e3744 570 }
718e3744 571}
572
573/* Return prompt character of specified node. */
8c328f11 574const char *
718e3744 575cmd_prompt (enum node_type node)
576{
577 struct cmd_node *cnode;
578
579 cnode = vector_slot (cmdvec, node);
580 return cnode->prompt;
581}
582
583/* Install a command into a node. */
584void
585install_element (enum node_type ntype, struct cmd_element *cmd)
586{
587 struct cmd_node *cnode;
eb820afe 588
589 /* cmd_init hasn't been called */
590 if (!cmdvec)
591 return;
592
718e3744 593 cnode = vector_slot (cmdvec, ntype);
594
595 if (cnode == NULL)
596 {
597 fprintf (stderr, "Command node %d doesn't exist, please check it\n",
598 ntype);
599 exit (1);
600 }
601
602 vector_set (cnode->cmd_vector, cmd);
cd40b329
CF
603 if (cmd->tokens == NULL)
604 cmd->tokens = cmd_parse_format(cmd->string, cmd->doc);
718e3744 605}
606
2d362d10 607static const unsigned char itoa64[] =
718e3744 608"./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
609
274a4a44 610static void
718e3744 611to64(char *s, long v, int n)
612{
613 while (--n >= 0)
614 {
615 *s++ = itoa64[v&0x3f];
616 v >>= 6;
617 }
618}
619
274a4a44 620static char *
621zencrypt (const char *passwd)
718e3744 622{
623 char salt[6];
624 struct timeval tv;
625 char *crypt (const char *, const char *);
626
627 gettimeofday(&tv,0);
628
629 to64(&salt[0], random(), 3);
630 to64(&salt[3], tv.tv_usec, 3);
631 salt[5] = '\0';
632
633 return crypt (passwd, salt);
634}
635
636/* This function write configuration of this host. */
274a4a44 637static int
718e3744 638config_write_host (struct vty *vty)
639{
640 if (host.name)
641 vty_out (vty, "hostname %s%s", host.name, VTY_NEWLINE);
642
643 if (host.encrypt)
644 {
645 if (host.password_encrypt)
646 vty_out (vty, "password 8 %s%s", host.password_encrypt, VTY_NEWLINE);
647 if (host.enable_encrypt)
648 vty_out (vty, "enable password 8 %s%s", host.enable_encrypt, VTY_NEWLINE);
649 }
650 else
651 {
652 if (host.password)
653 vty_out (vty, "password %s%s", host.password, VTY_NEWLINE);
654 if (host.enable)
655 vty_out (vty, "enable password %s%s", host.enable, VTY_NEWLINE);
656 }
657
274a4a44 658 if (zlog_default->default_lvl != LOG_DEBUG)
82146b88 659 {
660 vty_out (vty, "! N.B. The 'log trap' command is deprecated.%s",
661 VTY_NEWLINE);
662 vty_out (vty, "log trap %s%s",
663 zlog_priority[zlog_default->default_lvl], VTY_NEWLINE);
664 }
274a4a44 665
666 if (host.logfile && (zlog_default->maxlvl[ZLOG_DEST_FILE] != ZLOG_DISABLED))
667 {
668 vty_out (vty, "log file %s", host.logfile);
669 if (zlog_default->maxlvl[ZLOG_DEST_FILE] != zlog_default->default_lvl)
670 vty_out (vty, " %s",
671 zlog_priority[zlog_default->maxlvl[ZLOG_DEST_FILE]]);
672 vty_out (vty, "%s", VTY_NEWLINE);
673 }
674
675 if (zlog_default->maxlvl[ZLOG_DEST_STDOUT] != ZLOG_DISABLED)
676 {
677 vty_out (vty, "log stdout");
678 if (zlog_default->maxlvl[ZLOG_DEST_STDOUT] != zlog_default->default_lvl)
679 vty_out (vty, " %s",
680 zlog_priority[zlog_default->maxlvl[ZLOG_DEST_STDOUT]]);
681 vty_out (vty, "%s", VTY_NEWLINE);
682 }
718e3744 683
274a4a44 684 if (zlog_default->maxlvl[ZLOG_DEST_MONITOR] == ZLOG_DISABLED)
685 vty_out(vty,"no log monitor%s",VTY_NEWLINE);
686 else if (zlog_default->maxlvl[ZLOG_DEST_MONITOR] != zlog_default->default_lvl)
687 vty_out(vty,"log monitor %s%s",
688 zlog_priority[zlog_default->maxlvl[ZLOG_DEST_MONITOR]],VTY_NEWLINE);
718e3744 689
274a4a44 690 if (zlog_default->maxlvl[ZLOG_DEST_SYSLOG] != ZLOG_DISABLED)
12ab19f1 691 {
692 vty_out (vty, "log syslog");
274a4a44 693 if (zlog_default->maxlvl[ZLOG_DEST_SYSLOG] != zlog_default->default_lvl)
694 vty_out (vty, " %s",
695 zlog_priority[zlog_default->maxlvl[ZLOG_DEST_SYSLOG]]);
12ab19f1 696 vty_out (vty, "%s", VTY_NEWLINE);
697 }
274a4a44 698
699 if (zlog_default->facility != LOG_DAEMON)
700 vty_out (vty, "log facility %s%s",
701 facility_name(zlog_default->facility), VTY_NEWLINE);
718e3744 702
703 if (zlog_default->record_priority == 1)
704 vty_out (vty, "log record-priority%s", VTY_NEWLINE);
705
1ed72e0b
AS
706 if (zlog_default->timestamp_precision > 0)
707 vty_out (vty, "log timestamp precision %d%s",
708 zlog_default->timestamp_precision, VTY_NEWLINE);
709
718e3744 710 if (host.advanced)
711 vty_out (vty, "service advanced-vty%s", VTY_NEWLINE);
712
713 if (host.encrypt)
714 vty_out (vty, "service password-encryption%s", VTY_NEWLINE);
715
716 if (host.lines >= 0)
717 vty_out (vty, "service terminal-length %d%s", host.lines,
718 VTY_NEWLINE);
719
3b0c5d9a 720 if (host.motdfile)
721 vty_out (vty, "banner motd file %s%s", host.motdfile, VTY_NEWLINE);
722 else if (! host.motd)
718e3744 723 vty_out (vty, "no banner motd%s", VTY_NEWLINE);
724
725 return 1;
726}
727
728/* Utility function for getting command vector. */
274a4a44 729static vector
718e3744 730cmd_node_vector (vector v, enum node_type ntype)
731{
732 struct cmd_node *cnode = vector_slot (v, ntype);
733 return cnode->cmd_vector;
734}
735
274a4a44 736#if 0
737/* Filter command vector by symbol. This function is not actually used;
738 * should it be deleted? */
739static int
718e3744 740cmd_filter_by_symbol (char *command, char *symbol)
741{
742 int i, lim;
743
744 if (strcmp (symbol, "IPV4_ADDRESS") == 0)
745 {
746 i = 0;
747 lim = strlen (command);
748 while (i < lim)
749 {
750 if (! (isdigit ((int) command[i]) || command[i] == '.' || command[i] == '/'))
751 return 1;
752 i++;
753 }
754 return 0;
755 }
756 if (strcmp (symbol, "STRING") == 0)
757 {
758 i = 0;
759 lim = strlen (command);
760 while (i < lim)
761 {
762 if (! (isalpha ((int) command[i]) || command[i] == '_' || command[i] == '-'))
763 return 1;
764 i++;
765 }
766 return 0;
767 }
768 if (strcmp (symbol, "IFNAME") == 0)
769 {
770 i = 0;
771 lim = strlen (command);
772 while (i < lim)
773 {
774 if (! isalnum ((int) command[i]))
775 return 1;
776 i++;
777 }
778 return 0;
779 }
780 return 0;
781}
274a4a44 782#endif
718e3744 783
784/* Completion match types. */
785enum match_type
786{
787 no_match,
788 extend_match,
789 ipv4_prefix_match,
790 ipv4_match,
791 ipv6_prefix_match,
792 ipv6_match,
793 range_match,
794 vararg_match,
795 partly_match,
796 exact_match
797};
798
274a4a44 799static enum match_type
8c328f11 800cmd_ipv4_match (const char *str)
718e3744 801{
8c328f11 802 const char *sp;
718e3744 803 int dots = 0, nums = 0;
804 char buf[4];
805
806 if (str == NULL)
807 return partly_match;
808
809 for (;;)
810 {
811 memset (buf, 0, sizeof (buf));
812 sp = str;
813 while (*str != '\0')
814 {
815 if (*str == '.')
816 {
817 if (dots >= 3)
818 return no_match;
819
820 if (*(str + 1) == '.')
821 return no_match;
822
823 if (*(str + 1) == '\0')
824 return partly_match;
825
826 dots++;
827 break;
828 }
829 if (!isdigit ((int) *str))
830 return no_match;
831
832 str++;
833 }
834
835 if (str - sp > 3)
836 return no_match;
837
838 strncpy (buf, sp, str - sp);
839 if (atoi (buf) > 255)
840 return no_match;
841
842 nums++;
843
844 if (*str == '\0')
845 break;
846
847 str++;
848 }
849
850 if (nums < 4)
851 return partly_match;
852
853 return exact_match;
854}
855
274a4a44 856static enum match_type
8c328f11 857cmd_ipv4_prefix_match (const char *str)
718e3744 858{
8c328f11 859 const char *sp;
718e3744 860 int dots = 0;
861 char buf[4];
862
863 if (str == NULL)
864 return partly_match;
865
866 for (;;)
867 {
868 memset (buf, 0, sizeof (buf));
869 sp = str;
870 while (*str != '\0' && *str != '/')
871 {
872 if (*str == '.')
873 {
874 if (dots == 3)
875 return no_match;
876
877 if (*(str + 1) == '.' || *(str + 1) == '/')
878 return no_match;
879
880 if (*(str + 1) == '\0')
881 return partly_match;
882
883 dots++;
884 break;
885 }
886
887 if (!isdigit ((int) *str))
888 return no_match;
889
890 str++;
891 }
892
893 if (str - sp > 3)
894 return no_match;
895
896 strncpy (buf, sp, str - sp);
897 if (atoi (buf) > 255)
898 return no_match;
899
900 if (dots == 3)
901 {
902 if (*str == '/')
903 {
904 if (*(str + 1) == '\0')
905 return partly_match;
906
907 str++;
908 break;
909 }
910 else if (*str == '\0')
911 return partly_match;
912 }
913
914 if (*str == '\0')
915 return partly_match;
916
917 str++;
918 }
919
920 sp = str;
921 while (*str != '\0')
922 {
923 if (!isdigit ((int) *str))
924 return no_match;
925
926 str++;
927 }
928
929 if (atoi (sp) > 32)
930 return no_match;
931
932 return exact_match;
933}
934
935#define IPV6_ADDR_STR "0123456789abcdefABCDEF:.%"
936#define IPV6_PREFIX_STR "0123456789abcdefABCDEF:.%/"
937#define STATE_START 1
938#define STATE_COLON 2
939#define STATE_DOUBLE 3
940#define STATE_ADDR 4
941#define STATE_DOT 5
942#define STATE_SLASH 6
943#define STATE_MASK 7
944
22e0a9e6 945#ifdef HAVE_IPV6
946
274a4a44 947static enum match_type
8c328f11 948cmd_ipv6_match (const char *str)
718e3744 949{
726f9b2b 950 struct sockaddr_in6 sin6_dummy;
951 int ret;
718e3744 952
953 if (str == NULL)
954 return partly_match;
955
956 if (strspn (str, IPV6_ADDR_STR) != strlen (str))
957 return no_match;
958
726f9b2b 959 /* use inet_pton that has a better support,
960 * for example inet_pton can support the automatic addresses:
961 * ::1.2.3.4
962 */
963 ret = inet_pton(AF_INET6, str, &sin6_dummy.sin6_addr);
964
965 if (ret == 1)
966 return exact_match;
967
7c9c6aeb 968 return no_match;
718e3744 969}
970
274a4a44 971static enum match_type
8c328f11 972cmd_ipv6_prefix_match (const char *str)
718e3744 973{
974 int state = STATE_START;
975 int colons = 0, nums = 0, double_colon = 0;
976 int mask;
8c328f11 977 const char *sp = NULL;
718e3744 978 char *endptr = NULL;
979
980 if (str == NULL)
981 return partly_match;
982
983 if (strspn (str, IPV6_PREFIX_STR) != strlen (str))
984 return no_match;
985
986 while (*str != '\0' && state != STATE_MASK)
987 {
988 switch (state)
989 {
990 case STATE_START:
991 if (*str == ':')
992 {
993 if (*(str + 1) != ':' && *(str + 1) != '\0')
994 return no_match;
995 colons--;
996 state = STATE_COLON;
997 }
998 else
999 {
1000 sp = str;
1001 state = STATE_ADDR;
1002 }
1003
1004 continue;
1005 case STATE_COLON:
1006 colons++;
1007 if (*(str + 1) == '/')
1008 return no_match;
1009 else if (*(str + 1) == ':')
1010 state = STATE_DOUBLE;
1011 else
1012 {
1013 sp = str + 1;
1014 state = STATE_ADDR;
1015 }
1016 break;
1017 case STATE_DOUBLE:
1018 if (double_colon)
1019 return no_match;
1020
1021 if (*(str + 1) == ':')
1022 return no_match;
1023 else
1024 {
1025 if (*(str + 1) != '\0' && *(str + 1) != '/')
1026 colons++;
1027 sp = str + 1;
1028
1029 if (*(str + 1) == '/')
1030 state = STATE_SLASH;
1031 else
1032 state = STATE_ADDR;
1033 }
1034
1035 double_colon++;
1036 nums += 1;
1037 break;
1038 case STATE_ADDR:
1039 if (*(str + 1) == ':' || *(str + 1) == '.'
1040 || *(str + 1) == '\0' || *(str + 1) == '/')
1041 {
1042 if (str - sp > 3)
1043 return no_match;
1044
1045 for (; sp <= str; sp++)
1046 if (*sp == '/')
1047 return no_match;
1048
1049 nums++;
1050
1051 if (*(str + 1) == ':')
1052 state = STATE_COLON;
1053 else if (*(str + 1) == '.')
aa5cf24b
DL
1054 {
1055 if (colons || double_colon)
1056 state = STATE_DOT;
1057 else
1058 return no_match;
1059 }
718e3744 1060 else if (*(str + 1) == '/')
1061 state = STATE_SLASH;
1062 }
1063 break;
1064 case STATE_DOT:
1065 state = STATE_ADDR;
1066 break;
1067 case STATE_SLASH:
1068 if (*(str + 1) == '\0')
1069 return partly_match;
1070
1071 state = STATE_MASK;
1072 break;
1073 default:
1074 break;
1075 }
1076
1077 if (nums > 11)
1078 return no_match;
1079
1080 if (colons > 7)
1081 return no_match;
1082
1083 str++;
1084 }
1085
1086 if (state < STATE_MASK)
1087 return partly_match;
1088
1089 mask = strtol (str, &endptr, 10);
1090 if (*endptr != '\0')
1091 return no_match;
1092
1093 if (mask < 0 || mask > 128)
1094 return no_match;
1095
1096/* I don't know why mask < 13 makes command match partly.
1097 Forgive me to make this comments. I Want to set static default route
1098 because of lack of function to originate default in ospf6d; sorry
1099 yasu
1100 if (mask < 13)
1101 return partly_match;
1102*/
1103
1104 return exact_match;
1105}
1106
22e0a9e6 1107#endif /* HAVE_IPV6 */
1108
718e3744 1109#define DECIMAL_STRLEN_MAX 10
1110
274a4a44 1111static int
8c328f11 1112cmd_range_match (const char *range, const char *str)
718e3744 1113{
1114 char *p;
1115 char buf[DECIMAL_STRLEN_MAX + 1];
1116 char *endptr = NULL;
1117 unsigned long min, max, val;
1118
1119 if (str == NULL)
1120 return 1;
1121
1122 val = strtoul (str, &endptr, 10);
1123 if (*endptr != '\0')
1124 return 0;
1125
1126 range++;
1127 p = strchr (range, '-');
1128 if (p == NULL)
1129 return 0;
1130 if (p - range > DECIMAL_STRLEN_MAX)
1131 return 0;
1132 strncpy (buf, range, p - range);
1133 buf[p - range] = '\0';
1134 min = strtoul (buf, &endptr, 10);
1135 if (*endptr != '\0')
1136 return 0;
1137
1138 range = p + 1;
1139 p = strchr (range, '>');
1140 if (p == NULL)
1141 return 0;
1142 if (p - range > DECIMAL_STRLEN_MAX)
1143 return 0;
1144 strncpy (buf, range, p - range);
1145 buf[p - range] = '\0';
1146 max = strtoul (buf, &endptr, 10);
1147 if (*endptr != '\0')
1148 return 0;
1149
1150 if (val < min || val > max)
1151 return 0;
1152
1153 return 1;
1154}
1155
274a4a44 1156static enum match_type
cd40b329
CF
1157cmd_word_match(struct cmd_token *token,
1158 enum filter_type filter,
1159 const char *word)
718e3744 1160{
8c328f11 1161 const char *str;
718e3744 1162 enum match_type match_type;
909a2155 1163
cd40b329 1164 str = token->cmd;
718e3744 1165
cd40b329
CF
1166 if (filter == FILTER_RELAXED)
1167 if (!word || !strlen(word))
1168 return partly_match;
718e3744 1169
cd40b329
CF
1170 if (!word)
1171 return no_match;
909a2155 1172
cd40b329
CF
1173 if (CMD_VARARG(str))
1174 {
1175 return vararg_match;
1176 }
1177 else if (CMD_RANGE(str))
1178 {
1179 if (cmd_range_match(str, word))
1180 return range_match;
1181 }
22e0a9e6 1182#ifdef HAVE_IPV6
cd40b329
CF
1183 else if (CMD_IPV6(str))
1184 {
1185 match_type = cmd_ipv6_match(word);
1186 if ((filter == FILTER_RELAXED && match_type != no_match)
1187 || (filter == FILTER_STRICT && match_type == exact_match))
1188 return ipv6_match;
1189 }
1190 else if (CMD_IPV6_PREFIX(str))
1191 {
1192 match_type = cmd_ipv6_prefix_match(word);
1193 if ((filter == FILTER_RELAXED && match_type != no_match)
1194 || (filter == FILTER_STRICT && match_type == exact_match))
1195 return ipv6_prefix_match;
1196 }
1197#endif /* HAVE_IPV6 */
1198 else if (CMD_IPV4(str))
1199 {
1200 match_type = cmd_ipv4_match(word);
1201 if ((filter == FILTER_RELAXED && match_type != no_match)
1202 || (filter == FILTER_STRICT && match_type == exact_match))
1203 return ipv4_match;
1204 }
1205 else if (CMD_IPV4_PREFIX(str))
1206 {
1207 match_type = cmd_ipv4_prefix_match(word);
1208 if ((filter == FILTER_RELAXED && match_type != no_match)
1209 || (filter == FILTER_STRICT && match_type == exact_match))
1210 return ipv4_prefix_match;
1211 }
1212 else if (CMD_OPTION(str) || CMD_VARIABLE(str))
1213 {
1214 return extend_match;
1215 }
1216 else
1217 {
1218 if (filter == FILTER_RELAXED && !strncmp(str, word, strlen(word)))
1219 {
1220 if (!strcmp(str, word))
1221 return exact_match;
1222 return partly_match;
1223 }
1224 if (filter == FILTER_STRICT && !strcmp(str, word))
1225 return exact_match;
1226 }
909a2155 1227
cd40b329
CF
1228 return no_match;
1229}
909a2155 1230
cd40b329
CF
1231struct cmd_matcher
1232{
1233 struct cmd_element *cmd; /* The command element the matcher is using */
1234 enum filter_type filter; /* Whether to use strict or relaxed matching */
1235 vector vline; /* The tokenized commandline which is to be matched */
1236 unsigned int index; /* The index up to which matching should be done */
909a2155 1237
cd40b329
CF
1238 /* If set, construct a list of matches at the position given by index */
1239 enum match_type *match_type;
1240 vector *match;
1241
1242 unsigned int word_index; /* iterating over vline */
1243};
1244
1245static int
1246push_argument(int *argc, const char **argv, const char *arg)
1247{
1248 if (!arg || !strlen(arg))
1249 arg = NULL;
1250
1251 if (!argc || !argv)
1252 return 0;
1253
1254 if (*argc >= CMD_ARGC_MAX)
1255 return -1;
1256
1257 argv[(*argc)++] = arg;
1258 return 0;
1259}
1260
1261static void
1262cmd_matcher_record_match(struct cmd_matcher *matcher,
1263 enum match_type match_type,
1264 struct cmd_token *token)
1265{
1266 if (matcher->word_index != matcher->index)
1267 return;
1268
1269 if (matcher->match)
1270 {
1271 if (!*matcher->match)
1272 *matcher->match = vector_init(VECTOR_MIN_SIZE);
1273 vector_set(*matcher->match, token);
1274 }
1275
1276 if (matcher->match_type)
1277 {
1278 if (match_type > *matcher->match_type)
1279 *matcher->match_type = match_type;
1280 }
1281}
1282
1283static int
1284cmd_matcher_words_left(struct cmd_matcher *matcher)
1285{
1286 return matcher->word_index < vector_active(matcher->vline);
1287}
1288
1289static const char*
1290cmd_matcher_get_word(struct cmd_matcher *matcher)
1291{
1292 assert(cmd_matcher_words_left(matcher));
1293
1294 return vector_slot(matcher->vline, matcher->word_index);
1295}
1296
1297static enum matcher_rv
1298cmd_matcher_match_terminal(struct cmd_matcher *matcher,
1299 struct cmd_token *token,
1300 int *argc, const char **argv)
1301{
1302 const char *word;
1303 enum match_type word_match;
1304
1305 assert(token->type == TOKEN_TERMINAL);
1306
1307 if (!cmd_matcher_words_left(matcher))
1308 {
1309 if (CMD_OPTION(token->cmd))
1310 return MATCHER_OK; /* missing optional args are NOT pushed as NULL */
1311 else
1312 return MATCHER_INCOMPLETE;
1313 }
1314
1315 word = cmd_matcher_get_word(matcher);
1316 word_match = cmd_word_match(token, matcher->filter, word);
1317 if (word_match == no_match)
1318 return MATCHER_NO_MATCH;
1319
1320 /* We have to record the input word as argument if it matched
1321 * against a variable. */
1322 if (CMD_VARARG(token->cmd)
1323 || CMD_VARIABLE(token->cmd)
1324 || CMD_OPTION(token->cmd))
1325 {
1326 if (push_argument(argc, argv, word))
1327 return MATCHER_EXCEED_ARGC_MAX;
1328 }
1329
1330 cmd_matcher_record_match(matcher, word_match, token);
1331
1332 matcher->word_index++;
1333
1334 /* A vararg token should consume all left over words as arguments */
1335 if (CMD_VARARG(token->cmd))
1336 while (cmd_matcher_words_left(matcher))
1337 {
1338 word = cmd_matcher_get_word(matcher);
1339 if (word && strlen(word))
1340 push_argument(argc, argv, word);
1341 matcher->word_index++;
718e3744 1342 }
cd40b329
CF
1343
1344 return MATCHER_OK;
718e3744 1345}
1346
cd40b329
CF
1347static enum matcher_rv
1348cmd_matcher_match_multiple(struct cmd_matcher *matcher,
1349 struct cmd_token *token,
1350 int *argc, const char **argv)
1351{
1352 enum match_type multiple_match;
1353 unsigned int multiple_index;
1354 const char *word;
1355 const char *arg;
1356 struct cmd_token *word_token;
1357 enum match_type word_match;
1358
1359 assert(token->type == TOKEN_MULTIPLE);
1360
1361 multiple_match = no_match;
1362
1363 if (!cmd_matcher_words_left(matcher))
1364 return MATCHER_INCOMPLETE;
1365
1366 word = cmd_matcher_get_word(matcher);
1367 for (multiple_index = 0;
1368 multiple_index < vector_active(token->multiple);
1369 multiple_index++)
1370 {
1371 word_token = vector_slot(token->multiple, multiple_index);
1372
1373 word_match = cmd_word_match(word_token, matcher->filter, word);
1374 if (word_match == no_match)
1375 continue;
1376
1377 cmd_matcher_record_match(matcher, word_match, word_token);
1378
1379 if (word_match > multiple_match)
1380 {
1381 multiple_match = word_match;
1382 arg = word;
1383 }
1384 /* To mimic the behavior of the old command implementation, we
1385 * tolerate any ambiguities here :/ */
1386 }
1387
1388 matcher->word_index++;
1389
1390 if (multiple_match == no_match)
1391 return MATCHER_NO_MATCH;
1392
1393 if (push_argument(argc, argv, arg))
1394 return MATCHER_EXCEED_ARGC_MAX;
1395
1396 return MATCHER_OK;
1397}
1398
1399static enum matcher_rv
1400cmd_matcher_read_keywords(struct cmd_matcher *matcher,
1401 struct cmd_token *token,
1402 vector args_vector)
718e3744 1403{
8c328f11 1404 unsigned int i;
cd40b329
CF
1405 unsigned long keyword_mask;
1406 unsigned int keyword_found;
1407 enum match_type keyword_match;
1408 enum match_type word_match;
1409 vector keyword_vector;
1410 struct cmd_token *word_token;
1411 const char *word;
1412 int keyword_argc;
1413 const char **keyword_argv;
1414 enum matcher_rv rv;
1415
1416 keyword_mask = 0;
1417 while (1)
1418 {
1419 if (!cmd_matcher_words_left(matcher))
1420 return MATCHER_OK;
909a2155 1421
cd40b329 1422 word = cmd_matcher_get_word(matcher);
718e3744 1423
cd40b329
CF
1424 keyword_found = -1;
1425 keyword_match = no_match;
1426 for (i = 0; i < vector_active(token->keyword); i++)
1427 {
1428 if (keyword_mask & (1 << i))
1429 continue;
1430
1431 keyword_vector = vector_slot(token->keyword, i);
1432 word_token = vector_slot(keyword_vector, 0);
1433
1434 word_match = cmd_word_match(word_token, matcher->filter, word);
1435 if (word_match == no_match)
1436 continue;
1437
1438 cmd_matcher_record_match(matcher, word_match, word_token);
1439
1440 if (word_match > keyword_match)
1441 {
1442 keyword_match = word_match;
1443 keyword_found = i;
1444 }
1445 else if (word_match == keyword_match)
1446 {
1447 if (matcher->word_index != matcher->index || args_vector)
1448 return MATCHER_AMBIGUOUS;
1449 }
1450 }
718e3744 1451
cd40b329
CF
1452 if (keyword_found == (unsigned int)-1)
1453 return MATCHER_NO_MATCH;
718e3744 1454
cd40b329 1455 matcher->word_index++;
909a2155 1456
cd40b329
CF
1457 if (matcher->word_index > matcher->index)
1458 return MATCHER_OK;
1459
1460 keyword_mask |= (1 << keyword_found);
1461
1462 if (args_vector)
1463 {
1464 keyword_argc = 0;
1465 keyword_argv = XMALLOC(MTYPE_TMP, (CMD_ARGC_MAX + 1) * sizeof(char*));
1466 /* We use -1 as a marker for unused fields as NULL might be a valid value */
1467 for (i = 0; i < CMD_ARGC_MAX + 1; i++)
1468 keyword_argv[i] = (void*)-1;
1469 vector_set_index(args_vector, keyword_found, keyword_argv);
1470 }
1471 else
1472 {
1473 keyword_argv = NULL;
1474 }
1475
1476 keyword_vector = vector_slot(token->keyword, keyword_found);
1477 /* the keyword itself is at 0. We are only interested in the arguments,
1478 * so start counting at 1. */
1479 for (i = 1; i < vector_active(keyword_vector); i++)
1480 {
1481 word_token = vector_slot(keyword_vector, i);
1482
1483 switch (word_token->type)
1484 {
1485 case TOKEN_TERMINAL:
1486 rv = cmd_matcher_match_terminal(matcher, word_token,
1487 &keyword_argc, keyword_argv);
1488 break;
1489 case TOKEN_MULTIPLE:
1490 rv = cmd_matcher_match_multiple(matcher, word_token,
1491 &keyword_argc, keyword_argv);
1492 break;
1493 case TOKEN_KEYWORD:
1494 assert(!"Keywords should never be nested.");
1495 break;
1496 }
1497
1498 if (MATCHER_ERROR(rv))
1499 return rv;
1500
1501 if (matcher->word_index > matcher->index)
1502 return MATCHER_OK;
1503 }
1504 }
1505 /* not reached */
1506}
1507
1508static enum matcher_rv
1509cmd_matcher_build_keyword_args(struct cmd_matcher *matcher,
1510 struct cmd_token *token,
1511 int *argc, const char **argv,
1512 vector keyword_args_vector)
1513{
1514 unsigned int i, j;
1515 const char **keyword_args;
1516 vector keyword_vector;
1517 struct cmd_token *word_token;
1518 const char *arg;
1519 enum matcher_rv rv;
1520
1521 rv = MATCHER_OK;
1522
1523 if (keyword_args_vector == NULL)
1524 return rv;
1525
1526 for (i = 0; i < vector_active(token->keyword); i++)
1527 {
1528 keyword_vector = vector_slot(token->keyword, i);
1529 keyword_args = vector_lookup(keyword_args_vector, i);
1530
1531 if (vector_active(keyword_vector) == 1)
1532 {
1533 /* this is a keyword without arguments */
1534 if (keyword_args)
1535 {
1536 word_token = vector_slot(keyword_vector, 0);
1537 arg = word_token->cmd;
1538 }
1539 else
1540 {
1541 arg = NULL;
1542 }
1543
1544 if (push_argument(argc, argv, arg))
1545 rv = MATCHER_EXCEED_ARGC_MAX;
1546 }
1547 else
1548 {
1549 /* this is a keyword with arguments */
1550 if (keyword_args)
1551 {
1552 /* the keyword was present, so just fill in the arguments */
1553 for (j = 0; keyword_args[j] != (void*)-1; j++)
1554 if (push_argument(argc, argv, keyword_args[j]))
1555 rv = MATCHER_EXCEED_ARGC_MAX;
1556 XFREE(MTYPE_TMP, keyword_args);
1557 }
1558 else
1559 {
1560 /* the keyword was not present, insert NULL for the arguments
1561 * the keyword would have taken. */
1562 for (j = 1; j < vector_active(keyword_vector); j++)
1563 {
1564 word_token = vector_slot(keyword_vector, j);
1565 if ((word_token->type == TOKEN_TERMINAL
1566 && (CMD_VARARG(word_token->cmd)
1567 || CMD_VARIABLE(word_token->cmd)
1568 || CMD_OPTION(word_token->cmd)))
1569 || word_token->type == TOKEN_MULTIPLE)
1570 {
1571 if (push_argument(argc, argv, NULL))
1572 rv = MATCHER_EXCEED_ARGC_MAX;
1573 }
1574 }
1575 }
1576 }
1577 }
1578 vector_free(keyword_args_vector);
1579 return rv;
1580}
1581
1582static enum matcher_rv
1583cmd_matcher_match_keyword(struct cmd_matcher *matcher,
1584 struct cmd_token *token,
1585 int *argc, const char **argv)
1586{
1587 vector keyword_args_vector;
1588 enum matcher_rv reader_rv;
1589 enum matcher_rv builder_rv;
1590
1591 assert(token->type == TOKEN_KEYWORD);
1592
1593 if (argc && argv)
1594 keyword_args_vector = vector_init(VECTOR_MIN_SIZE);
1595 else
1596 keyword_args_vector = NULL;
1597
1598 reader_rv = cmd_matcher_read_keywords(matcher, token, keyword_args_vector);
1599 builder_rv = cmd_matcher_build_keyword_args(matcher, token, argc,
1600 argv, keyword_args_vector);
1601 /* keyword_args_vector is consumed by cmd_matcher_build_keyword_args */
1602
1603 if (!MATCHER_ERROR(reader_rv) && MATCHER_ERROR(builder_rv))
1604 return builder_rv;
1605
1606 return reader_rv;
1607}
1608
1609static void
1610cmd_matcher_init(struct cmd_matcher *matcher,
1611 struct cmd_element *cmd,
1612 enum filter_type filter,
1613 vector vline,
1614 unsigned int index,
1615 enum match_type *match_type,
1616 vector *match)
1617{
1618 memset(matcher, 0, sizeof(*matcher));
1619
1620 matcher->cmd = cmd;
1621 matcher->filter = filter;
1622 matcher->vline = vline;
1623 matcher->index = index;
1624
1625 matcher->match_type = match_type;
1626 if (matcher->match_type)
1627 *matcher->match_type = no_match;
1628 matcher->match = match;
1629
1630 matcher->word_index = 0;
1631}
1632
1633static enum matcher_rv
1634cmd_element_match(struct cmd_element *cmd_element,
1635 enum filter_type filter,
1636 vector vline,
1637 unsigned int index,
1638 enum match_type *match_type,
1639 vector *match,
1640 int *argc,
1641 const char **argv)
1642{
1643 struct cmd_matcher matcher;
1644 unsigned int token_index;
1645 enum matcher_rv rv;
1646
1647 cmd_matcher_init(&matcher, cmd_element, filter,
1648 vline, index, match_type, match);
1649
1650 if (argc != NULL)
1651 *argc = 0;
1652
1653 for (token_index = 0;
1654 token_index < vector_active(cmd_element->tokens);
1655 token_index++)
1656 {
1657 struct cmd_token *token = vector_slot(cmd_element->tokens, token_index);
1658
1659 switch (token->type)
1660 {
1661 case TOKEN_TERMINAL:
1662 rv = cmd_matcher_match_terminal(&matcher, token, argc, argv);
1663 break;
1664 case TOKEN_MULTIPLE:
1665 rv = cmd_matcher_match_multiple(&matcher, token, argc, argv);
1666 break;
1667 case TOKEN_KEYWORD:
1668 rv = cmd_matcher_match_keyword(&matcher, token, argc, argv);
1669 }
1670
1671 if (MATCHER_ERROR(rv))
1672 return rv;
1673
1674 if (matcher.word_index > index)
1675 return MATCHER_OK;
1676 }
1677
1678 /* return MATCHER_COMPLETE if all words were consumed */
1679 if (matcher.word_index >= vector_active(vline))
1680 return MATCHER_COMPLETE;
1681
1682 /* return MATCHER_COMPLETE also if only an empty word is left. */
1683 if (matcher.word_index == vector_active(vline) - 1
1684 && (!vector_slot(vline, matcher.word_index)
1685 || !strlen((char*)vector_slot(vline, matcher.word_index))))
1686 return MATCHER_COMPLETE;
1687
1688 return MATCHER_NO_MATCH; /* command is too long to match */
1689}
1690
1691/**
1692 * Filter a given vector of commands against a given commandline and
1693 * calculate possible completions.
1694 *
1695 * @param commands A vector of struct cmd_element*. Commands that don't
1696 * match against the given command line will be overwritten
1697 * with NULL in that vector.
1698 * @param filter Either FILTER_RELAXED or FILTER_STRICT. This basically
1699 * determines how incomplete commands are handled, compare with
1700 * cmd_word_match for details.
1701 * @param vline A vector of char* containing the tokenized commandline.
1702 * @param index Only match up to the given token of the commandline.
1703 * @param match_type Record the type of the best match here.
1704 * @param matches Record the matches here. For each cmd_element in the commands
1705 * vector, a match vector will be created in the matches vector.
1706 * That vector will contain all struct command_token* of the
1707 * cmd_element which matched against the given vline at the given
1708 * index.
1709 * @return A code specifying if an error occured. If all went right, it's
1710 * CMD_SUCCESS.
1711 */
1712static int
1713cmd_vector_filter(vector commands,
1714 enum filter_type filter,
1715 vector vline,
1716 unsigned int index,
1717 enum match_type *match_type,
1718 vector *matches)
1719{
1720 unsigned int i;
1721 struct cmd_element *cmd_element;
1722 enum match_type best_match;
1723 enum match_type element_match;
1724 enum matcher_rv matcher_rv;
1725
1726 best_match = no_match;
1727 *matches = vector_init(VECTOR_MIN_SIZE);
1728
1729 for (i = 0; i < vector_active (commands); i++)
1730 if ((cmd_element = vector_slot (commands, i)) != NULL)
1731 {
1732 vector_set_index(*matches, i, NULL);
1733 matcher_rv = cmd_element_match(cmd_element, filter,
1734 vline, index,
1735 &element_match,
1736 (vector*)&vector_slot(*matches, i),
1737 NULL, NULL);
1738 if (MATCHER_ERROR(matcher_rv))
1739 {
1740 vector_slot(commands, i) = NULL;
1741 if (matcher_rv == MATCHER_AMBIGUOUS)
1742 return CMD_ERR_AMBIGUOUS;
1743 if (matcher_rv == MATCHER_EXCEED_ARGC_MAX)
1744 return CMD_ERR_EXEED_ARGC_MAX;
1745 }
1746 else if (element_match > best_match)
1747 {
1748 best_match = element_match;
1749 }
718e3744 1750 }
cd40b329
CF
1751 *match_type = best_match;
1752 return CMD_SUCCESS;
1753}
1754
1755/**
1756 * Check whether a given commandline is complete if used for a specific
1757 * cmd_element.
1758 *
1759 * @param cmd_element A cmd_element against which the commandline should be
1760 * checked.
1761 * @param vline The tokenized commandline.
1762 * @return 1 if the given commandline is complete, 0 otherwise.
1763 */
1764static int
1765cmd_is_complete(struct cmd_element *cmd_element,
1766 vector vline)
1767{
1768 enum matcher_rv rv;
1769
1770 rv = cmd_element_match(cmd_element,
1771 FILTER_RELAXED,
1772 vline, -1,
1773 NULL, NULL,
1774 NULL, NULL);
1775 return (rv == MATCHER_COMPLETE);
1776}
1777
1778/**
1779 * Parse a given commandline and construct a list of arguments for the
1780 * given command_element.
1781 *
1782 * @param cmd_element The cmd_element for which we want to construct arguments.
1783 * @param vline The tokenized commandline.
1784 * @param argc Where to store the argument count.
1785 * @param argv Where to store the argument list. Should be at least
1786 * CMD_ARGC_MAX elements long.
1787 * @return CMD_SUCCESS if everything went alright, an error otherwise.
1788 */
1789static int
1790cmd_parse(struct cmd_element *cmd_element,
1791 vector vline,
1792 int *argc, const char **argv)
1793{
1794 enum matcher_rv rv = cmd_element_match(cmd_element,
1795 FILTER_RELAXED,
1796 vline, -1,
1797 NULL, NULL,
1798 argc, argv);
1799 switch (rv)
1800 {
1801 case MATCHER_COMPLETE:
1802 return CMD_SUCCESS;
1803
1804 case MATCHER_NO_MATCH:
1805 return CMD_ERR_NO_MATCH;
1806
1807 case MATCHER_AMBIGUOUS:
1808 return CMD_ERR_AMBIGUOUS;
1809
1810 case MATCHER_EXCEED_ARGC_MAX:
1811 return CMD_ERR_EXEED_ARGC_MAX;
1812
1813 default:
1814 return CMD_ERR_INCOMPLETE;
1815 }
718e3744 1816}
1817
1818/* Check ambiguous match */
274a4a44 1819static int
cd40b329
CF
1820is_cmd_ambiguous (vector cmd_vector,
1821 const char *command,
1822 vector matches,
1823 enum match_type type)
718e3744 1824{
8c328f11 1825 unsigned int i;
1826 unsigned int j;
1827 const char *str = NULL;
8c328f11 1828 const char *matched = NULL;
cd40b329
CF
1829 vector match_vector;
1830 struct cmd_token *cmd_token;
909a2155 1831
cd40b329
CF
1832 if (command == NULL)
1833 command = "";
1834
1835 for (i = 0; i < vector_active (matches); i++)
1836 if ((match_vector = vector_slot (matches, i)) != NULL)
718e3744 1837 {
1838 int match = 0;
1839
cd40b329
CF
1840 for (j = 0; j < vector_active (match_vector); j++)
1841 if ((cmd_token = vector_slot (match_vector, j)) != NULL)
909a2155 1842 {
1843 enum match_type ret;
cd40b329
CF
1844
1845 assert(cmd_token->type == TOKEN_TERMINAL);
1846 if (cmd_token->type != TOKEN_TERMINAL)
1847 continue;
1848
1849 str = cmd_token->cmd;
718e3744 1850
909a2155 1851 switch (type)
1852 {
1853 case exact_match:
1854 if (!(CMD_OPTION (str) || CMD_VARIABLE (str))
1855 && strcmp (command, str) == 0)
718e3744 1856 match++;
909a2155 1857 break;
1858 case partly_match:
1859 if (!(CMD_OPTION (str) || CMD_VARIABLE (str))
1860 && strncmp (command, str, strlen (command)) == 0)
1861 {
1862 if (matched && strcmp (matched, str) != 0)
1863 return 1; /* There is ambiguous match. */
1864 else
1865 matched = str;
1866 match++;
1867 }
1868 break;
1869 case range_match:
1870 if (cmd_range_match (str, command))
1871 {
1872 if (matched && strcmp (matched, str) != 0)
1873 return 1;
1874 else
1875 matched = str;
1876 match++;
1877 }
1878 break;
1879#ifdef HAVE_IPV6
1880 case ipv6_match:
1881 if (CMD_IPV6 (str))
718e3744 1882 match++;
909a2155 1883 break;
1884 case ipv6_prefix_match:
1885 if ((ret = cmd_ipv6_prefix_match (command)) != no_match)
1886 {
1887 if (ret == partly_match)
1888 return 2; /* There is incomplete match. */
1889
1890 match++;
1891 }
1892 break;
1893#endif /* HAVE_IPV6 */
1894 case ipv4_match:
1895 if (CMD_IPV4 (str))
718e3744 1896 match++;
909a2155 1897 break;
1898 case ipv4_prefix_match:
1899 if ((ret = cmd_ipv4_prefix_match (command)) != no_match)
1900 {
1901 if (ret == partly_match)
1902 return 2; /* There is incomplete match. */
1903
1904 match++;
1905 }
1906 break;
1907 case extend_match:
1908 if (CMD_OPTION (str) || CMD_VARIABLE (str))
718e3744 1909 match++;
909a2155 1910 break;
1911 case no_match:
1912 default:
1913 break;
1914 }
1915 }
1916 if (!match)
cd40b329 1917 vector_slot (cmd_vector, i) = NULL;
718e3744 1918 }
1919 return 0;
1920}
1921
1922/* If src matches dst return dst string, otherwise return NULL */
274a4a44 1923static const char *
8c328f11 1924cmd_entry_function (const char *src, const char *dst)
718e3744 1925{
1926 /* Skip variable arguments. */
1927 if (CMD_OPTION (dst) || CMD_VARIABLE (dst) || CMD_VARARG (dst) ||
1928 CMD_IPV4 (dst) || CMD_IPV4_PREFIX (dst) || CMD_RANGE (dst))
1929 return NULL;
1930
1931 /* In case of 'command \t', given src is NULL string. */
1932 if (src == NULL)
1933 return dst;
1934
1935 /* Matched with input string. */
1936 if (strncmp (src, dst, strlen (src)) == 0)
1937 return dst;
1938
1939 return NULL;
1940}
1941
1942/* If src matches dst return dst string, otherwise return NULL */
1943/* This version will return the dst string always if it is
1944 CMD_VARIABLE for '?' key processing */
274a4a44 1945static const char *
8c328f11 1946cmd_entry_function_desc (const char *src, const char *dst)
718e3744 1947{
1948 if (CMD_VARARG (dst))
1949 return dst;
1950
1951 if (CMD_RANGE (dst))
1952 {
1953 if (cmd_range_match (dst, src))
1954 return dst;
1955 else
1956 return NULL;
1957 }
1958
22e0a9e6 1959#ifdef HAVE_IPV6
718e3744 1960 if (CMD_IPV6 (dst))
1961 {
1962 if (cmd_ipv6_match (src))
1963 return dst;
1964 else
1965 return NULL;
1966 }
1967
1968 if (CMD_IPV6_PREFIX (dst))
1969 {
1970 if (cmd_ipv6_prefix_match (src))
1971 return dst;
1972 else
1973 return NULL;
1974 }
22e0a9e6 1975#endif /* HAVE_IPV6 */
718e3744 1976
1977 if (CMD_IPV4 (dst))
1978 {
1979 if (cmd_ipv4_match (src))
1980 return dst;
1981 else
1982 return NULL;
1983 }
1984
1985 if (CMD_IPV4_PREFIX (dst))
1986 {
1987 if (cmd_ipv4_prefix_match (src))
1988 return dst;
1989 else
1990 return NULL;
1991 }
1992
1993 /* Optional or variable commands always match on '?' */
1994 if (CMD_OPTION (dst) || CMD_VARIABLE (dst))
1995 return dst;
1996
1997 /* In case of 'command \t', given src is NULL string. */
1998 if (src == NULL)
1999 return dst;
2000
2001 if (strncmp (src, dst, strlen (src)) == 0)
2002 return dst;
2003 else
2004 return NULL;
2005}
2006
cd40b329
CF
2007/**
2008 * Check whether a string is already present in a vector of strings.
2009 * @param v A vector of char*.
2010 * @param str A char*.
2011 * @return 0 if str is already present in the vector, 1 otherwise.
2012 */
274a4a44 2013static int
8c328f11 2014cmd_unique_string (vector v, const char *str)
718e3744 2015{
8c328f11 2016 unsigned int i;
718e3744 2017 char *match;
2018
55468c86 2019 for (i = 0; i < vector_active (v); i++)
718e3744 2020 if ((match = vector_slot (v, i)) != NULL)
2021 if (strcmp (match, str) == 0)
2022 return 0;
2023 return 1;
2024}
2025
cd40b329
CF
2026/**
2027 * Check whether a struct cmd_token matching a given string is already
2028 * present in a vector of struct cmd_token.
2029 * @param v A vector of struct cmd_token*.
2030 * @param str A char* which should be searched for.
2031 * @return 0 if there is a struct cmd_token* with its cmd matching str,
2032 * 1 otherwise.
2033 */
274a4a44 2034static int
8c328f11 2035desc_unique_string (vector v, const char *str)
718e3744 2036{
8c328f11 2037 unsigned int i;
cd40b329 2038 struct cmd_token *token;
718e3744 2039
55468c86 2040 for (i = 0; i < vector_active (v); i++)
cd40b329
CF
2041 if ((token = vector_slot (v, i)) != NULL)
2042 if (strcmp (token->cmd, str) == 0)
2043 return 0;
2044 return 1;
718e3744 2045}
2046
274a4a44 2047static int
b92938a7 2048cmd_try_do_shortcut (enum node_type node, char* first_word) {
2049 if ( first_word != NULL &&
2050 node != AUTH_NODE &&
2051 node != VIEW_NODE &&
2052 node != AUTH_ENABLE_NODE &&
2053 node != ENABLE_NODE &&
62687ff1 2054 node != RESTRICTED_NODE &&
b92938a7 2055 0 == strcmp( "do", first_word ) )
2056 return 1;
2057 return 0;
2058}
2059
cd40b329
CF
2060static void
2061cmd_matches_free(vector *matches)
2062{
2063 unsigned int i;
2064 vector cmd_matches;
2065
2066 for (i = 0; i < vector_active(*matches); i++)
2067 if ((cmd_matches = vector_slot(*matches, i)) != NULL)
2068 vector_free(cmd_matches);
2069 vector_free(*matches);
2070 *matches = NULL;
2071}
2072
2073static int
2074cmd_describe_cmp(const void *a, const void *b)
2075{
2076 const struct cmd_token *first = *(struct cmd_token * const *)a;
2077 const struct cmd_token *second = *(struct cmd_token * const *)b;
2078
2079 return strcmp(first->cmd, second->cmd);
2080}
2081
2082static void
2083cmd_describe_sort(vector matchvec)
2084{
2085 qsort(matchvec->index, vector_active(matchvec),
2086 sizeof(void*), cmd_describe_cmp);
2087}
2088
718e3744 2089/* '?' describe command support. */
274a4a44 2090static vector
b92938a7 2091cmd_describe_command_real (vector vline, struct vty *vty, int *status)
718e3744 2092{
b8961476 2093 unsigned int i;
718e3744 2094 vector cmd_vector;
2095#define INIT_MATCHVEC_SIZE 10
2096 vector matchvec;
2097 struct cmd_element *cmd_element;
b8961476 2098 unsigned int index;
54aba54c 2099 int ret;
2100 enum match_type match;
2101 char *command;
cd40b329
CF
2102 vector matches = NULL;
2103 vector match_vector;
718e3744 2104
2105 /* Set index. */
55468c86 2106 if (vector_active (vline) == 0)
b8961476 2107 {
2108 *status = CMD_ERR_NO_MATCH;
2109 return NULL;
2110 }
cd40b329
CF
2111
2112 index = vector_active (vline) - 1;
2113
718e3744 2114 /* Make copy vector of current node's command vector. */
2115 cmd_vector = vector_copy (cmd_node_vector (cmdvec, vty->node));
2116
2117 /* Prepare match vector */
2118 matchvec = vector_init (INIT_MATCHVEC_SIZE);
2119
cd40b329
CF
2120 /* Filter commands and build a list how they could possibly continue. */
2121 for (i = 0; i <= index; i++)
2122 {
2123 command = vector_slot (vline, i);
718e3744 2124
cd40b329
CF
2125 if (matches)
2126 cmd_matches_free(&matches);
718e3744 2127
cd40b329
CF
2128 ret = cmd_vector_filter(cmd_vector,
2129 FILTER_RELAXED,
2130 vline, i,
2131 &match,
2132 &matches);
718e3744 2133
cd40b329
CF
2134 if (ret != CMD_SUCCESS)
2135 {
2136 vector_free (cmd_vector);
2137 vector_free (matchvec);
2138 cmd_matches_free(&matches);
2139 *status = ret;
2140 return NULL;
2141 }
718e3744 2142
cd40b329
CF
2143 /* The last match may well be ambigious, so break here */
2144 if (i == index)
2145 break;
2146
2147 if (match == vararg_match)
2148 {
2149 /* We found a vararg match - so we can throw out the current matches here
2150 * and don't need to continue checking the command input */
2151 unsigned int j, k;
2152
2153 for (j = 0; j < vector_active (matches); j++)
2154 if ((match_vector = vector_slot (matches, j)) != NULL)
2155 for (k = 0; k < vector_active (match_vector); k++)
2156 {
2157 struct cmd_token *token = vector_slot (match_vector, k);
2158 vector_set (matchvec, token);
2159 }
2160
2161 *status = CMD_SUCCESS;
2162 vector_set(matchvec, &token_cr);
2163 vector_free (cmd_vector);
2164 cmd_matches_free(&matches);
2165 cmd_describe_sort(matchvec);
2166 return matchvec;
2167 }
718e3744 2168
cd40b329
CF
2169 ret = is_cmd_ambiguous(cmd_vector, command, matches, match);
2170 if (ret == 1)
2171 {
2172 vector_free (cmd_vector);
2173 vector_free (matchvec);
2174 cmd_matches_free(&matches);
2175 *status = CMD_ERR_AMBIGUOUS;
2176 return NULL;
2177 }
2178 else if (ret == 2)
2179 {
2180 vector_free (cmd_vector);
2181 vector_free (matchvec);
2182 cmd_matches_free(&matches);
2183 *status = CMD_ERR_NO_MATCH;
2184 return NULL;
2185 }
2186 }
54aba54c 2187
718e3744 2188 /* Make description vector. */
cd40b329 2189 for (i = 0; i < vector_active (matches); i++)
718e3744 2190 if ((cmd_element = vector_slot (cmd_vector, i)) != NULL)
2191 {
cd40b329
CF
2192 unsigned int j;
2193 const char *last_word;
2194 vector vline_trimmed;
718e3744 2195
cd40b329
CF
2196 last_word = vector_slot(vline, vector_active(vline) - 1);
2197 if (last_word == NULL || !strlen(last_word))
2198 {
2199 vline_trimmed = vector_copy(vline);
2200 vector_unset(vline_trimmed, vector_active(vline_trimmed) - 1);
2201
2202 if (cmd_is_complete(cmd_element, vline_trimmed)
2203 && desc_unique_string(matchvec, command_cr))
2204 {
2205 if (match != vararg_match)
2206 vector_set(matchvec, &token_cr);
2207 }
2208
2209 vector_free(vline_trimmed);
2210 }
2211
2212 match_vector = vector_slot (matches, i);
2213 if (match_vector)
2214 for (j = 0; j < vector_active(match_vector); j++)
2215 {
2216 struct cmd_token *token = vector_slot(match_vector, j);
2217 const char *string;
2218
2219 string = cmd_entry_function_desc(command, token->cmd);
2220 if (string && desc_unique_string(matchvec, string))
2221 vector_set(matchvec, token);
2222 }
718e3744 2223 }
2224 vector_free (cmd_vector);
cd40b329 2225 cmd_matches_free(&matches);
718e3744 2226
2227 if (vector_slot (matchvec, 0) == NULL)
2228 {
2229 vector_free (matchvec);
909a2155 2230 *status = CMD_ERR_NO_MATCH;
5fc60519 2231 return NULL;
718e3744 2232 }
718e3744 2233
5fc60519 2234 *status = CMD_SUCCESS;
cd40b329 2235 cmd_describe_sort(matchvec);
718e3744 2236 return matchvec;
2237}
2238
b92938a7 2239vector
2240cmd_describe_command (vector vline, struct vty *vty, int *status)
2241{
2242 vector ret;
2243
2244 if ( cmd_try_do_shortcut(vty->node, vector_slot(vline, 0) ) )
2245 {
2246 enum node_type onode;
2247 vector shifted_vline;
8c328f11 2248 unsigned int index;
b92938a7 2249
2250 onode = vty->node;
2251 vty->node = ENABLE_NODE;
2252 /* We can try it on enable node, cos' the vty is authenticated */
2253
2254 shifted_vline = vector_init (vector_count(vline));
2255 /* use memcpy? */
55468c86 2256 for (index = 1; index < vector_active (vline); index++)
b92938a7 2257 {
2258 vector_set_index (shifted_vline, index-1, vector_lookup(vline, index));
2259 }
2260
2261 ret = cmd_describe_command_real (shifted_vline, vty, status);
2262
2263 vector_free(shifted_vline);
2264 vty->node = onode;
2265 return ret;
2266 }
2267
2268
2269 return cmd_describe_command_real (vline, vty, status);
2270}
2271
2272
718e3744 2273/* Check LCD of matched command. */
274a4a44 2274static int
718e3744 2275cmd_lcd (char **matched)
2276{
2277 int i;
2278 int j;
2279 int lcd = -1;
2280 char *s1, *s2;
2281 char c1, c2;
2282
2283 if (matched[0] == NULL || matched[1] == NULL)
2284 return 0;
2285
2286 for (i = 1; matched[i] != NULL; i++)
2287 {
2288 s1 = matched[i - 1];
2289 s2 = matched[i];
2290
2291 for (j = 0; (c1 = s1[j]) && (c2 = s2[j]); j++)
2292 if (c1 != c2)
2293 break;
2294
2295 if (lcd < 0)
2296 lcd = j;
2297 else
2298 {
2299 if (lcd > j)
2300 lcd = j;
2301 }
2302 }
2303 return lcd;
2304}
2305
cd40b329
CF
2306static int
2307cmd_complete_cmp(const void *a, const void *b)
2308{
2309 const char *first = *(char * const *)a;
2310 const char *second = *(char * const *)b;
2311
2312 if (!first)
2313 {
2314 if (!second)
2315 return 0;
2316 return 1;
2317 }
2318 if (!second)
2319 return -1;
2320
2321 return strcmp(first, second);
2322}
2323
2324static void
2325cmd_complete_sort(vector matchvec)
2326{
2327 qsort(matchvec->index, vector_active(matchvec),
2328 sizeof(void*), cmd_complete_cmp);
2329}
2330
718e3744 2331/* Command line completion support. */
274a4a44 2332static char **
b92938a7 2333cmd_complete_command_real (vector vline, struct vty *vty, int *status)
718e3744 2334{
b8961476 2335 unsigned int i;
718e3744 2336 vector cmd_vector = vector_copy (cmd_node_vector (cmdvec, vty->node));
2337#define INIT_MATCHVEC_SIZE 10
2338 vector matchvec;
b8961476 2339 unsigned int index;
718e3744 2340 char **match_str;
cd40b329 2341 struct cmd_token *token;
718e3744 2342 char *command;
2343 int lcd;
cd40b329
CF
2344 vector matches = NULL;
2345 vector match_vector;
718e3744 2346
55468c86 2347 if (vector_active (vline) == 0)
b8961476 2348 {
d2519962 2349 vector_free (cmd_vector);
b8961476 2350 *status = CMD_ERR_NO_MATCH;
2351 return NULL;
2352 }
2353 else
55468c86 2354 index = vector_active (vline) - 1;
b8961476 2355
cd40b329
CF
2356 /* First, filter by command string */
2357 for (i = 0; i <= index; i++)
2358 {
2359 command = vector_slot (vline, i);
2360 enum match_type match;
2361 int ret;
718e3744 2362
cd40b329
CF
2363 if (matches)
2364 cmd_matches_free(&matches);
718e3744 2365
cd40b329
CF
2366 /* First try completion match, if there is exactly match return 1 */
2367 ret = cmd_vector_filter(cmd_vector,
2368 FILTER_RELAXED,
2369 vline, i,
2370 &match,
2371 &matches);
2372
2373 if (ret != CMD_SUCCESS)
2374 {
2375 vector_free(cmd_vector);
2376 cmd_matches_free(&matches);
2377 *status = ret;
2378 return NULL;
2379 }
2380
2381 /* Break here - the completion mustn't be checked to be non-ambiguous */
2382 if (i == index)
2383 break;
2384
2385 /* If there is exact match then filter ambiguous match else check
2386 ambiguousness. */
2387 ret = is_cmd_ambiguous (cmd_vector, command, matches, match);
2388 if (ret == 1)
2389 {
2390 vector_free (cmd_vector);
2391 cmd_matches_free(&matches);
2392 *status = CMD_ERR_AMBIGUOUS;
2393 return NULL;
2394 }
2395 /*
909a2155 2396 else if (ret == 2)
2397 {
2398 vector_free (cmd_vector);
cd40b329 2399 cmd_matches_free(&matches);
909a2155 2400 *status = CMD_ERR_NO_MATCH;
2401 return NULL;
2402 }
2403 */
cd40b329 2404 }
909a2155 2405
718e3744 2406 /* Prepare match vector. */
2407 matchvec = vector_init (INIT_MATCHVEC_SIZE);
2408
cd40b329
CF
2409 /* Build the possible list of continuations into a list of completions */
2410 for (i = 0; i < vector_active (matches); i++)
2411 if ((match_vector = vector_slot (matches, i)))
718e3744 2412 {
8c328f11 2413 const char *string;
cd40b329 2414 unsigned int j;
718e3744 2415
cd40b329
CF
2416 for (j = 0; j < vector_active (match_vector); j++)
2417 if ((token = vector_slot (match_vector, j)))
909a2155 2418 {
b8961476 2419 if ((string =
2420 cmd_entry_function (vector_slot (vline, index),
cd40b329 2421 token->cmd)))
909a2155 2422 if (cmd_unique_string (matchvec, string))
2423 vector_set (matchvec, XSTRDUP (MTYPE_TMP, string));
2424 }
718e3744 2425 }
2426
2427 /* We don't need cmd_vector any more. */
2428 vector_free (cmd_vector);
cd40b329 2429 cmd_matches_free(&matches);
718e3744 2430
2431 /* No matched command */
2432 if (vector_slot (matchvec, 0) == NULL)
2433 {
2434 vector_free (matchvec);
2435
2436 /* In case of 'command \t' pattern. Do you need '?' command at
2437 the end of the line. */
2438 if (vector_slot (vline, index) == '\0')
2439 *status = CMD_ERR_NOTHING_TODO;
2440 else
2441 *status = CMD_ERR_NO_MATCH;
2442 return NULL;
2443 }
2444
2445 /* Only one matched */
2446 if (vector_slot (matchvec, 1) == NULL)
2447 {
2448 match_str = (char **) matchvec->index;
2449 vector_only_wrapper_free (matchvec);
2450 *status = CMD_COMPLETE_FULL_MATCH;
2451 return match_str;
2452 }
2453 /* Make it sure last element is NULL. */
2454 vector_set (matchvec, NULL);
2455
2456 /* Check LCD of matched strings. */
2457 if (vector_slot (vline, index) != NULL)
2458 {
2459 lcd = cmd_lcd ((char **) matchvec->index);
2460
2461 if (lcd)
2462 {
2463 int len = strlen (vector_slot (vline, index));
909a2155 2464
718e3744 2465 if (len < lcd)
2466 {
2467 char *lcdstr;
909a2155 2468
cd40b329 2469 lcdstr = XMALLOC (MTYPE_TMP, lcd + 1);
718e3744 2470 memcpy (lcdstr, matchvec->index[0], lcd);
2471 lcdstr[lcd] = '\0';
2472
2473 /* match_str = (char **) &lcdstr; */
2474
2475 /* Free matchvec. */
55468c86 2476 for (i = 0; i < vector_active (matchvec); i++)
718e3744 2477 {
2478 if (vector_slot (matchvec, i))
cd40b329 2479 XFREE (MTYPE_TMP, vector_slot (matchvec, i));
718e3744 2480 }
2481 vector_free (matchvec);
2482
909a2155 2483 /* Make new matchvec. */
718e3744 2484 matchvec = vector_init (INIT_MATCHVEC_SIZE);
2485 vector_set (matchvec, lcdstr);
2486 match_str = (char **) matchvec->index;
2487 vector_only_wrapper_free (matchvec);
2488
2489 *status = CMD_COMPLETE_MATCH;
2490 return match_str;
2491 }
2492 }
2493 }
2494
2495 match_str = (char **) matchvec->index;
cd40b329 2496 cmd_complete_sort(matchvec);
718e3744 2497 vector_only_wrapper_free (matchvec);
2498 *status = CMD_COMPLETE_LIST_MATCH;
2499 return match_str;
2500}
2501
b92938a7 2502char **
9ab6812d 2503cmd_complete_command (vector vline, struct vty *vty, int *status)
b92938a7 2504{
2505 char **ret;
2506
2507 if ( cmd_try_do_shortcut(vty->node, vector_slot(vline, 0) ) )
2508 {
2509 enum node_type onode;
2510 vector shifted_vline;
8c328f11 2511 unsigned int index;
b92938a7 2512
2513 onode = vty->node;
2514 vty->node = ENABLE_NODE;
2515 /* We can try it on enable node, cos' the vty is authenticated */
2516
2517 shifted_vline = vector_init (vector_count(vline));
2518 /* use memcpy? */
55468c86 2519 for (index = 1; index < vector_active (vline); index++)
b92938a7 2520 {
2521 vector_set_index (shifted_vline, index-1, vector_lookup(vline, index));
2522 }
2523
2524 ret = cmd_complete_command_real (shifted_vline, vty, status);
2525
2526 vector_free(shifted_vline);
2527 vty->node = onode;
2528 return ret;
2529 }
2530
2531
2532 return cmd_complete_command_real (vline, vty, status);
2533}
2534
2535/* return parent node */
2536/* MUST eventually converge on CONFIG_NODE */
13bfca7a 2537enum node_type
274a4a44 2538node_parent ( enum node_type node )
b92938a7 2539{
2540 enum node_type ret;
2541
9ab6812d 2542 assert (node > CONFIG_NODE);
2543
2544 switch (node)
2545 {
2546 case BGP_VPNV4_NODE:
2547 case BGP_IPV4_NODE:
2548 case BGP_IPV4M_NODE:
2549 case BGP_IPV6_NODE:
1e836590 2550 case BGP_IPV6M_NODE:
9ab6812d 2551 ret = BGP_NODE;
2552 break;
2553 case KEYCHAIN_KEY_NODE:
2554 ret = KEYCHAIN_NODE;
2555 break;
2556 default:
2557 ret = CONFIG_NODE;
b92938a7 2558 }
2559
2560 return ret;
2561}
2562
718e3744 2563/* Execute command by argument vline vector. */
274a4a44 2564static int
cd40b329
CF
2565cmd_execute_command_real (vector vline,
2566 enum filter_type filter,
2567 struct vty *vty,
b8961476 2568 struct cmd_element **cmd)
718e3744 2569{
8c328f11 2570 unsigned int i;
2571 unsigned int index;
718e3744 2572 vector cmd_vector;
2573 struct cmd_element *cmd_element;
2574 struct cmd_element *matched_element;
2575 unsigned int matched_count, incomplete_count;
2576 int argc;
9035efaa 2577 const char *argv[CMD_ARGC_MAX];
718e3744 2578 enum match_type match = 0;
718e3744 2579 char *command;
cd40b329
CF
2580 int ret;
2581 vector matches;
718e3744 2582
2583 /* Make copy of command elements. */
2584 cmd_vector = vector_copy (cmd_node_vector (cmdvec, vty->node));
2585
55468c86 2586 for (index = 0; index < vector_active (vline); index++)
cd40b329
CF
2587 {
2588 command = vector_slot (vline, index);
2589 ret = cmd_vector_filter(cmd_vector,
2590 filter,
2591 vline, index,
2592 &match,
2593 &matches);
2594
2595 if (ret != CMD_SUCCESS)
2596 {
2597 cmd_matches_free(&matches);
2598 return ret;
2599 }
718e3744 2600
cd40b329
CF
2601 if (match == vararg_match)
2602 {
2603 cmd_matches_free(&matches);
909a2155 2604 break;
cd40b329 2605 }
718e3744 2606
cd40b329
CF
2607 ret = is_cmd_ambiguous (cmd_vector, command, matches, match);
2608 cmd_matches_free(&matches);
2609
2610 if (ret == 1)
2611 {
2612 vector_free(cmd_vector);
2613 return CMD_ERR_AMBIGUOUS;
2614 }
2615 else if (ret == 2)
2616 {
2617 vector_free(cmd_vector);
2618 return CMD_ERR_NO_MATCH;
2619 }
2620 }
718e3744 2621
2622 /* Check matched count. */
2623 matched_element = NULL;
2624 matched_count = 0;
2625 incomplete_count = 0;
2626
55468c86 2627 for (i = 0; i < vector_active (cmd_vector); i++)
b8961476 2628 if ((cmd_element = vector_slot (cmd_vector, i)))
718e3744 2629 {
cd40b329 2630 if (cmd_is_complete(cmd_element, vline))
718e3744 2631 {
2632 matched_element = cmd_element;
718e3744 2633 matched_count++;
2634 }
2635 else
2636 {
2637 incomplete_count++;
2638 }
2639 }
909a2155 2640
718e3744 2641 /* Finish of using cmd_vector. */
2642 vector_free (cmd_vector);
2643
909a2155 2644 /* To execute command, matched_count must be 1. */
2645 if (matched_count == 0)
718e3744 2646 {
2647 if (incomplete_count)
2648 return CMD_ERR_INCOMPLETE;
2649 else
2650 return CMD_ERR_NO_MATCH;
2651 }
2652
909a2155 2653 if (matched_count > 1)
718e3744 2654 return CMD_ERR_AMBIGUOUS;
2655
cd40b329
CF
2656 ret = cmd_parse(matched_element, vline, &argc, argv);
2657 if (ret != CMD_SUCCESS)
2658 return ret;
718e3744 2659
2660 /* For vtysh execution. */
2661 if (cmd)
2662 *cmd = matched_element;
2663
2664 if (matched_element->daemon)
2665 return CMD_SUCCESS_DAEMON;
2666
2667 /* Execute matched command. */
2668 return (*matched_element->func) (matched_element, vty, argc, argv);
2669}
2670
cd40b329
CF
2671/**
2672 * Execute a given command, handling things like "do ..." and checking
2673 * whether the given command might apply at a parent node if doesn't
2674 * apply for the current node.
2675 *
2676 * @param vline Command line input, vector of char* where each element is
2677 * one input token.
2678 * @param vty The vty context in which the command should be executed.
2679 * @param cmd Pointer where the struct cmd_element of the matched command
2680 * will be stored, if any. May be set to NULL if this info is
2681 * not needed.
2682 * @param vtysh If set != 0, don't lookup the command at parent nodes.
2683 * @return The status of the command that has been executed or an error code
2684 * as to why no command could be executed.
2685 */
eda031f6 2686int
87d683b0 2687cmd_execute_command (vector vline, struct vty *vty, struct cmd_element **cmd,
2688 int vtysh) {
9ab6812d 2689 int ret, saved_ret, tried = 0;
2690 enum node_type onode, try_node;
eda031f6 2691
9ab6812d 2692 onode = try_node = vty->node;
b92938a7 2693
2694 if ( cmd_try_do_shortcut(vty->node, vector_slot(vline, 0) ) )
2695 {
2696 vector shifted_vline;
8c328f11 2697 unsigned int index;
b92938a7 2698
2699 vty->node = ENABLE_NODE;
2700 /* We can try it on enable node, cos' the vty is authenticated */
2701
2702 shifted_vline = vector_init (vector_count(vline));
2703 /* use memcpy? */
55468c86 2704 for (index = 1; index < vector_active (vline); index++)
b92938a7 2705 {
2706 vector_set_index (shifted_vline, index-1, vector_lookup(vline, index));
2707 }
2708
cd40b329 2709 ret = cmd_execute_command_real (shifted_vline, FILTER_RELAXED, vty, cmd);
b92938a7 2710
2711 vector_free(shifted_vline);
2712 vty->node = onode;
2713 return ret;
2714 }
2715
2716
cd40b329 2717 saved_ret = ret = cmd_execute_command_real (vline, FILTER_RELAXED, vty, cmd);
b92938a7 2718
87d683b0 2719 if (vtysh)
2720 return saved_ret;
2721
b92938a7 2722 /* This assumes all nodes above CONFIG_NODE are childs of CONFIG_NODE */
9ab6812d 2723 while ( ret != CMD_SUCCESS && ret != CMD_WARNING
b92938a7 2724 && vty->node > CONFIG_NODE )
2725 {
9ab6812d 2726 try_node = node_parent(try_node);
2727 vty->node = try_node;
cd40b329 2728 ret = cmd_execute_command_real (vline, FILTER_RELAXED, vty, cmd);
9ab6812d 2729 tried = 1;
2730 if (ret == CMD_SUCCESS || ret == CMD_WARNING)
b92938a7 2731 {
9ab6812d 2732 /* succesfull command, leave the node as is */
b92938a7 2733 return ret;
2734 }
b92938a7 2735 }
9ab6812d 2736 /* no command succeeded, reset the vty to the original node and
2737 return the error for this node */
2738 if ( tried )
2739 vty->node = onode;
2740 return saved_ret;
b92938a7 2741}
2742
cd40b329
CF
2743/**
2744 * Execute a given command, matching it strictly against the current node.
2745 * This mode is used when reading config files.
2746 *
2747 * @param vline Command line input, vector of char* where each element is
2748 * one input token.
2749 * @param vty The vty context in which the command should be executed.
2750 * @param cmd Pointer where the struct cmd_element* of the matched command
2751 * will be stored, if any. May be set to NULL if this info is
2752 * not needed.
2753 * @return The status of the command that has been executed or an error code
2754 * as to why no command could be executed.
2755 */
718e3744 2756int
909a2155 2757cmd_execute_command_strict (vector vline, struct vty *vty,
718e3744 2758 struct cmd_element **cmd)
2759{
cd40b329 2760 return cmd_execute_command_real(vline, FILTER_STRICT, vty, cmd);
718e3744 2761}
2762
2763/* Configration make from file. */
2764int
2765config_from_file (struct vty *vty, FILE *fp)
2766{
2767 int ret;
2768 vector vline;
2769
2770 while (fgets (vty->buf, VTY_BUFSIZ, fp))
2771 {
2772 vline = cmd_make_strvec (vty->buf);
2773
2774 /* In case of comment line */
2775 if (vline == NULL)
2776 continue;
2777 /* Execute configuration command : this is strict match */
2778 ret = cmd_execute_command_strict (vline, vty, NULL);
2779
2780 /* Try again with setting node to CONFIG_NODE */
b92938a7 2781 while (ret != CMD_SUCCESS && ret != CMD_WARNING
ddd85ed1 2782 && ret != CMD_ERR_NOTHING_TODO && vty->node != CONFIG_NODE)
2783 {
b92938a7 2784 vty->node = node_parent(vty->node);
ddd85ed1 2785 ret = cmd_execute_command_strict (vline, vty, NULL);
2786 }
9ab6812d 2787
718e3744 2788 cmd_free_strvec (vline);
2789
ddd85ed1 2790 if (ret != CMD_SUCCESS && ret != CMD_WARNING
2791 && ret != CMD_ERR_NOTHING_TODO)
718e3744 2792 return ret;
2793 }
2794 return CMD_SUCCESS;
2795}
2796
2797/* Configration from terminal */
2798DEFUN (config_terminal,
2799 config_terminal_cmd,
2800 "configure terminal",
2801 "Configuration from vty interface\n"
2802 "Configuration terminal\n")
2803{
2804 if (vty_config_lock (vty))
2805 vty->node = CONFIG_NODE;
2806 else
2807 {
2808 vty_out (vty, "VTY configuration is locked by other VTY%s", VTY_NEWLINE);
2809 return CMD_WARNING;
2810 }
2811 return CMD_SUCCESS;
2812}
2813
2814/* Enable command */
2815DEFUN (enable,
2816 config_enable_cmd,
2817 "enable",
2818 "Turn on privileged mode command\n")
2819{
2820 /* If enable password is NULL, change to ENABLE_NODE */
2821 if ((host.enable == NULL && host.enable_encrypt == NULL) ||
2822 vty->type == VTY_SHELL_SERV)
2823 vty->node = ENABLE_NODE;
2824 else
2825 vty->node = AUTH_ENABLE_NODE;
2826
2827 return CMD_SUCCESS;
2828}
2829
2830/* Disable command */
2831DEFUN (disable,
2832 config_disable_cmd,
2833 "disable",
2834 "Turn off privileged mode command\n")
2835{
2836 if (vty->node == ENABLE_NODE)
2837 vty->node = VIEW_NODE;
2838 return CMD_SUCCESS;
2839}
2840
2841/* Down vty node level. */
2842DEFUN (config_exit,
2843 config_exit_cmd,
2844 "exit",
2845 "Exit current mode and down to previous mode\n")
2846{
2847 switch (vty->node)
2848 {
2849 case VIEW_NODE:
2850 case ENABLE_NODE:
62687ff1 2851 case RESTRICTED_NODE:
718e3744 2852 if (vty_shell (vty))
2853 exit (0);
2854 else
2855 vty->status = VTY_CLOSE;
2856 break;
2857 case CONFIG_NODE:
2858 vty->node = ENABLE_NODE;
2859 vty_config_unlock (vty);
2860 break;
2861 case INTERFACE_NODE:
2862 case ZEBRA_NODE:
2863 case BGP_NODE:
2864 case RIP_NODE:
2865 case RIPNG_NODE:
5734509c 2866 case BABEL_NODE:
718e3744 2867 case OSPF_NODE:
2868 case OSPF6_NODE:
9e867fe6 2869 case ISIS_NODE:
718e3744 2870 case KEYCHAIN_NODE:
2871 case MASC_NODE:
2872 case RMAP_NODE:
2873 case VTY_NODE:
2874 vty->node = CONFIG_NODE;
2875 break;
2876 case BGP_VPNV4_NODE:
2877 case BGP_IPV4_NODE:
2878 case BGP_IPV4M_NODE:
2879 case BGP_IPV6_NODE:
1e836590 2880 case BGP_IPV6M_NODE:
718e3744 2881 vty->node = BGP_NODE;
2882 break;
2883 case KEYCHAIN_KEY_NODE:
2884 vty->node = KEYCHAIN_NODE;
2885 break;
2886 default:
2887 break;
2888 }
2889 return CMD_SUCCESS;
2890}
2891
2892/* quit is alias of exit. */
2893ALIAS (config_exit,
2894 config_quit_cmd,
2895 "quit",
2896 "Exit current mode and down to previous mode\n")
2897
2898/* End of configuration. */
2899DEFUN (config_end,
2900 config_end_cmd,
2901 "end",
2902 "End current mode and change to enable mode.")
2903{
2904 switch (vty->node)
2905 {
2906 case VIEW_NODE:
2907 case ENABLE_NODE:
62687ff1 2908 case RESTRICTED_NODE:
718e3744 2909 /* Nothing to do. */
2910 break;
2911 case CONFIG_NODE:
2912 case INTERFACE_NODE:
2913 case ZEBRA_NODE:
2914 case RIP_NODE:
2915 case RIPNG_NODE:
5734509c 2916 case BABEL_NODE:
718e3744 2917 case BGP_NODE:
2918 case BGP_VPNV4_NODE:
2919 case BGP_IPV4_NODE:
2920 case BGP_IPV4M_NODE:
2921 case BGP_IPV6_NODE:
1e836590 2922 case BGP_IPV6M_NODE:
718e3744 2923 case RMAP_NODE:
2924 case OSPF_NODE:
2925 case OSPF6_NODE:
9e867fe6 2926 case ISIS_NODE:
718e3744 2927 case KEYCHAIN_NODE:
2928 case KEYCHAIN_KEY_NODE:
2929 case MASC_NODE:
2930 case VTY_NODE:
2931 vty_config_unlock (vty);
2932 vty->node = ENABLE_NODE;
2933 break;
2934 default:
2935 break;
2936 }
2937 return CMD_SUCCESS;
2938}
2939
2940/* Show version. */
2941DEFUN (show_version,
2942 show_version_cmd,
2943 "show version",
2944 SHOW_STR
2945 "Displays zebra version\n")
2946{
12f6ea23 2947 vty_out (vty, "Quagga %s (%s).%s", QUAGGA_VERSION, host.name?host.name:"",
2948 VTY_NEWLINE);
0be793e6 2949 vty_out (vty, "%s%s%s", QUAGGA_COPYRIGHT, GIT_INFO, VTY_NEWLINE);
718e3744 2950
2951 return CMD_SUCCESS;
2952}
2953
2954/* Help display function for all node. */
2955DEFUN (config_help,
2956 config_help_cmd,
2957 "help",
2958 "Description of the interactive help system\n")
2959{
2960 vty_out (vty,
6590f2c3 2961 "Quagga VTY provides advanced help feature. When you need help,%s\
718e3744 2962anytime at the command line please press '?'.%s\
2963%s\
2964If nothing matches, the help list will be empty and you must backup%s\
2965 until entering a '?' shows the available options.%s\
2966Two styles of help are provided:%s\
29671. Full help is available when you are ready to enter a%s\
2968command argument (e.g. 'show ?') and describes each possible%s\
2969argument.%s\
29702. Partial help is provided when an abbreviated argument is entered%s\
2971 and you want to know what arguments match the input%s\
2972 (e.g. 'show me?'.)%s%s", VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE,
2973 VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE,
2974 VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE);
2975 return CMD_SUCCESS;
2976}
2977
2978/* Help display function for all node. */
2979DEFUN (config_list,
2980 config_list_cmd,
2981 "list",
2982 "Print command list\n")
2983{
8c328f11 2984 unsigned int i;
718e3744 2985 struct cmd_node *cnode = vector_slot (cmdvec, vty->node);
2986 struct cmd_element *cmd;
2987
55468c86 2988 for (i = 0; i < vector_active (cnode->cmd_vector); i++)
4275b1de 2989 if ((cmd = vector_slot (cnode->cmd_vector, i)) != NULL
2990 && !(cmd->attr == CMD_ATTR_DEPRECATED
2991 || cmd->attr == CMD_ATTR_HIDDEN))
718e3744 2992 vty_out (vty, " %s%s", cmd->string,
2993 VTY_NEWLINE);
2994 return CMD_SUCCESS;
2995}
2996
2997/* Write current configuration into file. */
2998DEFUN (config_write_file,
2999 config_write_file_cmd,
3000 "write file",
3001 "Write running configuration to memory, network, or terminal\n"
3002 "Write to configuration file\n")
3003{
8c328f11 3004 unsigned int i;
718e3744 3005 int fd;
3006 struct cmd_node *node;
3007 char *config_file;
3008 char *config_file_tmp = NULL;
3009 char *config_file_sav = NULL;
05865c90 3010 int ret = CMD_WARNING;
718e3744 3011 struct vty *file_vty;
3012
3013 /* Check and see if we are operating under vtysh configuration */
3014 if (host.config == NULL)
3015 {
3016 vty_out (vty, "Can't save to configuration file, using vtysh.%s",
3017 VTY_NEWLINE);
3018 return CMD_WARNING;
3019 }
3020
3021 /* Get filename. */
3022 config_file = host.config;
3023
05865c90 3024 config_file_sav =
3025 XMALLOC (MTYPE_TMP, strlen (config_file) + strlen (CONF_BACKUP_EXT) + 1);
718e3744 3026 strcpy (config_file_sav, config_file);
3027 strcat (config_file_sav, CONF_BACKUP_EXT);
3028
3029
05865c90 3030 config_file_tmp = XMALLOC (MTYPE_TMP, strlen (config_file) + 8);
718e3744 3031 sprintf (config_file_tmp, "%s.XXXXXX", config_file);
3032
3033 /* Open file to configuration write. */
3034 fd = mkstemp (config_file_tmp);
3035 if (fd < 0)
3036 {
3037 vty_out (vty, "Can't open configuration file %s.%s", config_file_tmp,
3038 VTY_NEWLINE);
05865c90 3039 goto finished;
718e3744 3040 }
3041
3042 /* Make vty for configuration file. */
3043 file_vty = vty_new ();
3044 file_vty->fd = fd;
3045 file_vty->type = VTY_FILE;
3046
3047 /* Config file header print. */
3048 vty_out (file_vty, "!\n! Zebra configuration saved from vty\n! ");
3049 vty_time_print (file_vty, 1);
3050 vty_out (file_vty, "!\n");
3051
55468c86 3052 for (i = 0; i < vector_active (cmdvec); i++)
718e3744 3053 if ((node = vector_slot (cmdvec, i)) && node->func)
3054 {
3055 if ((*node->func) (file_vty))
3056 vty_out (file_vty, "!\n");
3057 }
3058 vty_close (file_vty);
3059
3060 if (unlink (config_file_sav) != 0)
3061 if (errno != ENOENT)
3062 {
3063 vty_out (vty, "Can't unlink backup configuration file %s.%s", config_file_sav,
3064 VTY_NEWLINE);
05865c90 3065 goto finished;
718e3744 3066 }
3067 if (link (config_file, config_file_sav) != 0)
3068 {
3069 vty_out (vty, "Can't backup old configuration file %s.%s", config_file_sav,
3070 VTY_NEWLINE);
05865c90 3071 goto finished;
718e3744 3072 }
3073 sync ();
3074 if (unlink (config_file) != 0)
3075 {
3076 vty_out (vty, "Can't unlink configuration file %s.%s", config_file,
3077 VTY_NEWLINE);
05865c90 3078 goto finished;
718e3744 3079 }
3080 if (link (config_file_tmp, config_file) != 0)
3081 {
3082 vty_out (vty, "Can't save configuration file %s.%s", config_file,
3083 VTY_NEWLINE);
05865c90 3084 goto finished;
718e3744 3085 }
718e3744 3086 sync ();
3087
aa593d5e 3088 if (chmod (config_file, CONFIGFILE_MASK) != 0)
3089 {
3090 vty_out (vty, "Can't chmod configuration file %s: %s (%d).%s",
6099b3b5 3091 config_file, safe_strerror(errno), errno, VTY_NEWLINE);
05865c90 3092 goto finished;
aa593d5e 3093 }
3094
718e3744 3095 vty_out (vty, "Configuration saved to %s%s", config_file,
3096 VTY_NEWLINE);
05865c90 3097 ret = CMD_SUCCESS;
3098
3099finished:
3100 unlink (config_file_tmp);
3101 XFREE (MTYPE_TMP, config_file_tmp);
3102 XFREE (MTYPE_TMP, config_file_sav);
3103 return ret;
718e3744 3104}
3105
3106ALIAS (config_write_file,
3107 config_write_cmd,
3108 "write",
3109 "Write running configuration to memory, network, or terminal\n")
3110
3111ALIAS (config_write_file,
3112 config_write_memory_cmd,
3113 "write memory",
3114 "Write running configuration to memory, network, or terminal\n"
3115 "Write configuration to the file (same as write file)\n")
3116
3117ALIAS (config_write_file,
3118 copy_runningconfig_startupconfig_cmd,
3119 "copy running-config startup-config",
3120 "Copy configuration\n"
3121 "Copy running config to... \n"
3122 "Copy running config to startup config (same as write file)\n")
3123
3124/* Write current configuration into the terminal. */
3125DEFUN (config_write_terminal,
3126 config_write_terminal_cmd,
3127 "write terminal",
3128 "Write running configuration to memory, network, or terminal\n"
3129 "Write to terminal\n")
3130{
8c328f11 3131 unsigned int i;
718e3744 3132 struct cmd_node *node;
3133
3134 if (vty->type == VTY_SHELL_SERV)
3135 {
55468c86 3136 for (i = 0; i < vector_active (cmdvec); i++)
718e3744 3137 if ((node = vector_slot (cmdvec, i)) && node->func && node->vtysh)
3138 {
3139 if ((*node->func) (vty))
3140 vty_out (vty, "!%s", VTY_NEWLINE);
3141 }
3142 }
3143 else
3144 {
3145 vty_out (vty, "%sCurrent configuration:%s", VTY_NEWLINE,
3146 VTY_NEWLINE);
3147 vty_out (vty, "!%s", VTY_NEWLINE);
3148
55468c86 3149 for (i = 0; i < vector_active (cmdvec); i++)
718e3744 3150 if ((node = vector_slot (cmdvec, i)) && node->func)
3151 {
3152 if ((*node->func) (vty))
3153 vty_out (vty, "!%s", VTY_NEWLINE);
3154 }
3155 vty_out (vty, "end%s",VTY_NEWLINE);
3156 }
3157 return CMD_SUCCESS;
3158}
3159
3160/* Write current configuration into the terminal. */
3161ALIAS (config_write_terminal,
3162 show_running_config_cmd,
3163 "show running-config",
3164 SHOW_STR
3165 "running configuration\n")
3166
3167/* Write startup configuration into the terminal. */
3168DEFUN (show_startup_config,
3169 show_startup_config_cmd,
3170 "show startup-config",
3171 SHOW_STR
3172 "Contentes of startup configuration\n")
3173{
3174 char buf[BUFSIZ];
3175 FILE *confp;
3176
3177 confp = fopen (host.config, "r");
3178 if (confp == NULL)
3179 {
3180 vty_out (vty, "Can't open configuration file [%s]%s",
3181 host.config, VTY_NEWLINE);
3182 return CMD_WARNING;
3183 }
3184
3185 while (fgets (buf, BUFSIZ, confp))
3186 {
3187 char *cp = buf;
3188
3189 while (*cp != '\r' && *cp != '\n' && *cp != '\0')
3190 cp++;
3191 *cp = '\0';
3192
3193 vty_out (vty, "%s%s", buf, VTY_NEWLINE);
3194 }
3195
3196 fclose (confp);
3197
3198 return CMD_SUCCESS;
3199}
3200
3201/* Hostname configuration */
3202DEFUN (config_hostname,
3203 hostname_cmd,
3204 "hostname WORD",
3205 "Set system's network name\n"
3206 "This system's network name\n")
3207{
3208 if (!isalpha((int) *argv[0]))
3209 {
3210 vty_out (vty, "Please specify string starting with alphabet%s", VTY_NEWLINE);
3211 return CMD_WARNING;
3212 }
3213
3214 if (host.name)
05865c90 3215 XFREE (MTYPE_HOST, host.name);
718e3744 3216
05865c90 3217 host.name = XSTRDUP (MTYPE_HOST, argv[0]);
718e3744 3218 return CMD_SUCCESS;
3219}
3220
3221DEFUN (config_no_hostname,
3222 no_hostname_cmd,
3223 "no hostname [HOSTNAME]",
3224 NO_STR
3225 "Reset system's network name\n"
3226 "Host name of this router\n")
3227{
3228 if (host.name)
05865c90 3229 XFREE (MTYPE_HOST, host.name);
718e3744 3230 host.name = NULL;
3231 return CMD_SUCCESS;
3232}
3233
3234/* VTY interface password set. */
3235DEFUN (config_password, password_cmd,
3236 "password (8|) WORD",
3237 "Assign the terminal connection password\n"
3238 "Specifies a HIDDEN password will follow\n"
3239 "dummy string \n"
3240 "The HIDDEN line password string\n")
3241{
3242 /* Argument check. */
3243 if (argc == 0)
3244 {
3245 vty_out (vty, "Please specify password.%s", VTY_NEWLINE);
3246 return CMD_WARNING;
3247 }
3248
3249 if (argc == 2)
3250 {
3251 if (*argv[0] == '8')
3252 {
3253 if (host.password)
05865c90 3254 XFREE (MTYPE_HOST, host.password);
718e3744 3255 host.password = NULL;
3256 if (host.password_encrypt)
05865c90 3257 XFREE (MTYPE_HOST, host.password_encrypt);
3258 host.password_encrypt = XSTRDUP (MTYPE_HOST, argv[1]);
718e3744 3259 return CMD_SUCCESS;
3260 }
3261 else
3262 {
3263 vty_out (vty, "Unknown encryption type.%s", VTY_NEWLINE);
3264 return CMD_WARNING;
3265 }
3266 }
3267
3268 if (!isalnum ((int) *argv[0]))
3269 {
3270 vty_out (vty,
3271 "Please specify string starting with alphanumeric%s", VTY_NEWLINE);
3272 return CMD_WARNING;
3273 }
3274
3275 if (host.password)
05865c90 3276 XFREE (MTYPE_HOST, host.password);
718e3744 3277 host.password = NULL;
3278
3279 if (host.encrypt)
3280 {
3281 if (host.password_encrypt)
05865c90 3282 XFREE (MTYPE_HOST, host.password_encrypt);
3283 host.password_encrypt = XSTRDUP (MTYPE_HOST, zencrypt (argv[0]));
718e3744 3284 }
3285 else
05865c90 3286 host.password = XSTRDUP (MTYPE_HOST, argv[0]);
718e3744 3287
3288 return CMD_SUCCESS;
3289}
3290
3291ALIAS (config_password, password_text_cmd,
3292 "password LINE",
3293 "Assign the terminal connection password\n"
3294 "The UNENCRYPTED (cleartext) line password\n")
3295
3296/* VTY enable password set. */
3297DEFUN (config_enable_password, enable_password_cmd,
3298 "enable password (8|) WORD",
3299 "Modify enable password parameters\n"
3300 "Assign the privileged level password\n"
3301 "Specifies a HIDDEN password will follow\n"
3302 "dummy string \n"
3303 "The HIDDEN 'enable' password string\n")
3304{
3305 /* Argument check. */
3306 if (argc == 0)
3307 {
3308 vty_out (vty, "Please specify password.%s", VTY_NEWLINE);
3309 return CMD_WARNING;
3310 }
3311
3312 /* Crypt type is specified. */
3313 if (argc == 2)
3314 {
3315 if (*argv[0] == '8')
3316 {
3317 if (host.enable)
05865c90 3318 XFREE (MTYPE_HOST, host.enable);
718e3744 3319 host.enable = NULL;
3320
3321 if (host.enable_encrypt)
05865c90 3322 XFREE (MTYPE_HOST, host.enable_encrypt);
3323 host.enable_encrypt = XSTRDUP (MTYPE_HOST, argv[1]);
718e3744 3324
3325 return CMD_SUCCESS;
3326 }
3327 else
3328 {
3329 vty_out (vty, "Unknown encryption type.%s", VTY_NEWLINE);
3330 return CMD_WARNING;
3331 }
3332 }
3333
3334 if (!isalnum ((int) *argv[0]))
3335 {
3336 vty_out (vty,
3337 "Please specify string starting with alphanumeric%s", VTY_NEWLINE);
3338 return CMD_WARNING;
3339 }
3340
3341 if (host.enable)
05865c90 3342 XFREE (MTYPE_HOST, host.enable);
718e3744 3343 host.enable = NULL;
3344
3345 /* Plain password input. */
3346 if (host.encrypt)
3347 {
3348 if (host.enable_encrypt)
05865c90 3349 XFREE (MTYPE_HOST, host.enable_encrypt);
3350 host.enable_encrypt = XSTRDUP (MTYPE_HOST, zencrypt (argv[0]));
718e3744 3351 }
3352 else
05865c90 3353 host.enable = XSTRDUP (MTYPE_HOST, argv[0]);
718e3744 3354
3355 return CMD_SUCCESS;
3356}
3357
3358ALIAS (config_enable_password,
3359 enable_password_text_cmd,
3360 "enable password LINE",
3361 "Modify enable password parameters\n"
3362 "Assign the privileged level password\n"
3363 "The UNENCRYPTED (cleartext) 'enable' password\n")
3364
3365/* VTY enable password delete. */
3366DEFUN (no_config_enable_password, no_enable_password_cmd,
3367 "no enable password",
3368 NO_STR
3369 "Modify enable password parameters\n"
3370 "Assign the privileged level password\n")
3371{
3372 if (host.enable)
05865c90 3373 XFREE (MTYPE_HOST, host.enable);
718e3744 3374 host.enable = NULL;
3375
3376 if (host.enable_encrypt)
05865c90 3377 XFREE (MTYPE_HOST, host.enable_encrypt);
718e3744 3378 host.enable_encrypt = NULL;
3379
3380 return CMD_SUCCESS;
3381}
3382
3383DEFUN (service_password_encrypt,
3384 service_password_encrypt_cmd,
3385 "service password-encryption",
3386 "Set up miscellaneous service\n"
3387 "Enable encrypted passwords\n")
3388{
3389 if (host.encrypt)
3390 return CMD_SUCCESS;
3391
3392 host.encrypt = 1;
3393
3394 if (host.password)
3395 {
3396 if (host.password_encrypt)
05865c90 3397 XFREE (MTYPE_HOST, host.password_encrypt);
3398 host.password_encrypt = XSTRDUP (MTYPE_HOST, zencrypt (host.password));
718e3744 3399 }
3400 if (host.enable)
3401 {
3402 if (host.enable_encrypt)
05865c90 3403 XFREE (MTYPE_HOST, host.enable_encrypt);
3404 host.enable_encrypt = XSTRDUP (MTYPE_HOST, zencrypt (host.enable));
718e3744 3405 }
3406
3407 return CMD_SUCCESS;
3408}
3409
3410DEFUN (no_service_password_encrypt,
3411 no_service_password_encrypt_cmd,
3412 "no service password-encryption",
3413 NO_STR
3414 "Set up miscellaneous service\n"
3415 "Enable encrypted passwords\n")
3416{
3417 if (! host.encrypt)
3418 return CMD_SUCCESS;
3419
3420 host.encrypt = 0;
3421
3422 if (host.password_encrypt)
05865c90 3423 XFREE (MTYPE_HOST, host.password_encrypt);
718e3744 3424 host.password_encrypt = NULL;
3425
3426 if (host.enable_encrypt)
05865c90 3427 XFREE (MTYPE_HOST, host.enable_encrypt);
718e3744 3428 host.enable_encrypt = NULL;
3429
3430 return CMD_SUCCESS;
3431}
3432
3433DEFUN (config_terminal_length, config_terminal_length_cmd,
3434 "terminal length <0-512>",
3435 "Set terminal line parameters\n"
3436 "Set number of lines on a screen\n"
3437 "Number of lines on screen (0 for no pausing)\n")
3438{
3439 int lines;
3440 char *endptr = NULL;
3441
3442 lines = strtol (argv[0], &endptr, 10);
3443 if (lines < 0 || lines > 512 || *endptr != '\0')
3444 {
3445 vty_out (vty, "length is malformed%s", VTY_NEWLINE);
3446 return CMD_WARNING;
3447 }
3448 vty->lines = lines;
3449
3450 return CMD_SUCCESS;
3451}
3452
3453DEFUN (config_terminal_no_length, config_terminal_no_length_cmd,
3454 "terminal no length",
3455 "Set terminal line parameters\n"
3456 NO_STR
3457 "Set number of lines on a screen\n")
3458{
3459 vty->lines = -1;
3460 return CMD_SUCCESS;
3461}
3462
3463DEFUN (service_terminal_length, service_terminal_length_cmd,
3464 "service terminal-length <0-512>",
3465 "Set up miscellaneous service\n"
3466 "System wide terminal length configuration\n"
3467 "Number of lines of VTY (0 means no line control)\n")
3468{
3469 int lines;
3470 char *endptr = NULL;
3471
3472 lines = strtol (argv[0], &endptr, 10);
3473 if (lines < 0 || lines > 512 || *endptr != '\0')
3474 {
3475 vty_out (vty, "length is malformed%s", VTY_NEWLINE);
3476 return CMD_WARNING;
3477 }
3478 host.lines = lines;
3479
3480 return CMD_SUCCESS;
3481}
3482
3483DEFUN (no_service_terminal_length, no_service_terminal_length_cmd,
3484 "no service terminal-length [<0-512>]",
3485 NO_STR
3486 "Set up miscellaneous service\n"
3487 "System wide terminal length configuration\n"
3488 "Number of lines of VTY (0 means no line control)\n")
3489{
3490 host.lines = -1;
3491 return CMD_SUCCESS;
3492}
3493
2885f72d 3494DEFUN_HIDDEN (do_echo,
3495 echo_cmd,
3496 "echo .MESSAGE",
3497 "Echo a message back to the vty\n"
3498 "The message to echo\n")
3499{
3500 char *message;
3501
f6834d4c 3502 vty_out (vty, "%s%s", ((message = argv_concat(argv, argc, 0)) ? message : ""),
3503 VTY_NEWLINE);
3504 if (message)
3505 XFREE(MTYPE_TMP, message);
2885f72d 3506 return CMD_SUCCESS;
3507}
3508
274a4a44 3509DEFUN (config_logmsg,
3510 config_logmsg_cmd,
3511 "logmsg "LOG_LEVELS" .MESSAGE",
3512 "Send a message to enabled logging destinations\n"
3513 LOG_LEVEL_DESC
3514 "The message to send\n")
3515{
3516 int level;
3517 char *message;
3518
3519 if ((level = level_match(argv[0])) == ZLOG_DISABLED)
3520 return CMD_ERR_NO_MATCH;
3521
fc95186c 3522 zlog(NULL, level, "%s", ((message = argv_concat(argv, argc, 1)) ? message : ""));
f6834d4c 3523 if (message)
3524 XFREE(MTYPE_TMP, message);
274a4a44 3525 return CMD_SUCCESS;
3526}
3527
3528DEFUN (show_logging,
3529 show_logging_cmd,
3530 "show logging",
3531 SHOW_STR
3532 "Show current logging configuration\n")
3533{
3534 struct zlog *zl = zlog_default;
3535
3536 vty_out (vty, "Syslog logging: ");
3537 if (zl->maxlvl[ZLOG_DEST_SYSLOG] == ZLOG_DISABLED)
3538 vty_out (vty, "disabled");
3539 else
3540 vty_out (vty, "level %s, facility %s, ident %s",
3541 zlog_priority[zl->maxlvl[ZLOG_DEST_SYSLOG]],
3542 facility_name(zl->facility), zl->ident);
3543 vty_out (vty, "%s", VTY_NEWLINE);
3544
3545 vty_out (vty, "Stdout logging: ");
3546 if (zl->maxlvl[ZLOG_DEST_STDOUT] == ZLOG_DISABLED)
3547 vty_out (vty, "disabled");
3548 else
3549 vty_out (vty, "level %s",
3550 zlog_priority[zl->maxlvl[ZLOG_DEST_STDOUT]]);
3551 vty_out (vty, "%s", VTY_NEWLINE);
3552
3553 vty_out (vty, "Monitor logging: ");
3554 if (zl->maxlvl[ZLOG_DEST_MONITOR] == ZLOG_DISABLED)
3555 vty_out (vty, "disabled");
3556 else
3557 vty_out (vty, "level %s",
3558 zlog_priority[zl->maxlvl[ZLOG_DEST_MONITOR]]);
3559 vty_out (vty, "%s", VTY_NEWLINE);
3560
3561 vty_out (vty, "File logging: ");
3562 if ((zl->maxlvl[ZLOG_DEST_FILE] == ZLOG_DISABLED) ||
3563 !zl->fp)
3564 vty_out (vty, "disabled");
3565 else
3566 vty_out (vty, "level %s, filename %s",
3567 zlog_priority[zl->maxlvl[ZLOG_DEST_FILE]],
3568 zl->filename);
3569 vty_out (vty, "%s", VTY_NEWLINE);
3570
3571 vty_out (vty, "Protocol name: %s%s",
3572 zlog_proto_names[zl->protocol], VTY_NEWLINE);
3573 vty_out (vty, "Record priority: %s%s",
3574 (zl->record_priority ? "enabled" : "disabled"), VTY_NEWLINE);
1ed72e0b
AS
3575 vty_out (vty, "Timestamp precision: %d%s",
3576 zl->timestamp_precision, VTY_NEWLINE);
274a4a44 3577
3578 return CMD_SUCCESS;
3579}
3580
718e3744 3581DEFUN (config_log_stdout,
3582 config_log_stdout_cmd,
3583 "log stdout",
3584 "Logging control\n"
274a4a44 3585 "Set stdout logging level\n")
718e3744 3586{
274a4a44 3587 zlog_set_level (NULL, ZLOG_DEST_STDOUT, zlog_default->default_lvl);
3588 return CMD_SUCCESS;
3589}
3590
3591DEFUN (config_log_stdout_level,
3592 config_log_stdout_level_cmd,
3593 "log stdout "LOG_LEVELS,
3594 "Logging control\n"
3595 "Set stdout logging level\n"
3596 LOG_LEVEL_DESC)
3597{
3598 int level;
3599
3600 if ((level = level_match(argv[0])) == ZLOG_DISABLED)
3601 return CMD_ERR_NO_MATCH;
3602 zlog_set_level (NULL, ZLOG_DEST_STDOUT, level);
718e3744 3603 return CMD_SUCCESS;
3604}
3605
3606DEFUN (no_config_log_stdout,
3607 no_config_log_stdout_cmd,
274a4a44 3608 "no log stdout [LEVEL]",
718e3744 3609 NO_STR
3610 "Logging control\n"
274a4a44 3611 "Cancel logging to stdout\n"
3612 "Logging level\n")
718e3744 3613{
274a4a44 3614 zlog_set_level (NULL, ZLOG_DEST_STDOUT, ZLOG_DISABLED);
718e3744 3615 return CMD_SUCCESS;
3616}
3617
274a4a44 3618DEFUN (config_log_monitor,
3619 config_log_monitor_cmd,
3620 "log monitor",
718e3744 3621 "Logging control\n"
274a4a44 3622 "Set terminal line (monitor) logging level\n")
3623{
3624 zlog_set_level (NULL, ZLOG_DEST_MONITOR, zlog_default->default_lvl);
3625 return CMD_SUCCESS;
3626}
3627
3628DEFUN (config_log_monitor_level,
3629 config_log_monitor_level_cmd,
3630 "log monitor "LOG_LEVELS,
3631 "Logging control\n"
3632 "Set terminal line (monitor) logging level\n"
3633 LOG_LEVEL_DESC)
3634{
3635 int level;
3636
3637 if ((level = level_match(argv[0])) == ZLOG_DISABLED)
3638 return CMD_ERR_NO_MATCH;
3639 zlog_set_level (NULL, ZLOG_DEST_MONITOR, level);
3640 return CMD_SUCCESS;
3641}
3642
3643DEFUN (no_config_log_monitor,
3644 no_config_log_monitor_cmd,
3645 "no log monitor [LEVEL]",
3646 NO_STR
3647 "Logging control\n"
3648 "Disable terminal line (monitor) logging\n"
3649 "Logging level\n")
3650{
3651 zlog_set_level (NULL, ZLOG_DEST_MONITOR, ZLOG_DISABLED);
3652 return CMD_SUCCESS;
3653}
3654
3655static int
3656set_log_file(struct vty *vty, const char *fname, int loglevel)
718e3744 3657{
3658 int ret;
9035efaa 3659 char *p = NULL;
3660 const char *fullpath;
3661
718e3744 3662 /* Path detection. */
274a4a44 3663 if (! IS_DIRECTORY_SEP (*fname))
718e3744 3664 {
9035efaa 3665 char cwd[MAXPATHLEN+1];
3666 cwd[MAXPATHLEN] = '\0';
3667
3668 if (getcwd (cwd, MAXPATHLEN) == NULL)
3669 {
3670 zlog_err ("config_log_file: Unable to alloc mem!");
3671 return CMD_WARNING;
3672 }
3673
274a4a44 3674 if ( (p = XMALLOC (MTYPE_TMP, strlen (cwd) + strlen (fname) + 2))
9035efaa 3675 == NULL)
3676 {
3677 zlog_err ("config_log_file: Unable to alloc mem!");
3678 return CMD_WARNING;
3679 }
274a4a44 3680 sprintf (p, "%s/%s", cwd, fname);
9035efaa 3681 fullpath = p;
718e3744 3682 }
3683 else
274a4a44 3684 fullpath = fname;
718e3744 3685
274a4a44 3686 ret = zlog_set_file (NULL, fullpath, loglevel);
718e3744 3687
9035efaa 3688 if (p)
3689 XFREE (MTYPE_TMP, p);
3690
718e3744 3691 if (!ret)
3692 {
274a4a44 3693 vty_out (vty, "can't open logfile %s\n", fname);
718e3744 3694 return CMD_WARNING;
3695 }
3696
3697 if (host.logfile)
05865c90 3698 XFREE (MTYPE_HOST, host.logfile);
718e3744 3699
05865c90 3700 host.logfile = XSTRDUP (MTYPE_HOST, fname);
718e3744 3701
3702 return CMD_SUCCESS;
3703}
3704
274a4a44 3705DEFUN (config_log_file,
3706 config_log_file_cmd,
3707 "log file FILENAME",
3708 "Logging control\n"
3709 "Logging to file\n"
3710 "Logging filename\n")
3711{
3712 return set_log_file(vty, argv[0], zlog_default->default_lvl);
3713}
3714
3715DEFUN (config_log_file_level,
3716 config_log_file_level_cmd,
3717 "log file FILENAME "LOG_LEVELS,
3718 "Logging control\n"
3719 "Logging to file\n"
3720 "Logging filename\n"
3721 LOG_LEVEL_DESC)
3722{
3723 int level;
3724
3725 if ((level = level_match(argv[1])) == ZLOG_DISABLED)
3726 return CMD_ERR_NO_MATCH;
3727 return set_log_file(vty, argv[0], level);
3728}
3729
718e3744 3730DEFUN (no_config_log_file,
3731 no_config_log_file_cmd,
3732 "no log file [FILENAME]",
3733 NO_STR
3734 "Logging control\n"
3735 "Cancel logging to file\n"
3736 "Logging file name\n")
3737{
3738 zlog_reset_file (NULL);
3739
3740 if (host.logfile)
05865c90 3741 XFREE (MTYPE_HOST, host.logfile);
718e3744 3742
3743 host.logfile = NULL;
3744
3745 return CMD_SUCCESS;
3746}
3747
274a4a44 3748ALIAS (no_config_log_file,
3749 no_config_log_file_level_cmd,
3750 "no log file FILENAME LEVEL",
3751 NO_STR
3752 "Logging control\n"
3753 "Cancel logging to file\n"
3754 "Logging file name\n"
3755 "Logging level\n")
3756
718e3744 3757DEFUN (config_log_syslog,
3758 config_log_syslog_cmd,
3759 "log syslog",
3760 "Logging control\n"
274a4a44 3761 "Set syslog logging level\n")
718e3744 3762{
274a4a44 3763 zlog_set_level (NULL, ZLOG_DEST_SYSLOG, zlog_default->default_lvl);
12ab19f1 3764 return CMD_SUCCESS;
3765}
3766
274a4a44 3767DEFUN (config_log_syslog_level,
3768 config_log_syslog_level_cmd,
3769 "log syslog "LOG_LEVELS,
12ab19f1 3770 "Logging control\n"
274a4a44 3771 "Set syslog logging level\n"
3772 LOG_LEVEL_DESC)
3773{
3774 int level;
12ab19f1 3775
274a4a44 3776 if ((level = level_match(argv[0])) == ZLOG_DISABLED)
3777 return CMD_ERR_NO_MATCH;
3778 zlog_set_level (NULL, ZLOG_DEST_SYSLOG, level);
3779 return CMD_SUCCESS;
3780}
3781
3782DEFUN_DEPRECATED (config_log_syslog_facility,
3783 config_log_syslog_facility_cmd,
3784 "log syslog facility "LOG_FACILITIES,
3785 "Logging control\n"
3786 "Logging goes to syslog\n"
3787 "(Deprecated) Facility parameter for syslog messages\n"
3788 LOG_FACILITY_DESC)
3789{
3790 int facility;
3791
3792 if ((facility = facility_match(argv[0])) < 0)
3793 return CMD_ERR_NO_MATCH;
12ab19f1 3794
274a4a44 3795 zlog_set_level (NULL, ZLOG_DEST_SYSLOG, zlog_default->default_lvl);
3796 zlog_default->facility = facility;
718e3744 3797 return CMD_SUCCESS;
3798}
3799
3800DEFUN (no_config_log_syslog,
3801 no_config_log_syslog_cmd,
274a4a44 3802 "no log syslog [LEVEL]",
718e3744 3803 NO_STR
3804 "Logging control\n"
274a4a44 3805 "Cancel logging to syslog\n"
3806 "Logging level\n")
718e3744 3807{
274a4a44 3808 zlog_set_level (NULL, ZLOG_DEST_SYSLOG, ZLOG_DISABLED);
718e3744 3809 return CMD_SUCCESS;
3810}
3811
12ab19f1 3812ALIAS (no_config_log_syslog,
3813 no_config_log_syslog_facility_cmd,
274a4a44 3814 "no log syslog facility "LOG_FACILITIES,
12ab19f1 3815 NO_STR
3816 "Logging control\n"
3817 "Logging goes to syslog\n"
3818 "Facility parameter for syslog messages\n"
274a4a44 3819 LOG_FACILITY_DESC)
3820
3821DEFUN (config_log_facility,
3822 config_log_facility_cmd,
3823 "log facility "LOG_FACILITIES,
718e3744 3824 "Logging control\n"
274a4a44 3825 "Facility parameter for syslog messages\n"
3826 LOG_FACILITY_DESC)
718e3744 3827{
274a4a44 3828 int facility;
3829
3830 if ((facility = facility_match(argv[0])) < 0)
3831 return CMD_ERR_NO_MATCH;
3832 zlog_default->facility = facility;
3833 return CMD_SUCCESS;
718e3744 3834}
3835
274a4a44 3836DEFUN (no_config_log_facility,
3837 no_config_log_facility_cmd,
3838 "no log facility [FACILITY]",
718e3744 3839 NO_STR
3840 "Logging control\n"
274a4a44 3841 "Reset syslog facility to default (daemon)\n"
3842 "Syslog facility\n")
3843{
3844 zlog_default->facility = LOG_DAEMON;
3845 return CMD_SUCCESS;
3846}
3847
3848DEFUN_DEPRECATED (config_log_trap,
3849 config_log_trap_cmd,
3850 "log trap "LOG_LEVELS,
3851 "Logging control\n"
3852 "(Deprecated) Set logging level and default for all destinations\n"
3853 LOG_LEVEL_DESC)
3854{
3855 int new_level ;
3856 int i;
3857
3858 if ((new_level = level_match(argv[0])) == ZLOG_DISABLED)
3859 return CMD_ERR_NO_MATCH;
3860
3861 zlog_default->default_lvl = new_level;
3862 for (i = 0; i < ZLOG_NUM_DESTS; i++)
3863 if (zlog_default->maxlvl[i] != ZLOG_DISABLED)
3864 zlog_default->maxlvl[i] = new_level;
3865 return CMD_SUCCESS;
3866}
3867
3868DEFUN_DEPRECATED (no_config_log_trap,
3869 no_config_log_trap_cmd,
3870 "no log trap [LEVEL]",
3871 NO_STR
3872 "Logging control\n"
3873 "Permit all logging information\n"
3874 "Logging level\n")
718e3744 3875{
274a4a44 3876 zlog_default->default_lvl = LOG_DEBUG;
718e3744 3877 return CMD_SUCCESS;
3878}
3879
3880DEFUN (config_log_record_priority,
3881 config_log_record_priority_cmd,
3882 "log record-priority",
3883 "Logging control\n"
3884 "Log the priority of the message within the message\n")
3885{
3886 zlog_default->record_priority = 1 ;
3887 return CMD_SUCCESS;
3888}
3889
3890DEFUN (no_config_log_record_priority,
3891 no_config_log_record_priority_cmd,
3892 "no log record-priority",
3893 NO_STR
3894 "Logging control\n"
3895 "Do not log the priority of the message within the message\n")
3896{
3897 zlog_default->record_priority = 0 ;
3898 return CMD_SUCCESS;
3899}
3900
1ed72e0b
AS
3901DEFUN (config_log_timestamp_precision,
3902 config_log_timestamp_precision_cmd,
3903 "log timestamp precision <0-6>",
3904 "Logging control\n"
3905 "Timestamp configuration\n"
3906 "Set the timestamp precision\n"
3907 "Number of subsecond digits\n")
3908{
3909 if (argc != 1)
3910 {
3911 vty_out (vty, "Insufficient arguments%s", VTY_NEWLINE);
3912 return CMD_WARNING;
3913 }
3914
3915 VTY_GET_INTEGER_RANGE("Timestamp Precision",
3916 zlog_default->timestamp_precision, argv[0], 0, 6);
3917 return CMD_SUCCESS;
3918}
3919
3920DEFUN (no_config_log_timestamp_precision,
3921 no_config_log_timestamp_precision_cmd,
3922 "no log timestamp precision",
3923 NO_STR
3924 "Logging control\n"
3925 "Timestamp configuration\n"
3926 "Reset the timestamp precision to the default value of 0\n")
3927{
3928 zlog_default->timestamp_precision = 0 ;
3929 return CMD_SUCCESS;
3930}
3931
3b0c5d9a 3932DEFUN (banner_motd_file,
3933 banner_motd_file_cmd,
3934 "banner motd file [FILE]",
3935 "Set banner\n"
3936 "Banner for motd\n"
3937 "Banner from a file\n"
3938 "Filename\n")
3939{
b45da6f0 3940 if (host.motdfile)
05865c90 3941 XFREE (MTYPE_HOST, host.motdfile);
3942 host.motdfile = XSTRDUP (MTYPE_HOST, argv[0]);
b45da6f0 3943
3b0c5d9a 3944 return CMD_SUCCESS;
3945}
718e3744 3946
3947DEFUN (banner_motd_default,
3948 banner_motd_default_cmd,
3949 "banner motd default",
3950 "Set banner string\n"
3951 "Strings for motd\n"
3952 "Default string\n")
3953{
3954 host.motd = default_motd;
3955 return CMD_SUCCESS;
3956}
3957
3958DEFUN (no_banner_motd,
3959 no_banner_motd_cmd,
3960 "no banner motd",
3961 NO_STR
3962 "Set banner string\n"
3963 "Strings for motd\n")
3964{
3965 host.motd = NULL;
22085181 3966 if (host.motdfile)
05865c90 3967 XFREE (MTYPE_HOST, host.motdfile);
3b0c5d9a 3968 host.motdfile = NULL;
718e3744 3969 return CMD_SUCCESS;
3970}
3971
3972/* Set config filename. Called from vty.c */
3973void
3974host_config_set (char *filename)
3975{
228da428
CC
3976 if (host.config)
3977 XFREE (MTYPE_HOST, host.config);
05865c90 3978 host.config = XSTRDUP (MTYPE_HOST, filename);
718e3744 3979}
3980
3981void
3982install_default (enum node_type node)
3983{
3984 install_element (node, &config_exit_cmd);
3985 install_element (node, &config_quit_cmd);
3986 install_element (node, &config_end_cmd);
3987 install_element (node, &config_help_cmd);
3988 install_element (node, &config_list_cmd);
3989
3990 install_element (node, &config_write_terminal_cmd);
3991 install_element (node, &config_write_file_cmd);
3992 install_element (node, &config_write_memory_cmd);
3993 install_element (node, &config_write_cmd);
3994 install_element (node, &show_running_config_cmd);
3995}
3996
3997/* Initialize command interface. Install basic nodes and commands. */
3998void
3999cmd_init (int terminal)
4000{
cd40b329
CF
4001 command_cr = XSTRDUP(MTYPE_CMD_TOKENS, "<cr>");
4002 token_cr.type = TOKEN_TERMINAL;
4003 token_cr.cmd = command_cr;
4004 token_cr.desc = XSTRDUP(MTYPE_CMD_TOKENS, "");
228da428 4005
718e3744 4006 /* Allocate initial top vector of commands. */
4007 cmdvec = vector_init (VECTOR_MIN_SIZE);
4008
4009 /* Default host value settings. */
4010 host.name = NULL;
4011 host.password = NULL;
4012 host.enable = NULL;
4013 host.logfile = NULL;
4014 host.config = NULL;
4015 host.lines = -1;
4016 host.motd = default_motd;
3b0c5d9a 4017 host.motdfile = NULL;
718e3744 4018
4019 /* Install top nodes. */
4020 install_node (&view_node, NULL);
4021 install_node (&enable_node, NULL);
4022 install_node (&auth_node, NULL);
4023 install_node (&auth_enable_node, NULL);
62687ff1 4024 install_node (&restricted_node, NULL);
718e3744 4025 install_node (&config_node, config_write_host);
4026
4027 /* Each node's basic commands. */
4028 install_element (VIEW_NODE, &show_version_cmd);
4029 if (terminal)
4030 {
4031 install_element (VIEW_NODE, &config_list_cmd);
4032 install_element (VIEW_NODE, &config_exit_cmd);
4033 install_element (VIEW_NODE, &config_quit_cmd);
4034 install_element (VIEW_NODE, &config_help_cmd);
4035 install_element (VIEW_NODE, &config_enable_cmd);
4036 install_element (VIEW_NODE, &config_terminal_length_cmd);
4037 install_element (VIEW_NODE, &config_terminal_no_length_cmd);
274a4a44 4038 install_element (VIEW_NODE, &show_logging_cmd);
2885f72d 4039 install_element (VIEW_NODE, &echo_cmd);
62687ff1
PJ
4040
4041 install_element (RESTRICTED_NODE, &config_list_cmd);
4042 install_element (RESTRICTED_NODE, &config_exit_cmd);
4043 install_element (RESTRICTED_NODE, &config_quit_cmd);
4044 install_element (RESTRICTED_NODE, &config_help_cmd);
4045 install_element (RESTRICTED_NODE, &config_enable_cmd);
4046 install_element (RESTRICTED_NODE, &config_terminal_length_cmd);
4047 install_element (RESTRICTED_NODE, &config_terminal_no_length_cmd);
4048 install_element (RESTRICTED_NODE, &echo_cmd);
718e3744 4049 }
4050
4051 if (terminal)
4052 {
4053 install_default (ENABLE_NODE);
4054 install_element (ENABLE_NODE, &config_disable_cmd);
4055 install_element (ENABLE_NODE, &config_terminal_cmd);
4056 install_element (ENABLE_NODE, &copy_runningconfig_startupconfig_cmd);
4057 }
4058 install_element (ENABLE_NODE, &show_startup_config_cmd);
4059 install_element (ENABLE_NODE, &show_version_cmd);
718e3744 4060
718e3744 4061 if (terminal)
4062 {
e7168df4 4063 install_element (ENABLE_NODE, &config_terminal_length_cmd);
4064 install_element (ENABLE_NODE, &config_terminal_no_length_cmd);
274a4a44 4065 install_element (ENABLE_NODE, &show_logging_cmd);
2885f72d 4066 install_element (ENABLE_NODE, &echo_cmd);
274a4a44 4067 install_element (ENABLE_NODE, &config_logmsg_cmd);
e7168df4 4068
4069 install_default (CONFIG_NODE);
ea8e9d97 4070 }
4071
4072 install_element (CONFIG_NODE, &hostname_cmd);
4073 install_element (CONFIG_NODE, &no_hostname_cmd);
e7168df4 4074
ea8e9d97 4075 if (terminal)
4076 {
e7168df4 4077 install_element (CONFIG_NODE, &password_cmd);
4078 install_element (CONFIG_NODE, &password_text_cmd);
4079 install_element (CONFIG_NODE, &enable_password_cmd);
4080 install_element (CONFIG_NODE, &enable_password_text_cmd);
4081 install_element (CONFIG_NODE, &no_enable_password_cmd);
4082
718e3744 4083 install_element (CONFIG_NODE, &config_log_stdout_cmd);
274a4a44 4084 install_element (CONFIG_NODE, &config_log_stdout_level_cmd);
718e3744 4085 install_element (CONFIG_NODE, &no_config_log_stdout_cmd);
274a4a44 4086 install_element (CONFIG_NODE, &config_log_monitor_cmd);
4087 install_element (CONFIG_NODE, &config_log_monitor_level_cmd);
4088 install_element (CONFIG_NODE, &no_config_log_monitor_cmd);
718e3744 4089 install_element (CONFIG_NODE, &config_log_file_cmd);
274a4a44 4090 install_element (CONFIG_NODE, &config_log_file_level_cmd);
718e3744 4091 install_element (CONFIG_NODE, &no_config_log_file_cmd);
274a4a44 4092 install_element (CONFIG_NODE, &no_config_log_file_level_cmd);
718e3744 4093 install_element (CONFIG_NODE, &config_log_syslog_cmd);
274a4a44 4094 install_element (CONFIG_NODE, &config_log_syslog_level_cmd);
12ab19f1 4095 install_element (CONFIG_NODE, &config_log_syslog_facility_cmd);
718e3744 4096 install_element (CONFIG_NODE, &no_config_log_syslog_cmd);
12ab19f1 4097 install_element (CONFIG_NODE, &no_config_log_syslog_facility_cmd);
274a4a44 4098 install_element (CONFIG_NODE, &config_log_facility_cmd);
4099 install_element (CONFIG_NODE, &no_config_log_facility_cmd);
718e3744 4100 install_element (CONFIG_NODE, &config_log_trap_cmd);
4101 install_element (CONFIG_NODE, &no_config_log_trap_cmd);
4102 install_element (CONFIG_NODE, &config_log_record_priority_cmd);
4103 install_element (CONFIG_NODE, &no_config_log_record_priority_cmd);
1ed72e0b
AS
4104 install_element (CONFIG_NODE, &config_log_timestamp_precision_cmd);
4105 install_element (CONFIG_NODE, &no_config_log_timestamp_precision_cmd);
718e3744 4106 install_element (CONFIG_NODE, &service_password_encrypt_cmd);
4107 install_element (CONFIG_NODE, &no_service_password_encrypt_cmd);
4108 install_element (CONFIG_NODE, &banner_motd_default_cmd);
3b0c5d9a 4109 install_element (CONFIG_NODE, &banner_motd_file_cmd);
718e3744 4110 install_element (CONFIG_NODE, &no_banner_motd_cmd);
4111 install_element (CONFIG_NODE, &service_terminal_length_cmd);
4112 install_element (CONFIG_NODE, &no_service_terminal_length_cmd);
718e3744 4113
354d119a 4114 install_element (VIEW_NODE, &show_thread_cpu_cmd);
4115 install_element (ENABLE_NODE, &show_thread_cpu_cmd);
62687ff1 4116 install_element (RESTRICTED_NODE, &show_thread_cpu_cmd);
e276eb82
PJ
4117
4118 install_element (ENABLE_NODE, &clear_thread_cpu_cmd);
354d119a 4119 install_element (VIEW_NODE, &show_work_queues_cmd);
4120 install_element (ENABLE_NODE, &show_work_queues_cmd);
9ab6812d 4121 }
718e3744 4122 srand(time(NULL));
4123}
228da428 4124
cd40b329
CF
4125static void
4126cmd_terminate_token(struct cmd_token *token)
4127{
4128 unsigned int i, j;
4129 vector keyword_vect;
4130
4131 if (token->multiple)
4132 {
4133 for (i = 0; i < vector_active(token->multiple); i++)
4134 cmd_terminate_token(vector_slot(token->multiple, i));
4135 vector_free(token->multiple);
4136 token->multiple = NULL;
4137 }
4138
4139 if (token->keyword)
4140 {
4141 for (i = 0; i < vector_active(token->keyword); i++)
4142 {
4143 keyword_vect = vector_slot(token->keyword, i);
4144 for (j = 0; j < vector_active(keyword_vect); j++)
4145 cmd_terminate_token(vector_slot(keyword_vect, j));
4146 vector_free(keyword_vect);
4147 }
4148 vector_free(token->keyword);
4149 token->keyword = NULL;
4150 }
4151
4152 XFREE(MTYPE_CMD_TOKENS, token->cmd);
4153 XFREE(MTYPE_CMD_TOKENS, token->desc);
4154
4155 XFREE(MTYPE_CMD_TOKENS, token);
4156}
4157
4158static void
4159cmd_terminate_element(struct cmd_element *cmd)
4160{
4161 unsigned int i;
4162
4163 if (cmd->tokens == NULL)
4164 return;
4165
4166 for (i = 0; i < vector_active(cmd->tokens); i++)
4167 cmd_terminate_token(vector_slot(cmd->tokens, i));
4168
4169 vector_free(cmd->tokens);
4170 cmd->tokens = NULL;
4171}
4172
228da428
CC
4173void
4174cmd_terminate ()
4175{
cd40b329 4176 unsigned int i, j;
228da428
CC
4177 struct cmd_node *cmd_node;
4178 struct cmd_element *cmd_element;
cd40b329 4179 vector cmd_node_v;
228da428
CC
4180
4181 if (cmdvec)
4182 {
4183 for (i = 0; i < vector_active (cmdvec); i++)
4184 if ((cmd_node = vector_slot (cmdvec, i)) != NULL)
4185 {
4186 cmd_node_v = cmd_node->cmd_vector;
4187
4188 for (j = 0; j < vector_active (cmd_node_v); j++)
cd40b329
CF
4189 if ((cmd_element = vector_slot (cmd_node_v, j)) != NULL)
4190 cmd_terminate_element(cmd_element);
228da428
CC
4191
4192 vector_free (cmd_node_v);
4193 }
4194
4195 vector_free (cmdvec);
4196 cmdvec = NULL;
4197 }
4198
4199 if (command_cr)
cd40b329
CF
4200 XFREE(MTYPE_CMD_TOKENS, command_cr);
4201 if (token_cr.desc)
4202 XFREE(MTYPE_CMD_TOKENS, token_cr.desc);
228da428
CC
4203 if (host.name)
4204 XFREE (MTYPE_HOST, host.name);
4205 if (host.password)
4206 XFREE (MTYPE_HOST, host.password);
4207 if (host.password_encrypt)
4208 XFREE (MTYPE_HOST, host.password_encrypt);
4209 if (host.enable)
4210 XFREE (MTYPE_HOST, host.enable);
4211 if (host.enable_encrypt)
4212 XFREE (MTYPE_HOST, host.enable_encrypt);
4213 if (host.logfile)
4214 XFREE (MTYPE_HOST, host.logfile);
4215 if (host.motdfile)
4216 XFREE (MTYPE_HOST, host.motdfile);
4217 if (host.config)
4218 XFREE (MTYPE_HOST, host.config);
4219}