source: protocols/nogaim.c @ 80c2f3c

Last change on this file since 80c2f3c was d6e2aa8, checked in by dequis <dx@…>, at 2015-11-09T12:21:46Z

Nuke imcb_clean_handle(), which was merging handles accidentally

Well, just deprecated and turned into a no-op. It was only used for
jabber anonymous MUCs, but this is something the IRC layer must take
care of. It stripped all whitespace, control and non-ascii characters,
breaking utf8 nicks support and accidentally merging contacts whose
cleaned-up handles were the same string.

For example, you could have two users with nicks ' ' and ' ' (one and
two spaces respectively) and imcb_clean_handle() would just merge them
into a single handle, , which makes them look like a single irc user.
The same thing happens with nicks that are entirely made of utf8.

Thanks to schoppenhauer from #bitlbee for reporting this and preparing a
test case channel!

  • Property mode set to 100644
File size: 17.1 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/*
8 * nogaim
9 *
10 * Gaim without gaim - for BitlBee
11 *
12 * This file contains functions called by the Gaim IM-modules. It's written
13 * from scratch for BitlBee and doesn't contain any code from Gaim anymore
14 * (except for the function names).
15 */
16
17/*
18  This program is free software; you can redistribute it and/or modify
19  it under the terms of the GNU General Public License as published by
20  the Free Software Foundation; either version 2 of the License, or
21  (at your option) any later version.
22
23  This program is distributed in the hope that it will be useful,
24  but WITHOUT ANY WARRANTY; without even the implied warranty of
25  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  GNU General Public License for more details.
27
28  You should have received a copy of the GNU General Public License with
29  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
30  if not, write to the Free Software Foundation, Inc., 51 Franklin St.,
31  Fifth Floor, Boston, MA  02110-1301  USA
32*/
33
34#define BITLBEE_CORE
35#include <ctype.h>
36
37#include "nogaim.h"
38
39GSList *connections;
40
41#ifdef WITH_PLUGINS
42gboolean load_plugin(char *path)
43{
44        void (*init_function) (void);
45
46        GModule *mod = g_module_open(path, G_MODULE_BIND_LAZY);
47
48        if (!mod) {
49                log_message(LOGLVL_ERROR, "Can't find `%s', not loading (%s)\n", path, g_module_error());
50                return FALSE;
51        }
52
53        if (!g_module_symbol(mod, "init_plugin", (gpointer *) &init_function)) {
54                log_message(LOGLVL_WARNING, "Can't find function `init_plugin' in `%s'\n", path);
55                return FALSE;
56        }
57
58        init_function();
59
60        return TRUE;
61}
62
63void load_plugins(void)
64{
65        GDir *dir;
66        GError *error = NULL;
67
68        dir = g_dir_open(global.conf->plugindir, 0, &error);
69
70        if (dir) {
71                const gchar *entry;
72                char *path;
73
74                while ((entry = g_dir_read_name(dir))) {
75                        path = g_build_filename(global.conf->plugindir, entry, NULL);
76                        if (!path) {
77                                log_message(LOGLVL_WARNING, "Can't build path for %s\n", entry);
78                                continue;
79                        }
80
81                        load_plugin(path);
82
83                        g_free(path);
84                }
85
86                g_dir_close(dir);
87        }
88}
89#endif
90
91GList *protocols = NULL;
92
93void register_protocol(struct prpl *p)
94{
95        int i;
96        gboolean refused = global.conf->protocols != NULL;
97
98        for (i = 0; global.conf->protocols && global.conf->protocols[i]; i++) {
99                if (g_strcasecmp(p->name, global.conf->protocols[i]) == 0) {
100                        refused = FALSE;
101                }
102        }
103
104        if (refused) {
105                log_message(LOGLVL_WARNING, "Protocol %s disabled\n", p->name);
106        } else {
107                protocols = g_list_append(protocols, p);
108        }
109}
110
111struct prpl *find_protocol(const char *name)
112{
113        GList *gl;
114
115        for (gl = protocols; gl; gl = gl->next) {
116                struct prpl *proto = gl->data;
117
118                if (g_strcasecmp(proto->name, name) == 0) {
119                        return proto;
120                }
121        }
122
123        return NULL;
124}
125
126void nogaim_init()
127{
128        extern void msn_initmodule();
129        extern void oscar_initmodule();
130        extern void byahoo_initmodule();
131        extern void jabber_initmodule();
132        extern void twitter_initmodule();
133        extern void purple_initmodule();
134
135#ifdef WITH_MSN
136        msn_initmodule();
137#endif
138
139#ifdef WITH_OSCAR
140        oscar_initmodule();
141#endif
142
143#ifdef WITH_YAHOO
144        byahoo_initmodule();
145#endif
146
147#ifdef WITH_JABBER
148        jabber_initmodule();
149#endif
150
151#ifdef WITH_TWITTER
152        twitter_initmodule();
153#endif
154
155#ifdef WITH_PURPLE
156        purple_initmodule();
157#endif
158
159#ifdef WITH_PLUGINS
160        load_plugins();
161#endif
162}
163
164GSList *get_connections()
165{
166        return connections;
167}
168
169struct im_connection *imcb_new(account_t *acc)
170{
171        struct im_connection *ic;
172
173        ic = g_new0(struct im_connection, 1);
174
175        ic->bee = acc->bee;
176        ic->acc = acc;
177        acc->ic = ic;
178
179        connections = g_slist_append(connections, ic);
180
181        return(ic);
182}
183
184void imc_free(struct im_connection *ic)
185{
186        account_t *a;
187
188        /* Destroy the pointer to this connection from the account list */
189        for (a = ic->bee->accounts; a; a = a->next) {
190                if (a->ic == ic) {
191                        a->ic = NULL;
192                        break;
193                }
194        }
195
196        connections = g_slist_remove(connections, ic);
197        g_free(ic);
198}
199
200static void serv_got_crap(struct im_connection *ic, char *format, ...)
201{
202        va_list params;
203        char *text;
204        account_t *a;
205
206        va_start(params, format);
207        text = g_strdup_vprintf(format, params);
208        va_end(params);
209
210        if ((g_strcasecmp(set_getstr(&ic->bee->set, "strip_html"), "always") == 0) ||
211            ((ic->flags & OPT_DOES_HTML) && set_getbool(&ic->bee->set, "strip_html"))) {
212                strip_html(text);
213        }
214
215        /* Try to find a different connection on the same protocol. */
216        for (a = ic->bee->accounts; a; a = a->next) {
217                if (a->prpl == ic->acc->prpl && a->ic != ic) {
218                        break;
219                }
220        }
221
222        /* If we found one, include the screenname in the message. */
223        if (a) {
224                /* FIXME(wilmer): ui_log callback or so */
225                irc_rootmsg(ic->bee->ui_data, "%s - %s", ic->acc->tag, text);
226        } else {
227                irc_rootmsg(ic->bee->ui_data, "%s - %s", ic->acc->prpl->name, text);
228        }
229
230        g_free(text);
231}
232
233void imcb_log(struct im_connection *ic, char *format, ...)
234{
235        va_list params;
236        char *text;
237
238        va_start(params, format);
239        text = g_strdup_vprintf(format, params);
240        va_end(params);
241
242        if (ic->flags & OPT_LOGGED_IN) {
243                serv_got_crap(ic, "%s", text);
244        } else {
245                serv_got_crap(ic, "Logging in: %s", text);
246        }
247
248        g_free(text);
249}
250
251void imcb_error(struct im_connection *ic, char *format, ...)
252{
253        va_list params;
254        char *text;
255
256        va_start(params, format);
257        text = g_strdup_vprintf(format, params);
258        va_end(params);
259
260        if (ic->flags & OPT_LOGGED_IN) {
261                serv_got_crap(ic, "Error: %s", text);
262        } else {
263                serv_got_crap(ic, "Login error: %s", text);
264        }
265
266        g_free(text);
267}
268
269static gboolean send_keepalive(gpointer d, gint fd, b_input_condition cond)
270{
271        struct im_connection *ic = d;
272
273        if ((ic->flags & OPT_PONGS) && !(ic->flags & OPT_PONGED)) {
274                /* This protocol is expected to ack keepalives and hasn't
275                   since the last time we were here. */
276                imcb_error(ic, "Connection timeout");
277                imc_logout(ic, TRUE);
278                return FALSE;
279        }
280        ic->flags &= ~OPT_PONGED;
281
282        if (ic->acc->prpl->keepalive) {
283                ic->acc->prpl->keepalive(ic);
284        }
285
286        return TRUE;
287}
288
289void start_keepalives(struct im_connection *ic, int interval)
290{
291        b_event_remove(ic->keepalive);
292        ic->keepalive = b_timeout_add(interval, send_keepalive, ic);
293
294        /* Connecting successfully counts as a first successful pong. */
295        if (ic->flags & OPT_PONGS) {
296                ic->flags |= OPT_PONGED;
297        }
298}
299
300void imcb_connected(struct im_connection *ic)
301{
302        /* MSN servers sometimes redirect you to a different server and do
303           the whole login sequence again, so these "late" calls to this
304           function should be handled correctly. (IOW, ignored) */
305        if (ic->flags & OPT_LOGGED_IN) {
306                return;
307        }
308
309        if (ic->acc->flags & ACC_FLAG_LOCAL) {
310                GHashTableIter nicks;
311                gpointer k, v;
312                g_hash_table_iter_init(&nicks, ic->acc->nicks);
313                while (g_hash_table_iter_next(&nicks, &k, &v)) {
314                        ic->acc->prpl->add_buddy(ic, (char *) k, NULL);
315                }
316        }
317
318        imcb_log(ic, "Logged in");
319
320        ic->flags |= OPT_LOGGED_IN;
321        start_keepalives(ic, 60000);
322
323        /* Necessary to send initial presence status, even if we're not away. */
324        imc_away_send_update(ic);
325
326        /* Apparently we're connected successfully, so reset the
327           exponential backoff timer. */
328        ic->acc->auto_reconnect_delay = 0;
329
330        if (ic->bee->ui->imc_connected) {
331                ic->bee->ui->imc_connected(ic);
332        }
333}
334
335gboolean auto_reconnect(gpointer data, gint fd, b_input_condition cond)
336{
337        account_t *a = data;
338
339        a->reconnect = 0;
340        account_on(a->bee, a);
341
342        return(FALSE);          /* Only have to run the timeout once */
343}
344
345void cancel_auto_reconnect(account_t *a)
346{
347        b_event_remove(a->reconnect);
348        a->reconnect = 0;
349}
350
351void imc_logout(struct im_connection *ic, int allow_reconnect)
352{
353        bee_t *bee = ic->bee;
354        account_t *a;
355        GSList *l;
356        int delay;
357
358        /* Nested calls might happen sometimes, this is probably the best
359           place to catch them. */
360        if (ic->flags & OPT_LOGGING_OUT) {
361                return;
362        } else {
363                ic->flags |= OPT_LOGGING_OUT;
364        }
365
366        if (ic->bee->ui->imc_disconnected) {
367                ic->bee->ui->imc_disconnected(ic);
368        }
369
370        imcb_log(ic, "Signing off..");
371
372        /* TBH I don't remember anymore why I didn't just use ic->acc... */
373        for (a = bee->accounts; a; a = a->next) {
374                if (a->ic == ic) {
375                        break;
376                }
377        }
378
379        if (a && !allow_reconnect && !(ic->flags & OPT_LOGGED_IN) &&
380            set_getbool(&a->set, "oauth")) {
381                /* If this account supports OAuth, we're not logged in yet and
382                   not allowed to retry, assume there were auth issues. Give a
383                   helpful message on what might be necessary to fix this. */
384                imcb_log(ic, "If you're having problems logging in, try re-requesting "
385                         "an OAuth token: account %s set password \"\"", a->tag);
386        }
387
388        for (l = bee->users; l; ) {
389                bee_user_t *bu = l->data;
390                GSList *next = l->next;
391
392                if (bu->ic == ic) {
393                        bee_user_free(bee, bu);
394                }
395
396                l = next;
397        }
398
399        b_event_remove(ic->keepalive);
400        ic->keepalive = 0;
401        ic->acc->prpl->logout(ic);
402        b_event_remove(ic->inpa);
403
404        g_free(ic->away);
405        ic->away = NULL;
406
407        query_del_by_conn((irc_t *) ic->bee->ui_data, ic);
408
409        if (!a) {
410                /* Uhm... This is very sick. */
411        } else if (allow_reconnect && set_getbool(&bee->set, "auto_reconnect") &&
412                   set_getbool(&a->set, "auto_reconnect") &&
413                   (delay = account_reconnect_delay(a)) > 0) {
414                imcb_log(ic, "Reconnecting in %d seconds..", delay);
415                a->reconnect = b_timeout_add(delay * 1000, auto_reconnect, a);
416        }
417
418        imc_free(ic);
419}
420
421void imcb_ask(struct im_connection *ic, char *msg, void *data,
422              query_callback doit, query_callback dont)
423{
424        query_add((irc_t *) ic->bee->ui_data, ic, msg, doit, dont, g_free, data);
425}
426
427void imcb_ask_with_free(struct im_connection *ic, char *msg, void *data,
428                        query_callback doit, query_callback dont, query_callback myfree)
429{
430        query_add((irc_t *) ic->bee->ui_data, ic, msg, doit, dont, myfree, data);
431}
432
433void imcb_add_buddy(struct im_connection *ic, const char *handle, const char *group)
434{
435        bee_user_t *bu;
436        bee_t *bee = ic->bee;
437        bee_group_t *oldg;
438
439        if (!(bu = bee_user_by_handle(bee, ic, handle))) {
440                bu = bee_user_new(bee, ic, handle, 0);
441        }
442
443        oldg = bu->group;
444        bu->group = bee_group_by_name(bee, group, TRUE);
445
446        if (bee->ui->user_group && bu->group != oldg) {
447                bee->ui->user_group(bee, bu);
448        }
449}
450
451void imcb_rename_buddy(struct im_connection *ic, const char *handle, const char *fullname)
452{
453        bee_t *bee = ic->bee;
454        bee_user_t *bu = bee_user_by_handle(bee, ic, handle);
455
456        if (!bu || !fullname) {
457                return;
458        }
459
460        if (!bu->fullname || strcmp(bu->fullname, fullname) != 0) {
461                g_free(bu->fullname);
462                bu->fullname = g_strdup(fullname);
463
464                if (bee->ui->user_fullname) {
465                        bee->ui->user_fullname(bee, bu);
466                }
467        }
468}
469
470void imcb_remove_buddy(struct im_connection *ic, const char *handle, char *group)
471{
472        bee_user_free(ic->bee, bee_user_by_handle(ic->bee, ic, handle));
473}
474
475/* Mainly meant for ICQ (and now also for Jabber conferences) to allow IM
476   modules to suggest a nickname for a handle. */
477void imcb_buddy_nick_hint(struct im_connection *ic, const char *handle, const char *nick)
478{
479        bee_t *bee = ic->bee;
480        bee_user_t *bu = bee_user_by_handle(bee, ic, handle);
481
482        if (!bu || !nick) {
483                return;
484        }
485
486        g_free(bu->nick);
487        bu->nick = g_strdup(nick);
488
489        if (bee->ui->user_nick_hint) {
490                bee->ui->user_nick_hint(bee, bu, nick);
491        }
492}
493
494
495struct imcb_ask_cb_data {
496        struct im_connection *ic;
497        char *handle;
498};
499
500static void imcb_ask_cb_free(void *data)
501{
502        struct imcb_ask_cb_data *cbd = data;
503
504        g_free(cbd->handle);
505        g_free(cbd);
506}
507
508static void imcb_ask_auth_cb_no(void *data)
509{
510        struct imcb_ask_cb_data *cbd = data;
511
512        cbd->ic->acc->prpl->auth_deny(cbd->ic, cbd->handle);
513
514        imcb_ask_cb_free(cbd);
515}
516
517static void imcb_ask_auth_cb_yes(void *data)
518{
519        struct imcb_ask_cb_data *cbd = data;
520
521        cbd->ic->acc->prpl->auth_allow(cbd->ic, cbd->handle);
522
523        imcb_ask_cb_free(cbd);
524}
525
526void imcb_ask_auth(struct im_connection *ic, const char *handle, const char *realname)
527{
528        struct imcb_ask_cb_data *data = g_new0(struct imcb_ask_cb_data, 1);
529        char *s, *realname_ = NULL;
530
531        if (realname != NULL) {
532                realname_ = g_strdup_printf(" (%s)", realname);
533        }
534
535        s = g_strdup_printf("The user %s%s wants to add you to his/her buddy list.",
536                            handle, realname_ ? realname_ : "");
537
538        g_free(realname_);
539
540        data->ic = ic;
541        data->handle = g_strdup(handle);
542        query_add((irc_t *) ic->bee->ui_data, ic, s,
543                  imcb_ask_auth_cb_yes, imcb_ask_auth_cb_no, imcb_ask_cb_free, data);
544
545        g_free(s);
546}
547
548static void imcb_ask_add_cb_yes(void *data)
549{
550        struct imcb_ask_cb_data *cbd = data;
551
552        cbd->ic->acc->prpl->add_buddy(cbd->ic, cbd->handle, NULL);
553
554        imcb_ask_cb_free(data);
555}
556
557void imcb_ask_add(struct im_connection *ic, const char *handle, const char *realname)
558{
559        struct imcb_ask_cb_data *data;
560        char *s;
561
562        /* TODO: Make a setting for this! */
563        if (bee_user_by_handle(ic->bee, ic, handle) != NULL) {
564                return;
565        }
566
567        data = g_new0(struct imcb_ask_cb_data, 1);
568
569        s = g_strdup_printf("The user %s is not in your buddy list yet. Do you want to add him/her now?", handle);
570
571        data->ic = ic;
572        data->handle = g_strdup(handle);
573        query_add((irc_t *) ic->bee->ui_data, ic, s,
574                  imcb_ask_add_cb_yes, imcb_ask_cb_free, imcb_ask_cb_free, data);
575
576        g_free(s);
577}
578
579struct bee_user *imcb_buddy_by_handle(struct im_connection *ic, const char *handle)
580{
581        return bee_user_by_handle(ic->bee, ic, handle);
582}
583
584/* The plan is to not allow straight calls to prpl functions anymore, but do
585   them all from some wrappers. We'll start to define some down here: */
586
587int imc_chat_msg(struct groupchat *c, char *msg, int flags)
588{
589        char *buf = NULL;
590
591        if ((c->ic->flags & OPT_DOES_HTML) && (g_strncasecmp(msg, "<html>", 6) != 0)) {
592                buf = escape_html(msg);
593                msg = buf;
594        }
595
596        c->ic->acc->prpl->chat_msg(c, msg, flags);
597        g_free(buf);
598
599        return 1;
600}
601
602static char *imc_away_state_find(GList *gcm, char *away, char **message);
603
604int imc_away_send_update(struct im_connection *ic)
605{
606        char *away, *msg = NULL;
607
608        if (ic->acc->prpl->away_states == NULL ||
609            ic->acc->prpl->set_away == NULL) {
610                return 0;
611        }
612
613        away = set_getstr(&ic->acc->set, "away") ?
614               : set_getstr(&ic->bee->set, "away");
615        if (away && *away) {
616                GList *m = ic->acc->prpl->away_states(ic);
617                msg = ic->acc->flags & ACC_FLAG_AWAY_MESSAGE ? away : NULL;
618                away = imc_away_state_find(m, away, &msg) ? : m->data;
619        } else if (ic->acc->flags & ACC_FLAG_STATUS_MESSAGE) {
620                away = NULL;
621                msg = set_getstr(&ic->acc->set, "status") ?
622                      : set_getstr(&ic->bee->set, "status");
623        }
624
625        ic->acc->prpl->set_away(ic, away, msg);
626
627        return 1;
628}
629
630static char *imc_away_alias_list[8][5] =
631{
632        { "Away from computer", "Away", "Extended away", NULL },
633        { "NA", "N/A", "Not available", NULL },
634        { "Busy", "Do not disturb", "DND", "Occupied", NULL },
635        { "Be right back", "BRB", NULL },
636        { "On the phone", "Phone", "On phone", NULL },
637        { "Out to lunch", "Lunch", "Food", NULL },
638        { "Invisible", "Hidden" },
639        { NULL }
640};
641
642static char *imc_away_state_find(GList *gcm, char *away, char **message)
643{
644        GList *m;
645        int i, j;
646
647        for (m = gcm; m; m = m->next) {
648                if (g_strncasecmp(m->data, away, strlen(m->data)) == 0) {
649                        /* At least the Yahoo! module works better if message
650                           contains no data unless it adds something to what
651                           we have in state already. */
652                        if (strlen(m->data) == strlen(away)) {
653                                *message = NULL;
654                        }
655
656                        return m->data;
657                }
658        }
659
660        for (i = 0; *imc_away_alias_list[i]; i++) {
661                int keep_message;
662
663                for (j = 0; imc_away_alias_list[i][j]; j++) {
664                        if (g_strncasecmp(away, imc_away_alias_list[i][j], strlen(imc_away_alias_list[i][j])) == 0) {
665                                keep_message = strlen(away) != strlen(imc_away_alias_list[i][j]);
666                                break;
667                        }
668                }
669
670                if (!imc_away_alias_list[i][j]) {       /* If we reach the end, this row */
671                        continue;                       /* is not what we want. Next!    */
672
673                }
674                /* Now find an entry in this row which exists in gcm */
675                for (j = 0; imc_away_alias_list[i][j]; j++) {
676                        for (m = gcm; m; m = m->next) {
677                                if (g_strcasecmp(imc_away_alias_list[i][j], m->data) == 0) {
678                                        if (!keep_message) {
679                                                *message = NULL;
680                                        }
681
682                                        return imc_away_alias_list[i][j];
683                                }
684                        }
685                }
686
687                /* No need to look further, apparently this state doesn't
688                   have any good alias for this protocol. */
689                break;
690        }
691
692        return NULL;
693}
694
695void imc_add_allow(struct im_connection *ic, char *handle)
696{
697        if (g_slist_find_custom(ic->permit, handle, (GCompareFunc) ic->acc->prpl->handle_cmp) == NULL) {
698                ic->permit = g_slist_prepend(ic->permit, g_strdup(handle));
699        }
700
701        ic->acc->prpl->add_permit(ic, handle);
702}
703
704void imc_rem_allow(struct im_connection *ic, char *handle)
705{
706        GSList *l;
707
708        if ((l = g_slist_find_custom(ic->permit, handle, (GCompareFunc) ic->acc->prpl->handle_cmp))) {
709                g_free(l->data);
710                ic->permit = g_slist_delete_link(ic->permit, l);
711        }
712
713        ic->acc->prpl->rem_permit(ic, handle);
714}
715
716void imc_add_block(struct im_connection *ic, char *handle)
717{
718        if (g_slist_find_custom(ic->deny, handle, (GCompareFunc) ic->acc->prpl->handle_cmp) == NULL) {
719                ic->deny = g_slist_prepend(ic->deny, g_strdup(handle));
720        }
721
722        ic->acc->prpl->add_deny(ic, handle);
723}
724
725void imc_rem_block(struct im_connection *ic, char *handle)
726{
727        GSList *l;
728
729        if ((l = g_slist_find_custom(ic->deny, handle, (GCompareFunc) ic->acc->prpl->handle_cmp))) {
730                g_free(l->data);
731                ic->deny = g_slist_delete_link(ic->deny, l);
732        }
733
734        ic->acc->prpl->rem_deny(ic, handle);
735}
736
737/* Deprecated: using this function resulted in merging several handles accidentally
738 * Also the irc layer handles this decently nowadays */
739void imcb_clean_handle(struct im_connection *ic, char *handle)
740{
741}
Note: See TracBrowser for help on using the repository browser.