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 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
42 int build_unique_lengths(command_context_t *context, command_t *commands)
46 /* iterate through all commands */
47 for (c = commands; c; c = c->next)
49 /* find out how many characters are required to uniquely identify a command */
50 for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
54 /* for every command, see if the current length is enough */
55 for (p = commands; p; p = p->next)
57 /* ignore the command itself */
61 /* compare commands up to the current length */
62 if (strncmp(p->name, c->name, c->unique_len) == 0)
66 /* when none of the commands matched, we've found the minimum length required */
71 /* if the current command has children, build the unique lengths for them */
73 build_unique_lengths(context, c->children);
79 /* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n).
80 * Makes a difference on ARM7 types machines and is not observable on GHz machines.
82 static int unique_length_dirty = 1;
84 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)
87 unique_length_dirty = 1;
89 if (!context || !name)
92 c = malloc(sizeof(command_t));
94 c->name = strdup(name);
100 c->help = strdup(help);
106 /* place command in tree */
109 if (parent->children)
111 /* find last child */
112 for (p = parent->children; p && p->next; p = p->next);
118 parent->children = c;
123 if (context->commands)
125 /* find last command */
126 for (p = context->commands; p && p->next; p = p->next);
132 context->commands = c;
139 int unregister_command(command_context_t *context, char *name)
141 unique_length_dirty = 1;
143 command_t *c, *p = NULL, *c2;
145 if ((!context) || (!name))
146 return ERROR_INVALID_ARGUMENTS;
149 for (c = context->commands; c; c = c->next)
151 if (strcmp(name, c->name) == 0)
160 context->commands = c->next;
163 /* unregister children */
166 for (c2 = c->children; c2; c2 = c2->next)
182 /* remember the last command for unlinking */
189 int parse_line(char *line, char *words[], int max_words)
193 char *word_start = line;
196 while (nwords < max_words - 1)
198 /* check if we reached
200 * a matching closing quote character " or '
201 * we're inside a word but not a quote, and the current character is whitespace
203 if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
205 /* we're inside a word or quote, and reached its end*/
211 /* This will handle extra whitespace within quotes */
212 while (isspace(*word_start)&&(word_start<word_end))
214 while (isspace(*(word_end-1))&&(word_start<word_end))
216 len = word_end - word_start;
221 memcpy(words[nwords] = malloc(len + 1), word_start, len);
222 /* add terminating NUL */
223 words[nwords++][len] = 0;
226 /* we're done parsing the line */
230 /* skip over trailing quote or whitespace*/
231 if (inquote || isspace(*p))
239 else if (*p == '"' || *p == '\'')
241 /* we've reached the beginning of a quote */
247 /* we've reached the beginning of a new word */
251 /* normal character, skip */
259 void command_print(command_context_t *context, char *format, ...)
266 va_start(ap, format);
268 /* process format string */
269 /* TODO: possible bug. va_list is undefined after the first call to vsnprintf */
270 while (!buffer || (n = vsnprintf(buffer, size, format, ap)) >= size)
272 /* increase buffer until it fits the whole string */
273 if (!(p = realloc(buffer, size += 4096)))
284 /* vsnprintf failed */
294 /* process lines in buffer */
296 char *next = strchr(p, '\n');
301 if (context->output_handler)
302 context->output_handler(context, p);
313 int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word)
317 if (unique_length_dirty)
319 unique_length_dirty = 0;
320 /* update unique lengths */
321 build_unique_lengths(context, context->commands);
324 for (c = commands; c; c = c->next)
326 if (strncasecmp(c->name, words[start_word], c->unique_len))
329 if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
332 if ((c->mode == context->mode) || (c->mode == COMMAND_ANY))
338 command_print(context, "No handler for command");
343 return c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
348 if (start_word == num_words - 1)
350 command_print(context, "Incomplete command");
353 return find_and_run_command(context, c->children, words, num_words, start_word + 1);
358 command_print(context, "Command %s not found", words[start_word]);
362 static int command_run_line_inner(command_context_t *context, char *line)
365 char *words[128] = {0};
369 if ((!context) || (!line))
370 return ERROR_INVALID_ARGUMENTS;
372 /* skip preceding whitespace */
373 while (isspace(*line))
376 /* empty line, ignore */
380 /* ignore comments */
381 if (*line && (line[0] == '#'))
386 command_print(context, "%s", line);
389 nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
392 retval = find_and_run_command(context, context->commands, words, nwords, 0);
394 return ERROR_INVALID_ARGUMENTS;
396 for (i = 0; i < nwords; i++)
402 int command_run_line(command_context_t *context, char *line)
404 int retval=command_run_line_inner(context, line);
405 // we don't want any dangling callbacks!
407 // Capturing output from logging is *very* loosly modeled on C/C++ exceptions.
408 // the capture must be set up at function entry and
409 // stops when the function call returns
410 log_setCallback(NULL, NULL);
413 int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
415 int retval = ERROR_OK;
416 int old_command_mode;
417 char *buffer=malloc(4096);
420 return ERROR_INVALID_ARGUMENTS;
423 old_command_mode = context->mode;
424 context->mode = mode;
426 while (fgets(buffer, 4096, file))
431 /* stop processing line after a comment (#, !) or a LF, CR were encountered */
432 if ((p = strpbrk(buffer, "#!\r\n")))
435 /* skip over leading whitespace */
437 while (isspace(*cmd))
440 /* empty (all whitespace) line? */
444 /* search the end of the current line, ignore trailing whitespace */
445 for (p = end = cmd; *p; p++)
451 if (strcasecmp(cmd, "quit") == 0)
455 if ((retval = command_run_line_inner(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
459 context->mode = old_command_mode;
467 void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
470 char indents[32] = {0};
471 char *help = "no help available";
475 for (i = 0; i < indent; i+=2)
478 indents[i*2+1] = '-';
482 if ((command->mode == COMMAND_EXEC) || (command->mode == COMMAND_ANY))
485 help = command->help;
487 snprintf(name_buf, 64, command->name);
488 strncat(name_buf, indents, 64);
489 command_print(context, "%20s\t%s", name_buf, help);
492 if (command->children)
494 for (c = command->children; c; c = c->next)
496 command_print_help_line(context, c, indent + 1);
501 int command_print_help(command_context_t* context, char* name, char** args, int argc)
505 for (c = context->commands; c; c = c->next)
509 if (strncasecmp(c->name, args[0], c->unique_len))
512 if (strncasecmp(c->name, args[0], strlen(args[0])))
516 command_print_help_line(context, c, 0);
522 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
524 context->output_handler = output_handler;
525 context->output_handler_priv = priv;
528 command_context_t* copy_command_context(command_context_t* context)
530 command_context_t* copy_context = malloc(sizeof(command_context_t));
532 *copy_context = *context;
537 int command_done(command_context_t *context)
545 command_context_t* command_init()
547 command_context_t* context = malloc(sizeof(command_context_t));
549 context->mode = COMMAND_EXEC;
550 context->commands = NULL;
551 context->current_target = 0;
553 context->output_handler = NULL;
554 context->output_handler_priv = NULL;
556 register_command(context, NULL, "help", command_print_help,
557 COMMAND_EXEC, "display this help");
559 register_command(context, NULL, "sleep", handle_sleep_command,
560 COMMAND_ANY, "sleep for <n> milliseconds");
565 /* sleep command sleeps for <n> miliseconds
566 * this is useful in target startup scripts
568 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
570 unsigned long duration = 0;
574 duration = strtoul(args[0], NULL, 0);
575 usleep(duration * 1000);