util: Make util/error bilingual_str (refactor)

MarcoFalke · MarcoFalke · commit fa70d199d0c2 · 2019-08-28T15:52:26.000-04:00
Translated strings should not end up in the debug log, stderr, or
returned by an RPC.

Changing the util methods in util/error to return a bilingual_str paves
the way to achieve this goal in the long term.
diff --git a/src/init.cpp b/src/init.cpp
@@ -1060,7 +1060,7 @@ bool AppInitParameterInteraction()
     {
         CAmount n = 0;
         if (!ParseMoney(gArgs.GetArg("-incrementalrelayfee", ""), n))
-            return InitError(AmountErrMsg("incrementalrelayfee", gArgs.GetArg("-incrementalrelayfee", "")));
+            return InitError(AmountErrMsg("incrementalrelayfee", gArgs.GetArg("-incrementalrelayfee", "")).translated);
         incrementalRelayFee = CFeeRate(n);
     }
 
@@ -1104,7 +1104,7 @@ bool AppInitParameterInteraction()
     if (gArgs.IsArgSet("-minrelaytxfee")) {
         CAmount n = 0;
         if (!ParseMoney(gArgs.GetArg("-minrelaytxfee", ""), n)) {
-            return InitError(AmountErrMsg("minrelaytxfee", gArgs.GetArg("-minrelaytxfee", "")));
+            return InitError(AmountErrMsg("minrelaytxfee", gArgs.GetArg("-minrelaytxfee", "")).translated);
         }
         // High fee check is done afterward in WalletParameterInteraction()
         ::minRelayTxFee = CFeeRate(n);
@@ -1120,7 +1120,7 @@ bool AppInitParameterInteraction()
     {
         CAmount n = 0;
         if (!ParseMoney(gArgs.GetArg("-blockmintxfee", ""), n))
-            return InitError(AmountErrMsg("blockmintxfee", gArgs.GetArg("-blockmintxfee", "")));
+            return InitError(AmountErrMsg("blockmintxfee", gArgs.GetArg("-blockmintxfee", "")).translated);
     }
 
     // Feerate used to define dust.  Shouldn't be changed lightly as old
@@ -1129,7 +1129,7 @@ bool AppInitParameterInteraction()
     {
         CAmount n = 0;
         if (!ParseMoney(gArgs.GetArg("-dustrelayfee", ""), n))
-            return InitError(AmountErrMsg("dustrelayfee", gArgs.GetArg("-dustrelayfee", "")));
+            return InitError(AmountErrMsg("dustrelayfee", gArgs.GetArg("-dustrelayfee", "")).translated);
         dustRelayFee = CFeeRate(n);
     }
 
diff --git a/src/util/error.cpp b/src/util/error.cpp
@@ -41,12 +41,12 @@ std::string ResolveErrMsg(const std::string& optname, const std::string& strBind
     return strprintf(_("Cannot resolve -%s address: '%s'").translated, optname, strBind);
 }
 
-std::string AmountHighWarn(const std::string& optname)
+bilingual_str AmountHighWarn(const std::string& optname)
 {
-    return strprintf(_("%s is set very high!").translated, optname);
+    return strprintf(_("%s is set very high!"), optname);
 }
 
-std::string AmountErrMsg(const std::string& optname, const std::string& strValue)
+bilingual_str AmountErrMsg(const std::string& optname, const std::string& strValue)
 {
-    return strprintf(_("Invalid amount for -%s=<amount>: '%s'").translated, optname, strValue);
+    return strprintf(_("Invalid amount for -%s=<amount>: '%s'"), optname, strValue);
 }
diff --git a/src/util/error.h b/src/util/error.h
@@ -17,6 +17,8 @@
 
 #include <string>
 
+struct bilingual_str;
+
 enum class TransactionError {
     OK, //!< No error
     MISSING_INPUTS,
@@ -34,8 +36,8 @@ std::string TransactionErrorString(const TransactionError error);
 
 std::string ResolveErrMsg(const std::string& optname, const std::string& strBind);
 
-std::string AmountHighWarn(const std::string& optname);
+bilingual_str AmountHighWarn(const std::string& optname);
 
-std::string AmountErrMsg(const std::string& optname, const std::string& strValue);
+bilingual_str AmountErrMsg(const std::string& optname, const std::string& strValue);
 
 #endif // BITCOIN_UTIL_ERROR_H
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -4407,11 +4407,11 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,
     if (gArgs.IsArgSet("-mintxfee")) {
         CAmount n = 0;
         if (!ParseMoney(gArgs.GetArg("-mintxfee", ""), n) || 0 == n) {
-            chain.initError(AmountErrMsg("mintxfee", gArgs.GetArg("-mintxfee", "")));
+            chain.initError(AmountErrMsg("mintxfee", gArgs.GetArg("-mintxfee", "")).translated);
             return nullptr;
         }
         if (n > HIGH_TX_FEE_PER_KB) {
-            chain.initWarning(AmountHighWarn("-mintxfee") + " " +
+            chain.initWarning(AmountHighWarn("-mintxfee").translated + " " +
                               _("This is the minimum transaction fee you pay on every transaction.").translated);
         }
         walletInstance->m_min_fee = CFeeRate(n);
@@ -4425,7 +4425,7 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,
             return nullptr;
         }
         if (nFeePerK > HIGH_TX_FEE_PER_KB) {
-            chain.initWarning(AmountHighWarn("-fallbackfee") + " " +
+            chain.initWarning(AmountHighWarn("-fallbackfee").translated + " " +
                               _("This is the transaction fee you may pay when fee estimates are not available.").translated);
         }
         walletInstance->m_fallback_fee = CFeeRate(nFeePerK);
@@ -4438,19 +4438,19 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,
             return nullptr;
         }
         if (nFeePerK > HIGH_TX_FEE_PER_KB) {
-            chain.initWarning(AmountHighWarn("-discardfee") + " " +
+            chain.initWarning(AmountHighWarn("-discardfee").translated + " " +
                               _("This is the transaction fee you may discard if change is smaller than dust at this level").translated);
         }
         walletInstance->m_discard_rate = CFeeRate(nFeePerK);
     }
     if (gArgs.IsArgSet("-paytxfee")) {
         CAmount nFeePerK = 0;
         if (!ParseMoney(gArgs.GetArg("-paytxfee", ""), nFeePerK)) {
-            chain.initError(AmountErrMsg("paytxfee", gArgs.GetArg("-paytxfee", "")));
+            chain.initError(AmountErrMsg("paytxfee", gArgs.GetArg("-paytxfee", "")).translated);
             return nullptr;
         }
         if (nFeePerK > HIGH_TX_FEE_PER_KB) {
-            chain.initWarning(AmountHighWarn("-paytxfee") + " " +
+            chain.initWarning(AmountHighWarn("-paytxfee").translated + " " +
                               _("This is the transaction fee you will pay if you send a transaction.").translated);
         }
         walletInstance->m_pay_tx_fee = CFeeRate(nFeePerK, 1000);
@@ -4465,7 +4465,7 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,
     {
         CAmount nMaxFee = 0;
         if (!ParseMoney(gArgs.GetArg("-maxtxfee", ""), nMaxFee)) {
-            chain.initError(AmountErrMsg("maxtxfee", gArgs.GetArg("-maxtxfee", "")));
+            chain.initError(AmountErrMsg("maxtxfee", gArgs.GetArg("-maxtxfee", "")).translated);
             return nullptr;
         }
         if (nMaxFee > HIGH_MAX_TX_FEE) {
@@ -4480,7 +4480,7 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,
     }
 
     if (chain.relayMinFee().GetFeePerK() > HIGH_TX_FEE_PER_KB)
-        chain.initWarning(AmountHighWarn("-minrelaytxfee") + " " +
+        chain.initWarning(AmountHighWarn("-minrelaytxfee").translated + " " +
                     _("The wallet will avoid paying less than the minimum relay fee.").translated);
 
     walletInstance->m_confirm_target = gArgs.GetArg("-txconfirmtarget", DEFAULT_TX_CONFIRM_TARGET);

Original file line number	Diff line number	Diff line change
`@@ -1060,7 +1060,7 @@ bool AppInitParameterInteraction()`
`1060`	`1060`	`{`
`1061`	`1061`	`CAmount n = 0;`
`1062`	`1062`	`if (!ParseMoney(gArgs.GetArg("-incrementalrelayfee", ""), n))`
`1063`		`- return InitError(AmountErrMsg("incrementalrelayfee", gArgs.GetArg("-incrementalrelayfee", "")));`
	`1063`	`+ return InitError(AmountErrMsg("incrementalrelayfee", gArgs.GetArg("-incrementalrelayfee", "")).translated);`
`1064`	`1064`	`incrementalRelayFee = CFeeRate(n);`
`1065`	`1065`	`}`
`1066`	`1066`
`@@ -1104,7 +1104,7 @@ bool AppInitParameterInteraction()`
`1104`	`1104`	`if (gArgs.IsArgSet("-minrelaytxfee")) {`
`1105`	`1105`	`CAmount n = 0;`
`1106`	`1106`	`if (!ParseMoney(gArgs.GetArg("-minrelaytxfee", ""), n)) {`
`1107`		`- return InitError(AmountErrMsg("minrelaytxfee", gArgs.GetArg("-minrelaytxfee", "")));`
	`1107`	`+ return InitError(AmountErrMsg("minrelaytxfee", gArgs.GetArg("-minrelaytxfee", "")).translated);`
`1108`	`1108`	`}`
`1109`	`1109`	`// High fee check is done afterward in WalletParameterInteraction()`
`1110`	`1110`	`::minRelayTxFee = CFeeRate(n);`
`@@ -1120,7 +1120,7 @@ bool AppInitParameterInteraction()`
`1120`	`1120`	`{`
`1121`	`1121`	`CAmount n = 0;`
`1122`	`1122`	`if (!ParseMoney(gArgs.GetArg("-blockmintxfee", ""), n))`
`1123`		`- return InitError(AmountErrMsg("blockmintxfee", gArgs.GetArg("-blockmintxfee", "")));`
	`1123`	`+ return InitError(AmountErrMsg("blockmintxfee", gArgs.GetArg("-blockmintxfee", "")).translated);`
`1124`	`1124`	`}`
`1125`	`1125`
`1126`	`1126`	`// Feerate used to define dust. Shouldn't be changed lightly as old`
`@@ -1129,7 +1129,7 @@ bool AppInitParameterInteraction()`
`1129`	`1129`	`{`
`1130`	`1130`	`CAmount n = 0;`
`1131`	`1131`	`if (!ParseMoney(gArgs.GetArg("-dustrelayfee", ""), n))`
`1132`		`- return InitError(AmountErrMsg("dustrelayfee", gArgs.GetArg("-dustrelayfee", "")));`
	`1132`	`+ return InitError(AmountErrMsg("dustrelayfee", gArgs.GetArg("-dustrelayfee", "")).translated);`
`1133`	`1133`	`dustRelayFee = CFeeRate(n);`
`1134`	`1134`	`}`
`1135`	`1135`
Original file line number	Diff line number	Diff line change
`@@ -41,12 +41,12 @@ std::string ResolveErrMsg(const std::string& optname, const std::string& strBind`
`41`	`41`	`return strprintf(_("Cannot resolve -%s address: '%s'").translated, optname, strBind);`
`42`	`42`	`}`
`43`	`43`
`44`		`-std::string AmountHighWarn(const std::string& optname)`
	`44`	`+bilingual_str AmountHighWarn(const std::string& optname)`
`45`	`45`	`{`
`46`		`- return strprintf(_("%s is set very high!").translated, optname);`
	`46`	`+ return strprintf(_("%s is set very high!"), optname);`
`47`	`47`	`}`
`48`	`48`
`49`		`-std::string AmountErrMsg(const std::string& optname, const std::string& strValue)`
	`49`	`+bilingual_str AmountErrMsg(const std::string& optname, const std::string& strValue)`
`50`	`50`	`{`
`51`		`- return strprintf(_("Invalid amount for -%s=<amount>: '%s'").translated, optname, strValue);`
	`51`	`+ return strprintf(_("Invalid amount for -%s=<amount>: '%s'"), optname, strValue);`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4407,11 +4407,11 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,`
`4407`	`4407`	`if (gArgs.IsArgSet("-mintxfee")) {`
`4408`	`4408`	`CAmount n = 0;`
`4409`	`4409`	`if (!ParseMoney(gArgs.GetArg("-mintxfee", ""), n) \|\| 0 == n) {`
`4410`		`- chain.initError(AmountErrMsg("mintxfee", gArgs.GetArg("-mintxfee", "")));`
	`4410`	`+ chain.initError(AmountErrMsg("mintxfee", gArgs.GetArg("-mintxfee", "")).translated);`
`4411`	`4411`	`return nullptr;`
`4412`	`4412`	`}`
`4413`	`4413`	`if (n > HIGH_TX_FEE_PER_KB) {`
`4414`		`- chain.initWarning(AmountHighWarn("-mintxfee") + " " +`
	`4414`	`+ chain.initWarning(AmountHighWarn("-mintxfee").translated + " " +`
`4415`	`4415`	`_("This is the minimum transaction fee you pay on every transaction.").translated);`
`4416`	`4416`	`}`
`4417`	`4417`	`walletInstance->m_min_fee = CFeeRate(n);`
`@@ -4425,7 +4425,7 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,`
`4425`	`4425`	`return nullptr;`
`4426`	`4426`	`}`
`4427`	`4427`	`if (nFeePerK > HIGH_TX_FEE_PER_KB) {`
`4428`		`- chain.initWarning(AmountHighWarn("-fallbackfee") + " " +`
	`4428`	`+ chain.initWarning(AmountHighWarn("-fallbackfee").translated + " " +`
`4429`	`4429`	`_("This is the transaction fee you may pay when fee estimates are not available.").translated);`
`4430`	`4430`	`}`
`4431`	`4431`	`walletInstance->m_fallback_fee = CFeeRate(nFeePerK);`
`@@ -4438,19 +4438,19 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,`
`4438`	`4438`	`return nullptr;`
`4439`	`4439`	`}`
`4440`	`4440`	`if (nFeePerK > HIGH_TX_FEE_PER_KB) {`
`4441`		`- chain.initWarning(AmountHighWarn("-discardfee") + " " +`
	`4441`	`+ chain.initWarning(AmountHighWarn("-discardfee").translated + " " +`
`4442`	`4442`	`_("This is the transaction fee you may discard if change is smaller than dust at this level").translated);`
`4443`	`4443`	`}`
`4444`	`4444`	`walletInstance->m_discard_rate = CFeeRate(nFeePerK);`
`4445`	`4445`	`}`
`4446`	`4446`	`if (gArgs.IsArgSet("-paytxfee")) {`
`4447`	`4447`	`CAmount nFeePerK = 0;`
`4448`	`4448`	`if (!ParseMoney(gArgs.GetArg("-paytxfee", ""), nFeePerK)) {`
`4449`		`- chain.initError(AmountErrMsg("paytxfee", gArgs.GetArg("-paytxfee", "")));`
	`4449`	`+ chain.initError(AmountErrMsg("paytxfee", gArgs.GetArg("-paytxfee", "")).translated);`
`4450`	`4450`	`return nullptr;`
`4451`	`4451`	`}`
`4452`	`4452`	`if (nFeePerK > HIGH_TX_FEE_PER_KB) {`
`4453`		`- chain.initWarning(AmountHighWarn("-paytxfee") + " " +`
	`4453`	`+ chain.initWarning(AmountHighWarn("-paytxfee").translated + " " +`
`4454`	`4454`	`_("This is the transaction fee you will pay if you send a transaction.").translated);`
`4455`	`4455`	`}`
`4456`	`4456`	`walletInstance->m_pay_tx_fee = CFeeRate(nFeePerK, 1000);`
`@@ -4465,7 +4465,7 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,`
`4465`	`4465`	`{`
`4466`	`4466`	`CAmount nMaxFee = 0;`
`4467`	`4467`	`if (!ParseMoney(gArgs.GetArg("-maxtxfee", ""), nMaxFee)) {`
`4468`		`- chain.initError(AmountErrMsg("maxtxfee", gArgs.GetArg("-maxtxfee", "")));`
	`4468`	`+ chain.initError(AmountErrMsg("maxtxfee", gArgs.GetArg("-maxtxfee", "")).translated);`
`4469`	`4469`	`return nullptr;`
`4470`	`4470`	`}`
`4471`	`4471`	`if (nMaxFee > HIGH_MAX_TX_FEE) {`
`@@ -4480,7 +4480,7 @@ std::shared_ptr<CWallet> CWallet::CreateWalletFromFile(interfaces::Chain& chain,`
`4480`	`4480`	`}`
`4481`	`4481`
`4482`	`4482`	`if (chain.relayMinFee().GetFeePerK() > HIGH_TX_FEE_PER_KB)`
`4483`		`- chain.initWarning(AmountHighWarn("-minrelaytxfee") + " " +`
	`4483`	`+ chain.initWarning(AmountHighWarn("-minrelaytxfee").translated + " " +`
`4484`	`4484`	`_("The wallet will avoid paying less than the minimum relay fee.").translated);`
`4485`	`4485`
`4486`	`4486`	`walletInstance->m_confirm_target = gArgs.GetArg("-txconfirmtarget", DEFAULT_TX_CONFIRM_TARGET);`