source: irc_send.c @ 9b02bab

Last change on this file since 9b02bab was 80c2f3c, checked in by dequis <dx@…>, at 2015-11-20T15:51:45Z

IRCv3 away-notify capability

Neat lightweight notifications of the awayness of contacts.

In practice, this means weechat/hexchat users can see away people in
their nick list and change show_users to 'online,special,away' to avoid
the mode spam completely.

These are also sent on online/offline changes, since offline_user_quits
can be turned off, and you'd need something when they come back.

  • Property mode set to 100644
File size: 13.3 KB
Line 
1/********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2012 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/* The IRC-based UI - Sending responses to commands/etc.                */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 51 Franklin St.,
23  Fifth Floor, Boston, MA  02110-1301  USA
24*/
25
26#include "bitlbee.h"
27
28void irc_send_num(irc_t *irc, int code, char *format, ...)
29{
30        char text[IRC_MAX_LINE];
31        va_list params;
32
33        va_start(params, format);
34        g_vsnprintf(text, IRC_MAX_LINE, format, params);
35        va_end(params);
36
37        irc_write(irc, ":%s %03d %s %s", irc->root->host, code, irc->user->nick ? : "*", text);
38}
39
40void irc_send_login(irc_t *irc)
41{
42        irc_send_num(irc,   1, ":Welcome to the %s gateway, %s", PACKAGE, irc->user->nick);
43        irc_send_num(irc,   2, ":Host %s is running %s %s %s/%s.", irc->root->host,
44                     PACKAGE, BITLBEE_VERSION, ARCH, CPU);
45        irc_send_num(irc,   3, ":%s", IRCD_INFO);
46        irc_send_num(irc,   4, "%s %s %s %s", irc->root->host, BITLBEE_VERSION, UMODES UMODES_PRIV, CMODES);
47        irc_send_num(irc,   5, "PREFIX=(ohv)@%%+ CHANTYPES=%s CHANMODES=,,,%s NICKLEN=%d CHANNELLEN=%d "
48                     "NETWORK=BitlBee SAFELIST CASEMAPPING=rfc1459 MAXTARGETS=1 WATCH=128 "
49                     "FLOOD=0/9999 :are supported by this server",
50                     CTYPES, CMODES, MAX_NICK_LENGTH - 1, MAX_NICK_LENGTH - 1);
51        irc_send_motd(irc);
52}
53
54void irc_send_motd(irc_t *irc)
55{
56        char motd[2048];
57        ssize_t len;
58        int fd;
59
60        fd = open(global.conf->motdfile, O_RDONLY);
61        if (fd == -1 || (len = read(fd, motd, sizeof(motd) - 1)) <= 0) {
62                irc_send_num(irc, 422, ":We don't need MOTDs.");
63        } else {
64                char linebuf[80];
65                char *add = "", max, *in;
66
67                in = motd;
68                motd[len] = '\0';
69                linebuf[79] = len = 0;
70                max = sizeof(linebuf) - 1;
71
72                irc_send_num(irc, 375, ":- %s Message Of The Day - ", irc->root->host);
73                while ((linebuf[len] = *(in++))) {
74                        if (linebuf[len] == '\n' || len == max) {
75                                linebuf[len] = 0;
76                                irc_send_num(irc, 372, ":- %s", linebuf);
77                                len = 0;
78                        } else if (linebuf[len] == '%') {
79                                linebuf[len] = *(in++);
80                                if (linebuf[len] == 'h') {
81                                        add = irc->root->host;
82                                } else if (linebuf[len] == 'v') {
83                                        add = BITLBEE_VERSION;
84                                } else if (linebuf[len] == 'n') {
85                                        add = irc->user->nick;
86                                } else if (linebuf[len] == '\0') {
87                                        in--;
88                                } else {
89                                        add = "%";
90                                }
91
92                                strncpy(linebuf + len, add, max - len);
93                                while (linebuf[++len]) {
94                                        ;
95                                }
96                        } else if (len < max) {
97                                len++;
98                        }
99                }
100                irc_send_num(irc, 376, ":End of MOTD");
101        }
102
103        if (fd != -1) {
104                close(fd);
105        }
106}
107
108/* Used by some funcs that generate PRIVMSGs to figure out if we're talking to
109   this person in /query or in a control channel. WARNING: callers rely on
110   this returning a pointer at irc->user_nick, not a copy of it. */
111const char *irc_user_msgdest(irc_user_t *iu)
112{
113        irc_t *irc = iu->irc;
114        irc_channel_t *ic = NULL;
115
116        if (iu->last_channel) {
117                if (iu->last_channel->flags & IRC_CHANNEL_JOINED) {
118                        ic = iu->last_channel;
119                } else {
120                        ic = irc_channel_with_user(irc, iu);
121                }
122        }
123
124        if (ic) {
125                return ic->name;
126        } else {
127                return irc->user->nick;
128        }
129}
130
131/* cmd = "PRIVMSG" or "NOTICE" */
132static void irc_usermsg_(const char *cmd, irc_user_t *iu, const char *format, va_list params)
133{
134        char text[2048];
135        const char *dst;
136
137        g_vsnprintf(text, sizeof(text), format, params);
138
139        dst = irc_user_msgdest(iu);
140        irc_send_msg(iu, cmd, dst, text, NULL);
141}
142
143void irc_usermsg(irc_user_t *iu, char *format, ...)
144{
145        va_list params;
146
147        va_start(params, format);
148        irc_usermsg_("PRIVMSG", iu, format, params);
149        va_end(params);
150}
151
152void irc_usernotice(irc_user_t *iu, char *format, ...)
153{
154        va_list params;
155
156        va_start(params, format);
157        irc_usermsg_("NOTICE", iu, format, params);
158        va_end(params);
159}
160
161void irc_rootmsg(irc_t *irc, char *format, ...)
162{
163        va_list params;
164
165        va_start(params, format);
166        irc_usermsg_("PRIVMSG", irc->root, format, params);
167        va_end(params);
168}
169
170void irc_send_join(irc_channel_t *ic, irc_user_t *iu)
171{
172        irc_t *irc = ic->irc;
173
174        if (irc->caps & CAP_EXTENDED_JOIN) {
175                irc_write(irc, ":%s!%s@%s JOIN %s * :%s", iu->nick, iu->user, iu->host, ic->name, iu->fullname);
176        } else {
177                irc_write(irc, ":%s!%s@%s JOIN :%s", iu->nick, iu->user, iu->host, ic->name);
178        }
179
180        if (iu == irc->user) {
181                if (ic->topic && *ic->topic) {
182                        irc_send_topic(ic, FALSE);
183                }
184                irc_send_names(ic);
185        }
186}
187
188void irc_send_part(irc_channel_t *ic, irc_user_t *iu, const char *reason)
189{
190        irc_write(ic->irc, ":%s!%s@%s PART %s :%s", iu->nick, iu->user, iu->host, ic->name, reason ? : "");
191}
192
193void irc_send_quit(irc_user_t *iu, const char *reason)
194{
195        irc_write(iu->irc, ":%s!%s@%s QUIT :%s", iu->nick, iu->user, iu->host, reason ? : "");
196}
197
198void irc_send_kick(irc_channel_t *ic, irc_user_t *iu, irc_user_t *kicker, const char *reason)
199{
200        irc_write(ic->irc, ":%s!%s@%s KICK %s %s :%s", kicker->nick, kicker->user,
201                  kicker->host, ic->name, iu->nick, reason ? : "");
202}
203
204void irc_send_names(irc_channel_t *ic)
205{
206        GSList *l;
207        char namelist[385] = "";
208
209        /* RFCs say there is no error reply allowed on NAMES, so when the
210           channel is invalid, just give an empty reply. */
211        for (l = ic->users; l; l = l->next) {
212                irc_channel_user_t *icu = l->data;
213                irc_user_t *iu = icu->iu;
214
215                if (strlen(namelist) + strlen(iu->nick) > sizeof(namelist) - 4) {
216                        irc_send_num(ic->irc, 353, "= %s :%s", ic->name, namelist);
217                        *namelist = 0;
218                }
219
220                namelist[strlen(namelist) + 1] = '\0';
221                namelist[strlen(namelist)] = irc_channel_user_get_prefix(icu);
222
223                strcat(namelist, iu->nick);
224                strcat(namelist, " ");
225        }
226
227        if (*namelist) {
228                irc_send_num(ic->irc, 353, "= %s :%s", ic->name, namelist);
229        }
230
231        irc_send_num(ic->irc, 366, "%s :End of /NAMES list", ic->name);
232}
233
234void irc_send_topic(irc_channel_t *ic, gboolean topic_change)
235{
236        if (topic_change && ic->topic_who) {
237                irc_write(ic->irc, ":%s TOPIC %s :%s", ic->topic_who,
238                          ic->name, ic->topic && *ic->topic ? ic->topic : "");
239        } else if (ic->topic) {
240                irc_send_num(ic->irc, 332, "%s :%s", ic->name, ic->topic);
241                if (ic->topic_who) {
242                        irc_send_num(ic->irc, 333, "%s %s %d",
243                                     ic->name, ic->topic_who, (int) ic->topic_time);
244                }
245        } else {
246                irc_send_num(ic->irc, 331, "%s :No topic for this channel", ic->name);
247        }
248}
249
250/* msg1 and msg2 are output parameters. If msg2 is non-null, msg1 is guaranteed to be non-null too.
251   The idea is to defer the formatting of "$msg1 ($msg2)" to later calls to avoid a g_strdup_printf() here. */
252static void get_status_message(bee_user_t *bu, char **msg1, char **msg2)
253{
254        *msg1 = NULL;
255        *msg2 = NULL;
256
257        if (!(bu->flags & BEE_USER_ONLINE)) {
258                *msg1 = "User is offline";
259
260        } else if ((bu->status && *bu->status) ||
261                   (bu->status_msg && *bu->status_msg)) {
262
263                if (bu->status && bu->status_msg) {
264                        *msg1 = bu->status;
265                        *msg2 = bu->status_msg;
266                } else {
267                        *msg1 = bu->status ? : bu->status_msg;
268                }
269        }
270
271        if (*msg1 && !**msg1) {
272                *msg1 = (bu->flags & BEE_USER_AWAY) ? "Away" : NULL;
273        }
274}
275
276void irc_send_whois(irc_user_t *iu)
277{
278        irc_t *irc = iu->irc;
279
280        irc_send_num(irc, 311, "%s %s %s * :%s",
281                     iu->nick, iu->user, iu->host, iu->fullname);
282
283        if (iu->bu) {
284                bee_user_t *bu = iu->bu;
285                char *msg1, *msg2;
286                int num;
287
288                irc_send_num(irc, 312, "%s %s.%s :%s network", iu->nick, bu->ic->acc->user,
289                             bu->ic->acc->server && *bu->ic->acc->server ? bu->ic->acc->server : "",
290                             bu->ic->acc->prpl->name);
291
292                num = (bu->flags & BEE_USER_AWAY || !(bu->flags & BEE_USER_ONLINE)) ? 301 : 320;
293
294                get_status_message(bu, &msg1, &msg2);
295
296                if (msg1 && msg2) {
297                        irc_send_num(irc, num, "%s :%s (%s)", iu->nick, msg1, msg2);
298                } else if (msg1) {
299                        irc_send_num(irc, num, "%s :%s", iu->nick, msg1);
300                }
301
302                if (bu->idle_time || bu->login_time) {
303                        irc_send_num(irc, 317, "%s %d %d :seconds idle, signon time",
304                                     iu->nick,
305                                     bu->idle_time ? (int) (time(NULL) - bu->idle_time) : 0,
306                                     (int) bu->login_time);
307                }
308        } else {
309                irc_send_num(irc, 312, "%s %s :%s", iu->nick, irc->root->host, IRCD_INFO);
310        }
311
312        irc_send_num(irc, 318, "%s :End of /WHOIS list", iu->nick);
313}
314
315void irc_send_who(irc_t *irc, GSList *l, const char *channel)
316{
317        gboolean is_channel = strchr(CTYPES, channel[0]) != NULL;
318
319        while (l) {
320                irc_user_t *iu;
321
322                /* Null terminated string with three chars, respectively:
323                 * { <H|G>, <@|%|+|\0>, \0 } */
324                char status_prefix[3] = {0};
325
326                if (is_channel) {
327                        irc_channel_user_t *icu = l->data;
328                        status_prefix[1] = irc_channel_user_get_prefix(icu);
329                        iu = icu->iu;
330                } else {
331                        iu = l->data;
332                }
333
334                /* rfc1459 doesn't mention this: G means gone, H means here */
335                status_prefix[0] = iu->flags & IRC_USER_AWAY ? 'G' : 'H';
336
337                irc_send_num(irc, 352, "%s %s %s %s %s %s :0 %s",
338                             is_channel ? channel : "*", iu->user, iu->host, irc->root->host,
339                             iu->nick, status_prefix, iu->fullname);
340                l = l->next;
341        }
342
343        irc_send_num(irc, 315, "%s :End of /WHO list", channel);
344}
345
346void irc_send_msg(irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix)
347{
348        char last = 0;
349        const char *s = msg, *line = msg;
350        char raw_msg[strlen(msg) + 1024];
351
352        while (!last) {
353                if (*s == '\r' && *(s + 1) == '\n') {
354                        s++;
355                }
356                if (*s == '\n') {
357                        last = s[1] == 0;
358                } else {
359                        last = s[0] == 0;
360                }
361                if (*s == 0 || *s == '\n') {
362                        if (g_strncasecmp(line, "/me ", 4) == 0 && (!prefix || !*prefix) &&
363                            g_strcasecmp(type, "PRIVMSG") == 0) {
364                                strcpy(raw_msg, "\001ACTION ");
365                                strncat(raw_msg, line + 4, s - line - 4);
366                                strcat(raw_msg, "\001");
367                                irc_send_msg_raw(iu, type, dst, raw_msg);
368                        } else {
369                                *raw_msg = '\0';
370                                if (prefix && *prefix) {
371                                        strcpy(raw_msg, prefix);
372                                }
373                                strncat(raw_msg, line, s - line);
374                                irc_send_msg_raw(iu, type, dst, raw_msg);
375                        }
376                        line = s + 1;
377                }
378                s++;
379        }
380}
381
382void irc_send_msg_raw(irc_user_t *iu, const char *type, const char *dst, const char *msg)
383{
384        irc_write(iu->irc, ":%s!%s@%s %s %s :%s",
385                  iu->nick, iu->user, iu->host, type, dst, msg && *msg ? msg : " ");
386}
387
388void irc_send_msg_f(irc_user_t *iu, const char *type, const char *dst, const char *format, ...)
389{
390        char text[IRC_MAX_LINE];
391        va_list params;
392
393        va_start(params, format);
394        g_vsnprintf(text, IRC_MAX_LINE, format, params);
395        va_end(params);
396
397        irc_write(iu->irc, ":%s!%s@%s %s %s :%s",
398                  iu->nick, iu->user, iu->host, type, dst, text);
399}
400
401void irc_send_nick(irc_user_t *iu, const char *new)
402{
403        irc_write(iu->irc, ":%s!%s@%s NICK %s",
404                  iu->nick, iu->user, iu->host, new);
405}
406
407/* Send an update of a user's mode inside a channel, compared to what it was. */
408void irc_send_channel_user_mode_diff(irc_channel_t *ic, irc_user_t *iu,
409                                     irc_channel_user_flags_t old, irc_channel_user_flags_t new)
410{
411        char changes[3 * (5 + strlen(iu->nick))];
412        char from[strlen(ic->irc->root->nick) + strlen(ic->irc->root->user) + strlen(ic->irc->root->host) + 3];
413        int n;
414
415        *changes = '\0'; n = 0;
416        if ((old & IRC_CHANNEL_USER_OP) != (new & IRC_CHANNEL_USER_OP)) {
417                n++;
418                if (new & IRC_CHANNEL_USER_OP) {
419                        strcat(changes, "+o");
420                } else {
421                        strcat(changes, "-o");
422                }
423        }
424        if ((old & IRC_CHANNEL_USER_HALFOP) != (new & IRC_CHANNEL_USER_HALFOP)) {
425                n++;
426                if (new & IRC_CHANNEL_USER_HALFOP) {
427                        strcat(changes, "+h");
428                } else {
429                        strcat(changes, "-h");
430                }
431        }
432        if ((old & IRC_CHANNEL_USER_VOICE) != (new & IRC_CHANNEL_USER_VOICE)) {
433                n++;
434                if (new & IRC_CHANNEL_USER_VOICE) {
435                        strcat(changes, "+v");
436                } else {
437                        strcat(changes, "-v");
438                }
439        }
440        while (n) {
441                strcat(changes, " ");
442                strcat(changes, iu->nick);
443                n--;
444        }
445
446        if (set_getbool(&ic->irc->b->set, "simulate_netsplit")) {
447                g_snprintf(from, sizeof(from), "%s", ic->irc->root->host);
448        } else {
449                g_snprintf(from, sizeof(from), "%s!%s@%s", ic->irc->root->nick,
450                           ic->irc->root->user, ic->irc->root->host);
451        }
452
453        if (*changes) {
454                irc_write(ic->irc, ":%s MODE %s %s", from, ic->name, changes);
455        }
456}
457
458void irc_send_invite(irc_user_t *iu, irc_channel_t *ic)
459{
460        irc_t *irc = iu->irc;
461
462        irc_write(iu->irc, ":%s!%s@%s INVITE %s :%s",
463                  iu->nick, iu->user, iu->host, irc->user->nick, ic->name);
464}
465
466void irc_send_cap(irc_t *irc, char *subcommand, char *body)
467{
468        char *nick = irc->user->nick ? : "*";
469
470        irc_write(irc, ":%s CAP %s %s :%s", irc->root->host, nick, subcommand, body);
471}
472
473void irc_send_away_notify(irc_user_t *iu)
474{
475        bee_user_t *bu = iu->bu;
476
477        if (!bu) {
478                return;
479        }
480
481        if (bu->flags & BEE_USER_AWAY || !(bu->flags & BEE_USER_ONLINE)) {
482                char *msg1, *msg2;
483
484                get_status_message(bu, &msg1, &msg2);
485
486                if (msg2) {
487                        irc_write(iu->irc, ":%s!%s@%s AWAY :%s (%s)", iu->nick, iu->user, iu->host, msg1, msg2);
488                } else {
489                        irc_write(iu->irc, ":%s!%s@%s AWAY :%s", iu->nick, iu->user, iu->host, msg1);
490                }
491        } else {
492                irc_write(iu->irc, ":%s!%s@%s AWAY", iu->nick, iu->user, iu->host);
493        }
494}
495
Note: See TracBrowser for help on using the repository browser.