Koha/koha_perl_deps.pl
Jonathan Druart 9d6d641d1f Bug 17600: Standardize our EXPORT_OK
On bug 17591 we discovered that there was something weird going on with
the way we export and use subroutines/modules.
This patch tries to standardize our EXPORT to use EXPORT_OK only.

That way we will need to explicitely define the subroutine we want to
use from a module.

This patch is a squashed version of:
Bug 17600: After export.pl
Bug 17600: After perlimport
Bug 17600: Manual changes
Bug 17600: Other manual changes after second perlimports run
Bug 17600: Fix tests

And a lot of other manual changes.

export.pl is a dirty script that can be found on bug 17600.

"perlimport" is:
git clone https://github.com/oalders/App-perlimports.git
cd App-perlimports/
cpanm --installdeps .
export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib"
find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \;

The ideas of this patch are to:
* use EXPORT_OK instead of EXPORT
* perltidy the EXPORT_OK list
* remove '&' before the subroutine names
* remove some uneeded use statements
* explicitely import the subroutines we need within the controllers or
modules

Note that the private subroutines (starting with _) should not be
exported (and not used from outside of the module except from tests).

EXPORT vs EXPORT_OK (from
https://www.thegeekstuff.com/2010/06/perl-exporter-examples/)
"""
Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members.

@EXPORT and @EXPORT_OK are the two main variables used during export operation.

@EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace.

@EXPORT_OK does export of symbols on demand basis.
"""

If this patch caused a conflict with a patch you wrote prior to its
push:
* Make sure you are not reintroducing a "use" statement that has been
removed
* "$subroutine" is not exported by the C4::$MODULE module
means that you need to add the subroutine to the @EXPORT_OK list
* Bareword "$subroutine" not allowed while "strict subs"
means that you didn't imported the subroutine from the module:
  - use $MODULE qw( $subroutine list );
You can also use the fully qualified namespace: C4::$MODULE::$subroutine

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-07-16 08:58:47 +02:00

190 lines
4.9 KiB
Perl
Executable file

#!/usr/bin/perl
use Getopt::Long qw( GetOptions );
use Pod::Usage qw( pod2usage );
use Term::ANSIColor qw( color );
use FindBin; # we need to enforce which C4::Installer is used in case more than one is installed
use lib $FindBin::Bin;
use C4::Installer::PerlModules;
use Modern::Perl;
my $help = 0;
my $missing = 0;
my $installed = 0;
my $upgrade = 0;
my $all = 0;
my $color = 0;
my $brief = 0;
my $req = 0;
GetOptions(
'h|help|?' => \$help,
'm|missing' => \$missing,
'i|installed' => \$installed,
'u|upgrade' => \$upgrade,
'a|all' => \$all,
'b|brief' => \$brief,
'r|required' => \$req,
'c|color' => \$color,
);
pod2usage(1) if $help || (!$missing && !$installed && !$upgrade && !$all);
my $koha_pm = C4::Installer::PerlModules->new;
$koha_pm->versions_info;
my @pm = ();
push @pm, 'missing_pm' if $missing || $all;
push @pm, 'upgrade_pm' if $upgrade || $all;
push @pm, 'current_pm' if $installed || $all;
if (!$brief) {
print color 'bold blue' if $color;
print"
Installed Required Module is
Module Name Version Version Required
--------------------------------------------------------------------------------------------
";
}
my $count = 0;
foreach my $type (@pm) {
my $mod_type = $type;
$mod_type =~ s/_pm$//;
my $pm = $koha_pm->get_attr($type);
foreach (@$pm) {
foreach my $pm (keys(%$_)) {
print color 'yellow' if $type eq 'upgrade_pm' && $color;
print color 'red' if $type eq 'missing_pm' && $color;
print color 'green' if $type eq 'current_pm' && $color;
my $required = ($_->{$pm}->{'required'}?'Yes':'No');
my $current_version = ($color ? $_->{$pm}->{'cur_ver'} :
$type eq 'missing_pm' || $type eq 'upgrade_pm' ? $_->{$pm}->{'cur_ver'}." *" : $_->{$pm}->{'cur_ver'});
if (!$brief) {
if (($req && $required eq 'Yes') || !$req) {
format =
@<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<< @<<<<<<<<<<<<<<<< @<<<<<
$pm, $current_version, $_->{$pm}->{'min_ver'}, $required
.
write;
$count++;
}
}
else {
if (($req && $required eq 'Yes') || !$req) {
print "$pm\n";
$count++;
}
}
}
}
}
if (!$brief) {
print color 'bold blue' if $color;
my $footer = "
--------------------------------------------------------------------------------------------
Total modules reported: $count ";
if ($color) {
$footer .= "\n\n";
}
else {
$footer .= "* Module is missing or requires an upgrade.\n\n";
}
print $footer;
print color 'reset' if $color;
}
1;
__END__
=head1 NAME
koha_perl_deps.pl
=head1 SYNOPSIS
At least one of -a, -m, -i, or -u flags must specified to not trigger help.
./koha_perl_deps.pl -m [-b] [-r] [-c]
./koha_perl_deps.pl -u [-b] [-r] [-c]
./koha_perl_deps.pl -i [-b] [-r] [-c]
./koha_perl_deps.pl -a [-b] [-r] [-c]
./koha_perl_deps.pl [-[h?]]
=head1 OPTIONS
=over 8
=item B<-m|--missing>
lists all missing perl modules
=item B<-i|--installed>
lists all installed perl modules
=item B<-u|--upgrade>
lists all perl modules needing to be upgraded relative to Koha
=item B<-a|--all>
lists all koha perl dependencies
This is equivalent to '-m -i -u'.
=item B<-b|--brief>
lists only the perl dependency name.
=item B<-r|--required>
filters list to only required perl dependencies.
=item B<-c|--color>
formats the output in color; red = module is missing, yellow = module requires upgrading, green = module is installed and current
=item B<-h|--help|?>
prints this help text
=back
=head1 AUTHOR
Chris Nighswonger <cnighswonger AT foundations DOT edu>
=head1 COPYRIGHT
Copyright 2010 Foundations Bible College.
=head1 LICENSE
This file is part of Koha.
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 Foundation; either version 3 of the License, or
(at your option) any later version.
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 A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Koha; if not, see <http://www.gnu.org/licenses>.
=head1 DISCLAIMER OF WARRANTY
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
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
=cut