2 # BEGIN BPS TAGGED BLOCK {{{
6 # This software is Copyright (c) 1996-2013 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.
55 no warnings qw(numeric redefine);
61 'install', 'with-MYSQL',
62 'with-POSTGRESQL|with-pg|with-pgsql', 'with-SQLITE',
63 'with-ORACLE', 'with-FASTCGI', 'with-FASTCGI-SERVER',
64 'with-SPEEDYCGI', 'with-MODPERL1',
65 'with-MODPERL2', 'with-DEV',
91 'with-DEV' => @RT_DEVEL_MODE@,
92 'with-STANDALONE' => 1,
93 'with-GPG' => @RT_GPG@,
96 'with-GRAPHVIZ' => @RT_GRAPHVIZ@,
98 'with-DASHBOARDS' => 1
100 $args{$_} = $default{$_} foreach grep !exists $args{$_}, keys %default;
104 my %always_show_sections = (
112 print "$s:\n" unless $args{'list-deps'};
120 unless ( $args{'list-deps'} ) {
121 if ( $args{'v'} or not $test or $always_show_sections{$section} ) {
123 print $test ? "found" : "MISSING";
127 print "\t\t$extra\n" if defined $extra;
133 my %missing_by_type = @_;
135 unless ( $args{'list-deps'} ) {
136 unless ( keys %missing_by_type ) {
137 print "\nAll dependencies have been found.\n";
141 print "\nSOME DEPENDENCIES WERE MISSING.\n";
143 for my $type ( keys %missing_by_type ) {
144 my $missing = $missing_by_type{$type};
146 print "$type missing dependencies:\n";
147 for my $name ( keys %$missing ) {
148 my $module = $missing->{$name};
149 my $version = $module->{version};
150 my $error = $module->{error};
151 print_found( $name . ( $version && !$error ? " >= $version" : "" ),
152 0, $module->{error} );
164 By default, testdeps determine whether you have
165 installed all the perl modules RT needs to run.
167 --install Install missing modules
169 The following switches will tell the tool to check for specific dependencies
171 --with-mysql Database interface for MySQL
172 --with-postgresql Database interface for PostgreSQL
173 --with-oracle Database interface for Oracle
174 --with-sqlite Database interface and driver for SQLite (unsupported)
176 --with-standalone Libraries needed to support the standalone simple pure perl server
177 --with-fastcgi-server Libraries needed to support the external fastcgi server
178 --with-fastcgi Libraries needed to support the fastcgi handler
179 --with-speedycgi Libraries needed to support the speedycgi handler
180 --with-modperl1 Libraries needed to support the modperl 1 handler
181 --with-modperl2 Libraries needed to support the modperl 2 handler
183 --with-dev Tools needed for RT development
185 You can also specify -v or --verbose to list the status of all dependencies,
186 rather than just the missing ones.
188 The "RT_FIX_DEPS_CMD" environment variable, if set, will be used
189 instead of the standard CPAN shell by --install to install any
190 required modules. It will be called with the module name, or, if
191 "RT_FIX_DEPS_CMD" contains a "%s", will replace the "%s" with the
192 module name before calling the program.
199 for my $line ( split /\n/, $_[0] ) {
200 my($key, $value) = $line =~ /(\S+)\s*(\S*)/;
202 $hash{$key} = $value;
208 $deps{'CORE'} = [ text_to_hash( << '.') ];
213 Class::ReturnValue 0.40
214 DBIx::SearchBuilder 1.54
222 Locale::Maketext 1.06
223 Locale::Maketext::Lexicon 0.32
224 Locale::Maketext::Fuzzy
237 Module::Versions::Report 1.05
238 Cache::Simple::TimedExpiry
243 Devel::StackTrace 1.19
246 $deps{'MASON'} = [ text_to_hash( << '.') ];
254 Text::WikiFormat 0.76
256 Devel::StackTrace 1.19
259 $deps{'STANDALONE'} = [ text_to_hash( << '.') ];
260 HTTP::Server::Simple 0.34
261 HTTP::Server::Simple::Mason 0.14
265 $deps{'MAILGATE'} = [ text_to_hash( << '.') ];
273 $deps{'CLI'} = [ text_to_hash( << '.') ];
276 HTTP::Request::Common
282 $deps{'DEV'} = [ text_to_hash( << '.') ];
286 Test::WWW::Mechanize 1.04
291 Test::Deep 0 # needed for shredder tests
292 String::ShellQuote 0 # needed for gnupg-incoming.t
293 Test::HTTP::Server::Simple 0.09
294 Test::HTTP::Server::Simple::StashWarnings 0.02
297 Test::Builder 0.77 # needed to fix TODO test
300 HTTP::Server::Simple::Mason 0.13
304 $deps{'FASTCGI'} = [ text_to_hash( << '.') ];
310 $deps{'FASTCGI-SERVER'} = [ text_to_hash( << '.') ];
320 $deps{'SPEEDYCGI'} = [ text_to_hash( << '.') ];
326 $deps{'MODPERL1'} = [ text_to_hash( << '.') ];
332 $deps{'MODPERL2'} = [ text_to_hash( << '.') ];
338 $deps{'MYSQL'} = [ text_to_hash( << '.') ];
342 $deps{'ORACLE'} = [ text_to_hash( << '.') ];
346 $deps{'POSTGRESQL'} = [ text_to_hash( << '.') ];
350 $deps{'SQLITE'} = [ text_to_hash( << '.') ];
354 $deps{'GPG'} = [ text_to_hash( << '.') ];
359 $deps{'ICAL'} = [ text_to_hash( << '.') ];
363 $deps{'SMTP'} = [ text_to_hash( << '.') ];
367 $deps{'DASHBOARDS'} = [ text_to_hash( << '.') ];
368 HTML::RewriteAttributes 0.02
372 $deps{'GRAPHVIZ'} = [ text_to_hash( << '.') ];
375 IPC::Run::SafeHandles
378 $deps{'GD'} = [ text_to_hash( << '.') ];
385 'DBD::Oracle' => [qw(1.23)],
388 if ($args{'download'}) {
393 check_perl_version();
397 my %Missing_By_Type = ();
398 foreach my $type (sort grep $args{$_}, keys %args) {
399 next unless ($type =~ /^with-(.*?)$/);
402 section("$type dependencies");
405 my @deps = @{ $deps{$type} };
407 my %missing = test_deps(@deps);
409 if ( $args{'install'} ) {
410 for my $module (keys %missing) {
411 resolve_dep($module, $missing{$module}{version});
412 delete $missing{$module}
413 if test_dep($module, $missing{$module}{version}, $AVOID{$module});
417 $Missing_By_Type{$type} = \%missing if keys %missing;
420 conclude(%Missing_By_Type);
427 my $module = shift @deps;
428 my $version = shift @deps;
429 my($test, $error) = test_dep($module, $version, $AVOID{$module});
430 my $msg = $module . ($version && !$error ? " >= $version" : '');
431 print_found($msg, $test, $error);
433 $missing{$module} = { version => $version, error => $error } unless $test;
444 if ( $args{'list-deps'} ) {
445 print $module, ': ', $version || 0, "\n";
448 eval "use $module $version ()";
449 if ( my $error = $@ ) {
450 return 0 unless wantarray;
452 $error =~ s/\n(.*)$//s;
453 $error =~ s/at \(eval \d+\) line \d+\.$//;
454 undef $error if $error =~ /this is only/;
456 return ( 0, $error );
460 my $version = $module->VERSION;
461 if ( grep $version eq $_, @$avoid ) {
462 return 0 unless wantarray;
463 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.");
475 print "\nInstall module $module\n";
477 my $ext = $ENV{'RT_FIX_DEPS_CMD'};
482 if ( $ENV{'HOME'} ) {
483 unshift @INC, "$ENV{'HOME'}/.cpan";
485 $configured = eval { require CPAN::MyConfig } || eval { require CPAN::Config };
487 unless ( $configured ) {
489 You haven't configured the CPAN shell yet.
490 Please run `@PERL@ -MCPAN -e shell` to configure it.
494 my $rv = eval { require CPAN; CPAN::Shell->install($module) };
495 return $rv unless $@;
498 Failed to load module CPAN.
500 -------- Error ---------
502 ------------------------
504 When we tried to start installing RT's perl dependencies,
505 we were unable to load the CPAN client. This module is usually distributed
506 with Perl. This usually indicates that your vendor has shipped an unconfigured
507 or incorrectly configured CPAN client.
508 The error above may (or may not) give you a hint about what went wrong
510 You have several choices about how to install dependencies in
513 1) use a different tool to install dependencies by running setting the following
514 shell environment variable and rerunning this tool:
515 RT_FIX_DEPS_CMD='@PERL@ -MCPAN -e"install %s"'
516 2) Attempt to configure CPAN by running:
517 `@PERL@ -MCPAN -e shell` program from shell.
518 If this fails, you may have to manually upgrade CPAN (see below)
519 3) Try to update the CPAN client. Download it from:
520 http://search.cpan.org/dist/CPAN and try again
521 4) Install each dependency manually by downloading them one by one from
522 http://search.cpan.org
529 $ext =~ s/\%s/$module/g; # sprintf( $ext, $module );
533 print "\t\tcommand: '$ext'\n";
534 return scalar `$ext 1>&2`;
541 foreach my $key (keys %deps) {
542 my @deps = (@{$deps{$key}});
544 my $mod = shift @deps;
545 my $ver = shift @deps;
546 next if ($mod =~ /^(DBD-|Apache-Request)/);
547 $modules{$mod} = $ver;
550 my @mods = keys %modules;
552 my $moddir = $args{'download'};
553 foreach my $mod (@mods) {
554 $CPAN::Config->{'build_dir'} = $moddir;
558 opendir(DIR, $moddir);
559 while ( my $dir = readdir(DIR)) {
560 print "Dir is $dir\n";
561 next if ( $dir =~ /^\.\.?$/);
563 # Skip things we've previously tagged
564 my $out = `svn ls $args{'repository'}/tags/$dir`;
567 if ($dir =~ /^(.*)-(.*?)$/) {
568 `svn_load_dirs -no_user_input -t tags/$dir -v $args{'repository'} dists/$1 $moddir/$dir`;
569 `rm -rf $moddir/$dir`;
578 sub check_perl_version {
580 eval {require 5.008003};
582 print_found("5.8.3", 0,"RT is known to be non-functional on versions of perl older than 5.8.3. Please upgrade to 5.8.3 or newer.");
585 print_found( sprintf(">=5.8.3(%vd)", $^V), 1 );
591 print_found("rt group (@RTGROUP@)", defined getgrnam("@RTGROUP@"));
592 print_found("bin owner (@BIN_OWNER@)", defined getpwnam("@BIN_OWNER@"));
593 print_found("libs owner (@LIBS_OWNER@)", defined getpwnam("@LIBS_OWNER@"));
594 print_found("libs group (@LIBS_GROUP@)", defined getgrnam("@LIBS_GROUP@"));
595 print_found("web owner (@WEB_USER@)", defined getpwnam("@WEB_USER@"));
596 print_found("web group (@WEB_GROUP@)", defined getgrnam("@WEB_GROUP@"));