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 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)
83 if (!context || !name)
86 c = malloc(sizeof(command_t));
88 c->name = strdup(name);
94 c->help = strdup(help);
100 /* place command in tree */
103 if (parent->children)
105 /* find last child */
106 for (p = parent->children; p && p->next; p = p->next);
112 parent->children = c;
117 if (context->commands)
119 /* find last command */
120 for (p = context->commands; p && p->next; p = p->next);
126 context->commands = c;
130 /* update unique lengths */
131 build_unique_lengths(context, (parent) ? parent : context->commands);
136 int unregister_command(command_context_t *context, char *name)
138 command_t *c, *p = NULL, *c2;
140 if ((!context) || (!name))
141 return ERROR_INVALID_ARGUMENTS;
144 for (c = context->commands; c; c = c->next)
146 if (strcmp(name, c->name) == 0)
155 context->commands = c->next;
158 /* unregister children */
161 for (c2 = c->children; c2; c2 = c2->next)
177 /* remember the last command for unlinking */
184 int parse_line(char *line, char *words[], int max_words)
188 char *word_start = line;
191 while (nwords < max_words - 1)
193 /* check if we reached
195 * a matching closing quote character " or '
196 * we're inside a word but not a quote, and the current character is whitespace
198 if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
200 /* we're inside a word or quote, and reached its end*/
203 int len = p - word_start;
206 memcpy(words[nwords] = malloc(len + 1), word_start, len);
207 /* add terminating NUL */
208 words[nwords++][len] = 0;
211 /* we're done parsing the line */
215 /* skip over trailing quote or whitespace*/
216 if (inquote || isspace(*p))
222 else if (*p == '"' || *p == '\'')
224 /* we've reached the beginning of a quote */
230 /* we've reached the beginning of a new word */
234 /* normal character, skip */
242 void command_print(command_context_t *context, char *format, ...)
249 va_start(ap, format);
251 /* process format string */
252 /* TODO: possible bug. va_list is undefined after the first call to vsnprintf */
253 while (!buffer || (n = vsnprintf(buffer, size, format, ap)) >= size)
255 /* increase buffer until it fits the whole string */
256 if (!(p = realloc(buffer, size += 4096)))
262 /* vsnprintf failed */
268 /* process lines in buffer */
270 char *next = strchr(p, '\n');
275 if (context->output_handler)
276 context->output_handler(context, p);
287 int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word)
291 for (c = commands; c; c = c->next)
293 if (strncasecmp(c->name, words[start_word], c->unique_len))
296 if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
299 if ((c->mode == context->mode) || (c->mode == COMMAND_ANY))
305 command_print(context, "No handler for command");
310 return c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
315 if (start_word == num_words - 1)
317 command_print(context, "Incomplete command");
320 return find_and_run_command(context, c->children, words, num_words, start_word + 1);
325 command_print(context, "Command %s not found", words[start_word]);
329 int command_run_line(command_context_t *context, char *line)
332 char *words[128] = {0};
336 if ((!context) || (!line))
337 return ERROR_INVALID_ARGUMENTS;
339 /* skip preceding whitespace */
340 while (isspace(*line))
343 /* empty line, ignore */
349 command_print(context, "%s", line);
352 nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
355 retval = find_and_run_command(context, context->commands, words, nwords, 0);
357 return ERROR_INVALID_ARGUMENTS;
359 for (i = 0; i < nwords; i++)
365 int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
368 int old_command_mode;
371 old_command_mode = context->mode;
372 context->mode = mode;
374 while (fgets(buffer, 4096, file))
379 /* stop processing line after a comment (#, !) or a LF, CR were encountered */
380 if ((p = strpbrk(buffer, "#!\r\n")))
383 /* skip over leading whitespace */
385 while (isspace(*cmd))
388 /* empty (all whitespace) line? */
392 /* search the end of the current line, ignore trailing whitespace */
393 for (p = end = cmd; *p; p++)
399 if (strcasecmp(cmd, "quit") == 0)
403 if (command_run_line(context, cmd) == ERROR_COMMAND_CLOSE_CONNECTION)
407 context->mode = old_command_mode;
412 void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
415 char indents[32] = {0};
416 char *help = "no help available";
420 for (i = 0; i < indent; i+=2)
423 indents[i*2+1] = '-';
427 if ((command->mode == COMMAND_EXEC) || (command->mode == COMMAND_ANY))
430 help = command->help;
432 snprintf(name_buf, 64, command->name);
433 strncat(name_buf, indents, 64);
434 command_print(context, "%20s\t%s", name_buf, help);
437 if (command->children)
439 for (c = command->children; c; c = c->next)
441 command_print_help_line(context, c, indent + 1);
446 int command_print_help(command_context_t* context, char* name, char** args, int argc)
450 for (c = context->commands; c; c = c->next)
454 if (strncasecmp(c->name, args[0], c->unique_len))
457 if (strncasecmp(c->name, args[0], strlen(args[0])))
461 command_print_help_line(context, c, 0);
467 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
469 context->output_handler = output_handler;
470 context->output_handler_priv = priv;
473 command_context_t* copy_command_context(command_context_t* context)
475 command_context_t* copy_context = malloc(sizeof(command_context_t));
477 *copy_context = *context;
482 int command_done(command_context_t *context)
489 command_context_t* command_init()
491 command_context_t* context = malloc(sizeof(command_context_t));
493 context->mode = COMMAND_EXEC;
494 context->commands = NULL;
495 context->current_target = 0;
497 context->output_handler = NULL;
498 context->output_handler_priv = NULL;
500 register_command(context, NULL, "help", command_print_help,
501 COMMAND_EXEC, "display this help");
503 register_command(context, NULL, "sleep", handle_sleep_command,
504 COMMAND_ANY, "sleep for <n> milliseconds");
509 /* sleep command sleeps for <n> miliseconds
510 * this is useful in target startup scripts
512 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
514 unsigned long duration = 0;
518 duration = strtoul(args[0], NULL, 0);
519 usleep(duration * 1000);