1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * part of this file is taken from libcli (libcli.sourceforge.net) *
6 * Copyright (C) David Parrish (david@dparrish.com) *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
27 #include "replacements.h"
40 void command_print_help_line(command_context_t* context, struct command_s *command, int indent);
42 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
44 int build_unique_lengths(command_context_t *context, command_t *commands)
48 /* iterate through all commands */
49 for (c = commands; c; c = c->next)
51 /* find out how many characters are required to uniquely identify a command */
52 for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
56 /* for every command, see if the current length is enough */
57 for (p = commands; p; p = p->next)
59 /* ignore the command itself */
63 /* compare commands up to the current length */
64 if (strncmp(p->name, c->name, c->unique_len) == 0)
68 /* when none of the commands matched, we've found the minimum length required */
73 /* if the current command has children, build the unique lengths for them */
75 build_unique_lengths(context, c->children);
81 /* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n).
82 * Makes a difference on ARM7 types machines and is not observable on GHz machines.
84 static int unique_length_dirty = 1;
86 command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)
89 unique_length_dirty = 1;
91 if (!context || !name)
94 c = malloc(sizeof(command_t));
96 c->name = strdup(name);
102 c->help = strdup(help);
108 /* place command in tree */
111 if (parent->children)
113 /* find last child */
114 for (p = parent->children; p && p->next; p = p->next);
120 parent->children = c;
125 if (context->commands)
127 /* find last command */
128 for (p = context->commands; p && p->next; p = p->next);
134 context->commands = c;
141 int unregister_command(command_context_t *context, char *name)
143 unique_length_dirty = 1;
145 command_t *c, *p = NULL, *c2;
147 if ((!context) || (!name))
148 return ERROR_INVALID_ARGUMENTS;
151 for (c = context->commands; c; c = c->next)
153 if (strcmp(name, c->name) == 0)
162 context->commands = c->next;
165 /* unregister children */
168 for (c2 = c->children; c2; c2 = c2->next)
184 /* remember the last command for unlinking */
191 int parse_line(char *line, char *words[], int max_words)
195 char *word_start = line;
198 while (nwords < max_words - 1)
200 /* check if we reached
202 * a matching closing quote character " or '
203 * we're inside a word but not a quote, and the current character is whitespace
205 if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
207 /* we're inside a word or quote, and reached its end*/
213 /* This will handle extra whitespace within quotes */
214 while (isspace(*word_start)&&(word_start<word_end))
216 while (isspace(*(word_end-1))&&(word_start<word_end))
218 len = word_end - word_start;
223 memcpy(words[nwords] = malloc(len + 1), word_start, len);
224 /* add terminating NUL */
225 words[nwords++][len] = 0;
228 /* we're done parsing the line */
232 /* skip over trailing quote or whitespace*/
233 if (inquote || isspace(*p))
241 else if (*p == '"' || *p == '\'')
243 /* we've reached the beginning of a quote */
249 /* we've reached the beginning of a new word */
253 /* normal character, skip */
261 void command_print(command_context_t *context, char *format, ...)
267 /* process format string */
271 va_start(ap, format);
272 if (!buffer || (n = vsnprintf(buffer, size, format, ap)) >= size)
274 /* increase buffer until it fits the whole string */
275 if (!(p = realloc(buffer, size += 4096)))
293 /* vsnprintf failed */
303 /* process lines in buffer */
305 char *next = strchr(p, '\n');
310 if (context->output_handler)
311 context->output_handler(context, p);
320 int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word)
324 if (unique_length_dirty)
326 unique_length_dirty = 0;
327 /* update unique lengths */
328 build_unique_lengths(context, context->commands);
331 for (c = commands; c; c = c->next)
333 if (strncasecmp(c->name, words[start_word], c->unique_len))
336 if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
339 if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
345 command_print(context, "No handler for command");
350 int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
351 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
353 command_print(context, "Syntax error:");
354 command_print_help_line(context, c, 0);
361 if (start_word == num_words - 1)
363 command_print(context, "Incomplete command");
366 return find_and_run_command(context, c->children, words, num_words, start_word + 1);
371 command_print(context, "Command %s not found", words[start_word]);
375 static int command_run_line_inner(command_context_t *context, char *line)
378 char *words[128] = {0};
382 if ((!context) || (!line))
383 return ERROR_INVALID_ARGUMENTS;
385 /* skip preceding whitespace */
386 while (isspace(*line))
389 /* empty line, ignore */
393 /* ignore comments */
394 if (*line && (line[0] == '#'))
399 command_print(context, "%s", line);
402 nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
405 retval = find_and_run_command(context, context->commands, words, nwords, 0);
407 return ERROR_INVALID_ARGUMENTS;
409 for (i = 0; i < nwords; i++)
415 int command_run_line(command_context_t *context, char *line)
417 int retval=command_run_line_inner(context, line);
418 // we don't want any dangling callbacks!
420 // Capturing output from logging is *very* loosly modeled on C/C++ exceptions.
421 // the capture must be set up at function entry and
422 // stops when the function call returns
423 log_setCallback(NULL, NULL);
426 int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
428 int retval = ERROR_OK;
429 int old_command_mode;
430 char *buffer=malloc(4096);
433 return ERROR_INVALID_ARGUMENTS;
436 old_command_mode = context->mode;
437 context->mode = mode;
439 while (fgets(buffer, 4096, file))
444 /* stop processing line after a comment (#, !) or a LF, CR were encountered */
445 if ((p = strpbrk(buffer, "#!\r\n")))
448 /* skip over leading whitespace */
450 while (isspace(*cmd))
453 /* empty (all whitespace) line? */
457 /* search the end of the current line, ignore trailing whitespace */
458 for (p = end = cmd; *p; p++)
464 if (strcasecmp(cmd, "quit") == 0)
468 if ((retval = command_run_line_inner(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
472 context->mode = old_command_mode;
480 void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
483 char indents[32] = {0};
484 char *help = "no help available";
488 for (i = 0; i < indent; i+=2)
491 indents[i*2+1] = '-';
496 help = command->help;
498 snprintf(name_buf, 64, command->name);
499 strncat(name_buf, indents, 64);
500 command_print(context, "%20s\t%s", name_buf, help);
502 if (command->children)
504 for (c = command->children; c; c = c->next)
506 command_print_help_line(context, c, indent + 1);
511 int command_print_help(command_context_t* context, char* name, char** args, int argc)
515 for (c = context->commands; c; c = c->next)
519 if (strncasecmp(c->name, args[0], c->unique_len))
522 if (strncasecmp(c->name, args[0], strlen(args[0])))
526 command_print_help_line(context, c, 0);
532 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
534 context->output_handler = output_handler;
535 context->output_handler_priv = priv;
538 command_context_t* copy_command_context(command_context_t* context)
540 command_context_t* copy_context = malloc(sizeof(command_context_t));
542 *copy_context = *context;
547 int command_done(command_context_t *context)
555 command_context_t* command_init()
557 command_context_t* context = malloc(sizeof(command_context_t));
559 context->mode = COMMAND_EXEC;
560 context->commands = NULL;
561 context->current_target = 0;
563 context->output_handler = NULL;
564 context->output_handler_priv = NULL;
566 register_command(context, NULL, "help", command_print_help,
567 COMMAND_EXEC, "display this help");
569 register_command(context, NULL, "sleep", handle_sleep_command,
570 COMMAND_ANY, "sleep for <n> milliseconds");
575 /* sleep command sleeps for <n> miliseconds
576 * this is useful in target startup scripts
578 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
580 unsigned long duration = 0;
584 duration = strtoul(args[0], NULL, 0);
585 usleep(duration * 1000);