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