#
# 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 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 3 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.
+# 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.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
use strict;
use warnings;
$VERSION = '3.07.00.049';
}
-use DBI;
+use Encode;
use ZOOM;
use XML::Simple;
-use C4::Boolean;
-use C4::Debug;
use POSIX ();
use DateTime::TimeZone;
use Module::Load::Conditional qw(can_load);
use Carp;
+use C4::Boolean;
+use C4::Debug;
+use Koha;
+use Koha::Config::SysPrefs;
+
=head1 NAME
C4::Context - Maintain and manipulate the context of a Koha script
$Zconn = C4::Context->Zconn;
- $stopwordhash = C4::Context->stopwords;
-
=head1 DESCRIPTION
When a Koha script runs, it makes use of a certain number of things:
@context_stack = (); # Initially, no saved contexts
-=head2 KOHAVERSION
-
-returns the kohaversion stored in kohaversion.pl file
-
-=cut
-
-sub KOHAVERSION {
- my $cgidir = C4::Context->intranetdir;
-
- # Apparently the GIT code does not run out of a CGI-BIN subdirectory
- # but distribution code does? (Stan, 1jan08)
- if(-d $cgidir . "/cgi-bin"){
- my $cgidir .= "/cgi-bin";
- }
-
- do $cgidir."/kohaversion.pl" || die "NO $cgidir/kohaversion.pl";
- return kohaversion();
-}
-
-=head2 final_linear_version
-
-Returns the version number of the final update to run in updatedatabase.pl.
-This number is equal to the version in kohaversion.pl
-
-=cut
-
-sub final_linear_version {
- return KOHAVERSION;
-}
-
=head2 read_config_file
Reads the specified Koha config file.
}
}
-=head2 db_schema2dbi
+=head2 db_scheme2dbi
my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
# the first time the module is called
# (a config file can be optionaly passed)
- # default context allready exists?
+ # default context already exists?
return if $context;
# no ? so load it!
}
if ($ismemcached) {
- # retreive from memcached
+ # retrieve from memcached
$self = $memcached->get('kohaconf');
if (not defined $self) {
# not in memcached yet
warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
return if !defined($self->{"config"});
- $self->{"dbh"} = undef; # Database handle
$self->{"Zconn"} = undef; # Zebra Connections
- $self->{"stopwords"} = undef; # stopwords list
$self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
$self->{"userenv"} = undef; # User env
$self->{"activeuser"} = undef; # current active user
$self->{tz} = undef; # local timezone object
bless $self, $class;
+ $self->{db_driver} = db_scheme2dbi($self->config('db_scheme')); # cache database driver
return $self;
}
if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
$value = $ENV{"OVERRIDE_SYSPREF_$var"};
} else {
- # Look up systempreferences.variable==$var
- my $sql = q{
- SELECT value
- FROM systempreferences
- WHERE variable = ?
- LIMIT 1
- };
- $value = $dbh->selectrow_array( $sql, {}, lc $var );
+ my $syspref;
+ eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
+ $value = $syspref ? $syspref->value() : undef;
}
$sysprefs{lc $var} = $value;
my $var = lc(shift);
my $value = shift;
- my $dbh = C4::Context->dbh or return 0;
-
- my $type = $dbh->selectrow_array( "SELECT type FROM systempreferences WHERE variable = ?", {}, $var );
+ my $syspref = Koha::Config::SysPrefs->find( $var );
+ my $type = $syspref ? $syspref->type() : undef;
$value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
- my $sth = $dbh->prepare( "
- INSERT INTO systempreferences
- ( variable, value )
- VALUES( ?, ? )
- ON DUPLICATE KEY UPDATE value = VALUES(value)
- " );
-
- if($sth->execute( $var, $value )) {
- $sysprefs{$var} = $value;
+ # force explicit protocol on OPACBaseURL
+ if ($var eq 'opacbaseurl' && substr($value,0,4) !~ /http/) {
+ $value = 'http://' . $value;
}
- $sth->finish;
-}
-
-# AUTOLOAD
-# This implements C4::Config->foo, and simply returns
-# C4::Context->config("foo"), as described in the documentation for
-# &config, above.
-# FIXME - Perhaps this should be extended to check &config first, and
-# then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
-# code, so it'd probably be best to delete it altogether so as not to
-# encourage people to use it.
-sub AUTOLOAD
-{
- my $self = shift;
+ if ($syspref) {
+ $syspref = $syspref->set( { value => $value } )->store();
+ }
+ else {
+ $syspref = Koha::Config::SysPref->new( { variable => $var, value => $value } )->store();
+ }
- $AUTOLOAD =~ s/.*:://; # Chop off the package name,
- # leaving only the function name.
- return $self->config($AUTOLOAD);
+ if ($syspref) {
+ $sysprefs{$var} = $value;
+ }
}
=head2 Zconn
$Zconn = C4::Context->Zconn
-Returns a connection to the Zebra database for the current
-context. If no connection has yet been made, this method
-creates one and connects.
+Returns a connection to the Zebra database
C<$self>
C<$async> whether this is a asynchronous connection
-C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
-
-
=cut
sub Zconn {
- my $self=shift;
- my $server=shift;
- my $async=shift;
- my $auth=shift;
- my $piggyback=shift;
- my $syntax=shift;
- if ( defined($context->{"Zconn"}->{$server}) && (0 == $context->{"Zconn"}->{$server}->errcode()) ) {
- return $context->{"Zconn"}->{$server};
- # No connection object or it died. Create one.
- }else {
- # release resources if we're closing a connection and making a new one
- # FIXME: this needs to be smarter -- an error due to a malformed query or
- # a missing index does not necessarily require us to close the connection
- # and make a new one, particularly for a batch job. However, at
- # first glance it does not look like there's a way to easily check
- # the basic health of a ZOOM::Connection
- $context->{"Zconn"}->{$server}->destroy() if defined($context->{"Zconn"}->{$server});
-
- $context->{"Zconn"}->{$server} = &_new_Zconn($server,$async,$auth,$piggyback,$syntax);
- return $context->{"Zconn"}->{$server};
+ my ($self, $server, $async ) = @_;
+ my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
+ if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
+ # if we are running the script from the commandline, lets try to use the caching
+ return $context->{"Zconn"}->{$cache_key};
}
+ $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
+ $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
+ return $context->{"Zconn"}->{$cache_key};
}
=head2 _new_Zconn
=cut
sub _new_Zconn {
- my ($server,$async,$auth,$piggyback,$syntax) = @_;
+ my ( $server, $async ) = @_;
my $tried=0; # first attempt
my $Zconn; # connection object
my $elementSetName;
my $index_mode;
+ my $syntax;
$server //= "biblioserver";
- $syntax //= "XML";
if ( $server eq 'biblioserver' ) {
- $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'grs1';
+ $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
} elsif ( $server eq 'authorityserver' ) {
$index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
}
if ( $index_mode eq 'grs1' ) {
-
$elementSetName = 'F';
$syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
? 'unimarc'
: 'usmarc';
- } else {
-
+ } else { # $index_mode eq 'dom'
+ $syntax = 'xml';
$elementSetName = 'marcxml';
- $syntax = 'XML';
}
my $host = $context->{'listen'}->{$server}->{'content'};
- my $servername = $context->{"config"}->{$server};
my $user = $context->{"serverinfo"}->{$server}->{"user"};
my $password = $context->{"serverinfo"}->{$server}->{"password"};
- $auth = 1 if($user && $password);
- retry:
eval {
# set options
my $o = new ZOOM::Options();
- $o->option(user=>$user) if $auth;
- $o->option(password=>$password) if $auth;
+ $o->option(user => $user) if $user && $password;
+ $o->option(password => $password) if $user && $password;
$o->option(async => 1) if $async;
- $o->option(count => $piggyback) if $piggyback;
$o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
$o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
$o->option(preferredRecordSyntax => $syntax);
- $o->option(elementSetName => $elementSetName);
- $o->option(databaseName => ($servername?$servername:"biblios"));
+ $o->option(elementSetName => $elementSetName) if $elementSetName;
+ $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
# create a new connection object
$Zconn= create ZOOM::Connection($o);
if ($Zconn->errcode() !=0) {
warn "something wrong with the connection: ". $Zconn->errmsg();
}
-
};
-
return $Zconn;
}
sub _new_dbh
{
- ## $context
- ## correct name for db_schme
- my $db_driver = db_scheme2dbi($context->config("db_scheme"));
-
- my $db_name = $context->config("database");
- my $db_host = $context->config("hostname");
- my $db_port = $context->config("port") || '';
- my $db_user = $context->config("user");
- my $db_passwd = $context->config("pass");
- # MJR added or die here, as we can't work without dbh
- my $dbh = DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
- $db_user, $db_passwd, {'RaiseError' => $ENV{DEBUG}?1:0 }) or die $DBI::errstr;
-
- # Check for the existence of a systempreference table; if we don't have this, we don't
- # have a valid database and should not set RaiseError in order to allow the installer
- # to run; installer will not run otherwise since we raise all db errors
-
- eval {
- local $dbh->{PrintError} = 0;
- local $dbh->{RaiseError} = 1;
- $dbh->do(qq{SELECT * FROM systempreferences WHERE 1 = 0 });
- };
-
- if ($@) {
- $dbh->{RaiseError} = 0;
- }
-
- my $tz = $ENV{TZ};
- if ( $db_driver eq 'mysql' ) {
- # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
- # this is better than modifying my.cnf (and forcing all communications to be in utf8)
- $dbh->{'mysql_enable_utf8'}=1; #enable
- $dbh->do("set NAMES 'utf8'");
- ($tz) and $dbh->do(qq(SET time_zone = "$tz"));
- }
- elsif ( $db_driver eq 'Pg' ) {
- $dbh->do( "set client_encoding = 'UTF8';" );
- ($tz) and $dbh->do(qq(SET TIME ZONE = "$tz"));
- }
- return $dbh;
+ Koha::Database->schema({ new => 1 })->storage->dbh;
}
=head2 dbh
sub dbh
{
my $self = shift;
+ my $params = shift;
my $sth;
- if (defined($context->{"dbh"}) && $context->{"dbh"}->ping()) {
- return $context->{"dbh"};
+ unless ( $params->{new} ) {
+ return Koha::Database->schema->storage->dbh;
}
- # No database handle or it died . Create one.
- $context->{"dbh"} = &_new_dbh();
-
- return $context->{"dbh"};
+ return Koha::Database->schema({ new => 1 })->storage->dbh;
}
=head2 new_dbh
{
my $self = shift;
- return &_new_dbh();
+ return &dbh({ new => 1 });
}
=head2 set_dbh
my $config_file = $context->config('queryparser_config');
$config_file ||= '/etc/koha/searchengine/queryparser.yaml';
if ( $QParser->load_config($config_file) ) {
+ # Set 'keyword' as the default search class
+ $QParser->default_search_class('keyword');
# TODO: allow indexes to be configured in the database
return $QParser;
}
}
# _new_marcfromkohafield
-# Internal helper function (not a method!). This creates a new
-# hash with stopwords
sub _new_marcfromkohafield
{
my $dbh = C4::Context->dbh;
return $marcfromkohafield;
}
-=head2 stopwords
-
- $dbh = C4::Context->stopwords;
-
-Returns a hash with stopwords.
-
-This hash is cached for future use: if you call
-C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
-
-=cut
-
-#'
-sub stopwords
-{
- my $retval = {};
-
- # If the hash already exists, return it.
- return $context->{"stopwords"} if defined($context->{"stopwords"});
-
- # No hash. Create one.
- $context->{"stopwords"} = &_new_stopwords();
-
- return $context->{"stopwords"};
-}
-
-# _new_stopwords
-# Internal helper function (not a method!). This creates a new
-# hash with stopwords
-sub _new_stopwords
-{
- my $dbh = C4::Context->dbh;
- my $stopwordlist;
- my $sth = $dbh->prepare("select word from stopwords");
- $sth->execute;
- while (my $stopword = $sth->fetchrow_array) {
- $stopwordlist->{$stopword} = uc($stopword);
- }
- $stopwordlist->{A} = "A" unless $stopwordlist;
- return $stopwordlist;
-}
-
=head2 userenv
C4::Context->userenv;
=head2 set_userenv
- C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname,
- $usersurname, $userbranch, $userflags, $emailaddress, $branchprinter,
- $persona);
+ C4::Context->set_userenv($usernum, $userid, $usercnum,
+ $userfirstname, $usersurname,
+ $userbranch, $branchname, $userflags,
+ $emailaddress, $branchprinter, $persona);
Establish a hash of user environment variables.
#'
sub set_userenv {
- my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona)= @_;
+ shift @_;
+ my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
+ map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
+ @_;
my $var=$context->{"activeuser"} || '';
my $cell = {
"number" => $usernum,
"emailaddress" => $emailaddress,
"branchprinter" => $branchprinter,
"persona" => $persona,
+ "shibboleth" => $shibboleth,
};
$context->{userenv}->{$var} = $cell;
return $cell;
# A little example sub to show more debugging info for CGI::Carp
sub get_versions {
my %versions;
- $versions{kohaVersion} = KOHAVERSION();
+ $versions{kohaVersion} = Koha::version();
$versions{kohaDbVersion} = C4::Context->preference('version');
$versions{osVersion} = join(" ", POSIX::uname());
$versions{perlVersion} = $];
{
no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
$versions{mysqlVersion} = `mysql -V`;
- $versions{apacheVersion} = `httpd -v`;
+ $versions{apacheVersion} = (`apache2ctl -v`)[0];
+ $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
$versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
$versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
$versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
=head2 IsSuperLibrarian
- C4::Context->IsSuperlibrarian();
+ C4::Context->IsSuperLibrarian();
=cut
return 1;
}
- return $userenv->{flags} % 2;
+ return ($userenv->{flags}//0) % 2;
+}
+
+=head2 interface
+
+Sets the current interface for later retrieval in any Perl module
+
+ C4::Context->interface('opac');
+ C4::Context->interface('intranet');
+ my $interface = C4::Context->interface;
+
+=cut
+
+sub interface {
+ my ($class, $interface) = @_;
+
+ if (defined $interface) {
+ $interface = lc $interface;
+ if ($interface eq 'opac' || $interface eq 'intranet' || $interface eq 'sip' || $interface eq 'commandline') {
+ $context->{interface} = $interface;
+ } else {
+ warn "invalid interface : '$interface'";
+ }
+ }
+
+ return $context->{interface} // 'opac';
}
1;
Joshua Ferraro <jmf at liblime dot com>
-=cut
projects / koha.git / blobdiff