source: trunk/qt/prefs.cc @ 13686

Last change on this file since 13686 was 13686, checked in by jordan, 8 years ago

(trunk, qt) #5192 'Free Memory Read error in transmission-qt's Prefs destructor' -- fixed.

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