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
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
28 #include "irssi-version.h"
33 #include "window-item-def.h"
35 #ifdef HAVE_SYS_UTSNAME_H
36 # include <sys/utsname.h>
39 #define MAX_EXPANDO_SIGNALS 10
45 int signal_ids[MAX_EXPANDO_SIGNALS];
46 int signal_args[MAX_EXPANDO_SIGNALS];
51 static EXPANDO_REC *char_expandos[255];
52 static GHashTable *expandos;
53 static time_t client_start_time;
54 static char *last_sent_msg, *last_sent_msg_body;
55 static char *last_privmsg_from, *last_public_from;
56 static char *sysname, *sysrelease, *sysarch;
58 static const char *timestamp_format;
59 static int timestamp_seconds;
60 static time_t last_timestamp;
62 #define CHAR_EXPANDO(chr) \
63 (char_expandos[(int) (unsigned char) chr])
65 /* Create expando - overrides any existing ones. */
66 void expando_create(const char *key, EXPANDO_FUNC func, ...)
72 g_return_if_fail(key != NULL || *key == '\0');
73 g_return_if_fail(func != NULL);
76 rec = g_hash_table_lookup(expandos, key);
78 /* single character expando */
79 rec = CHAR_EXPANDO(*key);
85 rec = g_new0(EXPANDO_REC, 1);
87 g_hash_table_insert(expandos, g_strdup(key), rec);
89 char_expandos[(int) (unsigned char) *key] = rec;
95 while ((signal = (const char *) va_arg(va, const char *)) != NULL)
96 expando_add_signal(key, signal, (int) va_arg(va, int));
100 static EXPANDO_REC *expando_find(const char *key)
103 return g_hash_table_lookup(expandos, key);
105 return CHAR_EXPANDO(*key);
108 /* Add new signal to expando */
109 void expando_add_signal(const char *key, const char *signal, ExpandoArg arg)
113 g_return_if_fail(key != NULL);
114 g_return_if_fail(signal != NULL);
116 rec = expando_find(key);
117 g_return_if_fail(rec != NULL);
119 if (arg == EXPANDO_NEVER) {
120 /* expando changes never */
122 } else if (rec->signals < MAX_EXPANDO_SIGNALS) {
123 g_return_if_fail(rec->signals != -1);
125 rec->signal_ids[rec->signals] = signal_get_uniq_id(signal);
126 rec->signal_args[rec->signals] = arg;
131 /* Destroy expando */
132 void expando_destroy(const char *key, EXPANDO_FUNC func)
137 g_return_if_fail(key != NULL || *key == '\0');
138 g_return_if_fail(func != NULL);
140 if (key[1] == '\0') {
141 /* single character expando */
142 rec = CHAR_EXPANDO(*key);
143 if (rec != NULL && rec->func == func) {
144 char_expandos[(int) (unsigned char) *key] = NULL;
147 } else if (g_hash_table_lookup_extended(expandos, key, &origkey,
148 (gpointer *) &rec)) {
149 if (rec->func == func) {
150 g_hash_table_remove(expandos, key);
157 void expando_bind(const char *key, int funccount, SIGNAL_FUNC *funcs)
163 g_return_if_fail(key != NULL);
164 g_return_if_fail(funccount >= 1);
165 g_return_if_fail(funcs != NULL);
166 g_return_if_fail(funcs[0] != NULL);
168 rec = expando_find(key);
169 g_return_if_fail(rec != NULL);
171 if (rec->signals == 0) {
172 /* it's unknown when this expando changes..
173 check it once in a second */
174 signal_add("expando timer", funcs[EXPANDO_ARG_NONE]);
177 for (n = 0; n < rec->signals; n++) {
178 arg = rec->signal_args[n];
179 func = arg < funccount ? funcs[arg] : NULL;
180 if (func == NULL) func = funcs[EXPANDO_ARG_NONE];
182 signal_add_to_id(MODULE_NAME, 1, rec->signal_ids[n], func);
186 void expando_unbind(const char *key, int funccount, SIGNAL_FUNC *funcs)
192 g_return_if_fail(key != NULL);
193 g_return_if_fail(funccount >= 1);
194 g_return_if_fail(funcs != NULL);
195 g_return_if_fail(funcs[0] != NULL);
197 rec = expando_find(key);
198 g_return_if_fail(rec != NULL);
200 if (rec->signals == 0) {
201 /* it's unknown when this expando changes..
202 check it once in a second */
203 signal_remove("expando timer", funcs[EXPANDO_ARG_NONE]);
206 for (n = 0; n < rec->signals; n++) {
207 arg = rec->signal_args[n];
208 func = arg < funccount ? funcs[arg] : NULL;
209 if (func == NULL) func = funcs[EXPANDO_ARG_NONE];
211 signal_remove_id(rec->signal_ids[n], func);
215 /* Returns [<signal id>, EXPANDO_ARG_xxx, <signal id>, ..., -1] */
216 int *expando_get_signals(const char *key)
222 g_return_val_if_fail(key != NULL, NULL);
224 rec = expando_find(key);
225 if (rec == NULL || rec->signals < 0)
228 if (rec->signals == 0) {
229 /* it's unknown when this expando changes..
230 check it once in a second */
231 signals = g_new(int, 3);
232 signals[0] = signal_get_uniq_id("expando timer");
233 signals[1] = EXPANDO_ARG_NONE;
238 signals = g_new(int, rec->signals*2+1);
239 for (n = 0; n < rec->signals; n++) {
240 signals[n*2] = rec->signal_ids[n];
241 signals[n*2+1] = rec->signal_args[n];
243 signals[rec->signals*2] = -1;
247 EXPANDO_FUNC expando_find_char(char chr)
249 return CHAR_EXPANDO(chr) == NULL ? NULL :
250 CHAR_EXPANDO(chr)->func;
253 EXPANDO_FUNC expando_find_long(const char *key)
255 EXPANDO_REC *rec = g_hash_table_lookup(expandos, key);
256 return rec == NULL ? NULL : rec->func;
259 /* last person who sent you a MSG */
260 static char *expando_lastmsg(SERVER_REC *server, void *item, int *free_ret)
262 return last_privmsg_from;
265 /* last person to whom you sent a MSG */
266 static char *expando_lastmymsg(SERVER_REC *server, void *item, int *free_ret)
268 return last_sent_msg;
271 /* last person to send a public message to a channel you are on */
272 static char *expando_lastpublic(SERVER_REC *server, void *item, int *free_ret)
274 return last_public_from;
277 /* text of your AWAY message, if any */
278 static char *expando_awaymsg(SERVER_REC *server, void *item, int *free_ret)
280 return server == NULL ? "" : server->away_reason;
283 /* body of last MSG you sent */
284 static char *expando_lastmymsg_body(SERVER_REC *server, void *item, int *free_ret)
286 return last_sent_msg_body;
289 /* current channel */
290 static char *expando_channel(SERVER_REC *server, void *item, int *free_ret)
292 return !IS_CHANNEL(item) ? NULL : CHANNEL(item)->name;
295 /* time client was started, $time() format */
296 static char *expando_clientstarted(SERVER_REC *server, void *item, int *free_ret)
299 return g_strdup_printf("%ld", (long) client_start_time);
302 /* channel you were last INVITEd to */
303 static char *expando_last_invite(SERVER_REC *server, void *item, int *free_ret)
305 return server == NULL ? "" : server->last_invite;
308 /* client version text string */
309 static char *expando_version(SERVER_REC *server, void *item, int *free_ret)
311 return IRSSI_VERSION;
314 /* current value of CMDCHARS */
315 static char *expando_cmdchars(SERVER_REC *server, void *item, int *free_ret)
317 return (char *) settings_get_str("cmdchars");
320 /* modes of current channel, if any */
321 static char *expando_chanmode(SERVER_REC *server, void *item, int *free_ret)
323 return !IS_CHANNEL(item) ? NULL : CHANNEL(item)->mode;
326 /* current nickname */
327 static char *expando_nick(SERVER_REC *server, void *item, int *free_ret)
329 return server == NULL ? "" : server->nick;
332 /* value of STATUS_OPER if you are an irc operator */
333 static char *expando_statusoper(SERVER_REC *server, void *item, int *free_ret)
335 return server == NULL || !server->server_operator ? "" :
336 (char *) settings_get_str("STATUS_OPER");
339 /* if you are a channel operator in $C, expands to a '@' */
340 static char *expando_chanop(SERVER_REC *server, void *item, int *free_ret)
342 return IS_CHANNEL(item) && CHANNEL(item)->chanop ? "@" : "";
345 /* nickname of whomever you are QUERYing */
346 static char *expando_query(SERVER_REC *server, void *item, int *free_ret)
348 return !IS_QUERY(item) ? "" : QUERY(item)->name;
351 /* version of current server */
352 static char *expando_serverversion(SERVER_REC *server, void *item, int *free_ret)
354 return server == NULL ? "" : server->version;
357 /* target of current input (channel or QUERY nickname) */
358 static char *expando_target(SERVER_REC *server, void *item, int *free_ret)
360 return item == NULL ? "" : ((WI_ITEM_REC *) item)->name;
363 /* client release date (in YYYYMMDD format) */
364 static char *expando_releasedate(SERVER_REC *server, void *item, int *free_ret)
367 return g_strdup_printf("%d", IRSSI_VERSION_DATE);
370 /* client release time (in HHMM format) */
371 static char *expando_releasetime(SERVER_REC *server, void *item, int *free_ret)
374 return g_strdup_printf("%04d", IRSSI_VERSION_TIME);
377 /* current working directory */
378 static char *expando_workdir(SERVER_REC *server, void *item, int *free_ret)
381 return g_get_current_dir();
384 /* value of REALNAME */
385 static char *expando_realname(SERVER_REC *server, void *item, int *free_ret)
387 return server == NULL ? "" : server->connrec->realname;
390 /* time of day (hh:mm) */
391 static char *expando_time(SERVER_REC *server, void *item, int *free_ret)
398 tm = localtime(&now);
400 if (strftime(str, sizeof(str), timestamp_format, tm) == 0)
404 return g_strdup(str);
408 static char *expando_dollar(SERVER_REC *server, void *item, int *free_ret)
414 static char *expando_sysname(SERVER_REC *server, void *item, int *free_ret)
420 static char *expando_sysrelease(SERVER_REC *server, void *item, int *free_ret)
425 /* system architecture */
426 static char *expando_sysarch(SERVER_REC *server, void *item, int *free_ret)
431 /* Topic of active channel (or address of queried nick) */
432 static char *expando_topic(SERVER_REC *server, void *item, int *free_ret)
434 if (IS_CHANNEL(item))
435 return CHANNEL(item)->topic;
436 if (IS_QUERY(item)) {
437 QUERY_REC *query = QUERY(item);
439 if (query->server_tag == NULL)
443 return query->address == NULL ?
444 g_strdup_printf("(%s)", query->server_tag) :
445 g_strdup_printf("%s (%s)", query->address,
452 static char *expando_servertag(SERVER_REC *server, void *item, int *free_ret)
454 return server == NULL ? "" : server->tag;
458 static char *expando_chatnet(SERVER_REC *server, void *item, int *free_ret)
460 return server == NULL ? "" : server->connrec->chatnet;
463 static void sig_message_public(SERVER_REC *server, const char *msg,
464 const char *nick, const char *address,
467 g_free_not_null(last_public_from);
468 last_public_from = g_strdup(nick);
471 static void sig_message_private(SERVER_REC *server, const char *msg,
472 const char *nick, const char *address)
474 g_free_not_null(last_privmsg_from);
475 last_privmsg_from = g_strdup(nick);
478 static void sig_message_own_private(SERVER_REC *server, const char *msg,
479 const char *target, const char *origtarget)
481 g_return_if_fail(server != NULL);
482 g_return_if_fail(msg != NULL);
484 if (target != NULL) {
485 if (target != last_sent_msg) {
486 g_free_not_null(last_sent_msg);
487 last_sent_msg = g_strdup(target);
489 g_free_not_null(last_sent_msg_body);
490 last_sent_msg_body = g_strdup(msg);
494 static int sig_timer(void)
500 signal_emit("expando timer", 0);
502 /* check if $Z has changed */
504 if (last_timestamp != now) {
505 if (!timestamp_seconds && last_timestamp != 0) {
506 /* assume it changes every minute */
507 tm = localtime(&last_timestamp);
508 last_min = tm->tm_min;
510 tm = localtime(&now);
511 if (tm->tm_min == last_min)
515 signal_emit("time changed", 0);
516 last_timestamp = now;
522 static void read_settings(void)
524 timestamp_format = settings_get_str("timestamp_format");
526 strstr(timestamp_format, "%r") != NULL ||
527 strstr(timestamp_format, "%s") != NULL ||
528 strstr(timestamp_format, "%S") != NULL ||
529 strstr(timestamp_format, "%X") != NULL ||
530 strstr(timestamp_format, "%T") != NULL;
534 void expandos_init(void)
536 #ifdef HAVE_SYS_UTSNAME_H
539 settings_add_str("misc", "STATUS_OPER", "*");
540 settings_add_str("misc", "timestamp_format", "%H:%M");
542 client_start_time = time(NULL);
543 last_sent_msg = NULL; last_sent_msg_body = NULL;
544 last_privmsg_from = NULL; last_public_from = NULL;
547 sysname = sysrelease = sysarch = NULL;
548 #ifdef HAVE_SYS_UTSNAME_H
549 if (uname(&un) >= 0) {
550 sysname = g_strdup(un.sysname);
551 sysrelease = g_strdup(un.release);
552 sysarch = g_strdup(un.machine);
556 memset(char_expandos, 0, sizeof(char_expandos));
557 expandos = g_hash_table_new((GHashFunc) g_str_hash,
558 (GCompareFunc) g_str_equal);
560 expando_create(",", expando_lastmsg,
561 "message private", EXPANDO_ARG_SERVER, NULL);
562 expando_create(".", expando_lastmymsg,
563 "command msg", EXPANDO_ARG_NONE, NULL);
564 expando_create(";", expando_lastpublic,
565 "message public", EXPANDO_ARG_SERVER, NULL);
566 expando_create("A", expando_awaymsg,
567 "away mode changed", EXPANDO_ARG_NONE, NULL);
568 expando_create("B", expando_lastmymsg_body,
569 "command msg", EXPANDO_ARG_NONE, NULL);
570 expando_create("C", expando_channel,
571 "window changed", EXPANDO_ARG_NONE,
572 "window item changed", EXPANDO_ARG_WINDOW, NULL);
573 expando_create("F", expando_clientstarted,
574 "", EXPANDO_NEVER, NULL);
575 expando_create("I", expando_last_invite, NULL);
576 expando_create("J", expando_version,
577 "", EXPANDO_NEVER, NULL);
578 expando_create("K", expando_cmdchars,
579 "setup changed", EXPANDO_ARG_NONE, NULL);
580 expando_create("M", expando_chanmode,
581 "window changed", EXPANDO_ARG_NONE,
582 "window item changed", EXPANDO_ARG_WINDOW,
583 "channel mode changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
584 expando_create("N", expando_nick,
585 "window changed", EXPANDO_ARG_NONE,
586 "window server changed", EXPANDO_ARG_WINDOW,
587 "server nick changed", EXPANDO_ARG_SERVER, NULL);
588 expando_create("O", expando_statusoper,
589 "setup changed", EXPANDO_ARG_NONE,
590 "window changed", EXPANDO_ARG_NONE,
591 "window server changed", EXPANDO_ARG_WINDOW,
592 "user mode changed", EXPANDO_ARG_WINDOW, NULL);
593 expando_create("P", expando_chanop,
594 "window changed", EXPANDO_ARG_NONE,
595 "window item changed", EXPANDO_ARG_WINDOW,
596 "nick mode changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
597 expando_create("Q", expando_query,
598 "window changed", EXPANDO_ARG_NONE,
599 "window item changed", EXPANDO_ARG_WINDOW, NULL);
600 expando_create("R", expando_serverversion,
601 "window changed", EXPANDO_ARG_NONE,
602 "window server changed", EXPANDO_ARG_WINDOW, NULL);
603 expando_create("T", expando_target,
604 "window changed", EXPANDO_ARG_NONE,
605 "window item changed", EXPANDO_ARG_WINDOW, NULL);
606 expando_create("V", expando_releasedate,
607 "", EXPANDO_NEVER, NULL);
608 expando_create("versiontime", expando_releasetime,
609 "", EXPANDO_NEVER, NULL);
610 expando_create("W", expando_workdir, NULL);
611 expando_create("Y", expando_realname,
612 "window changed", EXPANDO_ARG_NONE,
613 "window server changed", EXPANDO_ARG_WINDOW, NULL);
614 expando_create("Z", expando_time,
615 "time changed", EXPANDO_ARG_NONE, NULL);
616 expando_create("$", expando_dollar,
617 "", EXPANDO_NEVER, NULL);
619 expando_create("sysname", expando_sysname,
620 "", EXPANDO_NEVER, NULL);
621 expando_create("sysrelease", expando_sysrelease,
622 "", EXPANDO_NEVER, NULL);
623 expando_create("sysarch", expando_sysarch,
624 "", EXPANDO_NEVER, NULL);
625 expando_create("topic", expando_topic,
626 "window changed", EXPANDO_ARG_NONE,
627 "window item changed", EXPANDO_ARG_WINDOW,
628 "channel topic changed", EXPANDO_ARG_WINDOW_ITEM,
629 "query address changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
630 expando_create("tag", expando_servertag,
631 "window changed", EXPANDO_ARG_NONE,
632 "window server changed", EXPANDO_ARG_WINDOW, NULL);
633 expando_create("chatnet", expando_chatnet,
634 "window changed", EXPANDO_ARG_NONE,
635 "window server changed", EXPANDO_ARG_WINDOW, NULL);
639 timer_tag = g_timeout_add(500, (GSourceFunc) sig_timer, NULL);
640 signal_add("message public", (SIGNAL_FUNC) sig_message_public);
641 signal_add("message private", (SIGNAL_FUNC) sig_message_private);
642 signal_add("message own_private", (SIGNAL_FUNC) sig_message_own_private);
643 signal_add_first("setup changed", (SIGNAL_FUNC) read_settings);
646 void expandos_deinit(void)
650 for (n = 0; n < sizeof(char_expandos)/sizeof(char_expandos[0]); n++)
651 g_free_not_null(char_expandos[n]);
653 expando_destroy("sysname", expando_sysname);
654 expando_destroy("sysrelease", expando_sysrelease);
655 expando_destroy("sysarch", expando_sysarch);
656 expando_destroy("topic", expando_topic);
657 expando_destroy("tag", expando_servertag);
658 expando_destroy("chatnet", expando_chatnet);
660 g_hash_table_destroy(expandos);
662 g_free_not_null(last_sent_msg); g_free_not_null(last_sent_msg_body);
663 g_free_not_null(last_privmsg_from); g_free_not_null(last_public_from);
664 g_free_not_null(sysname); g_free_not_null(sysrelease);
665 g_free_not_null(sysarch);
667 g_source_remove(timer_tag);
668 signal_remove("message public", (SIGNAL_FUNC) sig_message_public);
669 signal_remove("message private", (SIGNAL_FUNC) sig_message_private);
670 signal_remove("message own_private", (SIGNAL_FUNC) sig_message_own_private);
671 signal_remove("setup changed", (SIGNAL_FUNC) read_settings);