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"
32 #include "time_support.h"
41 void command_print_help_line(command_context_t* context, struct command_s *command, int indent);
43 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
44 int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
46 int build_unique_lengths(command_context_t *context, command_t *commands)
50 /* iterate through all commands */
51 for (c = commands; c; c = c->next)
53 /* find out how many characters are required to uniquely identify a command */
54 for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
58 /* for every command, see if the current length is enough */
59 for (p = commands; p; p = p->next)
61 /* ignore the command itself */
65 /* compare commands up to the current length */
66 if (strncmp(p->name, c->name, c->unique_len) == 0)
70 /* when none of the commands matched, we've found the minimum length required */
75 /* if the current command has children, build the unique lengths for them */
77 build_unique_lengths(context, c->children);
83 /* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n).
84 * Makes a difference on ARM7 types machines and is not observable on GHz machines.
86 static int unique_length_dirty = 1;
88 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)
91 unique_length_dirty = 1;
93 if (!context || !name)
96 c = malloc(sizeof(command_t));
98 c->name = strdup(name);
101 c->handler = handler;
104 c->help = strdup(help);
110 /* place command in tree */
113 if (parent->children)
115 /* find last child */
116 for (p = parent->children; p && p->next; p = p->next);
122 parent->children = c;
127 if (context->commands)
129 /* find last command */
130 for (p = context->commands; p && p->next; p = p->next);
136 context->commands = c;
143 int unregister_command(command_context_t *context, char *name)
145 unique_length_dirty = 1;
147 command_t *c, *p = NULL, *c2;
149 if ((!context) || (!name))
150 return ERROR_INVALID_ARGUMENTS;
153 for (c = context->commands; c; c = c->next)
155 if (strcmp(name, c->name) == 0)
164 context->commands = c->next;
167 /* unregister children */
170 for (c2 = c->children; c2; c2 = c2->next)
186 /* remember the last command for unlinking */
193 int parse_line(char *line, char *words[], int max_words)
197 char *word_start = line;
200 while (nwords < max_words - 1)
202 /* check if we reached
204 * a matching closing quote character " or '
205 * we're inside a word but not a quote, and the current character is whitespace
207 if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
209 /* we're inside a word or quote, and reached its end*/
215 /* This will handle extra whitespace within quotes */
216 while (isspace(*word_start)&&(word_start<word_end))
218 while (isspace(*(word_end-1))&&(word_start<word_end))
220 len = word_end - word_start;
225 memcpy(words[nwords] = malloc(len + 1), word_start, len);
226 /* add terminating NUL */
227 words[nwords++][len] = 0;
230 /* we're done parsing the line */
234 /* skip over trailing quote or whitespace*/
235 if (inquote || isspace(*p))
243 else if (*p == '"' || *p == '\'')
245 /* we've reached the beginning of a quote */
251 /* we've reached the beginning of a new word */
255 /* normal character, skip */
263 void command_print(command_context_t *context, char *format, ...)
269 /* process format string */
273 va_start(ap, format);
274 if (!buffer || (n = vsnprintf(buffer, size, format, ap)) >= size)
276 /* increase buffer until it fits the whole string */
277 if (!(p = realloc(buffer, size += 4096)))
295 /* vsnprintf failed */
305 /* process lines in buffer */
307 char *next = strchr(p, '\n');
312 if (context->output_handler)
313 context->output_handler(context, p);
322 int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word)
326 if (unique_length_dirty)
328 unique_length_dirty = 0;
329 /* update unique lengths */
330 build_unique_lengths(context, context->commands);
333 for (c = commands; c; c = c->next)
335 if (strncasecmp(c->name, words[start_word], c->unique_len))
338 if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
341 if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
347 command_print(context, "No handler for command");
352 int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
353 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
355 command_print(context, "Syntax error:");
356 command_print_help_line(context, c, 0);
363 if (start_word == num_words - 1)
365 command_print(context, "Incomplete command");
368 return find_and_run_command(context, c->children, words, num_words, start_word + 1);
373 command_print(context, "Command %s not found", words[start_word]);
377 static int command_run_line_inner(command_context_t *context, char *line)
380 char *words[128] = {0};
384 if ((!context) || (!line))
385 return ERROR_INVALID_ARGUMENTS;
387 /* skip preceding whitespace */
388 while (isspace(*line))
391 /* empty line, ignore */
395 /* ignore comments */
396 if (*line && (line[0] == '#'))
401 command_print(context, "%s", line);
404 nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
407 retval = find_and_run_command(context, context->commands, words, nwords, 0);
409 return ERROR_INVALID_ARGUMENTS;
411 for (i = 0; i < nwords; i++)
417 int command_run_line(command_context_t *context, char *line)
419 int retval=command_run_line_inner(context, line);
420 // we don't want any dangling callbacks!
422 // Capturing output from logging is *very* loosly modeled on C/C++ exceptions.
423 // the capture must be set up at function entry and
424 // stops when the function call returns
425 log_setCallback(NULL, NULL);
428 int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
430 int retval = ERROR_OK;
431 int old_command_mode;
432 char *buffer=malloc(4096);
435 return ERROR_INVALID_ARGUMENTS;
438 old_command_mode = context->mode;
439 context->mode = mode;
441 while (fgets(buffer, 4096, file))
446 /* stop processing line after a comment (#, !) or a LF, CR were encountered */
447 if ((p = strpbrk(buffer, "#!\r\n")))
450 /* skip over leading whitespace */
452 while (isspace(*cmd))
455 /* empty (all whitespace) line? */
459 /* search the end of the current line, ignore trailing whitespace */
460 for (p = end = cmd; *p; p++)
466 if (strcasecmp(cmd, "quit") == 0)
470 if ((retval = command_run_line_inner(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
474 context->mode = old_command_mode;
482 void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
485 char indents[32] = {0};
486 char *help = "no help available";
490 for (i = 0; i < indent; i+=2)
493 indents[i*2+1] = '-';
498 help = command->help;
500 snprintf(name_buf, 64, command->name);
501 strncat(name_buf, indents, 64);
502 command_print(context, "%20s\t%s", name_buf, help);
504 if (command->children)
506 for (c = command->children; c; c = c->next)
508 command_print_help_line(context, c, indent + 1);
513 int command_print_help(command_context_t* context, char* name, char** args, int argc)
517 for (c = context->commands; c; c = c->next)
521 if (strncasecmp(c->name, args[0], c->unique_len))
524 if (strncasecmp(c->name, args[0], strlen(args[0])))
528 command_print_help_line(context, c, 0);
534 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
536 context->output_handler = output_handler;
537 context->output_handler_priv = priv;
540 command_context_t* copy_command_context(command_context_t* context)
542 command_context_t* copy_context = malloc(sizeof(command_context_t));
544 *copy_context = *context;
549 int command_done(command_context_t *context)
557 command_context_t* command_init()
559 command_context_t* context = malloc(sizeof(command_context_t));
561 context->mode = COMMAND_EXEC;
562 context->commands = NULL;
563 context->current_target = 0;
565 context->output_handler = NULL;
566 context->output_handler_priv = NULL;
568 register_command(context, NULL, "help", command_print_help,
569 COMMAND_EXEC, "display this help");
571 register_command(context, NULL, "sleep", handle_sleep_command,
572 COMMAND_ANY, "sleep for <n> milliseconds");
574 register_command(context, NULL, "time", handle_time_command,
575 COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");
580 /* sleep command sleeps for <n> miliseconds
581 * this is useful in target startup scripts
583 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
585 unsigned long duration = 0;
589 duration = strtoul(args[0], NULL, 0);
590 usleep(duration * 1000);
596 int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
599 return ERROR_COMMAND_SYNTAX_ERROR;
605 duration_start_measure(&duration);
607 retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc, 0);
609 duration_stop_measure(&duration, &duration_text);
611 float t=duration.duration.tv_sec;
612 t+=((float)duration.duration.tv_usec / 1000000.0);
613 command_print(cmd_ctx, "%s took %fs", args[0], t);