source: protocols/nogaim.c @ f6f5eee

Last change on this file since f6f5eee was f6f5eee, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-27T22:04:19Z

Source documentation update, including a short HACKING file.
  • Property mode set to 100644
File size: 16.5 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2010 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., 59 Temple Place,
31  Suite 330, Boston, MA  02111-1307  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        {
100                if (g_strcasecmp(p->name, global.conf->protocols[i]) == 0)
101                        refused = FALSE;
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
110struct prpl *find_protocol(const char *name)
111{
112        GList *gl;
113       
114        for( gl = protocols; gl; gl = gl->next )
115        {
116                struct prpl *proto = gl->data;
117               
118                if( g_strcasecmp( proto->name, name ) == 0 )
119                        return proto;
120        }
121       
122        return NULL;
123}
124
125void nogaim_init()
126{
127        extern void msn_initmodule();
128        extern void oscar_initmodule();
129        extern void byahoo_initmodule();
130        extern void jabber_initmodule();
131        extern void twitter_initmodule();
132        extern void purple_initmodule();
133
134#ifdef WITH_MSN
135        msn_initmodule();
136#endif
137
138#ifdef WITH_OSCAR
139        oscar_initmodule();
140#endif
141       
142#ifdef WITH_YAHOO
143        byahoo_initmodule();
144#endif
145       
146#ifdef WITH_JABBER
147        jabber_initmodule();
148#endif
149
150#ifdef WITH_TWITTER
151        twitter_initmodule();
152#endif
153
154#ifdef WITH_PURPLE
155        purple_initmodule();
156#endif
157
158#ifdef WITH_PLUGINS
159        load_plugins();
160#endif
161}
162
163GSList *get_connections() { return connections; }
164
165struct im_connection *imcb_new( account_t *acc )
166{
167        struct im_connection *ic;
168       
169        ic = g_new0( struct im_connection, 1 );
170       
171        ic->bee = acc->bee;
172        ic->acc = acc;
173        acc->ic = ic;
174       
175        connections = g_slist_append( connections, ic );
176       
177        return( ic );
178}
179
180void imc_free( struct im_connection *ic )
181{
182        account_t *a;
183       
184        /* Destroy the pointer to this connection from the account list */
185        for( a = ic->bee->accounts; a; a = a->next )
186                if( a->ic == ic )
187                {
188                        a->ic = NULL;
189                        break;
190                }
191       
192        connections = g_slist_remove( connections, ic );
193        g_free( ic );
194}
195
196static void serv_got_crap( struct im_connection *ic, char *format, ... )
197{
198        va_list params;
199        char *text;
200        account_t *a;
201       
202        va_start( params, format );
203        text = g_strdup_vprintf( format, params );
204        va_end( params );
205
206        if( ( g_strcasecmp( set_getstr( &ic->bee->set, "strip_html" ), "always" ) == 0 ) ||
207            ( ( ic->flags & OPT_DOES_HTML ) && set_getbool( &ic->bee->set, "strip_html" ) ) )
208                strip_html( text );
209       
210        /* Try to find a different connection on the same protocol. */
211        for( a = ic->bee->accounts; a; a = a->next )
212                if( a->prpl == ic->acc->prpl && a->ic != ic )
213                        break;
214       
215        /* If we found one, include the screenname in the message. */
216        if( a )
217                /* FIXME(wilmer): ui_log callback or so */
218                irc_usermsg( ic->bee->ui_data, "%s(%s) - %s", ic->acc->prpl->name, ic->acc->user, text );
219        else
220                irc_usermsg( ic->bee->ui_data, "%s - %s", ic->acc->prpl->name, text );
221       
222        g_free( text );
223}
224
225void imcb_log( struct im_connection *ic, char *format, ... )
226{
227        va_list params;
228        char *text;
229       
230        va_start( params, format );
231        text = g_strdup_vprintf( format, params );
232        va_end( params );
233       
234        if( ic->flags & OPT_LOGGED_IN )
235                serv_got_crap( ic, "%s", text );
236        else
237                serv_got_crap( ic, "Logging in: %s", text );
238       
239        g_free( text );
240}
241
242void imcb_error( struct im_connection *ic, char *format, ... )
243{
244        va_list params;
245        char *text;
246       
247        va_start( params, format );
248        text = g_strdup_vprintf( format, params );
249        va_end( params );
250       
251        if( ic->flags & OPT_LOGGED_IN )
252                serv_got_crap( ic, "Error: %s", text );
253        else
254                serv_got_crap( ic, "Couldn't log in: %s", text );
255       
256        g_free( text );
257}
258
259static gboolean send_keepalive( gpointer d, gint fd, b_input_condition cond )
260{
261        struct im_connection *ic = d;
262       
263        if( ic->acc->prpl->keepalive )
264                ic->acc->prpl->keepalive( ic );
265       
266        return TRUE;
267}
268
269void imcb_connected( struct im_connection *ic )
270{
271        /* MSN servers sometimes redirect you to a different server and do
272           the whole login sequence again, so these "late" calls to this
273           function should be handled correctly. (IOW, ignored) */
274        if( ic->flags & OPT_LOGGED_IN )
275                return;
276       
277        imcb_log( ic, "Logged in" );
278       
279        ic->keepalive = b_timeout_add( 60000, send_keepalive, ic );
280        ic->flags |= OPT_LOGGED_IN;
281       
282        /* Necessary to send initial presence status, even if we're not away. */
283        imc_away_send_update( ic );
284       
285        /* Apparently we're connected successfully, so reset the
286           exponential backoff timer. */
287        ic->acc->auto_reconnect_delay = 0;
288       
289        if( ic->bee->ui->imc_connected )
290                ic->bee->ui->imc_connected( ic );
291}
292
293gboolean auto_reconnect( gpointer data, gint fd, b_input_condition cond )
294{
295        account_t *a = data;
296       
297        a->reconnect = 0;
298        account_on( a->bee, a );
299       
300        return( FALSE );        /* Only have to run the timeout once */
301}
302
303void cancel_auto_reconnect( account_t *a )
304{
305        b_event_remove( a->reconnect );
306        a->reconnect = 0;
307}
308
309void imc_logout( struct im_connection *ic, int allow_reconnect )
310{
311        bee_t *bee = ic->bee;
312        account_t *a;
313        GSList *l;
314        int delay;
315       
316        /* Nested calls might happen sometimes, this is probably the best
317           place to catch them. */
318        if( ic->flags & OPT_LOGGING_OUT )
319                return;
320        else
321                ic->flags |= OPT_LOGGING_OUT;
322       
323        if( ic->bee->ui->imc_disconnected )
324                ic->bee->ui->imc_disconnected( ic );
325       
326        imcb_log( ic, "Signing off.." );
327       
328        b_event_remove( ic->keepalive );
329        ic->keepalive = 0;
330        ic->acc->prpl->logout( ic );
331        b_event_remove( ic->inpa );
332       
333        g_free( ic->away );
334        ic->away = NULL;
335       
336        for( l = bee->users; l; )
337        {
338                bee_user_t *bu = l->data;
339                GSList *next = l->next;
340               
341                if( bu->ic == ic )
342                        bee_user_free( bee, bu );
343               
344                l = next;
345        }
346       
347        query_del_by_conn( (irc_t*) ic->bee->ui_data, ic );
348       
349        for( a = bee->accounts; a; a = a->next )
350                if( a->ic == ic )
351                        break;
352       
353        if( !a )
354        {
355                /* Uhm... This is very sick. */
356        }
357        else if( allow_reconnect && set_getbool( &bee->set, "auto_reconnect" ) &&
358                 set_getbool( &a->set, "auto_reconnect" ) &&
359                 ( delay = account_reconnect_delay( a ) ) > 0 )
360        {
361                imcb_log( ic, "Reconnecting in %d seconds..", delay );
362                a->reconnect = b_timeout_add( delay * 1000, auto_reconnect, a );
363        }
364       
365        imc_free( ic );
366}
367
368void imcb_ask( struct im_connection *ic, char *msg, void *data,
369               query_callback doit, query_callback dont )
370{
371        query_add( (irc_t *) ic->bee->ui_data, ic, msg, doit, dont, g_free, data );
372}
373
374void imcb_ask_with_free( struct im_connection *ic, char *msg, void *data,
375                         query_callback doit, query_callback dont, query_callback myfree )
376{
377        query_add( (irc_t *) ic->bee->ui_data, ic, msg, doit, dont, myfree, data );
378}
379
380void imcb_add_buddy( struct im_connection *ic, const char *handle, const char *group )
381{
382        bee_user_t *bu;
383        bee_t *bee = ic->bee;
384       
385        if( !( bu = bee_user_by_handle( bee, ic, handle ) ) )
386                bu = bee_user_new( bee, ic, handle, 0 );
387       
388        bu->group = bee_group_by_name( bee, group, TRUE );
389       
390        if( bee->ui->user_group )
391                bee->ui->user_group( bee, bu );
392}
393
394void imcb_rename_buddy( struct im_connection *ic, const char *handle, const char *fullname )
395{
396        bee_t *bee = ic->bee;
397        bee_user_t *bu = bee_user_by_handle( bee, ic, handle );
398       
399        if( !bu || !fullname ) return;
400       
401        if( !bu->fullname || strcmp( bu->fullname, fullname ) != 0 )
402        {
403                g_free( bu->fullname );
404                bu->fullname = g_strdup( fullname );
405               
406                if( bee->ui->user_fullname )
407                        bee->ui->user_fullname( bee, bu );
408        }
409}
410
411void imcb_remove_buddy( struct im_connection *ic, const char *handle, char *group )
412{
413        bee_user_free( ic->bee, bee_user_by_handle( ic->bee, ic, handle ) );
414}
415
416/* Mainly meant for ICQ (and now also for Jabber conferences) to allow IM
417   modules to suggest a nickname for a handle. */
418void imcb_buddy_nick_hint( struct im_connection *ic, const char *handle, const char *nick )
419{
420        bee_t *bee = ic->bee;
421        bee_user_t *bu = bee_user_by_handle( bee, ic, handle );
422       
423        if( !bu || !nick ) return;
424       
425        g_free( bu->nick );
426        bu->nick = g_strdup( nick );
427       
428        if( bee->ui->user_nick_hint )
429                bee->ui->user_nick_hint( bee, bu, nick );
430}
431
432
433struct imcb_ask_cb_data
434{
435        struct im_connection *ic;
436        char *handle;
437};
438
439static void imcb_ask_auth_cb_no( void *data )
440{
441        struct imcb_ask_cb_data *cbd = data;
442       
443        cbd->ic->acc->prpl->auth_deny( cbd->ic, cbd->handle );
444       
445        g_free( cbd->handle );
446        g_free( cbd );
447}
448
449static void imcb_ask_auth_cb_yes( void *data )
450{
451        struct imcb_ask_cb_data *cbd = data;
452       
453        cbd->ic->acc->prpl->auth_allow( cbd->ic, cbd->handle );
454       
455        g_free( cbd->handle );
456        g_free( cbd );
457}
458
459void imcb_ask_auth( struct im_connection *ic, const char *handle, const char *realname )
460{
461        struct imcb_ask_cb_data *data = g_new0( struct imcb_ask_cb_data, 1 );
462        char *s, *realname_ = NULL;
463       
464        if( realname != NULL )
465                realname_ = g_strdup_printf( " (%s)", realname );
466       
467        s = g_strdup_printf( "The user %s%s wants to add you to his/her buddy list.",
468                             handle, realname_ ?: "" );
469       
470        g_free( realname_ );
471       
472        data->ic = ic;
473        data->handle = g_strdup( handle );
474        query_add( (irc_t *) ic->bee->ui_data, ic, s,
475                   imcb_ask_auth_cb_yes, imcb_ask_auth_cb_no, g_free, data );
476}
477
478
479static void imcb_ask_add_cb_no( void *data )
480{
481        g_free( ((struct imcb_ask_cb_data*)data)->handle );
482        g_free( data );
483}
484
485static void imcb_ask_add_cb_yes( void *data )
486{
487        struct imcb_ask_cb_data *cbd = data;
488       
489        cbd->ic->acc->prpl->add_buddy( cbd->ic, cbd->handle, NULL );
490       
491        return imcb_ask_add_cb_no( data );
492}
493
494void imcb_ask_add( struct im_connection *ic, const char *handle, const char *realname )
495{
496        struct imcb_ask_cb_data *data = g_new0( struct imcb_ask_cb_data, 1 );
497        char *s;
498       
499        /* TODO: Make a setting for this! */
500        if( bee_user_by_handle( ic->bee, ic, handle ) != NULL )
501                return;
502       
503        s = g_strdup_printf( "The user %s is not in your buddy list yet. Do you want to add him/her now?", handle );
504       
505        data->ic = ic;
506        data->handle = g_strdup( handle );
507        query_add( (irc_t *) ic->bee->ui_data, ic, s,
508                   imcb_ask_add_cb_yes, imcb_ask_add_cb_no, g_free, data );
509}
510
511struct bee_user *imcb_buddy_by_handle( struct im_connection *ic, const char *handle )
512{
513        return bee_user_by_handle( ic->bee, ic, handle );
514}
515
516/* The plan is to not allow straight calls to prpl functions anymore, but do
517   them all from some wrappers. We'll start to define some down here: */
518
519int imc_chat_msg( struct groupchat *c, char *msg, int flags )
520{
521        char *buf = NULL;
522       
523        if( ( c->ic->flags & OPT_DOES_HTML ) && ( g_strncasecmp( msg, "<html>", 6 ) != 0 ) )
524        {
525                buf = escape_html( msg );
526                msg = buf;
527        }
528       
529        c->ic->acc->prpl->chat_msg( c, msg, flags );
530        g_free( buf );
531       
532        return 1;
533}
534
535static char *imc_away_state_find( GList *gcm, char *away, char **message );
536
537int imc_away_send_update( struct im_connection *ic )
538{
539        char *away, *msg = NULL;
540       
541        if( ic->acc->prpl->away_states == NULL ||
542            ic->acc->prpl->set_away == NULL )
543                return 0;
544       
545        away = set_getstr( &ic->acc->set, "away" ) ?
546             : set_getstr( &ic->bee->set, "away" );
547        if( away && *away )
548        {
549                GList *m = ic->acc->prpl->away_states( ic );
550                msg = ic->acc->flags & ACC_FLAG_AWAY_MESSAGE ? away : NULL;
551                away = imc_away_state_find( m, away, &msg ) ? : m->data;
552        }
553        else if( ic->acc->flags & ACC_FLAG_STATUS_MESSAGE )
554        {
555                away = NULL;
556                msg = set_getstr( &ic->acc->set, "status" ) ?
557                    : set_getstr( &ic->bee->set, "status" );
558        }
559       
560        ic->acc->prpl->set_away( ic, away, msg );
561       
562        return 1;
563}
564
565static char *imc_away_alias_list[8][5] =
566{
567        { "Away from computer", "Away", "Extended away", NULL },
568        { "NA", "N/A", "Not available", NULL },
569        { "Busy", "Do not disturb", "DND", "Occupied", NULL },
570        { "Be right back", "BRB", NULL },
571        { "On the phone", "Phone", "On phone", NULL },
572        { "Out to lunch", "Lunch", "Food", NULL },
573        { "Invisible", "Hidden" },
574        { NULL }
575};
576
577static char *imc_away_state_find( GList *gcm, char *away, char **message )
578{
579        GList *m;
580        int i, j;
581       
582        for( m = gcm; m; m = m->next )
583                if( g_strncasecmp( m->data, away, strlen( m->data ) ) == 0 )
584                {
585                        /* At least the Yahoo! module works better if message
586                           contains no data unless it adds something to what
587                           we have in state already. */
588                        if( strlen( m->data ) == strlen( away ) )
589                                *message = NULL;
590                       
591                        return m->data;
592                }
593       
594        for( i = 0; *imc_away_alias_list[i]; i ++ )
595        {
596                int keep_message;
597               
598                for( j = 0; imc_away_alias_list[i][j]; j ++ )
599                        if( g_strncasecmp( away, imc_away_alias_list[i][j], strlen( imc_away_alias_list[i][j] ) ) == 0 )
600                        {
601                                keep_message = strlen( away ) != strlen( imc_away_alias_list[i][j] );
602                                break;
603                        }
604               
605                if( !imc_away_alias_list[i][j] )        /* If we reach the end, this row */
606                        continue;                       /* is not what we want. Next!    */
607               
608                /* Now find an entry in this row which exists in gcm */
609                for( j = 0; imc_away_alias_list[i][j]; j ++ )
610                {
611                        for( m = gcm; m; m = m->next )
612                                if( g_strcasecmp( imc_away_alias_list[i][j], m->data ) == 0 )
613                                {
614                                        if( !keep_message )
615                                                *message = NULL;
616                                       
617                                        return imc_away_alias_list[i][j];
618                                }
619                }
620               
621                /* No need to look further, apparently this state doesn't
622                   have any good alias for this protocol. */
623                break;
624        }
625       
626        return NULL;
627}
628
629void imc_add_allow( struct im_connection *ic, char *handle )
630{
631        if( g_slist_find_custom( ic->permit, handle, (GCompareFunc) ic->acc->prpl->handle_cmp ) == NULL )
632        {
633                ic->permit = g_slist_prepend( ic->permit, g_strdup( handle ) );
634        }
635       
636        ic->acc->prpl->add_permit( ic, handle );
637}
638
639void imc_rem_allow( struct im_connection *ic, char *handle )
640{
641        GSList *l;
642       
643        if( ( l = g_slist_find_custom( ic->permit, handle, (GCompareFunc) ic->acc->prpl->handle_cmp ) ) )
644        {
645                g_free( l->data );
646                ic->permit = g_slist_delete_link( ic->permit, l );
647        }
648       
649        ic->acc->prpl->rem_permit( ic, handle );
650}
651
652void imc_add_block( struct im_connection *ic, char *handle )
653{
654        if( g_slist_find_custom( ic->deny, handle, (GCompareFunc) ic->acc->prpl->handle_cmp ) == NULL )
655        {
656                ic->deny = g_slist_prepend( ic->deny, g_strdup( handle ) );
657        }
658       
659        ic->acc->prpl->add_deny( ic, handle );
660}
661
662void imc_rem_block( struct im_connection *ic, char *handle )
663{
664        GSList *l;
665       
666        if( ( l = g_slist_find_custom( ic->deny, handle, (GCompareFunc) ic->acc->prpl->handle_cmp ) ) )
667        {
668                g_free( l->data );
669                ic->deny = g_slist_delete_link( ic->deny, l );
670        }
671       
672        ic->acc->prpl->rem_deny( ic, handle );
673}
674
675void imcb_clean_handle( struct im_connection *ic, char *handle )
676{
677        /* Accepts a handle and does whatever is necessary to make it
678           BitlBee-friendly. Currently this means removing everything
679           outside 33-127 (ASCII printable excl spaces), @ (only one
680           is allowed) and ! and : */
681        char out[strlen(handle)+1];
682        int s, d;
683       
684        s = d = 0;
685        while( handle[s] )
686        {
687                if( handle[s] > ' ' && handle[s] != '!' && handle[s] != ':' &&
688                    ( handle[s] & 0x80 ) == 0 )
689                {
690                        if( handle[s] == '@' )
691                        {
692                                /* See if we got an @ already? */
693                                out[d] = 0;
694                                if( strchr( out, '@' ) )
695                                        continue;
696                        }
697                       
698                        out[d++] = handle[s];
699                }
700                s ++;
701        }
702        out[d] = handle[s];
703       
704        strcpy( handle, out );
705}
Note: See TracBrowser for help on using the repository browser.