source: cmd.c @ 3c0ec97

release-1.5
Last change on this file since 3c0ec97 was 3c0ec97, checked in by Nelson Elhage <nelhage@mit.edu>, 11 years ago
owl_cmddict_execute: Don’t leak buffers when given no arguments. Signed-off-by: Anders Kaseorg <andersk@mit.edu> Reviewed-by: Alejandro R. Sedeño <asedeno@mit.edu>
  • Property mode set to 100644
File size: 8.8 KB
Line 
1#include <stdio.h>
2#include <stdlib.h>
3#include <string.h>
4#include <unistd.h>
5#include "owl.h"
6
7extern const owl_cmd commands_to_init[];
8
9/**************************************************************************/
10/***************************** COMMAND DICT *******************************/
11/**************************************************************************/
12
13int owl_cmddict_setup(owl_cmddict *cd) {
14  if (0 != owl_cmddict_init(cd)) return(-1);
15  if (0 != owl_cmddict_add_from_list(cd, commands_to_init)) return(-1);
16  return(0);
17}
18
19int owl_cmddict_init(owl_cmddict *cd) {
20  if (owl_dict_create(cd)) return(-1);
21  return(0);
22}
23
24/* for bulk initialization at startup */
25int owl_cmddict_add_from_list(owl_cmddict *cd, const owl_cmd *cmds) {
26  const owl_cmd *cur;
27  int ret = 0;
28  for (cur = cmds; cur->name != NULL; cur++) {
29    ret = owl_cmddict_add_cmd(cd, cur);
30    if (ret < 0) break;
31  }
32  return ret;
33}
34
35/* free the list with owl_cmddict_namelist_free */
36void owl_cmddict_get_names(const owl_cmddict *d, owl_list *l) {
37  owl_dict_get_keys(d, l);
38}
39
40const owl_cmd *owl_cmddict_find(const owl_cmddict *d, const char *name) {
41  return owl_dict_find_element(d, name);
42}
43
44void owl_cmddict_namelist_free(owl_list *l) {
45  owl_list_free_all(l, owl_free);
46}
47
48/* creates a new command alias */
49int owl_cmddict_add_alias(owl_cmddict *cd, const char *alias_from, const char *alias_to) {
50  owl_cmd *cmd;
51  cmd = owl_malloc(sizeof(owl_cmd));
52  owl_cmd_create_alias(cmd, alias_from, alias_to);
53  owl_dict_insert_element(cd, cmd->name, cmd, (void(*)(void*))owl_cmd_free);   
54  return(0);
55}
56
57int owl_cmddict_add_cmd(owl_cmddict *cd, const owl_cmd * cmd) {
58  owl_cmd * newcmd = owl_malloc(sizeof(owl_cmd));
59  if(owl_cmd_create_from_template(newcmd, cmd) < 0) {
60    owl_free(newcmd);
61    return -1;
62  }
63  owl_perlconfig_new_command(cmd->name);
64  return owl_dict_insert_element(cd, newcmd->name, newcmd, (void(*)(void*))owl_cmd_free);
65}
66
67char *_owl_cmddict_execute(const owl_cmddict *cd, const owl_context *ctx, const char *const *argv, int argc, const char *buff) {
68  char *retval = NULL;
69  const owl_cmd *cmd;
70
71  if (!strcmp(argv[0], "")) {
72  } else if (NULL != (cmd = owl_dict_find_element(cd, argv[0]))) {
73    retval = owl_cmd_execute(cmd, cd, ctx, argc, argv, buff);
74  } else {
75    owl_function_makemsg("Unknown command '%s'.", buff);
76  }
77  return retval;
78}
79
80char *owl_cmddict_execute(const owl_cmddict *cd, const owl_context *ctx, const char *cmdbuff) {
81  char **argv;
82  int argc;
83  char *tmpbuff;
84  char *retval = NULL;
85
86  tmpbuff=owl_strdup(cmdbuff);
87  argv=owl_parseline(tmpbuff, &argc);
88  if (argc < 0) {
89    owl_free(tmpbuff);
90    sepbar(NULL);
91    owl_function_makemsg("Unbalanced quotes");
92    return NULL;
93  } 
94 
95  if (argc < 1) {
96    owl_parsefree(argv, argc);
97    owl_free(tmpbuff);
98    return NULL;
99  }
100
101  retval = _owl_cmddict_execute(cd, ctx, strs(argv), argc, cmdbuff);
102
103  owl_parsefree(argv, argc);
104  owl_free(tmpbuff);
105  sepbar(NULL);
106  return retval;
107}
108
109char *owl_cmddict_execute_argv(const owl_cmddict *cd, const owl_context *ctx, const char *const *argv, int argc) {
110  char *buff, *ptr;
111  int len = 0, i;
112  char *retval = NULL;
113
114  for(i = 0; i < argc; i++) {
115    len += strlen(argv[i]) + 1;
116  }
117
118  ptr = buff = owl_malloc(len);
119
120  for(i = 0; i < argc; i++) {
121    strcpy(ptr, argv[i]);
122    ptr += strlen(argv[i]);
123    *(ptr++) = ' ';
124  }
125  *(ptr - 1) = 0;
126
127  retval = _owl_cmddict_execute(cd, ctx, argv, argc, buff);
128
129  owl_free(buff);
130  return retval;
131}
132
133/*********************************************************************/
134/***************************** COMMAND *******************************/
135/*********************************************************************/
136
137/* sets up a new command based on a template, copying strings */
138int owl_cmd_create_from_template(owl_cmd *cmd, const owl_cmd *templ) {
139  *cmd = *templ;
140  if (!templ->name) return(-1);
141  cmd->name = owl_strdup(templ->name);
142  if (templ->summary)     cmd->summary     = owl_strdup(templ->summary);
143  if (templ->usage)       cmd->usage       = owl_strdup(templ->usage);
144  if (templ->description) cmd->description = owl_strdup(templ->description);
145  if (templ->cmd_aliased_to) cmd->cmd_aliased_to = owl_strdup(templ->cmd_aliased_to);
146  return(0);
147}
148
149int owl_cmd_create_alias(owl_cmd *cmd, const char *name, const char *aliased_to) {
150  memset(cmd, 0, sizeof(owl_cmd));
151  cmd->name = owl_strdup(name);
152  cmd->cmd_aliased_to = owl_strdup(aliased_to);
153  cmd->summary = owl_sprintf("%s%s", OWL_CMD_ALIAS_SUMMARY_PREFIX, aliased_to);
154  return(0);
155}
156
157void owl_cmd_free(owl_cmd *cmd) {
158  if (cmd->name) owl_free(cmd->name);
159  if (cmd->summary) owl_free(cmd->summary);
160  if (cmd->usage) owl_free(cmd->usage);
161  if (cmd->description) owl_free(cmd->description);
162  if (cmd->cmd_aliased_to) owl_free(cmd->cmd_aliased_to);
163  if (cmd->cmd_perl) owl_perlconfig_cmd_free(cmd);
164}
165
166int owl_cmd_is_context_valid(const owl_cmd *cmd, const owl_context *ctx) { 
167  if (owl_context_matches(ctx, cmd->validctx)) return 1;
168  else return 0;
169}
170
171char *owl_cmd_execute(const owl_cmd *cmd, const owl_cmddict *cd, const owl_context *ctx, int argc, const char *const *argv, const char *cmdbuff) {
172  static int alias_recurse_depth = 0;
173  int ival=0;
174  const char *cmdbuffargs;
175  char *newcmd, *rv=NULL;
176
177  if (argc < 1) return(NULL);
178
179  /* Recurse if this is an alias */
180  if (cmd->cmd_aliased_to) {
181    if (alias_recurse_depth++ > 50) {
182      owl_function_makemsg("Alias loop detected for '%s'.", cmdbuff);
183    } else {
184      cmdbuffargs = skiptokens(cmdbuff, 1);
185      newcmd = owl_sprintf("%s %s", cmd->cmd_aliased_to, cmdbuffargs);
186      rv = owl_function_command(newcmd);
187      owl_free(newcmd);
188    } 
189    alias_recurse_depth--;
190    return rv;
191  }
192
193  /* Do validation and conversions */
194  if (cmd->cmd_ctxargs_fn || cmd->cmd_ctxv_fn || cmd->cmd_ctxi_fn) {
195    if (!owl_cmd_is_context_valid(cmd, ctx)) {
196      owl_function_makemsg("Invalid context for command '%s'.", cmdbuff);
197      return NULL;
198    }
199  }
200
201  if ((argc != 1) && (cmd->cmd_v_fn || cmd->cmd_ctxv_fn)) {
202    owl_function_makemsg("Wrong number of arguments for %s command.", argv[0]);
203    return NULL;
204  }
205
206  if (cmd->cmd_i_fn || cmd->cmd_ctxi_fn) {
207      char *ep;
208      if (argc != 2) {
209        owl_function_makemsg("Wrong number of arguments for %s command.", argv[0]);
210        return NULL;
211      }
212      ival = strtol(argv[1], &ep, 10);
213      if (*ep || ep==argv[1]) {
214        owl_function_makemsg("Invalid argument '%s' for %s command.", argv[1], argv[0]);
215        return(NULL);
216      }
217  }
218
219  if (cmd->cmd_args_fn) {
220    return cmd->cmd_args_fn(argc, argv, cmdbuff);
221  } else if (cmd->cmd_v_fn) {   
222    cmd->cmd_v_fn();
223  } else if (cmd->cmd_i_fn) {
224    cmd->cmd_i_fn(ival);
225  } else if (cmd->cmd_ctxargs_fn) {
226    return cmd->cmd_ctxargs_fn(owl_context_get_data(ctx), argc, argv, cmdbuff);
227  } else if (cmd->cmd_ctxv_fn) {   
228    cmd->cmd_ctxv_fn(owl_context_get_data(ctx));
229  } else if (cmd->cmd_ctxi_fn) {
230    cmd->cmd_ctxi_fn(owl_context_get_data(ctx), ival);
231  } else if (cmd->cmd_perl) {
232    return owl_perlconfig_perlcmd(cmd, argc, argv);
233  }
234
235  return NULL;
236}
237
238/* returns a reference */
239const char *owl_cmd_get_summary(const owl_cmd *cmd) {
240  return cmd->summary;
241}
242
243/* returns a summary line describing this keymap.  the caller must free. */
244char *owl_cmd_describe(const owl_cmd *cmd) {
245  if (!cmd || !cmd->name || !cmd->summary) return NULL;
246  return owl_sprintf("%-25s - %s", cmd->name, cmd->summary);
247}
248
249
250
251void owl_cmd_get_help(const owl_cmddict *d, const char *name, owl_fmtext *fm) {
252  const char *s;
253  char *indent;
254  owl_cmd *cmd;
255
256  if (!name || (cmd = owl_dict_find_element(d, name)) == NULL) {
257    owl_fmtext_append_bold(fm, "OWL HELP\n\n");
258    owl_fmtext_append_normal(fm, "No such command...\n");
259    return;
260  }
261
262  owl_fmtext_append_bold(fm, "OWL HELP\n\n");
263  owl_fmtext_append_bold(fm, "NAME\n\n");
264  owl_fmtext_append_normal(fm, OWL_TABSTR);
265  owl_fmtext_append_normal(fm, cmd->name);
266
267  if (cmd->summary && *cmd->summary) {
268    owl_fmtext_append_normal(fm, " - ");
269    owl_fmtext_append_normal(fm, cmd->summary);
270  }
271  owl_fmtext_append_normal(fm, "\n");
272
273  if (cmd->usage && *cmd->usage) {
274    s = cmd->usage;
275    indent = owl_malloc(strlen(s)+(owl_text_num_lines(s)+3)*OWL_TAB+1);
276    owl_text_indent(indent, s, OWL_TAB);
277    owl_fmtext_append_bold(fm, "\nSYNOPSIS\n");
278    owl_fmtext_append_normal(fm, indent);
279    owl_fmtext_append_normal(fm, "\n");
280    owl_free(indent);
281  } else {
282    owl_fmtext_append_bold(fm, "\nSYNOPSIS\n");
283    owl_fmtext_append_normal(fm, OWL_TABSTR);
284    owl_fmtext_append_normal(fm, cmd->name);
285    owl_fmtext_append_normal(fm, "\n");
286  }
287
288  if (cmd->description && *cmd->description) {
289    s = cmd->description;
290    indent = owl_malloc(strlen(s)+(owl_text_num_lines(s)+3)*OWL_TAB+1);
291    owl_text_indent(indent, s, OWL_TAB);
292    owl_fmtext_append_bold(fm, "\nDESCRIPTION\n");
293    owl_fmtext_append_normal(fm, indent);
294    owl_fmtext_append_normal(fm, "\n");
295    owl_free(indent);
296  }
297
298  owl_fmtext_append_normal(fm, "\n\n"); 
299}
Note: See TracBrowser for help on using the repository browser.