chiark / gitweb /
docs: wip
[cgi-auth-flexible.git] / cgi-auth-flexible.pm
index a462bf8434f79f2e0f0190565ebfed908ff2e4af..52920758163f4b019abf4f6eafe0d4d76f9415d6 100644 (file)
@@ -48,6 +48,8 @@ use Digest::HMAC;
 use Digest::SHA;
 use Data::Dumper;
 use File::Copy;
+use Cwd qw/realpath/;
+
 
 #---------- public utilities ----------
 
@@ -226,57 +228,86 @@ sub dump_plain ($$$$) {
     }
 }
 
-sub srcdump_process_dir ($$$$$$) {
-    my ($c, $v, $dumpdir, $incdir, $tarballcounter,
-       $needlicence, $dirsdone) = @_;
-    return () if $v->_ch('srcdump_system_dir', $incdir);
-    my $upwards = $incdir;
+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#/+##;
+       $upwards =~ s#/+$##;
+       $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 die "check $upwards/$try $!";
+               $!==&ENOENT or $!==&ENOTDIR or die "check $upwards/$try $!";
                next;
            }
+#print STDERR "VCS $item $upwards $try\n";
+            if ($dirsdone->{$upwards}++) {
+               $outfn->("srcdump_process_item: did $upwards,".
+                        " skipping $item");
+               return;
+           }
+#print STDERR "VCS $item $upwards $try GO\n";
            $try =~ m/\w+/ or die;
-           return if $dirsdone->{$upwards}++;
-           return $v->_ch(('srcdump_byvcs_'.lc $try),
-                          $dumpdir, $upwards, $tarballcounter);
+           return $v->_ch(('srcdump_byvcs_'.lc $&),
+                          $dumpdir, $upwards, $outfn);
        }
-       $upwards =~ s#/*[^/]+##;
+       $upwards =~ s#/*[^/]+$##;
     }
-    return $v->_ch('srcdump_novcs', $dumpdir, $incdir, $tarballcounter);
+    return $v->_ch('srcdump_novcs', $dumpdir, $item, $outfn);
 }
 
 sub srcdump_novcs ($$$$$) {
-    my ($c, $v, $dumpdir, $dir, $tarballcounter) = @_;
-    my $script = 'find -type f -perm +004';
-    foreach my $excl (@{ $v->{S}{srcdump_excludes} }) {
-       $script .= " \\! -name '$excl'";
+    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,'novcs',$script);
+    } elsif (-f _) {
+       return srcdump_file($c,$v,$dumpdir,$item,$outfn);
+    } else {
+       die "$item not file or directory";
     }
-    $script .= " -print0";
-    return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$tarballcounter,$script);
 }
 
 sub srcdump_byvcs_git ($$$$$) {
-    my ($c, $v, $dumpdir, $dir, $tarballcounter) = @_;
-    return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$tarballcounter,"
-                 git-ls-files -z;
-                 git-ls-files -z --others --exclude-from=.gitignore;
+    my ($c, $v, $dumpdir, $dir, $outfn) = @_;
+#print STDERR "BYVCS GIT $dir\n";
+    return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$outfn,'git',"
+                 git ls-files -z
+                 git ls-files -z --others --exclude-from=.gitignore
                  find .git -print0
                             ");
 }
 
-sub srcdump_dir_cpio ($$$$$) {
-    my ($c,$v,$dumpdir,$dir,$tarballcounter,$script) = @_;
-    my $outfile = "$dumpdir/$$tarballcounter.tar";
+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,$how,$script) = @_;
+    my $outfile = $outfn->("srcdump_dir_cpio $how 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','',"
+       exec '/bin/bash','-ec',"
             set -o pipefail
            (
             $script
@@ -289,8 +320,6 @@ sub srcdump_dir_cpio ($$$$$) {
     }
     $!=0; (waitpid $pid, 0) == $pid or die "$!";
     die "$dir ($script) $outfile $?" if $?;
-    $$tarballcounter++;
-    return $outfile;
 }
 
 sub srcdump_dirscan_prepare ($$) {
@@ -307,22 +336,68 @@ sub srcdump_dirscan_prepare ($$) {
            or die "$v->{S}{srcdump_licence_path} $!";
        $needlicence = undef;
     }
-    my $srctarballcounter = 'aaa';
+    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;
-    my @srcfiles = ("$dumpdir/licence.data");
-    foreach my $incdir ($v->_ch('srcdump_includedirs')) {
+    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("$incdir/$try", $needlicence);
-               $!==&ENOENT or die "copy $incdir/$try $!";
+               last if copy("$item/$try", $needlicence);
+               $!==&ENOENT or $!==&ENOTDIR or die "copy $item/$try $!";
            }
        }
-       push @srcfiles, $v->_ch('srcdump_process_dir', $dumpdir, $incdir,
-                               \$srctarballcounter, \$needlicence, \%dirsdone);
-       $dirsdone{$incdir}++;
+       $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 $!;
 }
 
@@ -399,9 +474,12 @@ sub new_verifier {
            srcdump_prepare => \&srcdump_dirscan_prepare,
            srcdump_licence_path => undef,
            srcdump_licence_files => [qw(AGPLv3 CGI/Auth/Flexible/AGPLv3)],
-           srcdump_includedirs => sub { return @INC; },
-           srcdump_system_dir => sub { $_[2] =~ m#^/etc/|^/usr/(?!local/)#; },
-           srcdump_process_dir => \&srcdump_process_dir,
+           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,
@@ -1242,34 +1320,26 @@ __END__
 
 CGI::Auth::Flexible - web authentication optionally using cookies
 
-=head1 SYNOPSYS
+=head1 SYNOPSYS - STARTUP
 
  my $verifier = CGI::Auth::Flexible->new_verifier(setting => value,...);
  my $authreq = $verifier->new_request($cgi_request_object);
 
- my $authreq = CGI::Auth::Flexible->new_request($cgi_request_object,
-                                              setting => value,...);
-
-=head1 USAGE PATTERN FOR SIMPLE APPLICATIONS
+=head1 SYNOPSYS - SIMPLE APPLICATIONS
 
  $authreq->check_ok() or return;
-
- blah blah blah
+ ...
  $authreq->check_mutate();
- blah blah blah
+ ...
 
-=head1 USAGE PATTERN FOR FANCY APPLICATIONS
+=head1 SYNOPSIS - SOPHISTICATED APPLICATIONS
 
  my $divert_kind = $authreq->check_divert();
- if ($divert_kind) {
-     if ($divert_kind eq 'LOGGEDOUT') {
-        print "goodbye you are now logged out" and quit
-     } elsif ($divert_kind eq 'NOCOOKIES') {
-        print "you need cookies" and quit
-     ... etc.
-     }
- }
-
- blah blah blah
+ if ($divert_kind) { ... print diversion page and quit ... }
+ ...
  $authreq->check_mutate();
- blah blah blah
+ ...
+
+=head1 DESCRIPTION
+
+CGI::Auth::Flexible is a