Dotfiles for my tiling window manager + terminal workflow.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

230 lines
8.6 KiB

5 years ago
  1. #!/usr/bin/env bash
  2. set -o noclobber -o noglob -o nounset -o pipefail
  3. IFS=$'\n'
  4. # If the option `use_preview_script` is set to `true`,
  5. # then this script will be called and its output will be displayed in ranger.
  6. # ANSI color codes are supported.
  7. # STDIN is disabled, so interactive scripts won't work properly
  8. # This script is considered a configuration file and must be updated manually.
  9. # It will be left untouched if you upgrade ranger.
  10. # Meanings of exit codes:
  11. # code | meaning | action of ranger
  12. # -----+------------+-------------------------------------------
  13. # 0 | success | Display stdout as preview
  14. # 1 | no preview | Display no preview at all
  15. # 2 | plain text | Display the plain content of the file
  16. # 3 | fix width | Don't reload when width changes
  17. # 4 | fix height | Don't reload when height changes
  18. # 5 | fix both | Don't ever reload
  19. # 6 | image | Display the image `$IMAGE_CACHE_PATH` points to as an image preview
  20. # 7 | image | Display the file directly as an image
  21. # Script arguments
  22. FILE_PATH="${1}" # Full path of the highlighted file
  23. PV_WIDTH="${2}" # Width of the preview pane (number of fitting characters)
  24. PV_HEIGHT="${3}" # Height of the preview pane (number of fitting characters)
  25. IMAGE_CACHE_PATH="${4}" # Full path that should be used to cache image preview
  26. PV_IMAGE_ENABLED="${5}" # 'True' if image previews are enabled, 'False' otherwise.
  27. FILE_EXTENSION="${FILE_PATH##*.}"
  28. FILE_EXTENSION_LOWER=$(echo ${FILE_EXTENSION} | tr '[:upper:]' '[:lower:]')
  29. # Settings
  30. HIGHLIGHT_SIZE_MAX=262143 # 256KiB
  31. HIGHLIGHT_TABWIDTH=8
  32. HIGHLIGHT_STYLE='pablo'
  33. PYGMENTIZE_STYLE='autumn'
  34. handle_extension() {
  35. case "${FILE_EXTENSION_LOWER}" in
  36. # Archive
  37. a|ace|alz|arc|arj|bz|bz2|cab|cpio|deb|gz|jar|lha|lz|lzh|lzma|lzo|\
  38. rpm|rz|t7z|tar|tbz|tbz2|tgz|tlz|txz|tZ|tzo|war|xpi|xz|Z|zip)
  39. atool --list -- "${FILE_PATH}" && exit 5
  40. bsdtar --list --file "${FILE_PATH}" && exit 5
  41. exit 1;;
  42. rar)
  43. # Avoid password prompt by providing empty password
  44. unrar lt -p- -- "${FILE_PATH}" && exit 5
  45. exit 1;;
  46. 7z)
  47. # Avoid password prompt by providing empty password
  48. 7z l -p -- "${FILE_PATH}" && exit 5
  49. exit 1;;
  50. # PDF
  51. pdf)
  52. # Preview as text conversion
  53. pdftotext -l 10 -nopgbrk -q -- "${FILE_PATH}" - | fmt -w ${PV_WIDTH} && exit 5
  54. mutool draw -F txt -i -- "${FILE_PATH}" 1-10 | fmt -w ${PV_WIDTH} && exit 5
  55. exiftool "${FILE_PATH}" && exit 5
  56. exit 1;;
  57. # BitTorrent
  58. torrent)
  59. transmission-show -- "${FILE_PATH}" && exit 5
  60. exit 1;;
  61. # OpenDocument
  62. odt|ods|odp|sxw)
  63. # Preview as text conversion
  64. odt2txt "${FILE_PATH}" && exit 5
  65. exit 1;;
  66. # HTML
  67. # htm|html|xhtml)
  68. # # Preview as text conversion
  69. # w3m -dump "${FILE_PATH}" && exit 5
  70. # lynx -dump -- "${FILE_PATH}" && exit 5
  71. # elinks -dump "${FILE_PATH}" && exit 5
  72. # ;; # Continue with next handler on failure
  73. # htm|html|xhtml)
  74. # # Preview as text conversion
  75. # w3m -dump "${FILE_PATH}" && exit 5
  76. # lynx -dump -- "${FILE_PATH}" && exit 5
  77. # elinks -dump "${FILE_PATH}" && exit 5
  78. # ;; # Continue with next handler on failure
  79. # JSON
  80. json)
  81. jq --color-output . "${FILE_PATH}" && exit 5
  82. python -m json.tool -- "${FILE_PATH}" && exit 5
  83. esac
  84. }
  85. handle_image() {
  86. local mimetype="${1}"
  87. case "${mimetype}" in
  88. # SVG
  89. # image/svg+xml)
  90. # convert "${FILE_PATH}" "${IMAGE_CACHE_PATH}" && exit 6
  91. # exit 1;;
  92. # Image
  93. image/*)
  94. local orientation
  95. orientation="$( identify -format '%[EXIF:Orientation]\n' -- "${FILE_PATH}" )"
  96. # If orientation data is present and the image actually
  97. # needs rotating ("1" means no rotation)...
  98. if [[ -n "$orientation" && "$orientation" != 1 ]]; then
  99. # ...auto-rotate the image according to the EXIF data.
  100. convert -- "${FILE_PATH}" -auto-orient "${IMAGE_CACHE_PATH}" && exit 6
  101. fi
  102. # `w3mimgdisplay` will be called for all images (unless overriden as above),
  103. # but might fail for unsupported types.
  104. exit 7;;
  105. # Video
  106. # video/*)
  107. # # Thumbnail
  108. # ffmpegthumbnailer -i "${FILE_PATH}" -o "${IMAGE_CACHE_PATH}" -s 0 && exit 6
  109. # exit 1;;
  110. # PDF
  111. # application/pdf)
  112. # pdftoppm -f 1 -l 1 \
  113. # -scale-to-x 1920 \
  114. # -scale-to-y -1 \
  115. # -singlefile \
  116. # -jpeg -tiffcompression jpeg \
  117. # -- "${FILE_PATH}" "${IMAGE_CACHE_PATH%.*}" \
  118. # && exit 6 || exit 1;;
  119. # Preview archives using the first image inside.
  120. # (Very useful for comic book collections for example.)
  121. # application/zip|application/x-rar|application/x-7z-compressed|\
  122. # application/x-xz|application/x-bzip2|application/x-gzip|application/x-tar)
  123. # local fn=""; local fe=""
  124. # local zip=""; local rar=""; local tar=""; local bsd=""
  125. # case "${mimetype}" in
  126. # application/zip) zip=1 ;;
  127. # application/x-rar) rar=1 ;;
  128. # application/x-7z-compressed) ;;
  129. # *) tar=1 ;;
  130. # esac
  131. # { [ "$tar" ] && fn=$(tar --list --file "${FILE_PATH}"); } || \
  132. # { fn=$(bsdtar --list --file "${FILE_PATH}") && bsd=1 && tar=""; } || \
  133. # { [ "$rar" ] && fn=$(unrar lb -p- -- "${FILE_PATH}"); } || \
  134. # { [ "$zip" ] && fn=$(zipinfo -1 -- "${FILE_PATH}"); } || return
  135. #
  136. # fn=$(echo "$fn" | python -c "import sys; import mimetypes as m; \
  137. # [ print(l, end='') for l in sys.stdin if \
  138. # (m.guess_type(l[:-1])[0] or '').startswith('image/') ]" |\
  139. # sort -V | head -n 1)
  140. # [ "$fn" = "" ] && return
  141. # [ "$bsd" ] && fn=$(printf '%b' "$fn")
  142. #
  143. # [ "$tar" ] && tar --extract --to-stdout \
  144. # --file "${FILE_PATH}" -- "$fn" > "${IMAGE_CACHE_PATH}" && exit 6
  145. # fe=$(echo -n "$fn" | sed 's/[][*?\]/\\\0/g')
  146. # [ "$bsd" ] && bsdtar --extract --to-stdout \
  147. # --file "${FILE_PATH}" -- "$fe" > "${IMAGE_CACHE_PATH}" && exit 6
  148. # [ "$bsd" ] || [ "$tar" ] && rm -- "${IMAGE_CACHE_PATH}"
  149. # [ "$rar" ] && unrar p -p- -inul -- "${FILE_PATH}" "$fn" > \
  150. # "${IMAGE_CACHE_PATH}" && exit 6
  151. # [ "$zip" ] && unzip -pP "" -- "${FILE_PATH}" "$fe" > \
  152. # "${IMAGE_CACHE_PATH}" && exit 6
  153. # [ "$rar" ] || [ "$zip" ] && rm -- "${IMAGE_CACHE_PATH}"
  154. # ;;
  155. esac
  156. }
  157. handle_mime() {
  158. local mimetype="${1}"
  159. case "${mimetype}" in
  160. # Text
  161. text/* | */xml)
  162. # Syntax highlight
  163. if [[ "$( stat --printf='%s' -- "${FILE_PATH}" )" -gt "${HIGHLIGHT_SIZE_MAX}" ]]; then
  164. exit 2
  165. fi
  166. if [[ "$( tput colors )" -ge 256 ]]; then
  167. local pygmentize_format='terminal256'
  168. local highlight_format='xterm256'
  169. else
  170. local pygmentize_format='terminal'
  171. local highlight_format='ansi'
  172. fi
  173. # local pygmentize_format='terminal'
  174. # local highlight_format='ansi'
  175. highlight --replace-tabs="${HIGHLIGHT_TABWIDTH}" --out-format="${highlight_format}" \
  176. --style="${HIGHLIGHT_STYLE}" --force -- "${FILE_PATH}" && exit 5
  177. # pygmentize -f "${pygmentize_format}" -O "style=${PYGMENTIZE_STYLE}" -- "${FILE_PATH}" && exit 5
  178. exit 2;;
  179. # Image
  180. image/*)
  181. # Preview as text conversion
  182. # img2txt --gamma=0.6 --width="${PV_WIDTH}" -- "${FILE_PATH}" && exit 4
  183. exiftool "${FILE_PATH}" && exit 5
  184. exit 1;;
  185. # Video and audio
  186. video/* | audio/*)
  187. mediainfo "${FILE_PATH}" && exit 5
  188. exiftool "${FILE_PATH}" && exit 5
  189. exit 1;;
  190. esac
  191. }
  192. handle_fallback() {
  193. echo '----- File Type Classification -----' && file --dereference --brief -- "${FILE_PATH}" && exit 5
  194. exit 1
  195. }
  196. MIMETYPE="$( file --dereference --brief --mime-type -- "${FILE_PATH}" )"
  197. if [[ "${PV_IMAGE_ENABLED}" == 'True' ]]; then
  198. handle_image "${MIMETYPE}"
  199. fi
  200. handle_extension
  201. handle_mime "${MIMETYPE}"
  202. handle_fallback
  203. exit 1