1 package Koha
::Plugins
::Base
;
3 # Copyright 2012 Kyle Hall
5 # This file is part of Koha.
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.
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.
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>.
22 use Module
::Pluggable
require => 1;
24 use List
::Util
qw(max);
26 use base
qw{Module
::Bundled
::Files
};
29 use C4
::Output
qw(output_with_http_headers output_html_with_http_headers);
33 Koha::Plugins::Base - Base Module for plugins
38 my ( $class, $args ) = @_;
40 return unless ( C4
::Context
->config("enable_plugins") || $args->{'enable_plugins'} );
42 $args->{'class'} = $class;
43 $args->{'template'} = Template
->new( { ABSOLUTE
=> 1, ENCODING
=> 'UTF-8' } );
45 my $self = bless( $args, $class );
47 my $plugin_version = $self->get_metadata->{version
};
48 my $database_version = $self->retrieve_data('__INSTALLED_VERSION__');
50 ## Run the installation method if it exists and hasn't been run before
51 if ( $self->can('install') && !$self->retrieve_data('__INSTALLED__') ) {
52 if ( $self->install() ) {
53 $self->store_data( { '__INSTALLED__' => 1 } );
54 if ( my $version = $plugin_version ) {
55 $self->store_data({ '__INSTALLED_VERSION__' => $version });
58 warn "Plugin $class failed during installation!";
60 } elsif ( $self->can('upgrade') && $plugin_version && $database_version ) {
61 if ( _version_compare
( $plugin_version, $database_version ) == 1 ) {
62 if ( $self->upgrade() ) {
63 $self->store_data({ '__INSTALLED_VERSION__' => $plugin_version });
64 warn "Plugin $class failed during upgrade!";
74 store_data allows a plugin to store key value pairs in the database for future use.
76 usage: $self->store_data({ param1 => 'param1val', param2 => 'param2value' })
81 my ( $self, $data ) = @_;
83 my $dbh = C4
::Context
->dbh;
84 my $sql = "REPLACE INTO plugin_data SET plugin_class = ?, plugin_key = ?, plugin_value = ?";
85 my $sth = $dbh->prepare($sql);
87 foreach my $key ( keys %$data ) {
88 $sth->execute( $self->{'class'}, $key, $data->{$key} );
94 retrieve_data allows a plugin to read the values that were previously saved with store_data
96 usage: my $value = $self->retrieve_data( $key );
101 my ( $self, $key ) = @_;
103 my $dbh = C4
::Context
->dbh;
104 my $sql = "SELECT plugin_value FROM plugin_data WHERE plugin_class = ? AND plugin_key = ?";
105 my $sth = $dbh->prepare($sql);
106 $sth->execute( $self->{'class'}, $key );
107 my $row = $sth->fetchrow_hashref();
109 return $row->{'plugin_value'};
114 get_template returns a Template object. Eventually this will probably be calling
115 C4:Template, but at the moment, it does not.
120 my ( $self, $args ) = @_;
124 my $template_name = $args->{'file'} // '';
125 # if not absolute, call mbf_path, which dies if file does not exist
126 $template_name = $self->mbf_path( $template_name )
127 if $template_name !~ m/^\//;
128 my ( $template, $loggedinuser, $cookie ) = C4
::Auth
::get_template_and_user
(
129 { template_name
=> $template_name,
130 query
=> $self->{'cgi'},
132 authnotrequired
=> 1,
137 CLASS
=> $self->{'class'},
138 METHOD
=> scalar $self->{'cgi'}->param('method'),
139 PLUGIN_PATH
=> $self->get_plugin_http_path(),
146 my ( $self, $args ) = @_;
148 return $self->{'metadata'};
151 =head2 get_qualified_table_name
153 To avoid naming conflict, each plugins tables should use a fully qualified namespace.
154 To avoid hardcoding and make plugins more flexible, this method will return the proper
155 fully qualified table name.
157 usage: my $table = $self->get_qualified_table_name( 'myTable' );
161 sub get_qualified_table_name
{
162 my ( $self, $table_name ) = @_;
164 return lc( join( '_', split( '::', $self->{'class'} ), $table_name ) );
167 =head2 get_plugin_http_path
169 To access a plugin's own resources ( images, js files, css files, etc... )
170 a plugin will need to know what path to use in the template files. This
171 method returns that path.
173 usage: my $path = $self->get_plugin_http_path();
177 sub get_plugin_http_path
{
180 return "/plugin/" . join( '/', split( '::', $self->{'class'} ) );
185 go_home is a quick redirect to the Koha plugins home page
190 my ( $self, $params ) = @_;
192 print $self->{'cgi'}->redirect("/cgi-bin/koha/plugins/plugins-home.pl");
197 $self->output_html( $data, $status, $extra_options );
199 Outputs $data setting the right headers for HTML content.
201 Note: this is a wrapper function for C4::Output::output_with_http_headers
206 my ( $self, $data, $status, $extra_options ) = @_;
207 output_with_http_headers
( $self->{cgi
}, undef, $data, 'html', $status, $extra_options );
212 $self->output( $data, $content_type[, $status[, $extra_options]]);
214 Outputs $data with the appropriate HTTP headers,
215 the authentication cookie and a Content-Type specified in
218 $content_type is one of the following: 'html', 'js', 'json', 'xml', 'rss', or 'atom'.
220 $status is an HTTP status message, like '403 Authentication Required'. It defaults to '200 OK'.
222 $extra_options is hashref. If the key 'force_no_caching' is present and has
223 a true value, the HTTP headers include directives to force there to be no
226 Note: this is a wrapper function for C4::Output::output_with_http_headers
231 my ( $self, $data, $content_type, $status, $extra_options ) = @_;
232 output_with_http_headers
( $self->{cgi
}, undef, $data, $content_type, $status, $extra_options );
235 =head2 _version_compare
237 Utility method to compare two version numbers.
238 Returns 1 if the first argument is the higher version
239 Returns -1 if the first argument is the lower version
240 Returns 0 if both versions are equal
242 if ( _version_compare( '2.6.26', '2.6.0' ) == 1 ) {
243 print "2.6.26 is greater than 2.6.0\n";
248 sub _version_compare
{
249 my $ver1 = shift || 0;
250 my $ver2 = shift || 0;
252 my @v1 = split /[.+:~-]/, $ver1;
253 my @v2 = split /[.+:~-]/, $ver2;
255 for ( my $i = 0 ; $i < max
( scalar(@v1), scalar(@v2) ) ; $i++ ) {
257 # Add missing version parts if one string is shorter than the other
258 # i.e. 0 should be lt 0.2.1 and not equal, so we append .0
259 # 0.0.0 <=> 0.2.1 = -1
260 push( @v1, 0 ) unless defined( $v1[$i] );
261 push( @v2, 0 ) unless defined( $v2[$i] );
262 if ( int( $v1[$i] ) > int( $v2[$i] ) ) {
265 elsif ( int( $v1[$i] ) < int( $v2[$i] ) ) {
277 Kyle M Hall <kyle.m.hall@gmail.com>