Attachment #76956 for bug #21073

View | Details | Raw Unified | Return to bug 21073
Collapse All | Expand All

Lines 19-30 package Koha::Plugins; Link Here

(-)a/Koha/Plugins.pm (-7 / +41 lines)
19		19
20	use Modern::Perl;	20	use Modern::Perl;
21		21
		22	use Class::Inspector;
		23	use List::MoreUtils qw( any );
22	use Module::Load::Conditional qw(can_load);	24	use Module::Load::Conditional qw(can_load);
		25	use Module::Load qw(load);
23	use Module::Pluggable search_path => ['Koha::Plugin'], except => qr/::Edifact(\|::Line\|::Message\|::Order\|::Segment\|::Transport)$/;	26	use Module::Pluggable search_path => ['Koha::Plugin'], except => qr/::Edifact(\|::Line\|::Message\|::Order\|::Segment\|::Transport)$/;
24	use List::MoreUtils qw( any );
25		27
26	use C4::Context;	28	use C4::Context;
27	use C4::Output;	29	use C4::Output;
		30	use Koha::Plugins::Methods;
28		31
29	BEGIN {	32	BEGIN {
30	my $pluginsdir = C4::Context->config("pluginsdir");	33	my $pluginsdir = C4::Context->config("pluginsdir");
Lines 70-75 sub GetPlugins { Link Here
70	my $method = $params->{method};	73	my $method = $params->{method};
71	my $req_metadata = $params->{metadata} // {};	74	my $req_metadata = $params->{metadata} // {};
72		75
		76	my $dbh = C4::Context->dbh;
		77	my $plugin_classes = $dbh->selectcol_arrayref('SELECT DISTINCT(plugin_class) FROM plugin_methods');
		78	my @plugins;
		79
		80	foreach my $plugin_class (@$plugin_classes) {
		81	next if $method && !Koha::Plugins::Methods->search({ plugin_class => $plugin_class, plugin_method => $method })->count;
		82	load $plugin_class;
		83	my $plugin = $plugin_class->new({ enable_plugins => $self->{'enable_plugins'} });
		84	push @plugins, $plugin;
		85	}
		86	return @plugins;
		87	}
		88
		89	=head2
		90
		91	Koha::Plugins::InstallPlugins()
		92
		93	This method iterates through all plugins physically present on a system.
		94	For each plugin module found, it will test that the plugin can be loaded,
		95	and if it can, will store its available methods in the plugin_methods table.
		96
		97	=cut
		98
		99	sub InstallPlugins {
		100	my ( $self, $params ) = @_;
		101
73	my @plugin_classes = $self->plugins();	102	my @plugin_classes = $self->plugins();
74	my @plugins;	103	my @plugins;
75		104
Lines 79-90 sub GetPlugins { Link Here
79		108
80	my $plugin = $plugin_class->new({ enable_plugins => $self->{'enable_plugins'} });	109	my $plugin = $plugin_class->new({ enable_plugins => $self->{'enable_plugins'} });
81		110
82	# Limit results by method or metadata	111	Koha::Plugins::Methods->search({ plugin_class => $plugin_class })->delete();
83	next if $method && !$plugin->can($method);	112
84	my $plugin_metadata = $plugin->get_metadata;	113	foreach my $method ( @{ Class::Inspector->methods($plugin_class) } ) {
85	next if $plugin_metadata	114	Koha::Plugins::Method->new(
86	and %$req_metadata	115	{
87	and any { !$plugin_metadata->{$_} \|\| $plugin_metadata->{$_} ne $req_metadata->{$_} } keys %$req_metadata;	116	plugin_class => $plugin_class,
		117	plugin_method => $method,
		118	}
		119	)->store();
		120	}
		121
88	push @plugins, $plugin;	122	push @plugins, $plugin;
89	} else {	123	} else {
90	my $error = $Module::Load::Conditional::ERROR;	124	my $error = $Module::Load::Conditional::ERROR;





use File::Path qw(remove_tree);

use Module::Load qw(load);

use C4::Context;
use Koha::Plugins::Methods;

BEGIN {
    my $pluginsdir = C4::Context->config("pluginsdir");

    my $cgi           = $args->{'cgi'};
    my $params        = $args->{'params'};

    my $has_method = Koha::Plugins::Methods->search({ plugin_class => $plugin_class, plugin_method => $plugin_method })->count();
    if ( $has_method ) {
        load $plugin_class;
        my $plugin = $plugin_class->new( { cgi => $cgi, enable_plugins => $args->{'enable_plugins'} } );
        my @return = $plugin->$plugin_method( $params );
        return $plugin->$plugin_method( $params );
        } else {
            warn "Plugin does not have method $plugin_method";
        }
    } else {
        warn "Plugin does not have method $plugin_method";
        return undef;
    }
}


Lines 21-27 use Carp; Link Here

(-)a/Koha/Plugins/Methods.pm (-1 / +1 lines)
21		21
22	use Koha::Database;	22	use Koha::Database;
23		23
24	use Koha::City;	24	use Koha::Plugins::Method;
25		25
26	use base qw(Koha::Objects);	26	use base qw(Koha::Objects);
27		27




                    <dt><a href="/cgi-bin/koha/admin/cities.pl">Cities and towns</a></dt>
                    <dd>Define cities and towns that your patrons live in.</dd>
                </dl>
                [% IF CAN_user_plugins && plugins_enabled %]
                    <h3>Plugins</h3>
                    <dl>
                        <dt><a href="/cgi-bin/koha/plugins/plugins-home.pl">Manage plugins</a></dt>
                        <dd>View, manage, configure and run plugins.</dd>
                    </dl>
                [% END %]
                </div>
                <div class="col-md-6 sysprefs">
                <h3>Catalog</h3>

Lines 19-27 Link Here

(-)a/plugins/plugins-upload.pl (-2 / +5 lines)
19	use Modern::Perl;	19	use Modern::Perl;
20		20
21	use Archive::Extract;	21	use Archive::Extract;
22	use File::Temp;
23	use File::Copy;
24	use CGI qw ( -utf8 );	22	use CGI qw ( -utf8 );
		23	use Class::Inspector;
		24	use File::Copy;
		25	use File::Temp;
25		26
26	use C4::Context;	27	use C4::Context;
27	use C4::Auth;	28	use C4::Auth;
Lines 86-91 if ($plugins_enabled) { Link Here
86	$template->param( ERRORS => [ \%errors ] );	87	$template->param( ERRORS => [ \%errors ] );
87	output_html_with_http_headers $input, $cookie, $template->output;	88	output_html_with_http_headers $input, $cookie, $template->output;
88	exit;	89	exit;
		90	} else {
		91	Koha::Plugins->new()->InstallPlugins();
89	}	92	}
90	}	93	}
91	} elsif ( ( $op eq 'Upload' ) && !$uploadfile ) {	94	} elsif ( ( $op eq 'Upload' ) && !$uploadfile ) {

Lines 12-17 use Module::Load::Conditional qw(can_load); Link Here

(-)a/t/db_dependent/Plugins.t (-7 / +5 lines)
12	use Test::MockModule;	12	use Test::MockModule;
13		13
14	use C4::Context;	14	use C4::Context;
		15	use Koha::Plugins::Methods;
15		16
16	use t::lib::Mocks;	17	use t::lib::Mocks;
17		18
Lines 24-29 BEGIN { Link Here
24	use_ok('Koha::Plugin::Test');	25	use_ok('Koha::Plugin::Test');
25	}	26	}
26		27
		28	Koha::Plugins->new()->InstallPlugins();
		29
		30	ok( Koha::Plugins::Methods->search( { plugin_class => 'Koha::Plugin::Test' } )->count, 'Test plugin methods added to database' );
		31
