1 package CPANPLUS::Dist::Gentoo;
7 use List::Util qw<reduce>;
13 use Parse::CPAN::Meta ();
15 use CPANPLUS::Error ();
17 use base qw<CPANPLUS::Dist::Base>;
19 use CPANPLUS::Dist::Gentoo::Atom;
20 use CPANPLUS::Dist::Gentoo::Guard;
21 use CPANPLUS::Dist::Gentoo::Maps;
25 CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
33 our $VERSION = '0.10';
37 # Using default values from your make.conf
38 cpan2dist --format=CPANPLUS::Dist::Gentoo --buildprereq Some::Module
40 # Specifying your own options
41 cpan2dist --format=CPANPLUS::Dist::Gentoo \
42 --dist-opts overlay=/usr/local/portage \
43 --dist-opts distdir=/usr/portage/distfiles \
44 --dist-opts manifest=yes \
45 --dist-opts keywords=x86 \
46 --dist-opts header="# Begin" \
47 --dist-opts footer="# End" \
52 This module is a CPANPLUS backend that recursively generates Gentoo ebuilds for a given package in the default overlay, updates the manifest, and even emerges it (together with its dependencies) if the user requires it.
54 The generated ebuilds are placed into the C<perl-gcpanp> category.
55 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>.
59 You can pass specific options to L<cpan2dist> by using the C<--dist-opts> command-line argument followed by a C<key=value> pair, where C<key> is the option name and C<value> is what it is set to.
60 C<--dist-opts> can be used several times.
62 The valid option C<key>s are :
70 A boolean that indicates whether the F<Manifest> file should be generated by running C<ebuild manifest> onto the generated ebuilds.
78 A string formatted as a space-delimited sequence of paths, that lists the different overlays in which existent ebuilds will be looked for.
80 Defaults to the value of C<PORTDIR_OVERLAY> as returned by C<emerge --info> (usually F</usr/local/portage>).
86 The directory where C<ebuild> expects to find the source tarballs.
87 You need write permissions on this directory.
89 Defaults to the value of C<DISTDIR> as returned by C<emerge --info> (usually F</usr/portage/distfiles>).
95 The valid C<KEYWORDS> for the generated ebuilds.
97 Defaults to the value of C<ACCEPT_KEYWORDS> as returned by C<emerge --info>.
103 A chunk of text that is prepended to every ebuild.
105 Defaults to the generic Gentoo Foundation header.
111 A chunk of text that is appended to every ebuild.
117 L<cpan2dist> itself takes other options, most notably :
123 C<--buildprereq> generates an ebuild for every dependency, even for those that are already up-to-date.
124 Setting this option is recommended.
128 C<--force> forcefully regenerates ebuilds even if they already exist.
132 C<--install> installs the ebuilds after generating them.
136 C<--skiptest> skips tests while building, which speeds up the building process.
140 C<--verbose> shows a lot more information.
144 Please refer to L<cpan2dist> documentation for a complete coverage of its abilities.
148 Before installing this module, you should append C<perl-gcpanp> to your F</etc/portage/categories> file.
150 You have two ways for installing this module :
156 Use the perl overlay located at L<http://git.overlays.gentoo.org/gitweb/?p=proj/perl-overlay.git>.
157 It contains an ebuild for L<CPANPLUS::Dist::Gentoo> which will most likely be up-to-date given the reactivity of Gentoo's Perl herd.
161 Bootstrap an ebuild for L<CPANPLUS::Dist::Gentoo> using itself.
163 First, make sure your system C<perl> is C<5.10> or greater, so that the L<CPANPLUS> toolchain is available.
166 This is perl 5, version 12, subversion 2 (v5.12.2)...
168 C<perl> C<5.12> is the current stable Perl version in Gentoo.
169 If you still have C<perl> C<5.8.x>, you can upgrade it by running the following commands as root :
171 # emerge -tv ">=dev-lang/perl-5.10"
174 Then, fetch the L<CPANPLUS::Dist::Gentoo> tarball :
177 $ wget http://search.cpan.org/CPAN/authors/id/V/VP/VPIT/CPANPLUS-Dist-Gentoo-0.10.tar.gz
179 Log in as root and unpack it in e.g. your home directory :
182 # tar xzf /tmp/CPANPLUS-Dist-Gentoo-0.10.tar.gz
183 # cd CPANPLUS-Dist-Gentoo-0.10
185 Bootstrap L<CPANPLUS::Dist::Gentoo> using the bundled shell script C<g-cpanp> :
189 # PERL5LIB=blib/lib samples/g-cpanp CPANPLUS::Dist::Gentoo
191 Finally, emerge the C<CPANPLUS-Dist-Gentoo> ebuild you've just generated :
193 # emerge -tv CPANPLUS-Dist-Gentoo
199 This module inherits all the methods from L<CPANPLUS::Dist::Base>.
200 Please refer to its documentation for precise information on what's done at each step.
204 use constant CATEGORY => 'perl-gcpanp';
207 my $default_keywords;
221 my $format_available;
223 sub format_available {
224 return $format_available if defined $format_available;
226 for my $prog (qw<emerge ebuild>) {
227 unless (IPC::Cmd::can_run($prog)) {
228 __PACKAGE__->_abort("$prog is required to write ebuilds");
229 return $format_available = 0;
233 if (IPC::Cmd->can_capture_buffer) {
235 my ($success, $errmsg) = IPC::Cmd::run(
236 command => [ qw<emerge --info> ],
241 if ($buffers =~ /^PORTDIR_OVERLAY=(.*)$/m) {
242 $overlays = [ map Cwd::abs_path($_), split ' ', $unquote->($1) ];
244 if ($buffers =~ /^ACCEPT_KEYWORDS=(.*)$/m) {
245 $default_keywords = [ split ' ', $unquote->($1) ];
247 if ($buffers =~ /^DISTDIR=(.*)$/m) {
248 $default_distdir = Cwd::abs_path($unquote->($1));
250 if ($buffers =~ /^PORTDIR=(.*)$/m) {
251 $main_portdir = Cwd::abs_path($unquote->($1));
254 __PACKAGE__->_abort($errmsg);
255 return $format_available = 0;
259 $default_keywords = [ 'x86' ] unless defined $default_keywords;
260 $default_distdir = '/usr/portage/distfiles' unless defined $default_distdir;
262 return $format_available = 1;
267 my $stat = $self->status;
268 my $conf = $self->parent->parent->configure_object;
270 $stat->mk_accessors(qw<
271 name version author distribution desc uri src license
274 requires configure_requires recursive_requires
275 ebuild_name ebuild_version ebuild_dir ebuild_file
276 portdir_overlay overlay distdir keywords do_manifest header footer
280 $stat->force($conf->get_conf('force'));
281 $stat->verbose($conf->get_conf('verbose'));
286 my $filter_prereqs = sub {
287 my ($int, $prereqs) = @_;
290 for my $prereq (sort keys %$prereqs) {
291 next if $prereq =~ /^perl(?:-|\z)/;
293 my $obj = $int->module_tree($prereq);
294 next unless $obj; # Not in the module tree (e.g. Config)
295 next if $obj->package_is_perl_core;
297 my $version = $prereqs->{$prereq} || undef;
299 push @requires, [ $obj->package_name, $version ];
307 my $mod = $self->parent;
308 my $stat = $self->status;
309 my $int = $mod->parent;
310 my $conf = $int->configure_object;
314 my $OK = sub { $stat->prepared(1); 1 };
315 my $FAIL = sub { $stat->prepared(0); $self->_abort(@_) if @_; 0 };
316 my $SKIP = sub { $stat->prepared(1); $stat->created(1); $self->_skip(@_) if @_; 1 };
318 my $keywords = delete $opts{keywords};
319 if (defined $keywords) {
320 $keywords = [ split ' ', $keywords ];
322 $keywords = $default_keywords;
324 $stat->keywords($keywords);
326 my $manifest = delete $opts{manifest};
327 $manifest = 1 unless defined $manifest;
328 $manifest = 0 if $manifest =~ /^\s*no?\s*$/i;
329 $stat->do_manifest($manifest);
331 my $header = delete $opts{header};
332 if (defined $header) {
333 1 while chomp $header;
336 my $year = (localtime)[5] + 1900;
337 $header = <<" DEF_HEADER";
338 # Copyright 1999-$year Gentoo Foundation
339 # Distributed under the terms of the GNU General Public License v2
343 $stat->header($header);
345 my $footer = delete $opts{footer};
346 if (defined $footer) {
347 $footer = "\n" . $footer;
351 $stat->footer($footer);
353 my $overlay = delete $opts{overlay};
354 $overlay = (defined $overlay) ? Cwd::abs_path($overlay) : '/usr/local/portage';
355 $stat->overlay($overlay);
357 my $distdir = delete $opts{distdir};
358 $distdir = (defined $distdir) ? Cwd::abs_path($distdir) : $default_distdir;
359 $stat->distdir($distdir);
361 return $FAIL->("distdir isn't writable") if $stat->do_manifest && !-w $distdir;
363 $stat->fetched_arch($mod->status->fetch);
365 my $cur = File::Spec->curdir();
368 if ($_ eq $overlay or File::Spec->abs2rel($overlay, $_) eq $cur) {
369 $portdir_overlay = [ @$overlays ];
373 $portdir_overlay = [ @$overlays, $overlay ] unless $portdir_overlay;
374 $stat->portdir_overlay($portdir_overlay);
376 my $name = $mod->package_name;
379 my $version = $mod->package_version;
380 $stat->version($version);
382 my $author = $mod->author->cpanid;
383 $stat->author($author);
385 $stat->distribution($name . '-' . $version);
387 $stat->ebuild_version(CPANPLUS::Dist::Gentoo::Maps::version_c2g($name, $version));
389 $stat->ebuild_name(CPANPLUS::Dist::Gentoo::Maps::name_c2g($name));
391 $stat->ebuild_dir(File::Spec->catdir(
397 my $file = File::Spec->catfile(
399 $stat->ebuild_name . '-' . $stat->ebuild_version . '.ebuild',
401 $stat->ebuild_file($file);
404 # Always generate an ebuild in our category when forcing
405 if ($forced{$file}) {
407 return $SKIP->('Ebuild already forced for', $stat->distribution);
413 return $SKIP->("Can't force rewriting of $file");
415 1 while unlink $file;
418 if (my $atom = $self->_cpan2portage($name, $version)) {
419 $stat->dist($atom->ebuild);
420 return $SKIP->('Ebuild already generated for', $stat->distribution);
426 $self->SUPER::prepare(@_);
428 return $FAIL->() unless $stat->prepared;
430 my $desc = $mod->description;
431 $desc = $mod->comment unless $desc;
432 $desc = "$name Perl distribution (provides " . $mod->module . ')'
434 $desc = substr($desc, 0, 77) . '...' if length $desc > 80;
437 $stat->uri('http://search.cpan.org/dist/' . $name);
439 $author =~ /^(.)(.)/ or return $FAIL->('Wrong author name');
440 $stat->src("mirror://cpan/modules/by-authors/id/$1/$1$2/$author/" . $mod->package);
442 $stat->license($self->intuit_license);
444 my $mstat = $mod->status;
445 $stat->configure_requires($int->$filter_prereqs($mstat->configure_requires));
446 $stat->requires($int->$filter_prereqs($mstat->requires));
447 $stat->recursive_requires([ ]);
449 $dependencies{$name} = [ map $_->[0], @{ $stat->requires } ];
451 my $meta = $self->meta;
452 $stat->min_perl(CPANPLUS::Dist::Gentoo::Maps::perl_version_c2g(
453 $meta->{requires}->{perl},
461 Returns the contents of the F<META.yml> or F<META.json> files as parsed by L<Parse::CPAN::Meta>.
467 my $mod = $self->parent;
468 my $stat = $self->status;
470 my $meta = $stat->meta;
471 return $meta if defined $meta;
473 my $extract_dir = $mod->status->extract;
475 for my $name (qw<META.json META.yml>) {
476 my $meta_file = File::Spec->catdir($extract_dir, $name);
477 next unless -e $meta_file;
480 my $meta = eval { Parse::CPAN::Meta::LoadFile($meta_file) };
490 =head2 C<intuit_license>
492 Returns an array reference to a list of Gentoo licences identifiers under which the current distribution is released.
496 my %dslip_license = (
507 my $mod = $self->parent;
509 my $dslip = $mod->dslip;
510 if (defined $dslip and $dslip =~ /\S{4}(\S)/) {
511 my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($dslip_license{$1});
512 return \@licenses if @licenses;
515 my $meta = $self->meta;
516 my $license = $meta->{license};
517 if (defined $license) {
518 my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($license);
519 return \@licenses if @licenses;
522 return [ CPANPLUS::Dist::Gentoo::Maps::license_c2g('perl') ];
527 my $stat = $self->status;
531 my $guard = CPANPLUS::Dist::Gentoo::Guard->new(sub {
532 if (defined $file and -e $file and -w _) {
533 1 while unlink $file;
537 my $SIG_INT = $SIG{INT};
538 local $SIG{INT} = sub {
541 eval { $SIG_INT->() };
550 $stat->dist($file) if defined $file;
557 $self->_abort(@_) if @_;
561 unless ($stat->prepared) {
563 'Can\'t create', $stat->distribution, 'since it was never prepared'
567 if ($stat->created) {
568 $self->_skip($stat->distribution, 'was already created');
569 $file = $stat->dist; # Keep the existing one.
573 my $dir = $stat->ebuild_dir;
575 eval { File::Path::mkpath($dir) };
576 return $FAIL->("mkpath($dir): $@") if $@;
579 $file = $stat->ebuild_file;
581 # Create a placeholder ebuild to prevent recursion with circular dependencies.
583 open my $eb, '>', $file or return $FAIL->("open($file): $!");
584 print $eb "PLACEHOLDER\n";
590 $self->SUPER::create(@_);
592 return $FAIL->() unless $stat->created;
595 open my $eb, '>', $file or return $FAIL->("open($file): $!");
596 my $source = $self->ebuild_source;
597 return $FAIL->() unless defined $source;
601 return $FAIL->() if $stat->do_manifest and not $self->update_manifest;
606 =head2 C<update_manifest>
608 Updates the F<Manifest> file for the ebuild associated to the current dist object.
612 sub update_manifest {
614 my $stat = $self->status;
616 my $file = $stat->ebuild_file;
617 unless (defined $file and -e $file) {
618 return $self->_abort('The ebuild file is invalid or does not exist');
621 unless (File::Copy::copy($stat->fetched_arch => $stat->distdir)) {
622 return $self->_abort("Couldn\'t copy the distribution file to distdir ($!)");
625 $self->_notify('Adding Manifest entry for', $stat->distribution);
627 return $self->_run([ 'ebuild', $file, 'manifest' ], 0);
630 =head2 C<ebuild_source>
632 Returns the source of the ebuild for the current dist object, or C<undef> when one of the dependencies couldn't be mapped to an existing ebuild.
636 my $dep_tree_contains;
640 $dep_tree_contains = sub {
641 my ($dist, $target) = @_;
643 return 0 if $seen{$dist};
644 local $seen{$dist} = 1;
646 for my $kid (@{ $dependencies{$dist} }) {
647 return 1 if $kid eq $target
648 or $dep_tree_contains->($kid, $target);
657 my $stat = $self->status;
660 my $name = $stat->name;
661 my %recursive_kids = map { $_ => 1 }
662 grep $dep_tree_contains->($_, $name),
663 @{ $dependencies{$name} };
664 if (%recursive_kids) {
665 my (@requires, @recursive_requires);
666 for (@{ $stat->requires }) {
667 if ($recursive_kids{$_->[0]}) {
668 push @recursive_requires, $_;
673 $stat->requires(\@requires);
674 $stat->recursive_requires(\@recursive_requires);
678 # We must resolve the deps now and not inside prepare because _cpan2portage
679 # has to see the ebuilds already generated for the dependencies of the current
682 my (@configure_requires, @requires, @recursive_requires);
685 [ configure_requires => \@configure_requires ],
686 [ requires => \@requires ],
687 [ recursive_requires => \@recursive_requires ],
690 push @requires, CPANPLUS::Dist::Gentoo::Atom->new(
691 category => 'dev-lang',
693 version => $stat->min_perl,
697 my ($phase, $list) = @$_;
699 for (@{ $stat->$phase }) {
700 my $atom = $self->_cpan2portage(@$_);
701 unless (defined $atom) {
703 "Couldn't find an appropriate ebuild for $_->[0] in the portage tree"
711 @$list = CPANPLUS::Dist::Gentoo::Atom->fold(@$list);
714 my $d = $stat->header;
715 $d .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
716 $d .= 'MODULE_AUTHOR="' . $stat->author . "\"\ninherit perl-module\n\n";
717 $d .= 'S="${WORKDIR}/' . $stat->distribution . "\"\n";
718 $d .= 'DESCRIPTION="' . $stat->desc . "\"\n";
719 $d .= 'HOMEPAGE="' . $stat->uri . "\"\n";
720 $d .= 'SRC_URI="' . $stat->src . "\"\n";
721 $d .= "SLOT=\"0\"\n";
722 $d .= 'LICENSE="|| ( ' . join(' ', sort @{$stat->license}) . " )\"\n";
723 $d .= 'KEYWORDS="' . join(' ', sort @{$stat->keywords}) . "\"\n";
724 $d .= 'RDEPEND="' . join("\n", sort @requires) . "\"\n" if @requires;
725 $d .= 'PDEPEND="' . join("\n", sort @recursive_requires) . "\"\n"
726 if @recursive_requires;
727 $d .= 'DEPEND="' . join("\n", '${RDEPEND}', sort @configure_requires) . "\"\n";
728 $d .= "SRC_TEST=\"do\"\n";
735 my ($self, $dist_name, $dist_version) = @_;
737 my $name = CPANPLUS::Dist::Gentoo::Maps::name_c2g($dist_name);
738 my $version = CPANPLUS::Dist::Gentoo::Maps::version_c2g($dist_name, $dist_version);
740 my @portdirs = ($main_portdir, @{$self->status->portdir_overlay});
742 for my $category (qw<virtual perl-core dev-perl perl-gcpan>, CATEGORY) {
743 my $name = ($category eq 'virtual' ? 'perl-' : '') . $name;
745 for my $portdir (@portdirs) {
746 my @ebuilds = glob File::Spec->catfile(
753 my $last = reduce { $a < $b ? $b : $a } # handles overloading
754 map CPANPLUS::Dist::Gentoo::Atom->new_from_ebuild($_),
756 next if defined $version and $last < $version;
758 return CPANPLUS::Dist::Gentoo::Atom->new(
759 category => $last->category,
762 ebuild => $last->ebuild,
773 my $stat = $self->status;
774 my $conf = $self->parent->parent->configure_object;
776 my $sudo = $conf->get_program('sudo');
777 my @cmd = ('emerge', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
778 unshift @cmd, $sudo if $sudo;
780 my $success = $self->_run(\@cmd, 1);
781 $stat->installed($success);
788 my $stat = $self->status;
789 my $conf = $self->parent->parent->configure_object;
791 my $sudo = $conf->get_program('sudo');
792 my @cmd = ('emerge', '-C', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
793 unshift @cmd, $sudo if $sudo;
795 my $success = $self->_run(\@cmd, 1);
796 $stat->uninstalled($success);
802 my ($self, $cmd, $verbose) = @_;
803 my $stat = $self->status;
805 my ($success, $errmsg, $output) = do {
806 local $ENV{PORTDIR_OVERLAY} = join ' ', @{$stat->portdir_overlay};
807 local $ENV{PORTAGE_RO_DISTDIRS} = $stat->distdir;
815 $self->_abort($errmsg);
816 if (not $verbose and defined $output and $stat->verbose) {
817 my $msg = join '', @$output;
819 CPANPLUS::Error::error($msg);
829 CPANPLUS::Error::error("@_ -- aborting");
837 CPANPLUS::Error::msg("@_");
842 sub _skip { shift->_notify(@_, '-- skipping') }
846 Gentoo (L<http://gentoo.org>).
848 L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5), L<Parse::CPAN::Meta> (since 5.10.1).
850 L<Cwd>, L<Carp> (since perl 5), L<File::Path> (5.001), L<File::Copy> (5.002), L<File::Spec> (5.00405), L<List::Util> (5.007003).
856 L<CPANPLUS::Dist::Base>, L<CPANPLUS::Dist::Deb>, L<CPANPLUS::Dist::Mdv>.
860 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
862 You can contact me by mail or on C<irc.perl.org> (vincent).
866 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>.
867 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
871 You can find documentation for this module with the perldoc command.
873 perldoc CPANPLUS::Dist::Gentoo
875 =head1 ACKNOWLEDGEMENTS
877 The module was inspired by L<CPANPLUS::Dist::Deb> and L<CPANPLUS::Dist::Mdv>.
879 Kent Fredric, for testing and suggesting improvements.
881 =head1 COPYRIGHT & LICENSE
883 Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
885 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
889 1; # End of CPANPLUS::Dist::Gentoo