#!/usr/bin/env bash # Tests to ensure that the monkeysphere is working # Authors: # Daniel Kahn Gillmor # Jameson Rollins # Micah Anderson # # Copyright: 2008-2009 # License: GPL v3 or later # these tests should all be able to run as a non-privileged user. # all subcommands in this script should complete without failure: set -e # piped commands should return the code of the first non-zero return set -o pipefail # make sure the TESTDIR is an absolute path, not a relative one. export TESTDIR=$(cd $(dirname "$0") && pwd) source "$TESTDIR"/common ## make sure that the right tools are installed to run the test. the ## test has *more* requirements than plain ol' monkeysphere: which socat >/dev/null || { echo "You must have socat installed to run this test." ; exit 1; } ## FIXME: other checks? ###################################################################### ### FUNCTIONS # gpg command for test admin user gpgadmin() { chmod 0700 "$TEMPDIR"/admin GNUPGHOME="$TEMPDIR"/admin/.gnupg gpg "$@" } # test ssh connection # first argument is expected return code from ssh connection ssh_test() { umask 0077 CODE=${1:-0} # start the ssh daemon on the socket echo "##### starting ssh server..." socat EXEC:"/usr/sbin/sshd -f ${SSHD_CONFIG} -i -D -e" "UNIX-LISTEN:${SOCKET}" 2> "$TEMPDIR"/sshd.log & SSHD_PID="$!" # wait until the socket is created before continuing while [ ! -S "$SOCKET" ] ; do sleep 1 done set +e # make a client connection to the socket echo "##### starting ssh client..." ssh-agent bash -c \ "monkeysphere subkey-to-ssh-agent && ssh -F $TEMPDIR/testuser/.ssh/config testhost true" RETURN="$?" # kill the sshd process if it's still running kill "$SSHD_PID" SSHD_PID= set -e echo "##### return $RETURN" if [ "$RETURN" = "$CODE" ] ; then echo "##### ssh connection test returned as desired" return 0 else echo "##### ssh connection test failed. expected return code $CODE" return 1 fi } SSHD_PID= ## setup trap trap failed_cleanup EXIT ###################################################################### ### SETUP VARIABLES ## set up some variables to ensure that we're operating strictly in ## the tests, not system-wide: # set up temp dir # NOTE: /tmp can not be used as the temp dir here, since the # permissions on /tmp are usually such that they will not pass the # monkeysphere/ssh path permission checking. If you need to use a # different location than the current source, please set $TMPDIR # somewhere with tighter permissions. mkdir -p "$TESTDIR"/tmp TEMPDIR=$(mktemp -d "${TMPDIR:-$TESTDIR/tmp}/monkeyspheretest.XXXXXXX") # Use the local copy of executables first, instead of system ones. # This should help us test without installing. export PATH="$TESTDIR"/../src:"$TESTDIR"/../src/keytrans:"$PATH" export MONKEYSPHERE_SYSDATADIR="$TEMPDIR" export MONKEYSPHERE_SYSCONFIGDIR="$TEMPDIR" export MONKEYSPHERE_SYSSHAREDIR="$TESTDIR"/../src/share export MONKEYSPHERE_MONKEYSPHERE_USER=$(whoami) export MONKEYSPHERE_CHECK_KEYSERVER=false export MONKEYSPHERE_LOG_LEVEL=DEBUG export MONKEYSPHERE_CORE_KEYLENGTH=1024 export MONKEYSPHERE_PROMPT=false export SSHD_CONFIG="$TEMPDIR"/sshd_config export SOCKET="$TEMPDIR"/ssh-socket # Make sure $DISPLAY is set to convince ssh and monkeysphere to fall # back on $SSH_ASKPASS. Make sure it's not set to the current actual # $DISPLAY (if one exists) because this test suite should not be doing # *anything* with any running X11 session. export DISPLAY=monkeys ## make sure that the version number matches the debian changelog ## (don't bother if this is being run from the tests). if [ -f "$TESTDIR"/../packaging/debian/changelog ]; then echo "##################################################" echo "### checking version string match..." repver=$(monkeysphere version) debver=$(head -n1 "$TESTDIR"/../packaging/debian/changelog | sed 's/.*(\([^-]*\)-.*/\1/') if [ "$repver" = "$debver" ] ; then echo "Versions match!" else printf "reported version string (%s) does not match debian changelog (%s)\n" "$repver" "$debver" exit 1 fi fi ###################################################################### ### CONFIGURE ENVIRONMENTS # copy in admin and testuser home to tmp echo "##################################################" echo "### configuring testuser home..." cp -a "$TESTDIR"/home/testuser "$TEMPDIR"/ # set up environment for testuser export TESTHOME="$TEMPDIR"/testuser export GNUPGHOME="$TESTHOME"/.gnupg chmod 0700 "$GNUPGHOME" export SSH_ASKPASS="$TESTHOME"/.ssh/askpass export MONKEYSPHERE_HOME="$TESTHOME"/.monkeysphere cat <> "$TESTHOME"/.ssh/config UserKnownHostsFile $TESTHOME/.ssh/known_hosts IdentityFile $TESTHOME/.ssh/no-such-identity ProxyCommand $TESTHOME/.ssh/proxy-command %h %p $SOCKET EOF cat <> "$MONKEYSPHERE_HOME"/monkeysphere.conf KNOWN_HOSTS=$TESTHOME/.ssh/known_hosts EOF get_gpg_prng_arg >> "$GNUPGHOME"/gpg.conf echo "##################################################" echo "### configuring admin home..." cp -a "$TESTDIR"/home/admin "$TEMPDIR"/ # set up sshd echo "##################################################" echo "### configuring sshd..." cp "$TESTDIR"/etc/ssh/sshd_config "$SSHD_CONFIG" # write the sshd_config cat <> "$SSHD_CONFIG" HostKey ${MONKEYSPHERE_SYSDATADIR}/ssh_host_rsa_key AuthorizedKeysFile ${MONKEYSPHERE_SYSDATADIR}/authorized_keys/%u EOF ###################################################################### ### SERVER HOST SETUP # import host key echo "##################################################" echo "### import host key..." ssh-keygen -b 1024 -t rsa -N '' -f "$TEMPDIR"/ssh_host_rsa_key monkeysphere-host import-key testhost < "$TEMPDIR"/ssh_host_rsa_key echo "##################################################" echo "### getting host key fingerprint..." HOSTKEYID=$( monkeysphere-host show-key | grep '^OpenPGP fingerprint: ' | cut -f3 -d\ ) echo "$HOSTKEYID" # change host key expiration echo "##################################################" echo "### setting host key expiration..." monkeysphere-host set-expire 1 # FIXME: how do we check that the expiration has really been set? # certify host key with the "Admin's Key". # (this would normally be done via keyservers) echo "##################################################" echo "### certifying server host key..." GNUPGHOME="$MONKEYSPHERE_SYSCONFIGDIR"/host gpg --armor --export "$HOSTKEYID" | gpgadmin --import echo y | gpgadmin --command-fd 0 --sign-key "$HOSTKEYID" # FIXME: add revoker? # FIXME: how can we test publish-key without flooding junk into the # keyservers? # FIXME: should we run "diagnostics" here to test setup? ###################################################################### ### SERVER AUTHENTICATION SETUP # set up monkeysphere authentication echo "##################################################" echo "### setup monkeysphere authentication..." cp "$TESTDIR"/etc/monkeysphere/monkeysphere-authentication.conf "$TEMPDIR"/ cat <> "$TEMPDIR"/monkeysphere-authentication.conf AUTHORIZED_USER_IDS="$MONKEYSPHERE_HOME/authorized_user_ids" EOF monkeysphere-authentication setup get_gpg_prng_arg >> "$MONKEYSPHERE_SYSDATADIR"/authentication/sphere/gpg.conf # add admin as identity certifier for testhost echo "##################################################" echo "### adding admin as certifier..." monkeysphere-authentication add-id-certifier "$TEMPDIR"/admin/.gnupg/pubkey.gpg echo "##################################################" echo "### list certifiers..." monkeysphere-authentication list-certifiers # FIXME: should we run "diagnostics" here to test setup? ###################################################################### ### TESTUSER SETUP # generate an auth subkey for the test user that expires in 2 days echo "##################################################" echo "### generating key for testuser..." monkeysphere gen-subkey --expire 2 # add server key to testuser keychain echo "##################################################" echo "### export server key to testuser..." gpgadmin --armor --export "$HOSTKEYID" | gpg --import # teach the "server" about the testuser's key echo "##################################################" echo "### export testuser key to server..." gpg --export testuser | monkeysphere-authentication gpg-cmd --import # update authorized_keys for user echo "##################################################" echo "### update server authorized_keys file for this testuser..." monkeysphere-authentication update-users $(whoami) # FIXME: this is maybe not failing properly for: # ms: improper group or other writability on path '/tmp'. ###################################################################### ### TESTS # connect to test sshd, using monkeysphere ssh-proxycommand to verify # the identity before connection. This should work in both directions! echo "##################################################" echo "### ssh connection test for success..." ssh_test # remove the testuser's authorized_user_ids file, update, and make # sure that the ssh authentication FAILS echo "##################################################" echo "### removing testuser authorized_user_ids and updating..." mv "$TESTHOME"/.monkeysphere/authorized_user_ids{,.bak} monkeysphere-authentication update-users $(whoami) echo "##################################################" echo "### ssh connection test for server authentication denial..." ssh_test 255 mv "$TESTHOME"/.monkeysphere/authorized_user_ids{.bak,} # put improper permissions on authorized_user_ids file, update, and # make sure ssh authentication FAILS echo "##################################################" echo "### setting group writability on authorized_user_ids and updating..." chmod g+w "$TESTHOME"/.monkeysphere/authorized_user_ids monkeysphere-authentication update-users $(whoami) echo "##################################################" echo "### ssh connection test for server authentication denial..." ssh_test 255 chmod g-w "$TESTHOME"/.monkeysphere/authorized_user_ids echo "##################################################" echo "### setting other writability on authorized_user_ids and updating..." chmod o+w "$TESTHOME"/.monkeysphere/authorized_user_ids monkeysphere-authentication update-users $(whoami) echo "##################################################" echo "### ssh connection test for server authentication denial..." ssh_test 255 chmod o-w "$TESTHOME"/.monkeysphere/authorized_user_ids # FIXME: addtest: remove admin as id-certifier and check ssh failure # FIXME: addtest: add hostname on host key # FIXME: addtest: revoke hostname on host key and check ssh failure # FIXME: addtest: revoke the host key and check ssh failure ###################################################################### trap - EXIT echo "##################################################" echo " Monkeysphere basic tests completed successfully!" echo "##################################################" cleanup ass="hl ipl">@example.com',
  • description => "contact email for wiki",
  • safe => 1,
  • rebuild => 0,
  • },
  • adminuser => {
  • type => "string",
  • default => [],
  • description => "users who are wiki admins",
  • safe => 1,
  • rebuild => 0,
  • },
  • banned_users => {
  • type => "string",
  • default => [],
  • description => "users who are banned from the wiki",
  • safe => 1,
  • rebuild => 0,
  • },
  • srcdir => {
  • type => "string",
  • default => undef,
  • example => "$ENV{HOME}/wiki",
  • description => "where the source of the wiki is located",
  • safe => 0, # path
  • rebuild => 1,
  • },
  • destdir => {
  • type => "string",
  • default => undef,
  • example => "/var/www/wiki",
  • description => "where to build the wiki",
  • safe => 0, # path
  • rebuild => 1,
  • },
  • url => {
  • type => "string",
  • default => '',
  • example => "http://example.com/wiki",
  • description => "base url to the wiki",
  • safe => 1,
  • rebuild => 1,
  • },
  • cgiurl => {
  • type => "string",
  • default => '',
  • example => "http://example.com/wiki/ikiwiki.cgi",
  • description => "url to the ikiwiki.cgi",
  • safe => 1,
  • rebuild => 1,
  • },
  • cgi_wrapper => {
  • type => "string",
  • default => '',
  • example => "/var/www/wiki/ikiwiki.cgi",
  • description => "filename of cgi wrapper to generate",
  • safe => 0, # file
  • rebuild => 0,
  • },
  • cgi_wrappermode => {
  • type => "string",
  • default => '06755',
  • description => "mode for cgi_wrapper (can safely be made suid)",
  • safe => 0,
  • rebuild => 0,
  • },
  • rcs => {
  • type => "string",
  • default => '',
  • description => "rcs backend to use",
  • safe => 0, # don't allow overriding
  • rebuild => 0,
  • },
  • default_plugins => {
  • type => "internal",
  • default => [qw{mdwn link inline meta htmlscrubber passwordauth
  • openid signinedit lockedit conditional
  • recentchanges parentlinks editpage}],
  • description => "plugins to enable by default",
  • safe => 0,
  • rebuild => 1,
  • },
  • add_plugins => {
  • type => "string",
  • default => [],
  • description => "plugins to add to the default configuration",
  • safe => 1,
  • rebuild => 1,
  • },
  • disable_plugins => {
  • type => "string",
  • default => [],
  • description => "plugins to disable",
  • safe => 1,
  • rebuild => 1,
  • },
  • templatedir => {
  • type => "string",
  • default => "$installdir/share/ikiwiki/templates",
  • description => "additional directory to search for template files",
  • advanced => 1,
  • safe => 0, # path
  • rebuild => 1,
  • },
  • underlaydir => {
  • type => "string",
  • default => "$installdir/share/ikiwiki/basewiki",
  • description => "base wiki source location",
  • advanced => 1,
  • safe => 0, # path
  • rebuild => 0,
  • },
  • underlaydirbase => {
  • type => "internal",
  • default => "$installdir/share/ikiwiki",
  • description => "parent directory containing additional underlays",
  • safe => 0,
  • rebuild => 0,
  • },
  • wrappers => {
  • type => "internal",
  • default => [],
  • description => "wrappers to generate",
  • safe => 0,
  • rebuild => 0,
  • },
  • underlaydirs => {
  • type => "internal",
  • default => [],
  • description => "additional underlays to use",
  • safe => 0,
  • rebuild => 0,
  • },
  • verbose => {
  • type => "boolean",
  • example => 1,
  • description => "display verbose messages?",
  • safe => 1,
  • rebuild => 0,
  • },
  • syslog => {
  • type => "boolean",
  • example => 1,
  • description => "log to syslog?",
  • safe => 1,
  • rebuild => 0,
  • },
  • usedirs => {
  • type => "boolean",
  • default => 1,
  • description => "create output files named page/index.html?",
  • safe => 0, # changing requires manual transition
  • rebuild => 1,
  • },
  • prefix_directives => {
  • type => "boolean",
  • default => 1,
  • description => "use '!'-prefixed preprocessor directives?",
  • safe => 0, # changing requires manual transition
  • rebuild => 1,
  • },
  • indexpages => {
  • type => "boolean",
  • default => 0,
  • description => "use page/index.mdwn source files",
  • safe => 1,
  • rebuild => 1,
  • },
  • discussion => {
  • type => "boolean",
  • default => 1,
  • description => "enable Discussion pages?",
  • safe => 1,
  • rebuild => 1,
  • },
  • discussionpage => {
  • type => "string",
  • default => gettext("Discussion"),
  • description => "name of Discussion pages",
  • safe => 1,
  • rebuild => 1,
  • },
  • html5 => {
  • type => "boolean",
  • default => 0,
  • description => "generate HTML5? (experimental)",
  • advanced => 1,
  • safe => 1,
  • rebuild => 1,
  • },
  • sslcookie => {
  • type => "boolean",
  • default => 0,
  • description => "only send cookies over SSL connections?",
  • advanced => 1,
  • safe => 1,
  • rebuild => 0,
  • },
  • default_pageext => {
  • type => "string",
  • default => "mdwn",
  • description => "extension to use for new pages",
  • safe => 0, # not sanitized
  • rebuild => 0,
  • },
  • htmlext => {
  • type => "string",
  • default => "html",
  • description => "extension to use for html files",
  • safe => 0, # not sanitized
  • rebuild => 1,
  • },
  • timeformat => {
  • type => "string",
  • default => '%c',
  • description => "strftime format string to display date",
  • advanced => 1,
  • safe => 1,
  • rebuild => 1,
  • },
  • locale => {
  • type => "string",
  • default => undef,
  • example => "en_US.UTF-8",
  • description => "UTF-8 locale to use",
  • advanced => 1,
  • safe => 0,
  • rebuild => 1,
  • },
  • userdir => {
  • type => "string",
  • default => "",
  • example => "users",
  • description => "put user pages below specified page",
  • safe => 1,
  • rebuild => 1,
  • },
  • numbacklinks => {
  • type => "integer",
  • default => 10,
  • description => "how many backlinks to show before hiding excess (0 to show all)",
  • safe => 1,
  • rebuild => 1,
  • },
  • hardlink => {
  • type => "boolean",
  • default => 0,
  • description => "attempt to hardlink source files? (optimisation for large files)",
  • advanced => 1,
  • safe => 0, # paranoia
  • rebuild => 0,
  • },
  • umask => {
  • type => "integer",
  • example => "022",
  • description => "force ikiwiki to use a particular umask",
  • advanced => 1,
  • safe => 0, # paranoia
  • rebuild => 0,
  • },
  • wrappergroup => {
  • type => "string",
  • example => "ikiwiki",
  • description => "group for wrappers to run in",
  • advanced => 1,
  • safe => 0, # paranoia
  • rebuild => 0,
  • },
  • libdir => {
  • type => "string",
  • default => "",
  • example => "$ENV{HOME}/.ikiwiki/",
  • description => "extra library and plugin directory",
  • advanced => 1,
  • safe => 0, # directory
  • rebuild => 0,
  • },
  • ENV => {
  • type => "string",
  • default => {},
  • description => "environment variables",
  • safe => 0, # paranoia
  • rebuild => 0,
  • },
  • include => {
  • type => "string",
  • default => undef,
  • example => '^\.htaccess$',
  • description => "regexp of normally excluded files to include",
  • advanced => 1,
  • safe => 0, # regexp
  • rebuild => 1,
  • },
  • exclude => {
  • type => "string",
  • default => undef,
  • example => '^(*\.private|Makefile)$',
  • description => "regexp of files that should be skipped",
  • advanced => 1,
  • safe => 0, # regexp
  • rebuild => 1,
  • },
  • wiki_file_prune_regexps => {
  • type => "internal",
  • default => [qr/(^|\/)\.\.(\/|$)/, qr/^\//, qr/^\./, qr/\/\./,
  • qr/\.x?html?$/, qr/\.ikiwiki-new$/,
  • qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
  • qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
  • qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],
  • description => "regexps of source files to ignore",
  • safe => 0,
  • rebuild => 1,
  • },
  • wiki_file_chars => {
  • type => "string",
  • description => "specifies the characters that are allowed in source filenames",
  • default => "-[:alnum:]+/.:_",
  • safe => 0,
  • rebuild => 1,
  • },
  • wiki_file_regexp => {
  • type => "internal",
  • description => "regexp of legal source files",
  • safe => 0,
  • rebuild => 1,
  • },
  • web_commit_regexp => {
  • type => "internal",
  • default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,
  • description => "regexp to parse web commits from logs",
  • safe => 0,
  • rebuild => 0,
  • },
  • cgi => {
  • type => "internal",
  • default => 0,
  • description => "run as a cgi",
  • safe => 0,
  • rebuild => 0,
  • },
  • cgi_disable_uploads => {
  • type => "internal",
  • default => 1,
  • description => "whether CGI should accept file uploads",
  • safe => 0,
  • rebuild => 0,
  • },
  • post_commit => {
  • type => "internal",
  • default => 0,
  • description => "run as a post-commit hook",
  • safe => 0,
  • rebuild => 0,
  • },
  • rebuild => {
  • type => "internal",
  • default => 0,
  • description => "running in rebuild mode",
  • safe => 0,
  • rebuild => 0,
  • },
  • setup => {
  • type => "internal",
  • default => undef,
  • description => "running in setup mode",
  • safe => 0,
  • rebuild => 0,
  • },
  • clean => {
  • type => "internal",
  • default => 0,
  • description => "running in clean mode",
  • safe => 0,
  • rebuild => 0,
  • },
  • refresh => {
  • type => "internal",
  • default => 0,
  • description => "running in refresh mode",
  • safe => 0,
  • rebuild => 0,
  • },
  • test_receive => {
  • type => "internal",
  • default => 0,
  • description => "running in receive test mode",
  • safe => 0,
  • rebuild => 0,
  • },
  • gettime => {
  • type => "internal",
  • description => "running in gettime mode",
  • safe => 0,
  • rebuild => 0,
  • },
  • w3mmode => {
  • type => "internal",
  • default => 0,
  • description => "running in w3mmode",
  • safe => 0,
  • rebuild => 0,
  • },
  • wikistatedir => {
  • type => "internal",
  • default => undef,
  • description => "path to the .ikiwiki directory holding ikiwiki state",
  • safe => 0,
  • rebuild => 0,
  • },
  • setupfile => {
  • type => "internal",
  • default => undef,
  • description => "path to setup file",
  • safe => 0,
  • rebuild => 0,
  • },
  • setuptype => {
  • type => "internal",
  • default => "Standard",
  • description => "perl class to use to dump setup file",
  • safe => 0,
  • rebuild => 0,
  • },
  • allow_symlinks_before_srcdir => {
  • type => "boolean",
  • default => 0,
  • description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
  • safe => 0,
  • rebuild => 0,
  • },
  • }
  • sub defaultconfig () {
  • my %s=getsetup();
  • my @ret;
  • foreach my $key (keys %s) {
  • push @ret, $key, $s{$key}->{default};
  • }
  • use Data::Dumper;
  • return @ret;
  • }
  • sub checkconfig () {
  • # locale stuff; avoid LC_ALL since it overrides everything
  • if (defined $ENV{LC_ALL}) {
  • $ENV{LANG} = $ENV{LC_ALL};
  • delete $ENV{LC_ALL};
  • }
  • if (defined $config{locale}) {
  • if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
  • $ENV{LANG}=$config{locale};
  • define_gettext();
  • }
  • }
  • if (! defined $config{wiki_file_regexp}) {
  • $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
  • }
  • if (ref $config{ENV} eq 'HASH') {
  • foreach my $val (keys %{$config{ENV}}) {
  • $ENV{$val}=$config{ENV}{$val};
  • }
  • }
  • if ($config{w3mmode}) {
  • eval q{use Cwd q{abs_path}};
  • error($@) if $@;
  • $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
  • $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
  • $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
  • unless $config{cgiurl} =~ m!file:///!;
  • $config{url}="file://".$config{destdir};
  • }
  • if ($config{cgi} && ! length $config{url}) {
  • error(gettext("Must specify url to wiki with --url when using --cgi"));
  • }
  • $config{wikistatedir}="$config{srcdir}/.ikiwiki"
  • unless exists $config{wikistatedir} && defined $config{wikistatedir};
  • if (defined $config{umask}) {
  • umask(possibly_foolish_untaint($config{umask}));
  • }
  • run_hooks(checkconfig => sub { shift->() });
  • return 1;
  • }
  • sub listplugins () {
  • my %ret;
  • foreach my $dir (@INC, $config{libdir}) {
  • next unless defined $dir && length $dir;
  • foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
  • my ($plugin)=$file=~/.*\/(.*)\.pm$/;
  • $ret{$plugin}=1;
  • }
  • }
  • foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
  • next unless defined $dir && length $dir;
  • foreach my $file (glob("$dir/plugins/*")) {
  • $ret{basename($file)}=1 if -x $file;
  • }
  • }
  • return keys %ret;
  • }
  • sub loadplugins () {
  • if (defined $config{libdir} && length $config{libdir}) {
  • unshift @INC, possibly_foolish_untaint($config{libdir});
  • }
  • foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
  • loadplugin($plugin);
  • }
  • if ($config{rcs}) {
  • if (exists $hooks{rcs}) {
  • error(gettext("cannot use multiple rcs plugins"));
  • }
  • loadplugin($config{rcs});
  • }
  • if (! exists $hooks{rcs}) {
  • loadplugin("norcs");
  • }
  • run_hooks(getopt => sub { shift->() });
  • if (grep /^-/, @ARGV) {
  • print STDERR "Unknown option (or missing parameter): $_\n"
  • foreach grep /^-/, @ARGV;
  • usage();
  • }
  • return 1;
  • }
  • sub loadplugin ($) {
  • my $plugin=shift;
  • return if grep { $_ eq $plugin} @{$config{disable_plugins}};
  • foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
  • "$installdir/lib/ikiwiki") {
  • if (defined $dir && -x "$dir/plugins/$plugin") {
  • eval { require IkiWiki::Plugin::external };
  • if ($@) {
  • my $reason=$@;
  • error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
  • }
  • import IkiWiki::Plugin::external "$dir/plugins/$plugin";
  • $loaded_plugins{$plugin}=1;
  • return 1;
  • }
  • }
  • my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
  • eval qq{use $mod};
  • if ($@) {
  • error("Failed to load plugin $mod: $@");
  • }
  • $loaded_plugins{$plugin}=1;
  • return 1;
  • }
  • sub error ($;$) {
  • my $message=shift;
  • my $cleaner=shift;
  • log_message('err' => $message) if $config{syslog};
  • if (defined $cleaner) {
  • $cleaner->();
  • }
  • die $message."\n";
  • }
  • sub debug ($) {
  • return unless $config{verbose};
  • return log_message(debug => @_);
  • }
  • my $log_open=0;
  • sub log_message ($$) {
  • my $type=shift;
  • if ($config{syslog}) {
  • require Sys::Syslog;
  • if (! $log_open) {
  • Sys::Syslog::setlogsock('unix');
  • Sys::Syslog::openlog('ikiwiki', '', 'user');
  • $log_open=1;
  • }
  • return eval {
  • Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
  • };
  • }
  • elsif (! $config{cgi}) {
  • return print "@_\n";
  • }
  • else {
  • return print STDERR "@_\n";
  • }
  • }
  • sub possibly_foolish_untaint ($) {
  • my $tainted=shift;
  • my ($untainted)=$tainted=~/(.*)/s;
  • return $untainted;
  • }
  • sub basename ($) {
  • my $file=shift;
  • $file=~s!.*/+!!;
  • return $file;
  • }
  • sub dirname ($) {
  • my $file=shift;
  • $file=~s!/*[^/]+$!!;
  • return $file;
  • }
  • sub isinternal ($) {
  • my $page=shift;
  • return exists $pagesources{$page} &&
  • $pagesources{$page} =~ /\._([^.]+)$/;
  • }
  • sub pagetype ($) {
  • my $file=shift;
  • if ($file =~ /\.([^.]+)$/) {
  • return $1 if exists $hooks{htmlize}{$1};
  • }
  • my $base=basename($file);
  • if (exists $hooks{htmlize}{$base} &&
  • $hooks{htmlize}{$base}{noextension}) {
  • return $base;
  • }
  • return;
  • }
  • my %pagename_cache;
  • sub pagename ($) {
  • my $file=shift;
  • if (exists $pagename_cache{$file}) {
  • return $pagename_cache{$file};
  • }
  • my $type=pagetype($file);
  • my $page=$file;
  • $page=~s/\Q.$type\E*$//
  • if defined $type && !$hooks{htmlize}{$type}{keepextension}
  • && !$hooks{htmlize}{$type}{noextension};
  • if ($config{indexpages} && $page=~/(.*)\/index$/) {
  • $page=$1;
  • }
  • $pagename_cache{$file} = $page;
  • return $page;
  • }
  • sub newpagefile ($$) {
  • my $page=shift;
  • my $type=shift;
  • if (! $config{indexpages} || $page eq 'index') {
  • return $page.".".$type;
  • }
  • else {
  • return $page."/index.".$type;
  • }
  • }
  • sub targetpage ($$;$) {
  • my $page=shift;
  • my $ext=shift;
  • my $filename=shift;
  • if (defined $filename) {
  • return $page."/".$filename.".".$ext;
  • }
  • elsif (! $config{usedirs} || $page eq 'index') {
  • return $page.".".$ext;
  • }
  • else {
  • return $page."/index.".$ext;
  • }
  • }
  • sub htmlpage ($) {
  • my $page=shift;
  • return targetpage($page, $config{htmlext});
  • }
  • sub srcfile_stat {
  • my $file=shift;
  • my $nothrow=shift;
  • return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
  • foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
  • return "$dir/$file", stat(_) if -e "$dir/$file";
  • }
  • error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
  • return;
  • }
  • sub srcfile ($;$) {
  • return (srcfile_stat(@_))[0];
  • }
  • sub add_underlay ($) {
  • my $dir=shift;
  • if ($dir !~ /^\//) {
  • $dir="$config{underlaydirbase}/$dir";
  • }
  • if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
  • unshift @{$config{underlaydirs}}, $dir;
  • }
  • return 1;
  • }
  • sub readfile ($;$$) {
  • my $file=shift;
  • my $binary=shift;
  • my $wantfd=shift;
  • if (-l $file) {
  • error("cannot read a symlink ($file)");
  • }
  • local $/=undef;
  • open (my $in, "<", $file) || error("failed to read $file: $!");
  • binmode($in) if ($binary);
  • return \*$in if $wantfd;
  • my $ret=<$in>;
  • # check for invalid utf-8, and toss it back to avoid crashes
  • if (! utf8::valid($ret)) {
  • $ret=encode_utf8($ret);
  • }
  • close $in || error("failed to read $file: $!");
  • return $ret;
  • }
  • sub prep_writefile ($$) {
  • my $file=shift;
  • my $destdir=shift;
  • my $test=$file;
  • while (length $test) {
  • if (-l "$destdir/$test") {
  • error("cannot write to a symlink ($test)");
  • }
  • $test=dirname($test);
  • }
  • my $dir=dirname("$destdir/$file");
  • if (! -d $dir) {
  • my $d="";
  • foreach my $s (split(m!/+!, $dir)) {
  • $d.="$s/";
  • if (! -d $d) {
  • mkdir($d) || error("failed to create directory $d: $!");
  • }
  • }
  • }
  • return 1;
  • }
  • sub writefile ($$$;$$) {
  • my $file=shift; # can include subdirs
  • my $destdir=shift; # directory to put file in
  • my $content=shift;
  • my $binary=shift;
  • my $writer=shift;
  • prep_writefile($file, $destdir);
  • my $newfile="$destdir/$file.ikiwiki-new";
  • if (-l $newfile) {
  • error("cannot write to a symlink ($newfile)");
  • }
  • my $cleanup = sub { unlink($newfile) };
  • open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
  • binmode($out) if ($binary);
  • if ($writer) {
  • $writer->(\*$out, $cleanup);
  • }
  • else {
  • print $out $content or error("failed writing to $newfile: $!", $cleanup);
  • }
  • close $out || error("failed saving $newfile: $!", $cleanup);
  • rename($newfile, "$destdir/$file") ||
  • error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
  • return 1;
  • }
  • my %cleared;
  • sub will_render ($$;$) {
  • my $page=shift;
  • my $dest=shift;
  • my $clear=shift;
  • # Important security check.
  • if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
  • ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
  • error("$config{destdir}/$dest independently created, not overwriting with version from $page");
  • }
  • if (! $clear || $cleared{$page}) {