fix(unitproc):appendArgTar:Fix minor usage comment error
[BK-2020-03.git] / unitproc / bktemp-appendArgTar
CommitLineData
0f8ac166
SBS
1#!/bin/bash
2
3# Desc: Template function to write data supplied as argument
4
5yell() { echo "$0: $*" >&2; } # Yell, Die, Try Three-Fingered Claw technique; # Ref/Attrib: https://stackoverflow.com/a/25515370
6die() { yell "$*"; exit 111; }
7try() { "$@" || die "cannot $*"; }
8appendArgTar(){
9 # Desc: Writes first argument to temporary file with arguments as options, then appends file to tar
71d6b5c9
SBS
10 # Usage: appendArgTar "$(echo "Data to be written.")" [name of file to be inserted] [tar path] [temp dir] ([cmd1] [cmd2] [cmd3] [cmd4]...)
11 # Version: 1.0.1
0f8ac166
SBS
12 # Input: arg1: data to be written
13 # arg2: file name of file to be inserted into tar
14 # arg3: tar archive path (must exist first)
15 # arg4: temporary working dir
16 # arg5+: command strings (ex: "gpsbabel -i nmea -f - -o kml -F - ")
17 # Output: file written to disk
18 # Example: decrypt multiple large files in parallel
19 # appendArgTar "$(cat /tmp/largefile1.gpg)" "largefile1" $HOME/archive.tar /tmp "gpg --decrypt" &
20 # appendArgTar "$(cat /tmp/largefile2.gpg)" "largefile2" $HOME/archive.tar /tmp "gpg --decrypt" &
21 # appendArgTar "$(cat /tmp/largefile3.gpg)" "largefile3" $HOME/archive.tar /tmp "gpg --decrypt" &
0f8ac166
SBS
22 # Depends: bash 5
23
4dad1c36
SBS
24 # Save function name
25 local FN="${FUNCNAME[0]}";
26 #yell "DEBUG:STATUS:$FN:Finished appendArgTar()."
27
0f8ac166 28 # Set file name
4dad1c36 29 if ! [ -z "$2" ]; then FILENAME="$2"; else yell "ERROR:$FN:Not enough arguments."; exit 1; fi
0f8ac166
SBS
30
31 # Check tar path is a file
4dad1c36 32 if [ -f "$3" ]; then TAR_PATH="$3"; else yell "ERROR:$FN:Tar archive arg not a file."; exit 1; fi
0f8ac166
SBS
33
34 # Check temp dir arg
4dad1c36 35 if ! [ -z "$4" ]; then TMP_DIR="$4"; else yell "ERROR:$FN:No temporary working dir set."; exit 1; fi
0f8ac166
SBS
36
37 # Set command strings
38 if ! [ -z "$5" ]; then CMD1="$5"; else CMD1="tee /dev/null "; fi # command string 1
39 if ! [ -z "$6" ]; then CMD2="$6"; else CMD2="tee /dev/null "; fi # command string 2
40 if ! [ -z "$7" ]; then CMD3="$7"; else CMD3="tee /dev/null "; fi # command string 3
41 if ! [ -z "$8" ]; then CMD4="$8"; else CMD4="tee /dev/null "; fi # command string 4
42
4dad1c36
SBS
43 # # Debug
44 # yell "DEBUG:STATUS:$FN:CMD1:$CMD1"
45 # yell "DEBUG:STATUS:$FN:CMD2:$CMD2"
46 # yell "DEBUG:STATUS:$FN:CMD3:$CMD3"
47 # yell "DEBUG:STATUS:$FN:CMD4:$CMD4"
48 # yell "DEBUG:STATUS:$FN:FILENAME:$FILENAME"
49 # yell "DEBUG:STATUS:$FN:TAR_PATH:$TAR_PATH"
50 # yell "DEBUG:STATUS:$FN:TMP_DIR:$TMP_DIR"
51
0f8ac166
SBS
52 # Write to temporary working dir
53 echo "$1" | $CMD1 | $CMD2 | $CMD3 | $CMD4 > "$TMP_DIR"/"$FILENAME";
54
55 # Append to tar
56 try tar --append --directory="$TMP_DIR" --file="$TAR_PATH" "$FILENAME";
4dad1c36 57 #yell "DEBUG:STATUS:$FN:Finished appendArgTar()."
0f8ac166
SBS
58} # Append Bash var to file appended to Tar archive
59
60#==BEGIN sample code==
61myFile="/tmp/$(date +%s)..original"
62echo "how are you doing?" > "$myFile"
4dad1c36 63myVAR="$(cat "$myFile")"
0f8ac166
SBS
64writeArg "$myVAR" "$myFile..LOUD_CHILD" "tee /tmp/cloneityclone " "tr '[:lower:]' '[:upper:]'"
65#==END sample code==
66
67# Author: Steven Baltakatei Sandoval
68# License: GPLv3+