source: protocols/jabber/jabber_util.c @ 63075d7

Last change on this file since 63075d7 was 979cfb4, checked in by Wilmer van der Gaast <wilmer@…>, at 2008-02-03T13:54:19Z

Saner garbage collection of cached packets in the Jabber module. Now
cached packets are removed after about ten minues instead of something
between one and two minutes. Closes one issue in #354.

  • Property mode set to 100644
File size: 19.6 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Jabber module - Misc. stuff                                              *
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 "jabber.h"
25
26static unsigned int next_id = 1;
27
28char *set_eval_priority( set_t *set, char *value )
29{
30        account_t *acc = set->data;
31        int i;
32       
33        if( sscanf( value, "%d", &i ) == 1 )
34        {
35                /* Priority is a signed 8-bit integer, according to RFC 3921. */
36                if( i < -128 || i > 127 )
37                        return NULL;
38        }
39        else
40                return NULL;
41       
42        /* Only run this stuff if the account is online ATM,
43           and if the setting seems to be acceptable. */
44        if( acc->ic )
45        {
46                /* Although set_eval functions usually are very nice and
47                   convenient, they have one disadvantage: If I would just
48                   call p_s_u() now to send the new prio setting, it would
49                   send the old setting because the set->value gets changed
50                   after the (this) eval returns a non-NULL value.
51                   
52                   So now I can choose between implementing post-set
53                   functions next to evals, or just do this little hack: */
54               
55                g_free( set->value );
56                set->value = g_strdup( value );
57               
58                /* (Yes, sorry, I prefer the hack. :-P) */
59               
60                presence_send_update( acc->ic );
61        }
62       
63        return value;
64}
65
66char *set_eval_tls( set_t *set, char *value )
67{
68        if( g_strcasecmp( value, "try" ) == 0 )
69                return value;
70        else
71                return set_eval_bool( set, value );
72}
73
74struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children )
75{
76        struct xt_node *node;
77       
78        node = xt_new_node( name, NULL, children );
79       
80        if( type )
81                xt_add_attr( node, "type", type );
82        if( to )
83                xt_add_attr( node, "to", to );
84       
85        /* IQ packets should always have an ID, so let's generate one. It
86           might get overwritten by jabber_cache_add() if this packet has
87           to be saved until we receive a response. Cached packets get
88           slightly different IDs so we can recognize them. */
89        if( strcmp( name, "iq" ) == 0 )
90        {
91                char *id = g_strdup_printf( "%s%05x", JABBER_PACKET_ID, ( next_id++ ) & 0xfffff );
92                xt_add_attr( node, "id", id );
93                g_free( id );
94        }
95       
96        return node;
97}
98
99struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type )
100{
101        struct xt_node *node, *c;
102        char *to;
103       
104        /* Create the "defined-condition" tag. */
105        c = xt_new_node( err_cond, NULL, NULL );
106        xt_add_attr( c, "xmlns", XMLNS_STANZA_ERROR );
107       
108        /* Put it in an <error> tag. */
109        c = xt_new_node( "error", NULL, c );
110        xt_add_attr( c, "type", err_type );
111       
112        /* To make the actual error packet, we copy the original packet and
113           add our <error>/type="error" tag. Including the original packet
114           is recommended, so let's just do it. */
115        node = xt_dup( orig );
116        xt_add_child( node, c );
117        xt_add_attr( node, "type", "error" );
118       
119        /* Return to sender. */
120        if( ( to = xt_find_attr( node, "from" ) ) )
121        {
122                xt_add_attr( node, "to", to );
123                xt_remove_attr( node, "from" );
124        }
125               
126        return node;
127}
128
129/* Cache a node/packet for later use. Mainly useful for IQ packets if you need
130   them when you receive the response. Use this BEFORE sending the packet so
131   it'll get a new id= tag, and do NOT free() the packet after sending it! */
132void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func )
133{
134        struct jabber_data *jd = ic->proto_data;
135        struct jabber_cache_entry *entry = g_new0( struct jabber_cache_entry, 1 );
136        char *id;
137       
138        id = g_strdup_printf( "%s%05x", jd->cached_id_prefix, ( next_id++ ) & 0xfffff );
139        xt_add_attr( node, "id", id );
140        g_free( id );
141       
142        entry->node = node;
143        entry->func = func;
144        entry->saved_at = time( NULL );
145        g_hash_table_insert( jd->node_cache, xt_find_attr( node, "id" ), entry );
146}
147
148void jabber_cache_entry_free( gpointer data )
149{
150        struct jabber_cache_entry *entry = data;
151       
152        xt_free_node( entry->node );
153        g_free( entry );
154}
155
156gboolean jabber_cache_clean_entry( gpointer key, gpointer entry, gpointer nullpointer );
157
158/* This one should be called from time to time (from keepalive, in this case)
159   to make sure things don't stay in the node cache forever. By marking nodes
160   during the first run and deleting marked nodes during a next run, every
161   node should be available in the cache for at least a minute (assuming the
162   function is indeed called every minute). */
163void jabber_cache_clean( struct im_connection *ic )
164{
165        struct jabber_data *jd = ic->proto_data;
166        time_t threshold = time( NULL ) - JABBER_CACHE_MAX_AGE;
167       
168        g_hash_table_foreach_remove( jd->node_cache, jabber_cache_clean_entry, &threshold );
169}
170
171gboolean jabber_cache_clean_entry( gpointer key, gpointer entry_, gpointer threshold_ )
172{
173        struct jabber_cache_entry *entry = entry_;
174        time_t *threshold = threshold_;
175       
176        return entry->saved_at < *threshold;
177}
178
179xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node )
180{
181        struct jabber_data *jd = ic->proto_data;
182        struct jabber_cache_entry *entry;
183        char *s;
184       
185        if( ( s = xt_find_attr( node, "id" ) ) == NULL ||
186            strncmp( s, jd->cached_id_prefix, strlen( jd->cached_id_prefix ) ) != 0 )
187        {
188                /* Silently ignore it, without an ID (or a non-cache
189                   ID) we don't know how to handle the packet and we
190                   probably don't have to. */
191                return XT_HANDLED;
192        }
193       
194        entry = g_hash_table_lookup( jd->node_cache, s );
195       
196        if( entry == NULL )
197        {
198                imcb_log( ic, "Warning: Received %s-%s packet with unknown/expired ID %s!",
199                              node->name, xt_find_attr( node, "type" ) ? : "(no type)", s );
200        }
201        else if( entry->func )
202        {
203                return entry->func( ic, node, entry->node );
204        }
205       
206        return XT_HANDLED;
207}
208
209const struct jabber_away_state jabber_away_state_list[] =
210{
211        { "away",  "Away" },
212        { "chat",  "Free for Chat" },
213        { "dnd",   "Do not Disturb" },
214        { "xa",    "Extended Away" },
215        { "",      "Online" },
216        { "",      NULL }
217};
218
219const struct jabber_away_state *jabber_away_state_by_code( char *code )
220{
221        int i;
222       
223        for( i = 0; jabber_away_state_list[i].full_name; i ++ )
224                if( g_strcasecmp( jabber_away_state_list[i].code, code ) == 0 )
225                        return jabber_away_state_list + i;
226       
227        return NULL;
228}
229
230const struct jabber_away_state *jabber_away_state_by_name( char *name )
231{
232        int i;
233       
234        for( i = 0; jabber_away_state_list[i].full_name; i ++ )
235                if( g_strcasecmp( jabber_away_state_list[i].full_name, name ) == 0 )
236                        return jabber_away_state_list + i;
237       
238        return NULL;
239}
240
241struct jabber_buddy_ask_data
242{
243        struct im_connection *ic;
244        char *handle;
245        char *realname;
246};
247
248static void jabber_buddy_ask_yes( gpointer w, struct jabber_buddy_ask_data *bla )
249{
250        presence_send_request( bla->ic, bla->handle, "subscribed" );
251       
252        if( imcb_find_buddy( bla->ic, bla->handle ) == NULL )
253                imcb_ask_add( bla->ic, bla->handle, NULL );
254       
255        g_free( bla->handle );
256        g_free( bla );
257}
258
259static void jabber_buddy_ask_no( gpointer w, struct jabber_buddy_ask_data *bla )
260{
261        presence_send_request( bla->ic, bla->handle, "subscribed" );
262       
263        g_free( bla->handle );
264        g_free( bla );
265}
266
267void jabber_buddy_ask( struct im_connection *ic, char *handle )
268{
269        struct jabber_buddy_ask_data *bla = g_new0( struct jabber_buddy_ask_data, 1 );
270        char *buf;
271       
272        bla->ic = ic;
273        bla->handle = g_strdup( handle );
274       
275        buf = g_strdup_printf( "The user %s wants to add you to his/her buddy list.", handle );
276        imcb_ask( ic, buf, bla, jabber_buddy_ask_yes, jabber_buddy_ask_no );
277        g_free( buf );
278}
279
280/* Returns a new string. Don't leak it! */
281char *jabber_normalize( const char *orig )
282{
283        int len, i;
284        char *new;
285       
286        len = strlen( orig );
287        new = g_new( char, len + 1 );
288        for( i = 0; i < len; i ++ )
289                new[i] = tolower( orig[i] );
290       
291        new[i] = 0;
292        return new;
293}
294
295/* Adds a buddy/resource to our list. Returns NULL if full_jid is not really a
296   FULL jid or if we already have this buddy/resource. XXX: No, great, actually
297   buddies from transports don't (usually) have resources. So we'll really have
298   to deal with that properly. Set their ->resource property to NULL. Do *NOT*
299   allow to mix this stuff, though... */
300struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid_ )
301{
302        struct jabber_data *jd = ic->proto_data;
303        struct jabber_buddy *bud, *new, *bi;
304        char *s, *full_jid;
305       
306        full_jid = jabber_normalize( full_jid_ );
307       
308        if( ( s = strchr( full_jid, '/' ) ) )
309                *s = 0;
310       
311        new = g_new0( struct jabber_buddy, 1 );
312       
313        if( ( bud = g_hash_table_lookup( jd->buddies, full_jid ) ) )
314        {
315                /* If this is a transport buddy or whatever, it can't have more
316                   than one instance, so this is always wrong: */
317                if( s == NULL || bud->resource == NULL )
318                {
319                        if( s ) *s = '/';
320                        g_free( new );
321                        g_free( full_jid );
322                        return NULL;
323                }
324               
325                new->bare_jid = bud->bare_jid;
326               
327                /* We already have another resource for this buddy, add the
328                   new one to the list. */
329                for( bi = bud; bi; bi = bi->next )
330                {
331                        /* Check for dupes. */
332                        if( g_strcasecmp( bi->resource, s + 1 ) == 0 )
333                        {
334                                *s = '/';
335                                g_free( new );
336                                g_free( full_jid );
337                                return NULL;
338                        }
339                        /* Append the new item to the list. */
340                        else if( bi->next == NULL )
341                        {
342                                bi->next = new;
343                                break;
344                        }
345                }
346        }
347        else
348        {
349                /* Keep in mind that full_jid currently isn't really
350                   a full JID... */
351                new->bare_jid = g_strdup( full_jid );
352                g_hash_table_insert( jd->buddies, new->bare_jid, new );
353        }
354       
355        if( s )
356        {
357                *s = '/';
358                new->full_jid = full_jid;
359                new->resource = strchr( new->full_jid, '/' ) + 1;
360        }
361        else
362        {
363                /* Let's waste some more bytes of RAM instead of to make
364                   memory management a total disaster here. And it saves
365                   me one g_free() call in this function. :-P */
366                new->full_jid = full_jid;
367        }
368       
369        return new;
370}
371
372/* Finds a buddy from our structures. Can find both full- and bare JIDs. When
373   asked for a bare JID, it uses the "resource_select" setting to see which
374   resource to pick. */
375struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid_, get_buddy_flags_t flags )
376{
377        struct jabber_data *jd = ic->proto_data;
378        struct jabber_buddy *bud;
379        char *s, *jid;
380       
381        jid = jabber_normalize( jid_ );
382       
383        if( ( s = strchr( jid, '/' ) ) )
384        {
385                int none_found = 0;
386               
387                *s = 0;
388                if( ( bud = g_hash_table_lookup( jd->buddies, jid ) ) )
389                {
390                        /* Just return the first one for this bare JID. */
391                        if( flags & GET_BUDDY_FIRST )
392                        {
393                                *s = '/';
394                                g_free( jid );
395                                return bud;
396                        }
397                       
398                        /* Is this one of those no-resource buddies? */
399                        if( bud->resource == NULL )
400                        {
401                                *s = '/';
402                                g_free( jid );
403                                return NULL;
404                        }
405                       
406                        /* See if there's an exact match. */
407                        for( ; bud; bud = bud->next )
408                                if( g_strcasecmp( bud->resource, s + 1 ) == 0 )
409                                        break;
410                }
411                else
412                {
413                        /* This hack is there to make sure that O_CREAT will
414                           work if there's already another resouce present
415                           for this JID, even if it's an unknown buddy. This
416                           is done to handle conferences properly. */
417                        none_found = 1;
418                        /* TODO(wilmer): Find out what I was thinking when I
419                           wrote this??? And then fix it. This makes me sad... */
420                }
421               
422                if( bud == NULL && ( flags & GET_BUDDY_CREAT ) && ( imcb_find_buddy( ic, jid ) || !none_found ) )
423                {
424                        *s = '/';
425                        bud = jabber_buddy_add( ic, jid );
426                }
427               
428                g_free( jid );
429                return bud;
430        }
431        else
432        {
433                struct jabber_buddy *best_prio, *best_time;
434                char *set;
435               
436                bud = g_hash_table_lookup( jd->buddies, jid );
437               
438                g_free( jid );
439               
440                if( bud == NULL )
441                        /* No match. Create it now? */
442                        return ( ( flags & GET_BUDDY_CREAT ) && imcb_find_buddy( ic, jid_ ) ) ?
443                                   jabber_buddy_add( ic, jid_ ) : NULL;
444                else if( bud->resource && ( flags & GET_BUDDY_EXACT ) )
445                        /* We want an exact match, so in thise case there shouldn't be a /resource. */
446                        return NULL;
447                else if( ( bud->resource == NULL || bud->next == NULL ) )
448                        /* No need for selection if there's only one option. */
449                        return bud;
450                else if( flags & GET_BUDDY_FIRST )
451                        /* Looks like the caller doesn't care about details. */
452                        return bud;
453               
454                best_prio = best_time = bud;
455                for( ; bud; bud = bud->next )
456                {
457                        if( bud->priority > best_prio->priority )
458                                best_prio = bud;
459                        if( bud->last_act > best_time->last_act )
460                                best_time = bud;
461                }
462               
463                if( ( set = set_getstr( &ic->acc->set, "resource_select" ) ) == NULL )
464                        return NULL;
465                else if( strcmp( set, "activity" ) == 0 )
466                        return best_time;
467                else /* if( strcmp( set, "priority" ) == 0 ) */
468                        return best_prio;
469        }
470}
471
472/* I'm keeping a separate ext_jid attribute to save a JID that makes sense
473   to export to BitlBee. This is mainly for groupchats right now. It's
474   a bit of a hack, but I just think having the user nickname in the hostname
475   part of the hostmask doesn't look nice on IRC. Normally you can convert
476   a normal JID to ext_jid by swapping the part before and after the / and
477   replacing the / with a =. But there should be some stripping (@s are
478   allowed in Jabber nicks...). */
479struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid_, get_buddy_flags_t flags )
480{
481        struct jabber_buddy *bud;
482        char *s, *jid;
483       
484        jid = jabber_normalize( jid_ );
485       
486        if( ( s = strchr( jid, '=' ) ) == NULL )
487                return NULL;
488       
489        for( bud = jabber_buddy_by_jid( ic, s + 1, GET_BUDDY_FIRST ); bud; bud = bud->next )
490        {
491                /* Hmmm, could happen if not all people in the chat are anonymized? */
492                if( bud->ext_jid == NULL )
493                        continue;
494               
495                if( strcmp( bud->ext_jid, jid ) == 0 )
496                        break;
497        }
498       
499        g_free( jid );
500       
501        return bud;
502}
503
504/* Remove one specific full JID from our list. Use this when a buddy goes
505   off-line (because (s)he can still be online from a different location.
506   XXX: See above, we should accept bare JIDs too... */
507int jabber_buddy_remove( struct im_connection *ic, char *full_jid_ )
508{
509        struct jabber_data *jd = ic->proto_data;
510        struct jabber_buddy *bud, *prev, *bi;
511        char *s, *full_jid;
512       
513        full_jid = jabber_normalize( full_jid_ );
514       
515        if( ( s = strchr( full_jid, '/' ) ) )
516                *s = 0;
517       
518        if( ( bud = g_hash_table_lookup( jd->buddies, full_jid ) ) )
519        {
520                /* If there's only one item in the list (and if the resource
521                   matches), removing it is simple. (And the hash reference
522                   should be removed too!) */
523                if( bud->next == NULL && ( ( s == NULL || bud->resource == NULL ) || g_strcasecmp( bud->resource, s + 1 ) == 0 ) )
524                {
525                        g_hash_table_remove( jd->buddies, bud->bare_jid );
526                        g_free( bud->bare_jid );
527                        g_free( bud->ext_jid );
528                        g_free( bud->full_jid );
529                        g_free( bud->away_message );
530                        g_free( bud );
531                       
532                        g_free( full_jid );
533                       
534                        return 1;
535                }
536                else if( s == NULL || bud->resource == NULL )
537                {
538                        /* Tried to remove a bare JID while this JID does seem
539                           to have resources... (Or the opposite.) *sigh* */
540                        g_free( full_jid );
541                        return 0;
542                }
543                else
544                {
545                        for( bi = bud, prev = NULL; bi; bi = (prev=bi)->next )
546                                if( g_strcasecmp( bi->resource, s + 1 ) == 0 )
547                                        break;
548                       
549                        g_free( full_jid );
550                       
551                        if( bi )
552                        {
553                                if( prev )
554                                        prev->next = bi->next;
555                                else
556                                        /* The hash table should point at the second
557                                           item, because we're removing the first. */
558                                        g_hash_table_replace( jd->buddies, bi->bare_jid, bi->next );
559                               
560                                g_free( bi->ext_jid );
561                                g_free( bi->full_jid );
562                                g_free( bi->away_message );
563                                g_free( bi );
564                               
565                                return 1;
566                        }
567                        else
568                        {
569                                return 0;
570                        }
571                }
572        }
573        else
574        {
575                g_free( full_jid );
576                return 0;
577        }
578}
579
580/* Remove a buddy completely; removes all resources that belong to the
581   specified bare JID. Use this when removing someone from the contact
582   list, for example. */
583int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid )
584{
585        struct jabber_data *jd = ic->proto_data;
586        struct jabber_buddy *bud, *next;
587       
588        if( strchr( bare_jid, '/' ) )
589                return 0;
590       
591        if( ( bud = jabber_buddy_by_jid( ic, bare_jid, GET_BUDDY_FIRST ) ) )
592        {
593                /* Most important: Remove the hash reference. We don't know
594                   this buddy anymore. */
595                g_hash_table_remove( jd->buddies, bud->bare_jid );
596                g_free( bud->bare_jid );
597               
598                /* Deallocate the linked list of resources. */
599                while( bud )
600                {
601                        /* ext_jid && anonymous means that this buddy is
602                           specific to one groupchat (the one we're
603                           currently cleaning up) so it can be deleted
604                           completely. */
605                        if( bud->ext_jid && bud->flags & JBFLAG_IS_ANONYMOUS )
606                                imcb_remove_buddy( ic, bud->ext_jid, NULL );
607                       
608                        next = bud->next;
609                        g_free( bud->ext_jid );
610                        g_free( bud->full_jid );
611                        g_free( bud->away_message );
612                        g_free( bud );
613                        bud = next;
614                }
615               
616                return 1;
617        }
618        else
619        {
620                return 0;
621        }
622}
623
624time_t jabber_get_timestamp( struct xt_node *xt )
625{
626        struct tm tp, utc;
627        struct xt_node *c;
628        time_t res, tres;
629        char *s = NULL;
630       
631        for( c = xt->children; ( c = xt_find_node( c, "x" ) ); c = c->next )
632        {
633                if( ( s = xt_find_attr( c, "xmlns" ) ) && strcmp( s, XMLNS_DELAY ) == 0 )
634                        break;
635        }
636       
637        if( !c || !( s = xt_find_attr( c, "stamp" ) ) )
638                return 0;
639       
640        memset( &tp, 0, sizeof( tp ) );
641        if( sscanf( s, "%4d%2d%2dT%2d:%2d:%2d", &tp.tm_year, &tp.tm_mon, &tp.tm_mday,
642                                                &tp.tm_hour, &tp.tm_min, &tp.tm_sec ) != 6 )
643                return 0;
644       
645        tp.tm_year -= 1900;
646        tp.tm_mon --;
647        tp.tm_isdst = -1; /* GRRRRRRRRRRR */
648       
649        res = mktime( &tp );
650        /* Problem is, mktime() just gave us the GMT timestamp for the
651           given local time... While the given time WAS NOT local. So
652           we should fix this now.
653       
654           Now I could choose between messing with environment variables
655           (kludgy) or using timegm() (not portable)... Or doing the
656           following, which I actually prefer... */
657        gmtime_r( &res, &utc );
658        utc.tm_isdst = -1; /* Once more: GRRRRRRRRRRRRRRRRRR!!! */
659        if( utc.tm_hour == tp.tm_hour && utc.tm_min == tp.tm_min )
660                /* Sweet! We're in UTC right now... */
661                return res;
662       
663        tres = mktime( &utc );
664        res += res - tres;
665       
666        /* Yes, this is a hack. And it will go wrong around DST changes.
667           BUT this is more likely to be threadsafe than messing with
668           environment variables, and possibly more portable... */
669       
670        return res;
671}
672
673struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns )
674{
675        struct jabber_error *err;
676        struct xt_node *c;
677        char *s;
678       
679        if( node == NULL )
680                return NULL;
681       
682        err = g_new0( struct jabber_error, 1 );
683        err->type = xt_find_attr( node, "type" );
684       
685        for( c = node->children; c; c = c->next )
686        {
687                if( !( s = xt_find_attr( c, "xmlns" ) ) ||
688                    strcmp( s, xmlns ) != 0 )
689                        continue;
690               
691                if( strcmp( c->name, "text" ) != 0 )
692                {
693                        err->code = c->name;
694                }
695                /* Only use the text if it doesn't have an xml:lang attribute,
696                   if it's empty or if it's set to something English. */
697                else if( !( s = xt_find_attr( c, "xml:lang" ) ) ||
698                         !*s || strncmp( s, "en", 2 ) == 0 )
699                {
700                        err->text = c->text;
701                }
702        }
703       
704        return err;
705}
706
707void jabber_error_free( struct jabber_error *err )
708{
709        g_free( err );
710}
Note: See TracBrowser for help on using the repository browser.