cleaning out references to avenger5 text
[feisty_meow.git] / scripts / site_avenger / shared_site_mgr.sh
index 015d3e68f9485ca4d2015cd6c180e1d259f1718c..300ed3e708a4316f4cb310f2ca9fb8d8d6b6dd61 100644 (file)
@@ -13,33 +13,116 @@ source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
 
 export SSM_LOG_FILE="$TMP/$(logname)-siteavenger-script.log"
 
-# get our configuration loaded, if we know the config file.
-# if there is none, we will use our default version.
-export SITE_MANAGEMENT_CONFIG_FILE
-if [ -z "$SITE_MANAGEMENT_CONFIG_FILE" ]; then
-  SITE_MANAGEMENT_CONFIG_FILE="$THISDIR/config/default.app"
-  echo "$(date_stringer): Site management config file was not set.  Using default:" >> "$SSM_LOG_FILE"
-  echo "$(date_stringer):   $SITE_MANAGEMENT_CONFIG_FILE" >> "$SSM_LOG_FILE"
-fi
-
-# load in at least the default version to get us moving.
-source "$SITE_MANAGEMENT_CONFIG_FILE"
-exit_on_error "loading site management configuration from: $SITE_MANAGEMENT_CONFIG_FILE"
-
 # configure feisty revision control to ignore vendor folders.
 export NO_CHECKIN_VENDOR=true
 
+# handles the computation of the base application path and the app dir name.
+# this expects to be passed the application directory name, but it will attempt to
+# do something intelligent if no name is passed in.
+function autoconfigure_paths()
+{
+  export app_dirname="$1"; shift
+
+  if [ -z "$app_dirname" ]; then
+    echo "$(date_stringer): Guessing application dir from local folder."
+    app_dirname="$(basename $(\pwd))"
+    export BASE_APPLICATION_PATH="$(dirname $(\pwd))"
+echo "calculated application dir of '$app_dirname' and"
+echo "a base app path of '$BASE_APPLICATION_PATH'"
+  fi
+
+  # get our configuration loaded, if we know the config file.
+  # if there is none, we will use our default version.
+  export SITE_MANAGEMENT_CONFIG_FILE
+  if [ -z "$SITE_MANAGEMENT_CONFIG_FILE" ]; then
+    SITE_MANAGEMENT_CONFIG_FILE="$THISDIR/config/default.app"
+    echo "$(date_stringer): Site management config file was not set.  Using default:" >> "$SSM_LOG_FILE"
+    echo "$(date_stringer):   $SITE_MANAGEMENT_CONFIG_FILE" >> "$SSM_LOG_FILE"
+  fi
+
+  # load in at least the default version to get us moving.
+  source "$SITE_MANAGEMENT_CONFIG_FILE"
+  exit_on_error "loading site management configuration from: $SITE_MANAGEMENT_CONFIG_FILE"
+
+
+echo "after site config file sourced, app dirname now '$app_dirname' and"
+echo "base app path now '$BASE_APPLICATION_PATH'"
+
+}
+
 # tests that the main storage folder for apps exists.
+# the parameter passed in should be the application directory name (app_dirname), without
+# any additional path components.  the script will attempt to auto-configure the application
+# base path (above the project folder with app_dirname) and get all the other path variables
+# established.
 function check_apps_root()
 {
-  local appdir="$1"; shift
-  if [ ! -d "$appdir" ]; then
-    echo "$(date_stringer): Creating the apps directory: $appdir" >> "$SSM_LOG_FILE"
-    mkdir "$appdir"
+  local temp_app_dirname="$1"; shift
+
+echo new call to auto conf func...
+  autoconfigure_paths "$temp_app_dirname"
+echo after call to auto conf func...
+
+  if [ -z "$BASE_APPLICATION_PATH" ]; then
+echo fix this: we had no base app path, what to do now?
+exit 1
+  fi
+
+  if [ ! -d "$BASE_APPLICATION_PATH" ]; then
+    echo "$(date_stringer): Creating the apps directory: $BASE_APPLICATION_PATH" >> "$SSM_LOG_FILE"
+    mkdir "$BASE_APPLICATION_PATH"
     exit_on_error "Making apps directory when not already present"
   fi
 }
 
