gitweb: use new Git::Repo API, and add optional caching
[git/gitweb-caching.git] / git-submodule.sh
blob59b8c978843a1a1272ae7ee2b4675c9f835025e5
1 #!/bin/sh
3 # git-submodules.sh: add, init, update or list git submodules
5 # Copyright (c) 2007 Lars Hjemli
7 USAGE="[--quiet] [--cached] \
8 [add <repo> [-b branch] <path>]|[status|init|update [-i|--init]|summary [-n|--summary-limit <n>] [<commit>]] \
9 [--] [<path>...]|[foreach <command>]"
10 OPTIONS_SPEC=
11 . git-sh-setup
12 . git-parse-remote
13 require_work_tree
15 command=
16 branch=
17 quiet=
18 cached=
21 # print stuff on stdout unless -q was specified
23 say()
25 if test -z "$quiet"
26 then
27 echo "$@"
31 # Resolve relative url by appending to parent's url
32 resolve_relative_url ()
34 remote=$(get_default_remote)
35 remoteurl=$(git config "remote.$remote.url") ||
36 die "remote ($remote) does not have a url defined in .git/config"
37 url="$1"
38 remoteurl=${remoteurl%/}
39 while test -n "$url"
41 case "$url" in
42 ../*)
43 url="${url#../}"
44 remoteurl="${remoteurl%/*}"
46 ./*)
47 url="${url#./}"
50 break;;
51 esac
52 done
53 echo "$remoteurl/${url%/}"
57 # Get submodule info for registered submodules
58 # $@ = path to limit submodule list
60 module_list()
62 git ls-files --stage -- "$@" | grep '^160000 '
66 # Map submodule path to submodule name
68 # $1 = path
70 module_name()
72 # Do we have "submodule.<something>.path = $1" defined in .gitmodules file?
73 re=$(printf '%s\n' "$1" | sed -e 's/[].[^$\\*]/\\&/g')
74 name=$( git config -f .gitmodules --get-regexp '^submodule\..*\.path$' |
75 sed -n -e 's|^submodule\.\(.*\)\.path '"$re"'$|\1|p' )
76 test -z "$name" &&
77 die "No submodule mapping found in .gitmodules for path '$path'"
78 echo "$name"
82 # Clone a submodule
84 # Prior to calling, cmd_update checks that a possibly existing
85 # path is not a git repository.
86 # Likewise, cmd_add checks that path does not exist at all,
87 # since it is the location of a new submodule.
89 module_clone()
91 path=$1
92 url=$2
94 # If there already is a directory at the submodule path,
95 # expect it to be empty (since that is the default checkout
96 # action) and try to remove it.
97 # Note: if $path is a symlink to a directory the test will
98 # succeed but the rmdir will fail. We might want to fix this.
99 if test -d "$path"
100 then
101 rmdir "$path" 2>/dev/null ||
102 die "Directory '$path' exist, but is neither empty nor a git repository"
105 test -e "$path" &&
106 die "A file already exist at path '$path'"
108 git-clone -n "$url" "$path" ||
109 die "Clone of '$url' into submodule path '$path' failed"
113 # Add a new submodule to the working tree, .gitmodules and the index
115 # $@ = repo path
117 # optional branch is stored in global branch variable
119 cmd_add()
121 # parse $args after "submodule ... add".
122 while test $# -ne 0
124 case "$1" in
125 -b | --branch)
126 case "$2" in '') usage ;; esac
127 branch=$2
128 shift
130 -q|--quiet)
131 quiet=1
134 shift
135 break
138 usage
141 break
143 esac
144 shift
145 done
147 repo=$1
148 path=$2
150 if test -z "$repo" -o -z "$path"; then
151 usage
154 # assure repo is absolute or relative to parent
155 case "$repo" in
156 ./*|../*)
157 # dereference source url relative to parent's url
158 realrepo=$(resolve_relative_url "$repo") || exit
160 *:*|/*)
161 # absolute url
162 realrepo=$repo
165 die "repo URL: '$repo' must be absolute or begin with ./|../"
167 esac
169 # strip trailing slashes from path
170 path=$(echo "$path" | sed -e 's|/*$||')
172 git ls-files --error-unmatch "$path" > /dev/null 2>&1 &&
173 die "'$path' already exists in the index"
175 # perhaps the path exists and is already a git repo, else clone it
176 if test -e "$path"
177 then
178 if test -d "$path"/.git -o -f "$path"/.git
179 then
180 echo "Adding existing repo at '$path' to the index"
181 else
182 die "'$path' already exists and is not a valid git repo"
185 case "$repo" in
186 ./*|../*)
187 url=$(resolve_relative_url "$repo") || exit
190 url="$repo"
192 esac
193 git config submodule."$path".url "$url"
194 else
196 module_clone "$path" "$realrepo" || exit
197 (unset GIT_DIR; cd "$path" && git checkout -q ${branch:+-b "$branch" "origin/$branch"}) ||
198 die "Unable to checkout submodule '$path'"
201 git add "$path" ||
202 die "Failed to add submodule '$path'"
204 git config -f .gitmodules submodule."$path".path "$path" &&
205 git config -f .gitmodules submodule."$path".url "$repo" &&
206 git add .gitmodules ||
207 die "Failed to register submodule '$path'"
211 # Execute an arbitrary command sequence in each checked out
212 # submodule
214 # $@ = command to execute
216 cmd_foreach()
218 module_list |
219 while read mode sha1 stage path
221 if test -e "$path"/.git
222 then
223 say "Entering '$path'"
224 (cd "$path" && eval "$@") ||
225 die "Stopping at '$path'; script returned non-zero status."
227 done
231 # Register submodules in .git/config
233 # $@ = requested paths (default to all)
235 cmd_init()
237 # parse $args after "submodule ... init".
238 while test $# -ne 0
240 case "$1" in
241 -q|--quiet)
242 quiet=1
245 shift
246 break
249 usage
252 break
254 esac
255 shift
256 done
258 module_list "$@" |
259 while read mode sha1 stage path
261 # Skip already registered paths
262 name=$(module_name "$path") || exit
263 url=$(git config submodule."$name".url)
264 test -z "$url" || continue
266 url=$(git config -f .gitmodules submodule."$name".url)
267 test -z "$url" &&
268 die "No url found for submodule path '$path' in .gitmodules"
270 # Possibly a url relative to parent
271 case "$url" in
272 ./*|../*)
273 url=$(resolve_relative_url "$url") || exit
275 esac
277 git config submodule."$name".url "$url" ||
278 die "Failed to register url for submodule path '$path'"
280 say "Submodule '$name' ($url) registered for path '$path'"
281 done
285 # Update each submodule path to correct revision, using clone and checkout as needed
287 # $@ = requested paths (default to all)
289 cmd_update()
291 # parse $args after "submodule ... update".
292 while test $# -ne 0
294 case "$1" in
295 -q|--quiet)
296 shift
297 quiet=1
299 -i|--init)
300 shift
301 cmd_init "$@" || return
304 shift
305 break
308 usage
311 break
313 esac
314 done
316 module_list "$@" |
317 while read mode sha1 stage path
319 name=$(module_name "$path") || exit
320 url=$(git config submodule."$name".url)
321 if test -z "$url"
322 then
323 # Only mention uninitialized submodules when its
324 # path have been specified
325 test "$#" != "0" &&
326 say "Submodule path '$path' not initialized"
327 say "Maybe you want to use 'update --init'?"
328 continue
331 if ! test -d "$path"/.git -o -f "$path"/.git
332 then
333 module_clone "$path" "$url" || exit
334 subsha1=
335 else
336 subsha1=$(unset GIT_DIR; cd "$path" &&
337 git rev-parse --verify HEAD) ||
338 die "Unable to find current revision in submodule path '$path'"
341 if test "$subsha1" != "$sha1"
342 then
343 (unset GIT_DIR; cd "$path" && git-fetch &&
344 git-checkout -q "$sha1") ||
345 die "Unable to checkout '$sha1' in submodule path '$path'"
347 say "Submodule path '$path': checked out '$sha1'"
349 done
352 set_name_rev () {
353 revname=$( (
354 unset GIT_DIR
355 cd "$1" && {
356 git describe "$2" 2>/dev/null ||
357 git describe --tags "$2" 2>/dev/null ||
358 git describe --contains "$2" 2>/dev/null ||
359 git describe --all --always "$2"
362 test -z "$revname" || revname=" ($revname)"
365 # Show commit summary for submodules in index or working tree
367 # If '--cached' is given, show summary between index and given commit,
368 # or between working tree and given commit
370 # $@ = [commit (default 'HEAD'),] requested paths (default all)
372 cmd_summary() {
373 summary_limit=-1
374 for_status=
376 # parse $args after "submodule ... summary".
377 while test $# -ne 0
379 case "$1" in
380 --cached)
381 cached="$1"
383 --for-status)
384 for_status="$1"
386 -n|--summary-limit)
387 if summary_limit=$(($2 + 0)) 2>/dev/null && test "$summary_limit" = "$2"
388 then
390 else
391 usage
393 shift
396 shift
397 break
400 usage
403 break
405 esac
406 shift
407 done
409 test $summary_limit = 0 && return
411 if rev=$(git rev-parse --verify "$1^0" 2>/dev/null)
412 then
413 head=$rev
414 shift
415 else
416 head=HEAD
419 cd_to_toplevel
420 # Get modified modules cared by user
421 modules=$(git diff-index $cached --raw $head -- "$@" |
422 grep -e '^:160000' -e '^:[0-7]* 160000' |
423 while read mod_src mod_dst sha1_src sha1_dst status name
425 # Always show modules deleted or type-changed (blob<->module)
426 test $status = D -o $status = T && echo "$name" && continue
427 # Also show added or modified modules which are checked out
428 GIT_DIR="$name/.git" git-rev-parse --git-dir >/dev/null 2>&1 &&
429 echo "$name"
430 done
433 test -z "$modules" && return
435 git diff-index $cached --raw $head -- $modules |
436 grep -e '^:160000' -e '^:[0-7]* 160000' |
437 cut -c2- |
438 while read mod_src mod_dst sha1_src sha1_dst status name
440 if test -z "$cached" &&
441 test $sha1_dst = 0000000000000000000000000000000000000000
442 then
443 case "$mod_dst" in
444 160000)
445 sha1_dst=$(GIT_DIR="$name/.git" git rev-parse HEAD)
447 100644 | 100755 | 120000)
448 sha1_dst=$(git hash-object $name)
450 000000)
451 ;; # removed
453 # unexpected type
454 echo >&2 "unexpected mode $mod_dst"
455 continue ;;
456 esac
458 missing_src=
459 missing_dst=
461 test $mod_src = 160000 &&
462 ! GIT_DIR="$name/.git" git-rev-parse --verify $sha1_src^0 >/dev/null 2>&1 &&
463 missing_src=t
465 test $mod_dst = 160000 &&
466 ! GIT_DIR="$name/.git" git-rev-parse --verify $sha1_dst^0 >/dev/null 2>&1 &&
467 missing_dst=t
469 total_commits=
470 case "$missing_src,$missing_dst" in
472 errmsg=" Warn: $name doesn't contain commit $sha1_src"
475 errmsg=" Warn: $name doesn't contain commit $sha1_dst"
477 t,t)
478 errmsg=" Warn: $name doesn't contain commits $sha1_src and $sha1_dst"
481 errmsg=
482 total_commits=$(
483 if test $mod_src = 160000 -a $mod_dst = 160000
484 then
485 range="$sha1_src...$sha1_dst"
486 elif test $mod_src = 160000
487 then
488 range=$sha1_src
489 else
490 range=$sha1_dst
492 GIT_DIR="$name/.git" \
493 git log --pretty=oneline --first-parent $range | wc -l
495 total_commits=" ($(($total_commits + 0)))"
497 esac
499 sha1_abbr_src=$(echo $sha1_src | cut -c1-7)
500 sha1_abbr_dst=$(echo $sha1_dst | cut -c1-7)
501 if test $status = T
502 then
503 if test $mod_dst = 160000
504 then
505 echo "* $name $sha1_abbr_src(blob)->$sha1_abbr_dst(submodule)$total_commits:"
506 else
507 echo "* $name $sha1_abbr_src(submodule)->$sha1_abbr_dst(blob)$total_commits:"
509 else
510 echo "* $name $sha1_abbr_src...$sha1_abbr_dst$total_commits:"
512 if test -n "$errmsg"
513 then
514 # Don't give error msg for modification whose dst is not submodule
515 # i.e. deleted or changed to blob
516 test $mod_dst = 160000 && echo "$errmsg"
517 else
518 if test $mod_src = 160000 -a $mod_dst = 160000
519 then
520 limit=
521 test $summary_limit -gt 0 && limit="-$summary_limit"
522 GIT_DIR="$name/.git" \
523 git log $limit --pretty='format: %m %s' \
524 --first-parent $sha1_src...$sha1_dst
525 elif test $mod_dst = 160000
526 then
527 GIT_DIR="$name/.git" \
528 git log --pretty='format: > %s' -1 $sha1_dst
529 else
530 GIT_DIR="$name/.git" \
531 git log --pretty='format: < %s' -1 $sha1_src
533 echo
535 echo
536 done |
537 if test -n "$for_status"; then
538 echo "# Modified submodules:"
539 echo "#"
540 sed -e 's|^|# |' -e 's|^# $|#|'
541 else
546 # List all submodules, prefixed with:
547 # - submodule not initialized
548 # + different revision checked out
550 # If --cached was specified the revision in the index will be printed
551 # instead of the currently checked out revision.
553 # $@ = requested paths (default to all)
555 cmd_status()
557 # parse $args after "submodule ... status".
558 while test $# -ne 0
560 case "$1" in
561 -q|--quiet)
562 quiet=1
564 --cached)
565 cached=1
568 shift
569 break
572 usage
575 break
577 esac
578 shift
579 done
581 module_list "$@" |
582 while read mode sha1 stage path
584 name=$(module_name "$path") || exit
585 url=$(git config submodule."$name".url)
586 if test -z "$url" || ! test -d "$path"/.git -o -f "$path"/.git
587 then
588 say "-$sha1 $path"
589 continue;
591 set_name_rev "$path" "$sha1"
592 if git diff-files --quiet -- "$path"
593 then
594 say " $sha1 $path$revname"
595 else
596 if test -z "$cached"
597 then
598 sha1=$(unset GIT_DIR; cd "$path" && git rev-parse --verify HEAD)
599 set_name_rev "$path" "$sha1"
601 say "+$sha1 $path$revname"
603 done
606 # This loop parses the command line arguments to find the
607 # subcommand name to dispatch. Parsing of the subcommand specific
608 # options are primarily done by the subcommand implementations.
609 # Subcommand specific options such as --branch and --cached are
610 # parsed here as well, for backward compatibility.
612 while test $# != 0 && test -z "$command"
614 case "$1" in
615 add | foreach | init | update | status | summary)
616 command=$1
618 -q|--quiet)
619 quiet=1
621 -b|--branch)
622 case "$2" in
624 usage
626 esac
627 branch="$2"; shift
629 --cached)
630 cached="$1"
633 break
636 usage
639 break
641 esac
642 shift
643 done
645 # No command word defaults to "status"
646 test -n "$command" || command=status
648 # "-b branch" is accepted only by "add"
649 if test -n "$branch" && test "$command" != add
650 then
651 usage
654 # "--cached" is accepted only by "status" and "summary"
655 if test -n "$cached" && test "$command" != status -a "$command" != summary
656 then
657 usage
660 "cmd_$command" "$@"