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