source: trunk/gtk/conf.c @ 7390

Last change on this file since 7390 was 7390, checked in by charles, 10 years ago

(trunk gtk) fix prefs oopsie reported by RolCol?

  • Property svn:keywords set to Date Rev Author Id
File size: 12.3 KB
Line 
1/******************************************************************************
2 * $Id: conf.c 7390 2008-12-14 22:14:00Z charles $
3 *
4 * Copyright (c) 2005-2008 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#include <assert.h>
26#include <errno.h>
27#include <stdio.h>
28#include <stdlib.h>
29#include <string.h>
30
31#include <unistd.h>
32
33#include <glib.h>
34#include <glib/gi18n.h>
35#include <glib/gstdio.h>
36
37#include <libtransmission/transmission.h>
38#include <libtransmission/bencode.h>
39#include <libtransmission/platform.h>
40
41#include "conf.h"
42#include "util.h"
43
44#define MY_NAME "transmission"
45
46static char * gl_confdir = NULL;
47static char * gl_lockpath = NULL;
48
49/* errstr may be NULL, this might be called before GTK is initialized */
50gboolean
51cf_init( const char   * configDir,
52         char        ** errstr )
53{
54    if( errstr != NULL )
55        *errstr = NULL;
56
57    gl_confdir = g_strdup( configDir );
58
59    if( mkdir_p( gl_confdir, 0755 ) )
60        return TRUE;
61
62    if( errstr != NULL )
63        *errstr = g_strdup_printf( _( "Couldn't create \"%1$s\": %2$s" ),
64                                  gl_confdir, g_strerror( errno ) );
65
66    return FALSE;
67}
68
69/***
70****
71****  Lockfile
72****
73***/
74
75/* errstr may be NULL, this might be called before GTK is initialized */
76static gboolean
77lockfile( const char *         filename,
78          tr_lockfile_state_t *tr_state,
79          char **              errstr )
80{
81    const tr_lockfile_state_t state = tr_lockfile( filename );
82    const gboolean            success = state == TR_LOCKFILE_SUCCESS;
83
84    if( errstr ) switch( state )
85        {
86            case TR_LOCKFILE_EOPEN:
87                *errstr =
88                    g_strdup_printf( _( "Couldn't open \"%1$s\": %2$s" ),
89                                    filename, g_strerror( errno ) );
90                break;
91
92            case TR_LOCKFILE_ELOCK:
93                *errstr = g_strdup_printf( _( "%s is already running." ),
94                                          g_get_application_name( ) );
95                break;
96
97            case TR_LOCKFILE_SUCCESS:
98                *errstr = NULL;
99                break;
100        }
101
102    if( tr_state != NULL )
103        *tr_state = state;
104
105    return success;
106}
107
108static char*
109getLockFilename( void )
110{
111    assert( gl_confdir != NULL );
112    return g_build_filename( gl_confdir, "lock", NULL );
113}
114
115static void
116cf_removelocks( void )
117{
118    if( gl_lockpath )
119    {
120        g_unlink( gl_lockpath );
121        g_free( gl_lockpath );
122    }
123}
124
125/* errstr may be NULL, this might be called before GTK is initialized */
126gboolean
127cf_lock( tr_lockfile_state_t *tr_state,
128         char **              errstr )
129{
130    char *         path = getLockFilename( );
131    const gboolean didLock = lockfile( path, tr_state, errstr );
132
133    if( didLock )
134        gl_lockpath = g_strdup( path );
135    g_atexit( cf_removelocks );
136    g_free( path );
137    return didLock;
138}
139
140/***
141****
142****  Preferences
143****
144***/
145
146static char*
147getPrefsFilename( void )
148{
149    assert( gl_confdir != NULL );
150    return g_build_filename( gl_confdir, "settings.json", NULL );
151}
152
153static tr_benc*
154getPrefs( void )
155{
156    static tr_benc settings;
157    static gboolean loaded = FALSE;
158
159    if( !loaded )
160    {
161        tr_bencInitDict( &settings, 0 );
162        tr_sessionLoadSettings( &settings, gl_confdir, MY_NAME );
163        loaded = TRUE;
164    }
165
166    return &settings;
167}
168
169/***
170****
171***/
172
173tr_benc*
174pref_get_all( void )
175{
176    return getPrefs( );
177}
178
179int64_t
180pref_int_get( const char * key )
181{
182    int64_t i = 0;
183
184    tr_bencDictFindInt( getPrefs( ), key, &i );
185    return i;
186}
187
188void
189pref_int_set( const char * key,
190              int64_t      value )
191{
192    tr_bencDictAddInt( getPrefs( ), key, value );
193}
194
195void
196pref_int_set_default( const char * key,
197                      int64_t      value )
198{
199    if( !tr_bencDictFind( getPrefs( ), key ) )
200        pref_int_set( key, value );
201}
202
203/***
204****
205***/
206
207gboolean
208pref_flag_get( const char * key )
209{
210    int64_t i;
211
212    tr_bencDictFindInt( getPrefs( ), key, &i );
213    return i != 0;
214}
215
216gboolean
217pref_flag_eval( pref_flag_t  val,
218                const char * key )
219{
220    switch( val )
221    {
222        case PREF_FLAG_TRUE:
223            return TRUE;
224
225        case PREF_FLAG_FALSE:
226            return FALSE;
227
228        default:
229            return pref_flag_get( key );
230    }
231}
232
233void
234pref_flag_set( const char * key,
235               gboolean     value )
236{
237    pref_int_set( key, value != 0 );
238}
239
240void
241pref_flag_set_default( const char * key,
242                       gboolean     value )
243{
244    pref_int_set_default( key, value != 0 );
245}
246
247/***
248****
249***/
250
251const char*
252pref_string_get( const char * key )
253{
254    const char * str = NULL;
255
256    tr_bencDictFindStr( getPrefs( ), key, &str );
257    return str;
258}
259
260void
261pref_string_set( const char * key,
262                 const char * value )
263{
264    tr_bencDictAddStr( getPrefs( ), key, value );
265}
266
267void
268pref_string_set_default( const char * key,
269                         const char * value )
270{
271    if( !tr_bencDictFind( getPrefs( ), key ) )
272        pref_string_set( key, value );
273}
274
275/***
276****
277***/
278
279void
280pref_save( tr_session * session )
281{
282    tr_sessionSaveSettings( session, gl_confdir, getPrefs( ) );
283}
284
285/***
286****
287***/
288
289#if !GLIB_CHECK_VERSION( 2, 8, 0 )
290static void
291tr_file_set_contents( const char *   filename,
292                      const void *   out,
293                      size_t         len,
294                      GError* unused UNUSED )
295{
296    FILE * fp = fopen( filename, "wb+" );
297
298    if( fp != NULL )
299    {
300        fwrite( out, 1, len, fp );
301        fclose( fp );
302    }
303}
304
305 #define g_file_set_contents tr_file_set_contents
306#endif
307
308static char*
309getCompat080PrefsFilename( void )
310{
311    assert( gl_confdir != NULL );
312
313    return g_build_filename( g_get_home_dir( ), ".transmission", "gtk", "prefs", NULL );
314}
315
316static char*
317getCompat090PrefsFilename( void )
318{
319    assert( gl_confdir != NULL );
320
321    return g_build_filename( g_get_home_dir( ), ".transmission", "gtk", "prefs.ini", NULL );
322}
323
324static char*
325getCompat121PrefsFilename( void )
326{
327    return g_build_filename( g_get_user_config_dir( ), "transmission", "gtk", "prefs.ini", NULL );
328}
329
330static void
331translate_08_to_09( const char* oldfile,
332                    const char* newfile )
333{
334    static struct pref_entry {
335        const char*   oldkey;
336        const char*   newkey;
337    } pref_table[] = {
338        { "add-behavior-ipc",       "add-behavior-ipc"               },
339        { "add-behavior-standard",  "add-behavior-standard"          },
340        { "download-directory",     "default-download-directory"     },
341        { "download-limit",         "download-limit"                 },
342        { "use-download-limit",     "download-limit-enabled"         },
343        { "listening-port",         "listening-port"                 },
344        { "use-nat-traversal",      "nat-traversal-enabled"          },
345        { "use-peer-exchange",      "pex-enabled"                    },
346        { "ask-quit",               "prompt-before-exit"             },
347        { "ask-download-directory", "prompt-for-download-directory"  },
348        { "use-tray-icon",          "system-tray-icon-enabled"       },
349        { "upload-limit",           "upload-limit"                   },
350        { "use-upload-limit",       "upload-limit-enabled"           }
351    };
352
353    GString * out = g_string_new( NULL );
354    gchar *   contents = NULL;
355    gsize     contents_len = 0;
356    tr_benc   top;
357
358    memset( &top, 0, sizeof( tr_benc ) );
359
360    if( g_file_get_contents( oldfile, &contents, &contents_len, NULL )
361      && !tr_bencLoad( contents, contents_len, &top, NULL )
362      && top.type == TYPE_DICT )
363    {
364        unsigned int i;
365        g_string_append( out, "\n[general]\n" );
366        for( i = 0; i < G_N_ELEMENTS( pref_table ); ++i )
367        {
368            const tr_benc * val = tr_bencDictFind( &top,
369                                                   pref_table[i].oldkey );
370            if( val != NULL )
371            {
372                const char * valstr = val->val.s.s;
373                if( !strcmp( valstr, "yes" ) ) valstr = "true";
374                if( !strcmp( valstr, "no" ) ) valstr = "false";
375                g_string_append_printf( out, "%s=%s\n",
376                                        pref_table[i].newkey,
377                                        valstr );
378            }
379        }
380    }
381
382    g_file_set_contents( newfile, out->str, out->len, NULL );
383    g_string_free( out, TRUE );
384    g_free( contents );
385}
386
387static void
388translate_keyfile_to_json( const char * old_file,
389                           const char * new_file )
390{
391    tr_benc    dict;
392    GKeyFile * keyfile;
393    gchar **   keys;
394    gsize      i;
395    gsize      length;
396
397    static struct pref_entry {
398        const char*   oldkey;
399        const char*   newkey;
400    } renamed[] = {
401        { "default-download-directory", "download-dir"             },
402        { "encrypted-connections-only", "encryption"               },
403        { "listening-port",             "peer-port"                },
404        { "nat-traversal-enabled",      "port-forwarding-enabled"  },
405        { "open-dialog-folder",         "open-dialog-dir"          },
406        { "watch-folder",               "watch-dir"                },
407        { "watch-folder-enabled",       "watch-dir-enabled"        }
408    };
409
410    keyfile = g_key_file_new( );
411    g_key_file_load_from_file( keyfile, old_file, 0, NULL );
412    length = 0;
413    keys = g_key_file_get_keys( keyfile, "general", &length, NULL );
414
415    tr_bencInitDict( &dict, length );
416    for( i = 0; i < length; ++i )
417    {
418        guint        j;
419        const char * key = keys[i];
420        gchar *      val = g_key_file_get_value( keyfile, "general", key,
421                                                 NULL );
422
423        for( j = 0; j < G_N_ELEMENTS( renamed ); ++j )
424            if( !strcmp( renamed[j].oldkey, key ) )
425                key = renamed[j].newkey;
426
427        if( !strcmp( val, "true" ) || !strcmp( val, "false" ) )
428            tr_bencDictAddInt( &dict, key, !strcmp( val, "true" ) );
429        else
430        {
431            char * end;
432            long   l;
433            errno = 0;
434            l = strtol( val, &end, 10 );
435            if( !errno && end && !*end )
436                tr_bencDictAddInt( &dict, key, l );
437            else
438                tr_bencDictAddStr( &dict, key, val );
439        }
440
441        g_free( val );
442    }
443
444    g_key_file_free( keyfile );
445    tr_bencSaveJSONFile( new_file, &dict );
446    tr_bencFree( &dict );
447}
448
449void
450cf_check_older_configs( void )
451{
452    char * filename = getPrefsFilename( );
453
454    if( !g_file_test( filename, G_FILE_TEST_IS_REGULAR ) )
455    {
456        char * key1 = getCompat121PrefsFilename( );
457        char * key2 = getCompat090PrefsFilename( );
458        char * benc = getCompat080PrefsFilename( );
459
460        if( g_file_test( key1, G_FILE_TEST_IS_REGULAR ) )
461        {
462            translate_keyfile_to_json( key1, filename );
463        }
464        else if( g_file_test( key2, G_FILE_TEST_IS_REGULAR ) )
465        {
466            translate_keyfile_to_json( key2, filename );
467        }
468        else if( g_file_test( benc, G_FILE_TEST_IS_REGULAR ) )
469        {
470            char * tmpfile;
471            int    fd =
472                g_file_open_tmp( "transmission-prefs-XXXXXX", &tmpfile,
473                                 NULL );
474            if( fd != -1 ) close( fd );
475            translate_08_to_09( benc, tmpfile );
476            translate_keyfile_to_json( tmpfile, filename );
477            unlink( tmpfile );
478        }
479
480        g_free( benc );
481        g_free( key2 );
482        g_free( key1 );
483    }
484
485    g_free( filename );
486}
487
Note: See TracBrowser for help on using the repository browser.