# This contains a bunch of reusable functions that help out in managing websites.
-# This script is sourced, and relies on the value of WORKDIR, which should
+# This script is sourced, and relies on the value of THISDIR, which should
# point at the directory where the site management scripts are stored,
# especially this one.
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="$WORKDIR/config/default.app"
- echo "Site management config file was not set. Using default:"
- echo " $SITE_MANAGEMENT_CONFIG_FILE"
+ 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"
-test_or_die "loading site management configuration from: $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
{
local appdir="$1"; shift
if [ ! -d "$appdir" ]; then
- echo "Creating the apps directory: $appdir"
+ echo "$(date_stringer): Creating the apps directory: $appdir" >> "$SSM_LOG_FILE"
mkdir "$appdir"
- test_or_die "Making apps directory when not already present"
+ 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
+ # 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.
+ return 1
+ 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"
+ return 0
+ fi
+ done
+}
+
# tries to find an appropriate config file for the application.
function locate_config_file()
{
local app_dirname="$1"; shift
- local configfile="$WORKDIR/config/${app_dirname}.app"
- echo "config file?: $configfile"
+ local configfile="$THISDIR/config/${app_dirname}.app"
+ echo "$(date_stringer): config file guessed?: $configfile" >> "$SSM_LOG_FILE"
if [ ! -f "$configfile" ]; then
# this is not a good config file. we can't auto-guess the config.
- echo -e "
+ echo -e "$(date_stringer):
There is no specific site configuration file in:
$configfile
We will continue onward using the default and hope that this project follows
-the standard pattern for cakephp projects."
+the standard pattern for cakephp projects." >> "$SSM_LOG_FILE"
# we'll pull in the default config file we set earlier; this will
# reinitialize some variables based on the app name.
else
# try to load the config.
source "$SITE_MANAGEMENT_CONFIG_FILE"
- test_or_die "loading site management configuration from: $SITE_MANAGEMENT_CONFIG_FILE"
+ exit_on_error "loading site management configuration from: $SITE_MANAGEMENT_CONFIG_FILE"
return 0
}
exit 1
elif [ $numdirs -eq 1 ]; then
app_dirname="$(basename $(find "$appsdir" -mindepth 1 -maxdepth 1 -type d) )"
- test_or_die "Guessing application folder"
+ 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...
+
+ # if we can find an avenger5 directory above our current PWD, then that might tell us our name.
+ if find_named_parent_dir "avenger5"; then
+ # we can grab a name above the avenger5 location. let's try that.
+ app_dirname="$(basename "$(dirname $PARENT_DIR_FOUND)" )"
+ else
+ # 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" -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"
- test_or_die "Testing application folder: $app_dirname"
+ exit_on_error "Testing application folder: $app_dirname"
echo "Application folder is: $app_dirname"
return 0
local combo="$appsdir/$dir"
if [ ! -d "$combo" ]; then
- echo "Creating app directory: $combo"
+ echo "$(date_stringer): Creating app directory: $combo" >> "$SSM_LOG_FILE"
mkdir "$combo"
- test_or_die "Making application directory when not already present"
+ exit_on_error "Making application directory when not already present"
fi
locate_config_file "$dir"
if [ -f "$site_dir/bin/cake" ]; then
sudo chmod -R a+rx "$site_dir/bin/cake"
- test_or_die "Enabling execute bit on cake binary"
+ exit_on_error "Enabling execute bit on cake binary"
fi
if [ -d "$site_dir/logs" ]; then
sudo chmod -R g+w "$site_dir/logs"
- test_or_die "Enabling group write on site's Logs directory"
+ exit_on_error "Enabling group write on site's Logs directory"
fi
if [ -d "$site_dir/tmp" ]; then
sudo chmod -R g+w "$site_dir/tmp"
- test_or_die "Enabling group write on site's tmp directory"
+ exit_on_error "Enabling group write on site's tmp directory"
fi
}
if [ -f "$site_dir/bin/cake" ]; then
# flush any cached objects from db.
"$site_dir/bin/cake" orm_cache clear
- test_or_die "Clearing ORM cache"
+ exit_on_error "Clearing ORM cache"
fi
}
local repo_root="$1"; shift
local repo_name="$1"; shift
-echo here are parms in update repo:
-var full_app_dir checkout_dirname repo_root repo_name
+echo "$(date_stringer): here are parms in update repo:" >> "$SSM_LOG_FILE"
+echo "$(date_stringer): $(var full_app_dir checkout_dirname repo_root repo_name)" >> "$SSM_LOG_FILE"
# forget any prior value, since we are going to validate the path.
unset site_store_path
pushd "$full_app_dir" &>/dev/null
- test_or_die "Switching to our app dir '$full_app_dir'"
+ exit_on_error "Switching to our app dir '$full_app_dir'"
local complete_path="$full_app_dir/$checkout_dirname"
if [ -d "$checkout_dirname" ]; then
# checkout directory exists, so let's check it.
pushd "$checkout_dirname" &>/dev/null
- test_or_die "Switching to our checkout directory: $checkout_dirname"
+ exit_on_error "Switching to our checkout directory: $checkout_dirname"
# ask for repository name (without .git).
if git rev-parse --git-dir > /dev/null 2>&1; then
# a repository was found, so update the version here and leave.
echo "Repository $repo_name exists. Updating it."
rgetem
- test_or_die "Recursive checkout on: $complete_path"
+ exit_on_error "Recursive checkout on: $complete_path"
else
# clone the repo since it wasn't found.
echo "Cloning repository $repo_name now."
git clone "$repo_root/$repo_name.git" $checkout_dirname
- test_or_die "Git clone of repository: $repo_name"
+ exit_on_error "Git clone of repository: $repo_name"
fi
#not doing this here since powerup uses this and has no sudo.
local site_store_path="$1"; shift
pushd "$site_store_path" &>/dev/null
- test_or_die "Switching to our app dir '$site_store_path'"
+ exit_on_error "Switching to our app dir '$site_store_path'"
echo "Updating site with composer..."
composer -n install
- test_or_die "Composer installation step on '$site_store_path'."
+ exit_on_error "Composer installation step on '$site_store_path'."
echo "Site updated."
#hmmm: argh global
# jump into the site path so we can start making relative links.
pushd "$site_store_path" &>/dev/null
- test_or_die "Switching to our app dir '$site_store_path'"
+ exit_on_error "Switching to our app dir '$site_store_path'"
pushd webroot &>/dev/null
# remove all symlinks that might plague us.
find . -maxdepth 1 -type l -exec rm -f {} ';'
- test_or_die "Cleaning out links in webroot"
+ exit_on_error "Cleaning out links in webroot"
# link in the avcore plugin.
make_safe_link "../vendor/siteavenger/avcore/webroot" avcore
if [ -L public ]; then
# public is a symlink.
\rm public
- test_or_die "Removing public directory symlink"
+ exit_on_error "Removing public directory symlink"
elif [ -d public ]; then
# public is a folder with default files.
#hmmm: is that safe?
\rm -rf public
- test_or_die "Removing public directory and contents"
+ exit_on_error "Removing public directory and contents"
fi
# create the main 'public' symlink
#hmmm: argh global
make_safe_link $CHECKOUT_DIR_NAME/webroot public
- test_or_die "Creating link to webroot called 'public'"
+ exit_on_error "Creating link to webroot called 'public'"
#hmmm: public/$themelower/im will be created automatically by system user with appropriate permissions
# go with the default user running the script.
user_name="$USER"
if [ ! -z "$user_name" -a "$user_name" != "root" ]; then
- echo "Chowning the app folder to be owned by: $user_name"
+ echo "$(date_stringer): Chowning the app folder to be owned by: $user_name" >> "$SSM_LOG_FILE"
#hmmm: have to hope for now for standard group named after user
sudo chown -R "$user_name:$user_name" "$combo"
- test_or_die "Chowning $combo to be owned by $user_name"
+ exit_on_error "Chowning $combo to be owned by $user_name"
else
- echo "user name failed checks for chowning, was found as '$user_name'"
+ echo "$(date_stringer): user name failed checks for chowning, was found as '$user_name'" >> "$SSM_LOG_FILE"
fi
#
test_app_folder "$BASE_APPLICATION_PATH" "$app_dirname"
fi
if [ $? -ne 0 ]; then
- echo "Could not locate that application directory"
+ echo "Could not locate the application directory: ${app_dirname}"
return 1
fi
# where we expect to find our checkout folder underneath.
full_app_dir="$BASE_APPLICATION_PATH/$app_dirname"
- cd $full_app_dir/$CHECKOUT_DIR_NAME
- pwd
+ pushd $full_app_dir/$CHECKOUT_DIR_NAME
+#redundant if pushd pwd
}
projects / feisty_meow.git / blobdiff