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