source: trunk/qt/prefs.cc @ 8216

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

(qt) better integration of sort & filter modes into the preferences mechanism

File size: 11.9 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:$
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
60    /* libtransmission settings */
61    { ALT_SPEED_LIMIT_UP, TR_PREFS_KEY_ALT_SPEED_UP, QVariant::Int },
62    { ALT_SPEED_LIMIT_DOWN, TR_PREFS_KEY_ALT_SPEED_DOWN, QVariant::Int },
63    { ALT_SPEED_LIMIT_ENABLED, TR_PREFS_KEY_ALT_SPEED_ENABLED, QVariant::Bool },
64    { ALT_SPEED_LIMIT_TIME_BEGIN, TR_PREFS_KEY_ALT_SPEED_TIME_BEGIN, QVariant::Int },
65    { ALT_SPEED_LIMIT_TIME_END, TR_PREFS_KEY_ALT_SPEED_TIME_END, QVariant::Int },
66    { ALT_SPEED_LIMIT_TIME_ENABLED, TR_PREFS_KEY_ALT_SPEED_TIME_ENABLED, QVariant::Bool },
67    { ALT_SPEED_LIMIT_TIME_DAY, TR_PREFS_KEY_ALT_SPEED_TIME_DAY, QVariant::Int },
68    { BLOCKLIST_ENABLED, TR_PREFS_KEY_BLOCKLIST_ENABLED, QVariant::Bool },
69    { DSPEED, TR_PREFS_KEY_DSPEED, QVariant::Int },
70    { DSPEED_ENABLED, TR_PREFS_KEY_DSPEED_ENABLED, QVariant::Bool },
71    { DOWNLOAD_DIR, TR_PREFS_KEY_DOWNLOAD_DIR, QVariant::String },
72    { ENCRYPTION, TR_PREFS_KEY_ENCRYPTION, QVariant::Int },
73    { LAZY_BITFIELD, TR_PREFS_KEY_LAZY_BITFIELD, QVariant::Bool },
74    { MSGLEVEL, TR_PREFS_KEY_MSGLEVEL, QVariant::Int },
75    { OPEN_FILE_LIMIT, TR_PREFS_KEY_OPEN_FILE_LIMIT, QVariant::Int },
76    { PEER_LIMIT_GLOBAL, TR_PREFS_KEY_PEER_LIMIT_GLOBAL, QVariant::Int },
77    { PEER_LIMIT_TORRENT, TR_PREFS_KEY_PEER_LIMIT_TORRENT, QVariant::Int },
78    { PEER_PORT, TR_PREFS_KEY_PEER_PORT, QVariant::Int },
79    { PEER_PORT_RANDOM_ON_START, TR_PREFS_KEY_PEER_PORT_RANDOM_ON_START, QVariant::Bool },
80    { PEER_PORT_RANDOM_LOW, TR_PREFS_KEY_PEER_PORT_RANDOM_LOW, QVariant::Int },
81    { PEER_PORT_RANDOM_HIGH, TR_PREFS_KEY_PEER_PORT_RANDOM_HIGH, QVariant::Int },
82    { SOCKET_TOS, TR_PREFS_KEY_PEER_SOCKET_TOS, QVariant::Int },
83    { PEX_ENABLED, TR_PREFS_KEY_PEX_ENABLED, QVariant::Bool },
84    { PORT_FORWARDING, TR_PREFS_KEY_PORT_FORWARDING, QVariant::Bool },
85    { PROXY_AUTH_ENABLED, TR_PREFS_KEY_PROXY_AUTH_ENABLED, QVariant::Bool },
86    { PREALLOCATION, TR_PREFS_KEY_PREALLOCATION, QVariant::Int },
87    { PROXY_ENABLED, TR_PREFS_KEY_PROXY_ENABLED, QVariant::Bool },
88    { PROXY_PASSWORD, TR_PREFS_KEY_PROXY_PASSWORD, QVariant::String },
89    { PROXY_PORT, TR_PREFS_KEY_PROXY_PORT, QVariant::Int },
90    { PROXY, TR_PREFS_KEY_PROXY, QVariant::String },
91    { PROXY_TYPE, TR_PREFS_KEY_PROXY_TYPE, QVariant::Int },
92    { PROXY_USERNAME, TR_PREFS_KEY_PROXY_USERNAME, QVariant::String },
93    { RATIO, TR_PREFS_KEY_RATIO, QVariant::Double },
94    { RATIO_ENABLED, TR_PREFS_KEY_RATIO_ENABLED, QVariant::Bool },
95    { RPC_AUTH_REQUIRED, TR_PREFS_KEY_RPC_AUTH_REQUIRED, QVariant::Bool },
96    { RPC_ENABLED, TR_PREFS_KEY_RPC_ENABLED, QVariant::Bool },
97    { RPC_PASSWORD, TR_PREFS_KEY_RPC_PASSWORD, QVariant::String },
98    { RPC_PORT, TR_PREFS_KEY_RPC_PORT, QVariant::Int },
99    { RPC_USERNAME, TR_PREFS_KEY_RPC_USERNAME, QVariant::String },
100    { RPC_WHITELIST_ENABLED, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, QVariant::Bool },
101    { RPC_WHITELIST, TR_PREFS_KEY_RPC_WHITELIST, QVariant::String },
102    { SEED_RATIO_LIMIT, TR_PREFS_KEY_RATIO, QVariant::Double },
103    { SEED_RATIO_LIMITED, TR_PREFS_KEY_RATIO_ENABLED, QVariant::Bool },
104    { USPEED_ENABLED, TR_PREFS_KEY_USPEED_ENABLED, QVariant::Bool },
105    { USPEED, TR_PREFS_KEY_USPEED, QVariant::Int },
106    { UPLOAD_SLOTS_PER_TORRENT, TR_PREFS_KEY_UPLOAD_SLOTS_PER_TORRENT, QVariant::Int }
107};
108
109/***
110****
111***/
112
113Prefs :: Prefs( const char * configDir ):
114    myConfigDir( configDir )
115{
116    assert( sizeof(myItems) / sizeof(myItems[0]) == PREFS_COUNT );
117    for( int i=0; i<PREFS_COUNT; ++i )
118        assert( myItems[i].id == i );
119
120    tr_benc top;
121    tr_bencInitDict( &top, 0 );
122    initDefaults( &top );
123    tr_sessionLoadSettings( &top, configDir, NULL );
124    for( int i=0; i<PREFS_COUNT; ++i )
125    {
126        double d;
127        tr_bool boolVal;
128        int64_t intVal;
129        const char * str;
130        tr_benc * b( tr_bencDictFind( &top, myItems[i].key ) );
131
132        switch( myItems[i].type )
133        {
134            case QVariant::Int:
135                if( tr_bencGetInt( b, &intVal ) )
136                    myValues[i].setValue( qlonglong(intVal) );
137                break;
138            case TrTypes::SortModeType:
139                if( tr_bencGetStr( b, &str ) )
140                    myValues[i] = QVariant::fromValue( SortMode( str ) );
141                break;
142            case TrTypes::FilterModeType:
143                if( tr_bencGetStr( b, &str ) )
144                    myValues[i] = QVariant::fromValue( FilterMode( str ) );
145                break;
146            case QVariant::String:
147                if( tr_bencGetStr( b, &str ) )
148                    myValues[i].setValue( QString::fromUtf8(str) );
149                break;
150            case QVariant::Bool:
151                if( tr_bencGetBool( b, &boolVal ) )
152                    myValues[i].setValue( bool(boolVal) );
153                break;
154            case QVariant::Double:
155                if( tr_bencGetReal( b, &d ) )
156                    myValues[i].setValue( d );
157                break;
158            case QVariant::DateTime:
159                if( tr_bencGetInt( b, &intVal ) )
160                    myValues[i].setValue( QDateTime :: fromTime_t( intVal ) );
161                break;
162            default:
163                assert( "unhandled type" && 0 );
164                break;
165        }
166    }
167
168    tr_bencFree( &top );
169}
170
171Prefs :: ~Prefs( )
172{
173    tr_benc top;
174
175    /* load in the existing preferences file */
176    QFile file( QDir( myConfigDir ).absoluteFilePath( "settings.json" ) );
177    file.open( QIODevice::ReadOnly | QIODevice::Text );
178    const QByteArray oldPrefs = file.readAll( );
179    file.close( );
180    if( tr_jsonParse( oldPrefs.data(), oldPrefs.length(), &top, NULL ) )
181        tr_bencInitDict( &top, PREFS_COUNT );
182
183    /* merge our own settings with the ones already in the file */
184    for( int i=0; i<PREFS_COUNT; ++i ) {
185        const char * key = myItems[i].key;
186        const QVariant& val = myValues[i];
187        switch( myItems[i].type ) {
188            case QVariant::Int:
189                tr_bencDictAddInt( &top, key, val.toInt() );
190                break;
191            case TrTypes::SortModeType:
192                tr_bencDictAddStr( &top, key, val.value<SortMode>().name().toUtf8().constData() );
193                break;
194            case TrTypes::FilterModeType:
195                tr_bencDictAddStr( &top, key, val.value<FilterMode>().name().toUtf8().constData() );
196                break;
197            case QVariant::String:
198                tr_bencDictAddStr( &top, key, val.toString().toUtf8().constData() );
199                break;
200            case QVariant::Bool:
201                tr_bencDictAddBool( &top, key, val.toBool() );
202                break;
203            case QVariant::Double:
204                tr_bencDictAddReal( &top, key, val.toDouble() );
205                break;
206            case QVariant::DateTime:
207                tr_bencDictAddInt( &top, key, val.toDateTime().toTime_t() );
208                break;
209            default:
210                assert( "unhandled type" && 0 );
211                break;
212        }
213    }
214
215    /* write back out the serialized preferences */
216    char * json = tr_bencToJSON( &top );
217    if( json && *json ) {
218        file.open( QIODevice::WriteOnly | QIODevice::Text );
219        file.write( json );
220        file.close( );
221    }
222    tr_free( json );
223    tr_bencFree( &top );
224}
225
226/**
227 * This is where we initialize the preferences file with the default values.
228 * If you add a new preferences key, you /must/ add a default value here.
229 */
230void
231Prefs :: initDefaults( tr_benc * d )
232{
233    tr_bencDictAddStr( d, keyStr(DIR_WATCH), tr_getDefaultDownloadDir( ) );
234    tr_bencDictAddInt( d, keyStr(DIR_WATCH_ENABLED), false );
235    tr_bencDictAddInt( d, keyStr(INHIBIT_HIBERNATION), false );
236    tr_bencDictAddInt( d, keyStr(BLOCKLIST_DATE), 0 );
237    tr_bencDictAddInt( d, keyStr(BLOCKLIST_UPDATES_ENABLED), true );
238    tr_bencDictAddStr( d, keyStr(OPEN_DIALOG_FOLDER), QDir::home().absolutePath().toLatin1() );
239    tr_bencDictAddInt( d, keyStr(TOOLBAR), true );
240    tr_bencDictAddInt( d, keyStr(FILTERBAR), true );
241    tr_bencDictAddInt( d, keyStr(STATUSBAR), true );
242    tr_bencDictAddInt( d, keyStr(SHOW_TRAY_ICON), false );
243    tr_bencDictAddInt( d, keyStr(SHOW_DESKTOP_NOTIFICATION), true );
244    tr_bencDictAddStr( d, keyStr(STATUSBAR_STATS), "total-ratio" );
245    tr_bencDictAddInt( d, keyStr(OPTIONS_PROMPT), true );
246    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_HEIGHT), 500 );
247    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_WIDTH), 300 );
248    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_X), 50 );
249    tr_bencDictAddInt( d, keyStr(MAIN_WINDOW_Y), 50 );
250    tr_bencDictAddStr( d, keyStr(FILTER_MODE), "all" );
251    tr_bencDictAddStr( d, keyStr(MAIN_WINDOW_LAYOUT_ORDER), "menu,toolbar,filter,list,statusbar" );
252    tr_bencDictAddStr( d, keyStr(DOWNLOAD_DIR), tr_getDefaultDownloadDir( ) );
253    tr_bencDictAddInt( d, keyStr(ASKQUIT), true );
254    tr_bencDictAddStr( d, keyStr(SORT_MODE), "sort-by-name" );
255    tr_bencDictAddInt( d, keyStr(SORT_REVERSED), false );
256    tr_bencDictAddInt( d, keyStr(MINIMAL_VIEW), false );
257    tr_bencDictAddInt( d, keyStr(START), true );
258    tr_bencDictAddInt( d, keyStr(TRASH_ORIGINAL), false );
259}
260
261/***
262****
263***/
264
265bool
266Prefs :: getBool( int key ) const
267{
268    assert( myItems[key].type == QVariant::Bool );
269    return myValues[key].toBool( );
270}
271
272QString
273Prefs :: getString( int key ) const
274{
275    assert( myItems[key].type == QVariant::String );
276    return myValues[key].toString( );
277}
278
279int
280Prefs :: getInt( int key ) const
281{
282    assert( myItems[key].type == QVariant::Int );
283    return myValues[key].toInt( );
284}
285
286double
287Prefs :: getDouble( int key ) const
288{
289    assert( myItems[key].type == QVariant::Double );
290    return myValues[key].toDouble( );
291}
292
293QDateTime
294Prefs :: getDateTime( int key ) const
295{
296    assert( myItems[key].type == QVariant::DateTime );
297    return myValues[key].toDateTime( );
298}
299
300/***
301****
302***/
303
304void
305Prefs :: toggleBool( int key )
306{
307    set( key, !getBool( key ) );
308}
Note: See TracBrowser for help on using the repository browser.