final tweaks before beta2
[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / Install.pm
index 46b09d5..6a5c184 100644 (file)
@@ -1,43 +1,48 @@
 package ExtUtils::Install;
 
+$VERSION = substr q$Revision: 1.28 $, 10;
+# $Date: 1998/01/25 07:08:24 $
+
 use Exporter;
-use SelfLoader;
 use Carp ();
-
+use Config qw(%Config);
+use vars qw(@ISA @EXPORT $VERSION);
 @ISA = ('Exporter');
-@EXPORT = ('install','uninstall','pm_to_blib');
+@EXPORT = ('install','uninstall','pm_to_blib', 'install_default');
 $Is_VMS = $^O eq 'VMS';
 
+my $splitchar = $^O eq 'VMS' ? '|' : ($^O eq 'os2' || $^O eq 'dos') ? ';' : ':';
+my @PERL_ENV_LIB = split $splitchar, defined $ENV{'PERL5LIB'} ? $ENV{'PERL5LIB'} : $ENV{'PERLLIB'} || '';
+my $Inc_uninstall_warn_handler;
+
 #use vars qw( @EXPORT @ISA $Is_VMS );
 #use strict;
 
-1;
-
-sub ExtUtils::Install::install;
-sub ExtUtils::Install::uninstall;
-sub ExtUtils::Install::pm_to_blib;
-sub ExtUtils::Install::my_cmp;
-
-__DATA__
+sub forceunlink {
+    chmod 0666, $_[0];
+    unlink $_[0] or Carp::croak("Cannot forceunlink $_[0]: $!")
+}
 
 sub install {
-    my($hash,$verbose,$nonono) = @_;
+    my($hash,$verbose,$nonono,$inc_uninstall) = @_;
     $verbose ||= 0;
     $nonono  ||= 0;
 
     use Cwd qw(cwd);
     use ExtUtils::MakeMaker; # to implement a MY class
+    use ExtUtils::Packlist;
     use File::Basename qw(dirname);
     use File::Copy qw(copy);
     use File::Find qw(find);
     use File::Path qw(mkpath);
-    # require "auto/ExtUtils/Install/my_cmp.al"; # Hairy, but for the first
-    # time use we are in a different directory when autoload happens, so
-    # the relativ path to ./blib is ill.
+    use File::Compare qw(compare);
 
     my(%hash) = %$hash;
-    my(%pack, %write, $dir);
-    local(*DIR, *P);
+    my(%pack, $dir, $warn_permissions);
+    my($packlist) = ExtUtils::Packlist->new();
+    # -w doesn't work reliably on FAT dirs
+    $warn_permissions++ if $^O eq 'MSWin32';
+    local(*DIR);
     for (qw/read write/) {
        $pack{$_}=$hash{$_};
        delete $hash{$_};
@@ -47,33 +52,23 @@ sub install {
        #Check if there are files, and if yes, look if the corresponding
        #target directory is writable for us
        opendir DIR, $source_dir_or_file or next;
-       while ($_ = readdir DIR) {
+       for (readdir DIR) {
            next if $_ eq "." || $_ eq ".." || $_ eq ".exists";
-           if (-w $hash{$source_dir_or_file} || mkpath($hash{$source_dir_or_file})) {
+           if (-w $hash{$source_dir_or_file} ||
+               mkpath($hash{$source_dir_or_file})) {
                last;
            } else {
-               Carp::croak("You do not have permissions to install into $hash{$source_dir_or_file}");
+               warn "Warning: You do not have permissions to " .
+                   "install into $hash{$source_dir_or_file}"
+                   unless $warn_permissions++;
            }
        }
        closedir DIR;
     }
-    if (-f $pack{"read"}) {
-       open P, $pack{"read"} or Carp::croak("Couldn't read $pack{'read'}");
-       # Remember what you found
-       while (<P>) {
-           chomp;
-           $write{$_}++;
-       }
-       close P;
-    }
+    $packlist->read($pack{"read"}) if (-f $pack{"read"});
     my $cwd = cwd();
     my $umask = umask 0 unless $Is_VMS;
 
-    # This silly reference is just here to be able to call MY->catdir
-    # without a warning (Waiting for a proper path/directory module,
-    # Charles!)
-    my $MY = {};
-    bless $MY, 'MY';
     my($source);
     MOD_INSTALL: foreach $source (sort keys %hash) {
        #copy the tree to the target directory without altering
@@ -81,19 +76,32 @@ sub install {
        #file. The packlist file contains the absolute paths of the
        #install locations. AFS users may call this a bug. We'll have
        #to reconsider how to add the means to satisfy AFS users also.
+
+       #October 1997: we want to install .pm files into archlib if
+       #there are any files in arch. So we depend on having ./blib/arch
+       #hardcoded here.
+       my $targetroot = $hash{$source};
+       if ($source eq "blib/lib" and
+           exists $hash{"blib/arch"} and
+           directory_not_empty("blib/arch")) {
+           $targetroot = $hash{"blib/arch"};
+            print "Files found in blib/arch --> Installing files in " 
+               . "blib/lib into architecture dependend library tree!\n"
+               ; #if $verbose>1;
+       }
        chdir($source) or next;
        find(sub {
            my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
                          $atime,$mtime,$ctime,$blksize,$blocks) = stat;
            return unless -f _;
            return if $_ eq ".exists";
-           my $targetdir = $MY->catdir($hash{$source},$File::Find::dir);
-           my $targetfile = $MY->catfile($targetdir,$_);
-           my $diff = 0;
+           my $targetdir = MY->catdir($targetroot,$File::Find::dir);
+           my $targetfile = MY->catfile($targetdir,$_);
 
+           my $diff = 0;
            if ( -f $targetfile && -s _ == $size) {
                # We have a good chance, we can skip this one
-               $diff = my_cmp($_,$targetfile);
+               $diff = compare($_,$targetfile);
            } else {
                print "$_ differs\n" if $verbose>1;
                $diff++;
@@ -101,22 +109,29 @@ sub install {
 
            if ($diff){
                if (-f $targetfile){
-                   unlink $targetfile or Carp::croak("Couldn't unlink $targetfile");
+                   forceunlink($targetfile) unless $nonono;
                } else {
                    mkpath($targetdir,0,0755) unless $nonono;
                    print "mkpath($targetdir,0,0755)\n" if $verbose>1;
                }
                copy($_,$targetfile) unless $nonono;
-               print "Installing $targetfile\n" if $verbose;
+               print "Installing $targetfile\n";
                utime($atime,$mtime + $Is_VMS,$targetfile) unless $nonono>1;
                print "utime($atime,$mtime,$targetfile)\n" if $verbose>1;
+               $mode = 0444 | ( $mode & 0111 ? 0111 : 0 );
                chmod $mode, $targetfile;
                print "chmod($mode, $targetfile)\n" if $verbose>1;
            } else {
-               print "Skipping $targetfile (unchanged)\n";
+               print "Skipping $targetfile (unchanged)\n" if $verbose;
            }
-
-           $write{$targetfile}++;
+           
+           if (! defined $inc_uninstall) { # it's called 
+           } elsif ($inc_uninstall == 0){
+               inc_uninstall($_,$File::Find::dir,$verbose,1); # nonono set to 1
+           } else {
+               inc_uninstall($_,$File::Find::dir,$verbose,0); # nonono set to 0
+           }
+           $packlist->{$targetfile}++;
 
        }, ".");
        chdir($cwd) or Carp::croak("Couldn't chdir to $cwd: $!");
@@ -126,52 +141,102 @@ sub install {
        $dir = dirname($pack{'write'});
        mkpath($dir,0,0755);
        print "Writing $pack{'write'}\n";
-       open P, ">$pack{'write'}" or Carp::croak("Couldn't write $pack{'write'}: $!");
-       for (sort keys %write) {
-           print P "$_\n";
-       }
-       close P;
+       $packlist->write($pack{'write'});
     }
 }
 
-sub my_cmp {
-    my($one,$two) = @_;
-    local(*F,*T);
-    my $diff = 0;
-    open T, $two or return 1;
-    open F, $one or Carp::croak("Couldn't open $one: $!");
-    my($fr, $tr, $fbuf, $tbuf, $size);
-    $size = 1024;
-    # print "Reading $one\n";
-    while ( $fr = read(F,$fbuf,$size)) {
-       unless (
-               $tr = read(T,$tbuf,$size) and 
-               $tbuf eq $fbuf
-              ){
-           # print "diff ";
-           $diff++;
-           last;
-       }
-       # print "$fr/$tr ";
-    }
-    # print "\n";
-    close F;
-    close T;
-    $diff;
+sub directory_not_empty ($) {
+  my($dir) = @_;
+  my $files = 0;
+  find(sub {
+          return if $_ eq ".exists";
+          if (-f) {
+            $File::Find::prune++;
+            $files = 1;
+          }
+       }, $dir);
+  return $files;
+}
+
+sub install_default {
+  @_ < 2 or die "install_default should be called with 0 or 1 argument";
+  my $FULLEXT = @_ ? shift : $ARGV[0];
+  defined $FULLEXT or die "Do not know to where to write install log";
+  my $INST_LIB = MM->catdir(MM->curdir,"blib","lib");
+  my $INST_ARCHLIB = MM->catdir(MM->curdir,"blib","arch");
+  my $INST_BIN = MM->catdir(MM->curdir,'blib','bin');
+  my $INST_SCRIPT = MM->catdir(MM->curdir,'blib','script');
+  my $INST_MAN1DIR = MM->catdir(MM->curdir,'blib','man1');
+  my $INST_MAN3DIR = MM->catdir(MM->curdir,'blib','man3');
+  install({
+          read => "$Config{sitearchexp}/auto/$FULLEXT/.packlist",
+          write => "$Config{installsitearch}/auto/$FULLEXT/.packlist",
+          $INST_LIB => (directory_not_empty($INST_ARCHLIB)) ?
+                        $Config{installsitearch} :
+                        $Config{installsitelib},
+          $INST_ARCHLIB => $Config{installsitearch},
+          $INST_BIN => $Config{installbin} ,
+          $INST_SCRIPT => $Config{installscript},
+          $INST_MAN1DIR => $Config{installman1dir},
+          $INST_MAN3DIR => $Config{installman3dir},
+         },1,0,0);
 }
 
 sub uninstall {
+    use ExtUtils::Packlist;
     my($fil,$verbose,$nonono) = @_;
     die "no packlist file found: $fil" unless -f $fil;
-    local *P;
-    open P, $fil or Carp::croak("uninstall: Could not read packlist file $fil: $!");
-    while (<P>) {
+    # my $my_req = $self->catfile(qw(auto ExtUtils Install forceunlink.al));
+    # require $my_req; # Hairy, but for the first
+    my ($packlist) = ExtUtils::Packlist->new($fil);
+    foreach (sort(keys(%$packlist))) {
        chomp;
        print "unlink $_\n" if $verbose;
-       unlink($_) || Carp::carp("Couldn't unlink $_") unless $nonono;
+       forceunlink($_) unless $nonono;
     }
     print "unlink $fil\n" if $verbose;
-    unlink($fil) || Carp::carp("Couldn't unlink $fil") unless $nonono;
+    close P;
+    forceunlink($fil) unless $nonono;
+}
+
+sub inc_uninstall {
+    my($file,$libdir,$verbose,$nonono) = @_;
+    my($dir);
+    my %seen_dir = ();
+    foreach $dir (@INC, @PERL_ENV_LIB, @Config{qw(archlibexp
+                                                 privlibexp
+                                                 sitearchexp
+                                                 sitelibexp)}) {
+       next if $dir eq ".";
+       next if $seen_dir{$dir}++;
+       my($targetfile) = MY->catfile($dir,$libdir,$file);
+       next unless -f $targetfile;
+
+       # The reason why we compare file's contents is, that we cannot
+       # know, which is the file we just installed (AFS). So we leave
+       # an identical file in place
+       my $diff = 0;
+       if ( -f $targetfile && -s _ == -s $file) {
+           # We have a good chance, we can skip this one
+           $diff = compare($file,$targetfile);
+       } else {
+           print "#$file and $targetfile differ\n" if $verbose>1;
+           $diff++;
+       }
+
+       next unless $diff;
+       if ($nonono) {
+           if ($verbose) {
+               $Inc_uninstall_warn_handler ||= new ExtUtils::Install::Warn;
+               $libdir =~ s|^\./|| ; # That's just cosmetics, no need to port. It looks prettier.
+               $Inc_uninstall_warn_handler->add("$libdir/$file",$targetfile);
+           }
+           # if not verbose, we just say nothing
+       } else {
+           print "Unlinking $targetfile (shadowing?)\n";
+           forceunlink($targetfile);
+       }
+    }
 }
 
 sub pm_to_blib {
@@ -180,23 +245,39 @@ sub pm_to_blib {
     use File::Basename qw(dirname);
     use File::Copy qw(copy);
     use File::Path qw(mkpath);
+    use File::Compare qw(compare);
     use AutoSplit;
+    # my $my_req = $self->catfile(qw(auto ExtUtils Install forceunlink.al));
+    # require $my_req; # Hairy, but for the first
+
+    if (!ref($fromto) && -r $fromto)
+     {
+      # Win32 has severe command line length limitations, but
+      # can generate temporary files on-the-fly
+      # so we pass name of file here - eval it to get hash 
+      open(FROMTO,"<$fromto") or die "Cannot open $fromto:$!";
+      my $str = '$fromto = {qw{'.join('',<FROMTO>).'}}';
+      eval $str;
+      close(FROMTO);
+     }
 
     my $umask = umask 0022 unless $Is_VMS;
     mkpath($autodir,0,0755);
     foreach (keys %$fromto) {
        next if -f $fromto->{$_} && -M $fromto->{$_} < -M $_;
-       unless (my_cmp($_,$fromto->{$_})){
+       unless (compare($_,$fromto->{$_})){
            print "Skip $fromto->{$_} (unchanged)\n";
            next;
        }
        if (-f $fromto->{$_}){
-           unlink $fromto->{$_} or Carp::carp("Couldn't unlink $fromto->{$_}");
+           forceunlink($fromto->{$_});
        } else {
            mkpath(dirname($fromto->{$_}),0,0755);
        }
        copy($_,$fromto->{$_});
-       chmod((stat)[2],$fromto->{$_});
+       my($mode,$atime,$mtime) = (stat)[2,8,9];
+       utime($atime,$mtime+$Is_VMS,$fromto->{$_});
+       chmod(0444 | ( $mode & 0111 ? 0111 : 0 ),$fromto->{$_});
        print "cp $_ $fromto->{$_}\n";
        next unless /\.pm$/;
        autosplit($fromto->{$_},$autodir);
@@ -204,6 +285,30 @@ sub pm_to_blib {
     umask $umask unless $Is_VMS;
 }
 
+package ExtUtils::Install::Warn;
+
+sub new { bless {}, shift }
+
+sub add {
+    my($self,$file,$targetfile) = @_;
+    push @{$self->{$file}}, $targetfile;
+}
+
+sub DESTROY {
+    my $self = shift;
+    my($file,$i,$plural);
+    foreach $file (sort keys %$self) {
+       $plural = @{$self->{$file}} > 1 ? "s" : "";
+       print "## Differing version$plural of $file found. You might like to\n";
+       for (0..$#{$self->{$file}}) {
+           print "rm ", $self->{$file}[$_], "\n";
+           $i++;
+       }
+    }
+    $plural = $i>1 ? "all those files" : "this file";
+    print "## Running 'make install UNINST=1' will unlink $plural for you.\n";
+}
+
 1;
 
 __END__
@@ -237,12 +342,26 @@ be copied preserving timestamps and permissions.
 
 There are two keys with a special meaning in the hash: "read" and
 "write". After the copying is done, install will write the list of
-target files to the file named by $hashref->{write}. If there is
-another file named by $hashref->{read}, the contents of this file will
+target files to the file named by C<$hashref-E<gt>{write}>. If there is
+another file named by C<$hashref-E<gt>{read}>, the contents of this file will
 be merged into the written file. The read and the written file may be
 identical, but on AFS it is quite likely, people are installing to a
 different directory than the one where the files later appear.
 
+install_default() takes one or less arguments.  If no arguments are 
+specified, it takes $ARGV[0] as if it was specified as an argument.  
+The argument is the value of MakeMaker's C<FULLEXT> key, like F<Tk/Canvas>.  
+This function calls install() with the same arguments as the defaults 
+the MakeMaker would use.
+
+The argumement-less form is convenient for install scripts like
+
+  perl -MExtUtils::Install -e install_default Tk/Canvas
+
+Assuming this command is executed in a directory with populated F<blib> 
+directory, it will proceed as if the F<blib> was build by MakeMaker on 
+this machine.  This is useful for binary distributions.
+
 uninstall() takes as first argument a file containing filenames to be
 unlinked. The second argument is a verbose switch, the third is a
 no-don't-really-do-it-now switch.
@@ -253,4 +372,3 @@ the extension pm are autosplit. Second argument is the autosplit
 directory.
 
 =cut
-