]> git.ipfire.org Git - thirdparty/git.git/blob - git-web--browse.sh
Documentation/git-archive: spell --worktree-attributes correctly
[thirdparty/git.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 | konqueror | w3m | links | lynx | dillo | open | start)
35 ;; # happy
36 *)
37 valid_custom_tool "$1" || return 1
38 ;;
39 esac
40 }
41
42 init_browser_path() {
43 browser_path=$(git config "browser.$1.path")
44 test -z "$browser_path" && browser_path="$1"
45 }
46
47 while test $# != 0
48 do
49 case "$1" in
50 -b|--browser*|-t|--tool*)
51 case "$#,$1" in
52 *,*=*)
53 browser=`expr "z$1" : 'z-[^=]*=\(.*\)'`
54 ;;
55 1,*)
56 usage ;;
57 *)
58 browser="$2"
59 shift ;;
60 esac
61 ;;
62 -c|--config*)
63 case "$#,$1" in
64 *,*=*)
65 conf=`expr "z$1" : 'z-[^=]*=\(.*\)'`
66 ;;
67 1,*)
68 usage ;;
69 *)
70 conf="$2"
71 shift ;;
72 esac
73 ;;
74 --)
75 break
76 ;;
77 -*)
78 usage
79 ;;
80 *)
81 break
82 ;;
83 esac
84 shift
85 done
86
87 test $# = 0 && usage
88
89 if test -z "$browser"
90 then
91 for opt in "$conf" "web.browser"
92 do
93 test -z "$opt" && continue
94 browser="`git config $opt`"
95 test -z "$browser" || break
96 done
97 if test -n "$browser" && ! valid_tool "$browser"; then
98 echo >&2 "git config option $opt set to unknown browser: $browser"
99 echo >&2 "Resetting to default..."
100 unset browser
101 fi
102 fi
103
104 if test -z "$browser" ; then
105 if test -n "$DISPLAY"; then
106 browser_candidates="firefox iceweasel konqueror w3m links lynx dillo"
107 if test "$KDE_FULL_SESSION" = "true"; then
108 browser_candidates="konqueror $browser_candidates"
109 fi
110 else
111 browser_candidates="w3m links lynx"
112 fi
113 # SECURITYSESSIONID indicates an OS X GUI login session
114 if test -n "$SECURITYSESSIONID" \
115 -o "$TERM_PROGRAM" = "Apple_Terminal" ; then
116 browser_candidates="open $browser_candidates"
117 fi
118 # /bin/start indicates MinGW
119 if test -x /bin/start; then
120 browser_candidates="start $browser_candidates"
121 fi
122
123 for i in $browser_candidates; do
124 init_browser_path $i
125 if type "$browser_path" > /dev/null 2>&1; then
126 browser=$i
127 break
128 fi
129 done
130 test -z "$browser" && die "No known browser available."
131 else
132 valid_tool "$browser" || die "Unknown browser '$browser'."
133
134 init_browser_path "$browser"
135
136 if test -z "$browser_cmd" && ! type "$browser_path" > /dev/null 2>&1; then
137 die "The browser $browser is not available as '$browser_path'."
138 fi
139 fi
140
141 case "$browser" in
142 firefox|iceweasel)
143 # Check version because firefox < 2.0 does not support "-new-tab".
144 vers=$(expr "$($browser_path -version)" : '.* \([0-9][0-9]*\)\..*')
145 NEWTAB='-new-tab'
146 test "$vers" -lt 2 && NEWTAB=''
147 "$browser_path" $NEWTAB "$@" &
148 ;;
149 konqueror)
150 case "$(basename "$browser_path")" in
151 konqueror)
152 # It's simpler to use kfmclient to open a new tab in konqueror.
153 browser_path="$(echo "$browser_path" | sed -e 's/konqueror$/kfmclient/')"
154 type "$browser_path" > /dev/null 2>&1 || die "No '$browser_path' found."
155 eval "$browser_path" newTab "$@"
156 ;;
157 kfmclient)
158 eval "$browser_path" newTab "$@"
159 ;;
160 *)
161 "$browser_path" "$@" &
162 ;;
163 esac
164 ;;
165 w3m|links|lynx|open)
166 eval "$browser_path" "$@"
167 ;;
168 start)
169 exec "$browser_path" '"web-browse"' "$@"
170 ;;
171 dillo)
172 "$browser_path" "$@" &
173 ;;
174 *)
175 if test -n "$browser_cmd"; then
176 ( eval $browser_cmd "$@" )
177 fi
178 ;;
179 esac