4 Copyright (C) 1999-2000 Timo Sirainen
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "special-vars.h"
26 #include "window-item-def.h"
31 #include "lib-config/iconfig.h"
35 char *current_command;
37 static int signal_default_command;
39 static GSList *alias_runstack;
41 COMMAND_REC *command_find(const char *cmd)
45 g_return_val_if_fail(cmd != NULL, NULL);
47 for (tmp = commands; tmp != NULL; tmp = tmp->next) {
48 COMMAND_REC *rec = tmp->data;
50 if (g_strcasecmp(rec->cmd, cmd) == 0)
57 static COMMAND_MODULE_REC *command_module_find(COMMAND_REC *rec,
62 g_return_val_if_fail(rec != NULL, NULL);
63 g_return_val_if_fail(module != NULL, NULL);
65 for (tmp = rec->modules; tmp != NULL; tmp = tmp->next) {
66 COMMAND_MODULE_REC *rec = tmp->data;
68 if (g_strcasecmp(rec->name, module) == 0)
75 static COMMAND_MODULE_REC *
76 command_module_find_and_remove(COMMAND_REC *rec, SIGNAL_FUNC func)
80 g_return_val_if_fail(rec != NULL, NULL);
81 g_return_val_if_fail(func != NULL, NULL);
83 for (tmp = rec->modules; tmp != NULL; tmp = tmp->next) {
84 COMMAND_MODULE_REC *rec = tmp->data;
86 for (tmp2 = rec->callbacks; tmp2 != NULL; tmp2 = tmp2->next) {
87 COMMAND_CALLBACK_REC *cb = tmp2->data;
89 if (cb->func == func) {
91 g_slist_remove(rec->callbacks, cb);
100 int command_have_sub(const char *command)
105 g_return_val_if_fail(command != NULL, FALSE);
107 /* find "command "s */
108 len = strlen(command);
109 for (tmp = commands; tmp != NULL; tmp = tmp->next) {
110 COMMAND_REC *rec = tmp->data;
112 if (g_strncasecmp(rec->cmd, command, len) == 0 &&
113 rec->cmd[len] == ' ')
120 static COMMAND_MODULE_REC *
121 command_module_get(COMMAND_REC *rec, const char *module, int protocol)
123 COMMAND_MODULE_REC *modrec;
125 g_return_val_if_fail(rec != NULL, NULL);
127 modrec = command_module_find(rec, module);
128 if (modrec == NULL) {
129 modrec = g_new0(COMMAND_MODULE_REC, 1);
130 modrec->name = g_strdup(module);
131 modrec->protocol = -1;
132 rec->modules = g_slist_append(rec->modules, modrec);
136 modrec->protocol = protocol;
141 void command_bind_full(const char *module, int priority, const char *cmd,
142 int protocol, const char *category, SIGNAL_FUNC func,
146 COMMAND_MODULE_REC *modrec;
147 COMMAND_CALLBACK_REC *cb;
150 g_return_if_fail(module != NULL);
151 g_return_if_fail(cmd != NULL);
153 rec = command_find(cmd);
155 rec = g_new0(COMMAND_REC, 1);
156 rec->cmd = g_strdup(cmd);
157 rec->category = category == NULL ? NULL : g_strdup(category);
158 commands = g_slist_append(commands, rec);
160 modrec = command_module_get(rec, module, protocol);
162 cb = g_new0(COMMAND_CALLBACK_REC, 1);
164 cb->user_data = user_data;
165 modrec->callbacks = g_slist_append(modrec->callbacks, cb);
168 str = g_strconcat("command ", cmd, NULL);
169 signal_add_full(module, priority, str, func, user_data);
173 signal_emit("commandlist new", 1, rec);
176 static void command_free(COMMAND_REC *rec)
178 commands = g_slist_remove(commands, rec);
179 signal_emit("commandlist remove", 1, rec);
181 g_free_not_null(rec->category);
182 g_strfreev(rec->options);
187 static void command_module_free(COMMAND_MODULE_REC *modrec, COMMAND_REC *rec)
189 rec->modules = g_slist_remove(rec->modules, modrec);
191 g_slist_foreach(modrec->callbacks, (GFunc) g_free, NULL);
192 g_slist_free(modrec->callbacks);
193 g_free(modrec->name);
194 g_free_not_null(modrec->options);
198 static void command_module_destroy(COMMAND_REC *rec,
199 COMMAND_MODULE_REC *modrec)
201 GSList *tmp, *freelist;
203 command_module_free(modrec, rec);
205 /* command_set_options() might have added module declaration of it's
206 own without any signals .. check if they're the only ones left
207 and if so, destroy them. */
209 for (tmp = rec->modules; tmp != NULL; tmp = tmp->next) {
210 COMMAND_MODULE_REC *rec = tmp->data;
212 if (rec->callbacks == NULL)
213 freelist = g_slist_append(freelist, rec);
215 g_slist_free(freelist);
221 g_slist_foreach(freelist, (GFunc) command_module_free, rec);
222 g_slist_free(freelist);
224 if (rec->modules == NULL)
228 void command_unbind_full(const char *cmd, SIGNAL_FUNC func, void *user_data)
231 COMMAND_MODULE_REC *modrec;
234 g_return_if_fail(cmd != NULL);
235 g_return_if_fail(func != NULL);
237 rec = command_find(cmd);
239 modrec = command_module_find_and_remove(rec, func);
240 g_return_if_fail(modrec != NULL);
242 if (modrec->callbacks == NULL)
243 command_module_destroy(rec, modrec);
246 str = g_strconcat("command ", cmd, NULL);
247 signal_remove_data(str, func, user_data);
251 /* Expand `cmd' - returns `cmd' if not found, NULL if more than one
253 static const char *command_expand(char *cmd)
259 g_return_val_if_fail(cmd != NULL, NULL);
264 for (tmp = commands; tmp != NULL; tmp = tmp->next) {
265 COMMAND_REC *rec = tmp->data;
267 if (g_strncasecmp(rec->cmd, cmd, len) == 0 &&
268 strchr(rec->cmd+len, ' ') == NULL) {
269 if (rec->cmd[len] == '\0') {
275 /* multiple matches, we still need to check
276 if there's some command left that is a
281 /* check that this is the only match */
287 signal_emit("error command", 2,
288 GINT_TO_POINTER(CMDERR_AMBIGUOUS), cmd);
292 return match != NULL ? match : cmd;
295 void command_runsub(const char *cmd, const char *data,
296 void *server, void *item)
299 char *orig, *subcmd, *defcmd, *args;
301 g_return_if_fail(data != NULL);
303 while (*data == ' ') data++;
306 /* no subcommand given - list the subcommands */
307 signal_emit("list subcommands", 2, cmd);
312 orig = subcmd = g_strdup_printf("command %s %s", cmd, data);
313 args = strchr(subcmd+8 + strlen(cmd)+1, ' ');
314 if (args != NULL) *args++ = '\0'; else args = "";
315 while (*args == ' ') args++;
317 /* check if this command can be expanded */
318 newcmd = command_expand(subcmd+8);
319 if (newcmd == NULL) {
320 /* ambiguous command */
325 subcmd = g_strconcat("command ", newcmd, NULL);
328 if (!signal_emit(subcmd, 3, args, server, item)) {
329 defcmd = g_strdup_printf("default command %s", cmd);
330 if (!signal_emit(defcmd, 3, data, server, item)) {
331 signal_emit("error command", 2,
332 GINT_TO_POINTER(CMDERR_UNKNOWN), subcmd+8);
341 static GSList *optlist_find(GSList *optlist, const char *option)
343 while (optlist != NULL) {
344 char *name = optlist->data;
345 if (iscmdtype(*name)) name++;
347 if (g_strcasecmp(name, option) == 0)
350 optlist = optlist->next;
356 int command_have_option(const char *cmd, const char *option)
361 g_return_val_if_fail(cmd != NULL, FALSE);
362 g_return_val_if_fail(option != NULL, FALSE);
364 rec = command_find(cmd);
365 g_return_val_if_fail(rec != NULL, FALSE);
367 if (rec->options == NULL)
370 for (tmp = rec->options; *tmp != NULL; tmp++) {
371 char *name = iscmdtype(**tmp) ? (*tmp)+1 : *tmp;
373 if (g_strcasecmp(name, option) == 0)
380 static void command_calc_options(COMMAND_REC *rec, const char *options)
382 char **optlist, **tmp, *name, *str;
383 GSList *list, *oldopt;
385 optlist = g_strsplit(options, " ", -1);
387 if (rec->options == NULL) {
388 /* first call - use specified args directly */
389 rec->options = optlist;
393 /* save old options to linked list */
395 for (tmp = rec->options; *tmp != NULL; tmp++)
396 list = g_slist_append(list, g_strdup(*tmp));
397 g_strfreev(rec->options);
399 /* merge the options */
400 for (tmp = optlist; *tmp != NULL; tmp++) {
401 name = iscmdtype(**tmp) ? (*tmp)+1 : *tmp;
403 oldopt = optlist_find(list, name);
404 if (oldopt != NULL) {
405 /* already specified - overwrite old defination */
406 g_free(oldopt->data);
407 oldopt->data = g_strdup(*tmp);
409 /* new option, append to list */
410 list = g_slist_append(list, g_strdup(*tmp));
415 /* linked list -> string[] */
416 str = gslist_to_string(list, " ");
417 rec->options = g_strsplit(str, " ", -1);
420 g_slist_foreach(list, (GFunc) g_free, NULL);
424 /* recalculate options to command from options in all modules */
425 static void command_update_options(COMMAND_REC *rec)
429 g_strfreev(rec->options);
432 for (tmp = rec->modules; tmp != NULL; tmp = tmp->next) {
433 COMMAND_MODULE_REC *modrec = tmp->data;
435 if (modrec->options != NULL)
436 command_calc_options(rec, modrec->options);
440 void command_set_options_module(const char *module,
441 const char *cmd, const char *options)
444 COMMAND_MODULE_REC *modrec;
447 g_return_if_fail(module != NULL);
448 g_return_if_fail(cmd != NULL);
449 g_return_if_fail(options != NULL);
451 rec = command_find(cmd);
452 g_return_if_fail(rec != NULL);
453 modrec = command_module_get(rec, module, -1);
455 reload = modrec->options != NULL;
457 /* options already set for the module ..
458 we need to recalculate everything */
459 g_free(modrec->options);
462 modrec->options = g_strdup(options);
465 command_update_options(rec);
467 command_calc_options(rec, options);
470 char *cmd_get_param(char **data)
474 g_return_val_if_fail(data != NULL, NULL);
475 g_return_val_if_fail(*data != NULL, NULL);
477 while (**data == ' ') (*data)++;
480 while (**data != '\0' && **data != ' ') (*data)++;
481 if (**data == ' ') *(*data)++ = '\0';
486 static char *cmd_get_quoted_param(char **data)
490 g_return_val_if_fail(data != NULL, NULL);
491 g_return_val_if_fail(*data != NULL, NULL);
493 while (**data == ' ') (*data)++;
494 if (**data != '\'' && **data != '"')
495 return cmd_get_param(data);
497 quote = **data; (*data)++;
500 while (**data != '\0' && **data != quote) {
501 if (**data == '\\' && (*data)[1] != '\0')
502 g_memmove(*data, (*data)+1, strlen(*data));
506 if (**data != '\0') *(*data)++ = '\0';
511 /* Find specified option from list of options - the `option' might be
512 shortened version of the full command. Returns index where the
513 option was found, -1 if not found or -2 if there was multiple matches. */
514 static int option_find(char **array, const char *option)
517 int index, found, len, multiple;
519 g_return_val_if_fail(array != NULL, -1);
520 g_return_val_if_fail(option != NULL, -1);
522 len = strlen(option);
524 found = -1; index = 0; multiple = FALSE;
525 for (tmp = array; *tmp != NULL; tmp++, index++) {
526 const char *text = *tmp + iscmdtype(**tmp);
528 if (g_strncasecmp(text, option, len) == 0) {
529 if (text[len] == '\0') {
535 /* multiple matches - we still need to check
536 if there's a full match left.. */
540 /* partial match, check that it's the only one */
551 static int get_cmd_options(char **data, int ignore_unknown,
552 const char *cmd, GHashTable *options)
555 char *option, *arg, **optlist;
558 /* get option definations */
559 rec = cmd == NULL ? NULL : command_find(cmd);
560 optlist = rec == NULL ? NULL : rec->options;
562 option = NULL; pos = -1;
565 if (option != NULL && *optlist[pos] == '+') {
566 /* required argument missing! */
567 *data = optlist[pos] + 1;
568 return CMDERR_OPTION_ARG_MISSING;
572 if (**data == '-' && i_isspace((*data)[1])) {
573 /* -- option means end of options even
574 if next word starts with - */
576 while (i_isspace(**data)) (*data)++;
582 else if (!i_isspace(**data))
583 option = cmd_get_param(data);
589 /* check if this option can have argument */
590 pos = optlist == NULL ? -1 :
591 option_find(optlist, option);
593 if (pos == -1 && optlist != NULL &&
594 is_numeric(option, '\0')) {
595 /* check if we want -<number> option */
596 pos = option_find(optlist, "#");
598 g_hash_table_insert(options, "#",
604 if (pos == -1 && !ignore_unknown) {
605 /* unknown option! */
607 return CMDERR_OPTION_UNKNOWN;
609 if (pos == -2 && !ignore_unknown) {
610 /* multiple matches */
612 return CMDERR_OPTION_AMBIGUOUS;
615 /* if we used a shortcut of parameter, put
616 the whole parameter name in options table */
617 option = optlist[pos] +
618 iscmdtype(*optlist[pos]);
620 if (options != NULL && pos != -3)
621 g_hash_table_insert(options, option, "");
623 if (pos < 0 || !iscmdtype(*optlist[pos]) ||
624 *optlist[pos] == '!')
627 while (i_isspace(**data)) (*data)++;
634 if (*optlist[pos] == '@' && !i_isdigit(**data))
635 break; /* expected a numeric argument */
637 /* save the argument */
638 arg = cmd_get_quoted_param(data);
639 if (options != NULL) {
640 g_hash_table_remove(options, option);
641 g_hash_table_insert(options, option, arg);
645 while (i_isspace(**data)) (*data)++;
656 static char *get_optional_channel(WI_ITEM_REC *active_item, char **data,
659 CHANNEL_REC *chanrec;
660 char *tmp, *origtmp, *channel, *ret;
662 if (active_item == NULL) {
663 /* no active channel in window, channel required */
664 return cmd_get_param(data);
667 origtmp = tmp = g_strdup(*data);
668 channel = cmd_get_param(&tmp);
670 if (strcmp(channel, "*") == 0 && !require_name) {
671 /* "*" means active channel */
673 ret = active_item->name;
674 } else if (!server_ischannel(active_item->server, channel)) {
675 /* we don't have channel parameter - use active channel */
676 ret = active_item->name;
678 /* Find the channel first and use it's name if found.
679 This allows automatic !channel -> !XXXXXchannel replaces. */
680 channel = cmd_get_param(data);
682 chanrec = channel_find(active_item->server, channel);
683 ret = chanrec == NULL ? channel : chanrec->name;
690 int cmd_get_params(const char *data, gpointer *free_me, int count, ...)
694 GHashTable **opthash;
695 char **str, *arg, *datad;
697 int cnt, error, ignore_unknown, require_name;
699 g_return_val_if_fail(data != NULL, FALSE);
701 va_start(args, count);
703 rec = g_new0(CMD_TEMP_REC, 1);
704 rec->data = g_strdup(data);
710 item = (count & PARAM_FLAG_OPTCHAN) == 0 ? NULL:
711 (WI_ITEM_REC *) va_arg(args, WI_ITEM_REC *);
713 if (count & PARAM_FLAG_OPTIONS) {
714 arg = (char *) va_arg(args, char *);
715 opthash = (GHashTable **) va_arg(args, GHashTable **);
717 rec->options = *opthash =
718 g_hash_table_new((GHashFunc) g_istr_hash,
719 (GCompareFunc) g_istr_equal);
721 ignore_unknown = count & PARAM_FLAG_UNKNOWN_OPTIONS;
722 error = get_cmd_options(&datad, ignore_unknown,
727 /* and now handle the string */
728 cnt = PARAM_WITHOUT_FLAGS(count);
729 if (count & PARAM_FLAG_OPTCHAN) {
730 /* optional channel as first parameter */
731 require_name = (count & PARAM_FLAG_OPTCHAN_NAME) ==
732 PARAM_FLAG_OPTCHAN_NAME;
733 arg = get_optional_channel(item, &datad, require_name);
735 str = (char **) va_arg(args, char **);
736 if (str != NULL) *str = arg;
741 if (cnt == 0 && count & PARAM_FLAG_GETREST) {
745 arg = (count & PARAM_FLAG_NOQUOTES) ?
746 cmd_get_param(&datad) :
747 cmd_get_quoted_param(&datad);
750 str = (char **) va_arg(args, char **);
751 if (str != NULL) *str = arg;
757 signal_emit("error command", 2, GINT_TO_POINTER(error), datad);
760 cmd_params_free(rec);
767 void cmd_params_free(void *free_me)
769 CMD_TEMP_REC *rec = free_me;
771 if (rec->options != NULL) g_hash_table_destroy(rec->options);
776 static void command_module_unbind_all(COMMAND_REC *rec,
777 COMMAND_MODULE_REC *modrec)
781 for (tmp = modrec->callbacks; tmp != NULL; tmp = next) {
782 COMMAND_CALLBACK_REC *cb = tmp->data;
785 command_unbind_full(rec->cmd, cb->func, cb->user_data);
788 if (g_slist_find(commands, rec) != NULL) {
789 /* this module might have removed some options
790 from command, update them. */
791 command_update_options(rec);
795 void commands_remove_module(const char *module)
797 GSList *tmp, *next, *modlist;
799 g_return_if_fail(module != NULL);
801 for (tmp = commands; tmp != NULL; tmp = next) {
802 COMMAND_REC *rec = tmp->data;
805 modlist = gslist_find_string(rec->modules, module);
807 command_module_unbind_all(rec, modlist->data);
811 static int cmd_protocol_match(COMMAND_REC *cmd, SERVER_REC *server)
815 for (tmp = cmd->modules; tmp != NULL; tmp = tmp->next) {
816 COMMAND_MODULE_REC *rec = tmp->data;
818 if (rec->protocol == -1) {
819 /* at least one module accepts the command
820 without specific protocol */
824 if (server != NULL && rec->protocol == server->chat_type) {
825 /* matching protocol found */
833 #define alias_runstack_push(alias) \
834 alias_runstack = g_slist_append(alias_runstack, alias)
836 #define alias_runstack_pop(alias) \
837 alias_runstack = g_slist_remove(alias_runstack, alias)
839 #define alias_runstack_find(alias) \
840 (gslist_find_icase_string(alias_runstack, alias) != NULL)
842 static void parse_command(const char *command, int expand_aliases,
843 SERVER_REC *server, void *item)
846 const char *alias, *newcmd;
847 char *cmd, *orig, *args, *oldcmd;
849 g_return_if_fail(command != NULL);
851 cmd = orig = g_strconcat("command ", command, NULL);
852 args = strchr(cmd+8, ' ');
853 if (args != NULL) *args++ = '\0'; else args = "";
855 /* check if there's an alias for command. Don't allow
857 alias = !expand_aliases || alias_runstack_find(cmd+8) ? NULL :
860 alias_runstack_push(cmd+8);
861 eval_special_string(alias, args, server, item);
862 alias_runstack_pop(cmd+8);
867 /* check if this command can be expanded */
868 newcmd = command_expand(cmd+8);
869 if (newcmd == NULL) {
870 /* ambiguous command */
875 rec = command_find(newcmd);
876 if (rec != NULL && !cmd_protocol_match(rec, server)) {
879 signal_emit("error command", 2,
880 GINT_TO_POINTER(server == NULL ?
881 CMDERR_NOT_CONNECTED :
882 CMDERR_ILLEGAL_PROTO));
886 cmd = g_strconcat("command ", newcmd, NULL);
889 oldcmd = current_command;
890 current_command = cmd+8;
891 if (server != NULL) server_ref(server);
892 if (!signal_emit(cmd, 3, args, server, item)) {
893 signal_emit_id(signal_default_command, 3,
894 command, server, item);
896 if (server != NULL) {
897 if (server->connection_lost)
898 server_disconnect(server);
899 server_unref(server);
901 current_command = oldcmd;
907 static void event_command(const char *line, SERVER_REC *server, void *item)
910 int expand_aliases = TRUE;
912 g_return_if_fail(line != NULL);
915 /* empty line, forget it. */
920 cmdchar = strchr(settings_get_str("cmdchars"), *line);
921 if (cmdchar != NULL && line[1] == ' ') {
922 /* "/ text" = same as sending "text" to active channel. */
926 if (cmdchar == NULL) {
927 /* non-command - let someone else handle this */
928 signal_emit("send text", 3, line, server, item);
932 /* same cmdchar twice ignores aliases ignores aliases */
934 if (*line == *cmdchar) {
936 expand_aliases = FALSE;
939 /* ^command hides the output - we'll do this at fe-common but
940 we have to skip the ^ char here.. */
941 if (*line == '^') line++;
943 parse_command(line, expand_aliases, server, item);
946 /* SYNTAX: EVAL <command(s)> */
947 static void cmd_eval(const char *data, SERVER_REC *server, void *item)
949 g_return_if_fail(data != NULL);
951 eval_special_string(data, "", server, item);
954 /* SYNTAX: CD <directory> */
955 static void cmd_cd(const char *data)
959 g_return_if_fail(data != NULL);
960 if (*data == '\0') return;
962 str = convert_home(data);
967 void commands_init(void)
970 current_command = NULL;
971 alias_runstack = NULL;
973 signal_default_command = signal_get_uniq_id("default command");
975 settings_add_str("misc", "cmdchars", "/");
976 signal_add("send command", (SIGNAL_FUNC) event_command);
978 command_bind("eval", NULL, (SIGNAL_FUNC) cmd_eval);
979 command_bind("cd", NULL, (SIGNAL_FUNC) cmd_cd);
982 void commands_deinit(void)
984 g_free_not_null(current_command);
986 signal_remove("send command", (SIGNAL_FUNC) event_command);
988 command_unbind("eval", (SIGNAL_FUNC) cmd_eval);
989 command_unbind("cd", (SIGNAL_FUNC) cmd_cd);