Bug 19230: Preventing warn when deleting course
[koha.git] / 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 my $brief = 0;
22 my $req = 0;
23
24 GetOptions(
25             'h|help|?'    => \$help,
26             'm|missing'   => \$missing,
27             'i|installed' => \$installed,
28             'u|upgrade'   => \$upgrade,
29             'a|all'       => \$all,
30             'b|brief'     => \$brief,
31             'r|required'  => \$req,
32             'c|color'     => \$color,
33           );
34
35 pod2usage(1) if $help || (!$missing && !$installed && !$upgrade && !$all);
36
37 my $koha_pm = C4::Installer::PerlModules->new;
38 $koha_pm->versions_info;
39
40 my @pm = ();
41
42 push @pm, 'missing_pm' if $missing || $all;
43 push @pm, 'upgrade_pm' if $upgrade || $all;
44 push @pm, 'current_pm' if $installed || $all;
45
46 if (!$brief) {
47     print color 'bold blue' if $color;
48     print"
49                                               Installed         Required          Module is
50 Module Name                                   Version           Version            Required
51 --------------------------------------------------------------------------------------------
52 ";
53 }
54
55 my $count = 0;
56 foreach my $type (@pm) {
57     my $mod_type = $type;
58     $mod_type =~ s/_pm$//;
59     my $pm = $koha_pm->get_attr($type);
60     foreach (@$pm) {
61         foreach my $pm (keys(%$_)) {
62             print color 'yellow' if $type eq 'upgrade_pm' && $color;
63             print color 'red' if $type eq 'missing_pm' && $color;
64             print color 'green' if $type eq 'current_pm' && $color;
65             my $required = ($_->{$pm}->{'required'}?'Yes':'No');
66             my $current_version = ($color ? $_->{$pm}->{'cur_ver'} :
67                                    $type eq 'missing_pm' || $type eq 'upgrade_pm' ? $_->{$pm}->{'cur_ver'}." *" : $_->{$pm}->{'cur_ver'});
68             if (!$brief) {
69                 if (($req && $required eq 'Yes') || !$req) {
70 format =
71 @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<<       @<<<<<
72 $pm,                                          $current_version, $_->{$pm}->{'min_ver'},  $required
73 .
74 write;
75                     $count++;
76                 }
77             }
78             else {
79                 if (($req && $required eq 'Yes') || !$req) {
80                     print "$pm\n";
81                     $count++;
82                 }
83             }
84         }
85     }
86 }
87
88 if (!$brief) {
89     print color 'bold blue' if $color;
90     my $footer = "
91 --------------------------------------------------------------------------------------------
92 Total modules reported: $count                      ";
93
94     if ($color) {
95         $footer .= "\n\n";
96     }
97     else {
98         $footer .= "* Module is missing or requires an upgrade.\n\n";
99     }
100
101     print $footer;
102     print color 'reset' if $color;
103 }
104
105 1;
106
107 __END__
108
109 =head1 NAME
110
111 koha_perl_deps.pl
112
113 =head1 SYNOPSIS
114
115  At least one of -a, -m, -i, or -u flags must specified to not trigger help.
116  ./koha_perl_deps.pl -m [-b] [-r] [-c]
117  ./koha_perl_deps.pl -u [-b] [-r] [-c]
118  ./koha_perl_deps.pl -i [-b] [-r] [-c]
119  ./koha_perl_deps.pl -a [-b] [-r] [-c]
120  ./koha_perl_deps.pl [-[h?]]
121
122 =head1 OPTIONS
123
124 =over 8
125
126 =item B<-m|--missing>
127
128 lists all missing perl modules
129
130 =item B<-i|--installed>
131
132 lists all installed perl modules
133
134 =item B<-u|--upgrade>
135
136 lists all perl modules needing to be upgraded relative to Koha
137
138 =item B<-a|--all>
139
140  lists all koha perl dependencies
141  This is equivalent to '-m -i -u'.
142
143 =item B<-b|--brief>
144
145 lists only the perl dependency name.
146
147 =item B<-r|--required>
148
149 filters list to only required perl dependencies.
150
151 =item B<-c|--color>
152
153 formats the output in color; red = module is missing, yellow = module requires upgrading, green = module is installed and current
154
155 =item B<-h|--help|?>
156
157 prints this help text
158
159 =back
160
161 =head1 AUTHOR
162
163 Chris Nighswonger <cnighswonger AT foundations DOT edu>
164
165 =head1 COPYRIGHT
166
167 Copyright 2010 Foundations Bible College.
168
169 =head1 LICENSE
170
171 This file is part of Koha.
172
173 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
174 Foundation; either version 2 of the License, or (at your option) any later version.
175
176 You should have received a copy of the GNU General Public License along
177 with Koha; if not, write to the Free Software Foundation, Inc.,
178 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
179
180 =head1 DISCLAIMER OF WARRANTY
181
182 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
183 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
184
185 =cut