coderev-0.1/coderev.sh			coderev-0.2/coderev.sh
f	1	#!/bin/bash	f	1	#!/bin/bash
	2	#		2	#
	3	# Homepage: http://code.google.com/p/coderev		3	# Homepage: http://code.google.com/p/coderev
	4	# License: GPLv2, see "COPYING"		4	# License: GPLv2, see "COPYING"
	5	#		5	#
	6	# Generate code review page of <workspace> vs <workspace>@HEAD, by using		6	# Generate code review page of <workspace> vs <workspace>@HEAD, by using
	7	# `codediff.py' - a standalone diff tool		7	# `codediff.py' - a standalone diff tool
	8	#		8	#
n	9	# Usage: coderev.sh [file|subdir ...]	n	9	# Usage: cd your-workspace; coderev.sh [file|subdir ...]
	10	#		10	#
n	11	# $Id: coderev.sh 4 2008-08-19 05:24:24Z mattwyl $	n	11	# $Id: coderev.sh 10 2008-08-23 09:02:26Z mattwyl $
	12			12
	13	PROG_NAME=$(basename $0)		13	PROG_NAME=$(basename $0)
n			n	14	BINDIR=$(cd $(dirname $0) && pwd -L) || exit 1
				15	CODEDIFF=$BINDIR/codediff.py
	14			16
	15	function help		17	function help
	16	{		18	{
	17	cat << EOF		19	cat << EOF
	18			20
	19	Usage:		21	Usage:
n	20	$PROG_NAME [-r revsion] [file|subdir ...]	n	22	$PROG_NAME [-r revsion] [-w width] [file|subdir ...]
	21			23
n	22	\`revision' is a revision number, or symbol (PREV, BASE, HEAD), see svn	n	24	\`revision' is a revision number, or symbol (PREV, BASE, HEAD) in svn,
	23	books for details.  Default revision is revision of your working copy		25	see svn books for details.  Default revision is revision of your working
	24	(aka. BASE)		26	copy
				27
				28	\`width' is a number to make code review pages wrap in specific column
	25			29
	26	Default \`subdir' is working dir.		30	Default \`subdir' is working dir.
	27			31
	28	Example 1:		32	Example 1:
n	29	$PROG_NAME bin lib	n	33	$PROG_NAME -w80 bin lib
	30			34
n	31	Generate coderev based on your working copy.  If you are working on the	n	35	Generate coderev based on your working copy, web pages wrap in column 80.
	32	most up-to-date version, this is suggested way (faster).		36	If you are working on the most up-to-date version, this is suggested way
				37	(faster).
	33			38
n	34	Example 2:	n	39	Example 2 (for SVN):
	35	$PROG_NAME -r HEAD bin lib		40	$PROG_NAME -r HEAD bin lib
	36			41
	37	Generate coderev based on HEAD revision (up-to-date version in repository),		42	Generate coderev based on HEAD revision (up-to-date version in repository),
	38	this will retrive diffs from SVN server so it's slower, but most safely.		43	this will retrive diffs from SVN server so it's slower, but most safely.
	39			44
	40	EOF		45	EOF
	41			46
	42	return 0		47	return 0
	43	}		48	}
	44			49
n			n	50	####################  VCS Operations Begin ####################
				51
				52	# Return code: 0 - Unknown, 1 - SVN, 2 - CVS
				53	#
				54	function detect_vcs
				55	{
				56	[[ -f .svn/entries ]] && return 1
				57	[[ -f CVS/Entries ]] && return 2
				58	return 0
				59	}
				60
				61	function set_vcs_ops
				62	{
				63	local i=${1?}
				64	local vcs_opt=${VCS_OPS_TABLE[i]}
				65
				66	eval vcs_get_banner=\${$vcs_opt[0]}
				67	eval vcs_get_repository=\${$vcs_opt[1]}
				68	eval vcs_get_project_path=\${$vcs_opt[2]}
				69	eval vcs_get_working_revision=\${$vcs_opt[3]}
				70	eval vcs_get_active_list=\${$vcs_opt[4]}
				71	eval vcs_get_diff=\${$vcs_opt[5]}
				72	eval vcs_get_diff_opt=\${$vcs_opt[6]}
				73	}
				74
				75	# VCS Operations:
				76	#   get_banner                        - print banner, return 1 if not supported
				77	#   get_repository                    - print repository
				78	#   get_project_path                  - print project path without repository
				79	#   get_working_revision pathname ... - print working revision
				80	#   get_active_list pathname ...      - print active file list
				81	#   get_diff [diff_opt] pathname ...  - get diffs for active files
				82	#   get_diff_opt                      - print diff option and args
				83
				84	# Unknown ops just defined here, others see libxxx.sh
				85	#
				86	UNKNOWN_OPS=( unknown_get_banner : : : : : : )
				87
				88	function unknown_get_banner
				89	{
				90	echo "unknown"
				91	return 1
				92	}
				93
				94	VCS_OPS_TABLE=( UNKNOWN_OPS  SVN_OPS  CVS_OPS )
				95
				96	. $BINDIR/libsvn.sh || exit 1
				97	. $BINDIR/libcvs.sh || exit 1
				98
				99	# Detect VCS (Version Control System) and set handler
				100	#
				101	detect_vcs
				102	set_vcs_ops $?
				103
				104	####################  VCS Operations End ####################
				105
				106	# Main Proc
				107	#
	45	while getopts "r:h" op; do		108	while getopts "hr:w:" op; do
	46	case $op in		109	case $op in
n	47	r) REV="$OPTARG" ;;	n
	48	h) help; exit 0 ;;		110	h) help; exit 0 ;;
n			n	111	r) REV_ARG="$OPTARG" ;;
				112	w) CODEDIFF_OPT="-w $OPTARG" ;;
	49	?) help; exit 1 ;;		113	?) help; exit 1 ;;
	50	esac		114	esac
	51	done		115	done
n			n	116	shift $((OPTIND - 1))
				117	PATHNAME="${@:-.}"
	52			118
n	53	shift $((OPTIND - 1))	n	119	BANNER=$($vcs_get_banner) || {
	54	SUBDIRS="$@"		120	echo "Unsupported version control system ($BANNER)." >&2
				121	exit 1
				122	}
				123	echo "Version control system \"$BANNER\" detected."
	55			124
n	56	[[ -n "$REV" ]] && SVN_OPT="-r $REV"	n	125	# Retrive information
	57
	58	# Get codediff path
	59	#		126	#
n	60	BINDIR=$(cd $(dirname $0) && pwd -L) || exit 1	n
	61	CODEDIFF=$BINDIR/codediff.py
	62
	63	# Retrive SVN information
	64	#
	65	echo "Retriving SVN information ..."		127	echo "Retriving information ..."
	66	URL=$(svn info | grep '^URL:' | awk '{print $2}') || exit 1		128	PROJ_PATH=$($vcs_get_project_path)
	67	WS_NAME=$(basename "$URL")		129	WS_NAME=$(basename $PROJ_PATH)
	68	WS_REV=$(svn info | grep 'Revision:' | awk '{print $2}') || exit 1		130	WS_REV=$($vcs_get_working_revision $PATHNAME)
	69	BASE_REV=$(svn info $SVN_OPT | grep 'Revision:' | awk '{print $2}') || exit 1		131	echo "Repository       : $($vcs_get_repository)"
	70	echo "URL     : $URL"		132	echo "Project path     : $PROJ_PATH"
	71	echo "WS_REV  : $WS_REV"		133	echo "Working revision : $WS_REV"
	72	echo "BASE_REV: $BASE_REV"
	73
	74			134
	75	# Prepare file list and base source		135	# Prepare file list and base source
	76	#		136	#
n	77	LIST=$(mktemp /tmp/list.XXXXXX) || exit 1	n
	78	DIFF=$(mktemp /tmp/diff.XXXXXX) || exit 1		137	TMPDIR=$(mktemp -d /tmp/coderev.XXXXXX) || exit 1
	79	BASE_SRC="/tmp/${WS_NAME}@${BASE_REV}"		138	LIST="$TMPDIR/activelist"
				139	DIFF="$TMPDIR/diffs"
				140	BASE_SRC="$TMPDIR/$WS_NAME-base"
	80			141
n	81	for file in $(svn st $SUBDIRS | grep '^[A-Z]' | awk '{print $2}'); do	n	142	$vcs_get_active_list $PATHNAME > $LIST || exit 1
	82	[[ -d $file ]] && continue		143	echo "==========  Active file list  =========="
	83	echo $file >> $LIST || exit 1		144	cat $LIST
	84	done		145	echo "========================================"
	85			146
n	86	echo "Active file list:"	n	147	# Generate $BASE_SRC
	87	echo "============================"
	88	cat $LIST
	89	echo "============================"
	90
	91	# Generate $base_src
	92	#		148	#
	93	mkdir -p $BASE_SRC || exit 1		149	mkdir -p $BASE_SRC || exit 1
	94	tar -cf - $(cat $LIST) | tar -C $BASE_SRC -xf - || exit 1		150	tar -cf - $(cat $LIST) | tar -C $BASE_SRC -xf - || exit 1
	95			151
	96	echo "Retriving diffs ..."		152	echo "Retriving diffs ..."
n			n	153	VCS_REV_OPT=""
				154	[[ -n $REV_ARG ]] && VCS_REV_OPT="$($vcs_get_diff_opt $REV_ARG)"
	97	svn diff $SVN_OPT $(cat $LIST) > $DIFF || exit 1		155	$vcs_get_diff $VCS_REV_OPT $(cat $LIST) > $DIFF || exit 1
	98	cat $DIFF | patch -NER -p0 -d $BASE_SRC || exit 1		156	patch -NER -p0 -d $BASE_SRC < $DIFF || exit 1
	99			157
	100	# Generate coderev		158	# Generate coderev
	101	#		159	#
n	102	CODEREV=/tmp/${WS_NAME}-diff-${BASE_REV}	n	160	echo "Generating code review ..."
	103	cat $LIST | $CODEDIFF -o $CODEREV -w80 -y -f- $BASE_SRC . || exit 1		161	CODEREV=$TMPDIR/${WS_NAME}-r${WS_REV}-diff
	104			162	$CODEDIFF $CODEDIFF_OPT -o $CODEREV -y -f- $BASE_SRC . < $LIST || exit 1
	105	echo
	106	echo "Coderev generated under $CODEREV"		163	echo "Coderev pages generated at $CODEREV"
	107	echo		164	echo
	108			165
	109	# Cleanup		166	# Cleanup
	110	#		167	#
	111	rm -rf $LIST $DIFF $BASE_SRC		168	rm -rf $LIST $DIFF $BASE_SRC
	112			169
n			n	170	# Copy to web host
				171	#
				172	[[ -r ~/.coderevrc ]] || {
				173	echo "[*] Hint: if you want to copy coderev pages to a remote host"
				174	echo "    automatically, see coderevrc.sample"
				175	echo
				176	exit 0
				177	}
	113			178
n	114	##############################################################################	n	179	. ~/.coderevrc || {
	115	#		180	echo "Reading ~/.coderevrc failed." >&2
	116	# Customize your webdir to save coderev:		181	exit 1
	117	#		182	}
	118	# 1. define WEBHOST, SSH_USER, HOST_DIR and WEBDIR
	119	# 2. Comment out the line ":<< \__copy_to_webserver__" below
	120	#
	121	##############################################################################
	122			183
n	123	: << __copy_to_webserver__	n	184	: ${WEB_HOST?"WEB_HOST not defined."}
				185	: ${SSH_USER?"SSH_USER not defined."}
				186	: ${HOST_DIR?"HOST_DIR not defined."}
				187	: ${WEB_URL?"WEB_URL not defined."}
	124			188
n	125	WEBHOST=example.org	n
	126	SSH_USER=me
	127	HOST_DIR='~/public_html/coderev'
	128	WEBDIR="http://$WEBHOST/~$SSH_USER/coderev"
	129
	130	scp -r $CODEREV ${SSH_USER}@${WEBHOST}:$HOST_DIR/ || exit 1		189	scp -r $CODEREV ${SSH_USER}@${WEB_HOST}:$HOST_DIR/ || exit 1
	131			190
	132	echo		191	echo
	133	echo "Coderev link:"		192	echo "Coderev link:"
n	134	echo "$WEBDIR/$(basename $CODEREV)"	n	193	echo "$WEB_URL/$(basename $CODEREV)"
	135	echo		194	echo
	136			195
	137	exit 0		196	exit 0
t	138		t
	139	__copy_to_webserver__

Legends
Colors  Added  Changed Deleted	Links (f)irst change (n)ext change (t)op