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
244 Plack::Handler::Starlet
246 Regexp::Common::net::CIDR
251 Symbol::Global::Name 0.04
253 Text::Password::Pronounceable
256 Text::WikiFormat 0.76
264 set_dep( CORE => 'Symbol::Global::Name' => 0.05 ) if $] >= 5.019003;
265 set_dep( CORE => CGI => 4.00 ) if $] > 5.019003;
267 $deps{'MAILGATE'} = [ text_to_hash( << '.') ];
277 $deps{'CLI'} = [ text_to_hash( << '.') ];
279 HTTP::Request::Common
286 $deps{'DEVELOPER'} = [ text_to_hash( << '.') ];
293 Plack::Middleware::Test::StashWarnings 0.08
295 String::ShellQuote 0 # needed for gnupg-incoming.t
296 Test::Builder 0.90 # needed for is_passing
297 Test::Deep 0 # needed for shredder tests
305 Test::WWW::Mechanize 1.30
306 Test::WWW::Mechanize::PSGI
311 $deps{'FASTCGI'} = [ text_to_hash( << '.') ];
316 $deps{'MODPERL1'} = [ text_to_hash( << '.') ];
321 $deps{'MODPERL2'} = [ text_to_hash( << '.') ];
325 $deps{'MYSQL'} = [ text_to_hash( << '.') ];
329 $deps{'ORACLE'} = [ text_to_hash( << '.') ];
333 $deps{'PG'} = [ text_to_hash( << '.') ];
334 DBIx::SearchBuilder 1.66
338 $deps{'SQLITE'} = [ text_to_hash( << '.') ];
342 $deps{'GPG'} = [ text_to_hash( << '.') ];
348 $deps{'SMIME'} = [ text_to_hash( << '.') ];
354 $deps{'ICAL'} = [ text_to_hash( << '.') ];
358 $deps{'DASHBOARDS'} = [ text_to_hash( << '.') ];
364 $deps{'GRAPHVIZ'} = [ text_to_hash( << '.') ];
369 $deps{'GD'} = [ text_to_hash( << '.') ];
375 $deps{'USERLOGO'} = [ text_to_hash( << '.') ];
379 $deps{'HTML-DOC'} = [ text_to_hash( <<'.') ];
385 'DBD::Oracle' => [qw(1.23)],
386 'Devel::StackTrace' => [qw(1.28 1.29)],
389 if ($args{'download'}) {
394 check_perl_version();
398 my %Missing_By_Type = ();
399 foreach my $type (sort grep $args{$_}, keys %args) {
400 next unless ($type =~ /^with-(.*?)$/) and $deps{$1};
403 section("$type dependencies");
406 my @deps = @{ $deps{$type} };
408 my %missing = test_deps(@deps);
410 if ( $args{'install'} ) {
411 for my $module (keys %missing) {
412 resolve_dep($module, $missing{$module}{version});
413 my $m = $module . '.pm';
415 if ( delete $INC{$m} ) {
416 my $symtab = $module . '::';
418 for my $symbol ( keys %{$symtab} ) {
419 next if substr( $symbol, -2, 2 ) eq '::';
420 delete $symtab->{$symbol};
423 delete $missing{$module}
424 if test_dep($module, $missing{$module}{version}, $AVOID{$module});
428 $Missing_By_Type{$type} = \%missing if keys %missing;
431 if ( $args{'install'} && keys %Missing_By_Type ) {
432 exec($script_path, @orig_argv, '--no-install');
435 conclude(%Missing_By_Type);
443 my $module = shift @deps;
444 my $version = shift @deps;
445 my($test, $error) = test_dep($module, $version, $AVOID{$module});
446 my $msg = $module . ($version && !$error ? " >= $version" : '');
447 print_found($msg, $test, $error);
449 $missing{$module} = { version => $version, error => $error } unless $test;
460 if ( $args{'list-deps'} ) {
461 print $module, ': ', $version || 0, "\n";
464 no warnings 'deprecated';
465 eval "{ local \$ENV{__WARN__}; use $module $version () }";
466 if ( my $error = $@ ) {
467 return 0 unless wantarray;
469 $error =~ s/\n(.*)$//s;
470 $error =~ s/at \(eval \d+\) line \d+\.$//;
471 undef $error if $error =~ /this is only/;
475 undef $error if defined $error and $error =~ /^Can't locate $path\.pm in \@INC/;
477 return ( 0, $error );
481 my $version = $module->VERSION;
482 if ( grep $version eq $_, @$avoid ) {
483 return 0 unless wantarray;
484 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.");
496 unless (defined $args{siteinstall}) {
499 my @order = grep {($_ eq $Config::Config{sitelibexp}
500 or $_ eq $Config::Config{privlibexp})
501 and not $uniq{$_}++} @INC;
502 if ($] < 5.011 and @order == 2
503 and $order[0] eq $Config::Config{sitelibexp}
504 and $order[1] eq $Config::Config{privlibexp}) {
507 print "Patched perl, with site_perl before core in \@INC, detected.\n";
508 print "Installing dual-life modules into site_perl so they are not\n";
509 print "later overridden by the distribution's package.\n";
511 $args{siteinstall} = 1;
513 $args{siteinstall} = 0;
517 print "\nInstall module $module\n";
519 my $ext = $ENV{'RT_FIX_DEPS_CMD'} || $ENV{'PERL_PREFER_CPAN_CLIENT'};
524 if ( $ENV{'HOME'} ) {
525 unshift @INC, "$ENV{'HOME'}/.cpan";
527 $configured = eval { require CPAN::MyConfig } || eval { require CPAN::Config };
529 unless ( $configured ) {
531 You haven't configured the CPAN shell yet.
532 Please run `@PERL@ -MCPAN -e shell` to configure it.
537 my $installdirs = $CPAN::Config->{makepl_arg} ||= "";
538 $installdirs =~ s/(\bINSTALLDIRS=\S+|$)/ INSTALLDIRS=site/
539 if $args{siteinstall};
540 local $CPAN::Config->{makepl_arg} = $installdirs;
542 my $rv = eval { require CPAN; CPAN::Shell->install($module) };
543 return $rv unless $@;
546 Failed to load module CPAN.
548 -------- Error ---------
550 ------------------------
552 When we tried to start installing RT's perl dependencies,
553 we were unable to load the CPAN client. This module is usually distributed
554 with Perl. This usually indicates that your vendor has shipped an unconfigured
555 or incorrectly configured CPAN client.
556 The error above may (or may not) give you a hint about what went wrong
558 You have several choices about how to install dependencies in
561 1) use a different tool to install dependencies by running setting the following
562 shell environment variable and rerunning this tool:
563 RT_FIX_DEPS_CMD='@PERL@ -MCPAN -e"install %s"'
564 2) Attempt to configure CPAN by running:
565 `@PERL@ -MCPAN -e shell` program from shell.
566 If this fails, you may have to manually upgrade CPAN (see below)
567 3) Try to update the CPAN client. Download it from:
568 http://search.cpan.org/dist/CPAN and try again
569 4) Install each dependency manually by downloading them one by one from
570 http://search.cpan.org
577 $ext =~ s/\%s/$module/g; # sprintf( $ext, $module );
581 print "\t\tcommand: '$ext'\n";
582 return scalar `$ext 1>&2`;
585 sub check_perl_version {
587 eval {require 5.010_001};
589 print_found("5.10.1", 0, sprintf("RT requires Perl v5.10.1 or newer. Your current Perl is v%vd", $^V));
592 print_found( sprintf(">=5.10.1(%vd)", $^V), 1 );
598 print_found("rt group (@RTGROUP@)", defined getgrnam("@RTGROUP@"));
599 print_found("bin owner (@BIN_OWNER@)", defined getpwnam("@BIN_OWNER@"));
600 print_found("libs owner (@LIBS_OWNER@)", defined getpwnam("@LIBS_OWNER@"));
601 print_found("libs group (@LIBS_GROUP@)", defined getgrnam("@LIBS_GROUP@"));
602 print_found("web owner (@WEB_USER@)", defined getpwnam("@WEB_USER@"));
603 print_found("web group (@WEB_GROUP@)", defined getgrnam("@WEB_GROUP@"));
612 rt-test-dependencies - test rt's dependencies
617 rt-test-dependencies --install
618 rt-test-dependencies --with-mysql --with-fastcgi
622 by default, C<rt-test-dependencies> determines whether you have installed all
623 the perl modules RT needs to run.
625 the "RT_FIX_DEPS_CMD" environment variable, if set, will be used instead of
626 the standard CPAN shell by --install to install any required modules. it will
627 be called with the module name, or, if "RT_FIX_DEPS_CMD" contains a "%s", will
628 replace the "%s" with the module name before calling the program.
636 install missing modules
640 list the status of all dependencies, rather than just the missing ones.
642 -v is equal to --verbose
644 =item specify dependencies
650 database interface for mysql
654 database interface for postgresql
658 database interface for oracle
662 database interface and driver for sqlite (unsupported)
666 libraries needed to support the fastcgi handler
668 =item --with-modperl1
670 libraries needed to support the modperl 1 handler
672 =item --with-modperl2
674 libraries needed to support the modperl 2 handler
676 =item --with-developer
678 tools needed for RT development