From 5eabc672fd818b312b3dbc8e2c19defcca97ed13 Mon Sep 17 00:00:00 2001 From: Kyle M Hall Date: Fri, 22 Jan 2010 16:34:52 +0000 Subject: [PATCH] Bug 7804 - Add Koha Plugin System Adds support for custom plugins. At the moment the Plugins feature supports two types of plugins, reports and tools. Plugins are installed by uploading KPZ ( Koha Plugin Zip ) packages. A KPZ file is just a zip file containing the perl files, template files, and any other files neccessary to make the plugin work. Test plan: 1) Apply patch 2) Run updatedatabase.pl 3) Create the directory /var/lib/koha/plugins 4) Add the lines /var/lib/koha/plugins 1" to your koha-conf.xml file 5) Add the line Alias /plugin/ "/var/lib/koha/plugins/" to your koha-httpd.conf file 6) Restart your webserver 7) Access the plugins system from the "More" pulldown 8) Upload the example plugin file provided here 9) Try it out! Signed-off-by: Bernardo Gonzalez Kriegel Signed-off-by: Jonathan Druart Signed-off-by: Kyle M Hall Signed-off-by: Jared Camins-Esakov --- C4/Auth.pm | 4 +- C4/Installer/PerlDependencies.pm | 40 ++++ C4/Templates.pm | 4 +- Koha/Plugins.pm | 87 ++++++++ Koha/Plugins/Base.pm | 190 ++++++++++++++++++ Koha/Plugins/Handler.pm | 100 +++++++++ Makefile.PL | 10 +- debian/templates/koha-conf-site.xml.in | 2 + etc/koha-conf.xml | 1 + etc/koha-httpd.conf | 1 + installer/data/mysql/kohastructure.sql | 11 + installer/data/mysql/sysprefs.sql | 1 + installer/data/mysql/updatedatabase.pl | 24 +++ .../intranet-tmpl/prog/en/includes/header.inc | 5 +- .../admin/preferences/enhanced_content.pref | 7 + .../prog/en/modules/plugins/plugins-home.tt | 116 +++++++++++ .../prog/en/modules/plugins/plugins-upload.tt | 55 +++++ .../prog/en/modules/reports/reports-home.tt | 11 +- .../prog/en/modules/tools/tools-home.tt | 5 + plugins/plugins-home.pl | 57 ++++++ plugins/plugins-uninstall.pl | 52 +++++ plugins/plugins-upload.pl | 98 +++++++++ plugins/run.pl | 50 +++++ rewrite-config.PL | 3 +- skel/var/lib/koha/plugins/README | 1 + 25 files changed, 929 insertions(+), 6 deletions(-) create mode 100644 Koha/Plugins.pm create mode 100644 Koha/Plugins/Base.pm create mode 100644 Koha/Plugins/Handler.pm create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-home.tt create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-upload.tt create mode 100755 plugins/plugins-home.pl create mode 100755 plugins/plugins-uninstall.pl create mode 100755 plugins/plugins-upload.pl create mode 100755 plugins/run.pl create mode 100644 skel/var/lib/koha/plugins/README diff --git a/C4/Auth.pm b/C4/Auth.pm index 27aa39b217..2984570469 100644 --- a/C4/Auth.pm +++ b/C4/Auth.pm @@ -133,7 +133,7 @@ EOQ sub get_template_and_user { my $in = shift; my $template = - C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} ); + C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'}, $in->{'is_plugin'} ); my ( $user, $cookie, $sessionID, $flags ); if ( $in->{'template_name'} !~m/maintenance/ ) { ( $user, $cookie, $sessionID, $flags ) = checkauth( @@ -202,6 +202,7 @@ sub get_template_and_user { $template->param( CAN_user_serials => 1 ); $template->param( CAN_user_reports => 1 ); $template->param( CAN_user_staffaccess => 1 ); + $template->param( CAN_user_plugins => 1 ); foreach my $module (keys %$all_perms) { foreach my $subperm (keys %{ $all_perms->{$module} }) { $template->param( "CAN_user_${module}_${subperm}" => 1 ); @@ -366,6 +367,7 @@ sub get_template_and_user { OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'), AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'), EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'), + UseKohaPlugins => C4::Context->preference('UseKohaPlugins'), ); } else { diff --git a/C4/Installer/PerlDependencies.pm b/C4/Installer/PerlDependencies.pm index 83ba962776..f240f25f20 100644 --- a/C4/Installer/PerlDependencies.pm +++ b/C4/Installer/PerlDependencies.pm @@ -634,6 +634,46 @@ our $PERL_DEPS = { 'required' => '1', 'min_ver' => '0.22', }, + 'File::Temp' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '0.22', + }, + 'File::Copy' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '2.08', + }, + 'File::Path' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '2.07', + }, + 'Archive::Extract' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '0.60', + }, + 'Archive::Zip' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '1.30', + }, + 'Module::Load::Conditional' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '0.38', + }, + 'Module::Bundled::Files' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '0.03', + }, + 'Module::Pluggable' => { + 'usage' => 'Plugins', + 'required' => '0', + 'min_ver' => '3.9', + }, }; 1; diff --git a/C4/Templates.pm b/C4/Templates.pm index 78dcdddd03..88b9b01687 100644 --- a/C4/Templates.pm +++ b/C4/Templates.pm @@ -228,13 +228,15 @@ sub _get_template_file { sub gettemplate { - my ( $tmplbase, $interface, $query ) = @_; + my ( $tmplbase, $interface, $query, $is_plugin ) = @_; ($query) or warn "no query in gettemplate"; my $path = C4::Context->preference('intranet_includes') || 'includes'; $tmplbase =~ s/\.tmpl$/.tt/; my ($htdocs, $theme, $lang, $filename) = _get_template_file($tmplbase, $interface, $query); + $filename = $tmplbase if ( $is_plugin ); my $template = C4::Templates->new($interface, $filename, $tmplbase, $query); + # NOTE: Commenting these out rather than deleting them so that those who need # to know how we previously shimmed these directories will be able to understand. # my $is_intranet = $interface eq 'intranet'; diff --git a/Koha/Plugins.pm b/Koha/Plugins.pm new file mode 100644 index 0000000000..797f60012c --- /dev/null +++ b/Koha/Plugins.pm @@ -0,0 +1,87 @@ +package Koha::Plugins; + +# Copyright 2012 Kyle Hall +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it under the +# terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# Koha is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use Modern::Perl; + +use Module::Load::Conditional qw(can_load); +use Module::Pluggable search_path => ['Koha::Plugin']; + +use C4::Context; +use C4::Output; + +BEGIN { + die('Plugins not enabled in config') unless ( C4::Context->config("enable_plugins") ); + + push @INC, C4::Context->config("pluginsdir"); +} + +=head1 NAME + +Koha::Plugins - Module for loading and managing plugins. + +=cut + +sub new { + my ( $class, $args ) = @_; + + $args->{'pluginsdir'} = C4::Context->config("pluginsdir"); + + return bless( $args, $class ); +} + +=head2 GetPlugins() + +This will return a list of all the available plugins of the passed type. + +Usage: my @plugins = C4::Plugins::GetPlugins( $method ); + +At the moment, the available types are 'report' and 'tool'. +=cut + +sub GetPlugins { + my $self = shift; + my $method = shift; + + my @plugin_classes = $self->plugins(); + my @plugins; + + foreach my $plugin_class (@plugin_classes) { + if ( can_load( modules => { $plugin_class => undef } ) ) { + my $plugin = $plugin_class->new(); + + if ($method) { + if ( $plugin->can($method) ) { + push( @plugins, $plugin ); + } + } else { + push( @plugins, $plugin ); + } + } + } + return @plugins; +} + +1; +__END__ + +=head1 AUTHOR + +Kyle M Hall + +=cut diff --git a/Koha/Plugins/Base.pm b/Koha/Plugins/Base.pm new file mode 100644 index 0000000000..f1cff3b9cb --- /dev/null +++ b/Koha/Plugins/Base.pm @@ -0,0 +1,190 @@ +package Koha::Plugins::Base; + +# Copyright 2012 Kyle Hall +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it under the +# terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# Koha is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use Modern::Perl; + +use Module::Pluggable require => 1; + +use base qw{Module::Bundled::Files}; + +use C4::Context; +use C4::Auth; + +BEGIN { + die('Plugins not enabled in config') unless ( C4::Context->config("enable_plugins") ); + + push @INC, C4::Context->config("pluginsdir"); +} + +=head1 NAME + +C4::Plugins::Base - Base Module for plugins + +=cut + +sub new { + my ( $class, $args ) = @_; + + $args->{'class'} = $class; + $args->{'template'} = Template->new( { ABSOLUTE => 1 } ); + + my $self = bless( $args, $class ); + + ## Run the installation method if it exists and hasn't been run before + if ( $self->can('install') && !$self->retrieve_data('__INSTALLED__') ) { + if ( $self->install() ) { + $self->store_data( { '__INSTALLED__' => 1 } ); + } else { + warn "Plugin $class failed during installation!"; + } + } + + return $self; +} + +=head2 store_data + +set_data allows a plugin to store key value pairs in the database for future use. + +usage: $self->set_data({ param1 => 'param1val', param2 => 'param2value' }) + +=cut + +sub store_data { + my ( $self, $data ) = @_; + + my $dbh = C4::Context->dbh; + my $sql = "REPLACE INTO plugin_data SET plugin_class = ?, plugin_key = ?, plugin_value = ?"; + my $sth = $dbh->prepare($sql); + + foreach my $key ( keys %$data ) { + $sth->execute( $self->{'class'}, $key, $data->{$key} ); + } +} + +=head2 retrieve_data + +retrieve_data allows a plugin to read the values that were previously saved with store_data + +usage: my $value = $self->retrieve_data( $key ); + +=cut + +sub retrieve_data { + my ( $self, $key ) = @_; + + my $dbh = C4::Context->dbh; + my $sql = "SELECT plugin_value FROM plugin_data WHERE plugin_class = ? AND plugin_key = ?"; + my $sth = $dbh->prepare($sql); + $sth->execute( $self->{'class'}, $key ); + my $row = $sth->fetchrow_hashref(); + + return $row->{'plugin_value'}; +} + +=head2 get_template + +get_template returns a Template object. Eventually this will probably be calling +C4:Template, but at the moment, it does not. + +=cut + +sub get_template { + my ( $self, $args ) = @_; + + # my $template = + # C4::Templates->new( my $interface = 'intranet', my $filename = $self->mbf_path( $args->{'file'} ), my $tmplbase = '', my $query = $self->{'cgi'} ); + + my ( $template, $loggedinuser, $cookie ) = get_template_and_user( + { template_name => $self->mbf_path( $args->{'file'} ), + query => $self->{'cgi'}, + type => "intranet", + authnotrequired => 1, +# flagsrequired => { tools => '*' }, + is_plugin => 1, + } + ); + + $template->param( + CLASS => $self->{'class'}, + METHOD => $self->{'cgi'}->param('method'), + PLUGIN_PATH => $self->get_plugin_http_path(), + ); + + return $template; +} + +sub get_metadata { + my ( $self, $args ) = @_; + + return $self->{'metadata'}; +} + +=head2 get_qualified_table_name + +To avoid naming conflict, each plugins tables should use a fully qualified namespace. +To avoid hardcoding and make plugins more flexible, this method will return the proper +fully qualified table name. + +usage: my $table = $self->get_qualified_table_name( 'myTable' ); + +=cut + +sub get_qualified_table_name { + my ( $self, $table_name ) = @_; + + return lc( join( '_', split( '::', $self->{'class'} ), $table_name ) ); +} + +=head2 get_plugin_http_path + +To access a plugin's own resources ( images, js files, css files, etc... ) +a plugin will need to know what path to use in the template files. This +method returns that path. + +usage: my $path = $self->get_plugin_http_path(); + +=cut + +sub get_plugin_http_path { + my ($self) = @_; + + return "/plugin/" . join( '/', split( '::', $self->{'class'} ) ); +} + +=head2 go_home + + go_home is a quick redirect to the Koha plugins home page + +=cut + +sub go_home { + my ( $self, $params ) = @_; + + print $self->{'cgi'}->redirect("/cgi-bin/koha/plugins/plugins-home.pl"); +} + +1; +__END__ + +=head1 AUTHOR + +Kyle M Hall + +=cut diff --git a/Koha/Plugins/Handler.pm b/Koha/Plugins/Handler.pm new file mode 100644 index 0000000000..7ecdb793ef --- /dev/null +++ b/Koha/Plugins/Handler.pm @@ -0,0 +1,100 @@ +package Koha::Plugins::Handler; + +# Copyright 2012 Kyle Hall +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it under the +# terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# Koha is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use Modern::Perl; + +use File::Path qw(remove_tree); + +use Module::Load::Conditional qw(can_load); + +use C4::Context; + +BEGIN { + die('Plugins not enabled in config') unless ( C4::Context->config("enable_plugins") ); + + push @INC, C4::Context->config("pluginsdir"); +} + +=head1 NAME + +C4::Plugins::Handler - Handler Module for running plugins + +=head1 SYNOPSIS + + Koha::Plugins::Handler->run({ class => $class, method => $method, cgi => $cgi }); + $p->run(); + +=over 2 + +=cut + +=item run + +Runs a plugin + +=cut + +sub run { + my ( $class, $args ) = @_; + my $plugin_class = $args->{'class'}; + my $plugin_method = $args->{'method'}; + my $cgi = $args->{'cgi'}; + + if ( can_load( modules => { $plugin_class => undef } ) ) { + my $plugin = $plugin_class->new( { cgi => $cgi } ); + if ( $plugin->can($plugin_method) ) { + $plugin->$plugin_method(); + } else { + warn "Plugin does not have method $plugin_method"; + } + } else { + warn "Plugin $plugin_class cannot be loaded"; + } +} + +=item delete + +Deletes a plugin + +=cut + +sub delete { + my ( $class, $args ) = @_; + my $plugin_class = $args->{'class'}; + my $plugin_dir = C4::Context->config("pluginsdir"); + my $plugin_path = "$plugin_dir/" . join( '/', split( '::', $args->{'class'} ) ); + + Koha::Plugins::Handler->run( { class => $plugin_class, method => 'uninstall' } ); + + C4::Context->dbh->do( "DELETE FROM plugin_data WHERE plugin_class = ?", undef, ($plugin_class) ); + + unlink("$plugin_path.pm"); + remove_tree($plugin_path); +} + +1; +__END__ + +=back + +=head1 AUTHOR + +Kyle M Hall + +=cut diff --git a/Makefile.PL b/Makefile.PL index 02e96890cc..b69dfad35a 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -230,6 +230,10 @@ Directory for Apache and Zebra logs produced by Koha. Directory for backup files produced by Koha. +=item PLUGINS_DIR + +Directory for external Koha plugins. + =item PAZPAR2_CONF_DIR Directory for PazPar2 configuration files. @@ -310,6 +314,7 @@ my $target_map = { './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 }, './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 }, './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 }, + './skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 }, './sms' => 'INTRANET_CGI_DIR', './suggestion' => 'INTRANET_CGI_DIR', './svc' => 'INTRANET_CGI_DIR', @@ -1235,6 +1240,7 @@ sub get_target_directories { $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb'); $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log'); $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool'); + $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'koha', 'plugins'); $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb'); $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb'); } elsif ($mode eq 'dev') { @@ -1265,6 +1271,7 @@ sub get_target_directories { $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb'); $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log'); $dirmap{'BACKUP_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'spool'); + $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'plugins'); $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb'); $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb'); } else { @@ -1287,6 +1294,7 @@ sub get_target_directories { $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb'); $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package); $dirmap{'BACKUP_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'spool', $package); + $dirmap{'PLUGINS_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'plugins'); $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb'); $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb'); } @@ -1560,7 +1568,7 @@ make_upgrade_backup :: \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\ /; foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR - PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) { + PAZPAR2_CONF_DIR ZEBRA_CONF_DIR PLUGINS_DIR/) { $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key} or diff --git a/debian/templates/koha-conf-site.xml.in b/debian/templates/koha-conf-site.xml.in index 2d7d12416c..f3da6ec421 100644 --- a/debian/templates/koha-conf-site.xml.in +++ b/debian/templates/koha-conf-site.xml.in @@ -257,6 +257,8 @@ 1 authorities 1 + __PLUGINS_DIR__ + 0 /usr/share/koha/intranet/cgi-bin /usr/share/koha/opac/cgi-bin/opac /usr/share/koha/opac/htdocs/opac-tmpl diff --git a/etc/koha-conf.xml b/etc/koha-conf.xml index ad7bce706c..73d67bf7eb 100644 --- a/etc/koha-conf.xml +++ b/etc/koha-conf.xml @@ -276,6 +276,7 @@ __PAZPAR2_TOGGLE_XML_POST__ 1 authorities 1 + __PLUGINS_DIR__ __INTRANET_CGI_DIR__ __OPAC_CGI_DIR__/opac __OPAC_TMPL_DIR__ diff --git a/etc/koha-httpd.conf b/etc/koha-httpd.conf index dc82d08a39..0e7af51d85 100644 --- a/etc/koha-httpd.conf +++ b/etc/koha-httpd.conf @@ -105,6 +105,7 @@ ScriptAlias /cgi-bin/koha/ "__INTRANET_CGI_DIR__/" ScriptAlias /index.html "__INTRANET_CGI_DIR__/mainpage.pl" ScriptAlias /search "__INTRANET_CGI_DIR__/search.pl" + Alias /plugin/ "__PLUGINS_DIR__/" ErrorLog __LOG_DIR__/koha-error_log # TransferLog __LOG_DIR__/koha-access.log SetEnv KOHA_CONF "__KOHA_CONF_DIR__/koha-conf.xml" diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql index 4872a1f491..c74c39bbc5 100644 --- a/installer/data/mysql/kohastructure.sql +++ b/installer/data/mysql/kohastructure.sql @@ -3063,6 +3063,17 @@ CREATE TABLE linktracker ( KEY dateidx (timeclicked) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; +-- +-- Table structure for table 'plugin_data' +-- + +CREATE TABLE IF NOT EXISTS plugin_data ( + plugin_class varchar(255) NOT NULL, + plugin_key varchar(255) NOT NULL, + plugin_value text, + PRIMARY KEY (plugin_class,plugin_key) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; + /*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */; /*!40101 SET SQL_MODE=@OLD_SQL_MODE */; /*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */; diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql index 0189c6b5f7..df821c0ffe 100644 --- a/installer/data/mysql/sysprefs.sql +++ b/installer/data/mysql/sysprefs.sql @@ -418,3 +418,4 @@ INSERT IGNORE INTO systempreferences (variable,value,explanation,options,type) V INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('UseQueryParser', '0', 'If enabled, try to use QueryParser for queries.', NULL, 'YesNo'); INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('FinesIncludeGracePeriod','1','If enabled, fines calculations will include the grace period.',NULL,'YesNo'); INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES ('UNIMARCAuthorsFacetsSeparator',', ', 'UNIMARC authors facets separator', NULL, 'short'); +INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('UseKohaPlugins','1','Enable or disable the ability to use Koha Plugins.','','YesNo'); diff --git a/installer/data/mysql/updatedatabase.pl b/installer/data/mysql/updatedatabase.pl index d6c18d1864..6c576fa540 100755 --- a/installer/data/mysql/updatedatabase.pl +++ b/installer/data/mysql/updatedatabase.pl @@ -6631,6 +6631,30 @@ if ( CheckVersion($DBversion) ) { } +$DBversion = "3.11.00.XXX"; +if ( C4::Context->preference("Version") < TransformToNum($DBversion) ) { + $dbh->do("INSERT INTO userflags (bit, flag, flagdesc, defaulton) VALUES ('19', 'plugins', 'Koha plugins', '0')"); + $dbh->do("INSERT INTO permissions (module_bit, code, description) VALUES + ('19', 'manage', 'Manage plugins ( install / uninstall )'), + ('19', 'tool', 'Use tool plugins'), + ('19', 'report', 'Use report plugins'), + ('19', 'configure', 'Configure plugins') + "); + $dbh->do("INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('UseKohaPlugins','1','Enable or disable the ability to use Koha Plugins.','','YesNo')"); + + $dbh->do(" + CREATE TABLE IF NOT EXISTS plugin_data ( + plugin_class varchar(255) NOT NULL, + plugin_key varchar(255) NOT NULL, + plugin_value text, + PRIMARY KEY (plugin_class,plugin_key) + ) ENGINE=InnoDB DEFAULT CHARSET=utf8; + "); + + print "Upgrade to $DBversion done (Bug 7804: Added plugin system.)\n"; + SetVersion($DBversion); +} + =head1 FUNCTIONS =head2 TableExists($table) diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc index f4ab3f2d96..d75b36e131 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/header.inc @@ -30,6 +30,9 @@ [% IF ( CAN_user_tools ) %]
  • Tools
    • [% END %] + [% IF ( UseKohaPlugins && CAN_user_plugins ) %] +
  • Plugins
    • + [% END %] [% IF ( CAN_user_parameters ) %]
  • Administration
    • [% END %] @@ -93,4 +96,4 @@ [% IF ( intranetbookbag ) %]
    Your cart is empty.
    [% END %] - \ No newline at end of file + diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/enhanced_content.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/enhanced_content.pref index 74e6553c14..ba6a6acf96 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/enhanced_content.pref +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/enhanced_content.pref @@ -319,3 +319,10 @@ Enhanced Content: - pref: HTML5MediaExtensions class: multi - (separated with |). + Plugins: + - + - pref: UseKohaPlugins + choices: + yes: Enable + no: "Don't enable" + - the ability to use Koha Plugins. Note, the plugin system must also be enabled in the Koha configuration file to be fully enabled. diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-home.tt new file mode 100644 index 0000000000..7f9a5814b7 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-home.tt @@ -0,0 +1,116 @@ +[% USE KohaDates %] +[% INCLUDE 'doc-head-open.inc' %] +Koha › Tools › Plugins +[% INCLUDE 'doc-head-close.inc' %] +[% INCLUDE 'calendar.inc' %] + + + +[% INCLUDE 'header.inc' %] +[% INCLUDE 'circ-search.inc' %] + + + +
    +
    +
    +
    +
    +

    Plugins

    + + [% UNLESS ( plugins ) %] + [% UNLESS ( method ) %] +

    No plugins installed

    + [% ELSE %] + [% IF method == 'tool' %] +

    No plugins that can be used as a tool are installed

    + [% ELSIF method == 'report' %] +

    No plugins that can create a report are installed

    + [% ELSE %] +

    Unknown plugin type [% method %] + [% END %] + [% END %] + [% ELSE %] + + + + + + + + + + + [% IF ( CAN_user_plugins_configure ) %][% END %] + [% IF ( CAN_user_plugins_manage ) %][% END %] + + + [% FOREACH plugin IN plugins %] + + + + + + + + + + [% IF ( CAN_user_plugins_configure ) %] + + [% END %] + [% IF ( CAN_user_plugins_manage ) %] + + [% END %] + [% END %] +
    Name DescriptionAuthorPlugin VersionMinimum Koha VersionMaximum Koha VersionLast UpdatedConfigureUninstall
    [% plugin.metadata.name %] + [% IF ( CAN_user_plugins_report ) %] + [% IF plugin.can('report') %] +

    Run report

    + [% END %] + [% END %] + + [% IF ( CAN_user_plugins_tool ) %] + [% IF plugin.can('tool') %] +

    Run tool

    + [% END %] + [% END %] +     		+ [% plugin.metadata.description %] + + [% IF ( plugin.metadata.minimum_version && koha_version < plugin.metadata.minimum_version ) %] +
    Warning: This report was written for a newer version of Koha. Run at your own risk.
    + [% END %] + + [% IF ( plugin.metadata.maximum_version && koha_version > plugin.metadata.maximum_version ) %] +
    Warning: This report was written for an older version of Koha. Run at your own risk.
    + [% END %] +     		[% plugin.metadata.author %][% plugin.metadata.version %][% plugin.metadata.minimum_version %][% plugin.metadata.maximum_version %][% plugin.metadata.date_updated | $KohaDates %] + [% IF plugin.can('configure') %] + Configure + [% END %] + + [% IF plugin.can('uninstall') %] + Uninstall + [% END %] +
    + [% END %] +

    +
    +
    + +
    + +
    +
    +
    + + +[% INCLUDE 'intranet-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-upload.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-upload.tt new file mode 100644 index 0000000000..94d33737ea --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/plugins/plugins-upload.tt @@ -0,0 +1,55 @@ +[% INCLUDE 'doc-head-open.inc' %] +Koha › Tools › Plugins › Upload Plugin + +[% INCLUDE 'doc-head-close.inc' %] +[% INCLUDE 'calendar.inc' %] + + + +[% INCLUDE 'header.inc' %] +[% INCLUDE 'circ-search.inc' %] + + + +
    +
    +
    +
    +
    +
    +

    Upload Koha Plugin

    + [% IF ( ERRORS ) %] +
    + [% FOREACH ERROR IN ERRORS %] + [% IF ( ERROR.NOTKPZ ) %]
  • The upload file does not appear to be a kpz file. The extention is not '.kpz'.
    • + [% ELSIF ( ERROR.NOWRITETEMP ) %]
  • This script is not able to create/write to the necessary temporary directory.
    • + [% ELSIF ( ERROR.EMPTYUPLOAD ) %]
  • The upload file appears to be empty.
    • + [% ELSIF ( ERROR.UZIPFAIL ) %]
  • [% ERROR.UZIPFAIL %] failed to unpack.
    Please verify the integrity of the zip file and retry.
    • + [% ELSIF ( ERROR.NOWRITEPLUGINS ) %]
  • Cannot unpack file to the plugins directory.
    Please verify that the Apache user can write to the plugins directory.
    • + [% ELSE %]
  • [% ERROR.CORERR %] An unknown error has occurred.
    Please review the error log for more details.
    • [% END %] + [% END %] +
    + [% END %] +
    +
    +
    NOTE: Only KPZ file format is supported.
    +
      +
    1. + +
      2. +
    +
    +
    + + +
    +
    + +
    +
    +
    +
    +[% INCLUDE 'intranet-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/reports-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/reports-home.tt index 32c1803ebc..c7744faeae 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/reports-home.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/reports-home.tt @@ -35,7 +35,16 @@
  • Circulation
  • Serials
  • Holds
    • -
    + + + [% IF UseKohaPlugins %] +

    Report Plugins

    + + [% END %] + +

    Top lists

      diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/tools-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/tools-home.tt index 31124a9cca..4fff72184c 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/tools-home.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/tools-home.tt @@ -97,6 +97,11 @@
      Quote editor for Quote-of-the-day feature in OPAC
      [% END %] + [% IF ( UseKohaPlugins && CAN_user_plugins_tool ) %] +
      Tool Plugins
      +
      Use tool plugins
      + [% END %] +
    diff --git a/plugins/plugins-home.pl b/plugins/plugins-home.pl new file mode 100755 index 0000000000..8b7a42adbc --- /dev/null +++ b/plugins/plugins-home.pl @@ -0,0 +1,57 @@ +#!/usr/bin/perl + +# Copyright 2010 Kyle M Hall +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it under the +# terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# Koha is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use strict; +use warnings; + +use CGI; + +use Koha::Plugins; +use C4::Auth; +use C4::Output; +use C4::Dates; +use C4::Debug; +use C4::Context; + +die("Koha plugins are disabled!") + unless C4::Context->preference('UseKohaPlugins'); + +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", + authnotrequired => 0, + flagsrequired => { plugins => '*' }, + debug => 1, + } +); + +$template->param( + koha_version => C4::Context->preference("Version"), + method => $method, +); + +my @plugins = Koha::Plugins->new()->GetPlugins($method); + +$template->param( plugins => \@plugins ); + +output_html_with_http_headers( $input, $cookie, $template->output ); diff --git a/plugins/plugins-uninstall.pl b/plugins/plugins-uninstall.pl new file mode 100755 index 0000000000..63240103e7 --- /dev/null +++ b/plugins/plugins-uninstall.pl @@ -0,0 +1,52 @@ +#!/usr/bin/perl +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it under the +# terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# Koha is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use strict; +use warnings; + +use Archive::Extract; +use File::Temp; +use File::Copy; +use CGI; + +use C4::Context; +use C4::Auth; +use C4::Output; +use C4::Members; +use C4::Debug; +use Koha::Plugins::Handler; + +die("Koha plugins are disabled!") + unless C4::Context->preference('UseKohaPlugins'); + +my $input = new CGI; + +my ( $template, $loggedinuser, $cookie ) = get_template_and_user( + { template_name => "plugins/plugins-upload.tmpl", + query => $input, + type => "intranet", + authnotrequired => 0, + flagsrequired => { plugins => 'manage' }, + debug => 1, + } +); + +my $class = $input->param('class'); + +Koha::Plugins::Handler->delete( { class => $class } ); + +print $input->redirect("/cgi-bin/koha/plugins/plugins-home.pl"); diff --git a/plugins/plugins-upload.pl b/plugins/plugins-upload.pl new file mode 100755 index 0000000000..4548104410 --- /dev/null +++ b/plugins/plugins-upload.pl @@ -0,0 +1,98 @@ +#!/usr/bin/perl +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it under the +# terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# Koha is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use strict; +use warnings; + +use Archive::Extract; +use File::Temp; +use File::Copy; +use CGI; + +use C4::Context; +use C4::Auth; +use C4::Output; +use C4::Members; +use C4::Debug; +use Koha::Plugins; + +die("Koha plugins are disabled!") + unless C4::Context->preference('UseKohaPlugins'); + +my $input = new CGI; + +my ( $template, $loggedinuser, $cookie ) = get_template_and_user( + { template_name => "plugins/plugins-upload.tmpl", + query => $input, + type => "intranet", + authnotrequired => 0, + flagsrequired => { plugins => 'manage' }, + debug => 1, + } +); + +my $uploadfilename = $input->param('uploadfile'); +my $uploadfile = $input->upload('uploadfile'); +my $op = $input->param('op'); + +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"; + + my $filesuffix; + $filesuffix = $1 if $uploadfilename =~ m/(\..+)$/i; + ( $tfh, $tempfile ) = File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 ); + + $debug and warn "tempfile = $tempfile"; + + $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 ); + + if (%errors) { + $template->param( ERRORS => [ \%errors ] ); + } 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; +} diff --git a/plugins/run.pl b/plugins/run.pl new file mode 100755 index 0000000000..6b8ef28def --- /dev/null +++ b/plugins/run.pl @@ -0,0 +1,50 @@ +#!/usr/bin/perl + +# Copyright 2010 Kyle M Hall +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it under the +# terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# Koha is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use strict; +use warnings; + +use CGI; + +use Koha::Plugins::Handler; +use C4::Auth; +use C4::Output; +use C4::Dates; +use C4::Debug; +use C4::Context; + +die("Koha plugins are disabled!") + unless C4::Context->preference('UseKohaPlugins'); + +my $cgi = new CGI; + +my $class = $cgi->param('class'); +my $method = $cgi->param('method'); + +my ( $template, $borrowernumber, $cookie ) = get_template_and_user( + { template_name => "plugins/plugins-home.tmpl", + query => $cgi, + type => "intranet", + authnotrequired => 0, + flagsrequired => { plugins => $method }, + debug => 1, + } +); + +my $plugin = Koha::Plugins::Handler->run( { class => $class, method => $method, cgi => $cgi } ); diff --git a/rewrite-config.PL b/rewrite-config.PL index 02715ab48f..90fd5ff190 100644 --- a/rewrite-config.PL +++ b/rewrite-config.PL @@ -43,7 +43,7 @@ guesses worked out by the script. The following configuration keywords are available: PREFIX, -BASE_DIR, CGI_DIR, LOG_DIR, INSTALL_BASE, +BASE_DIR, CGI_DIR, LOG_DIR, PLUGINS_DIR, INSTALL_BASE, DB_TYPE, DB_HOST, DB_PORT, DB_NAME, DB_PASS, DB_USER, WEBMASTER_EMAIL, WEBSERVER_DOMAIN, WEBSERVER_HOST, WEBSERVER_IP, WEBSERVER_PORT, WEBSERVER_PORT_LIBRARIAN, ZEBRA_PASS, ZEBRA_USER @@ -82,6 +82,7 @@ $prefix = $ENV{'INSTALL_BASE'} || "/usr"; %configuration = ( "__KOHA_INSTALLED_VERSION__" => "no_version_found", "__LOG_DIR__" => "/var/log", + "__PLUGINS_DIR__" => "/var/lib/koha/plugins", "__DB_TYPE__" => "mysql", "__DB_NAME__" => "koha", "__DB_HOST__" => $myhost, diff --git a/skel/var/lib/koha/plugins/README b/skel/var/lib/koha/plugins/README new file mode 100644 index 0000000000..d4290eaac0 --- /dev/null +++ b/skel/var/lib/koha/plugins/README @@ -0,0 +1 @@ +plugins dir \ No newline at end of file -- 2.39.5