Koha-community
/
Koha
12
4
Fork 0
Code Issues Releases Wiki Activity
Browse Source

Bug 7804 - Add Koha Plugin System - QA Followup 2 

* Add "Plugins disabled" screen instead of error
* Allow plugins to return a value, add a test run that checks the return value

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>
3.12.x
Kyle Hall 10 years ago
committed by Jared Camins-Esakov
parent
171542059e
commit
58cc246e93
9 changed files with 104 additions and 61 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      Koha/Plugins.pm
  2. 2
      Koha/Plugins/Base.pm
  3. 4
      Koha/Plugins/Handler.pm
  4. 30
      koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-disabled.tt
  5. 25
      plugins/plugins-home.pl
  6. 77
      plugins/plugins-upload.pl
  7. 11
      plugins/run.pl
  8. 10
      t/Koha/Plugin/Test.pm
  9. 4
      t/db_dependent/Plugins.t

2
Koha/Plugins.pm
View File

@ -38,7 +38,7 @@ Koha::Plugins - Module for loading and managing plugins.
sub new {
my ( $class, $args ) = @_;
die('Plugins not enabled in config') unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
$args->{'pluginsdir'} = C4::Context->config("pluginsdir");

2
Koha/Plugins/Base.pm
View File

@ -39,7 +39,7 @@ C4::Plugins::Base - Base Module for plugins
sub new {
my ( $class, $args ) = @_;
die('Plugins not enabled in config') unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
$args->{'class'} = $class;
$args->{'template'} = Template->new( { ABSOLUTE => 1 } );

4
Koha/Plugins/Handler.pm
View File

@ -51,7 +51,7 @@ Runs a plugin
sub run {
my ( $class, $args ) = @_;
die('Plugins not enabled in config') unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
my $plugin_class = $args->{'class'};
my $plugin_method = $args->{'method'};
@ -60,7 +60,7 @@ sub run {
if ( can_load( modules => { $plugin_class => undef } ) ) {
my $plugin = $plugin_class->new( { cgi => $cgi } );
if ( $plugin->can($plugin_method) ) {
$plugin->$plugin_method();
return $plugin->$plugin_method();
} else {
warn "Plugin does not have method $plugin_method";
}

30
koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-disabled.tt
View File

@ -0,0 +1,30 @@
[% INCLUDE 'doc-head-open.inc' %]
<title>Koha &rsaquo; Tools &rsaquo; Plugins &rsaquo; Upload Plugin
</title>
[% INCLUDE 'doc-head-close.inc' %]
[% INCLUDE 'calendar.inc' %]
</head>
<body>
[% INCLUDE 'header.inc' %]
[% INCLUDE 'circ-search.inc' %]
<div id="breadcrumbs"><a href="/cgi-bin/koha/mainpage.pl">Home</a>
&rsaquo; <a href="/cgi-bin/koha/plugins/plugins-home.pl">Plugins</a>
&rsaquo; Plugins disabled
</div>
<div id="doc3" class="yui-t2">
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g">
<div class="yui-u first">
<h1>Plugins disabled!</h1>
<p>To enable Koha plugins, the system preference UseKohaPlugins must be enabled, and the flag enable_plugins must be set in the Koha configuration file</p>
</div>
</div>
</div>
</div>
[% INCLUDE 'intranet-bottom.inc' %]

25
plugins/plugins-home.pl
View File

@ -29,29 +29,32 @@ use C4::Dates;
use C4::Debug;
use C4::Context;
die("Koha plugins are disabled!")
unless C4::Context->preference('UseKohaPlugins');
my $plugins_enabled = C4::Context->preference('UseKohaPlugins') && C4::Context->config("enable_plugins");
my $input = new CGI;
my $method = $input->param('method');
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
{ template_name => "plugins/plugins-home.tmpl",
query => $input,
type => "intranet",
{ template_name => ($plugins_enabled) ? "plugins/plugins-home.tt" : "plugins/plugins-disabled.tt",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => { plugins => '*' },
debug => 1,
}
);
$template->param(
koha_version => C4::Context->preference("Version"),
method => $method,
);
if ($plugins_enabled) {
$template->param(
koha_version => C4::Context->preference("Version"),
method => $method,
);
my @plugins = Koha::Plugins->new()->GetPlugins($method);
my @plugins = Koha::Plugins->new()->GetPlugins($method);
$template->param( plugins => \@plugins, );
$template->param( plugins => \@plugins );
}
output_html_with_http_headers( $input, $cookie, $template->output );

77
plugins/plugins-upload.pl
View File

@ -1,4 +1,5 @@
#!/usr/bin/perl
#
# This file is part of Koha.
#
@ -30,15 +31,14 @@ use C4::Members;
use C4::Debug;
use Koha::Plugins;
die("Koha plugins are disabled!")
unless C4::Context->preference('UseKohaPlugins');
my $plugins_enabled = C4::Context->preference('UseKohaPlugins') && C4::Context->config("enable_plugins");
my $input = new CGI;
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{ template_name => "plugins/plugins-upload.tmpl",
query => $input,
type => "intranet",
{ template_name => ($plugins_enabled) ? "plugins/plugins-upload.tmpl" : "plugins/plugins-disabled.tt",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => { plugins => 'manage' },
debug => 1,
@ -53,46 +53,51 @@ my ( $total, $handled, @counts, $tempfile, $tfh );
my %errors;
if ( ( $op eq 'Upload' ) && $uploadfile ) {
my $plugins_dir = C4::Context->config("pluginsdir");
my $dirname = File::Temp::tempdir( CLEANUP => 1 );
$debug and warn "dirname = $dirname";
if ($plugins_enabled) {
if ( ( $op eq 'Upload' ) && $uploadfile ) {
my $plugins_dir = C4::Context->config("pluginsdir");
my $filesuffix;
$filesuffix = $1 if $uploadfilename =~ m/(\..+)$/i;
( $tfh, $tempfile ) = File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 );
my $dirname = File::Temp::tempdir( CLEANUP => 1 );
$debug and warn "dirname = $dirname";
$debug and warn "tempfile = $tempfile";
my $filesuffix;
$filesuffix = $1 if $uploadfilename =~ m/(\..+)$/i;
( $tfh, $tempfile ) = File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 );
$errors{'NOTKPZ'} = 1 if ( $uploadfilename !~ /\.kpz$/i );
$errors{'NOWRITETEMP'} = 1 unless ( -w $dirname );
$errors{'NOWRITEPLUGINS'} = 1 unless ( -w $plugins_dir );
$errors{'EMPTYUPLOAD'} = 1 unless ( length($uploadfile) > 0 );
$debug and warn "tempfile = $tempfile";
if (%errors) {
$template->param( ERRORS => [ \%errors ] );
} else {
while (<$uploadfile>) {
print $tfh $_;
}
close $tfh;
$errors{'NOTKPZ'} = 1 if ( $uploadfilename !~ /\.kpz$/i );
$errors{'NOWRITETEMP'} = 1 unless ( -w $dirname );
$errors{'NOWRITEPLUGINS'} = 1 unless ( -w $plugins_dir );
$errors{'EMPTYUPLOAD'} = 1 unless ( length($uploadfile) > 0 );
my $ae = Archive::Extract->new( archive => $tempfile, type => 'zip' );
unless ( $ae->extract( to => $plugins_dir ) ) {
warn "ERROR: " . $ae->error;
$errors{'UZIPFAIL'} = $uploadfilename;
if (%errors) {
$template->param( ERRORS => [ \%errors ] );
output_html_with_http_headers $input, $cookie, $template->output;
exit;
} else {
while (<$uploadfile>) {
print $tfh $_;
}
close $tfh;
my $ae = Archive::Extract->new( archive => $tempfile, type => 'zip' );
unless ( $ae->extract( to => $plugins_dir ) ) {
warn "ERROR: " . $ae->error;
$errors{'UZIPFAIL'} = $uploadfilename;
$template->param( ERRORS => [ \%errors ] );
output_html_with_http_headers $input, $cookie, $template->output;
exit;
}
}
} elsif ( ( $op eq 'Upload' ) && !$uploadfile ) {
warn "Problem uploading file or no file uploaded.";
}
if ( $uploadfile && !%errors && !$template->param('ERRORS') ) {
print $input->redirect("/cgi-bin/koha/plugins/plugins-home.pl");
} else {
output_html_with_http_headers $input, $cookie, $template->output;
}
} elsif ( ( $op eq 'Upload' ) && !$uploadfile ) {
warn "Problem uploading file or no file uploaded.";
}
if ( $uploadfile && !%errors && !$template->param('ERRORS') ) {
print $input->redirect("/cgi-bin/koha/plugins/plugins-home.pl");
} else {
output_html_with_http_headers $input, $cookie, $template->output;
}

11
plugins/run.pl
View File

@ -29,8 +29,7 @@ use C4::Dates;
use C4::Debug;
use C4::Context;
die("Koha plugins are disabled!")
unless C4::Context->preference('UseKohaPlugins');
my $plugins_enabled = C4::Context->preference('UseKohaPlugins') && C4::Context->config("enable_plugins");
my $cgi = new CGI;
@ -38,7 +37,7 @@ my $class = $cgi->param('class');
my $method = $cgi->param('method');
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
{ template_name => "plugins/plugins-home.tmpl",
{ template_name => "plugins/plugins-disabled.tmpl",
query => $cgi,
type => "intranet",
authnotrequired => 0,
@ -47,4 +46,8 @@ my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
}
);
my $plugin = Koha::Plugins::Handler->run( { class => $class, method => $method, cgi => $cgi } );
if ( $plugins_enabled ) {
my $plugin = Koha::Plugins::Handler->run( { class => $class, method => $method, cgi => $cgi } );
} else {
output_html_with_http_headers( $cgi, $cookie, $template->output );
}

10
t/Koha/Plugin/Test.pm
View File

@ -29,25 +29,25 @@ sub new {
sub report {
my ( $self, $args ) = @_;
return 1;
return "Koha::Plugin::Test::report";
}
sub tool {
my ( $self, $args ) = @_;
return 1;
return "Koha::Plugin::Test::tool";
}
sub configure {
my ( $self, $args ) = @_;
return 1;
return "Koha::Plugin::Test::configure";;
}
sub install {
my ( $self, $args ) = @_;
return 1;
return "Koha::Plugin::Test::install";
}
sub uninstall {
my ( $self, $args ) = @_;
return 1;
return "Koha::Plugin::Test::uninstall";
}

4
t/db_dependent/Plugins.t
View File

@ -3,7 +3,7 @@
use strict;
use warnings;
use Test::More tests => 15;
use Test::More tests => 16;
use File::Basename;
use Module::Load::Conditional qw(can_load);
@ -32,6 +32,8 @@ ok( $plugin->can('configure'), 'Test plugin can configure' );
ok( $plugin->can('install'), 'Test plugin can install' );
ok( $plugin->can('uninstall'), 'Test plugin can install' );
ok( Koha::Plugins::Handler->run({ class => "Koha::Plugin::Test", method => 'report' }) eq "Koha::Plugin::Test::report", 'Test run plugin report method' );
my $metadata = $plugin->get_metadata();
ok( $metadata->{'name'} eq 'Test Plugin', 'Test $plugin->get_metadata()' );

Write Preview
Loading…
Cancel
Save