// Copyright (c) 2019-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. #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using wallet::WALLET_FLAG_BLANK_WALLET; using wallet::WALLET_FLAG_DESCRIPTORS; using wallet::WALLET_FLAG_DISABLE_PRIVATE_KEYS; using wallet::WALLET_FLAG_EXTERNAL_SIGNER; WalletController::WalletController(ClientModel& client_model, const PlatformStyle* platform_style, QObject* parent) : QObject(parent) , m_activity_thread(new QThread(this)) , m_activity_worker(new QObject) , m_client_model(client_model) , m_node(client_model.node()) , m_platform_style(platform_style) , m_options_model(client_model.getOptionsModel()) { m_handler_load_wallet = m_node.walletLoader().handleLoadWallet([this](std::unique_ptr wallet) { getOrCreateWallet(std::move(wallet)); }); m_activity_worker->moveToThread(m_activity_thread); m_activity_thread->start(); QTimer::singleShot(0, m_activity_worker, []() { util::ThreadRename("qt-walletctrl"); }); } // Not using the default destructor because not all member types definitions are // available in the header, just forward declared. WalletController::~WalletController() { m_activity_thread->quit(); m_activity_thread->wait(); delete m_activity_worker; } std::map WalletController::listWalletDir() const { QMutexLocker locker(&m_mutex); std::map wallets; for (const std::string& name : m_node.walletLoader().listWalletDir()) { wallets[name] = false; } for (WalletModel* wallet_model : m_wallets) { auto it = wallets.find(wallet_model->wallet().getWalletName()); if (it != wallets.end()) it->second = true; } return wallets; } void WalletController::closeWallet(WalletModel* wallet_model, QWidget* parent) { QMessageBox box(parent); box.setWindowTitle(tr("Close wallet")); box.setText(tr("Are you sure you wish to close the wallet %1?").arg(GUIUtil::HtmlEscape(wallet_model->getDisplayName()))); box.setInformativeText(tr("Closing the wallet for too long can result in having to resync the entire chain if pruning is enabled.")); box.setStandardButtons(QMessageBox::Yes|QMessageBox::Cancel); box.setDefaultButton(QMessageBox::Yes); if (box.exec() != QMessageBox::Yes) return; // First remove wallet from node. wallet_model->wallet().remove(); // Now release the model. removeAndDeleteWallet(wallet_model); } void WalletController::closeAllWallets(QWidget* parent) { QMessageBox::StandardButton button = QMessageBox::question(parent, tr("Close all wallets"), tr("Are you sure you wish to close all wallets?"), QMessageBox::Yes|QMessageBox::Cancel, QMessageBox::Yes); if (button != QMessageBox::Yes) return; QMutexLocker locker(&m_mutex); for (WalletModel* wallet_model : m_wallets) { wallet_model->wallet().remove(); Q_EMIT walletRemoved(wallet_model); delete wallet_model; } m_wallets.clear(); } WalletModel* WalletController::getOrCreateWallet(std::unique_ptr wallet) { QMutexLocker locker(&m_mutex); // Return model instance if exists. if (!m_wallets.empty()) { std::string name = wallet->getWalletName(); for (WalletModel* wallet_model : m_wallets) { if (wallet_model->wallet().getWalletName() == name) { return wallet_model; } } } // Instantiate model and register it. WalletModel* wallet_model = new WalletModel(std::move(wallet), m_client_model, m_platform_style, nullptr /* required for the following moveToThread() call */); // Move WalletModel object to the thread that created the WalletController // object (GUI main thread), instead of the current thread, which could be // an outside wallet thread or RPC thread sending a LoadWallet notification. // This ensures queued signals sent to the WalletModel object will be // handled on the GUI event loop. wallet_model->moveToThread(thread()); // setParent(parent) must be called in the thread which created the parent object. More details in #18948. QMetaObject::invokeMethod(this, [wallet_model, this] { wallet_model->setParent(this); }, GUIUtil::blockingGUIThreadConnection()); m_wallets.push_back(wallet_model); // WalletModel::startPollBalance needs to be called in a thread managed by // Qt because of startTimer. Considering the current thread can be a RPC // thread, better delegate the calling to Qt with Qt::AutoConnection. const bool called = QMetaObject::invokeMethod(wallet_model, "startPollBalance"); assert(called); connect(wallet_model, &WalletModel::unload, this, [this, wallet_model] { // Defer removeAndDeleteWallet when no modal widget is active. // TODO: remove this workaround by removing usage of QDialog::exec. if (QApplication::activeModalWidget()) { connect(qApp, &QApplication::focusWindowChanged, wallet_model, [this, wallet_model]() { if (!QApplication::activeModalWidget()) { removeAndDeleteWallet(wallet_model); } }, Qt::QueuedConnection); } else { removeAndDeleteWallet(wallet_model); } }, Qt::QueuedConnection); // Re-emit coinsSent signal from wallet model. connect(wallet_model, &WalletModel::coinsSent, this, &WalletController::coinsSent); Q_EMIT walletAdded(wallet_model); return wallet_model; } void WalletController::removeAndDeleteWallet(WalletModel* wallet_model) { // Unregister wallet model. { QMutexLocker locker(&m_mutex); m_wallets.erase(std::remove(m_wallets.begin(), m_wallets.end(), wallet_model)); } Q_EMIT walletRemoved(wallet_model); // Currently this can trigger the unload since the model can hold the last // CWallet shared pointer. delete wallet_model; } WalletControllerActivity::WalletControllerActivity(WalletController* wallet_controller, QWidget* parent_widget) : QObject(wallet_controller) , m_wallet_controller(wallet_controller) , m_parent_widget(parent_widget) { connect(this, &WalletControllerActivity::finished, this, &QObject::deleteLater); } void WalletControllerActivity::showProgressDialog(const QString& title_text, const QString& label_text, bool show_minimized) { auto progress_dialog = new QProgressDialog(m_parent_widget); progress_dialog->setAttribute(Qt::WA_DeleteOnClose); connect(this, &WalletControllerActivity::finished, progress_dialog, &QWidget::close); progress_dialog->setWindowTitle(title_text); progress_dialog->setLabelText(label_text); progress_dialog->setRange(0, 0); progress_dialog->setCancelButton(nullptr); progress_dialog->setWindowModality(Qt::ApplicationModal); GUIUtil::PolishProgressDialog(progress_dialog); // The setValue call forces QProgressDialog to start the internal duration estimation. // See details in https://bugreports.qt.io/browse/QTBUG-47042. progress_dialog->setValue(0); // When requested, launch dialog minimized if (show_minimized) progress_dialog->showMinimized(); } CreateWalletActivity::CreateWalletActivity(WalletController* wallet_controller, QWidget* parent_widget) : WalletControllerActivity(wallet_controller, parent_widget) { m_passphrase.reserve(MAX_PASSPHRASE_SIZE); } CreateWalletActivity::~CreateWalletActivity() { delete m_create_wallet_dialog; delete m_passphrase_dialog; } void CreateWalletActivity::askPassphrase() { m_passphrase_dialog = new AskPassphraseDialog(AskPassphraseDialog::Encrypt, m_parent_widget, &m_passphrase); m_passphrase_dialog->setWindowModality(Qt::ApplicationModal); m_passphrase_dialog->show(); connect(m_passphrase_dialog, &QObject::destroyed, [this] { m_passphrase_dialog = nullptr; }); connect(m_passphrase_dialog, &QDialog::accepted, [this] { createWallet(); }); connect(m_passphrase_dialog, &QDialog::rejected, [this] { Q_EMIT finished(); }); } void CreateWalletActivity::createWallet() { showProgressDialog( //: Title of window indicating the progress of creation of a new wallet. tr("Create Wallet"), /*: Descriptive text of the create wallet progress window which indicates to the user which wallet is currently being created. */ tr("Creating Wallet %1…").arg(m_create_wallet_dialog->walletName().toHtmlEscaped())); std::string name = m_create_wallet_dialog->walletName().toStdString(); uint64_t flags = 0; // Enable descriptors by default. flags |= WALLET_FLAG_DESCRIPTORS; if (m_create_wallet_dialog->isDisablePrivateKeysChecked()) { flags |= WALLET_FLAG_DISABLE_PRIVATE_KEYS; } if (m_create_wallet_dialog->isMakeBlankWalletChecked()) { flags |= WALLET_FLAG_BLANK_WALLET; } if (m_create_wallet_dialog->isExternalSignerChecked()) { flags |= WALLET_FLAG_EXTERNAL_SIGNER; } QTimer::singleShot(500ms, worker(), [this, name, flags] { auto wallet{node().walletLoader().createWallet(name, m_passphrase, flags, m_warning_message)}; if (wallet) { m_wallet_model = m_wallet_controller->getOrCreateWallet(std::move(*wallet)); } else { m_error_message = util::ErrorString(wallet); } QTimer::singleShot(500ms, this, &CreateWalletActivity::finish); }); } void CreateWalletActivity::finish() { if (!m_error_message.empty()) { QMessageBox::critical(m_parent_widget, tr("Create wallet failed"), QString::fromStdString(m_error_message.translated)); } else if (!m_warning_message.empty()) { QMessageBox::warning(m_parent_widget, tr("Create wallet warning"), QString::fromStdString(Join(m_warning_message, Untranslated("\n")).translated)); } if (m_wallet_model) Q_EMIT created(m_wallet_model); Q_EMIT finished(); } void CreateWalletActivity::create() { m_create_wallet_dialog = new CreateWalletDialog(m_parent_widget); std::vector> signers; try { signers = node().listExternalSigners(); } catch (const std::runtime_error& e) { QMessageBox::critical(nullptr, tr("Can't list signers"), e.what()); } if (signers.size() > 1) { QMessageBox::critical(nullptr, tr("Too many external signers found"), QString::fromStdString("More than one external signer found. Please connect only one at a time.")); signers.clear(); } m_create_wallet_dialog->setSigners(signers); m_create_wallet_dialog->setWindowModality(Qt::ApplicationModal); m_create_wallet_dialog->show(); connect(m_create_wallet_dialog, &QObject::destroyed, [this] { m_create_wallet_dialog = nullptr; }); connect(m_create_wallet_dialog, &QDialog::rejected, [this] { Q_EMIT finished(); }); connect(m_create_wallet_dialog, &QDialog::accepted, [this] { if (m_create_wallet_dialog->isEncryptWalletChecked()) { askPassphrase(); } else { createWallet(); } }); } OpenWalletActivity::OpenWalletActivity(WalletController* wallet_controller, QWidget* parent_widget) : WalletControllerActivity(wallet_controller, parent_widget) { } void OpenWalletActivity::finish() { if (!m_error_message.empty()) { QMessageBox::critical(m_parent_widget, tr("Open wallet failed"), QString::fromStdString(m_error_message.translated)); } else if (!m_warning_message.empty()) { QMessageBox::warning(m_parent_widget, tr("Open wallet warning"), QString::fromStdString(Join(m_warning_message, Untranslated("\n")).translated)); } if (m_wallet_model) Q_EMIT opened(m_wallet_model); Q_EMIT finished(); } void OpenWalletActivity::open(const std::string& path) { QString name = path.empty() ? QString("["+tr("default wallet")+"]") : QString::fromStdString(path); showProgressDialog( //: Title of window indicating the progress of opening of a wallet. tr("Open Wallet"), /*: Descriptive text of the open wallet progress window which indicates to the user which wallet is currently being opened. */ tr("Opening Wallet %1…").arg(name.toHtmlEscaped())); QTimer::singleShot(0, worker(), [this, path] { auto wallet{node().walletLoader().loadWallet(path, m_warning_message)}; if (wallet) { m_wallet_model = m_wallet_controller->getOrCreateWallet(std::move(*wallet)); } else { m_error_message = util::ErrorString(wallet); } QTimer::singleShot(0, this, &OpenWalletActivity::finish); }); } LoadWalletsActivity::LoadWalletsActivity(WalletController* wallet_controller, QWidget* parent_widget) : WalletControllerActivity(wallet_controller, parent_widget) { } void LoadWalletsActivity::load(bool show_loading_minimized) { showProgressDialog( //: Title of progress window which is displayed when wallets are being loaded. tr("Load Wallets"), /*: Descriptive text of the load wallets progress window which indicates to the user that wallets are currently being loaded.*/ tr("Loading wallets…"), /*show_minimized=*/show_loading_minimized); QTimer::singleShot(0, worker(), [this] { for (auto& wallet : node().walletLoader().getWallets()) { m_wallet_controller->getOrCreateWallet(std::move(wallet)); } QTimer::singleShot(0, this, [this] { Q_EMIT finished(); }); }); } RestoreWalletActivity::RestoreWalletActivity(WalletController* wallet_controller, QWidget* parent_widget) : WalletControllerActivity(wallet_controller, parent_widget) { } void RestoreWalletActivity::restore(const fs::path& backup_file, const std::string& wallet_name) { QString name = QString::fromStdString(wallet_name); showProgressDialog( //: Title of progress window which is displayed when wallets are being restored. tr("Restore Wallet"), /*: Descriptive text of the restore wallets progress window which indicates to the user that wallets are currently being restored.*/ tr("Restoring Wallet %1…").arg(name.toHtmlEscaped())); QTimer::singleShot(0, worker(), [this, backup_file, wallet_name] { auto wallet{node().walletLoader().restoreWallet(backup_file, wallet_name, m_warning_message)}; if (wallet) { m_wallet_model = m_wallet_controller->getOrCreateWallet(std::move(*wallet)); } else { m_error_message = util::ErrorString(wallet); } QTimer::singleShot(0, this, &RestoreWalletActivity::finish); }); } void RestoreWalletActivity::finish() { if (!m_error_message.empty()) { //: Title of message box which is displayed when the wallet could not be restored. QMessageBox::critical(m_parent_widget, tr("Restore wallet failed"), QString::fromStdString(m_error_message.translated)); } else if (!m_warning_message.empty()) { //: Title of message box which is displayed when the wallet is restored with some warning. QMessageBox::warning(m_parent_widget, tr("Restore wallet warning"), QString::fromStdString(Join(m_warning_message, Untranslated("\n")).translated)); } else { //: Title of message box which is displayed when the wallet is successfully restored. QMessageBox::information(m_parent_widget, tr("Restore wallet message"), QString::fromStdString(Untranslated("Wallet restored successfully \n").translated)); } if (m_wallet_model) Q_EMIT restored(m_wallet_model); Q_EMIT finished(); } void MigrateWalletActivity::migrate(WalletModel* wallet_model) { // Warn the user about migration QMessageBox box(m_parent_widget); box.setWindowTitle(tr("Migrate wallet")); box.setText(tr("Are you sure you wish to migrate the wallet %1?").arg(GUIUtil::HtmlEscape(wallet_model->getDisplayName()))); box.setInformativeText(tr("Migrating the wallet will convert this wallet to one or more descriptor wallets. A new wallet backup will need to be made.\n" "If this wallet contains any watchonly scripts, a new wallet will be created which contains those watchonly scripts.\n" "If this wallet contains any solvable but not watched scripts, a different and new wallet will be created which contains those scripts.\n\n" "The migration process will create a backup of the wallet before migrating. This backup file will be named " "-.legacy.bak and can be found in the directory for this wallet. In the event of " "an incorrect migration, the backup can be restored with the \"Restore Wallet\" functionality.")); box.setStandardButtons(QMessageBox::Yes|QMessageBox::Cancel); box.setDefaultButton(QMessageBox::Yes); if (box.exec() != QMessageBox::Yes) return; // Get the passphrase if it is encrypted regardless of it is locked or unlocked. We need the passphrase itself. SecureString passphrase; WalletModel::EncryptionStatus enc_status = wallet_model->getEncryptionStatus(); if (enc_status == WalletModel::EncryptionStatus::Locked || enc_status == WalletModel::EncryptionStatus::Unlocked) { AskPassphraseDialog dlg(AskPassphraseDialog::Unlock, m_parent_widget, &passphrase); dlg.setModel(wallet_model); dlg.exec(); } // GUI needs to remove the wallet so that it can actually be unloaded by migration const std::string name = wallet_model->wallet().getWalletName(); m_wallet_controller->removeAndDeleteWallet(wallet_model); showProgressDialog(tr("Migrate Wallet"), tr("Migrating Wallet %1…").arg(GUIUtil::HtmlEscape(name))); QTimer::singleShot(0, worker(), [this, name, passphrase] { auto res{node().walletLoader().migrateWallet(name, passphrase)}; if (res) { m_success_message = tr("The wallet '%1' was migrated successfully.").arg(GUIUtil::HtmlEscape(res->wallet->getWalletName())); if (res->watchonly_wallet_name) { m_success_message += tr(" Watchonly scripts have been migrated to a new wallet named '%1'.").arg(GUIUtil::HtmlEscape(res->watchonly_wallet_name.value())); } if (res->solvables_wallet_name) { m_success_message += tr(" Solvable but not watched scripts have been migrated to a new wallet named '%1'.").arg(GUIUtil::HtmlEscape(res->solvables_wallet_name.value())); } m_wallet_model = m_wallet_controller->getOrCreateWallet(std::move(res->wallet)); } else { m_error_message = util::ErrorString(res); } QTimer::singleShot(0, this, &MigrateWalletActivity::finish); }); } void MigrateWalletActivity::finish() { if (!m_error_message.empty()) { QMessageBox::critical(m_parent_widget, tr("Migration failed"), QString::fromStdString(m_error_message.translated)); } else { QMessageBox::information(m_parent_widget, tr("Migration Successful"), m_success_message); } if (m_wallet_model) Q_EMIT migrated(m_wallet_model); Q_EMIT finished(); }