command.c 16.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   part of this file is taken from libcli (libcli.sourceforge.net)       *
 *   Copyright (C) David Parrish (david@dparrish.com)                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "replacements.h"

#include "command.h"

#include "log.h"
#include "time_support.h"

#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <stdarg.h>
#include <stdio.h>
#include <unistd.h>

oharboe's avatar
oharboe committed
41
42
int fast_and_dangerous = 0;

43
44
45
46
void command_print_help_line(command_context_t* context, struct command_s *command, int indent);

int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
oharboe's avatar
oharboe committed
47
int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
48

ntfreak's avatar
ntfreak committed
49
50
51
/* forward declaration of jim_command */
extern int jim_command(command_context_t *context, char *line);

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
int build_unique_lengths(command_context_t *context, command_t *commands)
{
	command_t *c, *p;

	/* iterate through all commands */
	for (c = commands; c; c = c->next)
	{
		/* find out how many characters are required to uniquely identify a command */
		for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
		{
			int foundmatch = 0;
			
			/* for every command, see if the current length is enough */
			for (p = commands; p; p = p->next)
			{
				/* ignore the command itself */
				if (c == p)
					continue;
				
				/* compare commands up to the current length */
				if (strncmp(p->name, c->name, c->unique_len) == 0)
					foundmatch++;
			}
			
			/* when none of the commands matched, we've found the minimum length required */
			if (!foundmatch)
				break;
		}
		
		/* if the current command has children, build the unique lengths for them */
		if (c->children)
			build_unique_lengths(context, c->children);
	}
	
	return ERROR_OK;
}

/* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n). 
 * Makes a difference on ARM7 types machines and is not observable on GHz machines.
 */
static int unique_length_dirty = 1; 

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)
{
	command_t *c, *p;
	unique_length_dirty = 1;
	
	if (!context || !name)
		return NULL;
				
	c = malloc(sizeof(command_t));
	
	c->name = strdup(name);
	c->parent = parent;
	c->children = NULL;
	c->handler = handler;
	c->mode = mode;
	if (help)
		c->help = strdup(help);
	else
		c->help = NULL;
	c->unique_len = 0;
	c->next = NULL;
	
	/* place command in tree */
	if (parent)
	{
		if (parent->children)
		{
			/* find last child */
			for (p = parent->children; p && p->next; p = p->next);
			if (p)
				p->next = c;
		}
		else
		{
			parent->children = c;
		}
	}
	else
	{
		if (context->commands)
		{
			/* find last command */
			for (p = context->commands; p && p->next; p = p->next);
			if (p)
				p->next = c;
		}
		else
		{
			context->commands = c;
		}
	}
	
	return c;
}

149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
int unregister_all_commands(command_context_t *context)
{
	command_t *c, *c2;
	
	unique_length_dirty = 1;
	
	if (context == NULL)
		return ERROR_OK;
	
	
	while(NULL != context->commands)
	{
		c = context->commands;
		
		while(NULL != c->children)
		{
			c2 = c->children;
			c->children = c->children->next;
			free(c2->name);
			c2->name = NULL;
			free(c2->help);
			c2->help = NULL;
			free(c2);
			c2 = NULL;
		}
		
		context->commands = context->commands->next;
		
		free(c->name);
		c->name = NULL;
		free(c->help);
		c->help = NULL;
		free(c);
		c = NULL;		
	}
	
	return ERROR_OK;
}

188
189
190
191
int unregister_command(command_context_t *context, char *name)
{
	command_t *c, *p = NULL, *c2;
	
oharboe's avatar
oharboe committed
192
193
	unique_length_dirty = 1;
	
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
	if ((!context) || (!name))
		return ERROR_INVALID_ARGUMENTS;
	
	/* find command */
	for (c = context->commands; c; c = c->next)
	{
		if (strcmp(name, c->name) == 0)
		{
			/* unlink command */
			if (p)
			{
				p->next = c->next;
			}
			else
			{
				context->commands = c->next;
			}
			
			/* unregister children */
			if (c->children)
			{
				for (c2 = c->children; c2; c2 = c2->next)
				{
					free(c2->name);
					if (c2->help)
						free(c2->help);
					free(c2);
				}
			}
			
			/* delete command */
			free(c->name);
			if (c->help)
				free(c->help);
			free(c);
		}
		
		/* remember the last command for unlinking */
		p = c;
	}
	
	return ERROR_OK;
}

