Bitcoin Core  27.99.0
P2P Digital Currency
kernel_notifications.cpp
Go to the documentation of this file.
1 // Copyright (c) 2023 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
6 
7 #if defined(HAVE_CONFIG_H)
9 #endif
10 
11 #include <chain.h>
12 #include <common/args.h>
13 #include <common/system.h>
14 #include <kernel/context.h>
15 #include <logging.h>
16 #include <node/abort.h>
17 #include <node/interface_ui.h>
18 #include <util/check.h>
19 #include <util/strencodings.h>
20 #include <util/string.h>
21 #include <util/translation.h>
22 #include <warnings.h>
23 
24 #include <cstdint>
25 #include <string>
26 #include <thread>
27 
28 static void AlertNotify(const std::string& strMessage)
29 {
30  uiInterface.NotifyAlertChanged();
31 #if HAVE_SYSTEM
32  std::string strCmd = gArgs.GetArg("-alertnotify", "");
33  if (strCmd.empty()) return;
34 
35  // Alert text should be plain ascii coming from a trusted source, but to
36  // be safe we first strip anything not in safeChars, then add single quotes around
37  // the whole string before passing it to the shell:
38  std::string singleQuote("'");
39  std::string safeStatus = SanitizeString(strMessage);
40  safeStatus = singleQuote+safeStatus+singleQuote;
41  ReplaceAll(strCmd, "%s", safeStatus);
42 
43  std::thread t(runCommand, strCmd);
44  t.detach(); // thread runs free
45 #endif
46 }
47 
48 static void DoWarning(const bilingual_str& warning)
49 {
50  static bool fWarned = false;
51  SetMiscWarning(warning);
52  if (!fWarned) {
53  AlertNotify(warning.original);
54  fWarned = true;
55  }
56 }
57 
58 namespace node {
59 
61 {
62  uiInterface.NotifyBlockTip(state, &index);
63  if (m_stop_at_height && index.nHeight >= m_stop_at_height) {
64  if (!m_shutdown()) {
65  LogPrintf("Error: failed to send shutdown signal after reaching stop height\n");
66  }
67  return kernel::Interrupted{};
68  }
69  return {};
70 }
71 
72 void KernelNotifications::headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync)
73 {
74  uiInterface.NotifyHeaderTip(state, height, timestamp, presync);
75 }
76 
77 void KernelNotifications::progress(const bilingual_str& title, int progress_percent, bool resume_possible)
78 {
79  uiInterface.ShowProgress(title.translated, progress_percent, resume_possible);
80 }
81 
83 {
85 }
86 
88 {
90 }
91 
93 {
95  m_exit_status, message);
96 }
97 
99 {
100  if (auto value{args.GetIntArg("-stopatheight")}) notifications.m_stop_at_height = *value;
101 }
102 
103 } // namespace node
ArgsManager gArgs
Definition: args.cpp:41
ArgsManager & args
Definition: bitcoind.cpp:268
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:480
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:455
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:141
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:153
util::SignalInterrupt & m_shutdown
int m_stop_at_height
Block height after which blockTip notification will return Interrupted{}, if >0.
void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
std::atomic< int > & m_exit_status
void progress(const bilingual_str &title, int progress_percent, bool resume_possible) override
void warning(const bilingual_str &warning) override
void fatalError(const bilingual_str &message) override
The fatal error notification is sent to notify the user when an error occurs in kernel code that can'...
kernel::InterruptResult blockTip(SynchronizationState state, CBlockIndex &index) override
bool m_shutdown_on_fatal_error
Useful for tests, can be set to false to avoid shutdown on fatal error.
void flushError(const bilingual_str &message) override
The flush error notification is sent to notify the user that an error occurred while flushing block d...
CClientUIInterface uiInterface
static void AlertNotify(const std::string &strMessage)
static void DoWarning(const bilingual_str &warning)
#define LogPrintf(...)
Definition: logging.h:244
std::variant< std::monostate, Interrupted > InterruptResult
Simple result type for functions that need to propagate an interrupt status and don't have other retu...
Definition: init.h:25
void AbortNode(util::SignalInterrupt *shutdown, std::atomic< int > &exit_status, const bilingual_str &message)
Definition: abort.cpp:19
void ReadNotificationArgs(const ArgsManager &args, KernelNotifications &notifications)
Bilingual messages:
Definition: translation.h:18
std::string translated
Definition: translation.h:20
std::string original
Definition: translation.h:19
Result type for use with std::variant to indicate that an operation should be interrupted.
std::string SanitizeString(std::string_view str, int rule)
Remove unsafe chars.
void ReplaceAll(std::string &in_out, const std::string &search, const std::string &substitute)
Definition: string.cpp:10
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:80
void SetMiscWarning(const bilingual_str &warning)
Definition: warnings.cpp:23