dropped setting of umask for people
[feisty_meow.git] / scripts / core / variables.sh
index 36069c07b3f62f2a20b891b73baaf6c1645d43d8..a937d05dba10fa66be708817bc2c096956ff0f7a 100644 (file)
 
 ##############
 
-if [ ! -z "$SHELL_DEBUG" ]; then echo variables initialization begins...; fi
+#hmmm: moved from functions.sh; does that hose everything up?
 
-##############
-
-# System variables...
-
-# OS variable records the operating system we think we found.
-if [ -z "$OS" ]; then
-  export OS=UNIX
-fi
-export IS_DARWIN=$(echo $OSTYPE | grep -i darwin)
-
-if [ -z "$HOME" ]; then
-  if [ "$OS" == "Windows_NT" ]; then
-    export HOME=/c/home
-    if [ ! -d $HOME ]; then
-      mkdir $HOME
-    fi
-  fi
-fi
-
-# patch home to undo cygwin style of drive letter.
-export HOME=$(echo $HOME | sed -e 's/\/cygdrive\//\//g')
-#echo HOME is now $HOME
-
-if [ "$OS" == "Windows_NT" ]; then
-  export HOSTNAME=$(echo $HOSTNAME | tr A-Z a-z)
-fi
-
-# ulimit and umask.  umask sets a permission mask for all file
-# creations.  The mask shown here disallows writing by the "group" and
-# "others" categories of users.  ulimit sets the user limits.  the core
-# file size is set to zero.
-umask 022
-ulimit -c 0
-
-##############
+  # defines a variable within the feisty meow environment and remembers that
+  # this is a new or modified definition.  if the feisty meow codebase is
+  # unloaded, then so are all the variables that were defined.
+  # this function always exports the variables it defines.
+  function define_yeti_variable()
+  {
+    #hmmm: simple implem just sets it up and exports the variable.
+    #  i.e., this method always exports.
+    export "${@}" 
 
-# Directory variables...
+#hmmm: eventual approach-- if variable exists already, save old value for restore,
+# otherwise save null value for restore,
+# have to handle unsetting if there was no prior value of one
+# we newly defined.
+# add variable name to a list of feisty defined variables.
 
-export SCRIPT_SYSTEM=feisty_meow
+return 0
+  }
 
-#if [ -z "$FEISTY_MEOW_DIR" ]; then export FEISTY_MEOW_DIR="$HOME/$SCRIPT_SYSTEM"; fi
-#if [ -z "$FEISTY_MEOW_SCRIPTS" ]; then export FEISTY_MEOW_SCRIPTS="$FEISTY_MEOW_DIR/scripts"; fi
-#if [ -z "$FEISTY_MEOW_SCRIPTS" ]; then export FEISTY_MEOW_SCRIPTS="$FEISTY_MEOW_SCRIPTS"; fi
-
-# include helpful functions.
-source "$FEISTY_MEOW_SCRIPTS/core/functions.sh"
-
-# LIBDIR is an older variable that points at the root of the yeti code.
-export LIBDIR=$FEISTY_MEOW_DIR
-
-if [ -z "$FEISTY_MEOW_GENERATED" ]; then
-  # The generated scripts directory is where automatically generated files live.
-  # It is separate from the main body of the shell scripts in order to keep things from
-  # exploding.
-  export FEISTY_MEOW_GENERATED=$HOME/.zz_auto_gen
-fi
 
 ##############
 
-# user variables...
+# this section should always run or bash will reset them on us.
+# these need to be as minimal as possible.
 
-# define a default name, if one wasn't already set.
-if [ -z "$NAME" ]; then
-  export NAME='Unset Q. Namington, Fixley Your Name III'
-fi
+# sets the main prompt to a simple default, with user@host.
+define_yeti_variable PS1='\u@\h $ ';
+# sets the history length and max file size so we can get some long history around here.
+define_yeti_variable HISTSIZE=1000000
+define_yeti_variable HISTFILESIZE=8000000
 
