updates.
[silc.git] / apps / irssi / src / core / expandos.c
1 /*
2  expandos.c : irssi
3
4     Copyright (C) 2000 Timo Sirainen
5
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.
10
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.
15
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
19 */
20
21 #include "module.h"
22 #include "modules.h"
23 #include "signals.h"
24 #include "expandos.h"
25 #include "settings.h"
26 #include "commands.h"
27 #include "misc.h"
28 #include "irssi-version.h"
29
30 #include "servers.h"
31 #include "channels.h"
32 #include "queries.h"
33 #include "window-item-def.h"
34
35 #ifdef HAVE_SYS_UTSNAME_H
36 #  include <sys/utsname.h>
37 #endif
38
39 #define MAX_EXPANDO_SIGNALS 10
40
41 typedef struct {
42         EXPANDO_FUNC func;
43
44         int signals;
45         int signal_ids[MAX_EXPANDO_SIGNALS];
46         int signal_args[MAX_EXPANDO_SIGNALS];
47 } EXPANDO_REC;
48
49 static int timer_tag;
50
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;
57
58 static const char *timestamp_format;
59 static int timestamp_seconds;
60 static time_t last_timestamp;
61
62 #define CHAR_EXPANDO(chr) \
63         (char_expandos[(int) (unsigned char) chr])
64
65 /* Create expando - overrides any existing ones. */
66 void expando_create(const char *key, EXPANDO_FUNC func, ...)
67 {
68         EXPANDO_REC *rec;
69         const char *signal;
70         va_list va;
71
72         g_return_if_fail(key != NULL || *key == '\0');
73         g_return_if_fail(func != NULL);
74
75         if (key[1] != '\0')
76                 rec = g_hash_table_lookup(expandos, key);
77         else {
78                 /* single character expando */
79                 rec = CHAR_EXPANDO(*key);
80         }
81
82         if (rec != NULL)
83                 rec->signals = 0;
84         else {
85                 rec = g_new0(EXPANDO_REC, 1);
86                 if (key[1] != '\0')
87                         g_hash_table_insert(expandos, g_strdup(key), rec);
88                 else
89                         char_expandos[(int) (unsigned char) *key] = rec;
90         }
91
92         rec->func = func;
93
94         va_start(va, func);
95         while ((signal = (const char *) va_arg(va, const char *)) != NULL)
96                expando_add_signal(key, signal, (int) va_arg(va, int));
97         va_end(va);
98 }
99
100 static EXPANDO_REC *expando_find(const char *key)
101 {
102         if (key[1] != '\0')
103                 return g_hash_table_lookup(expandos, key);
104         else
105                 return CHAR_EXPANDO(*key);
106 }
107
108 /* Add new signal to expando */
109 void expando_add_signal(const char *key, const char *signal, ExpandoArg arg)
110 {
111         EXPANDO_REC *rec;
112
113         g_return_if_fail(key != NULL);
114         g_return_if_fail(signal != NULL);
115
116         rec = expando_find(key);
117         g_return_if_fail(rec != NULL);
118
119         if (arg == EXPANDO_NEVER) {
120                 /* expando changes never */
121                 rec->signals = -1;
122         } else if (rec->signals < MAX_EXPANDO_SIGNALS) {
123                 g_return_if_fail(rec->signals != -1);
124
125                 rec->signal_ids[rec->signals] = signal_get_uniq_id(signal);
126                 rec->signal_args[rec->signals] = arg;
127                 rec->signals++;
128         }
129 }
130
131 /* Destroy expando */
132 void expando_destroy(const char *key, EXPANDO_FUNC func)
133 {
134         gpointer origkey;
135         EXPANDO_REC *rec;
136
137         g_return_if_fail(key != NULL || *key == '\0');
138         g_return_if_fail(func != NULL);
139
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;
145                         g_free(rec);
146                 }
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);
151                         g_free(origkey);
152                         g_free(rec);
153                 }
154         }
155 }
156
157 void expando_bind(const char *key, int funccount, SIGNAL_FUNC *funcs)
158 {
159         SIGNAL_FUNC func;
160         EXPANDO_REC *rec;
161         int n, arg;
162
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);
167
168         rec = expando_find(key);
169         g_return_if_fail(rec != NULL);
170
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]);
175         }
176
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];
181
182                 signal_add_full_id(MODULE_NAME, SIGNAL_PRIORITY_DEFAULT,
183                                    rec->signal_ids[n], func, NULL);
184         }
185 }
186
187 void expando_unbind(const char *key, int funccount, SIGNAL_FUNC *funcs)
188 {
189         SIGNAL_FUNC func;
190         EXPANDO_REC *rec;
191         int n, arg;
192
193         g_return_if_fail(key != NULL);
194         g_return_if_fail(funccount >= 1);
195         g_return_if_fail(funcs != NULL);
196         g_return_if_fail(funcs[0] != NULL);
197
198         rec = expando_find(key);
199         g_return_if_fail(rec != NULL);
200
201         if (rec->signals == 0) {
202                 /* it's unknown when this expando changes..
203                    check it once in a second */
204                 signal_remove("expando timer", funcs[EXPANDO_ARG_NONE]);
205         }
206
207         for (n = 0; n < rec->signals; n++) {
208                 arg = rec->signal_args[n];
209                 func = arg < funccount ? funcs[arg] : NULL;
210                 if (func == NULL) func = funcs[EXPANDO_ARG_NONE];
211
212                 signal_remove_id(rec->signal_ids[n], func, NULL);
213         }
214 }
215
216 /* Returns [<signal id>, EXPANDO_ARG_xxx, <signal id>, ..., -1] */
217 int *expando_get_signals(const char *key)
218 {
219         EXPANDO_REC *rec;
220         int *signals;
221         int n;
222
223         g_return_val_if_fail(key != NULL, NULL);
224
225         rec = expando_find(key);
226         if (rec == NULL || rec->signals < 0)
227                 return NULL;
228
229         if (rec->signals == 0) {
230                 /* it's unknown when this expando changes..
231                    check it once in a second */
232                 signals = g_new(int, 3);
233                 signals[0] = signal_get_uniq_id("expando timer");
234                 signals[1] = EXPANDO_ARG_NONE;
235                 signals[2] = -1;
236                 return signals;
237         }
238
239         signals = g_new(int, rec->signals*2+1);
240         for (n = 0; n < rec->signals; n++) {
241                 signals[n*2] = rec->signal_ids[n];
242                 signals[n*2+1] = rec->signal_args[n];
243         }
244         signals[rec->signals*2] = -1;
245         return signals;
246 }
247
248 EXPANDO_FUNC expando_find_char(char chr)
249 {
250         return CHAR_EXPANDO(chr) == NULL ? NULL :
251                 CHAR_EXPANDO(chr)->func;
252 }
253
254 EXPANDO_FUNC expando_find_long(const char *key)
255 {
256         EXPANDO_REC *rec = g_hash_table_lookup(expandos, key);
257         return rec == NULL ? NULL : rec->func;
258 }
259
260 /* last person who sent you a MSG */
261 static char *expando_lastmsg(SERVER_REC *server, void *item, int *free_ret)
262 {
263         return last_privmsg_from;
264 }
265
266 /* last person to whom you sent a MSG */
267 static char *expando_lastmymsg(SERVER_REC *server, void *item, int *free_ret)
268 {
269         return last_sent_msg;
270 }
271
272 /* last person to send a public message to a channel you are on */
273 static char *expando_lastpublic(SERVER_REC *server, void *item, int *free_ret)
274 {
275         return last_public_from;
276 }
277
278 /* text of your AWAY message, if any */
279 static char *expando_awaymsg(SERVER_REC *server, void *item, int *free_ret)
280 {
281         return server == NULL ? "" : server->away_reason;
282 }
283
284 /* body of last MSG you sent */
285 static char *expando_lastmymsg_body(SERVER_REC *server, void *item, int *free_ret)
286 {
287         return last_sent_msg_body;
288 }
289
290 /* current channel */
291 static char *expando_channel(SERVER_REC *server, void *item, int *free_ret)
292 {
293         return !IS_CHANNEL(item) ? NULL : CHANNEL(item)->name;
294 }
295
296 /* time client was started, $time() format */
297 static char *expando_clientstarted(SERVER_REC *server, void *item, int *free_ret)
298 {
299         *free_ret = TRUE;
300         return g_strdup_printf("%ld", (long) client_start_time);
301 }
302
303 /* channel you were last INVITEd to */
304 static char *expando_last_invite(SERVER_REC *server, void *item, int *free_ret)
305 {
306         return server == NULL ? "" : server->last_invite;
307 }
308
309 /* client version text string */
310 static char *expando_version(SERVER_REC *server, void *item, int *free_ret)
311 {
312         return IRSSI_VERSION;
313 }
314
315 /* current value of CMDCHARS */
316 static char *expando_cmdchars(SERVER_REC *server, void *item, int *free_ret)
317 {
318         return (char *) settings_get_str("cmdchars");
319 }
320
321 /* modes of current channel, if any */
322 static char *expando_chanmode(SERVER_REC *server, void *item, int *free_ret)
323 {
324         return !IS_CHANNEL(item) ? NULL : CHANNEL(item)->mode;
325 }
326
327 /* current nickname */
328 static char *expando_nick(SERVER_REC *server, void *item, int *free_ret)
329 {
330         return server == NULL ? "" : server->nick;
331 }
332
333 /* value of STATUS_OPER if you are an irc operator */
334 static char *expando_statusoper(SERVER_REC *server, void *item, int *free_ret)
335 {
336         return server == NULL || !server->server_operator ? "" :
337                 (char *) settings_get_str("STATUS_OPER");
338 }
339
340 /* if you are a channel operator in $C, expands to a '@' */
341 static char *expando_chanop(SERVER_REC *server, void *item, int *free_ret)
342 {
343         return IS_CHANNEL(item) && CHANNEL(item)->chanop ? "@" : "";
344 }
345
346 /* nickname of whomever you are QUERYing */
347 static char *expando_query(SERVER_REC *server, void *item, int *free_ret)
348 {
349         return !IS_QUERY(item) ? "" : QUERY(item)->name;
350 }
351
352 /* version of current server */
353 static char *expando_serverversion(SERVER_REC *server, void *item, int *free_ret)
354 {
355         return server == NULL ? "" : server->version;
356 }
357
358 /* target of current input (channel or QUERY nickname) */
359 static char *expando_target(SERVER_REC *server, void *item, int *free_ret)
360 {
361         return item == NULL ? "" : ((WI_ITEM_REC *) item)->name;
362 }
363
364 /* client release date (in YYYYMMDD format) */
365 static char *expando_releasedate(SERVER_REC *server, void *item, int *free_ret)
366 {
367         *free_ret = TRUE;
368         return g_strdup_printf("%d", IRSSI_VERSION_DATE);
369 }
370
371 /* client release time (in HHMM format) */
372 static char *expando_releasetime(SERVER_REC *server, void *item, int *free_ret)
373 {
374         *free_ret = TRUE;
375         return g_strdup_printf("%04d", IRSSI_VERSION_TIME);
376 }
377
378 /* current working directory */
379 static char *expando_workdir(SERVER_REC *server, void *item, int *free_ret)
380 {
381         *free_ret = TRUE;
382         return g_get_current_dir();
383 }
384
385 /* value of REALNAME */
386 static char *expando_realname(SERVER_REC *server, void *item, int *free_ret)
387 {
388         return server == NULL ? "" : server->connrec->realname;
389 }
390
391 /* time of day (hh:mm) */
392 static char *expando_time(SERVER_REC *server, void *item, int *free_ret)
393 {
394         time_t now;
395         struct tm *tm;
396         char str[256];
397
398         now = time(NULL);
399         tm = localtime(&now);
400
401         if (strftime(str, sizeof(str), timestamp_format, tm) == 0)
402                 return "";
403
404         *free_ret = TRUE;
405         return g_strdup(str);
406 }
407
408 /* a literal '$' */
409 static char *expando_dollar(SERVER_REC *server, void *item, int *free_ret)
410 {
411         return "$";
412 }
413
414 /* system name */
415 static char *expando_sysname(SERVER_REC *server, void *item, int *free_ret)
416 {
417         return sysname;
418 }
419
420 /* system release */
421 static char *expando_sysrelease(SERVER_REC *server, void *item, int *free_ret)
422 {
423         return sysrelease;
424 }
425
426 /* system architecture */
427 static char *expando_sysarch(SERVER_REC *server, void *item, int *free_ret)
428 {
429         return sysarch;
430 }
431
432 /* Topic of active channel (or address of queried nick) */
433 static char *expando_topic(SERVER_REC *server, void *item, int *free_ret)
434 {
435         if (IS_CHANNEL(item))
436                 return CHANNEL(item)->topic;
437         if (IS_QUERY(item)) {
438                 QUERY_REC *query = QUERY(item);
439
440                 if (query->server_tag == NULL)
441                         return "";
442
443                 *free_ret = TRUE;
444                 return query->address == NULL ?
445                         g_strdup_printf("(%s)", query->server_tag) :
446                         g_strdup_printf("%s (%s)", query->address,
447                                         query->server_tag);
448         }
449         return "";
450 }
451
452 /* Server tag */
453 static char *expando_servertag(SERVER_REC *server, void *item, int *free_ret)
454 {
455         return server == NULL ? "" : server->tag;
456 }
457
458 /* Server chatnet */
459 static char *expando_chatnet(SERVER_REC *server, void *item, int *free_ret)
460 {
461         return server == NULL ? "" : server->connrec->chatnet;
462 }
463
464 static void sig_message_public(SERVER_REC *server, const char *msg,
465                                const char *nick, const char *address,
466                                const char *target)
467 {
468         g_free_not_null(last_public_from);
469         last_public_from = g_strdup(nick);
470 }
471
472 static void sig_message_private(SERVER_REC *server, const char *msg,
473                                 const char *nick, const char *address)
474 {
475         g_free_not_null(last_privmsg_from);
476         last_privmsg_from = g_strdup(nick);
477 }
478
479 static void sig_message_own_private(SERVER_REC *server, const char *msg,
480                                     const char *target, const char *origtarget)
481 {
482         g_return_if_fail(server != NULL);
483         g_return_if_fail(msg != NULL);
484
485         if (target != NULL) {
486                 if (target != last_sent_msg) {
487                         g_free_not_null(last_sent_msg);
488                         last_sent_msg = g_strdup(target);
489                 }
490                 g_free_not_null(last_sent_msg_body);
491                 last_sent_msg_body = g_strdup(msg);
492         }
493 }
494
495 static int sig_timer(void)
496 {
497         time_t now;
498         struct tm *tm;
499         int last_min;
500
501         signal_emit("expando timer", 0);
502
503         /* check if $Z has changed */
504         now = time(NULL);
505         if (last_timestamp != now) {
506                 if (!timestamp_seconds && last_timestamp != 0) {
507                         /* assume it changes every minute */
508                         tm = localtime(&last_timestamp);
509                         last_min = tm->tm_min;
510
511                         tm = localtime(&now);
512                         if (tm->tm_min == last_min)
513                                 return 1;
514                 }
515
516                 signal_emit("time changed", 0);
517                 last_timestamp = now;
518         }
519
520         return 1;
521 }
522
523 static void read_settings(void)
524 {
525         timestamp_format = settings_get_str("timestamp_format");
526         timestamp_seconds =
527                 strstr(timestamp_format, "%r") != NULL ||
528                 strstr(timestamp_format, "%s") != NULL ||
529                 strstr(timestamp_format, "%S") != NULL ||
530                 strstr(timestamp_format, "%X") != NULL ||
531                 strstr(timestamp_format, "%T") != NULL;
532
533 }
534
535 void expandos_init(void)
536 {
537 #ifdef HAVE_SYS_UTSNAME_H
538         struct utsname un;
539 #endif
540         settings_add_str("misc", "STATUS_OPER", "*");
541         settings_add_str("lookandfeel", "timestamp_format", "%H:%M");
542
543         client_start_time = time(NULL);
544         last_sent_msg = NULL; last_sent_msg_body = NULL;
545         last_privmsg_from = NULL; last_public_from = NULL;
546         last_timestamp = 0;
547
548         sysname = sysrelease = sysarch = NULL;
549 #ifdef HAVE_SYS_UTSNAME_H
550         if (uname(&un) >= 0) {
551                 sysname = g_strdup(un.sysname);
552                 sysrelease = g_strdup(un.release);
553                 sysarch = g_strdup(un.machine);
554         }
555 #endif
556
557         memset(char_expandos, 0, sizeof(char_expandos));
558         expandos = g_hash_table_new((GHashFunc) g_str_hash,
559                                     (GCompareFunc) g_str_equal);
560
561         expando_create(",", expando_lastmsg,
562                        "message private", EXPANDO_ARG_SERVER, NULL);
563         expando_create(".", expando_lastmymsg,
564                        "command msg", EXPANDO_ARG_NONE, NULL);
565         expando_create(";", expando_lastpublic,
566                        "message public", EXPANDO_ARG_SERVER, NULL);
567         expando_create("A", expando_awaymsg,
568                        "away mode changed", EXPANDO_ARG_NONE, NULL);
569         expando_create("B", expando_lastmymsg_body,
570                        "command msg", EXPANDO_ARG_NONE, NULL);
571         expando_create("C", expando_channel,
572                        "window changed", EXPANDO_ARG_NONE,
573                        "window item changed", EXPANDO_ARG_WINDOW, NULL);
574         expando_create("F", expando_clientstarted,
575                        "", EXPANDO_NEVER, NULL);
576         expando_create("I", expando_last_invite, NULL);
577         expando_create("J", expando_version,
578                        "", EXPANDO_NEVER, NULL);
579         expando_create("K", expando_cmdchars,
580                        "setup changed", EXPANDO_ARG_NONE, NULL);
581         expando_create("M", expando_chanmode,
582                        "window changed", EXPANDO_ARG_NONE,
583                        "window item changed", EXPANDO_ARG_WINDOW,
584                        "channel mode changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
585         expando_create("N", expando_nick,
586                        "window changed", EXPANDO_ARG_NONE,
587                        "window server changed", EXPANDO_ARG_WINDOW,
588                        "server nick changed", EXPANDO_ARG_SERVER, NULL);
589         expando_create("O", expando_statusoper,
590                        "setup changed", EXPANDO_ARG_NONE,
591                        "window changed", EXPANDO_ARG_NONE,
592                        "window server changed", EXPANDO_ARG_WINDOW,
593                        "user mode changed", EXPANDO_ARG_WINDOW, NULL);
594         expando_create("P", expando_chanop,
595                        "window changed", EXPANDO_ARG_NONE,
596                        "window item changed", EXPANDO_ARG_WINDOW,
597                        "nick mode changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
598         expando_create("Q", expando_query,
599                        "window changed", EXPANDO_ARG_NONE,
600                        "window item changed", EXPANDO_ARG_WINDOW, NULL);
601         expando_create("R", expando_serverversion,
602                        "window changed", EXPANDO_ARG_NONE,
603                        "window server changed", EXPANDO_ARG_WINDOW, NULL);
604         expando_create("T", expando_target,
605                        "window changed", EXPANDO_ARG_NONE,
606                        "window item changed", EXPANDO_ARG_WINDOW, NULL);
607         expando_create("V", expando_releasedate,
608                        "", EXPANDO_NEVER, NULL);
609         expando_create("versiontime", expando_releasetime,
610                        "", EXPANDO_NEVER, NULL);
611         expando_create("W", expando_workdir, NULL);
612         expando_create("Y", expando_realname,
613                        "window changed", EXPANDO_ARG_NONE,
614                        "window server changed", EXPANDO_ARG_WINDOW, NULL);
615         expando_create("Z", expando_time,
616                        "time changed", EXPANDO_ARG_NONE, NULL);
617         expando_create("$", expando_dollar,
618                        "", EXPANDO_NEVER, NULL);
619
620         expando_create("sysname", expando_sysname,
621                        "", EXPANDO_NEVER, NULL);
622         expando_create("sysrelease", expando_sysrelease,
623                        "", EXPANDO_NEVER, NULL);
624         expando_create("sysarch", expando_sysarch,
625                        "", EXPANDO_NEVER, NULL);
626         expando_create("topic", expando_topic,
627                        "window changed", EXPANDO_ARG_NONE,
628                        "window item changed", EXPANDO_ARG_WINDOW,
629                        "channel topic changed", EXPANDO_ARG_WINDOW_ITEM,
630                        "query address changed", EXPANDO_ARG_WINDOW_ITEM, NULL);
631         expando_create("tag", expando_servertag,
632                        "window changed", EXPANDO_ARG_NONE,
633                        "window server changed", EXPANDO_ARG_WINDOW, NULL);
634         expando_create("chatnet", expando_chatnet,
635                        "window changed", EXPANDO_ARG_NONE,
636                        "window server changed", EXPANDO_ARG_WINDOW, NULL);
637
638         read_settings();
639
640         timer_tag = g_timeout_add(500, (GSourceFunc) sig_timer, NULL);
641         signal_add("message public", (SIGNAL_FUNC) sig_message_public);
642         signal_add("message private", (SIGNAL_FUNC) sig_message_private);
643         signal_add("message own_private", (SIGNAL_FUNC) sig_message_own_private);
644         signal_add_first("setup changed", (SIGNAL_FUNC) read_settings);
645 }
646
647 void expandos_deinit(void)
648 {
649         int n;
650
651         for (n = 0; n < sizeof(char_expandos)/sizeof(char_expandos[0]); n++)
652                 g_free_not_null(char_expandos[n]);
653
654         expando_destroy("sysname", expando_sysname);
655         expando_destroy("sysrelease", expando_sysrelease);
656         expando_destroy("sysarch", expando_sysarch);
657         expando_destroy("topic", expando_topic);
658         expando_destroy("tag", expando_servertag);
659         expando_destroy("chatnet", expando_chatnet);
660
661         g_hash_table_destroy(expandos);
662
663         g_free_not_null(last_sent_msg); g_free_not_null(last_sent_msg_body);
664         g_free_not_null(last_privmsg_from); g_free_not_null(last_public_from);
665         g_free_not_null(sysname); g_free_not_null(sysrelease);
666         g_free_not_null(sysarch);
667
668         g_source_remove(timer_tag);
669         signal_remove("message public", (SIGNAL_FUNC) sig_message_public);
670         signal_remove("message private", (SIGNAL_FUNC) sig_message_private);
671         signal_remove("message own_private", (SIGNAL_FUNC) sig_message_own_private);
672         signal_remove("setup changed", (SIGNAL_FUNC) read_settings);
673 }