src/qt/optionsmodel.cpp

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