source: trunk/qt/prefs.cc @ 8588

Last change on this file since 8588 was 8588, checked in by charles, 13 years ago

(trunk) #2131: clean up benc read/write API

  • Property svn:keywords set to Date Rev Author Id
File size: 12.4 KB
Line 
1/*
2 * This file Copyright (C) 2009 Charles Kerr <charles@transmissionbt.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: prefs.cc 8588 2009-06-02 01:48:48Z charles $
11 */
12
13#include <cassert>
14#include <iostream>
15#include <cstdlib> // strtod
16
17#include <QDir>
18#include <QFile>
19
20#include <libtransmission/transmission.h>
21#include <libtransmission/bencode.h>
22#include <libtransmission/json.h>
23#include <libtransmission/utils.h>
24#include "prefs.h"
25#include "types.h"
26
27/***
28****
29***/
30
31Prefs::PrefItem Prefs::myItems[] =
32{
33    /* gui settings */
34    { OPTIONS_PROMPT, "show-options-window", QVariant::Bool },
35    { OPEN_DIALOG_FOLDER, "open-dialog-dir", QVariant::String },
36    { INHIBIT_HIBERNATION, "inhibit-desktop-hibernation", QVariant::Bool },
37    { DIR_WATCH, "watch-dir", QVariant::String },
38    { DIR_WATCH_ENABLED, "watch-dir-enabled", QVariant::Bool },
39    { SHOW_TRAY_ICON, "show-notification-area-icon", QVariant::Bool },
40    { SHOW_DESKTOP_NOTIFICATION, "show-desktop-notification", QVariant::Bool },
41    { START, "start-added-torrents", QVariant::Bool },
42    { TRASH_ORIGINAL, "trash-original-torrent-files", QVariant::Bool },
43    { ASKQUIT, "prompt-before-exit", QVariant::Bool },
44    { SORT_MODE, "sort-mode", TrTypes::SortModeType },
45    { SORT_REVERSED, "sort-reversed", QVariant::Bool },
46    { MINIMAL_VIEW, "minimal-view", QVariant::Bool },
47    { FILTERBAR, "show-filterbar", QVariant::Bool },
48    { STATUSBAR, "show-statusbar", QVariant::Bool },
49    { STATUSBAR_STATS, "statusbar-stats", QVariant::String },
50    { TOOLBAR, "show-toolbar" , QVariant::Bool },
51    { BLOCKLIST_DATE, "blocklist-date", QVariant::DateTime },
52    { BLOCKLIST_UPDATES_ENABLED, "blocklist-updates-enabled" , QVariant::Bool },
53    { MAIN_WINDOW_LAYOUT_ORDER, "main-window-layout-order", QVariant::String },
54    { MAIN_WINDOW_HEIGHT, "main-window-height", QVariant::Int },
55    { MAIN_WINDOW_WIDTH, "main-window-width", QVariant::Int },
56    { MAIN_WINDOW_X, "main-window-x", QVariant::Int },
57    { MAIN_WINDOW_Y, "main-window-y", QVariant::Int },
58    { FILTER_MODE, "filter-mode", TrTypes::FilterModeType },
59    { SESSION_IS_REMOTE, "remote-session-enabled", QVariant::Bool },
60    { SESSION_REMOTE_HOST, "remote-session-host", QVariant::String },
61    { SESSION_REMOTE_PORT, "remote-session-port", QVariant::Int },
62    { SESSION_REMOTE_AUTH, "remote-session-requres-authentication", QVariant::Bool },
63    { SESSION_REMOTE_USERNAME, "remote-session-username", QVariant::String },
64    { SESSION_REMOTE_PASSWORD, "remote-session-password", QVariant::String },
65
66    /* libtransmission settings */
67    { ALT_SPEED_LIMIT_UP, TR_PREFS_KEY_ALT_SPEED_UP, QVariant::Int },
68    { ALT_SPEED_LIMIT_DOWN, TR_PREFS_KEY_ALT_SPEED_DOWN, QVariant::Int },
69    { ALT_SPEED_LIMIT_ENABLED, TR_PREFS_KEY_ALT_SPEED_ENABLED, QVariant::Bool },
70    { ALT_SPEED_LIMIT_TIME_BEGIN, TR_PREFS_KEY_ALT_SPEED_TIME_BEGIN, QVariant::Int },
71    { ALT_SPEED_LIMIT_TIME_END, TR_PREFS_KEY_ALT_SPEED_TIME_END, QVariant::Int },
72    { ALT_SPEED_LIMIT_TIME_ENABLED, TR_PREFS_KEY_ALT_SPEED_TIME_ENABLED, QVariant::Bool },
73    { ALT_SPEED_LIMIT_TIME_DAY, TR_PREFS_KEY_ALT_SPEED_TIME_DAY, QVariant::Int },
74    { BLOCKLIST_ENABLED, TR_PREFS_KEY_BLOCKLIST_ENABLED, QVariant::Bool },
75    { DSPEED, TR_PREFS_KEY_DSPEED, QVariant::Int },
76    { DSPEED_ENABLED, TR_PREFS_KEY_DSPEED_ENABLED, QVariant::Bool },
77    { DOWNLOAD_DIR, TR_PREFS_KEY_DOWNLOAD_DIR, QVariant::String },
78    { ENCRYPTION, TR_PREFS_KEY_ENCRYPTION, QVariant::Int },
79    { LAZY_BITFIELD, TR_PREFS_KEY_LAZY_BITFIELD, QVariant::Bool },
80    { MSGLEVEL, TR_PREFS_KEY_MSGLEVEL, QVariant::Int },
81    { OPEN_FILE_LIMIT, TR_PREFS_KEY_OPEN_FILE_LIMIT, QVariant::Int },
82    { PEER_LIMIT_GLOBAL, TR_PREFS_KEY_PEER_LIMIT_GLOBAL, QVariant::Int },
83    { PEER_LIMIT_TORRENT, TR_PREFS_KEY_PEER_LIMIT_TORRENT, QVariant::Int },
84    { PEER_PORT, TR_PREFS_KEY_PEER_PORT, QVariant::Int },
85    { PEER_PORT_RANDOM_ON_START, TR_PREFS_KEY_PEER_PORT_RANDOM_ON_START, QVariant::Bool },
86    { PEER_PORT_RANDOM_LOW, TR_PREFS_KEY_PEER_PORT_RANDOM_LOW, QVariant::Int },
87    { PEER_PORT_RANDOM_HIGH, TR_PREFS_KEY_PEER_PORT_RANDOM_HIGH, QVariant::Int },
88    { SOCKET_TOS, TR_PREFS_KEY_PEER_SOCKET_TOS, QVariant::Int },
89    { PEX_ENABLED, TR_PREFS_KEY_PEX_ENABLED, QVariant::Bool },
90    { DHT_ENABLED, TR_PREFS_KEY_DHT_ENABLED, QVariant::Bool },
91    { PORT_FORWARDING, TR_PREFS_KEY_PORT_FORWARDING, QVariant::Bool },
92    { PROXY_AUTH_ENABLED, TR_PREFS_KEY_PROXY_AUTH_ENABLED, QVariant::Bool },
93    { PREALLOCATION, TR_PREFS_KEY_PREALLOCATION, QVariant::Int },
94    { PROXY_ENABLED, TR_PREFS_KEY_PROXY_ENABLED, QVariant::Bool },
95    { PROXY_PASSWORD, TR_PREFS_KEY_PROXY_PASSWORD, QVariant::String },
96    { PROXY_PORT, TR_PREFS_KEY_PROXY_PORT, QVariant::Int },
97    { PROXY, TR_PREFS_KEY_PROXY, QVariant::String },
98    { PROXY_TYPE, TR_PREFS_KEY_PROXY_TYPE, QVariant::Int },
99    { PROXY_USERNAME, TR_PREFS_KEY_PROXY_USERNAME, QVariant::String },
100    { RATIO, TR_PREFS_KEY_RATIO, QVariant::Double },
101    { RATIO_ENABLED, TR_PREFS_KEY_RATIO_ENABLED, QVariant::Bool },
102    { RPC_AUTH_REQUIRED, TR_PREFS_KEY_RPC_AUTH_REQUIRED, QVariant::Bool },
103    { RPC_ENABLED, TR_PREFS_KEY_RPC_ENABLED, QVariant::Bool },
104    { RPC_PASSWORD, TR_PREFS_KEY_RPC_PASSWORD, QVariant::String },
105    { RPC_PORT, TR_PREFS_KEY_RPC_PORT, QVariant::Int },
106    { RPC_USERNAME, TR_PREFS_KEY_RPC_USERNAME, QVariant::String },
107    { RPC_WHITELIST_ENABLED, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, QVariant::Bool },
108    { RPC_WHITELIST, TR_PREFS_KEY_RPC_WHITELIST, QVariant::String },
109    { USPEED_ENABLED, TR_PREFS_KEY_USPEED_ENABLED, QVariant::Bool },
110    { USPEED, TR_PREFS_KEY_USPEED, QVariant::Int },
111    { UPLOAD_SLOTS_PER_TORRENT, TR_PREFS_KEY_UPLOAD_SLOTS_PER_TORRENT, QVariant::Int }
112};
113
114/***
115****
116***/
117
118Prefs :: Prefs( const char * configDir ):
119    myConfigDir( configDir )
120{
121    assert( sizeof(myItems) / sizeof(myItems[0]) == PREFS_COUNT );
122    for( int i=0; i<PREFS_COUNT; ++i )
123        assert( myItems[i].id == i );
124
125    tr_benc top;
126    tr_bencInitDict( &top, 0 );
127    initDefaults( &top );
128    tr_sessionLoadSettings( &top, configDir, NULL );
129    for( int i=0; i<PREFS_COUNT; ++i )
130    {
131        double d;
132        tr_bool boolVal;
133        int64_t intVal;
134        const char * str;
135        tr_benc * b( tr_bencDictFind( &top, myItems[i].key ) );
136
137        switch( myItems[i].type )
138        {
139            case QVariant::Int:
140                if( tr_bencGetInt( b, &intVal ) )
141                    myValues[i].setValue( qlonglong(intVal) );
142                break;
143            case TrTypes::SortModeType:
144                if( tr_bencGetStr( b, &str ) )
145                    myValues[i] = QVariant::fromValue( SortMode( str ) );
146                break;
147            case TrTypes::FilterModeType:
148                if( tr_bencGetStr( b, &str ) )
149                    myValues[i] = QVariant::fromValue( FilterMode( str ) );
150                break;
151            case QVariant::String:
152                if( tr_bencGetStr( b, &str ) )
153                    myValues[i].setValue( QString::fromUtf8(str) );
154                break;
155            case QVariant::Bool:
156                if( tr_bencGetBool( b, &boolVal ) )
157                    myValues[i].setValue( bool(boolVal) );
158                break;
159            case QVariant::Double:
160                if( tr_bencGetReal( b, &d ) )
161                    myValues[i].setValue( d );
162                break;
163            case QVariant::DateTime:
164                if( tr_bencGetInt( b, &intVal ) )
165                    myValues[i].setValue( QDateTime :: fromTime_t( intVal ) );
166                break;
167            default:
168                assert( "unhandled type" && 0 );
169                break;
170        }
171    }
172
173    tr_bencFree( &top );
174}
175
176Prefs :: ~Prefs( )
177{
178    tr_benc top;
179
180    /* load in the existing preferences file */
181    QFile file( QDir( myConfigDir ).absoluteFilePath( "settings.json" ) );
182    file.open( QIODevice::ReadOnly | QIODevice::Text );
183    const QByteArray oldPrefs = file.readAll( );
184    file.close( );
185    if( tr_jsonParse( "settings.json", oldPrefs.data(), oldPrefs.length(), &top, NULL ) )
186        tr_bencInitDict( &top, PREFS_COUNT );
187
188    /* merge our own settings with the ones already in the file */
189    for( int i=0; i<PREFS_COUNT; ++i ) {
190        const char * key = myItems[i].key;
191        const QVariant& val = myValues[i];
192        switch( myItems[i].type ) {
193            case QVariant::Int:
194                tr_bencDictAddInt( &top, key, val.toInt() );
195                break;
196            case TrTypes::SortModeType:
197                tr_bencDictAddStr( &top, key, val.value<SortMode>().name().toUtf8().constData() );
198                break;
199            case TrTypes::FilterModeType:
200                tr_bencDictAddStr( &top, key, val.value<FilterMode>().name().toUtf8().constData() );
201                break;
202            case QVariant::String:
203                tr_bencDictAddStr( &top, key, val.toString().toUtf8().constData() );
204                break;
205            case QVariant::Bool:
206                tr_bencDictAddBool( &top, key, val.toBool() );
207                break;
208            case QVariant::Double:
209                tr_bencDictAddReal( &top, key, val.toDouble() );
210                break;
211            case QVariant::DateTime:
212                tr_bencDictAddInt( &top, key, val.toDateTime().toTime_t() );
213                break;
214            default:
215                assert( "unhandled type" && 0 );
216                break;
217        }
218    }
219
220    /* write back out the serialized preferences */
221    tr_bencToFile( &top, TR_FMT_JSON, file.fileName().toUtf8().constData() );
222    tr_bencFree( &top );
223}
224
225/**
226 * This is where we initialize the preferences file with the default values.
227 * If you add a new preferences key, you /must/ add a default value here.
228 */
229void
230Prefs :: initDefaults( tr_benc * d )
231{
232    tr_bencDictAddStr( d, keyStr(DIR_WATCH), tr_getDefaultDownloadDir( ) );
233    tr_bencDictAddInt( d, keyStr(DIR_WATCH_ENABLED), false );
234    tr_bencDictAddInt( d, keyStr(INHIBIT_HIBERNATION), false );
235    tr_bencDictAddInt( d, keyStr(BLOCKLIST_DATE), 0 );
236    tr_bencDictAddInt( d, keyStr(BLOCKLIST_UPDATES_ENABLED), true );
237    tr_bencDictAddStr( d, keyStr(OPEN_DIALOG_FOLDER), QDir::home().absolutePath().toLatin1() );
238    tr_bencDictAddInt( d, keyStr(TOOLBAR), true );
239    tr_bencDictAddInt( d, keyStr(FILTERBAR), true );
240    tr_bencDictAddInt( d, keyStr(STATUSBAR), true );
241    tr_bencDictAddInt( d, keyStr(SHOW_TRAY_ICON), false );
242    tr_bencDictAddInt( d, keyStr(SHOW_DESKTOP_NOTIFICATION), true );
243    tr_bencDictAddStr( d, keyStr(STATUSBAR_STATS), "total-ratio" );
244    tr_bencDictAddInt( d, keyStr(OPTIONS_PROMPT), true );
245    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_HEIGHT), 500 );
246    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_WIDTH), 300 );
247    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_X), 50 );
248    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_Y), 50 );
249    tr_bencDictAddStr( d, keyStr(FILTER_MODE), "all" );
250    tr_bencDictAddStr( d, keyStr(MAIN_WINDOW_LAYOUT_ORDER), "menu,toolbar,filter,list,statusbar" );
251    tr_bencDictAddStr( d, keyStr(DOWNLOAD_DIR), tr_getDefaultDownloadDir( ) );
252    tr_bencDictAddInt( d, keyStr(ASKQUIT), true );
253    tr_bencDictAddStr( d, keyStr(SORT_MODE), "sort-by-name" );
254    tr_bencDictAddInt( d, keyStr(SORT_REVERSED), false );
255    tr_bencDictAddInt( d, keyStr(MINIMAL_VIEW), false );
256    tr_bencDictAddInt( d, keyStr(START), true );
257    tr_bencDictAddInt( d, keyStr(TRASH_ORIGINAL), false );
258    tr_bencDictAddStr( d, keyStr(SESSION_REMOTE_HOST), "localhost" );
259    tr_bencDictAddInt( d, keyStr(SESSION_REMOTE_PORT), atoi(TR_DEFAULT_RPC_PORT_STR) );
260    tr_bencDictAddBool( d, keyStr(SESSION_IS_REMOTE), false );
261    tr_bencDictAddBool( d, keyStr(SESSION_REMOTE_AUTH), false );
262}
263
264/***
265****
266***/
267
268bool
269Prefs :: getBool( int key ) const
270{
271    assert( myItems[key].type == QVariant::Bool );
272    return myValues[key].toBool( );
273}
274
275QString
276Prefs :: getString( int key ) const
277{
278    assert( myItems[key].type == QVariant::String );
279    return myValues[key].toString( );
280}
281
282int
283Prefs :: getInt( int key ) const
284{
285    assert( myItems[key].type == QVariant::Int );
286    return myValues[key].toInt( );
287}
288
289double
290Prefs :: getDouble( int key ) const
291{
292    assert( myItems[key].type == QVariant::Double );
293    return myValues[key].toDouble( );
294}
295
296QDateTime
297Prefs :: getDateTime( int key ) const
298{
299    assert( myItems[key].type == QVariant::DateTime );
300    return myValues[key].toDateTime( );
301}
302
303/***
304****
305***/
306
307void
308Prefs :: toggleBool( int key )
309{
310    set( key, !getBool( key ) );
311}
Note: See TracBrowser for help on using the repository browser.