Koha/Plugins/Base.pm

   1 package Koha::Plugins::Base;
   2
   3 # Copyright 2012 Kyle Hall
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21
  22 use Module::Pluggable require => 1;
  23
  24 use base qw{Module::Bundled::Files};
  25
  26 use C4::Context;
  27 use C4::Auth;
  28
  29 BEGIN {
  30     push @INC, C4::Context->config("pluginsdir");
  31 }
  32
  33 =head1 NAME
  34
  35 C4::Plugins::Base - Base Module for plugins
  36
  37 =cut
  38
  39 sub new {
  40     my ( $class, $args ) = @_;
  41
  42     return unless ( C4::Context->config("enable_plugins") || $args->{'enable_plugins'} );
  43
  44     $args->{'class'} = $class;
  45     $args->{'template'} = Template->new( { ABSOLUTE => 1 } );
  46
  47     my $self = bless( $args, $class );
  48
  49     ## Run the installation method if it exists and hasn't been run before
  50     if ( $self->can('install') && !$self->retrieve_data('__INSTALLED__') ) {
  51         if ( $self->install() ) {
  52             $self->store_data( { '__INSTALLED__' => 1 } );
  53         } else {
  54             warn "Plugin $class failed during installation!";
  55         }
  56     }
  57
  58     return $self;
  59 }
  60
  61 =head2 store_data
  62
  63 store_data allows a plugin to store key value pairs in the database for future use.
  64
  65 usage: $self->store_data({ param1 => 'param1val', param2 => 'param2value' })
  66
  67 =cut
  68
  69 sub store_data {
  70     my ( $self, $data ) = @_;
  71
  72     my $dbh = C4::Context->dbh;
  73     my $sql = "REPLACE INTO plugin_data SET plugin_class = ?, plugin_key = ?, plugin_value = ?";
  74     my $sth = $dbh->prepare($sql);
  75
  76     foreach my $key ( keys %$data ) {
  77         $sth->execute( $self->{'class'}, $key, $data->{$key} );
  78     }
  79 }
  80
  81 =head2 retrieve_data
  82
  83 retrieve_data allows a plugin to read the values that were previously saved with store_data
  84
  85 usage: my $value = $self->retrieve_data( $key );
  86
  87 =cut
  88
  89 sub retrieve_data {
  90     my ( $self, $key ) = @_;
  91
  92     my $dbh = C4::Context->dbh;
  93     my $sql = "SELECT plugin_value FROM plugin_data WHERE plugin_class = ? AND plugin_key = ?";
  94     my $sth = $dbh->prepare($sql);
  95     $sth->execute( $self->{'class'}, $key );
  96     my $row = $sth->fetchrow_hashref();
  97
  98     return $row->{'plugin_value'};
  99 }
 100
 101 =head2 get_template
 102
 103 get_template returns a Template object. Eventually this will probably be calling
 104 C4:Template, but at the moment, it does not.
 105
 106 =cut
 107
 108 sub get_template {
 109     my ( $self, $args ) = @_;
 110
 111     my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
 112         {   template_name   => $self->mbf_path( $args->{'file'} ),
 113             query           => $self->{'cgi'},
 114             type            => "intranet",
 115             authnotrequired => 1,
 116 #           flagsrequired   => { tools => '*' },
 117             is_plugin       => 1,
 118         }
 119     );
 120
 121     $template->param(
 122         CLASS       => $self->{'class'},
 123         METHOD      => $self->{'cgi'}->param('method'),
 124         PLUGIN_PATH => $self->get_plugin_http_path(),
 125     );
 126
 127     return $template;
 128 }
 129
 130 sub get_metadata {
 131     my ( $self, $args ) = @_;
 132
 133     return $self->{'metadata'};
 134 }
 135
 136 =head2 get_qualified_table_name
 137
 138 To avoid naming conflict, each plugins tables should use a fully qualified namespace.
 139 To avoid hardcoding and make plugins more flexible, this method will return the proper
 140 fully qualified table name.
 141
 142 usage: my $table = $self->get_qualified_table_name( 'myTable' );
 143
 144 =cut
 145
 146 sub get_qualified_table_name {
 147     my ( $self, $table_name ) = @_;
 148
 149     return lc( join( '_', split( '::', $self->{'class'} ), $table_name ) );
 150 }
 151
 152 =head2 get_plugin_http_path
 153
 154 To access a plugin's own resources ( images, js files, css files, etc... )
 155 a plugin will need to know what path to use in the template files. This
 156 method returns that path.
 157
 158 usage: my $path = $self->get_plugin_http_path();
 159
 160 =cut
 161
 162 sub get_plugin_http_path {
 163     my ($self) = @_;
 164
 165     return "/plugin/" . join( '/', split( '::', $self->{'class'} ) );
 166 }
 167
 168 =head2 go_home
 169
 170    go_home is a quick redirect to the Koha plugins home page
 171
 172 =cut
 173
 174 sub go_home {
 175     my ( $self, $params ) = @_;
 176
 177     print $self->{'cgi'}->redirect("/cgi-bin/koha/plugins/plugins-home.pl");
 178 }
 179
 180 1;
 181 __END__
 182
 183 =head1 AUTHOR
 184
 185 Kyle M Hall <kyle.m.hall@gmail.com>
 186
 187 =cut