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       # tell git about all the files and get a check-in comment.
 158       git commit .
 159       retval+=$?
 160       # upload the files to the server so others can see them.
 161       git push 2>&1 | grep -v "X11 forwarding request failed"
 162       retval+=$?
 163     fi
 164   else
 165     echo no repository in $directory
 166     retval=1
 167   fi
 168   popd &>/dev/null
 169
 170   restore_terminal_title
 171
 172   return $retval
 173 }
 174
 175 function do_diff
 176 {
 177   local directory="$1"; shift
 178
 179   save_terminal_title
 180
 181   pushd "$directory" &>/dev/null
 182   local retval=0  # normally successful.
 183
 184   # only update if we see a repository living there.
 185   if [ -d ".svn" ]; then
 186     svn diff .
 187     retval+=$?
 188   elif [ -d ".git" ]; then
 189     git diff
 190     retval+=$?
 191   elif [ -d "CVS" ]; then
 192     cvs diff .
 193     retval+=$?
 194   fi
 195
 196   popd &>/dev/null
 197
 198   restore_terminal_title
 199
 200   return $retval
 201 }
 202
 203 function do_report_new
 204 {
 205   local directory="$1"; shift
 206
 207   save_terminal_title
 208
 209   pushd "$directory" &>/dev/null
 210   local retval=0  # normally successful.
 211
 212   # only update if we see a repository living there.
 213   if [ -f ".no-checkin" ]; then
 214     echo "skipping reporting due to presence of .no-checkin sentinel file."
 215   elif [ -d ".svn" ]; then
 216     # this action so far only makes sense and is needed for svn.
 217     bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
 218     retval=$?
 219   elif [ -d ".git" ]; then
 220     git status -u
 221     retval=$?
 222   fi
 223
 224   popd &>/dev/null
 225
 226   restore_terminal_title
 227
 228   return $retval
 229 }
 230
 231 # checks in all the folders in a specified list.
 232 function checkin_list()
 233 {
 234   # make the list of directories unique.
 235   local list="$(uniquify $*)"
 236
 237   save_terminal_title
 238
 239   # turn repo list back into an array.
 240   eval "repository_list=( ${REPOSITORY_LIST[*]} )"
 241
 242   local outer inner
 243
 244   for outer in "${repository_list[@]}"; do
 245     # check the repository first, since it might be an absolute path.
 246     if [[ $outer =~ /.* ]]; then
 247       # yep, this path is absolute.  just handle it directly.
 248       if [ ! -d "$outer" ]; then continue; fi
 249       do_checkin $outer
 250       test_or_die "running check-in on: $outer"
 251       sep 28
 252     else
 253       for inner in $list; do
 254         # add in the directory component to see if we can find the folder.
 255         local path="$inner/$outer"
 256         if [ ! -d "$path" ]; then continue; fi
 257         do_checkin $path
 258         test_or_die "running check-in on: $path"
 259         sep 28
 260       done
 261     fi
 262   done
 263
 264   restore_terminal_title
 265 }
 266
 267 # takes out the first few carriage returns that are in the input.
 268 function squash_first_few_crs()
 269 {
 270   i=0
 271   while read input_text; do
 272     i=$((i+1))
 273     if [ $i -le 5 ]; then
 274       echo -n "$input_text  "
 275     else
 276       echo $input_text
 277     fi
 278   done
 279   if [ $i -le 3 ]; then
 280     # if we're still squashing eols, make sure we don't leave them hanging.
 281     echo
 282   fi
 283 }
 284
 285 # selects the checkout method based on where we are (the host the script runs on).
 286 function do_update()
 287 {
 288   directory="$1"; shift
 289
 290   save_terminal_title
 291
 292   # make a nice echoer since we want to use it inside conditions below.
 293   local nicedir="$directory"
 294   if [ $nicedir == "." ]; then
 295     nicedir=$(\pwd)
 296   fi
 297   local blatt="echo retrieving '$nicedir'..."
 298
 299   local retval=0  # plan on success for now.
 300   pushd "$directory" &>/dev/null
 301   if [ -d "CVS" ]; then
 302     if test_writeable "CVS"; then
 303       $blatt
 304       cvs update . | squash_first_few_crs
 305       retval=${PIPESTATUS[0]}
 306     fi
 307   elif [ -d ".svn" ]; then
 308     if test_writeable ".svn"; then
 309       $blatt
 310       svn update . | squash_first_few_crs
 311       retval=${PIPESTATUS[0]}
 312     fi
 313   elif [ -d ".git" ]; then
 314     if test_writeable ".git"; then
 315       $blatt
 316       git pull 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
 317       retval=${PIPESTATUS[0]}
 318     fi
 319   else
 320     # this is not an error necessarily; we'll just pretend they planned this.
 321     echo no repository in $directory
 322   fi
 323   popd &>/dev/null
 324
 325   restore_terminal_title
 326
 327   return $retval
 328 }
 329
 330 # gets all the updates for a list of folders under revision control.
 331 function checkout_list()
 332 {
 333   local list="$(uniquify $*)"
 334
 335   save_terminal_title
 336
 337   # turn repo list back into an array.
 338   eval "repository_list=( ${REPOSITORY_LIST[*]} )"
 339
 340   local outer inner
 341
 342   for outer in "${repository_list[@]}"; do
 343     # check the repository first, since it might be an absolute path.
 344     if [[ $outer =~ /.* ]]; then
 345       # yep, this path is absolute.  just handle it directly.
 346       if [ ! -d "$outer" ]; then continue; fi
 347       do_update $outer
 348       test_or_die "running update on: $path"
 349       sep 28
 350     else
 351       for inner in $list; do
 352         # add in the directory component to see if we can find the folder.
 353         local path="$inner/$outer"
 354         if [ ! -d "$path" ]; then continue; fi
 355         do_update $path
 356         test_or_die "running update on: $path"
 357         sep 28
 358       done
 359     fi
 360   done
 361
 362   restore_terminal_title
 363 }
 364
 365 # provides a list of absolute paths of revision control directories
 366 # that are located under the directory passed as the first parameter.
 367 function generate_rev_ctrl_filelist()
 368 {
 369   local dir="$1"; shift
 370   pushd "$dir" &>/dev/null
 371   local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
 372   local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
 373   echo >$tempfile
 374   local additional_filter
 375   find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
 376   find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
 377   # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
 378   popd &>/dev/null
 379
 380   # see if they've warned us not to try checking in within vendor hierarchies.
 381   if [ ! -z "NO_CHECKIN_VENDOR" ]; then
 382     sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
 383   fi
 384
 385   local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
 386   sort <"$tempfile" >"$sortfile"
 387   \rm "$tempfile"
 388   echo "$sortfile"
 389 }
 390
 391 # iterates across a list of directories contained in a file (first parameter).
 392 # on each directory name, it performs the action (second parameter) provided.
 393 function perform_revctrl_action_on_file()
 394 {
 395   local tempfile="$1"; shift
 396   local action="$1"; shift
 397
 398   save_terminal_title
 399
 400   while read -u 3 dirname; do
 401     if [ -z "$dirname" ]; then continue; fi
 402     pushd "$dirname" &>/dev/null
 403     echo "[$(pwd)]"
 404     $action .
 405     test_or_die "performing action $action on: $(pwd)"
 406     sep 28
 407     popd &>/dev/null
 408   done 3<"$tempfile"
 409
 410   restore_terminal_title
 411
 412   rm $tempfile
 413 }
 414
 415