source: trunk/qt/Prefs.cc @ 14540

Last change on this file since 14540 was 14540, checked in by mikedld, 6 years ago

Instead of standard C headers include their C++ counterparts

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