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