Bug 23463: Replace new occurrence of AddItem
[srvgit] / Koha / Plugins.pm
index da336ad..9dc42c5 100644 (file)
@@ -19,14 +19,20 @@ package Koha::Plugins;
 
 use Modern::Perl;
 
+use Class::Inspector;
+use List::MoreUtils qw(any);
 use Module::Load::Conditional qw(can_load);
+use Module::Load qw(load);
 use Module::Pluggable search_path => ['Koha::Plugin'], except => qr/::Edifact(|::Line|::Message|::Order|::Segment|::Transport)$/;
 
 use C4::Context;
 use C4::Output;
+use Koha::Plugins::Methods;
 
 BEGIN {
-    push @INC, C4::Context->config("pluginsdir");
+    my $pluginsdir = C4::Context->config("pluginsdir");
+    my @pluginsdir = ref($pluginsdir) eq 'ARRAY' ? @$pluginsdir : $pluginsdir;
+    push( @INC, @pluginsdir );
     pop @INC if $INC[-1] eq '.';
 }
 
@@ -51,7 +57,7 @@ sub new {
 This will return a list of all available plugins, optionally limited by
 method or metadata value.
 
-    my @plugins = C4::Plugins::GetPlugins({
+    my @plugins = Koha::Plugins::GetPlugins({
         method => 'some_method',
         metadata => { some_key => 'some_value' },
     });
@@ -64,30 +70,89 @@ If you pass multiple keys in the metadata hash, all keys must match.
 
 sub GetPlugins {
     my ( $self, $params ) = @_;
-    my $method = $params->{method};
+
+    my $method       = $params->{method};
     my $req_metadata = $params->{metadata} // {};
 
+    my $filter = ( $method ) ? { plugin_method => $method } : undef;
+
+    my $plugin_classes = Koha::Plugins::Methods->search(
+        $filter,
+        {   columns  => 'plugin_class',
+            distinct => 1
+        }
+    )->_resultset->get_column('plugin_class');
+
+    my @plugins;
+
+    # Loop through all plugins that implement at least a method
+    while ( my $plugin_class = $plugin_classes->next ) {
+
+        load $plugin_class;
+        my $plugin = $plugin_class->new({
+            enable_plugins => $self->{'enable_plugins'}
+                # loads even if plugins are disabled
+                # FIXME: is this for testing without bothering to mock config?
+        });
+
+        next unless $plugin->is_enabled or
+                    defined($params->{all}) && $params->{all};
+
+        # filter the plugin out by metadata
+        my $plugin_metadata = $plugin->get_metadata;
+        next
+            if $plugin_metadata
+            and %$req_metadata
+            and any { !$plugin_metadata->{$_} || $plugin_metadata->{$_} ne $req_metadata->{$_} } keys %$req_metadata;
+
+        push @plugins, $plugin;
+
+    }
+
+    return @plugins;
+}
+
+=head2 InstallPlugins
+
+Koha::Plugins::InstallPlugins()
+
+This method iterates through all plugins physically present on a system.
+For each plugin module found, it will test that the plugin can be loaded,
+and if it can, will store its available methods in the plugin_methods table.
+
+NOTE: We re-load all plugins here as a protective measure in case someone
+has removed a plugin directly from the system without using the UI
+
+=cut
+
+sub InstallPlugins {
+    my ( $self, $params ) = @_;
+
     my @plugin_classes = $self->plugins();
     my @plugins;
 
     foreach my $plugin_class (@plugin_classes) {
-        if ( can_load( modules => { $plugin_class => undef } ) ) {
+        if ( can_load( modules => { $plugin_class => undef }, nocache => 1 ) ) {
             next unless $plugin_class->isa('Koha::Plugins::Base');
 
             my $plugin = $plugin_class->new({ enable_plugins => $self->{'enable_plugins'} });
 
-            # Limit results by method or metadata
-            my $ok = 1;
-            next if $method && !$plugin->can($method);
-            my $plugin_metadata = $plugin->get_metadata;
-            foreach my $key ( keys %$req_metadata ) {
-                if( !$plugin_metadata->{$key} ||
-                  $plugin_metadata->{$key} ne $req_metadata->{$key} ) {
-                    $ok = 0;
-                    last;
-                }
+            Koha::Plugins::Methods->search({ plugin_class => $plugin_class })->delete();
+
+            foreach my $method ( @{ Class::Inspector->methods( $plugin_class, 'public' ) } ) {
+                Koha::Plugins::Method->new(
+                    {
+                        plugin_class  => $plugin_class,
+                        plugin_method => $method,
+                    }
+                )->store();
             }
-            push( @plugins, $plugin ) if $ok;
+
+            push @plugins, $plugin;
+        } else {
+            my $error = $Module::Load::Conditional::ERROR;
+            # Do not warn the error if the plugin has been uninstalled
+            warn $error unless $error =~ m|^Could not find or check module '$plugin_class'|;
         }
     }
     return @plugins;