source: storage_xml.c @ 547ea68

Last change on this file since 547ea68 was 547ea68, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-06-27T15:32:12Z

Save and load channels. Also fixing a bug in creating non-control channels
with a &-name.

  • Property mode set to 100644
File size: 16.8 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2006 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/* Storage backend that uses an XMLish format for all data. */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23  Suite 330, Boston, MA  02111-1307  USA
24*/
25
26#define BITLBEE_CORE
27#include "bitlbee.h"
28#include "base64.h"
29#include "arc.h"
30#include "md5.h"
31
32#if GLIB_CHECK_VERSION(2,8,0)
33#include <glib/gstdio.h>
34#else
35/* GLib < 2.8.0 doesn't have g_access, so just use the system access(). */
36#include <unistd.h>
37#define g_access access
38#endif
39
40typedef enum
41{
42        XML_PASS_CHECK_ONLY = -1,
43        XML_PASS_UNKNOWN = 0,
44        XML_PASS_WRONG,
45        XML_PASS_OK
46} xml_pass_st;
47
48/* To make it easier later when extending the format: */
49#define XML_FORMAT_VERSION 1
50
51struct xml_parsedata
52{
53        irc_t *irc;
54        char *current_setting;
55        account_t *current_account;
56        irc_channel_t *current_channel;
57        set_t **current_set_head;
58        char *given_nick;
59        char *given_pass;
60        xml_pass_st pass_st;
61};
62
63static char *xml_attr( const gchar **attr_names, const gchar **attr_values, const gchar *key )
64{
65        int i;
66       
67        for( i = 0; attr_names[i]; i ++ )
68                if( g_strcasecmp( attr_names[i], key ) == 0 )
69                        return (char*) attr_values[i];
70       
71        return NULL;
72}
73
74static void xml_destroy_xd( gpointer data )
75{
76        struct xml_parsedata *xd = data;
77       
78        g_free( xd->given_nick );
79        g_free( xd->given_pass );
80        g_free( xd );
81}
82
83static void xml_start_element( GMarkupParseContext *ctx, const gchar *element_name, const gchar **attr_names, const gchar **attr_values, gpointer data, GError **error )
84{
85        struct xml_parsedata *xd = data;
86        irc_t *irc = xd->irc;
87       
88        if( g_strcasecmp( element_name, "user" ) == 0 )
89        {
90                char *nick = xml_attr( attr_names, attr_values, "nick" );
91                char *pass = xml_attr( attr_names, attr_values, "password" );
92                int st;
93               
94                if( !nick || !pass )
95                {
96                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
97                                     "Missing attributes for %s element", element_name );
98                }
99                else if( ( st = md5_verify_password( xd->given_pass, pass ) ) == -1 )
100                {
101                        xd->pass_st = XML_PASS_WRONG;
102                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
103                                     "Error while decoding password attribute" );
104                }
105                else if( st == 0 )
106                {
107                        if( xd->pass_st != XML_PASS_CHECK_ONLY )
108                                xd->pass_st = XML_PASS_OK;
109                }
110                else
111                {
112                        xd->pass_st = XML_PASS_WRONG;
113                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
114                                     "Password mismatch" );
115                }
116        }
117        else if( xd->pass_st < XML_PASS_OK )
118        {
119                /* Let's not parse anything else if we only have to check
120                   the password. */
121        }
122        else if( g_strcasecmp( element_name, "account" ) == 0 )
123        {
124                char *protocol, *handle, *server, *password = NULL, *autoconnect;
125                char *pass_b64 = NULL;
126                unsigned char *pass_cr = NULL;
127                int pass_len;
128                struct prpl *prpl = NULL;
129               
130                handle = xml_attr( attr_names, attr_values, "handle" );
131                pass_b64 = xml_attr( attr_names, attr_values, "password" );
132                server = xml_attr( attr_names, attr_values, "server" );
133                autoconnect = xml_attr( attr_names, attr_values, "autoconnect" );
134               
135                protocol = xml_attr( attr_names, attr_values, "protocol" );
136                if( protocol )
137                        prpl = find_protocol( protocol );
138               
139                if( !handle || !pass_b64 || !protocol )
140                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
141                                     "Missing attributes for %s element", element_name );
142                else if( !prpl )
143                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
144                                     "Unknown protocol: %s", protocol );
145                else if( ( pass_len = base64_decode( pass_b64, (unsigned char**) &pass_cr ) ) &&
146                                         arc_decode( pass_cr, pass_len, &password, xd->given_pass ) )
147                {
148                        xd->current_account = account_add( irc->b, prpl, handle, password );
149                        if( server )
150                                set_setstr( &xd->current_account->set, "server", server );
151                        if( autoconnect )
152                                set_setstr( &xd->current_account->set, "auto_connect", autoconnect );
153                }
154                else
155                {
156                        /* Actually the _decode functions don't even return error codes,
157                           but maybe they will later... */
158                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
159                                     "Error while decrypting account password" );
160                }
161               
162                g_free( pass_cr );
163                g_free( password );
164        }
165        else if( g_strcasecmp( element_name, "setting" ) == 0 )
166        {
167                char *setting;
168               
169                if( xd->current_setting )
170                {
171                        g_free( xd->current_setting );
172                        xd->current_setting = NULL;
173                }
174               
175                if( ( setting = xml_attr( attr_names, attr_values, "name" ) ) )
176                {
177                        if( xd->current_channel != NULL )
178                                xd->current_set_head = &xd->current_channel->set;
179                        else if( xd->current_account != NULL )
180                                xd->current_set_head = &xd->current_account->set;
181                        else
182                                xd->current_set_head = &xd->irc->b->set;
183                       
184                        xd->current_setting = g_strdup( setting );
185                }
186                else
187                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
188                                     "Missing attributes for %s element", element_name );
189        }
190        else if( g_strcasecmp( element_name, "buddy" ) == 0 )
191        {
192                char *handle, *nick;
193               
194                handle = xml_attr( attr_names, attr_values, "handle" );
195                nick = xml_attr( attr_names, attr_values, "nick" );
196               
197                if( xd->current_account && handle && nick )
198                {
199                        nick_set( xd->current_account, handle, nick );
200                }
201                else
202                {
203                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
204                                     "Missing attributes for %s element", element_name );
205                }
206        }
207        else if( g_strcasecmp( element_name, "channel" ) == 0 )
208        {
209                char *name, *type;
210               
211                name = xml_attr( attr_names, attr_values, "name" );
212                type = xml_attr( attr_names, attr_values, "type" );
213               
214                if( !name || !type )
215                {
216                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
217                                     "Missing attributes for %s element", element_name );
218                        return;
219                }
220               
221                if( ( xd->current_channel = irc_channel_by_name( irc, name ) ) ||
222                    ( xd->current_channel = irc_channel_new( irc, name ) ) )
223                        set_setstr( &xd->current_channel->set, "type", type );
224        }
225        /* Backward compatibility: Keep this around for a while for people
226           switching from BitlBee 1.2.4+. */
227        else if( g_strcasecmp( element_name, "chat" ) == 0 )
228        {
229                char *handle, *channel;
230               
231                handle = xml_attr( attr_names, attr_values, "handle" );
232                channel = xml_attr( attr_names, attr_values, "channel" );
233               
234                if( xd->current_account && handle && channel )
235                {
236                        irc_channel_t *ic;
237                        char *acc;
238                       
239                        acc = g_strdup_printf( "%s(%s)",
240                                               xd->current_account->prpl->name,
241                                               xd->current_account->user );
242                       
243                        if( ( ic = irc_channel_new( irc, channel ) ) &&
244                            set_setstr( &ic->set, "type", "chat" ) &&
245                            set_setstr( &ic->set, "chat_type", "room" ) &&
246                            set_setstr( &ic->set, "account", acc ) &&
247                            set_setstr( &ic->set, "room", handle ) )
248                        {
249                                /* Try to pick up some settings where possible. */
250                                xd->current_channel = ic;
251                        }
252                        else if( ic )
253                                irc_channel_free( ic );
254                       
255                        g_free( acc );
256                }
257                else
258                {
259                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
260                                     "Missing attributes for %s element", element_name );
261                }
262        }
263        else
264        {
265                g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
266                             "Unkown element: %s", element_name );
267        }
268}
269
270static void xml_end_element( GMarkupParseContext *ctx, const gchar *element_name, gpointer data, GError **error )
271{
272        struct xml_parsedata *xd = data;
273       
274        if( g_strcasecmp( element_name, "setting" ) == 0 && xd->current_setting )
275        {
276                g_free( xd->current_setting );
277                xd->current_setting = NULL;
278        }
279        else if( g_strcasecmp( element_name, "account" ) == 0 )
280        {
281                xd->current_account = NULL;
282        }
283        else if( g_strcasecmp( element_name, "channel" ) == 0 ||
284                 g_strcasecmp( element_name, "chat" ) == 0 )
285        {
286                xd->current_channel = NULL;
287        }
288}
289
290static void xml_text( GMarkupParseContext *ctx, const gchar *text_orig, gsize text_len, gpointer data, GError **error )
291{
292        char text[text_len+1];
293        struct xml_parsedata *xd = data;
294       
295        strncpy( text, text_orig, text_len );
296        text[text_len] = 0;
297       
298        if( xd->pass_st < XML_PASS_OK )
299        {
300                /* Let's not parse anything else if we only have to check
301                   the password, or if we didn't get the chance to check it
302                   yet. */
303        }
304        else if( g_strcasecmp( g_markup_parse_context_get_element( ctx ), "setting" ) == 0 && xd->current_setting )
305        {
306                set_setstr( xd->current_set_head, xd->current_setting, (char*) text );
307                g_free( xd->current_setting );
308                xd->current_setting = NULL;
309        }
310}
311
312GMarkupParser xml_parser =
313{
314        xml_start_element,
315        xml_end_element,
316        xml_text,
317        NULL,
318        NULL
319};
320
321static void xml_init( void )
322{
323        if( g_access( global.conf->configdir, F_OK ) != 0 )
324                log_message( LOGLVL_WARNING, "The configuration directory `%s' does not exist. Configuration won't be saved.", global.conf->configdir );
325        else if( g_access( global.conf->configdir, F_OK ) != 0 || 
326                 g_access( global.conf->configdir, W_OK ) != 0 )
327                log_message( LOGLVL_WARNING, "Permission problem: Can't read/write from/to `%s'.", global.conf->configdir );
328}
329
330static storage_status_t xml_load_real( irc_t *irc, const char *my_nick, const char *password, xml_pass_st action )
331{
332        GMarkupParseContext *ctx;
333        struct xml_parsedata *xd;
334        char *fn, buf[512];
335        GError *gerr = NULL;
336        int fd, st;
337       
338        xd = g_new0( struct xml_parsedata, 1 );
339        xd->irc = irc;
340        xd->given_nick = g_strdup( my_nick );
341        xd->given_pass = g_strdup( password );
342        xd->pass_st = action;
343        nick_lc( xd->given_nick );
344       
345        fn = g_strdup_printf( "%s%s%s", global.conf->configdir, xd->given_nick, ".xml" );
346        if( ( fd = open( fn, O_RDONLY ) ) < 0 )
347        {
348                xml_destroy_xd( xd );
349                g_free( fn );
350                return STORAGE_NO_SUCH_USER;
351        }
352        g_free( fn );
353       
354        ctx = g_markup_parse_context_new( &xml_parser, 0, xd, xml_destroy_xd );
355       
356        while( ( st = read( fd, buf, sizeof( buf ) ) ) > 0 )
357        {
358                if( !g_markup_parse_context_parse( ctx, buf, st, &gerr ) || gerr )
359                {
360                        xml_pass_st pass_st = xd->pass_st;
361                       
362                        g_markup_parse_context_free( ctx );
363                        close( fd );
364                       
365                        if( pass_st == XML_PASS_WRONG )
366                        {
367                                g_clear_error( &gerr );
368                                return STORAGE_INVALID_PASSWORD;
369                        }
370                        else
371                        {
372                                if( gerr && irc )
373                                        irc_usermsg( irc, "Error from XML-parser: %s", gerr->message );
374                               
375                                g_clear_error( &gerr );
376                                return STORAGE_OTHER_ERROR;
377                        }
378                }
379        }
380        /* Just to be sure... */
381        g_clear_error( &gerr );
382       
383        g_markup_parse_context_free( ctx );
384        close( fd );
385       
386        if( action == XML_PASS_CHECK_ONLY )
387                return STORAGE_OK;
388       
389        return STORAGE_OK;
390}
391
392static storage_status_t xml_load( irc_t *irc, const char *password )
393{
394        return xml_load_real( irc, irc->user->nick, password, XML_PASS_UNKNOWN );
395}
396
397static storage_status_t xml_check_pass( const char *my_nick, const char *password )
398{
399        /* This is a little bit risky because we have to pass NULL for the
400           irc_t argument. This *should* be fine, if I didn't miss anything... */
401        return xml_load_real( NULL, my_nick, password, XML_PASS_CHECK_ONLY );
402}
403
404static int xml_printf( int fd, int indent, char *fmt, ... )
405{
406        va_list params;
407        char *out;
408        char tabs[9] = "\t\t\t\t\t\t\t\t";
409        int len;
410       
411        /* Maybe not very clean, but who needs more than 8 levels of indentation anyway? */
412        if( write( fd, tabs, indent <= 8 ? indent : 8 ) != indent )
413                return 0;
414       
415        va_start( params, fmt );
416        out = g_markup_vprintf_escaped( fmt, params );
417        va_end( params );
418       
419        len = strlen( out );
420        len -= write( fd, out, len );
421        g_free( out );
422       
423        return len == 0;
424}
425
426static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data );
427
428static storage_status_t xml_save( irc_t *irc, int overwrite )
429{
430        char path[512], *path2, *pass_buf = NULL;
431        set_t *set;
432        account_t *acc;
433        int fd;
434        md5_byte_t pass_md5[21];
435        md5_state_t md5_state;
436        GSList *l;
437       
438        path2 = g_strdup( irc->user->nick );
439        nick_lc( path2 );
440        g_snprintf( path, sizeof( path ) - 2, "%s%s%s", global.conf->configdir, path2, ".xml" );
441        g_free( path2 );
442       
443        if( !overwrite && g_access( path, F_OK ) == 0 )
444                return STORAGE_ALREADY_EXISTS;
445       
446        strcat( path, ".XXXXXX" );
447        if( ( fd = mkstemp( path ) ) < 0 )
448        {
449                irc_usermsg( irc, "Error while opening configuration file." );
450                return STORAGE_OTHER_ERROR;
451        }
452       
453        /* Generate a salted md5sum of the password. Use 5 bytes for the salt
454           (to prevent dictionary lookups of passwords) to end up with a 21-
455           byte password hash, more convenient for base64 encoding. */
456        random_bytes( pass_md5 + 16, 5 );
457        md5_init( &md5_state );
458        md5_append( &md5_state, (md5_byte_t*) irc->password, strlen( irc->password ) );
459        md5_append( &md5_state, pass_md5 + 16, 5 ); /* Add the salt. */
460        md5_finish( &md5_state, pass_md5 );
461        /* Save the hash in base64-encoded form. */
462        pass_buf = base64_encode( pass_md5, 21 );
463       
464        if( !xml_printf( fd, 0, "<user nick=\"%s\" password=\"%s\" version=\"%d\">\n", irc->user->nick, pass_buf, XML_FORMAT_VERSION ) )
465                goto write_error;
466       
467        g_free( pass_buf );
468       
469        for( set = irc->b->set; set; set = set->next )
470                if( set->value )
471                        if( !xml_printf( fd, 1, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
472                                goto write_error;
473       
474        for( acc = irc->b->accounts; acc; acc = acc->next )
475        {
476                unsigned char *pass_cr;
477                char *pass_b64;
478                int pass_len;
479               
480                pass_len = arc_encode( acc->pass, strlen( acc->pass ), (unsigned char**) &pass_cr, irc->password, 12 );
481                pass_b64 = base64_encode( pass_cr, pass_len );
482                g_free( pass_cr );
483               
484                if( !xml_printf( fd, 1, "<account protocol=\"%s\" handle=\"%s\" password=\"%s\" autoconnect=\"%d\"", acc->prpl->name, acc->user, pass_b64, acc->auto_connect ) )
485                {
486                        g_free( pass_b64 );
487                        goto write_error;
488                }
489                g_free( pass_b64 );
490               
491                if( acc->server && acc->server[0] && !xml_printf( fd, 0, " server=\"%s\"", acc->server ) )
492                        goto write_error;
493                if( !xml_printf( fd, 0, ">\n" ) )
494                        goto write_error;
495               
496                for( set = acc->set; set; set = set->next )
497                        if( set->value && !( set->flags & ACC_SET_NOSAVE ) )
498                                if( !xml_printf( fd, 2, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
499                                        goto write_error;
500               
501                /* This probably looks pretty strange. g_hash_table_foreach
502                   is quite a PITA already (but it can't get much better in
503                   C without using #define, I'm afraid), and since it
504                   doesn't seem to be possible to abort the foreach on write
505                   errors, so instead let's use the _find function and
506                   return TRUE on write errors. Which means, if we found
507                   something, there was an error. :-) */
508                if( g_hash_table_find( acc->nicks, xml_save_nick, & fd ) )
509                        goto write_error;
510               
511                if( !xml_printf( fd, 1, "</account>\n" ) )
512                        goto write_error;
513        }
514       
515        for( l = irc->channels; l; l = l->next )
516        {
517                irc_channel_t *ic = l->data;
518               
519                if( !xml_printf( fd, 1, "<channel name=\"%s\" type=\"%s\">\n",
520                                 ic->name, set_getstr( &ic->set, "type" ) ) )
521                        goto write_error;
522               
523                for( set = ic->set; set; set = set->next )
524                        if( set->value && strcmp( set->key, "type" ) != 0 )
525                                if( !xml_printf( fd, 2, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
526                                        goto write_error;
527               
528                if( !xml_printf( fd, 1, "</channel>\n" ) )
529                        goto write_error;
530        }
531       
532        if( !xml_printf( fd, 0, "</user>\n" ) )
533                goto write_error;
534       
535        fsync( fd );
536        close( fd );
537       
538        path2 = g_strndup( path, strlen( path ) - 7 );
539        if( rename( path, path2 ) != 0 )
540        {
541                irc_usermsg( irc, "Error while renaming temporary configuration file." );
542               
543                g_free( path2 );
544                unlink( path );
545               
546                return STORAGE_OTHER_ERROR;
547        }
548       
549        g_free( path2 );
550       
551        return STORAGE_OK;
552
553write_error:
554        g_free( pass_buf );
555       
556        irc_usermsg( irc, "Write error. Disk full?" );
557        close( fd );
558       
559        return STORAGE_OTHER_ERROR;
560}
561
562static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data )
563{
564        return !xml_printf( *( (int*) data ), 2, "<buddy handle=\"%s\" nick=\"%s\" />\n", key, value );
565}
566
567static storage_status_t xml_remove( const char *nick, const char *password )
568{
569        char s[512], *lc;
570        storage_status_t status;
571
572        status = xml_check_pass( nick, password );
573        if( status != STORAGE_OK )
574                return status;
575
576        lc = g_strdup( nick );
577        nick_lc( lc );
578        g_snprintf( s, 511, "%s%s%s", global.conf->configdir, lc, ".xml" );
579        g_free( lc );
580       
581        if( unlink( s ) == -1 )
582                return STORAGE_OTHER_ERROR;
583       
584        return STORAGE_OK;
585}
586
587storage_t storage_xml = {
588        .name = "xml",
589        .init = xml_init,
590        .check_pass = xml_check_pass,
591        .remove = xml_remove,
592        .load = xml_load,
593        .save = xml_save
594};
Note: See TracBrowser for help on using the repository browser.