source: trunk/qt/prefs.cc @ 13724

Last change on this file since 13724 was 13724, checked in by jordan, 9 years ago

(trunk, qt) #5060 'start minimized to tray option' -- added.

  • Property svn:keywords set to Date Rev Author Id
File size: 13.9 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 13724 2012-12-30 22:51:55Z jordan $
11 */
12
13#include <cassert>
14#include <iostream>
15
16#include <QDir>
17#include <QFile>
18
19#include <libtransmission/transmission.h>
20#include <libtransmission/utils.h>
21#include <libtransmission/variant.h>
22#include <stdlib.h>
23#include "prefs.h"
24#include "types.h"
25#include "utils.h"
26
27/***
28****
29***/
30
31Prefs::PrefItem Prefs::myItems[] =
32{
33  /* gui settings */
34  { OPTIONS_PROMPT, TR_KEY_show_options_window, QVariant::Bool },
35  { OPEN_DIALOG_FOLDER, TR_KEY_open_dialog_dir, QVariant::String },
36  { INHIBIT_HIBERNATION, TR_KEY_inhibit_desktop_hibernation, QVariant::Bool },
37  { DIR_WATCH, TR_KEY_watch_dir, QVariant::String },
38  { DIR_WATCH_ENABLED, TR_KEY_watch_dir_enabled, QVariant::Bool },
39  { SHOW_TRAY_ICON, TR_KEY_show_notification_area_icon, QVariant::Bool },
40  { START_MINIMIZED, TR_KEY_start_minimized, QVariant::Bool },
41  { SHOW_DESKTOP_NOTIFICATION, TR_KEY_show_desktop_notification, QVariant::Bool },
42  { ASKQUIT, TR_KEY_prompt_before_exit, QVariant::Bool },
43  { SORT_MODE, TR_KEY_sort_mode, TrTypes::SortModeType },
44  { SORT_REVERSED, TR_KEY_sort_reversed, QVariant::Bool },
45  { COMPACT_VIEW, TR_KEY_compact_view, QVariant::Bool },
46  { FILTERBAR, TR_KEY_show_filterbar, QVariant::Bool },
47  { STATUSBAR, TR_KEY_show_statusbar, QVariant::Bool },
48  { STATUSBAR_STATS, TR_KEY_statusbar_stats, QVariant::String },
49  { SHOW_TRACKER_SCRAPES, TR_KEY_show_extra_peer_details, QVariant::Bool },
50  { SHOW_BACKUP_TRACKERS, TR_KEY_show_backup_trackers, QVariant::Bool },
51  { TOOLBAR, TR_KEY_show_toolbar , QVariant::Bool },
52  { BLOCKLIST_DATE, TR_KEY_blocklist_date, QVariant::DateTime },
53  { BLOCKLIST_UPDATES_ENABLED, TR_KEY_blocklist_updates_enabled , QVariant::Bool },
54  { MAIN_WINDOW_LAYOUT_ORDER, TR_KEY_main_window_layout_order, QVariant::String },
55  { MAIN_WINDOW_HEIGHT, TR_KEY_main_window_height, QVariant::Int },
56  { MAIN_WINDOW_WIDTH, TR_KEY_main_window_width, QVariant::Int },
57  { MAIN_WINDOW_X, TR_KEY_main_window_x, QVariant::Int },
58  { MAIN_WINDOW_Y, TR_KEY_main_window_y, QVariant::Int },
59  { FILTER_MODE, TR_KEY_filter_mode, TrTypes::FilterModeType },
60  { FILTER_TRACKERS, TR_KEY_filter_trackers, QVariant::String },
61  { FILTER_TEXT, TR_KEY_filter_text, QVariant::String },
62  { SESSION_IS_REMOTE, TR_KEY_remote_session_enabled, QVariant::Bool },
63  { SESSION_REMOTE_HOST, TR_KEY_remote_session_host, QVariant::String },
64  { SESSION_REMOTE_PORT, TR_KEY_remote_session_port, QVariant::Int },
65  { SESSION_REMOTE_AUTH, TR_KEY_remote_session_requres_authentication, QVariant::Bool },
66  { SESSION_REMOTE_USERNAME, TR_KEY_remote_session_username, QVariant::String },
67  { SESSION_REMOTE_PASSWORD, TR_KEY_remote_session_password, QVariant::String },
68  { USER_HAS_GIVEN_INFORMED_CONSENT, TR_KEY_user_has_given_informed_consent, QVariant::Bool },
69
70  /* libtransmission settings */
71  { ALT_SPEED_LIMIT_UP, TR_KEY_alt_speed_up, QVariant::Int },
72  { ALT_SPEED_LIMIT_DOWN, TR_KEY_alt_speed_down, QVariant::Int },
73  { ALT_SPEED_LIMIT_ENABLED, TR_KEY_alt_speed_enabled, QVariant::Bool },
74  { ALT_SPEED_LIMIT_TIME_BEGIN, TR_KEY_alt_speed_time_begin, QVariant::Int },
75  { ALT_SPEED_LIMIT_TIME_END, TR_KEY_alt_speed_time_end, QVariant::Int },
76  { ALT_SPEED_LIMIT_TIME_ENABLED, TR_KEY_alt_speed_time_enabled, QVariant::Bool },
77  { ALT_SPEED_LIMIT_TIME_DAY, TR_KEY_alt_speed_time_day, QVariant::Int },
78  { BLOCKLIST_ENABLED, TR_KEY_blocklist_enabled, QVariant::Bool },
79  { BLOCKLIST_URL, TR_KEY_blocklist_url, QVariant::String },
80  { DSPEED, TR_KEY_speed_limit_down, QVariant::Int },
81  { DSPEED_ENABLED, TR_KEY_speed_limit_down_enabled, QVariant::Bool },
82  { DOWNLOAD_DIR, TR_KEY_download_dir, QVariant::String },
83  { DOWNLOAD_QUEUE_ENABLED, TR_KEY_download_queue_enabled, QVariant::Bool },
84  { DOWNLOAD_QUEUE_SIZE, TR_KEY_download_queue_size, QVariant::Int },
85  { ENCRYPTION, TR_KEY_encryption, QVariant::Int },
86  { IDLE_LIMIT, TR_KEY_idle_seeding_limit, QVariant::Int },
87  { IDLE_LIMIT_ENABLED, TR_KEY_idle_seeding_limit_enabled, QVariant::Bool },
88  { INCOMPLETE_DIR, TR_KEY_incomplete_dir, QVariant::String },
89  { INCOMPLETE_DIR_ENABLED, TR_KEY_incomplete_dir_enabled, QVariant::Bool },
90  { MSGLEVEL, TR_KEY_message_level, QVariant::Int },
91  { PEER_LIMIT_GLOBAL, TR_KEY_peer_limit_global, QVariant::Int },
92  { PEER_LIMIT_TORRENT, TR_KEY_peer_limit_per_torrent, QVariant::Int },
93  { PEER_PORT, TR_KEY_peer_port, QVariant::Int },
94  { PEER_PORT_RANDOM_ON_START, TR_KEY_peer_port_random_on_start, QVariant::Bool },
95  { PEER_PORT_RANDOM_LOW, TR_KEY_peer_port_random_low, QVariant::Int },
96  { PEER_PORT_RANDOM_HIGH, TR_KEY_peer_port_random_high, QVariant::Int },
97  { QUEUE_STALLED_MINUTES, TR_KEY_queue_stalled_minutes, QVariant::Int },
98  { SCRIPT_TORRENT_DONE_ENABLED, TR_KEY_script_torrent_done_enabled, QVariant::Bool },
99  { SCRIPT_TORRENT_DONE_FILENAME, TR_KEY_script_torrent_done_filename, QVariant::String },
100  { SOCKET_TOS, TR_KEY_peer_socket_tos, QVariant::Int },
101  { START, TR_KEY_start_added_torrents, QVariant::Bool },
102  { TRASH_ORIGINAL, TR_KEY_trash_original_torrent_files, QVariant::Bool },
103  { PEX_ENABLED, TR_KEY_pex_enabled, QVariant::Bool },
104  { DHT_ENABLED, TR_KEY_dht_enabled, QVariant::Bool },
105  { UTP_ENABLED, TR_KEY_utp_enabled, QVariant::Bool },
106  { LPD_ENABLED, TR_KEY_lpd_enabled, QVariant::Bool },
107  { PORT_FORWARDING, TR_KEY_port, QVariant::Bool },
108  { PREALLOCATION, TR_KEY_preallocation, QVariant::Int },
109  { RATIO, TR_KEY_ratio_limit, QVariant::Double },
110  { RATIO_ENABLED, TR_KEY_ratio_limit_enabled, QVariant::Bool },
111  { RENAME_PARTIAL_FILES, TR_KEY_rename_partial_files, QVariant::Bool },
112  { RPC_AUTH_REQUIRED, TR_KEY_rpc_authentication_required, QVariant::Bool },
113  { RPC_ENABLED, TR_KEY_rpc_enabled, QVariant::Bool },
114  { RPC_PASSWORD, TR_KEY_rpc_password, QVariant::String },
115  { RPC_PORT, TR_KEY_rpc_port, QVariant::Int },
116  { RPC_USERNAME, TR_KEY_rpc_username, QVariant::String },
117  { RPC_WHITELIST_ENABLED, TR_KEY_rpc_whitelist_enabled, QVariant::Bool },
118  { RPC_WHITELIST, TR_KEY_rpc_whitelist, QVariant::String },
119  { USPEED_ENABLED, TR_KEY_speed_limit_up_enabled, QVariant::Bool },
120  { USPEED, TR_KEY_speed_limit_up, QVariant::Int },
121  { UPLOAD_SLOTS_PER_TORRENT, TR_KEY_upload_slots_per_torrent, QVariant::Int }
122};
123
124/***
125****
126***/
127
128Prefs :: Prefs (const char * configDir):
129  myConfigDir (QString::fromUtf8 (configDir))
130{
131  assert (sizeof(myItems) / sizeof(myItems[0]) == PREFS_COUNT);
132
133#ifndef NDEBUG
134  for (int i=0; i<PREFS_COUNT; ++i)
135    assert (myItems[i].id == i);
136#endif
137
138  // these are the prefs that don't get saved to settings.json
139  // when the application exits.
140  myTemporaryPrefs << FILTER_TEXT;
141
142  tr_variant top;
143  tr_variantInitDict (&top, 0);
144  initDefaults (&top);
145  tr_sessionLoadSettings (&top, configDir, NULL);
146
147  for (int i=0; i<PREFS_COUNT; ++i)
148    {
149      double d;
150      bool boolVal;
151      int64_t intVal;
152      const char * str;
153      size_t strLen;
154      tr_variant * b (tr_variantDictFind (&top, myItems[i].key));
155
156      switch (myItems[i].type)
157        {
158          case QVariant::Int:
159            if (tr_variantGetInt (b, &intVal))
160              myValues[i].setValue (qlonglong(intVal));
161            break;
162
163          case TrTypes::SortModeType:
164            if (tr_variantGetStr (b, &str, NULL))
165              myValues[i] = QVariant::fromValue (SortMode (str));
166            break;
167
168          case TrTypes::FilterModeType:
169            if (tr_variantGetStr (b, &str, NULL))
170              myValues[i] = QVariant::fromValue (FilterMode (str));
171            break;
172
173          case QVariant::String:
174            if (tr_variantGetStr (b, &str, &strLen))
175              myValues[i].setValue (QString::fromUtf8 (str, strLen));
176            break;
177
178          case QVariant::Bool:
179            if (tr_variantGetBool (b, &boolVal))
180              myValues[i].setValue (bool(boolVal));
181            break;
182
183          case QVariant::Double:
184            if (tr_variantGetReal (b, &d))
185              myValues[i].setValue (d);
186            break;
187
188          case QVariant::DateTime:
189            if (tr_variantGetInt (b, &intVal))
190                myValues[i].setValue (QDateTime :: fromTime_t (intVal));
191            break;
192
193          default:
194            assert ("unhandled type" && 0);
195            break;
196        }
197    }
198
199    tr_variantFree (&top);
200}
201
202Prefs :: ~Prefs ()
203{
204  // make a dict from settings.json
205  tr_variant current_settings;
206  tr_variantInitDict (&current_settings, PREFS_COUNT);
207  for (int i=0; i<PREFS_COUNT; ++i)
208    {
209      if (myTemporaryPrefs.contains(i))
210        continue;
211
212      const tr_quark key = myItems[i].key;
213      const QVariant& val = myValues[i];
214
215      switch (myItems[i].type)
216        {
217          case QVariant::Int:
218            tr_variantDictAddInt (&current_settings, key, val.toInt());
219            break;
220
221          case TrTypes::SortModeType:
222            tr_variantDictAddStr (&current_settings, key, val.value<SortMode>().name().toUtf8().constData());
223            break;
224
225          case TrTypes::FilterModeType:
226            tr_variantDictAddStr (&current_settings, key, val.value<FilterMode>().name().toUtf8().constData());
227            break;
228
229          case QVariant::String:
230            {
231              const QByteArray ba (val.toByteArray());
232              const char * s = ba.constData();
233              if (Utils::isValidUtf8 (s))
234                tr_variantDictAddStr (&current_settings, key, s);
235              else
236                tr_variantDictAddStr (&current_settings, key, val.toString().toUtf8().constData());
237            }
238            break;
239
240          case QVariant::Bool:
241            tr_variantDictAddBool (&current_settings, key, val.toBool());
242            break;
243
244          case QVariant::Double:
245            tr_variantDictAddReal (&current_settings, key, val.toDouble());
246            break;
247
248          case QVariant::DateTime:
249            tr_variantDictAddInt (&current_settings, key, val.toDateTime().toTime_t());
250            break;
251
252          default:
253            assert ("unhandled type" && 0);
254            break;
255        }
256    }
257
258  // update settings.json with our settings
259  tr_variant file_settings;
260  const QFile file (QDir(myConfigDir).absoluteFilePath("settings.json"));
261  if (tr_variantFromFile (&file_settings, TR_VARIANT_FMT_JSON, file.fileName().toUtf8().constData()))
262    tr_variantInitDict (&file_settings, PREFS_COUNT);
263  tr_variantMergeDicts (&file_settings, &current_settings);
264  tr_variantToFile (&file_settings, TR_VARIANT_FMT_JSON, file.fileName().toUtf8().constData());
265  tr_variantFree (&file_settings);
266
267  // cleanup
268  tr_variantFree (&current_settings);
269}
270
271/**
272 * This is where we initialize the preferences file with the default values.
273 * If you add a new preferences key, you /must/ add a default value here.
274 */
275void
276Prefs :: initDefaults (tr_variant * d)
277{
278  tr_variantDictReserve (d, 35);
279  tr_variantDictAddBool (d, TR_KEY_blocklist_updates_enabled, true);
280  tr_variantDictAddBool (d, TR_KEY_compact_view, false);
281  tr_variantDictAddBool (d, TR_KEY_inhibit_desktop_hibernation, false);
282  tr_variantDictAddBool (d, TR_KEY_prompt_before_exit, true);
283  tr_variantDictAddBool (d, TR_KEY_remote_session_enabled, false);
284  tr_variantDictAddBool (d, TR_KEY_remote_session_requres_authentication, false);
285  tr_variantDictAddBool (d, TR_KEY_show_backup_trackers, false);
286  tr_variantDictAddBool (d, TR_KEY_show_desktop_notification, true);
287  tr_variantDictAddBool (d, TR_KEY_show_extra_peer_details, false),
288  tr_variantDictAddBool (d, TR_KEY_show_filterbar, true);
289  tr_variantDictAddBool (d, TR_KEY_show_notification_area_icon, false);
290  tr_variantDictAddBool (d, TR_KEY_start_minimized, false);
291  tr_variantDictAddBool (d, TR_KEY_show_options_window, true);
292  tr_variantDictAddBool (d, TR_KEY_show_statusbar, true);
293  tr_variantDictAddBool (d, TR_KEY_show_toolbar, true);
294  tr_variantDictAddBool (d, TR_KEY_show_tracker_scrapes, false);
295  tr_variantDictAddBool (d, TR_KEY_sort_reversed, false);
296  tr_variantDictAddBool (d, TR_KEY_user_has_given_informed_consent, false);
297  tr_variantDictAddBool (d, TR_KEY_watch_dir_enabled, false);
298  tr_variantDictAddInt  (d, TR_KEY_blocklist_date, 0);
299  tr_variantDictAddInt  (d, TR_KEY_main_window_height, 500);
300  tr_variantDictAddInt  (d, TR_KEY_main_window_width, 300);
301  tr_variantDictAddInt  (d, TR_KEY_main_window_x, 50);
302  tr_variantDictAddInt  (d, TR_KEY_main_window_y, 50);
303  tr_variantDictAddInt  (d, TR_KEY_remote_session_port, atoi(TR_DEFAULT_RPC_PORT_STR));
304  tr_variantDictAddStr  (d, TR_KEY_download_dir, tr_getDefaultDownloadDir());
305  tr_variantDictAddStr  (d, TR_KEY_filter_mode, "all");
306  tr_variantDictAddStr  (d, TR_KEY_main_window_layout_order, "menu,toolbar,filter,list,statusbar");
307  tr_variantDictAddStr  (d, TR_KEY_open_dialog_dir, QDir::home().absolutePath().toUtf8());
308  tr_variantDictAddStr  (d, TR_KEY_remote_session_host, "localhost");
309  tr_variantDictAddStr  (d, TR_KEY_remote_session_password, "");
310  tr_variantDictAddStr  (d, TR_KEY_remote_session_username, "");
311  tr_variantDictAddStr  (d, TR_KEY_sort_mode, "sort-by-name");
312  tr_variantDictAddStr  (d, TR_KEY_statusbar_stats, "total-ratio");
313  tr_variantDictAddStr  (d, TR_KEY_watch_dir, tr_getDefaultDownloadDir());
314}
315
316/***
317****
318***/
319
320bool
321Prefs :: getBool (int key) const
322{
323  assert (myItems[key].type == QVariant::Bool);
324  return myValues[key].toBool();
325}
326
327QString
328Prefs :: getString (int key) const
329{
330  assert (myItems[key].type == QVariant::String);
331  const QByteArray b = myValues[key].toByteArray();
332  if (Utils::isValidUtf8 (b.constData()))
333    myValues[key].setValue (QString::fromUtf8 (b.constData()));
334  return myValues[key].toString();
335}
336
337int
338Prefs :: getInt (int key) const
339{
340  assert (myItems[key].type == QVariant::Int);
341  return myValues[key].toInt();
342}
343
344double
345Prefs :: getDouble (int key) const
346{
347  assert (myItems[key].type == QVariant::Double);
348  return myValues[key].toDouble();
349}
350
351QDateTime
352Prefs :: getDateTime (int key) const
353{
354  assert (myItems[key].type == QVariant::DateTime);
355  return myValues[key].toDateTime();
356}
357
358/***
359****
360***/
361
362void
363Prefs :: toggleBool (int key)
364{
365  set (key, !getBool(key));
366}
Note: See TracBrowser for help on using the repository browser.