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 F<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 specified overlay (defaults to F</usr/local/portage>), 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.
127 C<--force> forcefully regenerates ebuilds even if they already exist.
131 C<--skiptest> skips tests while building, which speeds up the building process.
135 C<--verbose> shows a lot more information.
139 Please refer to L<cpan2dist> documentation for a complete coverage of its abilities.
143 Before installing this module, you should append C<perl-gcpanp> to your F</etc/portage/categories> file.
145 You have two ways for installing this module :
151 Use the perl overlay located at L<http://git.overlays.gentoo.org/gitweb/?p=proj/perl-overlay.git>.
152 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.
156 Bootstrap an ebuild for L<CPANPLUS::Dist::Gentoo> using itself.
158 First, make sure your system C<perl> is C<5.10> or greater, so that the L<CPANPLUS> toolchain is available.
161 This is perl 5, version 12, subversion 2 (v5.12.2)...
163 C<perl> C<5.12> is the current stable Perl version in Gentoo.
164 If you still have C<perl> C<5.8.x>, you can upgrade it by running the following commands as root :
166 # emerge -tv ">=dev-lang/perl-5.10"
169 Then, fetch the L<CPANPLUS::Dist::Gentoo> tarball :
172 $ wget http://search.cpan.org/CPAN/authors/id/V/VP/VPIT/CPANPLUS-Dist-Gentoo-0.10.tar.gz
174 Log in as root and unpack it in e.g. your home directory :
177 # tar xzf /tmp/CPANPLUS-Dist-Gentoo-0.10.tar.gz
178 # cd CPANPLUS-Dist-Gentoo-0.10
180 Bootstrap L<CPANPLUS::Dist::Gentoo> using the bundled shell script C<g-cpanp> :
184 # PERL5LIB=blib/lib samples/g-cpanp CPANPLUS::Dist::Gentoo
186 Finally, emerge the C<CPANPLUS-Dist-Gentoo> ebuild you've just generated :
188 # emerge -tv CPANPLUS-Dist-Gentoo
194 This module inherits all the methods from L<CPANPLUS::Dist::Base>.
195 Please refer to its documentation for precise information on what's done at each step.
199 use constant CATEGORY => 'perl-gcpanp';
202 my $default_keywords;
216 my $format_available;
218 sub format_available {
219 return $format_available if defined $format_available;
221 for my $prog (qw<emerge ebuild>) {
222 unless (IPC::Cmd::can_run($prog)) {
223 __PACKAGE__->_abort("$prog is required to write ebuilds");
224 return $format_available = 0;
228 if (IPC::Cmd->can_capture_buffer) {
230 my ($success, $errmsg) = IPC::Cmd::run(
231 command => [ qw<emerge --info> ],
236 if ($buffers =~ /^PORTDIR_OVERLAY=(.*)$/m) {
237 $overlays = [ map Cwd::abs_path($_), split ' ', $unquote->($1) ];
239 if ($buffers =~ /^ACCEPT_KEYWORDS=(.*)$/m) {
240 $default_keywords = [ split ' ', $unquote->($1) ];
242 if ($buffers =~ /^DISTDIR=(.*)$/m) {
243 $default_distdir = Cwd::abs_path($unquote->($1));
245 if ($buffers =~ /^PORTDIR=(.*)$/m) {
246 $main_portdir = Cwd::abs_path($unquote->($1));
249 __PACKAGE__->_abort($errmsg);
250 return $format_available = 0;
254 $default_keywords = [ 'x86' ] unless defined $default_keywords;
255 $default_distdir = '/usr/portage/distfiles' unless defined $default_distdir;
257 return $format_available = 1;
262 my $stat = $self->status;
263 my $conf = $self->parent->parent->configure_object;
265 $stat->mk_accessors(qw<
266 name version author distribution desc uri src license
269 requires configure_requires recursive_requires
270 ebuild_name ebuild_version ebuild_dir ebuild_file
271 portdir_overlay overlay distdir keywords do_manifest header footer
275 $stat->force($conf->get_conf('force'));
276 $stat->verbose($conf->get_conf('verbose'));
281 my $filter_prereqs = sub {
282 my ($int, $prereqs) = @_;
285 for my $prereq (sort keys %$prereqs) {
286 next if $prereq =~ /^perl(?:-|\z)/;
288 my $obj = $int->module_tree($prereq);
289 next unless $obj; # Not in the module tree (e.g. Config)
290 next if $obj->package_is_perl_core;
292 my $version = $prereqs->{$prereq} || undef;
294 push @requires, [ $obj->package_name, $version ];
302 my $mod = $self->parent;
303 my $stat = $self->status;
304 my $int = $mod->parent;
305 my $conf = $int->configure_object;
309 my $OK = sub { $stat->prepared(1); 1 };
310 my $FAIL = sub { $stat->prepared(0); $self->_abort(@_) if @_; 0 };
311 my $SKIP = sub { $stat->prepared(1); $stat->created(1); $self->_skip(@_) if @_; 1 };
313 my $keywords = delete $opts{keywords};
314 if (defined $keywords) {
315 $keywords = [ split ' ', $keywords ];
317 $keywords = $default_keywords;
319 $stat->keywords($keywords);
321 my $manifest = delete $opts{manifest};
322 $manifest = 1 unless defined $manifest;
323 $manifest = 0 if $manifest =~ /^\s*no?\s*$/i;
324 $stat->do_manifest($manifest);
326 my $header = delete $opts{header};
327 if (defined $header) {
328 1 while chomp $header;
331 my $year = (localtime)[5] + 1900;
332 $header = <<" DEF_HEADER";
333 # Copyright 1999-$year Gentoo Foundation
334 # Distributed under the terms of the GNU General Public License v2
338 $stat->header($header);
340 my $footer = delete $opts{footer};
341 if (defined $footer) {
342 $footer = "\n" . $footer;
346 $stat->footer($footer);
348 my $overlay = delete $opts{overlay};
349 $overlay = (defined $overlay) ? Cwd::abs_path($overlay) : '/usr/local/portage';
350 $stat->overlay($overlay);
352 my $distdir = delete $opts{distdir};
353 $distdir = (defined $distdir) ? Cwd::abs_path($distdir) : $default_distdir;
354 $stat->distdir($distdir);
356 return $FAIL->("distdir isn't writable") if $stat->do_manifest && !-w $distdir;
358 $stat->fetched_arch($mod->status->fetch);
360 my $cur = File::Spec->curdir();
363 if ($_ eq $overlay or File::Spec->abs2rel($overlay, $_) eq $cur) {
364 $portdir_overlay = [ @$overlays ];
368 $portdir_overlay = [ @$overlays, $overlay ] unless $portdir_overlay;
369 $stat->portdir_overlay($portdir_overlay);
371 my $name = $mod->package_name;
374 my $version = $mod->package_version;
375 $stat->version($version);
377 my $author = $mod->author->cpanid;
378 $stat->author($author);
380 $stat->distribution($name . '-' . $version);
382 $stat->ebuild_version(CPANPLUS::Dist::Gentoo::Maps::version_c2g($name, $version));
384 $stat->ebuild_name(CPANPLUS::Dist::Gentoo::Maps::name_c2g($name));
386 $stat->ebuild_dir(File::Spec->catdir(
392 my $file = File::Spec->catfile(
394 $stat->ebuild_name . '-' . $stat->ebuild_version . '.ebuild',
396 $stat->ebuild_file($file);
399 # Always generate an ebuild in our category when forcing
400 if ($forced{$file}) {
402 return $SKIP->('Ebuild already forced for', $stat->distribution);
408 return $SKIP->("Can't force rewriting of $file");
410 1 while unlink $file;
413 if (my $atom = $self->_cpan2portage($name, $version)) {
414 $stat->dist($atom->ebuild);
415 return $SKIP->('Ebuild already generated for', $stat->distribution);
421 $self->SUPER::prepare(@_);
423 return $FAIL->() unless $stat->prepared;
425 my $desc = $mod->description;
426 $desc = $mod->comment unless $desc;
427 $desc = "$name Perl distribution (provides " . $mod->module . ')'
429 $desc = substr($desc, 0, 77) . '...' if length $desc > 80;
432 $stat->uri('http://search.cpan.org/dist/' . $name);
434 $author =~ /^(.)(.)/ or return $FAIL->('Wrong author name');
435 $stat->src("mirror://cpan/modules/by-authors/id/$1/$1$2/$author/" . $mod->package);
437 $stat->license($self->intuit_license);
439 my $mstat = $mod->status;
440 $stat->configure_requires($int->$filter_prereqs($mstat->configure_requires));
441 $stat->requires($int->$filter_prereqs($mstat->requires));
442 $stat->recursive_requires([ ]);
444 $dependencies{$name} = [ map $_->[0], @{ $stat->requires } ];
446 my $meta = $self->meta;
447 $stat->min_perl(CPANPLUS::Dist::Gentoo::Maps::perl_version_c2g(
448 $meta->{requires}->{perl},
456 Returns the contents of the F<META.yml> or F<META.json> files as parsed by L<Parse::CPAN::Meta>.
462 my $mod = $self->parent;
463 my $stat = $self->status;
465 my $meta = $stat->meta;
466 return $meta if defined $meta;
468 my $extract_dir = $mod->status->extract;
470 for my $name (qw<META.json META.yml>) {
471 my $meta_file = File::Spec->catdir($extract_dir, $name);
472 next unless -e $meta_file;
475 my $meta = eval { Parse::CPAN::Meta::LoadFile($meta_file) };
485 =head2 C<intuit_license>
487 Returns an array reference to a list of Gentoo licences identifiers under which the current distribution is released.
491 my %dslip_license = (
502 my $mod = $self->parent;
504 my $dslip = $mod->dslip;
505 if (defined $dslip and $dslip =~ /\S{4}(\S)/) {
506 my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($dslip_license{$1});
507 return \@licenses if @licenses;
510 my $meta = $self->meta;
511 my $license = $meta->{license};
512 if (defined $license) {
513 my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($license);
514 return \@licenses if @licenses;
517 return [ CPANPLUS::Dist::Gentoo::Maps::license_c2g('perl') ];
522 my $stat = $self->status;
526 my $guard = CPANPLUS::Dist::Gentoo::Guard->new(sub {
527 if (defined $file and -e $file and -w _) {
528 1 while unlink $file;
532 my $SIG_INT = $SIG{INT};
533 local $SIG{INT} = sub {
536 eval { $SIG_INT->() };
545 $stat->dist($file) if defined $file;
552 $self->_abort(@_) if @_;
556 unless ($stat->prepared) {
558 'Can\'t create', $stat->distribution, 'since it was never prepared'
562 if ($stat->created) {
563 $self->_skip($stat->distribution, 'was already created');
564 $file = $stat->dist; # Keep the existing one.
568 my $dir = $stat->ebuild_dir;
570 eval { File::Path::mkpath($dir) };
571 return $FAIL->("mkpath($dir): $@") if $@;
574 $file = $stat->ebuild_file;
576 # Create a placeholder ebuild to prevent recursion with circular dependencies.
578 open my $eb, '>', $file or return $FAIL->("open($file): $!");
579 print $eb "PLACEHOLDER\n";
585 $self->SUPER::create(@_);
587 return $FAIL->() unless $stat->created;
590 open my $eb, '>', $file or return $FAIL->("open($file): $!");
591 my $source = $self->ebuild_source;
592 return $FAIL->() unless defined $source;
596 return $FAIL->() if $stat->do_manifest and not $self->update_manifest;
601 =head2 C<update_manifest>
603 Updates the F<Manifest> file for the ebuild associated to the current dist object.
607 sub update_manifest {
609 my $stat = $self->status;
611 my $file = $stat->ebuild_file;
612 unless (defined $file and -e $file) {
613 return $self->_abort('The ebuild file is invalid or does not exist');
616 unless (File::Copy::copy($stat->fetched_arch => $stat->distdir)) {
617 return $self->_abort("Couldn\'t copy the distribution file to distdir ($!)");
620 $self->_notify('Adding Manifest entry for', $stat->distribution);
622 return $self->_run([ 'ebuild', $file, 'manifest' ], 0);
625 =head2 C<ebuild_source>
627 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.
631 my $dep_tree_contains;
635 $dep_tree_contains = sub {
636 my ($dist, $target) = @_;
638 return 0 if $seen{$dist};
639 local $seen{$dist} = 1;
641 for my $kid (@{ $dependencies{$dist} }) {
642 return 1 if $kid eq $target
643 or $dep_tree_contains->($kid, $target);
652 my $stat = $self->status;
655 my $name = $stat->name;
656 my %recursive_kids = map { $_ => 1 }
657 grep $dep_tree_contains->($_, $name),
658 @{ $dependencies{$name} };
659 if (%recursive_kids) {
660 my (@requires, @recursive_requires);
661 for (@{ $stat->requires }) {
662 if ($recursive_kids{$_->[0]}) {
663 push @recursive_requires, $_;
668 $stat->requires(\@requires);
669 $stat->recursive_requires(\@recursive_requires);
673 # We must resolve the deps now and not inside prepare because _cpan2portage
674 # has to see the ebuilds already generated for the dependencies of the current
677 my (@configure_requires, @requires, @recursive_requires);
680 [ configure_requires => \@configure_requires ],
681 [ requires => \@requires ],
682 [ recursive_requires => \@recursive_requires ],
685 push @requires, CPANPLUS::Dist::Gentoo::Atom->new(
686 category => 'dev-lang',
688 version => $stat->min_perl,
692 my ($phase, $list) = @$_;
694 for (@{ $stat->$phase }) {
695 my $atom = $self->_cpan2portage(@$_);
696 unless (defined $atom) {
698 "Couldn't find an appropriate ebuild for $_->[0] in the portage tree"
706 @$list = CPANPLUS::Dist::Gentoo::Atom->fold(@$list);
709 my $d = $stat->header;
710 $d .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
711 $d .= 'MODULE_AUTHOR="' . $stat->author . "\"\ninherit perl-module\n\n";
712 $d .= 'S="${WORKDIR}/' . $stat->distribution . "\"\n";
713 $d .= 'DESCRIPTION="' . $stat->desc . "\"\n";
714 $d .= 'HOMEPAGE="' . $stat->uri . "\"\n";
715 $d .= 'SRC_URI="' . $stat->src . "\"\n";
716 $d .= "SLOT=\"0\"\n";
717 $d .= 'LICENSE="|| ( ' . join(' ', sort @{$stat->license}) . " )\"\n";
718 $d .= 'KEYWORDS="' . join(' ', sort @{$stat->keywords}) . "\"\n";
719 $d .= 'RDEPEND="' . join("\n", sort @requires) . "\"\n" if @requires;
720 $d .= 'PDEPEND="' . join("\n", sort @recursive_requires) . "\"\n"
721 if @recursive_requires;
722 $d .= 'DEPEND="' . join("\n", '${RDEPEND}', sort @configure_requires) . "\"\n";
723 $d .= "SRC_TEST=\"do\"\n";
730 my ($self, $dist_name, $dist_version) = @_;
732 my $name = CPANPLUS::Dist::Gentoo::Maps::name_c2g($dist_name);
733 my $version = CPANPLUS::Dist::Gentoo::Maps::version_c2g($dist_name, $dist_version);
735 my @portdirs = ($main_portdir, @{$self->status->portdir_overlay});
737 for my $category (qw<virtual perl-core dev-perl perl-gcpan>, CATEGORY) {
738 my $name = ($category eq 'virtual' ? 'perl-' : '') . $name;
740 for my $portdir (@portdirs) {
741 my @ebuilds = glob File::Spec->catfile(
748 my $last = reduce { $a < $b ? $b : $a } # handles overloading
749 map CPANPLUS::Dist::Gentoo::Atom->new_from_ebuild($_),
751 next if defined $version and $last < $version;
753 return CPANPLUS::Dist::Gentoo::Atom->new(
754 category => $last->category,
757 ebuild => $last->ebuild,
768 my $stat = $self->status;
769 my $conf = $self->parent->parent->configure_object;
771 my $sudo = $conf->get_program('sudo');
772 my @cmd = ('emerge', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
773 unshift @cmd, $sudo if $sudo;
775 my $success = $self->_run(\@cmd, 1);
776 $stat->installed($success);
783 my $stat = $self->status;
784 my $conf = $self->parent->parent->configure_object;
786 my $sudo = $conf->get_program('sudo');
787 my @cmd = ('emerge', '-C', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
788 unshift @cmd, $sudo if $sudo;
790 my $success = $self->_run(\@cmd, 1);
791 $stat->uninstalled($success);
797 my ($self, $cmd, $verbose) = @_;
798 my $stat = $self->status;
800 my ($success, $errmsg, $output) = do {
801 local $ENV{PORTDIR_OVERLAY} = join ' ', @{$stat->portdir_overlay};
802 local $ENV{PORTAGE_RO_DISTDIRS} = $stat->distdir;
810 $self->_abort($errmsg);
811 if (not $verbose and defined $output and $stat->verbose) {
812 my $msg = join '', @$output;
814 CPANPLUS::Error::error($msg);
824 CPANPLUS::Error::error("@_ -- aborting");
832 CPANPLUS::Error::msg("@_");
837 sub _skip { shift->_notify(@_, '-- skipping') }
841 Gentoo (L<http://gentoo.org>).
843 L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5), L<Parse::CPAN::Meta> (since 5.10.1).
845 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).
851 L<CPANPLUS::Dist::Base>, L<CPANPLUS::Dist::Deb>, L<CPANPLUS::Dist::Mdv>.
855 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
857 You can contact me by mail or on C<irc.perl.org> (vincent).
861 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>.
862 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
866 You can find documentation for this module with the perldoc command.
868 perldoc CPANPLUS::Dist::Gentoo
870 =head1 ACKNOWLEDGEMENTS
872 The module was inspired by L<CPANPLUS::Dist::Deb> and L<CPANPLUS::Dist::Mdv>.
874 Kent Fredric, for testing and suggesting improvements.
876 =head1 COPYRIGHT & LICENSE
878 Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
880 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
884 1; # End of CPANPLUS::Dist::Gentoo