1 package CPANPLUS::Dist::Build;
5 use vars qw[@ISA $STATUS $VERSION];
6 @ISA = qw[CPANPLUS::Dist];
8 use CPANPLUS::Internals::Constants;
10 ### these constants were exported by CPANPLUS::Internals::Constants
11 ### in previous versions.. they do the same though. If we want to have
12 ### a normal 'use' here, up the dependency to CPANPLUS 0.056 or higher
14 require CPANPLUS::Dist::Build::Constants;
15 CPANPLUS::Dist::Build::Constants->import()
16 if not __PACKAGE__->can('BUILD') && __PACKAGE__->can('BUILD_DIR');
27 use Params::Check qw[check];
28 use Module::Load::Conditional qw[can_load check_install];
29 use Locale::Maketext::Simple Class => 'CPANPLUS', Style => 'gettext';
31 local $Params::Check::VERBOSE = 1;
39 CPANPLUS::Dist::Build - CPANPLUS plugin to install packages that use Build.PL
43 my $build = CPANPLUS::Dist->new(
44 format => 'CPANPLUS::Dist::Build',
48 $build->prepare; # runs Build.PL
49 $build->create; # runs build && build test
50 $build->install; # runs build install
55 C<CPANPLUS::Dist::Build> is a distribution class for C<Module::Build>
57 Using this package, you can create, install and uninstall perl
58 modules. It inherits from C<CPANPLUS::Dist>.
60 Normal users won't have to worry about the interface to this module,
61 as it functions transparently as a plug-in to C<CPANPLUS> and will
62 just C<Do The Right Thing> when it's loaded.
70 Returns the C<CPANPLUS::Module> object that parented this object.
74 Returns the C<Object::Accessor> object that keeps the status for
79 =head1 STATUS ACCESSORS
81 All accessors can be accessed as follows:
82 $build->status->ACCESSOR
88 Location of the Build file.
89 Set to 0 explicitly if something went wrong.
93 BOOL indicating if the C<Build> command was successful.
97 BOOL indicating if the C<Build test> command was successful.
101 BOOL indicating if the C<prepare> call exited succesfully
102 This gets set after C<perl Build.PL>
106 Full path to the directory in which the C<prepare> call took place,
107 set after a call to C<prepare>.
111 BOOL indicating if the C<create> call exited succesfully. This gets
112 set after C<Build> and C<Build test>.
114 =item C<installed ()>
116 BOOL indicating if the module was installed. This gets set after
117 C<Build install> exits successfully.
121 BOOL indicating if the module was uninstalled properly.
123 =item C<_create_args ()>
125 Storage of the arguments passed to C<create> for this object. Used
126 for recursive calls when satisfying prerequisites.
128 =item C<_install_args ()>
130 Storage of the arguments passed to C<install> for this object. Used
131 for recursive calls when satisfying prerequisites.
139 =head2 $bool = CPANPLUS::Dist::Build->format_available();
141 Returns a boolean indicating whether or not you can use this package
142 to create and install modules in your environment.
146 ### check if the format is available ###
147 sub format_available {
148 my $mod = "Module::Build";
149 unless( can_load( modules => { $mod => '0.2611' } ) ) {
150 error( loc( "You do not have '%1' -- '%2' not available",
151 $mod, __PACKAGE__ ) );
159 =head2 $bool = $dist->init();
161 Sets up the C<CPANPLUS::Dist::Build> object for use.
162 Effectively creates all the needed status accessors.
164 Called automatically whenever you create a new C<CPANPLUS::Dist> object.
170 my $status = $dist->status;
172 $status->mk_accessors(qw[build_pl build test created installed uninstalled
173 _create_args _install_args _prepare_args
174 _mb_object _buildflags
177 ### just in case 'format_available' didn't get called
178 require Module::Build;
185 =head2 $bool = $dist->prepare([perl => '/path/to/perl', buildflags => 'EXTRA=FLAGS', force => BOOL, verbose => BOOL])
187 C<prepare> prepares a distribution, running C<Build.PL>
188 and establishing any prerequisites this
191 The variable C<PERL5_CPANPLUS_IS_EXECUTING> will be set to the full path
192 of the C<Build.PL> that is being executed. This enables any code inside
193 the C<Build.PL> to know that it is being installed via CPANPLUS.
195 After a succcesfull C<prepare> you may call C<create> to create the
196 distribution, followed by C<install> to actually install it.
198 Returns true on success and false on failure.
203 ### just in case you already did a create call for this module object
204 ### just via a different dist object
206 my $self = $dist->parent;
208 ### we're also the cpan_dist, since we don't need to have anything
209 ### prepared from another installer
210 $dist = $self->status->dist_cpan if $self->status->dist_cpan;
211 $self->status->dist_cpan( $dist ) unless $self->status->dist_cpan;
213 my $cb = $self->parent;
214 my $conf = $cb->configure_object;
218 unless( $dir = $self->status->extract ) {
219 error( loc( "No dir found to operate on!" ) );
224 my( $force, $verbose, $buildflags, $perl, $prereq_target, $prereq_format,
226 { local $Params::Check::ALLOW_UNKNOWN = 1;
228 force => { default => $conf->get_conf('force'),
230 verbose => { default => $conf->get_conf('verbose'),
231 store => \$verbose },
232 perl => { default => $^X, store => \$perl },
233 buildflags => { default => $conf->get_conf('buildflags'),
234 store => \$buildflags },
235 prereq_target => { default => '', store => \$prereq_target },
236 prereq_format => { default => '',
237 store => \$prereq_format },
238 prereq_build => { default => 0, store => \$prereq_build },
241 $args = check( $tmpl, \%hash ) or return;
244 return 1 if $dist->status->prepared && !$force;
246 $dist->status->_prepare_args( $args );
248 ### chdir to work directory ###
250 unless( $cb->_chdir( dir => $dir ) ) {
251 error( loc( "Could not chdir to build directory '%1'", $dir ) );
255 ### by now we've loaded module::build, and we're using the API, so
256 ### it's safe to remove CPANPLUS::inc from our inc path, especially
257 ### because it can trip up tests run under taint (just like EU::MM).
258 ### turn off our PERL5OPT so no modules from CPANPLUS::inc get
259 ### included in make test -- it should build without.
260 ### also, modules that run in taint mode break if we leave
261 ### our code ref in perl5opt
262 ### XXX we've removed the ENV settings from cp::inc, so only need
263 ### to reset the @INC
264 #local $ENV{PERL5OPT} = CPANPLUS::inc->original_perl5opt;
265 #local $ENV{PERL5LIB} = CPANPLUS::inc->original_perl5lib;
266 #local @INC = CPANPLUS::inc->original_inc;
268 ### this will generate warnings under anything lower than M::B 0.2606
269 my @buildflags = $dist->_buildflags_as_list( $buildflags );
270 $dist->status->_buildflags( $buildflags );
275 ### we resolve 'configure requires' here, so we can run the 'perl
276 ### Makefile.PL' command
277 ### XXX for tests: mock f_c_r to something that *can* resolve and
278 ### something that *doesnt* resolve. Check the error log for ok
279 ### on this step or failure
280 ### XXX make a seperate tarball to test for this scenario: simply
281 ### containing a makefile.pl/build.pl for test purposes?
282 my $safe_ver = version->new('0.85_01');
283 if ( version->new($CPANPLUS::Internals::VERSION) >= $safe_ver )
284 { my $configure_requires = $dist->find_configure_requires;
285 my $ok = $dist->_resolve_prereqs(
286 format => $prereq_format,
288 prereqs => $configure_requires,
289 target => $prereq_target,
291 prereq_build => $prereq_build,
296 #### use $dist->flush to reset the cache ###
297 error( loc( "Unable to satisfy '%1' for '%2' " .
298 "-- aborting install",
299 'configure_requires', $self->module ) );
300 $dist->status->prepared(0);
304 ### end of prereq resolving ###
307 # Wrap the exception that may be thrown here (should likely be
308 # done at a much higher level).
311 my $env = ENV_CPANPLUS_IS_EXECUTING;
312 local $ENV{$env} = BUILD_PL->( $dir );
313 my $run_perl = $conf->get_program('perlwrapper');
314 my $cmd = [$perl, $run_perl, BUILD_PL->($dir), @buildflags];
316 unless ( scalar run( command => $cmd,
317 buffer => \$prep_output,
318 verbose => $verbose )
320 error( loc( "Build.PL failed: %1", $prep_output ) );
324 msg( $prep_output, 0 );
326 my $prereqs = $self->status->prereqs;
328 $prereqs ||= $dist->_find_prereqs( verbose => $verbose,
331 buildflags => $buildflags );
335 ### send out test report? ###
336 if( $fail and $conf->get_conf('cpantest') ) {
340 buffer => CPANPLUS::Error->stack_as_string,
343 ) or error(loc("Failed to send test report for '%1'",
347 unless( $cb->_chdir( dir => $orig ) ) {
348 error( loc( "Could not chdir back to start dir '%1'", $orig ) );
351 ### save where we wrote this stuff -- same as extract dir in normal
352 ### installer circumstances
353 $dist->status->distdir( $self->status->extract );
355 return $dist->status->prepared( $fail ? 0 : 1 );
360 my $self = $dist->parent;
361 my $cb = $self->parent;
362 my $conf = $cb->configure_object;
365 my ($verbose, $dir, $buildflags, $perl);
367 verbose => { default => $conf->get_conf('verbose'), store => \$verbose },
368 dir => { default => $self->status->extract, store => \$dir },
369 perl => { default => $^X, store => \$perl },
370 buildflags => { default => $conf->get_conf('buildflags'),
371 store => \$buildflags },
374 my $args = check( $tmpl, \%hash ) or return;
378 $prereqs = $dist->find_mymeta_requires()
379 if $dist->can('find_mymeta_requires');
381 if ( keys %$prereqs ) {
385 my $safe_ver = version->new('0.31_03');
387 if ( version->new( $Module::Build::VERSION ) >= $safe_ver and IPC::Cmd->can_capture_buffer ) {
388 my @buildflags = $dist->_buildflags_as_list( $buildflags );
390 # Use the new Build action 'prereq_data'
391 my $run_perl = $conf->get_program('perlwrapper');
393 unless ( scalar run( command => [$perl, $run_perl, BUILD->($dir), 'prereq_data', @buildflags],
397 error( loc( "Build 'prereq_data' failed: %1 %2", $!, $content ) );
403 my $file = File::Spec->catfile( $dir, '_build', 'prereqs' );
404 return unless -f $file;
406 my $fh = FileHandle->new();
408 unless( $fh->open( $file ) ) {
409 error( loc( "Cannot open '%1': %2", $file, $! ) );
413 $content = do { local $/; <$fh> };
416 return unless $content;
417 my $bphash = eval $content;
418 return unless $bphash and ref $bphash eq 'HASH';
419 foreach my $type ('requires', 'build_requires') {
420 next unless $bphash->{$type} and ref $bphash->{$type} eq 'HASH';
421 $prereqs->{$_} = $bphash->{$type}->{$_} for keys %{ $bphash->{$type} };
425 delete $prereqs->{'perl'};
427 ### allows for a user defined callback to filter the prerequisite
428 ### list as they see fit, to remove (or add) any prereqs they see
429 ### fit. The default installed callback will return the hashref in
430 ### an unmodified form
431 ### this callback got added after cpanplus 0.0562, so use a 'can'
432 ### to find out if it's supported. For older versions, we'll just
433 ### return the hashref as is ourselves.
434 my $href = $cb->_callbacks->can('filter_prereqs')
435 ? $cb->_callbacks->filter_prereqs->( $cb, $prereqs )
438 $self->status->prereqs( $href );
440 ### make sure it's not the same ref
446 =head2 $dist->create([perl => '/path/to/perl', buildflags => 'EXTRA=FLAGS', prereq_target => TARGET, force => BOOL, verbose => BOOL, skiptest => BOOL])
448 C<create> preps a distribution for installation. This means it will
449 run C<Build> and C<Build test>.
450 This will also satisfy any prerequisites the module may have.
452 If you set C<skiptest> to true, it will skip the C<Build test> stage.
453 If you set C<force> to true, it will go over all the stages of the
454 C<Build> process again, ignoring any previously cached results. It
455 will also ignore a bad return value from C<Build test> and still allow
456 the operation to return true.
458 Returns true on success and false on failure.
460 You may then call C<< $dist->install >> on the object to actually
466 ### just in case you already did a create call for this module object
467 ### just via a different dist object
469 my $self = $dist->parent;
471 ### we're also the cpan_dist, since we don't need to have anything
472 ### prepared from another installer
473 $dist = $self->status->dist_cpan if $self->status->dist_cpan;
474 $self->status->dist_cpan( $dist ) unless $self->status->dist_cpan;
476 my $cb = $self->parent;
477 my $conf = $cb->configure_object;
481 unless( $dir = $self->status->extract ) {
482 error( loc( "No dir found to operate on!" ) );
487 my( $force, $verbose, $buildflags, $skiptest, $prereq_target,
488 $perl, $prereq_format, $prereq_build);
489 { local $Params::Check::ALLOW_UNKNOWN = 1;
491 force => { default => $conf->get_conf('force'),
493 verbose => { default => $conf->get_conf('verbose'),
494 store => \$verbose },
495 perl => { default => $^X, store => \$perl },
496 buildflags => { default => $conf->get_conf('buildflags'),
497 store => \$buildflags },
498 skiptest => { default => $conf->get_conf('skiptest'),
499 store => \$skiptest },
500 prereq_target => { default => '', store => \$prereq_target },
501 ### don't set the default format to 'build' -- that is wrong!
502 prereq_format => { #default => $self->status->installer_type,
504 store => \$prereq_format },
505 prereq_build => { default => 0, store => \$prereq_build },
508 $args = check( $tmpl, \%hash ) or return;
511 # restore the state as we have created this already.
512 if ( $dist->status->created && !$force ) {
513 ### add this directory to your lib ###
514 $self->add_to_includepath();
518 $dist->status->_create_args( $args );
520 ### is this dist prepared?
521 unless( $dist->status->prepared ) {
522 error( loc( "You have not successfully prepared a '%2' distribution ".
523 "yet -- cannot create yet", __PACKAGE__ ) );
527 ### chdir to work directory ###
529 unless( $cb->_chdir( dir => $dir ) ) {
530 error( loc( "Could not chdir to build directory '%1'", $dir ) );
534 ### by now we've loaded module::build, and we're using the API, so
535 ### it's safe to remove CPANPLUS::inc from our inc path, especially
536 ### because it can trip up tests run under taint (just like EU::MM).
537 ### turn off our PERL5OPT so no modules from CPANPLUS::inc get
538 ### included in make test -- it should build without.
539 ### also, modules that run in taint mode break if we leave
540 ### our code ref in perl5opt
541 ### XXX we've removed the ENV settings from cp::inc, so only need
542 ### to reset the @INC
543 #local $ENV{PERL5OPT} = CPANPLUS::inc->original_perl5opt;
544 #local $ENV{PERL5LIB} = CPANPLUS::inc->original_perl5lib;
545 #local @INC = CPANPLUS::inc->original_inc;
547 ### but do it *before* the new_from_context, as M::B seems
548 ### to be actually running the file...
549 ### an unshift in the block seems to be ignored.. somehow...
550 #{ my $lib = $self->best_path_to_module_build;
551 # unshift @INC, $lib if $lib;
553 unshift @INC, $self->best_path_to_module_build
554 if $self->best_path_to_module_build;
556 ### this will generate warnings under anything lower than M::B 0.2606
557 my @buildflags = $dist->_buildflags_as_list( $buildflags );
558 $dist->status->_buildflags( $buildflags );
560 my $fail; my $prereq_fail; my $test_fail;
563 my $run_perl = $conf->get_program('perlwrapper');
565 ### this will set the directory back to the start
566 ### dir, so we must chdir /again/
567 my $ok = $dist->_resolve_prereqs(
569 format => $prereq_format,
571 prereqs => $self->status->prereqs,
572 target => $prereq_target,
573 prereq_build => $prereq_build,
576 unless( $cb->_chdir( dir => $dir ) ) {
577 error( loc( "Could not chdir to build directory '%1'", $dir ) );
582 #### use $dist->flush to reset the cache ###
583 error( loc( "Unable to satisfy prerequisites for '%1' " .
584 "-- aborting install", $self->module ) );
585 $dist->status->build(0);
586 $fail++; $prereq_fail++;
590 my ($captured, $cmd);
592 $cmd = [$perl, BUILD->($dir), @buildflags];
595 $cmd = [$perl, $run_perl, BUILD->($dir), @buildflags];
598 unless ( scalar run( command => $cmd,
599 buffer => \$captured,
600 verbose => $verbose )
602 error( loc( "MAKE failed:\n%1", $captured ) );
603 $dist->status->build(0);
609 $dist->status->build(1);
611 ### add this directory to your lib ###
612 $self->add_to_includepath();
614 ### this buffer will not include what tests failed due to a
615 ### M::B/Test::Harness bug. Reported as #9793 with patch
616 ### against 0.2607 on 26/1/2005
617 unless( $skiptest ) {
620 $cmd = [$perl, BUILD->($dir), "test", @buildflags];
623 $cmd = [$perl, $run_perl, BUILD->($dir), "test", @buildflags];
625 unless ( scalar run( command => $cmd,
626 buffer => \$test_output,
627 verbose => $verbose )
629 error( loc( "MAKE TEST failed:\n%1 ", $test_output ) );
631 ### mark specifically *test* failure.. so we dont
632 ### send success on force...
635 if( !$force and !$cb->_callbacks->proceed_on_test_failure->(
638 $dist->status->test(0);
644 msg( loc( "MAKE TEST passed:\n%1", $test_output ), 0 );
645 #msg( $test_output, 0 );
646 $dist->status->test(1);
650 msg(loc("Tests skipped"), $verbose);
654 unless( $cb->_chdir( dir => $orig ) ) {
655 error( loc( "Could not chdir back to start dir '%1'", $orig ) );
658 ### send out test report? ###
659 if( $conf->get_conf('cpantest') and not $prereq_fail ) {
662 failed => $test_fail || $fail,
663 buffer => CPANPLUS::Error->stack_as_string,
666 tests_skipped => $skiptest,
667 ) or error(loc("Failed to send test report for '%1'",
671 return $dist->status->created( $fail ? 0 : 1 );
674 =head2 $dist->install([verbose => BOOL, perl => /path/to/perl])
676 Actually installs the created dist.
678 Returns true on success and false on failure.
683 ### just in case you already did a create call for this module object
684 ### just via a different dist object
686 my $self = $dist->parent;
688 ### we're also the cpan_dist, since we don't need to have anything
689 ### prepared from another installer
690 $dist = $self->status->dist_cpan if $self->status->dist_cpan;
692 my $cb = $self->parent;
693 my $conf = $cb->configure_object;
697 my $verbose; my $perl; my $force; my $buildflags;
698 { local $Params::Check::ALLOW_UNKNOWN = 1;
700 verbose => { default => $conf->get_conf('verbose'),
701 store => \$verbose },
702 force => { default => $conf->get_conf('force'),
704 buildflags => { default => $conf->get_conf('buildflags'),
705 store => \$buildflags },
706 perl => { default => $^X, store => \$perl },
709 my $args = check( $tmpl, \%hash ) or return;
710 $dist->status->_install_args( $args );
714 unless( $dir = $self->status->extract ) {
715 error( loc( "No dir found to operate on!" ) );
721 unless( $cb->_chdir( dir => $dir ) ) {
722 error( loc( "Could not chdir to build directory '%1'", $dir ) );
726 ### value set and false -- means failure ###
727 if( defined $self->status->installed &&
728 !$self->status->installed && !$force
730 error( loc( "Module '%1' has failed to install before this session " .
731 "-- aborting install", $self->module ) );
736 my @buildflags = $dist->_buildflags_as_list( $buildflags );
737 my $run_perl = $conf->get_program('perlwrapper');
739 ### hmm, how is this going to deal with sudo?
740 ### for now, check effective uid, if it's not root,
741 ### shell out, otherwise use the method
744 ### don't worry about loading the right version of M::B anymore
745 ### the 'new_from_context' already added the 'right' path to
746 ### M::B at the top of the build.pl
749 $cmd = [$perl, BUILD->($dir), "install", @buildflags];
752 $cmd = [$perl, $run_perl, BUILD->($dir), "install", @buildflags];
754 my $sudo = $conf->get_program('sudo');
755 unshift @$cmd, $sudo if $sudo;
759 unless( scalar run( command => $cmd,
761 verbose => $verbose )
763 error(loc("Could not run '%1': %2", 'Build install', $buffer));
767 my ($install_output, $cmd);
769 $cmd = [$perl, BUILD->($dir), "install", @buildflags];
772 $cmd = [$perl, $run_perl, BUILD->($dir), "install", @buildflags];
774 unless( scalar run( command => $cmd,
775 buffer => \$install_output,
776 verbose => $verbose )
778 error(loc("Could not run '%1': %2", 'Build install', $install_output));
782 msg( $install_output, 0 );
787 unless( $cb->_chdir( dir => $orig ) ) {
788 error( loc( "Could not chdir back to start dir '%1'", $orig ) );
791 return $dist->status->installed( $fail ? 0 : 1 );
794 ### returns the string 'foo=bar --zot quux'
795 ### as the list 'foo=bar', '--zot', 'qux'
796 sub _buildflags_as_list {
798 my $flags = shift or return;
800 return Module::Build->split_like_shell($flags);
805 Originally by Jos Boumans E<lt>kane@cpan.orgE<gt>. Brought to working
806 condition by Ken Williams E<lt>kwilliams@cpan.orgE<gt>.
808 Other hackery and currently maintained by Chris C<BinGOs> Williams ( no relation ). E<lt>bingos@cpan.orgE<gt>.
812 The CPAN++ interface (of which this module is a part of) is
813 copyright (c) 2001, 2002, 2003, 2004, 2005 Jos Boumans E<lt>kane@cpan.orgE<gt>.
816 This library is free software;
817 you may redistribute and/or modify it under the same
818 terms as Perl itself.
822 qq[Putting the Module::Build into CPANPLUS];
826 # c-indentation-style: bsd
828 # indent-tabs-mode: nil
830 # vim: expandtab shiftwidth=4: