src/alert.h

   1 // Copyright (c) 2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2013 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or https://www.opensource.org/licenses/mit-license.php .
   5
   6 #ifndef BITCOIN_ALERT_H
   7 #define BITCOIN_ALERT_H
   8
   9 #include "serialize.h"
  10 #include "sync.h"
  11
  12 #include <map>
  13 #include <set>
  14 #include <stdint.h>
  15 #include <string>
  16
  17 class CAlert;
  18 class CNode;
  19 class uint256;
  20
  21 extern std::map<uint256, CAlert> mapAlerts;
  22 extern CCriticalSection cs_mapAlerts;
  23
  24 /** Alerts are for notifying old versions if they become too obsolete and
  25  * need to upgrade.  The message is displayed in the status bar.
  26  * Alert messages are broadcast as a vector of signed data.  Unserializing may
  27  * not read the entire buffer if the alert is for a newer version, but older
  28  * versions can still relay the original data.
  29  */
  30 class CUnsignedAlert
  31 {
  32 public:
  33     int nVersion;
  34     int64_t nRelayUntil;      // when newer nodes stop relaying to newer nodes
  35     int64_t nExpiration;
  36     int nID;
  37     int nCancel;
  38     std::set<int> setCancel;
  39     int nMinVer;            // lowest version inclusive
  40     int nMaxVer;            // highest version inclusive
  41     std::set<std::string> setSubVer;  // empty matches all
  42     int nPriority;
  43
  44     // Actions
  45     std::string strComment;
  46     std::string strStatusBar;
  47     std::string strRPCError;
  48
  49     ADD_SERIALIZE_METHODS;
  50
  51     template <typename Stream, typename Operation>
  52     inline void SerializationOp(Stream& s, Operation ser_action) {
  53         READWRITE(this->nVersion);
  54         READWRITE(nRelayUntil);
  55         READWRITE(nExpiration);
  56         READWRITE(nID);
  57         READWRITE(nCancel);
  58         READWRITE(setCancel);
  59         READWRITE(nMinVer);
  60         READWRITE(nMaxVer);
  61         READWRITE(setSubVer);
  62         READWRITE(nPriority);
  63
  64         READWRITE(LIMITED_STRING(strComment, 65536));
  65         READWRITE(LIMITED_STRING(strStatusBar, 256));
  66         READWRITE(LIMITED_STRING(strRPCError, 256));
  67     }
  68
  69     void SetNull();
  70
  71     std::string ToString() const;
  72 };
  73
  74 /** An alert is a combination of a serialized CUnsignedAlert and a signature. */
  75 class CAlert : public CUnsignedAlert
  76 {
  77 public:
  78     std::vector<unsigned char> vchMsg;
  79     std::vector<unsigned char> vchSig;
  80
  81     CAlert()
  82     {
  83         SetNull();
  84     }
  85
  86     ADD_SERIALIZE_METHODS;
  87
  88     template <typename Stream, typename Operation>
  89     inline void SerializationOp(Stream& s, Operation ser_action) {
  90         READWRITE(vchMsg);
  91         READWRITE(vchSig);
  92     }
  93
  94     void SetNull();
  95     bool IsNull() const;
  96     uint256 GetHash() const;
  97     bool IsInEffect() const;
  98     bool Cancels(const CAlert& alert) const;
  99     bool AppliesTo(int nVersion, const std::string& strSubVerIn) const;
 100     bool AppliesToMe() const;
 101     bool RelayTo(CNode* pnode) const;
 102     bool CheckSignature(const std::vector<unsigned char>& alertKey) const;
 103     bool ProcessAlert(const std::vector<unsigned char>& alertKey, bool fThread = true); // fThread means run -alertnotify in a free-running thread
 104     static void Notify(const std::string& strMessage, bool fThread);
 105
 106     /*
 107      * Get copy of (active) alert object by hash. Returns a null alert if it is not found.
 108      */
 109     static CAlert getAlertByHash(const uint256 &hash);
 110 };
 111
 112 #endif // BITCOIN_ALERT_H