4 Copyright (C) 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 along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include "irssi-version.h"
34 #include "window-item-def.h"
36 #ifdef HAVE_SYS_UTSNAME_H
37 # include <sys/utsname.h>
40 #define MAX_EXPANDO_SIGNALS 10
46 int signal_ids[MAX_EXPANDO_SIGNALS];
47 int signal_args[MAX_EXPANDO_SIGNALS];
50 const char *current_expando = NULL;
54 static EXPANDO_REC *char_expandos[255];
55 static GHashTable *expandos;
56 static char *last_sent_msg, *last_sent_msg_body;
57 static char *last_privmsg_from, *last_public_from;
58 static char *sysname, *sysrelease, *sysarch;
60 static const char *timestamp_format;
61 static int timestamp_seconds;
62 static time_t last_timestamp;
64 #define CHAR_EXPANDO(chr) \
65 (char_expandos[(int) (unsigned char) chr])
67 /* Create expando - overrides any existing ones. */
68 void expando_create(const char *key, EXPANDO_FUNC func, ...)
74 g_return_if_fail(key != NULL && *key != '\0');
75 g_return_if_fail(func != NULL);
78 rec = g_hash_table_lookup(expandos, key);
80 /* single character expando */
81 rec = CHAR_EXPANDO(*key);
87 rec = g_new0(EXPANDO_REC, 1);
89 g_hash_table_insert(expandos, g_strdup(key), rec);
91 char_expandos[(int) (unsigned char) *key] = rec;
97 while ((signal = (const char *) va_arg(va, const char *)) != NULL)
98 expando_add_signal(key, signal, (int) va_arg(va, int));
102 static EXPANDO_REC *expando_find(const char *key)
105 return g_hash_table_lookup(expandos, key);
107 return CHAR_EXPANDO(*key);
110 /* Add new signal to expando */
111 void expando_add_signal(const char *key, const char *signal, ExpandoArg arg)
115 g_return_if_fail(key != NULL);
116 g_return_if_fail(signal != NULL);
118 rec = expando_find(key);
119 g_return_if_fail(rec != NULL);
121 if (arg == EXPANDO_NEVER) {
122 /* expando changes never */
124 } else if (rec->signals < MAX_EXPANDO_SIGNALS) {
125 g_return_if_fail(rec->signals != -1);
127 rec->signal_ids[rec->signals] = signal_get_uniq_id(signal);
128 rec->signal_args[rec->signals] = arg;
133 /* Destroy expando */
134 void expando_destroy(const char *key, EXPANDO_FUNC func)
136 gpointer origkey, value;
139 g_return_if_fail(key != NULL && *key != '\0');
140 g_return_if_fail(func != NULL);
142 if (key[1] == '\0') {
143 /* single character expando */
144 rec = CHAR_EXPANDO(*key);
145 if (rec != NULL && rec->func == func) {
146 char_expandos[(int) (unsigned char) *key] = NULL;
149 } else if (g_hash_table_lookup_extended(expandos, key,
152 if (rec->func == func) {
153 g_hash_table_remove(expandos, key);
160 void expando_bind(const char *key, int funccount, SIGNAL_FUNC *funcs)
166 g_return_if_fail(key != NULL);
167 g_return_if_fail(funccount >= 1);
168 g_return_if_fail(funcs != NULL);
169 g_return_if_fail(funcs[0] != NULL);
171 rec = expando_find(key);
172 g_return_if_fail(rec != NULL);
174 if (rec->signals == 0) {
175 /* it's unknown when this expando changes..
176 check it once in a second */
177 signal_add("expando timer", funcs[EXPANDO_ARG_NONE]);
180 for (n = 0; n < rec->signals; n++) {
181 arg = rec->signal_args[n];
182 func = arg < funccount ? funcs[arg] : NULL;
183 if (func == NULL) func = funcs[EXPANDO_ARG_NONE];
185 signal_add_full_id(MODULE_NAME, SIGNAL_PRIORITY_DEFAULT,
186 rec->signal_ids[n], func, NULL);
190 void expando_unbind(const char *key, int funccount, SIGNAL_FUNC *funcs)
196 g_return_if_fail(key != NULL);
197 g_return_if_fail(funccount >= 1);
198 g_return_if_fail(funcs != NULL);
199 g_return_if_fail(funcs[0] != NULL);
201 rec = expando_find(key);
202 g_return_if_fail(rec != NULL);
204 if (rec->signals == 0) {
205 /* it's unknown when this expando changes..
206 check it once in a second */
207 signal_remove("expando timer", funcs[EXPANDO_ARG_NONE]);
210 for (n = 0; n < rec->signals; n++) {
211 arg = rec->signal_args[n];
212 func = arg < funccount ? funcs[arg] : NULL;
213 if (func == NULL) func = funcs[EXPANDO_ARG_NONE];
215 signal_remove_id(rec->signal_ids[n], func, NULL);
219 /* Returns [<signal id>, EXPANDO_ARG_xxx, <signal id>, ..., -1] */
220 int *expando_get_signals(const char *key)
226 g_return_val_if_fail(key != NULL, NULL);
228 rec = expando_find(key);
229 if (rec == NULL || rec->signals < 0)
232 if (rec->signals == 0) {
233 /* it's unknown when this expando changes..
234 check it once in a second */
235 signals = g_new(int, 3);
236 signals[0] = signal_get_uniq_id("expando timer");
237 signals[1] = EXPANDO_ARG_NONE;
242 signals = g_new(int, rec->signals*2+1);
243 for (n = 0; n < rec->signals; n++) {
244 signals[n*2] = rec->signal_ids[n];
245 signals[n*2+1] = rec->signal_args[n];
247 signals[rec->signals*2] = -1;
251 EXPANDO_FUNC expando_find_char(char chr)
253 return CHAR_EXPANDO(chr) == NULL ? NULL :
254 CHAR_EXPANDO(chr)->func;
257 EXPANDO_FUNC expando_find_long(const char *key)
259 EXPANDO_REC *rec = g_hash_table_lookup(expandos, key);
260 return rec == NULL ? NULL : rec->func;
263 static gboolean free_expando(gpointer key, gpointer value, gpointer user_data)
270 /* last person who sent you a MSG */
271 static char *expando_lastmsg(SERVER_REC *server, void *item, int *free_ret)
273 return last_privmsg_from;
276 /* last person to whom you sent a MSG */
277 static char *expando_lastmymsg(SERVER_REC *server, void *item, int *free_ret)
279 return last_sent_msg;
282 /* last person to send a public message to a channel you are on */
283 static char *expando_lastpublic(SERVER_REC *server, void *item, int *free_ret)
285 return last_public_from;
288 /* text of your AWAY message, if any */
289 static char *expando_awaymsg(SERVER_REC *server, void *item, int *free_ret)
291 return server == NULL ? "" : server->away_reason;
294 /* body of last MSG you sent */
295 static char *expando_lastmymsg_body(SERVER_REC *server, void *item, int *free_ret)
297 return last_sent_msg_body;
300 /* current channel */
301 static char *expando_channel(SERVER_REC *server, void *item, int *free_ret)
303 return !IS_CHANNEL(item) ? NULL : CHANNEL(item)->name;
306 /* time client was started, $time() format */
307 static char *expando_clientstarted(SERVER_REC *server, void *item, int *free_ret)
310 return g_strdup_printf("%ld", (long) client_start_time);
313 /* channel you were last INVITEd to */
314 static char *expando_last_invite(SERVER_REC *server, void *item, int *free_ret)
316 return server == NULL ? "" : server->last_invite;
319 /* client version text string */
320 static char *expando_version(SERVER_REC *server, void *item, int *free_ret)
322 return IRSSI_VERSION;
325 /* current value of CMDCHARS */
326 static char *expando_cmdchars(SERVER_REC *server, void *item, int *free_ret)
328 return (char *) settings_get_str("cmdchars");
332 static char *expando_cmdchar(SERVER_REC *server, void *item, int *free_ret)
334 char str[2] = { 0, 0 };
336 str[0] = *settings_get_str("cmdchars");
339 return g_strdup(str);
342 /* modes of current channel, if any */
343 static char *expando_chanmode(SERVER_REC *server, void *item, int *free_ret)
350 if (!IS_CHANNEL(item))
353 if (!settings_get_bool("chanmode_expando_strip"))
354 return CHANNEL(item)->mode;
357 cmode = g_strdup(CHANNEL(item)->mode);
358 args = strchr(cmode, ' ');
365 /* current nickname */
366 static char *expando_nick(SERVER_REC *server, void *item, int *free_ret)
368 return server == NULL ? "" : server->nick;
371 /* value of STATUS_OPER if you are an irc operator */
372 static char *expando_statusoper(SERVER_REC *server, void *item, int *free_ret)
374 return server == NULL || !server->server_operator ? "" :
375 (char *) settings_get_str("STATUS_OPER");
378 /* if you are a channel operator in $C, expands to a '@' */
379 static char *expando_chanop(SERVER_REC *server, void *item, int *free_ret)
381 return IS_CHANNEL(item) && CHANNEL(item)->chanop ? "@" : "";
384 /* nickname of whomever you are QUERYing */
385 static char *expando_query(SERVER_REC *server, void *item, int *free_ret)
387 return !IS_QUERY(item) ? "" : QUERY(item)->name;
390 /* version of current server */
391 static char *expando_serverversion(SERVER_REC *server, void *item, int *free_ret)
393 return server == NULL ? "" : server->version;
396 /* target of current input (channel or QUERY nickname) */
397 static char *expando_target(SERVER_REC *server, void *item, int *free_ret)
399 return item == NULL ? "" :
400 (char *) window_item_get_target((WI_ITEM_REC *) item);
403 /* client release date (in YYYYMMDD format) */
404 static char *expando_releasedate(SERVER_REC *server, void *item, int *free_ret)
407 return g_strdup_printf("%d", IRSSI_VERSION_DATE);
410 /* client release time (in HHMM format) */
411 static char *expando_releasetime(SERVER_REC *server, void *item, int *free_ret)
414 return g_strdup_printf("%04d", IRSSI_VERSION_TIME);
417 /* current working directory */
418 static char *expando_workdir(SERVER_REC *server, void *item, int *free_ret)
421 return g_get_current_dir();
424 /* value of REALNAME */
425 static char *expando_realname(SERVER_REC *server, void *item, int *free_ret)
427 return server == NULL ? "" : server->connrec->realname;
430 /* time of day (hh:mm) */
431 static char *expando_time(SERVER_REC *server, void *item, int *free_ret)
438 tm = localtime(&now);
440 if (strftime(str, sizeof(str), timestamp_format, tm) == 0)
444 return g_strdup(str);
448 static char *expando_dollar(SERVER_REC *server, void *item, int *free_ret)
454 static char *expando_sysname(SERVER_REC *server, void *item, int *free_ret)
460 static char *expando_sysrelease(SERVER_REC *server, void *item, int *free_ret)
465 /* system architecture */
466 static char *expando_sysarch(SERVER_REC *server, void *item, int *free_ret)
471 /* Topic of active channel (or address of queried nick) */
472 static char *expando_topic(SERVER_REC *server, void *item, int *free_ret)
474 if (IS_CHANNEL(item))
475 return CHANNEL(item)->topic;
476 if (IS_QUERY(item)) {
477 QUERY_REC *query = QUERY(item);
479 if (query->server_tag == NULL)
483 return query->address == NULL ?
484 g_strdup_printf("(%s)", query->server_tag) :
485 g_strdup_printf("%s (%s)", query->address,
492 static char *expando_servertag(SERVER_REC *server, void *item, int *free_ret)
494 return server == NULL ? "" : server->tag;
498 static char *expando_chatnet(SERVER_REC *server, void *item, int *free_ret)
500 return server == NULL ? "" : server->connrec->chatnet;
503 /* visible_name of current window item */
504 static char *expando_itemname(SERVER_REC *server, void *item, int *free_ret)
506 return item == NULL ? "" : ((WI_ITEM_REC *) item)->visible_name;
509 static void sig_message_public(SERVER_REC *server, const char *msg,
510 const char *nick, const char *address,
513 g_free_not_null(last_public_from);
514 last_public_from = g_strdup(nick);
517 static void sig_message_private(SERVER_REC *server, const char *msg,
518 const char *nick, const char *address)
520 g_free_not_null(last_privmsg_from);
521 last_privmsg_from = g_strdup(nick);
524 static void sig_message_own_private(SERVER_REC *server, const char *msg,
525 const char *target, const char *origtarget)
527 g_return_if_fail(server != NULL);
528 g_return_if_fail(msg != NULL);
530 if (target != NULL) {
531 if (target != last_sent_msg) {
532 g_free_not_null(last_sent_msg);
533 last_sent_msg = g_strdup(target);
535 g_free_not_null(last_sent_msg_body);
536 last_sent_msg_body = g_strdup(msg);
540 static int sig_timer(void)
546 signal_emit("expando timer", 0);
548 /* check if $Z has changed */
550 if (last_timestamp != now) {
551 if (!timestamp_seconds && last_timestamp != 0) {
552 /* assume it changes every minute */
553 tm = localtime(&last_timestamp);
554 last_min = tm->tm_min;
556 tm = localtime(&now);
557 if (tm->tm_min == last_min)
561 signal_emit("time changed", 0);
562 last_timestamp = now;
568 static void read_settings(void)
570 timestamp_format = settings_get_str("timestamp_format");
572 strstr(timestamp_format, "%r") != NULL ||
573 strstr(timestamp_format, "%s") != NULL ||
574 strstr(timestamp_format, "%S") != NULL ||
575 strstr(timestamp_format, "%X") != NULL ||
576 strstr(timestamp_format, "%T") != NULL;
580 void expandos_init(void)
582 #ifdef HAVE_SYS_UTSNAME_H
585 settings_add_str("misc", "STATUS_OPER", "*");
586 settings_add_str("lookandfeel", "timestamp_format", "%H:%M");
587 settings_add_bool("lookandfeel", "chanmode_expando_strip", FALSE);
589 last_sent_msg = NULL; last_sent_msg_body = NULL;
590 last_privmsg_from = NULL; last_public_from = NULL;
593 sysname = sysrelease = sysarch = NULL;
594 #ifdef HAVE_SYS_UTSNAME_H
595 if (uname(&un) >= 0) {
596 sysname = g_strdup(un.sysname);
597 sysrelease = g_strdup(un.release);
598 sysarch = g_strdup(un.machine);
602 memset(char_expandos, 0, sizeof(char_expandos));
603 expandos = g_hash_table_new((GHashFunc) g_str_hash,
604 (GCompareFunc) g_str_equal);
606 expando_create(",", expando_lastmsg,
607 "message private", EXPANDO_ARG_SERVER, NULL);
608 expando_create(".", expando_lastmymsg,
609 "command msg", EXPANDO_ARG_NONE, NULL);
610 expando_create(";", expando_lastpublic,
611 "message public", EXPANDO_ARG_SERVER, NULL);
612 expando_create("A", expando_awaymsg,
613 "away mode changed", EXPANDO_ARG_NONE, NULL);
614 expando_create("B", expando_lastmymsg_body,
615 "command msg", EXPANDO_ARG_NONE, NULL);
616 expando_create("C", expando_channel,
617 "window changed", EXPANDO_ARG_NONE,
618 "window item changed", EXPANDO_ARG_WINDOW, NULL);
619 expando_create("F", expando_clientstarted,
620 "", EXPANDO_NEVER, NULL);
621 expando_create("I", expando_last_invite, NULL);
622 expando_create("J", expando_version,
623 "", EXPANDO_NEVER, NULL);
624 expando_create("K", expando_cmdchars,
625 "setup changed", EXPANDO_ARG_NONE, NULL);
626 expando_create("k", expando_cmdchar,
627 "setup changed", EXPANDO_ARG_NONE, NULL);
628 expando_create("M", expando_chanmode,
629 "window changed", EXPANDO_ARG_NONE,
630 "window item changed", EXPANDO_ARG_WINDOW,
631 "channel mode changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
632 expando_create("N", expando_nick,
633 "window changed", EXPANDO_ARG_NONE,
634 "window connect changed", EXPANDO_ARG_WINDOW,
635 "window server changed", EXPANDO_ARG_WINDOW,
636 "server nick changed", EXPANDO_ARG_SERVER, NULL);
637 expando_create("O", expando_statusoper,
638 "setup changed", EXPANDO_ARG_NONE,
639 "window changed", EXPANDO_ARG_NONE,
640 "window server changed", EXPANDO_ARG_WINDOW,
641 "user mode changed", EXPANDO_ARG_WINDOW, NULL);
642 expando_create("P", expando_chanop,
643 "window changed", EXPANDO_ARG_NONE,
644 "window item changed", EXPANDO_ARG_WINDOW,
645 "nick mode changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
646 expando_create("Q", expando_query,
647 "window changed", EXPANDO_ARG_NONE,
648 "window item changed", EXPANDO_ARG_WINDOW, NULL);
649 expando_create("R", expando_serverversion,
650 "window changed", EXPANDO_ARG_NONE,
651 "window server changed", EXPANDO_ARG_WINDOW, NULL);
652 expando_create("T", expando_target,
653 "window changed", EXPANDO_ARG_NONE,
654 "window item changed", EXPANDO_ARG_WINDOW, NULL);
655 expando_create("V", expando_releasedate,
656 "", EXPANDO_NEVER, NULL);
657 expando_create("versiontime", expando_releasetime,
658 "", EXPANDO_NEVER, NULL);
659 expando_create("W", expando_workdir, NULL);
660 expando_create("Y", expando_realname,
661 "window changed", EXPANDO_ARG_NONE,
662 "window connect changed", EXPANDO_ARG_WINDOW,
663 "window server changed", EXPANDO_ARG_WINDOW, NULL);
664 expando_create("Z", expando_time,
665 "time changed", EXPANDO_ARG_NONE, NULL);
666 expando_create("$", expando_dollar,
667 "", EXPANDO_NEVER, NULL);
669 expando_create("sysname", expando_sysname,
670 "", EXPANDO_NEVER, NULL);
671 expando_create("sysrelease", expando_sysrelease,
672 "", EXPANDO_NEVER, NULL);
673 expando_create("sysarch", expando_sysarch,
674 "", EXPANDO_NEVER, NULL);
675 expando_create("topic", expando_topic,
676 "window changed", EXPANDO_ARG_NONE,
677 "window item changed", EXPANDO_ARG_WINDOW,
678 "channel topic changed", EXPANDO_ARG_WINDOW_ITEM,
679 "query address changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
680 expando_create("tag", expando_servertag,
681 "window changed", EXPANDO_ARG_NONE,
682 "window connect changed", EXPANDO_ARG_WINDOW,
683 "window server changed", EXPANDO_ARG_WINDOW, NULL);
684 expando_create("chatnet", expando_chatnet,
685 "window changed", EXPANDO_ARG_NONE,
686 "window connect changed", EXPANDO_ARG_WINDOW,
687 "window server changed", EXPANDO_ARG_WINDOW, NULL);
688 expando_create("itemname", expando_itemname,
689 "window changed", EXPANDO_ARG_NONE,
690 "window item changed", EXPANDO_ARG_WINDOW,
691 "window item name changed", EXPANDO_ARG_WINDOW_ITEM,
696 timer_tag = g_timeout_add(1000, (GSourceFunc) sig_timer, NULL);
697 signal_add("message public", (SIGNAL_FUNC) sig_message_public);
698 signal_add("message private", (SIGNAL_FUNC) sig_message_private);
699 signal_add("message own_private", (SIGNAL_FUNC) sig_message_own_private);
700 signal_add_first("setup changed", (SIGNAL_FUNC) read_settings);
703 void expandos_deinit(void)
707 for (n = 0; n < sizeof(char_expandos)/sizeof(char_expandos[0]); n++)
708 g_free_not_null(char_expandos[n]);
710 g_hash_table_foreach_remove(expandos, free_expando, NULL);
711 g_hash_table_destroy(expandos);
713 g_free_not_null(last_sent_msg); g_free_not_null(last_sent_msg_body);
714 g_free_not_null(last_privmsg_from); g_free_not_null(last_public_from);
715 g_free_not_null(sysname); g_free_not_null(sysrelease);
716 g_free_not_null(sysarch);
718 g_source_remove(timer_tag);
719 signal_remove("message public", (SIGNAL_FUNC) sig_message_public);
720 signal_remove("message private", (SIGNAL_FUNC) sig_message_private);
721 signal_remove("message own_private", (SIGNAL_FUNC) sig_message_own_private);
722 signal_remove("setup changed", (SIGNAL_FUNC) read_settings);