source: trunk/qt/Prefs.cc @ 14539

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

Unify/prettify Qt client headers style

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