+# make the TERM available to all sub-shells.
+define_yeti_variable TERM
+  
 ##############
+  
+# we'll run this again only if we think it's needed.
+if [ -z "$CORE_VARIABLES_LOADED" ]; then
+
+  if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo variables initialization begins...; fi
+  
+  ##############
+  
+  # start with some simpler things.
+  
+#hmmm: this needs to come from some configuration item.  especially for installs.
+define_yeti_variable DEFAULT_FEISTYMEOW_ORG_DIR=/opt/feistymeow.org
+
+  define_yeti_variable SCRIPT_SYSTEM=feisty_meow
+  
+  # OS variable records the operating system we think we found.
+  if [ -z "$OS" ]; then
+    define_yeti_variable OS=UNIX
+  fi
+  define_yeti_variable IS_DARWIN=$(echo $OSTYPE | grep -i darwin)
+  
+  ##############
+
+  # guess the current platform.
+  IS_UNIX=$(uname | grep -i linux)
+  if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i unix); fi
+  if [ -z "$IS_UNIX" ]; then IS_UNIX=$(uname | grep -i darwin); fi
+  IS_DOS=$(uname | grep -i ming)
+  if [ -z "$IS_DOS" ]; then IS_DOS=$(uname | grep -i cygwin); fi
+
+  # now if we're stuck in DOS, try to determine the type of system.
+  if [ ! -z "$IS_DOS" ]; then
+    # IS_MSYS will be non-empty if this is the msys toolset.  otherwise
+    # we assume that it's cygwin.
+    IS_MSYS=$(uname | grep -i ming)
+
+    # if not MSYS, then we'll assume cygwin and set the cygwin root var.
+    if [ -z "$IS_MSYS" ]; then
+      define_yeti_variable CYGROOT=$(cygpath -w -m /)
+    fi
+  fi
 
