Merge branch 'mg/doc-bundle'
[git] / contrib / examples / git-fetch.sh
1 #!/bin/sh
2 #
3
4 USAGE='<fetch-options> <repository> <refspec>...'
5 SUBDIRECTORY_OK=Yes
6 . git-sh-setup
7 set_reflog_action "fetch $*"
8 cd_to_toplevel ;# probably unnecessary...
9
10 . git-parse-remote
11 _x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
12 _x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
13
14 LF='
15 '
16 IFS="$LF"
17
18 no_tags=
19 tags=
20 append=
21 force=
22 verbose=
23 update_head_ok=
24 exec=
25 keep=
26 shallow_depth=
27 no_progress=
28 test -t 1 || no_progress=--no-progress
29 quiet=
30 while test $# != 0
31 do
32         case "$1" in
33         -a|--a|--ap|--app|--appe|--appen|--append)
34                 append=t
35                 ;;
36         --upl|--uplo|--uploa|--upload|--upload-|--upload-p|\
37         --upload-pa|--upload-pac|--upload-pack)
38                 shift
39                 exec="--upload-pack=$1"
40                 ;;
41         --upl=*|--uplo=*|--uploa=*|--upload=*|\
42         --upload-=*|--upload-p=*|--upload-pa=*|--upload-pac=*|--upload-pack=*)
43                 exec=--upload-pack=$(expr "z$1" : 'z-[^=]*=\(.*\)')
44                 shift
45                 ;;
46         -f|--f|--fo|--for|--forc|--force)
47                 force=t
48                 ;;
49         -t|--t|--ta|--tag|--tags)
50                 tags=t
51                 ;;
52         -n|--n|--no|--no-|--no-t|--no-ta|--no-tag|--no-tags)
53                 no_tags=t
54                 ;;
55         -u|--u|--up|--upd|--upda|--updat|--update|--update-|--update-h|\
56         --update-he|--update-hea|--update-head|--update-head-|\
57         --update-head-o|--update-head-ok)
58                 update_head_ok=t
59                 ;;
60         -q|--q|--qu|--qui|--quie|--quiet)
61                 quiet=--quiet
62                 ;;
63         -v|--verbose)
64                 verbose="$verbose"Yes
65                 ;;
66         -k|--k|--ke|--kee|--keep)
67                 keep='-k -k'
68                 ;;
69         --depth=*)
70                 shallow_depth="--depth=`expr "z$1" : 'z-[^=]*=\(.*\)'`"
71                 ;;
72         --depth)
73                 shift
74                 shallow_depth="--depth=$1"
75                 ;;
76         -*)
77                 usage
78                 ;;
79         *)
80                 break
81                 ;;
82         esac
83         shift
84 done
85
86 case "$#" in
87 0)
88         origin=$(get_default_remote)
89         test -n "$(get_remote_url ${origin})" ||
90                 die "Where do you want to fetch from today?"
91         set x $origin ; shift ;;
92 esac
93
94 if test -z "$exec"
95 then
96         # No command line override and we have configuration for the remote.
97         exec="--upload-pack=$(get_uploadpack $1)"
98 fi
99
100 remote_nick="$1"
101 remote=$(get_remote_url "$@")
102 refs=
103 rref=
104 rsync_slurped_objects=
105
106 if test "" = "$append"
107 then
108         : >"$GIT_DIR/FETCH_HEAD"
109 fi
110
111 # Global that is reused later
112 ls_remote_result=$(git ls-remote $exec "$remote") ||
113         die "Cannot get the repository state from $remote"
114
115 append_fetch_head () {
116         flags=
117         test -n "$verbose" && flags="$flags$LF-v"
118         test -n "$force$single_force" && flags="$flags$LF-f"
119         GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION" \
120                 git fetch--tool $flags append-fetch-head "$@"
121 }
122
123 # updating the current HEAD with git-fetch in a bare
124 # repository is always fine.
125 if test -z "$update_head_ok" && test $(is_bare_repository) = false
126 then
127         orig_head=$(git rev-parse --verify HEAD 2>/dev/null)
128 fi
129
130 # Allow --tags/--notags from remote.$1.tagopt
131 case "$tags$no_tags" in
132 '')
133         case "$(git config --get "remote.$1.tagopt")" in
134         --tags)
135                 tags=t ;;
136         --no-tags)
137                 no_tags=t ;;
138         esac
139 esac
140
141 # If --tags (and later --heads or --all) is specified, then we are
142 # not talking about defaults stored in Pull: line of remotes or
143 # branches file, and just fetch those and refspecs explicitly given.
144 # Otherwise we do what we always did.
145
146 reflist=$(get_remote_refs_for_fetch "$@")
147 if test "$tags"
148 then
149         taglist=`IFS='  ' &&
150                   echo "$ls_remote_result" |
151                   git show-ref --exclude-existing=refs/tags/ |
152                   while read sha1 name
153                   do
154                         echo ".${name}:${name}"
155                   done` || exit
156         if test "$#" -gt 1
157         then
158                 # remote URL plus explicit refspecs; we need to merge them.
159                 reflist="$reflist$LF$taglist"
160         else
161                 # No explicit refspecs; fetch tags only.
162                 reflist=$taglist
163         fi
164 fi
165
166 fetch_all_at_once () {
167
168   eval=$(echo "$1" | git fetch--tool parse-reflist "-")
169   eval "$eval"
170
171     ( : subshell because we muck with IFS
172       IFS="     $LF"
173       (
174         if test "$remote" = . ; then
175             git show-ref $rref || echo failed "$remote"
176         elif test -f "$remote" ; then
177             test -n "$shallow_depth" &&
178                 die "shallow clone with bundle is not supported"
179             git bundle unbundle "$remote" $rref ||
180             echo failed "$remote"
181         else
182                 if      test -d "$remote" &&
183
184                         # The remote might be our alternate.  With
185                         # this optimization we will bypass fetch-pack
186                         # altogether, which means we cannot be doing
187                         # the shallow stuff at all.
188                         test ! -f "$GIT_DIR/shallow" &&
189                         test -z "$shallow_depth" &&
190
191                         # See if all of what we are going to fetch are
192                         # connected to our repository's tips, in which
193                         # case we do not have to do any fetch.
194                         theirs=$(echo "$ls_remote_result" | \
195                                 git fetch--tool -s pick-rref "$rref" "-") &&
196
197                         # This will barf when $theirs reach an object that
198                         # we do not have in our repository.  Otherwise,
199                         # we already have everything the fetch would bring in.
200                         git rev-list --objects $theirs --not --all \
201                                 >/dev/null 2>/dev/null
202                 then
203                         echo "$ls_remote_result" | \
204                                 git fetch--tool pick-rref "$rref" "-"
205                 else
206                         flags=
207                         case $verbose in
208                         YesYes*)
209                             flags="-v"
210                             ;;
211                         esac
212                         git-fetch-pack --thin $exec $keep $shallow_depth \
213                                 $quiet $no_progress $flags "$remote" $rref ||
214                         echo failed "$remote"
215                 fi
216         fi
217       ) |
218       (
219         flags=
220         test -n "$verbose" && flags="$flags -v"
221         test -n "$force" && flags="$flags -f"
222         GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION" \
223                 git fetch--tool $flags native-store \
224                         "$remote" "$remote_nick" "$refs"
225       )
226     ) || exit
227
228 }
229
230 fetch_per_ref () {
231   reflist="$1"
232   refs=
233   rref=
234
235   for ref in $reflist
236   do
237       refs="$refs$LF$ref"
238
239       # These are relative path from $GIT_DIR, typically starting at refs/
240       # but may be HEAD
241       if expr "z$ref" : 'z\.' >/dev/null
242       then
243           not_for_merge=t
244           ref=$(expr "z$ref" : 'z\.\(.*\)')
245       else
246           not_for_merge=
247       fi
248       if expr "z$ref" : 'z+' >/dev/null
249       then
250           single_force=t
251           ref=$(expr "z$ref" : 'z+\(.*\)')
252       else
253           single_force=
254       fi
255       remote_name=$(expr "z$ref" : 'z\([^:]*\):')
256       local_name=$(expr "z$ref" : 'z[^:]*:\(.*\)')
257
258       rref="$rref$LF$remote_name"
259
260       # There are transports that can fetch only one head at a time...
261       case "$remote" in
262       http://* | https://* | ftp://*)
263           test -n "$shallow_depth" &&
264                 die "shallow clone with http not supported"
265           proto=`expr "$remote" : '\([^:]*\):'`
266           if [ -n "$GIT_SSL_NO_VERIFY" ]; then
267               curl_extra_args="-k"
268           fi
269           if [ -n "$GIT_CURL_FTP_NO_EPSV" -o \
270                 "`git config --bool http.noEPSV`" = true ]; then
271               noepsv_opt="--disable-epsv"
272           fi
273
274           # Find $remote_name from ls-remote output.
275           head=$(echo "$ls_remote_result" | \
276                 git fetch--tool -s pick-rref "$remote_name" "-")
277           expr "z$head" : "z$_x40\$" >/dev/null ||
278                 die "No such ref $remote_name at $remote"
279           echo >&2 "Fetching $remote_name from $remote using $proto"
280           case "$quiet" in '') v=-v ;; *) v= ;; esac
281           git-http-fetch $v -a "$head" "$remote" || exit
282           ;;
283       rsync://*)
284           test -n "$shallow_depth" &&
285                 die "shallow clone with rsync not supported"
286           TMP_HEAD="$GIT_DIR/TMP_HEAD"
287           rsync -L -q "$remote/$remote_name" "$TMP_HEAD" || exit 1
288           head=$(git rev-parse --verify TMP_HEAD)
289           rm -f "$TMP_HEAD"
290           case "$quiet" in '') v=-v ;; *) v= ;; esac
291           test "$rsync_slurped_objects" || {
292               rsync -a $v --ignore-existing --exclude info \
293                   "$remote/objects/" "$GIT_OBJECT_DIRECTORY/" || exit
294
295               # Look at objects/info/alternates for rsync -- http will
296               # support it natively and git native ones will do it on
297               # the remote end.  Not having that file is not a crime.
298               rsync -q "$remote/objects/info/alternates" \
299                   "$GIT_DIR/TMP_ALT" 2>/dev/null ||
300                   rm -f "$GIT_DIR/TMP_ALT"
301               if test -f "$GIT_DIR/TMP_ALT"
302               then
303                   resolve_alternates "$remote" <"$GIT_DIR/TMP_ALT" |
304                   while read alt
305                   do
306                       case "$alt" in 'bad alternate: '*) die "$alt";; esac
307                       echo >&2 "Getting alternate: $alt"
308                       rsync -av --ignore-existing --exclude info \
309                       "$alt" "$GIT_OBJECT_DIRECTORY/" || exit
310                   done
311                   rm -f "$GIT_DIR/TMP_ALT"
312               fi
313               rsync_slurped_objects=t
314           }
315           ;;
316       esac
317
318       append_fetch_head "$head" "$remote" \
319           "$remote_name" "$remote_nick" "$local_name" "$not_for_merge" || exit
320
321   done
322
323 }
324
325 fetch_main () {
326         case "$remote" in
327         http://* | https://* | ftp://* | rsync://* )
328                 fetch_per_ref "$@"
329                 ;;
330         *)
331                 fetch_all_at_once "$@"
332                 ;;
333         esac
334 }
335
336 fetch_main "$reflist" || exit
337
338 # automated tag following
339 case "$no_tags$tags" in
340 '')
341         case "$reflist" in
342         *:refs/*)
343                 # effective only when we are following remote branch
344                 # using local tracking branch.
345                 taglist=$(IFS=' ' &&
346                 echo "$ls_remote_result" |
347                 git show-ref --exclude-existing=refs/tags/ |
348                 while read sha1 name
349                 do
350                         git cat-file -t "$sha1" >/dev/null 2>&1 || continue
351                         echo >&2 "Auto-following $name"
352                         echo ".${name}:${name}"
353                 done)
354         esac
355         case "$taglist" in
356         '') ;;
357         ?*)
358                 # do not deepen a shallow tree when following tags
359                 shallow_depth=
360                 fetch_main "$taglist" || exit ;;
361         esac
362 esac
363
364 # If the original head was empty (i.e. no "master" yet), or
365 # if we were told not to worry, we do not have to check.
366 case "$orig_head" in
367 '')
368         ;;
369 ?*)
370         curr_head=$(git rev-parse --verify HEAD 2>/dev/null)
371         if test "$curr_head" != "$orig_head"
372         then
373             git update-ref \
374                         -m "$GIT_REFLOG_ACTION: Undoing incorrectly fetched HEAD." \
375                         HEAD "$orig_head"
376                 die "Cannot fetch into the current branch."
377         fi
378         ;;
379 esac