blob: ae152534f5026d50fa32b568d1bdd591629bc59d [file] [log] [blame]
Christian Couder5d6491c2007-12-02 06:07:55 +01001#!/bin/sh
2#
3# This program launch a web browser on the html page
4# describing a git command.
5#
6# Copyright (c) 2007 Christian Couder
7# Copyright (c) 2006 Theodore Y. Ts'o
8#
9# This file is heavily stolen from git-mergetool.sh, by
10# Theodore Y. Ts'o (thanks) that is:
11#
12# Copyright (c) 2006 Theodore Y. Ts'o
13#
14# This file is licensed under the GPL v2, or a later version
15# at the discretion of Junio C Hamano or any other official
16# git maintainer.
17#
18
Christian Coudercaa87712008-02-02 07:32:41 +010019USAGE='[--browser=browser|--tool=browser] [--config=conf.var] url/file ...'
Junio C Hamano22c90712007-12-12 17:34:30 -080020
21# This must be capable of running outside of git directory, so
22# the vanilla git-sh-setup should not be used.
23NONGIT_OK=Yes
Christian Couder5d6491c2007-12-02 06:07:55 +010024. git-sh-setup
25
Christian Couder77e21532008-03-14 05:56:49 +010026valid_custom_tool()
27{
28 browser_cmd="$(git config "browser.$1.cmd")"
29 test -n "$browser_cmd"
30}
31
Christian Couder5d6491c2007-12-02 06:07:55 +010032valid_tool() {
33 case "$1" in
Giuseppe Bilotta14ea67c2010-12-03 17:47:39 +010034 firefox | iceweasel | seamonkey | iceape | \
Yaakov Selkowitzcc2f6b62013-06-21 02:24:32 -050035 chrome | google-chrome | chromium | chromium-browser | \
36 konqueror | opera | w3m | elinks | links | lynx | dillo | open | \
Rüdiger Sonderfeld6ca0f802013-10-26 19:43:54 +020037 start | cygstart | xdg-open)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010038 ;; # happy
39 *)
40 valid_custom_tool "$1" || return 1
41 ;;
Christian Couder5d6491c2007-12-02 06:07:55 +010042 esac
43}
44
45init_browser_path() {
jaysoffian+git@gmail.com8e086892008-02-11 10:57:34 -050046 browser_path=$(git config "browser.$1.path")
Giuseppe Bilotta14ea67c2010-12-03 17:47:39 +010047 if test -z "$browser_path" &&
48 test "$1" = chromium &&
49 type chromium-browser >/dev/null 2>&1
50 then
51 browser_path=chromium-browser
52 fi
53 : ${browser_path:="$1"}
Christian Couder5d6491c2007-12-02 06:07:55 +010054}
55
56while test $# != 0
57do
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010058 case "$1" in
Christian Couder5d6491c2007-12-02 06:07:55 +010059 -b|--browser*|-t|--tool*)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010060 case "$#,$1" in
Christian Couder5d6491c2007-12-02 06:07:55 +010061 *,*=*)
Elia Pinto9e5878f2014-04-23 06:44:02 -070062 browser=$(expr "z$1" : 'z-[^=]*=\(.*\)')
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010063 ;;
Christian Couder5d6491c2007-12-02 06:07:55 +010064 1,*)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010065 usage ;;
Christian Couder5d6491c2007-12-02 06:07:55 +010066 *)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010067 browser="$2"
68 shift ;;
69 esac
70 ;;
Christian Coudercaa87712008-02-02 07:32:41 +010071 -c|--config*)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010072 case "$#,$1" in
Christian Coudercaa87712008-02-02 07:32:41 +010073 *,*=*)
Elia Pinto9e5878f2014-04-23 06:44:02 -070074 conf=$(expr "z$1" : 'z-[^=]*=\(.*\)')
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010075 ;;
Christian Coudercaa87712008-02-02 07:32:41 +010076 1,*)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010077 usage ;;
Christian Coudercaa87712008-02-02 07:32:41 +010078 *)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010079 conf="$2"
80 shift ;;
81 esac
82 ;;
Christian Couder5d6491c2007-12-02 06:07:55 +010083 --)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010084 break
85 ;;
Christian Couder5d6491c2007-12-02 06:07:55 +010086 -*)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010087 usage
88 ;;
Christian Couder5d6491c2007-12-02 06:07:55 +010089 *)
Giuseppe Bilottaa1800552010-12-03 17:47:36 +010090 break
91 ;;
92 esac
93 shift
Christian Couder5d6491c2007-12-02 06:07:55 +010094done
95
Christian Couder482cce82008-02-02 07:32:33 +010096test $# = 0 && usage
97
Christian Couder70087cd2007-12-15 05:57:28 +010098if test -z "$browser"
Junio C Hamano22c90712007-12-12 17:34:30 -080099then
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100100 for opt in "$conf" "web.browser"
101 do
102 test -z "$opt" && continue
Elia Pinto9e5878f2014-04-23 06:44:02 -0700103 browser="$(git config $opt)"
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100104 test -z "$browser" || break
105 done
106 if test -n "$browser" && ! valid_tool "$browser"; then
107 echo >&2 "git config option $opt set to unknown browser: $browser"
108 echo >&2 "Resetting to default..."
109 unset browser
110 fi
Christian Couder5d6491c2007-12-02 06:07:55 +0100111fi
112
113if test -z "$browser" ; then
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100114 if test -n "$DISPLAY"; then
Rüdiger Sonderfeld6ca0f802013-10-26 19:43:54 +0200115 browser_candidates="firefox iceweasel google-chrome chrome chromium chromium-browser konqueror opera seamonkey iceape w3m elinks links lynx dillo xdg-open"
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100116 if test "$KDE_FULL_SESSION" = "true"; then
117 browser_candidates="konqueror $browser_candidates"
118 fi
119 else
Giuseppe Bilotta81f42f12010-12-03 17:47:38 +0100120 browser_candidates="w3m elinks links lynx"
Christian Couder5d6491c2007-12-02 06:07:55 +0100121 fi
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100122 # SECURITYSESSIONID indicates an OS X GUI login session
John Szakmeisterbe537e42013-03-25 06:13:18 -0400123 if test -n "$SECURITYSESSIONID" || test -n "$TERM_PROGRAM"
124 then
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100125 browser_candidates="open $browser_candidates"
126 fi
127 # /bin/start indicates MinGW
128 if test -x /bin/start; then
129 browser_candidates="start $browser_candidates"
130 fi
Yaakov Selkowitzcc2f6b62013-06-21 02:24:32 -0500131 # /usr/bin/cygstart indicates Cygwin
132 if test -x /usr/bin/cygstart; then
133 browser_candidates="cygstart $browser_candidates"
134 fi
Junio C Hamano22c90712007-12-12 17:34:30 -0800135
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100136 for i in $browser_candidates; do
137 init_browser_path $i
138 if type "$browser_path" > /dev/null 2>&1; then
139 browser=$i
140 break
141 fi
142 done
143 test -z "$browser" && die "No known browser available."
Christian Couder5d6491c2007-12-02 06:07:55 +0100144else
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100145 valid_tool "$browser" || die "Unknown browser '$browser'."
Christian Couder5d6491c2007-12-02 06:07:55 +0100146
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100147 init_browser_path "$browser"
Christian Couder5d6491c2007-12-02 06:07:55 +0100148
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100149 if test -z "$browser_cmd" && ! type "$browser_path" > /dev/null 2>&1; then
150 die "The browser $browser is not available as '$browser_path'."
151 fi
Christian Couder5d6491c2007-12-02 06:07:55 +0100152fi
153
Christian Couder5d6491c2007-12-02 06:07:55 +0100154case "$browser" in
Giuseppe Bilotta81f42f12010-12-03 17:47:38 +0100155firefox|iceweasel|seamonkey|iceape)
Christian Couder5d6491c2007-12-02 06:07:55 +0100156 # Check version because firefox < 2.0 does not support "-new-tab".
157 vers=$(expr "$($browser_path -version)" : '.* \([0-9][0-9]*\)\..*')
158 NEWTAB='-new-tab'
159 test "$vers" -lt 2 && NEWTAB=''
Dmitry Potapova0685a42008-02-09 23:22:22 -0800160 "$browser_path" $NEWTAB "$@" &
Christian Couder5d6491c2007-12-02 06:07:55 +0100161 ;;
Giuseppe Bilotta14ea67c2010-12-03 17:47:39 +0100162google-chrome|chrome|chromium|chromium-browser)
Pavan Kumar Sunkara0b3261b2010-05-30 00:06:51 +0530163 # No need to specify newTab. It's default in chromium
Chris Packham480f0622011-10-02 13:44:17 +1300164 "$browser_path" "$@" &
Pavan Kumar Sunkara0b3261b2010-05-30 00:06:51 +0530165 ;;
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100166konqueror)
Christian Couder5d6491c2007-12-02 06:07:55 +0100167 case "$(basename "$browser_path")" in
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100168 konqueror)
Christian Couder5d6491c2007-12-02 06:07:55 +0100169 # It's simpler to use kfmclient to open a new tab in konqueror.
170 browser_path="$(echo "$browser_path" | sed -e 's/konqueror$/kfmclient/')"
171 type "$browser_path" > /dev/null 2>&1 || die "No '$browser_path' found."
Chris Packham480f0622011-10-02 13:44:17 +1300172 "$browser_path" newTab "$@" &
Christian Couder5d6491c2007-12-02 06:07:55 +0100173 ;;
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100174 kfmclient)
Chris Packham480f0622011-10-02 13:44:17 +1300175 "$browser_path" newTab "$@" &
Christian Couder5d6491c2007-12-02 06:07:55 +0100176 ;;
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100177 *)
Dmitry Potapova0685a42008-02-09 23:22:22 -0800178 "$browser_path" "$@" &
Christian Couder5d6491c2007-12-02 06:07:55 +0100179 ;;
180 esac
181 ;;
Rüdiger Sonderfeld6ca0f802013-10-26 19:43:54 +0200182w3m|elinks|links|lynx|open|cygstart|xdg-open)
Chris Packham480f0622011-10-02 13:44:17 +1300183 "$browser_path" "$@"
Christian Couder5d6491c2007-12-02 06:07:55 +0100184 ;;
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100185start)
186 exec "$browser_path" '"web-browse"' "$@"
187 ;;
Giuseppe Bilotta81f42f12010-12-03 17:47:38 +0100188opera|dillo)
Dmitry Potapova0685a42008-02-09 23:22:22 -0800189 "$browser_path" "$@" &
Christian Couder5d6491c2007-12-02 06:07:55 +0100190 ;;
Giuseppe Bilottaa1800552010-12-03 17:47:36 +0100191*)
Christian Couder77e21532008-03-14 05:56:49 +0100192 if test -n "$browser_cmd"; then
Chris Packham480f0622011-10-02 13:44:17 +1300193 ( eval "$browser_cmd \"\$@\"" )
Christian Couder77e21532008-03-14 05:56:49 +0100194 fi
195 ;;
Christian Couder5d6491c2007-12-02 06:07:55 +0100196esac