source: protocols/jabber/jabber.c @ 4a5d885

Last change on this file since 4a5d885 was 4a5d885, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-07-26T11:58:38Z

Working OAuth2 support. Needs some more debugging (error handling is not
great and imc_logout() gets (rightfully) confused when jabber_data is empty).

  • Property mode set to 100644
File size: 17.2 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Jabber module - Main file                                                *
5*                                                                           *
6*  Copyright 2006 Wilmer van der Gaast <wilmer@gaast.net>                   *
7*                                                                           *
8*  This program is free software; you can redistribute it and/or modify     *
9*  it under the terms of the GNU General Public License as published by     *
10*  the Free Software Foundation; either version 2 of the License, or        *
11*  (at your option) any later version.                                      *
12*                                                                           *
13*  This program is distributed in the hope that it will be useful,          *
14*  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
15*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
16*  GNU General Public License for more details.                             *
17*                                                                           *
18*  You should have received a copy of the GNU General Public License along  *
19*  with this program; if not, write to the Free Software Foundation, Inc.,  *
20*  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.              *
21*                                                                           *
22\***************************************************************************/
23
24#include <glib.h>
25#include <string.h>
26#include <unistd.h>
27#include <ctype.h>
28#include <stdio.h>
29
30#include "ssl_client.h"
31#include "xmltree.h"
32#include "bitlbee.h"
33#include "jabber.h"
34#include "md5.h"
35
36GSList *jabber_connections;
37
38/* First enty is the default */
39static const int jabber_port_list[] = {
40        5222,
41        5223,
42        5220,
43        5221,
44        5224,
45        5225,
46        5226,
47        5227,
48        5228,
49        5229,
50        80,
51        443,
52        0
53};
54
55static void jabber_init( account_t *acc )
56{
57        set_t *s;
58        char str[16];
59       
60        s = set_add( &acc->set, "activity_timeout", "600", set_eval_int, acc );
61       
62        s = set_add( &acc->set, "oauth", "false", set_eval_bool, acc );
63
64        g_snprintf( str, sizeof( str ), "%d", jabber_port_list[0] );
65        s = set_add( &acc->set, "port", str, set_eval_int, acc );
66        s->flags |= ACC_SET_OFFLINE_ONLY;
67       
68        s = set_add( &acc->set, "priority", "0", set_eval_priority, acc );
69
70        s = set_add( &acc->set, "proxy", "<local>;<auto>", NULL, acc );
71       
72        s = set_add( &acc->set, "resource", "BitlBee", NULL, acc );
73        s->flags |= ACC_SET_OFFLINE_ONLY;
74       
75        s = set_add( &acc->set, "resource_select", "activity", NULL, acc );
76       
77        s = set_add( &acc->set, "server", NULL, set_eval_account, acc );
78        s->flags |= ACC_SET_NOSAVE | ACC_SET_OFFLINE_ONLY | SET_NULL_OK;
79       
80        s = set_add( &acc->set, "ssl", "false", set_eval_bool, acc );
81        s->flags |= ACC_SET_OFFLINE_ONLY;
82       
83        s = set_add( &acc->set, "tls", "try", set_eval_tls, acc );
84        s->flags |= ACC_SET_OFFLINE_ONLY;
85       
86        s = set_add( &acc->set, "user_agent", "BitlBee", NULL, acc );
87       
88        s = set_add( &acc->set, "xmlconsole", "false", set_eval_bool, acc );
89        s->flags |= ACC_SET_OFFLINE_ONLY;
90       
91        acc->flags |= ACC_FLAG_AWAY_MESSAGE | ACC_FLAG_STATUS_MESSAGE;
92}
93
94static void jabber_generate_id_hash( struct jabber_data *jd );
95
96static void jabber_login( account_t *acc )
97{
98        struct im_connection *ic = imcb_new( acc );
99        struct jabber_data *jd = g_new0( struct jabber_data, 1 );
100        char *s;
101       
102        /* For now this is needed in the _connected() handlers if using
103           GLib event handling, to make sure we're not handling events
104           on dead connections. */
105        jabber_connections = g_slist_prepend( jabber_connections, ic );
106       
107        jd->ic = ic;
108        ic->proto_data = jd;
109       
110        jd->username = g_strdup( acc->user );
111        jd->server = strchr( jd->username, '@' );
112       
113        jd->fd = jd->r_inpa = jd->w_inpa = -1;
114       
115        if( jd->server == NULL )
116        {
117                imcb_error( ic, "Incomplete account name (format it like <username@jabberserver.name>)" );
118                imc_logout( ic, FALSE );
119                return;
120        }
121       
122        /* So don't think of free()ing jd->server.. :-) */
123        *jd->server = 0;
124        jd->server ++;
125       
126        if( ( s = strchr( jd->server, '/' ) ) )
127        {
128                *s = 0;
129                set_setstr( &acc->set, "resource", s + 1 );
130               
131                /* Also remove the /resource from the original variable so we
132                   won't have to do this again every time. */
133                s = strchr( acc->user, '/' );
134                *s = 0;
135        }
136       
137        jd->node_cache = g_hash_table_new_full( g_str_hash, g_str_equal, NULL, jabber_cache_entry_free );
138        jd->buddies = g_hash_table_new( g_str_hash, g_str_equal );
139       
140        if( set_getbool( &acc->set, "oauth" ) )
141        {
142                /* For the first login with OAuth, we have to authenticate via the browser.
143                   For subsequent logins, exchange the refresh token for a valid access
144                   token (even though the last one maybe didn't expire yet). */
145                if( strncmp( acc->pass, "refresh_token=", 14 ) != 0 )
146                        sasl_oauth2_init( ic );
147                else
148                        sasl_oauth2_refresh( ic, acc->pass + 14 );
149        }
150        else
151                jabber_connect( ic );
152}
153
154/* Separate this from jabber_login() so we can do OAuth first if necessary.
155   Putting this in io.c would probably be more correct. */
156void jabber_connect( struct im_connection *ic )
157{
158        account_t *acc = ic->acc;
159        struct jabber_data *jd = ic->proto_data;
160        int i;
161        char *connect_to;
162        struct ns_srv_reply **srvl = NULL, *srv = NULL;
163       
164        /* Figure out the hostname to connect to. */
165        if( acc->server && *acc->server )
166                connect_to = acc->server;
167        else if( ( srvl = srv_lookup( "xmpp-client", "tcp", jd->server ) ) ||
168                 ( srvl = srv_lookup( "jabber-client", "tcp", jd->server ) ) )
169        {
170                /* Find the lowest-priority one. These usually come
171                   back in random/shuffled order. Not looking at
172                   weights etc for now. */
173                srv = *srvl;
174                for( i = 1; srvl[i]; i ++ )
175                        if( srvl[i]->prio < srv->prio )
176                                srv = srvl[i];
177               
178                connect_to = srv->name;
179        }
180        else
181                connect_to = jd->server;
182       
183        imcb_log( ic, "Connecting" );
184       
185        for( i = 0; jabber_port_list[i] > 0; i ++ )
186                if( set_getint( &acc->set, "port" ) == jabber_port_list[i] )
187                        break;
188
189        if( jabber_port_list[i] == 0 )
190        {
191                imcb_log( ic, "Illegal port number" );
192                imc_logout( ic, FALSE );
193                return;
194        }
195       
196        /* For non-SSL connections we can try to use the port # from the SRV
197           reply, but let's not do that when using SSL, SSL usually runs on
198           non-standard ports... */
199        if( set_getbool( &acc->set, "ssl" ) )
200        {
201                jd->ssl = ssl_connect( connect_to, set_getint( &acc->set, "port" ), jabber_connected_ssl, ic );
202                jd->fd = jd->ssl ? ssl_getfd( jd->ssl ) : -1;
203        }
204        else
205        {
206                jd->fd = proxy_connect( connect_to, srv ? srv->port : set_getint( &acc->set, "port" ), jabber_connected_plain, ic );
207        }
208        srv_free( srvl );
209       
210        if( jd->fd == -1 )
211        {
212                imcb_error( ic, "Could not connect to server" );
213                imc_logout( ic, TRUE );
214               
215                return;
216        }
217       
218        if( set_getbool( &acc->set, "xmlconsole" ) )
219        {
220                jd->flags |= JFLAG_XMLCONSOLE;
221                /* Shouldn't really do this at this stage already, maybe. But
222                   I think this shouldn't break anything. */
223                imcb_add_buddy( ic, JABBER_XMLCONSOLE_HANDLE, NULL );
224        }
225       
226        jabber_generate_id_hash( jd );
227}
228
229/* This generates an unfinished md5_state_t variable. Every time we generate
230   an ID, we finish the state by adding a sequence number and take the hash. */
231static void jabber_generate_id_hash( struct jabber_data *jd )
232{
233        md5_byte_t binbuf[4];
234        char *s;
235       
236        md5_init( &jd->cached_id_prefix );
237        md5_append( &jd->cached_id_prefix, (unsigned char *) jd->username, strlen( jd->username ) );
238        md5_append( &jd->cached_id_prefix, (unsigned char *) jd->server, strlen( jd->server ) );
239        s = set_getstr( &jd->ic->acc->set, "resource" );
240        md5_append( &jd->cached_id_prefix, (unsigned char *) s, strlen( s ) );
241        random_bytes( binbuf, 4 );
242        md5_append( &jd->cached_id_prefix, binbuf, 4 );
243}
244
245static void jabber_logout( struct im_connection *ic )
246{
247        struct jabber_data *jd = ic->proto_data;
248       
249        while( jd->filetransfers )
250                imcb_file_canceled( ic, ( ( struct jabber_transfer *) jd->filetransfers->data )->ft, "Logging out" );
251
252        while( jd->streamhosts )
253        {
254                jabber_streamhost_t *sh = jd->streamhosts->data;
255                jd->streamhosts = g_slist_remove( jd->streamhosts, sh );
256                g_free( sh->jid );
257                g_free( sh->host );
258                g_free( sh );
259        }
260
261        if( jd->fd >= 0 )
262                jabber_end_stream( ic );
263       
264        while( ic->groupchats )
265                jabber_chat_free( ic->groupchats->data );
266       
267        if( jd->r_inpa >= 0 )
268                b_event_remove( jd->r_inpa );
269        if( jd->w_inpa >= 0 )
270                b_event_remove( jd->w_inpa );
271       
272        if( jd->ssl )
273                ssl_disconnect( jd->ssl );
274        if( jd->fd >= 0 )
275                closesocket( jd->fd );
276       
277        if( jd->tx_len )
278                g_free( jd->txq );
279       
280        if( jd->node_cache )
281                g_hash_table_destroy( jd->node_cache );
282       
283        jabber_buddy_remove_all( ic );
284       
285        xt_free( jd->xt );
286       
287        g_free( jd->away_message );
288        g_free( jd->username );
289        g_free( jd );
290       
291        jabber_connections = g_slist_remove( jabber_connections, ic );
292}
293
294static int jabber_buddy_msg( struct im_connection *ic, char *who, char *message, int flags )
295{
296        struct jabber_data *jd = ic->proto_data;
297        struct jabber_buddy *bud;
298        struct xt_node *node;
299        char *s;
300        int st;
301       
302        if( g_strcasecmp( who, JABBER_XMLCONSOLE_HANDLE ) == 0 )
303                return jabber_write( ic, message, strlen( message ) );
304       
305        if( g_strcasecmp( who, "jabber_oauth" ) == 0 )
306        {
307                if( sasl_oauth2_get_refresh_token( ic, message ) )
308                {
309                        return 1;
310                }
311                else
312                {
313                        imcb_error( ic, "OAuth failure" );
314                        imc_logout( ic, TRUE );
315                }
316        }
317       
318        if( ( s = strchr( who, '=' ) ) && jabber_chat_by_jid( ic, s + 1 ) )
319                bud = jabber_buddy_by_ext_jid( ic, who, 0 );
320        else
321                bud = jabber_buddy_by_jid( ic, who, GET_BUDDY_BARE_OK );
322       
323        node = xt_new_node( "body", message, NULL );
324        node = jabber_make_packet( "message", "chat", bud ? bud->full_jid : who, node );
325       
326        if( bud && ( jd->flags & JFLAG_WANT_TYPING ) &&
327            ( ( bud->flags & JBFLAG_DOES_XEP85 ) ||
328             !( bud->flags & JBFLAG_PROBED_XEP85 ) ) )
329        {
330                struct xt_node *act;
331               
332                /* If the user likes typing notification and if we don't know
333                   (and didn't probe before) if this resource supports XEP85,
334                   include a probe in this packet now. Also, if we know this
335                   buddy does support XEP85, we have to send this <active/>
336                   tag to tell that the user stopped typing (well, that's what
337                   we guess when s/he pressed Enter...). */
338                act = xt_new_node( "active", NULL, NULL );
339                xt_add_attr( act, "xmlns", XMLNS_CHATSTATES );
340                xt_add_child( node, act );
341               
342                /* Just make sure we do this only once. */
343                bud->flags |= JBFLAG_PROBED_XEP85;
344        }
345       
346        st = jabber_write_packet( ic, node );
347        xt_free_node( node );
348       
349        return st;
350}
351
352static GList *jabber_away_states( struct im_connection *ic )
353{
354        static GList *l = NULL;
355        int i;
356       
357        if( l == NULL )
358                for( i = 0; jabber_away_state_list[i].full_name; i ++ )
359                        l = g_list_append( l, (void*) jabber_away_state_list[i].full_name );
360       
361        return l;
362}
363
364static void jabber_get_info( struct im_connection *ic, char *who )
365{
366        struct jabber_buddy *bud;
367       
368        bud = jabber_buddy_by_jid( ic, who, GET_BUDDY_FIRST );
369       
370        while( bud )
371        {
372                imcb_log( ic, "Buddy %s (%d) information:", bud->full_jid, bud->priority );
373                if( bud->away_state )
374                        imcb_log( ic, "Away state: %s", bud->away_state->full_name );
375                imcb_log( ic, "Status message: %s", bud->away_message ? bud->away_message : "(none)" );
376               
377                bud = bud->next;
378        }
379       
380        jabber_get_vcard( ic, bud ? bud->full_jid : who );
381}
382
383static void jabber_set_away( struct im_connection *ic, char *state_txt, char *message )
384{
385        struct jabber_data *jd = ic->proto_data;
386       
387        /* state_txt == NULL -> Not away.
388           Unknown state -> fall back to the first defined away state. */
389        if( state_txt == NULL )
390                jd->away_state = NULL;
391        else if( ( jd->away_state = jabber_away_state_by_name( state_txt ) ) == NULL )
392                jd->away_state = jabber_away_state_list;
393       
394        g_free( jd->away_message );
395        jd->away_message = ( message && *message ) ? g_strdup( message ) : NULL;
396       
397        presence_send_update( ic );
398}
399
400static void jabber_add_buddy( struct im_connection *ic, char *who, char *group )
401{
402        struct jabber_data *jd = ic->proto_data;
403       
404        if( g_strcasecmp( who, JABBER_XMLCONSOLE_HANDLE ) == 0 )
405        {
406                jd->flags |= JFLAG_XMLCONSOLE;
407                imcb_add_buddy( ic, JABBER_XMLCONSOLE_HANDLE, NULL );
408                return;
409        }
410       
411        if( jabber_add_to_roster( ic, who, NULL, group ) )
412                presence_send_request( ic, who, "subscribe" );
413}
414
415static void jabber_remove_buddy( struct im_connection *ic, char *who, char *group )
416{
417        struct jabber_data *jd = ic->proto_data;
418       
419        if( g_strcasecmp( who, JABBER_XMLCONSOLE_HANDLE ) == 0 )
420        {
421                jd->flags &= ~JFLAG_XMLCONSOLE;
422                /* Not necessary for now. And for now the code isn't too
423                   happy if the buddy is completely gone right after calling
424                   this function already.
425                imcb_remove_buddy( ic, JABBER_XMLCONSOLE_HANDLE, NULL );
426                */
427                return;
428        }
429       
430        /* We should always do this part. Clean up our administration a little bit. */
431        jabber_buddy_remove_bare( ic, who );
432       
433        if( jabber_remove_from_roster( ic, who ) )
434                presence_send_request( ic, who, "unsubscribe" );
435}
436
437static struct groupchat *jabber_chat_join_( struct im_connection *ic, const char *room, const char *nick, const char *password, set_t **sets )
438{
439        if( strchr( room, '@' ) == NULL )
440                imcb_error( ic, "Invalid room name: %s", room );
441        else if( jabber_chat_by_jid( ic, room ) )
442                imcb_error( ic, "Already present in chat `%s'", room );
443        else
444                return jabber_chat_join( ic, room, nick, set_getstr( sets, "password" ) );
445       
446        return NULL;
447}
448
449static void jabber_chat_msg_( struct groupchat *c, char *message, int flags )
450{
451        if( c && message )
452                jabber_chat_msg( c, message, flags );
453}
454
455static void jabber_chat_topic_( struct groupchat *c, char *topic )
456{
457        if( c && topic )
458                jabber_chat_topic( c, topic );
459}
460
461static void jabber_chat_leave_( struct groupchat *c )
462{
463        if( c )
464                jabber_chat_leave( c, NULL );
465}
466
467static void jabber_chat_invite_( struct groupchat *c, char *who, char *msg )
468{
469        struct jabber_chat *jc = c->data;
470        gchar *msg_alt = NULL;
471
472        if( msg == NULL )
473                msg_alt = g_strdup_printf( "%s invited you to %s", c->ic->acc->user, jc->name );
474       
475        if( c && who )
476                jabber_chat_invite( c, who, msg ? msg : msg_alt );
477       
478        g_free( msg_alt );
479}
480
481static void jabber_keepalive( struct im_connection *ic )
482{
483        /* Just any whitespace character is enough as a keepalive for XMPP sessions. */
484        if( !jabber_write( ic, "\n", 1 ) )
485                return;
486       
487        /* This runs the garbage collection every minute, which means every packet
488           is in the cache for about a minute (which should be enough AFAIK). */
489        jabber_cache_clean( ic );
490}
491
492static int jabber_send_typing( struct im_connection *ic, char *who, int typing )
493{
494        struct jabber_data *jd = ic->proto_data;
495        struct jabber_buddy *bud;
496       
497        /* Enable typing notification related code from now. */
498        jd->flags |= JFLAG_WANT_TYPING;
499       
500        if( ( bud = jabber_buddy_by_jid( ic, who, 0 ) ) == NULL )
501        {
502                /* Sending typing notifications to unknown buddies is
503                   unsupported for now. Shouldn't be a problem, I think. */
504                return 0;
505        }
506       
507        if( bud->flags & JBFLAG_DOES_XEP85 )
508        {
509                /* We're only allowed to send this stuff if we know the other
510                   side supports it. */
511               
512                struct xt_node *node;
513                char *type;
514                int st;
515               
516                if( typing & OPT_TYPING )
517                        type = "composing";
518                else if( typing & OPT_THINKING )
519                        type = "paused";
520                else
521                        type = "active";
522               
523                node = xt_new_node( type, NULL, NULL );
524                xt_add_attr( node, "xmlns", XMLNS_CHATSTATES );
525                node = jabber_make_packet( "message", "chat", bud->full_jid, node );
526               
527                st = jabber_write_packet( ic, node );
528                xt_free_node( node );
529               
530                return st;
531        }
532       
533        return 1;
534}
535
536void jabber_chat_add_settings( account_t *acc, set_t **head )
537{
538        /* Meh. Stupid room passwords. Not trying to obfuscate/hide
539           them from the user for now. */
540        set_add( head, "password", NULL, NULL, NULL );
541}
542
543void jabber_chat_free_settings( account_t *acc, set_t **head )
544{
545        set_del( head, "password" );
546}
547
548GList *jabber_buddy_action_list( bee_user_t *bu )
549{
550        static GList *ret = NULL;
551       
552        if( ret == NULL )
553        {
554                static const struct buddy_action ba[2] = {
555                        { "VERSION", "Get client (version) information" },
556                };
557               
558                ret = g_list_prepend( ret, (void*) ba + 0 );
559        }
560       
561        return ret;
562}
563
564void *jabber_buddy_action( struct bee_user *bu, const char *action, char * const args[], void *data )
565{
566        if( g_strcasecmp( action, "VERSION" ) == 0 )
567        {
568                struct jabber_buddy *bud;
569               
570                if( ( bud = jabber_buddy_by_ext_jid( bu->ic, bu->handle, 0 ) ) == NULL )
571                        bud = jabber_buddy_by_jid( bu->ic, bu->handle, GET_BUDDY_FIRST );
572                for( ; bud; bud = bud->next )
573                        jabber_iq_version_send( bu->ic, bud, data );
574        }
575       
576        return NULL;
577}
578
579void jabber_initmodule()
580{
581        struct prpl *ret = g_new0( struct prpl, 1 );
582       
583        ret->name = "jabber";
584        ret->mms = 0;                        /* no limit */
585        ret->login = jabber_login;
586        ret->init = jabber_init;
587        ret->logout = jabber_logout;
588        ret->buddy_msg = jabber_buddy_msg;
589        ret->away_states = jabber_away_states;
590        ret->set_away = jabber_set_away;
591//      ret->set_info = jabber_set_info;
592        ret->get_info = jabber_get_info;
593        ret->add_buddy = jabber_add_buddy;
594        ret->remove_buddy = jabber_remove_buddy;
595        ret->chat_msg = jabber_chat_msg_;
596        ret->chat_topic = jabber_chat_topic_;
597        ret->chat_invite = jabber_chat_invite_;
598        ret->chat_leave = jabber_chat_leave_;
599        ret->chat_join = jabber_chat_join_;
600        ret->chat_add_settings = jabber_chat_add_settings;
601        ret->chat_free_settings = jabber_chat_free_settings;
602        ret->keepalive = jabber_keepalive;
603        ret->send_typing = jabber_send_typing;
604        ret->handle_cmp = g_strcasecmp;
605        ret->transfer_request = jabber_si_transfer_request;
606        ret->buddy_action_list = jabber_buddy_action_list;
607        ret->buddy_action = jabber_buddy_action;
608
609        register_protocol( ret );
610}
Note: See TracBrowser for help on using the repository browser.