Fix exit codes:

UdjinM6 · UdjinM6 · commit bd0de1386e1c · 2016-11-04T18:40:33.000+03:00
- `--help`, `--version` etc should exit with `0` i.e. no error ("not enough args" case should still trigger an error)
- error reading config file should exit with `1`

Slightly refactor AppInitRPC/AppInitRawTx to return standard exit codes (EXIT_FAILURE/EXIT_SUCCESS) or CONTINUE_EXECUTION (-1)
diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp
@@ -28,6 +28,7 @@ using namespace std;
 
 static const char DEFAULT_RPCCONNECT[] = "127.0.0.1";
 static const int DEFAULT_HTTP_CLIENT_TIMEOUT=900;
+static const int CONTINUE_EXECUTION=-1;
 
 std::string HelpMessageCli()
 {
@@ -67,7 +68,11 @@ class CConnectionFailed : public std::runtime_error
 
 };
 
-static bool AppInitRPC(int argc, char* argv[])
+//
+// This function returns either one of EXIT_ codes when it's expected to stop the process or
+// CONTINUE_EXECUTION when it's expected to continue further.
+//
+static int AppInitRPC(int argc, char* argv[])
 {
     //
     // Parameters
@@ -85,31 +90,35 @@ static bool AppInitRPC(int argc, char* argv[])
         }
 
         fprintf(stdout, "%s", strUsage.c_str());
-        return false;
+        if (argc < 2) {
+            fprintf(stderr, "Error: too few parameters\n");
+            return EXIT_FAILURE;
+        }
+        return EXIT_SUCCESS;
     }
     if (!boost::filesystem::is_directory(GetDataDir(false))) {
         fprintf(stderr, "Error: Specified data directory \"%s\" does not exist.\n", mapArgs["-datadir"].c_str());
-        return false;
+        return EXIT_FAILURE;
     }
     try {
         ReadConfigFile(GetArg("-conf", BITCOIN_CONF_FILENAME), mapArgs, mapMultiArgs);
     } catch (const std::exception& e) {
         fprintf(stderr,"Error reading configuration file: %s\n", e.what());
-        return false;
+        return EXIT_FAILURE;
     }
     // Check for -testnet or -regtest parameter (BaseParams() calls are only valid after this clause)
     try {
         SelectBaseParams(ChainNameFromCommandLine());
     } catch (const std::exception& e) {
         fprintf(stderr, "Error: %s\n", e.what());
-        return false;
+        return EXIT_FAILURE;
     }
     if (GetBoolArg("-rpcssl", false))
     {
         fprintf(stderr, "Error: SSL mode for RPC (-rpcssl) is no longer supported.\n");
-        return false;
+        return EXIT_FAILURE;
     }
-    return true;
+    return CONTINUE_EXECUTION;
 }
 
 
@@ -354,8 +363,9 @@ int main(int argc, char* argv[])
     }
 
     try {
-        if(!AppInitRPC(argc, argv))
-            return EXIT_FAILURE;
+        int ret = AppInitRPC(argc, argv);
+        if (ret != CONTINUE_EXECUTION)
+            return ret;
     }
     catch (const std::exception& e) {
         PrintExceptionContinue(&e, "AppInitRPC()");
diff --git a/src/bitcoin-tx.cpp b/src/bitcoin-tx.cpp
@@ -30,8 +30,13 @@ using namespace std;
 
 static bool fCreateBlank;
 static map<string,UniValue> registers;
+static const int CONTINUE_EXECUTION=-1;
 
-static bool AppInitRawTx(int argc, char* argv[])
+//
+// This function returns either one of EXIT_ codes when it's expected to stop the process or
+// CONTINUE_EXECUTION when it's expected to continue further.
+//
+static int AppInitRawTx(int argc, char* argv[])
 {
     //
     // Parameters
@@ -89,9 +94,13 @@ static bool AppInitRawTx(int argc, char* argv[])
         strUsage += HelpMessageOpt("set=NAME:JSON-STRING", _("Set register NAME to given JSON-STRING"));
         fprintf(stdout, "%s", strUsage.c_str());
 
-        return false;
+        if (argc < 2) {
+            fprintf(stderr, "Error: too few parameters\n");
+            return EXIT_FAILURE;
+        }
+        return EXIT_SUCCESS;
     }
-    return true;
+    return CONTINUE_EXECUTION;
 }
 
 static void RegisterSetJson(const string& key, const string& rawJson)
@@ -678,8 +687,9 @@ int main(int argc, char* argv[])
     SetupEnvironment();
 
     try {
-        if(!AppInitRawTx(argc, argv))
-            return EXIT_FAILURE;
+        int ret = AppInitRawTx(argc, argv);
+        if (ret != CONTINUE_EXECUTION)
+            return ret;
     }
     catch (const std::exception& e) {
         PrintExceptionContinue(&e, "AppInitRawTx()");
diff --git a/src/bitcoind.cpp b/src/bitcoind.cpp
@@ -92,7 +92,7 @@ bool AppInit(int argc, char* argv[])
         }
 
         fprintf(stdout, "%s", strUsage.c_str());
-        return false;
+        return true;
     }
 
     try
diff --git a/src/qt/bitcoin.cpp b/src/qt/bitcoin.cpp
@@ -573,7 +573,7 @@ int main(int argc, char *argv[])
     {
         HelpMessageDialog help(NULL, mapArgs.count("-version"));
         help.showOrPrint();
-        return 1;
+        return 0;
     }
 
     /// 5. Now that settings and translations are available, ask user for data directory
