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