2 # BEGIN BPS TAGGED BLOCK {{{
6 # This software is Copyright (c) 1996-2019 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.05
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
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( << '.') ];
276 $deps{'CLI'} = [ text_to_hash( << '.') ];
278 HTTP::Request::Common
285 $deps{'DEVELOPER'} = [ text_to_hash( << '.') ];
292 Plack::Middleware::Test::StashWarnings 0.08
294 String::ShellQuote 0 # needed for gnupg-incoming.t
295 Test::Builder 0.90 # needed for is_passing
296 Test::Deep 0 # needed for shredder tests
304 Test::WWW::Mechanize 1.30
305 Test::WWW::Mechanize::PSGI
310 $deps{'FASTCGI'} = [ text_to_hash( << '.') ];
315 $deps{'MODPERL1'} = [ text_to_hash( << '.') ];
319 $deps{'MYSQL'} = [ text_to_hash( << '.') ];
323 $deps{'ORACLE'} = [ text_to_hash( << '.') ];
327 $deps{'PG'} = [ text_to_hash( << '.') ];
328 DBIx::SearchBuilder 1.66
332 $deps{'SQLITE'} = [ text_to_hash( << '.') ];
336 $deps{'GPG'} = [ text_to_hash( << '.') ];
342 $deps{'SMIME'} = [ text_to_hash( << '.') ];
348 $deps{'ICAL'} = [ text_to_hash( << '.') ];
352 $deps{'DASHBOARDS'} = [ text_to_hash( << '.') ];
358 $deps{'GRAPHVIZ'} = [ text_to_hash( << '.') ];
363 $deps{'GD'} = [ text_to_hash( << '.') ];
369 $deps{'USERLOGO'} = [ text_to_hash( << '.') ];
373 $deps{'HTML-DOC'} = [ text_to_hash( <<'.') ];
379 'DBD::Oracle' => [qw(1.23)],
380 'Devel::StackTrace' => [qw(1.28 1.29)],
381 'DateTime::Locale' => [qw(1.00 1.01)],
382 'DBD::mysql' => [qw(4.042)],
385 if ($args{'download'}) {
390 check_perl_version();
394 my %Missing_By_Type = ();
395 foreach my $type (sort grep $args{$_}, keys %args) {
396 next unless ($type =~ /^with-(.*?)$/) and $deps{$1};
399 section("$type dependencies");
402 my @deps = @{ $deps{$type} };
404 my %missing = test_deps(@deps);
406 if ( $args{'install'} ) {
407 for my $module (keys %missing) {
408 resolve_dep($module, $missing{$module}{version});
409 my $m = $module . '.pm';
411 if ( delete $INC{$m} ) {
412 my $symtab = $module . '::';
414 for my $symbol ( keys %{$symtab} ) {
415 next if substr( $symbol, -2, 2 ) eq '::';
416 delete $symtab->{$symbol};
419 delete $missing{$module}
420 if test_dep($module, $missing{$module}{version}, $AVOID{$module});
424 $Missing_By_Type{$type} = \%missing if keys %missing;
427 if ( $args{'install'} && keys %Missing_By_Type ) {
428 exec($script_path, @orig_argv, '--no-install');
431 conclude(%Missing_By_Type);
439 my $module = shift @deps;
440 my $version = shift @deps;
441 my($test, $error) = test_dep($module, $version, $AVOID{$module});
442 my $msg = $module . ($version && !$error ? " >= $version" : '');
443 print_found($msg, $test, $error);
445 $missing{$module} = { version => $version, error => $error } unless $test;
456 if ( $args{'list-deps'} ) {
457 print $module, ': ', $version || 0, "\n";
460 no warnings 'deprecated';
461 eval "{ local \$ENV{__WARN__}; use $module $version () }";
462 if ( my $error = $@ ) {
463 return 0 unless wantarray;
465 $error =~ s/\n(.*)$//s;
466 $error =~ s/at \(eval \d+\) line \d+\.$//;
467 undef $error if $error =~ /this is only/;
471 undef $error if defined $error and $error =~ /^Can't locate $path\.pm in \@INC/;
473 return ( 0, $error );
477 my $version = $module->VERSION;
478 if ( grep $version eq $_, @$avoid ) {
479 return 0 unless wantarray;
480 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.");
492 unless (defined $args{siteinstall}) {
495 my @order = grep {($_ eq $Config::Config{sitelibexp}
496 or $_ eq $Config::Config{privlibexp})
497 and not $uniq{$_}++} @INC;
498 if ($] < 5.011 and @order == 2
499 and $order[0] eq $Config::Config{sitelibexp}
500 and $order[1] eq $Config::Config{privlibexp}) {
503 print "Patched perl, with site_perl before core in \@INC, detected.\n";
504 print "Installing dual-life modules into site_perl so they are not\n";
505 print "later overridden by the distribution's package.\n";
507 $args{siteinstall} = 1;
509 $args{siteinstall} = 0;
513 print "\nInstall module $module\n";
515 my $ext = $ENV{'RT_FIX_DEPS_CMD'} || $ENV{'PERL_PREFER_CPAN_CLIENT'};
520 if ( $ENV{'HOME'} ) {
521 unshift @INC, "$ENV{'HOME'}/.cpan";
523 $configured = eval { require CPAN::MyConfig } || eval { require CPAN::Config };
525 unless ( $configured ) {
527 You haven't configured the CPAN shell yet.
528 Please run `@PERL@ -MCPAN -e shell` to configure it.
533 my $installdirs = $CPAN::Config->{makepl_arg} ||= "";
534 $installdirs =~ s/(\bINSTALLDIRS=\S+|$)/ INSTALLDIRS=site/
535 if $args{siteinstall};
536 local $CPAN::Config->{makepl_arg} = $installdirs;
538 my $rv = eval { require CPAN; CPAN::Shell->install($module) };
539 return $rv unless $@;
542 Failed to load module CPAN.
544 -------- Error ---------
546 ------------------------
548 When we tried to start installing RT's perl dependencies,
549 we were unable to load the CPAN client. This module is usually distributed
550 with Perl. This usually indicates that your vendor has shipped an unconfigured
551 or incorrectly configured CPAN client.
552 The error above may (or may not) give you a hint about what went wrong
554 You have several choices about how to install dependencies in
557 1) use a different tool to install dependencies by running setting the following
558 shell environment variable and rerunning this tool:
559 RT_FIX_DEPS_CMD='@PERL@ -MCPAN -e"install %s"'
560 2) Attempt to configure CPAN by running:
561 `@PERL@ -MCPAN -e shell` program from shell.
562 If this fails, you may have to manually upgrade CPAN (see below)
563 3) Try to update the CPAN client. Download it from:
564 http://search.cpan.org/dist/CPAN and try again
565 4) Install each dependency manually by downloading them one by one from
566 http://search.cpan.org
573 $ext =~ s/\%s/$module/g; # sprintf( $ext, $module );
577 print "\t\tcommand: '$ext'\n";
578 return scalar `$ext 1>&2`;
581 sub check_perl_version {
583 eval {require 5.010_001};
585 print_found("5.10.1", 0, sprintf("RT requires Perl v5.10.1 or newer. Your current Perl is v%vd", $^V));
588 print_found( sprintf(">=5.10.1(%vd)", $^V), 1 );
594 print_found("rt group (@RTGROUP@)", defined getgrnam("@RTGROUP@"));
595 print_found("bin owner (@BIN_OWNER@)", defined getpwnam("@BIN_OWNER@"));
596 print_found("libs owner (@LIBS_OWNER@)", defined getpwnam("@LIBS_OWNER@"));
597 print_found("libs group (@LIBS_GROUP@)", defined getgrnam("@LIBS_GROUP@"));
598 print_found("web owner (@WEB_USER@)", defined getpwnam("@WEB_USER@"));
599 print_found("web group (@WEB_GROUP@)", defined getgrnam("@WEB_GROUP@"));
608 rt-test-dependencies - test rt's dependencies
613 rt-test-dependencies --install
614 rt-test-dependencies --with-mysql --with-fastcgi
618 by default, C<rt-test-dependencies> determines whether you have installed all
619 the perl modules RT needs to run.
621 the "RT_FIX_DEPS_CMD" environment variable, if set, will be used instead of
622 the standard CPAN shell by --install to install any required modules. it will
623 be called with the module name, or, if "RT_FIX_DEPS_CMD" contains a "%s", will
624 replace the "%s" with the module name before calling the program.
632 install missing modules
636 list the status of all dependencies, rather than just the missing ones.
638 -v is equal to --verbose
640 =item specify dependencies
646 database interface for mysql
650 database interface for postgresql
654 database interface for oracle
658 database interface and driver for sqlite (unsupported)
662 libraries needed to support the fastcgi handler
664 =item --with-modperl1
666 libraries needed to support the modperl 1 handler
668 =item --with-modperl2
670 libraries needed to support the modperl 2 handler
672 =item --with-developer
674 tools needed for RT development