61f6967f67
...there was one real bug, plus I had forgotten to put a comented out line in the rc file, but most of the rest of the effort was moving the test script over. oh and I'd also forgotten to move this from 'commands' to 'triggers' :-)
327 lines
9.5 KiB
Perl
327 lines
9.5 KiB
Perl
package Gitolite::Rc;
|
|
|
|
# everything to do with 'rc'. Also defines some 'constants'
|
|
# ----------------------------------------------------------------------
|
|
|
|
@EXPORT = qw(
|
|
%rc
|
|
glrc
|
|
query_rc
|
|
version
|
|
trigger
|
|
|
|
$REMOTE_COMMAND_PATT
|
|
$REF_OR_FILENAME_PATT
|
|
$REPONAME_PATT
|
|
$REPOPATT_PATT
|
|
$USERNAME_PATT
|
|
$UNSAFE_PATT
|
|
);
|
|
|
|
use Exporter 'import';
|
|
use Getopt::Long;
|
|
|
|
use Gitolite::Common;
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
our %rc;
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
# variables that could be overridden by the rc file
|
|
# ----------------------------------------------------------------------
|
|
|
|
$rc{GL_BINDIR} = $ENV{GL_BINDIR};
|
|
$rc{GL_REPO_BASE} = "$ENV{HOME}/repositories";
|
|
|
|
$rc{GL_ADMIN_BASE} = "$ENV{HOME}/.gitolite";
|
|
$rc{LOG_TEMPLATE} = "$ENV{HOME}/.gitolite/logs/gitolite-%y-%m.log";
|
|
|
|
# variables that should probably never be changed but someone will want to, I'll bet...
|
|
# ----------------------------------------------------------------------
|
|
|
|
$REMOTE_COMMAND_PATT = qr(^[- 0-9a-zA-Z\@\%_=+:,./]*$);
|
|
$REF_OR_FILENAME_PATT = qr(^[0-9a-zA-Z][0-9a-zA-Z._\@/+ :,-]*$);
|
|
$REPONAME_PATT = qr(^\@?[0-9a-zA-Z][0-9a-zA-Z._\@/+-]*$);
|
|
$REPOPATT_PATT = qr(^\@?[0-9a-zA-Z[][\\^.$|()[\]*+?{}0-9a-zA-Z._\@/,-]*$);
|
|
$USERNAME_PATT = qr(^\@?[0-9a-zA-Z][0-9a-zA-Z._\@+-]*$);
|
|
$UNSAFE_PATT = qr([`~#\$\&()|;<>]);
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
# find the rc file and 'do' it
|
|
# ----------------------------------------------------------------------
|
|
|
|
my $current_data_version = "3.0";
|
|
|
|
my $rc = glrc('filename');
|
|
do $rc if -r $rc;
|
|
if ( defined($GL_ADMINDIR) ) {
|
|
say2 "";
|
|
say2 "FATAL: $rc seems to be for older gitolite; please see doc/g2migr.mkd\n" .
|
|
"(online at http://sitaramc.github.com/gitolite/g3/g2migr.html)";
|
|
|
|
exit 1;
|
|
}
|
|
# let values specified in rc file override our internal ones
|
|
@rc{ keys %RC } = values %RC;
|
|
|
|
# (testing only) testing sometimes requires all of it to be overridden
|
|
# silently; use an env var that is highly unlikely to appear in real life :)
|
|
do $ENV{G3T_RC} if exists $ENV{G3T_RC} and -r $ENV{G3T_RC};
|
|
|
|
# fix some env vars, setup gitolite internal "env" vars (aka rc vars)
|
|
# ----------------------------------------------------------------------
|
|
|
|
$ENV{PATH} = "$ENV{GL_BINDIR}:$ENV{PATH}";
|
|
|
|
{
|
|
$rc{GL_TID} = $ENV{GL_TID} ||= $$;
|
|
# TID: loosely, transaction ID. The first PID at the entry point passes
|
|
# it down to all its children so you can track each access, across all the
|
|
# various commands it spawns and actions it generates.
|
|
|
|
$rc{GL_LOGFILE} = $ENV{GL_LOGFILE} ||= gen_lfn( $rc{LOG_TEMPLATE} );
|
|
}
|
|
|
|
# these two are meant to help externally written commands (see
|
|
# src/commands/writes for an example)
|
|
$ENV{GL_REPO_BASE} = $rc{GL_REPO_BASE};
|
|
$ENV{GL_ADMIN_BASE} = $rc{GL_ADMIN_BASE};
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
my $glrc_default_text = '';
|
|
{
|
|
local $/ = undef;
|
|
$glrc_default_text = <DATA>;
|
|
}
|
|
|
|
sub glrc {
|
|
my $cmd = shift;
|
|
if ( $cmd eq 'default-filename' ) {
|
|
return "$ENV{HOME}/.gitolite.rc";
|
|
} elsif ( $cmd eq 'default-text' ) {
|
|
return $glrc_default_text if $glrc_default_text;
|
|
_die "rc file default text not set; this should not happen!";
|
|
} elsif ( $cmd eq 'filename' ) {
|
|
# where is the rc file?
|
|
|
|
# search $HOME first
|
|
return "$ENV{HOME}/.gitolite.rc" if -f "$ENV{HOME}/.gitolite.rc";
|
|
|
|
return '';
|
|
} elsif ( $cmd eq 'current-data-version' ) {
|
|
return $current_data_version;
|
|
} else {
|
|
_die "unknown argument to glrc: $cmd";
|
|
}
|
|
}
|
|
|
|
# exported functions
|
|
# ----------------------------------------------------------------------
|
|
|
|
my $all = 0;
|
|
my $nonl = 0;
|
|
my $quiet = 0;
|
|
|
|
sub query_rc {
|
|
|
|
my @vars = args();
|
|
|
|
no strict 'refs';
|
|
|
|
if ($all) {
|
|
for my $e ( sort keys %rc ) {
|
|
print "$e=" . ( defined( $rc{$e} ) ? $rc{$e} : 'undef' ) . "\n";
|
|
}
|
|
exit 0;
|
|
}
|
|
|
|
my @res = map { $rc{$_} } grep { $rc{$_} } @vars;
|
|
print join( "\t", @res ) . ( $nonl ? '' : "\n" ) if not $quiet and @res;
|
|
# shell truth
|
|
exit 0 if @res;
|
|
exit 1;
|
|
}
|
|
|
|
sub version {
|
|
my $version = '';
|
|
$version = '(unknown)';
|
|
for ("$rc{GL_ADMIN_BASE}/VERSION") {
|
|
$version = slurp($_) if -r $_;
|
|
}
|
|
chomp($version);
|
|
return $version;
|
|
}
|
|
|
|
sub trigger {
|
|
my $rc_section = shift;
|
|
|
|
if ( exists $rc{$rc_section} ) {
|
|
if ( ref( $rc{$rc_section} ) ne 'ARRAY' ) {
|
|
_die "$rc_section section in rc file is not a perl list";
|
|
} else {
|
|
for my $s ( @{ $rc{$rc_section} } ) {
|
|
|
|
my ($pgm, @args) = split ' ', $s;
|
|
$pgm = "$ENV{GL_BINDIR}/triggers/$pgm";
|
|
|
|
_warn("skipped command '$s'"), next if not -x $pgm;
|
|
trace( 2, "command: $s" );
|
|
_system( $pgm, @args, $rc_section, @_ ); # they better all return with 0 exit codes!
|
|
}
|
|
}
|
|
return;
|
|
}
|
|
trace( 2, "'$rc_section' not found in rc" );
|
|
}
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
=for args
|
|
Usage: gitolite query-rc -a
|
|
gitolite query-rc [-n] <list of rc variables>
|
|
|
|
-a print all variables and values
|
|
-n do not append a newline
|
|
-q exit code only (shell truth; 0 is success)
|
|
|
|
Example:
|
|
|
|
gitolite query-rc GL_ADMIN_BASE UMASK
|
|
# prints "/home/git/.gitolite<tab>0077" or similar
|
|
|
|
gitolite query-rc -a
|
|
# prints all known variables and values, one per line
|
|
|
|
Note: '-q' is best used with only one variable.
|
|
=cut
|
|
|
|
sub args {
|
|
my $help = 0;
|
|
|
|
GetOptions(
|
|
'all|a' => \$all,
|
|
'nonl|n' => \$nonl,
|
|
'quiet|q' => \$quiet,
|
|
'help|h' => \$help,
|
|
) or usage();
|
|
|
|
usage("'-a' cannot be combined with other arguments or options") if $all and ( @ARGV or $nonl or $quiet );
|
|
usage() if not $all and not @ARGV or $help;
|
|
return @ARGV;
|
|
}
|
|
|
|
1;
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
__DATA__
|
|
# configuration variables for gitolite
|
|
|
|
# This file is in perl syntax. But you do NOT need to know perl to edit it --
|
|
# just mind the commas, use single quotes unless you know what you're doing,
|
|
# and make sure the brackets and braces stay matched up!
|
|
|
|
# (Tip: perl allows a comma after the last item in a list also!)
|
|
|
|
%RC = (
|
|
UMASK => 0077,
|
|
GIT_CONFIG_KEYS => '',
|
|
|
|
# settings used by external programs; uncomment and change as needed. You
|
|
# can add your own variables for use in your own external programs; take a
|
|
# look at the cpu-time and desc commands for perl and shell samples.
|
|
|
|
# used by the cpu-time command
|
|
# DISPLAY_CPU_TIME => 1,
|
|
# CPU_TIME_WARN_LIMIT => 0.1,
|
|
# used by the desc command
|
|
# WRITER_CAN_UPDATE_DESC => 1,
|
|
# used by the info command
|
|
# SITE_INFO => 'Please see http://blahblah/gitolite for more help',
|
|
|
|
# add more roles (like MANAGER, TESTER, ...) here.
|
|
# WARNING: if you make changes to this hash, you MUST run 'gitolite
|
|
# compile' afterward, and possibly also 'gitolite trigger POST_COMPILE'
|
|
ROLES =>
|
|
{
|
|
READERS => 1,
|
|
WRITERS => 1,
|
|
},
|
|
# uncomment (and change) this if you wish
|
|
# DEFAULT_ROLE_PERMS => 'READERS @all',
|
|
|
|
# comment out or uncomment as needed
|
|
# these are available to remote users
|
|
COMMANDS =>
|
|
{
|
|
'help' => 1,
|
|
'info' => 1,
|
|
'desc' => 1,
|
|
'perms' => 1,
|
|
'writes' => 1,
|
|
},
|
|
|
|
# comment out or uncomment as needed
|
|
# these will run in sequence during the conf file parse
|
|
SYNTACTIC_SUGAR =>
|
|
[
|
|
# 'continuation-lines',
|
|
],
|
|
|
|
# comment out or uncomment as needed
|
|
# these will run in sequence at the start, before a git operation has started
|
|
PRE_GIT =>
|
|
[
|
|
# if you use this, make this the first item in the list
|
|
# 'renice 10',
|
|
|
|
# see docs ("list of non-core programs shipped") for details
|
|
# 'partial-copy',
|
|
],
|
|
|
|
# comment out or uncomment as needed
|
|
# these will run in sequence at the end, after a git operation has ended
|
|
POST_GIT =>
|
|
[
|
|
# if you use this, make this the last item in the list
|
|
# 'cpu-time',
|
|
],
|
|
|
|
# comment out or uncomment as needed
|
|
# these will run in sequence after post-update
|
|
POST_COMPILE =>
|
|
[
|
|
'post-compile/ssh-authkeys',
|
|
'post-compile/update-git-configs',
|
|
'post-compile/update-gitweb-access-list',
|
|
'post-compile/update-git-daemon-access-list',
|
|
],
|
|
|
|
# comment out or uncomment as needed
|
|
# these will run in sequence after a new wild repo is created
|
|
POST_CREATE =>
|
|
[
|
|
'post-compile/update-git-configs',
|
|
'post-compile/update-gitweb-access-list',
|
|
'post-compile/update-git-daemon-access-list',
|
|
],
|
|
);
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# per perl rules, this should be the last line in such a file:
|
|
1;
|
|
|
|
# Local variables:
|
|
# mode: perl
|
|
# End:
|
|
# vim: set syn=perl:
|