bbi_actions.sh #2

# bbi_actions.lib
Version=3.8.1

#==============================================================================
# Copyright and license info is available in the LICENSE file included with
# the P4BBI tool, and also available online:
# https://swarm.workshop.perforce.com/view/p4bbi/main/LICENSE
#------------------------------------------------------------------------------

#==============================================================================
# BBI Library Functions.

#------------------------------------------------------------------------------
# Function: map_workspace_to_path
# Parameters:
# $1 - workspace
#      client workspace name
# $2 - depotType
#  The depot type, i.e. 'stream' or 'local'.
# $3 - depotDepth
#  For stream depots, the StreamDepth value of the stream depot, trimmed to
#  just the numeric value.  So if the StreamDepth value is //FOO/1/2/3, this
#  will be just '3'.  This is the number of directory levels down from the
#  root of the stream depot in which streams are rooted.  The default is 1,
#  P4D 2015.1 introduced the StreamDepth field of the depot spec.
# $4 - target path
#  The path to map in the workspace.
#------------------------------------------------------------------------------
function map_workspace_to_path {
   vvmsg "CALL: map_workspace_to_path ($*)"
   declare workspace=${1:-Unset}
   declare depotType=${2:-Unset}
   declare depotDepth=${3:-1}
   declare targetPath=${4:-Unset}
   declare stream=

   [[ $workspace == Unset || $depotType == Unset || $targetPath == Unset ]] && \
      return 1

   declare cSpecFile=/tmp/bbi.cspec.$$.$RANDOM
   
   if [[ $NO_OP -eq 0 ]]; then
      msg "Mapping workspace $workspace to $depotType depot path $targetPath."

      if [[ $depotType == stream ]]; then
         vmsg "Path $targetPath is in a Stream depot of depth $depotDepth."
         stream=$(get_stream "$targetPath" "$depotDepth")
         $P4 client -o $workspace |\
            $PERL -e "while(<>){s/^Stream:.*//; last if /^View:/; print;}" > $cSpecFile
         echo -e "\\nStream: $stream\\n\\n" >> $cSpecFile
         $P4 -s client -i < $cSpecFile || return 1
         runCmd "/bin/rm -f $cSpecFile"
      else
         vmsg "Path $targetPath is in a Classic local depot."
         $P4 client -o $workspace |\
            $PERL -e "while(<>){s/^Stream:.*//; last if /^View:/; print;}" > $cSpecFile
         echo -e "\\nView:\\n $targetPath //$workspace/...\\n\\n" >> $cSpecFile
         $P4 -s client -i < $cSpecFile || return 1
         runCmd "/bin/rm -f $cSpecFile"
      fi

   else
      if [[ $depotType == stream ]]; then
         msg "NO_OP: Would bind workspace $workspace to stream depot path $targetPath (StreamDepth=$depotDepth)."
      else
         msg "NO_OP: Would bind workspace $workspace to $depotType depot path $targetPath."
      fi
   fi
}

#------------------------------------------------------------------------------
# Function: prep_for_import
function prep_for_import {
   vvmsg "CALL: prep_for_import ($*)"

   declare cSpecFile=/tmp/bbi.cspec.$$.$RANDOM
   declare dSpecFile=/tmp/bbi.dspec.$$.$RANDOM
   declare DemoWSRoot='C:\\\\p4\\\\bbi_demo'
   declare value=

   if [[ -n "$($P4BIN -ztag -F '%Access%' client -o $ImportWS)" ]]; then
      runCmd "$P4BIN -s client -df -Fs $ImportWS 2>&1" \
         "Prepatory quiet cleanup of import workspace $ImportWS." 1 0 0
      if [[ $CMDEXITCODE -ne 0 ]]; then
         errmsg "Failed to remove import workspace [$ImportWS]."
         return 1
      fi
   fi

   if [[ -d "$ImportWSRoot" ]]; then
      runCmd "/bin/rm -rf $ImportWSRoot" \
         "Prepatory cleanup of import workspace root dir [$ImportWSRoot]." 1 0 0

      if [[ $CMDEXITCODE -ne 0 ]]; then
         runCmd "sudo /bin/rm -rf $ImportWSRoot" \
            "Second try using sudo: Prepatory cleanup of import workspace root dir [$ImportWSRoot]." 1 0 0 ||\
            bail "Second attempt to clean workspace using sudo failed."
      fi

      runCmd "/bin/mkdir -p $ImportWSRoot" \
         "Initializing empty import workspace root dir: [$ImportWSRoot]." 1 0 0 ||\
         bail "Failed to create import workspace root dir [$ImportWSRoot]."
   fi

   echo -e "Depot: depot\\n\\nOwner: p4import\\n\\nDescription:\\n\\tCreated by p4import.\\n\\nType: local\\n\\nMap: depot/...\\n\\n" > $dSpecFile

   vmsg "$(cat $dSpecFile)"

   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s depot -i < $dSpecFile || return 1
   fi

   echo -e "Client: $ImportWS\\n\\nOwner: $ImportUser\\n\\nDescription:\\n\\tBBI Import Workspace\\n\\nRoot: $ImportWSRoot\\n\\nOptions: noallwrite clobber nocompress unlocked modtime rmdir\\n\\nSubmitOptions: revertunchanged\\n\\nLineEnd: local\\n\\nView:\\n\\t//depot/... //$ImportWS/...\\n\\n" > $cSpecFile

   vmsg "$(cat $cSpecFile)"
   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s client -i < $cSpecFile || return 1
   fi

   echo -e "Client: $VerifyWS\\n\\nOwner: $ImportUser\\n\\nDescription:\\n\\tBBI Verify Workspace\\n\\nRoot: $VerifyWSRoot\\n\\nOptions: noallwrite clobber nocompress unlocked modtime rmdir\\n\\nSubmitOptions: leaveunchanged\\n\\nLineEnd: local\\n\\nView:\\n\\t//depot/... //$VerifyWS/...\\n\\n" > $cSpecFile

   vmsg "$(cat $cSpecFile)"
   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s client -i < $cSpecFile || return 1
   fi

   echo -e "Client: ${ImportUser}_bbi_demo\\n\\nOwner: $ImportUser\\n\\nDescription:\\n\\tDemo Workspace\\n\\nRoot: $DemoWSRoot\\n\\nOptions: allwrite noclobber nocompress unlocked nomodtime rmdir\\n\\nSubmitOptions: revertunchanged\\n\\nLineEnd: local\\n\\nView:\\n\\t//depot/... //${ImportUser}_bbi_demo/...\\n\\n" > $cSpecFile

   vmsg "$(cat $cSpecFile)"
   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s client -i < $cSpecFile || return 1
   fi

   # See if we can use parallel submits to enhance performance.
   echo $P4 -ztag -F '%Value%' configure show net.parallel.max
   $P4 -ztag -F '%Value%' configure show net.parallel.max
   value=$($P4 -ztag -F '%Value%' configure show net.parallel.max 2>/dev/null ||:)
   if [[ $value =~ ^[0-9]+$ ]]; then
      NetParallelMax=$value
      msg "Parallel submits enabled (net.parallel.max=$NetParallelMax)."
   else
      msg "Parallel submits disabled."
   fi

   runCmd "/bin/rm -f $cSpecFile"

   return 0
}

