koha_perl_deps.pl

   1 #!/usr/bin/perl
   2
   3 use Getopt::Long;
   4 use Pod::Usage;
   5 use Term::ANSIColor;
   6 use FindBin; # we need to enforce which C4::Installer is used in case more than one is installed
   7
   8 use lib $FindBin::Bin;
   9
  10 use C4::Installer::PerlModules;
  11
  12 use strict;
  13 use warnings;
  14
  15 my $help = 0;
  16 my $missing = 0;
  17 my $installed = 0;
  18 my $upgrade = 0;
  19 my $all = 0;
  20 my $color = 0;
  21
  22 GetOptions(
  23             'h|help|?'    => \$help,
  24             'm|missing'   => \$missing,
  25             'i|installed' => \$installed,
  26             'u|upgrade'   => \$upgrade,
  27             'a|all'       => \$all,
  28             'c|color'     => \$color,
  29           );
  30
  31 pod2usage(1) if $help || (!$missing && !$installed && !$upgrade && !$all);
  32
  33 my $koha_pm = C4::Installer::PerlModules->new;
  34 $koha_pm->version_info(all => 1);
  35
  36 my @pm = ();
  37
  38 push @pm, 'missing_pm' if $missing || $all;
  39 push @pm, 'upgrade_pm' if $upgrade || $all;
  40 push @pm, 'current_pm' if $installed || $all;
  41
  42 print color 'bold blue' if $color;
  43 print"
  44                                               Installed         Required          Module is
  45 Module Name                                   Version           Version            Required
  46 --------------------------------------------------------------------------------------------
  47 ";
  48
  49 my $count = 0;
  50 foreach my $type (@pm) {
  51     my $mod_type = $type;
  52     $mod_type =~ s/_pm$//;
  53     my $pm = $koha_pm->get_attr($type);
  54     foreach (@$pm) {
  55         foreach my $pm (keys(%$_)) {
  56             print color 'yellow' if $type eq 'upgrade_pm' && $color;
  57             print color 'red' if $type eq 'missing_pm' && $color;
  58             print color 'green' if $type eq 'current_pm' && $color;
  59             $count++;
  60             my $required = ($_->{$pm}->{'required'}?'Yes':'No');
  61             my $current_version = ($color ? $_->{$pm}->{'cur_ver'} :
  62                                    $type eq 'missing_pm' || $type eq 'upgrade_pm' ? $_->{$pm}->{'cur_ver'}." *" : $_->{$pm}->{'cur_ver'});
  63 format =
  64 @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<<       @<<<<<
  65 $pm,                                          $current_version, $_->{$pm}->{'min_ver'},  $required
  66 .
  67 write;
  68         }
  69     }
  70 }
  71 print color 'bold blue' if $color;
  72 my $footer = "
  73 --------------------------------------------------------------------------------------------
  74 Total modules reported: $count                      ";
  75
  76 if ($color) {
  77     $footer .= "\n\n";
  78 }
  79 else {
  80     $footer .= "* Module is missing or requires an upgrade.\n\n";
  81 }
  82
  83 print $footer;
  84 print color 'reset' if $color;
  85
  86 1;
  87
  88 __END__
  89
  90 =head1 NAME
  91
  92 koha_perl_deps.pl
  93
  94 =head1 SYNOPSIS
  95
  96 ./koha_perl_deps.pl -m
  97
  98 =head1 OPTIONS
  99
 100 =over 8
 101
 102 =item B<-m|--missing>
 103
 104 lists all missing perl modules
 105
 106 =item B<-i|--installed>
 107
 108 lists all installed perl modules
 109
 110 =item B<-u|--upgrade>
 111
 112 lists all perl modules needing to be upgraded relative to Koha
 113
 114 =item B<-a|--all>
 115
 116 lists all koha perl dependencies
 117
 118 =item B<-c|--color>
 119
 120 formats the output in color; red = module is missing, yellow = module requires upgrading, green = module is installed and current
 121
 122 =item B<-h|--help|?>
 123
 124 prints this help text
 125
 126 =back
 127
 128 =head1 AUTHOR
 129
 130 Chris Nighswonger <cnighswonger AT foundations DOT edu>
 131
 132 =head1 COPYRIGHT
 133
 134 Copyright 2010 Foundations Bible College.
 135
 136 =head1 LICENSE
 137
 138 This file is part of Koha.
 139
 140 Koha is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software
 141 Foundation; either version 2 of the License, or (at your option) any later version.
 142
 143 You should have received a copy of the GNU General Public License along
 144 with Koha; if not, write to the Free Software Foundation, Inc.,
 145 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 146
 147 =head1 DISCLAIMER OF WARRANTY
 148
 149 Koha is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 150 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 151
 152 =cut