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 unless ( C4::Context->config("enable_plugins") ) {
  35     print
  36 "The plugin system must be enabled for one to be able to install plugins\n";
  37     exit 1;
  38 }
  39
  40
  41 my @existing_plugins = Koha::Plugins->new()->GetPlugins({
  42     all    => 1,
  43 });
  44 my $existing_plugins;
  45 for my $existing_plugin (@existing_plugins) {
  46     $existing_plugins->{ $existing_plugin->{metadata}->{name} } =
  47       $existing_plugin->{metadata}->{version};
  48 }
  49
  50 my @installed_plugins = Koha::Plugins->new()->InstallPlugins();
  51 unless (@installed_plugins) {
  52     my $plugins_dir = C4::Context->config("pluginsdir");
  53     if ( ref($plugins_dir) eq 'ARRAY' ) {
  54         print "No plugins found\n";
  55         print "pluginsdir contains: \n" . join( '\n', @{$plugins_dir} );
  56     }
  57     else {
  58         print "No plugins found at $plugins_dir\n";
  59     }
  60     exit 0;
  61 }
  62
  63 for my $installed_plugin (@installed_plugins) {
  64     if ( !exists( $existing_plugins->{ $installed_plugin->{metadata}->{name} } )
  65       )
  66     {
  67         print "Installed "
  68           . $installed_plugin->{metadata}->{name}
  69           . " version "
  70           . $installed_plugin->{metadata}->{version} . "\n";
  71     }
  72     elsif ( $existing_plugins->{ $installed_plugin->{metadata}->{name} } ne
  73         $installed_plugin->{metadata}->{version} )
  74     {
  75         print "Upgraded "
  76           . $installed_plugin->{metadata}->{name}
  77           . " from version "
  78           . $existing_plugins->{ $installed_plugin->{metadata}->{name} }
  79           . " to version "
  80           . $installed_plugin->{metadata}->{version} . "\n";
  81     }
  82 }
  83 print "All plugins successfully re-initialised\n";
  84
  85 =head1 NAME
  86
  87 install_plugins.pl - install all plugins found in plugins_dir
  88
  89 =head1 SYNOPSIS
  90
  91  install_plugins.pl
  92
  93 Options:
  94   -?|--help        brief help message
  95
  96 =head1 OPTIONS
  97
  98 =over 8
  99
 100 =item B<--help|-?>
 101
 102 Print a brief help message and exits
 103
 104 =back
 105
 106 =head1 DESCRIPTION
 107
 108 A simple script to install plugins from the command line
 109
 110 =cut