X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=scripts%2Fsite_avenger%2Fshared_site_mgr.sh;h=015d3e68f9485ca4d2015cd6c180e1d259f1718c;hb=69fd603d5774adbf6f107a3523a0bc498f8d33e6;hp=5f3ca1643938b5e6b6d2ca59275c62ffba0703fd;hpb=33942f43a2d7c1e5d7b091bd11ab5cb9d320e8f1;p=feisty_meow.git diff --git a/scripts/site_avenger/shared_site_mgr.sh b/scripts/site_avenger/shared_site_mgr.sh index 5f3ca164..015d3e68 100644 --- a/scripts/site_avenger/shared_site_mgr.sh +++ b/scripts/site_avenger/shared_site_mgr.sh @@ -5,37 +5,67 @@ # 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 # tests that the main storage folder for apps exists. -function check_application_dir() +function check_apps_root() { 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 +} + +# tries to find an appropriate config file for the application. +function locate_config_file() +{ + local app_dirname="$1"; shift + + 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 "$(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." >> "$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 + # they gave us a valid config file. let's try using it. + export SITE_MANAGEMENT_CONFIG_FILE="$configfile" fi + + # try to load the config. + source "$SITE_MANAGEMENT_CONFIG_FILE" + exit_on_error "loading site management configuration from: $SITE_MANAGEMENT_CONFIG_FILE" + + return 0 } # this function will seek out top-level directories in the target directory passed in. @@ -64,7 +94,7 @@ function find_app_folder() 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 @@ -73,44 +103,26 @@ function find_app_folder() 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."; exit 1; ;; + "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." - exit 1 + return 1 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" - - local configfile="$WORKDIR/config/${app_dirname}.app" -echo hoping config file would be: $configfile - if [ ! -f "$configfile" ]; then - # this is not a good config file. we can't auto-guess the config. - echo -e " -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." - # we'll pull in the default config file we set earlier; this will - # reinitialize some variables based on the app name. - else - # they gave us a valid config file. let's try using it. - export SITE_MANAGEMENT_CONFIG_FILE="$configfile" - fi - - # try to load the config. - source "$SITE_MANAGEMENT_CONFIG_FILE" - test_or_die "loading site management configuration from: $SITE_MANAGEMENT_CONFIG_FILE" + return 0 } -# ensures that the app directory name is valid. +# ensures that the app directory name is valid and then loads the config +# for the app (either via a specific file or using the defaults). function test_app_folder() { local appsdir="$1"; shift @@ -119,30 +131,34 @@ function test_app_folder() 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" } # eases some permissions to enable apache to write log files and do other shopkeeping. function fix_site_perms() { - local site_dir="$1"; shift + local app_dir="$1"; shift + + local site_dir="$app_dir/$CHECKOUT_DIR_NAME" if [ -f "$site_dir/bin/cake" ]; then - chmod -R a+rx "$site_dir/bin/cake" - test_or_die "Enabling execute bit on cake binary" + sudo chmod -R a+rx "$site_dir/bin/cake" + exit_on_error "Enabling execute bit on cake binary" fi if [ -d "$site_dir/logs" ]; then - chmod -R g+w "$site_dir/logs" - test_or_die "Enabling group write on site's Logs directory" + sudo chmod -R g+w "$site_dir/logs" + exit_on_error "Enabling group write on site's Logs directory" fi if [ -d "$site_dir/tmp" ]; then - chmod -R g+w "$site_dir/tmp" - test_or_die "Enabling group write on site's tmp directory" + sudo chmod -R g+w "$site_dir/tmp" + exit_on_error "Enabling group write on site's tmp directory" fi } @@ -154,7 +170,7 @@ function clear_orm_cache() 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 } @@ -170,26 +186,24 @@ function update_repo() 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" -echo A # see if the checkout directory exits. the repo_found variable is set to # non-empty if we find it and it's a valid git repo. repo_found= if [ -d "$checkout_dirname" ]; then -echo B # 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 @@ -197,7 +211,6 @@ echo B repo_found=yes fi -echo C # we don't consider the state of having the dir exist but the repo be wrong as good. if [ -z "$repo_found" ]; then echo "There is a problem; this folder is not a valid repository:" @@ -208,24 +221,22 @@ echo C popd &>/dev/null fi -echo D if [ ! -z "$repo_found" ]; then # a repository was found, so update the version here and leave. -echo E 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 -echo F # 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 -echo G - fix_site_perms "$complete_path" +#not doing this here since powerup uses this and has no sudo. + #fix_site_perms "$complete_path" +#unused? # construct the full path to where the app will actually live. site_store_path="$complete_path" @@ -240,12 +251,12 @@ function composer_repuff() 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 @@ -279,13 +290,13 @@ function create_site_links() # 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 @@ -312,18 +323,18 @@ function create_site_links() 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 @@ -349,4 +360,57 @@ function update_composer_repository() fi } +# fixes the ownership for a site avenger or php application. +# this almost certainly will require sudo capability, if there are any ownership problems +# that need to be resolved. +function fix_appdir_ownership() +{ + local appsdir="$1"; shift + local dir="$1"; shift + + local combo="$appsdir/$dir" + + # go with the default user running the script. + user_name="$USER" + if [ ! -z "$user_name" -a "$user_name" != "root" ]; then + 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" + exit_on_error "Chowning $combo to be owned by $user_name" + else + echo "$(date_stringer): user name failed checks for chowning, was found as '$user_name'" >> "$SSM_LOG_FILE" + fi + + # +#probably not enough for path! + fix_site_perms "$combo" +} + +# Jumps to an application directory given the app name. If no app name is +# given, it will show a menu to pick the app. +function switch_to() +{ + # check for parameters. + app_dirname="$1"; shift + + check_apps_root "$BASE_APPLICATION_PATH" + + # find proper webroot where the site will be initialized. + if [ -z "$app_dirname" ]; then + # no dir was passed, so guess it. + 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}" + return 1 + fi + + # where we expect to find our checkout folder underneath. + full_app_dir="$BASE_APPLICATION_PATH/$app_dirname" + + pushd $full_app_dir/$CHECKOUT_DIR_NAME +#redundant if pushd pwd +}