#!/bin/sh # spmenu_run # Feature rich run launcher, file lister and .desktop launcher for spmenu # Set basic variables, in case the config isn't valid, env variables and config file can override these CONFDIR="${CONFDIR:-${XDG_CONFIG_HOME:-$HOME/.config}}" TERMINAL="${TERMINAL:-st -e}" BROWSER="${BROWSER:-xdg-open}" TORRENT="${TORRENT:-qbittorrent}" PDF_READER="${PDF_READER:-zathura}" EDITOR="${EDITOR:-nvim}" PLAYER="${PLAYER:-mpv}" GENERIC="${GENERIC:-$TERMINAL -e $EDITOR}" WEB_GREP="${WEB_GREP:-http:|https:|www[.]}" MAGNET_GREP="${MAGNET_GREP:-magnet:?}" HISTORY="${HISTORY:-${XDG_CACHE_HOME:-$HOME/.cache/}/spmenu_run.hist}" RUNLAUNCHER="${RUNLAUNCHER:-spmenu}" PREFIX="${PREFIX:-/usr}" DESTDIR="${DESTDIR:-}" STDOUT="${STDOUT:-false}" SORT_BY_NUMBER="${SORT_BY_NUMBER:-true}" SORT_IN_REVERSE="${SORT_IN_REVERSE:-true}" SORT_BY_RECENT="${SORT_BY_RECENT:-false}" SORT_ARGS="${SORT_ARGS:-}" UNIQ_ARGS="${UNIQ_ARGS:-}" HIDDEN_KEYWORDS="${HIDDEN_KEYWORDS:-spmenu}" KEYWORDS="${KEYWORDS:-}" DISPLAY_DUPLICATES="${DISPLAY_DUPLICATES:-false}" LS_ARGS="${LS_ARGS:- --color=always}" DESKTOP_DIR="${DESKTOP_DIR:-${DESTDIR}${PREFIX}/share/applications}" ICON_DIR="${ICON_DIR:-${DESTDIR}${PREFIX}/share/icons/hicolor ${DESTDIR}${PREFIX}/share/pixmaps}" TEMPORARY_DIR="${TEMPORARY_DIR:-$CONFDIR/spmenu/run/cache}" USEIMAGE="${USEIMAGE:-true}" CACHE="${CACHE:-true}" LOGFILE="${LOGFILE:-/tmp/spmenu_run.log}" check() { [ ! -d "$CONFDIR/spmenu/run" ] && mkdir -p "$CONFDIR/spmenu/run" if [ ! -f "$CONFDIR/spmenu/run/.first_run" ]; then print_help "$@" touch "$CONFDIR/spmenu/run/.first_run" fi } path() { [ "$SORT_BY_NUMBER" != "false" ] && NUMBERSORTARG="-n" [ "$SORT_IN_REVERSE" != "false" ] && REVERSESORTARG="-r" SORTARGS="$NUMBERSORTARG $REVERSESORTARG $SORT_ARGS" [ -z "$HIDDEN_KEYWORDS" ] && HIDDEN_KEYWORDS="NULL_ENTRY" print_menu() { print() { printf "%s\n" "$PATH" | \ tr ':' '\n' | \ sed 's#$#/#' | \ xargs ls -lu --time-style=+%s 2>&1 | \ grep -vE "$HIDDEN_KEYWORDS" | \ grep -E "$KEYWORDS" } if [ "$SORT_BY_RECENT" != "false" ]; then print | awk '/^(-|l)/ { print $6, $7 }' | sort $SORTARGS | cut -d' ' -f 2 2>&1 else print | awk '/^(-|l)/ { print $7 }' | sort $SORTARGS | cut -d' ' -f 2 2>&1 fi } # uniq if [ "$DISPLAY_DUPLICATES" != "false" ]; then print_menu else print_menu | uniq $UNIQ_ARGS fi command -v run_pre_func && run_pre_func } print_help() { cat << EOF | $RUNLAUNCHER $RUNLAUNCHER_HELP_ARGS --lines 20 --columns 1 --normal --sgr1 "#FFFF00" --hide-cursor --no-allow-typing --no-color-items --hide-prompt --hide-powerline --hide-input --hide-right-arrow --hide-left-arrow --hide-mode --hide-match-count > /dev/null Start typing in keywords to list out entries. Press Enter to select an entry. The selected entry will be run through a shell. To set spmenu options, you pass arguments to 'spmenu_run' directly. See 'spmenu --help' for a list of valid arguments. To configure spmenu, you may also copy ${DESTDIR}${PREFIX}/share/spmenu/example.Xresources to $CONFDIR/spmenu/spmenurc and edit that. - Type in '?' to show this help screen at any time. - If the entry selected starts with 'www', it will instead be treated as a link and spawned in a web browser (\$BROWSER) - If the entry selected starts with 'magnet', it will instead be treated as a magnet link and spawned in a torrent client (\$TORRENT) - If the entry selected starts with '?' followed by a valid command, it will be opened as a man page in spmenu. - If the entry starts with '#' followed by a valid command, it will be opened in the defined terminal emulator. $(printf '\033[0;31m')Note: This may also be displayed if you deleted your spmenu configuration directory. EOF parse "$args" exec_cmd "$args" } print_cli_help() { cat << EOF spmenu_run - Run launcher for spmenu spmenu -x, --run List entries in \$PATH. spmenu -f, --fm List files and directories in . spmenu -d, --desktop List .desktop entries. spmenu -h, --help Print this help. spmenu -o, --stdout Print to standard input and do not execute the selected item. spmenu -no, --no-stdout Don't print to standard input, execute the selected item. spmenu -a, --args Pass to spmenu. EOF } print_config() { [ -f "$CONFDIR/spmenu/run/config" ] && . "$CONFDIR/spmenu/run/config" && return mkdir -p "$CONFDIR/spmenu/run" cat << EOF > "$CONFDIR/spmenu/run/config" # spmenu_run default configuration file # # This is the configuration file for the run launcher spmenu comes with. # It is not the configuration file for spmenu, see ~/.config/spmenu/spmenu.conf for that. # # spmenu_run also runs these functions: # # 'run_pre_func' before spawning spmenu. # 'run_post_func' after spawning spmenu, selected item passed as an argument. # 'desktop_pre_func' before spawning spmenu. # 'desktop_post_func' after spawning spmenu, selected item passed as an argument. # 'fm_pre_func' before spawning spmenu. # 'fm_post_func' after spawning spmenu, selected item passed as an argument. # 'fm_pre_list_func' right before listing out files. # 'fm_post_list_func' right after listing out files. # 'read_man' when reading a man page, selected item passed as an argument. # # You may create those functions below. # # For example, to implement a basic history file: # # run_post_func() { # rm -f /tmp/spmenu_entryhist; printf "\$1\n" >> /tmp/spmenu_entryhist # } # # You can use anything POSIX compliant shells support, as well as programs available on the system. # misc software TERMINAL="\${TERMINAL:-st -e}" # Terminal commands are spawned in BROWSER="\${BROWSER:-xdg-open}" # Web browser, for URLs TORRENT="\${TORRENT:-qbittorrent}" # Torrent client, for magnet links PDF_READER="\${PDF_READER:-zathura}" # PDF reader, for file management EDITOR="\${EDITOR:-nvim}" # Editor, used to open documents PLAYER="\${PLAYER:-mpv}" # Player, used to play audio/video GENERIC="\${GENERIC:-\$TERMINAL -e \$EDITOR}" # Generic, used to open unknown files WEB_GREP="http:|https:|www[.]" # Needs to be in grep -E syntax MAGNET_GREP="magnet:?" # Needs to be in grep -E syntax HISTORY="\${XDG_CACHE_HOME:-\$HOME/.cache/}/spmenu_run.hist" # History file, spmenu (meaning your user) must have permission to read and write to it. # run launcher options RUNLAUNCHER="\${RUNLAUNCHER:-spmenu}" # Run launcher to use RUNLAUNCHER_RUN_ARGS="" # Extra rguments passed to \$RUNLAUNCHER when using the run launcher RUNLAUNCHER_DESKTOP_ARGS="" # Extra rguments passed to \$RUNLAUNCHER when using the .desktop launcher RUNLAUNCHER_FM_ARGS="--lines 40" # Extra arguments passed to \$RUNLAUNCHER when using the file manager RUNLAUNCHER_HELP_ARGS="" # Extra arguments passed to \$RUNLAUNCHER when using the help # sorting SORT_BY_NUMBER="true" # Sort by numbers SORT_IN_REVERSE="true" # Sort in reverse SORT_BY_RECENT="false" # Sort by recent SORT_ARGS="" # Extra arguments passed to the sort command. # keywords HIDDEN_KEYWORDS="spmenu" # Keywords that will be ignored, needs to be in grep -vE syntax. KEYWORDS="" # Keywords that will be matched, needs to be in grep -E syntax. # misc STDOUT="false" # Print to stdout and exit (true/false) DISPLAY_DUPLICATES="false" # Display duplicates or not DEFAULT_FEATURE="run" # spmenu_run default feature (run/fm/desktop/help) # .desktop options DESKTOP_DIR="\${DESTDIR}\${PREFIX}/share/applications" # Directories for .desktop entries ICON_DIR="\${DESTDIR}\${PREFIX}/share/icons/hicolor \${DESTDIR}\${PREFIX}/share/pixmaps" # Directories for icons defined in the entries TEMPORARY_DIR="\$CONFDIR/spmenu/run/cache" # Directory used to store cached entries USEIMAGE="true" # Enable images (true/false) CACHE="true" # Cache entries (true/false) LOGFILE="/tmp/spmenu_run.log" # Log file # file management DEFAULT_DIRECTORY="\$(pwd)" # Directory to start -fm if none is specified. LS_ARGS="\${LS_ARGS:- --color=always}" # Arguments passed to /bin/ls # function to read the man page in spmenu read_man() { man "\$1" | \\ col -b | \\ \${RUNLAUNCHER:-spmenu} --lines 40 --columns 1 -p "man \$1" } EOF [ -f "$CONFDIR/spmenu/run/config" ] && . "$CONFDIR/spmenu/run/config" && return } parse() { sout="$(path | sed "s/\&/\&/g" | $RUNLAUNCHER $RUNLAUNCHER_RUN_ARGS)" # parse case "$(printf '%c' "$sout")" in "#") EXEC="term" ;; "?") EXEC="man" ;; esac case "$(printf "%s" "$sout" | awk '{ print $1 }')" in "magnet") EXEC=torrent ;; "www") EXEC=web ;; "?") print_help "$@" && main && return ;; esac # check for keywords printf "%s" "$sout" | grep -qE "$WEB_GREP" && EXEC=web printf "%s" "$sout" | grep -qE "$MAGNET_GREP" && EXEC=torrent } exec_cmd() { [ -z "$EXEC" ] && EXEC=shell [ "$STDOUT" != "false" ] && printf "%s\n" "$sout" && exit 1 command -v run_post_func > /dev/null && run_post_func "$sout" read_nman() { $TERMINAL -e man "$1" } case "$EXEC" in "shell") printf "%s" "$sout" | sed "s/#//g" | ${SHELL:-"/bin/sh"} & ;; "term") $TERMINAL -e "$(printf "%s" "$sout" | sed "s/#//g")" & ;; "web") $BROWSER "$(printf "%s" "$sout" | sed "s/www //g")" & ;; "torrent") $TORRENT "$(printf "%s" "$sout" | sed "s/magnet //g")" & ;; "man") exec="$(printf "%s" "$sout" | sed "s/?//g")" [ -x "$(command -v "$exec")" ] || return if [ "$(command -v read_man)" ]; then read_man "$exec" return else read_nman "$exec" return fi ;; esac } remove_arg() { args="$(printf "%s\n" "$args" | sed "s|$1||g")"; } read_args() { function="${DEFAULT_FEATURE:-run}" # default functionality dir="${DEFAULT_DIRECTORY:-$(pwd)}" # default directory args="$(printf "%s\n" "$@")" argc="$(printf "%s\n" "$@" | wc -l)" while true; do i=$(($i+1)) arg="$(printf "%s\n" "$args" | sed "${i}q;d")" narg="$(printf "%s\n" "$args" | sed "$((i+1))q;d")" case "$arg" in -x|-run|--run) remove_arg "$arg" && function=run ;; -o|-stdout|--stdout) remove_arg "$arg" && STDOUT=true ;; -no|-no-stdout) remove_arg "$arg" && STDOUT=false ;; -f|-fm|--fm) remove_arg "$arg" [ -d "$narg" ] && dir="$narg" && remove_arg "$narg" function=fm ;; -d|-desktop|--desktop) remove_arg "$arg" function=desktop ;; -a|-args|--args) remove_arg "$arg" if [ -z "$narg" ]; then printf "You must specify a list of arguments to pass to %s.\n" "$RUNLAUNCHER" exit 1 fi remove_arg "$narg" MARGS="$narg" ;; -h|--help) remove_arg "$arg" && function=help ;; esac [ "$argc" = "$i" ] && break done args="$(printf "%s\n" "$*")" } exec_file() { [ "$STDOUT" != "false" ] && printf "%s\n" "$1" && exit 0 command -v fm_post_func > /dev/null && fm_post_func "$1" # some default basic parsing case "$1" in *.html|*.htm) $BROWSER "$1" ;; *.pdf) $PDF_READER "$1" ;; *.flac|*.mp3|*.wav|*.ogg) $PLAYER "$1" ;; *.mp4|*.mov|*.mkv) $PLAYER "$1" ;; *.theme) $EDITOR "$1" ;; *) if [ -x "$1" ]; then $TERMINAL -e "$1" else $GENERIC "$1" fi ;; esac } prepare_dirnav() { [ ! -d "$dir" ] && return 1 cd "$dir" || printf "Invalid directory.. somehow\n" listing() { command -v fm_pre_list_func > /dev/null && fm_pre_list_func ls $LS_ARGS # this allows us SGR colors printf "..\n" command -v fm_post_list_func > /dev/null && fm_post_list_func } command -v fm_pre_func > /dev/null && fm_pre_func dir="$(listing | $RUNLAUNCHER $RUNLAUNCHER_FM_ARGS | sed -e 's/\x1b\[[0-9;]*m//g')" case "$dir" in *) if [ -d "$dir" ]; then dir="$(pwd)/$dir" prepare_dirnav elif [ -f "$dir" ]; then exec_file "$dir" && return 0 return 1 else return 1 fi ;; esac } print_desktop_help() { cat << EOF | $RUNLAUNCHER $RUNLAUNCHER_HELP_ARGS --lines 20 --columns 1 --normal --sgr1 "#FFFF00" --hide-cursor --no-allow-typing --no-color-items --hide-prompt --hide-powerline --hide-input --hide-right-arrow --hide-left-arrow --hide-mode --hide-match-count > /dev/null Start typing in keywords to list out entries. Press Enter to select an entry. The selected entry will be run through a shell. To set spmenu options, you modify \$RUNLAUNCHER_ARGS in the config. See 'spmenu --help' for a list of valid arguments to add to the variable. To configure spmenu itself, you may copy ${DESTDIR}${PREFIX}/share/spmenu.conf to ~/.config/spmenu/spmenu.conf. By default, spmenu_run will cache entries for speed reasons. You can find these entries in ~/.config/spmenu/run/cache. If you make changes to .desktop files (not new entries, modified old entries), you need to clear the cache for the changes to appear. Simply delete the directory to do this. - Type in '?' to show this help screen at any time. $(printf '\033[0;31m')Note: This may also be displayed if you deleted your spmenu configuration directory. EOF } main_desktop() { print_menu() { if [ "$DISPLAY_DUPLICATES" != "false" ]; then res="$(print_list | $RUNLAUNCHER $RUNLAUNCHER_DESKTOP_ARGS)" else res="$(print_list | uniq $UNIQ_ARGS | $RUNLAUNCHER $RUNLAUNCHER_DESKTOP_ARGS)" fi } prep() { mkdir -p "$TEMPORARY_DIR"; rm -f "$LOGFILE"; touch "$LOGFILE"; } scan() { entry_c="$(find "$DESKTOP_DIR" -type f | wc -l)"; cached_c="$(find "$TEMPORARY_DIR" -type f | wc -l)"; cached="$(find "$TEMPORARY_DIR" -type f)"; } # cache it, this means some speed improvements cache() { printf "Cached: %s\n" "$cached_c" >> "$LOGFILE" printf "Entries: %s\n" "$entry_c" >> "$LOGFILE" [ "$cached_c" = "$entry_c" ] && return # we don't need to cache anything, it's already done # find entry="$(find $DESKTOP_DIR -type f)" icons="$(find $ICON_DIR -type f)" # write new entries for i in $(seq "$entry_c"); do cur_file="$(printf "%s" "$entry" | sed "${i}q;d")" exec="$(grep -v "TryExec" "$cur_file" | grep -m1 "Exec=" | sed "s/Exec=//g; s/%U//g; s/%F//g; s/%u//g")" name="$(grep "Name=" "$cur_file" | grep -v Generic | head -n 1 | sed "s/Name=//g")" # icon name icon_name="$(grep "Icon=" "$cur_file" | head -n 1 | sed "s/Icon=//g")" icon="$(printf "%s" "$icons" | grep "/$icon_name[.]" | head -n 1)" && [ ! -f "$icon" ] && icon="" # write the file printf "%s\n%s\n%s\n" "Name:$name" "Executable:$exec" "Icon:$icon" > "$TEMPORARY_DIR/$(basename "$cur_file").entry" done # run scan() again scan } print_list() { command -v desktop_pre_func > /dev/null && desktop_pre_func # print data from entries for i in $(seq "$cached_c"); do # current file cur_file="$(printf "%s" "$cached" | sed "${i}q;d")" && [ ! -e "$cur_file" ] && printf "File '%s' does not exist. Skipping...\n" "$cur_file" >> "$LOGFILE" && continue # get details to display title="$(head -n 1 "$cur_file" | sed "s/Name://g")" icon="$(tail -n 1 "$cur_file" | sed "s/Icon://g")" [ -z "$title" ] && continue # no title isn't worth displaying, obviously # print it all [ "$USEIMAGE" = "true" ] && [ ! -e "$icon" ] && USEIMAGE=false && reenable=1 [ "$USEIMAGE" = "true" ] && printf "%s\t%s\n" "IMG:${icon}" "$title" || \ printf "%s\n" "$title" [ "$reenable" = "1" ] && USEIMAGE=true done } execute_program() { [ "$res" = "?" ] && print_desktop_help && main "$@" command -v desktop_post_func > /dev/null && desktop_post_func "$res" [ -z "$res" ] && cached_c=0 || printf "User input: %s\n" "$res" >> "$LOGFILE" for i in $(seq "$cached_c"); do cur_file="$(printf "%s" "$cached" | sed "${i}q;d")" && [ ! -f "$cur_file" ] && printf "File '%s' does not exist. Skipping...\n" "$cur_file" >> "$LOGFILE" && continue # find the executable matching the selected name if grep -q "Name:$res" "$cur_file"; then exec="$(head -n 2 "$cur_file" | tail -n -1 | sed "s/Executable://g")" printf "Current file: '%s'\n" "$cur_file" >> "$LOGFILE" break; else exec="" continue; fi done # finally run the program if [ -n "$exec" ]; then /bin/sh -c "$exec" else [ -n "$res" ] && printf "No executable found. Try clearing cache." >> "$LOGFILE" fi return 0 } prep check scan cache print_menu "$@" execute_program "$@" } main() { print_config read_args "$@" check "$args" # some run launcher args RUNLAUNCHER_FM_ARGS="--insert --hist-file $HISTORY $RUNLAUNCHER_FM_ARGS $MARGS" RUNLAUNCHER_RUN_ARGS="--insert --hist-file $HISTORY $RUNLAUNCHER_RUN_ARGS $MARGS" RUNLAUNCHER_DESKTOP_ARGS="--lines 20 --columns 1 --image-size 100 --image-gaps 20 $RUNLAUNCHER_DESKTOP_ARGS $MARGS" RUNLAUNCHER_HELP_ARGS="--insert --hist-file $HISTORY $RUNLAUNCHER_HELP_ARGS $MARGS" # $PATH listing case "$function" in "run") parse "$args" exec_cmd "$args" ;; "fm") prepare_dirnav "$args" ;; "desktop") main_desktop "$args" ;; "help") print_cli_help exit 0 ;; *) printf "Undefined function: '%s'\n" "$function" exit 1 ;; esac } main "$@"