#------------------------------------------------------------------------------
# Function: action_BRANCH_SPEC
#
# Input:
# $1 - branchSpecFile
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_BRANCH_SPEC {
   vvmsg "CALL: action_BRANCH_SPEC ($*)"

   declare branchSpecFile=$1

   msg "Loading hand-crafted branch spec from $branchSpecFile."

   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s branch -i < $branchSpecFile
      if [[ $? -eq 0 ]]; then
         vmsg "Loaded this branch spec:\\n$(cat $branchSpecFile)\\n"
      else
         errmsg "Failed to load this branch spec:\\n$(cat $branchSpecFile)\\n"
         return 1
      fi
   else
      msg "NO_OP: Would have loaded this branch spec:\\n$(cat $branchSpecFile)\\n"
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_CLIENT_SPEC
#
# Input:
# $1 - clientSpecFile
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_CLIENT_SPEC {
   vvmsg "CALL: action_CLIENT_SPEC ($*)"

   declare clientSpecFile=$1

   msg "Loading hand-crafted branch spec from $branchSpecFile."

   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s client -i < $branchSpecFile
      if [[ $? -eq 0 ]]; then
         vmsg "Loaded this client spec:\\n$(cat $clientSpecFile)\\n"
      else
         errmsg "Failed to load this client spec:\\n$(cat $clientSpecFile)\\n"
         return 1
      fi
   else
      msg "NO_OP: Would have loaded this client spec:\\n$(cat $clientSpecFile)\\n"
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_DEPOT_SPEC
#
# Input:
# $1 - depotSpecFile
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_DEPOT_SPEC {
   vvmsg "CALL: action_DEPOT_SPEC ($*)"

   declare depotSpecFile=$1

   msg "Loading hand-crafted depot spec from $depotSpecFile."

   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s depot -i < $depotSpecFile
      if [[ $? -eq 0 ]]; then
         vmsg "Loaded this depot spec:\\n$(cat $depotSpecFile)\\n"
      else
         errmsg "Failed to load this depot spec:\\n$(cat $depotSpecFile)\\n"
         return 1
      fi
   else
      msg "NO_OP: Would have loaded this depot spec:\\n$(cat $depotSpecFile)\\n"
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_STREAM_SPEC
#
# Input:
# $1 - streamSpecFile
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_STREAM_SPEC {
   vvmsg "CALL: action_STREAM_SPEC ($*)"

   declare streamSpecFile=$1

   msg "Loading hand-crafted stream spec from $streamSpecFile."

   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s stream -i < $streamSpecFile
      if [[ $? -eq 0 ]]; then
         vmsg "Loaded this stream spec:\\n$(cat $streamSpecFile)\\n"
      else
         errmsg "Failed to load this stream spec:\\n$(cat $streamSpecFile)\\n"
         return 1
      fi
   else
      msg "NO_OP: Would have loaded this stream spec:\\n$(cat $streamSpecFile)\\n"
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_DEPOT
#
# Input:
# $1 - Depot Name
# $2 - Depot Type
# $3 - Depot Desc
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_DEPOT {
   vvmsg "CALL: action_DEPOT ($*)"

   declare depotName=$1
   declare depotType=$2
   declare depotDesc=$3
   declare dSpecFile=/tmp/bbi.dspec.$$.$RANDOM

   msg "Creating $depotType depot //$depotName."

   if [[ $P4D_VERSION > 2015.2 ]]; then
      echo -e "Depot: $depotName\\n\\nOwner: $ImportUser\\n\\nDescription:\\n\\tCreated by $ImportUser.\\n\\nType: $depotType\\n\\nStreamDepth: //$depotName/1\\n\\nMap: $depotName/...\\n\\n" > $dSpecFile
   else
      echo -e "Depot: $depotName\\n\\nOwner: $ImportUser\\n\\nDescription:\\n\\tCreated by $ImportUser.\\n\\nType: $depotType\\n\\nMap: $depotName/...\\n\\n" > $dSpecFile
   fi

   vmsg "$(cat $dSpecFile)"

   if [[ $NO_OP -eq 0 ]]; then
      $P4 -s depot -i < $dSpecFile || return 1
      runCmd "/bin/rm -f $dSpecFile"
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_UPDATE
#
# Input:
# $1 - Baseline Name
# $2 - Path to baseline.  Can be a directory, tar file, or zipped tar file.
# $3 - Changelist description.
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_UPDATE {
   vvmsg "CALL: action_UPDATE ($*)"
   declare baseline=$1
   declare targetPath=$2
   declare changeDesc=$3
   declare updateOptions=${4:-""}

   declare dir=
   declare subdir=
   declare startDir=
   declare streamSubdir=
   declare targetDepot=
   declare targetDepotType=
   declare stream=
   declare streamType=
   declare parentView=
   declare baselineOptions=${BaselineOptions[$baseline]}
   declare baselineSource=${Baselines[$baseline]}
   declare changeFormFile=/tmp/bbi.changeFormFile.$$.$RANDOM
   declare cSpecFile=/tmp/bbi.cspec.$$.$RANDOM
   declare lSpecFile=/tmp/bbi.lspec.$$.$RANDOM
   declare submitLog=/tmp/bbi.submit.$$.$RANDOM.log
   declare -i exitCode
   declare cmd=
   declare label=
   declare changelist=
   declare nonBranchingListFile=
   declare nonBranchingFile=
   declare astyleDirListFile=
   declare astyleTmpFile=/tmp/astyle.dl.$$.$RANDOM
   declare astyleTool=
   declare jsBeautifyTool=
   declare dos2unixExe=
   declare userCmd=
   declare userScript=
   declare file= action= rev=
   declare localFile=
   declare injectionScript=
   declare tmpFile=/tmp/bbi.tmp.$$.$RANDOM
   declare tmpFile2=/tmp/bbi.tmp2.$$.$RANDOM
   declare -i i=0
   declare -i filesFound=0
   declare -i jsCount=0
   declare -i jsFailedCount=0

   declare stagingDir=$WorkingDir/stage

   msg "Applying baseline $baseline to: $targetPath"

   if [[ $baselineSource == *.tar.gz || $baselineSource == *.tgz ||\
      $baselineSource == *.tar || $baselineSource == *.zip ]]; then

      runCmd "/bin/rm -rf $stagingDir" \
         "Cleaning up staging dir [$stagingDir]." 1 0 0 

      if [[ $CMDEXITCODE -ne 0 ]]; then
         runCmd "sudo /bin/rm -rf $stagingDir" \
            "Second try using sudo: Cleaning up staging dir $stagingDir" 1 0 0  ||\
            bail "Second attempt to clean staging dir [$stagingDir] using sudo failed."
      fi

      runCmd "/bin/mkdir -p $stagingDir" ||\
         bail "Failed to create staging dir [$stagingDir]."

      if [[ $NO_OP -eq 0 ]]; then
         cd "$stagingDir" ||\
            "Failed to cd to staging dir [$stagingDir]."
         msg "Now working in: $PWD"
      fi

      if [[ $baselineSource == *.tar ]]; then
         runCmd "tar -xpf $baselineSource" \
            "Expanding tar file [$baselineSource]." ||\
            bail "Failed to expand tar file [$baselineSource]."
      elif [[ $baselineSource == *.zip ]]; then
         runCmd "unzip $baselineSource" \
            "Expanding zip file [$baselineSource]." ||\
            bail "Failed to expand zipped tar file [$baselineSource]."
      else
         runCmd "tar -xzpf $baselineSource" \
            "Expanding tar file [$baselineSource]." ||\
            bail "Failed to expand zipped tar file [$baselineSource]."
      fi

      if [[ $baselineOptions == *RMTOP* ]]; then
         topDir=$(ls|head -1)
         vmsg "Removing top dir [$topDir] due to RMTOP option."
         runCmd "/bin/mv $topDir/* ."
         runCmd "/bin/rmdir $topDir"
      fi

   elif [[ $baselineSource == "CMD:"* ]]; then
      runCmd "/bin/rm -rf $stagingDir" \
         "Cleaning up staging dir [$stagingDir]." 1 0 0 

      if [[ $CMDEXITCODE -ne 0 ]]; then
         runCmd "sudo /bin/rm -rf $stagingDir" \
            "Second try using sudo: Cleaning up staging dir $stagingDir" 1 0 0  ||\
            bail "Second attempt to clean staging dir [$stagingDir] using sudo failed."
      fi

      runCmd "/bin/mkdir -p $stagingDir" ||\
         bail "Failed to create staging dir [$stagingDir]."

      cd "$stagingDir" || bail "Could not cd to staging dir [$stagingDir]."

      userCmd=${baselineSource#CMD:}
      userScript=/tmp/bbi.userScript.$$.$RANDOM.sh
      echo -e "#!/bin/bash\\n\\necho Running: $userCmd\\n$userCmd\\nExitCode=\$?\\necho EXIT_CODE=\$ExitCode\\nexit \$ExitCode\\n" > $userScript
      chmod +x $userScript
      runCmd "$userScript" "Running script:\\n$(cat $userScript)\\n" 1 0 0 ||\
         bail "User script to acquire baseline returned non-zero exit code."
      cd - > /dev/null
   elif [[ -d "$baselineSource" ]]; then
      stagingDir=$baselineSource
   else
      bail "Don't know how to handle baseline source [$baselineSource].  It is not a simple directory, tar file, or zipped tar file with a known extension."
   fi

   if [[ ! -d $ImportWSRoot ]]; then
      runCmd "/bin/mkdir -p $ImportWSRoot" "Re-initializing import workspace root dir [$ImportWSRoot]." ||\
         bail "Failed to re-initialize import workspace root dir [$ImportWSRoot]."
   fi

   if [[ ! -d $VerifyWSRoot ]]; then
      runCmd "/bin/mkdir -p $VerifyWSRoot" "Re-initializing verify workspace root dir [$VerifyWSRoot]." ||\
         bail "Failed to re-initialize verify workspace root dir [$VerifyWSRoot]."
   fi

   targetDepot=${targetPath#//}
   targetDepot=${targetDepot%%/*}
   targetDepotType=$($P4 -ztag -F %Type% depot -o $targetDepot)
   targetDepotDepth=$($P4 -ztag -F %StreamDepth% depot -o $targetDepot)
   targetDepotDepth=${targetDepotDepth##*/}

   map_workspace_to_path "$ImportWS" "$targetDepotType" "$targetDepotDepth" "$targetPath" ||\
      bail "Failed to map workspace "$ImportWS" to path [$targetPath] $targetDepotType depot."

   map_workspace_to_path "$VerifyWS" "$targetDepotType" "$targetDepotDepth" "$targetPath" ||\
      bail "Failed to map workspace "$VerifyWS" to path [$targetPath] $targetDepotType depot."

   runCmd "$P4C -s flush -q" "Flushing workspace with updated view." 1 0 0 ||\
      return 1

   if [[ $targetDepotType == stream ]]; then
      streamSubdir=$(get_stream_subdir "$targetPath" "$targetDepotDepth")
   else
      streamSubdir=
   fi

   if [[ -n "$streamSubdir" ]]; then
      if [[ ! -d "$ImportWSRoot/$streamSubdir" ]]; then
         runCmd "/bin/mkdir -p $ImportWSRoot/$streamSubdir" \
            "Creating subdir under stream workspace root." ||\
            bail "Failed to create subdir under workspace root: $ImportWSRoot/$streamSubdir"
      fi

      runCmd "$RSYNC -aq --delete $stagingDir/ $ImportWSRoot/$streamSubdir/." \
         "Updating subdir of stream workspace root."
   else
      runCmd "$RSYNC -aq --delete $stagingDir/ $ImportWSRoot/." \
         "Updating classic workspace root."
   fi

   if [[ $CMDEXITCODE -eq 0 ]]; then
      msg "Verified: rsync copied clean."
   else
      bail "The rsync exit code was $CMDEXITCODE.  Do 'man rsync' to get details on rsync exit codes."
   fi

   if [[ -n "$streamSubdir" ]]; then
      cd "$ImportWSRoot/$streamSubdir" ||\
         bail "Failed to cd to workspace stream subdir [$ImportWSRoot/$streamSubdir]."
   else
      cd "$ImportWSRoot" ||\
         bail "Failed to cd to workspace root [$ImportWSRoot]."
   fi

   runCmd "chmod -R +w ." "Ensuring working area is writable." ||\
      bail "Failed to do 'chmod -R +w .' in $PWD."

   msg "Now working in: $PWD\\nP4Path: $($P4C -ztag -F '%depotFile%' where ...)\\n"

   #---------------------------------------------------------------------------
   msg "Seeking for usage of three consecutive dots in paths."

   # The original attempt here was to detect '...' in any arbitrary element of the
   # path name.  But there was no immediate need for that, so for now I focused only
   # getting it to work for cases where '...' exists in a file name (but not any
   # directory in the fully qualified path).
   ### # Search in depth-first order, so we do replacements in the correct order.
   ### find $PWD -type d -name "*\.\.\.*" -print  > $tmpFile
   ###
   ### if [[ -s $tmpFile ]]; then
   ###    # Replace ellipses dirs.
   ###    while read -r ed; do
   ###       [[ -d "$ed" ]] || continue
   ###       while [[ "$ed" == *"..."* ]]; do
   ###          ned=${ed/\.\.\./___}
   ###          [[ -d "$ned" ]] && warnmsg "Couldn't replace '...' to '___' for dir [$ed]; target already exists."
   ###          warnmsg "Replacing detected occurences of '...' with '___' in dir [$ed]."
   ###          mv -f "$ed" "$ned"
   ###          ed=$ned
   ###       done
   ###    done < $tmpFile
   ### fi

   find $PWD -type f -name "*\.\.\.*" -print > $tmpFile

   if [[ -s $tmpFile ]]; then
      while read -r f; do
         [[ -f "$f" ]] || warnmsg "Find reported file [$f] with '...' but it disappeared."
         # Do a 'greedy match' replacement of all occurences of '...' with '___'.
         nf=${f//.../___}
         [[ -f "$nf" ]] && warnmsg "Couldn't replace '...' to '___' for file [$f]; target already exists."
         warnmsg "Replacing detected occurences of '...' with '___' in file [$f]."
         mv -f "$f" "$nf"
      done < $tmpFile
   fi

   /bin/rm -f $tmpFile

   #---------------------------------------------------------------------------
   # Injection processing.
   # Run any hand-crafted injection scripts for this baseline.
   injectionScript="$BBIConfigDir/injections/before_UPDATE_${baseline}.sh"

   if [[ -r "$injectionScript" ]]; then
      runCmd "$injectionScript" "Executing this injection script:\\n$injectionScript\\nCONTENTS:\\n$(cat $injectionScript)\\nEND_CONTENTS\\n" 1 0 0 ||\
         bail "Injection Script Failed!"

      msg "Injection script completed OK."
   fi

   #---------------------------------------------------------------------------
   # ASTYLE for C/C++/Java Processing, and beautify.sh for JavaScript.
   # ASTYLE and the JavaScript beautifier are not included in the BBI
   # package; they are 3rd party utils.
   if [[ "${updateOptions^^}" =~ ASTYLE ]]; then
      msg "Performing ASTYLE processing."
      startDir=$PWD
      astyleDirListFile=${BBIConfigDir}/astyle.${ImportTag}.dirs
      astyleTool=$(which astyle-new 2> /dev/null ||:)
      jsBeautifyTool=$(which beautify.sh 2> /dev/null ||:)

      [[ ! -x "$astyleTool" ]] && \
         bail "Could not find executable astyle tool 'astyle-new' in PATH [$PATH]."

      [[ ! -x "$jsBeautifyTool" ]] && \
         bail "Could not find executable JavaScript beautify tool 'beautify.sh' in PATH [$PATH]."

      [[ ! -r $astyleDirListFile ]] && \
         bail "Could not find expected astyle directory list file [$astyleDirListFile]."

      # If the dir list file contains 'include:name' directive, process them.
      # Generate a temp dir list file.  When including a directory from an included
      # file, prefix the path with 'name/', so 'include:foo' will prefix each path
      # with 'foo/'.
      grep -l '^include:' $astyleDirListFile > /dev/null 2>&1

      if [[ $? -eq 0 ]]; then
         msg "Processing 'include:' directives in astyle dirs file $astyleDirListFile."
         grep -v '^include:' $astyleDirListFile > $astyleTmpFile
         for inc in $(grep '^include:' $astyleDirListFile); do
            incFile=${BBIConfigDir}/astyle.${inc#include:}.dirs

            # If we're importing into a subdirectory of the root of a Stream, ignore
            # 'include' directives for subdirectories other than the one we're importing.
            if [[ -n "$streamSubdir" ]]; then
               if [[ "$streamSubdir" != "${inc#include:}" ]]; then
                  msg "Ignoring include directive [$inc] while in stream subdir $streamSubdir."
                  continue
               fi
            fi

            [[ ! -r "$incFile" ]] && \
               bail "Missing astyle dirs file $incFile referenced in $astyleDirListFile."

            echo -e "\\n# BEGIN includes from $incFile:" >> $astyleTmpFile

            while read -r subdir; do
               [[ -z "$(echo $subdir)" ]] && continue
               [[ "$subdir" == "#"* ]] && continue
               styleType=${subdir%%:*}
               styleDir=${subdir##*:}

               # If we're importing into the stream root in a Stream depot, or in a Classic depot,
               # prefix the directory as listed in hte inluced file with the prefix directory specified
               # in the 'include' directive.  However, if we're importing into a subdir of the stream
               # root, then we assume that subdir is the same as that in the include directive,
               # and we can use the directory as listed in the included file verbatim.
               if [[ -n "$streamSubdir" ]]; then
                  echo "$styleType:$styleDir" >> $astyleTmpFile
               else
                  echo "$styleType:${inc#include:}/$styleDir" >> $astyleTmpFile
               fi
            done < $incFile
            echo -e "\\n# END includes from $incFile." >> $astyleTmpFile
         done
      else
         msg "Processing astyle dirs listed in $astyleDirListFile."
         astyleTmpFile="$astyleDirListFile"
      fi

      msg "Using this list of style processing directives:"
      cat $astyleTmpFile

      while read -r subdir; do
         [[ -z "$(echo $subdir)" ]] && continue
         [[ "$subdir" == "#"* ]] && continue

         styleType=${subdir%%:*}
         styleDir=${subdir##*:}
         dir="$startDir/$styleDir"

         if [[ -d "$dir" ]]; then
            cd "$dir" || bail "Could not cd to [$dir]."

            case ${styleType} in
               (C)
                  astyleOpts="--style=allman --indent-switches --indent-namespaces --indent-classes --indent=spaces=4 --suffix=none"
                  msg "Running $astyleTool for C/C++ files in $PWD\\nArtistic Style Options: $astyleOpts"
                  filesFound=0

                  if ls *.cpp > /dev/null 2>&1; then
                     $astyleTool *.cpp $astyleOpts ||\
                        warnmsg "The $astyleTool tool failed processing *.cpp files in $PWD."
                     filesFound=1
                  fi

                  if ls *.c > /dev/null 2>&1; then
                     $astyleTool *.c $astyleOpts ||\
                        warnmsg "The $astyleTool tool failed processing *.c files in $PWD."
                     filesFound=1
                  fi

                  if ls *.h > /dev/null 2>&1; then
                     $astyleTool *.h $astyleOpts ||\
                        warnmsg "The $astyleTool tool failed processing *.h files in $PWD."
                     filesFound=1
                  fi

                  [[ $filesFound -eq 0 ]] && warnmsg "C/C++ files expected, but none were found in $PWD."
               ;;

               (Java)
                  astyleOpts="--recursive --style=java --lineend=linux --indent=spaces=4 --suffix=none"

                  find . -name "*.java" -print > $tmpFile
                  if [[ -s $tmpFile ]]; then
                     msg "Running $astyleTool for Java files in and under $PWD\\nArtistic Style Options: $astyleOpts"

                     $astyleTool '*.java' $astyleOpts ||\
                        warnmsg "The $astyleTool tool failed processing Java files in and under $PWD."
                  else
                     warnmsg "Java files expected, but none were found in $PWD."
                  fi
               ;;
               (JavaScript)
                  find $PWD -type f -name "*.js" -print | grep -v 'min.js$' > $tmpFile

                  jsCount=0
                  jsFailedCount=0

                  if [[ -s $tmpFile ]]; then
                     msg "Running $jsBeautifyTool for JavaScript (*.js) files (excluding *min.js) in $PWD."

                     while read -r jsFile; do
                        /bin/cp -f "$jsFile" "${jsFile}.tmp.$$"
                        $jsBeautifyTool "${jsFile}.tmp.$$"
                        if [[ $? -eq 0 ]]; then
                           /bin/mv -f "${jsFile}.tmp.$$" "$jsFile"
                        else
                           warnmsg "The $jsBeautifyTool tool failed processing JavaScript file [$jsFile]. The original file was left unmodified."
                           jsFailedCount=$((jsFailedCount+1))
                           /bin/rm -f "${jsFile}.tmp.$$"
                        fi

                        jsCount=$((jsCount+1))
                     done < $tmpFile

                     if [[ $jsFailedCount -eq 0 ]]; then
                        msg "Ran $jsBeautifyTool for $jsCount JavaScript file(s).  All ran OK."
                     else
                        msg "Ran $jsBeautifyTool for $jsCount JavaScript file(s).  $jsFailedCount of $jsCount failed."
                     fi
                  else
                     warnmsg "JavaScript files expected, but none were found in $PWD."
                  fi
               ;;
               (*)
                  bail "Unrecognized style processing [$styleType]; must be C, Java, or JavaScript."
               ;;
            esac
         else
            warnmsg "Dir [$dir] specified for style processing did not exist and skipped."
         fi
      done < $astyleTmpFile

      if [[ -n "$streamSubdir" ]]; then
         cd "$ImportWSRoot/$streamSubdir" ||\
            bail "Failed to cd to workspace stream subdir [$ImportWSRoot/$streamSubdir]."
      else
         cd "$ImportWSRoot" ||\
            bail "Failed to cd to workspace root [$ImportWSRoot]."
      fi

      msg "The ASTYLE processing is complete. Returned to directory [$PWD]."
   fi

   [[ -f $tmpFile ]] && /bin/rm -f $tmpFile

   #---------------------------------------------------------------------------
   # Do the reconcile.

   # The reconcile is performed in multiple steps to avoid triggering
   # rename detection, which can be very costly in a baseline & branch
   # import, where each import represents the culmination of perhaps
   # months of effort.  Reconcile and specifically rename detection is
   # optimzed for a small amount of incremental change.

   if [[ $AttemptRenameDetection -eq 1 ]]; then
      runCmd "$P4C -s reconcile -f" "Reconciling adds/edits/deletes/renames" 1 0 0 ||\
         bail "Failed to reconcile (adds/edits/deletes/renames)."
   else
      runCmd "$P4C -s reconcile -a -f" "Reconciling adds." 1 0 0 ||\
         bail "Failed to reconcile (adds only)."

      runCmd "$P4C -s reconcile -d" "Reconciling deletes." 1 0 0 ||\
         bail "Failed to reconcile (deletes only)."

      runCmd "$P4C -s reconcile -e" "Reconciling edits." 1 0 0 ||\
         bail "Failed to reconcile (edits only)."
   fi

   #---------------------------------------------------------------------------
   # Do DOS2UNIX processing if specified.
   if [[ "${updateOptions^^}" =~ DOS2UNIX ]]; then
      msg "Performing DOS2UNIX processing on text-based files opened for add, edit, or move/add."
      dos2unixExe=$(which dos2unix 2> /dev/null ||:)

      [[ ! -x "$dos2unixExe" ]] && \
         bail "Could not find executable 'dos2unix' utility in PATH [$PATH]. Perahps try:\\n\\tsudo yum install -y dos2unix\\n"

      tmpFile=/tmp/bbi.tmp.dos2unix_files.txt

      # For dos2unix processing, We ignore delete and move/delete for obvious
      # reasons.  We ignore branch and integ; branch is a copy by def'n, and integ
      # will always be a copy in the context of this BBI script.  We process files
      # opened for add, edit, and move/add actions.
      $P4C -ztag -F "%action% %type% %depotFile%" opened |\
         egrep '^(add|move/add|edit) .*text.* //' > $tmpFile

      if [[ -s $tmpFile ]]; then
         i=0
         while read -r file; do
            file="//${file#*//}"
            localFile=$($P4C -ztag -F '%path%' where "$file")
            $dos2unixExe "$localFile"
            $P4C revert -a "$localFile"
            i=$((i+1))
         done < $tmpFile
         msg "Ran dos2unix on $i text file(s)."
      else
         msg "No files require DOS2UNIX processing for this update."
      fi
      /bin/rm -f $tmpFile
   fi

   #---------------------------------------------------------------------------
   # Process Streams Non-Branching files, if any.  Non-Branching files
   # are files in the //.nb depot, which must have the following behaviours:
   #
   # 1. If opened for 'edit', they must be larger than the prior version.
   # 2. They cannot be opened for delete. 
   #
   # If either of these isn't true, the non-branching file is simply reverted.
   $P4C -ztag -F '%action%:%rev%:%depotFile%' opened > $tmpFile
   if [[ -s $tmpFile ]]; then
      while read -r data; do
         action=${data%%:*}
         rev=${data#*:}
         rev=${rev%%:*}
         file=${data##*:}
         action=$(echo $action)
         rev=$(echo $rev)
         file=$(echo $file)

         [[ $file == "//.nb/"* ]] || continue

         # For edits, make sure file size always grows.
         if [[ $action == edit ]]; then
            localFile=$($P4C -ztag -F '%path%' where $file)

            $P4C print -q -o $tmpFile2 ${file}#${rev}

            oldFileSize=$(wc -c $tmpFile2 | cut -d ' ' -f 1)
            newFileSize=$(wc -c $localFile | cut -d ' ' -f 1)

            if [[ $newFileSize -gt $oldFileSize ]]; then
               msg "Verified: New non-branching file $file size ($newFileSize) is\\nbigger than the earlier version ($oldFileSize)."
            else
               msg "Reverting Non-branching file $file as size ($newFileSize) is\\nnot bigger than the earlier version ($oldFileSize)."
               $P4C -s revert $file
            fi

         elif [[ $action == *"delete" ]]; then
            msg "Preventing delete of non-branching file $file."
            $P4C -s revert $file
         fi
      done < $tmpFile
   fi

   #---------------------------------------------------------------------------
   # Submit any changes.
   if [[ -n "$($P4C -ztag -F "%depotFile%" opened -m1)" ]]; then
      $P4C change -o | sed "s/<enter description here>/$changeDesc/g" |\
         $PERL -e "while(<>){last if /^Jobs:/; print;}" > $changeFormFile

      if [[ $NO_OP -eq 0 ]]; then
         if [[ $NetParallelMax -gt 1 ]]; then
            msg "Submitting in parallel ..."
            cmd="$P4C -s submit --parallel=threads=$NetParallelMax"
         else
            msg "Submitting ..."
            cmd="$P4C -s submit"
         fi

         echo Running: $cmd > $submitLog
         $cmd -i < $changeFormFile > $submitLog 2>&1
         exitCode=$?
         cat $submitLog
         [[ $exitCode -ne 0 ]] && return 1
         GARBAGE+=" $changeFormFile"

         # Do LABEL processing if specified.
         if [[ "${updateOptions^^}" =~ LABEL ]]; then
            label=$(echo ${updateOptions##*LABEL:})
            label=${label%% *}
            if [[ -n "$label" ]]; then
               changelist=$($P4C -ztag -F '%change%' changes -c $ImportWS -s submitted -m 1 $targetPath)
               msg "Generating label $label for changelist $changelist."
               echo -e "Label: $label\\n\\nOwner: p4import\\n\\nDescription:\\n\\tCreated by p4import.\\n\\nView:\\n\\t$targetPath\\n\\nRevision: @$changelist\\n\\n" > $lSpecFile
            $P4C -s label -i < $lSpecFile || bail "Failed to load label spec:\\n$(cat $lSpecFile)\\n"
            else
               warnmsg "Could not determine label name. Ignoring."
            fi
         fi
      else
         msg "NO_OP: Would submit changelist with updates here."
      fi

      if [[ "${updateOptions^^}" =~ VERIFY ]]; then
         if [[ "${updateOptions^^}" =~ DOS2UNIX || "${updateOptions^^}" =~ ASTYLE ]]; then
            warnmsg "Skipping VERIFY for this baseline because VERIFY is not possible when ASTYLE or DOS2UNIX are used.  Uptation options for this baseline are: $updateOptions."
         else
            msg "Performing VERIFY for imported baseline $baseline."

            runCmd "$P4VC -s flush -q @0" "Flushing verify workspace $VerifyWS." 1 0 0 ||\
               bail "Failed to remove verification workspace [$VerifyWS]."

            if [[ -d "$VerifyWSRoot" ]]; then
               runCmd "/bin/rm -rf $VerifyWSRoot" "Pre-sync cleaning verify workspace $VerifyWS." 1 0 0 ||\
                  bail "Pre-sync cleaning of verify workspace $VerifyWS FAILED."
            fi

            runCmd "$P4VC -s sync -q" "Syncing verify workspace $VerifyWS." 1 0 0 ||\
               bail "Failed to sync verify workspace!"

            if [[ -n "$streamSubdir" ]]; then
               diffTargetDir="$VerifyWSRoot/$streamSubdir"
            else
               diffTargetDir="$VerifyWSRoot"
            fi

            runCmd "$DIFF -qr --no-dereference $stagingDir $diffTargetDir" \
               "Diffing $stagingDir vs. $diffTargetDir" ||\
               bail "Verify for baseline $baseline FAILED."
            msg "Baseline $baseline Verified OK."
         fi
      fi
   else
      warnmsg "No changes detected for baseline $baseline."
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_COPY
#
# Input:
# $1 - Path 1 (or literal BRANCH_SPEC or BRANCH_SPEC-r)
# $2 - Path 2
# $3 - Changelist Desc
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_COPY {
   vvmsg "CALL: action_COPY ($*)"

   declare path1=$1
   declare path2=$2
   declare sourcePath=
   declare targetPath=
   declare branchSpec=
   declare changeDesc=${3:-default}

   declare targetDepot=
   declare targetDepotType=
   declare changeFormFile=/tmp/bbi.changeFormFile.$$.$RANDOM
   declare submitLog=/tmp/bbi.submit.$$.$RANDOM.log
   declare -i exitCode
   declare cmd=

   cmd="$P4C -s copy"

   if [[ ${path1^^} == BRANCH_SPEC ]]; then
      branchSpec=$path2
      cmd="$cmd -b $branchSpec"
      targetPath=$($P4 -ztag -F '%View0%' branch -o $branchSpec)
      targetPath=${targetPath#//}
      targetPath="//${targetPath##*//}"
   elif [[ ${path1^^} == BRANCH_SPEC-R ]]; then
      branchSpec=$path2
      cmd="$cmd -r -b $branchSpec"
      echo "targetPath=\$($P4 -ztag -F '%View0%' branch -o $branchSpec)"
      targetPath=$($P4 -ztag -F '%View0%' branch -o $branchSpec)
      targetPath="${targetPath%% //*}"
   else
      sourcePath="$path1"
      targetPath="$path2"
      cmd="$cmd $sourcePath $targetPath"
   fi

   targetDepot="${targetPath#//}"
   targetDepot="${targetDepot%%/*}"
   targetDepotType=$($P4 -ztag -F %Type% depot -o $targetDepot)
   targetDepotDepth=$($P4 -ztag -F %StreamDepth% depot -o $targetDepot)
   targetDepotDepth=${targetDepotDepth##*/}

   msg "Copying to $targetPath ($targetDepotType depot)."

   map_workspace_to_path "$ImportWS" "$targetDepotType" "$targetDepotDepth" "$targetPath" ||\
      bail "Failed to map workspace "$ImportWS" to path [$targetPath] $targetDepotType depot."

   runCmd "$P4C -s flush -q" "Flushing workspace with updated view." ||\
      return 1

   runCmd "$cmd" "Copying files using: $cmd" 1 0 0||\
      return 1

   if [[ -n "$($P4C -ztag -F "%depotFile%" opened -m1)" ]]; then
      $P4C change -o | sed "s/<enter description here>/$changeDesc/g" |\
         $PERL -e "while(<>){last if /^Jobs:/; print;}" > $changeFormFile

      if [[ $NO_OP -eq 0 ]]; then
         if [[ $NetParallelMax -gt 1 ]]; then
            msg "Submitting in parallel ..."
            cmd="$P4C -s submit --parallel=threads=$NetParallelMax"
         else
            msg "Submitting ..."
            cmd="$P4C -s submit"
         fi

         echo Running: $cmd > $submitLog
         $cmd -i < $changeFormFile > $submitLog 2>&1
         exitCode=$?
         cat $submitLog
         [[ $exitCode -ne 0 ]] && return 1
         GARBAGE+=" $changeFormFile"
      else
         msg "NO_OP: Would submit changelist with updates here."
      fi
   else
      warnmsg "Copy to $targetPath resulted in no changes."
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_RECORD_MERGE
#
# Input:
# $1 - Path 1 (or literal BRANCH_SPEC or BRANCH_SPEC-r)
# $2 - Path 2
# $3 - Changelist Desc
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_RECORD_MERGE {
   vvmsg "CALL: action_RECORD_MERGE ($*)"

   declare path1=$1
   declare path2=$2
   declare sourcePath=
   declare targetPath=
   declare branchSpec=
   declare changeDesc=${3:-default}

   declare targetDepot=
   declare targetDepotType=
   declare changeFormFile=/tmp/bbi.changeFormFile.$$.$RANDOM
   declare submitLog=/tmp/bbi.submit.$$.$RANDOM.log
   declare -i exitCode
   declare cmd=

   cmd="$P4C -s merge"

   if [[ ${path1^^} == BRANCH_SPEC ]]; then
      branchSpec=$path2
      cmd="$cmd -b $branchSpec"
      targetPath=$($P4 -ztag -F '%View0%' branch -o $branchSpec)
      targetPath=${targetPath#//}
      targetPath="//${targetPath##*//}"
   elif [[ ${path1^^} == BRANCH_SPEC-R ]]; then
      branchSpec=$path2
      cmd="$cmd -r -b $branchSpec"
      targetPath=$($P4 -ztag -F '%View0%' branch -o $branchSpec)
      targetPath="${targetPath%% //*}"
   else
      sourcePath="$path1"
      targetPath="$path2"
      cmd="$cmd $sourcePath $targetPath"
   fi

   targetDepot="${targetPath#//}"
   targetDepot="${targetDepot%%/*}"
   targetDepotType=$($P4 -ztag -F %Type% depot -o $targetDepot)
   targetDepotDepth=$($P4 -ztag -F %StreamDepth% depot -o $targetDepot)
   targetDepotDepth=${targetDepotDepth##*/}

   msg "Recording merge to $targetPath ($targetDepotType depot)."

   map_workspace_to_path "$ImportWS" "$targetDepotType" "$targetDepotDepth" "$targetPath" ||\
      bail "Failed to map workspace "$ImportWS" to path [$targetPath] $targetDepotType depot."

   runCmd "$P4C -s sync -q" "Syncing workspace with updated view." 1 0 0 ||\
      return 1

   runCmd "$cmd" "Merging files using: $cmd" 1 0 0 ||\
      return 1

   if [[ -n "$($P4C -ztag -F "%depotFile%" opened -m1)" ]]; then
      runCmd "$P4C -s resolve -ay" "Resolving files." 1 0 0 ||\
         return 1
      $P4C change -o | sed "s/<enter description here>/$changeDesc/g" |\
         $PERL -e "while(<>){last if /^Jobs:/; print;}" > $changeFormFile

      if [[ $NO_OP -eq 0 ]]; then
         if [[ $NetParallelMax -gt 1 ]]; then
            msg "Submitting in parallel ..."
            cmd="$P4C -s submit --parallel=threads=$NetParallelMax"
         else
            msg "Submitting ..."
            cmd="$P4C -s submit"
         fi

         echo Running: $cmd > $submitLog
         $cmd -i < $changeFormFile > $submitLog 2>&1
         exitCode=$?
         cat $submitLog
         [[ $exitCode -ne 0 ]] && return 1
         GARBAGE+=" $changeFormFile"
      else
         msg "NO_OP: Would submit changelist with updates here."
      fi
   else
      warnmsg "Record merge to $targetPath resulted in no changes."
   fi

   return 0
}

#------------------------------------------------------------------------------
# Function: action_POPULATE
#
# Input:
# $1 - Path 1 (or literal BRANCH_SPEC or BRANCH_SPEC-r)
# $2 - Path 2
# $3 - Changelist Desc
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_POPULATE {
   vvmsg "CALL: action_POPULATE ($*)"

   declare path1=$1
   declare path2=$2
   declare changeDesc=${3:-default}
   declare cmd="$P4 -s populate -f"

   [[ $changeDesc != default ]] && cmd="$cmd -d '$changeDesc'"

   if [[ ${path1^^} == BRANCH_SPEC ]]; then
      cmd="$cmd -b $path2"
   elif [[ ${path1^^} == BRANCH_SPEC-R ]]; then
      cmd="$cmd -r -b $path2"
   else
      cmd="$cmd $path1 $path2"
   fi

   runCmd "$cmd" "Populating with command: $cmd." 1 0 0 ||\
      return 1

   return 0
}

#------------------------------------------------------------------------------
# Function: action_MOVE
#
# Input:
# $1 - Path 1
# $2 - Path 2
# $3 - Changelist Desc
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#------------------------------------------------------------------------------
function action_MOVE {
   vvmsg "CALL: action_MOVE ($*)"

   declare path1="$1"
   declare path2="$2"
   declare changeDesc=${3:-default}

   declare changeFormFile=/tmp/bbi.changeFormFile.$$.$RANDOM
   declare submitLog=/tmp/bbi.submit.$$.$RANDOM.log
   declare -i exitCode
   declare cmd=
   declare targetDepot=
   declare targetDepotType=

   targetDepot="${path2#//}"
   targetDepot="${targetDepot%%/*}"
   targetDepotType=$($P4 -ztag -F %Type% depot -o $targetDepot)
   targetDepotDepth=$($P4 -ztag -F %StreamDepth% depot -o $targetDepot)
   targetDepotDepth=${targetDepotDepth##*/}

   msg "Moving to $path2 ($targetDepotType depot)."

   map_workspace_to_path "$ImportWS" "$targetDepotType" "$targetDepotDepth" "$path2" ||\
      bail "Failed to map workspace "$ImportWS" to path [$path2] $targetDepotType depot."

   runCmd "$P4C -s sync -q" "Syncing workspace with updated view." 1 0 0 ||\
      return 1

   runCmd "$P4C -s edit $path1" "Editing prior to rename." 1 0 0 ||\
      bail "Edit prior to rename failed."

   runCmd "$P4C -s move $path1 $path2" "Renaming." 1 0 0 ||\
      bail "Rename failed."

   if [[ -n "$($P4C -ztag -F '%depotFile%' opened -m1)" ]]; then
      $P4C change -o | sed "s/<enter description here>/$changeDesc/g" |\
         $PERL -e "while(<>){last if /^Jobs:/; print;}" > $changeFormFile

      if [[ $NO_OP -eq 0 ]]; then
         if [[ $NetParallelMax -gt 1 ]]; then
            msg "Submitting in parallel ..."
            cmd="$P4C -s submit --parallel=threads=$NetParallelMax"
         else
            msg "Submitting ..."
            cmd="$P4C -s submit"
         fi

         echo Running: $cmd > $submitLog
         $cmd -i < $changeFormFile > $submitLog 2>&1
         exitCode=$?
         cat $submitLog
         [[ $exitCode -ne 0 ]] && return 1
         GARBAGE+=" $changeFormFile"
      else
         msg "NO_OP: Would submit changelist with updates here."
      fi
   else
      warnmsg "MOVE to $path2 resulted in no changes."
   fi

   return 0
}


#------------------------------------------------------------------------------
# Function: action_STREAM
#
# Create a stream spec, and configure the import workspace to use it.
#
# Globals Variables are uppercase-initiated, e.g. $ImportWS, while local
# variables are lowercase-initiated, e.g. $baseline.
#
#------------------------------------------------------------------------------
function action_STREAM {
   vvmsg "CALL: action_STREAM ($*)"

   declare streamPath=$1
   declare streamType=$2
   declare streamParent=$3
   declare streamDesc=${4:-default}
   declare streamOptions=${5:-default}
   declare streamOwner=$ImportUser
   declare sSpecFile=/tmp/bbi.sspec.$$.$RANDOM
   declare streamDepot=
   declare streamName=

   streamDepot=${streamPath#//}
   streamDepot=${streamDepot%/*}
   streamName=${streamPath##*/}

   if [[ -n "$($P4 -ztag -F '%Update%' stream -o $streamPath)" ]]; then
      msg "Skipping update of existing stream $streamPath."
   else
      msg "Creating $streamType stream $streamPath."

      case "$streamType" in
         (release) parentView=noinherit;;
         (*) parentView=inherit;;
      esac

      # If the user has not defined stream options, use the current 'p4d' default
      # stream options for a stream of this type.
      if [[ $streamOptions == default ]]; then
         if [[ $streamType == mainline ]]; then
            streamOptions=$($P4 -ztag -F "%Options%" stream -t $streamType -o $streamPath 2>/dev/null)
         else
            streamOptions=$($P4 -ztag -F "%Options%" stream -t $streamType -P $streamParent -o $streamPath 2>/dev/null)
         fi
      fi

      [[ $streamDesc == default ]] && streamDesc="Created by $ImportUser."

      echo -e "Stream: $streamPath\\n\\nOwner: $ImportUser\\n\\nName: $streamName\\n\\nParent: $streamParent\\n\\nType: $streamType\\n\\nDescription:\\n\\t$streamDesc\\n\\nOptions: $streamOptions\\n\\nParentView: $parentView\\n\\nPaths:\\n\\tshare ...\\n\\n" > $sSpecFile

      vmsg "Generated stream spec:\\n$(cat $sSpecFile)"

      if [[ $NO_OP -eq 0 ]]; then
         $P4 -s stream -i < $sSpecFile || return 1
      else
         msg "NO_OP: Would generate stream $streamPath."
      fi
   fi

   map_workspace_to_path "$ImportWS" stream 1 "$streamPath" ||\
      bail "Failed to map workspace "$ImportWS" to path [$streamPath] in stream depot."

   return 0

}

#------------------------------------------------------------------------------
# Function: baseline_and_branch_import
#
# Input: None.  Global variables are referenced.
#
# Environment Dependency:  P4CONFIG must be defined.
#
# Globals Referenced: See load_actions() in bbi_load_and_verify.lib for a
# list of globals referenced.  This references the same values loaded in that
# function.
#
# Additional Globals Referenced:
# ImportUser
# ImportWS
# ImportWSRoot
#
# Return:
# 0 - Import ran OK.
# 1 - Errors detected.
#------------------------------------------------------------------------------
function baseline_and_branch_import {
   vvmsg "CALL: baseline_and_branch_import ($*)"

   declare -a errors
   declare -i errorCount=0
   declare -i i=0

   msg "${H}\\nStarting import at $(date).\\n"

   prep_for_import ||\
      bail "Failure preparing for import."

   i=1; while [[ $i -lt ${#ActionType[*]} ]]; do
      case ${ActionType[$i]} in
         (BRANCH_SPEC)
            msg "ACTION $i: ${ActionType[$i]}"
            action_BRANCH_SPEC "${ActionBranchSpecFile[$i]}" ||\
               bail "Failed to load hand-crafted branch spec file ${ActionBranchSpecFile[$i]}"
         ;;
         (DEPOT_SPEC)
            msg "ACTION $i: ${ActionType[$i]}"
            action_DEPOT_SPEC "${ActionDepotSpecFile[$i]}" ||\
               bail "Failed to load hand-crafted depot spec file ${ActionDepotSpecFile[$i]}"
         ;;
         (STREAM_SPEC)
            msg "ACTION $i: ${ActionType[$i]}"
            action_STREAM_SPEC "${ActionStreamSpecFile[$i]}" ||\
               bail "Failed to load hand-crafted stream spec file ${ActionStreamSpecFile[$i]}"
         ;;
         (DEPOT)
            msg "ACTION $i: ${ActionType[$i]}"
            action_DEPOT "${ActionDepotName[$i]}" "${ActionDepotType[$i]}" \
               "${ActionDesc[$i]}" ||\
               bail "Failed to create ${ActionDepotType[$i]} depot //${ActionDepotName[$i]}"
         ;;
         (UPDATE)
            msg "ACTION $i: ${ActionType[$i]}"
            action_UPDATE "${ActionBaseline[$i]}" "${ActionPath1[$i]}" \
               "${ActionDesc[$i]}" "${ActionUpdateOptions[$i]}" ||\
               bail "Action UPDATE failed to apply baseline ${ActionBaseline[$i]}."

         ;;
         (POPULATE)
            msg "ACTION $i: ${ActionType[$i]}"
            action_POPULATE "${ActionPath1[$i]}" "${ActionPath2[$i]}" \
               "${ActionDesc[$i]}" ||\
               bail "Action POPULATE to ${ActionPath2[$i]} failed."
         ;;
         (COPY)
            msg "ACTION $i: ${ActionType[$i]}"
            action_COPY "${ActionPath1[$i]}" "${ActionPath2[$i]}" \
               "${ActionDesc[$i]}" ||\
               bail "Action COPY to ${ActionPath2[$i]} failed."
         ;;
         (MOVE)
            msg "ACTION $i: ${ActionType[$i]}"
            action_MOVE "${ActionPath1[$i]}" "${ActionPath2[$i]}" \
               "${ActionDesc[$i]}" ||\
               bail "Action MOVE to ${ActionPath2[$i]} failed."
         ;;
         (RECORD_MERGE)
            msg "ACTION $i: ${ActionType[$i]}"
            action_RECORD_MERGE "${ActionPath1[$i]}" "${ActionPath2[$i]}" \
               "${ActionDesc[$i]}" ||\
               bail "Action RECORD_MERGE to ${ActionPath2[$i]} failed."
         ;;
         (STREAM)
            msg "ACTION $i: ${ActionType[$i]}"
            msg "Creating ${ActionStreamType[$i]} stream ${ActionStreamPath[$i]}."
            action_STREAM "${ActionStreamPath[$i]}" "${ActionStreamType[$i]}" \
               "${ActionStreamParent[$i]}" "${ActionStreamDesc[$i]}" \
               "${ActionStreamOptions[$i]}" ||\
               bail "Failed to create and bind workspace to stream ${ActionStreamPath[$i]}."
         ;;
         (*)
            errors[errorCount]="Invalid action type detected at run time: [${ActionType[$i]}]."
            errorCount+=1
         ;;
      esac

      if [[ $StepMode -eq 1 ]]; then
      	echo -n "STEP MODE: ${ActionType[$i]} action completed - Press <Return> to continue...."
	read -r x </dev/tty
      fi

      i+=1
   done

   if [[ $errorCount -eq 0 ]]; then
      return 0
   else
      return 1
   fi
}