Koha/Plugins/Handler.pm

   1 package Koha::Plugins::Handler;
   2
   3 # Copyright 2012 Kyle Hall
   4 #
   5 # This file is part of Koha.
   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
  22 use File::Path qw(remove_tree);
  23
  24 use Module::Load::Conditional qw(can_load);
  25
  26 use C4::Context;
  27
  28 BEGIN {
  29     my $pluginsdir = C4::Context->config("pluginsdir");
  30     my @pluginsdir = ref($pluginsdir) eq 'ARRAY' ? @$pluginsdir : $pluginsdir;
  31     push( @INC, @pluginsdir );
  32     pop @INC if $INC[-1] eq '.' ;
  33 }
  34
  35 =head1 NAME
  36
  37 Koha::Plugins::Handler - Handler Module for running plugins
  38
  39 =head1 SYNOPSIS
  40
  41   Koha::Plugins::Handler->run({ class => $class, method => $method, cgi => $cgi });
  42   $p->run();
  43
  44 =over 2
  45
  46 =cut
  47
  48 =item run
  49
  50 Runs a plugin
  51
  52 =cut
  53
  54 sub run {
  55     my ( $class, $args ) = @_;
  56
  57     return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
  58
  59     my $plugin_class  = $args->{'class'};
  60     my $plugin_method = $args->{'method'};
  61     my $cgi           = $args->{'cgi'};
  62     my $params        = $args->{'params'};
  63
  64     if ( can_load( modules => { $plugin_class => undef } ) ) {
  65         my $plugin = $plugin_class->new( { cgi => $cgi, enable_plugins => $args->{'enable_plugins'} } );
  66         if ( $plugin->can($plugin_method) ) {
  67             return $plugin->$plugin_method( $params );
  68         } else {
  69             warn "Plugin does not have method $plugin_method";
  70         }
  71     } else {
  72         warn "Plugin $plugin_class cannot be loaded";
  73     }
  74 }
  75
  76 =item delete
  77
  78 Deletes a plugin
  79
  80 =cut
  81
  82 sub delete {
  83     my ( $class, $args ) = @_;
  84
  85     return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
  86
  87     my $plugin_class = $args->{'class'};
  88
  89     my $plugin_path = $plugin_class;
  90     $plugin_path =~ s/::/\//g;  # Take class name, transform :: to / to get path
  91     $plugin_path =~ s/$/.pm/;   # Add .pm to the end
  92     require $plugin_path;   # Require the plugin to have it's path listed in INC
  93     $plugin_path =
  94       $INC{$plugin_path};   # Get the full true path to the plugin from INC
  95     $plugin_path =~ s/.pm//;    # Remove the .pm from the end
  96
  97     Koha::Plugins::Handler->run({
  98         class          => $plugin_class,
  99         method         => 'uninstall',
 100         enable_plugins => $args->{enable_plugins},
 101     });
 102
 103     C4::Context->dbh->do( "DELETE FROM plugin_data WHERE plugin_class = ?", undef, ($plugin_class) );
 104
 105     unlink "$plugin_path.pm" or warn "Could not unlink $plugin_path.pm: $!";
 106     remove_tree($plugin_path);
 107 }
 108
 109 1;
 110 __END__
 111
 112 =back
 113
 114 =head1 AUTHOR
 115
 116 Kyle M Hall <kyle.m.hall@gmail.com>
 117
 118 =cut