source: trunk/qt/prefs.cc @ 12214

Last change on this file since 12214 was 12214, checked in by jordan, 11 years ago

(trunk qt) housekeeping: tr_bool --> bool

  • Property svn:keywords set to Date Rev Author Id
File size: 13.3 KB
Line 
1/*
2 * This file Copyright (C) Mnemosyne LLC
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2
6 * as published by the Free Software Foundation.
7 *
8 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
9 *
10 * $Id: prefs.cc 12214 2011-03-23 18:26:01Z jordan $
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    { ASKQUIT, "prompt-before-exit", QVariant::Bool },
42    { SORT_MODE, "sort-mode", TrTypes::SortModeType },
43    { SORT_REVERSED, "sort-reversed", QVariant::Bool },
44    { COMPACT_VIEW, "compact-view", QVariant::Bool },
45    { FILTERBAR, "show-filterbar", QVariant::Bool },
46    { STATUSBAR, "show-statusbar", QVariant::Bool },
47    { STATUSBAR_STATS, "statusbar-stats", QVariant::String },
48    { SHOW_TRACKER_SCRAPES, "show-extra-peer-details", QVariant::Bool },
49    { SHOW_BACKUP_TRACKERS, "show-backup-trackers", QVariant::Bool },
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    { FILTER_TRACKERS, "filter-trackers", QVariant::String },
60    { FILTER_TEXT, "filter-text", QVariant::String },
61    { SESSION_IS_REMOTE, "remote-session-enabled", QVariant::Bool },
62    { SESSION_REMOTE_HOST, "remote-session-host", QVariant::String },
63    { SESSION_REMOTE_PORT, "remote-session-port", QVariant::Int },
64    { SESSION_REMOTE_AUTH, "remote-session-requres-authentication", QVariant::Bool },
65    { SESSION_REMOTE_USERNAME, "remote-session-username", QVariant::String },
66    { SESSION_REMOTE_PASSWORD, "remote-session-password", QVariant::String },
67    { USER_HAS_GIVEN_INFORMED_CONSENT, "user-has-given-informed-consent", QVariant::Bool },
68
69    /* libtransmission settings */
70    { ALT_SPEED_LIMIT_UP, TR_PREFS_KEY_ALT_SPEED_UP_KBps, QVariant::Int },
71    { ALT_SPEED_LIMIT_DOWN, TR_PREFS_KEY_ALT_SPEED_DOWN_KBps, QVariant::Int },
72    { ALT_SPEED_LIMIT_ENABLED, TR_PREFS_KEY_ALT_SPEED_ENABLED, QVariant::Bool },
73    { ALT_SPEED_LIMIT_TIME_BEGIN, TR_PREFS_KEY_ALT_SPEED_TIME_BEGIN, QVariant::Int },
74    { ALT_SPEED_LIMIT_TIME_END, TR_PREFS_KEY_ALT_SPEED_TIME_END, QVariant::Int },
75    { ALT_SPEED_LIMIT_TIME_ENABLED, TR_PREFS_KEY_ALT_SPEED_TIME_ENABLED, QVariant::Bool },
76    { ALT_SPEED_LIMIT_TIME_DAY, TR_PREFS_KEY_ALT_SPEED_TIME_DAY, QVariant::Int },
77    { BLOCKLIST_ENABLED, TR_PREFS_KEY_BLOCKLIST_ENABLED, QVariant::Bool },
78    { BLOCKLIST_URL, TR_PREFS_KEY_BLOCKLIST_URL, QVariant::String },
79    { DSPEED, TR_PREFS_KEY_DSPEED_KBps, QVariant::Int },
80    { DSPEED_ENABLED, TR_PREFS_KEY_DSPEED_ENABLED, QVariant::Bool },
81    { DOWNLOAD_DIR, TR_PREFS_KEY_DOWNLOAD_DIR, QVariant::String },
82    { ENCRYPTION, TR_PREFS_KEY_ENCRYPTION, QVariant::Int },
83    { IDLE_LIMIT, TR_PREFS_KEY_IDLE_LIMIT, QVariant::Int },
84    { IDLE_LIMIT_ENABLED, TR_PREFS_KEY_IDLE_LIMIT_ENABLED, QVariant::Bool },
85    { INCOMPLETE_DIR, TR_PREFS_KEY_INCOMPLETE_DIR, QVariant::String },
86    { INCOMPLETE_DIR_ENABLED, TR_PREFS_KEY_INCOMPLETE_DIR_ENABLED, QVariant::Bool },
87    { MSGLEVEL, TR_PREFS_KEY_MSGLEVEL, QVariant::Int },
88    { OPEN_FILE_LIMIT, TR_PREFS_KEY_OPEN_FILE_LIMIT, QVariant::Int },
89    { PEER_LIMIT_GLOBAL, TR_PREFS_KEY_PEER_LIMIT_GLOBAL, QVariant::Int },
90    { PEER_LIMIT_TORRENT, TR_PREFS_KEY_PEER_LIMIT_TORRENT, QVariant::Int },
91    { PEER_PORT, TR_PREFS_KEY_PEER_PORT, QVariant::Int },
92    { PEER_PORT_RANDOM_ON_START, TR_PREFS_KEY_PEER_PORT_RANDOM_ON_START, QVariant::Bool },
93    { PEER_PORT_RANDOM_LOW, TR_PREFS_KEY_PEER_PORT_RANDOM_LOW, QVariant::Int },
94    { PEER_PORT_RANDOM_HIGH, TR_PREFS_KEY_PEER_PORT_RANDOM_HIGH, QVariant::Int },
95    { SCRIPT_TORRENT_DONE_ENABLED, TR_PREFS_KEY_SCRIPT_TORRENT_DONE_ENABLED, QVariant::Bool },
96    { SCRIPT_TORRENT_DONE_FILENAME, TR_PREFS_KEY_SCRIPT_TORRENT_DONE_FILENAME, QVariant::String },
97    { SOCKET_TOS, TR_PREFS_KEY_PEER_SOCKET_TOS, QVariant::Int },
98    { START, TR_PREFS_KEY_START, QVariant::Bool },
99    { TRASH_ORIGINAL, TR_PREFS_KEY_TRASH_ORIGINAL, QVariant::Bool },
100    { PEX_ENABLED, TR_PREFS_KEY_PEX_ENABLED, QVariant::Bool },
101    { DHT_ENABLED, TR_PREFS_KEY_DHT_ENABLED, QVariant::Bool },
102    { UTP_ENABLED, TR_PREFS_KEY_UTP_ENABLED, QVariant::Bool },
103    { LPD_ENABLED, TR_PREFS_KEY_LPD_ENABLED, QVariant::Bool },
104    { PORT_FORWARDING, TR_PREFS_KEY_PORT_FORWARDING, QVariant::Bool },
105    { PREALLOCATION, TR_PREFS_KEY_PREALLOCATION, QVariant::Int },
106    { RATIO, TR_PREFS_KEY_RATIO, QVariant::Double },
107    { RATIO_ENABLED, TR_PREFS_KEY_RATIO_ENABLED, QVariant::Bool },
108    { RENAME_PARTIAL_FILES, TR_PREFS_KEY_RENAME_PARTIAL_FILES, QVariant::Bool },
109    { RPC_AUTH_REQUIRED, TR_PREFS_KEY_RPC_AUTH_REQUIRED, QVariant::Bool },
110    { RPC_ENABLED, TR_PREFS_KEY_RPC_ENABLED, QVariant::Bool },
111    { RPC_PASSWORD, TR_PREFS_KEY_RPC_PASSWORD, QVariant::String },
112    { RPC_PORT, TR_PREFS_KEY_RPC_PORT, QVariant::Int },
113    { RPC_USERNAME, TR_PREFS_KEY_RPC_USERNAME, QVariant::String },
114    { RPC_WHITELIST_ENABLED, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, QVariant::Bool },
115    { RPC_WHITELIST, TR_PREFS_KEY_RPC_WHITELIST, QVariant::String },
116    { USPEED_ENABLED, TR_PREFS_KEY_USPEED_ENABLED, QVariant::Bool },
117    { USPEED, TR_PREFS_KEY_USPEED_KBps, QVariant::Int },
118    { UPLOAD_SLOTS_PER_TORRENT, TR_PREFS_KEY_UPLOAD_SLOTS_PER_TORRENT, QVariant::Int }
119};
120
121/***
122****
123***/
124
125Prefs :: Prefs( const char * configDir ):
126    myConfigDir( configDir )
127{
128    assert( sizeof(myItems) / sizeof(myItems[0]) == PREFS_COUNT );
129    for( int i=0; i<PREFS_COUNT; ++i )
130        assert( myItems[i].id == i );
131
132    // these are the prefs that don't get saved to settings.json
133    // when the application exits.
134    myTemporaryPrefs << FILTER_TEXT;
135
136    tr_benc top;
137    tr_bencInitDict( &top, 0 );
138    initDefaults( &top );
139    tr_sessionLoadSettings( &top, configDir, NULL );
140    for( int i=0; i<PREFS_COUNT; ++i )
141    {
142        double d;
143        bool boolVal;
144        int64_t intVal;
145        const char * str;
146        tr_benc * b( tr_bencDictFind( &top, myItems[i].key ) );
147
148        switch( myItems[i].type )
149        {
150            case QVariant::Int:
151                if( tr_bencGetInt( b, &intVal ) )
152                    myValues[i].setValue( qlonglong(intVal) );
153                break;
154            case TrTypes::SortModeType:
155                if( tr_bencGetStr( b, &str ) )
156                    myValues[i] = QVariant::fromValue( SortMode( str ) );
157                break;
158            case TrTypes::FilterModeType:
159                if( tr_bencGetStr( b, &str ) )
160                    myValues[i] = QVariant::fromValue( FilterMode( str ) );
161                break;
162            case QVariant::String:
163                if( tr_bencGetStr( b, &str ) )
164                    myValues[i].setValue( QString::fromUtf8(str) );
165                break;
166            case QVariant::Bool:
167                if( tr_bencGetBool( b, &boolVal ) )
168                    myValues[i].setValue( bool(boolVal) );
169                break;
170            case QVariant::Double:
171                if( tr_bencGetReal( b, &d ) )
172                    myValues[i].setValue( d );
173                break;
174            case QVariant::DateTime:
175                if( tr_bencGetInt( b, &intVal ) )
176                    myValues[i].setValue( QDateTime :: fromTime_t( intVal ) );
177                break;
178            default:
179                assert( "unhandled type" && 0 );
180                break;
181        }
182    }
183
184    tr_bencFree( &top );
185}
186
187Prefs :: ~Prefs( )
188{
189    tr_benc top;
190
191    /* load in the existing preferences file */
192    QFile file( QDir( myConfigDir ).absoluteFilePath( "settings.json" ) );
193    file.open( QIODevice::ReadOnly | QIODevice::Text );
194    const QByteArray oldPrefs = file.readAll( );
195    file.close( );
196    if( tr_jsonParse( "settings.json", oldPrefs.data(), oldPrefs.length(), &top, NULL ) )
197        tr_bencInitDict( &top, PREFS_COUNT );
198
199    /* merge our own settings with the ones already in the file */
200    for( int i=0; i<PREFS_COUNT; ++i )
201    {
202        if( myTemporaryPrefs.contains( i ) )
203            continue;
204
205        const char * key = myItems[i].key;
206        const QVariant& val = myValues[i];
207
208        switch( myItems[i].type )
209        {
210            case QVariant::Int:
211                tr_bencDictAddInt( &top, key, val.toInt() );
212                break;
213            case TrTypes::SortModeType:
214                tr_bencDictAddStr( &top, key, val.value<SortMode>().name().toUtf8().constData() );
215                break;
216            case TrTypes::FilterModeType:
217                tr_bencDictAddStr( &top, key, val.value<FilterMode>().name().toUtf8().constData() );
218                break;
219            case QVariant::String:
220                tr_bencDictAddStr( &top, key, val.toString().toUtf8().constData() );
221                break;
222            case QVariant::Bool:
223                tr_bencDictAddBool( &top, key, val.toBool() );
224                break;
225            case QVariant::Double:
226                tr_bencDictAddReal( &top, key, val.toDouble() );
227                break;
228            case QVariant::DateTime:
229                tr_bencDictAddInt( &top, key, val.toDateTime().toTime_t() );
230                break;
231            default:
232                assert( "unhandled type" && 0 );
233                break;
234        }
235    }
236
237    /* write back out the serialized preferences */
238    tr_bencToFile( &top, TR_FMT_JSON, file.fileName().toUtf8().constData() );
239    tr_bencFree( &top );
240}
241
242/**
243 * This is where we initialize the preferences file with the default values.
244 * If you add a new preferences key, you /must/ add a default value here.
245 */
246void
247Prefs :: initDefaults( tr_benc * d )
248{
249    tr_bencDictAddStr ( d, keyStr(DIR_WATCH), tr_getDefaultDownloadDir( ) );
250    tr_bencDictAddBool( d, keyStr(DIR_WATCH_ENABLED), false );
251    tr_bencDictAddBool( d, keyStr(INHIBIT_HIBERNATION), false );
252    tr_bencDictAddInt ( d, keyStr(BLOCKLIST_DATE), 0 );
253    tr_bencDictAddBool( d, keyStr(BLOCKLIST_UPDATES_ENABLED), true );
254    tr_bencDictAddStr ( d, keyStr(OPEN_DIALOG_FOLDER), QDir::home().absolutePath().toLatin1() );
255    tr_bencDictAddInt ( d, keyStr(SHOW_TRACKER_SCRAPES), false );
256    tr_bencDictAddBool( d, keyStr(TOOLBAR), true );
257    tr_bencDictAddBool( d, keyStr(FILTERBAR), true );
258    tr_bencDictAddBool( d, keyStr(STATUSBAR), true );
259    tr_bencDictAddBool( d, keyStr(SHOW_TRAY_ICON), false );
260    tr_bencDictAddBool( d, keyStr(SHOW_DESKTOP_NOTIFICATION), true );
261    tr_bencDictAddStr ( d, keyStr(STATUSBAR_STATS), "total-ratio" );
262    tr_bencDictAddBool( d, keyStr(SHOW_TRACKER_SCRAPES), false );
263    tr_bencDictAddBool( d, keyStr(SHOW_BACKUP_TRACKERS), false );
264    tr_bencDictAddBool( d, keyStr(OPTIONS_PROMPT), true );
265    tr_bencDictAddInt ( d, keyStr(MAIN_WINDOW_HEIGHT), 500 );
266    tr_bencDictAddInt ( d, keyStr(MAIN_WINDOW_WIDTH), 300 );
267    tr_bencDictAddInt ( d, keyStr(MAIN_WINDOW_X), 50 );
268    tr_bencDictAddInt ( d, keyStr(MAIN_WINDOW_Y), 50 );
269    tr_bencDictAddStr ( d, keyStr(FILTER_MODE), "all" );
270    tr_bencDictAddStr ( d, keyStr(MAIN_WINDOW_LAYOUT_ORDER), "menu,toolbar,filter,list,statusbar" );
271    tr_bencDictAddStr ( d, keyStr(DOWNLOAD_DIR), tr_getDefaultDownloadDir( ) );
272    tr_bencDictAddBool( d, keyStr(ASKQUIT), true );
273    tr_bencDictAddStr ( d, keyStr(SORT_MODE), "sort-by-name" );
274    tr_bencDictAddBool( d, keyStr(SORT_REVERSED), false );
275    tr_bencDictAddBool( d, keyStr(COMPACT_VIEW), false );
276    tr_bencDictAddStr ( d, keyStr(SESSION_REMOTE_HOST), "localhost" );
277    tr_bencDictAddInt ( d, keyStr(SESSION_REMOTE_PORT), atoi(TR_DEFAULT_RPC_PORT_STR) );
278    tr_bencDictAddBool( d, keyStr(SESSION_IS_REMOTE), false );
279    tr_bencDictAddBool( d, keyStr(SESSION_REMOTE_AUTH), false );
280    tr_bencDictAddBool( d, keyStr(USER_HAS_GIVEN_INFORMED_CONSENT), false );
281}
282
283/***
284****
285***/
286
287bool
288Prefs :: getBool( int key ) const
289{
290    assert( myItems[key].type == QVariant::Bool );
291    return myValues[key].toBool( );
292}
293
294QString
295Prefs :: getString( int key ) const
296{
297    assert( myItems[key].type == QVariant::String );
298    return myValues[key].toString( );
299}
300
301int
302Prefs :: getInt( int key ) const
303{
304    assert( myItems[key].type == QVariant::Int );
305    return myValues[key].toInt( );
306}
307
308double
309Prefs :: getDouble( int key ) const
310{
311    assert( myItems[key].type == QVariant::Double );
312    return myValues[key].toDouble( );
313}
314
315QDateTime
316Prefs :: getDateTime( int key ) const
317{
318    assert( myItems[key].type == QVariant::DateTime );
319    return myValues[key].toDateTime( );
320}
321
322/***
323****
324***/
325
326void
327Prefs :: toggleBool( int key )
328{
329    set( key, !getBool( key ) );
330}
Note: See TracBrowser for help on using the repository browser.