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