import rt 3.6.6
[freeside.git] / rt / sbin / rt-test-dependencies.in
index 6951290..ea6b9d1 100644 (file)
@@ -1,9 +1,15 @@
 #!@PERL@
-# BEGIN LICENSE BLOCK
+# BEGIN BPS TAGGED BLOCK {{{
 # 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
+# COPYRIGHT:
+#  
+# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC 
+#                                          <jesse@bestpractical.com>
 # 
-# (Except where explictly superceded by other copyright notices)
+# (Except where explicitly superseded by other copyright notices)
+# 
+# 
+# LICENSE:
 # 
 # This work is made available to you under the terms of Version 2 of
 # the GNU General Public License. A copy of that license should have
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 # General Public License for more details.
 # 
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/copyleft/gpl.html.
 # 
 # 
-# END LICENSE BLOCK
-
+# CONTRIBUTION SUBMISSION POLICY:
+# 
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+# 
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+# 
+# END BPS TAGGED BLOCK }}}
 #
 # This is just a basic script that checks to make sure that all
 # the modules needed by RT before you can install it.
 use strict;
 no warnings qw(numeric redefine);
 use Getopt::Long;
-use CPAN;
 my %args;
 my %deps;
-GetOptions(\%args,'install', 'with-MYSQL', 'with-POSTGRESQL|with-pg|with-pgsql', 'with-SQLITE', 'with-ORACLE', 'with-FASTCGI', 'with-SPEEDYCGI', 'with-MODPERL1', 'with-MODPERL2' ,'with-DEV');
-
-if  (!keys %args) {
-help();
-exit(0);
+GetOptions(
+    \%args,                               'v|verbose',
+    'install',                            'with-MYSQL',
+    'with-POSTGRESQL|with-pg|with-pgsql', 'with-SQLITE',
+    'with-ORACLE',                        'with-FASTCGI',
+    'with-SPEEDYCGI',                     'with-MODPERL1',
+    'with-MODPERL2',                      'with-DEV',
+    'with-STANDALONE',
+    'download=s',
+    'repository=s'
+);
+
+unless (keys %args) {
+    help();
+    exit(0);
 }
-$args{'with-MASON'} = 1;
-$args{'with-CORE'} = 1;
-$args{'with-DEV'} =1; 
-$args{'with-CLI'} =1; 
-$args{'with-MAILGATE'} =1; 
-if ($] < 5.007) {
-$args{'with-I18N-COMPAT'} = 1;
+# Set up defaults
+my %default = (
+    'with-MASON' => 1,
+    'with-CORE' => 1,
+    'with-CLI' => 1,
+    'with-MAILGATE' => 1, 
+    'with-DEV' => @RT_DEVEL_MODE@, 
+    'with-STANDALONE' => @RT_STANDALONE@,
+);
+$args{$_} = $default{$_} foreach grep !exists $args{$_}, keys %default;
+
+
+{
+  my $section;
+  my %always_show_sections = (
+    perl => 1,
+    users => 1,
+  );
+
+  sub section {
+    my $s = shift;
+    $section = $s;
+    print "$s:\n";
+  }
+
+  my $any_missing = 0;
+  sub found {
+    my $msg = shift;
+    my $test = shift;
+    my $extra = shift;
+  
+    $any_missing = 1 unless $test;
+    if ($args{'v'} or not $test or $always_show_sections{$section}) {
+      print "\t$msg...";
+      print $test ? "found" : "MISSING";
+      print "\n";
+    }
+    
+    print "\t\t$extra\n" if defined $extra;
+  }
+
+  sub conclude {
+    if ($any_missing) {
+      print "\nSOMETHING WAS MISSING!\n";
+    } else {
+      print "\nEverything was found.\n";
+    }
+  }
 }
 
-
 sub help {
 
-print <<'.'
+    print <<'.';
 
 By default, testdeps determine whether you have 
 installed all the perl modules RT needs to run.
@@ -66,181 +138,342 @@ The following switches will tell the tool to check for specific dependencies
        --with-sqlite           Database interface and driver for SQLite (unsupported)
        --with-oracle           Database interface for oracle (unsupported)
 
+       --with-standalone       Libraries needed to support the standalone simple pure perl server
        --with-fastcgi          Libraries needed to support the fastcgi handler
        --with-speedycgi        Libraries needed to support the speedycgi handler
        --with-modperl1         Libraries needed to support the modperl 1 handler
        --with-modperl2         Libraries needed to support the modperl 2 handler
 
        --with-dev              Tools needed for RT development
+
+You can also specify -v or --verbose to list the status of all dependencies,
+rather than just the missing ones.
+
+The "RT_FIX_DEPS_CMD" environment variable, if set, will be used
+instead of the standard CPAN shell by --install to install any
+required modules.  It will be called with the module name, or, if
+"RT_FIX_DEPS_CMD" contains a "%s", will replace the "%s" with the
+module name before calling the program.
 .
 }
 
 
-sub _ {
-    map { /(\S+)\s*(\S*)/; $1 => ($2 ? $2 :'') } split ( /\n/, $_[0] );
+sub text_to_hash {
+    my %hash;
+    for my $line ( split /\n/, $_[0] ) {
+        my($key, $value) = $line =~ /(\S+)\s*(\S*)/;
+        $value ||= '';
+        $hash{$key} = $value;
+    }
+
+    return %hash;
 }
 
-$deps{'CORE'} = [ _( << '.') ];
-Digest::MD5
-DBI 1.18
-Test::Inline
+$deps{'CORE'} = [ text_to_hash( << '.') ];
+Digest::base
+Digest::MD5 2.27
+DBI 1.37
 Class::ReturnValue 0.40
-DBIx::SearchBuilder 0.86
+Date::Format
+DBIx::SearchBuilder 1.50
 Text::Template
 File::Spec 0.8
 HTML::Entities 
-Net::Domain
+HTML::Scrubber 0.08
 Log::Dispatch 2.0
-Locale::Maketext 1.04
-Locale::Maketext::Lexicon 0.25
+Locale::Maketext 1.06
+Locale::Maketext::Lexicon 0.32
 Locale::Maketext::Fuzzy
 MIME::Entity 5.108
 Mail::Mailer 1.57
 Net::SMTP
 Text::Wrapper 
 Time::ParseDate
+Time::HiRes 
 File::Temp
-Term::ReadKey
 Text::Autoformat
-Text::Quoted
+Text::Quoted 2.02
+Tree::Simple 1.04
+Regexp::Common
+Scalar::Util
+Module::Versions::Report 1.03
+Cache::Simple::TimedExpiry
+UNIVERSAL::require
+Calendar::Simple
+CSS::Squish 0.06
 .
 
-$deps{'MASON'} = [ _( << '.') ];
-Params::Validate 0.02
-Cache::Cache
-Exception::Class
-HTML::Mason 1.16
-MLDBM
+$deps{'MASON'} = [ text_to_hash( << '.') ];
+HTML::Mason 1.23
 Errno
-FreezeThaw
-Digest::MD5
+Digest::MD5 2.27
 CGI::Cookie 1.20
-Storable
+Storable 2.08
 Apache::Session 1.53
+XML::RSS 1.05
+GD
+GD::Graph
+GD::Text
+Text::WikiFormat 0.76
+CSS::Squish 0.06
+.
+
+$deps{'STANDALONE'} = [ text_to_hash( << '.') ];
+HTTP::Server::Simple 0.07
+HTTP::Server::Simple::Mason 0.09
 .
 
-$deps{'MAILGATE'} = [ _( << '.') ];
+$deps{'MAILGATE'} = [ text_to_hash( << '.') ];
 HTML::TreeBuilder
 HTML::FormatText
 Getopt::Long
 LWP::UserAgent
+Pod::Usage
 .
 
-$deps{'CLI'} = [ _( << '.') ];
+$deps{'CLI'} = [ text_to_hash( << '.') ];
 Getopt::Long 2.24
+LWP
+HTTP::Request::Common
+Text::ParseWords
+Term::ReadLine
+Term::ReadKey
 .
 
-$deps{'DEV'} = [ _( << '.') ];
-Regexp::Common
-Time::HiRes 
+$deps{'DEV'} = [ text_to_hash( << '.') ];
 Test::Inline 
+Apache::Test
+HTML::Form
+HTML::TokeParser
 WWW::Mechanize
+Test::WWW::Mechanize 1.04
+Module::Refresh 0.03
+Test::Expect 0.30
+XML::Simple
+File::Find
 .
 
-$deps{'FASTCGI'} = [ _( << '.') ];
-CGI
+$deps{'FASTCGI'} = [ text_to_hash( << '.') ];
+CGI 2.92
 FCGI
 CGI::Fast 
 .
 
-$deps{'SPEEDYCGI'} = [ _( << '.') ];
-CGI
+$deps{'SPEEDYCGI'} = [ text_to_hash( << '.') ];
+CGI 2.92
 CGI::SpeedyCGI
 .
 
 
-$deps{'MODPERL1'} = [ _( << '.') ];
-CGI
+$deps{'MODPERL1'} = [ text_to_hash( << '.') ];
+CGI 2.92
 Apache::Request
-Apache::DBI
+Apache::DBI 0.92
 .
 
-$deps{'MODPERL2'} = [ _( << '.') ];
-CGI 2.89
+$deps{'MODPERL2'} = [ text_to_hash( << '.') ];
+CGI 2.92
 Apache::DBI
+HTML::Mason 1.31
 .
 
-$deps{'I18N-COMPAT'} = [ _( << '.') ];
-Text::Iconv
-Encode::compat 0.04
-.
-
-$deps{'MYSQL'} = [ _( << '.') ];
+$deps{'MYSQL'} = [ text_to_hash( << '.') ];
 DBD::mysql 2.1018
 .
-$deps{'ORACLE'} = [ _( << '.') ];
+$deps{'ORACLE'} = [ text_to_hash( << '.') ];
 DBD::Oracle
 .
-$deps{'POSTGRESQL'} = [ _( << '.') ];
-DBD::Pg
+$deps{'POSTGRESQL'} = [ text_to_hash( << '.') ];
+DBD::Pg 1.43
 .
 
+$deps{'SQLITE'} = [ text_to_hash( << '.') ];
+DBD::SQLite 1.00
+.
 
-foreach my $type (keys %args)  {
-next unless ($type =~ /^with-(.*?)$/);
-my $type = $1;
-print "$type dependencies:\n";
-       my @deps = (@{$deps{$type}});
-       while (@deps) {
-               my $module = shift @deps;
-               my $version = shift @deps;
-my $ret;
-       $ret =test_dep($module, $version);      
+if ($args{'download'}) {
 
-if ($args{'install'} && !$ret) {
-       resolve_dep($module);           
-}
-}
-}
-sub test_dep {
-       my $module = shift;
-       my $version = shift;
-
-         print "\t$module $version";
-        eval "use $module $version" ;
-        if ($@) {
-       my $error = $@;
-       $error =~ s/\n(.*)$//s;
-       print "...MISSING\n";
-               print "\t\t$error\n" if $error =~ /this is only/;
-
-       return undef;
-       } else {
-       print "...found\n";
-return 1;
-       }
+    download_mods();
 }
 
-sub resolve_dep {
-       my $module = shift;
-       use CPAN;
-       CPAN::Shell->install($module);          
-       
-}
 
+check_perl_version();
 
-sub print_help {
-    print << "EOF";
+check_users();
 
-$0 FLAG DBTYPE
 
+foreach my $type (sort grep $args{$_}, keys %args) {
+    next unless ($type =~ /^with-(.*?)$/);
 
-$0 is a tool for RT that will tell you if you've got all
-the modules RT depends on properly installed.
+    $type = $1;
+    section("$type dependencies");
 
-Flags: (only one flag is valid for a given run)
+    my @missing;
+    my @deps = @{ $deps{$type} };
+    while (@deps) {
+        my $module = shift @deps;
+        my $version = shift @deps;
+        my $ret = test_dep($module, $version);
 
--quiet will check to see if we've got everything we need
-       and will exit with a return code of (1) if we don't.
+        push @missing, $module, $version unless $ret;
+    }
+    if ( $args{'install'} ) {
+        while( @missing ) {
+            resolve_dep(shift @missing, shift @missing);
+        }
+    }
+}
 
--warn will tell you what isn't properly installed
+conclude();
 
--fix will use CPANPLUS.pm or CPAN.pm to magically make everything better
+sub test_dep {
+    my $module = shift;
+    my $version = shift;
+
+    eval "use $module $version ()";
+    if ($@) {
+        my $error = $@;
+        $error =~ s/\n(.*)$//s;
+        undef $error unless $error =~ /this is only/;
+        found("$module $version", 0, $error);
+
+        return undef;
+    } else {
+        my $msg = "$module";
+        $msg .= " >=$version" if $version;
+        found($msg, 1);
+        return 1;
+    }
+}
 
-DBTYPE is one of:
-       oracle, pg, mysql
+sub resolve_dep {
+    my $module = shift;
+    my $version = shift;
+
+    print "\nInstall module $module\n";
+
+    my $ext = $ENV{'RT_FIX_DEPS_CMD'};
+    unless( $ext ) {
+        my $configured = 1;
+        {
+            local @INC = @INC;
+            if ( $ENV{'HOME'} ) {
+                unshift @INC, "$ENV{'HOME'}/.cpan";
+            }
+            $configured = eval { require CPAN::MyConfig } || eval { require CPAN::Config };
+        }
+        unless ( $configured ) {
+            print <<END;
+You didn't configure CPAN shell yet.
+Please run `@PERL@ -MCPAN -e shell` tool and configure it.
+END
+            exit(1);
+        }
+        my $rv = eval { require CPAN; CPAN::Shell->install($module) };
+        return $rv unless $@;
+
+        print <<END;
+Failed to load module CPAN.
+
+-------- Error ---------
+$@
+------------------------
+
+When we tried to start installing RT's perl dependencies, 
+we were unable to load the CPAN client. This module is usually distributed
+with Perl. This usually indicates that your vendor has shipped an unconfigured
+or incorrectly configured CPAN client.
+The error above may (or may not) give you a hint about what went wrong
+
+You have several choices about how to install dependencies in 
+this situatation:
+
+1) use a different tool to install dependencies by running setting the following
+   shell environment variable and rerunning this tool:
+    RT_FIX_DEPS_CMD='@PERL@ -MCPAN -e"install %s"'
+2) Attempt to configure CPAN by running:
+   `@PERL@ -MCPAN -e shell` program from shell.
+   If this fails, you may have to manually upgrade CPAN (see below)
+3) Try to update the CPAN client. Download it from:
+   http://search.cpan.org/dist/CPAN and try again
+4) Install each dependency manually by downloading them one by one from
+   http://search.cpan.org
+
+END
+        exit(1);
+    }
+
+    if( $ext =~ /\%s/) {
+        $ext =~ s/\%s/$module/g; # sprintf( $ext, $module );
+    } else {
+        $ext .= " $module";
+    }
+    print "\t\tcommand: '$ext'\n";
+    return scalar `$ext 1>&2`;
+}
 
