Implement automatic shutdown of deprecated Zcash versions

Closes #2274.
2017-04-25 18:06:29 +12:00
parent 20d61ac0ea
commit 5b3bc9716e
10 changed files with 203 additions and 2 deletions
--- a/src/deprecation.cpp
+++ b/src/deprecation.cpp
@@ -0,0 +1,55 @@
+// Copyright (c) 2017 The Zcash developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#include "deprecation.h"
+
+#include "clientversion.h"
+#include "init.h"
+#include "ui_interface.h"
+#include "util.h"
+
+static const std::string CLIENT_VERSION_STR = FormatVersion(CLIENT_VERSION);
+
+void EnforceNodeDeprecation(int nHeight, bool forceLogging) {
+    int blocksToDeprecation = DEPRECATION_HEIGHT - nHeight;
+    bool disableDeprecation = (GetArg("-disabledeprecation", "") == CLIENT_VERSION_STR);
+    if (blocksToDeprecation <= 0) {
+        // In order to ensure we only log once per process when deprecation is
+        // disabled (to avoid log spam), we only need to log in two cases:
+        // - The deprecating block just arrived
+        //   - This can be triggered more than once if a block chain reorg
+        //     occurs, but that's an irregular event that won't cause spam.
+        // - The node is starting
+        if (blocksToDeprecation == 0 || forceLogging) {
+            auto msg = strprintf(_("This version has been deprecated as of block height %d."),
+                                 DEPRECATION_HEIGHT) + " " +
+                       _("You should upgrade to the latest version of Zcash.");
+            if (!disableDeprecation) {
+                msg += " " + strprintf(_("To disable deprecation for this version, set %s%s."),
+                                       "-disabledeprecation=", CLIENT_VERSION_STR);
+            }
+            LogPrintf("*** %s\n", msg);
+            uiInterface.ThreadSafeMessageBox(msg, "", CClientUIInterface::MSG_ERROR);
+        }
+        if (!disableDeprecation) {
+            StartShutdown();
+        }
+    } else if (blocksToDeprecation == DEPRECATION_WARN_LIMIT ||
+               (blocksToDeprecation < DEPRECATION_WARN_LIMIT && forceLogging)) {
+        std::string msg;
+        if (disableDeprecation) {
+            msg = strprintf(_("This version will be deprecated at block height %d."),
+                            DEPRECATION_HEIGHT) + " " +
+                  _("You should upgrade to the latest version of Zcash.");
+        } else {
+            msg = strprintf(_("This version will be deprecated at block height %d, and will automatically shut down."),
+                            DEPRECATION_HEIGHT) + " " +
+                  _("You should upgrade to the latest version of Zcash.") + " " +
+                  strprintf(_("To disable deprecation for this version, set %s%s."),
+                            "-disabledeprecation=", CLIENT_VERSION_STR);
+        }
+        LogPrintf("*** %s\n", msg);
+        uiInterface.ThreadSafeMessageBox(msg, "", CClientUIInterface::MSG_WARNING);
+    }
+}