docs/pretty-formats: mention commas in %(trailers) syntax
[git] / git-web--browse.sh
1 #!/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
19 USAGE='[--browser=browser|--tool=browser] [--config=conf.var] url/file ...'
20
21 # This must be capable of running outside of git directory, so
22 # the vanilla git-sh-setup should not be used.
23 NONGIT_OK=Yes
24 . git-sh-setup
25
26 valid_custom_tool()
27 {
28         browser_cmd="$(git config "browser.$1.cmd")"
29         test -n "$browser_cmd"
30 }
31
32 valid_tool() {
33         case "$1" in
34         firefox | iceweasel | seamonkey | iceape | \
35         chrome | google-chrome | chromium | chromium-browser | \
36         konqueror | opera | w3m | elinks | links | lynx | dillo | open | \
37         start | cygstart | xdg-open)
38                 ;; # happy
39         *)
40                 valid_custom_tool "$1" || return 1
41                 ;;
42         esac
43 }
44
45 init_browser_path() {
46         browser_path=$(git config "browser.$1.path")
47         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"}
54 }
55
56 while test $# != 0
57 do
58         case "$1" in
59         -b|--browser*|-t|--tool*)
60                 case "$#,$1" in
61                 *,*=*)
62                         browser=$(expr "z$1" : 'z-[^=]*=\(.*\)')
63                         ;;
64                 1,*)
65                         usage ;;
66                 *)
67                         browser="$2"
68                         shift ;;
69                 esac
70                 ;;
71         -c|--config*)
72                 case "$#,$1" in
73                 *,*=*)
74                         conf=$(expr "z$1" : 'z-[^=]*=\(.*\)')
75                         ;;
76                 1,*)
77                         usage ;;
78                 *)
79                         conf="$2"
80                         shift ;;
81                 esac
82                 ;;
83         --)
84                 break
85                 ;;
86         -*)
87                 usage
88                 ;;
89         *)
90                 break
91                 ;;
92         esac
93         shift
94 done
95
96 test $# = 0 && usage
97
98 if test -z "$browser"
99 then
100         for opt in "$conf" "web.browser"
101         do
102                 test -z "$opt" && continue
103                 browser="$(git config $opt)"
104                 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
111 fi
112
113 if test -z "$browser" ; then
114         if test -n "$DISPLAY"; then
115                 browser_candidates="firefox iceweasel google-chrome chrome chromium chromium-browser konqueror opera seamonkey iceape w3m elinks links lynx dillo xdg-open"
116                 if test "$KDE_FULL_SESSION" = "true"; then
117                         browser_candidates="konqueror $browser_candidates"
118                 fi
119         else
120                 browser_candidates="w3m elinks links lynx"
121         fi
122         # SECURITYSESSIONID indicates an OS X GUI login session
123         if test -n "$SECURITYSESSIONID" || test -n "$TERM_PROGRAM"
124         then
125                 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
131         # /usr/bin/cygstart indicates Cygwin
132         if test -x /usr/bin/cygstart; then
133                 browser_candidates="cygstart $browser_candidates"
134         fi
135
136         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."
144 else
145         valid_tool "$browser" || die "Unknown browser '$browser'."
146
147         init_browser_path "$browser"
148
149         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
152 fi
153
154 case "$browser" in
155 firefox|iceweasel|seamonkey|iceape)
156         # 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=''
160         "$browser_path" $NEWTAB "$@" &
161         ;;
162 google-chrome|chrome|chromium|chromium-browser)
163         # No need to specify newTab. It's default in chromium
164         "$browser_path" "$@" &
165         ;;
166 konqueror)
167         case "$(basename "$browser_path")" in
168         konqueror)
169                 # 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."
172                 "$browser_path" newTab "$@" &
173                 ;;
174         kfmclient)
175                 "$browser_path" newTab "$@" &
176                 ;;
177         *)
178                 "$browser_path" "$@" &
179                 ;;
180         esac
181         ;;
182 w3m|elinks|links|lynx|open|cygstart|xdg-open)
183         "$browser_path" "$@"
184         ;;
185 start)
186         exec "$browser_path" '"web-browse"' "$@"
187         ;;
188 opera|dillo)
189         "$browser_path" "$@" &
190         ;;
191 *)
192         if test -n "$browser_cmd"; then
193                 ( eval "$browser_cmd \"\$@\"" )
194         fi
195         ;;
196 esac