config: make the leading /r/ prefix optional on https?: URLs

[girocco.git] / shlib.sh

#!/bin/sh
#
# This is generic shell library for all the scripts used by Girocco;
# most importantly, it introduces all the $cfg_* shell variables.

get_girocco_config_var_list() {
        # Export all the variables from Girocco::Config to suitable var= lines
        # prefixing them with 'cfg_'. E.g. $cfg_admin is admin's mail address now
        # and also setting a 'defined_cfg_' prefix to 1 if they are not undef.
        __girocco_conf="$GIROCCO_CONF"
        [ -n "$__girocco_conf" ] || __girocco_conf="Girocco::Config"
        [ -z "$basedir" ] || __girocco_extrainc="-I$basedir"
        perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf -le \
                'foreach (keys %Girocco::Config::) {
                        my $val = ${$Girocco::Config::{$_}}; $val ||= "";
                        $val =~ s/([\\"!\$\`])/\\$1/gos;
                        $val =~ s/(?:\r\n|\r|\n)$//os;
                        print "cfg_$_=\"$val\"";
                        print "defined_cfg_$_=",
                                (defined(${$Girocco::Config::{$_}})?"1":"");
                }'
}

# If basedir has been replaced, and shlib_vars.sh exists, get the config
# definitions from it rather than running Perl.
if [ "@basedir@" = '@'basedir'@' ] || ! [ -r "@basedir@/shlib_vars.sh" ]; then
        # Import all the variables from Girocco::Config to the local environment,
        eval "$(get_girocco_config_var_list)"
else
        # Import the variables from shlib_vars.sh which avoids needlessly
        # running another copy of Perl
        . "@basedir@/shlib_vars.sh"
fi

git() (
        # some poorly behaving /bin/sh implementations do not
        # properly export variables when the command is actually
        # a shell function -- they are set for the function call
        # but not exported into the environment for anything the
        # function executes.  Export the two Git variables we
        # care about if they are set.  Since this is a subshell
        # the export will be temporary.
        [ -z "$GIT_DIR" ] || export GIT_DIR
        [ -z "$GIT_SSL_NO_VERIFY" ] || export GIT_SSL_NO_VERIFY
        exec "$cfg_git_bin" "$@"
)

nc_openbsd() { "$cfg_nc_openbsd_bin" "$@"; }

_addrlist() {
        _list=
        for _addr in "$@"; do
                [ -z "$_list" ] || _list="$_list, "
                _list="$_list$_addr"
        done
        echo "$_list"
}

_sendmail() {
        _mailer="${cfg_sendmail_bin:-/usr/sbin/sendmail}"
        if [ -n "$cfg_sender" ]; then
                "$_mailer" -i -f "$cfg_sender" "$@"
        else
                "$_mailer" -i "$@"
        fi
}

mail() {
        _subject=
        if [ "$1" = "-s" ]; then
                shift
                _subject="$1"
                shift
        fi
        {
                echo "From: \"$cfg_name\" ($cfg_title) <$cfg_admin>"
                echo "To: $(_addrlist "$@")"
                [ -z "$_subject" ] || echo "Subject: $_subject"
                echo "Auto-Submitted: auto-generated"
                echo ""
                cat
        } | _sendmail "$@"
}

# Supports both the bang CMD... and bang_eval CMD... functions
# Called when the command fails
# Should only be called from bang and bang_eval functions
bang_err() {
        if ! [ -e .banged ]; then
                bangmailok=true
                ! [ -f HEAD -a -f config -a -d objects ] ||
                bangmailok="$(GIT_DIR=. git config --bool gitweb.statusupdates 2>/dev/null || echo true)"
                bangaddrs=''
                [ "$bangmailok" = "false" -o -z "$mail" ] || bangaddrs="$mail"
                [ -z "$cfg_admincc" -o "$cfg_admincc" = "0" -o -z "$cfg_admin" ] ||
                if [ -z "$bangaddrs" ]; then bangaddrs="$cfg_admin"; else bangaddrs="$bangaddrs,$cfg_admin"; fi
                [ -z "$bangaddrs" ] ||
                {
                        echo "$* failed with error code $errcode"
                        echo ""
                        [ ! -n "$bang_once" ] || echo "you will not receive any more notifications until recovery"
                        echo "this status message may be disabled on the project admin page"
                        echo ""
                        echo "Log follows:"
                        echo ""
                        cat "$bang_log"
                } | mail -s "[$cfg_name] $proj $bang_action failed" "$bangaddrs"
        fi
        touch .banged
        bang_trap
        exit 1
}

# bang CMD... will execute the command with well-defined failure mode;
# set bang_action to string of the failed action ('clone', 'update', ...);
# pre-set bang_once=1 to make sure jobs banging on a repo repeatedly will
# not spam the owner; re-define the bang_trap() function to do custom
# cleanup before bailing out
bang() {
        if [ -n "$show_progress" ]; then
                exec 3>&1
                errcode=
                read -r errcode <<-EOT || :
                $(
                        exec 4>&3 3>&1 1>&4 4>&-
                        { "$@" 3>&- || echo $? >&3; } 2>&1 | tee -a "$bang_log"
                )
                EOT
                exec 3>&-
                if [ -z "$errcode" ]; then
                        # All right. Cool.
                        return;
                fi
        else
                if "$@" >>"$bang_log" 2>&1; then
                        # All right. Cool.
                        return;
                else
                        errcode="$?"
                fi
        fi
        bang_err "$@"
}

# bang_eval CMD... will evaluate the command with well-defined failure mode;
# Identical to bang CMD... except the command is eval'd instead of executed.
bang_eval() {
        if [ -n "$show_progress" ]; then
                exec 3>&1
                errcode=
                read -r errcode <<-EOT || :
                $(
                        exec 4>&3 3>&1 1>&4 4>&-
                        { eval "$*" 3>&- || echo $? >&3; } 2>&1 | tee -a "$bang_log"
                )
                EOT
                exec 3>&-
                if [ -z "$errcode" ]; then
                        # All right. Cool.
                        return;
                fi
        else
                if eval "$*" >>"$bang_log" 2>&1; then
                        # All right. Cool.
                        return;
                else
                        errcode="$?"
                fi
        fi
        bang_err "$@"
}

# Default bang settings:
bang_setup() {
        bang_action="lame_programmer"
        bang_once=
        bang_trap() { :; }
        bang_log="$(mktemp -t repomgr-XXXXXX)"
        trap "rm \"\$bang_log\"" EXIT
}


# Progress report - if show_progress is set, shows the given message.
progress() {
        [ ! -n "$show_progress" ] || echo "$@"
}


# Project config accessors; must be run in project directory
config_get() {
        git config "gitweb.$1"
}

config_set() {
        git config "gitweb.$1" "$2" && chgrp repo config && chmod g+w config
}

config_set_raw() {
        git config "$1" "$2"        && chgrp repo config && chmod g+w config
}


# Tool for checking whether given number of seconds has not passed yet
check_interval() {
        od="$(config_get "$1" || :)"
        [ -n "$od" ] || return 1
        os="$(perl -I@basedir@ -MGirocco::Util -e "print parse_rfc2822_date('$od')")"
        [ -n "$os" ] || return 1
        ns="$(date +%s)"
        [ $ns -lt $(($os+$2)) ]
}


# List all Git repositories, with given prefix if specified, one-per-line
get_repo_list() {
        if [ -n "$1" ]; then
                cut -d : -f 1,3 "$cfg_chroot"/etc/group | grep "^$1"
        else
                cut -d : -f 1,3 "$cfg_chroot"/etc/group
        fi | while IFS=: read name id; do
                [ $id -lt 65536 ] || echo "$name"
        done
}