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