Bitcoin Core  25.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 <shutdown.h>
19 #include <util/check.h>
20 #include <util/strencodings.h>
21 #include <util/string.h>
22 #include <util/translation.h>
23 #include <warnings.h>
24 
25 #include <cstdint>
26 #include <string>
27 #include <thread>
28 
29 static void AlertNotify(const std::string& strMessage)
30 {
31  uiInterface.NotifyAlertChanged();
32 #if HAVE_SYSTEM
33  std::string strCmd = gArgs.GetArg("-alertnotify", "");
34  if (strCmd.empty()) return;
35 
36  // Alert text should be plain ascii coming from a trusted source, but to
37  // be safe we first strip anything not in safeChars, then add single quotes around
38  // the whole string before passing it to the shell:
39  std::string singleQuote("'");
40  std::string safeStatus = SanitizeString(strMessage);
41  safeStatus = singleQuote+safeStatus+singleQuote;
42  ReplaceAll(strCmd, "%s", safeStatus);
43 
44  std::thread t(runCommand, strCmd);
45  t.detach(); // thread runs free
46 #endif
47 }
48 
49 static void DoWarning(const bilingual_str& warning)
50 {
51  static bool fWarned = false;
52  SetMiscWarning(warning);
53  if (!fWarned) {
54  AlertNotify(warning.original);
55  fWarned = true;
56  }
57 }
58 
59 namespace node {
60 
62 {
63  uiInterface.NotifyBlockTip(state, &index);
64  if (m_stop_at_height && index.nHeight >= m_stop_at_height) {
65  StartShutdown();
66  return kernel::Interrupted{};
67  }
68  return {};
69 }
70 
71 void KernelNotifications::headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync)
72 {
73  uiInterface.NotifyHeaderTip(state, height, timestamp, presync);
74 }
75 
76 void KernelNotifications::progress(const bilingual_str& title, int progress_percent, bool resume_possible)
77 {
78  uiInterface.ShowProgress(title.translated, progress_percent, resume_possible);
79 }
80 
82 {
84 }
85 
86 void KernelNotifications::flushError(const std::string& debug_message)
87 {
88  AbortNode(m_exit_status, debug_message);
89 }
90 
91 void KernelNotifications::fatalError(const std::string& debug_message, const bilingual_str& user_message)
92 {
93  node::AbortNode(m_exit_status, debug_message, user_message, m_shutdown_on_fatal_error);
94 }
95 
97 {
98  if (auto value{args.GetIntArg("-stopatheight")}) notifications.m_stop_at_height = *value;
99 }
100 
101 } // namespace node
ArgsManager gArgs
Definition: args.cpp:42
ArgsManager & args
Definition: bitcoind.cpp:269
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:481
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:456
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:159
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:171
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 flushError(const std::string &debug_message) override
The flush error notification is sent to notify the user that an error occurred while flushing block d...
void warning(const bilingual_str &warning) override
void fatalError(const std::string &debug_message, const bilingual_str &user_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.
CClientUIInterface uiInterface
static void AlertNotify(const std::string &strMessage)
static void DoWarning(const bilingual_str &warning)
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 ReadNotificationArgs(const ArgsManager &args, KernelNotifications &notifications)
void AbortNode(std::atomic< int > &exit_status, const std::string &debug_message, const bilingual_str &user_message, bool shutdown)
Definition: abort.cpp:19
void StartShutdown()
Request shutdown of the application.
Definition: shutdown.cpp:16
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:86
void SetMiscWarning(const bilingual_str &warning)
Definition: warnings.cpp:19