source: storage_xml.c @ 1917a1ec

Last change on this file since 1917a1ec was 1917a1ec, checked in by Wilmer van der Gaast <wilmer@…>, at 2008-08-30T19:43:38Z

Added support for loading chatroom data from user .xml files.

  • Property mode set to 100644
File size: 15.3 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        struct chat *current_chat;
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, 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_chat != NULL )
178                                xd->current_set_head = &xd->current_chat->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->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, "chat" ) == 0 )
208        {
209                char *handle, *channel;
210               
211                handle = xml_attr( attr_names, attr_values, "handle" );
212                channel = xml_attr( attr_names, attr_values, "channel" );
213               
214                if( xd->current_account && handle && channel )
215                {
216                        xd->current_chat = chat_add( xd->irc, xd->current_account, handle, channel );
217                }
218                else
219                {
220                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
221                                     "Missing attributes for %s element", element_name );
222                }
223        }
224        else
225        {
226                g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
227                             "Unkown element: %s", element_name );
228        }
229}
230
231static void xml_end_element( GMarkupParseContext *ctx, const gchar *element_name, gpointer data, GError **error )
232{
233        struct xml_parsedata *xd = data;
234       
235        if( g_strcasecmp( element_name, "setting" ) == 0 && xd->current_setting )
236        {
237                g_free( xd->current_setting );
238                xd->current_setting = NULL;
239        }
240        else if( g_strcasecmp( element_name, "account" ) == 0 )
241        {
242                xd->current_account = NULL;
243        }
244        else if( g_strcasecmp( element_name, "chat" ) == 0 )
245        {
246                xd->current_chat = NULL;
247        }
248}
249
250static void xml_text( GMarkupParseContext *ctx, const gchar *text_orig, gsize text_len, gpointer data, GError **error )
251{
252        char text[text_len+1];
253        struct xml_parsedata *xd = data;
254       
255        strncpy( text, text_orig, text_len );
256        text[text_len] = 0;
257       
258        if( xd->pass_st < XML_PASS_OK )
259        {
260                /* Let's not parse anything else if we only have to check
261                   the password, or if we didn't get the chance to check it
262                   yet. */
263        }
264        else if( g_strcasecmp( g_markup_parse_context_get_element( ctx ), "setting" ) == 0 && xd->current_setting )
265        {
266                set_setstr( xd->current_set_head, xd->current_setting, (char*) text );
267                g_free( xd->current_setting );
268                xd->current_setting = NULL;
269        }
270}
271
272GMarkupParser xml_parser =
273{
274        xml_start_element,
275        xml_end_element,
276        xml_text,
277        NULL,
278        NULL
279};
280
281static void xml_init( void )
282{
283        if( g_access( global.conf->configdir, F_OK ) != 0 )
284                log_message( LOGLVL_WARNING, "The configuration directory `%s' does not exist. Configuration won't be saved.", global.conf->configdir );
285        else if( g_access( global.conf->configdir, F_OK ) != 0 || 
286                 g_access( global.conf->configdir, W_OK ) != 0 )
287                log_message( LOGLVL_WARNING, "Permission problem: Can't read/write from/to `%s'.", global.conf->configdir );
288}
289
290static storage_status_t xml_load_real( const char *my_nick, const char *password, irc_t *irc, xml_pass_st action )
291{
292        GMarkupParseContext *ctx;
293        struct xml_parsedata *xd;
294        char *fn, buf[512];
295        GError *gerr = NULL;
296        int fd, st;
297       
298        if( irc && irc->status & USTATUS_IDENTIFIED )
299                return( 1 );
300       
301        xd = g_new0( struct xml_parsedata, 1 );
302        xd->irc = irc;
303        xd->given_nick = g_strdup( my_nick );
304        xd->given_pass = g_strdup( password );
305        xd->pass_st = action;
306        nick_lc( xd->given_nick );
307       
308        fn = g_strdup_printf( "%s%s%s", global.conf->configdir, xd->given_nick, ".xml" );
309        if( ( fd = open( fn, O_RDONLY ) ) < 0 )
310        {
311                xml_destroy_xd( xd );
312                g_free( fn );
313                return STORAGE_NO_SUCH_USER;
314        }
315        g_free( fn );
316       
317        ctx = g_markup_parse_context_new( &xml_parser, 0, xd, xml_destroy_xd );
318       
319        while( ( st = read( fd, buf, sizeof( buf ) ) ) > 0 )
320        {
321                if( !g_markup_parse_context_parse( ctx, buf, st, &gerr ) || gerr )
322                {
323                        xml_pass_st pass_st = xd->pass_st;
324                       
325                        g_markup_parse_context_free( ctx );
326                        close( fd );
327                       
328                        if( pass_st == XML_PASS_WRONG )
329                        {
330                                g_clear_error( &gerr );
331                                return STORAGE_INVALID_PASSWORD;
332                        }
333                        else
334                        {
335                                if( gerr && irc )
336                                        irc_usermsg( irc, "Error from XML-parser: %s", gerr->message );
337                               
338                                g_clear_error( &gerr );
339                                return STORAGE_OTHER_ERROR;
340                        }
341                }
342        }
343        /* Just to be sure... */
344        g_clear_error( &gerr );
345       
346        g_markup_parse_context_free( ctx );
347        close( fd );
348       
349        if( action == XML_PASS_CHECK_ONLY )
350                return STORAGE_OK;
351       
352        irc->status |= USTATUS_IDENTIFIED;
353       
354        return STORAGE_OK;
355}
356
357static storage_status_t xml_load( const char *my_nick, const char *password, irc_t *irc )
358{
359        return xml_load_real( my_nick, password, irc, XML_PASS_UNKNOWN );
360}
361
362static storage_status_t xml_check_pass( const char *my_nick, const char *password )
363{
364        /* This is a little bit risky because we have to pass NULL for the
365           irc_t argument. This *should* be fine, if I didn't miss anything... */
366        return xml_load_real( my_nick, password, NULL, XML_PASS_CHECK_ONLY );
367}
368
369static int xml_printf( int fd, int indent, char *fmt, ... )
370{
371        va_list params;
372        char *out;
373        char tabs[9] = "\t\t\t\t\t\t\t\t";
374        int len;
375       
376        /* Maybe not very clean, but who needs more than 8 levels of indentation anyway? */
377        if( write( fd, tabs, indent <= 8 ? indent : 8 ) != indent )
378                return 0;
379       
380        va_start( params, fmt );
381        out = g_markup_vprintf_escaped( fmt, params );
382        va_end( params );
383       
384        len = strlen( out );
385        len -= write( fd, out, len );
386        g_free( out );
387       
388        return len == 0;
389}
390
391static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data );
392
393static storage_status_t xml_save( irc_t *irc, int overwrite )
394{
395        char path[512], *path2, *pass_buf = NULL;
396        set_t *set;
397        account_t *acc;
398        int fd;
399        md5_byte_t pass_md5[21];
400        md5_state_t md5_state;
401       
402        if( irc->password == NULL )
403        {
404                irc_usermsg( irc, "Please register yourself if you want to save your settings." );
405                return STORAGE_OTHER_ERROR;
406        }
407       
408        path2 = g_strdup( irc->nick );
409        nick_lc( path2 );
410        g_snprintf( path, sizeof( path ) - 2, "%s%s%s", global.conf->configdir, path2, ".xml" );
411        g_free( path2 );
412       
413        if( !overwrite && g_access( path, F_OK ) == 0 )
414                return STORAGE_ALREADY_EXISTS;
415       
416        strcat( path, "~" );
417        if( ( fd = open( path, O_WRONLY | O_CREAT | O_TRUNC, 0600 ) ) < 0 )
418        {
419                irc_usermsg( irc, "Error while opening configuration file." );
420                return STORAGE_OTHER_ERROR;
421        }
422       
423        /* Generate a salted md5sum of the password. Use 5 bytes for the salt
424           (to prevent dictionary lookups of passwords) to end up with a 21-
425           byte password hash, more convenient for base64 encoding. */
426        random_bytes( pass_md5 + 16, 5 );
427        md5_init( &md5_state );
428        md5_append( &md5_state, (md5_byte_t*) irc->password, strlen( irc->password ) );
429        md5_append( &md5_state, pass_md5 + 16, 5 ); /* Add the salt. */
430        md5_finish( &md5_state, pass_md5 );
431        /* Save the hash in base64-encoded form. */
432        pass_buf = base64_encode( pass_md5, 21 );
433       
434        if( !xml_printf( fd, 0, "<user nick=\"%s\" password=\"%s\" version=\"%d\">\n", irc->nick, pass_buf, XML_FORMAT_VERSION ) )
435                goto write_error;
436       
437        g_free( pass_buf );
438       
439        for( set = irc->set; set; set = set->next )
440                if( set->value && set->def )
441                        if( !xml_printf( fd, 1, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
442                                goto write_error;
443       
444        for( acc = irc->accounts; acc; acc = acc->next )
445        {
446                unsigned char *pass_cr;
447                char *pass_b64;
448                int pass_len;
449               
450                pass_len = arc_encode( acc->pass, strlen( acc->pass ), (unsigned char**) &pass_cr, irc->password, 12 );
451                pass_b64 = base64_encode( pass_cr, pass_len );
452                g_free( pass_cr );
453               
454                if( !xml_printf( fd, 1, "<account protocol=\"%s\" handle=\"%s\" password=\"%s\" autoconnect=\"%d\"", acc->prpl->name, acc->user, pass_b64, acc->auto_connect ) )
455                {
456                        g_free( pass_b64 );
457                        goto write_error;
458                }
459                g_free( pass_b64 );
460               
461                if( acc->server && acc->server[0] && !xml_printf( fd, 0, " server=\"%s\"", acc->server ) )
462                        goto write_error;
463                if( !xml_printf( fd, 0, ">\n" ) )
464                        goto write_error;
465               
466                for( set = acc->set; set; set = set->next )
467                        if( set->value && set->def && !( set->flags & ACC_SET_NOSAVE ) )
468                                if( !xml_printf( fd, 2, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
469                                        goto write_error;
470               
471                /* This probably looks pretty strange. g_hash_table_foreach
472                   is quite a PITA already (but it can't get much better in
473                   C without using #define, I'm afraid), and since it
474                   doesn't seem to be possible to abort the foreach on write
475                   errors, so instead let's use the _find function and
476                   return TRUE on write errors. Which means, if we found
477                   something, there was an error. :-) */
478                if( g_hash_table_find( acc->nicks, xml_save_nick, & fd ) )
479                        goto write_error;
480               
481                if( !xml_printf( fd, 1, "</account>\n" ) )
482                        goto write_error;
483        }
484       
485        if( !xml_printf( fd, 0, "</user>\n" ) )
486                goto write_error;
487       
488        close( fd );
489       
490        path2 = g_strndup( path, strlen( path ) - 1 );
491        if( rename( path, path2 ) != 0 )
492        {
493                irc_usermsg( irc, "Error while renaming temporary configuration file." );
494               
495                g_free( path2 );
496                unlink( path );
497               
498                return STORAGE_OTHER_ERROR;
499        }
500       
501        g_free( path2 );
502       
503        return STORAGE_OK;
504
505write_error:
506        g_free( pass_buf );
507       
508        irc_usermsg( irc, "Write error. Disk full?" );
509        close( fd );
510       
511        return STORAGE_OTHER_ERROR;
512}
513
514static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data )
515{
516        return !xml_printf( *( (int*) data ), 2, "<buddy handle=\"%s\" nick=\"%s\" />\n", key, value );
517}
518
519static storage_status_t xml_remove( const char *nick, const char *password )
520{
521        char s[512], *lc;
522        storage_status_t status;
523
524        status = xml_check_pass( nick, password );
525        if( status != STORAGE_OK )
526                return status;
527
528        lc = g_strdup( nick );
529        nick_lc( lc );
530        g_snprintf( s, 511, "%s%s%s", global.conf->configdir, lc, ".xml" );
531        g_free( lc );
532       
533        if( unlink( s ) == -1 )
534                return STORAGE_OTHER_ERROR;
535       
536        return STORAGE_OK;
537}
538
539storage_t storage_xml = {
540        .name = "xml",
541        .init = xml_init,
542        .check_pass = xml_check_pass,
543        .remove = xml_remove,
544        .load = xml_load,
545        .save = xml_save
546};
Note: See TracBrowser for help on using the repository browser.