int parse_line(char *line, char *words[], int max_words)
{
	int nwords = 0;
	char *p = line;
	char *word_start = line;
	int inquote = 0;

	while (nwords < max_words - 1)
	{
		/* check if we reached
		 * a terminating NUL
		 * a matching closing quote character " or '
		 * we're inside a word but not a quote, and the current character is whitespace
		 */
		if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
		{
			/* we're inside a word or quote, and reached its end*/
			if (word_start)
			{
				int len;
				char *word_end=p;
				
				/* This will handle extra whitespace within quotes */
				while (isspace(*word_start)&&(word_start<word_end))
					word_start++;
				while (isspace(*(word_end-1))&&(word_start<word_end))
					word_end--;
				len = word_end - word_start;
				
				if (len>0)
				{
					/* copy the word */
					memcpy(words[nwords] = malloc(len + 1), word_start, len);
					/* add terminating NUL */
					words[nwords++][len] = 0;
				}
			}
			/* we're done parsing the line */
			if (!*p)
				break;

			/* skip over trailing quote or whitespace*/
			if (inquote || isspace(*p))
				p++;
			while (isspace(*p))
				p++;
			
			inquote = 0;
			word_start = 0;
		}
		else if (*p == '"' || *p == '\'')
		{
			/* we've reached the beginning of a quote */
			inquote = *p++;
			word_start = p;
		}
		else
		{
			/* we've reached the beginning of a new word */
			if (!word_start)
				word_start = p;
			
			/* normal character, skip */
			p++;
		}
	}
	
	return nwords;
}

308
void command_print_n(command_context_t *context, char *format, ...)
309
{
310
	char *string;
311
	
312
313
314
	va_list ap;
	va_start(ap, format);

oharboe's avatar
oharboe committed
315
	string = alloc_vprintf(format, ap);
316
	if (string != NULL)
317
	{
318
319
		context->output_handler(context, string);
		free(string);
320
321
	}

322
323
	va_end(ap);
}
324

325
326
void command_print(command_context_t *context, char *format, ...)
{
327
328
	char *string;

329
330
	va_list ap;
	va_start(ap, format);
331

oharboe's avatar
oharboe committed
332
	string = alloc_vprintf(format, ap);
333
334
	if (string != NULL)
	{
oharboe's avatar
oharboe committed
335
		strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
336
337
338
339
		context->output_handler(context, string);
		free(string);
	}

340
	va_end(ap);
341
342
}

343
command_t *find_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word, int *new_start_word)
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
{
	command_t *c;
	
	if (unique_length_dirty)
	{
		unique_length_dirty = 0;
		/* update unique lengths */
		build_unique_lengths(context, context->commands);
	}
	
	for (c = commands; c; c = c->next)
	{
		if (strncasecmp(c->name, words[start_word], c->unique_len))
			continue;

		if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
			continue;
		
		if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
		{
			if (!c->children)
			{
				if (!c->handler)
				{
368
					return NULL;
369
370
371
				}
				else
				{
372
373
					*new_start_word=start_word;
					return c;
374
375
376
377
378
379
				}
			}
			else
			{
				if (start_word == num_words - 1)
				{
380
					return NULL;
381
				}
382
				return find_command(context, c->children, words, num_words, start_word + 1, new_start_word);
383
384
385
			}
		}
	}
386
387
388
389
390
391
392
393
394
395
396
397
398
	return NULL;
}