-
-##############################################################################
-# other variables...
-##############################################################################
-
-# pull in the custom overrides for feisty_meow scripts.
-for i in $FEISTY_MEOW_GENERATED/custom/*.sh; do
-  if [ ! -z "$SHELL_DEBUG" ]; then
-    echo "loading customization: $(basename $(dirname $i))/$(basename $i)"
+  ##############
+  
+  # fallbacks to set crucial variables for feisty meow...
+  
+  # set the main root directory variable for the feisty meow codebase.
+  # this is only used for extreme failure modes, when the values were not
+  # pulled in from our auto-generated config.
+  if [ -z "$FEISTY_MEOW_APEX" ]; then
+    if [ -d "/opt/feistymeow.org/feisty_meow" ]; then
+      define_yeti_variable FEISTY_MEOW_APEX="/opt/feistymeow.org/feisty_meow"
+      define_yeti_variable FEISTY_MEOW_SCRIPTS="$FEISTY_MEOW_APEX/scripts"
+    elif [ -d "$HOME/feisty_meow" ]; then
+      define_yeti_variable FEISTY_MEOW_APEX="$HOME/feisty_meow"
+      define_yeti_variable FEISTY_MEOW_SCRIPTS="$FEISTY_MEOW_APEX/scripts"
+    fi
   fi
-  source $i
-done
 
-# sets the prompts to what we (i.e., i) like...
-# there are four different prompts.  the first one, PS1, is the one that users
-# see the most often. 
-export PS1='\u@\h $ ';
-### export PS2='> '; export PS3='#? '; export PS4='+ '
-
-# variables for perl.
-export PERLLIB
-if [ "$OS" != "Windows_NT" ]; then
-  PERLLIB+="/usr/lib/perl5"
-else
-#echo "the scripts dir is $FEISTY_MEOW_SCRIPTS"
-  FEISTY_MEOW_SCRIPTS="$(echo $FEISTY_MEOW_SCRIPTS | sed -e 's/\\/\//g')"
-  FEISTY_MEOW_SCRIPTS="$FEISTY_MEOW_SCRIPTS"
-#echo "the scripts dir is now $FEISTY_MEOW_SCRIPTS"
-  export PERLIO=:perlio
-    # choose perl's IO over the system's so we can handle file bytes exactly.
-fi
+  # main declaration of the transients area.
+  if [ -z "$TMP" ]; then
+    define_yeti_variable TMP=$HOME/.tmp
+  fi
 
-#make this automatic!
-PERLLIB+=":$FEISTY_MEOW_SCRIPTS/core:$FEISTY_MEOW_SCRIPTS/text:$FEISTY_MEOW_SCRIPTS/files:$FEISTY_MEOW_SCRIPTS/archival"
+  # set up the top-level for all build creations and logs and such.
+  if [ -z "$FEISTY_MEOW_GENERATED_STORE" ]; then
+    define_yeti_variable FEISTY_MEOW_GENERATED_STORE="$TMP/generated-feisty_meow"
+  fi
+  if [ ! -d "$FEISTY_MEOW_GENERATED_STORE" ]; then
+    mkdir -p "$FEISTY_MEOW_GENERATED_STORE"
+  fi
+  # set up our effluent outsourcing valves.
+  if [ -z "$TEMPORARIES_PILE" ]; then
+    define_yeti_variable TEMPORARIES_PILE="$FEISTY_MEOW_GENERATED_STORE/temporaries"
+  fi
+  if [ ! -d "$TEMPORARIES_PILE" ]; then
+    mkdir -p "$TEMPORARIES_PILE"
+  fi
 
-# set this so nechung can find its data.
-export NECHUNG=$LIBDIR/database/fortunes.dat
+  # similarly, make sure we have someplace to look for our generated files, if
+  # we were not handed a value.
+  if [ -z "$FEISTY_MEOW_LOADING_DOCK" ]; then
+    # The generated scripts directory is where automatically generated files live.
+    # It is separate from the main body of the shell scripts in order to keep things from
+    # exploding.
+    define_yeti_variable FEISTY_MEOW_LOADING_DOCK=$HOME/.zz_feisty_loading
+  fi
+  
+  ##############
 
-# ensure we use the right kind of rsh for security.
-export CVS_RSH=ssh
+  # set up the color_add variable which is a flag that lets ls know colors work.
 
-# sets the history length and max file size so we can get some long history around here.
-HISTSIZE=1000000
-HISTFILESIZE=2000000
-
-# set the editor for subversion if it hasn't already been set.
-if [ -z "$SVN_EDITOR" ]; then
-#hmmm: not sure what original reason for having these different was...
-  if [ "$OS"  == "Windows_NT" ]; then
-    export SVN_EDITOR=$(which gvim)
+  # test if we can use color in ls...
+  ls --help 2>&1 | grep -i -q color
+  if [ $? -eq 0 ]; then
+    export color_add='--color=auto'
   else
-    export SVN_EDITOR=$(which vi)
+    export color_add=
   fi
-fi
-
-# include variables needed for compiling hoople and using its scripts.
-if [ -z "$FEISTY_MEOW_DIR" ]; then
-  if [ -d "$HOME/feisty_meow" ]; then
-    export FEISTY_MEOW_DIR="$HOME/feisty_meow"
+  unset test_ls_colors
+  
+  ##############
+
+  # umask sets a permission mask for all file creations.  we don't set this for the users any
+  # more; they should set it themselves.  this is just documentation.
+  # 
+  # this mask disallows writes by the "group" and disallows all permissions for "others".
+  #umask 027
+  # this mask disallows writes by "group" and "others".
+  #umask 022
+  # this mask allows writes by "group" but not by "others".
+  #umask 002
+
+  # ulimit sets user limits.  we set the maximum allowed core dump file size
+  # to zero, because it is obnoxious to see the core dumps from crashed
+  # programs lying around everywhere.
+  ulimit -c 0
+  
+  ##############
+  
+  # user variables, sort of...  if they haven't given themselves a name yet,
+  # then we will make one up for them.
+  
+  # define a default name, if one wasn't already set.
+  if [ -z "$NAME" ]; then
+    define_yeti_variable NAME='Unset Q. Namington, Fixley Your Name III'
+  fi
+  
+  ##############
+  
+  # variables for perl.
+  
+  define_yeti_variable PERLLIB+="/usr/lib/perl5"
+  if [ "$OS" == "Windows_NT" ]; then
+    define_yeti_variable PERLIO=:perlio
+      # choose perl's IO over the ms-windows version so we can handle file
+      # bytes properly.
   fi
-fi
 
-# initialize the build variables, if possible.
-found_build_vars=0
-if [ ! -z "$FEISTY_MEOW_DIR" ]; then
-  # first guess at using the old school bin directory.
-  bv="$FEISTY_MEOW_DIR/bin/build_variables.sh"
-  if [ -f "$bv" ]; then
-    # the old bin directory is present, so let's use its build vars.
-    source "$bv" "$bv"
-    found_build_vars=1
-  else
-    # try again with the new school location for the file.
-    bv="$FEISTY_MEOW_DIR/scripts/generator/build_variables.sh"
-    if [ -f "$bv" ]; then
+  # iterate across our sub-directories and find the perl scripts.
+  # this currently only looks one level down.
+  for i in $FEISTY_MEOW_SCRIPTS/*; do
+    if [ -d "$i" ]; then
+      # check if there is a perl file present; add the folder to PERLLIB if so.
+      ls $i/*.pl &>/dev/null
+      if [ $? -eq 0 ]; then
+        PERLLIB+=":$(dos_to_unix_path $i)"
+      fi
+    fi
+  done
+  define_yeti_variable PERL5LIB=$PERLLIB
+  #echo PERLLIB is now $PERLLIB
+  
+  ##############
+  
+  # set this so nechung can find its data.
+  define_yeti_variable NECHUNG=$FEISTY_MEOW_APEX/infobase/fortunes.dat
+  
+##  # establish a pipe for less to see our beloved syntax highlighting.
+##  define_yeti_variable LESSOPEN="| source-highlight -f esc -o STDOUT -i %s"
+
+  # the base checkout list is just to update feisty_meow.  additional folder
+  # names can be added in your customized scripts.  the space at the end of
+  # this variable is important and allows users to extend the list like:
+  #    define_yeti_variable REPOSITORY_DIR+="muppets configs"
+  # see the customize/fred folder for a live example.
+  define_yeti_variable REPOSITORY_LIST="$FEISTY_MEOW_APEX "
+
+  # add in any active projects to the repository list.
+  if [ -d "$HOME/active" ]; then
+    REPOSITORY_LIST+="$(find "$HOME/active" -maxdepth 1 -mindepth 1 -type d) "
+  fi
+  # add in any site avenger applications that are in the apps folder.
+  if [ -d "$HOME/apps" ]; then
+    # first, simple projects.
+    REPOSITORY_LIST+="$(find "$HOME/apps" -iname "avenger5" -type d) "
+    # then, site avenger specific projects.
+    REPOSITORY_LIST+="$(find "$HOME/apps" -maxdepth 2 -mindepth 2 -iname "avenger5" -type d) "
+  fi
+  
+  # the archive collections list is a set of directories that are major
+  # repositories of data which can be synched to backup drives.
+  define_yeti_variable ARCHIVE_COLLECTIONS_LIST=
+
+  # initializes the feisty meow build variables, if possible.
+  function initialize_build_variables()
+  {
+    found_build_vars=0
+    # we need to know the feisty meow directory, or we bail.
+    if [ -z "$FEISTY_MEOW_APEX" ]; then return; fi
+    # pick from our expected generator folder, but make sure it's there...
+    buildvars="$FEISTY_MEOW_SCRIPTS/generator/build_variables.sh"
+    if [ -f "$buildvars" ]; then
       # yep, that one looks good, so pull in the build defs.
-      source "$bv" "$bv"
+      source "$buildvars" "$buildvars"
       found_build_vars=1
-    else
-      # try once more with new school and assume we're deep.
-      bv="$FEISTY_MEOW_DIR/../../scripts/generator/build_variables.sh"
-      if [ -f "$bv" ]; then
-        # sweet, there is something there.
-        source "$bv" "$bv"
-        found_build_vars=1
-      fi
     fi
+    # now augment the environment if we found our build variables.
+    if [ $found_build_vars == 1 ]; then
+      # the binary directory contains our collection of handy programs.
+      define_yeti_variable FEISTY_MEOW_BINARIES=$TARGETS_STORE
+      # add binaries created within build to the path.
+      define_yeti_variable PATH="$(dos_to_unix_path $FEISTY_MEOW_BINARIES):$PATH"
+      # Shared libraries are located via this variable.
+      define_yeti_variable LD_LIBRARY_PATH="$(dos_to_unix_path $LD_LIBRARY_PATH):$(dos_to_unix_path $FEISTY_MEOW_BINARIES)"
+    fi
+  }
+  
+  ##############
+  
+  # windoze specific patching up missing things.
+  
+  if [ "$OS" == "Windows_NT" ]; then
+    define_yeti_variable HOSTNAME=$(echo $HOSTNAME | tr A-Z a-z)
   fi
+  
+  ##############
+  
+  # load in the build environment.
+  initialize_build_variables
+  
+  ##############
+  
+  # add to the PATH variables used for locating applications.  this step is taken after any
+  # potential overrides from the user.
+  define_yeti_variable PATH="$(dos_to_unix_path $FEISTY_MEOW_LOADING_DOCK):$PATH:$(find /usr/local/games -maxdepth 1 -type d -exec echo -n {}: ';' 2>/dev/null)/sbin"
+  
+  ##############
+
+  # set the SHUNIT_PATH so our shunit tests can find the codebase.
+  define_yeti_variable SHUNIT_PATH="$FEISTY_MEOW_SCRIPTS/shunit"
+  
+  ##############
+
+  define_yeti_variable CORE_VARIABLES_LOADED=true
+  
+  if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo variables initialization ends....; fi
 fi
 
-# augment the configuration if we found our build variables.
-if [ $found_build_vars == 1 ]; then
-
-  # the binary directory contains handy programs we use a lot in yeti.  we set up the path to it
-  # here based on the operating system.
-  # note that yeti has recently become more dependent on hoople.  hoople was always the source of
-  # the binaries, but now we don't ship them with yeti any more as pre-built items.  this reduces
-  # the size of the code package a lot and shortens up our possible exposure to compromised
-  # binaries.  people can bootstrap up their own set from hoople now instead.
-  export BINDIR=$FEISTY_MEOW_DIR/production/binaries
-
-  # add binaries created within build to the path.
-  export PATH="$(dos_to_msys_path $BUILD_TOP/build/bin):$PATH"
-
-  # Shared libraries are located via this variable.
-  export LD_LIBRARY_PATH="$(dos_to_msys_path $LD_LIBRARY_PATH):$(dos_to_msys_path $BINDIR)"
-fi
-
-# Set the path for locating applications.
-export PATH="$(dos_to_msys_path $BINDIR):$(dos_to_msys_path $FEISTY_MEOW_GENERATED):$PATH:/bin:/sbin:/usr/sbin:/usr/local/bin:/usr/local/lib:/usr/games:/usr/bin:."
+##############
 
-if [ ! -z "$SHELL_DEBUG" ]; then echo variables initialization ends....; fi
+# pull in the custom overrides for feisty_meow scripts.  this is done last,
+# because we want to set everything up as expected, then let the user
+# override individual variables and definitions.  we also don't guard this
+# to avoid running it again, because we don't know what mix of functions and
+# aliases they want to define in there.
+for i in $FEISTY_MEOW_LOADING_DOCK/custom/*.sh; do
+  if [ ! -f "$i" ]; then
+    # skip it if it's not real.
+    continue;
+  fi
+  if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
+    echo "loading customization: $(basename $(dirname $i))/$(basename $i)"
+  fi
+  source "$i"
+done