// Copyright (c) 2011-2022 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #if defined(HAVE_CONFIG_H) #include #endif #include #include #include #include #include #include #include #include #include #include // for -dbcache defaults #include #include // For DEFAULT_SCRIPTCHECK_THREADS #include // For DEFAULT_SPEND_ZEROCONF_CHANGE #include #include #include #include #include #include const char *DEFAULT_GUI_PROXY_HOST = "127.0.0.1"; static QString GetDefaultProxyAddress(); /** Map GUI option ID to node setting name. */ static const char* SettingName(OptionsModel::OptionID option) { switch (option) { case OptionsModel::DatabaseCache: return "dbcache"; case OptionsModel::ThreadsScriptVerif: return "par"; case OptionsModel::SpendZeroConfChange: return "spendzeroconfchange"; case OptionsModel::ExternalSignerPath: return "signer"; case OptionsModel::MapPortUPnP: return "upnp"; case OptionsModel::MapPortNatpmp: return "natpmp"; case OptionsModel::Listen: return "listen"; case OptionsModel::Server: return "server"; case OptionsModel::PruneSize: return "prune"; case OptionsModel::Prune: return "prune"; case OptionsModel::ProxyIP: return "proxy"; case OptionsModel::ProxyPort: return "proxy"; case OptionsModel::ProxyUse: return "proxy"; case OptionsModel::ProxyIPTor: return "onion"; case OptionsModel::ProxyPortTor: return "onion"; case OptionsModel::ProxyUseTor: return "onion"; case OptionsModel::Language: return "lang"; default: throw std::logic_error(strprintf("GUI option %i has no corresponding node setting.", option)); } } /** Call node.updateRwSetting() with Bitcoin 22.x workaround. */ static void UpdateRwSetting(interfaces::Node& node, OptionsModel::OptionID option, const std::string& suffix, const common::SettingsValue& value) { if (value.isNum() && (option == OptionsModel::DatabaseCache || option == OptionsModel::ThreadsScriptVerif || option == OptionsModel::Prune || option == OptionsModel::PruneSize)) { // Write certain old settings as strings, even though they are numbers, // because Bitcoin 22.x releases try to read these specific settings as // strings in addOverriddenOption() calls at startup, triggering // uncaught exceptions in UniValue::get_str(). These errors were fixed // in later releases by https://github.com/bitcoin/bitcoin/pull/24498. // If new numeric settings are added, they can be written as numbers // instead of strings, because bitcoin 22.x will not try to read these. node.updateRwSetting(SettingName(option) + suffix, value.getValStr()); } else { node.updateRwSetting(SettingName(option) + suffix, value); } } //! Convert enabled/size values to bitcoin -prune setting. static common::SettingsValue PruneSetting(bool prune_enabled, int prune_size_gb) { assert(!prune_enabled || prune_size_gb >= 1); // PruneSizeGB and ParsePruneSizeGB never return less return prune_enabled ? PruneGBtoMiB(prune_size_gb) : 0; } //! Get pruning enabled value to show in GUI from bitcoin -prune setting. static bool PruneEnabled(const common::SettingsValue& prune_setting) { // -prune=1 setting is manual pruning mode, so disabled for purposes of the gui return SettingToInt(prune_setting, 0) > 1; } //! Get pruning size value to show in GUI from bitcoin -prune setting. If //! pruning is not enabled, just show default recommended pruning size (2GB). static int PruneSizeGB(const common::SettingsValue& prune_setting) { int value = SettingToInt(prune_setting, 0); return value > 1 ? PruneMiBtoGB(value) : DEFAULT_PRUNE_TARGET_GB; } //! Parse pruning size value provided by user in GUI or loaded from QSettings //! (windows registry key or qt .conf file). Smallest value that the GUI can //! display is 1 GB, so round up if anything less is parsed. static int ParsePruneSizeGB(const QVariant& prune_size) { return std::max(1, prune_size.toInt()); } struct ProxySetting { bool is_set; QString ip; QString port; }; static ProxySetting ParseProxyString(const std::string& proxy); static std::string ProxyString(bool is_set, QString ip, QString port); OptionsModel::OptionsModel(interfaces::Node& node, QObject *parent) : QAbstractListModel(parent), m_node{node} { } void OptionsModel::addOverriddenOption(const std::string &option) { strOverriddenByCommandLine += QString::fromStdString(option) + "=" + QString::fromStdString(gArgs.GetArg(option, "")) + " "; } // Writes all missing QSettings with their default values bool OptionsModel::Init(bilingual_str& error) { // Initialize display settings from stored settings. language = QString::fromStdString(SettingToString(node().getPersistentSetting("lang"), "")); checkAndMigrate(); QSettings settings; // Ensure restart flag is unset on client startup setRestartRequired(false); // These are Qt-only settings: // Window if (!settings.contains("fHideTrayIcon")) { settings.setValue("fHideTrayIcon", false); } m_show_tray_icon = !settings.value("fHideTrayIcon").toBool(); Q_EMIT showTrayIconChanged(m_show_tray_icon); if (!settings.contains("fMinimizeToTray")) settings.setValue("fMinimizeToTray", false); fMinimizeToTray = settings.value("fMinimizeToTray").toBool() && m_show_tray_icon; if (!settings.contains("fMinimizeOnClose")) settings.setValue("fMinimizeOnClose", false); fMinimizeOnClose = settings.value("fMinimizeOnClose").toBool(); // Display if (!settings.contains("DisplayBitcoinUnit")) { settings.setValue("DisplayBitcoinUnit", QVariant::fromValue(BitcoinUnit::BTC)); } QVariant unit = settings.value("DisplayBitcoinUnit"); if (unit.canConvert()) { m_display_bitcoin_unit = unit.value(); } else { m_display_bitcoin_unit = BitcoinUnit::BTC; settings.setValue("DisplayBitcoinUnit", QVariant::fromValue(m_display_bitcoin_unit)); } if (!settings.contains("strThirdPartyTxUrls")) settings.setValue("strThirdPartyTxUrls", ""); strThirdPartyTxUrls = settings.value("strThirdPartyTxUrls", "").toString(); if (!settings.contains("fCoinControlFeatures")) settings.setValue("fCoinControlFeatures", false); fCoinControlFeatures = settings.value("fCoinControlFeatures", false).toBool(); if (!settings.contains("enable_psbt_controls")) { settings.setValue("enable_psbt_controls", false); } m_enable_psbt_controls = settings.value("enable_psbt_controls", false).toBool(); // These are shared with the core or have a command-line parameter // and we want command-line parameters to overwrite the GUI settings. for (OptionID option : {DatabaseCache, ThreadsScriptVerif, SpendZeroConfChange, ExternalSignerPath, MapPortUPnP, MapPortNatpmp, Listen, Server, Prune, ProxyUse, ProxyUseTor, Language}) { std::string setting = SettingName(option); if (node().isSettingIgnored(setting)) addOverriddenOption("-" + setting); try { getOption(option); } catch (const std::exception& e) { // This handles exceptions thrown by univalue that can happen if // settings in settings.json don't have the expected types. error.original = strprintf("Could not read setting \"%s\", %s.", setting, e.what()); error.translated = tr("Could not read setting \"%1\", %2.").arg(QString::fromStdString(setting), e.what()).toStdString(); return false; } } // If setting doesn't exist create it with defaults. // Main if (!settings.contains("strDataDir")) settings.setValue("strDataDir", GUIUtil::getDefaultDataDirectory()); // Wallet #ifdef ENABLE_WALLET if (!settings.contains("SubFeeFromAmount")) { settings.setValue("SubFeeFromAmount", false); } m_sub_fee_from_amount = settings.value("SubFeeFromAmount", false).toBool(); #endif // Display if (!settings.contains("UseEmbeddedMonospacedFont")) { settings.setValue("UseEmbeddedMonospacedFont", "true"); } m_use_embedded_monospaced_font = settings.value("UseEmbeddedMonospacedFont").toBool(); Q_EMIT useEmbeddedMonospacedFontChanged(m_use_embedded_monospaced_font); m_mask_values = settings.value("mask_values", false).toBool(); return true; } /** Helper function to copy contents from one QSettings to another. * By using allKeys this also covers nested settings in a hierarchy. */ static void CopySettings(QSettings& dst, const QSettings& src) { for (const QString& key : src.allKeys()) { dst.setValue(key, src.value(key)); } } /** Back up a QSettings to an ini-formatted file. */ static void BackupSettings(const fs::path& filename, const QSettings& src) { qInfo() << "Backing up GUI settings to" << GUIUtil::PathToQString(filename); QSettings dst(GUIUtil::PathToQString(filename), QSettings::IniFormat); dst.clear(); CopySettings(dst, src); } void OptionsModel::Reset() { // Backup and reset settings.json node().resetSettings(); QSettings settings; // Backup old settings to chain-specific datadir for troubleshooting BackupSettings(gArgs.GetDataDirNet() / "guisettings.ini.bak", settings); // Save the strDataDir setting QString dataDir = GUIUtil::getDefaultDataDirectory(); dataDir = settings.value("strDataDir", dataDir).toString(); // Remove all entries from our QSettings object settings.clear(); // Set strDataDir settings.setValue("strDataDir", dataDir); // Set that this was reset settings.setValue("fReset", true); // default setting for OptionsModel::StartAtStartup - disabled if (GUIUtil::GetStartOnSystemStartup()) GUIUtil::SetStartOnSystemStartup(false); } int OptionsModel::rowCount(const QModelIndex & parent) const { return OptionIDRowCount; } static ProxySetting ParseProxyString(const QString& proxy) { static const ProxySetting default_val = {false, DEFAULT_GUI_PROXY_HOST, QString("%1").arg(DEFAULT_GUI_PROXY_PORT)}; // Handle the case that the setting is not set at all if (proxy.isEmpty()) { return default_val; } // contains IP at index 0 and port at index 1 QStringList ip_port = GUIUtil::SplitSkipEmptyParts(proxy, ":"); if (ip_port.size() == 2) { return {true, ip_port.at(0), ip_port.at(1)}; } else { // Invalid: return default return default_val; } } static ProxySetting ParseProxyString(const std::string& proxy) { return ParseProxyString(QString::fromStdString(proxy)); } static std::string ProxyString(bool is_set, QString ip, QString port) { return is_set ? QString(ip + ":" + port).toStdString() : ""; } static QString GetDefaultProxyAddress() { return QString("%1:%2").arg(DEFAULT_GUI_PROXY_HOST).arg(DEFAULT_GUI_PROXY_PORT); } void OptionsModel::SetPruneTargetGB(int prune_target_gb) { const common::SettingsValue cur_value = node().getPersistentSetting("prune"); const common::SettingsValue new_value = PruneSetting(prune_target_gb > 0, prune_target_gb); // Force setting to take effect. It is still safe to change the value at // this point because this function is only called after the intro screen is // shown, before the node starts. node().forceSetting("prune", new_value); // Update settings.json if value configured in intro screen is different // from saved value. Avoid writing settings.json if bitcoin.conf value // doesn't need to be overridden. if (PruneEnabled(cur_value) != PruneEnabled(new_value) || PruneSizeGB(cur_value) != PruneSizeGB(new_value)) { // Call UpdateRwSetting() instead of setOption() to avoid setting // RestartRequired flag UpdateRwSetting(node(), Prune, "", new_value); } // Keep previous pruning size, if pruning was disabled. if (PruneEnabled(cur_value)) { UpdateRwSetting(node(), Prune, "-prev", PruneEnabled(new_value) ? common::SettingsValue{} : cur_value); } } // read QSettings values and return them QVariant OptionsModel::data(const QModelIndex & index, int role) const { if(role == Qt::EditRole) { return getOption(OptionID(index.row())); } return QVariant(); } // write QSettings values bool OptionsModel::setData(const QModelIndex & index, const QVariant & value, int role) { bool successful = true; /* set to false on parse error */ if(role == Qt::EditRole) { successful = setOption(OptionID(index.row()), value); } Q_EMIT dataChanged(index, index); return successful; } QVariant OptionsModel::getOption(OptionID option, const std::string& suffix) const { auto setting = [&]{ return node().getPersistentSetting(SettingName(option) + suffix); }; QSettings settings; switch (option) { case StartAtStartup: return GUIUtil::GetStartOnSystemStartup(); case ShowTrayIcon: return m_show_tray_icon; case MinimizeToTray: return fMinimizeToTray; case MapPortUPnP: #ifdef USE_UPNP return SettingToBool(setting(), DEFAULT_UPNP); #else return false; #endif // USE_UPNP case MapPortNatpmp: #ifdef USE_NATPMP return SettingToBool(setting(), DEFAULT_NATPMP); #else return false; #endif // USE_NATPMP case MinimizeOnClose: return fMinimizeOnClose; // default proxy case ProxyUse: case ProxyUseTor: return ParseProxyString(SettingToString(setting(), "")).is_set; case ProxyIP: case ProxyIPTor: { ProxySetting proxy = ParseProxyString(SettingToString(setting(), "")); if (proxy.is_set) { return proxy.ip; } else if (suffix.empty()) { return getOption(option, "-prev"); } else { return ParseProxyString(GetDefaultProxyAddress().toStdString()).ip; } } case ProxyPort: case ProxyPortTor: { ProxySetting proxy = ParseProxyString(SettingToString(setting(), "")); if (proxy.is_set) { return proxy.port; } else if (suffix.empty()) { return getOption(option, "-prev"); } else { return ParseProxyString(GetDefaultProxyAddress().toStdString()).port; } } #ifdef ENABLE_WALLET case SpendZeroConfChange: return SettingToBool(setting(), wallet::DEFAULT_SPEND_ZEROCONF_CHANGE); case ExternalSignerPath: return QString::fromStdString(SettingToString(setting(), "")); case SubFeeFromAmount: return m_sub_fee_from_amount; #endif case DisplayUnit: return QVariant::fromValue(m_display_bitcoin_unit); case ThirdPartyTxUrls: return strThirdPartyTxUrls; case Language: return QString::fromStdString(SettingToString(setting(), "")); case UseEmbeddedMonospacedFont: return m_use_embedded_monospaced_font; case CoinControlFeatures: return fCoinControlFeatures; case EnablePSBTControls: return settings.value("enable_psbt_controls"); case Prune: return PruneEnabled(setting()); case PruneSize: return PruneEnabled(setting()) ? PruneSizeGB(setting()) : suffix.empty() ? getOption(option, "-prev") : DEFAULT_PRUNE_TARGET_GB; case DatabaseCache: return qlonglong(SettingToInt(setting(), nDefaultDbCache)); case ThreadsScriptVerif: return qlonglong(SettingToInt(setting(), DEFAULT_SCRIPTCHECK_THREADS)); case Listen: return SettingToBool(setting(), DEFAULT_LISTEN); case Server: return SettingToBool(setting(), false); case MaskValues: return m_mask_values; default: return QVariant(); } } bool OptionsModel::setOption(OptionID option, const QVariant& value, const std::string& suffix) { auto changed = [&] { return value.isValid() && value != getOption(option, suffix); }; auto update = [&](const common::SettingsValue& value) { return UpdateRwSetting(node(), option, suffix, value); }; bool successful = true; /* set to false on parse error */ QSettings settings; switch (option) { case StartAtStartup: successful = GUIUtil::SetStartOnSystemStartup(value.toBool()); break; case ShowTrayIcon: m_show_tray_icon = value.toBool(); settings.setValue("fHideTrayIcon", !m_show_tray_icon); Q_EMIT showTrayIconChanged(m_show_tray_icon); break; case MinimizeToTray: fMinimizeToTray = value.toBool(); settings.setValue("fMinimizeToTray", fMinimizeToTray); break; case MapPortUPnP: // core option - can be changed on-the-fly if (changed()) { update(value.toBool()); node().mapPort(value.toBool(), getOption(MapPortNatpmp).toBool()); } break; case MapPortNatpmp: // core option - can be changed on-the-fly if (changed()) { update(value.toBool()); node().mapPort(getOption(MapPortUPnP).toBool(), value.toBool()); } break; case MinimizeOnClose: fMinimizeOnClose = value.toBool(); settings.setValue("fMinimizeOnClose", fMinimizeOnClose); break; // default proxy case ProxyUse: if (changed()) { if (suffix.empty() && !value.toBool()) setOption(option, true, "-prev"); update(ProxyString(value.toBool(), getOption(ProxyIP).toString(), getOption(ProxyPort).toString())); if (suffix.empty() && value.toBool()) UpdateRwSetting(node(), option, "-prev", {}); if (suffix.empty()) setRestartRequired(true); } break; case ProxyIP: if (changed()) { if (suffix.empty() && !getOption(ProxyUse).toBool()) { setOption(option, value, "-prev"); } else { update(ProxyString(true, value.toString(), getOption(ProxyPort).toString())); } if (suffix.empty() && getOption(ProxyUse).toBool()) setRestartRequired(true); } break; case ProxyPort: if (changed()) { if (suffix.empty() && !getOption(ProxyUse).toBool()) { setOption(option, value, "-prev"); } else { update(ProxyString(true, getOption(ProxyIP).toString(), value.toString())); } if (suffix.empty() && getOption(ProxyUse).toBool()) setRestartRequired(true); } break; // separate Tor proxy case ProxyUseTor: if (changed()) { if (suffix.empty() && !value.toBool()) setOption(option, true, "-prev"); update(ProxyString(value.toBool(), getOption(ProxyIPTor).toString(), getOption(ProxyPortTor).toString())); if (suffix.empty() && value.toBool()) UpdateRwSetting(node(), option, "-prev", {}); if (suffix.empty()) setRestartRequired(true); } break; case ProxyIPTor: if (changed()) { if (suffix.empty() && !getOption(ProxyUseTor).toBool()) { setOption(option, value, "-prev"); } else { update(ProxyString(true, value.toString(), getOption(ProxyPortTor).toString())); } if (suffix.empty() && getOption(ProxyUseTor).toBool()) setRestartRequired(true); } break; case ProxyPortTor: if (changed()) { if (suffix.empty() && !getOption(ProxyUseTor).toBool()) { setOption(option, value, "-prev"); } else { update(ProxyString(true, getOption(ProxyIPTor).toString(), value.toString())); } if (suffix.empty() && getOption(ProxyUseTor).toBool()) setRestartRequired(true); } break; #ifdef ENABLE_WALLET case SpendZeroConfChange: if (changed()) { update(value.toBool()); setRestartRequired(true); } break; case ExternalSignerPath: if (changed()) { update(value.toString().toStdString()); setRestartRequired(true); } break; case SubFeeFromAmount: m_sub_fee_from_amount = value.toBool(); settings.setValue("SubFeeFromAmount", m_sub_fee_from_amount); break; #endif case DisplayUnit: setDisplayUnit(value); break; case ThirdPartyTxUrls: if (strThirdPartyTxUrls != value.toString()) { strThirdPartyTxUrls = value.toString(); settings.setValue("strThirdPartyTxUrls", strThirdPartyTxUrls); setRestartRequired(true); } break; case Language: if (changed()) { update(value.toString().toStdString()); setRestartRequired(true); } break; case UseEmbeddedMonospacedFont: m_use_embedded_monospaced_font = value.toBool(); settings.setValue("UseEmbeddedMonospacedFont", m_use_embedded_monospaced_font); Q_EMIT useEmbeddedMonospacedFontChanged(m_use_embedded_monospaced_font); break; case CoinControlFeatures: fCoinControlFeatures = value.toBool(); settings.setValue("fCoinControlFeatures", fCoinControlFeatures); Q_EMIT coinControlFeaturesChanged(fCoinControlFeatures); break; case EnablePSBTControls: m_enable_psbt_controls = value.toBool(); settings.setValue("enable_psbt_controls", m_enable_psbt_controls); break; case Prune: if (changed()) { if (suffix.empty() && !value.toBool()) setOption(option, true, "-prev"); update(PruneSetting(value.toBool(), getOption(PruneSize).toInt())); if (suffix.empty() && value.toBool()) UpdateRwSetting(node(), option, "-prev", {}); if (suffix.empty()) setRestartRequired(true); } break; case PruneSize: if (changed()) { if (suffix.empty() && !getOption(Prune).toBool()) { setOption(option, value, "-prev"); } else { update(PruneSetting(true, ParsePruneSizeGB(value))); } if (suffix.empty() && getOption(Prune).toBool()) setRestartRequired(true); } break; case DatabaseCache: if (changed()) { update(static_cast(value.toLongLong())); setRestartRequired(true); } break; case ThreadsScriptVerif: if (changed()) { update(static_cast(value.toLongLong())); setRestartRequired(true); } break; case Listen: case Server: if (changed()) { update(value.toBool()); setRestartRequired(true); } break; case MaskValues: m_mask_values = value.toBool(); settings.setValue("mask_values", m_mask_values); break; default: break; } return successful; } void OptionsModel::setDisplayUnit(const QVariant& new_unit) { if (new_unit.isNull() || new_unit.value() == m_display_bitcoin_unit) return; m_display_bitcoin_unit = new_unit.value(); QSettings settings; settings.setValue("DisplayBitcoinUnit", QVariant::fromValue(m_display_bitcoin_unit)); Q_EMIT displayUnitChanged(m_display_bitcoin_unit); } void OptionsModel::setRestartRequired(bool fRequired) { QSettings settings; return settings.setValue("fRestartRequired", fRequired); } bool OptionsModel::isRestartRequired() const { QSettings settings; return settings.value("fRestartRequired", false).toBool(); } bool OptionsModel::hasSigner() { return gArgs.GetArg("-signer", "") != ""; } void OptionsModel::checkAndMigrate() { // Migration of default values // Check if the QSettings container was already loaded with this client version QSettings settings; static const char strSettingsVersionKey[] = "nSettingsVersion"; int settingsVersion = settings.contains(strSettingsVersionKey) ? settings.value(strSettingsVersionKey).toInt() : 0; if (settingsVersion < CLIENT_VERSION) { // -dbcache was bumped from 100 to 300 in 0.13 // see https://github.com/bitcoin/bitcoin/pull/8273 // force people to upgrade to the new value if they are using 100MB if (settingsVersion < 130000 && settings.contains("nDatabaseCache") && settings.value("nDatabaseCache").toLongLong() == 100) settings.setValue("nDatabaseCache", (qint64)nDefaultDbCache); settings.setValue(strSettingsVersionKey, CLIENT_VERSION); } // Overwrite the 'addrProxy' setting in case it has been set to an illegal // default value (see issue #12623; PR #12650). if (settings.contains("addrProxy") && settings.value("addrProxy").toString().endsWith("%2")) { settings.setValue("addrProxy", GetDefaultProxyAddress()); } // Overwrite the 'addrSeparateProxyTor' setting in case it has been set to an illegal // default value (see issue #12623; PR #12650). if (settings.contains("addrSeparateProxyTor") && settings.value("addrSeparateProxyTor").toString().endsWith("%2")) { settings.setValue("addrSeparateProxyTor", GetDefaultProxyAddress()); } // Migrate and delete legacy GUI settings that have now moved to /settings.json. auto migrate_setting = [&](OptionID option, const QString& qt_name) { if (!settings.contains(qt_name)) return; QVariant value = settings.value(qt_name); if (node().getPersistentSetting(SettingName(option)).isNull()) { if (option == ProxyIP) { ProxySetting parsed = ParseProxyString(value.toString()); setOption(ProxyIP, parsed.ip); setOption(ProxyPort, parsed.port); } else if (option == ProxyIPTor) { ProxySetting parsed = ParseProxyString(value.toString()); setOption(ProxyIPTor, parsed.ip); setOption(ProxyPortTor, parsed.port); } else { setOption(option, value); } } settings.remove(qt_name); }; migrate_setting(DatabaseCache, "nDatabaseCache"); migrate_setting(ThreadsScriptVerif, "nThreadsScriptVerif"); #ifdef ENABLE_WALLET migrate_setting(SpendZeroConfChange, "bSpendZeroConfChange"); migrate_setting(ExternalSignerPath, "external_signer_path"); #endif migrate_setting(MapPortUPnP, "fUseUPnP"); migrate_setting(MapPortNatpmp, "fUseNatpmp"); migrate_setting(Listen, "fListen"); migrate_setting(Server, "server"); migrate_setting(PruneSize, "nPruneSize"); migrate_setting(Prune, "bPrune"); migrate_setting(ProxyIP, "addrProxy"); migrate_setting(ProxyUse, "fUseProxy"); migrate_setting(ProxyIPTor, "addrSeparateProxyTor"); migrate_setting(ProxyUseTor, "fUseSeparateProxyTor"); migrate_setting(Language, "language"); // In case migrating QSettings caused any settings value to change, rerun // parameter interaction code to update other settings. This is particularly // important for the -listen setting, which should cause -listenonion, -upnp, // and other settings to default to false if it was set to false. // (https://github.com/bitcoin-core/gui/issues/567). node().initParameterInteraction(); }