quickzip

#!/bin/bash

## Bash settings
set -uo pipefail

## Script globals
script_name=$(basename "${BASH_SOURCE[0]}")
script_dir=$({ cd "$(dirname "${BASH_SOURCE[0]}")" || { echo "Failed to access script file directory" >&2; exit; } } && pwd)
script_dir_abs=$({ cd "$(dirname "${BASH_SOURCE[0]}")" || { echo "Failed to access script file directory" >&2; exit; } } && pwd -P)
script_file="${script_dir}/${script_name}"
if [ -L "${BASH_SOURCE[0]}" ]; then
    script_file_abs=$(readlink "${BASH_SOURCE[0]}")
else
    script_file_abs="${script_dir_abs}/${script_name}"
fi
export CURRENT_PARENT_BASH_SCRIPT_FILE="$script_file"
script_args=("$@")

## Script imports
lib_dir="${script_dir}/../lib"
bash_functions_script="${lib_dir}/bash_script_func.sh"

## Source imports
source "$bash_functions_script"


## Arguments
src_path_arr=()
zipfile=''
force_glob=false
zip_on_ext=false
zip_ext='.zip'
fwd_args_arr_1=()
fwd_args_arr_2=()
dryrun=false

## Custom globals


## Script usage
read -r -d '' script_usage << EOM
Usage: ${script_name} [OPTION]... SRC_PATH... ['zip' OPTION]...

Quickly zip batches of files and/or folders.

  SRC_PATH may be a relative or absolute path to a file/folder,
or a path leading up and including the common filename/foldername
prefix of multiple files/folders in the same source directory.

  If the --zipfile location is a file path, files/folders from all
SRC_PATH arguments are combined in a single output zipfile created
at the indicated file path.
  If the --zipfile location is an existing directory, separate
zipfiles are created for each SRC_PATH argument with filnames like
"\$(basename SRC_PATH).zip" within the indicated directory.
  If the --zipfile option is not provided, separate zipfiles are
created for each SRC_PATH argument with filenames like
"\$(basename SRC_PATH).zip", each zipfile placed in the same
directory as the SRC_PATH.

  If SRC_PATH is a directory and SRC_PATH does not end with a
forward slash (/), the folder is placed at the root of the zipfile
 -- if it does end with a forward slash, the immediate contents of
the folder are placed at the root of the zipfile.

  For 'zip' options, note that --recurse-paths (-r) is automatically
provided, and --junk-paths (-j) is not advised.

Options:
 -o,--zipfile
        Location of output zipfile.
 -e,--zip-ext=<extension> (default='${zip_ext}')
        File extension for automatically-determined output zipfile(s).
        Cannot be used with --zipfile option.
 -x,--zip-on-ext
        Automatically group SRC_PATH arguments that have the same
        base filename with different dot extensions.
 -g,--glob
        When SRC_PATH is the full path to an existing file/folder,
        force treating all SRC_PATH arguments as prefixes matching
        additional files/folders in the same directories.
-db,--debug
-dr,--dryrun
        Print command(s) used to zip files/folders, without executing.
