package CPANPLUS::Dist::Arch;
use warnings;
use strict;
use base qw(CPANPLUS::Dist::Base Exporter);
use File::Spec::Functions qw(catfile catdir);
use Module::CoreList qw();
use CPANPLUS::Error qw(error msg);
use Digest::MD5 qw();
use Pod::Select qw();
use List::Util qw(first);
use File::Path 2.06_05 qw(make_path);
use File::Copy qw(copy);
use File::stat qw(stat);
use DynaLoader qw();
use IPC::Cmd qw(can_run);
use version qw(qv);
use English qw(-no_match_vars);
use Carp qw(carp croak confess);
use Cwd qw();
our $VERSION = '1.05';
our @EXPORT = qw();
our @EXPORT_OK = qw(dist_pkgname dist_pkgver);
our %EXPORT_TAGS = ( 'all' => [ @EXPORT_OK ] );
#-----------------------------------------------------------------------------
# CLASS CONSTANTS
#-----------------------------------------------------------------------------
my $MKPKGCONF_FQP = '/etc/makepkg.conf';
my $CPANURL = 'http://search.cpan.org';
my $ROOT_USER_ID = 0;
my $CFG_VALUE_MATCH = '\A \s* (%s) \s* = \s* (.*?) \s* (?: \#.* )? \z';
my $NONROOT_WARNING = <<'END_MSG';
In order to install packages as a non-root user (highly recommended)
you must have a sudo-like command specified in your CPANPLUS
configuration.
END_MSG
# META.yml abstract entries we should ignore.
my @BAD_METAYML_ABSTRACTS
= ( q{~}, 'Module abstract (<= 44 characters) goes here' );
# Patterns to use when using pacman for finding library owners.
my $PACMAN_FINDOWN = qr/\A[^ ]+ is owned by ([\w-]+) ([\w.-]+)/;
my $PACMAN_FINDOWN_ERR = qr/\Aerror:/;
# Override a package's name to conform to packaging guidelines.
# Copied entries from CPANPLUS::Dist::Pacman and alot more
# from searching for packages with perl in their name in
# [extra] and [community]
my $PKGNAME_OVERRIDES =
{ map { split /[\s=]+/ } split /\s*\n+\s*/, <<'END_OVERRIDES' };
libwww-perl = perl-libwww
glade-perl-two = perl-glade-two
aceperl = perl-ace
Gnome2-GConf = gconf-perl
Gtk2-GladeXML = glade-perl
Glib = glib-perl
Gnome2 = gnome-perl
Gnome2-VFS = gnome-vfs-perl
Gnome2-Canvas = gnomecanvas-perl
Gtk2 = gtk2-perl
XML-LibXML = libxml-perl
mod_perl = mod_perl
Pango = pango-perl
SDL = sdl_perl
Perl-Critic = perl-critic
Perl-Tidy = perl-tidy
App-Ack = ack
TermReadKey = perl-term-readkey
END_OVERRIDES
# This var tells us whether to use a template module or our internal code:
my $TT_MOD_NAME;
my @TT_MOD_SEARCH = qw/ Template Template::Alloy Template::Tiny /;
sub _tt_block
{
my $inside = shift;
return qr{ \[% -?
\s* $inside \s*
(?: (?: -%\] \n* ) | %\] ) }xms;
}
my $TT_IF_MATCH = _tt_block 'IF \s* (\w*)';
my $TT_END_MATCH = _tt_block 'END';
my $TT_VAR_MATCH = _tt_block '(\w+)';
# Crude template for our PKGBUILD script
my $PKGBUILD_TEMPL = <<'END_TEMPL';
# Contributor: [% packager %]
# Generator : CPANPLUS::Dist::Arch [% version %]
pkgname='[% pkgname %]'
pkgver='[% pkgver %]'
pkgrel='[% pkgrel %]'
pkgdesc="[% pkgdesc %]"
arch=('[% arch %]')
license=('PerlArtistic' 'GPL')
options=('!emptydirs')
depends=([% depends %])
url='[% url %]'
source=('[% source %]')
md5sums=('[% md5sums %]')
build() {
PERL=/usr/bin/perl
DIST_DIR="${srcdir}/[% distdir %]"
export PERL_MM_USE_DEFAULT=1 PERL5LIB="" \
PERL_AUTOINSTALL=--skipdeps \
PERL_MM_OPT="INSTALLDIRS=vendor DESTDIR='$pkgdir'" \
PERL_MB_OPT="--installdirs vendor --destdir '$pkgdir'" \
MODULEBUILDRC=/dev/null
{ cd "$DIST_DIR" &&
[% IF is_makemaker -%]
$PERL Makefile.PL &&
make &&
[% IF skiptest %]#[% END %]make test &&
make install;
[% END -%]
[% IF is_modulebuild -%]
$PERL Build.PL &&
$PERL Build &&
[% IF skiptest %]#[% END %]$PERL Build test &&
$PERL Build install;
[% END -%]
} || return 1;
find "$pkgdir" -name .packlist -o -name perllocal.pod -delete
}
END_TEMPL
=for Weird "perl Build" Syntax
We use "perl Build" above instead of the normal "./Build" in order to
make the yaourt packager happy. Yaourt runs the PKGBUILD under the /tmp
directory and makepkg will fail if /tmp is a seperate partition mounted
with noexec. Thanks to xenoterracide on the AUR for mentioning the
problem.
=cut
#----------------------------------------------------------------------
# CLASS GLOBALS
#----------------------------------------------------------------------
our ($Is_dependency, $PKGDEST, $PACKAGER, $DEBUG);
$PACKAGER = 'Anonymous';
sub _DEBUG;
*_DEBUG = ( $ENV{DIST_ARCH_DEBUG}
? sub { print STDERR '***DEBUG*** ', @_, "\n" }
: sub { return } );
#---HELPER FUNCTION---
# Purpose: Expand environment variables and tildes like bash would.
#---------------------
sub _shell_expand
{
my $dir = shift;
$dir =~ s/ \A ~ / $ENV{HOME} /xmse; # tilde = homedir
$dir =~ s/ (?<!\\) \$ (\w+) / $ENV{$1} || q{} /xmseg; # expand env vars
$dir =~ s/ \\ [a-zA-Z] / /xmsg;
$dir =~ s/ \\ (.) / $1 /xmsg; # escaped special
# chars
return $dir;
}
READ_CONF:
{
# Read makepkg.conf to see if there are system-wide settings
my $mkpkgconf;
if ( ! open $mkpkgconf, '<', $MKPKGCONF_FQP ) {
error "Could not read $MKPKGCONF_FQP: $!";
last READ_CONF;
}
my %cfg_vars = ( 'PKGDEST' => \$PKGDEST,
'PACKAGER' => \$PACKAGER );
my $cfg_field_match = sprintf $CFG_VALUE_MATCH,
join '|', keys %cfg_vars;
CFG_LINE:
while (<$mkpkgconf>) {
chomp;
next CFG_LINE unless ( my ($name, $value) = /$cfg_field_match/xmso );
${ $cfg_vars{$name} } =
( $value =~ m/\A"(.*)"\z/
? _shell_expand( $1 ) # expand double quotes
: ( $value =~ m/\A'(.*)'\z/
? $1 # dont single quotes
: _shell_expand( $value )));
}
close $mkpkgconf or error "close on makepkg.conf: $!";
}
#-----------------------------------------------------------------------------
# PUBLIC CPANPLUS::Dist::Base Interface
#-----------------------------------------------------------------------------
=for Interface Methods
See CPANPLUS::Dist::Base's documentation for a description of the
purpose of these functions. All of these "interface" methods override
Base's default actions in order to create our packages.
=cut
#---INTERFACE METHOD---
# Purpose : Checks if we have makepkg and pacman installed
# Returns : 1 - if we have the tools needed to make a pacman package.
# 0 - if we don't think so.
#----------------------
sub format_available
{
for my $prog ( qw/ makepkg pacman / ) {
if ( ! can_run($prog) ) {
error "CPANPLUS::Dist::Arch needs to run $prog, to work properly";
return 0;
}
}
return 1;
}
#---INTERFACE METHOD---
# Purpose : Initializes our object internals to get things started
# Returns : 1 always
#----------------------
sub init
{
my $self = shift;
$self->status->mk_accessors( qw{ pkgname pkgver pkgbase pkgdesc
pkgurl pkgsize arch pkgrel
builddir destdir
pkgbuild_templ tt_init_args } );
return 1;
}
#---INTERFACE METHOD---
# Purpose : Prepares the files and directories we will need to build a
# package. Also prepares any data we expect to have later,
# on a per-object basis.
# Return : 1 if ok, 0 on error.
# Postcond : Sets $self->status->prepare to 1 or 0 on success or
# failure.
#----------------------
sub prepare
{
my $self = shift;
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $intern = $module->parent; # CPANPLUS::Internals
my $conf = $intern->configure_object; # CPANPLUS::Configure
my $distcpan = $module->status->dist_cpan; # CPANPLUS::Dist::MM or
# CPANPLUS::Dist::Build
$self->_prepare_status;
$status->prepared(0);
# Call CPANPLUS::Dist::Base's prepare to resolve our pre-reqs.
return $self->SUPER::prepare(@_);
}
#---PRIVATE METHOD---
# Purpose : Finds the first package file that matches our internal data.
# (Meaning we might have built it) We search for .tar.gz and
# .tar.xz files.
# Note : .tar.xz files have higher priority than .tar.gz files.
# Params : $pkg_type - Must be 'bin' or 'src'.
# $destdir - The directory to search in for packages.
# Returns : The absolute path of the found package
#-------------------
sub _find_built_pkg
{
my ($self, $pkg_type, $destdir) = @_;
my $status = $self->status;
my $pkgfile = catfile( $destdir,
( join q{.},
( join q{-},
$status->pkgname,
$status->pkgver,
$status->pkgrel,
( $pkg_type eq q{bin}
? $status->arch : qw// ),
),
( $pkg_type eq q{bin} ? q{pkg} : q{src} ),
q{tar},
));
_DEBUG "Searching for file starting with $pkgfile";
my ($found) =
( grep { -f $_ }
map { "$pkgfile.$_" } qw/ xz gz / );
_DEBUG ( $found ? "Found $found" : "No package file found!" );
return $found;
}
#---INTERFACE METHOD---
# Purpose : Creates the pacman package using the 'makepkg' command.
#----------------------
sub create
{
my ($self, %opts) = (shift, @_);
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $intern = $module->parent; # CPANPLUS::Internals
my $conf = $intern->configure_object; # CPANPLUS::Configure
my $distcpan = $module->status->dist_cpan; # CPANPLUS::Dist::MM or
# CPANPLUS::Dist::Build
# Create directories for building and delivering the new package.
MKDIR_LOOP:
for my $dir ( $status->pkgbase, $status->destdir ) {
if ( -e $dir ) {
die "$dir exists but is not a directory!" unless ( -d _ );
die "$dir exists but is read-only!" unless ( -w _ );
next MKDIR_LOOP;
}
make_path( $dir, { verbose => $opts{verbose} ? 1 : 0 });
}
my $pkg_type = $opts{pkg} || $opts{pkgtype} || 'bin';
$pkg_type = lc $pkg_type;
unless ( $pkg_type =~ /^(?:bin|src)$/ ) {
error qq{Invalid package type requested: "$pkg_type"
Package type must be 'bin' or 'src'};
return 0;
}
if ( $opts{verbose} ) {
my %fullname = ( bin => 'binary', src => 'source' );
msg "Creating a $fullname{$pkg_type} pacman package";
}
if ( $pkg_type eq 'bin' ) {
# Use CPANPLUS::Dist::Base to make packages for pre-requisites...
# (starts the packaging process for any missing ones)
my @ok_resolve_args = qw/ verbose target force prereq_build /;
my %resolve_args = map { ( exists $opts{$_} ?
($_ => $opts{$_}) : () ) } @ok_resolve_args;
local $Is_dependency = 1; # only top level pkgs explicitly installed
$distcpan->_resolve_prereqs( %resolve_args,
'format' => ref $self,
'prereqs' => $module->status->prereqs );
}
# Prepare our file name paths for pkgfile and source tarball...
my $srcfile_fqp = $status->pkgbase . '/' . $module->package;
$status->destdir( $opts{destdir} ) if $opts{destdir};
my $destdir = $status->destdir;
$destdir = Cwd::abs_path( $destdir );
# Prepare our 'makepkg' package building directory,
# namely the PKGBUILD and source tarball files...
if ( ! -e $srcfile_fqp ) {
my $tarball_fqp = $module->_status->fetch;
link $tarball_fqp, $srcfile_fqp
or error "Failed to create link to $tarball_fqp: $OS_ERROR";
}
$self->create_pkgbuild( $self->status->pkgbase, $opts{skiptest} );
# Package it up!
local $ENV{PKGDEST} = $destdir;
my $oldcwd = Cwd::getcwd();
chdir $status->pkgbase or die "chdir: $OS_ERROR";
my $makepkg_cmd = join q{ }, ( 'makepkg',
'-f', # should we force rebuilding?
( $EUID == 0 ? '--asroot' : () ),
( $pkg_type eq 'src' ? '--source' : () ),
( $opts{nocolor} ? '--nocolor' : () ),
( $opts{quiet} ? '2>&1 >/dev/null'
: () ),
);
# I tried to use IPC::Cmd here, but colors didn't work...
system $makepkg_cmd;
if ( $CHILD_ERROR ) {
error ( $CHILD_ERROR & 127
? sprintf "makepkg failed with signal %d", $CHILD_ERROR & 127
: sprintf "makepkg returned abnormal status: %d",
$CHILD_ERROR >> 8 );
return 0;
}
chdir $oldcwd or die "chdir: $OS_ERROR";
my $pkg_path = $self->_find_built_pkg( $pkg_type, $destdir );
$status->dist( $pkg_path );
return $status->created( 1 );
}
#---INTERFACE METHOD---
# Purpose : Installs the package file (.pkg.tar.gz) using sudo and
# pacman.
# Comments : Called automatically on pre-requisite packages
#----------------------
sub install
{
my ($self, %opts) = (shift, @_);
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $intern = $module->parent; # CPANPLUS::Internals
my $conf = $intern->configure_object; # CPANPLUS::Configure
my $pkgfile_fqp = $status->dist;
unless ( $pkgfile_fqp ) {
error << 'END_ERROR';
Path to package file has not been set.
Someone is using CPANPLUS::Dist::Arch incorrectly.
Tell them to call create() before install().
END_ERROR
return 0;
}
die "Package file $pkgfile_fqp was not found" if ( ! -f $pkgfile_fqp );
my @pacmancmd = ( 'pacman', '--noconfirm', '-U', $pkgfile_fqp,
( $Is_dependency ? '--asdeps' : '--asexplicit' ),
);
# Make sure the user has access to install a package...
my $sudocmd = $conf->get_program('sudo');
if ( $EFFECTIVE_USER_ID != $ROOT_USER_ID ) {
if ( $sudocmd ) {
unshift @pacmancmd, $sudocmd;
# $pacmancmd = "$sudocmd pacman -U $pkgfile_fqp";
}
else {
error $NONROOT_WARNING;
return 0;
}
}
system @pacmancmd;
if ( $CHILD_ERROR ) {
error ( $CHILD_ERROR & 127
? sprintf qq{'@pacmancmd' failed with signal %d},
$CHILD_ERROR & 127
: sprintf qq{'@pacmancmd' returned abnormal status: %d},
$CHILD_ERROR >> 8
);
return 0;
}
return $status->installed(1);
}
#-----------------------------------------------------------------------------
# EXPORTED FUNCTIONS
#-----------------------------------------------------------------------------
sub dist_pkgname
{
croak "Must provide arguments to dist_pkgname" if ( @_ == 0 );
my ($distname) = @_;
# Override this package name if there is one specified...
return $PKGNAME_OVERRIDES->{$distname}
if $PKGNAME_OVERRIDES->{$distname};
# Package names should be lowercase and consist of alphanumeric
# characters only (and hyphens!)...
$distname = lc $distname;
$distname =~ tr/_/-/;
$distname =~ tr/-a-z0-9//cd;
$distname =~ tr/-/-/s;
# Delete leading or trailing hyphens...
$distname =~ s/\A-//;
$distname =~ s/-\z//;
die qq{Dist name '$distname' completely violates packaging standards}
if ( ! $distname );
# Don't prefix the package with perl- if it IS perl...
$distname = "perl-$distname" unless ( $distname eq 'perl' );
return $distname;
}
sub dist_pkgver
{
croak "Must provide arguments to pacman_version" if ( @_ == 0 );
my ($version) = @_;
# Package versions should be numbers and decimal points only...
$version =~ tr/-/./;
$version =~ tr/_0-9.-//cd;
# Developer packages have a ..._## at the end though...
unless (( $version =~ tr/_/_/ == 1 ) && ( $version =~ /\d_\d+$/ )) {
$version =~ tr/_//d; # Delete underscores otherwise.
}
$version =~ tr/././s;
$version =~ s/[.]$//;
$version =~ s/^[.]//;
return $version;
}
=for Letters In Versions
Letters aren't allowed in versions because makepkg doesn't handle them
in dependencies. Example:
* CAM::PDF requires Text::PDF 0.29
* Text::PDF 0.29a was built/installed
* makepkg still complains about perl-text-pdf>=0.29 is missing ... ?
So ... no more letters in versions.
=cut
#-----------------------------------------------------------------------------
# PUBLIC METHODS
#-----------------------------------------------------------------------------
sub set_destdir
{
croak 'Invalid arguments to set_destdir' if ( @_ != 2 );
my ($self, $destdir) = @_;
$self->status->destdir($destdir);
return $destdir;
}
sub get_destdir
{
my $self = shift;
return $self->status->destdir;
}
sub get_pkgpath
{
my $self = shift;
return $self->status->dist;
}
sub get_cpandistdir
{
my ($self) = @_;
my $module = $self->parent;
my $distdir = $module->status->dist_cpan->status->distdir;
$distdir =~ s{^.*/}{};
return $distdir;
}
sub get_pkgname
{
return shift->status->pkgname;
}
sub get_pkgver
{
return shift->status->pkgver;
}
sub get_pkgrel
{
my ($self) = @_;
return $self->status->pkgrel;
}
sub set_pkgrel
{
my ($self, $new_pkgrel) = @_;
return $self->status->pkgrel( $new_pkgrel );
}
sub get_pkgvars
{
croak 'Invalid arguments to get_pkgvars' if ( @_ != 1 );
my $self = shift;
my $status = $self->status;
croak 'prepare() must be called before get_pkgvars()'
unless ( $status->prepared );
return ( pkgname => $status->pkgname,
pkgver => $status->pkgver,
pkgrel => $status->pkgrel,
arch => $status->arch,
pkgdesc => $status->pkgdesc,
depends => scalar $self->_translate_cpan_deps,
url => $self->_get_disturl,
source => $self->_get_srcurl,
md5sums => $self->_calc_tarballmd5,
depshash => { $self->_translate_cpan_deps },
);
}
sub get_pkgvars_ref
{
croak 'Invalid arguments to get_pkgvars_ref' if ( @_ != 1 );
my $self = shift;
return { $self->get_pkgvars };
}
sub set_tt_init_args
{
my $self = shift;
croak 'set_tt_init_args() must be given a hash as an argument'
unless @_ % 2 == 0;
return $self->status->tt_init_args( { @_ } );
}
sub set_tt_module
{
my ($self, $modname) = @_;
return ( $TT_MOD_NAME = 0 ) unless $modname;
croak qq{Failed to load template module "$modname"}
unless eval "require $modname; 1;";
_DEBUG "Loaded template module: $modname";
return $TT_MOD_NAME = $modname;
}
sub get_tt_module
{
_load_tt_module() unless defined $TT_MOD_NAME;
return $TT_MOD_NAME;
}
sub set_pkgbuild_templ
{
my ($self, $template) = @_;
return $self->status->pkgbuild_templ( $template );
}
sub get_pkgbuild_templ
{
my ($self) = @_;
return $self->status->pkgbuild_templ() || $PKGBUILD_TEMPL;
}
sub get_pkgbuild
{
croak 'Invalid arguments to get_pkgbuild' if ( @_ < 1 );
my ($self, $skiptest) = @_;
my $status = $self->status;
my $module = $self->parent;
my $conf = $module->parent->configure_object;
croak 'prepare() must be called before get_pkgbuild()'
unless $status->prepared;
my %pkgvars = $self->get_pkgvars;
# Quote our package desc for bash.
$pkgvars{pkgdesc} =~ s/ ([\$\"\`]) / \\$1 /gxms;
# !'s are much more annoying...
$pkgvars{pkgdesc} =~ s/ \! /"'!'"/xms;
my $templ_vars = { packager => $ENV{PACKAGER} || $PACKAGER,
version => $VERSION,
%pkgvars,
distdir => $self->get_cpandistdir(),
skiptest => $skiptest || $conf->get_conf('skiptest'),
};
my $dist_type = $module->status->installer_type;
@{$templ_vars}{'is_makemaker', 'is_modulebuild'} =
( $dist_type eq 'CPANPLUS::Dist::MM' ? (1, 0) :
$dist_type eq 'CPANPLUS::Dist::Build' ? (0, 1) :
die "unknown Perl module installer type: '$dist_type'" );
my $templ_text = $status->pkgbuild_templ || $PKGBUILD_TEMPL;
return scalar $self->_process_template( $templ_text, $templ_vars );
}
sub create_pkgbuild
{
croak 'Invalid arguments to create_pkgbuild' if ( @_ < 2 );
my ($self, $destdir, $skiptest) = @_;
croak qq{Invalid directory passed to create_pkgbuild: "$destdir" ...
Directory does not exist or is not writeable}
unless ( -d $destdir && -w _ );
my $pkgbuild_text = $self->get_pkgbuild( $skiptest );
my $fqpath = catfile( $destdir, 'PKGBUILD' );
open my $pkgbuild_file, '>', $fqpath
or die "failed to open new PKGBUILD: $OS_ERROR";
print $pkgbuild_file $pkgbuild_text;
close $pkgbuild_file
or die "failed to close new PKGBUILD: $OS_ERROR";
return;
}
#-----------------------------------------------------------------------------
# PRIVATE INSTANCE METHODS
#-----------------------------------------------------------------------------
#---HELPER FUNCTION---
sub _is_main_module
{
my ($mod_name, $dist_name) = @_;
$mod_name =~ tr/:/-/s;
return (lc $mod_name) eq (lc $dist_name);
}
#---INSTANCE METHOD---
# Usage : my $deps_str = $self->_translate_cpan_deps()
# Purpose : Convert CPAN prerequisites into pacman package dependencies
# Returns : String to be appended after 'depends=' in PKGBUILD file,
# without parenthesis.
#---------------------
sub _translate_cpan_deps
{
croak 'Invalid arguments to _translate_cpan_deps method'
if @_ != 1;
my ($self) = @_;
my %pkgdeps;
my $module = $self->parent;
my $backend = $module->parent;
my $prereqs = $module->status->prereqs;
CPAN_DEP_LOOP:
for my $modname ( keys %{$prereqs} ) {
my $depver = $prereqs->{$modname};
# Sometimes a perl version is given as a prerequisite
if ( $modname eq 'perl' ) {
$pkgdeps{perl} = $depver;
next CPAN_DEP_LOOP;
}
# Ignore modules included with this version of perl...
# NOTE: If 'provides' are given version numbers in the perl
# package we won't need to check this.
# (But we still do, owell. It avoids redundancy.)
my $bundled_version = $Module::CoreList::version{ 0+$] }->{$modname};
if ( defined $bundled_version ) {
next CPAN_DEP_LOOP if ( qv($bundled_version) >= qv($depver) );
}
# Translate the module's distribution name into a package name...
my $modobj = $backend->module_tree( $modname )
or next CPAN_DEP_LOOP;
my $pkgname = dist_pkgname( $modobj->package_name );
# If two module prereqs are in the same distribution ("package") file
# then try to choose the one with the same name as the file...
if ( exists $pkgdeps{$pkgname} ) {
next CPAN_DEP_LOOP unless _is_main_module( $modname, $pkgname );
}
$pkgdeps{$pkgname} = ( qv($depver) == 0 ? 0 : dist_pkgver( $depver ));
}
# Always require perl.
$pkgdeps{perl} ||= 0;
# Merge in the XS C library package deps...
my $xs_deps = $self->_translate_xs_deps;
XSDEP_LOOP:
while ( my ($name, $ver) = each %$xs_deps ) {
# TODO: report this error?
next XSDEP_LOOP if ( exists $pkgdeps{$name} );
$pkgdeps{$name} = $ver;
}
# Return a hash if in list context or return a string representing
# the depends= line in the PKGBUILD if caller wants a scalar.
return %pkgdeps if ( wantarray );
return ( join ' ',
map { $pkgdeps{$_} ? qq{'${_}>=$pkgdeps{$_}'} : qq{'$_'} }
sort keys %pkgdeps );
}
#---HELPER FUNCTION---
sub _metayml_pkgdesc
{
my ($mod_obj) = @_;
my $metayml;
unless ( open $metayml, '<',
catfile( $mod_obj->status->extract, 'META.yml' )) {
_DEBUG( "Could not open META.yml to get pkgdesc: $!" );
return undef;
}
while ( <$metayml> ) {
chomp;
if ( my ($pkgdesc) = / \A abstract: \s* (.+) \s* \z /xms ) {
_DEBUG qq{Found pkgdesc "$pkgdesc" in META.yml};
# Ignore enclosing quotes...
$pkgdesc = $2 if ( $pkgdesc =~ / \A (['"]) (.*) \1 \z /xms );
# Ignore certain values we don't like...
for my $bad ( @BAD_METAYML_ABSTRACTS ) {
return undef if $pkgdesc eq $bad;
}
return $pkgdesc;
}
}
return undef;
}
#---HELPER FUNCTION---
sub _pod_pkgdesc
{
my ($mod_obj) = @_;
my $podselect = Pod::Select->new;
my $modname = $mod_obj->name;
$podselect->select('NAME');
=for POD Search
We use the package name because there is usually a module file
with the exact same name as the package file.
We want the main module's description, just in case the user requested
a lesser module in the same package file.
Assume the main .pm or .pod file is under lib/Module/Name/Here.pm
=cut
my $mainmod_path = $mod_obj->package_name;
$mainmod_path =~ tr{-}{/}s;
my $mainmod_file = $mainmod_path;
$mainmod_file =~ s{\A.*/}{};
$mainmod_path =~ s{/$mainmod_file}{};
my $base_path = $mod_obj->status->extract;
my @possible_pods = (# check directly inside the extracted folder
# and deep inside the lib directory
map { ( catfile( $base_path, 'lib', $_ ),
catfile( $base_path, $_ )) }
map { ( catfile( $mainmod_path, $_ ), $_ ) }
# .pm files and .pod files
map { "${mainmod_file}.$_" }
qw/pod pm/ );
PODSEARCH:
for my $podfile_path ( @possible_pods ) {
next PODSEARCH unless ( -e $podfile_path );
_DEBUG "Searching the POD inside $podfile_path for pkgdesc...";
my $name_section = q{};
open my $podfile, '<', $podfile_path
or next PODSEARCH;
open my $podout, '>', \$name_section
or die "failed open on filehandle to string: $!";
$podselect->parse_from_filehandle( $podfile, $podout );
close $podfile;
close $podout or die "failed close on filehandle to string: $!";
next PODSEARCH unless ( $name_section );
# Remove formatting codes.
$name_section =~ s{ [IBCLEFSXZ] <(.*?)> }{$1}gxms;
$name_section =~ s{ [IBCLEFSXZ] <<(.*?)>> }{$1}gxms;
# The short desc is on a line beginning with 'Module::Name - '
if ( $name_section =~ / ^ \s* $modname [ -]+ ([^\n]+) /xms ) {
_DEBUG qq{Found pkgdesc "$1" in POD};
return $1;
}
}
return undef;
}
#---HELPER FUNCTION---
sub _readme_pkgdesc
{
my ($mod_obj) = @_;
my $mod_name = $mod_obj->name;
open my $readme, '<', catfile( $mod_obj->status->extract, 'README' )
or return undef;
LINE:
while ( <$readme> ) {
chomp;
# limit ourselves to a NAME section
next LINE unless ( (/^NAME/ ... /^[A-Z]+/) &&
/ ^ \s* ${mod_name} [\s\-]+ (.+) $ /oxms );
_DEBUG qq{Found pkgdesc "$1" in README};
return $1;
}
return undef;
}
#---INSTANCE METHOD---
# Usage : $pkgdesc = $self->_prepare_pkgdesc();
# Purpose : Tries to find a module's "abstract" short description for
# use as a package description.
# Postcond : Sets the $self->status->pkgdesc accessor to the found
# package description.
# Returns : The package short description.
# Comments : We search through the META.yml file, the main module's .pm file,
# .pod file, and then the README file.
#---------------------
sub _prepare_pkgdesc
{
croak 'Invalid arguments to _prepare_pkgdesc method' if @_ != 1;
my ($self) = @_;
my ($status, $module, $pkgdesc) = ($self->status, $self->parent);
my @pkgdesc_srcs =
(
# Registered modules have their description stored in the object.
sub { $module->description },
# First, try to find the short description in the META.yml file...
\&_metayml_pkgdesc,
# Next, parse the source file or pod file for a NAME section...
\&_pod_pkgdesc,
# Last, try to find it in in the README file...
\&_readme_pkgdesc,
);
PKGDESC_LOOP:
for my $pkgdesc_src ( @pkgdesc_srcs ) {
$pkgdesc = $pkgdesc_src->( $module ) and last PKGDESC_LOOP;
}
return $status->pkgdesc( $pkgdesc || q{} );
}
#---INSTANCE METHOD---
# Usage : $self->_prepare_status()
# Purpose : Prepares all the package-specific accessors in our $self->status
# accessor object (of the class Object::Accessor).
# Postcond : Accessors assigned to: pkgname pkgver pkgbase arch destdir
# Returns : The object's status accessor.
#---------------------
sub _prepare_status
{
croak 'Invalid arguments to _prepare_status method' if @_ != 1;
my $self = shift;
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $conf = $module->parent->configure_object;
my $our_base = catdir( $conf->get_conf('base'),
( sprintf "%vd", $PERL_VERSION ),
'pacman' );
$status->destdir( $ENV{PKGDEST} ||
$PKGDEST ||
catdir( $our_base, 'pkg' ) );
my ($pkgver, $pkgname)
= ( dist_pkgver( $module->package_version ),
dist_pkgname( $module->package_name));
my $pkgbase = catdir( $our_base, 'build', "$pkgname-$pkgver" );
foreach ( $pkgname, $pkgver, $pkgbase ) {
die "A package variable is invalid" unless defined;
}
$status->pkgname( $pkgname );
$status->pkgver ( $pkgver );
$status->pkgbase( $pkgbase );
$status->pkgrel ( 1 );
$status->arch ( 'any' );
$status->tt_init_args( {} );
$self->_prepare_pkgdesc();
return $status;
}
#---INSTANCE METHOD---
# Usage : my $pkgurl = $self->_get_disturl()
# Purpose : Creates a nice, version agnostic homepage URL for the
# distribution.
# Returns : URL to the distribution's web page on CPAN.
#---------------------
sub _get_disturl
{
croak 'Invalid arguments to _get_disturl method' if @_ != 1;
my $self = shift;
my $module = $self->parent;
my $distname = $module->package_name;
return join '/', $CPANURL, 'dist', $distname;
}
#---INSTANCE METHOD---
# Usage : my $srcurl = $self->_get_srcurl()
# Purpose : Generates the standard cpan download link for the source tarball.
# Returns : URL to the distribution's tarball on CPAN.
#---------------------
sub _get_srcurl
{
croak 'Invalid arguments to _get_srcurl method' if @_ != 1;
my ($self) = @_;
my $module = $self->parent;
return join '/', $CPANURL, 'CPAN', $module->path, $module->package;
}
#---INSTANCE METHOD---
# Usage : my $md5hex = $self->calc_tarballmd5()
# Purpose : Returns the hex md5 string for the source (dist) tarball
# of the module.
# Throws : failed to get md5 of <filename>: ...
# Returns : The MD5 sum of the .tar.gz file in hex string form.
#---------------------
sub _calc_tarballmd5
{
my ($self) = @_;
my $module = $self->parent;
my $tarball_fqp = $module->_status->fetch;
# my $tarball_fqp = $self->status->pkgbase . '/' . $module->package;
open my $distfile, '<', $tarball_fqp
or die "failed to get md5 of $tarball_fqp: $OS_ERROR";
my $md5 = Digest::MD5->new;
$md5->addfile($distfile);
close $distfile;
return $md5->hexdigest;
}
#---HELPER FUNCTION---
# Purpose : Split the text into everything before the tags, inside tags, and
# after the tags. Inner nested tags are skipped.
#---------------------
sub _extract_nested
{
croak 'Invalid arguments to _extract_nested' unless ( @_ == 3 );
my ($text, $begin_match, $end_match) = @_;
my ($before_end, $middle_start, $middle_end, $after_start);
croak qq{could not find beginning match "$begin_match"}
unless ( $text =~ /$begin_match/ );
$before_end = $LAST_MATCH_START[0];
$middle_start = $LAST_MATCH_END [0];
my $search_pos = $middle_start;
END_SEARCH:
{
pos $text = $search_pos;
croak sprintf <<'END_ERR', substr $text, $search_pos, 30
could not find ending match starting at:
%s...
END_ERR
unless ( $text =~ /$end_match/go );
$middle_end = $LAST_MATCH_START[0];
$after_start = $LAST_MATCH_END[0];
pos $text = $search_pos;
if ( $text =~ /$begin_match/go && pos($text) < $after_start ) {
$search_pos = $after_start;
redo END_SEARCH;
}
}
my $before = substr $text, 0, $before_end;
my $middle = substr $text, $middle_start, $middle_end-$middle_start;
my $after = substr $text, $after_start;
return ($before, $middle, $after);
}
#---HELPER FUNCTION---
# Purpose : Removes IF blocks whose variables are not true.
# Params : $templ - The template as a string.
# $templ_vars - A hashref to template variables.
#---------------------
sub _prune_if_blocks
{
my ($templ, $templ_vars) = @_;
while ( my ($varname) = $templ =~ $TT_IF_MATCH ) {
croak "Invalid template given.\n"
. 'Must provide a variable name in an IF block' unless $varname;
croak "Unknown variable name in IF block: $varname"
unless ( exists $templ_vars->{$varname} );
my @chunks = _extract_nested( $templ, $TT_IF_MATCH, $TT_END_MATCH );
if ( ! $templ_vars->{$varname} ) { splice @chunks, 1, 1; }
$templ = join q{}, @chunks;
}
return $templ;
}
#---HELPER FUNCTION---
# Purpose : Load a template module and store its name for later use.
# Postcond : Stores the template name into $TT_MOD_NAME.
# Returns : Nothing.
#---------------------
sub _load_tt_module
{
_DEBUG "Searching for template modules...";
TT_SEARCH:
for my $ttmod ( @TT_MOD_SEARCH ) {
eval "require $ttmod; 1;" or next TT_SEARCH;
_DEBUG "Loaded template module: $ttmod";
$TT_MOD_NAME = $ttmod;
return;
}
_DEBUG "None found!";
$TT_MOD_NAME = 0;
return;
}
#---HELPER METHOD---
# Purpose : Create our template module object and process our template text.
# Params : $templ - A string of template text.
# $templ_vars - A hashref of template variable names and their
# values.
# Returns : The template module's processed text.
#-------------------
sub _tt_process
{
my ($self, $templ, $templ_vars) = @_;
confess 'Internal Error: $TT_MOD_NAME not set' unless $TT_MOD_NAME;
_DEBUG "Processing template using $TT_MOD_NAME";
my ($tt_obj, $tt_output, $tt_init_args);
$tt_init_args = $self->status->tt_init_args();
$tt_output = q{};
$tt_obj = $TT_MOD_NAME->new( $TT_MOD_NAME eq 'Template'
? $tt_init_args : %$tt_init_args );
# TT takes a hashref, others take the hash
$tt_obj->process( \$templ, $templ_vars, \$tt_output );
croak "$TT_MOD_NAME failed to process PKGBUILD template:\n"
. $tt_obj->error if ( eval { $tt_obj->error } );
return $tt_output;
}
#---INSTANCE METHOD---
# Usage : $self->_process_template( $templ, $templ_vars );
# Purpose : Process template text with a template module or our builtin
# template code.
# Params : templ - A string containing the template text.
# templ_vars - A hashref of template variables that you can
# refer to in the template to insert the
# variable's value.
# Throws : 'Template variable %s was not provided' is thrown if a template
# variable is used in $templ but not provided in $templ_vars,
# OR IF IT IS UNDEF!
# Returns : String of the template result.
#---------------------
sub _process_template
{
croak "Invalid arguments to _process_template" if @_ != 3;
my ($self, $templ, $templ_vars) = @_;
croak 'templ_var parameter must be a hashref'
if ( ref $templ_vars ne 'HASH' );
# Try to find a TT module if this is our first time called...
_load_tt_module() unless defined $TT_MOD_NAME;
# Use the TT module if we have found one earlier...
return $self->_tt_process( $templ, $templ_vars ) if $TT_MOD_NAME;
_DEBUG "Processing PKGBUILD template with built-in code...";
# Fall back on our own primitive little template engine...
$templ = _prune_if_blocks( $templ, $templ_vars );
$templ =~ s{ $TT_VAR_MATCH }
{ ( defined $templ_vars->{$1}
? $templ_vars->{$1}
: croak "Template variable $1 was not provided" )
}xmseg;
return $templ;
}
#-----------------------------------------------------------------------------
# XS module library dependency hunting
#-----------------------------------------------------------------------------
#---INSTANCE METHOD---
# Usage : $deps_ref = $self->_translate_cs_deps;
# Purpose : Attempts to find non-perl dependencies in XS modules.
# Returns : A hashref of 'package name' => 'minimum version'.
# (Minimum version will be the current installed version
# of the library)
#---------------------
sub _translate_xs_deps
{
my $self = shift;
my $modstat = $self->parent->status;
my $inst_type = $modstat->installer_type;
my $distcpan = $modstat->dist_cpan;
# Delegate to the other methods depending on the dist type...
my $libs_ref = ( $inst_type eq 'CPANPLUS::Dist::MM'
? $self->_get_mm_xs_deps($distcpan) : [] );
# TODO: figure out how to do this with Module::Build
# Turn the linker flags into package deps...
return +{ map { ($self->_get_lib_pkg($_)) }
@$libs_ref };
}
#---INSTANCE METHOD---
# Usage : %pkg = $self->_get_lib_pkg($lib)
# Params : $lib - Can be a dynamic library name, with/without lib prefix
# or the -l<name> flag that is passed to the linker.
# (anything DynaLoader::dl_findfile accepts)
# Returns : A hash (or two element list) of:
# 'package name' => 'installed version'
# or an empty list if the lib/package owner could not be found.
#---------------------
sub _get_lib_pkg
{
my ($self, $libname) = @_;
my $lib_fqp = DynaLoader::dl_findfile($libname)
or return ();
my $result = `pacman -Qo $lib_fqp`;
chomp $result;
if ( $result =~ /$PACMAN_FINDOWN_ERR/ ) {
error qq{Could not find owner of linked library }
. qq{"$libname", ignoring.};
return ();
}
my ($pkgname, $pkgver) = $result =~ /$PACMAN_FINDOWN/;
$pkgver =~ s/-\d+\z//; # remove the package revision number
return ($pkgname => $pkgver);
}
sub _unique(@)
{
my %seen;
return map { $seen{$_}++ ? () : $_ } @_;
}
#---INSTANCE METHOD---
# Usage : my $deps_ref = $self->_get_mm_xs_deps($dist_obj);
# Params : $dist_obj - A CPANPLUS::Dist::MM object
# Returns : Arrayref of library flags (-l...) passed to the linker on build.
#---------------------
sub _get_mm_xs_deps
{
my ($self, $dist) = @_;
my $field_srch = '\A(?:EXTRALIBS|LDLOADLIBS|BSLOADLIBS) = (.+)\z';
my $mkfile_fqp = $dist->status->makefile
or die "Internal error: makefile() path is unset in our object";
open my $mkfile, '<', $mkfile_fqp
or die "Internal error: failed to open Makefile at $mkfile_fqp ... $!";
my @libs = _unique map { chomp; (/$field_srch/o) } <$mkfile>;
close $mkfile;
return [ grep { /\A-l/ } map { split } @libs ];
}
1; # End of CPANPLUS::Dist::Arch