int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words)
{
	int start_word=0;
	command_t *c;
	c=find_command(context, commands, words, num_words, start_word, &start_word);
	if (c==NULL)
	{
		command_print(context, "Command %s not found", words[start_word]);
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
399
	
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
	int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
	if (retval == ERROR_COMMAND_SYNTAX_ERROR)
	{
		command_print(context, "Syntax error:");
		command_print_help_line(context, c, 0);
	}
	else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
	{
		/* just fall through for a shutdown request */
	}
	else if (retval != ERROR_OK)
	{
		/* we do not print out an error message because the command *should*
		 * have printed out an error
		 */
		LOG_DEBUG("Command failed with error code %d", retval); 
	}
	return retval; 
418
419
}

420
int command_run_line_internal_op(command_context_t *context, char *line, int run)
421
{
422
423
	LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ 
	
424
425
426
427
	int nwords;
	char *words[128] = {0};
	int retval;
	int i;
428

429
430
431
432
433
434
435
436
437
438
439
440
	/* skip preceding whitespace */
	while (isspace(*line))
		line++;
	
	/* empty line, ignore */
	if (!*line)
		return ERROR_OK;
	
	/* ignore comments */
	if (*line && (line[0] == '#'))
		return ERROR_OK;
	
441
	LOG_DEBUG("%s", line);
442
443
444
445

	nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
	
	if (nwords > 0)
446
447
448
449
450
451
452
453
		if (run)
		{
			retval = find_and_run_command(context, context->commands, words, nwords);
		} else
		{
			int t;
			return (find_command(context, context->commands, words, nwords, 0, &t)!=NULL)?ERROR_OK:ERROR_FAIL;
		}
454
455
456
457
458
459
460
461
462
	else
		return ERROR_INVALID_ARGUMENTS;
	
	for (i = 0; i < nwords; i++)
		free(words[i]);
	
	return retval;
}

463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
int command_run_line_internal(command_context_t *context, char *line)
{
	return command_run_line_internal_op(context, line, 1);
}

int command_run_line(command_context_t *context, char *line)
{
	if ((!context) || (!line))
		return ERROR_INVALID_ARGUMENTS;

	if (command_run_line_internal_op(context, line, 0)!=ERROR_OK)
	{
		/* If we can't find a command, then try the interpreter. 
		 * If there is no interpreter implemented, then this will
		 * simply print a syntax error.
		 * 
		 * These hooks were left in to reduce patch size for 
		 * wip to add scripting language.
		 */
		return jim_command(context, line);
	}

	return command_run_line_internal(context, line);
}

488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
{
	int retval = ERROR_OK;
	int old_command_mode;
	char *buffer=malloc(4096);
	if (buffer==NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
	
	old_command_mode = context->mode;
	context->mode = mode;
	
	while (fgets(buffer, 4096, file))
	{
		char *p;
		char *cmd, *end;
		
		/* stop processing line after a comment (#, !) or a LF, CR were encountered */
		if ((p = strpbrk(buffer, "#!\r\n")))
			*p = 0;

		/* skip over leading whitespace */
		cmd = buffer;
		while (isspace(*cmd))
			cmd++;

		/* empty (all whitespace) line? */
		if (!*cmd)
			continue;
		
		/* search the end of the current line, ignore trailing whitespace */
		for (p = end = cmd; *p; p++)
			if (!isspace(*p))
				end = p;
		
		/* terminate end */
		*++end = 0;
		if (strcasecmp(cmd, "quit") == 0)
			break;

		/* run line */
		if ((retval = command_run_line(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
			break;
	}
	
	context->mode = old_command_mode;

	
	free(buffer);
	
	return retval;
}

oharboe's avatar
oharboe committed
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
int command_run_linef(command_context_t *context, char *format, ...)
{
	int retval=ERROR_FAIL;
	char *string;
	va_list ap;
	va_start(ap, format);
	string = alloc_vprintf(format, ap);
	if (string!=NULL)
	{
		retval=command_run_line(context, string);
	}
	va_end(ap);
	return retval;
}

557
558
559
void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
{
	command_t *c;
560
561
	char *indent_text=malloc(indent + 2);
	
562
563
564
	char *help = "no help available";
	char name_buf[64];
	
oharboe's avatar
oharboe committed
565
	if (indent)
566
	{
oharboe's avatar
oharboe committed
567
568
569
	    indent_text[0] = ' ';
	    memset(indent_text + 1, '-', indent);
	    indent_text[indent + 1] = 0;
570
571
572
573
574
575
	}
	
	if (command->help)
		help = command->help;
		
	snprintf(name_buf, 64, command->name);
oharboe's avatar
oharboe committed
576
577
578
579
580

	if (indent)
	    strncat(name_buf, indent_text, 64);

	command_print(context, "%20s\t%s", name_buf, help, indent);
581
582
583
584
585
586
587
588
	
	if (command->children)
	{
		for (c = command->children; c; c = c->next)
		{
			command_print_help_line(context, c, indent + 1);
		}
	}
589
	free(indent_text);
590
591
}

oharboe's avatar
oharboe committed
592
int command_print_help_match(command_context_t* context, command_t* c_first, char* name, char** args, int argc)
593
{
oharboe's avatar
oharboe committed
594
	command_t * c;
595

oharboe's avatar
oharboe committed
596
	for (c = c_first; c; c = c->next)
597
	{
oharboe's avatar
oharboe committed
598
		if (argc > 0)
599
		{
oharboe's avatar
oharboe committed
600
601
			if (strncasecmp(c->name, args[0], c->unique_len))
				continue;
602

oharboe's avatar
oharboe committed
603
604
605
606
607
608
609
610
611
			if (strncasecmp(c->name, args[0], strlen(args[0])))
				continue;

			if (argc > 1)
			{
				command_print_help_match(context, c->children, name, args + 1, argc - 1);
				continue;
			}
		}
612
613
614
615
616
617
618

		command_print_help_line(context, c, 0);
	}
	
	return ERROR_OK;
}

oharboe's avatar
oharboe committed
619
620
621
622
623
int command_print_help(command_context_t* context, char* name, char** args, int argc)
{
    return command_print_help_match(context, context->commands, name, args, argc);
}

oharboe's avatar
oharboe committed
624
void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
{
	context->output_handler = output_handler;
	context->output_handler_priv = priv;
}

command_context_t* copy_command_context(command_context_t* context)
{
	command_context_t* copy_context = malloc(sizeof(command_context_t));

	*copy_context = *context;
	
	return copy_context;
}

int command_done(command_context_t *context)
{
	free(context);
	context = NULL;
	
	return ERROR_OK;
}

command_context_t* command_init()
{
	command_context_t* context = malloc(sizeof(command_context_t));
	
	context->mode = COMMAND_EXEC;
	context->commands = NULL;
	context->current_target = 0;
	context->output_handler = NULL;
	context->output_handler_priv = NULL;
	
	register_command(context, NULL, "help", command_print_help,
					 COMMAND_EXEC, "display this help");
	
	register_command(context, NULL, "sleep", handle_sleep_command,
					 COMMAND_ANY, "sleep for <n> milliseconds");
	
	register_command(context, NULL, "time", handle_time_command,
					 COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");
	
oharboe's avatar
oharboe committed
666
667
668
	register_command(context, NULL, "fast", handle_fast_command,
					 COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
	
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
	return context;
}

/* sleep command sleeps for <n> miliseconds
 * this is useful in target startup scripts
 */
int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	unsigned long duration = 0;
	
	if (argc == 1)
	{
		duration = strtoul(args[0], NULL, 0);
		usleep(duration * 1000);
	}

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
688
689
690
691
692
693
694
695
696
697
698
int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	if (argc!=1)
		return ERROR_COMMAND_SYNTAX_ERROR;
	
	fast_and_dangerous = strcmp("enable", args[0])==0;
	
	return ERROR_OK;
}


699
700
701
702
703
int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	duration_t duration;
	char *duration_text;
	int retval;
oharboe's avatar
oharboe committed
704
705
706
707
	float t;
	
	if (argc<1)
		return ERROR_COMMAND_SYNTAX_ERROR;
708
709
710
	
	duration_start_measure(&duration);
	
711
	retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc);
712
713
714
	
	duration_stop_measure(&duration, &duration_text);
	
oharboe's avatar
oharboe committed
715
	t=duration.duration.tv_sec;
716
717
718
719
720
721
722
	t+=((float)duration.duration.tv_usec / 1000000.0);
	command_print(cmd_ctx, "%s took %fs", args[0], t);
	
	free(duration_text);

	return retval;
}
oharboe's avatar
oharboe committed
723
724
725
726
727
728
729
/*
 * Local Variables: **
 * tab-width: 4 **
 * c-basic-offset: 4 **
 * End: **
 */