Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2070,9 +2070,12 @@ where

let tx_abort = should_ack.then(|| {
let logger = WithChannelContext::from(logger, &self.context(), None);
let reason =
types::string::UntrustedString(String::from_utf8_lossy(&msg.data).to_string());
log_info!(logger, "Counterparty failed interactive transaction negotiation: {reason}");
let reason = String::from_utf8_lossy(&msg.data);
log_info!(
logger,
"Counterparty failed interactive transaction negotiation: {}",
log_msg!(reason)
);
msgs::TxAbort {
channel_id: msg.channel_id,
data: "Acknowledged tx_abort".to_string().into_bytes(),
Expand Down
15 changes: 6 additions & 9 deletions lightning/src/ln/peer_handler.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,6 @@ use crate::onion_message::packet::OnionMessageContents;
use crate::routing::gossip::{NodeAlias, NodeId};
use crate::sign::{NodeSigner, Recipient};
use crate::types::features::{InitFeatures, NodeFeatures};
use crate::types::string::PrintableString;
use crate::util::atomic_counter::AtomicCounter;
use crate::util::logger::{Level, Logger, WithContext};
use crate::util::ser::{VecWriter, Writeable, Writer};
Expand DownExpand Up@@ -2384,15 +2383,15 @@ impl<
logger,
"Got Err message from {}: {}",
their_node_id,
PrintableString(&msg.data)
log_msg!(msg.data)
);
self.message_handler.chan_handler.handle_error(their_node_id, &msg);
if msg.channel_id.is_zero() {
return Err(PeerHandleError {}.into());
}
},
Message::Warning(msg) => {
log_debug!(logger, "Got warning message: {}", PrintableString(&msg.data));
log_debug!(logger, "Got warning message: {}", log_msg!(msg.data));
},

Message::Ping(msg) => {
Expand DownExpand Up@@ -3246,7 +3245,7 @@ impl<
msgs::ErrorAction::DisconnectPeer { msg } => {
if let Some(msg) = msg.as_ref() {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
} else {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler",
);
Expand All@@ -3260,7 +3259,7 @@ impl<
},
msgs::ErrorAction::DisconnectPeerWithWarning { msg } => {
log_trace!(logger, "Handling DisconnectPeer HandleError event in peer_handler with message {}",
msg.data);
log_msg!(msg.data));
// We do not have the peers write lock, so we just store that we're
// about to disconnect the peer and do it after we finish
// processing most messages.
Expand All@@ -3283,8 +3282,7 @@ impl<
},
msgs::ErrorAction::SendErrorMessage { msg } => {
log_trace!(logger, "Handling SendErrorMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Error(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand All@@ -3293,8 +3291,7 @@ impl<
},
msgs::ErrorAction::SendWarningMessage { msg, ref log_level } => {
log_given_level!(logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler with message {}",

msg.data);
log_msg!(msg.data));
let msg = Message::Warning(msg);
self.enqueue_message(
&mut *get_peer_for_forwarding!(&node_id)?,
Expand Down
85 changes: 85 additions & 0 deletions lightning/src/util/macro_logger.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,33 @@ macro_rules! log_spendable {
};
}

/// The maximum number of characters to display in a network message log entry.
pub(crate) const LOG_MSG_MAX_LEN: usize = 512;

/// Wraps a string slice for Display, truncating to [`LOG_MSG_MAX_LEN`] characters and
/// delegating sanitization to [`crate::types::string::PrintableString`].
/// Useful for logging counterparty-provided messages.
pub(crate) struct DebugMsg<'a>(pub &'a str);
impl<'a> core::fmt::Display for DebugMsg<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
let (msg, was_truncated) = match self.0.char_indices().nth(LOG_MSG_MAX_LEN) {
Some((idx, _)) => (&self.0[..idx], true),
None => (self.0, false),
};
core::fmt::Display::fmt(&crate::types::string::PrintableString(msg), f)?;
if was_truncated {
f.write_str("...")?;
}
Ok(())
}
}
Comment thread
tnull marked this conversation as resolved.

macro_rules! log_msg {
($obj: expr) => {
$crate::util::macro_logger::DebugMsg(&$obj)
};
}

/// Create a new Record and log it. You probably don't want to use this macro directly,
/// but it needs to be exported so `log_trace` etc can use it in external crates.
#[doc(hidden)]
Expand DownExpand Up@@ -226,3 +253,61 @@ macro_rules! log_gossip {
$crate::log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
)
}

#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;

#[test]
fn debug_msg_short_string() {
let s = "hello world";
assert_eq!(DebugMsg(s).to_string(), "hello world");
}

#[test]
fn debug_msg_truncates_at_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN + 100).collect();
let result = DebugMsg(&s).to_string();
// Should be exactly LOG_MSG_MAX_LEN 'a's followed by "..."
assert_eq!(result.len(), LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_no_truncation_at_exact_limit() {
let s: String = core::iter::repeat('a').take(LOG_MSG_MAX_LEN).collect();
let result = DebugMsg(&s).to_string();
assert_eq!(result.len(), LOG_MSG_MAX_LEN);
assert!(!result.ends_with("..."));
}

#[test]
fn debug_msg_replaces_control_characters() {
let s = "hello\x00world\nfoo";
let result = DebugMsg(s).to_string();
assert_eq!(result, "hello\u{FFFD}world\u{FFFD}foo");
}

#[test]
fn debug_msg_uses_printable_string_sanitization() {
let s = "safe\u{202E}cipsxe.exe";
assert_eq!(DebugMsg(s).to_string(), crate::types::string::PrintableString(s).to_string());
}

#[test]
fn debug_msg_multibyte_unicode() {
// Each emoji is multiple bytes but one character
let s: String = core::iter::repeat('\u{1F600}').take(LOG_MSG_MAX_LEN + 10).collect();
let result = DebugMsg(&s).to_string();
let char_count: usize = result.chars().count();
// LOG_MSG_MAX_LEN emoji chars + 3 chars for "..."
assert_eq!(char_count, LOG_MSG_MAX_LEN + 3);
assert!(result.ends_with("..."));
}

#[test]
fn debug_msg_empty_string() {
assert_eq!(DebugMsg("").to_string(), "");
}
}