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 # check git version to see if we can use autostash.
15 # this appears to be an ubuntu issue, where xenial did not provide it even though the
16 # feature appeared in git 2.6 and xenial claims it has git version 2.7.4. eventually,
17 # this version test can go away.
18 gitvertest="$(git version | sed -e 's/git version [0-9]\.//' | sed -e 's/\.[0-9][0-9]*$//' )"
19 if (( $gitvertest >= 11 )); then
20 # auto-stash is not available until 2.6 for git, but ubuntu is misreporting or using a
21 # differing version number somehow. we are sure autostash was missing on ubuntu xenial
22 # with git 2.7.4 and it's definitely present in zesty with git at 2.11.
23 # PULL_ADDITION='--rebase --autostash'
24 #although initially attractive, above set of flags seems to lose history we don't want to
31 # the maximum depth that the recursive functions will try to go below the starting directory.
34 # use our splitter tool for lengthy output if it's available.
35 if [ ! -z "$(which splitter 2>/dev/null)" ]; then
36 TO_SPLITTER="$(which splitter)"
37 # calculate the number of columsn in the terminal.
39 TO_SPLITTER+=" --maxcol $(($cols - 1))"
46 #hmmm: move this to core
47 # this makes the status of pipe N into the main return value.
48 function promote_pipe_return()
50 ( exit ${PIPESTATUS[$1]} )
55 # one unpleasantry to take care of first; cygwin barfs aggressively if the TMP directory
56 # is a DOS path, but we need it to be a DOS path for our GFFS testing, so that blows.
57 # to get past this, TMP gets changed below to a hopefully generic and safe place.
58 if [[ "$TMP" =~ .:.* ]]; then
59 log_feisty_meow_event "making weirdo temporary directory for PCDOS-style path."
60 export TMP=/tmp/rev_control_$USER
62 if [ ! -d "$TMP" ]; then
65 if [ ! -d "$TMP" ]; then
66 echo "could not create the temporary directory TMP in: $TMP"
67 echo "this script will not work properly without an existing TMP directory."
69 #hmmm: odd approach to solving the "sourced scripts shouldn't exit or they take down the
70 # original caller too" issue.
71 echo "hit ctrl-c to stay in this shell now, otherwise it may exit in 10 seconds..."
78 # checks the directory provided into the revision control system repository it belongs to.
81 local directory="$1"; shift
85 # make a nice echoer since we want to use it inside conditions below.
86 local nicedir="$directory"
87 if [ $nicedir == "." ]; then
90 local blatt="echo -ne \nchecking in '$nicedir'... "
92 do_update "$directory"
93 exit_on_error "updating repository; this issue should be fixed before check-in."
95 pushd "$directory" &>/dev/null
96 if [ -f ".no-checkin" ]; then
97 echo "skipping check-in due to presence of .no-checkin sentinel file."
98 elif [ -d "CVS" ]; then
99 if test_writeable "CVS"; then
102 exit_on_error "cvs checkin"
104 elif [ -d ".svn" ]; then
105 if test_writeable ".svn"; then
108 exit_on_error "svn checkin"
110 elif [ -d ".git" ]; then
111 if test_writeable ".git"; then
114 # put all changed and new files in the commit. not to everyone's liking.
115 git add --all . | $TO_SPLITTER
116 promote_pipe_return 0
117 exit_on_error "git add all new files"
119 # see if there are any changes in the local repository.
120 if ! git diff-index --quiet HEAD --; then
121 # tell git about all the files and get a check-in comment.
122 #hmmm: begins to look like, you guessed it, a reusable bit that all commit actions could enjoy.
125 continue_on_error "git commit"
126 if [ $retval -ne 0 ]; then
127 echo -e -n "Commit failed or was aborted:\nShould we continue with other check-ins? [y/N] "
130 if [[ "${line:0:1}" != "y" ]]; then
131 echo "Stopping check-in process due to missing commit and user request."
137 # a new set of steps we have to take to make sure the branch integrity is good.
138 do_careful_git_update "$(\pwd)"
140 # we continue on to the push, even if there were no changes this time, because
141 # there could already be committed changes that haven't been pushed yet.
143 # upload any changes to the upstream repo so others can see them.
144 git push --tags origin "$(my_branch_name)" 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
145 promote_pipe_return 0
146 exit_on_error "git push"
150 # nothing there. it's not an error though.
151 log_feisty_meow_event "no repository in $directory"
155 restore_terminal_title
160 # shows the local changes in a repository.
163 local directory="$1"; shift
167 pushd "$directory" &>/dev/null
169 # only update if we see a repository living there.
170 if [ -d ".svn" ]; then
172 exit_on_error "subversion diff"
173 elif [ -d ".git" ]; then
175 exit_on_error "git diff"
176 elif [ -d "CVS" ]; then
178 exit_on_error "cvs diff"
183 restore_terminal_title
188 # reports any files that are not already known to the upstream repository.
189 function do_report_new
191 local directory="$1"; shift
195 pushd "$directory" &>/dev/null
197 # only update if we see a repository living there.
198 if [ -f ".no-checkin" ]; then
199 echo "skipping reporting due to presence of .no-checkin sentinel file."
200 elif [ -d ".svn" ]; then
201 # this action so far only makes sense and is needed for svn.
202 bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
203 exit_on_error "svn diff"
204 elif [ -d ".git" ]; then
206 exit_on_error "git status -u"
211 restore_terminal_title
216 # checks in all the folders in the specified list.
217 function checkin_list()
219 # make the list of directories unique.
220 local list="$(uniquify $*)"
224 # turn repo list back into an array.
225 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
229 for outer in "${repository_list[@]}"; do
230 # check the repository first, since it might be an absolute path.
231 if [[ $outer =~ /.* ]]; then
232 # yep, this path is absolute. just handle it directly.
233 if [ ! -d "$outer" ]; then continue; fi
235 exit_on_error "running check-in (absolute) on path: $outer"
238 for inner in $list; do
239 # add in the directory component to see if we can find the folder.
240 local path="$inner/$outer"
241 if [ ! -d "$path" ]; then continue; fi
243 exit_on_error "running check-in (relative) on path: $path"
249 restore_terminal_title
252 # does a careful update on all the folders in the specified list;
253 # it looks in the REPOSITORY_LIST for those names and updates them.
254 # this is just like checkout_list, but it's for the puffing up action
255 # we need to do on git.
256 function puff_out_list()
258 # make the list of directories unique.
259 local list="$(uniquify $*)"
263 # turn repo list back into an array.
264 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
268 #hmmm: once again, seeing some reusable code in this loop...
269 for outer in "${repository_list[@]}"; do
270 # check the repository first, since it might be an absolute path.
271 if [[ $outer =~ /.* ]]; then
272 # yep, this path is absolute. just handle it directly.
273 if [ ! -d "$outer" ]; then continue; fi
274 do_careful_git_update "$outer"
275 exit_on_error "running puff-out (absolute) on path: $outer"
278 for inner in $list; do
279 # add in the directory component to see if we can find the folder.
280 local path="$inner/$outer"
281 if [ ! -d "$path" ]; then continue; fi
282 do_careful_git_update "$path"
283 exit_on_error "running puff-out (relative) on path: $path"
289 restore_terminal_title
292 #hmmm: below functions are git specific and should be named that way.
294 function all_branch_names()
296 echo "$(git branch -vv | cut -d ' ' -f2)"
299 # a helpful method that reports the git branch for the current directory's
301 function my_branch_name()
303 echo "$(git branch -vv | grep '\*' | cut -d ' ' -f2)"
306 #this had a -> in it at one point for not matching, didn't it?
307 # this reports the upstream branch for the current repo.
308 ##function parent_branch_name()
310 ##echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
313 # reports the status of the branch by echoing one of these values:
314 # okay: up to date and everything is good.
315 # needs_pull: this branch needs to be pulled from origins.
316 # needs_push: there are unsaved changes on this branch to push to remote store.
317 # diverged: the branches diverged and are going to need a merge.
318 # reference: https://stackoverflow.com/questions/3258243/check-if-pull-needed-in-git
319 function check_branch_state()
321 local branch="$1"; shift
323 if [ -z "$branch" ]; then
324 echo "No branch was passed to check branch state."
328 local to_return=120 # unknown issue.
330 local local_branch=$(git rev-parse @)
331 local remote_branch=$(git rev-parse "$branch")
332 local merge_base=$(git merge-base @ "$branch")
335 if [ "$local_branch" == "$remote_branch" ]; then
337 elif [ "$local_branch" == "$merge_base" ]; then
339 elif [ "$remote_branch" == "$merge_base" ]; then
350 # only shows the branch state if it's not okay.
351 # note that this is not the same as a conditional branch (ha ha).
352 function show_branch_conditionally()
354 local this_branch="$1"; shift
356 local state=$(check_branch_state "$this_branch")
357 if [ "$state" != "okay" ]; then
358 echo "=> branch '$this_branch' state is not clean: $state"
362 # the git update process just gets more and more complex when you bring in
363 # branches, so we've moved this here to avoid having a ton of code in the
365 function do_careful_git_update()
367 local directory="$1"; shift
368 pushd "$directory" &>/dev/null
369 exit_on_error "changing to directory: $directory"
371 if [ ! -d ".git" ]; then
372 # not a git project, so just boil this down to a getem action.
374 echo "special case; not doing careful git update on non git repository: $directory"
375 do_update "$directory"
379 local this_branch="$(my_branch_name)"
381 show_branch_conditionally "$this_branch"
383 # first update all our remote branches to their current state from the repos.
384 git remote update | $TO_SPLITTER
385 promote_pipe_return 0
386 exit_on_error "git remote update"
388 show_branch_conditionally "$this_branch"
390 # this code is now doing what i have to do when i repair the repo. and it seems to be good so far.
391 # note that we allow the local branch to be merged with its remote counterpart; otherwise we would
392 # miss changes that happened elsewhere which should be seen in our local copy.
393 local branch_list=$(all_branch_names)
395 for bran in $branch_list; do
396 # echo "synchronizing remote branch: $bran"
397 git checkout "$bran" | $TO_SPLITTER
398 promote_pipe_return 0
399 exit_on_error "git switching checkout to remote branch: $bran"
401 show_branch_conditionally "$this_branch"
403 remote_branch_info=$(git ls-remote --heads origin $bran 2>/dev/null)
404 if [ ! -z "$remote_branch_info" ]; then
405 # we are pretty sure the remote branch does exist.
406 git pull --tags $PULL_ADDITION origin "$bran" | $TO_SPLITTER
407 # we may want to choose to do fast forward, to avoid crazy multiple merge histories
408 # without any changes in them. --no-ff
409 promote_pipe_return 0
411 exit_on_error "git pull of remote branch: $bran"
413 # now switch back to our branch.
414 git checkout "$this_branch" | $TO_SPLITTER
415 promote_pipe_return 0
416 exit_on_error "git checking out our current branch: $this_branch"
418 # now pull down any changes in our own origin in the repo, to stay in synch
419 # with any changes from others.
420 git pull --tags $PULL_ADDITION --all | $TO_SPLITTER
421 #is the above really important when we did this branch already in the loop?
422 #it does an --all, but is that effective or different? should we be doing that in above loop?
424 promote_pipe_return 0
425 exit_on_error "git pulling all upstream"
430 # gets the latest versions of the assets from the upstream repository.
433 directory="$1"; shift
437 # make a nice echoer since we want to use it inside conditions below.
438 local nicedir="$directory"
439 if [ $nicedir == "." ]; then
442 local blatt="echo -e \nretrieving '$nicedir'..."
444 pushd "$directory" &>/dev/null
445 if [ -d "CVS" ]; then
446 if test_writeable "CVS"; then
448 cvs update . | $TO_SPLITTER
449 promote_pipe_return 0
450 exit_on_error "cvs update"
452 elif [ -d ".svn" ]; then
453 if test_writeable ".svn"; then
455 svn update . | $TO_SPLITTER
456 promote_pipe_return 0
457 exit_on_error "svn update"
459 elif [ -d ".git" ]; then
460 if test_writeable ".git"; then
462 git pull --tags $PULL_ADDITION 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
463 #ordinary pulls should be allowed to do fast forward: --no-ff
464 promote_pipe_return 0
465 exit_on_error "git pull of origin"
468 # this is not an error necessarily; we'll just pretend they planned this.
469 log_feisty_meow_event "no repository in $directory"
473 restore_terminal_title
478 # gets all the updates for a list of folders under revision control.
479 function checkout_list()
481 local list="$(uniquify $*)"
485 # turn repo list back into an array.
486 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
490 for outer in "${repository_list[@]}"; do
491 # check the repository first, since it might be an absolute path.
492 if [[ $outer =~ /.* ]]; then
493 # yep, this path is absolute. just handle it directly.
494 if [ ! -d "$outer" ]; then continue; fi
496 exit_on_error "running update on: $path"
499 for inner in $list; do
500 # add in the directory component to see if we can find the folder.
501 local path="$inner/$outer"
502 if [ ! -d "$path" ]; then continue; fi
504 exit_on_error "running update on: $path"
510 restore_terminal_title
513 # provides a list of absolute paths of revision control directories
514 # that are located under the directory passed as the first parameter.
515 function generate_rev_ctrl_filelist()
517 local dir="$1"; shift
518 pushd "$dir" &>/dev/null
519 local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
520 local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
522 local additional_filter
523 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
524 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
525 # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
528 # see if they've warned us not to try checking in within vendor hierarchies.
529 if [ ! -z "NO_CHECKIN_VENDOR" ]; then
530 sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
533 local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
534 sort <"$tempfile" >"$sortfile"
539 # iterates across a list of directories contained in a file (first parameter).
540 # on each directory name, it performs the action (second parameter) provided.
541 function perform_revctrl_action_on_file()
543 local tempfile="$1"; shift
544 local action="$1"; shift
550 while read -u 3 dirname; do
551 if [ -z "$dirname" ]; then
552 # we often have blank lines in the input file for some reason.
556 pushd "$dirname" &>/dev/null
558 # pass the current directory plus the remaining parameters from function invocation.
560 exit_on_error "performing action $action on: $(pwd)"
565 if [ -z "$did_anything" ]; then
566 echo "There was nothing to do the action '$action' on."
569 restore_terminal_title