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>.
22 use Array::Utils qw( array_minus );
24 use List::MoreUtils qw( any );
25 use Module::Load::Conditional qw( can_load );
27 use Module::Pluggable search_path => ['Koha::Plugin'], except => qr/::Edifact(|::Line|::Message|::Order|::Segment|::Transport)$/;
33 use Koha::Cache::Memory::Lite;
34 use Koha::Exceptions::Plugin;
35 use Koha::Plugins::Methods;
37 use constant ENABLED_PLUGINS_CACHE_KEY => 'enabled_plugins';
40 my $pluginsdir = C4::Context->config("pluginsdir");
41 my @pluginsdir = ref($pluginsdir) eq 'ARRAY' ? @$pluginsdir : $pluginsdir;
42 push @INC, array_minus(@pluginsdir, @INC) ;
43 pop @INC if $INC[-1] eq '.';
48 Koha::Plugins - Module for loading and managing plugins.
57 my ( $class, $args ) = @_;
59 return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
61 $args->{'pluginsdir'} = C4::Context->config("pluginsdir");
63 return bless( $args, $class );
68 Calls a plugin method for all enabled plugins
70 @responses = Koha::Plugins->call($method, @args)
72 Note: Pass your arguments as refs, when you want subsequent plugins to use the value
73 updated by preceding plugins, provided that these plugins support that.
78 my ($class, $method, @args) = @_;
80 return unless C4::Context->config('enable_plugins');
83 my @plugins = $class->get_enabled_plugins();
84 @plugins = grep { $_->can($method) } @plugins;
86 # TODO: Remove warn when after_hold_create is removed from the codebase
87 warn "after_hold_create is deprecated and will be removed soon. Contact the following plugin's authors: " . join( ', ', map {$_->{metadata}->{name}} @plugins)
88 if $method eq 'after_hold_create' and @plugins;
90 foreach my $plugin (@plugins) {
91 my $response = eval { $plugin->$method(@args) };
93 warn sprintf("Plugin error (%s): %s", $plugin->get_metadata->{name}, $@);
97 push @responses, $response;
103 =head2 get_enabled_plugins
105 Returns a list of enabled plugins.
107 @plugins = Koha::Plugins->get_enabled_plugins( [ verbose => 1 ] );
111 sub get_enabled_plugins {
112 my ( $class, $params ) = @_;
114 return unless C4::Context->config('enable_plugins');
116 my $enabled_plugins = Koha::Cache::Memory::Lite->get_from_cache(ENABLED_PLUGINS_CACHE_KEY);
117 unless ($enabled_plugins) {
118 my $verbose = $params->{verbose} // $class->_verbose;
119 $enabled_plugins = [];
123 my $rs = Koha::Database->schema->resultset('PluginData');
124 $rs = $rs->search({ plugin_key => '__ENABLED__', plugin_value => 1 });
125 @plugin_classes = $rs->get_column('plugin_class')->all();
130 foreach my $plugin_class (@plugin_classes) {
131 next unless can_load( modules => { $plugin_class => undef }, verbose => $verbose, nocache => 1 );
133 my $plugin = eval { $plugin_class->new() };
134 if ($@ || !$plugin) {
135 warn "Failed to instantiate plugin $plugin_class: $@";
139 push @$enabled_plugins, $plugin;
141 Koha::Cache::Memory::Lite->set_in_cache(ENABLED_PLUGINS_CACHE_KEY, $enabled_plugins);
144 return @$enabled_plugins;
149 # Return false when running unit tests
150 return exists $ENV{_} && $ENV{_} =~ /\/prove(\s|$)|\.t$/ ? 0 : 1;
153 =head2 feature_enabled
155 Returns a boolean denoting whether a plugin based feature is enabled or not.
157 $enabled = Koha::Plugins->feature_enabled('method_name');
161 sub feature_enabled {
162 my ( $class, $method ) = @_;
164 return 0 unless C4::Context->config('enable_plugins');
166 my $key = "ENABLED_PLUGIN_FEATURE_" . $method;
167 my $feature = Koha::Cache::Memory::Lite->get_from_cache($key);
168 unless ( defined($feature) ) {
169 my @plugins = $class->get_enabled_plugins();
170 my $enabled = any { $_->can($method) } @plugins;
171 Koha::Cache::Memory::Lite->set_in_cache( $key, $enabled );
178 This will return a list of all available plugins, optionally limited by
179 method or metadata value.
181 my @plugins = Koha::Plugins::GetPlugins({
182 method => 'some_method',
183 metadata => { some_key => 'some_value' },
187 The method and metadata parameters are optional.
188 If you pass multiple keys in the metadata hash, all keys must match.
193 my ( $self, $params ) = @_;
195 my $method = $params->{method};
196 my $req_metadata = $params->{metadata} // {};
197 my $verbose = delete $params->{verbose} // $self->_verbose;
199 my $filter = ( $method ) ? { plugin_method => $method } : undef;
201 my $plugin_classes = Koha::Plugins::Methods->search(
203 { columns => 'plugin_class',
206 )->_resultset->get_column('plugin_class');
210 # Loop through all plugins that implement at least a method
211 while ( my $plugin_class = $plugin_classes->next ) {
213 if ( can_load( modules => { $plugin_class => undef }, verbose => $verbose, nocache => 1 ) ) {
216 my $failed_instantiation;
219 $plugin = $plugin_class->new({
220 enable_plugins => $self->{'enable_plugins'}
221 # loads even if plugins are disabled
222 # FIXME: is this for testing without bothering to mock config?
227 $failed_instantiation = 1;
230 next if $failed_instantiation;
232 next unless $plugin->is_enabled or
233 defined($params->{all}) && $params->{all};
235 # filter the plugin out by metadata
236 my $plugin_metadata = $plugin->get_metadata;
240 and any { !$plugin_metadata->{$_} || $plugin_metadata->{$_} ne $req_metadata->{$_} } keys %$req_metadata;
242 push @plugins, $plugin;
243 } elsif ( defined($params->{errors}) && $params->{errors} ){
244 push @plugins, { error => 'cannot_load', name => $plugin_class };
252 =head2 InstallPlugins
254 Koha::Plugins::InstallPlugins( [ verbose => 1 ] )
256 This method iterates through all plugins physically present on a system.
257 For each plugin module found, it will test that the plugin can be loaded,
258 and if it can, will store its available methods in the plugin_methods table.
260 NOTE: We reload all plugins here as a protective measure in case someone
261 has removed a plugin directly from the system without using the UI
266 my ( $self, $params ) = @_;
267 my $verbose = $params->{verbose} // $self->_verbose;
269 my @plugin_classes = $self->plugins();
272 foreach my $plugin_class (@plugin_classes) {
273 if ( can_load( modules => { $plugin_class => undef }, verbose => $verbose, nocache => 1 ) ) {
274 next unless $plugin_class->isa('Koha::Plugins::Base');
277 my $failed_instantiation;
280 $plugin = $plugin_class->new({ enable_plugins => $self->{'enable_plugins'} });
284 $failed_instantiation = 1;
287 next if $failed_instantiation;
289 Koha::Plugins::Methods->search({ plugin_class => $plugin_class })->delete();
291 foreach my $method ( @{ Class::Inspector->methods( $plugin_class, 'public' ) } ) {
292 Koha::Plugins::Method->new(
294 plugin_class => $plugin_class,
295 plugin_method => $method,
300 push @plugins, $plugin;
304 Koha::Cache::Memory::Lite->clear_from_cache(ENABLED_PLUGINS_CACHE_KEY);
314 Kyle M Hall <kyle.m.hall@gmail.com>