2 # BEGIN BPS TAGGED BLOCK {{{
6 # This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
7 # <sales@bestpractical.com>
9 # (Except where explicitly superseded by other copyright notices)
14 # This work is made available to you under the terms of Version 2 of
15 # the GNU General Public License. A copy of that license should have
16 # been provided with this software, but in any event can be snarfed
19 # This work is distributed in the hope that it will be useful, but
20 # WITHOUT ANY WARRANTY; without even the implied warranty of
21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 # General Public License for more details.
24 # You should have received a copy of the GNU General Public License
25 # along with this program; if not, write to the Free Software
26 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
27 # 02110-1301 or visit their web page on the internet at
28 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
31 # CONTRIBUTION SUBMISSION POLICY:
33 # (The following paragraph is not intended to limit the rights granted
34 # to you to modify and distribute this software under the terms of
35 # the GNU General Public License and is only of importance to you if
36 # you choose to contribute your changes and enhancements to the
37 # community by submitting them to Best Practical Solutions, LLC.)
39 # By intentionally submitting any modifications, corrections or
40 # derivatives to this work, or any other work intended for use with
41 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
42 # you are the copyright holder for those contributions and you grant
43 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
44 # royalty-free, perpetual, license to use, copy, create derivative
45 # works based on those contributions, and sublicense and distribute
46 # those contributions and any derivatives thereof.
48 # END BPS TAGGED BLOCK }}}
50 # This is just a basic script that checks to make sure that all
51 # the modules needed by RT before you can install it.
56 no warnings qw(numeric redefine);
61 my @orig_argv = @ARGV;
62 # Save our path because installers or tests can change cwd
63 my $script_path = abs_path($0);
68 'with-MYSQL', 'with-PG', 'with-SQLITE', 'with-ORACLE',
69 'with-FASTCGI', 'with-MODPERL1', 'with-MODPERL2', 'with-STANDALONE',
88 Pod::Usage::pod2usage( { verbose => 2 } );
99 'with-DEVELOPER' => @RT_DEVELOPER@,
100 'with-GPG' => @RT_GPG_DEPS@,
101 'with-SMIME' => @RT_SMIME_DEPS@,
104 'with-GRAPHVIZ' => @RT_GRAPHVIZ@,
105 'with-GD' => @RT_GD@,
106 'with-DASHBOARDS' => 1,
107 'with-USERLOGO' => 1,
108 'with-HTML-DOC' => @RT_DEVELOPER@,
110 $args{$_} = $default{$_} foreach grep !exists $args{$_}, keys %default;
114 my %always_show_sections = (
122 print "$s:\n" unless $args{'list-deps'};
130 unless ( $args{'list-deps'} ) {
131 if ( $args{'v'} or not $test or $always_show_sections{$section} ) {
133 print $test ? "found" : "MISSING";
137 print "\t\t$extra\n" if defined $extra;
143 my %missing_by_type = @_;
145 unless ( $args{'list-deps'} ) {
146 unless ( keys %missing_by_type ) {
147 print "\nAll dependencies have been found.\n";
151 print "\nSOME DEPENDENCIES WERE MISSING.\n";
153 for my $type ( keys %missing_by_type ) {
154 my $missing = $missing_by_type{$type};
156 print "$type missing dependencies:\n";
157 for my $name ( keys %$missing ) {
158 my $module = $missing->{$name};
159 my $version = $module->{version};
160 my $error = $module->{error};
161 print_found( $name . ( $version && !$error ? " >= $version" : "" ),
162 0, $module->{error} );
166 print "\nPerl library path for @PERL@:\n";
167 print " $_\n" for @INC;
175 for my $line ( split /\n/, $_[0] ) {
176 my($key, $value) = $line =~ /(\S+)\s*(\S*)/;
178 $hash{$key} = $value;
184 my ($name, $module, $version) = @_;
185 my %list = @{$deps{$name}};
186 $list{$module} = ($version || '');
187 $deps{$name} = [ %list ];
190 $deps{'CORE'} = [ text_to_hash( << '.') ];
196 Class::Accessor::Fast
203 DateTime::Format::Natural 0.67
204 DateTime::Locale 0.40
206 DBIx::SearchBuilder 1.65
207 Devel::GlobalDestruction
208 Devel::StackTrace 1.19
213 Email::Address::List 0.02
221 HTML::FormatText::WithLinks 0.14
222 HTML::FormatText::WithLinks::AndTables
224 HTML::Mason::PSGIHandler 0.52
226 HTML::RewriteAttributes 0.05
233 Locale::Maketext 1.06
234 Locale::Maketext::Fuzzy 0.11
235 Locale::Maketext::Lexicon 0.32
241 Module::Versions::Report 1.05
245 Regexp::Common::net::CIDR
250 Symbol::Global::Name 0.04
252 Text::Password::Pronounceable
255 Text::WikiFormat 0.76
263 set_dep( CORE => 'Symbol::Global::Name' => 0.05 ) if $] >= 5.019003;
264 set_dep( CORE => CGI => 4.00 ) if $] > 5.019003;
266 $deps{'MAILGATE'} = [ text_to_hash( << '.') ];
275 $deps{'CLI'} = [ text_to_hash( << '.') ];
277 HTTP::Request::Common
284 $deps{'DEVELOPER'} = [ text_to_hash( << '.') ];
291 Plack::Middleware::Test::StashWarnings 0.08
293 String::ShellQuote 0 # needed for gnupg-incoming.t
294 Test::Builder 0.90 # needed for is_passing
295 Test::Deep 0 # needed for shredder tests
303 Test::WWW::Mechanize 1.30
304 Test::WWW::Mechanize::PSGI
309 $deps{'FASTCGI'} = [ text_to_hash( << '.') ];
314 $deps{'MODPERL1'} = [ text_to_hash( << '.') ];
319 $deps{'MODPERL2'} = [ text_to_hash( << '.') ];
323 $deps{'MYSQL'} = [ text_to_hash( << '.') ];
327 $deps{'ORACLE'} = [ text_to_hash( << '.') ];
331 $deps{'PG'} = [ text_to_hash( << '.') ];
332 DBIx::SearchBuilder 1.66
336 $deps{'SQLITE'} = [ text_to_hash( << '.') ];
340 $deps{'GPG'} = [ text_to_hash( << '.') ];
346 $deps{'SMIME'} = [ text_to_hash( << '.') ];
352 $deps{'ICAL'} = [ text_to_hash( << '.') ];
356 $deps{'DASHBOARDS'} = [ text_to_hash( << '.') ];
362 $deps{'GRAPHVIZ'} = [ text_to_hash( << '.') ];
367 $deps{'GD'} = [ text_to_hash( << '.') ];
373 $deps{'USERLOGO'} = [ text_to_hash( << '.') ];
377 $deps{'HTML-DOC'} = [ text_to_hash( <<'.') ];
383 'DBD::Oracle' => [qw(1.23)],
384 'Devel::StackTrace' => [qw(1.28 1.29)],
387 if ($args{'download'}) {
392 check_perl_version();
396 my %Missing_By_Type = ();
397 foreach my $type (sort grep $args{$_}, keys %args) {
398 next unless ($type =~ /^with-(.*?)$/) and $deps{$1};
401 section("$type dependencies");
404 my @deps = @{ $deps{$type} };
406 my %missing = test_deps(@deps);
408 if ( $args{'install'} ) {
409 for my $module (keys %missing) {
410 resolve_dep($module, $missing{$module}{version});
411 my $m = $module . '.pm';
413 if ( delete $INC{$m} ) {
414 my $symtab = $module . '::';
416 for my $symbol ( keys %{$symtab} ) {
417 next if substr( $symbol, -2, 2 ) eq '::';
418 delete $symtab->{$symbol};
421 delete $missing{$module}
422 if test_dep($module, $missing{$module}{version}, $AVOID{$module});
426 $Missing_By_Type{$type} = \%missing if keys %missing;
429 if ( $args{'install'} && keys %Missing_By_Type ) {
430 exec($script_path, @orig_argv, '--no-install');
433 conclude(%Missing_By_Type);
441 my $module = shift @deps;
442 my $version = shift @deps;
443 my($test, $error) = test_dep($module, $version, $AVOID{$module});
444 my $msg = $module . ($version && !$error ? " >= $version" : '');
445 print_found($msg, $test, $error);
447 $missing{$module} = { version => $version, error => $error } unless $test;
458 if ( $args{'list-deps'} ) {
459 print $module, ': ', $version || 0, "\n";
462 no warnings 'deprecated';
463 eval "{ local \$ENV{__WARN__}; use $module $version () }";
464 if ( my $error = $@ ) {
465 return 0 unless wantarray;
467 $error =~ s/\n(.*)$//s;
468 $error =~ s/at \(eval \d+\) line \d+\.$//;
469 undef $error if $error =~ /this is only/;
473 undef $error if defined $error and $error =~ /^Can't locate $path\.pm in \@INC/;
475 return ( 0, $error );
479 my $version = $module->VERSION;
480 if ( grep $version eq $_, @$avoid ) {
481 return 0 unless wantarray;
482 return (0, "It's known that there are problems with RT and version '$version' of '$module' module. If it's the latest available version of the module then you have to downgrade manually.");
494 unless (defined $args{siteinstall}) {
497 my @order = grep {($_ eq $Config::Config{sitelibexp}
498 or $_ eq $Config::Config{privlibexp})
499 and not $uniq{$_}++} @INC;
500 if ($] < 5.011 and @order == 2
501 and $order[0] eq $Config::Config{sitelibexp}
502 and $order[1] eq $Config::Config{privlibexp}) {
505 print "Patched perl, with site_perl before core in \@INC, detected.\n";
506 print "Installing dual-life modules into site_perl so they are not\n";
507 print "later overridden by the distribution's package.\n";
509 $args{siteinstall} = 1;
511 $args{siteinstall} = 0;
515 print "\nInstall module $module\n";
517 my $ext = $ENV{'RT_FIX_DEPS_CMD'} || $ENV{'PERL_PREFER_CPAN_CLIENT'};
522 if ( $ENV{'HOME'} ) {
523 unshift @INC, "$ENV{'HOME'}/.cpan";
525 $configured = eval { require CPAN::MyConfig } || eval { require CPAN::Config };
527 unless ( $configured ) {
529 You haven't configured the CPAN shell yet.
530 Please run `@PERL@ -MCPAN -e shell` to configure it.
535 my $installdirs = $CPAN::Config->{makepl_arg} ||= "";
536 $installdirs =~ s/(\bINSTALLDIRS=\S+|$)/ INSTALLDIRS=site/
537 if $args{siteinstall};
538 local $CPAN::Config->{makepl_arg} = $installdirs;
540 my $rv = eval { require CPAN; CPAN::Shell->install($module) };
541 return $rv unless $@;
544 Failed to load module CPAN.
546 -------- Error ---------
548 ------------------------
550 When we tried to start installing RT's perl dependencies,
551 we were unable to load the CPAN client. This module is usually distributed
552 with Perl. This usually indicates that your vendor has shipped an unconfigured
553 or incorrectly configured CPAN client.
554 The error above may (or may not) give you a hint about what went wrong
556 You have several choices about how to install dependencies in
559 1) use a different tool to install dependencies by running setting the following
560 shell environment variable and rerunning this tool:
561 RT_FIX_DEPS_CMD='@PERL@ -MCPAN -e"install %s"'
562 2) Attempt to configure CPAN by running:
563 `@PERL@ -MCPAN -e shell` program from shell.
564 If this fails, you may have to manually upgrade CPAN (see below)
565 3) Try to update the CPAN client. Download it from:
566 http://search.cpan.org/dist/CPAN and try again
567 4) Install each dependency manually by downloading them one by one from
568 http://search.cpan.org
575 $ext =~ s/\%s/$module/g; # sprintf( $ext, $module );
579 print "\t\tcommand: '$ext'\n";
580 return scalar `$ext 1>&2`;
583 sub check_perl_version {
585 eval {require 5.010_001};
587 print_found("5.10.1", 0, sprintf("RT requires Perl v5.10.1 or newer. Your current Perl is v%vd", $^V));
590 print_found( sprintf(">=5.10.1(%vd)", $^V), 1 );
596 print_found("rt group (@RTGROUP@)", defined getgrnam("@RTGROUP@"));
597 print_found("bin owner (@BIN_OWNER@)", defined getpwnam("@BIN_OWNER@"));
598 print_found("libs owner (@LIBS_OWNER@)", defined getpwnam("@LIBS_OWNER@"));
599 print_found("libs group (@LIBS_GROUP@)", defined getgrnam("@LIBS_GROUP@"));
600 print_found("web owner (@WEB_USER@)", defined getpwnam("@WEB_USER@"));
601 print_found("web group (@WEB_GROUP@)", defined getgrnam("@WEB_GROUP@"));
610 rt-test-dependencies - test rt's dependencies
615 rt-test-dependencies --install
616 rt-test-dependencies --with-mysql --with-fastcgi
620 by default, C<rt-test-dependencies> determines whether you have installed all
621 the perl modules RT needs to run.
623 the "RT_FIX_DEPS_CMD" environment variable, if set, will be used instead of
624 the standard CPAN shell by --install to install any required modules. it will
625 be called with the module name, or, if "RT_FIX_DEPS_CMD" contains a "%s", will
626 replace the "%s" with the module name before calling the program.
634 install missing modules
638 list the status of all dependencies, rather than just the missing ones.
640 -v is equal to --verbose
642 =item specify dependencies
648 database interface for mysql
652 database interface for postgresql
656 database interface for oracle
660 database interface and driver for sqlite (unsupported)
664 libraries needed to support the fastcgi handler
666 =item --with-modperl1
668 libraries needed to support the modperl 1 handler
670 =item --with-modperl2
672 libraries needed to support the modperl 2 handler
674 =item --with-developer
676 tools needed for RT development