EOM
if (( $# < 1 )); then
    echo_e -e "$script_usage"
    exit_script_with_status 1
fi


## Parse arguments
set +u
parsing_fwd_args=false
while (( $# > 0 )); do
    arg="$1"

    if [ "$parsing_fwd_args" = true ]; then
        # Accept critical script optional arguments
        # specified at end of command.
        is_fwd_arg=true
        if [ "$(string_startswith "$arg" '-')" = true ]; then
            arg_opt="$(string_lstrip "$arg" '-')"
            is_fwd_arg=false
            if [ "$arg_opt" = 'h' ] || [ "$arg_opt" = 'help' ]; then
                arg_opt_nargs=0
                echo "$script_usage"
                exit 0
            elif [ "$arg_opt" = 'db' ] || [ "$arg_opt" = 'debug' ]; then
                dryrun=true
            elif [ "$arg_opt" = 'dr' ] || [ "$arg_opt" = 'dryrun' ]; then
                dryrun=true
            else
                is_fwd_arg=true
                fwd_arg_pos=1
                if [ "$arg_opt" = 'i' ] || [ "$arg_opt" = 'include' ]; then
                    fwd_arg_pos=2
                elif [ "$arg_opt" = 'x' ] || [ "$arg_opt" = 'exclude' ]; then
                    fwd_arg_pos=2
                fi
            fi
        fi
        if [ "$is_fwd_arg" = true ]; then
            if [ "$(string_contains "$arg" '*')" = true ] || [ "$(string_contains "$arg" ' ')" = true ]; then
                arg="'${arg}'"
            fi
            if (( fwd_arg_pos == 1 )); then
                fwd_args_arr_1+=( "$arg" )
            elif (( fwd_arg_pos == 2 )); then
                fwd_args_arr_2+=( "$arg" )
            fi
        fi

    elif [ "$(string_startswith "$arg" '-')" = false ]; then
        src_path_arr+=( "$arg" )

    else
        arg_opt="$(string_lstrip "$arg" '-')"
        arg_opt_nargs=''
        if [ "$(string_contains "$arg_opt" '=')" = true ]; then
            arg_val=$(printf '%s' "${arg_opt#*=}" | sed -r -e "s|^['\"]+||" -e "s|['\"]+$||")
            arg_opt="${arg_opt%%=*}"
            arg_opt_nargs_do_shift=false
        else
            arg_val="$2"
            arg_opt_nargs_do_shift=true
        fi
        arg_val_can_start_with_dash=false

        if [ "$arg_opt" = 'h' ] || [ "$arg_opt" = 'help' ]; then
            arg_opt_nargs=0
            echo "$script_usage"
            exit 0

        elif [ "$arg_opt" = 'o' ] || [ "$arg_opt" = 'zipfile' ]; then
            arg_opt_nargs=1
            zipfile="$arg_val"

        elif [ "$arg_opt" = 'e' ] || [ "$arg_opt" = 'zip-ext' ]; then
            arg_opt_nargs=1
            zip_ext="$arg_val"

        elif [ "$arg_opt" = 'x' ] || [ "$arg_opt" = 'zip-on-ext' ]; then
            arg_opt_nargs=0
            zip_on_ext=true

        elif [ "$arg_opt" = 'g' ] || [ "$arg_opt" = 'glob' ]; then
            arg_opt_nargs=0
            force_glob=true

        elif [ "$arg_opt" = 'db' ] || [ "$arg_opt" = 'debug' ]; then
            arg_opt_nargs=0
            dryrun=true

        elif [ "$arg_opt" = 'dr' ] || [ "$arg_opt" = 'dryrun' ]; then
            arg_opt_nargs=0
            dryrun=true

        else
            arg_opt_nargs=0

            if (( ${#src_path_arr[@]} > 0 )); then
                parsing_fwd_args=true
                continue
            else
                echo_e "Unexpected argument: ${arg}"
                exit_script_with_status 1
            fi
        fi

        if [ -z "$arg_opt_nargs" ]; then
            echo_e "Developer error! "'$arg_opt_nargs'" was not set for argument: ${arg}"
            exit_script_with_status 1
        fi

        if [ "$arg_opt_nargs_do_shift" = true ] && (( arg_opt_nargs >= 1 )); then
            for arg_num in $(seq 1 $arg_opt_nargs); do
                shift
                arg_val="$1"
                if [ -z "$arg_val" ]; then
                    echo_e "Missing expected value (#${arg_num}) for argument: ${arg}"
                    exit_script_with_status 1
                elif [ "$arg_val_can_start_with_dash" = false ] && [ "$(string_startswith "$arg_val" '-')" = true ]; then
                    echo_e "Unexpected argument value: ${arg} ${arg_val}"
                    exit_script_with_status 1
                fi
            done
        fi
    fi

    shift
done
set -u


## Validate and adjust arguments

num_src_path_args="${#src_path_arr[@]}"
if (( num_src_path_args == 0 )); then
    echo_e "At least one SRC_PATH argument must be provided"
    exit_script_with_status 1
fi
if [ -n "$zipfile" ]; then
    zipfile=$(fullpath "$zipfile")
fi

src_path_zoe_arr=()
if [ "$zip_on_ext" = true ]; then
    for src_path in "${src_path_arr[@]}"; do
        src_path_dirname=$(dirname "$src_path")
        src_path_basename=$(basename "$src_path")
        src_path_basename_noext="${src_path_basename%%.*}"
        if [ "$src_path_basename_noext" != "$src_path_basename" ]; then
            src_path_basename_noext="${src_path_basename_noext}."
        fi
        src_path_noext="${src_path_dirname}/${src_path_basename_noext}"
        if [ "$(itemOneOf "$src_path_noext" ${src_path_zoe_arr[@]+"${src_path_zoe_arr[@]}"})" = false ]; then
            src_path_zoe_arr+=( "$src_path_noext" )
        fi
    done
    src_path_arr=("${src_path_zoe_arr[@]}")
fi

src_fullpath_arr=()
for src_path in "${src_path_arr[@]}"; do
    if [ ! -e "$src_path" ] || [ "$(string_endswith "$src_path" '/')" = true ] || [ "$force_glob" = true ]; then
        shopt -s nullglob
        src_dirent_arr=( "$src_path"* )
        shopt -u nullglob
        if (( ${#src_dirent_arr[@]} == 0 )); then
            echo_e "Cannot find any files/dirs matching SRC_PATH argument: $(string_rstrip "$src_path" '*')*"
            exit_script_with_status 1
        fi
    fi
    src_fullpath_arr+=( "$(fullpath_preserve_trailing_slash "$src_path")" )
done

zip_opt_args_1="${fwd_args_arr_1[*]+${fwd_args_arr_1[*]}}"
zip_opt_args_2="${fwd_args_arr_2[*]+${fwd_args_arr_2[*]}}"


## Perform zipping

for src_path in "${src_fullpath_arr[@]}"; do

    if [ -n "$zipfile" ]; then
        if [ -d "$zipfile" ]; then
            dst_zipfile="${zipfile}/$(string_rstrip "$(basename "$src_path")" '.')${zip_ext}"
        else
            dst_zipfile="$zipfile"
        fi
    else
        dst_zipfile="$(fullpath "$(string_rstrip "$src_path" '.')")${zip_ext}"
    fi

    if [ "$(string_endswith "$src_path" '/')" = true ]; then
        working_dir="$src_path"
        src_path_basename=""
    else
        working_dir=$(dirname "$src_path")
        src_path_basename=$(basename "$src_path")
    fi

    echo "Writing to zipfile: ${dst_zipfile}"
    echo "Working in directory: ${working_dir}"
    cd "$working_dir"
    cd_status=$?
    if (( cd_status != 0 )); then
        echo_e "Cannot 'cd' to directory: ${working_dir}"
        exit_script_with_status 1
    fi

    if [ ! -e "$src_path" ] || [ "$(string_endswith "$src_path" '/')" = true ] || [ "$force_glob" = true ]; then
        src_dirent_arr=( "$src_path_basename"* )
    else
        src_dirent_arr=( "$src_path_basename" )
    fi

    cmd="zip -r ${zip_opt_args_1} \"${dst_zipfile}\" $(printf ' "%s"' "${src_dirent_arr[@]}") ${zip_opt_args_2}"

    if [ "$dryrun" = true ]; then
        echo "$cmd"
    else
        eval "$cmd"
        cmd_status=$?
        if (( cmd_status != 0 )); then
            echo_e "Processing command failed with non-zero exit status (${cmd_status}): ${cmd}"
            exit_script_with_status 1
        fi
    fi
done