3 # these are helper functions for doing localized revision control.
4 # this script should be sourced into other scripts that use it.
6 # Author: Chris Koeritz
7 # Author: Kevin Wentworth
9 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
10 source "$FEISTY_MEOW_SCRIPTS/tty/terminal_titler.sh"
14 # the maximum depth that the recursive functions will try to go below the starting directory.
17 # use our splitter tool for lengthy output if it's available.
18 if [ ! -z "$(which splitter 2>/dev/null)" ]; then
19 TO_SPLITTER="$(which splitter)"
20 # calculate the number of columsn in the terminal.
22 TO_SPLITTER+=" --maxcol $(($cols - 1))"
29 # one unpleasantry to take care of first; cygwin barfs aggressively if the TMP directory
30 # is a DOS path, but we need it to be a DOS path for our GFFS testing, so that blows.
31 # to get past this, TMP gets changed below to a hopefully generic and safe place.
32 if [[ "$TMP" =~ .:.* ]]; then
33 log_feisty_meow_event "making weirdo temporary directory for PCDOS-style path."
34 export TMP=/tmp/rev_control_$USER
36 if [ ! -d "$TMP" ]; then
39 if [ ! -d "$TMP" ]; then
40 echo "could not create the temporary directory TMP in: $TMP"
41 echo "this script will not work properly without an existing TMP directory."
43 #hmmm: odd approach to solving the "sourced scripts shouldn't exit or they take down the
44 # original caller too" issue.
45 echo "hit ctrl-c to stay in this shell now, otherwise it may exit in 10 seconds..."
52 # checks the directory provided into the revision control system repository it belongs to.
53 function do_revctrl_checkin()
55 local directory="$1"; shift
57 #hmmm: another piece of reusable code, to process the directory for printing.
58 # make a nice echoer since we want to use it inside conditions below.
59 local nicedir="$directory"
60 if [ $nicedir == "." ]; then
63 local blatt_report="echo -ne \nchecking in '$nicedir'... "
64 local tell_no_checkin="echo -ne \nskipping check-in due to presence of .no-checkin sentinel file: $nicedir"
66 pushd "$directory" &>/dev/null
67 #hmmm: overly elaborate sections below here, but we do want precise handling for git case.
69 if test_writeable "CVS"; then
70 do_revctrl_simple_update "$directory"
71 exit_on_error "updating repository; this issue should be fixed before check-in."
72 if [ -f ".no-checkin" ]; then
73 # echo -ne "\nskipping check-in due to presence of .no-checkin sentinel file: $directory"
78 exit_on_error "cvs checkin"
81 elif [ -d ".svn" ]; then
82 if test_writeable ".svn"; then
83 do_revctrl_simple_update "$directory"
84 exit_on_error "updating repository; this issue should be fixed before check-in."
85 if [ -f ".no-checkin" ]; then
86 # echo -ne "\nskipping check-in due to presence of .no-checkin sentinel file: $directory"
91 exit_on_error "svn checkin"
94 elif [ -d ".git" ]; then
95 if test_writeable ".git"; then
97 # take steps to make sure the branch integrity is good and we're up to date against remote repos.
98 do_revctrl_careful_update "$(\pwd)"
100 if [ -f ".no-checkin" ]; then
101 # echo -ne "\nskipping check-in due to presence of .no-checkin sentinel file: $directory"
106 # put all changed and new files in the commit. not to everyone's liking.
107 git add --all . | $TO_SPLITTER
108 promote_pipe_return 0
109 exit_on_error "git add all new files"
111 # see if there are any changes in the local repository.
112 if ! git diff-index --quiet HEAD --; then
113 # tell git about all the files and get a check-in comment.
114 #hmmm: begins to look like, you guessed it, a reusable bit that all commit actions could enjoy.
117 continue_on_error "git commit"
118 if [ $retval -ne 0 ]; then
119 echo -e -n "Commit failed or was aborted:\nShould we continue with other check-ins? [y/N] "
122 if [[ "${line:0:1}" != "y" ]]; then
123 echo "Stopping check-in process due to missing commit and user request."
129 # we continue on to the push, even if there were no obvious changes this run, because
130 # there could already be committed changes that haven't been pushed yet.
132 # upload any changes to the upstream repo so others can see them.
133 git push --tags origin "$(my_branch_name)" 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
134 promote_pipe_return 0
135 exit_on_error "git push"
139 # nothing there. it's not an error though.
140 log_feisty_meow_event "no repository in $directory"
147 # shows the local changes in a repository.
148 function do_revctrl_diff
150 local directory="$1"; shift
152 pushd "$directory" &>/dev/null
154 # only update if we see a repository living there.
155 if [ -d ".svn" ]; then
157 exit_on_error "subversion diff"
158 elif [ -d ".git" ]; then
160 exit_on_error "git diff"
161 elif [ -d "CVS" ]; then
163 exit_on_error "cvs diff"
171 # reports any files that are not already known to the upstream repository.
172 function do_revctrl_report_new
174 local directory="$1"; shift
176 pushd "$directory" &>/dev/null
178 # only update if we see a repository living there.
179 if [ -f ".no-checkin" ]; then
180 echo -ne "\nskipping reporting due to presence of .no-checkin sentinel file: $directory"
181 elif [ -d ".svn" ]; then
182 # this action so far only makes sense and is needed for svn.
183 bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
184 exit_on_error "svn diff"
185 elif [ -d ".git" ]; then
187 exit_on_error "git status -u"
195 # checks in all the folders in the specified list.
196 function checkin_list()
198 # make the list of directories unique.
199 local list="$(uniquify $*)"
201 # turn repo list back into an array.
202 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
206 for outer in "${repository_list[@]}"; do
207 # check the repository first, since it might be an absolute path.
208 if [[ $outer =~ /.* ]]; then
209 # yep, this path is absolute. just handle it directly.
210 if [ ! -d "$outer" ]; then continue; fi
211 do_revctrl_checkin "$outer"
212 exit_on_error "running check-in (absolute) on path: $outer"
214 for inner in $list; do
215 # add in the directory component to see if we can find the folder.
216 local path="$inner/$outer"
217 if [ ! -d "$path" ]; then continue; fi
218 do_revctrl_checkin "$path"
219 exit_on_error "running check-in (relative) on path: $path"
225 #hmmm: below functions are git specific and should be named that way.
227 function all_branch_names()
229 echo "$(git branch -vv | cut -d ' ' -f2)"
232 #this had a -> in it at one point for not matching, didn't it?
233 # this reports the upstream branch for the current repo.
234 ##function parent_branch_name()
236 ##echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
239 # a helpful method that reports the git branch for the current directory's
241 function my_branch_name()
243 echo "$(git branch -vv | grep '\*' | cut -d ' ' -f2)"
246 # reports the status of the branch by echoing one of these values:
247 # okay: up to date and everything is good.
248 # needs_pull: this branch needs to be pulled from origins.
249 # needs_push: there are unsaved changes on this branch to push to remote store.
250 # diverged: the branches diverged and are going to need a merge.
251 # reference: https://stackoverflow.com/questions/3258243/check-if-pull-needed-in-git
252 function check_branch_state()
254 local branch="$1"; shift
256 if [ -z "$branch" ]; then
257 echo "No branch was passed to check branch state."
261 local to_return=120 # unknown issue.
263 local local_branch=$(git rev-parse @)
264 local remote_branch=$(git rev-parse "$branch")
265 local merge_base=$(git merge-base @ "$branch")
268 if [ "$local_branch" == "$remote_branch" ]; then
270 elif [ "$local_branch" == "$merge_base" ]; then
272 elif [ "$remote_branch" == "$merge_base" ]; then
283 # only shows the branch state if it's not okay.
284 # note that this is not the same as a conditional branch (ha ha).
285 function show_branch_conditionally()
287 local this_branch="$1"; shift
289 local state=$(check_branch_state "$this_branch")
290 if [ "$state" != "okay" ]; then
291 echo "=> branch '$this_branch' state is not clean: $state"
295 # the git update process just gets more and more complex when you bring in
296 # branches, so we've moved this here to avoid having a ton of code in the
298 function do_revctrl_careful_update()
300 local directory="$1"; shift
301 pushd "$directory" &>/dev/null
302 exit_on_error "changing to directory: $directory"
304 if [ ! -d ".git" ]; then
305 # not a git project, so just boil this down to a getem action.
307 log_feisty_meow_event "skipping careful part and doing simple update on non-git repository: $directory"
308 do_revctrl_simple_update "$directory"
312 #hmmm: another piece of reusable code, to process the directory for printing.
313 # make a nice echoer since we want to use it inside conditions below.
314 local nicedir="$directory"
315 if [ $nicedir == "." ]; then
318 local blatt_report="echo -e \ncarefully retrieving '$nicedir'..."
321 local this_branch="$(my_branch_name)"
323 show_branch_conditionally "$this_branch"
325 # first update all our remote branches to their current state from the repos.
326 git remote update | $TO_SPLITTER
327 promote_pipe_return 0
328 exit_on_error "git remote update"
330 show_branch_conditionally "$this_branch"
332 # this code is now doing what i have to do when i repair the repo. and it seems to be good so far.
333 # note that we allow the local branch to be merged with its remote counterpart; otherwise we would
334 # miss changes that happened elsewhere which should be seen in our local copy.
335 local branch_list=$(all_branch_names)
337 for bran in $branch_list; do
338 log_feisty_meow_event "synchronizing remote branch: $bran"
339 git checkout "$bran" | $TO_SPLITTER
340 promote_pipe_return 0
341 exit_on_error "git switching checkout to remote branch: $bran"
343 show_branch_conditionally "$this_branch"
345 remote_branch_info=$(git ls-remote --heads origin $bran 2>/dev/null)
346 if [ ! -z "$remote_branch_info" ]; then
347 # we are pretty sure the remote branch does exist.
348 git pull --tags origin "$bran" | $TO_SPLITTER
349 promote_pipe_return 0
351 exit_on_error "git pull of remote branch: $bran"
353 # now switch back to our branch.
354 git checkout "$this_branch" | $TO_SPLITTER
355 promote_pipe_return 0
356 exit_on_error "git checking out our current branch: $this_branch"
358 # now pull down any changes in our own origin in the repo, to stay in synch
359 # with any changes from others.
360 git pull --tags --all | $TO_SPLITTER
361 #is the above really important when we did this branch already in the loop?
362 #it does an --all, but is that effective or different? should we be doing that in above loop?
363 promote_pipe_return 0
364 exit_on_error "git pulling all upstream"
369 # gets the latest versions of the assets from the upstream repository.
370 function do_revctrl_simple_update()
372 directory="$1"; shift
374 #hmmm: another piece of reusable code, to process the directory for printing.
375 # make a nice echoer since we want to use it inside conditions below.
376 local nicedir="$directory"
377 if [ $nicedir == "." ]; then
380 local blatt_report="echo -e \nretrieving '$nicedir'..."
382 pushd "$directory" &>/dev/null
383 if [ -d "CVS" ]; then
384 if test_writeable "CVS"; then
386 cvs update . | $TO_SPLITTER
387 promote_pipe_return 0
388 exit_on_error "cvs update"
390 elif [ -d ".svn" ]; then
391 if test_writeable ".svn"; then
393 svn update . | $TO_SPLITTER
394 promote_pipe_return 0
395 exit_on_error "svn update"
397 elif [ -d ".git" ]; then
398 if test_writeable ".git"; then
400 git pull --tags 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
401 promote_pipe_return 0
402 exit_on_error "git pull of origin"
405 # this is not an error necessarily; we'll just pretend they planned this.
406 log_feisty_meow_event "no repository in $directory"
413 # gets all the updates for a list of folders under revision control.
414 function checkout_list()
416 local list="$(uniquify $*)"
418 # turn repo list back into an array.
419 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
423 for outer in "${repository_list[@]}"; do
424 # check the repository first, since it might be an absolute path.
425 if [[ $outer =~ /.* ]]; then
426 # yep, this path is absolute. just handle it directly.
427 if [ ! -d "$outer" ]; then continue; fi
428 do_revctrl_simple_update $outer
429 exit_on_error "running update on: $path"
431 for inner in $list; do
432 # add in the directory component to see if we can find the folder.
433 local path="$inner/$outer"
434 if [ ! -d "$path" ]; then continue; fi
435 do_revctrl_simple_update $path
436 exit_on_error "running update on: $path"
442 # does a careful update on all the folders in the specified list;
443 # it looks in the REPOSITORY_LIST for those names and updates them.
444 # this is just like checkout_list, but it's for the puffing up action
445 # we need to do on git.
446 function puff_out_list()
448 # make the list of directories unique.
449 local list="$(uniquify $*)"
451 # turn repo list back into an array.
452 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
456 #hmmm: once again, seeing some reusable code in this loop...
457 for outer in "${repository_list[@]}"; do
458 # check the repository first, since it might be an absolute path.
459 if [[ $outer =~ /.* ]]; then
460 # yep, this path is absolute. just handle it directly.
461 if [ ! -d "$outer" ]; then continue; fi
462 do_revctrl_careful_update "$outer"
463 exit_on_error "running puff-out (absolute) on path: $outer"
465 for inner in $list; do
466 # add in the directory component to see if we can find the folder.
467 local path="$inner/$outer"
468 if [ ! -d "$path" ]; then continue; fi
469 do_revctrl_careful_update "$path"
470 exit_on_error "running puff-out (relative) on path: $path"
476 # provides a list of absolute paths of revision control directories
477 # that are located under the directory passed as the first parameter.
478 function generate_rev_ctrl_filelist()
480 local dir="$1"; shift
481 pushd "$dir" &>/dev/null
482 local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
483 local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
485 local additional_filter
486 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
487 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
488 # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
491 # see if they've warned us not to try checking in within vendor hierarchies.
492 if [ ! -z "NO_CHECKIN_VENDOR" ]; then
493 sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
496 local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
497 sort <"$tempfile" >"$sortfile"
502 # iterates across a list of directories contained in a file (first parameter).
503 # on each directory name, it performs the action (second parameter) provided.
504 function perform_revctrl_action_on_file()
506 local tempfile="$1"; shift
507 local action="$1"; shift
511 while read -u 3 dirname; do
512 if [ -z "$dirname" ]; then
513 # we often have blank lines in the input file for some reason.
517 pushd "$dirname" &>/dev/null
519 # pass the current directory plus the remaining parameters from function invocation.
521 exit_on_error "performing action $action on: $(pwd)"
525 if [ -z "$did_anything" ]; then
526 echo "There was nothing to do the action '$action' on."