feat(unitproc):Bash function to insert string into another string

[BK-2020-03.git] / user / bkfeh

diff --git a/user/bkfeh b/user/bkfeh
index c0410ef06308dc36f2e13012a344278208c5e742..911d51b9fbb974212420a7287531a283afd7bcd9 100755 (executable)
--- a/user/bkfeh
+++ b/user/bkfeh
@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
 #!/usr/bin/env bash

-# Version: 0.1.0
+# Desc: Wrapper for feh that accepts directory paths via posargs or stdin lines.
+# Version: 0.3.0

 # Ref/Attrib: [1] Tange, Ole. GNU Parallel with Bash Array. 2019-03-24. https://unix.stackexchange.com/a/508365/411854
 # Ref/Attrib: [1] Tange, Ole. GNU Parallel with Bash Array. 2019-03-24. https://unix.stackexchange.com/a/508365/411854

-# Depends: GNU Parallel, GNU Bash v5.1.16, feh 3.6.3
+# Depends: GNU Parallel, GNU Bash v5.1.16, feh 3.6.3, GNU Coreutils 8.32 (b2sum)

 
 #===Declare local functions===
 yell() { echo "$0: $*" >&2; } # print script path and all args to stderr
 
 #===Declare local functions===
 yell() { echo "$0: $*" >&2; } # print script path and all args to stderr


@@ -152,9 +153,41 @@ displayMissing() {
     #==END Display errors==
 } # Display missing apps, files, dirs
 check_depends() {
     #==END Display errors==
 } # Display missing apps, files, dirs
 check_depends() {

-    if ! checkapp feh parallel; then displayMissing; die "FATAL:Missing apps."; fi;
+    if ! checkapp feh parallel bkshuf b2sum; then
+        displayMissing;
+        die "FATAL:Missing apps.";
+    fi;

     return 1;
 }; # check dependencies
     return 1;
 }; # check dependencies

