Bug 23846: Add a check to the data inconsistencies script
[koha.git] / Koha / Plugins.pm
1 package Koha::Plugins;
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 Class::Inspector;
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)$/;
27
28 use C4::Context;
29 use C4::Output;
30 use Koha::Plugins::Methods;
31
32 BEGIN {
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 '.';
37 }
38
39 =head1 NAME
40
41 Koha::Plugins - Module for loading and managing plugins.
42
43 =cut
44
45 sub new {
46     my ( $class, $args ) = @_;
47
48     return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
49
50     $args->{'pluginsdir'} = C4::Context->config("pluginsdir");
51
52     return bless( $args, $class );
53 }
54
55 =head2 GetPlugins
56
57 This will return a list of all available plugins, optionally limited by
58 method or metadata value.
59
60     my @plugins = Koha::Plugins::GetPlugins({
61         method => 'some_method',
62         metadata => { some_key => 'some_value' },
63     });
64
65 The method and metadata parameters are optional.
66 Available methods currently are: 'report', 'tool', 'to_marc', 'edifact'.
67 If you pass multiple keys in the metadata hash, all keys must match.
68
69 =cut
70
71 sub GetPlugins {
72     my ( $self, $params ) = @_;
73
74     my $method       = $params->{method};
75     my $req_metadata = $params->{metadata} // {};
76
77     my $filter = ( $method ) ? { plugin_method => $method } : undef;
78
79     my $plugin_classes = Koha::Plugins::Methods->search(
80         $filter,
81         {   columns  => 'plugin_class',
82             distinct => 1
83         }
84     )->_resultset->get_column('plugin_class');
85
86     my @plugins;
87
88     # Loop through all plugins that implement at least a method
89     while ( my $plugin_class = $plugin_classes->next ) {
90
91         load $plugin_class;
92         my $plugin = $plugin_class->new({
93             enable_plugins => $self->{'enable_plugins'}
94                 # loads even if plugins are disabled
95                 # FIXME: is this for testing without bothering to mock config?
96         });
97
98         next unless $plugin->is_enabled or
99                     defined($params->{all}) && $params->{all};
100
101         # filter the plugin out by metadata
102         my $plugin_metadata = $plugin->get_metadata;
103         next
104             if $plugin_metadata
105             and %$req_metadata
106             and any { !$plugin_metadata->{$_} || $plugin_metadata->{$_} ne $req_metadata->{$_} } keys %$req_metadata;
107
108         push @plugins, $plugin;
109
110     }
111
112     return @plugins;
113 }
114
115 =head2 InstallPlugins
116
117 Koha::Plugins::InstallPlugins()
118
119 This method iterates through all plugins physically present on a system.
120 For each plugin module found, it will test that the plugin can be loaded,
121 and if it can, will store its available methods in the plugin_methods table.
122
123 NOTE: We re-load all plugins here as a protective measure in case someone
124 has removed a plugin directly from the system without using the UI
125
126 =cut
127
128 sub InstallPlugins {
129     my ( $self, $params ) = @_;
130
131     my @plugin_classes = $self->plugins();
132     my @plugins;
133
134     foreach my $plugin_class (@plugin_classes) {
135         if ( can_load( modules => { $plugin_class => undef }, nocache => 1 ) ) {
136             next unless $plugin_class->isa('Koha::Plugins::Base');
137
138             my $plugin = $plugin_class->new({ enable_plugins => $self->{'enable_plugins'} });
139
140             Koha::Plugins::Methods->search({ plugin_class => $plugin_class })->delete();
141
142             foreach my $method ( @{ Class::Inspector->methods( $plugin_class, 'public' ) } ) {
143                 Koha::Plugins::Method->new(
144                     {
145                         plugin_class  => $plugin_class,
146                         plugin_method => $method,
147                     }
148                 )->store();
149             }
150
151             push @plugins, $plugin;
152         } else {
153             my $error = $Module::Load::Conditional::ERROR;
154             # Do not warn the error if the plugin has been uninstalled
155             warn $error unless $error =~ m|^Could not find or check module '$plugin_class'|;
156         }
157     }
158     return @plugins;
159 }
160
161 1;
162 __END__
163
164 =head1 AUTHOR
165
166 Kyle M Hall <kyle.m.hall@gmail.com>
167
168 =cut