source: protocols/jabber/jabber.c @ 08e5bb2

Last change on this file since 08e5bb2 was 76c85b4c, checked in by Wilmer van der Gaast <wilmer@…>, at 2009-11-19T13:11:38Z

resource_select now defaults to activity instead of priority. Also, adding
a activity_timeout setting. Now, messages to someone who hasn't spoken for
a while will be sent to his/her bare JID, usually resulting in a broadcast.
This should fix issues with messages sometimes arriving on someone's
Crackberry/Android/etc instead of some place s/he's paying attention to.
Last, the activity timer is only reset on incoming messages.

  • Property mode set to 100644
File size: 15.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        g_snprintf( str, sizeof( str ), "%d", jabber_port_list[0] );
63        s = set_add( &acc->set, "port", str, set_eval_int, acc );
64        s->flags |= ACC_SET_OFFLINE_ONLY;
65       
66        s = set_add( &acc->set, "priority", "0", set_eval_priority, acc );
67       
68        s = set_add( &acc->set, "resource", "BitlBee", NULL, acc );
69        s->flags |= ACC_SET_OFFLINE_ONLY;
70       
71        s = set_add( &acc->set, "resource_select", "activity", NULL, acc );
72       
73        s = set_add( &acc->set, "server", NULL, set_eval_account, acc );
74        s->flags |= ACC_SET_NOSAVE | ACC_SET_OFFLINE_ONLY | SET_NULL_OK;
75       
76        s = set_add( &acc->set, "ssl", "false", set_eval_bool, acc );
77        s->flags |= ACC_SET_OFFLINE_ONLY;
78       
79        s = set_add( &acc->set, "tls", "try", set_eval_tls, acc );
80        s->flags |= ACC_SET_OFFLINE_ONLY;
81       
82        s = set_add( &acc->set, "xmlconsole", "false", set_eval_bool, acc );
83        s->flags |= ACC_SET_OFFLINE_ONLY;
84}
85
86static void jabber_generate_id_hash( struct jabber_data *jd );
87
88static void jabber_login( account_t *acc )
89{
90        struct im_connection *ic = imcb_new( acc );
91        struct jabber_data *jd = g_new0( struct jabber_data, 1 );
92        struct ns_srv_reply *srv = NULL;
93        char *connect_to, *s;
94        int i;
95       
96        /* For now this is needed in the _connected() handlers if using
97           GLib event handling, to make sure we're not handling events
98           on dead connections. */
99        jabber_connections = g_slist_prepend( jabber_connections, ic );
100       
101        jd->ic = ic;
102        ic->proto_data = jd;
103       
104        jd->username = g_strdup( acc->user );
105        jd->server = strchr( jd->username, '@' );
106       
107        jd->fd = jd->r_inpa = jd->w_inpa = -1;
108       
109        if( jd->server == NULL )
110        {
111                imcb_error( ic, "Incomplete account name (format it like <username@jabberserver.name>)" );
112                imc_logout( ic, FALSE );
113                return;
114        }
115       
116        /* So don't think of free()ing jd->server.. :-) */
117        *jd->server = 0;
118        jd->server ++;
119       
120        if( ( s = strchr( jd->server, '/' ) ) )
121        {
122                *s = 0;
123                set_setstr( &acc->set, "resource", s + 1 );
124               
125                /* Also remove the /resource from the original variable so we
126                   won't have to do this again every time. */
127                s = strchr( acc->user, '/' );
128                *s = 0;
129        }
130       
131        /* This code isn't really pretty. Backwards compatibility never is... */
132        s = acc->server;
133        while( s )
134        {
135                static int had_port = 0;
136               
137                if( strncmp( s, "ssl", 3 ) == 0 )
138                {
139                        set_setstr( &acc->set, "ssl", "true" );
140                       
141                        /* Flush this part so that (if this was the first
142                           part of the server string) acc->server gets
143                           flushed. We don't want to have to do this another
144                           time. :-) */
145                        *s = 0;
146                        s ++;
147                       
148                        /* Only set this if the user didn't specify a custom
149                           port number already... */
150                        if( !had_port )
151                                set_setint( &acc->set, "port", 5223 );
152                }
153                else if( isdigit( *s ) )
154                {
155                        int i;
156                       
157                        /* The first character is a digit. It could be an
158                           IP address though. Only accept this as a port#
159                           if there are only digits. */
160                        for( i = 0; isdigit( s[i] ); i ++ );
161                       
162                        /* If the first non-digit character is a colon or
163                           the end of the string, save the port number
164                           where it should be. */
165                        if( s[i] == ':' || s[i] == 0 )
166                        {
167                                sscanf( s, "%d", &i );
168                                set_setint( &acc->set, "port", i );
169                               
170                                /* See above. */
171                                *s = 0;
172                                s ++;
173                        }
174                       
175                        had_port = 1;
176                }
177               
178                s = strchr( s, ':' );
179                if( s )
180                {
181                        *s = 0;
182                        s ++;
183                }
184        }
185       
186        jd->node_cache = g_hash_table_new_full( g_str_hash, g_str_equal, NULL, jabber_cache_entry_free );
187        jd->buddies = g_hash_table_new( g_str_hash, g_str_equal );
188       
189        /* Figure out the hostname to connect to. */
190        if( acc->server && *acc->server )
191                connect_to = acc->server;
192        else if( ( srv = srv_lookup( "xmpp-client", "tcp", jd->server ) ) ||
193                 ( srv = srv_lookup( "jabber-client", "tcp", jd->server ) ) )
194                connect_to = srv->name;
195        else
196                connect_to = jd->server;
197       
198        imcb_log( ic, "Connecting" );
199       
200        for( i = 0; jabber_port_list[i] > 0; i ++ )
201                if( set_getint( &acc->set, "port" ) == jabber_port_list[i] )
202                        break;
203
204        if( jabber_port_list[i] == 0 )
205        {
206                imcb_log( ic, "Illegal port number" );
207                imc_logout( ic, FALSE );
208                return;
209        }
210       
211        /* For non-SSL connections we can try to use the port # from the SRV
212           reply, but let's not do that when using SSL, SSL usually runs on
213           non-standard ports... */
214        if( set_getbool( &acc->set, "ssl" ) )
215        {
216                jd->ssl = ssl_connect( connect_to, set_getint( &acc->set, "port" ), jabber_connected_ssl, ic );
217                jd->fd = jd->ssl ? ssl_getfd( jd->ssl ) : -1;
218        }
219        else
220        {
221                jd->fd = proxy_connect( connect_to, srv ? srv->port : set_getint( &acc->set, "port" ), jabber_connected_plain, ic );
222        }
223        g_free( srv );
224       
225        if( jd->fd == -1 )
226        {
227                imcb_error( ic, "Could not connect to server" );
228                imc_logout( ic, TRUE );
229               
230                return;
231        }
232       
233        if( set_getbool( &acc->set, "xmlconsole" ) )
234        {
235                jd->flags |= JFLAG_XMLCONSOLE;
236                /* Shouldn't really do this at this stage already, maybe. But
237                   I think this shouldn't break anything. */
238                imcb_add_buddy( ic, JABBER_XMLCONSOLE_HANDLE, NULL );
239        }
240       
241        jabber_generate_id_hash( jd );
242}
243
244/* This generates an unfinished md5_state_t variable. Every time we generate
245   an ID, we finish the state by adding a sequence number and take the hash. */
246static void jabber_generate_id_hash( struct jabber_data *jd )
247{
248        md5_byte_t binbuf[4];
249        char *s;
250       
251        md5_init( &jd->cached_id_prefix );
252        md5_append( &jd->cached_id_prefix, (unsigned char *) jd->username, strlen( jd->username ) );
253        md5_append( &jd->cached_id_prefix, (unsigned char *) jd->server, strlen( jd->server ) );
254        s = set_getstr( &jd->ic->acc->set, "resource" );
255        md5_append( &jd->cached_id_prefix, (unsigned char *) s, strlen( s ) );
256        random_bytes( binbuf, 4 );
257        md5_append( &jd->cached_id_prefix, binbuf, 4 );
258}
259
260static void jabber_logout( struct im_connection *ic )
261{
262        struct jabber_data *jd = ic->proto_data;
263       
264        if( jd->fd >= 0 )
265                jabber_end_stream( ic );
266       
267        while( ic->groupchats )
268                jabber_chat_free( ic->groupchats );
269       
270        if( jd->r_inpa >= 0 )
271                b_event_remove( jd->r_inpa );
272        if( jd->w_inpa >= 0 )
273                b_event_remove( jd->w_inpa );
274       
275        if( jd->ssl )
276                ssl_disconnect( jd->ssl );
277        if( jd->fd >= 0 )
278                closesocket( jd->fd );
279       
280        if( jd->tx_len )
281                g_free( jd->txq );
282       
283        if( jd->node_cache )
284                g_hash_table_destroy( jd->node_cache );
285       
286        xt_free( jd->xt );
287       
288        g_free( jd->away_message );
289        g_free( jd->username );
290        g_free( jd );
291       
292        jabber_connections = g_slist_remove( jabber_connections, ic );
293}
294
295static int jabber_buddy_msg( struct im_connection *ic, char *who, char *message, int flags )
296{
297        struct jabber_data *jd = ic->proto_data;
298        struct jabber_buddy *bud;
299        struct xt_node *node;
300        char *s;
301        int st;
302       
303        if( g_strcasecmp( who, JABBER_XMLCONSOLE_HANDLE ) == 0 )
304                return jabber_write( ic, message, strlen( message ) );
305       
306        if( ( s = strchr( who, '=' ) ) && jabber_chat_by_jid( ic, s + 1 ) )
307                bud = jabber_buddy_by_ext_jid( ic, who, 0 );
308        else
309                bud = jabber_buddy_by_jid( ic, who, GET_BUDDY_BARE_OK );
310       
311        node = xt_new_node( "body", message, NULL );
312        node = jabber_make_packet( "message", "chat", bud ? bud->full_jid : who, node );
313       
314        if( bud && ( jd->flags & JFLAG_WANT_TYPING ) &&
315            ( ( bud->flags & JBFLAG_DOES_XEP85 ) ||
316             !( bud->flags & JBFLAG_PROBED_XEP85 ) ) )
317        {
318                struct xt_node *act;
319               
320                /* If the user likes typing notification and if we don't know
321                   (and didn't probe before) if this resource supports XEP85,
322                   include a probe in this packet now. Also, if we know this
323                   buddy does support XEP85, we have to send this <active/>
324                   tag to tell that the user stopped typing (well, that's what
325                   we guess when s/he pressed Enter...). */
326                act = xt_new_node( "active", NULL, NULL );
327                xt_add_attr( act, "xmlns", XMLNS_CHATSTATES );
328                xt_add_child( node, act );
329               
330                /* Just make sure we do this only once. */
331                bud->flags |= JBFLAG_PROBED_XEP85;
332        }
333       
334        st = jabber_write_packet( ic, node );
335        xt_free_node( node );
336       
337        return st;
338}
339
340static GList *jabber_away_states( struct im_connection *ic )
341{
342        static GList *l = NULL;
343        int i;
344       
345        if( l == NULL )
346                for( i = 0; jabber_away_state_list[i].full_name; i ++ )
347                        l = g_list_append( l, (void*) jabber_away_state_list[i].full_name );
348       
349        return l;
350}
351
352static void jabber_get_info( struct im_connection *ic, char *who )
353{
354        struct jabber_buddy *bud;
355       
356        bud = jabber_buddy_by_jid( ic, who, GET_BUDDY_FIRST );
357       
358        while( bud )
359        {
360                imcb_log( ic, "Buddy %s (%d) information:\nAway state: %s\nAway message: %s",
361                                   bud->full_jid, bud->priority,
362                                   bud->away_state ? bud->away_state->full_name : "(none)",
363                                   bud->away_message ? : "(none)" );
364                bud = bud->next;
365        }
366       
367        jabber_get_vcard( ic, bud ? bud->full_jid : who );
368}
369
370static void jabber_set_away( struct im_connection *ic, char *state_txt, char *message )
371{
372        struct jabber_data *jd = ic->proto_data;
373        struct jabber_away_state *state;
374       
375        /* Save all this info. We need it, for example, when changing the priority setting. */
376        state = (void *) jabber_away_state_by_name( state_txt );
377        jd->away_state = state ? state : (void *) jabber_away_state_list; /* Fall back to "Away" if necessary. */
378        g_free( jd->away_message );
379        jd->away_message = ( message && *message ) ? g_strdup( message ) : NULL;
380       
381        presence_send_update( ic );
382}
383
384static void jabber_add_buddy( struct im_connection *ic, char *who, char *group )
385{
386        struct jabber_data *jd = ic->proto_data;
387       
388        if( g_strcasecmp( who, JABBER_XMLCONSOLE_HANDLE ) == 0 )
389        {
390                jd->flags |= JFLAG_XMLCONSOLE;
391                imcb_add_buddy( ic, JABBER_XMLCONSOLE_HANDLE, NULL );
392                return;
393        }
394       
395        if( jabber_add_to_roster( ic, who, NULL ) )
396                presence_send_request( ic, who, "subscribe" );
397}
398
399static void jabber_remove_buddy( struct im_connection *ic, char *who, char *group )
400{
401        struct jabber_data *jd = ic->proto_data;
402       
403        if( g_strcasecmp( who, JABBER_XMLCONSOLE_HANDLE ) == 0 )
404        {
405                jd->flags &= ~JFLAG_XMLCONSOLE;
406                /* Not necessary for now. And for now the code isn't too
407                   happy if the buddy is completely gone right after calling
408                   this function already.
409                imcb_remove_buddy( ic, JABBER_XMLCONSOLE_HANDLE, NULL );
410                */
411                return;
412        }
413       
414        /* We should always do this part. Clean up our administration a little bit. */
415        jabber_buddy_remove_bare( ic, who );
416       
417        if( jabber_remove_from_roster( ic, who ) )
418                presence_send_request( ic, who, "unsubscribe" );
419}
420
421static struct groupchat *jabber_chat_join_( struct im_connection *ic, const char *room, const char *nick, const char *password )
422{
423        if( strchr( room, '@' ) == NULL )
424                imcb_error( ic, "Invalid room name: %s", room );
425        else if( jabber_chat_by_jid( ic, room ) )
426                imcb_error( ic, "Already present in chat `%s'", room );
427        else
428                return jabber_chat_join( ic, room, nick, password );
429       
430        return NULL;
431}
432
433static void jabber_chat_msg_( struct groupchat *c, char *message, int flags )
434{
435        if( c && message )
436                jabber_chat_msg( c, message, flags );
437}
438
439static void jabber_chat_topic_( struct groupchat *c, char *topic )
440{
441        if( c && topic )
442                jabber_chat_topic( c, topic );
443}
444
445static void jabber_chat_leave_( struct groupchat *c )
446{
447        if( c )
448                jabber_chat_leave( c, NULL );
449}
450
451static void jabber_chat_invite_( struct groupchat *c, char *who, char *msg )
452{
453        struct jabber_chat *jc = c->data;
454        gchar *msg_alt = NULL;
455
456        if( msg == NULL )
457                msg_alt = g_strdup_printf( "%s invited you to %s", c->ic->acc->user, jc->name );
458       
459        if( c && who )
460                jabber_chat_invite( c, who, msg ? msg : msg_alt );
461       
462        g_free( msg_alt );
463}
464
465static void jabber_keepalive( struct im_connection *ic )
466{
467        /* Just any whitespace character is enough as a keepalive for XMPP sessions. */
468        jabber_write( ic, "\n", 1 );
469       
470        /* This runs the garbage collection every minute, which means every packet
471           is in the cache for about a minute (which should be enough AFAIK). */
472        jabber_cache_clean( ic );
473}
474
475static int jabber_send_typing( struct im_connection *ic, char *who, int typing )
476{
477        struct jabber_data *jd = ic->proto_data;
478        struct jabber_buddy *bud;
479       
480        /* Enable typing notification related code from now. */
481        jd->flags |= JFLAG_WANT_TYPING;
482       
483        if( ( bud = jabber_buddy_by_jid( ic, who, 0 ) ) == NULL )
484        {
485                /* Sending typing notifications to unknown buddies is
486                   unsupported for now. Shouldn't be a problem, I think. */
487                return 0;
488        }
489       
490        if( bud->flags & JBFLAG_DOES_XEP85 )
491        {
492                /* We're only allowed to send this stuff if we know the other
493                   side supports it. */
494               
495                struct xt_node *node;
496                char *type;
497                int st;
498               
499                if( typing & OPT_TYPING )
500                        type = "composing";
501                else if( typing & OPT_THINKING )
502                        type = "paused";
503                else
504                        type = "active";
505               
506                node = xt_new_node( type, NULL, NULL );
507                xt_add_attr( node, "xmlns", XMLNS_CHATSTATES );
508                node = jabber_make_packet( "message", "chat", bud->full_jid, node );
509               
510                st = jabber_write_packet( ic, node );
511                xt_free_node( node );
512               
513                return st;
514        }
515       
516        return 1;
517}
518
519void jabber_initmodule()
520{
521        struct prpl *ret = g_new0( struct prpl, 1 );
522       
523        ret->name = "jabber";
524        ret->login = jabber_login;
525        ret->init = jabber_init;
526        ret->logout = jabber_logout;
527        ret->buddy_msg = jabber_buddy_msg;
528        ret->away_states = jabber_away_states;
529        ret->set_away = jabber_set_away;
530//      ret->set_info = jabber_set_info;
531        ret->get_info = jabber_get_info;
532        ret->add_buddy = jabber_add_buddy;
533        ret->remove_buddy = jabber_remove_buddy;
534        ret->chat_msg = jabber_chat_msg_;
535        ret->chat_topic = jabber_chat_topic_;
536        ret->chat_invite = jabber_chat_invite_;
537        ret->chat_leave = jabber_chat_leave_;
538        ret->chat_join = jabber_chat_join_;
539        ret->keepalive = jabber_keepalive;
540        ret->send_typing = jabber_send_typing;
541        ret->handle_cmp = g_strcasecmp;
542
543        register_protocol( ret );
544}
Note: See TracBrowser for help on using the repository browser.