+checkInt() {
+    # Desc: Checks if arg is integer
+    # Usage: checkInt arg
+    # Input: arg: integer
+    # Output: - return code 0 (if arg is integer)
+    #         - return code 1 (if arg is not integer)
+    # Example: if ! checkInt $arg; then echo "not int"; fi;
+    # Version: 0.0.1
+    local returnState
+
+    #===Process Arg===
+    if [[ $# -ne 1 ]]; then
+       die "ERROR:Invalid number of arguments:$#";
+    fi;
+    
+    RETEST1='^[0-9]+$'; # Regular Expression to test
+    if [[ ! $1 =~ $RETEST1 ]] ; then
+       returnState="false";
+    else
+       returnState="true";
+    fi;
+
+    #===Determine function return code===
+    if [ "$returnState" = "true" ]; then
+       return 0;
+    else
+       return 1;
+    fi;
+} # Checks if arg is integer

 read_stdin() {
     # Desc: Consumes stdin; outputs as stdout lines
     # Input: stdin (consumes)
 read_stdin() {
     # Desc: Consumes stdin; outputs as stdout lines
     # Input: stdin (consumes)


@@ -218,40 +251,71 @@ save_sample() {
     # Usage: save_sample arg1
     # Input: arg1   list_paths        (list of files to take samples from)
     #        envvar BKFEH_SAMPLE_DIR  (environment variable set outside of this script)
     # Usage: save_sample arg1
     # Input: arg1   list_paths        (list of files to take samples from)
     #        envvar BKFEH_SAMPLE_DIR  (environment variable set outside of this script)

-    # Depends: yell(), GNU Parallel, GNU find, GNU Coreutils 8.32 (cut, find, du)
+    #        envvar BKFEH_SAMPLE_SIZE (space limit for sample dir files)
+    # Depends: GNU Parallel, GNU find, GNU Coreutils 8.32 (cut, find, du)
+    #   BK-2020-03: bkshuf (0.0.1), yell()

     local list_paths
     local list_paths

-    sample_count="100";
-    sample_max_space="100000000"; # bytes
-    
+    sample_count="100"; # max number of images to put in sample dir
+    sample_max_space="10000000"; # max bytes to put in sample dir
+
+    # Load environment variables if set

     if [[ ! -v BKFEH_SAMPLE_DIR ]]; then return 0; fi; # return early if environment var not set.
     if [[ ! -v BKFEH_SAMPLE_DIR ]]; then return 0; fi; # return early if environment var not set.

+    if [[ -v BKFEH_SAMPLE_SIZE ]] && checkInt "$BKFEH_SAMPLE_SIZE"; then
+        sample_max_space="$BKFEH_SAMPLE_SIZE";
+    fi;
+    if [[ -v BKFEH_SAMPLE_COUNT ]] && checkInt "$BKFEH_SAMPLE_COUNT"; then
+        sample_count="$BKFEH_SAMPLE_COUNT";
+    fi;

     
     

-    if [[ ! -z "$1" ]]; then
+    if [[ -n "$1" ]]; then

         list_paths="$1"; # newline-delimited list of file paths to sample from
     else
         yell "ERROR:NO paths available to sample.";
     fi;
     
     if [[ -d "$BKFEH_SAMPLE_DIR" ]]; then
         list_paths="$1"; # newline-delimited list of file paths to sample from
     else
         yell "ERROR:NO paths available to sample.";
     fi;
     
     if [[ -d "$BKFEH_SAMPLE_DIR" ]]; then

-        sample_dir="$BKFEH_SAMPLE_DIR";
+        #sample_dir="$BKFEH_SAMPLE_DIR";

         yell "STATUS:Environment variable BKFEH_SAMPLE_DIR set. Clearing and saving samples...";
         
         ## clear previous sample
         yell "STATUS:Environment variable BKFEH_SAMPLE_DIR set. Clearing and saving samples...";
         
         ## clear previous sample

-        count_samples="$(find $BKFEH_SAMPLE_DIR -maxdepth 1 -type f | wc -l)";
+        count_prev_samples="$(find "$BKFEH_SAMPLE_DIR" -maxdepth 1 -type f | wc -l)";
+        yell "STATUS:Deleting $count_prev_samples previous samples...";

         find "$BKFEH_SAMPLE_DIR" -maxdepth 1 -type f -exec rm '{}' \; ;
         
         ## save random sample
         yell "STATUS:Saving random sample of size $sample_count to $BKFEH_SAMPLE_DIR...";
         find "$BKFEH_SAMPLE_DIR" -maxdepth 1 -type f -exec rm '{}' \; ;
         
         ## save random sample
         yell "STATUS:Saving random sample of size $sample_count to $BKFEH_SAMPLE_DIR...";

-        list_paths_sample="$(echo "$list_paths" | shuf | head -n"$sample_count")";
+        list_paths_sample="$(echo "$list_paths" | bkshuf "$sample_count" | head -n"$sample_count")";
+        n_samp=0; # init sample file counter
+        sample_log="$BKFEH_SAMPLE_DIR"/paths.txt;
+        printf "%s,%s,%s\n" "n_samp" "file_hash" "file_path" >> "$sample_log";

         while read -r line; do
             if [[ -z "$line" ]]; then continue; fi;
             ### check size limit
             sample_act_space="$(du -bd1 "$BKFEH_SAMPLE_DIR" | cut -f1 )"; # actual used space
             cand_space="$(du -bd1 "$line" | cut -f1 )"; # size of candidate file to add
             sample_req_space="$((sample_act_space + cand_space))";
         while read -r line; do
             if [[ -z "$line" ]]; then continue; fi;
             ### check size limit
             sample_act_space="$(du -bd1 "$BKFEH_SAMPLE_DIR" | cut -f1 )"; # actual used space
             cand_space="$(du -bd1 "$line" | cut -f1 )"; # size of candidate file to add
             sample_req_space="$((sample_act_space + cand_space))";

+
+            ### Customize file names
+            n_samp_w="$(printf "%s" "$sample_count" | wc -c)";
+            n_samp_fmt="%0""$n_samp_w""d";
+            n_samp_dd="$(printf "$n_samp_fmt" "$n_samp")"; # sample number fixed-width
+            file_path="$line";
+            #file_dir="$(dirname "$line")";
+            file_name="$(basename "$line")";
+            file_hash="$(b2sum -l32 "$line" | awk '{print $1}')"; # use file hash to avoid clobbering
+            file_ext="${file_name##*.}";
+            file_name="${file_name%.*}";
+            file_shortname="${file_name:0:32}";
+            file_name_new="$n_samp_dd"_"$file_hash".."$file_shortname"."$file_ext";
+            file_path_new="$BKFEH_SAMPLE_DIR"/"$file_name_new"            

             if [[ "$sample_req_space" -lt "$sample_max_space" ]]; then
                 #### add file to sample dir
             if [[ "$sample_req_space" -lt "$sample_max_space" ]]; then
                 #### add file to sample dir

-                cp -n "$line" "$BKFEH_SAMPLE_DIR" ;
+                must cp -n "$file_path" "$file_path_new";
+                #### note path in sample dir log
+                printf "%s,%s,%s\n" "$n_samp_dd" "$file_hash" "$file_path" \
+                       >> "$sample_log";

             fi;
             fi;

+            ((n_samp++));

         done < <( echo "$list_paths_sample" );
     else
         yell "ERROR:Does not exist: $BKFEH_SAMPLE_DIR";
         done < <( echo "$list_paths_sample" );
     else
         yell "ERROR:Does not exist: $BKFEH_SAMPLE_DIR";


@@ -341,17 +405,17 @@ main() {
     # Write
     list_paths_images_tmp="/dev/shm/$(date +%Y%m%dT%H%M%S.%N%z)"..feh_paths.txt;
     must echo -n "$list_paths_images" > "$list_paths_images_tmp";
     # Write
     list_paths_images_tmp="/dev/shm/$(date +%Y%m%dT%H%M%S.%N%z)"..feh_paths.txt;
     must echo -n "$list_paths_images" > "$list_paths_images_tmp";

-    ## Save sample to path in env. var. BKFEH_SAMPLE_DIR if set
-    save_sample "$list_paths_images";

 
     # Print stats
     yell "STATUS:Built file list in $SECONDS seconds.";
 
     # Run feh with filelist
 
     # Print stats
     yell "STATUS:Built file list in $SECONDS seconds.";
 
     # Run feh with filelist

-    feh --full-screen --auto-zoom --draw-filename --filelist "$list_paths_images_tmp";
+    feh --full-screen --auto-zoom --draw-filename --filelist "$list_paths_images_tmp" && \
+        must rm "$list_paths_images_tmp" &

 
 

-    # Cleanup
-    must rm "$list_paths_images_tmp";
+    # Save sample to path in env. var. BKFEH_SAMPLE_DIR if set
+    save_sample "$list_paths_images";
+    

 };
 export -f yell die must read_stdin read_psarg find_flist;
 #==END Define local functions==
 };
 export -f yell die must read_stdin read_psarg find_flist;
 #==END Define local functions==