Koha/misc/devel/install_plugins.pl
Nick Clemens 0eae966d25 Bug 25549: Remove plugin methods for broken plugins
To test:
 1 - Enable plugins in the koha-conf
 2 - Install the kitchen sink plugin
 3 - Your staff client should be orange now :-)
 4 - edit the plugin module
     /var/lib/koha/kohadev/plugins/Koha/Plugin/Com/ByWaterSolutions/KitchenSink.pm
 5 - Add a line to break compilation, like:
     this won't compile
 6 - Restart all
 7 - Your koha is now broken
 8 - kshell
 9 - perl misc/devel/install_plugins.pl
10 - Restart all
11 - Koha remains broken
12 - Apply patch
13 - kshell
14 - perl misc/devel/install_plugins.pl
15 - Koha now works!
16 - Koha is not orange because the plugin methods are removed

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2020-10-22 10:04:30 +02:00

114 lines
2.9 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;
use Pod::Usage;
use Koha::Script;
use C4::Context;
use Koha::Plugins;
my ($help);
GetOptions( 'help|?' => \$help );
pod2usage(1) if $help;
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,
errors => 1,
});
my $existing_plugins;
for my $existing_plugin (@existing_plugins) {
if( defined $existing_plugin->{error} ){
print "Could not load: ".$existing_plugin->{name}." any associated method will be removed\n";
} else {
$existing_plugins->{ $existing_plugin->{metadata}->{name} } =
$existing_plugin->{metadata}->{version};
}
}
my @installed_plugins = Koha::Plugins->new()->InstallPlugins();
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} );
}
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
=head1 OPTIONS
=over 8
=item B<--help|-?>
Print a brief help message and exits
=back
=head1 DESCRIPTION
A simple script to install plugins from the command line
=cut