+#hmmm: extract to core somewhere...
+# locates a parent directory of a certain name, if possible.  returns success
+# (as zero) if the directory was found, and failure if there was no parent
+# named as requested.  sets a global variable PARENT_DIR_FOUND to the full
+# directory name that matched, including the name being sought (but omitting
+# any deeper directories than that).
+function find_named_parent_dir()
+{
+  local dir_name_sought="$1"; shift
+  # clear any previous global result.
+  unset PARENT_DIR_FOUND
+  # check for degenerate case of parameter count.
+  if [ -z "$dir_name_sought" ]; then
+    echo "
+find_named_parent_dir: requires a directory name parameter, which will be
+sought out above the current directory.  the return value indicates whether
+the requested name was found or not.
+"
+    return 1
+  fi
+  # signal a failure by default with our return value.
+  local retval=1
+  # loop upwards in dir hierarchy to find the name.
+  while true; do
+    local currdir="$(\pwd)"
+    if [ "$currdir" == "/" ]; then
+      # we climbed out of all subdirs.  this is a failure case.
+      retval=1
+      break
+    fi
+    # get the base part of our name to check on success.
+    local base="$(basename "$currdir")"
+    if [ "$base" == "$dir_name_sought" ]; then
+      # yes, that is the right name.  success case.  save our result.
+      export PARENT_DIR_FOUND="$currdir"
+      retval=0
+      break
+    fi
+    # hop up a directory.
+    pushd .. &>/dev/null
+  done
+
+  # rollback any directories we pushed.
+  while popd &>/dev/null; do true; done
+
+  return $retval
+}
+
 # tries to find an appropriate config file for the application.
 function locate_config_file()
 {
@@ -80,7 +163,7 @@ function find_app_folder()
   unset app_dirname
   
   # count number of directories...  if exactly one, then choose it.
-  numdirs=$(count_directories "$appsdir")
+  numdirs=$(count_directories "$appsdir/")
 
   if [ $numdirs -eq 0 ]; then
     sep
@@ -91,28 +174,45 @@ function find_app_folder()
     echo "on the command line, e.g.:"
     echo "  $(basename $0) turtle"
     sep
-    exit 1
+    return 1
   elif [ $numdirs -eq 1 ]; then
-    app_dirname="$(basename $(find "$appsdir" -mindepth 1 -maxdepth 1 -type d) )"
+    # one directory in apps, so we'll pick that one.
+    app_dirname="$(basename $(find "$appsdir" -follow -mindepth 1 -maxdepth 1 -type d) )"
     exit_on_error "Guessing application folder"
   else
-    # if more than one folder, force user to choose.
-    # Reference: https://askubuntu.com/questions/1705/how-can-i-create-a-select-menu-in-a-shell-script
-    holdps3="$PS3"
-    PS3='Please pick a folder for site initialization: '
-    options=( $(find "$appsdir" -mindepth 1 -maxdepth 1 -type d -exec basename {} ';') "Quit")
-    select app_dirname in "${options[@]}"; do
-      case $app_dirname in
-        "Quit") echo ; echo "Quitting from the script."; return 1; ;;
-        *) echo ; echo "You picked folder '$app_dirname'" ; break; ;;
-      esac
-    done
-    if [ -z "$app_dirname" ]; then
-      echo "The folder was not provided.  This script needs a directory name"
-      echo "within which to initialize the site."
-      return 1
+    # there's more than one folder in apps...
+
+    # make sure we're allowed to auto-guess the folder name from our current dir.
+    if [ -z "$NO_AUTOMATIC_FOLDER_GUESS" ]; then
+      # if we can find the special checkout directory name above our current PWD, then that
+      # might tell us our project name.
+      if  find_named_parent_dir "$CHECKOUT_DIR_NAME"; then
+        # we can grab a name above the checkout dir name location.  let's try that.
+        app_dirname="$(basename "$(dirname $PARENT_DIR_FOUND)" )"
+      fi
+    else
+      # flag maintenance, to avoid hosing other commands by leaving this set.
+      unset NO_AUTOMATIC_FOLDER_GUESS
+
+      # well, we couldn't guess a directory based on our current location,
+      # so ask the user to choose.
+      # Reference: https://askubuntu.com/questions/1705/how-can-i-create-a-select-menu-in-a-shell-script
+      holdps3="$PS3"
+      PS3='Please pick a folder for site initialization: '
+      options=( $(find "$appsdir" -follow -mindepth 1 -maxdepth 1 -type d -exec basename {} ';') "Quit")
+      select app_dirname in "${options[@]}"; do
+        case $app_dirname in
+          "Quit") echo ; echo "Quitting from the script."; return 1; ;;
+          *) echo ; echo "You picked folder '$app_dirname'" ; break; ;;
+        esac
+      done
+      if [ -z "$app_dirname" ]; then
+        echo "The folder was not provided.  This script needs a directory name"
+        echo "within which to initialize the site."
+        return 1
+      fi
+      PS3="$holdps3"
     fi
-    PS3="$holdps3"
   fi
   test_app_folder "$appsdir" "$app_dirname"
   exit_on_error "Testing application folder: $app_dirname"
@@ -393,17 +493,20 @@ function switch_to()
   # check for parameters.
   app_dirname="$1"; shift
 
-  check_apps_root "$BASE_APPLICATION_PATH"
+  check_apps_root "$app_dirname"
 
   # find proper webroot where the site will be initialized.
   if [ -z "$app_dirname" ]; then
     # no dir was passed, so guess it.
+    export NO_AUTOMATIC_FOLDER_GUESS=true
     find_app_folder "$BASE_APPLICATION_PATH"
   else
     test_app_folder "$BASE_APPLICATION_PATH" "$app_dirname"
   fi
   if [ $? -ne 0 ]; then
-    echo "Could not locate the application directory: ${app_dirname}"
+    if [ "$app_dirname" != "Quit" ]; then
+      echo "Could not locate the application directory: ${app_dirname}"
+    fi
     return 1
   fi