Fix backslash-unaware pipe escaping in markdown tables - #46
Open
elhoim wants to merge 1 commit into
Open
Conversation
response_to_table() escaped '|' as '\\|' without first escaping existing backslashes. A value already containing a literal backslash immediately before a pipe (a Windows path, a regex snippet) turned '\|' into '\\|' after escaping: markdown reads that as an escaped backslash followed by an UNescaped pipe delimiter, breaking the table row it was meant to protect. Fix: escape backslashes before escaping pipes, so any pre-existing backslash is doubled first and the pipe delimiter stays properly escaped.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Finding 34 (Low) —
bin/cli.py:409,418,421Problem
.replace('|','\|') is not backslash-aware, so a value already containing a backslash before a pipe (a Windows path, a regex snippet) becomes backslash-backslash-pipe, which markdown reads as an escaped backslash plus an UNescaped delimiter - breaking the very table row the escaping protects.
Fix
response_to_table() in bin/cli.py escaped pipe characters as '|' for markdown table safety, but did so without first escaping any pre-existing backslashes in the value. A value containing a literal backslash immediately before a pipe (e.g. a Windows path or regex snippet like 'foo|bar') was turned into 'foo\|bar' -- markdown parses that as an escaped backslash followed by an UNescaped pipe delimiter, breaking the very table row the escaping was meant to protect. The fix adds a backslash-escaping replace step before the pipe-escaping replace at all three call sites (dict key/value, list value, scalar value), so any existing backslash is doubled first and the trailing pipe escape remains intact.
Verification
Reproduced against the unmodified code at
9b8c605, then re-checked after the change.Before
After
python bin/cli.py --helpexits 0 and the module still imports cleanly. Verification was performed offline against the pure functions — no runningmisp-modulesinstance is required.Branched from
9b8c605. This PR addresses only this finding; the other findings from the same review are in separate PRs, so they will need rebasing against each other as they merge.🤖 Generated with Claude Code
https://claude.ai/code/session_01DYX4TKA5inzByJ4qGWKjqh