package ExtUtils::InstallPaths; $ExtUtils::InstallPaths::VERSION = '0.012'; use 5.006; use strict; use warnings; use File::Spec (); use Carp (); use ExtUtils::Config 0.002; my %complex_accessors = map { $_ => 1 } qw/prefix_relpaths install_sets/; my %hash_accessors = map { $_ => 1 } qw/install_path install_base_relpaths original_prefix /; my %defaults = ( installdirs => 'site', install_base => undef, prefix => undef, verbose => 0, create_packlist => 1, dist_name => undef, module_name => undef, destdir => undef, install_path => sub { {} }, install_sets => \&_default_install_sets, original_prefix => \&_default_original_prefix, install_base_relpaths => \&_default_base_relpaths, prefix_relpaths => \&_default_prefix_relpaths, ); sub _merge_shallow { my ($name, $filter) = @_; return sub { my ($override, $config) = @_; my $defaults = $defaults{$name}->($config); $filter->($_) for grep $filter, values %$override; return { %$defaults, %$override }; } } sub _merge_deep { my ($name, $filter) = @_; return sub { my ($override, $config) = @_; my $defaults = $defaults{$name}->($config); my $pair_for = sub { my $key = shift; my %override = %{ $override->{$key} || {} }; $filter && $filter->($_) for values %override; return $key => { %{ $defaults->{$key} }, %override }; }; return { map { $pair_for->($_) } keys %$defaults }; } } my %allowed_installdir = map { $_ => 1 } qw/core site vendor/; my $must_be_relative = sub { Carp::croak('Value must be a relative path') if File::Spec->file_name_is_absolute($_[0]) }; my %deep_filter = map { $_ => $must_be_relative } qw/install_base_relpaths prefix_relpaths/; my %filter = ( installdirs => sub { my $value = shift; $value = 'core', Carp::carp('Perhaps you meant installdirs to be "core" rather than "perl"?') if $value eq 'perl'; Carp::croak('installdirs must be one of "core", "site", or "vendor"') if not $allowed_installdir{$value}; return $value; }, (map { $_ => _merge_shallow($_, $deep_filter{$_}) } qw/original_prefix install_base_relpaths/), (map { $_ => _merge_deep($_, $deep_filter{$_}) } qw/install_sets prefix_relpaths/), ); sub new { my ($class, %args) = @_; my $config = $args{config} || ExtUtils::Config->new; my %self = ( config => $config, map { $_ => exists $args{$_} ? $filter{$_} ? $filter{$_}->($args{$_}, $config) : $args{$_} : ref $defaults{$_} ? $defaults{$_}->($config) : $defaults{$_} } keys %defaults, ); $self{module_name} ||= do { my $module_name = $self{dist_name}; $module_name =~ s/-/::/g; $module_name } if defined $self{dist_name}; return bless \%self, $class; } for my $attribute (keys %defaults) { no strict qw/refs/; *{$attribute} = $hash_accessors{$attribute} ? sub { my ($self, $key) = @_; Carp::confess("$attribute needs key") if not defined $key; return $self->{$attribute}{$key}; } : $complex_accessors{$attribute} ? sub { my ($self, $installdirs, $key) = @_; Carp::confess("$attribute needs installdir") if not defined $installdirs; Carp::confess("$attribute needs key") if not defined $key; return $self->{$attribute}{$installdirs}{$key}; } : sub { my $self = shift; return $self->{$attribute}; }; } my $script = $] > 5.008000 ? 'script' : 'bin'; my @install_sets_keys = qw/lib arch bin script bindoc libdoc binhtml libhtml/; my @install_sets_tail = ('bin', $script, qw/man1dir man3dir html1dir html3dir/); my %install_sets_values = ( core => [ qw/privlib archlib /, @install_sets_tail ], site => [ map { "site$_" } qw/lib arch/, @install_sets_tail ], vendor => [ map { "vendor$_" } qw/lib arch/, @install_sets_tail ], ); sub _default_install_sets { my $c = shift; my %ret; for my $installdir (qw/core site vendor/) { @{$ret{$installdir}}{@install_sets_keys} = map { $c->get("install$_") } @{ $install_sets_values{$installdir} }; } return \%ret; } sub _default_base_relpaths { my $config = shift; return { lib => ['lib', 'perl5'], arch => ['lib', 'perl5', $config->get('archname')], bin => ['bin'], script => ['bin'], bindoc => ['man', 'man1'], libdoc => ['man', 'man3'], binhtml => ['html'], libhtml => ['html'], }; } my %common_prefix_relpaths = ( bin => ['bin'], script => ['bin'], bindoc => ['man', 'man1'], libdoc => ['man', 'man3'], binhtml => ['html'], libhtml => ['html'], ); sub _default_prefix_relpaths { my $c = shift; my @libstyle = $c->get('installstyle') ? File::Spec->splitdir($c->get('installstyle')) : qw(lib perl5); my $arch = $c->get('archname'); my $version = $c->get('version'); return { core => { lib => [@libstyle], arch => [@libstyle, $version, $arch], %common_prefix_relpaths, }, vendor => { lib => [@libstyle], arch => [@libstyle, $version, $arch], %common_prefix_relpaths, }, site => { lib => [@libstyle, 'site_perl'], arch => [@libstyle, 'site_perl', $version, $arch], %common_prefix_relpaths, }, }; } sub _default_original_prefix { my $c = shift; my %ret = ( core => $c->get('installprefixexp'), site => $c->get('siteprefixexp'), vendor => $c->get('usevendorprefix') ? $c->get('vendorprefixexp') : '', ); return \%ret; } sub _log_verbose { my $self = shift; print @_ if $self->verbose; return; } # Given a file type, will return true if the file type would normally # be installed when neither install-base nor prefix has been set. # I.e. it will be true only if the path is set from Config.pm or # set explicitly by the user via install-path. sub is_default_installable { my $self = shift; my $type = shift; my $installable = $self->install_destination($type) && ( $self->install_path($type) || $self->install_sets($self->installdirs, $type)); return $installable ? 1 : 0; } sub _prefixify_default { my $self = shift; my $type = shift; my $rprefix = shift; my $default = $self->prefix_relpaths($self->installdirs, $type); if( !$default ) { $self->_log_verbose(" no default install location for type '$type', using prefix '$rprefix'.\n"); return $rprefix; } else { return File::Spec->catdir(@{$default}); } } # Translated from ExtUtils::MM_Unix::prefixify() sub _prefixify_novms { my($self, $path, $sprefix, $type) = @_; my $rprefix = $self->prefix; $rprefix .= '/' if $sprefix =~ m{/$}; $self->_log_verbose(" prefixify $path from $sprefix to $rprefix\n") if defined $path && length $path; if (not defined $path or length $path == 0 ) { $self->_log_verbose(" no path to prefixify, falling back to default.\n"); return $self->_prefixify_default( $type, $rprefix ); } elsif( !File::Spec->file_name_is_absolute($path) ) { $self->_log_verbose(" path is relative, not prefixifying.\n"); } elsif( $path !~ s{^\Q$sprefix\E\b}{}s ) { $self->_log_verbose(" cannot prefixify, falling back to default.\n"); return $self->_prefixify_default( $type, $rprefix ); } $self->_log_verbose(" now $path in $rprefix\n"); return $path; } sub _catprefix_vms { my ($self, $rprefix, $default) = @_; my ($rvol, $rdirs) = File::Spec->splitpath($rprefix); if ($rvol) { return File::Spec->catpath($rvol, File::Spec->catdir($rdirs, $default), ''); } else { return File::Spec->catdir($rdirs, $default); } } sub _prefixify_vms { my($self, $path, $sprefix, $type) = @_; my $rprefix = $self->prefix; return '' unless defined $path; $self->_log_verbose(" prefixify $path from $sprefix to $rprefix\n"); require VMS::Filespec; # Translate $(PERLPREFIX) to a real path. $rprefix = VMS::Filespec::vmspath($rprefix) if $rprefix; $sprefix = VMS::Filespec::vmspath($sprefix) if $sprefix; $self->_log_verbose(" rprefix translated to $rprefix\n sprefix translated to $sprefix\n"); if (length($path) == 0 ) { $self->_log_verbose(" no path to prefixify.\n") } elsif (!File::Spec->file_name_is_absolute($path)) { $self->_log_verbose(" path is relative, not prefixifying.\n"); } elsif ($sprefix eq $rprefix) { $self->_log_verbose(" no new prefix.\n"); } else { my ($path_vol, $path_dirs) = File::Spec->splitpath( $path ); my $vms_prefix = $self->config->get('vms_prefix'); if ($path_vol eq $vms_prefix.':') { $self->_log_verbose(" $vms_prefix: seen\n"); $path_dirs =~ s{^\[}{\[.} unless $path_dirs =~ m{^\[\.}; $path = $self->_catprefix_vms($rprefix, $path_dirs); } else { $self->_log_verbose(" cannot prefixify.\n"); return File::Spec->catdir($self->prefix_relpaths($self->installdirs, $type)); } } $self->_log_verbose(" now $path\n"); return $path; } BEGIN { *_prefixify = $^O eq 'VMS' ? \&_prefixify_vms : \&_prefixify_novms } # Translated from ExtUtils::MM_Any::init_INSTALL_from_PREFIX sub prefix_relative { my ($self, $installdirs, $type) = @_; my $relpath = $self->install_sets($installdirs, $type); return $self->_prefixify($relpath, $self->original_prefix($installdirs), $type); } sub install_destination { my ($self, $type) = @_; return $self->install_path($type) if $self->install_path($type); if ( $self->install_base ) { my $relpath = $self->install_base_relpaths($type); return $relpath ? File::Spec->catdir($self->install_base, @{$relpath}) : undef; } if ( $self->prefix ) { my $relpath = $self->prefix_relative($self->installdirs, $type); return $relpath ? File::Spec->catdir($self->prefix, $relpath) : undef; } return $self->install_sets($self->installdirs, $type); } sub install_types { my $self = shift; my %types = ( %{ $self->{install_path} }, $self->install_base ? %{ $self->{install_base_relpaths} } : $self->prefix ? %{ $self->{prefix_relpaths}{ $self->installdirs } } : %{ $self->{install_sets}{ $self->installdirs } }); return sort keys %types; } sub install_map { my ($self, $dirs) = @_; my %localdir_for; if ($dirs && %$dirs) { %localdir_for = %$dirs; } else { foreach my $type ($self->install_types) { $localdir_for{$type} = File::Spec->catdir('blib', $type); } } my (%map, @skipping); foreach my $type (keys %localdir_for) { next if not -e $localdir_for{$type}; if (my $dest = $self->install_destination($type)) { $map{$localdir_for{$type}} = $dest; } else { push @skipping, $type; } } warn "WARNING: Can't figure out install path for types: @skipping\nFiles will not be installed.\n" if @skipping; # Write the packlist into the same place as ExtUtils::MakeMaker. if ($self->create_packlist and my $module_name = $self->module_name) { my $archdir = $self->install_destination('arch'); my @ext = split /::/, $module_name; $map{write} = File::Spec->catfile($archdir, 'auto', @ext, '.packlist'); } # Handle destdir if (length(my $destdir = $self->destdir || '')) { foreach (keys %map) { # Need to remove volume from $map{$_} using splitpath, or else # we'll create something crazy like C:\Foo\Bar\E:\Baz\Quux # VMS will always have the file separate than the path. my ($volume, $path, $file) = File::Spec->splitpath( $map{$_}, 0 ); # catdir needs a list of directories, or it will create something # crazy like volume:[Foo.Bar.volume.Baz.Quux] my @dirs = File::Spec->splitdir($path); # First merge the directories $path = File::Spec->catdir($destdir, @dirs); # Then put the file back on if there is one. if ($file ne '') { $map{$_} = File::Spec->catfile($path, $file) } else { $map{$_} = $path; } } } $map{read} = ''; # To keep ExtUtils::Install quiet return \%map; } 1; # ABSTRACT: Build.PL install path logic made easy __END__ =pod =encoding UTF-8 =head1 NAME ExtUtils::InstallPaths - Build.PL install path logic made easy =head1 VERSION version 0.012 =head1 SYNOPSIS use ExtUtils::InstallPaths; use ExtUtils::Install 'install'; GetOptions(\my %opt, 'install_base=s', 'install_path=s%', 'installdirs=s', 'destdir=s', 'prefix=s', 'uninst:1', 'verbose:1'); my $paths = ExtUtils::InstallPaths->new(%opt, dist_name => $dist_name); install($paths->install_map, $opt{verbose}, 0, $opt{uninst}); =head1 DESCRIPTION This module tries to make install path resolution as easy as possible. When you want to install a module, it needs to figure out where to install things. The nutshell version of how this works is that default installation locations are determined from L, and they may be individually overridden by using the C attribute. An C attribute lets you specify an alternative installation root like F and C does something similar in a rather different (and more complicated) way. C lets you specify a temporary installation directory like F in case you want to create bundled-up installable packages. The following types are supported by default. =over 4 =item * lib Usually pure-Perl module files ending in F<.pm> or F<.pod>. =item * arch "Architecture-dependent" module files, usually produced by compiling XS, L, or similar code. =item * script Programs written in pure Perl. In order to improve reuse, you may want to make these as small as possible - put the code into modules whenever possible. =item * bin "Architecture-dependent" executable programs, i.e. compiled C code or something. Pretty rare to see this in a perl distribution, but it happens. =item * bindoc Documentation for the stuff in C