1 package CPANPLUS::Dist::Gentoo;
7 use File::Copy qw/copy/;
8 use File::Path qw/mkpath/;
9 use File::Spec::Functions qw/catdir catfile/;
11 use IPC::Cmd qw/run can_run/;
15 use base qw/CPANPLUS::Dist::Base/;
19 CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
27 our $VERSION = '0.04';
31 cpan2dist --format=CPANPLUS::Dist::Gentoo \
32 --dist-opts overlay=/usr/local/portage \
33 --dist-opts distdir=/usr/portage/distfiles \
34 --dist-opts manifest=yes \
35 --dist-opts keywords=x86 \
36 --dist-opts header="# Copyright 1999-2008 Gentoo Foundation" \
37 --dist-opts footer="# End" \
42 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.
44 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>.
48 After installing this module, you should append C<perl-gcpanp> to your F</etc/portage/categories> file.
52 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.
56 use constant CATEGORY => 'perl-gcpanp';
69 sub format_available {
70 for my $prog (qw/emerge ebuild/) {
71 unless (can_run($prog)) {
72 error "$prog is required to write ebuilds -- aborting";
77 if (IPC::Cmd->can_capture_buffer) {
78 my ($success, $errmsg, $output) = run command => [ qw/emerge --info/ ],
81 for (@{$output || []}) {
82 if (/^PORTDIR_OVERLAY=(.*)$/m) {
83 $overlays = [ map abs_path($_), split ' ', _unquote($1) ];
85 if (/^ACCEPT_KEYWORDS=(.*)$/m) {
86 $default_keywords = [ split ' ', _unquote($1) ];
88 if (/^DISTDIR=(.*)$/m) {
89 $default_distdir = abs_path(_unquote($1));
97 $default_keywords = [ 'x86' ] unless defined $default_keywords;
98 $default_distdir = '/usr/portage/distfiles' unless defined $default_distdir;
105 my $stat = $self->status;
106 my $conf = $self->parent->parent->configure_object;
108 $stat->mk_accessors(qw/name version author distribution desc uri license
109 deps eb_name eb_version eb_dir eb_file fetched_arch
111 overlay distdir keywords do_manifest header footer
114 $stat->force($conf->get_conf('force'));
115 $stat->verbose($conf->get_conf('verbose'));
121 'ANSIColor' => 'Term-ANSIColor',
122 'Audio-CD' => 'Audio-CD-disc-cover',
123 'CGI-Simple' => 'Cgi-Simple',
124 'Cache-Mmap' => 'cache-mmap',
125 'Class-Loader' => 'class-loader',
126 'Class-ReturnValue' => 'class-returnvalue',
127 'Config-General' => 'config-general',
128 'Convert-ASCII-Armour' => 'convert-ascii-armour',
129 'Convert-PEM' => 'convert-pem',
130 'Crypt-CBC' => 'crypt-cbc',
131 'Crypt-DES_EDE3' => 'crypt-des-ede3',
132 'Crypt-DH' => 'crypt-dh',
133 'Crypt-DSA' => 'crypt-dsa',
134 'Crypt-IDEA' => 'crypt-idea',
135 'Crypt-Primes' => 'crypt-primes',
136 'Crypt-RSA' => 'crypt-rsa',
137 'Crypt-Random' => 'crypt-random',
138 'DBIx-SearchBuilder' => 'dbix-searchbuilder',
139 'Data-Buffer' => 'data-buffer',
140 'Digest' => 'digest-base',
141 'Digest-BubbleBabble' => 'digest-bubblebabble',
142 'Digest-MD2' => 'digest-md2',
143 'ExtUtils-Depends' => 'extutils-depends',
144 'ExtUtils-PkgConfig' => 'extutils-pkgconfig',
145 'Frontier-RPC' => 'frontier-rpc',
146 'Gimp' => 'gimp-perl',
147 'Glib' => 'glib-perl',
148 'Gnome2-Canvas' => 'gnome2-canvas',
149 'Gnome2-GConf' => 'gnome2-gconf',
150 'Gnome2-Print' => 'gnome2-print',
151 'Gnome2-VFS' => 'gnome2-vfs-perl',
152 'Gnome2-Wnck' => 'gnome2-wnck',
153 'Gtk2' => 'gtk2-perl',
154 'Gtk2-Ex-FormFactory' => 'gtk2-ex-formfactory',
155 'Gtk2-GladeXML' => 'gtk2-gladexml',
156 'Gtk2-Spell' => 'gtk2-spell',
157 'Gtk2-TrayIcon' => 'gtk2-trayicon',
158 'Gtk2-TrayManager' => 'gtk2-traymanager',
159 'Gtk2Fu' => 'gtk2-fu',
160 'I18N-LangTags' => 'i18n-langtags',
161 'Image-Info' => 'ImageInfo',
162 'Image-Size' => 'ImageSize',
163 'Inline-Files' => 'inline-files',
164 'Locale-Maketext' => 'locale-maketext',
165 'Locale-Maketext-Fuzzy' => 'locale-maketext-fuzzy',
166 'Locale-Maketext-Lexicon' => 'locale-maketext-lexicon',
167 'Log-Dispatch' => 'log-dispatch',
168 'Math-Pari' => 'math-pari',
169 'Module-Info' => 'module-info',
170 'Net-Ping' => 'net-ping',
171 'Net-SFTP' => 'net-sftp',
172 'Net-SSH-Perl' => 'net-ssh-perl',
173 'Net-Server' => 'net-server',
174 'OLE-Storage_Lite' => 'OLE-StorageLite',
175 'Ogg-Vorbis-Header' => 'ogg-vorbis-header',
176 'PathTools' => 'File-Spec',
177 'Pod-Parser' => 'PodParser',
178 'Regexp-Common' => 'regexp-common',
179 'SDL_Perl' => 'sdl-perl',
180 'Set-Scalar' => 'set-scalar',
181 'String-CRC32' => 'string-crc32',
182 'Text-Autoformat' => 'text-autoformat',
183 'Text-Reform' => 'text-reform',
184 'Text-Template' => 'text-template',
185 'Text-Wrapper' => 'text-wrapper',
186 'Tie-EncryptedHash' => 'tie-encryptedhash',
190 'gettext' => 'Locale-gettext',
191 'txt2html' => 'TextToHTML',
196 my $mod = $self->parent;
197 my $stat = $self->status;
198 my $int = $mod->parent;
199 my $conf = $int->configure_object;
205 my $keywords = delete $opts{'keywords'};
206 if (defined $keywords) {
207 $keywords = [ split ' ', $keywords ];
209 $keywords = $default_keywords;
211 $stat->keywords($keywords);
213 my $manifest = delete $opts{'manifest'};
214 $manifest = 1 unless defined $manifest;
215 $manifest = 0 if $manifest =~ /^\s*no?\s*$/i;
216 $stat->do_manifest($manifest);
218 my $header = delete $opts{'header'};
219 if (defined $header) {
220 1 while chomp $header;
225 $stat->header($header);
227 my $footer = delete $opts{'footer'};
228 if (defined $footer) {
229 $footer = "\n" . $footer;
233 $stat->footer($footer);
235 my $overlay = delete $opts{'overlay'};
236 $overlay = (defined $overlay) ? abs_path $overlay : '/usr/local/portage';
237 $stat->overlay($overlay);
239 my $distdir = delete $opts{'distdir'};
240 $distdir = (defined $distdir) ? abs_path $distdir : $default_distdir;
241 $stat->distdir($distdir);
243 if ($stat->do_manifest && !-w $stat->distdir) {
244 error 'distdir isn\'t writable -- aborting';
247 $stat->fetched_arch($mod->status->fetch);
249 my $cur = File::Spec::Functions::curdir();
252 if ($_ eq $overlay or File::Spec::Functions::abs2rel($overlay, $_) eq $cur) {
253 $portdir_overlay = join ' ', @$overlays;
257 $portdir_overlay = join ' ', @$overlays, $overlay
258 unless defined $portdir_overlay;
259 $stat->portdir_overlay($portdir_overlay);
261 my $name = $mod->package_name;
264 my $version = $mod->package_version;
265 $stat->version($version);
267 my $author = $mod->author->cpanid;
268 $stat->author($author);
270 $stat->distribution($name . '-' . $version);
272 $version =~ s/[^\d._]+//g;
273 $version =~ s/^[._]*//;
274 $version =~ s/[._]*$//;
275 $version =~ s/[._]*_[._]*/_/g;
277 ($version, my $patch, my @rest) = split /_/, $version;
278 $version .= '_p' . $patch if defined $patch;
279 $version .= join('.', '', @rest) if @rest;
281 $stat->eb_version($version);
283 $stat->eb_name($gentooism{$name} || $name);
285 $stat->eb_dir(catdir($stat->overlay, CATEGORY, $stat->eb_name));
287 my $file = catfile($stat->eb_dir,
288 $stat->eb_name . '-' . $stat->eb_version . '.ebuild');
289 $stat->eb_file($file);
295 1 while unlink $file;
298 error "Can't force rewriting of $file -- skipping";
301 msg 'Ebuild already generated for ' . $stat->distribution . ' -- skipping';
311 $self->SUPER::prepare(%opts);
315 my $desc = $mod->description;
316 ($desc = $name) =~ s/-+/::/g unless $desc;
319 $stat->uri('http://search.cpan.org/dist/' . $name);
321 $stat->license([ qw/Artistic GPL-2/ ]);
323 my $prereqs = $mod->status->prereqs;
325 for my $prereq (sort keys %$prereqs) {
326 next if $prereq =~ /^perl(?:-|\z)/;
327 my $obj = $int->module_tree($prereq);
329 error 'Wrong module object -- aborting';
332 next if $obj->package_is_perl_core;
335 if ($prereqs->{$prereq}) {
336 if ($obj->installed_version && $obj->installed_version < $obj->version) {
337 $version = $obj->installed_version;
339 $version = $obj->package_version;
342 push @depends, [ $obj , $version ];
345 $stat->deps(\@depends);
353 my $stat = $self->status;
355 unless ($stat->prepared) {
356 error 'Can\'t create ' . $stat->distribution . ' since it was never prepared -- aborting';
362 if ($stat->created) {
363 msg $stat->distribution . ' was already created -- skipping';
364 $stat->dist($stat->eb_file);
371 $self->SUPER::create(@_);
376 my $dir = $stat->eb_dir;
378 eval { mkpath $dir };
380 error "mkpath($dir): $@";
385 my $d = $stat->header;
386 $d .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
387 $d .= 'MODULE_AUTHOR="' . $stat->author . "\"\ninherit perl-module\n\n";
388 $d .= 'DESCRIPTION="' . $stat->desc . "\"\n";
389 $d .= 'HOMEPAGE="' . $stat->uri . "\"\n\n";
390 $d .= "SLOT=\"0\"\n";
391 $d .= 'LICENSE="|| ( ' . join(' ', sort @{$stat->license}) . " )\"\n";
392 $d .= 'KEYWORDS="' . join(' ', sort @{$stat->keywords}) . "\"\n";
393 $d .= 'DEPEND="' . join "\n",
396 my $a = $_->[0]->package_name;
397 $a = $gentooism{$a} || $a;
399 if (defined $_->[1]) {
403 '|| ( ' . join(' ', map "$x$_/$a",
404 qw/perl-core dev-perl perl-gcpan/, CATEGORY)
408 $d .= "SRC_TEST=\"do\"\n";
411 my $file = $stat->eb_file;
412 open my $eb, '>', $file or do {
413 error "open($file): $! -- aborting";
419 if ($stat->do_manifest) {
420 unless (copy $stat->fetched_arch, $stat->distdir) {
421 error "Couldn\'t copy the distribution file to distdir ($!) -- aborting";
422 1 while unlink $file;
426 msg 'Adding Manifest entry for ' . $stat->distribution;
427 unless ($self->_run([ 'ebuild', $file, 'manifest' ], 0)) {
428 1 while unlink $file;
440 my $stat = $self->status;
441 my $conf = $self->parent->parent->configure_object;
443 my $sudo = $conf->get_program('sudo');
444 my @cmd = ('emerge', '=' . $stat->eb_name . '-' . $stat->eb_version);
445 unshift @cmd, $sudo if $sudo;
447 my $success = $self->_run(\@cmd, 1);
448 $stat->installed($success);
455 my $stat = $self->status;
456 my $conf = $self->parent->parent->configure_object;
458 my $sudo = $conf->get_program('sudo');
459 my @cmd = ('emerge', '-C', '=' . $stat->eb_name . '-' . $stat->eb_version);
460 unshift @cmd, $sudo if $sudo;
462 my $success = $self->_run(\@cmd, 1);
463 $stat->uninstalled($success);
469 my ($self, $cmd, $verbose) = @_;
470 my $stat = $self->status;
472 my ($success, $errmsg, $output) = do {
473 local $ENV{PORTDIR_OVERLAY} = $stat->portdir_overlay;
474 local $ENV{PORTAGE_RO_DISTDIRS} = $stat->distdir;
475 run command => $cmd, verbose => $verbose;
479 error "$errmsg -- aborting";
480 if (not $verbose and defined $output and $self->status->verbose) {
481 my $msg = join '', @$output;
492 Gentoo (L<http://gentoo.org>).
494 L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5).
496 L<Cwd> (since perl 5) L<File::Path> (5.001), L<File::Copy> (5.002), L<File::Spec::Functions> (5.00504).
502 L<CPANPLUS::Dist::Base>, L<CPANPLUS::Dist::Deb>, L<CPANPLUS::Dist::Mdv>.
506 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
508 You can contact me by mail or on C<irc.perl.org> (vincent).
512 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.
516 You can find documentation for this module with the perldoc command.
518 perldoc CPANPLUS::Dist::Gentoo
520 =head1 ACKNOWLEDGEMENTS
522 The module is to some extend cargo-culted from L<CPANPLUS::Dist::Deb> and L<CPANPLUS::Dist::Mdv>.
524 Kent Fredric, for testing and suggesting improvements.
526 =head1 COPYRIGHT & LICENSE
528 Copyright 2008 Vincent Pit, all rights reserved.
530 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
534 1; # End of CPANPLUS::Dist::Gentoo