Merge pull request #11 from ethomson/updates

Handle unreachable and dangling blobs, plus --help information

Author: ethomson

git-recover

@@ -19,8 +19,41 @@ DO_INTERACTIVE=0
 BLOBS=()
 FILENAMES=()
 
+function print_usage {
+    echo "usage: $PROGNAME [-a] [-i] [--full] [<id> [-f <filename>] ...]"
+}
+
+function show_help {
+    print_usage
+
+    echo ""
+    echo "Recover deleted files in your git repository"
+    echo ""
+    echo "Options:"
+    echo "  -a, --all            Write all orphaned blobs to the current working"
+    echo "                       directory. Each file will be named using its 40"
+    echo "                       character object ID."
+    echo "  -i, --interactive    Display information about each orphaned blob and then"
+    echo "                       prompt to recover it."
+    echo "  --full               List or recover all orphaned blobs, even those that"
+    echo "                       are in packfiles. By default, git-recover will only"
+    echo "                       look at loose object files, which limits it to the"
+    echo "                       most recently created files. Examining packfiles may"
+    echo "                       be slow, especially in large repositories."
+    echo "  <id>                 The object ID (or its abbreviation) to recover. The"
+    echo "                       file will be written to the current working directory"
+    echo "                       and named using its 40 character object ID, unless the"
+    echo "                       -f option is specified."
+    echo "  -f, --filename name  When specified after an object ID, the file written"
+    echo "                       will use this filename. In addition, any filters"
+    echo "                       (for example: CRLF conversion or Git-LFS) will be run"
+    echo "                       according to the gitattributes configuration."
+
+    exit 0
+}
+
 function die_usage {
-    echo "usage: $PROGNAME [-a] [-i] [--full] [<id> [-f <filename>] ...]" >&2
+    print_usage >&2
     exit 1
 }
 
@@ -35,6 +68,9 @@ while [[ $# -gt 0 ]]; do
     --full)
         DO_FULL=1
         ;;
+    -h|--help)
+        show_help
+        ;;
     *)
         if [ "${1:0:1}" == "-" ]; then
             echo "$PROGNAME: unknown argument: $1" >&2
@@ -96,8 +132,10 @@ function find_unreachable() {
 
     if [ $DO_FULL == 1 ]; then FULLNESS="--full"; fi
 
-    BLOBS=($(git fsck --unreachable --no-reflogs \
-        "${FULLNESS}" --no-progress | sed -ne 's/^unreachable blob //p'))
+    # shellcheck disable=SC2207
+    BLOBS=($(git fsck --unreachable --no-reflogs "${FULLNESS}" \
+                      --no-progress 2>/dev/null | \
+             sed -E -ne 's/^unreachable blob |dangling blob //p'))
 }
 
 function read_one_file {
@@ -171,6 +209,7 @@ function timestamp_to_s {
 
 function sort_by_timestamp {
     # sort blobs in loose objects by their timestamp (packed blobs last)
+    # shellcheck disable=SC2207
     BLOB_AND_TIMESTAMPS=($(for BLOB in "${BLOBS[@]}"; do
         LOOSE="${BLOB::2}/${BLOB:2}"
         TIME=$(file_time "$GIT_DIR/objects/$LOOSE" 2>/dev/null || true)
@@ -186,7 +225,7 @@ function print_recoverable {
     for BLOB_AND_TIMESTAMP in "${BLOB_AND_TIMESTAMPS[@]}"; do
         BLOB=${BLOB_AND_TIMESTAMP::40}
         TIME=${BLOB_AND_TIMESTAMP:41}
-        DATE=$([ ! -z "$TIME" ] && timestamp_to_s "$TIME" || echo "(Unknown)") 
+        DATE=$([ -n "$TIME" ] && timestamp_to_s "$TIME" || echo "(Unknown)") 
 
         echo "$BLOB  $DATE"
     done
@@ -239,7 +278,7 @@ function interactive {
 
         BLOB=${BLOB_AND_TIMESTAMP::40}
         TIME=${BLOB_AND_TIMESTAMP:41}
-        DATE=$([ ! -z "$TIME" ] && timestamp_to_s "$TIME" || echo "(Unknown)") 
+        DATE=$([ -n "$TIME" ] && timestamp_to_s "$TIME" || echo "(Unknown)") 
 
         echo "$BLOB  ($DATE)"
         show_summary "${BLOB}" | head -4 | sed -e 's/^/> /'