Update scripts for microarchiver -> pubarchiver

Author: mhucka

scripts/archive-in-portico

@@ -4,7 +4,7 @@
 # @brief   Script meant to be run from cron
 # @author  Michael Hucka <[email protected]>
 # @license Please see the file named LICENSE in the project directory
-# @website https://github.com/caltechlibrary/microarchiver
+# @website https://github.com/caltechlibrary/pubarchiver
 #
 # Principles:
 #
@@ -13,7 +13,7 @@
 #  2. The local output directory where files are saved is set by environment
 #     variable PORTICO_OUTPUT.
 #
-#  3. A timestamp file is created in the output directory, and microarchiver
+#  3. A timestamp file is created in the output directory, and pubarchiver
 #     is run with that date stamp as the "after date" argument.
 #
 #  4. Archives are created in subdirectories of the output directory named
@@ -81,34 +81,34 @@ echo "" >> $log
 if [[ -e $datestampfile ]]; then
     read afterdate < $datestampfile
     # Go back one day to include the run date in the argument given to
-    # microarchiver's --after-date (or else we miss the day of the run itself).
+    # pubarchiver's --after-date (or else we miss the day of the run itself).
     afterdate=$(date -d "$afterdate -1 days" +"%Y-%m-%d")
 else
     # We've never run, or someone reset the date stamp.
     # Use a fake date that basically signifies "since forever".
     afterdate="1900-01-01"
 fi
 
-# Run microarchiver separately on past failures, leaving the results unpackaged
+# Run pubarchiver separately on past failures, leaving the results unpackaged
 # so that we can add to them the results of today's run.
 rerun_count=0
 if [[ -f $failurefile ]]; then
-    echo "=== Running microarchiver on past failures ===" >> $log
+    echo "=== Running pubarchiver on past failures ===" >> $log
     echo "" >> $log
     # Note the use of -Z to prevent zip'ing the final results.
-    run_microarchiver -s portico -Z -C -a $failurefile -o $outputdir -r $report \
+    run_pubarchiver -s portico -Z -C -a $failurefile -o $outputdir -r $report \
                       -f csv,html -t Past_failures_retried -@ $debuglog
     echo "" >> $log
 fi
 mv $outputdir/report.html $outputdir/rerun-report.html
 
-echo "=== Running microarchiver for new articles ===" >> $log
+echo "=== Running pubarchiver for new articles ===" >> $log
 echo "" >> $log
 this_report=$outputdir/latest-report.csv
 this_debuglog=$outputdir/latest-debug.log
 # This will add new articles to any existing ones from the past failures
 # code above, and this time will zip up the final result.
-run_microarchiver -s portico -C -d $afterdate -o $outputdir -r $this_report \
+run_pubarchiver -s portico -C -d $afterdate -o $outputdir -r $this_report \
                   -f csv,html -t $today -@ $this_debuglog
 
 # Combine separate report files, leave that, & delete the intermediate files.

scripts/helpers.sh

@@ -4,7 +4,7 @@
 # @brief   Common shell functions used across multiple workflows
 # @author  Michael Hucka <[email protected]>
 # @license Please see the file named LICENSE in the project directory
-# @website https://github.com/caltechlibrary/microarchiver
+# @website https://github.com/caltechlibrary/pubarchiver
 #
 # The code below assumes the following variables are set by the calling code:
 #
@@ -19,12 +19,12 @@
 # * SLACK_CHANNEL: Slack channel to send notifications of failure or success
 # * SLACK_CLI_TOKEN: used by slack-cli for the Slack API token
 #
-# The code below also assumes that programs "microarchiver" and "slack" (the
+# The code below also assumes that programs "pubarchiver" and "slack" (the
 # latter from https://github.com/rockymadden/slack-cli) are on the calling
 # user's command search $path.
 # =============================================================================
 
