unified logname uses into fm_username
[feisty_meow.git] / scripts / tty / terminal_titler.sh
index c93879d45dde250340177e244f62f09912fa3b45..a4e6a3fca9c711bd1d7c5458efd8ba9e59a11fa1 100644 (file)
@@ -3,73 +3,15 @@
 source "$FEISTY_MEOW_SCRIPTS/core/functions.sh"
 source "$FEISTY_MEOW_SCRIPTS/core/common.alias"
 
-# just saying this is an array...
-#declare -a PRIOR_TERMINAL_TITLES
-#and that whole approach fails; arrays aren't passed to subshells, so any commands
-# that execute in a subshell don't know about the contents and thus don't do what we want.
-#hmmm: revise back to single level memory.
-
-# set the stack position if not already set.
-if [ -z "$PTT_STACK_INDEX" ]; then
-  # this variable records where we will push new items on the stack.
-  PTT_STACK_INDEX=0
-fi
-
-# returns okay (0) if the stack is empty, or non-zero if not empty.
-function ptt_stack_empty()
-{
-  if [ -z "$PTT_STACK_INDEX" ]; then
-    # fix the index value.
-    PTT_STACK_INDEX=0
-    true
-  else
-    test $PTT_STACK_INDEX -le 0
-  fi
-}
-
-# a debugging function that should never have been necessary.
-# a little bit furious the restore is failing during regenerate right now.
-function show_terminal_titles()
-{
-  sep 14
-  echo "[terminal title list now has...]"
-  local i=${#PRIOR_TERMINAL_TITLES[@]}
-  if ptt_stack_empty; then
-    echo the terminal title list is empty.
-  else
-    while ((i--)); do
-      echo "ent #$i: '${PRIOR_TERMINAL_TITLES[$i]}'"
-    done
-  fi
-  sep 14
-}
+# uncomment this to get extra noisy debugging.
+#export DEBUG_TERM_TITLE=true
 
-# adds an entry into the stack of terminal titles.
-function push_ptt_stack()
-{
-  PRIOR_TERMINAL_TITLES[$PTT_STACK_INDEX]="$*"
-  ((PTT_STACK_INDEX++))
-echo stack index incremented and now at $PTT_STACK_INDEX
-show_terminal_titles
-}
-
-function pop_ptt_stack()
-{
-  if [ $PTT_STACK_INDEX -le 0 ]; then
-    echo nothing to pop from prior terminal titles stack.
-  else
-    ((PTT_STACK_INDEX--))
-echo stack index decremented and now at $PTT_STACK_INDEX
-    CURRENT_TERM_TITLE="${PRIOR_TERMINAL_TITLES[$PTT_STACK_INDEX]}"
-echo "got the last title as '$CURRENT_TERM_TITLE'"
-show_terminal_titles
-  fi
-}
+##############
 
 # puts a specific textual label on the terminal title bar.
 # this doesn't consider any previous titles; it just labels the terminal.
 # the title may not be visible in some window managers.
-function reset_terminal_title()
+function apply_title_to_terminal()
 {
   title="$*"
   # if we weren't given a title, then use just the hostname.  this is the degraded functionality.
@@ -77,44 +19,76 @@ function reset_terminal_title()
     title="$(hostname)"
   fi
   
-  if [ "${TERM}" != "dumb" -a -z "$PBS_ENVIRONMENT" -a ! -z "$PS1" ]; then
+  if [ "${TERM}" != "dumb" -a -z "$PBS_ENVIRONMENT" -a \
+        ! -z "$PS1" -a "${TERM}" != "linux" ]; then
     echo -n -e "\033]0;${title}\007"
   else
     # not running interactively, so just echo the title.
     sep
-    echo ${title}
+    echo "${title}"
     sep
   fi
 }
 
-# user friendly version that saves the title being added.
-function set_terminal_title()
+##############
+
+# records the current terminal title, pushing it down on the stack of titles,
+# possibly prior to a new one being used.
+function save_terminal_title()
 {
-  save_terminal_title
-  reset_terminal_title $*
-#reading a line made it update.
-#echo "what is title now?"
-#read line
-#this doesn't make it update.  echo -n
-echo
-  save_terminal_title
+  local title="$*"
+
+  if [ -z "$title" ]; then
+    if [ ! -z "$DEBUG_TERM_TITLE" ]; then
+      echo "terminal_titler: empty title: pushing current title again"
+    fi
+    peek_title_stack
+    title="$LAST_TITLE"
+    if [ -z "$title" ]; then
+      log_feisty_meow_event "terminal_titler: there was no saved title, so we're ignoring the save attempt."
+      return 1
+    fi
+  fi
+
+#hmmm: need a validation step here to remove bad chars that conflict with our title compression scheme.
+
+  # only slap a comma after the existing value if it wasn't empty.
+  if [ -z "$TERMINAL_TITLE_STACK" ]; then
+    export TERMINAL_TITLE_STACK="\"$title\""
+  else
+    export TERMINAL_TITLE_STACK="$TERMINAL_TITLE_STACK,\"$title\""
+  fi
+
+  if [ ! -z "$DEBUG_TERM_TITLE" ]; then
+    echo "terminal_titler: new terminal title stack is:"
+    echo "$TERMINAL_TITLE_STACK"
+  fi
 }
 
-# reads the current terminal title, if possible, and saves it to our stack of titles.
-function save_terminal_title()
+# takes a terminal title off the stack and sets the LAST_TITLE variable.
+function pop_title_stack()
+{
+  # whack our output variable, just in case.
+  unset LAST_TITLE
+  # get our stack top.
+  peek_title_stack
+  # trim the popped item out of the stack.
+  if [ ! -z "$TERMINAL_TITLE_STACK" ]; then
+    TERMINAL_TITLE_STACK="$(echo $TERMINAL_TITLE_STACK | sed -n -e 's/\(.*\),[^,]*$/\1/p')"
+  fi
+}
+
+# like pop, but does not change the stack, effectively handing you the most
+# recently set title.
+function peek_title_stack()
 {
-  # save the former terminal title if we're running in X with xterm.
-  which xprop &>/dev/null
-  if [ $? -eq 0 ]; then
-    # make sure we're actually using xterm *and* that we have a window ID.
-    if [[ "$TERM" =~ .*"xterm".* && ! -z "$WINDOWID" ]]; then
-      local prior_title="$(xprop -id $WINDOWID | perl -nle 'print $1 if /^WM_NAME.+= \"(.*)\"$/')"
-      if [ ! -z "$prior_title" ]; then
-echo "saving prior terminal title as '$prior_title'"
-        push_ptt_stack "$prior_title"
-      else
-echo "not saving prior terminal title which was empty"
-      fi
+  # whack our output variable, just in case.
+  unset LAST_TITLE
+
+  if [ ! -z "$TERMINAL_TITLE_STACK" ]; then
+    LAST_TITLE="$(echo $TERMINAL_TITLE_STACK | sed -n -e 's/.*","\([^,]*\)"$/\1/p')"
+    if [ -z "$LAST_TITLE" ]; then
+      LAST_TITLE="$(echo $TERMINAL_TITLE_STACK | sed -n -e 's/"//gp')"
     fi
   fi
 }
@@ -122,15 +96,15 @@ echo "not saving prior terminal title which was empty"
 # using our stored terminal title, this replaces the title on the terminal.
 function restore_terminal_title()
 {
-# we don't want to emit anything extra if this is being driven by git.
-#hmmm...  this could be a problem?
-#  if [ -z "$(echo $* | grep git)" ]; then
-
   # run the terminal labeller to restore the prior title, if there was one.
-  if ! ptt_stack_empty; then
-    pop_ptt_stack
-echo "restoring prior terminal title of '$CURRENT_TERM_TITLE'"
-    reset_terminal_title "$CURRENT_TERM_TITLE"
+  pop_title_stack
+
+  if [ ! -z "$LAST_TITLE" ]; then
+    if [ ! -z "$DEBUG_TERM_TITLE" ]; then
+      echo "terminal_titler: restoring prior terminal title of '$LAST_TITLE'"
+      echo "terminal_titler: while new title stack is: $TERMINAL_TITLE_STACK"
+    fi
+    apply_title_to_terminal "$LAST_TITLE"
   fi
 }
 
@@ -138,25 +112,36 @@ echo "restoring prior terminal title of '$CURRENT_TERM_TITLE'"
 function label_terminal_with_info()
 {
   # we only label the terminal anew if there's no saved title.
-  if ptt_stack_empty; then
-echo "showing new generated title since title stack was empty"
+  if [ -z "$TERMINAL_TITLE_STACK" ]; then
+    if [ ! -z "$DEBUG_TERM_TITLE" ]; then
+      echo "terminal_titler: showing new generated title since prior title was empty"
+    fi
     pruned_host=$(echo $HOSTNAME | sed -e 's/^\([^\.]*\)\..*$/\1/')
     date_string=$(date +"%Y %b %e @ %T")
-    user=$USER
+    user="$(fm_username)"
     if [ -z "$user" ]; then
       # try snagging the windoze name.
       user=$USERNAME
     fi
     new_title="-- $user@$pruned_host -- [$date_string]"
-    reset_terminal_title "$new_title"
+    apply_title_to_terminal "$new_title"
+    save_terminal_title "$new_title"
   else
     # use the former title; paste it back up there just in case.
-echo "showing prior terminal title since there was a prior title!"
-    pop_ptt_stack
-echo "using prior terminal title of '$CURRENT_TERM_TITLE'"
-    reset_terminal_title "$CURRENT_TERM_TITLE"
-    push_ptt_stack "$CURRENT_TERM_TITLE"
+    peek_title_stack
+    apply_title_to_terminal "$LAST_TITLE"
   fi
 }
 
+##############
+
+# user friendly version sets the terminal title and saves the title being added.
+function set_terminal_title()
+{
+  apply_title_to_terminal $*
+  save_terminal_title $*
+}
+
+##############
+