Koha-clms/misc/devel/install_plugins.pl

128 lines
3.8 KiB
Perl
Executable File

#!/usr/bin/perl
# This file is part of Koha.
#
# Copyright 2019 Koha Development Team
#
# 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>.
use Modern::Perl;
use Getopt::Long qw( GetOptions );
use Pod::Usage qw( pod2usage );
use Koha::Script;
use C4::Context;
use Koha::Plugins;
my ($help, @include, @exclude);
GetOptions(
'help|?' => \$help,
'include=s' => \@include,
'exclude=s' => \@exclude,
) or die "Installation aborted\n";
pod2usage(1) if $help;
die "Installation aborted : --include and --exclude can't be used simultaneously\n" if @include && @exclude;
unless ( C4::Context->config("enable_plugins") ) {
print "The plugin system must be enabled for one to be able to install plugins\n";
exit 1;
}
my @existing_plugins = Koha::Plugins->new()->GetPlugins(
{
all => 1,
verbose => 1, # warns about plugins failing to load
}
);
my $existing_plugins;
for my $existing_plugin (@existing_plugins) {
$existing_plugins->{ $existing_plugin->{metadata}->{name} } = $existing_plugin->{metadata}->{version};
}
my $params = {};
$params->{'include'} = \@include if @include;
$params->{'exclude'} = \@exclude if @exclude;
my @installed_plugins = Koha::Plugins->new()->InstallPlugins($params);
unless (@installed_plugins) {
my $plugins_dir = C4::Context->config("pluginsdir");
if ( ref($plugins_dir) eq 'ARRAY' ) {
print "No plugins found\n";
print "pluginsdir contains: \n" . join( "\n", @{$plugins_dir} ) . "\n";
} else {
print "No plugins found at $plugins_dir\n";
}
exit 0;
}
for my $installed_plugin (@installed_plugins) {
if ( !exists( $existing_plugins->{ $installed_plugin->{metadata}->{name} } ) ) {
print "Installed "
. $installed_plugin->{metadata}->{name}
. " version "
. $installed_plugin->{metadata}->{version} . "\n";
} elsif ( $existing_plugins->{ $installed_plugin->{metadata}->{name} } ne $installed_plugin->{metadata}->{version} )
{
print "Upgraded "
. $installed_plugin->{metadata}->{name}
. " from version "
. $existing_plugins->{ $installed_plugin->{metadata}->{name} }
. " to version "
. $installed_plugin->{metadata}->{version} . "\n";
}
}
print "All plugins successfully re-initialised\n";
=head1 NAME
install_plugins.pl - install all plugins found in plugins_dir
=head1 SYNOPSIS
install_plugins.pl
Options:
-?|--help brief help message
--include install only the plugins of the specified classes
--exclude install all the plugins except the specified ones
=head1 OPTIONS
=over 8
=item B<--help|-?>
Print a brief help message and exits
=item B<--include>
Retrieve the list of plugin classes and install only those. It's possible to specify the package of a class to install a specific plugin (e.g. --include <package::pluginClass> --include <anotherPluginClass>).
=item B<--exclude>
Retrieve the list of plugin classes and install all plugins except those. It's possible to specify the package of a class to install a specific plugin (e.g. --exclude <package::pluginClass> --exclude <anotherPluginClass>).
=back
=head1 DESCRIPTION
A simple script to install plugins from the command line
=cut