Merge branch 'release-2.140.113'
[feisty_meow.git] / scripts / tty / terminal_titler.sh
1 #!/bin/bash
2
3 source "$FEISTY_MEOW_SCRIPTS/core/functions.sh"
4 source "$FEISTY_MEOW_SCRIPTS/core/common.alias"
5
6 # uncomment this to get extra noisy debugging.
7 #export DEBUG_TERM_TITLE=true
8
9 # puts a specific textual label on the terminal title bar.
10 # this doesn't consider any previous titles; it just labels the terminal.
11 # the title may not be visible in some window managers.
12 function apply_title_to_terminal()
13 {
14   title="$*"
15   # if we weren't given a title, then use just the hostname.  this is the degraded functionality.
16   if [ -z "${title}" ]; then
17     title="$(hostname)"
18   fi
19   
20   if [ "${TERM}" != "dumb" -a -z "$PBS_ENVIRONMENT" -a \
21         ! -z "$PS1" -a "${TERM}" != "linux" ]; then
22     echo -n -e "\033]0;${title}\007"
23   else
24     # not running interactively, so just echo the title.
25     sep
26     echo ${title}
27     sep
28   fi
29 }
30
31 # user friendly version that saves the title being added.
32 function set_terminal_title()
33 {
34   apply_title_to_terminal $*
35
36 #tricky tries to get it to be available when we ask for it in get_terminal_title
37   sync
38 #  echo -n
39
40 #  # we're enforcing a new title from here on.
41 #  unset PRIOR_TERMINAL_TITLE
42   save_terminal_title
43 }
44
45 # echoes back the current title on the terminal window, if we can acquire it.
46 function get_terminal_title()
47 {
48   # this is an important value now; it is checked for in save_terminal_title.
49   local term_title_found="unknown"
50   # save the former terminal title if we're running in X with xterm.
51   which xprop &>/dev/null
52   if [ $? -eq 0 ]; then
53     # make sure we're actually using xterm *and* that we have a window ID.
54     if [[ "$TERM" =~ .*"xterm".* && ! -z "$WINDOWID" ]]; then
55       term_title_found="$(xprop -id $WINDOWID | perl -nle 'print $1 if /^WM_NAME.+= \"(.*)\"$/')"
56     fi
57   fi
58   echo -n "$term_title_found"
59 }
60
61 # reads the current terminal title, if possible, and saves it to our record.
62 function save_terminal_title()
63 {
64   local title="$(get_terminal_title)"
65   if [ "$title" != "unknown" ]; then
66     # there was a title, so save it.
67     if [ ! -z "$DEBUG_TERM_TITLE" ]; then
68       echo "saving prior terminal title as '$title'"
69     fi
70     export PRIOR_TERMINAL_TITLE="$title"
71   else
72     # the terminal had no title, or we couldn't access it, or there's no terminal.
73     if [ ! -z "$DEBUG_TERM_TITLE" ]; then
74       echo "not saving prior terminal title which was empty"
75     fi
76   fi
77 }
78
79 # using our stored terminal title, this replaces the title on the terminal.
80 function restore_terminal_title()
81 {
82 # we don't want to emit anything extra if this is being driven by git.
83 #hmmm...  this could be a problem?
84 #  if [ -z "$(echo $* | grep git)" ]; then
85
86   # run the terminal labeller to restore the prior title, if there was one.
87   if [ ! -z "$PRIOR_TERMINAL_TITLE" ]; then
88     if [ ! -z "$DEBUG_TERM_TITLE" ]; then
89       echo "restoring prior terminal title of '$PRIOR_TERMINAL_TITLE'"
90     fi
91     apply_title_to_terminal "$PRIOR_TERMINAL_TITLE"
92   fi
93 }
94
95 # sets a title for the terminal with the hostname and other details.
96 function label_terminal_with_info()
97 {
98   # we only label the terminal anew if there's no saved title.
99   if [ -z "$PRIOR_TERMINAL_TITLE" ]; then
100     if [ ! -z "$DEBUG_TERM_TITLE" ]; then
101       echo "showing new generated title since prior title was empty"
102     fi
103     pruned_host=$(echo $HOSTNAME | sed -e 's/^\([^\.]*\)\..*$/\1/')
104     date_string=$(date +"%Y %b %e @ %T")
105     user="$(logname)"
106     if [ -z "$user" ]; then
107       # try snagging the windoze name.
108       user=$USERNAME
109     fi
110     new_title="-- $user@$pruned_host -- [$date_string]"
111     apply_title_to_terminal "$new_title"
112     save_terminal_title
113   else
114     # use the former title; paste it back up there just in case.
115     if [ ! -z "$DEBUG_TERM_TITLE" ]; then
116       echo "showing prior terminal title since there was a prior title!"
117       echo "using prior terminal title of '$PRIOR_TERMINAL_TITLE'"
118     fi
119     apply_title_to_terminal "$PRIOR_TERMINAL_TITLE"
120   fi
121 }
122
123