src/qt/optionsmodel.cpp

   1 // Copyright (c) 2011-2016 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/guiutil.h>
  13
  14 #include <amount.h>
  15 #include <init.h>
  16 #include <validation.h> // For DEFAULT_SCRIPTCHECK_THREADS
  17 #include <net.h>
  18 #include <netbase.h>
  19 #include <txdb.h> // for -dbcache defaults
  20 #include <qt/intro.h>
  21
  22 #ifdef ENABLE_WALLET
  23 #include <wallet/wallet.h>
  24 #include <wallet/walletdb.h>
  25 #endif
  26
  27 #include <QNetworkProxy>
  28 #include <QSettings>
  29 #include <QStringList>
  30
  31 const char *DEFAULT_GUI_PROXY_HOST = "127.0.0.1";
  32
  33 OptionsModel::OptionsModel(QObject *parent, bool resetSettings) :
  34     QAbstractListModel(parent)
  35 {
  36     Init(resetSettings);
  37 }
  38
  39 void OptionsModel::addOverriddenOption(const std::string &option)
  40 {
  41     strOverriddenByCommandLine += QString::fromStdString(option) + "=" + QString::fromStdString(gArgs.GetArg(option, "")) + " ";
  42 }
  43
  44 // Writes all missing QSettings with their default values
  45 void OptionsModel::Init(bool resetSettings)
  46 {
  47     if (resetSettings)
  48         Reset();
  49
  50     checkAndMigrate();
  51
  52     QSettings settings;
  53
  54     // Ensure restart flag is unset on client startup
  55     setRestartRequired(false);
  56
  57     // These are Qt-only settings:
  58
  59     // Window
  60     if (!settings.contains("fHideTrayIcon"))
  61         settings.setValue("fHideTrayIcon", false);
  62     fHideTrayIcon = settings.value("fHideTrayIcon").toBool();
  63     Q_EMIT hideTrayIconChanged(fHideTrayIcon);
  64
  65     if (!settings.contains("fMinimizeToTray"))
  66         settings.setValue("fMinimizeToTray", false);
  67     fMinimizeToTray = settings.value("fMinimizeToTray").toBool() && !fHideTrayIcon;
  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("nDatabaseCache"))
  96         settings.setValue("nDatabaseCache", (qint64)nDefaultDbCache);
  97     if (!gArgs.SoftSetArg("-dbcache", settings.value("nDatabaseCache").toString().toStdString()))
  98         addOverriddenOption("-dbcache");
  99
 100     if (!settings.contains("nThreadsScriptVerif"))
 101         settings.setValue("nThreadsScriptVerif", DEFAULT_SCRIPTCHECK_THREADS);
 102     if (!gArgs.SoftSetArg("-par", settings.value("nThreadsScriptVerif").toString().toStdString()))
 103         addOverriddenOption("-par");
 104
 105     if (!settings.contains("strDataDir"))
 106         settings.setValue("strDataDir", Intro::getDefaultDataDirectory());
 107
 108     // Wallet
 109 #ifdef ENABLE_WALLET
 110     if (!settings.contains("bSpendZeroConfChange"))
 111         settings.setValue("bSpendZeroConfChange", true);
 112     if (!gArgs.SoftSetBoolArg("-spendzeroconfchange", settings.value("bSpendZeroConfChange").toBool()))
 113         addOverriddenOption("-spendzeroconfchange");
 114 #endif
 115
 116     // Network
 117     if (!settings.contains("fUseUPnP"))
 118         settings.setValue("fUseUPnP", DEFAULT_UPNP);
 119     if (!gArgs.SoftSetBoolArg("-upnp", settings.value("fUseUPnP").toBool()))
 120         addOverriddenOption("-upnp");
 121
 122     if (!settings.contains("fListen"))
 123         settings.setValue("fListen", DEFAULT_LISTEN);
 124     if (!gArgs.SoftSetBoolArg("-listen", settings.value("fListen").toBool()))
 125         addOverriddenOption("-listen");
 126
 127     if (!settings.contains("fUseProxy"))
 128         settings.setValue("fUseProxy", false);
 129     if (!settings.contains("addrProxy"))
 130         settings.setValue("addrProxy", QString("%1:%2").arg(DEFAULT_GUI_PROXY_HOST, DEFAULT_GUI_PROXY_PORT));
 131     // Only try to set -proxy, if user has enabled fUseProxy
 132     if (settings.value("fUseProxy").toBool() && !gArgs.SoftSetArg("-proxy", settings.value("addrProxy").toString().toStdString()))
 133         addOverriddenOption("-proxy");
 134     else if(!settings.value("fUseProxy").toBool() && !gArgs.GetArg("-proxy", "").empty())
 135         addOverriddenOption("-proxy");
 136
 137     if (!settings.contains("fUseSeparateProxyTor"))
 138         settings.setValue("fUseSeparateProxyTor", false);
 139     if (!settings.contains("addrSeparateProxyTor"))
 140         settings.setValue("addrSeparateProxyTor", QString("%1:%2").arg(DEFAULT_GUI_PROXY_HOST, DEFAULT_GUI_PROXY_PORT));
 141     // Only try to set -onion, if user has enabled fUseSeparateProxyTor
 142     if (settings.value("fUseSeparateProxyTor").toBool() && !gArgs.SoftSetArg("-onion", settings.value("addrSeparateProxyTor").toString().toStdString()))
 143         addOverriddenOption("-onion");
 144     else if(!settings.value("fUseSeparateProxyTor").toBool() && !gArgs.GetArg("-onion", "").empty())
 145         addOverriddenOption("-onion");
 146
 147     // Display
 148     if (!settings.contains("language"))
 149         settings.setValue("language", "");
 150     if (!gArgs.SoftSetArg("-lang", settings.value("language").toString().toStdString()))
 151         addOverriddenOption("-lang");
 152
 153     language = settings.value("language").toString();
 154 }
 155
 156 /** Helper function to copy contents from one QSettings to another.
 157  * By using allKeys this also covers nested settings in a hierarchy.
 158  */
 159 static void CopySettings(QSettings& dst, const QSettings& src)
 160 {
 161     for (const QString& key : src.allKeys()) {
 162         dst.setValue(key, src.value(key));
 163     }
 164 }
 165
 166 /** Back up a QSettings to an ini-formatted file. */
 167 static void BackupSettings(const fs::path& filename, const QSettings& src)
 168 {
 169     qWarning() << "Backing up GUI settings to" << GUIUtil::boostPathToQString(filename);
 170     QSettings dst(GUIUtil::boostPathToQString(filename), QSettings::IniFormat);
 171     dst.clear();
 172     CopySettings(dst, src);
 173 }
 174
 175 void OptionsModel::Reset()
 176 {
 177     QSettings settings;
 178
 179     // Backup old settings to chain-specific datadir for troubleshooting
 180     BackupSettings(GetDataDir(true) / "guisettings.ini.bak", settings);
 181
 182     // Save the strDataDir setting
 183     QString dataDir = Intro::getDefaultDataDirectory();
 184     dataDir = settings.value("strDataDir", dataDir).toString();
 185
 186     // Remove all entries from our QSettings object
 187     settings.clear();
 188
 189     // Set strDataDir
 190     settings.setValue("strDataDir", dataDir);
 191
 192     // Set that this was reset
 193     settings.setValue("fReset", true);
 194
 195     // default setting for OptionsModel::StartAtStartup - disabled
 196     if (GUIUtil::GetStartOnSystemStartup())
 197         GUIUtil::SetStartOnSystemStartup(false);
 198 }
 199
 200 int OptionsModel::rowCount(const QModelIndex & parent) const
 201 {
 202     return OptionIDRowCount;
 203 }
 204
 205 struct ProxySetting {
 206     bool is_set;
 207     QString ip;
 208     QString port;
 209 };
 210
 211 static ProxySetting GetProxySetting(QSettings &settings, const QString &name)
 212 {
 213     static const ProxySetting default_val = {false, DEFAULT_GUI_PROXY_HOST, QString("%1").arg(DEFAULT_GUI_PROXY_PORT)};
 214     // Handle the case that the setting is not set at all
 215     if (!settings.contains(name)) {
 216         return default_val;
 217     }
 218     // contains IP at index 0 and port at index 1
 219     QStringList ip_port = settings.value(name).toString().split(":", QString::SkipEmptyParts);
 220     if (ip_port.size() == 2) {
 221         return {true, ip_port.at(0), ip_port.at(1)};
 222     } else { // Invalid: return default
 223         return default_val;
 224     }
 225 }
 226
 227 static void SetProxySetting(QSettings &settings, const QString &name, const ProxySetting &ip_port)
 228 {
 229     settings.setValue(name, ip_port.ip + ":" + ip_port.port);
 230 }
 231
 232 // read QSettings values and return them
 233 QVariant OptionsModel::data(const QModelIndex & index, int role) const
 234 {
 235     if(role == Qt::EditRole)
 236     {
 237         QSettings settings;
 238         switch(index.row())
 239         {
 240         case StartAtStartup:
 241             return GUIUtil::GetStartOnSystemStartup();
 242         case HideTrayIcon:
 243             return fHideTrayIcon;
 244         case MinimizeToTray:
 245             return fMinimizeToTray;
 246         case MapPortUPnP:
 247 #ifdef USE_UPNP
 248             return settings.value("fUseUPnP");
 249 #else
 250             return false;
 251 #endif
 252         case MinimizeOnClose:
 253             return fMinimizeOnClose;
 254
 255         // default proxy
 256         case ProxyUse:
 257             return settings.value("fUseProxy", false);
 258         case ProxyIP:
 259             return GetProxySetting(settings, "addrProxy").ip;
 260         case ProxyPort:
 261             return GetProxySetting(settings, "addrProxy").port;
 262
 263         // separate Tor proxy
 264         case ProxyUseTor:
 265             return settings.value("fUseSeparateProxyTor", false);
 266         case ProxyIPTor:
 267             return GetProxySetting(settings, "addrSeparateProxyTor").ip;
 268         case ProxyPortTor:
 269             return GetProxySetting(settings, "addrSeparateProxyTor").port;
 270
 271 #ifdef ENABLE_WALLET
 272         case SpendZeroConfChange:
 273             return settings.value("bSpendZeroConfChange");
 274 #endif
 275         case DisplayUnit:
 276             return nDisplayUnit;
 277         case ThirdPartyTxUrls:
 278             return strThirdPartyTxUrls;
 279         case Language:
 280             return settings.value("language");
 281         case CoinControlFeatures:
 282             return fCoinControlFeatures;
 283         case DatabaseCache:
 284             return settings.value("nDatabaseCache");
 285         case ThreadsScriptVerif:
 286             return settings.value("nThreadsScriptVerif");
 287         case Listen:
 288             return settings.value("fListen");
 289         default:
 290             return QVariant();
 291         }
 292     }
 293     return QVariant();
 294 }
 295
 296 // write QSettings values
 297 bool OptionsModel::setData(const QModelIndex & index, const QVariant & value, int role)
 298 {
 299     bool successful = true; /* set to false on parse error */
 300     if(role == Qt::EditRole)
 301     {
 302         QSettings settings;
 303         switch(index.row())
 304         {
 305         case StartAtStartup:
 306             successful = GUIUtil::SetStartOnSystemStartup(value.toBool());
 307             break;
 308         case HideTrayIcon:
 309             fHideTrayIcon = value.toBool();
 310             settings.setValue("fHideTrayIcon", fHideTrayIcon);
 311                 Q_EMIT hideTrayIconChanged(fHideTrayIcon);
 312             break;
 313         case MinimizeToTray:
 314             fMinimizeToTray = value.toBool();
 315             settings.setValue("fMinimizeToTray", fMinimizeToTray);
 316             break;
 317         case MapPortUPnP: // core option - can be changed on-the-fly
 318             settings.setValue("fUseUPnP", value.toBool());
 319             MapPort(value.toBool());
 320             break;
 321         case MinimizeOnClose:
 322             fMinimizeOnClose = value.toBool();
 323             settings.setValue("fMinimizeOnClose", fMinimizeOnClose);
 324             break;
 325
 326         // default proxy
 327         case ProxyUse:
 328             if (settings.value("fUseProxy") != value) {
 329                 settings.setValue("fUseProxy", value.toBool());
 330                 setRestartRequired(true);
 331             }
 332             break;
 333         case ProxyIP: {
 334             auto ip_port = GetProxySetting(settings, "addrProxy");
 335             if (!ip_port.is_set || ip_port.ip != value.toString()) {
 336                 ip_port.ip = value.toString();
 337                 SetProxySetting(settings, "addrProxy", ip_port);
 338                 setRestartRequired(true);
 339             }
 340         }
 341         break;
 342         case ProxyPort: {
 343             auto ip_port = GetProxySetting(settings, "addrProxy");
 344             if (!ip_port.is_set || ip_port.port != value.toString()) {
 345                 ip_port.port = value.toString();
 346                 SetProxySetting(settings, "addrProxy", ip_port);
 347                 setRestartRequired(true);
 348             }
 349         }
 350         break;
 351
 352         // separate Tor proxy
 353         case ProxyUseTor:
 354             if (settings.value("fUseSeparateProxyTor") != value) {
 355                 settings.setValue("fUseSeparateProxyTor", value.toBool());
 356                 setRestartRequired(true);
 357             }
 358             break;
 359         case ProxyIPTor: {
 360             auto ip_port = GetProxySetting(settings, "addrSeparateProxyTor");
 361             if (!ip_port.is_set || ip_port.ip != value.toString()) {
 362                 ip_port.ip = value.toString();
 363                 SetProxySetting(settings, "addrSeparateProxyTor", ip_port);
 364                 setRestartRequired(true);
 365             }
 366         }
 367         break;
 368         case ProxyPortTor: {
 369             auto ip_port = GetProxySetting(settings, "addrSeparateProxyTor");
 370             if (!ip_port.is_set || ip_port.port != value.toString()) {
 371                 ip_port.port = value.toString();
 372                 SetProxySetting(settings, "addrSeparateProxyTor", ip_port);
 373                 setRestartRequired(true);
 374             }
 375         }
 376         break;
 377
 378 #ifdef ENABLE_WALLET
 379         case SpendZeroConfChange:
 380             if (settings.value("bSpendZeroConfChange") != value) {
 381                 settings.setValue("bSpendZeroConfChange", value);
 382                 setRestartRequired(true);
 383             }
 384             break;
 385 #endif
 386         case DisplayUnit:
 387             setDisplayUnit(value);
 388             break;
 389         case ThirdPartyTxUrls:
 390             if (strThirdPartyTxUrls != value.toString()) {
 391                 strThirdPartyTxUrls = value.toString();
 392                 settings.setValue("strThirdPartyTxUrls", strThirdPartyTxUrls);
 393                 setRestartRequired(true);
 394             }
 395             break;
 396         case Language:
 397             if (settings.value("language") != value) {
 398                 settings.setValue("language", value);
 399                 setRestartRequired(true);
 400             }
 401             break;
 402         case CoinControlFeatures:
 403             fCoinControlFeatures = value.toBool();
 404             settings.setValue("fCoinControlFeatures", fCoinControlFeatures);
 405             Q_EMIT coinControlFeaturesChanged(fCoinControlFeatures);
 406             break;
 407         case DatabaseCache:
 408             if (settings.value("nDatabaseCache") != value) {
 409                 settings.setValue("nDatabaseCache", value);
 410                 setRestartRequired(true);
 411             }
 412             break;
 413         case ThreadsScriptVerif:
 414             if (settings.value("nThreadsScriptVerif") != value) {
 415                 settings.setValue("nThreadsScriptVerif", value);
 416                 setRestartRequired(true);
 417             }
 418             break;
 419         case Listen:
 420             if (settings.value("fListen") != value) {
 421                 settings.setValue("fListen", value);
 422                 setRestartRequired(true);
 423             }
 424             break;
 425         default:
 426             break;
 427         }
 428     }
 429
 430     Q_EMIT dataChanged(index, index);
 431
 432     return successful;
 433 }
 434
 435 /** Updates current unit in memory, settings and emits displayUnitChanged(newUnit) signal */
 436 void OptionsModel::setDisplayUnit(const QVariant &value)
 437 {
 438     if (!value.isNull())
 439     {
 440         QSettings settings;
 441         nDisplayUnit = value.toInt();
 442         settings.setValue("nDisplayUnit", nDisplayUnit);
 443         Q_EMIT displayUnitChanged(nDisplayUnit);
 444     }
 445 }
 446
 447 bool OptionsModel::getProxySettings(QNetworkProxy& proxy) const
 448 {
 449     // Directly query current base proxy, because
 450     // GUI settings can be overridden with -proxy.
 451     proxyType curProxy;
 452     if (GetProxy(NET_IPV4, curProxy)) {
 453         proxy.setType(QNetworkProxy::Socks5Proxy);
 454         proxy.setHostName(QString::fromStdString(curProxy.proxy.ToStringIP()));
 455         proxy.setPort(curProxy.proxy.GetPort());
 456
 457         return true;
 458     }
 459     else
 460         proxy.setType(QNetworkProxy::NoProxy);
 461
 462     return false;
 463 }
 464
 465 void OptionsModel::setRestartRequired(bool fRequired)
 466 {
 467     QSettings settings;
 468     return settings.setValue("fRestartRequired", fRequired);
 469 }
 470
 471 bool OptionsModel::isRestartRequired() const
 472 {
 473     QSettings settings;
 474     return settings.value("fRestartRequired", false).toBool();
 475 }
 476
 477 void OptionsModel::checkAndMigrate()
 478 {
 479     // Migration of default values
 480     // Check if the QSettings container was already loaded with this client version
 481     QSettings settings;
 482     static const char strSettingsVersionKey[] = "nSettingsVersion";
 483     int settingsVersion = settings.contains(strSettingsVersionKey) ? settings.value(strSettingsVersionKey).toInt() : 0;
 484     if (settingsVersion < CLIENT_VERSION)
 485     {
 486         // -dbcache was bumped from 100 to 300 in 0.13
 487         // see https://github.com/bitcoin/bitcoin/pull/8273
 488         // force people to upgrade to the new value if they are using 100MB
 489         if (settingsVersion < 130000 && settings.contains("nDatabaseCache") && settings.value("nDatabaseCache").toLongLong() == 100)
 490             settings.setValue("nDatabaseCache", (qint64)nDefaultDbCache);
 491
 492         settings.setValue(strSettingsVersionKey, CLIENT_VERSION);
 493     }
 494 }