-run_microarchiver() {
+run_pubarchiver() {
     # We have only two cases, Portico and PMC, so this grungy approach is good
     # enough for now.  Future revisions should generalize this, though.
     destination=Portico
@@ -37,12 +37,12 @@ run_microarchiver() {
     done
     shopt -u nocasematch
 
-    # Next, make sure we can find microarchiver. If not, send mail & quit.
-    if ! command -v microarchiver &> /dev/null; then
+    # Next, make sure we can find pubarchiver. If not, send mail & quit.
+    if ! command -v pubarchiver &> /dev/null; then
         body=$(cat <<EOF
-This is an error message generated by the process running microarchiver for
+This is an error message generated by the process running pubarchiver for
 uploading publications to $destination. The process is unable to find the
-program "microarchiver". This indicates either a configuration problem or
+program "pubarchiver". This indicates either a configuration problem or
 a change in the computer system where the process is executed. Manual
 intervention is required. Additional information may be found here:
 
@@ -52,15 +52,15 @@ intervention is required. Additional information may be found here:
 This message was produced by $mainscript on `hostname`.
 EOF
 )
-        echo "$body" | mail -s"microarchiver failure $today" $EMAIL_FAILURE
+        echo "$body" | mail -s"pubarchiver failure $today" $EMAIL_FAILURE
         run_slack chat send --channel $SLACK_CHANNEL --color "#ff0000" \
               --title "Error: unable to upload micropublication.org to $destination" \
-              --text "$mainscript on `hostname` cannot find program 'microarchiver'"
+              --text "$mainscript on `hostname` cannot find program 'pubarchiver'"
         exit 1
     fi
 
-    # Run microarchiver with arguments and save output in $log
-    count=$(microarchiver $@ 2>&1 | tee -a $log | grep "Total articles" | cut -d ' ' -f3)
+    # Run pubarchiver with arguments and save output in $log
+    count=$(pubarchiver $@ 2>&1 | tee -a $log | grep "Total articles" | cut -d ' ' -f3)
 
     # If successful, return the num. of articles written, else send mail & quit
     status=$?
@@ -74,8 +74,8 @@ EOF
             *) cause="An unexpected error occurred during execution" ;;
         esac
         body=$(cat <<EOF
-This is an error message generated by the process running microarchiver for
-uploading publications to $destination. While doing its work, microarchiver has
+This is an error message generated by the process running pubarchiver for
+uploading publications to $destination. While doing its work, pubarchiver has
 encountered the following error:
 
    $cause
@@ -86,12 +86,12 @@ bottom the log file to see what was the last action attempted.
 Today's upload to $destination has been stopped.
 EOF
 )
-        echo "$body" | mail -s"microarchiver failure $today" -a $log $EMAIL_FAILURE
+        echo "$body" | mail -s"pubarchiver failure $today" -a $log $EMAIL_FAILURE
         run_slack chat send --channel $SLACK_CHANNEL --color "#ff0000" \
               --title "Error: unable to complete $destination archiving for micropublication.org" \
-              --text "microarchiver failed to create archive file for $destination. Cause: $cause."
+              --text "pubarchiver failed to create archive file for $destination. Cause: $cause."
         run_slack file upload --channels $SLACK_CHANNEL --file $log \
-              --comment "Here is the microarchiver run log:"
+              --comment "Here is the pubarchiver run log:"
         exit $status
     fi
 }
@@ -118,7 +118,7 @@ run_curl() {
     # First, make sure we can find curl. If not, send mail & quit.
     if ! command -v curl &> /dev/null; then
         body=$(cat <<EOF
-This is an error message generated by the process running microarchiver for
+This is an error message generated by the process running pubarchiver for
 uploading publications to $destination. The process is unable to find the
 program "curl". This indicates either a configuration problem or a
 change in the computer system where the process is executed. Manual
@@ -145,7 +145,7 @@ EOF
         # The 2nd-to-last line will have a message from curl.
         problem=$(tail -n 2 $log | head -n 1)
         body=$(cat <<EOF
-This is an error message generated by the process running microarchiver for
+This is an error message generated by the process running pubarchiver for
 uploading publications to $destination. The "curl" command used to upload files to
 $destination failed with the following return status:
 
@@ -162,7 +162,7 @@ EOF
               --title "Error: unable to complete PMC upload for micropublication.org" \
               --text "$mainscript unable to ftp to $destination. Cause: $problem."
         run_slack file upload --channels $SLACK_CHANNEL --file $log \
-              --comment "Here is the microarchiver run log:"
+              --comment "Here is the pubarchiver run log:"
         exit $status
     fi
 }

scripts/upload-to-pmc

@@ -4,7 +4,7 @@
 # @brief   Script meant to be run from cron
 # @author  Michael Hucka <[email protected]>
 # @license Please see the file named LICENSE in the project directory
-# @website https://github.com/caltechlibrary/microarchiver
+# @website https://github.com/caltechlibrary/pubarchiver
 #
 # Principles:
 #
@@ -13,7 +13,7 @@
 #  2. The local output directory where files are saved is set by environment
 #     variable PMC_OUTPUT.
 #
-#  3. A timestamp file is created in the output directory, and microarchiver
+#  3. A timestamp file is created in the output directory, and pubarchiver
 #     is run with that date stamp as the "after date" argument.
 #
 #  4. Archives are created in subdirectories of the output directory named
@@ -45,7 +45,7 @@ mainscript=${BASH_SOURCE[0]}
 today=$(date +%Y-%m-%d)
 datestampfile=$PMC_OUTPUT/last-run-date
 
-# Today's run will be written in a subdirctory.  Note the subdirectory name
+# Today's run will be written in a subdirectory.  Note the subdirectory name
 # includes the current time, not just today's date, because otherwise we
 # would overwrite the previous data if we ran run multiple times per day.
 now=$(date +%Y-%m-%d-%H%M)
@@ -81,20 +81,20 @@ echo "" >> $log
 if [[ -e $datestampfile ]]; then
     read afterdate < $datestampfile
     # Go back one day to include the run date in the argument given to
-    # microarchiver's --after-date (or else we miss the day of the run itself).
+    # pubarchiver's --after-date (or else we miss the day of the run itself).
     afterdate=$(date -d "$afterdate -1 days" +"%Y-%m-%d")
 else
     # We've never run, or someone reset the date stamp.
     # Use a fake date that basically signifies "since forever".
     afterdate="1900-01-01"
 fi
 
-echo "=== Running microarchiver for articles since $afterdate ===" >> $log
+echo "=== Running pubarchiver for articles since $afterdate ===" >> $log
 echo "" >> $log
 # This will get all articles since the last successful run.  If there were
 # any failures, they will be tried again as a result of this, because we
 # don't upload and don't update the last-run date if there are any failures.
-run_microarchiver -s pmc -C -d $afterdate -o $outputdir -r $report -@ $debuglog
+run_pubarchiver -s pmc -C -d $afterdate -o $outputdir -r $report -@ $debuglog
 
 # Did we have validation failures?  Notify someone specifically about that.
 lines=$(egrep 'validation|missing|failed' $report | wc -l)
@@ -105,9 +105,9 @@ if [[ $lines -gt 0 ]]; then
 
     run_slack chat send --channel $SLACK_CHANNEL --color "#ff0000" \
           --title "Error: did not upload micropublication.org to PMC" \
-          --text "Microarchiver stopped PMC upload due to errors in $lines articles"
+          --text "Pubarchiver stopped PMC upload due to errors in $lines articles"
     run_slack file upload --channels $SLACK_CHANNEL --file "$log" \
-          --comment "Here is the microarchiver run log"
+          --comment "Here is the pubarchiver run log"
 else
     # If we didn't have validation errors, ftp any new archives to PMC.
     # Note: curl has weird syntax for sending multiple files at once.
@@ -131,7 +131,7 @@ else
     # Post the report to Slack.
 
     run_slack chat send --channel $SLACK_CHANNEL --color "#00ff00" \
-        --title "microarchiver successfully completed PMC upload"
+        --title "pubarchiver successfully completed PMC upload"
     run_slack file upload --channels $SLACK_CHANNEL --file $report \
         --comment "Here is the record of what was uploaded:"
 fi