use strict;
use warnings;
-use File::Copy qw/copy/;
-use File::Path qw/mkpath/;
-use File::Spec::Functions qw/catdir catfile/;
+use Cwd qw/abs_path/;
+use File::Copy ();
+use File::Path ();
+use File::Spec;
use IPC::Cmd qw/run can_run/;
+use Parse::CPAN::Meta ();
-use CPANPLUS::Error;
+use CPANPLUS::Error ();
use base qw/CPANPLUS::Dist::Base/;
+use CPANPLUS::Dist::Gentoo::Maps;
+
=head1 NAME
CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
=head1 VERSION
-Version 0.03
+Version 0.07
=cut
-our $VERSION = '0.03';
+our $VERSION = '0.07';
=head1 SYNOPSIS
=head1 DESCRPITON
-This module is a CPANPLUS backend that recursively generates Gentoo ebuilds for a given package in the specified overlay (defaults to F</usr/local/portage>), updates the manifest, and even emerges it (together with its dependencies) if the user requires it. You need write permissions on the directory where Gentoo fetches its source files (usually F</usr/portage/distfiles>). You also need to specify the correct keyword for your architecture if it differs from the default C<x86>.
+This module is a CPANPLUS backend that recursively generates Gentoo ebuilds for a given package in the specified overlay (defaults to F</usr/local/portage>), updates the manifest, and even emerges it (together with its dependencies) if the user requires it.
+You need write permissions on the directory where Gentoo fetches its source files (usually F</usr/portage/distfiles>).
+The valid C<KEYWORDS> for the generated ebuilds are by default those given in C<ACCEPT_KEYWORDS>, but you can specify your own with the C<keywords> dist-option.
-The generated ebuilds are placed into the C<perl-gcpanp> category. They favour depending on C<perl-core>, C<dev-perl> or C<perl-gcpan> (in that order) rather than C<perl-gcpanp>.
+The generated ebuilds are placed into the C<perl-gcpanp> category.
+They favour depending on a C<virtual>, on C<perl-core>, C<dev-perl> or C<perl-gcpan> (in that order) rather than C<perl-gcpanp>.
=head1 INSTALLATION
=head1 METHODS
-All the methods are inherited from L<CPANPLUS::Dist::Base>. Please refer to its documentation for precise information on what's done at each step.
+This module inherits all the methods from L<CPANPLUS::Dist::Base>.
+Please refer to its documentation for precise information on what's done at each step.
=cut
use constant CATEGORY => 'perl-gcpanp';
+my $overlays;
+my $default_keywords;
+my $default_distdir;
+my $main_portdir;
+
+my %forced;
+
+my $unquote = sub {
+ my $s = shift;
+ $s =~ s/^["']*//;
+ $s =~ s/["']*$//;
+ return $s;
+};
+
+my $format_available;
+
sub format_available {
+ return $format_available if defined $format_available;
+
for my $prog (qw/emerge ebuild/) {
unless (can_run($prog)) {
- error "$prog is required to write ebuilds -- aborting";
- return 0;
+ __PACKAGE__->_abort("$prog is required to write ebuilds");
+ return $format_available = 0;
}
}
- return 1;
+
+ if (IPC::Cmd->can_capture_buffer) {
+ my $buffers;
+ my ($success, $errmsg) = run command => [ qw/emerge --info/ ],
+ verbose => 0,
+ buffer => \$buffers;
+ if ($success) {
+ if ($buffers =~ /^PORTDIR_OVERLAY=(.*)$/m) {
+ $overlays = [ map abs_path($_), split ' ', $unquote->($1) ];
+ }
+ if ($buffers =~ /^ACCEPT_KEYWORDS=(.*)$/m) {
+ $default_keywords = [ split ' ', $unquote->($1) ];
+ }
+ if ($buffers =~ /^DISTDIR=(.*)$/m) {
+ $default_distdir = abs_path($unquote->($1));
+ }
+ if ($buffers =~ /^PORTDIR=(.*)$/m) {
+ $main_portdir = abs_path($unquote->($1));
+ }
+ } else {
+ __PACKAGE__->_abort($errmsg);
+ }
+ }
+
+ $default_keywords = [ 'x86' ] unless defined $default_keywords;
+ $default_distdir = '/usr/portage/distfiles' unless defined $default_distdir;
+
+ return $format_available = 1;
}
sub init {
my $stat = $self->status;
my $conf = $self->parent->parent->configure_object;
- $stat->mk_accessors(qw/name version author dist desc uri src license deps
- eb_name eb_version eb_dir eb_file fetched_arch
+ $stat->mk_accessors(qw/name version author distribution desc uri src license
+ fetched_arch deps
+ ebuild_name ebuild_version ebuild_dir ebuild_file
+ portdir_overlay
overlay distdir keywords do_manifest header footer
force verbose/);
return 1;
}
-my %gentooism = (
- 'Digest' => 'digest-base',
- 'Locale-Maketext' => 'locale-maketext',
- 'Net-Ping' => 'net-ping',
- 'PathTools' => 'File-Spec',
- 'PodParser' => 'Pod-Parser',
- 'Set-Scalar' => 'set-scalar',
- 'Tie-EncryptedHash' => 'tie-encryptedhash',
-);
-
sub prepare {
my $self = shift;
my $mod = $self->parent;
my %opts = @_;
+ my $OK = sub { $stat->prepared(1); 1 };
+ my $FAIL = sub { $stat->prepared(0); $self->_abort(@_) if @_; 0 };
+
my $keywords = delete $opts{'keywords'};
- $keywords = 'x86' unless defined $keywords;
- $keywords = [ split ' ', $keywords ];
+ if (defined $keywords) {
+ $keywords = [ split ' ', $keywords ];
+ } else {
+ $keywords = $default_keywords;
+ }
$stat->keywords($keywords);
my $manifest = delete $opts{'manifest'};
}
$stat->footer($footer);
- $stat->overlay(delete($opts{'overlay'}) || '/usr/local/portage');
+ my $overlay = delete $opts{'overlay'};
+ $overlay = (defined $overlay) ? abs_path $overlay : '/usr/local/portage';
+ $stat->overlay($overlay);
- $stat->distdir(delete($opts{'distdir'}) || '/usr/portage/distfiles');
+ my $distdir = delete $opts{'distdir'};
+ $distdir = (defined $distdir) ? abs_path $distdir : $default_distdir;
+ $stat->distdir($distdir);
if ($stat->do_manifest && !-w $stat->distdir) {
- error 'distdir isn\'t writable -- aborting';
- return 0;
+ return $FAIL->('distdir isn\'t writable');
}
$stat->fetched_arch($mod->status->fetch);
+ my $cur = File::Spec->curdir();
+ my $portdir_overlay;
+ for (@$overlays) {
+ if ($_ eq $overlay or File::Spec->abs2rel($overlay, $_) eq $cur) {
+ $portdir_overlay = [ @$overlays ];
+ last;
+ }
+ }
+ $portdir_overlay = [ @$overlays, $overlay ] unless $portdir_overlay;
+ $stat->portdir_overlay($portdir_overlay);
+
my $name = $mod->package_name;
$stat->name($name);
my $author = $mod->author->cpanid;
$stat->author($author);
- $stat->dist($name . '-' . $version);
+ $stat->distribution($name . '-' . $version);
- $version =~ s/[^\d._]+//g;
- $version =~ s/^[._]*//;
- $version =~ s/[._]*$//;
- $version =~ s/[._]*_[._]*/_/g;
- {
- ($version, my $patch, my @rest) = split /_/, $version;
- $version .= '_p' . $patch if defined $patch;
- $version .= join('.', '', @rest) if @rest;
- }
- $stat->eb_version($version);
+ $stat->ebuild_version(CPANPLUS::Dist::Gentoo::Maps::version_c2g($version));
- $stat->eb_name($gentooism{$name} || $name);
+ $stat->ebuild_name(CPANPLUS::Dist::Gentoo::Maps::name_c2g($name));
- $stat->eb_dir(catdir($stat->overlay, CATEGORY, $stat->eb_name));
+ $stat->ebuild_dir(File::Spec->catdir(
+ $stat->overlay,
+ CATEGORY,
+ $stat->ebuild_name,
+ ));
+
+ my $file = File::Spec->catfile(
+ $stat->ebuild_dir,
+ $stat->ebuild_name . '-' . $stat->ebuild_version . '.ebuild',
+ );
+ $stat->ebuild_file($file);
- my $file = catfile($stat->eb_dir,
- $stat->eb_name . '-' . $stat->eb_version . '.ebuild');
if (-e $file) {
my $skip = 1;
- if ($stat->force) {
+ if ($stat->force and not $forced{$file}) {
if (-w $file) {
1 while unlink $file;
+ $forced{$file} = 1;
$skip = 0;
} else {
- error "Can't force rewriting of $file -- skipping";
+ $self->_skip("Can't force rewriting of $file");
}
} else {
- msg 'Ebuild already generated for ' . $stat->dist . ' -- skipping';
+ $self->_skip('Ebuild already generated for', $stat->distribution);
}
if ($skip) {
$stat->prepared(1);
$stat->created(1);
+ $stat->dist($file);
return 1;
}
}
- $stat->eb_file($file);
+
+ $stat->prepared(0);
$self->SUPER::prepare(%opts);
+ return $FAIL->() unless $stat->prepared;
+
my $desc = $mod->description;
($desc = $name) =~ s/-+/::/g unless $desc;
$stat->desc($desc);
$stat->uri('http://search.cpan.org/dist/' . $name);
unless ($author =~ /^(.)(.)/) {
- error 'Wrong author name -- aborting';
- return 0;
+ return $FAIL->('Wrong author name');
}
$stat->src("mirror://cpan/modules/by-authors/id/$1/$1$2/$author/"
. $mod->package);
- $stat->license([ qw/Artistic GPL-2/ ]);
+ $stat->license($self->intuit_license);
my $prereqs = $mod->status->prereqs;
- $prereqs = { map { ($gentooism{$_} || $_) => $prereqs->{$_} } keys %$prereqs };
my @depends;
for my $prereq (sort keys %$prereqs) {
next if $prereq =~ /^perl(?:-|\z)/;
my $obj = $int->module_tree($prereq);
- unless ($obj) {
- error 'Wrong module object -- aborting';
- return 0;
- }
+ return $FAIL->('Wrong module object') unless $obj;
next if $obj->package_is_perl_core;
{
my $version;
$version = $obj->package_version;
}
}
- push @depends, [ $obj , $version ];
+ push @depends, [ $obj->package_name, $version ];
}
}
$stat->deps(\@depends);
- return 1;
+ return $OK->();
+}
+
+=head2 C<intuit_license>
+
+Returns an array reference to a list of Gentoo licences identifiers under which the current distribution is released.
+
+=cut
+
+my %dslip_license = (
+ p => 'perl',
+ g => 'gpl',
+ l => 'lgpl',
+ b => 'bsd',
+ a => 'artistic',
+ 2 => 'artistic_2',
+);
+
+sub intuit_license {
+ my $self = shift;
+ my $mod = $self->parent;
+
+ my $dslip = $mod->dslip;
+ if (defined $dslip and $dslip =~ /\S{4}(\S)/) {
+ my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($dslip_license{$1});
+ return \@licenses if @licenses;
+ }
+ my $extract_dir = $mod->status->extract;
+
+ for my $meta_file (qw/META.json META.yml/) {
+ my $meta = eval {
+ Parse::CPAN::Meta::LoadFile(File::Spec->catdir(
+ $extract_dir,
+ $meta_file,
+ ));
+ } or next;
+ my $license = $meta->{license};
+ if (defined $license) {
+ my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($license);
+ return \@licenses if @licenses;
+ }
+ }
+
+ return [ CPANPLUS::Dist::Gentoo::Maps::license_c2g('perl') ];
}
sub create {
my $self = shift;
my $stat = $self->status;
+ my $OK = sub { $stat->created(1); $stat->dist($stat->ebuild_file); 1 };
+ my $FAIL = sub { $stat->created(0); $stat->dist(undef); $self->_abort(@_) if @_; 0 };
+
unless ($stat->prepared) {
- error 'Can\'t create ' . $stat->dist . ' since it was never prepared -- aborting';
- return 0;
+ return $FAIL->(
+ 'Can\'t create', $stat->distribution, 'since it was never prepared'
+ );
}
if ($stat->created) {
- msg $stat->dist . ' was already created -- skipping';
- return 1;
+ $self->_skip($stat->distribution, 'was already created');
+ return $OK->();
}
+ my $dir = $stat->ebuild_dir;
+ unless (-d $dir) {
+ eval { File::Path::mkpath($dir) };
+ return $FAIL->("mkpath($dir): $@") if $@;
+ }
+
+ my $file = $stat->ebuild_file;
+ open my $eb, '>', $file or return $FAIL->("open($file): $!");
+ print $eb $self->ebuild_source;
+ close $eb;
+
+ $stat->created(0);
+ $stat->dist(undef);
+
$self->SUPER::create(@_);
- my $dir = $stat->eb_dir;
- unless (-d $dir) {
- eval { mkpath $dir };
- if ($@) {
- error "mkpath($dir): $@";
- return 0;
- }
+ unless ($stat->created) {
+ 1 while unlink $file;
+ return $FAIL->();
}
+ if ($stat->do_manifest and not $self->update_manifest) {
+ 1 while unlink $file;
+ return $FAIL->();
+ }
+
+ return $OK->();
+}
+
+=head2 C<update_manifest>
+
+Updates the F<Manifest> file for the ebuild associated to the current dist object.
+
+=cut
+
+sub update_manifest {
+ my $self = shift;
+ my $stat = $self->status;
+
+ my $file = $stat->ebuild_file;
+ unless ($file and -e $file) {
+ return $self->_abort('The ebuild file is invalid or does not exist');
+ }
+
+ unless (File::Copy::copy($stat->fetched_arch => $stat->distdir)) {
+ return $self->_abort("Couldn\'t copy the distribution file to distdir ($!)");
+ }
+
+ $self->_notify('Adding Manifest entry for', $stat->distribution);
+
+ return $self->_run([ 'ebuild', $stat->ebuild_file, 'manifest' ], 0);
+}
+
+=head2 C<ebuild_source>
+
+Returns the source of the ebuild for the current dist object.
+
+=cut
+
+sub ebuild_source {
+ my $self = shift;
+ my $stat = $self->status;
+
+ # We must resolve the deps now and not inside prepare because _cpan2portage
+ # has to see the ebuilds already generated for the dependencies of the current
+ # dist.
+ my @deps = do {
+ my %seen;
+ sort grep !$seen{$_}++, 'dev-lang/perl',
+ map $self->_cpan2portage(@$_), @{$stat->deps}
+ };
+
my $d = $stat->header;
- $d .= "# Generated by CPANPLUS::Dist::Gentoo\n\n";
+ $d .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
$d .= 'MODULE_AUTHOR="' . $stat->author . "\"\ninherit perl-module\n\n";
- $d .= 'S="${WORKDIR}/' . $stat->dist . "\"\n";
+ $d .= 'S="${WORKDIR}/' . $stat->distribution . "\"\n";
$d .= 'DESCRIPTION="' . $stat->desc . "\"\n";
$d .= 'HOMEPAGE="' . $stat->uri . "\"\n";
$d .= 'SRC_URI="' . $stat->src . "\"\n";
$d .= "SLOT=\"0\"\n";
$d .= 'LICENSE="|| ( ' . join(' ', sort @{$stat->license}) . " )\"\n";
$d .= 'KEYWORDS="' . join(' ', sort @{$stat->keywords}) . "\"\n";
- $d .= 'DEPEND="' . join "\n",
- 'dev-lang/perl',
- map {
- my $a = $_->[0]->package_name;
- my $x = '';
- if (defined $_->[1]) {
- $x = '>=';
- $a .= '-' . $_->[1];
- }
- '|| ( ' . join(' ', map "$x$_/$a",
- qw/perl-core dev-perl perl-gcpan/, CATEGORY)
- . ' )';
- } @{$stat->deps};
- $d .= "\"\n";
+ $d .= 'DEPEND="' . join("\n", @deps) . "\"\n";
$d .= "SRC_TEST=\"do\"\n";
$d .= $stat->footer;
- my $file = $stat->eb_file;
- open my $eb, '>', $file or do {
- error "open($file): $! -- aborting";
- return 0;
- };
- print $eb $d;
- close $eb;
+ return $d;
+}
- if ($stat->do_manifest) {
- unless (copy $stat->fetched_arch, $stat->distdir) {
- error "Couldn\'t copy the distribution file to distdir ($!) -- aborting";
- 1 while unlink $file;
- return 0;
- }
+sub _cpan2portage {
+ my ($self, $name, $version) = @_;
+
+ $name = CPANPLUS::Dist::Gentoo::Maps::name_c2g($name);
+ my $ver;
+ $ver = CPANPLUS::Dist::Gentoo::Maps::version_c2g($version) if defined $version;
+
+ my @portdirs = ($main_portdir, @{$self->status->portdir_overlay});
+
+ for my $category (qw/virtual perl-core dev-perl perl-gcpan/, CATEGORY) {
+ my $atom = ($category eq 'virtual' ? 'perl-' : '') . $name;
+
+ for my $portdir (@portdirs) {
+ my @ebuilds = glob File::Spec->catfile(
+ $portdir,
+ $category,
+ $atom,
+ "$atom-*.ebuild",
+ ) or next;
+
+ if (defined $ver) { # implies that $version is defined
+ for (@ebuilds) {
+ my ($eb_ver) = /\Q$atom\E-v?([\d._pr-]+).*?\.ebuild$/;
+ return ">=$category/$atom-$ver"
+ if defined $eb_ver
+ and CPANPLUS::Dist::Gentoo::Maps::version_gcmp($eb_ver, $ver) > 0;
+ }
+ } else {
+ return "$category/$atom";
+ }
- msg 'Adding Manifest entry for ' . $stat->dist;
- unless ($self->_run([ 'ebuild', $file, 'manifest' ], 0)) {
- 1 while unlink $file;
- return 0;
}
+
}
- return 1;
+ $self->_skip(
+ "Couldn't find an appropriate ebuild for $name in the portage tree"
+ );
+
+ return '';
}
sub install {
my $conf = $self->parent->parent->configure_object;
my $sudo = $conf->get_program('sudo');
- my @cmd = ('emerge', '=' . $stat->eb_name . '-' . $stat->eb_version);
+ my @cmd = ('emerge', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
unshift @cmd, $sudo if $sudo;
- return $self->_run(\@cmd, 1);
+ my $success = $self->_run(\@cmd, 1);
+ $stat->installed($success);
+
+ return $success;
}
sub uninstall {
my $conf = $self->parent->parent->configure_object;
my $sudo = $conf->get_program('sudo');
- my @cmd = ('emerge', '-C', '=' . $stat->eb_name . '-' . $stat->eb_version);
+ my @cmd = ('emerge', '-C', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
unshift @cmd, $sudo if $sudo;
- return $self->_run(\@cmd, 1);
+ my $success = $self->_run(\@cmd, 1);
+ $stat->uninstalled($success);
+
+ return $success;
}
sub _run {
my $stat = $self->status;
my ($success, $errmsg, $output) = do {
- local $ENV{PORTDIR_OVERLAY} = $stat->overlay;
+ local $ENV{PORTDIR_OVERLAY} = join ' ', @{$stat->portdir_overlay};
local $ENV{PORTAGE_RO_DISTDIRS} = $stat->distdir;
run command => $cmd, verbose => $verbose;
};
unless ($success) {
- error "$errmsg -- aborting";
- if (not $verbose and defined $output and $self->status->verbose) {
+ $self->_abort($errmsg);
+ if (not $verbose and defined $output and $stat->verbose) {
my $msg = join '', @$output;
1 while chomp $msg;
- error $msg;
+ CPANPLUS::Error::error($msg);
}
}
return $success;
}
+sub _abort {
+ my $self = shift;
+
+ CPANPLUS::Error::error("@_ -- aborting");
+
+ return 0;
+}
+
+sub _notify {
+ my $self = shift;
+
+ CPANPLUS::Error::msg("@_");
+
+ return 1;
+}
+
+sub _skip { shift->_notify(@_, '-- skipping') }
+
=head1 DEPENDENCIES
Gentoo (L<http://gentoo.org>).
-L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5).
+L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5), L<Parse::CPAN::Meta> (since 5.10.1).
-L<File::Path> (since 5.001), L<File::Copy> (5.002), L<File::Spec::Functions> (5.00504).
+L<Cwd>, L<Carp> (since perl 5), L<File::Path> (5.001), L<File::Copy> (5.002), L<File::Spec> (5.00405).
=head1 SEE ALSO
=head1 BUGS
-Please report any bugs or feature requests to C<bug-cpanplus-dist-gentoo at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CPANPLUS-Dist-Gentoo>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+Please report any bugs or feature requests to C<bug-cpanplus-dist-gentoo at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CPANPLUS-Dist-Gentoo>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
=head1 ACKNOWLEDGEMENTS
-The module is to some extend cargo-culted from L<CPANPLUS::Dist::Deb> and L<CPANPLUS::Dist::Mdv>.
+The module was inspired by L<CPANPLUS::Dist::Deb> and L<CPANPLUS::Dist::Mdv>.
+
+Kent Fredric, for testing and suggesting improvements.
=head1 COPYRIGHT & LICENSE
-Copyright 2008 Vincent Pit, all rights reserved.
+Copyright 2008-2009 Vincent Pit, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.