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');
315 unless ( scalar run( command => [$perl, $run_perl, BUILD_PL->($dir), @buildflags],
316 buffer => \$prep_output,
317 verbose => $verbose )
319 error( loc( "Build.PL failed: %1", $prep_output ) );
323 msg( $prep_output, 0 );
325 my $prereqs = $self->status->prereqs;
327 $prereqs ||= $dist->_find_prereqs( verbose => $verbose,
330 buildflags => $buildflags );
334 ### send out test report? ###
335 if( $fail and $conf->get_conf('cpantest') ) {
339 buffer => CPANPLUS::Error->stack_as_string,
342 ) or error(loc("Failed to send test report for '%1'",
346 unless( $cb->_chdir( dir => $orig ) ) {
347 error( loc( "Could not chdir back to start dir '%1'", $orig ) );
350 ### save where we wrote this stuff -- same as extract dir in normal
351 ### installer circumstances
352 $dist->status->distdir( $self->status->extract );
354 return $dist->status->prepared( $fail ? 0 : 1 );
359 my $self = $dist->parent;
360 my $cb = $self->parent;
361 my $conf = $cb->configure_object;
364 my ($verbose, $dir, $buildflags, $perl);
366 verbose => { default => $conf->get_conf('verbose'), store => \$verbose },
367 dir => { default => $self->status->extract, store => \$dir },
368 perl => { default => $^X, store => \$perl },
369 buildflags => { default => $conf->get_conf('buildflags'),
370 store => \$buildflags },
373 my $args = check( $tmpl, \%hash ) or return;
377 my $safe_ver = version->new('0.31_03');
381 if ( version->new( $Module::Build::VERSION ) >= $safe_ver and ! ON_WIN32 ) {
382 my @buildflags = $dist->_buildflags_as_list( $buildflags );
384 # Use the new Build action 'prereq_data'
385 my $run_perl = $conf->get_program('perlwrapper');
386 my $flag = ON_VMS ? '"prereq_data"' : 'prereq_data';
388 unless ( scalar run( command => [$perl, $run_perl, BUILD->($dir), $flag, @buildflags],
392 error( loc( "Build 'prereq_data' failed: %1 %2", $!, $content ) );
398 my $file = File::Spec->catfile( $dir, '_build', 'prereqs' );
399 return unless -f $file;
401 my $fh = FileHandle->new();
403 unless( $fh->open( $file ) ) {
404 error( loc( "Cannot open '%1': %2", $file, $! ) );
408 $content = do { local $/; <$fh> };
411 return unless $content;
412 my $bphash = eval $content;
413 return unless $bphash and ref $bphash eq 'HASH';
414 foreach my $type ('requires', 'build_requires') {
415 next unless $bphash->{$type} and ref $bphash->{$type} eq 'HASH';
416 $prereqs->{$_} = $bphash->{$type}->{$_} for keys %{ $bphash->{$type} };
420 delete $prereqs->{'perl'};
422 ### allows for a user defined callback to filter the prerequisite
423 ### list as they see fit, to remove (or add) any prereqs they see
424 ### fit. The default installed callback will return the hashref in
425 ### an unmodified form
426 ### this callback got added after cpanplus 0.0562, so use a 'can'
427 ### to find out if it's supported. For older versions, we'll just
428 ### return the hashref as is ourselves.
429 my $href = $cb->_callbacks->can('filter_prereqs')
430 ? $cb->_callbacks->filter_prereqs->( $cb, $prereqs )
433 $self->status->prereqs( $href );
435 ### make sure it's not the same ref
441 =head2 $dist->create([perl => '/path/to/perl', buildflags => 'EXTRA=FLAGS', prereq_target => TARGET, force => BOOL, verbose => BOOL, skiptest => BOOL])
443 C<create> preps a distribution for installation. This means it will
444 run C<Build> and C<Build test>.
445 This will also satisfy any prerequisites the module may have.
447 If you set C<skiptest> to true, it will skip the C<Build test> stage.
448 If you set C<force> to true, it will go over all the stages of the
449 C<Build> process again, ignoring any previously cached results. It
450 will also ignore a bad return value from C<Build test> and still allow
451 the operation to return true.
453 Returns true on success and false on failure.
455 You may then call C<< $dist->install >> on the object to actually
461 ### just in case you already did a create call for this module object
462 ### just via a different dist object
464 my $self = $dist->parent;
466 ### we're also the cpan_dist, since we don't need to have anything
467 ### prepared from another installer
468 $dist = $self->status->dist_cpan if $self->status->dist_cpan;
469 $self->status->dist_cpan( $dist ) unless $self->status->dist_cpan;
471 my $cb = $self->parent;
472 my $conf = $cb->configure_object;
476 unless( $dir = $self->status->extract ) {
477 error( loc( "No dir found to operate on!" ) );
482 my( $force, $verbose, $buildflags, $skiptest, $prereq_target,
483 $perl, $prereq_format, $prereq_build);
484 { local $Params::Check::ALLOW_UNKNOWN = 1;
486 force => { default => $conf->get_conf('force'),
488 verbose => { default => $conf->get_conf('verbose'),
489 store => \$verbose },
490 perl => { default => $^X, store => \$perl },
491 buildflags => { default => $conf->get_conf('buildflags'),
492 store => \$buildflags },
493 skiptest => { default => $conf->get_conf('skiptest'),
494 store => \$skiptest },
495 prereq_target => { default => '', store => \$prereq_target },
496 ### don't set the default format to 'build' -- that is wrong!
497 prereq_format => { #default => $self->status->installer_type,
499 store => \$prereq_format },
500 prereq_build => { default => 0, store => \$prereq_build },
503 $args = check( $tmpl, \%hash ) or return;
506 # restore the state as we have created this already.
507 if ( $dist->status->created && !$force ) {
508 ### add this directory to your lib ###
509 $self->add_to_includepath();
513 $dist->status->_create_args( $args );
515 ### is this dist prepared?
516 unless( $dist->status->prepared ) {
517 error( loc( "You have not successfully prepared a '%2' distribution ".
518 "yet -- cannot create yet", __PACKAGE__ ) );
522 ### chdir to work directory ###
524 unless( $cb->_chdir( dir => $dir ) ) {
525 error( loc( "Could not chdir to build directory '%1'", $dir ) );
529 ### by now we've loaded module::build, and we're using the API, so
530 ### it's safe to remove CPANPLUS::inc from our inc path, especially
531 ### because it can trip up tests run under taint (just like EU::MM).
532 ### turn off our PERL5OPT so no modules from CPANPLUS::inc get
533 ### included in make test -- it should build without.
534 ### also, modules that run in taint mode break if we leave
535 ### our code ref in perl5opt
536 ### XXX we've removed the ENV settings from cp::inc, so only need
537 ### to reset the @INC
538 #local $ENV{PERL5OPT} = CPANPLUS::inc->original_perl5opt;
539 #local $ENV{PERL5LIB} = CPANPLUS::inc->original_perl5lib;
540 #local @INC = CPANPLUS::inc->original_inc;
542 ### but do it *before* the new_from_context, as M::B seems
543 ### to be actually running the file...
544 ### an unshift in the block seems to be ignored.. somehow...
545 #{ my $lib = $self->best_path_to_module_build;
546 # unshift @INC, $lib if $lib;
548 unshift @INC, $self->best_path_to_module_build
549 if $self->best_path_to_module_build;
551 ### this will generate warnings under anything lower than M::B 0.2606
552 my @buildflags = $dist->_buildflags_as_list( $buildflags );
553 $dist->status->_buildflags( $buildflags );
555 my $fail; my $prereq_fail; my $test_fail;
558 my $run_perl = $conf->get_program('perlwrapper');
560 ### this will set the directory back to the start
561 ### dir, so we must chdir /again/
562 my $ok = $dist->_resolve_prereqs(
564 format => $prereq_format,
566 prereqs => $self->status->prereqs,
567 target => $prereq_target,
568 prereq_build => $prereq_build,
571 unless( $cb->_chdir( dir => $dir ) ) {
572 error( loc( "Could not chdir to build directory '%1'", $dir ) );
577 #### use $dist->flush to reset the cache ###
578 error( loc( "Unable to satisfy prerequisites for '%1' " .
579 "-- aborting install", $self->module ) );
580 $dist->status->build(0);
581 $fail++; $prereq_fail++;
587 unless ( scalar run( command => [$perl, $run_perl, BUILD->($dir), @buildflags],
588 buffer => \$captured,
589 verbose => $verbose )
591 error( loc( "MAKE failed:\n%1", $captured ) );
592 $dist->status->build(0);
598 $dist->status->build(1);
600 ### add this directory to your lib ###
601 $self->add_to_includepath();
603 ### this buffer will not include what tests failed due to a
604 ### M::B/Test::Harness bug. Reported as #9793 with patch
605 ### against 0.2607 on 26/1/2005
606 unless( $skiptest ) {
608 my $flag = ON_VMS ? '"test"' : 'test';
609 my $cmd = [$perl, $run_perl, BUILD->($dir), $flag, @buildflags];
610 unless ( scalar run( command => $cmd,
611 buffer => \$test_output,
612 verbose => $verbose )
614 error( loc( "MAKE TEST failed:\n%1 ", $test_output ) );
616 ### mark specifically *test* failure.. so we dont
617 ### send success on force...
620 if( !$force and !$cb->_callbacks->proceed_on_test_failure->(
623 $dist->status->test(0);
629 msg( $test_output, 0 );
630 $dist->status->test(1);
634 msg(loc("Tests skipped"), $verbose);
638 unless( $cb->_chdir( dir => $orig ) ) {
639 error( loc( "Could not chdir back to start dir '%1'", $orig ) );
642 ### send out test report? ###
643 if( $conf->get_conf('cpantest') and not $prereq_fail ) {
646 failed => $test_fail || $fail,
647 buffer => CPANPLUS::Error->stack_as_string,
650 tests_skipped => $skiptest,
651 ) or error(loc("Failed to send test report for '%1'",
655 return $dist->status->created( $fail ? 0 : 1 );
658 =head2 $dist->install([verbose => BOOL, perl => /path/to/perl])
660 Actually installs the created dist.
662 Returns true on success and false on failure.
667 ### just in case you already did a create call for this module object
668 ### just via a different dist object
670 my $self = $dist->parent;
672 ### we're also the cpan_dist, since we don't need to have anything
673 ### prepared from another installer
674 $dist = $self->status->dist_cpan if $self->status->dist_cpan;
676 my $cb = $self->parent;
677 my $conf = $cb->configure_object;
681 my $verbose; my $perl; my $force;
682 { local $Params::Check::ALLOW_UNKNOWN = 1;
684 verbose => { default => $conf->get_conf('verbose'),
685 store => \$verbose },
686 force => { default => $conf->get_conf('force'),
688 perl => { default => $^X, store => \$perl },
691 my $args = check( $tmpl, \%hash ) or return;
692 $dist->status->_install_args( $args );
696 unless( $dir = $self->status->extract ) {
697 error( loc( "No dir found to operate on!" ) );
703 unless( $cb->_chdir( dir => $dir ) ) {
704 error( loc( "Could not chdir to build directory '%1'", $dir ) );
708 ### value set and false -- means failure ###
709 if( defined $self->status->installed &&
710 !$self->status->installed && !$force
712 error( loc( "Module '%1' has failed to install before this session " .
713 "-- aborting install", $self->module ) );
718 my @buildflags = $dist->_buildflags_as_list( $dist->status->_buildflags );
719 my $run_perl = $conf->get_program('perlwrapper');
721 ### hmm, how is this going to deal with sudo?
722 ### for now, check effective uid, if it's not root,
723 ### shell out, otherwise use the method
726 ### don't worry about loading the right version of M::B anymore
727 ### the 'new_from_context' already added the 'right' path to
728 ### M::B at the top of the build.pl
729 ### On VMS, flags need to be quoted
730 my $flag = ON_VMS ? '"install"' : 'install';
731 my $cmd = [$perl, $run_perl, BUILD->($dir), $flag, @buildflags];
732 my $sudo = $conf->get_program('sudo');
733 unshift @$cmd, $sudo if $sudo;
737 unless( scalar run( command => $cmd,
739 verbose => $verbose )
741 error(loc("Could not run '%1': %2", 'Build install', $buffer));
746 my $flag = ON_VMS ? '"install"' : 'install';
747 my $cmd = [$perl, $run_perl, BUILD->($dir), $flag, @buildflags];
748 unless( scalar run( command => $cmd,
749 buffer => \$install_output,
750 verbose => $verbose )
752 error(loc("Could not run '%1': %2", 'Build install', $install_output));
756 msg( $install_output, 0 );
761 unless( $cb->_chdir( dir => $orig ) ) {
762 error( loc( "Could not chdir back to start dir '%1'", $orig ) );
765 return $dist->status->installed( $fail ? 0 : 1 );
768 ### returns the string 'foo=bar --zot quux'
769 ### as the list 'foo=bar', '--zot', 'qux'
770 sub _buildflags_as_list {
772 my $flags = shift or return;
774 return Module::Build->split_like_shell($flags);
779 Originally by Jos Boumans E<lt>kane@cpan.orgE<gt>. Brought to working
780 condition by Ken Williams E<lt>kwilliams@cpan.orgE<gt>.
782 Other hackery and currently maintained by Chris C<BinGOs> Williams ( no relation ). E<lt>bingos@cpan.orgE<gt>.
786 The CPAN++ interface (of which this module is a part of) is
787 copyright (c) 2001, 2002, 2003, 2004, 2005 Jos Boumans E<lt>kane@cpan.orgE<gt>.
790 This library is free software;
791 you may redistribute and/or modify it under the same
792 terms as Perl itself.
800 # c-indentation-style: bsd
802 # indent-tabs-mode: nil
804 # vim: expandtab shiftwidth=4: