package C4::Context;
+
# Copyright 2002 Katipo Communications
#
# This file is part of Koha.
# 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;
-use vars qw($VERSION $AUTOLOAD $context @context_stack $servers $memcached $ismemcached);
+use Modern::Perl;
+
+use vars qw($AUTOLOAD $context @context_stack);
BEGIN {
if ($ENV{'HTTP_USER_AGENT'}) {
require CGI::Carp;
if ($ENV{KOHA_BACKTRACES}) {
$main::SIG{__DIE__} = \&CGI::Carp::confess;
}
- } # else there is no browser to send fatals to!
- # Check if there are memcached servers set
- $servers = $ENV{'MEMCACHED_SERVERS'};
- if ($servers) {
- # Load required libraries and create the memcached object
- require Cache::Memcached;
- $memcached = Cache::Memcached->new({
- servers => [ $servers ],
- debug => 0,
- compress_threshold => 10_000,
- expire_time => 600,
- namespace => $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
- });
- # Verify memcached available (set a variable and test the output)
- $ismemcached = $memcached->set('ismemcached','1');
- }
-
- $VERSION = '3.07.00.049';
+ # Redefine multi_param if cgi version is < 4.08
+ # Remove the "CGI::param called in list context" warning in this case
+ require CGI; # Can't check version without the require.
+ if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {
+ no warnings 'redefine';
+ *CGI::multi_param = \&CGI::param;
+ use warnings 'redefine';
+ $CGI::LIST_CONTEXT_WARN = 0;
+ }
+ } # else there is no browser to send fatals to!
}
-use DBIx::Connector;
-use Encode;
-use ZOOM;
-use XML::Simple;
-use POSIX ();
+use Carp;
use DateTime::TimeZone;
+use Encode;
+use File::Spec;
use Module::Load::Conditional qw(can_load);
-use Carp;
+use POSIX ();
+use ZOOM;
use C4::Boolean;
use C4::Debug;
-use Koha;
+use Koha::Caches;
+use Koha::Config::SysPref;
use Koha::Config::SysPrefs;
+use Koha::Config;
+use Koha;
=head1 NAME
$Zconn = C4::Context->Zconn;
- $stopwordhash = C4::Context->stopwords;
-
=head1 DESCRIPTION
When a Koha script runs, it makes use of a certain number of things:
# Zconn
# A connection object for the Zebra server
-# Koha's main configuration file koha-conf.xml
-# is searched for according to this priority list:
-#
-# 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
-# 2. Path supplied in KOHA_CONF environment variable.
-# 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
-# as value has changed from its default of
-# '__KOHA_CONF_DIR__/koha-conf.xml', as happens
-# when Koha is installed in 'standard' or 'single'
-# mode.
-# 4. Path supplied in CONFIG_FNAME.
-#
-# The first entry that refers to a readable file is used.
-
-use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
- # Default config file, if none is specified
-
-my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
- # path to config file set by installer
- # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
- # when Koha is installed in 'standard' or 'single'
- # mode. If Koha was installed in 'dev' mode,
- # __KOHA_CONF_DIR__ is *not* rewritten; instead
- # developers should set the KOHA_CONF environment variable
-
$context = undef; # Initially, no context is set
@context_stack = (); # Initially, no saved contexts
-
-=head2 read_config_file
-
-Reads the specified Koha config file.
-
-Returns an object containing the configuration variables. The object's
-structure is a bit complex to the uninitiated ... take a look at the
-koha-conf.xml file as well as the XML::Simple documentation for details. Or,
-here are a few examples that may give you what you need:
-
-The simple elements nested within the <config> element:
-
- my $pass = $koha->{'config'}->{'pass'};
-
-The <listen> elements:
-
- my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
-
-The elements nested within the <server> element:
-
- my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
-
-Returns undef in case of error.
-
-=cut
-
-sub read_config_file { # Pass argument naming config file to read
- my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo'], suppressempty => '');
-
- if ($ismemcached) {
- $memcached->set('kohaconf',$koha);
- }
-
- return $koha; # Return value: ref-to-hash holding the configuration
-}
-
-=head2 ismemcached
-
-Returns the value of the $ismemcached variable (0/1)
-
-=cut
-
-sub ismemcached {
- return $ismemcached;
-}
-
-=head2 memcached
-
-If $ismemcached is true, returns the $memcache variable.
-Returns undef otherwise
-
-=cut
-
-sub memcached {
- if ($ismemcached) {
- return $memcached;
- } else {
- return;
- }
-}
-
=head2 db_scheme2dbi
my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
undef $conf_fname unless
(defined $conf_fname && -s $conf_fname);
# Figure out a good config file to load if none was specified.
- if (!defined($conf_fname))
- {
- # If the $KOHA_CONF environment variable is set, use
- # that. Otherwise, use the built-in default.
- if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s $ENV{"KOHA_CONF"}) {
- $conf_fname = $ENV{"KOHA_CONF"};
- } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
- # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
- # regex to anything else -- don't want installer to rewrite it
- $conf_fname = $INSTALLED_CONFIG_FNAME;
- } elsif (-s CONFIG_FNAME) {
- $conf_fname = CONFIG_FNAME;
- } else {
+ unless ( defined $conf_fname ) {
+ $conf_fname = Koha::Config->guess_koha_conf;
+ unless ( $conf_fname ) {
warn "unable to locate Koha configuration file koha-conf.xml";
return;
}
}
-
- if ($ismemcached) {
- # retrieve from memcached
- $self = $memcached->get('kohaconf');
- if (not defined $self) {
- # not in memcached yet
- $self = read_config_file($conf_fname);
+
+ my $conf_cache = Koha::Caches->get_instance('config');
+ my $config_from_cache;
+ if ( $conf_cache->cache ) {
+ $self = $conf_cache->get_from_cache('koha_conf');
+ }
+ unless ( $self and %$self ) {
+ $self = Koha::Config->read_from_file($conf_fname);
+ if ( $conf_cache->memcached_cache ) {
+ # FIXME it may be better to use the memcached servers from the config file
+ # to cache it
+ $conf_cache->set_in_cache('koha_conf', $self)
}
- } else {
- # non-memcached env, read from file
- $self = read_config_file($conf_fname);
+ }
+ unless ( exists $self->{config} or defined $self->{config} ) {
+ warn "The config file ($conf_fname) has not been parsed correctly";
+ return;
}
- $self->{"config_file"} = $conf_fname;
- 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->{"shelves"} = undef;
=cut
-# FIXME: running this under mod_perl will require a means of
-# flushing the caching mechanism.
-
-my %sysprefs;
+my $syspref_cache = Koha::Caches->get_instance('syspref');
my $use_syspref_cache = 1;
-
sub preference {
my $self = shift;
my $var = shift; # The system preference to return
- if ($use_syspref_cache && exists $sysprefs{lc $var}) {
- return $sysprefs{lc $var};
- }
+ return $ENV{"OVERRIDE_SYSPREF_$var"}
+ if defined $ENV{"OVERRIDE_SYSPREF_$var"};
- my $dbh = C4::Context->dbh or return 0;
+ $var = lc $var;
- my $value;
- if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
- $value = $ENV{"OVERRIDE_SYSPREF_$var"};
- } else {
- my $syspref;
- eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
- $value = $syspref ? $syspref->value() : undef;
+ if ($use_syspref_cache) {
+ $syspref_cache = Koha::Caches->get_instance('syspref') unless $syspref_cache;
+ my $cached_var = $syspref_cache->get_from_cache("syspref_$var");
+ return $cached_var if defined $cached_var;
}
- $sysprefs{lc $var} = $value;
+ my $syspref;
+ eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
+ my $value = $syspref ? $syspref->value() : undef;
+
+ if ( $use_syspref_cache ) {
+ $syspref_cache->set_in_cache("syspref_$var", $value);
+ }
return $value;
}
sub enable_syspref_cache {
my ($self) = @_;
$use_syspref_cache = 1;
+ # We need to clear the cache to have it up-to-date
+ $self->clear_syspref_cache();
}
=head2 disable_syspref_cache
=cut
sub clear_syspref_cache {
- %sysprefs = ();
+ return unless $use_syspref_cache;
+ $syspref_cache->flush_all;
}
=head2 set_preference
- C4::Context->set_preference( $variable, $value );
+ C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
This updates a preference's value both in the systempreferences table and in
-the sysprefs cache.
+the sysprefs cache. If the optional parameters are provided, then the query
+becomes a create. It won't update the parameters (except value) for an existing
+preference.
=cut
sub set_preference {
- my $self = shift;
- my $var = lc(shift);
- my $value = shift;
+ my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
+
+ my $variable_case = $variable;
+ $variable = lc $variable;
- my $syspref = Koha::Config::SysPrefs->find( $var );
- my $type = $syspref ? $syspref->type() : undef;
+ my $syspref = Koha::Config::SysPrefs->find($variable);
+ $type =
+ $type ? $type
+ : $syspref ? $syspref->type
+ : undef;
$value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
# force explicit protocol on OPACBaseURL
- if ($var eq 'opacbaseurl' && substr($value,0,4) !~ /http/) {
+ if ( $variable eq 'opacbaseurl' && $value && substr( $value, 0, 4 ) !~ /http/ ) {
$value = 'http://' . $value;
}
if ($syspref) {
- $syspref = $syspref->set( { value => $value } )->store();
- }
- else {
- $syspref = Koha::Config::SysPref->new( { variable => $var, value => $value } )->store();
+ $syspref->set(
+ { ( defined $value ? ( value => $value ) : () ),
+ ( $explanation ? ( explanation => $explanation ) : () ),
+ ( $type ? ( type => $type ) : () ),
+ ( $options ? ( options => $options ) : () ),
+ }
+ )->store;
+ } else {
+ $syspref = Koha::Config::SysPref->new(
+ { variable => $variable_case,
+ value => $value,
+ explanation => $explanation || undef,
+ type => $type,
+ options => $options || undef,
+ }
+ )->store();
}
- if ($syspref) {
- $sysprefs{$var} = $value;
+ if ( $use_syspref_cache ) {
+ $syspref_cache->set_in_cache( "syspref_$variable", $value );
}
+
+ return $syspref;
}
-# AUTOLOAD
-# This implements C4::Config->foo, and simply returns
-# C4::Context->config("foo"), as described in the documentation for
-# &config, above.
+=head2 delete_preference
-# 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;
+ C4::Context->delete_preference( $variable );
+
+This deletes a system preference from the database. Returns a true value on
+success. Failure means there was an issue with the database, not that there
+was no syspref of the name.
+
+=cut
+
+sub delete_preference {
+ my ( $self, $var ) = @_;
- $AUTOLOAD =~ s/.*:://; # Chop off the package name,
- # leaving only the function name.
- return $self->config($AUTOLOAD);
+ if ( Koha::Config::SysPrefs->find( $var )->delete ) {
+ if ( $use_syspref_cache ) {
+ $syspref_cache->clear_from_cache("syspref_$var");
+ }
+
+ return 1;
+ }
+ return 0;
}
=head2 Zconn
my $tried=0; # first attempt
my $Zconn; # connection object
my $elementSetName;
- my $index_mode;
my $syntax;
$server //= "biblioserver";
- if ( $server eq 'biblioserver' ) {
- $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 { # $index_mode eq 'dom'
- $syntax = 'xml';
- $elementSetName = 'marcxml';
- }
+ $syntax = 'xml';
+ $elementSetName = 'marcxml';
my $host = $context->{'listen'}->{$server}->{'content'};
my $user = $context->{"serverinfo"}->{$server}->{"user"};
sub _new_dbh
{
- ## $context
- ## correct name for db_scheme
- my $db_driver = $context->{db_driver};
-
- 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 = DBIx::Connector->connect(
- "dbi:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
- $db_user, $db_passwd,
- {
- 'RaiseError' => $ENV{DEBUG} ? 1 : 0
- }
- );
-
- # 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;
- }
-
- if ( $db_driver eq 'mysql' ) {
- $dbh->{mysql_auto_reconnect} = 1;
- }
-
- 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
my $sth;
unless ( $params->{new} ) {
- if ( defined($context->{db_driver}) && $context->{db_driver} eq 'mysql' && $context->{"dbh"} ) {
- return $context->{"dbh"};
- } elsif ( defined($context->{"dbh"}) && $context->{"dbh"}->ping() ) {
- return $context->{"dbh"};
- }
+ 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
return;
}
-=head2 marcfromkohafield
-
- $dbh = C4::Context->marcfromkohafield;
-
-Returns a hash with marcfromkohafield.
-
-This hash is cached for future use: if you call
-C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
-
-=cut
-
-#'
-sub marcfromkohafield
-{
- my $retval = {};
-
- # If the hash already exists, return it.
- return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
-
- # No hash. Create one.
- $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
-
- return $context->{"marcfromkohafield"};
-}
-
-# _new_marcfromkohafield
-# Internal helper function (not a method!). This creates a new
-# hash with stopwords
-sub _new_marcfromkohafield
-{
- my $dbh = C4::Context->dbh;
- my $marcfromkohafield;
- my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
- $sth->execute;
- while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
- my $retval = {};
- $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
- }
- 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;
C4::Context->set_userenv($usernum, $userid, $usercnum,
$userfirstname, $usersurname,
$userbranch, $branchname, $userflags,
- $emailaddress, $branchprinter, $persona);
+ $emailaddress, $branchprinter, $shibboleth);
Establish a hash of user environment variables.
#'
sub set_userenv {
shift @_;
- my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
+ my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $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"} || '';
"flags" => $userflags,
"emailaddress" => $emailaddress,
"branchprinter" => $branchprinter,
- "persona" => $persona,
"shibboleth" => $shibboleth,
};
$context->{userenv}->{$var} = $cell;
{
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} ;
return %versions;
}
+=head2 timezone
+
+ my $C4::Context->timzone
+
+ Returns a timezone code for the instance of Koha
+
+=cut
+
+sub timezone {
+ my $self = shift;
+
+ my $timezone = C4::Context->config('timezone') || $ENV{TZ} || 'local';
+ if ( !DateTime::TimeZone->is_valid_name( $timezone ) ) {
+ warn "Invalid timezone in koha-conf.xml ($timezone)";
+ $timezone = 'local';
+ }
+
+ return $timezone;
+}
=head2 tz
sub tz {
my $self = shift;
if (!defined $context->{tz}) {
- $context->{tz} = DateTime::TimeZone->new(name => 'local');
+ my $timezone = $self->timezone;
+ $context->{tz} = DateTime::TimeZone->new(name => $timezone);
}
return $context->{tz};
}
if (defined $interface) {
$interface = lc $interface;
- if ($interface eq 'opac' || $interface eq 'intranet') {
+ 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';
}
+# always returns a string for OK comparison via "eq" or "ne"
+sub mybranch {
+ C4::Context->userenv or return '';
+ return C4::Context->userenv->{branch} || '';
+}
+
+=head2 only_my_library
+
+ my $test = C4::Context->only_my_library;
+
+ Returns true if you enabled IndependentBranches and the current user
+ does not have superlibrarian permissions.
+
+=cut
+
+sub only_my_library {
+ return
+ C4::Context->preference('IndependentBranches')
+ && C4::Context->userenv
+ && !C4::Context->IsSuperLibrarian()
+ && C4::Context->userenv->{branch};
+}
+
+=head3 temporary_directory
+
+Returns root directory for temporary storage
+
+=cut
+
+sub temporary_directory {
+ my ( $class ) = @_;
+ return C4::Context->config('tmp_path') || File::Spec->tmpdir;
+}
+
+
1;
+
__END__
=head1 ENVIRONMENT
projects / koha.git / blobdiff