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