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 # Author: Chris Koeritz
   7 # Author: Kevin Wentworth
   8
   9 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
  10 source "$FEISTY_MEOW_SCRIPTS/tty/terminal_titler.sh"
  11
  12 #hmmm: we need to dump all the outputs in this script into splitter
  13
  14 ##############
  15
  16 # the maximum depth that the recursive functions will try to go below the starting directory.
  17 export MAX_DEPTH=5
  18
  19 # use our splitter tool for lengthy output if it's available.
  20 if [ ! -z "$(which splitter)" ]; then
  21   TO_SPLITTER="$(which splitter)"
  22 else
  23   TO_SPLITTER=cat
  24 fi
  25
  26 ##############
  27
  28 # one unpleasantry to take care of first; cygwin barfs aggressively if the TMP directory
  29 # is a DOS path, but we need it to be a DOS path for our GFFS testing, so that blows.
  30 # to get past this, TMP gets changed below to a hopefully generic and safe place.
  31 if [[ "$TMP" =~ .:.* ]]; then
  32   echo "making weirdo temporary directory for PCDOS-style path."
  33   export TMP=/tmp/rev_control_$USER
  34 fi
  35 if [ ! -d "$TMP" ]; then
  36   mkdir -p $TMP
  37 fi
  38 if [ ! -d "$TMP" ]; then
  39   echo "could not create the temporary directory TMP in: $TMP"
  40   echo "this script will not work properly without an existing TMP directory."
  41 fi
  42
  43 ##############
  44
  45 # checks the directory provided into the revision control system repository it belongs to.
  46 function do_checkin()
  47 {
  48   local directory="$1"; shift
  49
  50   save_terminal_title
  51
  52   # make a nice echoer since we want to use it inside conditions below.
  53   local nicedir="$directory"
  54   if [ $nicedir == "." ]; then
  55     nicedir=$(\pwd)
  56   fi
  57   local blatt="echo checking in '$nicedir'..."
  58
  59   do_update "$directory"
  60   test_or_die "repository update--this should be fixed before check-in."
  61
  62   pushd "$directory" &>/dev/null
  63   if [ -f ".no-checkin" ]; then
  64     echo "skipping check-in due to presence of .no-checkin sentinel file."
  65   elif [ -d "CVS" ]; then
  66     if test_writeable "CVS"; then
  67       $blatt
  68       cvs ci .
  69       test_or_die "cvs checkin"
  70     fi
  71   elif [ -d ".svn" ]; then
  72     if test_writeable ".svn"; then
  73       $blatt
  74       svn ci .
  75       test_or_die "svn checkin"
  76     fi
  77   elif [ -d ".git" ]; then
  78     if test_writeable ".git"; then
  79       $blatt
  80       # snag all new files.  not to everyone's liking.
  81       git add --all .
  82       test_or_die "git add all new files"
  83
  84       # see if there are any changes in the local repository.
  85       if ! git diff-index --quiet HEAD --; then
  86         # tell git about all the files and get a check-in comment.
  87         git commit .
  88         test_or_die "git commit"
  89       fi
  90       # catch if the diff-index failed somehow.
  91       test_or_die "git diff-index"
  92
  93       # we continue on to the push, even if there were no changes this time, because
  94       # there could already be committed changes that haven't been pushed yet.
  95
  96       local myself="$(my_branch_name)"
  97       local parent="$(parent_branch_name)"
  98
  99       # upload any changes to the upstream repo so others can see them.
 100       if [ "$myself" != "$parent" ]; then
 101         git push origin "$(myself)" 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
 102         test_or_die "git push to origin: $myself"
 103       else
 104         # this branch is the same as the parent, so just push.
 105         git push 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
 106         test_or_die "normal git push"
 107       fi
 108
 109     fi
 110   else
 111     # nothing there.  it's not an error though.
 112     echo no repository in $directory
 113   fi
 114   popd &>/dev/null
 115
 116   restore_terminal_title
 117
 118   true;
 119 }
 120
 121 # shows the local changes in a repository.
 122 function do_diff
 123 {
 124   local directory="$1"; shift
 125
 126   save_terminal_title
 127
 128   pushd "$directory" &>/dev/null
 129
 130   # only update if we see a repository living there.
 131   if [ -d ".svn" ]; then
 132     svn diff .
 133     test_or_die "subversion diff"
 134   elif [ -d ".git" ]; then
 135     git diff
 136     test_or_die "git diff"
 137   elif [ -d "CVS" ]; then
 138     cvs diff .
 139     test_or_die "cvs diff"
 140   fi
 141
 142   popd &>/dev/null
 143
 144   restore_terminal_title
 145
 146   true;
 147 }
 148
 149 # reports any files that are not already known to the upstream repository.
 150 function do_report_new
 151 {
 152   local directory="$1"; shift
 153
 154   save_terminal_title
 155
 156   pushd "$directory" &>/dev/null
 157
 158   # only update if we see a repository living there.
 159   if [ -f ".no-checkin" ]; then
 160     echo "skipping reporting due to presence of .no-checkin sentinel file."
 161   elif [ -d ".svn" ]; then
 162     # this action so far only makes sense and is needed for svn.
 163     bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
 164     test_or_die "svn diff"
 165   elif [ -d ".git" ]; then
 166     git status -u
 167     test_or_die "git status -u"
 168   fi
 169
 170   popd &>/dev/null
 171
 172   restore_terminal_title
 173
 174   true
 175 }
 176
 177 # checks in all the folders in a specified list.
 178 function checkin_list()
 179 {
 180   # make the list of directories unique.
 181   local list="$(uniquify $*)"
 182
 183   save_terminal_title
 184
 185   # turn repo list back into an array.
 186   eval "repository_list=( ${REPOSITORY_LIST[*]} )"
 187
 188   local outer inner
 189
 190   for outer in "${repository_list[@]}"; do
 191     # check the repository first, since it might be an absolute path.
 192     if [[ $outer =~ /.* ]]; then
 193       # yep, this path is absolute.  just handle it directly.
 194       if [ ! -d "$outer" ]; then continue; fi
 195       do_checkin $outer
 196       test_or_die "running check-in (absolute) on path: $outer"
 197       sep 28
 198     else
 199       for inner in $list; do
 200         # add in the directory component to see if we can find the folder.
 201         local path="$inner/$outer"
 202         if [ ! -d "$path" ]; then continue; fi
 203         do_checkin $path
 204         test_or_die "running check-in (relative) on path: $path"
 205         sep 28
 206       done
 207     fi
 208   done
 209
 210   restore_terminal_title
 211 }
 212
 213 # takes out the first few carriage returns that are in the input.
 214 function squash_first_few_crs()
 215 {
 216   i=0
 217   while read input_text; do
 218     i=$((i+1))
 219     if [ $i -le 5 ]; then
 220       echo -n "$input_text  "
 221     else
 222       echo $input_text
 223     fi
 224   done
 225   if [ $i -le 3 ]; then
 226     # if we're still squashing eols, make sure we don't leave them hanging.
 227     echo
 228   fi
 229 }
 230
 231 # a helpful method that reports the git branch for the current directory's
 232 # git repository.
 233 function my_branch_name()
 234 {
 235   echo "$(git branch | grep \* | cut -d ' ' -f2)"
 236 }
 237
 238 # this reports the upstream branch for the current repo.
 239 function parent_branch_name()
 240 {
 241   echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
 242 }
 243
 244 # gets the latest versions of the assets from the upstream repository.
 245 function do_update()
 246 {
 247   directory="$1"; shift
 248
 249   save_terminal_title
 250
 251   # make a nice echoer since we want to use it inside conditions below.
 252   local nicedir="$directory"
 253   if [ $nicedir == "." ]; then
 254     nicedir=$(\pwd)
 255   fi
 256   local blatt="echo retrieving '$nicedir'..."
 257
 258   pushd "$directory" &>/dev/null
 259   if [ -d "CVS" ]; then
 260     if test_writeable "CVS"; then
 261       $blatt
 262       cvs update . | $TO_SPLITTER
 263       test_or_die "cvs update"
 264     fi
 265   elif [ -d ".svn" ]; then
 266     if test_writeable ".svn"; then
 267       $blatt
 268       svn update . | $TO_SPLITTER
 269       test_or_die "svn update"
 270     fi
 271   elif [ -d ".git" ]; then
 272     if test_writeable ".git"; then
 273       $blatt
 274
 275 #let's start over clean here...
 276
 277       git fetch origin
 278       test_or_die "git fetch origin"
 279
 280       git remote update
 281       test_or_die "git remote update"
 282
 283 # from: https://stackoverflow.com/questions/3258243/check-if-pull-needed-in-git
 284 UPSTREAM="${1:-'@{u}'}"
 285 LOCAL=$(git rev-parse @)
 286 REMOTE=$(git rev-parse "$UPSTREAM")
 287 BASE=$(git merge-base @ "$UPSTREAM")
 288 var UPSTREAM LOCAL REMOTE BASE
 289
 290 if [ $LOCAL = $REMOTE ]; then
 291     echo "Up-to-date"
 292 elif [ $LOCAL = $BASE ]; then
 293     echo "Need to pull"
 294 elif [ $REMOTE = $BASE ]; then
 295     echo "Need to push"
 296 else
 297     echo "Diverged"
 298 fi
 299
 300 echo The rest of pull is not done yet.
 301
 302
 303 #      reslog=$(git log HEAD..origin/master --oneline)
 304 #      if [[ "${reslog}" != "" ]] ; then
 305 #        git merge origin/master
 306
 307
 308
 309 #      # from very helpful page:
 310 #      # https://stackoverflow.com/questions/10312521/how-to-fetch-all-git-branches
 311 #      for remote in $( git branch -r | grep -v -- '->' ); do
 312 #        git branch --track ${remote#origin/} $remote 2>/dev/null
 313 ##hmmm: ignoring errors from these, since they are continual.
 314 ##hmmm: if we could find a way to not try to track with a local branch when there's already one present, that would be swell.  it's probably simple.
 315 #      done
 316 #
 317 ##hmmm: well, one time it failed without the fetch.  i hope that's because the fetch is actually needed and not because the whole approach is fubar.
 318 #      git fetch --all 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
 319 #      test_or_die "git fetch"
 320 #
 321 #      git pull --all 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
 322 #      test_or_die "git pull"
 323     fi
 324   else
 325     # this is not an error necessarily; we'll just pretend they planned this.
 326     echo no repository in $directory
 327   fi
 328   popd &>/dev/null
 329
 330   restore_terminal_title
 331
 332   true
 333 }
 334
 335 # gets all the updates for a list of folders under revision control.
 336 function checkout_list()
 337 {
 338   local list="$(uniquify $*)"
 339
 340   save_terminal_title
 341
 342   # turn repo list back into an array.
 343   eval "repository_list=( ${REPOSITORY_LIST[*]} )"
 344
 345   local outer inner
 346
 347   for outer in "${repository_list[@]}"; do
 348     # check the repository first, since it might be an absolute path.
 349     if [[ $outer =~ /.* ]]; then
 350       # yep, this path is absolute.  just handle it directly.
 351       if [ ! -d "$outer" ]; then continue; fi
 352       do_update $outer
 353       test_or_die "running update on: $path"
 354       sep 28
 355     else
 356       for inner in $list; do
 357         # add in the directory component to see if we can find the folder.
 358         local path="$inner/$outer"
 359         if [ ! -d "$path" ]; then continue; fi
 360         do_update $path
 361         test_or_die "running update on: $path"
 362         sep 28
 363       done
 364     fi
 365   done
 366
 367   restore_terminal_title
 368 }
 369
 370 # provides a list of absolute paths of revision control directories
 371 # that are located under the directory passed as the first parameter.
 372 function generate_rev_ctrl_filelist()
 373 {
 374   local dir="$1"; shift
 375   pushd "$dir" &>/dev/null
 376   local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
 377   local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
 378   echo >$tempfile
 379   local additional_filter
 380   find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
 381   find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
 382   # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
 383   popd &>/dev/null
 384
 385   # see if they've warned us not to try checking in within vendor hierarchies.
 386   if [ ! -z "NO_CHECKIN_VENDOR" ]; then
 387     sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
 388   fi
 389
 390   local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
 391   sort <"$tempfile" >"$sortfile"
 392   \rm "$tempfile"
 393   echo "$sortfile"
 394 }
 395
 396 # iterates across a list of directories contained in a file (first parameter).
 397 # on each directory name, it performs the action (second parameter) provided.
 398 function perform_revctrl_action_on_file()
 399 {
 400   local tempfile="$1"; shift
 401   local action="$1"; shift
 402
 403   save_terminal_title
 404
 405   while read -u 3 dirname; do
 406     if [ -z "$dirname" ]; then continue; fi
 407     pushd "$dirname" &>/dev/null
 408     echo "[$(pwd)]"
 409     $action .
 410     test_or_die "performing action $action on: $(pwd)"
 411     sep 28
 412     popd &>/dev/null
 413   done 3<"$tempfile"
 414
 415   restore_terminal_title
 416
 417   rm $tempfile
 418 }
 419