3 # Copyright 2012 Kyle Hall
5 # This file is part of Koha.
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.
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.
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>.
23 use List
::MoreUtils
qw(any);
24 use Module
::Load
::Conditional
qw(can_load);
25 use Module
::Load
qw(load);
26 use Module
::Pluggable search_path
=> ['Koha::Plugin'], except
=> qr/::Edifact(|::Line|::Message|::Order|::Segment|::Transport)$/;
30 use Koha
::Plugins
::Methods
;
33 my $pluginsdir = C4
::Context
->config("pluginsdir");
34 my @pluginsdir = ref($pluginsdir) eq 'ARRAY' ? @
$pluginsdir : $pluginsdir;
35 push( @INC, @pluginsdir );
36 pop @INC if $INC[-1] eq '.';
41 Koha::Plugins - Module for loading and managing plugins.
46 my ( $class, $args ) = @_;
48 return unless ( C4
::Context
->config("enable_plugins") || $args->{'enable_plugins'} );
50 $args->{'pluginsdir'} = C4
::Context
->config("pluginsdir");
52 return bless( $args, $class );
57 Calls a plugin method for all enabled plugins
59 @responses = Koha::Plugins->call($method, @args)
64 my ($class, $method, @args) = @_;
66 if (C4
::Context
->config('enable_plugins')) {
67 my @plugins = $class->new({ enable_plugins
=> 1 })->GetPlugins({ method
=> $method });
69 foreach my $plugin (@plugins) {
70 my $response = $plugin->$method(@args);
71 push @responses, $response;
80 This will return a list of all available plugins, optionally limited by
81 method or metadata value.
83 my @plugins = Koha::Plugins::GetPlugins({
84 method => 'some_method',
85 metadata => { some_key => 'some_value' },
88 The method and metadata parameters are optional.
89 Available methods currently are: 'report', 'tool', 'to_marc', 'edifact'.
90 If you pass multiple keys in the metadata hash, all keys must match.
95 my ( $self, $params ) = @_;
97 my $method = $params->{method
};
98 my $req_metadata = $params->{metadata
} // {};
100 my $filter = ( $method ) ?
{ plugin_method
=> $method } : undef;
102 my $plugin_classes = Koha
::Plugins
::Methods
->search(
104 { columns
=> 'plugin_class',
107 )->_resultset->get_column('plugin_class');
111 # Loop through all plugins that implement at least a method
112 while ( my $plugin_class = $plugin_classes->next ) {
115 my $plugin = $plugin_class->new({
116 enable_plugins
=> $self->{'enable_plugins'}
117 # loads even if plugins are disabled
118 # FIXME: is this for testing without bothering to mock config?
121 next unless $plugin->is_enabled or
122 defined($params->{all
}) && $params->{all
};
124 # filter the plugin out by metadata
125 my $plugin_metadata = $plugin->get_metadata;
129 and any
{ !$plugin_metadata->{$_} || $plugin_metadata->{$_} ne $req_metadata->{$_} } keys %$req_metadata;
131 push @plugins, $plugin;
138 =head2 InstallPlugins
140 Koha::Plugins::InstallPlugins()
142 This method iterates through all plugins physically present on a system.
143 For each plugin module found, it will test that the plugin can be loaded,
144 and if it can, will store its available methods in the plugin_methods table.
146 NOTE: We re-load all plugins here as a protective measure in case someone
147 has removed a plugin directly from the system without using the UI
152 my ( $self, $params ) = @_;
154 my @plugin_classes = $self->plugins();
157 foreach my $plugin_class (@plugin_classes) {
158 if ( can_load
( modules
=> { $plugin_class => undef }, nocache
=> 1 ) ) {
159 next unless $plugin_class->isa('Koha::Plugins::Base');
161 my $plugin = $plugin_class->new({ enable_plugins
=> $self->{'enable_plugins'} });
163 Koha
::Plugins
::Methods
->search({ plugin_class
=> $plugin_class })->delete();
165 foreach my $method ( @
{ Class
::Inspector
->methods( $plugin_class, 'public' ) } ) {
166 Koha
::Plugins
::Method
->new(
168 plugin_class
=> $plugin_class,
169 plugin_method
=> $method,
174 push @plugins, $plugin;
176 my $error = $Module::Load
::Conditional
::ERROR
;
177 # Do not warn the error if the plugin has been uninstalled
178 warn $error unless $error =~ m
|^Could
not find
or check module
'$plugin_class'|;
187 =head1 AVAILABLE HOOKS
189 =head2 after_hold_create
195 =item * C<$hold> - A Koha::Hold object that has just been inserted in database
205 sub after_hold_create {
206 my ($self, $hold) = @_;
208 warn "New hold for borrower " . $hold->borrower->borrowernumber;
213 Kyle M Hall <kyle.m.hall@gmail.com>