scripts/rev_control/version_control.sh

   1 #!/bin/bash
   2
   3 # these are helper functions for doing localized revision control.
   4 # this script should be sourced into other scripts that use it.
   5
   6 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
   7 source "$FEISTY_MEOW_SCRIPTS/tty/terminal_titler.sh"
   8
   9 ##############
  10
  11 # the maximum depth that the recursive functions will try to go below the starting directory.
  12 export MAX_DEPTH=5
  13
  14 #hmmm: re-address this code, since it doesn't make a lot of sense to me right now...
  15 # one unpleasantry to take care of first; cygwin barfs aggressively if the TMP directory
  16 # is a DOS path, but we need it to be a DOS path for our GFFS testing, so that blows.
  17 # to get past this, TMP gets changed below to a hopefully generic and safe place.
  18
  19 if [[ "$TMP" =~ .:.* ]]; then
  20   echo making weirdo temporary directory for DOS path.
  21   export TMP=/tmp/rev_control_$USER
  22 fi
  23 if [ ! -d "$TMP" ]; then
  24   mkdir -p $TMP
  25 fi
  26 if [ ! -d "$TMP" ]; then
  27   echo "could not create the temporary directory TMP in: $TMP"
  28   echo "this script will not work properly without an existing TMP directory."
  29 fi
  30
  31 this_host=
  32 # gets the machine's hostname and stores it in the variable "this_host".
  33 function get_our_hostname()
  34 {
  35   if [ "$OS" == "Windows_NT" ]; then
  36     this_host=$(hostname)
  37   elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
  38     this_host=$(hostname)
  39   elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
  40     this_host=$(hostname --long)
  41   else
  42     this_host=$(hostname)
  43   fi
  44   #echo "hostname is $this_host"
  45 }
  46
  47 # this function sets a variable called "home_system" to "true" if the
  48 # machine is considered one of fred's home machines.  if you are not
  49 # fred, you may want to change the machine choices.
  50 function is_home_system()
  51 {
  52   # load up the name of the host.
  53   get_our_hostname
  54   # reset the variable that we'll be setting.
  55   unset home_system
  56   export home_system
  57   if [[ $this_host == *.gruntose.blurgh ]]; then
  58     home_system=true
  59   fi
  60 }
  61
  62 #hmmm: move to core.
  63 # makes sure that the "folder" is a directory and is writable.
  64 # remember that bash successful returns are zeroes...
  65 function test_writeable()
  66 {
  67   local folder="$1"; shift
  68   if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
  69   return 0
  70 }
  71
  72 # we only want to totally personalize this script if the user is right.
  73 function check_user()
  74 {
  75   if [ "$USER" == "fred" ]; then
  76     export SVNUSER=fred_t_hamster@
  77     export EXTRA_PROTOCOL=+ssh
  78   else
  79     export SVNUSER=
  80     export EXTRA_PROTOCOL=
  81   fi
  82 }
  83
  84 # calculates the right modifier for hostnames / repositories.
  85 modifier=
  86 function compute_modifier()
  87 {
  88   modifier=
  89   directory="$1"; shift
  90   in_or_out="$1"; shift
  91   check_user
  92   # some project specific overrides.
  93   if [[ "$directory" == hoople* ]]; then
  94     modifier="svn${EXTRA_PROTOCOL}://${SVNUSER}svn.code.sf.net/p/hoople2/svn/"
  95   fi
  96   if [[ "$directory" == yeti* ]]; then
  97     modifier="svn${EXTRA_PROTOCOL}://${SVNUSER}svn.code.sf.net/p/yeti/svn/"
  98   fi
  99   # see if we're on one of fred's home machines.
 100   is_home_system
 101   # special override to pick local servers when at home.
 102   if [ "$home_system" == "true" ]; then
 103 #hmmm: this "home system" feature seems to be unnecessary?
 104     if [ "$in_or_out" == "out" ]; then
 105       # need the right home machine for modifier when checking out.
 106       modifier=
 107     else
 108       # no modifier for checkin.
 109       modifier=
 110     fi
 111   fi
 112 }
 113
 114 ##############
 115
 116 # selects the method for check-in based on where we are.
 117 function do_checkin()
 118 {
 119   local directory="$1"; shift
 120
 121   save_terminal_title
 122
 123   # make a nice echoer since we want to use it inside conditions below.
 124   local nicedir="$directory"
 125   if [ $nicedir == "." ]; then
 126     nicedir=$(\pwd)
 127   fi
 128   local blatt="echo checking in '$nicedir'..."
 129
 130   local retval=0  # normally successful.
 131
 132   do_update "$directory"
 133   retval=$?
 134   test_or_die "repository update failed; this should be fixed before check-in."
 135
 136   pushd "$directory" &>/dev/null
 137   if [ -f ".no-checkin" ]; then
 138     echo "skipping check-in due to presence of .no-checkin sentinel file."
 139   elif [ -d "CVS" ]; then
 140     if test_writeable "CVS"; then
 141       $blatt
 142       cvs ci .
 143       retval=$?
 144     fi
 145   elif [ -d ".svn" ]; then
 146     if test_writeable ".svn"; then
 147       $blatt
 148       svn ci .
 149       retval=$?
 150     fi
 151   elif [ -d ".git" ]; then
 152     if test_writeable ".git"; then
 153       $blatt
 154       # snag all new files.  not to everyone's liking.
 155       git add --all .
 156       retval=$?
 157 echo A: retval=$retval
 158       # tell git about all the files and get a check-in comment.
 159       git commit .
 160       retval+=$?
 161 echo B: retval=$retval
 162       # upload the files to the server so others can see them.
 163       git push 2>&1 | grep -v "X11 forwarding request failed"
 164       retval+=$?
 165 echo C: retval=$retval
 166     fi
 167   else
 168     echo no repository in $directory
 169     retval=1
 170   fi
 171   popd &>/dev/null
 172
 173   restore_terminal_title
 174
 175   return $retval
 176 }
 177
 178 function do_diff
 179 {
 180   local directory="$1"; shift
 181
 182   save_terminal_title
 183
 184   pushd "$directory" &>/dev/null
 185   local retval=0  # normally successful.
 186
 187   # only update if we see a repository living there.
 188   if [ -d ".svn" ]; then
 189     svn diff .
 190     retval+=$?
 191   elif [ -d ".git" ]; then
 192     git diff
 193     retval+=$?
 194   elif [ -d "CVS" ]; then
 195     cvs diff .
 196     retval+=$?
 197   fi
 198
 199   popd &>/dev/null
 200
 201   restore_terminal_title
 202
 203   return $retval
 204 }
 205
 206 function do_report_new
 207 {
 208   local directory="$1"; shift
 209
 210   save_terminal_title
 211
 212   pushd "$directory" &>/dev/null
 213   local retval=0  # normally successful.
 214
 215   # only update if we see a repository living there.
 216   if [ -f ".no-checkin" ]; then
 217     echo "skipping reporting due to presence of .no-checkin sentinel file."
 218   elif [ -d ".svn" ]; then
 219     # this action so far only makes sense and is needed for svn.
 220     bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
 221     retval=$?
 222   elif [ -d ".git" ]; then
 223     git status -u
 224     retval=$?
 225   fi
 226
 227   popd &>/dev/null
 228
 229   restore_terminal_title
 230
 231   return $retval
 232 }
 233
 234 # checks in all the folders in a specified list.
 235 function checkin_list()
 236 {
 237   # make the list of directories unique.
 238   local list="$(uniquify $*)"
 239
 240   save_terminal_title
 241
 242   # turn repo list back into an array.
 243   eval "repository_list=( ${REPOSITORY_LIST[*]} )"
 244
 245   local outer inner
 246
 247   for outer in "${repository_list[@]}"; do
 248     # check the repository first, since it might be an absolute path.
 249     if [[ $outer =~ /.* ]]; then
 250       # yep, this path is absolute.  just handle it directly.
 251       if [ ! -d "$outer" ]; then continue; fi
 252       do_checkin $outer
 253       test_or_die "running check-in on: $outer"
 254       sep 28
 255     else
 256       for inner in $list; do
 257         # add in the directory component to see if we can find the folder.
 258         local path="$inner/$outer"
 259         if [ ! -d "$path" ]; then continue; fi
 260         do_checkin $path
 261         test_or_die "running check-in on: $path"
 262         sep 28
 263       done
 264     fi
 265   done
 266
 267   restore_terminal_title
 268 }
 269
 270 # takes out the first few carriage returns that are in the input.
 271 function squash_first_few_crs()
 272 {
 273   i=0
 274   while read input_text; do
 275     i=$((i+1))
 276     if [ $i -le 5 ]; then
 277       echo -n "$input_text  "
 278     else
 279       echo $input_text
 280     fi
 281   done
 282   if [ $i -le 3 ]; then
 283     # if we're still squashing eols, make sure we don't leave them hanging.
 284     echo
 285   fi
 286 }
 287
 288 # selects the checkout method based on where we are (the host the script runs on).
 289 function do_update()
 290 {
 291   directory="$1"; shift
 292
 293   save_terminal_title
 294
 295   # make a nice echoer since we want to use it inside conditions below.
 296   local nicedir="$directory"
 297   if [ $nicedir == "." ]; then
 298     nicedir=$(\pwd)
 299   fi
 300   local blatt="echo retrieving '$nicedir'..."
 301
 302   local retval=0  # plan on success for now.
 303   pushd "$directory" &>/dev/null
 304   if [ -d "CVS" ]; then
 305     if test_writeable "CVS"; then
 306       $blatt
 307       cvs update . | squash_first_few_crs
 308       retval=${PIPESTATUS[0]}
 309     fi
 310   elif [ -d ".svn" ]; then
 311     if test_writeable ".svn"; then
 312       $blatt
 313       svn update . | squash_first_few_crs
 314       retval=${PIPESTATUS[0]}
 315     fi
 316   elif [ -d ".git" ]; then
 317     if test_writeable ".git"; then
 318       $blatt
 319       git pull 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
 320       retval=${PIPESTATUS[0]}
 321     fi
 322   else
 323     # this is not an error necessarily; we'll just pretend they planned this.
 324     echo no repository in $directory
 325   fi
 326   popd &>/dev/null
 327
 328   restore_terminal_title
 329
 330   return $retval
 331 }
 332
 333 # gets all the updates for a list of folders under revision control.
 334 function checkout_list()
 335 {
 336   local list="$(uniquify $*)"
 337
 338   save_terminal_title
 339
 340   # turn repo list back into an array.
 341   eval "repository_list=( ${REPOSITORY_LIST[*]} )"
 342
 343   local outer inner
 344
 345   for outer in "${repository_list[@]}"; do
 346     # check the repository first, since it might be an absolute path.
 347     if [[ $outer =~ /.* ]]; then
 348       # yep, this path is absolute.  just handle it directly.
 349       if [ ! -d "$outer" ]; then continue; fi
 350       do_update $outer
 351       test_or_die "running update on: $path"
 352       sep 28
 353     else
 354       for inner in $list; do
 355         # add in the directory component to see if we can find the folder.
 356         local path="$inner/$outer"
 357         if [ ! -d "$path" ]; then continue; fi
 358         do_update $path
 359         test_or_die "running update on: $path"
 360         sep 28
 361       done
 362     fi
 363   done
 364
 365   restore_terminal_title
 366 }
 367
 368 # provides a list of absolute paths of revision control directories
 369 # that are located under the directory passed as the first parameter.
 370 function generate_rev_ctrl_filelist()
 371 {
 372   local dir="$1"; shift
 373   pushd "$dir" &>/dev/null
 374   local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
 375   local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
 376   echo >$tempfile
 377   local additional_filter
 378   find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
 379   find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
 380   # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
 381   popd &>/dev/null
 382
 383   # see if they've warned us not to try checking in within vendor hierarchies.
 384   if [ ! -z "NO_CHECKIN_VENDOR" ]; then
 385     sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
 386   fi
 387
 388   local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
 389   sort <"$tempfile" >"$sortfile"
 390   \rm "$tempfile"
 391   echo "$sortfile"
 392 }
 393
 394 # iterates across a list of directories contained in a file (first parameter).
 395 # on each directory name, it performs the action (second parameter) provided.
 396 function perform_revctrl_action_on_file()
 397 {
 398   local tempfile="$1"; shift
 399   local action="$1"; shift
 400
 401   save_terminal_title
 402
 403   while read -u 3 dirname; do
 404     if [ -z "$dirname" ]; then continue; fi
 405     pushd "$dirname" &>/dev/null
 406     echo "[$(pwd)]"
 407     $action .
 408     test_or_die "performing action $action on: $(pwd)"
 409     sep 28
 410     popd &>/dev/null
 411   done 3<"$tempfile"
 412
 413   restore_terminal_title
 414
 415   rm $tempfile
 416 }
 417
 418