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)" ]; then
19 TO_SPLITTER="$(which splitter)"
26 # one unpleasantry to take care of first; cygwin barfs aggressively if the TMP directory
27 # is a DOS path, but we need it to be a DOS path for our GFFS testing, so that blows.
28 # to get past this, TMP gets changed below to a hopefully generic and safe place.
29 if [[ "$TMP" =~ .:.* ]]; then
30 echo "making weirdo temporary directory for PCDOS-style path."
31 export TMP=/tmp/rev_control_$USER
33 if [ ! -d "$TMP" ]; then
36 if [ ! -d "$TMP" ]; then
37 echo "could not create the temporary directory TMP in: $TMP"
38 echo "this script will not work properly without an existing TMP directory."
43 # checks the directory provided into the revision control system repository it belongs to.
46 local directory="$1"; shift
50 # make a nice echoer since we want to use it inside conditions below.
51 local nicedir="$directory"
52 if [ $nicedir == "." ]; then
55 local blatt="echo checking in '$nicedir'..."
57 do_update "$directory"
58 test_or_die "repository update--this should be fixed before check-in."
60 pushd "$directory" &>/dev/null
61 if [ -f ".no-checkin" ]; then
62 echo "skipping check-in due to presence of .no-checkin sentinel file."
63 elif [ -d "CVS" ]; then
64 if test_writeable "CVS"; then
67 test_or_die "cvs checkin"
69 elif [ -d ".svn" ]; then
70 if test_writeable ".svn"; then
73 test_or_die "svn checkin"
75 elif [ -d ".git" ]; then
76 if test_writeable ".git"; then
79 # put all changed and new files in the commit. not to everyone's liking.
81 test_or_die "git add all new files"
83 # see if there are any changes in the local repository.
84 if ! git diff-index --quiet HEAD --; then
85 # tell git about all the files and get a check-in comment.
87 test_or_die "git commit"
90 # a new set of steps we have to take to make sure the branch integrity is good.
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.
96 # upload any changes to the upstream repo so others can see them.
97 git push origin "$(my_branch_name)" 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
98 test_or_die "git push"
102 # nothing there. it's not an error though.
103 echo no repository in $directory
107 restore_terminal_title
112 # shows the local changes in a repository.
115 local directory="$1"; shift
119 pushd "$directory" &>/dev/null
121 # only update if we see a repository living there.
122 if [ -d ".svn" ]; then
124 test_or_die "subversion diff"
125 elif [ -d ".git" ]; then
127 test_or_die "git diff"
128 elif [ -d "CVS" ]; then
130 test_or_die "cvs diff"
135 restore_terminal_title
140 # reports any files that are not already known to the upstream repository.
141 function do_report_new
143 local directory="$1"; shift
147 pushd "$directory" &>/dev/null
149 # only update if we see a repository living there.
150 if [ -f ".no-checkin" ]; then
151 echo "skipping reporting due to presence of .no-checkin sentinel file."
152 elif [ -d ".svn" ]; then
153 # this action so far only makes sense and is needed for svn.
154 bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
155 test_or_die "svn diff"
156 elif [ -d ".git" ]; then
158 test_or_die "git status -u"
163 restore_terminal_title
168 # checks in all the folders in a specified list.
169 function checkin_list()
171 # make the list of directories unique.
172 local list="$(uniquify $*)"
176 # turn repo list back into an array.
177 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
181 for outer in "${repository_list[@]}"; do
182 # check the repository first, since it might be an absolute path.
183 if [[ $outer =~ /.* ]]; then
184 # yep, this path is absolute. just handle it directly.
185 if [ ! -d "$outer" ]; then continue; fi
187 test_or_die "running check-in (absolute) on path: $outer"
190 for inner in $list; do
191 # add in the directory component to see if we can find the folder.
192 local path="$inner/$outer"
193 if [ ! -d "$path" ]; then continue; fi
195 test_or_die "running check-in (relative) on path: $path"
201 restore_terminal_title
204 # takes out the first few carriage returns that are in the input.
205 function squash_first_few_crs()
208 while read input_text; do
210 if [ $i -le 5 ]; then
211 echo -n "$input_text "
216 if [ $i -le 3 ]; then
217 # if we're still squashing eols, make sure we don't leave them hanging.
222 #hmmm: the below are git specific and should be named that way.
224 function all_branch_names()
226 echo "$(git branch -vv | cut -d ' ' -f2)"
229 # a helpful method that reports the git branch for the current directory's
231 function my_branch_name()
233 echo "$(git branch -vv | grep '\*' | cut -d ' ' -f2)"
236 #this had a -> in it at one point for not matching, didn't it?
237 # this reports the upstream branch for the current repo.
238 ##function parent_branch_name()
240 ##echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
243 # this exits with 0 for success (normal bash behavior) when up to date. if the branch is not up to date,
244 # then these values are returned:
246 # reference: https://stackoverflow.com/questions/3258243/check-if-pull-needed-in-git
247 function check_branch_state()
249 local branch="$1"; shift
251 local to_return=120 # unknown issue.
255 LOCAL=$(git rev-parse @)
256 REMOTE=$(git rev-parse "$branch")
257 BASE=$(git merge-base @ "$branch")
258 var branch LOCAL REMOTE BASE
260 if [ "$LOCAL" == "$REMOTE" ]; then
263 elif [ "$LOCAL" == "$BASE" ]; then
266 elif [ "$REMOTE" == "$BASE" ]; then
279 # the git update process just gets more and more complex when you bring in
280 # branches, so we've moved this here to avoid having a ton of code in the
282 function do_careful_git_update()
284 local this_branch="$(my_branch_name)"
286 # first update all our remote branches to their current state from the repos.
288 test_or_die "git remote update"
290 #appears to be useless; reports no changes when we need to know about remote changes that do exist:
291 # check_branch_state "$this_branch"
293 # test_or_continue "branch state check"
294 # echo the branch state is $state
296 # this code is now doing what i have to do when i repair the repo. and it seems to be good so far.
297 local branch_list=$(all_branch_names)
299 for bran in $branch_list; do
300 # echo "synchronizing remote branch: $bran"
302 test_or_die "git switching checkout to remote branch: $bran"
303 remote_branch_info=$(git ls-remote --heads origin $bran 2>/dev/null)
304 if [ ! -z "$remote_branch_info" ]; then
305 # we are pretty sure the remote branch does exist.
306 git pull --no-ff origin "$bran"
308 test_or_die "git pull of remote branch: $bran"
310 # now switch back to our branch.
311 git checkout "$this_branch"
312 test_or_die "git checking out our current branch: $this_branch"
314 # now pull down any changes in our own origin in the repo, to stay in synch
315 # with any changes from others.
316 git pull --no-ff --all
317 test_or_die "git pulling all upstream"
320 # gets the latest versions of the assets from the upstream repository.
323 directory="$1"; shift
327 # make a nice echoer since we want to use it inside conditions below.
328 local nicedir="$directory"
329 if [ $nicedir == "." ]; then
332 local blatt="echo retrieving '$nicedir'..."
334 pushd "$directory" &>/dev/null
335 if [ -d "CVS" ]; then
336 if test_writeable "CVS"; then
338 cvs update . | $TO_SPLITTER
339 test_or_die "cvs update"
341 elif [ -d ".svn" ]; then
342 if test_writeable ".svn"; then
344 svn update . | $TO_SPLITTER
345 test_or_die "svn update"
347 elif [ -d ".git" ]; then
348 if test_writeable ".git"; then
350 git pull --no-ff 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
351 if [ ${PIPESTATUS[0]} -ne 0 ]; then false; fi
352 test_or_die "git pull of origin without fast forwards"
355 # this is not an error necessarily; we'll just pretend they planned this.
356 echo no repository in $directory
360 restore_terminal_title
365 # gets all the updates for a list of folders under revision control.
366 function checkout_list()
368 local list="$(uniquify $*)"
372 # turn repo list back into an array.
373 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
377 for outer in "${repository_list[@]}"; do
378 # check the repository first, since it might be an absolute path.
379 if [[ $outer =~ /.* ]]; then
380 # yep, this path is absolute. just handle it directly.
381 if [ ! -d "$outer" ]; then continue; fi
383 test_or_die "running update on: $path"
386 for inner in $list; do
387 # add in the directory component to see if we can find the folder.
388 local path="$inner/$outer"
389 if [ ! -d "$path" ]; then continue; fi
391 test_or_die "running update on: $path"
397 restore_terminal_title
400 # provides a list of absolute paths of revision control directories
401 # that are located under the directory passed as the first parameter.
402 function generate_rev_ctrl_filelist()
404 local dir="$1"; shift
405 pushd "$dir" &>/dev/null
406 local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
407 local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
409 local additional_filter
410 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
411 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
412 # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
415 # see if they've warned us not to try checking in within vendor hierarchies.
416 if [ ! -z "NO_CHECKIN_VENDOR" ]; then
417 sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
420 local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
421 sort <"$tempfile" >"$sortfile"
426 # iterates across a list of directories contained in a file (first parameter).
427 # on each directory name, it performs the action (second parameter) provided.
428 function perform_revctrl_action_on_file()
430 local tempfile="$1"; shift
431 local action="$1"; shift
437 while read -u 3 dirname; do
438 if [ -z "$dirname" ]; then
439 # we often have blank lines in the input file for some reason.
443 pushd "$dirname" &>/dev/null
446 test_or_die "performing action $action on: $(pwd)"
451 if [ -z "$did_anything" ]; then
452 echo "There was nothing to do the action '$action' on."
455 restore_terminal_title