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 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 # a helpful method that reports the git branch for the current directory's
224 function my_branch_name()
226 echo "$(git branch | grep '\*' | cut -d ' ' -f2)"
229 #this had a -> in it at one point for not matching, didn't it?
230 # this reports the upstream branch for the current repo.
231 ##function parent_branch_name()
233 ##echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
236 # this exits with 0 for success (normal bash behavior) when up to date. if the branch is not up to date,
237 # then these values are returned:
239 # reference: https://stackoverflow.com/questions/3258243/check-if-pull-needed-in-git
240 function check_branch_state()
242 local branch="$1"; shift
244 local to_return=120 # unknown issue.
248 LOCAL=$(git rev-parse @)
249 REMOTE=$(git rev-parse "$branch")
250 BASE=$(git merge-base @ "$branch")
251 var branch LOCAL REMOTE BASE
253 if [ "$LOCAL" == "$REMOTE" ]; then
256 elif [ "$LOCAL" == "$BASE" ]; then
259 elif [ "$REMOTE" == "$BASE" ]; then
272 # the git update process just gets more and more complex when you bring in
273 # branches, so we've moved this here to avoid having a ton of code in the
275 function careful_git_update()
277 local this_branch="$(my_branch_name)"
279 #appears to be useless; reports no changes when we need to know about remote changes that do exist:
280 # check_branch_state "$this_branch"
282 # test_or_continue "branch state check"
283 # echo the branch state is $state
285 # the above are just not enough. this code is now doing what i have to do when i repair the repo.
286 local branch_list=$(git branch |grep -v '^\*')
288 for bran in $branch_list; do
289 echo "synchronizing remote branch: $bran"
291 test_or_die "git checking out remote branch: $bran"
293 test_or_die "git pull of remote branch: $bran"
295 # now switch back to our branch.
296 git checkout "$this_branch"
297 test_or_die "git checking out our current branch: $this_branch"
299 # first update all our remote branches to their current state from the repos.
301 test_or_die "git remote update"
303 # now pull down any changes in our own origin in the repo, to stay in synch
304 # with any changes from others.
305 git pull --no-ff --all
306 test_or_die "git pulling all upstream"
309 # gets the latest versions of the assets from the upstream repository.
312 directory="$1"; shift
316 # make a nice echoer since we want to use it inside conditions below.
317 local nicedir="$directory"
318 if [ $nicedir == "." ]; then
321 local blatt="echo retrieving '$nicedir'..."
323 pushd "$directory" &>/dev/null
324 if [ -d "CVS" ]; then
325 if test_writeable "CVS"; then
327 cvs update . | $TO_SPLITTER
328 test_or_die "cvs update"
330 elif [ -d ".svn" ]; then
331 if test_writeable ".svn"; then
333 svn update . | $TO_SPLITTER
334 test_or_die "svn update"
336 elif [ -d ".git" ]; then
337 if test_writeable ".git"; then
339 git pull --no-ff origin 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
340 if [ ${PIPESTATUS[0]} -ne 0 ]; then false; fi
341 test_or_die "git pull of origin without fast forwards"
344 # this is not an error necessarily; we'll just pretend they planned this.
345 echo no repository in $directory
349 restore_terminal_title
354 # gets all the updates for a list of folders under revision control.
355 function checkout_list()
357 local list="$(uniquify $*)"
361 # turn repo list back into an array.
362 eval "repository_list=( ${REPOSITORY_LIST[*]} )"
366 for outer in "${repository_list[@]}"; do
367 # check the repository first, since it might be an absolute path.
368 if [[ $outer =~ /.* ]]; then
369 # yep, this path is absolute. just handle it directly.
370 if [ ! -d "$outer" ]; then continue; fi
372 test_or_die "running update on: $path"
375 for inner in $list; do
376 # add in the directory component to see if we can find the folder.
377 local path="$inner/$outer"
378 if [ ! -d "$path" ]; then continue; fi
380 test_or_die "running update on: $path"
386 restore_terminal_title
389 # provides a list of absolute paths of revision control directories
390 # that are located under the directory passed as the first parameter.
391 function generate_rev_ctrl_filelist()
393 local dir="$1"; shift
394 pushd "$dir" &>/dev/null
395 local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
396 local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
398 local additional_filter
399 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
400 find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
401 # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
404 # see if they've warned us not to try checking in within vendor hierarchies.
405 if [ ! -z "NO_CHECKIN_VENDOR" ]; then
406 sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
409 local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
410 sort <"$tempfile" >"$sortfile"
415 # iterates across a list of directories contained in a file (first parameter).
416 # on each directory name, it performs the action (second parameter) provided.
417 function perform_revctrl_action_on_file()
419 local tempfile="$1"; shift
420 local action="$1"; shift
424 while read -u 3 dirname; do
425 if [ -z "$dirname" ]; then continue; fi
426 pushd "$dirname" &>/dev/null
429 test_or_die "performing action $action on: $(pwd)"
434 restore_terminal_title