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_have_git_172 Set to 1 if git version >= 1.7.2 otherwise ''
70 # var_have_git_173 Set to 1 if git version >= 1.7.3 otherwise ''
71 # var_window_memory Value to use for repack --window-memory=
72 # var_big_file_threshold Value to use for core.bigFileThreshold
73 # var_log_window_size Value to use for git-svn --log-window-size=
74 # var_utf8_locale Value to use for a UTF-8 locale if available
75 # var_xargs_r A "-r" if xargs needs it to behave correctly
76 # var_du_exclude Option to exclude PATTERN from du if available
77 # var_du_follow Option to follow command line sym links if available
78 _cfg_vars
="$(get_girocco_config_pm_var_list)"
80 printf '%s\n' "$_cfg_vars"
81 printf 'var_group=%s\n' "${cfg_owning_group:-$(id -gn)}"
82 _gver
="$("$cfg_git_bin" version 2>/dev/null | \
83 sed -ne 's/^[^0-9]*\([0-9][0-9]*\(\.[0-9][0-9]*\)*\).*$/\1/p')"
84 printf 'var_git_ver=%s\n' "$_gver"
85 printf 'var_git_exec_path="%s"\n' "$("$cfg_git_bin" --exec-path 2>/dev/null)"
86 printf 'var_have_git_172=%s\n' "$([ $(vcmp "$_gver" 1.7.2) -ge 0 ] && echo 1)"
87 printf 'var_have_git_173=%s\n' "$([ $(vcmp "$_gver" 1.7.3) -ge 0 ] && echo 1)"
88 __girocco_conf
="$GIROCCO_CONF"
89 [ -n "$__girocco_conf" ] || __girocco_conf
="Girocco::Config"
90 [ -z "$basedir" ] || __girocco_extrainc
="-I$basedir"
91 printf "var_window_memory=%s\n" \
92 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
93 -MGirocco::Util -e 'print calc_windowmemory')"
94 printf "var_big_file_threshold=%s\n" \
95 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
96 -MGirocco::Util -e 'print calc_bigfilethreshold')"
97 printf 'var_log_window_size=%s\n' "${cfg_svn_log_window_size:-250}"
98 # We parse the output of `locale -a` and select a suitable UTF-8 locale.
99 _guess_locale
="$(locale -a | grep -viE '^(posix|c)(\..*)?$' | \
100 grep -iE '\.utf-?8$' | sed -e 's/\.[Uu][Tt][Ff]-*8$//' | \
101 sed -e '/en_US/ s/^/0 /; /en_US/ !s/^/1 /' | LC_ALL=C sort | \
102 head -n 1 | cut -d ' ' -f 2)"
103 [ -z "$_guess_locale" ] ||
printf 'var_utf8_locale=%s.UTF-8\n' "$_guess_locale"
104 # On some broken platforms running xargs without -r and empty input runs the command
105 printf 'var_xargs_r=%s\n' "$(: | command xargs echo -r)"
106 # The disk usage report produces better numbers if du has an exclude option
107 _x0
="$(basename "$0")"
109 for _duopt
in --exclude -I; do
110 if _test
="$(du $_duopt 's?lib.s*' $_duopt "$_x0" "$0" 2>/dev/null)" && [ -z "$_test" ]; then
111 printf 'var_du_exclude=%s\n' "$_duopt"
115 if _test
="$(du -H "$0" 2>/dev/null)" && [ -n "$_test" ]; then
116 printf 'var_du_follow=%s\n' "-H"
121 # If basedir has been replaced, and shlib_vars.sh exists, get the config
122 # definitions from it rather than running Perl.
123 if [ "@basedir@" = '@'basedir
'@' ] ||
! [ -r "@basedir@/shlib_vars.sh" ]; then
124 # Import all the variables from Girocco::Config to the local environment,
125 eval "$(get_girocco_config_var_list)"
127 # Import the variables from shlib_vars.sh which avoids needlessly
128 # running another copy of Perl
129 .
"@basedir@/shlib_vars.sh"
132 # git_add_config "some.var=value"
133 # every ' in value must be replaced with the 4-character sequence '\'' before
134 # calling this function or Git will barf. Will not be effective unless running
135 # Git version 1.7.3 or later.
137 GIT_CONFIG_PARAMETERS
="${GIT_CONFIG_PARAMETERS:+$GIT_CONFIG_PARAMETERS }'$1'"
138 export GIT_CONFIG_PARAMETERS
141 # Make sure we have a reproducible environment by using a controlled HOME dir
142 XDG_CONFIG_HOME
="$cfg_chroot/var/empty"
143 HOME
="$cfg_chroot/etc/girocco"
144 GIT_CONFIG_NOSYSTEM
=1
146 GIT_NO_REPLACE_OBJECTS
=1
147 GIT_TERMINAL_PROMPT
=0
148 GIT_ASKPASS
="$cfg_basedir/bin/git-askpass-password"
149 export XDG_CONFIG_HOME
151 export GIT_CONFIG_NOSYSTEM
152 export GIT_ATTR_NOSYSTEM
153 export GIT_NO_REPLACE_OBJECTS
154 export GIT_TERMINAL_PROMPT
157 unset GIT_HTTP_USER_AGENT
158 if [ -n "$defined_cfg_git_client_ua" ]; then
159 GIT_USER_AGENT
="$cfg_git_client_ua"
160 export GIT_USER_AGENT
161 GIT_HTTP_USER_AGENT
="$cfg_git_client_ua"
162 export GIT_HTTP_USER_AGENT
164 unset GIT_CONFIG_PARAMETERS
165 [ -z "$var_big_file_threshold" ] ||
166 git_add_config
"core.bigFileThreshold=$var_big_file_threshold"
168 # We cannot use a git() {} or nc_openbsd() {} function to redirect git
169 # and nc_openbsd to the desired executables because when using
170 # "ENV_VAR=xxx func" the various /bin/sh implementations behave in various
171 # different and unexpected ways:
172 # a) treat "ENV_VAR=xxx" like a separate, preceding "export ENV_VAR=xxx"
173 # b) treat "ENV_VAR=xxx" like a separate, prededing "ENV_VAR=xxx"
174 # c) treat "ENV_VAR=xxx" like a temporary setting only while running func
175 # None of these are good. We want a temporary "export ENV_VAR=xxx"
176 # setting only while running func which none of the /bin/sh's do.
178 # Instead we'd like to use an alias that provides the desired behavior without
179 # any of the bad (a), (b) or (c) effects.
181 # However, unfortunately, some of the crazy /bin/sh implementations do not
182 # recognize alias expansions when preceded by variable assignments!
184 # So we are left with git() {} and nc_openbsd() {} functions and in the
185 # case of git() {} we can compensate for (b) and (c) failing to export
186 # but not (a) and (b) persisting the values so the caller will simply
187 # have to beware and explicitly unset any variables that should not persist
188 # beyond the function call itself.
191 [ "${GIT_DIR+set}" = "set" ] && export GIT_DIR
192 [ "${GIT_SSL_NO_VERIFY+set}" = "set" ] && export GIT_SSL_NO_VERIFY
193 [ "${GIT_TRACE_PACKET+set}" = "set" ] && export GIT_TRACE_PACKET
194 [ "${GIT_USER_AGENT+set}" = "set" ] && export GIT_USER_AGENT
195 [ "${GIT_HTTP_USER_AGENT+set}" = "set" ] && export GIT_HTTP_USER_AGENT
196 exec "$cfg_git_bin" "$@"
199 nc_openbsd
() { "$cfg_nc_openbsd_bin" "$@"; }
201 # Some platforms' broken xargs runs the command always at least once even if
202 # there's no input unless given a special option. Automatically supply the
203 # option on those platforms by providing an xargs function.
204 xargs() { command xargs $var_xargs_r "$@"; }
208 for _addr
in "$@"; do
209 [ -z "$_list" ] || _list
="$_list, "
216 _mailer
="${cfg_sendmail_bin:-/usr/sbin/sendmail}"
217 if [ -n "$cfg_sender" ]; then
218 "$_mailer" -i -f "$cfg_sender" "$@"
226 if [ "$1" = "-s" ]; then
232 echo "From: \"$cfg_name\" ($cfg_title) <$cfg_admin>"
233 echo "To: $(_addrlist "$@
")"
234 [ -z "$_subject" ] ||
echo "Subject: $_subject"
235 echo "MIME-Version: 1.0"
236 echo "Content-Type: text/plain; charset=utf-8"
237 echo "Content-Transfer-Encoding: 8bit"
238 echo "Auto-Submitted: auto-generated"
244 # bang CMD... will execute the command with well-defined failure mode;
245 # set bang_action to string of the failed action ('clone', 'update', ...);
246 # pre-set bang_once=1 to make sure jobs banging on a repo repeatedly will
247 # not spam the owner; re-define the bang_trap() function to do custom
248 # cleanup before bailing out
250 if [ -n "$show_progress" ]; then
253 read -r errcode
<<-EOT || :
255 exec 4>&3 3>&1 1>&4 4>&-
256 { "$@" 3>&- || echo $? >&3; } 2>&1 | tee -a "$bang_log"
260 if [ -z "$errcode" ]; then
265 if "$@" >>"$bang_log" 2>&1; then
272 if ! [ -e .banged
] ||
[ -e .bangagain
]; then
275 ! [ -f HEAD
-a -f config
-a -d objects
] ||
276 bangmailok
="$(GIT_DIR=. git config --bool gitweb.statusupdates 2>/dev/null || echo true)"
278 [ "$bangmailok" = "false" -o -z "$mail" ] || bangaddrs
="$mail"
279 [ -z "$cfg_admincc" -o "$cfg_admincc" = "0" -o -z "$cfg_admin" ] ||
280 if [ -z "$bangaddrs" ]; then bangaddrs
="$cfg_admin"; else bangaddrs
="$bangaddrs,$cfg_admin"; fi
281 [ -z "$bangaddrs" ] ||
283 echo "$* failed with error code $errcode"
285 [ ! -n "$bang_once" ] ||
echo "you will not receive any more notifications until recovery"
286 echo "this status message may be disabled on the project admin page"
291 } |
mail -s "[$cfg_name] $proj $bang_action failed" "$bangaddrs"
294 cat "$bang_log" > .banglog
299 # bang_eval CMD... will evaluate the command with well-defined failure mode;
300 # Identical to bang CMD... except the command is eval'd instead of executed.
305 # Default bang settings:
307 bang_action
="lame_programmer"
310 bang_log
="$(mktemp -t repomgr-XXXXXX)"
311 trap 'rm -f "$bang_log"' EXIT
316 # Remove banged status
318 rm -f .banged .bangagain .banglog
321 # Check to see if banged status
327 # Progress report - if show_progress is set, shows the given message.
329 [ ! -n "$show_progress" ] ||
echo "$@"
333 # Project config accessors; must be run in project directory
335 git config
"gitweb.$1"
339 git config
"gitweb.$1" "$2" && chgrp
$var_group config
&& chmod g
+w config
343 git config
"$1" "$2" && chgrp
$var_group config
&& chmod g
+w config
346 config_get_date_seconds
() {
347 _dt
="$(config_get "$1" || :)"
348 [ -n "$_dt" ] ||
return 1
349 _ds
="$(perl -I@basedir@ -MGirocco::Util -e "print parse_rfc2822_date
('$_dt')")"
350 [ -n "$_ds" ] ||
return 1
354 # Tool for checking whether given number of seconds has not passed yet
356 os
="$(config_get_date_seconds "$1")" ||
return 1
358 [ $ns -lt $
(($os+$2)) ]
361 # Check if we are running with effective root permissions
363 [ "$(id -u 2>/dev/null)" = "0" ]
366 # Check to see if the single argument is a Git directory
368 # Just like Git's test except we ignore GIT_OBJECT_DIRECTORY
369 # And we are slightly more picky (must be refs/.+ not refs/.*)
370 [ -d "$1/objects" -a -x "$1/objects" ] ||
return 1
371 [ -d "$1/refs" -a -x "$1/refs" ] ||
return 1
372 if [ -L "$1/HEAD" ]; then
373 _hr
="$(readlink "$1/HEAD
")"
374 case "$_hr" in "refs/"?
*) :;; *) return 1;; esac
376 [ -f "$1/HEAD" -a -r "$1/HEAD" ] ||
return 1
377 read -r _hr
<"$1/HEAD" ||
return 1
382 _hr
="${_hr##ref:*[ $tab]}"
383 case "$_hr" in "refs/"?
*) return 0;; esac
388 # List all Git repositories, with given prefix if specified, one-per-line
389 # All project names starting with _ are always excluded from the result
392 cut
-d : -f 1,3 "$cfg_chroot"/etc
/group |
grep "^$1"
394 cut
-d : -f 1,3 "$cfg_chroot"/etc
/group
395 fi |
while IFS
=: read name id
; do
396 [ $id -lt 65536 ] ||
case "$name" in _
*) :;; ?
*) echo "$name"; esac
400 # returns empty string for non-mirrors, otherwise one of:
401 # m => normal Git mirror
402 # s => mirror from svn source
403 # d => mirror from darcs source
404 # b => mirror from bzr source
405 # h => mirror from hg source
406 # the optional passed in git dir defaults to "."
407 # will fail if the directory does not have .nofetch and gitweb.baseurl
411 # always return empty for non-mirrors
412 [ ! -e "$_gitdir/.nofetch" ] ||
return 0
413 _url
="$(GIT_DIR="$_gitdir" config_get baseurl 2>/dev/null || :)"
419 svn
://* | svn
+http
://* | svn
+https
://*)
428 hg
+http
://* | hg
+https
://*)
438 # returns true if the passed in git dir (defaults to ".") is a mirror using git fast-import
440 case "$(get_mirror_type "$1" 2>/dev/null || :)" in
442 # darcs, bzr and hg mirrors use git fast-import
446 # Don't think git-svn currently uses git fast-import
447 # And Git mirrors certainly do not
451 # assume it does not use git fast-import
455 # returns true if the passed in git dir (defaults to ".") is a mirror using git-svn
457 [ "$(get_mirror_type "$1" 2>/dev/null || :)" = "s" ]
460 # A well-known UTF-8 locale is required for some of the fast-import providers
461 # in order to avoid mangling characters. Ideally we could use "POSIX.UTF-8"
462 # but that is not reliably UTF-8 but rather usually US-ASCII.
463 # We parse the output of `locale -a` and select a suitable UTF-8 locale at
464 # install time and store that in $var_utf8_locale if one is found.
465 # If we cannot find one in the `locale -a` output then we just use a well-known
466 # UTF-8 locale and hope for the best. We set LC_ALL to our choice and export
467 # it. We only set this temporarily when running the fast-import providers.
469 LC_ALL
="${var_utf8_locale:-en_US.UTF-8}"
473 # hg-fast-export | git fast-import with error handling in current directory GIT_DIR
476 _python
="${PYTHON:-python}"
480 { read -r _err1 ||
:; read -r _err2 ||
:; } <<-EOT
482 exec 4>&3 3>&1 1>&4 4>&-
485 [ -f hg2git-marks ] || touch hg2git-marks
486 _af="$(git config hg.authorsfile || :)"
487 _cmd='GIT_DIR="$(pwd)" "$_python" "$cfg_basedir/bin/hg-fast-export.py" \
488 --repo "$(pwd)/repo.hg" \
489 --marks "$(pwd)/hg2git-marks" \
490 --mapping "$(pwd)/hg2git-mapping" \
491 --heads "$(pwd)/hg2git-heads" \
492 --status "$(pwd)/hg2git-state" \
493 -U unknown --force --flatten --hg-hash'
494 [ -z "$_af" ] || _cmd="$_cmd"' --authors "$_af"'
495 eval "$_cmd" 3>&- || _e1=$?
500 rm -f hg2git-marks.new
502 --export-marks="$(pwd)/hg2git-marks.new" \
503 --export-pack-edges="$(pwd)/gfi-packs" \
504 --force 3>&- || _e2=$?
510 [ "$_err1" = 0 -a "$_err2" = 0 ] ||
return 1
511 if [ -f hg2git-marks
]; then
512 rm -f hg2git-marks.old
513 mv hg2git-marks hg2git-marks.old
515 touch hg2git-marks.old
517 cat hg2git-marks.old hg2git-marks.new | \
518 LC_ALL
=C
sort -t : -k2,2n
-u | \
519 sed -ne "/^:[1-9][0-9]* $octet20\$/p" > hg2git-marks
520 rm hg2git-marks.old hg2git-marks.new
522 git branch
--no-color | \
523 while IFS
= read -r _head
; do
524 echo ":${_head#??} $(git rev-parse "refs
/heads
/${_head#??}")"