@@ -594,7 +594,7 @@ int main(int argc, char *argv[])
     } catch (const std::exception& e) {
         QMessageBox::critical(0, QObject::tr(PACKAGE_NAME),
                               QObject::tr("Error: Cannot parse configuration file: %1. Only use key=value syntax.").arg(e.what()));
-        return false;
+        return 1;
     }
 
     /// 7. Determine network (and switch to network specific options)

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ using namespace std;`
`28`	`28`
`29`	`29`	`static const char DEFAULT_RPCCONNECT[] = "127.0.0.1";`
`30`	`30`	`static const int DEFAULT_HTTP_CLIENT_TIMEOUT=900;`
	`31`	`+static const int CONTINUE_EXECUTION=-1;`
`31`	`32`
`32`	`33`	`std::string HelpMessageCli()`
`33`	`34`	`{`
`@@ -67,7 +68,11 @@ class CConnectionFailed : public std::runtime_error`
`67`	`68`
`68`	`69`	`};`
`69`	`70`
`70`		`-static bool AppInitRPC(int argc, char* argv[])`
	`71`	`+//`
	`72`	`+// This function returns either one of EXIT_ codes when it's expected to stop the process or`
	`73`	`+// CONTINUE_EXECUTION when it's expected to continue further.`
	`74`	`+//`
	`75`	`+static int AppInitRPC(int argc, char* argv[])`
`71`	`76`	`{`
`72`	`77`	`//`
`73`	`78`	`// Parameters`
`@@ -85,31 +90,35 @@ static bool AppInitRPC(int argc, char* argv[])`
`85`	`90`	`}`
`86`	`91`
`87`	`92`	`fprintf(stdout, "%s", strUsage.c_str());`
`88`		`- return false;`
	`93`	`+ if (argc < 2) {`
	`94`	`+ fprintf(stderr, "Error: too few parameters\n");`
	`95`	`+ return EXIT_FAILURE;`
	`96`	`+ }`
	`97`	`+ return EXIT_SUCCESS;`
`89`	`98`	`}`
`90`	`99`	`if (!boost::filesystem::is_directory(GetDataDir(false))) {`
`91`	`100`	`fprintf(stderr, "Error: Specified data directory \"%s\" does not exist.\n", mapArgs["-datadir"].c_str());`
`92`		`- return false;`
	`101`	`+ return EXIT_FAILURE;`
`93`	`102`	`}`
`94`	`103`	`try {`
`95`	`104`	`ReadConfigFile(GetArg("-conf", BITCOIN_CONF_FILENAME), mapArgs, mapMultiArgs);`
`96`	`105`	`} catch (const std::exception& e) {`
`97`	`106`	`fprintf(stderr,"Error reading configuration file: %s\n", e.what());`
`98`		`- return false;`
	`107`	`+ return EXIT_FAILURE;`
`99`	`108`	`}`
`100`	`109`	`// Check for -testnet or -regtest parameter (BaseParams() calls are only valid after this clause)`
`101`	`110`	`try {`
`102`	`111`	`SelectBaseParams(ChainNameFromCommandLine());`
`103`	`112`	`} catch (const std::exception& e) {`
`104`	`113`	`fprintf(stderr, "Error: %s\n", e.what());`
`105`		`- return false;`
	`114`	`+ return EXIT_FAILURE;`
`106`	`115`	`}`
`107`	`116`	`if (GetBoolArg("-rpcssl", false))`
`108`	`117`	`{`
`109`	`118`	`fprintf(stderr, "Error: SSL mode for RPC (-rpcssl) is no longer supported.\n");`
`110`		`- return false;`
	`119`	`+ return EXIT_FAILURE;`
`111`	`120`	`}`
`112`		`- return true;`
	`121`	`+ return CONTINUE_EXECUTION;`
`113`	`122`	`}`
`114`	`123`
`115`	`124`
`@@ -354,8 +363,9 @@ int main(int argc, char* argv[])`
`354`	`363`	`}`
`355`	`364`
`356`	`365`	`try {`
`357`		`- if(!AppInitRPC(argc, argv))`
`358`		`- return EXIT_FAILURE;`
	`366`	`+ int ret = AppInitRPC(argc, argv);`
	`367`	`+ if (ret != CONTINUE_EXECUTION)`
	`368`	`+ return ret;`
`359`	`369`	`}`
`360`	`370`	`catch (const std::exception& e) {`
`361`	`371`	`PrintExceptionContinue(&e, "AppInitRPC()");`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ bool AppInit(int argc, char* argv[])`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`fprintf(stdout, "%s", strUsage.c_str());`
`95`		`- return false;`
	`95`	`+ return true;`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`try`
Original file line number	Diff line number	Diff line change
`@@ -573,7 +573,7 @@ int main(int argc, char *argv[])`
`573`	`573`	`{`
`574`	`574`	`HelpMessageDialog help(NULL, mapArgs.count("-version"));`
`575`	`575`	`help.showOrPrint();`
`576`		`- return 1;`
	`576`	`+ return 0;`
`577`	`577`	`}`
`578`	`578`
`579`	`579`	`/// 5. Now that settings and translations are available, ask user for data directory`
`@@ -594,7 +594,7 @@ int main(int argc, char *argv[])`
`594`	`594`	`} catch (const std::exception& e) {`
`595`	`595`	`QMessageBox::critical(0, QObject::tr(PACKAGE_NAME),`
`596`	`596`	`QObject::tr("Error: Cannot parse configuration file: %1. Only use key=value syntax.").arg(e.what()));`
`597`		`- return false;`
	`597`	`+ return 1;`
`598`	`598`	`}`
`599`	`599`
`600`	`600`	`/// 7. Determine network (and switch to network specific options)`