misc/devel/install_plugins.pl

   1 #!/usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Copyright 2019 Koha Development Team
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21 use Getopt::Long;
  22 use Pod::Usage;
  23
  24 use Koha::Script;
  25
  26 use C4::Context;
  27 use Koha::Plugins;
  28
  29 my ($help);
  30 GetOptions( 'help|?' => \$help );
  31
  32 pod2usage(1) if $help;
  33
  34 my $plugins_enabled = C4::Context->preference('UseKohaPlugins')
  35   && C4::Context->config("enable_plugins");
  36 unless ($plugins_enabled) {
  37     print
  38 "The plugin system must be enabled for one to be able to install plugins\n";
  39     exit 1;
  40 }
  41
  42 my @existing_plugins = Koha::Plugins->new()->GetPlugins({
  43     all    => 1,
  44     errors => 1,
  45 });
  46 my $existing_plugins;
  47 for my $existing_plugin (@existing_plugins) {
  48     if( defined $existing_plugin->{error} ){
  49         print "Could not load: ".$existing_plugin->{name}." any associated method will be removed\n";
  50     } else {
  51         $existing_plugins->{ $existing_plugin->{metadata}->{name} } =
  52           $existing_plugin->{metadata}->{version};
  53     }
  54 }
  55
  56 my @installed_plugins = Koha::Plugins->new()->InstallPlugins();
  57 unless (@installed_plugins) {
  58     my $plugins_dir = C4::Context->config("pluginsdir");
  59     if ( ref($plugins_dir) eq 'ARRAY' ) {
  60         print "No plugins found\n";
  61         print "pluginsdir contains: \n" . join( '\n', @{$plugins_dir} );
  62     }
  63     else {
  64         print "No plugins found at $plugins_dir\n";
  65     }
  66     exit 0;
  67 }
  68
  69 for my $installed_plugin (@installed_plugins) {
  70     if ( !exists( $existing_plugins->{ $installed_plugin->{metadata}->{name} } )
  71       )
  72     {
  73         print "Installed "
  74           . $installed_plugin->{metadata}->{name}
  75           . " version "
  76           . $installed_plugin->{metadata}->{version} . "\n";
  77     }
  78     elsif ( $existing_plugins->{ $installed_plugin->{metadata}->{name} } ne
  79         $installed_plugin->{metadata}->{version} )
  80     {
  81         print "Upgraded "
  82           . $installed_plugin->{metadata}->{name}
  83           . " from version "
  84           . $existing_plugins->{ $installed_plugin->{metadata}->{name} }
  85           . " to version "
  86           . $installed_plugin->{metadata}->{version} . "\n";
  87     }
  88 }
  89 print "All plugins successfully re-initialised\n";
  90
  91 =head1 NAME
  92
  93 install_plugins.pl - install all plugins found in plugins_dir
  94
  95 =head1 SYNOPSIS
  96
  97  install_plugins.pl
  98
  99 Options:
 100   -?|--help        brief help message
 101
 102 =head1 OPTIONS
 103
 104 =over 8
 105
 106 =item B<--help|-?>
 107
 108 Print a brief help message and exits
 109
 110 =back
 111
 112 =head1 DESCRIPTION
 113
 114 A simple script to install plugins from the command line
 115
 116 =cut