git-submodule: replace duplicated code with a module_list function
[gitweb.git] / git-instaweb.sh
index ada1180528b08607858efbcce9b2afc6d1b0e061..0843372b57371b62cd68f2818f634209f55d5395 100755 (executable)
@@ -2,18 +2,30 @@
 #
 # Copyright (c) 2006 Eric Wong
 #
-USAGE='[--start] [--stop] [--restart]
-  [--local] [--httpd=<httpd>] [--port=<port>] [--browser=<browser>]
-  [--module-path=<path> (for Apache2 only)]'
+
+PERL='@@PERL@@'
+OPTIONS_KEEPDASHDASH=
+OPTIONS_SPEC="\
+git instaweb [options] (--start | --stop | --restart)
+--
+l,local        only bind on 127.0.0.1
+p,port=        the port to bind to
+d,httpd=       the command to launch
+b,browser=     the browser to launch
+m,module-path= the module path (only needed for apache2)
+ Action
+stop           stop the web server
+start          start the web server
+restart        restart the web server
+"
 
 . 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`"
+local="$(git config --bool --get instaweb.local)"
+httpd="$(git config --get instaweb.httpd)"
+port=$(git config --get instaweb.port)
+module_path="$(git config --get instaweb.modulepath)"
 
 conf="$GIT_DIR/gitweb/httpd.conf"
 
@@ -22,17 +34,24 @@ conf="$GIT_DIR/gitweb/httpd.conf"
 # 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' '`"
+resolve_full_httpd () {
+       case "$httpd" in
+       *apache2*|*lighttpd*)
+               # ensure that the apache2/lighttpd command ends with "-f"
+               if ! echo "$httpd" | grep -- '-f *$' >/dev/null 2>&1
+               then
+                       httpd="$httpd -f"
+               fi
+               ;;
+       esac
+
+       httpd_only="$(echo $httpd | cut -f1 -d' ')"
        if case "$httpd_only" in /*) : ;; *) which $httpd_only >/dev/null;; esac
        then
-               $httpd "$fqgitdir/gitweb/httpd.conf"
+               full_httpd=$httpd
        else
                # many httpds are installed in /usr/sbin or /usr/local/sbin
                # these days and those are not in most users $PATHs
@@ -42,16 +61,23 @@ start_httpd () {
                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"
+                               full_httpd=$i/$httpd
                                return
                        fi
                done
-               echo "$httpd_only not found. Install $httpd_only or use" \
-                    "--httpd to specify another http daemon."
+
+               echo >&2 "$httpd_only not found. Install $httpd_only or use" \
+                    "--httpd to specify another httpd daemon."
                exit 1
        fi
+}
+
+start_httpd () {
+       # here $httpd should have a meaningful value
+       resolve_full_httpd
+
+       # don't quote $full_httpd, there can be arguments to it (-f)
+       $full_httpd "$fqgitdir/gitweb/httpd.conf"
        if test $? != 0; then
                echo "Could not execute http daemon $httpd."
                exit 1
@@ -59,7 +85,7 @@ start_httpd () {
 }
 
 stop_httpd () {
-       test -f "$fqgitdir/pid" && kill `cat "$fqgitdir/pid"`
+       test -f "$fqgitdir/pid" && kill $(cat "$fqgitdir/pid")
 }
 
 while test $# != 0
@@ -78,52 +104,26 @@ do
                start_httpd
                exit 0
                ;;
-       --local|-l)
+       -l|--local)
                local=true
                ;;
-       -d|--httpd|--httpd=*)
-               case "$#,$1" in
-               *,*=*)
-                       httpd=`expr "$1" : '-[^=]*=\(.*\)'` ;;
-               1,*)
-                       usage ;;
-               *)
-                       httpd="$2"
-                       shift ;;
-               esac
+       -d|--httpd)
+               shift
+               httpd="$1"
+               ;;
+       -b|--browser)
+               shift
+               browser="$1"
                ;;
-       -b|--browser|--browser=*)
-               case "$#,$1" in
-               *,*=*)
-                       browser=`expr "$1" : '-[^=]*=\(.*\)'` ;;
-               1,*)
-                       usage ;;
-               *)
-                       browser="$2"
-                       shift ;;
-               esac
+       -p|--port)
+               shift
+               port="$1"
                ;;
-       -p|--port|--port=*)
-               case "$#,$1" in
-               *,*=*)
-                       port=`expr "$1" : '-[^=]*=\(.*\)'` ;;
-               1,*)
-                       usage ;;
-               *)
-                       port="$2"
-                       shift ;;
-               esac
+       -m|--module-path)
+               shift
+               module_path="$1"
                ;;
-       -m|--module-path=*|--module-path)
-               case "$#,$1" in
-               *,*=*)
-                       module_path=`expr "$1" : '-[^=]*=\(.*\)'` ;;
-               1,*)
-                       usage ;;
-               *)
-                       module_path="$2"
-                       shift ;;
-               esac
+       --)
                ;;
        *)
                usage
@@ -133,7 +133,7 @@ do
 done
 
 mkdir -p "$GIT_DIR/gitweb/tmp"
-GIT_EXEC_PATH="`git --exec-path`"
+GIT_EXEC_PATH="$(git --exec-path)"
 GIT_DIR="$fqgitdir"
 export GIT_EXEC_PATH GIT_DIR
 
@@ -232,7 +232,8 @@ PerlPassEnv GIT_EXEC_DIR
 EOF
        else
                # plain-old CGI
-               list_mods=`echo "$httpd" | sed "s/-f$/-l/"`
+               resolve_full_httpd
+               list_mods=$(echo "$full_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
@@ -245,16 +246,18 @@ EOF
 }
 
 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'";#'
+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"
+       # Use the configured full path to perl to match the generated
+       # scripts' 'hashpling' line
+       "$PERL" -p -e "$script" "$1.tmp"  > "$1"
        chmod +x "$1"
        rm -f "$1.tmp"
 }
@@ -286,4 +289,9 @@ esac
 
 start_httpd
 url=http://127.0.0.1:$port
-"$browser" $url || echo $url
+
+if test -n "$browser"; then
+       git web--browse -b "$browser" $url || echo $url
+else
+       git web--browse -c "instaweb.browser" $url || echo $url
+fi