27	my $mock_plugin = Test::MockModule->new( 'Koha::Plugin::Test' );	32	my $mock_plugin = Test::MockModule->new( 'Koha::Plugin::Test' );
28	$mock_plugin->mock( 'test_template', sub {	33	$mock_plugin->mock( 'test_template', sub {
29	my ( $self, $file ) = @_;	34	my ( $self, $file ) = @_;
Lines 80-91 is( scalar grep( /^Test Plugin$/, @names), 1, "Koha::Plugins::GetPlugins functio Link Here
80	});	85	});
81	@names = map { $_->get_metadata()->{'name'} } @plugins;	86	@names = map { $_->get_metadata()->{'name'} } @plugins;
82	is( scalar grep( /^Test Plugin$/, @names), 1, "GetPlugins also found Test Plugin via a metadata tag" );	87	is( scalar grep( /^Test Plugin$/, @names), 1, "GetPlugins also found Test Plugin via a metadata tag" );
83	# Test two metadata conditions; one does not exist for Test.pm
84	# Since it is a required key, we should not find the same results
85	my @plugins2 = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
86	metadata => { my_example_tag => 'find_me', not_there => '1' },
87	});
88	isnt( scalar @plugins2, scalar @plugins, 'GetPlugins with two metadata conditions' );
89		88
90	for my $pass ( 1 .. 2 ) {	89	for my $pass ( 1 .. 2 ) {
91	my $plugins_dir;	90	my $plugins_dir;
92	-

Return to bug 21073

Lines 21-29 use Modern::Perl; Link Here

(-)a/Koha/Plugins/Handler.pm (-8 / +9 lines)
21		21
22	use File::Path qw(remove_tree);	22	use File::Path qw(remove_tree);
23		23
24	use Module::Load::Conditional qw(can_load);	24	use Module::Load qw(load);
25		25
26	use C4::Context;	26	use C4::Context;
		27	use Koha::Plugins::Methods;
27		28
28	BEGIN {	29	BEGIN {
29	my $pluginsdir = C4::Context->config("pluginsdir");	30	my $pluginsdir = C4::Context->config("pluginsdir");
Lines 61-75 sub run { Link Here
61	my $cgi = $args->{'cgi'};	62	my $cgi = $args->{'cgi'};
62	my $params = $args->{'params'};	63	my $params = $args->{'params'};
63		64
64	if ( can_load( modules => { $plugin_class => undef } ) ) {	65	my $has_method = Koha::Plugins::Methods->search({ plugin_class => $plugin_class, plugin_method => $plugin_method })->count();
		66	if ( $has_method ) {
		67	load $plugin_class;
65	my $plugin = $plugin_class->new( { cgi => $cgi, enable_plugins => $args->{'enable_plugins'} } );	68	my $plugin = $plugin_class->new( { cgi => $cgi, enable_plugins => $args->{'enable_plugins'} } );
66	if ( $plugin->can($plugin_method) ) {	69	my @return = $plugin->$plugin_method( $params );
67	return $plugin->$plugin_method( $params );	70	return $plugin->$plugin_method( $params );
68	} else {
69	warn "Plugin does not have method $plugin_method";
70	}
71	} else {	71	} else {
72	warn "Plugin $plugin_class cannot be loaded";	72	warn "Plugin does not have method $plugin_method";
		73	return undef;
73	}	74	}
74	}	75	}
75		76

Lines 60-72 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/admin-home.tt (-2 lines)
60	<dt><a href="/cgi-bin/koha/admin/cities.pl">Cities and towns</a></dt>	60	<dt><a href="/cgi-bin/koha/admin/cities.pl">Cities and towns</a></dt>
61	<dd>Define cities and towns that your patrons live in.</dd>	61	<dd>Define cities and towns that your patrons live in.</dd>
62	</dl>	62	</dl>
63	[% IF CAN_user_plugins && plugins_enabled %]
64	<h3>Plugins</h3>	63	<h3>Plugins</h3>
65	<dl>	64	<dl>
66	<dt><a href="/cgi-bin/koha/plugins/plugins-home.pl">Manage plugins</a></dt>	65	<dt><a href="/cgi-bin/koha/plugins/plugins-home.pl">Manage plugins</a></dt>
67	<dd>View, manage, configure and run plugins.</dd>	66	<dd>View, manage, configure and run plugins.</dd>
68	</dl>	67	</dl>
69	[% END %]
70	</div>	68	</div>
71	<div class="col-md-6 sysprefs">	69	<div class="col-md-6 sysprefs">
72	<h3>Catalog</h3>	70	<h3>Catalog</h3>