[thirdparty/git.git] / git-instaweb.sh

#!/bin/sh
#
# Copyright (c) 2006 Eric Wong
#
USAGE='[--start] [--stop] [--restart]
  [--local] [--httpd=<httpd>] [--port=<port>] [--browser=<browser>]
  [--module-path=<path> (for Apache2 only)]'

. git-sh-setup

fqgitdir="$GIT_DIR"
local="`git config --bool --get instaweb.local`"
httpd="`git config --get instaweb.httpd`"
browser="`git config --get instaweb.browser`"
port=`git config --get instaweb.port`
module_path="`git config --get instaweb.modulepath`"

conf=$GIT_DIR/gitweb/httpd.conf

# Defaults:

# if installed, it doesn't need further configuration (module_path)
test -z "$httpd" && httpd='lighttpd -f'

# probably the most popular browser among gitweb users
test -z "$browser" && browser='firefox'

# any untaken local port will do...
test -z "$port" && port=1234

start_httpd () {
	httpd_only="`echo $httpd | cut -f1 -d' '`"
	if case "$httpd_only" in /*) : ;; *) which $httpd_only >/dev/null;; esac
	then
		$httpd $fqgitdir/gitweb/httpd.conf
	else
		# many httpds are installed in /usr/sbin or /usr/local/sbin
		# these days and those are not in most users $PATHs
		# in addition, we may have generated a server script
		# in $fqgitdir/gitweb.
		for i in /usr/local/sbin /usr/sbin "$fqgitdir/gitweb"
		do
			if test -x "$i/$httpd_only"
			then
				# don't quote $httpd, there can be
				# arguments to it (-f)
				$i/$httpd "$fqgitdir/gitweb/httpd.conf"
				return
			fi
		done
		echo "$httpd_only not found. Install $httpd_only or use" \
		     "--httpd to specify another http daemon."
		exit 1
	fi
	if test $? != 0; then
		echo "Could not execute http daemon $httpd."
		exit 1
	fi
}

stop_httpd () {
	test -f "$fqgitdir/pid" && kill `cat "$fqgitdir/pid"`
}

while test $# != 0
do
	case "$1" in
	--stop|stop)
		stop_httpd
		exit 0
		;;
	--start|start)
		start_httpd
		exit 0
		;;
	--restart|restart)
		stop_httpd
		start_httpd
		exit 0
		;;
	--local|-l)
		local=true
		;;
	-d|--httpd|--httpd=*)
		case "$#,$1" in
		*,*=*)
			httpd=`expr "$1" : '-[^=]*=\(.*\)'` ;;
		1,*)
			usage ;;
		*)
			httpd="$2"
			shift ;;
		esac
		;;
	-b|--browser|--browser=*)
		case "$#,$1" in
		*,*=*)
			browser=`expr "$1" : '-[^=]*=\(.*\)'` ;;
		1,*)
			usage ;;
		*)
			browser="$2"
			shift ;;
		esac
		;;
	-p|--port|--port=*)
		case "$#,$1" in
		*,*=*)
			port=`expr "$1" : '-[^=]*=\(.*\)'` ;;
		1,*)
			usage ;;
		*)
			port="$2"
			shift ;;
		esac
		;;
	-m|--module-path=*|--module-path)
		case "$#,$1" in
		*,*=*)
			module_path=`expr "$1" : '-[^=]*=\(.*\)'` ;;
		1,*)
			usage ;;
		*)
			module_path="$2"
			shift ;;
		esac
		;;
	*)
		usage
		;;
	esac
	shift
done

mkdir -p "$GIT_DIR/gitweb/tmp"
GIT_EXEC_PATH="`git --exec-path`"
GIT_DIR="$fqgitdir"
export GIT_EXEC_PATH GIT_DIR


webrick_conf () {
	# generate a standalone server script in $fqgitdir/gitweb.
	cat >"$fqgitdir/gitweb/$httpd.rb" <<EOF
require 'webrick'
require 'yaml'
options = YAML::load_file(ARGV[0])
options[:StartCallback] = proc do
  File.open(options[:PidFile],"w") do |f|
    f.puts Process.pid
  end
end
options[:ServerType] = WEBrick::Daemon
server = WEBrick::HTTPServer.new(options)
['INT', 'TERM'].each do |signal|
  trap(signal) {server.shutdown}
end
server.start
EOF
	# generate a shell script to invoke the above ruby script,
	# which assumes _ruby_ is in the user's $PATH. that's _one_
	# portable way to run ruby, which could be installed anywhere,
	# really.
	cat >"$fqgitdir/gitweb/$httpd" <<EOF
#!/bin/sh
exec ruby "$fqgitdir/gitweb/$httpd.rb" \$*
EOF
	chmod +x "$fqgitdir/gitweb/$httpd"

	cat >"$conf" <<EOF
:Port: $port
:DocumentRoot: "$fqgitdir/gitweb"
:DirectoryIndex: ["gitweb.cgi"]
:PidFile: "$fqgitdir/pid"
EOF
	test "$local" = true && echo ':BindAddress: "127.0.0.1"' >> "$conf"
}

lighttpd_conf () {
	cat > "$conf" <<EOF
server.document-root = "$fqgitdir/gitweb"
server.port = $port
server.modules = ( "mod_cgi" )
server.indexfiles = ( "gitweb.cgi" )
server.pid-file = "$fqgitdir/pid"
cgi.assign = ( ".cgi" => "" )
mimetype.assign = ( ".css" => "text/css" )
EOF
	test "$local" = true && echo 'server.bind = "127.0.0.1"' >> "$conf"
}

apache2_conf () {
	test -z "$module_path" && module_path=/usr/lib/apache2/modules
	mkdir -p "$GIT_DIR/gitweb/logs"
	bind=
	test "$local" = true && bind='127.0.0.1:'
	echo 'text/css css' > $fqgitdir/mime.types
	cat > "$conf" <<EOF
ServerName "git-instaweb"
ServerRoot "$fqgitdir/gitweb"
DocumentRoot "$fqgitdir/gitweb"
PidFile "$fqgitdir/pid"
Listen $bind$port
EOF

	for mod in mime dir; do
		if test -e $module_path/mod_${mod}.so; then
			echo "LoadModule ${mod}_module " \
			     "$module_path/mod_${mod}.so" >> "$conf"
		fi
	done
	cat >> "$conf" <<EOF
TypesConfig $fqgitdir/mime.types
DirectoryIndex gitweb.cgi
EOF

	# check to see if Dennis Stosberg's mod_perl compatibility patch
	# (<20060621130708.Gcbc6e5c@leonov.stosberg.net>) has been applied
	if test -f "$module_path/mod_perl.so" && grep '^our $gitbin' \
				"$GIT_DIR/gitweb/gitweb.cgi" >/dev/null
	then
		# favor mod_perl if available
		cat >> "$conf" <<EOF
LoadModule perl_module $module_path/mod_perl.so
PerlPassEnv GIT_DIR
PerlPassEnv GIT_EXEC_DIR
<Location /gitweb.cgi>
	SetHandler perl-script
	PerlResponseHandler ModPerl::Registry
	PerlOptions +ParseHeaders
	Options +ExecCGI
</Location>
EOF
	else
		# plain-old CGI
		list_mods=`echo "$httpd" | sed "s/-f$/-l/"`
		$list_mods | grep 'mod_cgi\.c' >/dev/null 2>&1 || \
		echo "LoadModule cgi_module $module_path/mod_cgi.so" >> "$conf"
		cat >> "$conf" <<EOF
AddHandler cgi-script .cgi
<Location /gitweb.cgi>
	Options +ExecCGI
</Location>
EOF
	fi
}

script='
s#^\(my\|our\) $projectroot =.*#\1 $projectroot = "'`dirname $fqgitdir`'";#
s#\(my\|our\) $gitbin =.*#\1 $gitbin = "'$GIT_EXEC_PATH'";#
s#\(my\|our\) $projects_list =.*#\1 $projects_list = $projectroot;#
s#\(my\|our\) $git_temp =.*#\1 $git_temp = "'$fqgitdir/gitweb/tmp'";#'

gitweb_cgi () {
	cat > "$1.tmp" <<\EOFGITWEB
@@GITWEB_CGI@@
EOFGITWEB
	sed "$script" "$1.tmp"  > "$1"
	chmod +x "$1"
	rm -f "$1.tmp"
}

gitweb_css () {
	cat > "$1" <<\EOFGITWEB
@@GITWEB_CSS@@
EOFGITWEB
}

gitweb_cgi $GIT_DIR/gitweb/gitweb.cgi
gitweb_css $GIT_DIR/gitweb/gitweb.css

case "$httpd" in
*lighttpd*)
	lighttpd_conf
	;;
*apache2*)
	apache2_conf
	;;
webrick)
	webrick_conf
	;;
*)
	echo "Unknown httpd specified: $httpd"
	exit 1
	;;
esac

start_httpd
test -z "$browser" && browser=echo
url=http://127.0.0.1:$port
$browser $url || echo $url
Commit	Line	Data
a51d37c1 EW	1	#!/bin/sh
	2	#
	3	# Copyright (c) 2006 Eric Wong
	4	#
	5	USAGE='[--start] [--stop] [--restart]
	6	[--local] [--httpd=<httpd>] [--port=<port>] [--browser=<browser>]
	7	[--module-path=<path> (for Apache2 only)]'
	8
	9	. git-sh-setup
	10
b2bc9a30	11	fqgitdir="$GIT_DIR"
e0d10e1c TP	12	local="`git config --bool --get instaweb.local`"
	13	httpd="`git config --get instaweb.httpd`"
	14	browser="`git config --get instaweb.browser`"
	15	port=`git config --get instaweb.port`
	16	module_path="`git config --get instaweb.modulepath`"
a51d37c1 EW	17
	18	conf=$GIT_DIR/gitweb/httpd.conf
	19
	20	# Defaults:
	21
82e5a82f	22	# if installed, it doesn't need further configuration (module_path)
a51d37c1 EW	23	test -z "$httpd" && httpd='lighttpd -f'
	24
	25	# probably the most popular browser among gitweb users
	26	test -z "$browser" && browser='firefox'
	27
	28	# any untaken local port will do...
	29	test -z "$port" && port=1234
	30
	31	start_httpd () {
	32	httpd_only="`echo $httpd \| cut -f1 -d' '`"
f5f30699	33	if case "$httpd_only" in /) : ;; ) which $httpd_only >/dev/null;; esac
a51d37c1 EW	34	then
	35	$httpd $fqgitdir/gitweb/httpd.conf
	36	else
	37	# many httpds are installed in /usr/sbin or /usr/local/sbin
	38	# these days and those are not in most users $PATHs
14b45b66 MD	39	# in addition, we may have generated a server script
	40	# in $fqgitdir/gitweb.
	41	for i in /usr/local/sbin /usr/sbin "$fqgitdir/gitweb"
a51d37c1 EW	42	do
	43	if test -x "$i/$httpd_only"
	44	then
	45	# don't quote $httpd, there can be
	46	# arguments to it (-f)
	47	$i/$httpd "$fqgitdir/gitweb/httpd.conf"
	48	return
	49	fi
	50	done
f281e3a1 FK	51	echo "$httpd_only not found. Install $httpd_only or use" \
	52	"--httpd to specify another http daemon."
	53	exit 1
a51d37c1	54	fi
5209eda8 JS	55	if test $? != 0; then
	56	echo "Could not execute http daemon $httpd."
	57	exit 1
	58	fi
a51d37c1 EW	59	}
	60
	61	stop_httpd () {
	62	test -f "$fqgitdir/pid" && kill `cat "$fqgitdir/pid"`
	63	}
	64
822f7c73	65	while test $# != 0
a51d37c1 EW	66	do
	67	case "$1" in
	68	--stop\|stop)
	69	stop_httpd
	70	exit 0
	71	;;
	72	--start\|start)
	73	start_httpd
	74	exit 0
	75	;;
	76	--restart\|restart)
	77	stop_httpd
	78	start_httpd
	79	exit 0
	80	;;
	81	--local\|-l)
	82	local=true
	83	;;
	84	-d\|--httpd\|--httpd=*)
	85	case "$#,$1" in
	86	,=*)
	87	httpd=`expr "$1" : '-[^=]=\(.\)'` ;;
	88	1,*)
	89	usage ;;
	90	*)
	91	httpd="$2"
	92	shift ;;
	93	esac
	94	;;
	95	-b\|--browser\|--browser=*)
	96	case "$#,$1" in
	97	,=*)
	98	browser=`expr "$1" : '-[^=]=\(.\)'` ;;
	99	1,*)
	100	usage ;;
	101	*)
	102	browser="$2"
	103	shift ;;
	104	esac
	105	;;
	106	-p\|--port\|--port=*)
	107	case "$#,$1" in
	108	,=*)
	109	port=`expr "$1" : '-[^=]=\(.\)'` ;;
	110	1,*)
	111	usage ;;
	112	*)
	113	port="$2"
	114	shift ;;
	115	esac
	116	;;
	117	-m\|--module-path=*\|--module-path)
	118	case "$#,$1" in
	119	,=*)
	120	module_path=`expr "$1" : '-[^=]=\(.\)'` ;;
	121	1,*)
	122	usage ;;
	123	*)
	124	module_path="$2"
	125	shift ;;
	126	esac
	127	;;
	128	*)
	129	usage
130	;;
131	esac
132	shift
133	done
134
135	mkdir -p "$GIT_DIR/gitweb/tmp"
136	GIT_EXEC_PATH="`git --exec-path`"
137	GIT_DIR="$fqgitdir"
138	export GIT_EXEC_PATH GIT_DIR
139
140
425b78e8 MD	141	webrick_conf () {
	142	# generate a standalone server script in $fqgitdir/gitweb.
	143	cat >"$fqgitdir/gitweb/$httpd.rb" <<EOF
	144	require 'webrick'
	145	require 'yaml'
	146	options = YAML::load_file(ARGV[0])
	147	options[:StartCallback] = proc do
	148	File.open(options[:PidFile],"w") do \|f\|
	149	f.puts Process.pid
	150	end
	151	end
	152	options[:ServerType] = WEBrick::Daemon
	153	server = WEBrick::HTTPServer.new(options)
	154	['INT', 'TERM'].each do \|signal\|
	155	trap(signal) {server.shutdown}
	156	end
	157	server.start
	158	EOF
	159	# generate a shell script to invoke the above ruby script,
	160	# which assumes _ruby_ is in the user's $PATH. that's _one_
	161	# portable way to run ruby, which could be installed anywhere,
	162	# really.
	163	cat >"$fqgitdir/gitweb/$httpd" <<EOF
	164	#!/bin/sh
	165	exec ruby "$fqgitdir/gitweb/$httpd.rb" \$*
	166	EOF
	167	chmod +x "$fqgitdir/gitweb/$httpd"
	168
	169	cat >"$conf" <<EOF
	170	:Port: $port
	171	:DocumentRoot: "$fqgitdir/gitweb"
	172	:DirectoryIndex: ["gitweb.cgi"]
	173	:PidFile: "$fqgitdir/pid"
	174	EOF
	175	test "$local" = true && echo ':BindAddress: "127.0.0.1"' >> "$conf"
	176	}
	177
a51d37c1 EW	178	lighttpd_conf () {
	179	cat > "$conf" <<EOF
	180	server.document-root = "$fqgitdir/gitweb"
	181	server.port = $port
	182	server.modules = ( "mod_cgi" )
	183	server.indexfiles = ( "gitweb.cgi" )
	184	server.pid-file = "$fqgitdir/pid"
	185	cgi.assign = ( ".cgi" => "" )
	186	mimetype.assign = ( ".css" => "text/css" )
	187	EOF
	188	test "$local" = true && echo 'server.bind = "127.0.0.1"' >> "$conf"
	189	}
	190
	191	apache2_conf () {
	192	test -z "$module_path" && module_path=/usr/lib/apache2/modules
	193	mkdir -p "$GIT_DIR/gitweb/logs"
	194	bind=
	195	test "$local" = true && bind='127.0.0.1:'
	196	echo 'text/css css' > $fqgitdir/mime.types
	197	cat > "$conf" <<EOF
44a167b0	198	ServerName "git-instaweb"
a51d37c1 EW	199	ServerRoot "$fqgitdir/gitweb"
	200	DocumentRoot "$fqgitdir/gitweb"
	201	PidFile "$fqgitdir/pid"
	202	Listen $bind$port
44a167b0 EW	203	EOF
	204
	205	for mod in mime dir; do
	206	if test -e $module_path/mod_${mod}.so; then
	207	echo "LoadModule ${mod}_module " \
	208	"$module_path/mod_${mod}.so" >> "$conf"
	209	fi
	210	done
	211	cat >> "$conf" <<EOF
a51d37c1 EW	212	TypesConfig $fqgitdir/mime.types
	213	DirectoryIndex gitweb.cgi
	214	EOF
	215
	216	# check to see if Dennis Stosberg's mod_perl compatibility patch
	217	# (<20060621130708.Gcbc6e5c@leonov.stosberg.net>) has been applied
	218	if test -f "$module_path/mod_perl.so" && grep '^our $gitbin' \
	219	"$GIT_DIR/gitweb/gitweb.cgi" >/dev/null
	220	then
	221	# favor mod_perl if available
	222	cat >> "$conf" <<EOF
	223	LoadModule perl_module $module_path/mod_perl.so
	224	PerlPassEnv GIT_DIR
	225	PerlPassEnv GIT_EXEC_DIR
	226	<Location /gitweb.cgi>
	227	SetHandler perl-script
	228	PerlResponseHandler ModPerl::Registry
	229	PerlOptions +ParseHeaders
	230	Options +ExecCGI
	231	</Location>
	232	EOF
	233	else
	234	# plain-old CGI
2b5d2d87	235	list_mods=`echo "$httpd" \| sed "s/-f$/-l/"`
5209eda8	236	$list_mods \| grep 'mod_cgi\.c' >/dev/null 2>&1 \|\| \
2b5d2d87	237	echo "LoadModule cgi_module $module_path/mod_cgi.so" >> "$conf"
a51d37c1	238	cat >> "$conf" <<EOF
a51d37c1 EW	239	AddHandler cgi-script .cgi
	240	<Location /gitweb.cgi>
	241	Options +ExecCGI
	242	</Location>
	243	EOF
	244	fi
	245	}
	246
	247	script='
6ee030d6 EW	248	s#^\(my\\|our\) $projectroot =.*#\1 $projectroot = "'`dirname $fqgitdir`'";#
	249	s#\(my\\|our\) $gitbin =.*#\1 $gitbin = "'$GIT_EXEC_PATH'";#
	250	s#\(my\\|our\) $projects_list =.*#\1 $projects_list = $projectroot;#
a51d37c1 EW	251	s#\(my\\|our\) $git_temp =.*#\1 $git_temp = "'$fqgitdir/gitweb/tmp'";#'
	252
	253	gitweb_cgi () {
	254	cat > "$1.tmp" <<\EOFGITWEB
	255	@@GITWEB_CGI@@
	256	EOFGITWEB
	257	sed "$script" "$1.tmp" > "$1"
	258	chmod +x "$1"
	259	rm -f "$1.tmp"
	260	}
	261
	262	gitweb_css () {
	263	cat > "$1" <<\EOFGITWEB
	264	@@GITWEB_CSS@@
	265	EOFGITWEB
	266	}
	267
	268	gitweb_cgi $GIT_DIR/gitweb/gitweb.cgi
	269	gitweb_css $GIT_DIR/gitweb/gitweb.css
	270
	271	case "$httpd" in
	272	lighttpd)
	273	lighttpd_conf
	274	;;
	275	apache2)
	276	apache2_conf
	277	;;
425b78e8 MD	278	webrick)
	279	webrick_conf
	280	;;
a51d37c1 EW	281	*)
	282	echo "Unknown httpd specified: $httpd"
	283	exit 1
	284	;;
	285	esac
	286
	287	start_httpd
	288	test -z "$browser" && browser=echo
5209eda8 JS	289	url=http://127.0.0.1:$port
5209eda8 JS	290	$browser $url \|\| echo $url