1 package CPANPLUS::Dist::Gentoo;
11 use IPC::Cmd qw/run can_run/;
13 use CPANPLUS::Error ();
15 use base qw/CPANPLUS::Dist::Base/;
17 use CPANPLUS::Dist::Gentoo::Maps;
21 CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
29 our $VERSION = '0.07';
33 cpan2dist --format=CPANPLUS::Dist::Gentoo \
34 --dist-opts overlay=/usr/local/portage \
35 --dist-opts distdir=/usr/portage/distfiles \
36 --dist-opts manifest=yes \
37 --dist-opts keywords=x86 \
38 --dist-opts header="# Copyright 1999-2008 Gentoo Foundation" \
39 --dist-opts footer="# End" \
44 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.
46 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>.
50 After installing this module, you should append C<perl-gcpanp> to your F</etc/portage/categories> file.
54 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.
58 use constant CATEGORY => 'perl-gcpanp';
76 sub format_available {
77 return $format_available if defined $format_available;
79 for my $prog (qw/emerge ebuild/) {
80 unless (can_run($prog)) {
81 __PACKAGE__->_abort("$prog is required to write ebuilds");
82 return $format_available = 0;
86 if (IPC::Cmd->can_capture_buffer) {
88 my ($success, $errmsg) = run command => [ qw/emerge --info/ ],
92 if ($buffers =~ /^PORTDIR_OVERLAY=(.*)$/m) {
93 $overlays = [ map abs_path($_), split ' ', $unquote->($1) ];
95 if ($buffers =~ /^ACCEPT_KEYWORDS=(.*)$/m) {
96 $default_keywords = [ split ' ', $unquote->($1) ];
98 if ($buffers =~ /^DISTDIR=(.*)$/m) {
99 $default_distdir = abs_path($unquote->($1));
101 if ($buffers =~ /^PORTDIR=(.*)$/m) {
102 $main_portdir = abs_path($unquote->($1));
105 __PACKAGE__->_abort($errmsg);
109 $default_keywords = [ 'x86' ] unless defined $default_keywords;
110 $default_distdir = '/usr/portage/distfiles' unless defined $default_distdir;
112 return $format_available = 1;
117 my $stat = $self->status;
118 my $conf = $self->parent->parent->configure_object;
120 $stat->mk_accessors(qw/name version author distribution desc uri src license
122 ebuild_name ebuild_version ebuild_dir ebuild_file
124 overlay distdir keywords do_manifest header footer
127 $stat->force($conf->get_conf('force'));
128 $stat->verbose($conf->get_conf('verbose'));
135 my $mod = $self->parent;
136 my $stat = $self->status;
137 my $int = $mod->parent;
138 my $conf = $int->configure_object;
142 my $OK = sub { $stat->prepared(1); 1 };
143 my $FAIL = sub { $stat->prepared(0); $self->_abort(@_) if @_; 0 };
145 my $keywords = delete $opts{'keywords'};
146 if (defined $keywords) {
147 $keywords = [ split ' ', $keywords ];
149 $keywords = $default_keywords;
151 $stat->keywords($keywords);
153 my $manifest = delete $opts{'manifest'};
154 $manifest = 1 unless defined $manifest;
155 $manifest = 0 if $manifest =~ /^\s*no?\s*$/i;
156 $stat->do_manifest($manifest);
158 my $header = delete $opts{'header'};
159 if (defined $header) {
160 1 while chomp $header;
165 $stat->header($header);
167 my $footer = delete $opts{'footer'};
168 if (defined $footer) {
169 $footer = "\n" . $footer;
173 $stat->footer($footer);
175 my $overlay = delete $opts{'overlay'};
176 $overlay = (defined $overlay) ? abs_path $overlay : '/usr/local/portage';
177 $stat->overlay($overlay);
179 my $distdir = delete $opts{'distdir'};
180 $distdir = (defined $distdir) ? abs_path $distdir : $default_distdir;
181 $stat->distdir($distdir);
183 if ($stat->do_manifest && !-w $stat->distdir) {
184 return $FAIL->('distdir isn\'t writable');
186 $stat->fetched_arch($mod->status->fetch);
188 my $cur = File::Spec->curdir();
191 if ($_ eq $overlay or File::Spec->abs2rel($overlay, $_) eq $cur) {
192 $portdir_overlay = [ @$overlays ];
196 $portdir_overlay = [ @$overlays, $overlay ] unless $portdir_overlay;
197 $stat->portdir_overlay($portdir_overlay);
199 my $name = $mod->package_name;
202 my $version = $mod->package_version;
203 $stat->version($version);
205 my $author = $mod->author->cpanid;
206 $stat->author($author);
208 $stat->distribution($name . '-' . $version);
210 $stat->ebuild_version(CPANPLUS::Dist::Gentoo::Maps::version_c2g($version));
212 $stat->ebuild_name(CPANPLUS::Dist::Gentoo::Maps::name_c2g($name));
214 $stat->ebuild_dir(File::Spec->catdir(
220 my $file = File::Spec->catfile(
222 $stat->ebuild_name . '-' . $stat->ebuild_version . '.ebuild',
224 $stat->ebuild_file($file);
228 if ($stat->force and not $forced{$file}) {
230 1 while unlink $file;
234 $self->_skip("Can't force rewriting of $file");
237 $self->_skip('Ebuild already generated for', $stat->distribution);
247 $self->SUPER::prepare(%opts);
251 my $desc = $mod->description;
252 ($desc = $name) =~ s/-+/::/g unless $desc;
255 $stat->uri('http://search.cpan.org/dist/' . $name);
257 unless ($author =~ /^(.)(.)/) {
258 return $FAIL->('Wrong author name');
260 $stat->src("mirror://cpan/modules/by-authors/id/$1/$1$2/$author/"
263 $stat->license([ qw/Artistic GPL-2/ ]);
265 my $prereqs = $mod->status->prereqs;
267 for my $prereq (sort keys %$prereqs) {
268 next if $prereq =~ /^perl(?:-|\z)/;
269 my $obj = $int->module_tree($prereq);
270 return $FAIL->('Wrong module object') unless $obj;
271 next if $obj->package_is_perl_core;
274 if ($prereqs->{$prereq}) {
275 if ($obj->installed_version && $obj->installed_version < $obj->version) {
276 $version = $obj->installed_version;
278 $version = $obj->package_version;
281 push @depends, [ $obj->package_name, $version ];
284 $stat->deps(\@depends);
291 my $stat = $self->status;
293 my $OK = sub { $stat->created(1); $stat->dist($stat->ebuild_file); 1 };
294 my $FAIL = sub { $stat->created(0); $stat->dist(undef); $self->_abort(@_) if @_; 0 };
296 unless ($stat->prepared) {
298 'Can\'t create', $stat->distribution, 'since it was never prepared'
302 if ($stat->created) {
303 $self->_skip($stat->distribution, 'was already created');
307 my $dir = $stat->ebuild_dir;
309 eval { File::Path::mkpath($dir) };
310 return $FAIL->("mkpath($dir): $@") if $@;
313 my $file = $stat->ebuild_file;
314 open my $eb, '>', $file or return $FAIL->("open($file): $!");
315 print $eb $self->ebuild_source;
321 $self->SUPER::create(@_);
323 if ($stat->do_manifest and not $self->update_manifest) {
324 1 while unlink $file;
331 =head2 C<update_manifest>
333 Update the F<Manifest> file for the ebuild associated to the current dist object.
337 sub update_manifest {
339 my $stat = $self->status;
341 my $file = $stat->ebuild_file;
342 unless ($file and -e $file) {
343 return $self->_abort('The ebuild file is invalid or does not exist');
346 unless (File::Copy::copy($stat->fetched_arch => $stat->distdir)) {
347 return $self->_abort("Couldn\'t copy the distribution file to distdir ($!)");
350 $self->_notify('Adding Manifest entry for', $stat->distribution);
352 return $self->_run([ 'ebuild', $stat->ebuild_file, 'manifest' ], 0);
355 =head2 C<ebuild_source>
357 Returns the source of the ebuild for the current dist object.
363 my $stat = $self->status;
365 # We must resolve the deps now and not inside prepare because _cpan2portage
366 # has to see the ebuilds already generated for the dependencies of the current
370 sort grep !$seen{$_}++, 'dev-lang/perl',
371 map $self->_cpan2portage(@$_), @{$stat->deps}
374 my $d = $stat->header;
375 $d .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
376 $d .= 'MODULE_AUTHOR="' . $stat->author . "\"\ninherit perl-module\n\n";
377 $d .= 'S="${WORKDIR}/' . $stat->distribution . "\"\n";
378 $d .= 'DESCRIPTION="' . $stat->desc . "\"\n";
379 $d .= 'HOMEPAGE="' . $stat->uri . "\"\n";
380 $d .= 'SRC_URI="' . $stat->src . "\"\n";
381 $d .= "SLOT=\"0\"\n";
382 $d .= 'LICENSE="|| ( ' . join(' ', sort @{$stat->license}) . " )\"\n";
383 $d .= 'KEYWORDS="' . join(' ', sort @{$stat->keywords}) . "\"\n";
384 $d .= 'DEPEND="' . join("\n", @deps) . "\"\n";
385 $d .= "SRC_TEST=\"do\"\n";
392 my ($self, $name, $version) = @_;
394 $name = CPANPLUS::Dist::Gentoo::Maps::name_c2g($name);
396 $ver = CPANPLUS::Dist::Gentoo::Maps::version_c2g($version) if defined $version;
398 my @portdirs = ($main_portdir, @{$self->status->portdir_overlay});
400 for my $category (qw/virtual perl-core dev-perl perl-gcpan/, CATEGORY) {
401 my $atom = ($category eq 'virtual' ? 'perl-' : '') . $name;
403 for my $portdir (@portdirs) {
404 my @ebuilds = glob File::Spec->catfile(
411 if (defined $ver) { # implies that $version is defined
413 my ($eb_ver) = /\Q$atom\E-v?([\d._pr-]+).*?\.ebuild$/;
414 return ">=$category/$atom-$ver"
416 and CPANPLUS::Dist::Gentoo::Maps::version_gcmp($eb_ver, $ver) > 0;
419 return "$category/$atom";
427 "Couldn't find an appropriate ebuild for $name in the portage tree"
435 my $stat = $self->status;
436 my $conf = $self->parent->parent->configure_object;
438 my $sudo = $conf->get_program('sudo');
439 my @cmd = ('emerge', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
440 unshift @cmd, $sudo if $sudo;
442 my $success = $self->_run(\@cmd, 1);
443 $stat->installed($success);
450 my $stat = $self->status;
451 my $conf = $self->parent->parent->configure_object;
453 my $sudo = $conf->get_program('sudo');
454 my @cmd = ('emerge', '-C', '=' . $stat->ebuild_name . '-' . $stat->ebuild_version);
455 unshift @cmd, $sudo if $sudo;
457 my $success = $self->_run(\@cmd, 1);
458 $stat->uninstalled($success);
464 my ($self, $cmd, $verbose) = @_;
465 my $stat = $self->status;
467 my ($success, $errmsg, $output) = do {
468 local $ENV{PORTDIR_OVERLAY} = join ' ', @{$stat->portdir_overlay};
469 local $ENV{PORTAGE_RO_DISTDIRS} = $stat->distdir;
470 run command => $cmd, verbose => $verbose;
474 $self->_abort($errmsg);
475 if (not $verbose and defined $output and $stat->verbose) {
476 my $msg = join '', @$output;
478 CPANPLUS::Error::error($msg);
488 CPANPLUS::Error::error("@_ -- aborting");
496 CPANPLUS::Error::msg("@_");
501 sub _skip { shift->_notify(@_, '-- skipping') }
505 Gentoo (L<http://gentoo.org>).
507 L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5).
509 L<Cwd>, L<Carp> (since perl 5), L<File::Path> (5.001), L<File::Copy> (5.002), L<File::Spec> (5.00405).
515 L<CPANPLUS::Dist::Base>, L<CPANPLUS::Dist::Deb>, L<CPANPLUS::Dist::Mdv>.
519 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
521 You can contact me by mail or on C<irc.perl.org> (vincent).
525 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.
529 You can find documentation for this module with the perldoc command.
531 perldoc CPANPLUS::Dist::Gentoo
533 =head1 ACKNOWLEDGEMENTS
535 The module is to some extend cargo-culted from L<CPANPLUS::Dist::Deb> and L<CPANPLUS::Dist::Mdv>.
537 Kent Fredric, for testing and suggesting improvements.
539 =head1 COPYRIGHT & LICENSE
541 Copyright 2008-2009 Vincent Pit, all rights reserved.
543 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
547 1; # End of CPANPLUS::Dist::Gentoo