3 # This is generic shell library for all the scripts used by Girocco;
4 # most importantly, it introduces all the $cfg_* shell variables.
7 octet
='[0-9a-f][0-9a-f]'
8 octet4
="$octet$octet$octet$octet"
9 octet19
="$octet4$octet4$octet4$octet4$octet$octet$octet"
10 octet20
="$octet4$octet4$octet4$octet4$octet4"
11 nullsha
="0000000000000000000000000000000000000000"
15 # set a sane umask that never excludes any user or group permissions
16 umask $
(printf '0%03o' $
(( $
(umask) & ~
0770 )) )
19 # Compare $1 to $2 each of which must match \d+(\.\d+)*
20 # An empty string ('') for $1 or $2 is treated like 0
25 # Note that `vcmp 1.8 1.8.0.0.0.0` correctly outputs 0.
29 [ -n "$_a" -o -n "$_b" ]
31 if [ "${_a:-0}" -lt "${_b:-0}" ]; then
34 elif [ "${_a:-0}" -gt "${_b:-0}" ]; then
40 set -- "${_a2#.}" "${_b2#.}"
45 get_girocco_config_pm_var_list
() {
46 # Export all the variables from Girocco::Config to suitable var= lines
47 # prefixing them with 'cfg_'. E.g. $cfg_admin is admin's mail address now
48 # and also setting a 'defined_cfg_' prefix to 1 if they are not undef.
49 __girocco_conf
="$GIROCCO_CONF"
50 [ -n "$__girocco_conf" ] || __girocco_conf
="Girocco::Config"
51 [ -z "$basedir" ] || __girocco_extrainc
="-I$basedir"
52 perl
-I@basedir@
$__girocco_extrainc -M$__girocco_conf -le \
53 'foreach (sort {uc($a) cmp uc($b)} keys %Girocco::Config::) {
54 my $val = ${$Girocco::Config::{$_}}; defined($val) or $val="";
55 $val =~ s/([\\"\$\`])/\\$1/gos;
56 $val =~ s/(?:\r\n|\r|\n)$//os;
57 print "cfg_$_=\"$val\"";
58 print "defined_cfg_$_=",
59 (defined(${$Girocco::Config::{$_}})?"1":"");
63 get_girocco_config_var_list
() (
64 # Same as get_girocco_config_pm_var_list except that
65 # the following variables (all starting with var_) are added:
66 # var_group cfg_owning_group if defined otherwise `id -gn`
67 # var_git_ver The version number part from `git version`
68 # var_git_exec_path The result of $cfg_git_bin --exec-dir
69 # var_perl_bin Full path to the perl interpreter to use
70 # var_have_git_172 Set to 1 if git version >= 1.7.2 otherwise ''
71 # var_have_git_173 Set to 1 if git version >= 1.7.3 otherwise ''
72 # var_window_memory Value to use for repack --window-memory=
73 # var_big_file_threshold Value to use for core.bigFileThreshold
74 # var_redelta_threshold Recompute deltas if no more than this many objs
75 # var_log_window_size Value to use for git-svn --log-window-size=
76 # var_utf8_locale Value to use for a UTF-8 locale if available
77 # var_xargs_r A "-r" if xargs needs it to behave correctly
78 # var_du_exclude Option to exclude PATTERN from du if available
79 # var_du_follow Option to follow command line sym links if available
80 _cfg_vars
="$(get_girocco_config_pm_var_list)"
82 printf '%s\n' "$_cfg_vars"
83 printf 'var_group=%s\n' "${cfg_owning_group:-$(id -gn)}"
84 _gver
="$("$cfg_git_bin" version 2>/dev/null | \
85 LC_ALL=C sed -ne 's/^[^0-9]*\([0-9][0-9]*\(\.[0-9][0-9]*\)*\).*$/\1/p')"
86 printf 'var_git_ver=%s\n' "$_gver"
87 printf 'var_git_exec_path="%s"\n' "$("$cfg_git_bin" --exec-path 2>/dev/null)"
88 printf 'var_perl_bin="%s"\n' "${cfg_perl_bin:-$(unset -f perl; command -v perl)}"
89 printf 'var_have_git_172=%s\n' "$([ $(vcmp "$_gver" 1.7.2) -ge 0 ] && echo 1)"
90 printf 'var_have_git_173=%s\n' "$([ $(vcmp "$_gver" 1.7.3) -ge 0 ] && echo 1)"
91 __girocco_conf
="$GIROCCO_CONF"
92 [ -n "$__girocco_conf" ] || __girocco_conf
="Girocco::Config"
93 [ -z "$basedir" ] || __girocco_extrainc
="-I$basedir"
94 printf "var_window_memory=%s\n" \
95 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
96 -MGirocco::Util -e 'print calc_windowmemory')"
97 printf "var_big_file_threshold=%s\n" \
98 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
99 -MGirocco::Util -e 'print calc_bigfilethreshold')"
100 printf "var_redelta_threshold=%s\n" \
101 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
102 -MGirocco::Util -e 'print calc_redeltathreshold')"
103 printf 'var_log_window_size=%s\n' "${cfg_svn_log_window_size:-250}"
104 # We parse the output of `locale -a` and select a suitable UTF-8 locale.
105 _guess_locale
="$(locale -a | LC_ALL=C grep -viE '^(posix|c)(\..*)?$' | \
106 LC_ALL=C grep -iE '\.utf-?8$' | LC_ALL=C sed -e 's/\.[Uu][Tt][Ff]-*8$//' | \
107 LC_ALL=C sed -e '/en_US/ s/^/0 /; /en_US/ !s/^/1 /' | LC_ALL=C sort | \
108 head -n 1 | LC_ALL=C cut -d ' ' -f 2)"
109 [ -z "$_guess_locale" ] ||
printf 'var_utf8_locale=%s.UTF-8\n' "$_guess_locale"
110 # On some broken platforms running xargs without -r and empty input runs the command
111 printf 'var_xargs_r=%s\n' "$(: | command xargs echo -r)"
112 # The disk usage report produces better numbers if du has an exclude option
113 _x0
="$(basename "$0")"
115 for _duopt
in --exclude -I; do
116 if _test
="$(du $_duopt 's?lib.s*' $_duopt "$_x0" "$0" 2>/dev/null)" && [ -z "$_test" ]; then
117 printf 'var_du_exclude=%s\n' "$_duopt"
121 if _test
="$(du -H "$0" 2>/dev/null)" && [ -n "$_test" ]; then
122 printf 'var_du_follow=%s\n' "-H"
127 # If basedir has been replaced, and shlib_vars.sh exists, get the config
128 # definitions from it rather than running Perl.
129 if [ "@basedir@" = '@'basedir
'@' ] ||
! [ -r "@basedir@/shlib_vars.sh" ]; then
130 # Import all the variables from Girocco::Config to the local environment,
131 eval "$(get_girocco_config_var_list)"
133 # Import the variables from shlib_vars.sh which avoids needlessly
134 # running another copy of Perl
135 .
"@basedir@/shlib_vars.sh"
138 # git_add_config "some.var=value"
139 # every ' in value must be replaced with the 4-character sequence '\'' before
140 # calling this function or Git will barf. Will not be effective unless running
141 # Git version 1.7.3 or later.
143 GIT_CONFIG_PARAMETERS
="${GIT_CONFIG_PARAMETERS:+$GIT_CONFIG_PARAMETERS }'$1'"
144 export GIT_CONFIG_PARAMETERS
147 # Make sure we have a reproducible environment by using a controlled HOME dir
148 XDG_CONFIG_HOME
="$cfg_chroot/var/empty"
149 HOME
="$cfg_chroot/etc/girocco"
151 GIT_CONFIG_NOSYSTEM
=1
153 GIT_NO_REPLACE_OBJECTS
=1
154 GIT_TERMINAL_PROMPT
=0
155 GIT_ASKPASS
="$cfg_basedir/bin/git-askpass-password"
156 export XDG_CONFIG_HOME
159 export GIT_CONFIG_NOSYSTEM
160 export GIT_ATTR_NOSYSTEM
161 export GIT_NO_REPLACE_OBJECTS
162 export GIT_TERMINAL_PROMPT
165 unset GIT_HTTP_USER_AGENT
166 if [ -n "$defined_cfg_git_client_ua" ]; then
167 GIT_USER_AGENT
="$cfg_git_client_ua"
168 export GIT_USER_AGENT
169 GIT_HTTP_USER_AGENT
="$cfg_git_client_ua"
170 export GIT_HTTP_USER_AGENT
172 unset GIT_CONFIG_PARAMETERS
173 git_add_config
"core.ignoreCase=false"
174 [ -z "$var_big_file_threshold" ] ||
175 git_add_config
"core.bigFileThreshold=$var_big_file_threshold"
177 # We cannot use a git() {} or nc_openbsd() {} function to redirect git
178 # and nc_openbsd to the desired executables because when using
179 # "ENV_VAR=xxx func" the various /bin/sh implementations behave in various
180 # different and unexpected ways:
181 # a) treat "ENV_VAR=xxx" like a separate, preceding "export ENV_VAR=xxx"
182 # b) treat "ENV_VAR=xxx" like a separate, prededing "ENV_VAR=xxx"
183 # c) treat "ENV_VAR=xxx" like a temporary setting only while running func
184 # None of these are good. We want a temporary "export ENV_VAR=xxx"
185 # setting only while running func which none of the /bin/sh's do.
187 # Instead we'd like to use an alias that provides the desired behavior without
188 # any of the bad (a), (b) or (c) effects.
190 # However, unfortunately, some of the crazy /bin/sh implementations do not
191 # recognize alias expansions when preceded by variable assignments!
193 # So we are left with git() {} and nc_openbsd() {} functions and in the
194 # case of git() {} we can compensate for (b) and (c) failing to export
195 # but not (a) and (b) persisting the values so the caller will simply
196 # have to beware and explicitly unset any variables that should not persist
197 # beyond the function call itself.
200 [ "${GIT_DIR+set}" = "set" ] && export GIT_DIR
201 [ "${GIT_SSL_NO_VERIFY+set}" = "set" ] && export GIT_SSL_NO_VERIFY
202 [ "${GIT_TRACE_PACKET+set}" = "set" ] && export GIT_TRACE_PACKET
203 [ "${GIT_USER_AGENT+set}" = "set" ] && export GIT_USER_AGENT
204 [ "${GIT_HTTP_USER_AGENT+set}" = "set" ] && export GIT_HTTP_USER_AGENT
205 exec "$cfg_git_bin" "$@"
208 # see comments for git() -- callers must explicitly export all variables
209 # intended for the perl interpreter before using this function
210 perl
() { command "${var_perl_bin:-perl}" "$@"; }
212 nc_openbsd
() { "$cfg_nc_openbsd_bin" "$@"; }
214 list_packs
() { command "$cfg_basedir/bin/list_packs" "$@"; }
216 strftime
() { command "$cfg_basedir/bin/strftime" "$@"; }
218 # Some platforms' broken xargs runs the command always at least once even if
219 # there's no input unless given a special option. Automatically supply the
220 # option on those platforms by providing an xargs function.
221 xargs() { command xargs $var_xargs_r "$@"; }
225 for _addr
in "$@"; do
226 [ -z "$_list" ] || _list
="$_list, "
233 _mailer
="${cfg_sendmail_bin:-/usr/sbin/sendmail}"
234 if [ -n "$cfg_sender" ]; then
235 "$_mailer" -i -f "$cfg_sender" "$@"
243 if [ "$1" = "-s" ]; then
249 echo "From: \"$cfg_name\" ($cfg_title) <$cfg_admin>"
250 echo "To: $(_addrlist "$@
")"
251 [ -z "$_subject" ] ||
echo "Subject: $_subject"
252 echo "MIME-Version: 1.0"
253 echo "Content-Type: text/plain; charset=utf-8"
254 echo "Content-Transfer-Encoding: 8bit"
255 [ -n "$cfg_suppress_x_girocco" ] ||
echo "X-Girocco: $cfg_gitweburl"
256 echo "Auto-Submitted: auto-generated"
262 # bang CMD... will execute the command with well-defined failure mode;
263 # set bang_action to string of the failed action ('clone', 'update', ...);
264 # pre-set bang_once=1 to make sure jobs banging on a repo repeatedly will
265 # not spam the owner; re-define the bang_trap() function to do custom
266 # cleanup before bailing out
268 if [ -n "$show_progress" ]; then
271 read -r errcode
<<-EOT || :
273 exec 4>&3 3>&1 1>&4 4>&-
274 { "$@" 3>&- || echo $? >&3; } 2>&1 | tee -a "$bang_log"
278 if [ -z "$errcode" ]; then
283 if "$@" >>"$bang_log" 2>&1; then
290 if ! [ -e .banged
] ||
[ -e .bangagain
]; then
293 ! [ -f HEAD
-a -f config
-a -d objects
] ||
294 bangmailok
="$(GIT_DIR=. git config --bool gitweb.statusupdates 2>/dev/null || echo true)"
296 [ "$bangmailok" = "false" -o -z "$mail" ] || bangaddrs
="$mail"
297 [ -z "$cfg_admincc" -o "$cfg_admincc" = "0" -o -z "$cfg_admin" ] ||
298 if [ -z "$bangaddrs" ]; then bangaddrs
="$cfg_admin"; else bangaddrs
="$bangaddrs,$cfg_admin"; fi
299 [ -z "$bangaddrs" ] ||
301 echo "$* failed with error code $errcode"
303 [ ! -n "$bang_once" ] ||
echo "you will not receive any more notifications until recovery"
304 echo "this status message may be disabled on the project admin page"
309 } |
mail -s "[$cfg_name] $proj $bang_action failed" "$bangaddrs"
312 cat "$bang_log" > .banglog
317 # bang_eval CMD... will evaluate the command with well-defined failure mode;
318 # Identical to bang CMD... except the command is eval'd instead of executed.
323 # Default bang settings:
325 bang_action
="lame_programmer"
328 bang_log
="$(mktemp -t repomgr-XXXXXX)"
329 trap 'rm -f "$bang_log"' EXIT
334 # Remove banged status
336 rm -f .banged .bangagain .banglog
339 # Check to see if banged status
345 # Progress report - if show_progress is set, shows the given message.
347 [ ! -n "$show_progress" ] ||
echo "$@"
351 # Project config accessors; must be run in project directory
353 git config
"gitweb.$1"
357 git config
"gitweb.$1" "$2" && chgrp
$var_group config
&& chmod g
+w config
361 git config
"$1" "$2" && chgrp
$var_group config
&& chmod g
+w config
364 config_get_date_seconds
() {
365 _dt
="$(config_get "$1" || :)"
366 [ -n "$_dt" ] ||
return 1
367 _ds
="$(perl -I@basedir@ -MGirocco::Util -e "print parse_rfc2822_date
('$_dt')")"
368 [ -n "$_ds" ] ||
return 1
372 # Tool for checking whether given number of seconds has not passed yet
374 os
="$(config_get_date_seconds "$1")" ||
return 1
376 [ $ns -lt $
(($os+$2)) ]
379 # Check if we are running with effective root permissions
381 [ "$(id -u 2>/dev/null)" = "0" ]
384 # Check to see if the single argument is a Git directory
386 # Just like Git's test except we ignore GIT_OBJECT_DIRECTORY
387 # And we are slightly more picky (must be refs/.+ not refs/.*)
388 [ -d "$1/objects" -a -x "$1/objects" ] ||
return 1
389 [ -d "$1/refs" -a -x "$1/refs" ] ||
return 1
390 if [ -L "$1/HEAD" ]; then
391 _hr
="$(readlink "$1/HEAD
")"
392 case "$_hr" in "refs/"?
*) :;; *) return 1;; esac
394 [ -f "$1/HEAD" -a -r "$1/HEAD" ] ||
return 1
395 read -r _hr
<"$1/HEAD" ||
return 1
400 _hr
="${_hr##ref:*[ $tab]}"
401 case "$_hr" in "refs/"?
*) return 0;; esac
406 # List all Git repositories, with given prefix if specified, one-per-line
407 # All project names starting with _ are always excluded from the result
410 LC_ALL
=C cut
-d : -f 1,3 "$cfg_chroot"/etc
/group | LC_ALL
=C
grep "^$1"
412 LC_ALL
=C cut
-d : -f 1,3 "$cfg_chroot"/etc
/group
413 fi |
while IFS
=: read name id
; do
414 [ $id -lt 65536 ] ||
case "$name" in _
*) :;; ?
*) echo "$name"; esac
418 # Return success if the given project name has any forks
421 [ -n "$_prj" ] ||
return 1
422 [ -d "$cfg_reporoot/$_prj" ] ||
return 1
423 is_git_dir
"$cfg_reporoot/$_prj.git" ||
return 1
424 test $
(get_repo_list
"$_prj/[^/][^/]*:" | LC_ALL
=C
wc -l) -gt 0
427 # returns empty string and error for empty string otherwise one of
428 # m => normal Git mirror
429 # s => mirror from svn source
430 # d => mirror from darcs source
431 # b => mirror from bzr source
432 # h => mirror from hg source
433 # w => mirror from mediawiki source
434 # f => mirror from other fast-import source
435 # note that if the string is non-empty and none of s, d, b or h match the
436 # return will always be type m regardless of whether it's a valid Git URL
437 get_url_mirror_type
() {
442 svn
://* | svn
+http
://* | svn
+https
://* | svn
+file://* | svn
+ssh://*)
451 hg
+http
://* | hg
+https
://* | hg
+file://* | hg
+ssh://* | hg
::*)
464 # returns false for empty string
465 # returns true if the passed in url is a mirror using git fast-import
466 is_gfi_mirror_url
() {
467 [ -n "$1" ] ||
return 1
468 case "$(get_url_mirror_type "$1" 2>/dev/null || :)" in
470 # darcs, bzr, hg and mediawiki mirrors use git fast-import
471 # and so do generic "f" fast-import mirrors
475 # Don't think git-svn currently uses git fast-import
476 # And Git mirrors certainly do not
480 # assume it does not use git fast-import
484 # returns mirror url for gitweb.baseurl of git directory
485 # (GIT_DIR) passed in as the argument (which defaults to "." if omitted)
486 # will fail if the directory does not have .nofetch and gitweb.baseurl
487 # comes back empty -- otherwise .nofetch directories succeed with a "" return
488 # automatically strips any leading "disabled " prefix before returning result
491 # always return empty for non-mirrors
492 [ ! -e "$_gitdir/.nofetch" ] ||
return 0
493 _url
="$(GIT_DIR="$_gitdir" config_get baseurl 2>/dev/null || :)"
495 [ -n "$_url" ] ||
return 1
496 printf '%s\n' "$_url"
500 # returns get_url_mirror_type for gitweb.baseurl of git directory
501 # (GIT_DIR) passed in as the argument (which defaults to "." if omitted)
502 # will fail if the directory does not have .nofetch and gitweb.baseurl
503 # comes back empty -- otherwise .nofetch directories succeed with a "" return
504 # automatically strips any leading "disabled " prefix before testing
506 _url
="$(get_mirror_url "$@
")" ||
return 1
507 get_url_mirror_type
"$_url"
510 # returns true if the passed in git dir (defaults to ".") is a mirror using git fast-import
512 _url
="$(get_mirror_url "$@
")" ||
return 1
513 is_gfi_mirror_url
"$_url"
516 # returns true if the passed in git dir (defaults to ".") is a mirror using git-svn
518 [ "$(get_mirror_type "$1" 2>/dev/null || :)" = "s" ]
521 # A well-known UTF-8 locale is required for some of the fast-import providers
522 # in order to avoid mangling characters. Ideally we could use "POSIX.UTF-8"
523 # but that is not reliably UTF-8 but rather usually US-ASCII.
524 # We parse the output of `locale -a` and select a suitable UTF-8 locale at
525 # install time and store that in $var_utf8_locale if one is found.
526 # If we cannot find one in the `locale -a` output then we just use a well-known
527 # UTF-8 locale and hope for the best. We set LC_ALL to our choice and export
528 # it. We only set this temporarily when running the fast-import providers.
530 LC_ALL
="${var_utf8_locale:-en_US.UTF-8}"
534 # hg-fast-export | git fast-import with error handling in current directory GIT_DIR
537 _python
="${PYTHON:-python}"
538 [ -e hg2git-marks
] ||
>hg2git-marks
539 rm -f hg2git-marks.new
543 { read -r _err1 ||
:; read -r _err2 ||
:; } <<-EOT
545 exec 4>&3 3>&1 1>&4 4>&-
548 _af="$(git config hg.authorsfile || :)"
549 _cmd='GIT_DIR="$(pwd)" "$_python" "$cfg_basedir/bin/hg-fast-export.py" \
550 --repo "$(pwd)/repo.hg" \
551 --marks "$(pwd)/hg2git-marks" \
552 --mapping "$(pwd)/hg2git-mapping" \
553 --heads "$(pwd)/hg2git-heads" \
554 --status "$(pwd)/hg2git-state" \
555 -U unknown --force --flatten --hg-hash'
556 [ -z "$_af" ] || _cmd="$_cmd"' --authors "$_af"'
557 eval "$_cmd" 3>&- || _e1=$?
563 --import-marks="$(pwd)/hg2git-marks" \
564 --export-marks="$(pwd)/hg2git-marks.new" \
565 --export-pack-edges="$(pwd)/gfi-packs" \
566 --force 3>&- || _e2=$?
572 [ "$_err1" = 0 -a "$_err2" = 0 ] ||
return 1
573 mv -f hg2git-marks.new hg2git-marks
574 git for-each-ref
--format='%(refname) %(objectname)' refs
/heads | \
575 LC_ALL
=C
sed -e 's,^refs/heads/,:,' >hg2git-heads