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