mirrors/nnn
1
0
Fork 0
mirror of https://github.com/jarun/nnn.git synced 2025-01-15 13:26:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(preview-tui): handle quoting in start_preview more robustly

Browse source 
This commit makes the script more resistant to naughty filenames.
The script now depends on bash for the following features:
- Arrays
Correctly creating and passing argument lists is now simple
- Parameter transformation
`${parameter@Q}` makes it easy to correctly quote a string so that it
can be safely re-evaluated by the interpreter later.

On iTerm, the shell command used to render the preview is now passed to
osascript via a named pipe: `$FIFO_OSASCRIPT`. By not embedding the
shell command directly, we now no longer need to worry about osascript's
quoting rules. It's not perfect, because $SHELL and $TMPDIR might
contain naughty characters, but it's quite unlikely to happen.
This commit is contained in:
musjj 2023-04-19 08:20:41 +07:00
parent 621dbba02e
commit 432b0755d3
1 changed files with 44 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
plugins/preview-tui
View file

@ -1,4 +1,4 @@
#!/usr/bin/env sh #!/usr/bin/env bash
# Description: Terminal based file previewer # Description: Terminal based file previewer
# #
@ -89,27 +89,29 @@ NNN_SPLITSIZE=${NNN_SPLITSIZE:-50} # Set previewer split size percentage
TMPDIR=${TMPDIR:-/tmp} TMPDIR=${TMPDIR:-/tmp}
NNN_PARENT=${NNN_FIFO#*.} NNN_PARENT=${NNN_FIFO#*.}
[ "$NNN_PARENT" -eq "$NNN_PARENT" ] 2>/dev/null || NNN_PARENT="" # Make empty if non-numeric [ "$NNN_PARENT" -eq "$NNN_PARENT" ] 2>/dev/null || NNN_PARENT="" # Make empty if non-numeric
ENVVARS=" ENVVARS=(
PWD=$PWD "PWD=$PWD"
PATH=$PATH "PATH=$PATH"
PREVIEW_MODE=$2 "PREVIEW_MODE=$2"
NNN_FIFO=$NNN_FIFO "NNN_FIFO=$NNN_FIFO"
NNN_SCOPE=${NNN_SCOPE:-0} "NNN_SCOPE=${NNN_SCOPE:-0}"
NNN_PISTOL=${NNN_PISTOL:-0} "NNN_PISTOL=${NNN_PISTOL:-0}"
NNN_ICONLOOKUP=${NNN_ICONLOOKUP:-0} "NNN_ICONLOOKUP=${NNN_ICONLOOKUP:-0}"
NNN_PAGER=${NNN_PAGER:-less -P?n -R} "NNN_PAGER=${NNN_PAGER:-less -P?n -R}"
NNN_BATTHEME=${NNN_BATTHEME:-ansi} "NNN_BATTHEME=${NNN_BATTHEME:-ansi}"
NNN_BATSTYLE=${NNN_BATSTYLE:-numbers} "NNN_BATSTYLE=${NNN_BATSTYLE:-numbers}"
NNN_PREVIEWWIDTH=${NNN_PREVIEWWIDTH:-1920} "NNN_PREVIEWWIDTH=${NNN_PREVIEWWIDTH:-1920}"
NNN_PREVIEWHEIGHT=${NNN_PREVIEWHEIGHT:-1080} "NNN_PREVIEWHEIGHT=${NNN_PREVIEWHEIGHT:-1080}"
NNN_PREVIEWDIR=${NNN_PREVIEWDIR:-$TMPDIR/nnn/previews} "NNN_PREVIEWDIR=${NNN_PREVIEWDIR:-$TMPDIR/nnn/previews}"
NNN_PREVIEWIMGPROG=${NNN_PREVIEWIMGPROG:-} "NNN_PREVIEWIMGPROG=${NNN_PREVIEWIMGPROG:-}"
FIFOPID=$TMPDIR/nnn-preview-tui-fifopid.$NNN_PARENT "FIFOPID=$TMPDIR/nnn-preview-tui-fifopid.$NNN_PARENT"
FIFOPATH=$TMPDIR/nnn-preview-tui-fifo.$NNN_PARENT "FIFOPATH=$TMPDIR/nnn-preview-tui-fifo.$NNN_PARENT"
PREVIEWPID=$TMPDIR/nnn-preview-tui-previewpid.$NNN_PARENT "PREVIEWPID=$TMPDIR/nnn-preview-tui-previewpid.$NNN_PARENT"
CURSEL=$TMPDIR/nnn-preview-tui-selection.$NNN_PARENT "CURSEL=$TMPDIR/nnn-preview-tui-selection.$NNN_PARENT"
FIFO_UEBERZUG=$TMPDIR/nnn-preview-tui-ueberzug-fifo.$NNN_PARENT "FIFO_UEBERZUG=$TMPDIR/nnn-preview-tui-ueberzug-fifo.$NNN_PARENT"
POSOFFSET=$TMPDIR/nnn-preview-tui-posoffset" "FIFO_OSASCRIPT=$TMPDIR/nnn-preview-tui-osascript-fifo.$NNN_PARENT"
"POSOFFSET=$TMPDIR/nnn-preview-tui-posoffset"
)
if [ -e "${TMUX%%,*}" ] && tmux -V | grep -q '[ -][3456789]\.'; then if [ -e "${TMUX%%,*}" ] && tmux -V | grep -q '[ -][3456789]\.'; then
NNN_TERMINAL=tmux NNN_TERMINAL=tmux
@ -119,6 +121,7 @@ elif [ -n "$WEZTERM_PANE" ]; then
NNN_TERMINAL=wezterm NNN_TERMINAL=wezterm
elif [ -z "$NNN_TERMINAL" ] && [ "$TERM_PROGRAM" = "iTerm.app" ]; then elif [ -z "$NNN_TERMINAL" ] && [ "$TERM_PROGRAM" = "iTerm.app" ]; then
NNN_TERMINAL=iterm NNN_TERMINAL=iterm
mkfifo "$FIFO_OSASCRIPT" || exit 1
elif [ -n "$WT_SESSION" ]; then elif [ -n "$WT_SESSION" ]; then
NNN_TERMINAL=winterm NNN_TERMINAL=winterm
else else
@ -131,20 +134,19 @@ elif [ "$NNN_SPLIT" != 'h' ]; then
NNN_SPLIT='v' NNN_SPLIT='v'
fi fi
ENVVARS="$ENVVARS ENVVARS+=(
NNN_SPLIT=$NNN_SPLIT "NNN_SPLIT=$NNN_SPLIT"
NNN_TERMINAL=$NNN_TERMINAL" "NNN_TERMINAL=$NNN_TERMINAL"
IFS=' )
' ENVARGS=()
for env in $ENVVARS; do for env in "${ENVVARS[@]}"; do
export "${env?}" export "${env?}"
case "$NNN_TERMINAL" in case "$NNN_TERMINAL" in
tmux) ENVSTRING="$ENVSTRING -e '$env'" ;; tmux) ENVARGS+=(-e "$env") ;;
kitty) ENVSTRING="$ENVSTRING --env '$env'" ;; kitty) ENVARGS+=(--env "$env") ;;
winterm|iterm) ENVSTRING="$ENVSTRING \\\"$env\\\"" ;; winterm|iterm|*) ENVARGS+=("$env") ;;
*) ENVSTRING="$ENVSTRING $env";;
esac esac
done; unset IFS done
trap '' PIPE trap '' PIPE
exists() { type "$1" >/dev/null 2>&1 ;} exists() { type "$1" >/dev/null 2>&1 ;}
@ -165,35 +167,35 @@ start_preview() {
case "$NNN_TERMINAL" in case "$NNN_TERMINAL" in
tmux) # tmux splits are inverted tmux) # tmux splits are inverted
if [ "$NNN_SPLIT" = "v" ]; then split="h"; else split="v"; fi if [ "$NNN_SPLIT" = "v" ]; then split="h"; else split="v"; fi
eval tmux split-window "$ENVSTRING" -d"$split" -p"$NNN_SPLITSIZE" "$0" "$1" 1 ;; tmux split-window "${ENVARGS[@]}" -d"$split" -p"$NNN_SPLITSIZE" "$0" "$1" 1 ;;
kitty) # Setting the layout for the new window. It will be restored after the script ends. kitty) # Setting the layout for the new window. It will be restored after the script ends.
kitty @ goto-layout splits kitty @ goto-layout splits
# Trying to use kitty's integrated window management as the split window. # Trying to use kitty's integrated window management as the split window.
eval kitty @ launch --no-response --title "preview-tui" --keep-focus \ kitty @ launch --no-response --title "preview-tui" --keep-focus \
--cwd "$PWD" "$ENVSTRING" --location "${NNN_SPLIT}split" "$0" "$1" 1 ;; --cwd "$PWD" "${ENVARGS[@]}" --location "${NNN_SPLIT}split" "$0" "$1" 1 ;;
wezterm) wezterm)
if [ "$NNN_SPLIT" = "v" ]; then split="--horizontal"; else split="--bottom"; fi if [ "$NNN_SPLIT" = "v" ]; then split="--horizontal"; else split="--bottom"; fi
wezterm cli split-pane --cwd "$PWD" $split --percent "$NNN_SPLITSIZE" "$0" "$1" 1 >/dev/null wezterm cli split-pane --cwd "$PWD" $split --percent "$NNN_SPLITSIZE" "$0" "$1" 1 >/dev/null
wezterm cli activate-pane-direction Prev ;; wezterm cli activate-pane-direction Prev ;;
iterm) iterm)
command="$SHELL -c 'cd $PWD; env $ENVSTRING $0 $1 1'" echo "cd ${PWD@Q}; env ${ENVARGS[*]@Q} ${0@Q} ${1@Q} 1" > "$FIFO_OSASCRIPT" &
if [ "$NNN_SPLIT" = "h" ]; then split="horizontally"; else split="vertically"; fi if [ "$NNN_SPLIT" = "h" ]; then split="horizontally"; else split="vertically"; fi
osascript <<-EOF osascript <<-EOF
tell application "iTerm" tell application "iTerm"
tell current session of current window tell current session of current window
split $split with default profile command "$command" split $split with default profile command "$SHELL $FIFO_OSASCRIPT"
end tell end tell
end tell end tell
EOF EOF
;; ;;
winterm) winterm)
if [ "$NNN_SPLIT" = "h" ]; then split="H"; else split="V"; fi if [ "$NNN_SPLIT" = "h" ]; then split="H"; else split="V"; fi
cmd.exe /c wt -w 0 sp -$split -s"0.$NNN_SPLITSIZE" bash -c "cd $PWD \; \ wt -w 0 sp -$split -s"0.$NNN_SPLITSIZE" bash -c "cd ${PWD@Q} ; \
env $ENVSTRING QLPATH=$2 $0 $1 1" \; -w 0 mf previous 2>/dev/null ;; env ${ENVARGS[*]@Q} QLPATH=${2@Q} ${0@Q} ${1@Q} 1" \; -w 0 mf previous 2>/dev/null ;;
*) if [ -n "$2" ]; then *) if [ -n "$2" ]; then
env "$ENVSTRING" QUICKLOOK=1 QLPATH="$2" "$0" "$1" 1 & env "${ENVARGS[@]}" QUICKLOOK=1 QLPATH="$2" "$0" "$1" 1 &
else else
env "$ENVSTRING" "$NNN_TERMINAL" -e "$0" "$1" 1 & env "${ENVARGS[@]}" "$NNN_TERMINAL" -e "$0" "$1" 1 &
fi ;; fi ;;
esac esac
} }