- added --pipe (wished by Joerg)

DESIGN.asciidoc

@@ -31,6 +31,7 @@ A cli tool which uses different validators to validate workflows.
 * --daemon - starts a daemon, works only with delete mode
 * --stage=[current,upcoming,any] - valides with current or upcoming profile
   /validator or any if any is valid
+* --pipe - use program as a filter
 
 == related files
 

validate_workflow.sh

@@ -26,19 +26,19 @@
 #hh
 #hh      -h, --help
 #hh                 help output
-#hh      -w, -i, --watch-folder <DIR>
+#hh      -w, --watch-folder <DIR>
 #hh                 watches folder for files which should be evaluated
-#hh      -r, -o, --result-folder <DIR>
+#hh      -r, --result-folder <DIR>
 #hh                 target folder to store validation results
 #hh      -f, --files-mode [sort|delete|nothing]
 #hh                 mode=sort it sorts files to valid- and invalid-folder,
 #hh                 mode=delete it deletes already checked files from watch-folder
 #hh                 mode=nothing files in watch-folder are untouched
 #hh                 The mode=delete is default.
-#hh      -p, --valid-folder <DIR> 
+#hh      -v, --valid-folder <DIR> 
 #hh                 only needed if files-mode=sort, moves valid files from
 #hh                 watch-folder to valid-folder
-#hh      -n, --invalid-folder <DIR>
+#hh      -i, --invalid-folder <DIR>
 #hh                 only needed if files-mode=sort, moves invalid files from
 #hh                 watch-folder to invalid folder
 #hh      -s, --statistics
@@ -51,16 +51,24 @@
 #hh      -t, --stage [current,upcoming,any]
 #hh                valides with current or upcoming profile/validator 
 #hh                or any if any is valid
+#hh      -p, --pipe
+#hh                validates a single filestream from STDIN, writes result to STDOUT
+#hh                no daemon, no folder nor filemode params needed
 #hh
 #hh
 
 #DEFAULTS
 WITH_DAEMON=0
+WITH_PIPE=0
 STAGE=any
 MODE=auto
 FILES_MODE=nothing
 STATFILE=${HOME}/.cache/validate_workflows/statistics.cnt
 LOCKFILE=/var/run/lock/validate_workflows.lock
+WATCH_FOLDER=""
+RESULT_FOLDER=""
+VALID_FOLDER=""
+INVALID_FOLDER=""
 
 set -o nounset                              # Treat unset variables as an error
 
@@ -84,22 +92,22 @@ get_cli_args() {
                 print_statistics
                 exit 0
                 ;;
-            -w | -i | --watch-folder)
+            -w | --watch-folder)
                 WATCH_FOLDER="${2}"
                 shift
                 shift
                 ;;
-            -r | -o | --result-folder)
+            -r | --result-folder)
                 RESULT_FOLDER="${2}"
                 shift
                 shift
                 ;;
-            -p | --valid-folder)
+            -v | --valid-folder)
                 VALID_FOLDER="${2}"
                 shift
                 shift
                 ;;
-            -n | --invalid-folder)
+            -i | --invalid-folder)
                 INVALID_FOLDER="${2}"
                 shift
                 shift
@@ -123,6 +131,10 @@ get_cli_args() {
                 shift
                 shift
                 ;;
+            -p | --pipe)
+                WITH_PIPE=1
+                shift
+                ;;
             *)
                 >&2 echo "'${1}' ist kein gültiger Parameter. Bitte benutzen Sie '$(basename "${0}") --help'."         
                 exit 1
@@ -138,6 +150,19 @@ get_cli_args() {
         >&2 echo "param --mode must be 'auto', 'mediathek', 'fotothek', 'save', 'kitodo' or 'lfulg'!"
         exit 1
     fi
+    if [ "$WITH_PIPE" -eq 1 ]; then
+        if 
+            [ "$WITH_DAEMON" -eq 1 ] \
+            || [ "$WATCH_FOLDER" ] \
+            || [ "$RESULT_FOLDER" ] \
+            || [ "$VALID_FOLDER" ] \
+            || [ "$INVALID_FOLDER" ] \
+            || [ "$FILES_MODE" = "sort" ] \
+            ; then 
+            >&2 echo "param --pipe not combineable with params --daemon, --result-folder, --watch-folder, --valid-folder, --invalid-folder, --files-mode"
+            exit 1
+        fi
+    else
         if [ "$WITH_DAEMON" -eq 1 -a "$FILES_MODE" = "sort" ]; then
             >&2 echo "param --daemon does only work with param --mode='delete' or --mode='nothing'!"
             exit 1
@@ -164,7 +189,7 @@ get_cli_args() {
                 exit 1
             fi
         fi
-
+    fi
 }
 
 scan_file() {
@@ -181,6 +206,13 @@ scan_dir() {
 #### MAIN
 
 get_cli_args "$@"
+if [ "$WITH_PIPE" -eq 1 ]; then
+    #cli mode, use stdin
+    echo "checking stream"
+    filename=$(mktemp validate_wrg.XXXX)
+    scan_file "$filename"
+    rm -f $filename
+else 
     if [ "$WITH_DAEMON" -eq 1 ]; then
         # echo daemon mode, use inotify to watch changes
         echo "starting daemon"
@@ -190,3 +222,4 @@ else
         echo "checking dir $WATCH_FOLDER"
         scan_dir "$WATCH_FOLDER"
     fi
+fi