1 // Copyright (c) 2011-2020 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #if defined(HAVE_CONFIG_H)
6 #include <config/bitcoin-config.h>
7 #endif
8 
9 #include <qt/optionsmodel.h>
10 
11 #include <qt/bitcoinunits.h>
12 #include <qt/guiconstants.h>
13 #include <qt/guiutil.h>
14 
15 #include <interfaces/node.h>
16 #include <mapport.h>
17 #include <net.h>
18 #include <netbase.h>
19 #include <txdb.h>       // for -dbcache defaults
20 #include <util/string.h>
21 #include <validation.h> // For DEFAULT_SCRIPTCHECK_THREADS
22 
23 #include <QDebug>
24 #include <QLatin1Char>
25 #include <QSettings>
26 #include <QStringList>
27 
28 const char *DEFAULT_GUI_PROXY_HOST = "127.0.0.1";
29 
30 static const QString GetDefaultProxyAddress();
31 
OptionsModel(QObject * parent,bool resetSettings)32 OptionsModel::OptionsModel(QObject *parent, bool resetSettings) :
33     QAbstractListModel(parent)
34 {
35     Init(resetSettings);
36 }
37 
addOverriddenOption(const std::string & option)38 void OptionsModel::addOverriddenOption(const std::string &option)
39 {
40     strOverriddenByCommandLine += QString::fromStdString(option) + "=" + QString::fromStdString(gArgs.GetArg(option, "")) + " ";
41 }
42 
43 // Writes all missing QSettings with their default values
Init(bool resetSettings)44 void OptionsModel::Init(bool resetSettings)
45 {
46     if (resetSettings)
47         Reset();
48 
49     checkAndMigrate();
50 
51     QSettings settings;
52 
53     // Ensure restart flag is unset on client startup
54     setRestartRequired(false);
55 
56     // These are Qt-only settings:
57 
58     // Window
59     if (!settings.contains("fHideTrayIcon")) {
60         settings.setValue("fHideTrayIcon", false);
61     }
62     m_show_tray_icon = !settings.value("fHideTrayIcon").toBool();
63     Q_EMIT showTrayIconChanged(m_show_tray_icon);
64 
65     if (!settings.contains("fMinimizeToTray"))
66         settings.setValue("fMinimizeToTray", false);
67     fMinimizeToTray = settings.value("fMinimizeToTray").toBool() && m_show_tray_icon;
68 
69     if (!settings.contains("fMinimizeOnClose"))
70         settings.setValue("fMinimizeOnClose", false);
71     fMinimizeOnClose = settings.value("fMinimizeOnClose").toBool();
72 
73     // Display
74     if (!settings.contains("nDisplayUnit"))
75         settings.setValue("nDisplayUnit", BitcoinUnits::BTC);
76     nDisplayUnit = settings.value("nDisplayUnit").toInt();
77 
78     if (!settings.contains("strThirdPartyTxUrls"))
79         settings.setValue("strThirdPartyTxUrls", "");
80     strThirdPartyTxUrls = settings.value("strThirdPartyTxUrls", "").toString();
81 
82     if (!settings.contains("fCoinControlFeatures"))
83         settings.setValue("fCoinControlFeatures", false);
84     fCoinControlFeatures = settings.value("fCoinControlFeatures", false).toBool();
85 
86     // These are shared with the core or have a command-line parameter
87     // and we want command-line parameters to overwrite the GUI settings.
88     //
89     // If setting doesn't exist create it with defaults.
90     //
91     // If gArgs.SoftSetArg() or gArgs.SoftSetBoolArg() return false we were overridden
92     // by command-line and show this in the UI.
93 
94     // Main
95     if (!settings.contains("bPrune"))
96         settings.setValue("bPrune", false);
97     if (!settings.contains("nPruneSize"))
98         settings.setValue("nPruneSize", DEFAULT_PRUNE_TARGET_GB);
99     SetPruneEnabled(settings.value("bPrune").toBool());
100 
101     if (!settings.contains("nDatabaseCache"))
102         settings.setValue("nDatabaseCache", (qint64)nDefaultDbCache);
103     if (!gArgs.SoftSetArg("-dbcache", settings.value("nDatabaseCache").toString().toStdString()))
104         addOverriddenOption("-dbcache");
105 
106     if (!settings.contains("nThreadsScriptVerif"))
107         settings.setValue("nThreadsScriptVerif", DEFAULT_SCRIPTCHECK_THREADS);
108     if (!gArgs.SoftSetArg("-par", settings.value("nThreadsScriptVerif").toString().toStdString()))
109         addOverriddenOption("-par");
110 
111     if (!settings.contains("strDataDir"))
112         settings.setValue("strDataDir", GUIUtil::getDefaultDataDirectory());
113 
114     // Wallet
115 #ifdef ENABLE_WALLET
116     if (!settings.contains("bSpendZeroConfChange"))
117         settings.setValue("bSpendZeroConfChange", true);
118     if (!gArgs.SoftSetBoolArg("-spendzeroconfchange", settings.value("bSpendZeroConfChange").toBool()))
119         addOverriddenOption("-spendzeroconfchange");
120 
121     if (!settings.contains("external_signer_path"))
122         settings.setValue("external_signer_path", "");
123 
124     if (!gArgs.SoftSetArg("-signer", settings.value("external_signer_path").toString().toStdString())) {
125         addOverriddenOption("-signer");
126     }
127 #endif
128 
129     // Network
130     if (!settings.contains("fUseUPnP"))
131         settings.setValue("fUseUPnP", DEFAULT_UPNP);
132     if (!gArgs.SoftSetBoolArg("-upnp", settings.value("fUseUPnP").toBool()))
133         addOverriddenOption("-upnp");
134 
135     if (!settings.contains("fUseNatpmp")) {
136         settings.setValue("fUseNatpmp", DEFAULT_NATPMP);
137     }
138     if (!gArgs.SoftSetBoolArg("-natpmp", settings.value("fUseNatpmp").toBool())) {
139         addOverriddenOption("-natpmp");
140     }
141 
142     if (!settings.contains("fListen"))
143         settings.setValue("fListen", DEFAULT_LISTEN);
144     if (!gArgs.SoftSetBoolArg("-listen", settings.value("fListen").toBool()))
145         addOverriddenOption("-listen");
146 
147     if (!settings.contains("fUseProxy"))
148         settings.setValue("fUseProxy", false);
149     if (!settings.contains("addrProxy"))
150         settings.setValue("addrProxy", GetDefaultProxyAddress());
151     // Only try to set -proxy, if user has enabled fUseProxy
152     if ((settings.value("fUseProxy").toBool() && !gArgs.SoftSetArg("-proxy", settings.value("addrProxy").toString().toStdString())))
153         addOverriddenOption("-proxy");
154     else if(!settings.value("fUseProxy").toBool() && !gArgs.GetArg("-proxy", "").empty())
155         addOverriddenOption("-proxy");
156 
157     if (!settings.contains("fUseSeparateProxyTor"))
158         settings.setValue("fUseSeparateProxyTor", false);
159     if (!settings.contains("addrSeparateProxyTor"))
160         settings.setValue("addrSeparateProxyTor", GetDefaultProxyAddress());
161     // Only try to set -onion, if user has enabled fUseSeparateProxyTor
162     if ((settings.value("fUseSeparateProxyTor").toBool() && !gArgs.SoftSetArg("-onion", settings.value("addrSeparateProxyTor").toString().toStdString())))
163         addOverriddenOption("-onion");
164     else if(!settings.value("fUseSeparateProxyTor").toBool() && !gArgs.GetArg("-onion", "").empty())
165         addOverriddenOption("-onion");
166 
167     // Display
168     if (!settings.contains("language"))
169         settings.setValue("language", "");
170     if (!gArgs.SoftSetArg("-lang", settings.value("language").toString().toStdString()))
171         addOverriddenOption("-lang");
172 
173     language = settings.value("language").toString();
174 
175     if (!settings.contains("UseEmbeddedMonospacedFont")) {
176         settings.setValue("UseEmbeddedMonospacedFont", "true");
177     }
178     m_use_embedded_monospaced_font = settings.value("UseEmbeddedMonospacedFont").toBool();
179     Q_EMIT useEmbeddedMonospacedFontChanged(m_use_embedded_monospaced_font);
180 }
181 
182 /** Helper function to copy contents from one QSettings to another.
183  * By using allKeys this also covers nested settings in a hierarchy.
184  */
CopySettings(QSettings & dst,const QSettings & src)185 static void CopySettings(QSettings& dst, const QSettings& src)
186 {
187     for (const QString& key : src.allKeys()) {
188         dst.setValue(key, src.value(key));
189     }
190 }
191 
192 /** Back up a QSettings to an ini-formatted file. */
BackupSettings(const fs::path & filename,const QSettings & src)193 static void BackupSettings(const fs::path& filename, const QSettings& src)
194 {
195     qInfo() << "Backing up GUI settings to" << GUIUtil::boostPathToQString(filename);
196     QSettings dst(GUIUtil::boostPathToQString(filename), QSettings::IniFormat);
197     dst.clear();
198     CopySettings(dst, src);
199 }
200 
Reset()201 void OptionsModel::Reset()
202 {
203     QSettings settings;
204 
205     // Backup old settings to chain-specific datadir for troubleshooting
206     BackupSettings(gArgs.GetDataDirNet() / "guisettings.ini.bak", settings);
207 
208     // Save the strDataDir setting
209     QString dataDir = GUIUtil::getDefaultDataDirectory();
210     dataDir = settings.value("strDataDir", dataDir).toString();
211 
212     // Remove all entries from our QSettings object
213     settings.clear();
214 
215     // Set strDataDir
216     settings.setValue("strDataDir", dataDir);
217 
218     // Set that this was reset
219     settings.setValue("fReset", true);
220 
221     // default setting for OptionsModel::StartAtStartup - disabled
222     if (GUIUtil::GetStartOnSystemStartup())
223         GUIUtil::SetStartOnSystemStartup(false);
224 }
225 
rowCount(const QModelIndex & parent) const226 int OptionsModel::rowCount(const QModelIndex & parent) const
227 {
228     return OptionIDRowCount;
229 }
230 
231 struct ProxySetting {
232     bool is_set;
233     QString ip;
234     QString port;
235 };
236 
GetProxySetting(QSettings & settings,const QString & name)237 static ProxySetting GetProxySetting(QSettings &settings, const QString &name)
238 {
239     static const ProxySetting default_val = {false, DEFAULT_GUI_PROXY_HOST, QString("%1").arg(DEFAULT_GUI_PROXY_PORT)};
240     // Handle the case that the setting is not set at all
241     if (!settings.contains(name)) {
242         return default_val;
243     }
244     // contains IP at index 0 and port at index 1
245     QStringList ip_port = GUIUtil::SplitSkipEmptyParts(settings.value(name).toString(), ":");
246     if (ip_port.size() == 2) {
247         return {true, ip_port.at(0), ip_port.at(1)};
248     } else { // Invalid: return default
249         return default_val;
250     }
251 }
252 
SetProxySetting(QSettings & settings,const QString & name,const ProxySetting & ip_port)253 static void SetProxySetting(QSettings &settings, const QString &name, const ProxySetting &ip_port)
254 {
255     settings.setValue(name, QString{ip_port.ip + QLatin1Char(':') + ip_port.port});
256 }
257 
GetDefaultProxyAddress()258 static const QString GetDefaultProxyAddress()
259 {
260     return QString("%1:%2").arg(DEFAULT_GUI_PROXY_HOST).arg(DEFAULT_GUI_PROXY_PORT);
261 }
262 
SetPruneEnabled(bool prune,bool force)263 void OptionsModel::SetPruneEnabled(bool prune, bool force)
264 {
265     QSettings settings;
266     settings.setValue("bPrune", prune);
267     const int64_t prune_target_mib = PruneGBtoMiB(settings.value("nPruneSize").toInt());
268     std::string prune_val = prune ? ToString(prune_target_mib) : "0";
269     if (force) {
270         gArgs.ForceSetArg("-prune", prune_val);
271         return;
272     }
273     if (!gArgs.SoftSetArg("-prune", prune_val)) {
274         addOverriddenOption("-prune");
275     }
276 }
277 
SetPruneTargetGB(int prune_target_gb,bool force)278 void OptionsModel::SetPruneTargetGB(int prune_target_gb, bool force)
279 {
280     const bool prune = prune_target_gb > 0;
281     if (prune) {
282         QSettings settings;
283         settings.setValue("nPruneSize", prune_target_gb);
284     }
285     SetPruneEnabled(prune, force);
286 }
287 
288 // read QSettings values and return them
data(const QModelIndex & index,int role) const289 QVariant OptionsModel::data(const QModelIndex & index, int role) const
290 {
291     if(role == Qt::EditRole)
292     {
293         QSettings settings;
294         switch(index.row())
295         {
296         case StartAtStartup:
297             return GUIUtil::GetStartOnSystemStartup();
298         case ShowTrayIcon:
299             return m_show_tray_icon;
300         case MinimizeToTray:
301             return fMinimizeToTray;
302         case MapPortUPnP:
303 #ifdef USE_UPNP
304             return settings.value("fUseUPnP");
305 #else
306             return false;
307 #endif // USE_UPNP
308         case MapPortNatpmp:
309 #ifdef USE_NATPMP
310             return settings.value("fUseNatpmp");
311 #else
312             return false;
313 #endif // USE_NATPMP
314         case MinimizeOnClose:
315             return fMinimizeOnClose;
316 
317         // default proxy
318         case ProxyUse:
319             return settings.value("fUseProxy", false);
320         case ProxyIP:
321             return GetProxySetting(settings, "addrProxy").ip;
322         case ProxyPort:
323             return GetProxySetting(settings, "addrProxy").port;
324 
325         // separate Tor proxy
326         case ProxyUseTor:
327             return settings.value("fUseSeparateProxyTor", false);
328         case ProxyIPTor:
329             return GetProxySetting(settings, "addrSeparateProxyTor").ip;
330         case ProxyPortTor:
331             return GetProxySetting(settings, "addrSeparateProxyTor").port;
332 
333 #ifdef ENABLE_WALLET
334         case SpendZeroConfChange:
335             return settings.value("bSpendZeroConfChange");
336         case ExternalSignerPath:
337             return settings.value("external_signer_path");
338 #endif
339         case DisplayUnit:
340             return nDisplayUnit;
341         case ThirdPartyTxUrls:
342             return strThirdPartyTxUrls;
343         case Language:
344             return settings.value("language");
345         case UseEmbeddedMonospacedFont:
346             return m_use_embedded_monospaced_font;
347         case CoinControlFeatures:
348             return fCoinControlFeatures;
349         case Prune:
350             return settings.value("bPrune");
351         case PruneSize:
352             return settings.value("nPruneSize");
353         case DatabaseCache:
354             return settings.value("nDatabaseCache");
355         case ThreadsScriptVerif:
356             return settings.value("nThreadsScriptVerif");
357         case Listen:
358             return settings.value("fListen");
359         default:
360             return QVariant();
361         }
362     }
363     return QVariant();
364 }
365 
366 // write QSettings values
setData(const QModelIndex & index,const QVariant & value,int role)367 bool OptionsModel::setData(const QModelIndex & index, const QVariant & value, int role)
368 {
369     bool successful = true; /* set to false on parse error */
370     if(role == Qt::EditRole)
371     {
372         QSettings settings;
373         switch(index.row())
374         {
375         case StartAtStartup:
376             successful = GUIUtil::SetStartOnSystemStartup(value.toBool());
377             break;
378         case ShowTrayIcon:
379             m_show_tray_icon = value.toBool();
380             settings.setValue("fHideTrayIcon", !m_show_tray_icon);
381             Q_EMIT showTrayIconChanged(m_show_tray_icon);
382             break;
383         case MinimizeToTray:
384             fMinimizeToTray = value.toBool();
385             settings.setValue("fMinimizeToTray", fMinimizeToTray);
386             break;
387         case MapPortUPnP: // core option - can be changed on-the-fly
388             settings.setValue("fUseUPnP", value.toBool());
389             break;
390         case MapPortNatpmp: // core option - can be changed on-the-fly
391             settings.setValue("fUseNatpmp", value.toBool());
392             break;
393         case MinimizeOnClose:
394             fMinimizeOnClose = value.toBool();
395             settings.setValue("fMinimizeOnClose", fMinimizeOnClose);
396             break;
397 
398         // default proxy
399         case ProxyUse:
400             if (settings.value("fUseProxy") != value) {
401                 settings.setValue("fUseProxy", value.toBool());
402                 setRestartRequired(true);
403             }
404             break;
405         case ProxyIP: {
406             auto ip_port = GetProxySetting(settings, "addrProxy");
407             if (!ip_port.is_set || ip_port.ip != value.toString()) {
408                 ip_port.ip = value.toString();
409                 SetProxySetting(settings, "addrProxy", ip_port);
410                 setRestartRequired(true);
411             }
412         }
413         break;
414         case ProxyPort: {
415             auto ip_port = GetProxySetting(settings, "addrProxy");
416             if (!ip_port.is_set || ip_port.port != value.toString()) {
417                 ip_port.port = value.toString();
418                 SetProxySetting(settings, "addrProxy", ip_port);
419                 setRestartRequired(true);
420             }
421         }
422         break;
423 
424         // separate Tor proxy
425         case ProxyUseTor:
426             if (settings.value("fUseSeparateProxyTor") != value) {
427                 settings.setValue("fUseSeparateProxyTor", value.toBool());
428                 setRestartRequired(true);
429             }
430             break;
431         case ProxyIPTor: {
432             auto ip_port = GetProxySetting(settings, "addrSeparateProxyTor");
433             if (!ip_port.is_set || ip_port.ip != value.toString()) {
434                 ip_port.ip = value.toString();
435                 SetProxySetting(settings, "addrSeparateProxyTor", ip_port);
436                 setRestartRequired(true);
437             }
438         }
439         break;
440         case ProxyPortTor: {
441             auto ip_port = GetProxySetting(settings, "addrSeparateProxyTor");
442             if (!ip_port.is_set || ip_port.port != value.toString()) {
443                 ip_port.port = value.toString();
444                 SetProxySetting(settings, "addrSeparateProxyTor", ip_port);
445                 setRestartRequired(true);
446             }
447         }
448         break;
449 
450 #ifdef ENABLE_WALLET
451         case SpendZeroConfChange:
452             if (settings.value("bSpendZeroConfChange") != value) {
453                 settings.setValue("bSpendZeroConfChange", value);
454                 setRestartRequired(true);
455             }
456             break;
457         case ExternalSignerPath:
458             if (settings.value("external_signer_path") != value.toString()) {
459                 settings.setValue("external_signer_path", value.toString());
460                 setRestartRequired(true);
461             }
462             break;
463 #endif
464         case DisplayUnit:
465             setDisplayUnit(value);
466             break;
467         case ThirdPartyTxUrls:
468             if (strThirdPartyTxUrls != value.toString()) {
469                 strThirdPartyTxUrls = value.toString();
470                 settings.setValue("strThirdPartyTxUrls", strThirdPartyTxUrls);
471                 setRestartRequired(true);
472             }
473             break;
474         case Language:
475             if (settings.value("language") != value) {
476                 settings.setValue("language", value);
477                 setRestartRequired(true);
478             }
479             break;
480         case UseEmbeddedMonospacedFont:
481             m_use_embedded_monospaced_font = value.toBool();
482             settings.setValue("UseEmbeddedMonospacedFont", m_use_embedded_monospaced_font);
483             Q_EMIT useEmbeddedMonospacedFontChanged(m_use_embedded_monospaced_font);
484             break;
485         case CoinControlFeatures:
486             fCoinControlFeatures = value.toBool();
487             settings.setValue("fCoinControlFeatures", fCoinControlFeatures);
488             Q_EMIT coinControlFeaturesChanged(fCoinControlFeatures);
489             break;
490         case Prune:
491             if (settings.value("bPrune") != value) {
492                 settings.setValue("bPrune", value);
493                 setRestartRequired(true);
494             }
495             break;
496         case PruneSize:
497             if (settings.value("nPruneSize") != value) {
498                 settings.setValue("nPruneSize", value);
499                 setRestartRequired(true);
500             }
501             break;
502         case DatabaseCache:
503             if (settings.value("nDatabaseCache") != value) {
504                 settings.setValue("nDatabaseCache", value);
505                 setRestartRequired(true);
506             }
507             break;
508         case ThreadsScriptVerif:
509             if (settings.value("nThreadsScriptVerif") != value) {
510                 settings.setValue("nThreadsScriptVerif", value);
511                 setRestartRequired(true);
512             }
513             break;
514         case Listen:
515             if (settings.value("fListen") != value) {
516                 settings.setValue("fListen", value);
517                 setRestartRequired(true);
518             }
519             break;
520         default:
521             break;
522         }
523     }
524 
525     Q_EMIT dataChanged(index, index);
526 
527     return successful;
528 }
529 
530 /** Updates current unit in memory, settings and emits displayUnitChanged(newUnit) signal */
setDisplayUnit(const QVariant & value)531 void OptionsModel::setDisplayUnit(const QVariant &value)
532 {
533     if (!value.isNull())
534     {
535         QSettings settings;
536         nDisplayUnit = value.toInt();
537         settings.setValue("nDisplayUnit", nDisplayUnit);
538         Q_EMIT displayUnitChanged(nDisplayUnit);
539     }
540 }
541 
setRestartRequired(bool fRequired)542 void OptionsModel::setRestartRequired(bool fRequired)
543 {
544     QSettings settings;
545     return settings.setValue("fRestartRequired", fRequired);
546 }
547 
isRestartRequired() const548 bool OptionsModel::isRestartRequired() const
549 {
550     QSettings settings;
551     return settings.value("fRestartRequired", false).toBool();
552 }
553 
checkAndMigrate()554 void OptionsModel::checkAndMigrate()
555 {
556     // Migration of default values
557     // Check if the QSettings container was already loaded with this client version
558     QSettings settings;
559     static const char strSettingsVersionKey[] = "nSettingsVersion";
560     int settingsVersion = settings.contains(strSettingsVersionKey) ? settings.value(strSettingsVersionKey).toInt() : 0;
561     if (settingsVersion < CLIENT_VERSION)
562     {
563         // -dbcache was bumped from 100 to 300 in 0.13
564         // see https://github.com/bitcoin/bitcoin/pull/8273
565         // force people to upgrade to the new value if they are using 100MB
566         if (settingsVersion < 130000 && settings.contains("nDatabaseCache") && settings.value("nDatabaseCache").toLongLong() == 100)
567             settings.setValue("nDatabaseCache", (qint64)nDefaultDbCache);
568 
569         settings.setValue(strSettingsVersionKey, CLIENT_VERSION);
570     }
571 
572     // Overwrite the 'addrProxy' setting in case it has been set to an illegal
573     // default value (see issue #12623; PR #12650).
574     if (settings.contains("addrProxy") && settings.value("addrProxy").toString().endsWith("%2")) {
575         settings.setValue("addrProxy", GetDefaultProxyAddress());
576     }
577 
578     // Overwrite the 'addrSeparateProxyTor' setting in case it has been set to an illegal
579     // default value (see issue #12623; PR #12650).
580     if (settings.contains("addrSeparateProxyTor") && settings.value("addrSeparateProxyTor").toString().endsWith("%2")) {
581         settings.setValue("addrSeparateProxyTor", GetDefaultProxyAddress());
582     }
583 }
584