Notify.pm: ignore updates for other than branches and tags
[girocco/readme.git] / shlib.sh
blob8a3878011c2fcd407785e441bf6c2b22be2212ca
1 #!/bin/sh
3 # This is generic shell library for all the scripts used by Girocco;
4 # most importantly, it introduces all the $cfg_* shell variables.
6 # SHA-1 patterns
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 nullsha="0000000000000000000000000000000000000000"
12 # tab
13 tab="$(printf '\t')"
15 # set a sane umask that never excludes any user or group permissions
16 umask $(printf '0%03o' $(( $(umask) & ~0770 )) )
18 vcmp() {
19 # Compare $1 to $2 each of which must match \d+(\.\d+)*
20 # An empty string ('') for $1 or $2 is treated like 0
21 # Outputs:
22 # -1 if $1 < $2
23 # 0 if $1 = $2
24 # 1 if $1 > $2
25 # Note that `vcmp 1.8 1.8.0.0.0.0` correctly outputs 0.
26 while
27 _a="${1%%.*}"
28 _b="${2%%.*}"
29 [ -n "$_a" -o -n "$_b" ]
31 if [ "${_a:-0}" -lt "${_b:-0}" ]; then
32 echo -1
33 return
34 elif [ "${_a:-0}" -gt "${_b:-0}" ]; then
35 echo 1
36 return
38 _a2="${1#$_a}"
39 _b2="${2#$_b}"
40 set -- "${_a2#.}" "${_b2#.}"
41 done
42 echo 0
45 get_girocco_config_pm_var_list() {
46 # Export all the variables from Girocco::Config to suitable var= lines
47 # prefixing them with 'cfg_'. E.g. $cfg_admin is admin's mail address now
48 # and also setting a 'defined_cfg_' prefix to 1 if they are not undef.
49 __girocco_conf="$GIROCCO_CONF"
50 [ -n "$__girocco_conf" ] || __girocco_conf="Girocco::Config"
51 [ -z "$basedir" ] || __girocco_extrainc="-I$basedir"
52 perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf -le \
53 'foreach (sort {uc($a) cmp uc($b)} keys %Girocco::Config::) {
54 my $val = ${$Girocco::Config::{$_}}; defined($val) or $val="";
55 $val =~ s/([\\"\$\`])/\\$1/gos;
56 $val =~ s/(?:\r\n|\r|\n)$//os;
57 print "cfg_$_=\"$val\"";
58 print "defined_cfg_$_=",
59 (defined(${$Girocco::Config::{$_}})?"1":"");
63 get_girocco_config_var_list() (
64 # Same as get_girocco_config_pm_var_list except that
65 # the following variables (all starting with var_) are added:
66 # var_group cfg_owning_group if defined otherwise `id -gn`
67 # var_git_ver The version number part from `git version`
68 # var_git_exec_path The result of $cfg_git_bin --exec-dir
69 # var_perl_bin Full path to the perl interpreter to use
70 # var_have_git_172 Set to 1 if git version >= 1.7.2 otherwise ''
71 # var_have_git_173 Set to 1 if git version >= 1.7.3 otherwise ''
72 # var_window_memory Value to use for repack --window-memory=
73 # var_big_file_threshold Value to use for core.bigFileThreshold
74 # var_redelta_threshold Recompute deltas if no more than this many objs
75 # var_log_window_size Value to use for git-svn --log-window-size=
76 # var_utf8_locale Value to use for a UTF-8 locale if available
77 # var_xargs_r A "-r" if xargs needs it to behave correctly
78 # var_du_exclude Option to exclude PATTERN from du if available
79 # var_du_follow Option to follow command line sym links if available
80 _cfg_vars="$(get_girocco_config_pm_var_list)"
81 eval "$_cfg_vars"
82 printf '%s\n' "$_cfg_vars"
83 printf 'var_group=%s\n' "${cfg_owning_group:-$(id -gn)}"
84 _gver="$("$cfg_git_bin" version 2>/dev/null | \
85 LC_ALL=C sed -ne 's/^[^0-9]*\([0-9][0-9]*\(\.[0-9][0-9]*\)*\).*$/\1/p')"
86 printf 'var_git_ver=%s\n' "$_gver"
87 printf 'var_git_exec_path="%s"\n' "$("$cfg_git_bin" --exec-path 2>/dev/null)"
88 printf 'var_perl_bin="%s"\n' "${cfg_perl_bin:-$(unset -f perl; command -v perl)}"
89 printf 'var_have_git_172=%s\n' "$([ $(vcmp "$_gver" 1.7.2) -ge 0 ] && echo 1)"
90 printf 'var_have_git_173=%s\n' "$([ $(vcmp "$_gver" 1.7.3) -ge 0 ] && echo 1)"
91 __girocco_conf="$GIROCCO_CONF"
92 [ -n "$__girocco_conf" ] || __girocco_conf="Girocco::Config"
93 [ -z "$basedir" ] || __girocco_extrainc="-I$basedir"
94 printf "var_window_memory=%s\n" \
95 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
96 -MGirocco::Util -e 'print calc_windowmemory')"
97 printf "var_big_file_threshold=%s\n" \
98 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
99 -MGirocco::Util -e 'print calc_bigfilethreshold')"
100 printf "var_redelta_threshold=%s\n" \
101 "$(perl -I@basedir@ $__girocco_extrainc -M$__girocco_conf \
102 -MGirocco::Util -e 'print calc_redeltathreshold')"
103 printf 'var_log_window_size=%s\n' "${cfg_svn_log_window_size:-250}"
104 # We parse the output of `locale -a` and select a suitable UTF-8 locale.
105 _guess_locale="$(locale -a | LC_ALL=C grep -viE '^(posix|c)(\..*)?$' | \
106 LC_ALL=C grep -iE '\.utf-?8$' | LC_ALL=C sed -e 's/\.[Uu][Tt][Ff]-*8$//' | \
107 LC_ALL=C sed -e '/en_US/ s/^/0 /; /en_US/ !s/^/1 /' | LC_ALL=C sort | \
108 head -n 1 | LC_ALL=C cut -d ' ' -f 2)"
109 [ -z "$_guess_locale" ] || printf 'var_utf8_locale=%s.UTF-8\n' "$_guess_locale"
110 # On some broken platforms running xargs without -r and empty input runs the command
111 printf 'var_xargs_r=%s\n' "$(: | command xargs echo -r)"
112 # The disk usage report produces better numbers if du has an exclude option
113 _x0="$(basename "$0")"
114 _x0="${_x0%?}?*"
115 for _duopt in --exclude -I; do
116 if _test="$(du $_duopt 's?lib.s*' $_duopt "$_x0" "$0" 2>/dev/null)" && [ -z "$_test" ]; then
117 printf 'var_du_exclude=%s\n' "$_duopt"
118 break
120 done
121 if _test="$(du -H "$0" 2>/dev/null)" && [ -n "$_test" ]; then
122 printf 'var_du_follow=%s\n' "-H"
123 break
127 # If basedir has been replaced, and shlib_vars.sh exists, get the config
128 # definitions from it rather than running Perl.
129 if [ "@basedir@" = '@'basedir'@' ] || ! [ -r "@basedir@/shlib_vars.sh" ]; then
130 # Import all the variables from Girocco::Config to the local environment,
131 eval "$(get_girocco_config_var_list)"
132 else
133 # Import the variables from shlib_vars.sh which avoids needlessly
134 # running another copy of Perl
135 . "@basedir@/shlib_vars.sh"
138 # git_add_config "some.var=value"
139 # every ' in value must be replaced with the 4-character sequence '\'' before
140 # calling this function or Git will barf. Will not be effective unless running
141 # Git version 1.7.3 or later.
142 git_add_config() {
143 GIT_CONFIG_PARAMETERS="${GIT_CONFIG_PARAMETERS:+$GIT_CONFIG_PARAMETERS }'$1'"
144 export GIT_CONFIG_PARAMETERS
147 # Make sure we have a reproducible environment by using a controlled HOME dir
148 XDG_CONFIG_HOME="$cfg_chroot/var/empty"
149 HOME="$cfg_chroot/etc/girocco"
150 GIT_CONFIG_NOSYSTEM=1
151 GIT_ATTR_NOSYSTEM=1
152 GIT_NO_REPLACE_OBJECTS=1
153 GIT_TERMINAL_PROMPT=0
154 GIT_ASKPASS="$cfg_basedir/bin/git-askpass-password"
155 export XDG_CONFIG_HOME
156 export HOME
157 export GIT_CONFIG_NOSYSTEM
158 export GIT_ATTR_NOSYSTEM
159 export GIT_NO_REPLACE_OBJECTS
160 export GIT_TERMINAL_PROMPT
161 export GIT_ASKPASS
162 unset GIT_USER_AGENT
163 unset GIT_HTTP_USER_AGENT
164 if [ -n "$defined_cfg_git_client_ua" ]; then
165 GIT_USER_AGENT="$cfg_git_client_ua"
166 export GIT_USER_AGENT
167 GIT_HTTP_USER_AGENT="$cfg_git_client_ua"
168 export GIT_HTTP_USER_AGENT
170 unset GIT_CONFIG_PARAMETERS
171 [ -z "$var_big_file_threshold" ] ||
172 git_add_config "core.bigFileThreshold=$var_big_file_threshold"
174 # We cannot use a git() {} or nc_openbsd() {} function to redirect git
175 # and nc_openbsd to the desired executables because when using
176 # "ENV_VAR=xxx func" the various /bin/sh implementations behave in various
177 # different and unexpected ways:
178 # a) treat "ENV_VAR=xxx" like a separate, preceding "export ENV_VAR=xxx"
179 # b) treat "ENV_VAR=xxx" like a separate, prededing "ENV_VAR=xxx"
180 # c) treat "ENV_VAR=xxx" like a temporary setting only while running func
181 # None of these are good. We want a temporary "export ENV_VAR=xxx"
182 # setting only while running func which none of the /bin/sh's do.
184 # Instead we'd like to use an alias that provides the desired behavior without
185 # any of the bad (a), (b) or (c) effects.
187 # However, unfortunately, some of the crazy /bin/sh implementations do not
188 # recognize alias expansions when preceded by variable assignments!
190 # So we are left with git() {} and nc_openbsd() {} functions and in the
191 # case of git() {} we can compensate for (b) and (c) failing to export
192 # but not (a) and (b) persisting the values so the caller will simply
193 # have to beware and explicitly unset any variables that should not persist
194 # beyond the function call itself.
196 git() (
197 [ "${GIT_DIR+set}" = "set" ] && export GIT_DIR
198 [ "${GIT_SSL_NO_VERIFY+set}" = "set" ] && export GIT_SSL_NO_VERIFY
199 [ "${GIT_TRACE_PACKET+set}" = "set" ] && export GIT_TRACE_PACKET
200 [ "${GIT_USER_AGENT+set}" = "set" ] && export GIT_USER_AGENT
201 [ "${GIT_HTTP_USER_AGENT+set}" = "set" ] && export GIT_HTTP_USER_AGENT
202 exec "$cfg_git_bin" "$@"
205 # see comments for git() -- callers must explicitly export all variables
206 # intended for the perl interpreter before using this function
207 perl() { command "${var_perl_bin:-perl}" "$@"; }
209 nc_openbsd() { "$cfg_nc_openbsd_bin" "$@"; }
211 list_packs() { command "$cfg_basedir/bin/list_packs" "$@"; }
213 strftime() { command "$cfg_basedir/bin/strftime" "$@"; }
215 # Some platforms' broken xargs runs the command always at least once even if
216 # there's no input unless given a special option. Automatically supply the
217 # option on those platforms by providing an xargs function.
218 xargs() { command xargs $var_xargs_r "$@"; }
220 _addrlist() {
221 _list=
222 for _addr in "$@"; do
223 [ -z "$_list" ] || _list="$_list, "
224 _list="$_list$_addr"
225 done
226 echo "$_list"
229 _sendmail() {
230 _mailer="${cfg_sendmail_bin:-/usr/sbin/sendmail}"
231 if [ -n "$cfg_sender" ]; then
232 "$_mailer" -i -f "$cfg_sender" "$@"
233 else
234 "$_mailer" -i "$@"
238 mail() {
239 _subject=
240 if [ "$1" = "-s" ]; then
241 shift
242 _subject="$1"
243 shift
246 echo "From: \"$cfg_name\" ($cfg_title) <$cfg_admin>"
247 echo "To: $(_addrlist "$@")"
248 [ -z "$_subject" ] || echo "Subject: $_subject"
249 echo "MIME-Version: 1.0"
250 echo "Content-Type: text/plain; charset=utf-8"
251 echo "Content-Transfer-Encoding: 8bit"
252 [ -n "$cfg_suppress_x_girocco" ] || echo "X-Girocco: $cfg_gitweburl"
253 echo "Auto-Submitted: auto-generated"
254 echo ""
256 } | _sendmail "$@"
259 # bang CMD... will execute the command with well-defined failure mode;
260 # set bang_action to string of the failed action ('clone', 'update', ...);
261 # pre-set bang_once=1 to make sure jobs banging on a repo repeatedly will
262 # not spam the owner; re-define the bang_trap() function to do custom
263 # cleanup before bailing out
264 bang() {
265 if [ -n "$show_progress" ]; then
266 exec 3>&1
267 errcode=
268 read -r errcode <<-EOT || :
270 exec 4>&3 3>&1 1>&4 4>&-
271 { "$@" 3>&- || echo $? >&3; } 2>&1 | tee -a "$bang_log"
274 exec 3>&-
275 if [ -z "$errcode" ]; then
276 # All right. Cool.
277 return;
279 else
280 if "$@" >>"$bang_log" 2>&1; then
281 # All right. Cool.
282 return;
283 else
284 errcode="$?"
287 if ! [ -e .banged ] || [ -e .bangagain ]; then
288 rm -f .bangagain
289 bangmailok=true
290 ! [ -f HEAD -a -f config -a -d objects ] ||
291 bangmailok="$(GIT_DIR=. git config --bool gitweb.statusupdates 2>/dev/null || echo true)"
292 bangaddrs=''
293 [ "$bangmailok" = "false" -o -z "$mail" ] || bangaddrs="$mail"
294 [ -z "$cfg_admincc" -o "$cfg_admincc" = "0" -o -z "$cfg_admin" ] ||
295 if [ -z "$bangaddrs" ]; then bangaddrs="$cfg_admin"; else bangaddrs="$bangaddrs,$cfg_admin"; fi
296 [ -z "$bangaddrs" ] ||
298 echo "$* failed with error code $errcode"
299 echo ""
300 [ ! -n "$bang_once" ] || echo "you will not receive any more notifications until recovery"
301 echo "this status message may be disabled on the project admin page"
302 echo ""
303 echo "Log follows:"
304 echo ""
305 cat "$bang_log"
306 } | mail -s "[$cfg_name] $proj $bang_action failed" "$bangaddrs"
308 touch .banged
309 cat "$bang_log" > .banglog
310 bang_trap
311 exit 1
314 # bang_eval CMD... will evaluate the command with well-defined failure mode;
315 # Identical to bang CMD... except the command is eval'd instead of executed.
316 bang_eval() {
317 bang eval "$*"
320 # Default bang settings:
321 bang_setup() {
322 bang_action="lame_programmer"
323 bang_once=
324 bang_trap() { :; }
325 bang_log="$(mktemp -t repomgr-XXXXXX)"
326 trap 'rm -f "$bang_log"' EXIT
327 trap 'exit 130' INT
328 trap 'exit 143' TERM
331 # Remove banged status
332 bang_reset() {
333 rm -f .banged .bangagain .banglog
336 # Check to see if banged status
337 is_banged() {
338 [ -e .banged ]
342 # Progress report - if show_progress is set, shows the given message.
343 progress() {
344 [ ! -n "$show_progress" ] || echo "$@"
348 # Project config accessors; must be run in project directory
349 config_get() {
350 git config "gitweb.$1"
353 config_set() {
354 git config "gitweb.$1" "$2" && chgrp $var_group config && chmod g+w config
357 config_set_raw() {
358 git config "$1" "$2" && chgrp $var_group config && chmod g+w config
361 config_get_date_seconds() {
362 _dt="$(config_get "$1" || :)"
363 [ -n "$_dt" ] || return 1
364 _ds="$(perl -I@basedir@ -MGirocco::Util -e "print parse_rfc2822_date('$_dt')")"
365 [ -n "$_ds" ] || return 1
366 echo "$_ds"
369 # Tool for checking whether given number of seconds has not passed yet
370 check_interval() {
371 os="$(config_get_date_seconds "$1")" || return 1
372 ns="$(date +%s)"
373 [ $ns -lt $(($os+$2)) ]
376 # Check if we are running with effective root permissions
377 is_root() {
378 [ "$(id -u 2>/dev/null)" = "0" ]
381 # Check to see if the single argument is a Git directory
382 is_git_dir() {
383 # Just like Git's test except we ignore GIT_OBJECT_DIRECTORY
384 # And we are slightly more picky (must be refs/.+ not refs/.*)
385 [ -d "$1/objects" -a -x "$1/objects" ] || return 1
386 [ -d "$1/refs" -a -x "$1/refs" ] || return 1
387 if [ -L "$1/HEAD" ]; then
388 _hr="$(readlink "$1/HEAD")"
389 case "$_hr" in "refs/"?*) :;; *) return 1;; esac
391 [ -f "$1/HEAD" -a -r "$1/HEAD" ] || return 1
392 read -r _hr <"$1/HEAD" || return 1
393 case "$_hr" in
394 $octet20)
395 return 0;;
396 ref:*)
397 _hr="${_hr##ref:*[ $tab]}"
398 case "$_hr" in "refs/"?*) return 0;; esac
399 esac
400 return 1
403 # List all Git repositories, with given prefix if specified, one-per-line
404 # All project names starting with _ are always excluded from the result
405 get_repo_list() {
406 if [ -n "$1" ]; then
407 LC_ALL=C cut -d : -f 1,3 "$cfg_chroot"/etc/group | LC_ALL=C grep "^$1"
408 else
409 LC_ALL=C cut -d : -f 1,3 "$cfg_chroot"/etc/group
410 fi | while IFS=: read name id; do
411 [ $id -lt 65536 ] || case "$name" in _*) :;; ?*) echo "$name"; esac
412 done
415 # Return success if the given project name has any forks
416 has_forks() {
417 _prj="${1%.git}"
418 [ -n "$_prj" ] || return 1
419 [ -d "$cfg_reporoot/$_prj" ] || return 1
420 is_git_dir "$cfg_reporoot/$_prj.git" || return 1
421 test $(get_repo_list "$_prj/[^/][^/]*:" | LC_ALL=C wc -l) -gt 0
424 # returns empty string and error for empty string otherwise one of
425 # m => normal Git mirror
426 # s => mirror from svn source
427 # d => mirror from darcs source
428 # b => mirror from bzr source
429 # h => mirror from hg source
430 # note that if the string is non-empty and none of s, d, b or h match the
431 # return will always be type m regardless of whether it's a valid Git URL
432 get_url_mirror_type() {
433 case "$1" in
435 return 1
437 svn://* | svn+http://* | svn+https://* | svn+file://* | svn+ssh://*)
438 echo 's'
440 darcs://*)
441 echo 'd'
443 bzr://*)
444 echo 'b'
446 hg+http://* | hg+https://*)
447 echo 'h'
450 echo 'm'
452 esac
453 return 0
456 # returns get_url_mirror_type for gitweb.base url of git directory
457 # (GIT_DIR) passed in as the argument (which defaults to "." if omitted)
458 # will fail if the directory does not have .nofetch and gitweb.baseurl
459 # comes back empty -- otherwise .nofetch directories succed with a "" return
460 # automatically strips any leading "disabled " prefix before testing
461 get_mirror_type() {
462 _gitdir="${1:-.}"
463 # always return empty for non-mirrors
464 [ ! -e "$_gitdir/.nofetch" ] || return 0
465 _url="$(GIT_DIR="$_gitdir" config_get baseurl 2>/dev/null || :)"
466 _url="${_url##* }"
467 [ -n "$_url" ] || return 1
468 get_url_mirror_type "$_url"
471 # returns true if the passed in git dir (defaults to ".") is a mirror using git fast-import
472 is_gfi_mirror() {
473 case "$(get_mirror_type "$1" 2>/dev/null || :)" in
474 d|b|h)
475 # darcs, bzr and hg mirrors use git fast-import
476 return 0
479 # Don't think git-svn currently uses git fast-import
480 # And Git mirrors certainly do not
481 return 1
483 esac
484 # assume it does not use git fast-import
485 return 1
488 # returns true if the passed in git dir (defaults to ".") is a mirror using git-svn
489 is_svn_mirror() {
490 [ "$(get_mirror_type "$1" 2>/dev/null || :)" = "s" ]
493 # A well-known UTF-8 locale is required for some of the fast-import providers
494 # in order to avoid mangling characters. Ideally we could use "POSIX.UTF-8"
495 # but that is not reliably UTF-8 but rather usually US-ASCII.
496 # We parse the output of `locale -a` and select a suitable UTF-8 locale at
497 # install time and store that in $var_utf8_locale if one is found.
498 # If we cannot find one in the `locale -a` output then we just use a well-known
499 # UTF-8 locale and hope for the best. We set LC_ALL to our choice and export
500 # it. We only set this temporarily when running the fast-import providers.
501 set_utf8_locale() {
502 LC_ALL="${var_utf8_locale:-en_US.UTF-8}"
503 export LC_ALL
506 # hg-fast-export | git fast-import with error handling in current directory GIT_DIR
507 git_hg_fetch() (
508 set_utf8_locale
509 _python="${PYTHON:-python}"
510 _err1=
511 _err2=
512 exec 3>&1
513 { read -r _err1 || :; read -r _err2 || :; } <<-EOT
515 exec 4>&3 3>&1 1>&4 4>&-
517 _e1=0
518 [ -f hg2git-marks ] || touch hg2git-marks
519 _af="$(git config hg.authorsfile || :)"
520 _cmd='GIT_DIR="$(pwd)" "$_python" "$cfg_basedir/bin/hg-fast-export.py" \
521 --repo "$(pwd)/repo.hg" \
522 --marks "$(pwd)/hg2git-marks" \
523 --mapping "$(pwd)/hg2git-mapping" \
524 --heads "$(pwd)/hg2git-heads" \
525 --status "$(pwd)/hg2git-state" \
526 -U unknown --force --flatten --hg-hash'
527 [ -z "$_af" ] || _cmd="$_cmd"' --authors "$_af"'
528 eval "$_cmd" 3>&- || _e1=$?
529 echo $_e1 >&3
530 } | \
532 _e2=0
533 rm -f hg2git-marks.new
534 git fast-import \
535 --export-marks="$(pwd)/hg2git-marks.new" \
536 --export-pack-edges="$(pwd)/gfi-packs" \
537 --force 3>&- || _e2=$?
538 echo $_e2 >&3
542 exec 3>&-
543 [ "$_err1" = 0 -a "$_err2" = 0 ] || return 1
544 if [ -f hg2git-marks ]; then
545 rm -f hg2git-marks.old
546 mv hg2git-marks hg2git-marks.old
547 else
548 touch hg2git-marks.old
550 cat hg2git-marks.old hg2git-marks.new | \
551 LC_ALL=C sort -t : -k2,2n -u | \
552 LC_ALL=C sed -ne "/^:[1-9][0-9]* $octet20\$/p" > hg2git-marks
553 rm hg2git-marks.old hg2git-marks.new
554 rm -f hg2git-heads
555 git branch --no-color | \
556 while IFS= read -r _head; do
557 echo ":${_head#??} $(git rev-parse "refs/heads/${_head#??}")"
558 done > hg2git-heads