3 # This script called in a CVS directory compares local files with
4 # the repository, and prepares an update package containing all
5 # changes and new files for submission to a CVS maintainer. If there
6 # are only changes in text files, then a compressed unified diff is
7 # made (foo.diff.bz2). If there are also changed binary or new files,
8 # then an archive is made instead (foo.tar.bz2). The base name ("foo")
9 # can be given as command line argument. Otherwise the directory name
10 # is used. The script also leaves a diff in uncompressed/unpackaged
11 # form. This is only for developer convenience -- for a quick check
12 # of the diff correctness. It is not to be submitted. The script will
13 # not overwrite any file, but rather rename conflicting files.
15 # Usage: fg-submit [-v] [<basename>]
18 # -v ... verbose output
21 # $ cd $FG_ROOT/Aircraft/bo105
22 # $ fg-submit # -> bo105.diff.bz2 or bo105.tar.bz2
24 # $ fg-submit update # -> update.diff.bz2 or update.tar.bz2
27 # Spaces in the basename are replaced with "%20". People who prefer
28 # to have the date in the archive name can conveniently achieve this
29 # by defining a shell alias in ~/.bashrc:
31 # alias submit='fg-submit "${PWD/#*\/}-$(date +%Y-%m-%d)"'
35 # If the script finds an application named "fg-upload", then it calls
36 # this at the end with two arguments:
38 # $1 ... archive or compressed diff for submission
39 # $2 ... accessory diff, *NOT* for submission!
41 # $1 and $2 are guaranteed not to contain spaces, only $1 is guaranteed
42 # to actually exist. Such as script can be used to upload the file to an
43 # ftp-/webserver, and/or to remove one or both files. Example using
44 # KDE's kfmclient for upload (alternatives: ncftpput, gnomevfs-copy, wput):
46 # $ cat ~/bin/fg-upload
49 # if kfmclient copy $1 ftp://user:password@server.com; then
50 # echo "deleting $1 $2"
53 # echo "Done. URL: ftp://server.com/$1"
55 # echo "arghh ... HELP! HELP!"
60 # Whether a file should be included in the archive or not, is decided
61 # by pattern rules. There is a set of reasonable default rules predefined,
62 # but alternative settings can be defined in a hidden configuration file
63 # named ".fg-submit". Such a file is searched in the current directory,
64 # in its parent directory, in its grand-parent directory and so on,
65 # and finally in the $HOME directory. The first found file is taken.
67 # A file can use a list of four keywords with arguments, each on a
70 # ALLOW <pattern-list> ... accept & report matching file
71 # DENY <pattern-list> ... reject & report matching file
72 # IGNORE <pattern-list> ... silently reject matching file
73 # DEFAULT ... adds default rules
75 # A <pattern-list> is a space-separated list of shell pattern.
76 # It may also be empty, in which case it has no effect. Examples:
81 # A config file that only contains the keyword DEFAULT causes the
82 # same behavior as no config file at all. A config file without
83 # DEFAULT drops the built-in default rules (with the exception of
84 # a few very basic ones, such as rejection of CVS files). Comments
85 # using the hash character '#' are allowed and ignored.
87 # The list of pattern is checked in the same in order in which it
88 # is built. The first match causes a file to be accepted or rejected.
89 # Further matches are not considered.
93 # DENY test.xcf # throw out the test graphic, but ...
94 # ALLOW *.xcf # ... allow all other GIMP graphics (the following
95 # # DEFAULT keyword throws them out otherwise)
97 # DEFAULT # insert the default rules here
99 # ALLOW g.old # add this silly file :-)
100 # IGNORE *.old # throw out the old files (and don't report
101 # # that to the terminal)
103 # .fg-submit configuration files are sourced bash scripts, the
104 # keywords are simple shell functions. That means that you can
105 # also use other bash commands in that file, such as "echo".
112 if [ "$1" == "-v" ]; then
120 CVS=/usr/bin/cvs # avoid colorcvs wrapper from
121 [ -x $CVS ] || CVS=cvs # http://www.hakubi.us/colorcvs/
122 UPLOAD=$(which fg-upload 2>/dev/null)
124 ARCHIVE=$BASE.tar.bz2
128 # these rules are always prepended (the leading ! makes silent rejects)
130 !$DIFF* !$CDIFF* !$ARCHIVE*
133 # these rules are used when no other rules are specified,
134 # and wherever the DEFAULT keyword is used
136 +.cvsignore +*/.cvsignore
137 -*~ -*. -*.bak -*.orig
138 -*.RGB -*.RGBA -*.MDL
139 -*.xcf -*.XCF -*.tga -*.TGA -*.bmp -*.BMP -*.png -*.PNG
140 -*.blend -*.blend[0-9] -*blend[0-9][0-9] -*.blend[0-9][0-9][0-9]
141 -*.gz -*.tgz -*.bz2 -*.zip -*.tar.gz* -*.tar.bz2*
143 # these rules are always appended; the last one accepts anything
144 # (throw out all hidden files that weren't explicitly allowed, and
152 function ERROR { echo -e "\e[31;1m$*\e[m"; }
153 function LOG { echo -e "\e[35m$*\e[m"; }
154 function NEW { echo -e "\e[32m\t+ $*\e[m"; }
155 function CHANGED { echo -e "\e[36m\t+ $*\e[m"; }
156 function REJECT { echo -e "\e[31m\t- $*\e[m"; }
157 function DEBUG { [ $DBG ] && echo -e "$*"; }
160 # output diff statistics, similar to the "diffstat" utility
162 function line(a, r, c, f) {
163 print "\t\033[32m"a"\033[m\t\033[31m"r"\033[m\t\033[34m"c"\033[m\t"f
170 print "\t. . . . binary . . . . \033[36m"file"\033[m"
173 at += a; rt += r; ct += c
178 print "\tadded---removed-changed----------------------------------------"
179 a = r = c = at = rt = ct = n = bin = 0
181 /^Index: / { dofile(); scan = bin = 0; file = $2; n++; next }
182 /^@@/ { scan = 1; next }
183 /^Binary/ { if (!scan) bin = 1; next }
184 /^\+/ { if (scan) a++; next }
185 /^-/ { if (scan) r++; next }
186 /^!/ { if (scan) c++; next }
189 print "\t----------------------------------------total------------------"
190 line(at, rt, ct, "\033[min "n" files")
196 # set up accept/reject rules
197 function DEFAULT { RULES="$RULES $DEFAULT_RULES"; }
198 function ALLOW { for i in $*; do RULES="$RULES +$i"; done }
199 function DENY { for i in $*; do RULES="$RULES -$i"; done }
200 function IGNORE { for i in $*; do RULES="$RULES !$i"; done }
205 if [ -f .fg-submit ]; then
206 CONFIG="$PWD/.fg-submit"
210 [ "$PWD" == "/" ] && break
214 if [ "$CONFIG" ]; then
215 DEBUG "reading config $CONFIG"
217 elif [ -f ~/.fg-submitrc ]; then
218 DEBUG "reading config ~/.fg-submitrc"
219 source ~/.fg-submitrc
221 DEBUG "no config file found; using default rules"
222 RULES="$RULES $DEFAULT_RULES"
224 RULES="$PREFIX_RULES $RULES $POSTFIX_RULES"
225 DEBUG "using these rules: $RULES"
228 # create temporary dir that's automatically removed on exit
229 TMP=$(mktemp -d /tmp/$SELF.$BASE.XXXXXX) || (echo "$0: can't create temporary dir"; exit 1)
230 trap "rm -rf $TMP" 0 1 2 3 13 15
233 # move old files out of the way
234 for i in $DIFF $CDIFF $ARCHIVE; do
235 [ -f $i ] && mv $i $(mktemp $i.XXXXXX)
239 LOG "updating and checking for new files ..."
240 $CVS -q up -dP >$TMP/up
243 if grep "^C " $TMP/up &>/dev/null; then
244 ERROR "there are conflicts with the following files:"
250 LOG "making diff ..."
251 if ! $CVS -q diff -up >$DIFF; then
252 LOG "diff statistics:"
256 # add diff file itself
257 echo $DIFF >>$TMP/files
259 # add changed binary files
261 /^Index: / { scan = 1; file = $2; next }
262 /^@@/ { scan = 0; next }
263 /^Binary/ { if (scan) { print file } }
264 ' <$DIFF >>$TMP/files
270 LOG "checking for files to submit ..."
271 if [ -f $TMP/files ]; then
272 cat $TMP/files|while read i; do
277 grep "^? " $TMP/up|while read i; do
278 find ${i#? } -type f >>$TMP/check
282 # classify and filter files
283 if [ -f $TMP/check ]; then
284 for i in $(cat $TMP/check); do
285 DEBUG "checking whether file '$i' matches"
290 DEBUG "\t\t\t\"silently\" rejected\t\t(rule $R)"
295 REJECT "$i\t\t(rule $R)"
300 NEW "$i\t\t(rule $R)"
301 echo "$i" >>$TMP/files
310 if ! [ -f $TMP/files ]; then
311 LOG "no changed or new files found"
316 numfiles=$(awk '//{n++}END{print n}' <$TMP/files)
317 if [ -f $DIFF -a $numfiles == 1 ]; then
318 LOG "only changed non-binary files found"
319 LOG "creating compressed diff \e[1;37;40m$CDIFF\e[m\e[35m ..."
323 LOG "changed and/or new files found"
324 LOG "creating archive \e[1;37;40m$ARCHIVE\e[m\e[35m ..."
325 tar -cjf $ARCHIVE --files-from $TMP/files
329 [ -x "$UPLOAD" -a -f $RESULT ] && $UPLOAD $RESULT $DIFF