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 base qw/CPANPLUS::Dist::Base/;
+use CPANPLUS::Dist::Gentoo::Maps;
+
=head1 NAME
CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
=head1 VERSION
-Version 0.02_01
+Version 0.07
=cut
-our $VERSION = '0.02_01';
+our $VERSION = '0.07';
=head1 SYNOPSIS
--dist-opts distdir=/usr/portage/distfiles \
--dist-opts manifest=yes \
--dist-opts keywords=x86 \
+ --dist-opts header="# Copyright 1999-2008 Gentoo Foundation" \
+ --dist-opts footer="# End" \
Any::Module You::Like
=head1 DESCRPITON
-This module is a CPANPLUS backend that recursively generates Gentoo ebuilds for a given package in the specified overlay (defaults to C</usr/local/portage>), update the manifest, and even emerge it (together with its dependencies) if the user requires it. You need write permissions on the directory where Gentoo fetches its source files (usually C</usr/portage/distfiles>).
+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 section C<perl-gcpanp>. They favour depending on C<perl-core> or C<dev-perl> 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 perldoc for precise information on what's done at each step.
+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.
=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;
+ 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 {
+ error $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 dist desc uri src license deps
- eb_name eb_version eb_dir eb_file distdir fetched_arch
- keywords do_manifest
- verbose/);
+ $stat->mk_accessors(qw/name version author distribution desc uri src license
+ deps eb_name eb_version eb_dir eb_file fetched_arch
+ portdir_overlay
+ overlay distdir keywords do_manifest header footer
+ force verbose/);
+ $stat->force($conf->get_conf('force'));
$stat->verbose($conf->get_conf('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 = @_;
+ $stat->prepared(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'};
$manifest = 0 if $manifest =~ /^\s*no?\s*$/i;
$stat->do_manifest($manifest);
- my $overlay = catdir(delete($opts{'overlay'}) || '/usr/local/portage',
- CATEGORY);
+ my $header = delete $opts{'header'};
+ if (defined $header) {
+ 1 while chomp $header;
+ $header .= "\n\n";
+ } else {
+ $header = '';
+ }
+ $stat->header($header);
+
+ my $footer = delete $opts{'footer'};
+ if (defined $footer) {
+ $footer = "\n" . $footer;
+ } else {
+ $footer = '';
+ }
+ $stat->footer($footer);
+
+ my $overlay = delete $opts{'overlay'};
+ $overlay = (defined $overlay) ? abs_path $overlay : '/usr/local/portage';
+ $stat->overlay($overlay);
+
+ my $distdir = delete $opts{'distdir'};
+ $distdir = (defined $distdir) ? abs_path $distdir : $default_distdir;
+ $stat->distdir($distdir);
- $stat->distdir(delete($opts{'distdir'}) || '/usr/portage/distfiles');
if ($stat->do_manifest && !-w $stat->distdir) {
error 'distdir isn\'t writable -- aborting';
return 0;
}
$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 $version = $mod->package_version;
$stat->version($version);
- $stat->dist($name . '-' . $version);
- my $f = 1;
- $version =~ s/_+/$f ? do { $f = 0; '_p' } : ''/ge;
- 1 while $version =~ s/(_p[^.]*)\.+/$1/;
- $stat->eb_version($version);
-
- $stat->eb_name($gentooism{$stat->name} || $stat->name);
- $stat->eb_dir(catdir($overlay, $stat->eb_name));
- $stat->eb_file(catfile($stat->eb_dir,
- $stat->eb_name . '-' . $stat->eb_version . '.ebuild'));
- if (-r $stat->eb_file) {
- msg 'Ebuild already generated for ' . $stat->dist . ' -- skipping';
- $stat->prepared(1);
- $stat->created(1);
- return 1;
+
+ my $author = $mod->author->cpanid;
+ $stat->author($author);
+
+ $stat->distribution($name . '-' . $version);
+
+ $stat->eb_version(CPANPLUS::Dist::Gentoo::Maps::version_c2g($version));
+
+ $stat->eb_name(CPANPLUS::Dist::Gentoo::Maps::name_c2g($name));
+
+ $stat->eb_dir(File::Spec->catdir(
+ $stat->overlay,
+ CATEGORY,
+ $stat->eb_name,
+ ));
+
+ my $file = File::Spec->catfile(
+ $stat->eb_dir,
+ $stat->eb_name . '-' . $stat->eb_version . '.ebuild',
+ );
+ $stat->eb_file($file);
+
+ if (-e $file) {
+ my $skip = 1;
+ 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";
+ }
+ } else {
+ msg 'Ebuild already generated for ' . $stat->distribution . ' -- skipping';
+ }
+ if ($skip) {
+ $stat->prepared(1);
+ $stat->created(1);
+ $stat->dist($file);
+ return 1;
+ }
}
$self->SUPER::prepare(%opts);
+ $stat->prepared(0);
+
my $desc = $mod->description;
($desc = $name) =~ s/-+/::/g unless $desc;
$stat->desc($desc);
+
$stat->uri('http://search.cpan.org/dist/' . $name);
- unless ($name =~ /^([^-]+)/) {
- error 'Wrong distribution name -- aborting';
+
+ unless ($author =~ /^(.)(.)/) {
+ error 'Wrong author name -- aborting';
return 0;
}
- $stat->src('mirror://cpan/modules/by-module/' . $1 . '/' . $mod->package);
+ $stat->src("mirror://cpan/modules/by-authors/id/$1/$1$2/$author/"
+ . $mod->package);
+
$stat->license([ qw/Artistic GPL-2/ ]);
my $prereqs = $mod->status->prereqs;
- $prereqs = { map { ($gentooism{$_} || $_) => $prereqs->{$_} } keys %$prereqs };
my @depends;
for my $prereq (sort keys %$prereqs) {
next if $prereq =~ /^perl(?:-|\z)/;
$version = $obj->package_version;
}
}
- push @depends, [ $obj , $version ];
+ push @depends, [ $obj->package_name, $version ];
}
}
$stat->deps(\@depends);
+ $stat->prepared(1);
return 1;
}
my $stat = $self->status;
unless ($stat->prepared) {
- error 'Can\'t create ' . $stat->dist . ' since it was never prepared -- aborting';
+ error 'Can\'t create ' . $stat->distribution . ' since it was never prepared -- aborting';
+ $stat->created(0);
+ $stat->dist(undef);
return 0;
}
if ($stat->created) {
- msg $stat->dist . ' was already created -- skipping';
+ msg $stat->distribution . ' was already created -- skipping';
+ $stat->dist($stat->eb_file);
return 1;
}
- $self->SUPER::create(@_);
-
my $dir = $stat->eb_dir;
unless (-d $dir) {
- eval { mkpath $dir };
+ eval { File::Path::mkpath($dir) };
if ($@) {
error "mkpath($dir): $@";
return 0;
}
}
- my $d = "# Generated by CPANPLUS::Dist::Gentoo\n\ninherit perl-module\n\n";
- $d .= 'S="${WORKDIR}/' . $stat->dist . "\"\n";
+ my %seen;
+
+ my $d = $stat->header;
+ $d .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
+ $d .= 'MODULE_AUTHOR="' . $stat->author . "\"\ninherit perl-module\n\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",
+ sort grep !$seen{$_}++, 'dev-lang/perl',
+ map $self->_cpan2portage(@$_), @{$stat->deps}
+ ) . "\"\n";
+ $d .= "SRC_TEST=\"do\"\n";
+ $d .= $stat->footer;
my $file = $stat->eb_file;
open my $eb, '>', $file or do {
print $eb $d;
close $eb;
+ $stat->created(0);
+ $stat->dist(undef);
+
+ $self->SUPER::create(@_);
+
+ $stat->created(0);
+ $stat->dist(undef);
+
if ($stat->do_manifest) {
- unless (copy $stat->fetched_arch, $stat->distdir) {
+ unless (File::Copy::copy($stat->fetched_arch => $stat->distdir)) {
error "Couldn\'t copy the distribution file to distdir ($!) -- aborting";
1 while unlink $file;
return 0;
}
- msg 'Adding Manifest entry for ' . $stat->dist;
- my ($success, $errmsg, $output) = run
- command => [ 'ebuild', $file, 'manifest' ],
- verbose => 0;
- unless ($success) {
- error "$errmsg -- aborting";
- if (defined $output and $stat->verbose) {
- my $msg = join '', @$output;
- 1 while chomp $msg;
- error $msg;
- }
+ msg 'Adding Manifest entry for ' . $stat->distribution;
+ unless ($self->_run([ 'ebuild', $file, 'manifest' ], 0)) {
1 while unlink $file;
return 0;
}
}
+ $stat->created(1);
+ $stat->dist($file);
return 1;
}
+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";
+ }
+
+ }
+
+ }
+
+ error "Couldn't find an appropriate ebuild for $name in the portage tree -- skipping";
+ return '';
+}
+
sub install {
my $self = shift;
my $stat = $self->status;
my @cmd = ('emerge', '=' . $stat->eb_name . '-' . $stat->eb_version);
unshift @cmd, $sudo if $sudo;
- my ($success, $errmsg) = run command => \@cmd,
- verbose => 1;
- unless ($success) {
- error "$errmsg -- aborting";
- return 0;
- }
+ my $success = $self->_run(\@cmd, 1);
+ $stat->installed($success);
- return 1;
+ return $success;
}
sub uninstall {
my @cmd = ('emerge', '-C', '=' . $stat->eb_name . '-' . $stat->eb_version);
unshift @cmd, $sudo if $sudo;
- my ($success, $errmsg) = run command => \@cmd,
- verbose => 1;
+ my $success = $self->_run(\@cmd, 1);
+ $stat->uninstalled($success);
+
+ return $success;
+}
+
+sub _run {
+ my ($self, $cmd, $verbose) = @_;
+ my $stat = $self->status;
+
+ my ($success, $errmsg, $output) = do {
+ 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";
- return 0;
+ if (not $verbose and defined $output and $stat->verbose) {
+ my $msg = join '', @$output;
+ 1 while chomp $msg;
+ error $msg;
+ }
}
- return 1;
+ return $success;
}
=head1 DEPENDENCIES
L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5).
-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
The module is to some extend cargo-culted from 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.