-EOF
+sub download_mods {
+    my %modules;
+    use CPAN;
+    
+    foreach my $key (keys %deps) {
+        my @deps = (@{$deps{$key}});
+        while (@deps) {
+            my $mod = shift @deps;
+            my $ver = shift @deps;
+            next if ($mod =~ /^(DBD-|Apache-Request)/);
+            $modules{$mod} = $ver;
+        }
+    }
+    my @mods = keys %modules;
+    CPAN::get();
+    my $moddir = $args{'download'};
+    foreach my $mod (@mods) {
+        $CPAN::Config->{'build_dir'} = $moddir;
+        CPAN::get($mod);
+    }
+
+    opendir(DIR, $moddir);
+    while ( my $dir = readdir(DIR)) {
+        print "Dir is $dir\n";
+        next if ( $dir =~ /^\.\.?$/);
+
+        # Skip things we've previously tagged
+        my $out = `svn ls $args{'repository'}/tags/$dir`;
+        next if ($out);
+
+        if ($dir =~ /^(.*)-(.*?)$/) {
+            `svn_load_dirs -no_user_input -t tags/$dir -v $args{'repository'} dists/$1 $moddir/$dir`;
+            `rm -rf $moddir/$dir`;
+
+        }
+
+    }
+    closedir(DIR);
+    exit;
+}
 
-    exit(0);
+sub check_perl_version {
+  section("perl");
+  eval {require 5.008003};
+  if ($@) {
+    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.");
+    exit(1);
+  } else {
+    found( ">=5.8.3($])", 1);
+  }
 }
+
+sub check_users {
+  section("users");
+  found("rt group (@RTGROUP@)",      defined getgrnam("@RTGROUP@"));
+  found("bin owner (@BIN_OWNER@)",   defined getpwnam("@BIN_OWNER@"));
+  found("libs owner (@LIBS_OWNER@)", defined getpwnam("@LIBS_OWNER@"));
+  found("libs group (@LIBS_GROUP@)", defined getgrnam("@LIBS_GROUP@"));
+  found("web owner (@WEB_USER@)",    defined getpwnam("@WEB_USER@"));
+  found("web group (@WEB_GROUP@)",   defined getgrnam("@WEB_GROUP@"));
+}
+
+
+
+1;