Bitcoin Core 28.0.0
P2P Digital Currency
Loading...
Searching...
No Matches
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#include <config/bitcoin-config.h> // IWYU pragma: keep
8
9#include <chain.h>
10#include <common/args.h>
11#include <common/system.h>
12#include <kernel/context.h>
13#include <kernel/warning.h>
14#include <logging.h>
15#include <node/abort.h>
16#include <node/interface_ui.h>
17#include <node/warnings.h>
18#include <util/check.h>
20#include <util/strencodings.h>
21#include <util/string.h>
22#include <util/translation.h>
23
24#include <cstdint>
25#include <string>
26#include <thread>
27
29
30static void AlertNotify(const std::string& strMessage)
31{
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
49namespace node {
50
52{
53 uiInterface.NotifyBlockTip(state, &index);
55 if (!m_shutdown()) {
56 LogError("Failed to send shutdown signal after reaching stop height\n");
57 }
58 return kernel::Interrupted{};
59 }
60 return {};
61}
62
63void KernelNotifications::headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync)
64{
65 uiInterface.NotifyHeaderTip(state, height, timestamp, presync);
66}
67
68void KernelNotifications::progress(const bilingual_str& title, int progress_percent, bool resume_possible)
69{
70 uiInterface.ShowProgress(title.translated, progress_percent, resume_possible);
71}
72
74{
75 if (m_warnings.Set(id, message)) {
76 AlertNotify(message.original);
77 }
78}
79
84
89
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:41
ArgsManager & args
Definition bitcoind.cpp:270
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: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 warningSet(kernel::Warning id, const bilingual_str &message) 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'...
void warningUnset(kernel::Warning id) override
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...
bool Unset(warning_type id) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Unset a warning message.
Definition warnings.cpp:36
bool Set(warning_type id, bilingual_str message) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Set a warning message.
Definition warnings.cpp:29
CClientUIInterface uiInterface
static void AlertNotify(const std::string &strMessage)
#define LogError(...)
Definition logging.h:271
Warning
Definition warning.h:9
std::variant< std::monostate, Interrupted > InterruptResult
Simple result type for functions that need to propagate an interrupt status and don't have other retu...
void ReadNotificationArgs(const ArgsManager &args, KernelNotifications &notifications)
void AbortNode(util::SignalInterrupt *shutdown, std::atomic< int > &exit_status, const bilingual_str &message, node::Warnings *warnings)
Definition abort.cpp:18
void ReplaceAll(std::string &in_out, const std::string &search, const std::string &substitute)
Definition string.cpp:11
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.
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition validation.h:82