bash-stdops/path-is at main · jamescherti/bash-stdops · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#!/usr/bin/env bash
#
# Requirements: grep
#
# Author: James Cherti
# URL: https://github.com/jamescherti/bash-stdops
#
# Description:
# ------------
# Print the Path to stdout and exit with the code 0 if it is a binary or text
# file.
#
# Example usage:
#   path-is /Path/TO/FILE binary
#   path-is /Path/TO/FILE text
#
# License:
# --------
# Copyright (C) 2012-2026 James Cherti
#
# Distributed under terms of the GNU General Public License version 3.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#

set -euf -o pipefail

show_usage() {
  {
    echo "Check whether a given file path points to a " \
      "binary file or a text file."
    echo ""
    echo "Usage: $0 [-h] <path/to/existing/file> <binary|text>"
    echo
    echo "-h    Show this help message and exit"
    echo "-s    Always exit with a status of 0"
    echo "-p    Print the path when it correspond to the specified type"
  } >&2
}

NEVER_FAIL=0
PRINT_PATH=0
while getopts ":hsp" opt; do
  case ${opt} in
  p)
    PRINT_PATH=1
    ;;
  s)
    NEVER_FAIL=1
    ;;
  h)
    show_usage
    exit 1
    ;;
  \?)
    echo "Invalid option: -$OPTARG" >&2
    exit 1
    ;;
  :)
    echo "Invalid option: -$OPTARG requires an argument" >&2
    exit 1
    ;;
  esac
done

shift $((OPTIND - 1))

_is_binary() {
  # Grep options:
  # -------------
  # -I: Process  a  binary file as if it did not contain matching data;
  # this is equivalent to the --binary-files=without-match option.
  #
  # -q Quiet; do not write anything to standard output.
  #
  grep -Iq . "$1" || return 0
  return 1
}

if [[ $# -lt 2 ]]; then
  show_usage
  exit 1
fi

PATH_EXISTING_FILE="$1"
shift

# if ! [[ -e "$PATH_EXISTING_FILE" ]]; then
#   echo "Error: No such file or directory: $PATH_EXISTING_FILE" >&2
#   exit 1
# fi

if ! [[ -f "$PATH_EXISTING_FILE" ]]; then
  echo "Error: The following path is not a file: $PATH_EXISTING_FILE" >&2
  exit 1
fi

for REQUEST in "$@"; do
  if [[ $REQUEST = "binary" ]] && _is_binary "$PATH_EXISTING_FILE"; then
    continue
  elif [[ $REQUEST = "text" ]] && ! _is_binary "$PATH_EXISTING_FILE"; then
    continue
  fi

  if [[ $NEVER_FAIL -ne 0 ]]; then
    exit 0
  else
    printf "Error: The following path is not '%s': %s\n" \
      "$REQUEST" "$PATH_EXISTING_FILE"
    exit 1
  fi
done

if [[ $PRINT_PATH -ne 0 ]]; then
  printf "%s\n" "$PATH_EXISTING_FILE"
fi

exit 0