Deduplicate bitcoind and bitcoin-qt init code

ryanofsky · ryanofsky · commit eeff271a693b · 2023-02-23T15:56:15.000-05:00
Add common InitConfig function to deduplicate bitcoind and bitcoin-qt code
parsing the config file, creating the datadir, and selecting the network.

There is a slight change of behavior for bitcoin-qt: When there is a problem
reading the configuration file, the error prefix is changed from "Error: Cannot
parse configuration file:" to "Error reading configuration file: ". The new
message is more accurate and makes the GUI consistent with the CLI.
diff --git a/src/Makefile.am b/src/Makefile.am
@@ -134,6 +134,7 @@ BITCOIN_CORE_H = \
   clientversion.h \
   coins.h \
   common/bloom.h \
+  common/init.h \
   common/run_command.h \
   common/url.h \
   compat/assumptions.h \
@@ -640,6 +641,7 @@ libbitcoin_common_a_SOURCES = \
   chainparams.cpp \
   coins.cpp \
   common/bloom.cpp \
+  common/init.cpp \
   common/interfaces.cpp \
   common/run_command.cpp \
   compressor.cpp \
diff --git a/src/bitcoind.cpp b/src/bitcoind.cpp
@@ -9,6 +9,7 @@
 
 #include <chainparams.h>
 #include <clientversion.h>
+#include <common/init.h>
 #include <common/url.h>
 #include <compat/compat.h>
 #include <init.h>
@@ -150,17 +151,8 @@ static bool AppInit(NodeContext& node, int argc, char* argv[])
     std::any context{&node};
     try
     {
-        if (!CheckDataDirOption()) {
-            return InitError(Untranslated(strprintf("Specified data directory \"%s\" does not exist.", args.GetArg("-datadir", ""))));
-        }
-        if (!args.ReadConfigFiles(error, true)) {
-            return InitError(Untranslated(strprintf("Error reading configuration file: %s", error)));
-        }
-        // Check for chain settings (Params() calls are only valid after this clause)
-        try {
-            SelectParams(args.GetChainName());
-        } catch (const std::exception& e) {
-            return InitError(Untranslated(strprintf("%s", e.what())));
+        if (auto error = common::InitConfig(args)) {
+            return InitError(*error);
         }
 
         // Error out when loose non-argument tokens are encountered on command line
diff --git a/src/common/init.cpp b/src/common/init.cpp
@@ -0,0 +1,29 @@
+// Copyright (c) 2023 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 <common/init.h>
+#include <chainparams.h>
+#include <util/system.h>
+
+#include <optional>
+
+namespace common {
+std::optional<bilingual_str> InitConfig(ArgsManager& args)
+{
+    if (!CheckDataDirOption()) {
+        return strprintf(_("Specified data directory \"%s\" does not exist."), args.GetArg("-datadir", ""));
+    }
+    std::string error;
+    if (!args.ReadConfigFiles(error, true)) {
+        return strprintf(_("Error reading configuration file: %s"), error);
+    }
+    // Check for chain settings (Params() calls are only valid after this clause)
+    try {
+        SelectParams(args.GetChainName());
+    } catch (const std::exception& e) {
+       return Untranslated(e.what());
+    }
+    return {};
+}
+} // namespace commond
diff --git a/src/common/init.h b/src/common/init.h
@@ -0,0 +1,19 @@
+// Copyright (c) 2023 The Bitcoin Core developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#ifndef BITCOIN_COMMON_INIT_H
+#define BITCOIN_COMMON_INIT_H
+
+#include <util/translation.h>
+
+#include <optional>
+
+class ArgsManager;
+
+namespace common {
+/* Read config files and create datadir if it does not exist. Return error on failure */
+std::optional<bilingual_str> InitConfig(ArgsManager& args);
+} // namespace common
+
+#endif // BITCOIN_COMMON_INIT_H
diff --git a/src/qt/bitcoin.cpp b/src/qt/bitcoin.cpp
@@ -9,6 +9,7 @@
 #include <qt/bitcoin.h>
 
 #include <chainparams.h>
+#include <common/init.h>
 #include <init.h>
 #include <interfaces/handler.h>
 #include <interfaces/init.h>
@@ -586,33 +587,19 @@ int GuiMain(int argc, char* argv[])
     // Gracefully exit if the user cancels
     if (!Intro::showIfNeeded(did_show_intro, prune_MiB)) return EXIT_SUCCESS;
 
-    /// 6a. Determine availability of data directory
-    if (!CheckDataDirOption()) {
-        InitError(strprintf(Untranslated("Specified data directory \"%s\" does not exist."), gArgs.GetArg("-datadir", "")));
-        QMessageBox::critical(nullptr, PACKAGE_NAME,
-            QObject::tr("Error: Specified data directory \"%1\" does not exist.").arg(QString::fromStdString(gArgs.GetArg("-datadir", ""))));
-        return EXIT_FAILURE;
-    }
     try {
-        /// 6b. Parse bitcoin.conf
-        /// - Do not call gArgs.GetDataDirNet() before this step finishes
-        if (!gArgs.ReadConfigFiles(error, true)) {
-            InitError(strprintf(Untranslated("Error reading configuration file: %s"), error));
-            QMessageBox::critical(nullptr, PACKAGE_NAME,
-                QObject::tr("Error: Cannot parse configuration file: %1.").arg(QString::fromStdString(error)));
-            return EXIT_FAILURE;
-        }
-
-        /// 7. Determine network (and switch to network specific options)
+        /// 6-7. Parse bitcoin.conf, determine network, switch to network specific options, and create datadir.
+        // - Do not call gArgs.GetDataDirNet() before this step finishes
         // - Do not call Params() before this step
-        // - Do this after parsing the configuration file, as the network can be switched there
         // - QSettings() will use the new application name after this, resulting in network-specific settings
         // - Needs to be done before createOptionsModel
-
-        // Check for chain settings (Params() calls are only valid after this clause)
-        SelectParams(gArgs.GetChainName());
+        if (auto error = common::InitConfig(gArgs)) {
+            InitError(*error);
+            QMessageBox::critical(nullptr, PACKAGE_NAME, QObject::tr("Error: %1").arg(QString::fromStdString(error->translated)));
+            return EXIT_FAILURE;
+        }
     } catch(std::exception &e) {
-        InitError(Untranslated(strprintf("%s", e.what())));
+        InitError(Untranslated(e.what()));
         QMessageBox::critical(nullptr, PACKAGE_NAME, QObject::tr("Error: %1").arg(e.what()));
         return EXIT_FAILURE;
     }
