1 package C4::Installer::PerlModules;
8 use C4::Installer::PerlDependencies;
10 use version; our $VERSION = qv('1.0.0_1');
12 our $PERL_DEPS = $C4::Installer::PerlDependencies::PERL_DEPS;
21 my $type = ref($invocant) || $invocant;
29 for (keys %$PERL_DEPS) {
30 $prereq_pm->{$_} = $PERL_DEPS->{$_}->{'min_ver'};
38 if ($params{'module'}) {
39 return -1 unless grep {m/$params{'module'}/} keys(%$PERL_DEPS);
40 return $PERL_DEPS->{$params{'module'}}->{'required'};
42 elsif ($params{'required'}) {
44 for (keys %$PERL_DEPS) {
45 push (@$required_pm, $_) if $PERL_DEPS->{$_}->{'required'} == 1;
49 elsif ($params{'optional'}) {
51 for (keys %$PERL_DEPS) {
52 push (@$optional_pm, $_) if $PERL_DEPS->{$_}->{'required'} == 0;
57 return -1; # unrecognized parameter passed in
62 no warnings; # perl throws warns for invalid $VERSION numbers which some modules use
64 # Reset these arrayref each pass through to ensure current information
65 $self->{'missing_pm'} = [];
66 $self->{'upgrade_pm'} = [];
67 $self->{'current_pm'} = [];
69 if ($params{'module'}) {
70 return -1 unless grep {m/$params{'module'}/} keys(%$PERL_DEPS);
71 eval "require $params{'module'}";
73 return {$params{'module'} => {cur_ver => 0, min_ver => $PERL_DEPS->{$_}->{'min_ver'}, upgrade => 0, required => $PERL_DEPS->{$_}->{'required'}, usage => $PERL_DEPS->{$_}->{'usage'}}};
75 elsif ($params{'module'}->VERSION lt $PERL_DEPS->{$params{'module'}}->{'min_ver'}) {
76 return {$params{'module'} => {cur_ver => $params{'module'}->VERSION, min_ver => $PERL_DEPS->{$params{'module'}}->{'min_ver'}, upgrade => 1, required => $PERL_DEPS->{$params{'module'}}->{'required'}, usage => $PERL_DEPS->{$_}->{'usage'}}};
79 return {$params{'module'} => {cur_ver => $params{'module'}->VERSION, min_ver => $PERL_DEPS->{$params{'module'}}->{'min_ver'}, upgrade => 0, required => $PERL_DEPS->{$params{'module'}}->{'required'}, usage => $PERL_DEPS->{$_}->{'usage'}}};
83 for (sort keys(%{$PERL_DEPS})) {
84 my $pkg = $_; # $_ holds the string
87 push (@{$self->{'missing_pm'}}, {$_ => {cur_ver => 0, min_ver => $PERL_DEPS->{$_}->{'min_ver'}, required => $PERL_DEPS->{$_}->{'required'}, usage => $PERL_DEPS->{$_}->{'usage'}}});
89 elsif ($pkg->VERSION lt $PERL_DEPS->{$_}->{'min_ver'}) {
90 push (@{$self->{'upgrade_pm'}}, {$_ => {cur_ver => $pkg->VERSION, min_ver => $PERL_DEPS->{$_}->{'min_ver'}, required => $PERL_DEPS->{$_}->{'required'}, usage => $PERL_DEPS->{$_}->{'usage'}}});
93 push (@{$self->{'current_pm'}}, {$_ => {cur_ver => $pkg->VERSION, min_ver => $PERL_DEPS->{$_}->{'min_ver'}, required => $PERL_DEPS->{$_}->{'required'}, usage => $PERL_DEPS->{$_}->{'usage'}}});
101 return $_[0]->{$_[1]};
105 return scalar(keys(%$PERL_DEPS));
109 return keys(%$PERL_DEPS);
117 C4::Installer::PerlModules
121 A module for manipulating Koha Perl dependency list objects.
127 Creates a new PerlModules object
130 C<my $perl_modules = C4::Installer::PerlModules->new;>
134 Returns a hashref of a hash of module information suitable for use in Makefile.PL
137 C<my $perl_modules = C4::Installer::PerlModules->new;
141 PREREQ_PM => $perl_modules->prereq_pm,>
145 This method accepts a single parameter with three possible values: a module name, the keyword 'required,' the keyword 'optional.' If passed the name of a module, a boolean value is returned indicating whether the module is required (1) or not (0). If on of the two keywords is passed in, it returns an arrayref to an array who's elements are the names of the modules specified either required or optional.
148 C<my $is_required = $perl_modules->required(module => 'CGI::Carp');>
150 C<my $optional_pm_names = $perl_modules->required(optional => 1);>
152 =head2 version_info()
154 Depending on the parameters passed when invoking, this method will give the current status of modules currently used in Koha as well as the currently installed version if the module is installed, the current minimum required version, and the upgrade status. If passed C<module => module_name>, the method evaluates only that module. If passed C<all => 1>, all modules are evaluated.
157 C<my $module_status = $perl_modules->version_info(module => 'foo');>
159 This usage returns a hashref with a single key/value pair. The key is the module name. The value is an anonymous hash with the following keys:
161 cur_ver = version number of the currently installed version (This is 0 if the module is not currently installed.)
162 min_ver = minimum version required by Koha
163 upgrade = upgrade status of the module relative to Koha's requirements (0 if the installed module does not need upgrading; 1 if it does)
164 required = 0 of the module is optional; 1 if required
169 'cur_ver' => '1.30_01',
175 C<$perl_modules->version_info;>
177 This usage loads the same basic data as the previous usage into three accessors: missing_pm, upgrade_pm, and current_pm. Each of these may be accessed by using the C<get_attr> method. Each accessor returns an anonymous array who's elements are anonymous hashes. They follow this format (NOTE: Upgrade status is indicated by the accessor name.):
181 'Text::CSV::Encoded' => {
188 'Biblio::EndnoteStyle' => {
196 =head2 get_attr(attr_name)
198 Returns an anonymous array containing the contents of the passed in accessor. Valid accessors are:
200 missing_pm - Perl modules used by Koha but not currently installed.
202 upgrade_pm - Perl modules currently installed but below the minimum version required by Koha.
204 current_pm - Perl modules currently installed and up to date as required by Koha.
207 C<my $missing_pm = $perl_modules->get_attr('missing_pm');>
211 Returns a scalar value representing the current number of Perl modules used by Koha.
214 C<my $module_count = $perl_modules->module_count;>
218 Returns an array who's elements are the names of the Perl modules used by Koha.
221 C<my @module_list = $perl_modules->module_list;>
223 This is useful for commandline exercises such as:
225 perl -MC4::Installer::PerlModules -e 'my $deps = C4::Installer::PerlModule->new; print (join("\n",$deps->module_list));'
229 Chris Nighswonger <cnighswonger AT foundations DOT edu>
233 Copyright 2010 Foundations Bible College.
237 This file is part of Koha.
239 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
240 Foundation; either version 2 of the License, or (at your option) any later version.
242 You should have received a copy of the GNU General Public License along with Koha; if not, write to the Free Software Foundation, Inc., 51 Franklin Street,
243 Fifth Floor, Boston, MA 02110-1301 USA.
245 =head1 DISCLAIMER OF WARRANTY
247 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
248 A PARTICULAR PURPOSE. See the GNU General Public License for more details.