shlib.sh

   1 #!/bin/sh
   2 #
   3 # This is generic shell library for all the scripts used by Girocco;
   4 # most importantly, it introduces all the $cfg_* shell variables.
   5
   6 # SHA-1 patterns
   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"
  12 # tab
  13 tab="$(printf '\t')"
  14
  15 # set a sane umask that never excludes any user or group permissions
  16 umask $(printf '0%03o' $(( $(umask) & ~0770 )) )
  17
  18 vcmp() {
  19         # Compare $1 to $2 each of which must match \d+(\.\d+)*
  20         # An empty string ('') for $1 or $2 is treated like 0
  21         # Outputs:
  22         #  -1 if $1 < $2
  23         #   0 if $1 = $2
  24         #   1 if $1 > $2
  25         # Note that `vcmp 1.8 1.8.0.0.0.0` correctly outputs 0.
  26         while
  27                 _a="${1%%.*}"
  28                 _b="${2%%.*}"
  29                 [ -n "$_a" -o -n "$_b" ]
  30         do
  31                 if [ "${_a:-0}" -lt "${_b:-0}" ]; then
  32                         echo -1
  33                         return
  34                 elif [ "${_a:-0}" -gt "${_b:-0}" ]; then
  35                         echo 1
  36                         return
  37                 fi
  38                 _a2="${1#$_a}"
  39                 _b2="${2#$_b}"
  40                 set -- "${_a2#.}" "${_b2#.}"
  41         done
  42         echo 0
  43 }
  44
  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":"");
  60                 }'
  61 }
  62
  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_171      Set to 1 if git version >= 1.7.1 otherwise ''
  71         # var_have_git_172      Set to 1 if git version >= 1.7.2 otherwise ''
  72         # var_have_git_173      Set to 1 if git version >= 1.7.3 otherwise ''
  73         # var_have_git_1710     Set to 1 if git version >= 1.7.10 otherwise ''
  74         # var_have_git_185      Set to 1 if git version >= 1.8.5 otherwise ''
  75         # var_window_memory     Value to use for repack --window-memory=
  76         # var_big_file_threshold Value to use for core.bigFileThreshold
  77         # var_redelta_threshold Recompute deltas if no more than this many objs
  78         # var_log_window_size   Value to use for git-svn --log-window-size=
  79         # var_utf8_locale       Value to use for a UTF-8 locale if available
  80         # var_xargs_r           A "-r" if xargs needs it to behave correctly
  81         # var_du_exclude        Option to exclude PATTERN from du if available
  82         # var_du_follow         Option to follow command line sym links if available
  83         _cfg_vars="$(get_girocco_config_pm_var_list)"
  84         eval "$_cfg_vars"
  85         printf '%s\n' "$_cfg_vars"
  86         printf 'var_group=%s\n' "${cfg_owning_group:-$(id -gn)}"
  87         _gver="$("$cfg_git_bin" version 2>/dev/null | \
  88                 LC_ALL=C sed -ne 's/^[^0-9]*\([0-9][0-9]*\(\.[0-9][0-9]*\)*\).*$/\1/p')"
  89         printf 'var_git_ver=%s\n' "$_gver"
  90         printf 'var_git_exec_path="%s"\n' "$("$cfg_git_bin" --exec-path 2>/dev/null)"
  91         printf 'var_perl_bin="%s"\n' "${cfg_perl_bin:-$(unset -f perl; command -v perl)}"
  92         printf 'var_have_git_171=%s\n' "$([ $(vcmp "$_gver" 1.7.1) -ge 0 ] && echo 1)"
  93         printf 'var_have_git_172=%s\n' "$([ $(vcmp "$_gver" 1.7.2) -ge 0 ] && echo 1)"
  94         printf 'var_have_git_173=%s\n' "$([ $(vcmp "$_gver" 1.7.3) -ge 0 ] && echo 1)"
  95         printf 'var_have_git_1710=%s\n' "$([ $(vcmp "$_gver" 1.7.10) -ge 0 ] && echo 1)"
  96         printf 'var_have_git_185=%s\n' "$([ $(vcmp "$_gver" 1.8.5) -ge 0 ] && echo 1)"
  97         __girocco_conf="$GIROCCO_CONF"
  98         [ -n "$__girocco_conf" ] || __girocco_conf="Girocco::Config"
  99         [ -z "$basedir" ] || __girocco_extrainc="-I$basedir"
 100         printf "var_window_memory=%s\n" \
 101                 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
 102                 -MGirocco::Util -e 'print calc_windowmemory')"
 103         printf "var_big_file_threshold=%s\n" \
 104                 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
 105                 -MGirocco::Util -e 'print calc_bigfilethreshold')"
 106         printf "var_redelta_threshold=%s\n" \
 107                 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
 108                 -MGirocco::Util -e 'print calc_redeltathreshold')"
 109         printf 'var_log_window_size=%s\n' "${cfg_svn_log_window_size:-250}"
 110         # We parse the output of `locale -a` and select a suitable UTF-8 locale.
 111         _guess_locale="$(locale -a | LC_ALL=C grep -viE '^(posix|c)(\..*)?$' | \
 112                 LC_ALL=C grep -iE '\.utf-?8$' | LC_ALL=C sed -e 's/\.[Uu][Tt][Ff]-*8$//' | \
 113                 LC_ALL=C sed -e '/en_US/ s/^/0 /; /en_US/ !s/^/1 /' | LC_ALL=C sort | \
 114                 head -n 1 | LC_ALL=C cut -d ' ' -f 2)"
 115         [ -z "$_guess_locale" ] || printf 'var_utf8_locale=%s.UTF-8\n' "$_guess_locale"
 116         # On some broken platforms running xargs without -r and empty input runs the command
 117         printf 'var_xargs_r=%s\n' "$(: | command xargs echo -r)"
 118         # The disk usage report produces better numbers if du has an exclude option
 119         _x0="$(basename "$0")"
 120         _x0="${_x0%?}?*"
 121         for _duopt in --exclude -I; do
 122                 if _test="$(du $_duopt 's?lib.s*' $_duopt "$_x0" "$0" 2>/dev/null)" && [ -z "$_test" ]; then
 123                         printf 'var_du_exclude=%s\n' "$_duopt"
 124                         break
 125                 fi
 126         done
 127         if _test="$(du -H "$0" 2>/dev/null)" && [ -n "$_test" ]; then
 128                 printf 'var_du_follow=%s\n' "-H"
 129                 break
 130         fi
 131 )
 132
 133 # If basedir has been replaced, and shlib_vars.sh exists, get the config
 134 # definitions from it rather than running Perl.
 135 if [ "@basedir@" = '@'basedir'@' ] || ! [ -r "@basedir@/shlib_vars.sh" ]; then
 136         # Import all the variables from Girocco::Config to the local environment,
 137         eval "$(get_girocco_config_var_list)"
 138 else
 139         # Import the variables from shlib_vars.sh which avoids needlessly
 140         # running another copy of Perl
 141         . "@basedir@/shlib_vars.sh"
 142 fi
 143
 144 # git_add_config "some.var=value"
 145 # every ' in value must be replaced with the 4-character sequence '\'' before
 146 # calling this function or Git will barf.  Will not be effective unless running
 147 # Git version 1.7.3 or later.
 148 git_add_config() {
 149         GIT_CONFIG_PARAMETERS="${GIT_CONFIG_PARAMETERS:+$GIT_CONFIG_PARAMETERS }'$1'"
 150         export GIT_CONFIG_PARAMETERS
 151 }
 152
 153 # Make sure we have a reproducible environment by using a controlled HOME dir
 154 XDG_CONFIG_HOME="$cfg_chroot/var/empty"
 155 HOME="$cfg_chroot/etc/girocco"
 156 TMPDIR="/tmp"
 157 GIT_CONFIG_NOSYSTEM=1
 158 GIT_ATTR_NOSYSTEM=1
 159 GIT_NO_REPLACE_OBJECTS=1
 160 GIT_TERMINAL_PROMPT=0
 161 GIT_ASKPASS="$cfg_basedir/bin/git-askpass-password"
 162 export XDG_CONFIG_HOME
 163 export HOME
 164 export TMPDIR
 165 export GIT_CONFIG_NOSYSTEM
 166 export GIT_ATTR_NOSYSTEM
 167 export GIT_NO_REPLACE_OBJECTS
 168 export GIT_TERMINAL_PROMPT
 169 export GIT_ASKPASS
 170 unset GIT_USER_AGENT
 171 unset GIT_HTTP_USER_AGENT
 172 if [ -n "$defined_cfg_git_client_ua" ]; then
 173         GIT_USER_AGENT="$cfg_git_client_ua"
 174         export GIT_USER_AGENT
 175         GIT_HTTP_USER_AGENT="$cfg_git_client_ua"
 176         export GIT_HTTP_USER_AGENT
 177 fi
 178 unset GIT_CONFIG_PARAMETERS
 179 git_add_config "core.ignoreCase=false"
 180 if [ -n "$cfg_git_no_mmap" ]; then
 181         # Just like compiling with NO_MMAP
 182         git_add_config "core.packedGitWindowSize=1m"
 183 else
 184         # Always use the 32-bit default (32m) even on 64-bit to avoid memory blowout
 185         git_add_config "core.packedGitWindowSize=32m"
 186 fi
 187 [ -z "$var_big_file_threshold" ] ||
 188         git_add_config "core.bigFileThreshold=$var_big_file_threshold"
 189
 190 # We cannot use a git() {} or nc_openbsd() {} function to redirect git
 191 # and nc_openbsd to the desired executables because when using
 192 # "ENV_VAR=xxx func" the various /bin/sh implementations behave in various
 193 # different and unexpected ways:
 194 #   a) treat "ENV_VAR=xxx" like a separate, preceding "export ENV_VAR=xxx"
 195 #   b) treat "ENV_VAR=xxx" like a separate, prededing "ENV_VAR=xxx"
 196 #   c) treat "ENV_VAR=xxx" like a temporary setting only while running func
 197 # None of these are good.  We want a temporary "export ENV_VAR=xxx"
 198 # setting only while running func which none of the /bin/sh's do.
 199 #
 200 # Instead we'd like to use an alias that provides the desired behavior without
 201 # any of the bad (a), (b) or (c) effects.
 202 #
 203 # However, unfortunately, some of the crazy /bin/sh implementations do not
 204 # recognize alias expansions when preceded by variable assignments!
 205 #
 206 # So we are left with git() {} and nc_openbsd() {} functions and in the
 207 # case of git() {} we can compensate for (b) and (c) failing to export
 208 # but not (a) and (b) persisting the values so the caller will simply
 209 # have to beware and explicitly unset any variables that should not persist
 210 # beyond the function call itself.
 211
 212 git() (
 213         [ "${GIT_DIR+set}" = "set" ] && export GIT_DIR
 214         [ "${GIT_SSL_NO_VERIFY+set}" = "set" ] && export GIT_SSL_NO_VERIFY
 215         [ "${GIT_TRACE_PACKET+set}" = "set" ] && export GIT_TRACE_PACKET
 216         [ "${GIT_USER_AGENT+set}" = "set" ] && export GIT_USER_AGENT
 217         [ "${GIT_HTTP_USER_AGENT+set}" = "set" ] && export GIT_HTTP_USER_AGENT
 218         exec "$cfg_git_bin" "$@"
 219 )
 220
 221 # see comments for git() -- callers must explicitly export all variables
 222 # intended for the perl interpreter before using this function
 223 perl() { command "${var_perl_bin:-perl}" "$@"; }
 224
 225 nc_openbsd() { "$cfg_nc_openbsd_bin" "$@"; }
 226
 227 list_packs() { command "$cfg_basedir/bin/list_packs" "$@"; }
 228
 229 strftime() { command "$cfg_basedir/bin/strftime" "$@"; }
 230
 231 # Some platforms' broken xargs runs the command always at least once even if
 232 # there's no input unless given a special option.  Automatically supply the
 233 # option on those platforms by providing an xargs function.
 234 xargs() { command xargs $var_xargs_r "$@"; }
 235
 236 _addrlist() {
 237         _list=
 238         for _addr in "$@"; do
 239                 [ -z "$_list" ] || _list="$_list, "
 240                 _list="$_list$_addr"
 241         done
 242         echo "$_list"
 243 }
 244
 245 _sendmail() {
 246         _mailer="${cfg_sendmail_bin:-/usr/sbin/sendmail}"
 247         if [ -n "$cfg_sender" ]; then
 248                 "$_mailer" -i -f "$cfg_sender" "$@"
 249         else
 250                 "$_mailer" -i "$@"
 251         fi
 252 }
 253
 254 mail() {
 255         _subject=
 256         if [ "$1" = "-s" ]; then
 257                 shift
 258                 _subject="$1"
 259                 shift
 260         fi
 261         {
 262                 echo "From: \"$cfg_name\" ($cfg_title) <$cfg_admin>"
 263                 echo "To: $(_addrlist "$@")"
 264                 [ -z "$_subject" ] || echo "Subject: $_subject"
 265                 echo "MIME-Version: 1.0"
 266                 echo "Content-Type: text/plain; charset=utf-8"
 267                 echo "Content-Transfer-Encoding: 8bit"
 268                 [ -n "$cfg_suppress_x_girocco" ] || echo "X-Girocco: $cfg_gitweburl"
 269                 echo "Auto-Submitted: auto-generated"
 270                 echo ""
 271                 cat
 272         } | _sendmail "$@"
 273 }
 274
 275 # bang CMD... will execute the command with well-defined failure mode;
 276 # set bang_action to string of the failed action ('clone', 'update', ...);
 277 # pre-set bang_once=1 to make sure jobs banging on a repo repeatedly will
 278 # not spam the owner; re-define the bang_trap() function to do custom
 279 # cleanup before bailing out
 280 bang() {
 281         if [ -n "$show_progress" ]; then
 282                 exec 3>&1
 283                 errcode=
 284                 read -r errcode <<-EOT || :
 285                 $(
 286                         exec 4>&3 3>&1 1>&4 4>&-
 287                         { "$@" 3>&- || echo $? >&3; } 2>&1 | tee -a "$bang_log"
 288                 )
 289                 EOT
 290                 exec 3>&-
 291                 if [ -z "$errcode" ]; then
 292                         # All right. Cool.
 293                         return;
 294                 fi
 295         else
 296                 if "$@" >>"$bang_log" 2>&1; then
 297                         # All right. Cool.
 298                         return;
 299                 else
 300                         errcode="$?"
 301                 fi
 302         fi
 303         if ! [ -e .banged ] || [ -e .bangagain ]; then
 304                 rm -f .bangagain
 305                 bangmailok=true
 306                 ! [ -f HEAD -a -f config -a -d objects ] ||
 307                 bangmailok="$(GIT_DIR=. git config --bool gitweb.statusupdates 2>/dev/null || echo true)"
 308                 bangaddrs=''
 309                 [ "$bangmailok" = "false" -o -z "$mail" ] || bangaddrs="$mail"
 310                 [ -z "$cfg_admincc" -o "$cfg_admincc" = "0" -o -z "$cfg_admin" ] ||
 311                 if [ -z "$bangaddrs" ]; then bangaddrs="$cfg_admin"; else bangaddrs="$bangaddrs,$cfg_admin"; fi
 312                 [ -z "$bangaddrs" ] ||
 313                 {
 314                         echo "$* failed with error code $errcode"
 315                         echo ""
 316                         [ ! -n "$bang_once" ] || echo "you will not receive any more notifications until recovery"
 317                         echo "this status message may be disabled on the project admin page"
 318                         echo ""
 319                         echo "Log follows:"
 320                         echo ""
 321                         cat "$bang_log"
 322                 } | mail -s "[$cfg_name] $proj $bang_action failed" "$bangaddrs"
 323         fi
 324         touch .banged
 325         cat "$bang_log" > .banglog
 326         bang_trap
 327         exit 1
 328 }
 329
 330 # bang_eval CMD... will evaluate the command with well-defined failure mode;
 331 # Identical to bang CMD... except the command is eval'd instead of executed.
 332 bang_eval() {
 333         bang eval "$*"
 334 }
 335
 336 # Default bang settings:
 337 bang_setup() {
 338         bang_action="lame_programmer"
 339         bang_once=
 340         bang_trap() { :; }
 341         bang_log="$(mktemp -t repomgr-XXXXXX)"
 342         trap 'rm -f "$bang_log"' EXIT
 343         trap 'exit 130' INT
 344         trap 'exit 143' TERM
 345 }
 346
 347 # Remove banged status
 348 bang_reset() {
 349         rm -f .banged .bangagain .banglog
 350 }
 351
 352 # Check to see if banged status
 353 is_banged() {
 354         [ -e .banged ]
 355 }
 356
 357
 358 # Progress report - if show_progress is set, shows the given message.
 359 progress() {
 360         [ ! -n "$show_progress" ] || echo "$@"
 361 }
 362
 363
 364 # Project config accessors; must be run in project directory
 365 config_get() {
 366         git config "gitweb.$1"
 367 }
 368
 369 config_set() {
 370         git config "gitweb.$1" "$2" && chgrp $var_group config && chmod g+w config
 371 }
 372
 373 config_set_raw() {
 374         git config "$1" "$2"        && chgrp $var_group config && chmod g+w config
 375 }
 376
 377 config_get_date_seconds() {
 378         _dt="$(config_get "$1" || :)"
 379         [ -n "$_dt" ] || return 1
 380         _ds="$(perl -I@basedir@ -MGirocco::Util -e "print parse_rfc2822_date('$_dt')")"
 381         [ -n "$_ds" ] || return 1
 382         echo "$_ds"
 383 }
 384
 385 # Tool for checking whether given number of seconds has not passed yet
 386 check_interval() {
 387         os="$(config_get_date_seconds "$1")" || return 1
 388         ns="$(date +%s)"
 389         [ $ns -lt $(($os+$2)) ]
 390 }
 391
 392 # Check if we are running with effective root permissions
 393 is_root() {
 394         [ "$(id -u 2>/dev/null)" = "0" ]
 395 }
 396
 397 # Check to see if the single argument is a Git directory
 398 is_git_dir() {
 399         # Just like Git's test except we ignore GIT_OBJECT_DIRECTORY
 400         # And we are slightly more picky (must be refs/.+ not refs/.*)
 401         [ -d "$1/objects" -a -x "$1/objects" ] || return 1
 402         [ -d "$1/refs" -a -x "$1/refs" ] || return 1
 403         if [ -L "$1/HEAD" ]; then
 404                 _hr="$(readlink "$1/HEAD")"
 405                 case "$_hr" in "refs/"?*) :;; *) return 1;; esac
 406         fi
 407         [ -f "$1/HEAD" -a -r "$1/HEAD" ] || return 1
 408         read -r _hr <"$1/HEAD" || return 1
 409         case "$_hr" in
 410                 $octet20)
 411                         return 0;;
 412                 ref:*)
 413                         _hr="${_hr##ref:*[ $tab]}"
 414                         case "$_hr" in "refs/"?*) return 0;; esac
 415         esac
 416         return 1
 417 }
 418
 419 # List all Git repositories, with given prefix if specified, one-per-line
 420 # All project names starting with _ are always excluded from the result
 421 get_repo_list() {
 422         if [ -n "$1" ]; then
 423                 LC_ALL=C cut -d : -f 1,3 "$cfg_chroot"/etc/group | LC_ALL=C grep "^$1"
 424         else
 425                 LC_ALL=C cut -d : -f 1,3 "$cfg_chroot"/etc/group
 426         fi | while IFS=: read name id; do
 427                 [ $id -lt 65536 ] || case "$name" in _*) :;; ?*) echo "$name"; esac
 428         done
 429 }
 430
 431 # Return success if the given project name has any forks
 432 has_forks() {
 433         _prj="${1%.git}"
 434         [ -n "$_prj" ] || return 1
 435         [ -d "$cfg_reporoot/$_prj" ] || return 1
 436         is_git_dir "$cfg_reporoot/$_prj.git" || return 1
 437         test $(get_repo_list "$_prj/[^/][^/]*:" | LC_ALL=C wc -l) -gt 0
 438 }
 439
 440 # returns empty string and error for empty string otherwise one of
 441 #   m  =>  normal Git mirror
 442 #   s  =>  mirror from svn source
 443 #   d  =>  mirror from darcs source
 444 #   b  =>  mirror from bzr source
 445 #   h  =>  mirror from hg source
 446 #   w  =>  mirror from mediawiki source
 447 #   f  =>  mirror from other fast-import source
 448 # note that if the string is non-empty and none of s, d, b or h match the
 449 # return will always be type m regardless of whether it's a valid Git URL
 450 get_url_mirror_type() {
 451         case "$1" in
 452                 "")
 453                         return 1
 454                         ;;
 455                 svn://* | svn+http://* | svn+https://* | svn+file://* | svn+ssh://*)
 456                         echo 's'
 457                         ;;
 458                 darcs://*)
 459                         echo 'd'
 460                         ;;
 461                 bzr://*)
 462                         echo 'b'
 463                         ;;
 464                 hg+http://* | hg+https://* | hg+file://* | hg+ssh://* | hg::*)
 465                         echo 'h'
 466                         ;;
 467                 mediawiki::*)
 468                         echo 'w'
 469                         ;;
 470                 *)
 471                         echo 'm'
 472                         ;;
 473         esac
 474         return 0
 475 }
 476
 477 # returns false for empty string
 478 # returns true if the passed in url is a mirror using git fast-import
 479 is_gfi_mirror_url() {
 480         [ -n "$1" ] || return 1
 481         case "$(get_url_mirror_type "$1" 2>/dev/null || :)" in
 482                 d|b|h|w|f)
 483                         # darcs, bzr, hg and mediawiki mirrors use git fast-import
 484                         # and so do generic "f" fast-import mirrors
 485                         return 0
 486                         ;;
 487                 *)
 488                         # Don't think git-svn currently uses git fast-import
 489                         # And Git mirrors certainly do not
 490                         return 1
 491                         ;;
 492         esac
 493         # assume it does not use git fast-import
 494         return 1
 495 }
 496
 497 # returns mirror url for gitweb.baseurl of git directory
 498 # (GIT_DIR) passed in as the argument (which defaults to "." if omitted)
 499 # will fail if the directory does not have .nofetch and gitweb.baseurl
 500 # comes back empty -- otherwise .nofetch directories succeed with a "" return
 501 # automatically strips any leading "disabled " prefix before returning result
 502 get_mirror_url() {
 503         _gitdir="${1:-.}"
 504         # always return empty for non-mirrors
 505         [ ! -e "$_gitdir/.nofetch" ] || return 0
 506         _url="$(GIT_DIR="$_gitdir" config_get baseurl 2>/dev/null || :)"
 507         _url="${_url##* }"
 508         [ -n "$_url" ] || return 1
 509         printf '%s\n' "$_url"
 510         return 0
 511 }
 512
 513 # returns get_url_mirror_type for gitweb.baseurl of git directory
 514 # (GIT_DIR) passed in as the argument (which defaults to "." if omitted)
 515 # will fail if the directory does not have .nofetch and gitweb.baseurl
 516 # comes back empty -- otherwise .nofetch directories succeed with a "" return
 517 # automatically strips any leading "disabled " prefix before testing
 518 get_mirror_type() {
 519         _url="$(get_mirror_url "$@")" || return 1
 520         get_url_mirror_type "$_url"
 521 }
 522
 523 # returns true if the passed in git dir (defaults to ".") is a mirror using git fast-import
 524 is_gfi_mirror() {
 525         _url="$(get_mirror_url "$@")" || return 1
 526         is_gfi_mirror_url "$_url"
 527 }
 528
 529 # returns true if the passed in git dir (defaults to ".") is a mirror using git-svn
 530 is_svn_mirror() {
 531         [ "$(get_mirror_type "$1" 2>/dev/null || :)" = "s" ]
 532 }
 533
 534 # A well-known UTF-8 locale is required for some of the fast-import providers
 535 # in order to avoid mangling characters.  Ideally we could use "POSIX.UTF-8"
 536 # but that is not reliably UTF-8 but rather usually US-ASCII.
 537 # We parse the output of `locale -a` and select a suitable UTF-8 locale at
 538 # install time and store that in $var_utf8_locale if one is found.
 539 # If we cannot find one in the `locale -a` output then we just use a well-known
 540 # UTF-8 locale and hope for the best.  We set LC_ALL to our choice and export
 541 # it.  We only set this temporarily when running the fast-import providers.
 542 set_utf8_locale() {
 543         LC_ALL="${var_utf8_locale:-en_US.UTF-8}"
 544         export LC_ALL
 545 }
 546
 547 # hg-fast-export | git fast-import with error handling in current directory GIT_DIR
 548 git_hg_fetch() (
 549         set_utf8_locale
 550         _python="${PYTHON:-python}"
 551         rm -f hg2git-marks.old hg2git-marks.new
 552         if [ -f hg2git-marks -a -s hg2git-marks ]; then
 553                 LC_ALL=C sed 's/^:\([^ ][^ ]*\) \([^ ][^ ]*\)$/\2 \1/' <hg2git-marks | {
 554                         if [ -n "$var_have_git_185" ]; then
 555                                 git cat-file --batch-check=':%(rest) %(objectname)'
 556                         else
 557                                 LC_ALL=C sed 's/^\([^ ][^ ]*\) \([^ ][^ ]*\)$/:\2 \1/'
 558                         fi
 559                 } | LC_ALL=C sed '/ missing$/d' >hg2git-marks.old
 560                 if [ -n "$var_have_git_171" ] && \
 561                    git rev-parse --quiet --verify refs/notes/hg >/dev/null; then
 562                         if [ -z "$var_have_git_185" ] || \
 563                            ! LC_ALL=C cmp -s hg2git-marks hg2git-marks.old; then
 564                                 _nm='hg-fast-export'
 565                                 GIT_AUTHOR_NAME="$_nm"
 566                                 GIT_COMMITTER_NAME="$_nm"
 567                                 GIT_AUTHOR_EMAIL="$_nm"
 568                                 GIT_COMMITTER_EMAIL="$_nm"
 569                                 export GIT_AUTHOR_NAME
 570                                 export GIT_COMMITTER_NAME
 571                                 export GIT_AUTHOR_EMAIL
 572                                 export GIT_COMMITTER_EMAIL
 573                                 git notes --ref=refs/notes/hg prune
 574                                 unset GIT_AUTHOR_NAME
 575                                 unset GIT_COMMITTER_NAME
 576                                 unset GIT_AUTHOR_EMAIL
 577                                 unset GIT_COMMITTER_EMAIL
 578                         fi
 579                 fi
 580         else
 581                 >hg2git-marks.old
 582         fi
 583         _err1=
 584         _err2=
 585         exec 3>&1
 586         { read -r _err1 || :; read -r _err2 || :; } <<-EOT
 587         $(
 588                 exec 4>&3 3>&1 1>&4 4>&-
 589                 {
 590                         _e1=0
 591                         _af="$(git config hg.authorsfile || :)"
 592                         _cmd='GIT_DIR="$(pwd)" "$_python" "$cfg_basedir/bin/hg-fast-export.py" \
 593                                 --repo    "$(pwd)/repo.hg" \
 594                                 --marks   "$(pwd)/hg2git-marks.old" \
 595                                 --mapping "$(pwd)/hg2git-mapping" \
 596                                 --heads   "$(pwd)/hg2git-heads" \
 597                                 --status  "$(pwd)/hg2git-state" \
 598                                 -U unknown --force --flatten --hg-hash'
 599                         [ -z "$_af" ] || _cmd="$_cmd"' --authors "$_af"'
 600                         eval "$_cmd" 3>&- || _e1=$?
 601                         echo $_e1 >&3
 602                 } | \
 603                 {
 604                         _e2=0
 605                         git fast-import \
 606                                 --import-marks="$(pwd)/hg2git-marks.old" \
 607                                 --export-marks="$(pwd)/hg2git-marks.new" \
 608                                 --export-pack-edges="$(pwd)/gfi-packs" \
 609                                 --force 3>&- || _e2=$?
 610                         echo $_e2 >&3
 611                 }
 612         )
 613         EOT
 614         exec 3>&-
 615         [ "$_err1" = 0 -a "$_err2" = 0 ] || return 1
 616         mv -f hg2git-marks.new hg2git-marks
 617         rm -f hg2git-marks.old
 618         git for-each-ref --format='%(refname) %(objectname)' refs/heads | \
 619         LC_ALL=C sed -e 's,^refs/heads/,:,' >hg2git-heads
 620 )