chiark / gitweb /
automatic agpl compliance: fixes, now does files too
[cgi-auth-flexible.git] / cgi-auth-flexible.pm
index 4ab430d5f989affb6b080e1efe8401dedd5e518b..8c3cb49d4cc33e172d281c0d94b66679668b68b7 100644 (file)
@@ -47,6 +47,8 @@ use Digest;
 use Digest::HMAC;
 use Digest::SHA;
 use Data::Dumper;
+use File::Copy;
+use Cwd qw/realpath/;
 
 #---------- public utilities ----------
 
@@ -173,6 +175,238 @@ sub gen_plain_login_link ($$) {
            '</a>');
 }
 
+sub gen_srcdump_link_html ($$$$) {
+    my ($c,$r,$anchor,$specval) = @_;
+    my %params = ($r->{S}{srcdump_param_name} => [ $specval ]);
+    return '<a href="'.escapeHTML($r->url_with_query_params(\%params)).'">'.
+       $anchor."</a>";
+}
+sub gen_plain_licence_link_html ($$) {
+    my ($c,$r) = @_;
+    gen_srcdump_link_html($c,$r, 'GNU Affero GPL', 'licence');
+}
+sub gen_plain_source_link_html ($$) {
+    my ($c,$r) = @_;
+    gen_srcdump_link_html($c,$r, 'Source available', 'source');
+}
+
+sub gen_plain_footer_html ($$) {
+    my ($c,$r) = @_;
+    return ('<hr><address>',
+           ("Powered by Free / Libre / Open Source Software".
+            " according to the ".$r->_ch('gen_licence_link_html')."."),
+           $r->_ch('gen_source_link_html').".",
+           '</address>');
+}
+
+#---------- licence and source code ----------
+
+sub srcdump_dump ($$$) {
+    my ($c,$r, $thing) = @_;
+    die if $thing =~ m/\W/ || $thing !~ m/\w/;
+    my $path = $r->_get_path('srcdump');
+    my $ctf = new IO::File "$path/$thing.ctype", 'r'
+       or die "$path/$thing.ctype $!";
+    my $ct = <$ctf>;
+    chomp $ct or die "$path/$thing ?";
+    $ctf->close or die "$path/$thing $!";
+    my $df = new IO::File "$path/$thing.data", 'r'
+       or die "$path/$thing.data $!";
+    $r->_ch('dump', $ct, $df);
+}
+
+sub dump_plain ($$$$) {
+    my ($c, $r, $ct, $df) = @_;
+    $r->_print($c->header('-type' => $ct));
+    my $buffer;
+    for (;;) {
+       my $got = read $df, $buffer, 65536;
+       die $! unless defined $got;
+       return if !$got;
+       $r->_print($buffer);
+    }
+}
+
+sub srcdump_process_item ($$$$$$) {
+    my ($c, $v, $dumpdir, $item, $outfn, $needlicence, $dirsdone) = @_;
+    if ($v->_ch('srcdump_system_dir', $item)) {
+       $outfn->("srcdump_process_item: srcdump_system_dir, skipping $item");
+       return;
+    }
+    my $upwards = $item;
+    for (;;) {
+       $upwards =~ s#/+$##;
+       last unless $upwards =~ m#[^/]#;
+       foreach my $try (@{ $v->{S}{srcdump_vcs_dirs} }) {
+#print STDERR "TRY $item $upwards $try\n";
+           if (!stat "$upwards/$try") {
+               $!==&ENOENT or $!==&ENOTDIR or die "check $upwards/$try $!";
+               next;
+           }
+#print STDERR "VCS $item $upwards $try\n";
+           return if $dirsdone->{$upwards}++;
+#print STDERR "VCS $item $upwards $try GO\n";
+           $try =~ m/\w+/ or die;
+           return $v->_ch(('srcdump_byvcs_'.lc $&),
+                          $dumpdir, $upwards, $outfn);
+       }
+       $upwards =~ s#/*[^/]+##;
+    }
+    return $v->_ch('srcdump_novcs', $dumpdir, $item, $outfn);
+}
+
+sub srcdump_novcs ($$$$$) {
+    my ($c, $v, $dumpdir, $item, $outfn) = @_;
+    stat $item or die "$item $!";
+    if (-d _) {
+       my $script = 'find -type f -perm +004';
+       foreach my $excl (@{ $v->{S}{srcdump_excludes} }) {
+           $script .= " \\! -name '$excl'";
+       }
+       $script .= " -print0";
+       return srcdump_dir_cpio($c,$v,$dumpdir,$item,$outfn,$script);
+    } elsif (-f _) {
+       return srcdump_file($c,$v,$dumpdir,$item,$outfn);
+    } else {
+       die "$item not file or directory";
+    }
+}
+
+sub srcdump_byvcs_git ($$$$$) {
+    my ($c, $v, $dumpdir, $dir, $outfn) = @_;
+#print STDERR "BYVCS GIT $dir\n";
+    return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$outfn,"
+                 git ls-files -z
+                 git ls-files -z --others --exclude-from=.gitignore
+                 find .git -print0
+                            ");
+}
+
+sub srcdump_file ($$$$) {
+    my ($c,$v,$dumpdir,$file,$outfn) = @_;
+    my $outfile = $outfn->("srcdump_file saved $file", "src");
+    copy($file,$outfile) or die "$file $outfile $!";
+}
+
+sub srcdump_dir_cpio ($$$$$) {
+    my ($c,$v,$dumpdir,$dir,$outfn,$script) = @_;
+    my $outfile = $outfn->("srcdump_dir_cpio saved $dir", "tar");
+#print STDERR "CPIO $dir >$script<\n";
+    my $pid = fork();
+    defined $pid or die $!;
+    if (!$pid) {
+       $SIG{__DIE__} = sub {
+           print STDERR "CGI::Auth::Flexible srcdump error: $@\n";
+           exit 127;
+       };
+       open STDOUT, ">", $outfile or die "$outfile $!";
+       chdir $dir or die "chdir $dir: $!";
+       exec '/bin/bash','-ec',"
+            set -o pipefail
+           (
+            $script
+           ) | (
+            cpio -Hustar -o --quiet -0 -R 1000:1000 || \
+             cpio -Hustar -o --quiet -0
+            )
+            ";
+       die $!;
+    }
+    $!=0; (waitpid $pid, 0) == $pid or die "$!";
+    die "$dir ($script) $outfile $?" if $?;
+}
+
+sub srcdump_dirscan_prepare ($$) {
+    my ($c, $v) = @_;
+    my $dumpdir = $v->_get_path('srcdump');
+    mkdir $dumpdir or $!==&EEXIST or die "mkdir $dumpdir $!";
+    my $lockf = new IO::File "$dumpdir/generate.lock", 'w+'
+       or die "$dumpdir/generate.lock $!";
+    flock $lockf, LOCK_EX or die "$dumpdir/generate.lock $!";
+    my $needlicence = "$dumpdir/licence.tmp";
+    unlink $needlicence or $!==&ENOENT or die "rm $needlicence $!";
+    if (defined $v->{S}{srcdump_licence_path}) {
+       copy($v->{S}{srcdump_licence_path}, $needlicence)
+           or die "$v->{S}{srcdump_licence_path} $!";
+       $needlicence = undef;
+    }
+    unlink <"$dumpdir/s.[a-z][a-z][a-z].*">;
+    my @srcfiles = qw(licence.data manifest.txt);
+    my $srcoutcounter = 'aaa';
+
+    my $reportfh = new IO::File "$dumpdir/manifest.txt", 'w' or die $!;
+    my $outfn = sub {
+       my ($message, $extension) = @_;
+       if (defined $extension) {
+           my $leaf = "s.$srcoutcounter.$extension";
+           $srcoutcounter++;
+           push @srcfiles, $leaf;
+           print $reportfh "$leaf: $message\n" or die $!;
+           return "$dumpdir/$leaf";
+       } else {
+           print $reportfh "none: $message\n" or die $!;
+           return undef;
+       }
+    };
+    my %dirsdone;
+    foreach my $item ($v->_ch('srcdump_listitems')) {
+       if ($item eq '.' && $v->{S}{srcdump_filter_cwd}) {
+           my @bad = grep { !m#^/# } values %INC;
+           die "filtering . from srcdump items and \@INC but already".
+               " included @bad " if @bad;
+           @INC = grep { $_ ne '.' } @INC;
+           next;
+       }
+       if (!lstat "$item") {
+           die "stat $item $!" unless $!==&ENOENT;
+           $outfn->("srcdump_dirscan_prepare stat ENOENT: skipping $item");
+           next;
+       };
+       if (-l _) {
+           $item = realpath($item);
+           if (!defined $item) {
+               die "realpath $item $!" unless $!==&ENOENT;
+               $outfn->("srcdump_dirscan_prepare realpath ENOENT:".
+                        " skipping $item");
+           }
+       }
+       if (defined $needlicence) {
+           foreach my $try (@{ $v->{S}{srcdump_licence_files} }) {
+               last if copy("$item/$try", $needlicence);
+               $!==&ENOENT or $!==&ENOTDIR or die "copy $item/$try $!";
+           }
+       }
+       $v->_ch('srcdump_process_item', $dumpdir, $item,
+               $outfn, \$needlicence, \%dirsdone);
+       $dirsdone{$item}++;
+    }
+    close $reportfh or die $!;
+    $!=0;
+    my @cmd = (qw(tar -zvvcf), "$dumpdir/source.tmp",
+              "-C", $dumpdir, qw(  --), @srcfiles);
+    my $r = system(@cmd);
+    if ($r) {
+       print STDERR "CGI::Auth::Flexible tar failed ($r $!) @cmd\n";
+       die "tar failed";
+    }
+    die "licence file not found" unless defined $needlicence;
+    srcdump_install($c,$v, $dumpdir, 'licence', 'text/plain');
+    srcdump_install($c,$v, $dumpdir, 'source', 'application/octet-stream');
+    close $lockf or die $!;
+}
+
+sub srcdump_install ($$$$$) {
+    my ($c,$v, $dumpdir, $which, $ctype) = @_;
+    rename "$dumpdir/$which.tmp", "$dumpdir/$which.data"
+       or die "$dumpdir/$which.data $!";
+    my $ctf = new IO::File "$dumpdir/$which.tmp", 'w'
+       or die "$dumpdir/$which.tmp $!";
+    print $ctf $ctype, "\n" or die $!;
+    close $ctf or die $!;
+    rename "$dumpdir/$which.tmp", "$dumpdir/$which.ctype"
+       or die "$dumpdir/$which.ctype $!";
+}
+
 #---------- verifier object methods ----------
 
 sub new_verifier {
@@ -183,6 +417,7 @@ sub new_verifier {
            assocdb_dbh => undef, # must have AutoCommit=0, RaiseError=1
            assocdb_path => 'caf-assocs.db',
            keys_path => 'caf-keys',
+           srcdump_path => 'caf-srcdump',
            assocdb_dsn => undef,
            assocdb_user => '',
            assocdb_password => '',
@@ -197,6 +432,7 @@ sub new_verifier {
            dummy_param_name_prefix => 'caf__',
            cookie_name => "caf_assocsecret",
            password_param_name => 'password',
+           srcdump_param_name => 'caf_srcdump',
            username_param_names => [qw(username)],
            form_entry_size => 60,
            logout_param_names => [qw(caf_logout)],
@@ -221,10 +457,31 @@ sub new_verifier {
            get_cookie_domain => \&get_cookie_domain,
            encrypted_only => 1,
            gen_start_html => sub { $_[0]->start_html($_[2]); },
+           gen_footer_html => \&gen_plain_footer_html,
+           gen_licence_link_html => \&gen_plain_licence_link_html,
+           gen_source_link_html => \&gen_plain_source_link_html,
            gen_end_html => sub { $_[0]->end_html(); },
            gen_login_form => \&gen_plain_login_form,
            gen_login_link => \&gen_plain_login_link,
            gen_postmainpage_form => \&gen_postmainpage_form,
+           srcdump_dump => \&srcdump_dump,
+           srcdump_prepare => \&srcdump_dirscan_prepare,
+           srcdump_licence_path => undef,
+           srcdump_licence_files => [qw(AGPLv3 CGI/Auth/Flexible/AGPLv3)],
+           srcdump_listitems => sub { (@INC, $ENV{'SCRIPT_FILENAME'}, $0); },
+           srcdump_filter_cwd => 1,
+           srcdump_system_dir => sub {
+               $_[2] =~ m#^/etc/|^/usr/(?!local/)(?!lib/cgi)#;
+           },
+           srcdump_process_item => \&srcdump_process_item,
+           srcdump_vcs_dirs => [qw(.git .hg .svn CVS)],
+           srcdump_byvcs_git => \&srcdump_byvcs_git,
+           srcdump_byvcs_hg => \&srcdump_byvcs_hg,
+           srcdump_byvcs_svn => \&srcdump_byvcs_svn,
+           srcdump_byvcs_cvs => \&srcdump_byvcs_cvs,
+           srcdump_novcs => \&srcdump_novcs,
+           srcdump_excludes => [qw(*~ *.bak *.tmp), '#*#'],
+           dump => \&dump_plain,
            gettext => sub { gettext($_[2]); },
            print => sub { print $_[2] or die $!; },
             debug => sub { }, # like print; msgs contain trailing \n
@@ -238,6 +495,7 @@ sub new_verifier {
     }
     bless $verifier, $class;
     $verifier->_dbopen();
+    $verifier->_ch('srcdump_prepare');
     return $verifier;
 }
 
@@ -365,10 +623,15 @@ sub _debug ($@) {
 }
 
 sub _get_path ($$) {
-    my ($v,$keybase) = @_;
-    my $leaf = $v->{S}{"${keybase}_path"};
-    my $dir = $v->{S}{dir};
+    my ($r,$keybase) = @_;
+    my $leaf = $r->{S}{"${keybase}_path"};
+    return $r->_absify_path($leaf);
+}
+
+sub _absify_path ($$) {
+    my ($v,$leaf) = @_;
     return $leaf if $leaf =~ m,^/,;
+    my $dir = $v->{S}{dir};
     die "relying on cwd by default ?!  set dir" unless defined $dir;
     return "$dir/$leaf";
 }
@@ -504,9 +767,18 @@ my @ca = (-name => $r->{S}{cookie_name},
 sub _check_divert_core ($) {
     my ($r) = @_;
 
+    my $srcdump = $r->_rp('srcdump_param_name');
+    if ($srcdump) {
+       die if $srcdump =~ m/\W/;
+       return ({ Kind => 'SRCDUMP-'.uc $srcdump,
+                 Message => undef,
+                 CookieSecret => undef,
+                 Params => { } });
+    }
+
     my $cooks = $r->_ch('get_cookie');
 
-    if (!$r->_ch('check_https')) {
+    if ($r->{S}{encrypted_only} && !$r->_ch('check_https')) {
         return ({ Kind => 'REDIRECT-HTTPS',
                   Message => $r->_gt("Redirecting to secure server..."),
                   CookieSecret => undef,
@@ -536,8 +808,8 @@ sub _check_divert_core ($) {
     }
     if ($r->_ch('is_loggedout')) {
        die unless $meth eq 'GET';
-       die unless $cookt;
-       die unless $parmt;
+       die if $cookt eq 'y';
+       die if $parmt;
        return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
                  Message => $r->_gt("You have been logged out."),
                  CookieSecret => '',
@@ -783,6 +1055,11 @@ sub check_ok ($) {
     my $params = $divert->{Params};
     my $cookie = $r->construct_cookie($cookiesecret);
 
+    if ($kind =~ m/^SRCDUMP-(\w+)$/) {
+       $r->_ch('srcdump_dump', (lc $1));
+       return 0;
+    }
+
     if ($kind =~ m/^REDIRECT-/) {
        # for redirects, we honour stored NextParams and SetCookie,
        # as we would for non-divert
@@ -828,8 +1105,9 @@ sub check_ok ($) {
 
     $r->_print($r->{Cgi}->header($r->_cgi_header_args($cookie)),
               $r->_ch('gen_start_html',$title),
-              (join "\n", @body),
-              $r->_ch('gen_end_html'));
+              (join "\n", (@body,
+                           $r->_ch('gen_footer_html'),
+                           $r->_ch('gen_end_html'))));
     return 0;
 }