2 # Copyright 2002 Katipo Communications
4 # This file is part of Koha.
6 # Koha is free software; you can redistribute it and/or modify it under the
7 # terms of the GNU General Public License as published by the Free Software
8 # Foundation; either version 2 of the License, or (at your option) any later
11 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
12 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with Koha; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 use vars
qw($VERSION $AUTOLOAD $context @context_stack $servers $memcached $ismemcached);
23 if ($ENV{'HTTP_USER_AGENT'}) {
25 # FIXME for future reference, CGI::Carp doc says
26 # "Note that fatalsToBrowser does not work with mod_perl version 2.0 and higher."
27 import CGI::Carp qw(fatalsToBrowser);
31 eval {C4
::Context
->dbh();};
36 $debug_level = C4
::Context
->preference("DebugLevel");
39 print q
(<!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN"
40 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
41 <html lang
="en" xml
:lang
="en" xmlns
="http://www.w3.org/1999/xhtml">
42 <head
><title
>Koha Error
</title></head
>
45 if ($debug_level eq "2"){
46 # debug 2 , print extra info too.
47 my %versions = get_versions
();
49 # a little example table with various version info";
52 <p>The following fatal error has occurred:</p>
53 <pre><code>$msg</code></pre>
55 <tr><th>Apache</th><td> $versions{apacheVersion}</td></tr>
56 <tr><th>Koha</th><td> $versions{kohaVersion}</td></tr>
57 <tr><th>Koha DB</th><td> $versions{kohaDbVersion}</td></tr>
58 <tr><th>MySQL</th><td> $versions{mysqlVersion}</td></tr>
59 <tr><th>OS</th><td> $versions{osVersion}</td></tr>
60 <tr><th>Perl</th><td> $versions{perlVersion}</td></tr>
63 } elsif ($debug_level eq "1"){
66 <p>The following fatal error has occurred:</p>
67 <pre><code>$msg</code></pre>";
69 print "<p>production mode - trapped fatal error</p>";
71 print "</body></html>";
73 #CGI::Carp::set_message(\&handle_errors);
74 ## give a stack backtrace if KOHA_BACKTRACES is set
75 ## can't rely on DebugLevel for this, as we're not yet connected
76 if ($ENV{KOHA_BACKTRACES
}) {
77 $main::SIG
{__DIE__
} = \
&CGI
::Carp
::confess
;
79 } # else there is no browser to send fatals to!
81 # Check if there are memcached servers set
82 $servers = $ENV{'MEMCACHED_SERVERS'};
84 # Load required libraries and create the memcached object
85 require Cache
::Memcached
;
86 $memcached = Cache
::Memcached
->new({
87 servers
=> [ $servers ],
89 compress_threshold
=> 10_000
,
91 namespace
=> $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
93 # Verify memcached available (set a variable and test the output)
94 $ismemcached = $memcached->set('ismemcached','1');
97 $VERSION = '3.07.00.049';
106 use DateTime
::TimeZone
;
107 use Module
::Load
::Conditional
qw(can_load);
112 C4::Context - Maintain and manipulate the context of a Koha script
118 use C4::Context("/path/to/koha-conf.xml");
120 $config_value = C4::Context->config("config_variable");
122 $koha_preference = C4::Context->preference("preference");
124 $db_handle = C4::Context->dbh;
126 $Zconn = C4::Context->Zconn;
128 $stopwordhash = C4::Context->stopwords;
132 When a Koha script runs, it makes use of a certain number of things:
133 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
134 databases, and so forth. These things make up the I<context> in which
137 This module takes care of setting up the context for a script:
138 figuring out which configuration file to load, and loading it, opening
139 a connection to the right database, and so forth.
141 Most scripts will only use one context. They can simply have
147 Other scripts may need to use several contexts. For instance, if a
148 library has two databases, one for a certain collection, and the other
149 for everything else, it might be necessary for a script to use two
150 different contexts to search both databases. Such scripts should use
151 the C<&set_context> and C<&restore_context> functions, below.
153 By default, C4::Context reads the configuration from
154 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
155 environment variable to the pathname of a configuration file to use.
162 # In addition to what is said in the POD above, a Context object is a
163 # reference-to-hash with the following fields:
166 # A reference-to-hash whose keys and values are the
167 # configuration variables and values specified in the config
168 # file (/etc/koha/koha-conf.xml).
170 # A handle to the appropriate database for this context.
172 # Used by &set_dbh and &restore_dbh to hold other database
173 # handles for this context.
175 # A connection object for the Zebra server
177 # Koha's main configuration file koha-conf.xml
178 # is searched for according to this priority list:
180 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
181 # 2. Path supplied in KOHA_CONF environment variable.
182 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
183 # as value has changed from its default of
184 # '__KOHA_CONF_DIR__/koha-conf.xml', as happens
185 # when Koha is installed in 'standard' or 'single'
187 # 4. Path supplied in CONFIG_FNAME.
189 # The first entry that refers to a readable file is used.
191 use constant CONFIG_FNAME
=> "/etc/koha/koha-conf.xml";
192 # Default config file, if none is specified
194 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
195 # path to config file set by installer
196 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
197 # when Koha is installed in 'standard' or 'single'
198 # mode. If Koha was installed in 'dev' mode,
199 # __KOHA_CONF_DIR__ is *not* rewritten; instead
200 # developers should set the KOHA_CONF environment variable
202 $context = undef; # Initially, no context is set
203 @context_stack = (); # Initially, no saved contexts
208 returns the kohaversion stored in kohaversion.pl file
213 my $cgidir = C4
::Context
->intranetdir;
215 # Apparently the GIT code does not run out of a CGI-BIN subdirectory
216 # but distribution code does? (Stan, 1jan08)
217 if(-d
$cgidir . "/cgi-bin"){
218 my $cgidir .= "/cgi-bin";
221 do $cgidir."/kohaversion.pl" || die "NO $cgidir/kohaversion.pl";
222 return kohaversion
();
225 =head2 final_linear_version
227 Returns the version number of the final update to run in updatedatabase.pl.
228 This number is equal to the version in kohaversion.pl
232 sub final_linear_version
{
236 =head2 read_config_file
238 Reads the specified Koha config file.
240 Returns an object containing the configuration variables. The object's
241 structure is a bit complex to the uninitiated ... take a look at the
242 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
243 here are a few examples that may give you what you need:
245 The simple elements nested within the <config> element:
247 my $pass = $koha->{'config'}->{'pass'};
249 The <listen> elements:
251 my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
253 The elements nested within the <server> element:
255 my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
257 Returns undef in case of error.
261 sub read_config_file
{ # Pass argument naming config file to read
262 my $koha = XMLin
(shift, keyattr
=> ['id'], forcearray
=> ['listen', 'server', 'serverinfo'], suppressempty
=> '');
265 $memcached->set('kohaconf',$koha);
268 return $koha; # Return value: ref-to-hash holding the configuration
273 Returns the value of the $ismemcached variable (0/1)
283 If $ismemcached is true, returns the $memcache variable.
284 Returns undef otherwise
298 my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
300 This routines translates a database type to part of the name
301 of the appropriate DBD driver to use when establishing a new
302 database connection. It recognizes 'mysql' and 'Pg'; if any
303 other scheme is supplied it defaults to 'mysql'.
308 my $scheme = shift // '';
309 return $scheme eq 'Pg' ?
$scheme : 'mysql';
313 # Create the default context ($C4::Context::Context)
314 # the first time the module is called
315 # (a config file can be optionaly passed)
317 # default context allready exists?
321 my ($pkg,$config_file) = @_ ;
322 my $new_ctx = __PACKAGE__
->new($config_file);
323 return unless $new_ctx;
325 # if successfully loaded, use it by default
326 $new_ctx->set_context;
332 $context = new C4::Context;
333 $context = new C4::Context("/path/to/koha-conf.xml");
335 Allocates a new context. Initializes the context from the specified
336 file, which defaults to either the file given by the C<$KOHA_CONF>
337 environment variable, or F</etc/koha/koha-conf.xml>.
339 It saves the koha-conf.xml values in the declared memcached server(s)
340 if currently available and uses those values until them expire and
343 C<&new> does not set this context as the new default context; for
344 that, use C<&set_context>.
350 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
353 my $conf_fname = shift; # Config file to load
356 # check that the specified config file exists and is not empty
357 undef $conf_fname unless
358 (defined $conf_fname && -s
$conf_fname);
359 # Figure out a good config file to load if none was specified.
360 if (!defined($conf_fname))
362 # If the $KOHA_CONF environment variable is set, use
363 # that. Otherwise, use the built-in default.
364 if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s
$ENV{"KOHA_CONF"}) {
365 $conf_fname = $ENV{"KOHA_CONF"};
366 } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s
$INSTALLED_CONFIG_FNAME) {
367 # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
368 # regex to anything else -- don't want installer to rewrite it
369 $conf_fname = $INSTALLED_CONFIG_FNAME;
370 } elsif (-s CONFIG_FNAME
) {
371 $conf_fname = CONFIG_FNAME
;
373 warn "unable to locate Koha configuration file koha-conf.xml";
379 # retreive from memcached
380 $self = $memcached->get('kohaconf');
381 if (not defined $self) {
382 # not in memcached yet
383 $self = read_config_file
($conf_fname);
386 # non-memcached env, read from file
387 $self = read_config_file
($conf_fname);
390 $self->{"config_file"} = $conf_fname;
391 warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
392 return if !defined($self->{"config"});
394 $self->{"dbh"} = undef; # Database handle
395 $self->{"Zconn"} = undef; # Zebra Connections
396 $self->{"stopwords"} = undef; # stopwords list
397 $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
398 $self->{"userenv"} = undef; # User env
399 $self->{"activeuser"} = undef; # current active user
400 $self->{"shelves"} = undef;
401 $self->{tz
} = undef; # local timezone object
404 $self->{db_driver
} = db_scheme2dbi
($self->config('db_scheme')); # cache database driver
410 $context = new C4::Context;
411 $context->set_context();
413 set_context C4::Context $context;
416 restore_context C4::Context;
418 In some cases, it might be necessary for a script to use multiple
419 contexts. C<&set_context> saves the current context on a stack, then
420 sets the context to C<$context>, which will be used in future
421 operations. To restore the previous context, use C<&restore_context>.
429 my $new_context; # The context to set
431 # Figure out whether this is a class or instance method call.
433 # We're going to make the assumption that control got here
434 # through valid means, i.e., that the caller used an instance
435 # or class method call, and that control got here through the
436 # usual inheritance mechanisms. The caller can, of course,
437 # break this assumption by playing silly buggers, but that's
438 # harder to do than doing it properly, and harder to check
440 if (ref($self) eq "")
442 # Class method. The new context is the next argument.
443 $new_context = shift;
445 # Instance method. The new context is $self.
446 $new_context = $self;
449 # Save the old context, if any, on the stack
450 push @context_stack, $context if defined($context);
452 # Set the new context
453 $context = $new_context;
456 =head2 restore_context
460 Restores the context set by C<&set_context>.
469 if ($#context_stack < 0)
472 die "Context stack underflow";
475 # Pop the old context and set it.
476 $context = pop @context_stack;
478 # FIXME - Should this return something, like maybe the context
479 # that was current when this was called?
484 $value = C4::Context->config("config_variable");
486 $value = C4::Context->config_variable;
488 Returns the value of a variable specified in the configuration file
489 from which the current context was created.
491 The second form is more compact, but of course may conflict with
492 method names. If there is a configuration variable called "new", then
493 C<C4::Config-E<gt>new> will not return it.
500 return if !defined($context->{$term});
501 # Presumably $self->{$term} might be
502 # undefined if the config file given to &new
503 # didn't exist, and the caller didn't bother
504 # to check the return value.
506 # Return the value of the requested config variable
507 return $context->{$term}->{$var};
511 return _common_config
($_[1],'config');
514 return _common_config
($_[1],'server');
517 return _common_config
($_[1],'serverinfo');
522 $sys_preference = C4::Context->preference('some_variable');
524 Looks up the value of the given system preference in the
525 systempreferences table of the Koha database, and returns it. If the
526 variable is not set or does not exist, undef is returned.
528 In case of an error, this may return 0.
530 Note: It is impossible to tell the difference between system
531 preferences which do not exist, and those whose values are set to NULL
536 # FIXME: running this under mod_perl will require a means of
537 # flushing the caching mechanism.
540 my $use_syspref_cache = 1;
544 my $var = shift; # The system preference to return
546 if ($use_syspref_cache && exists $sysprefs{lc $var}) {
547 return $sysprefs{lc $var};
550 my $dbh = C4
::Context
->dbh or return 0;
553 if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
554 $value = $ENV{"OVERRIDE_SYSPREF_$var"};
556 # Look up systempreferences.variable==$var
559 FROM systempreferences
563 $value = $dbh->selectrow_array( $sql, {}, lc $var );
566 $sysprefs{lc $var} = $value;
570 sub boolean_preference
{
572 my $var = shift; # The system preference to return
573 my $it = preference
($self, $var);
574 return defined($it)? C4
::Boolean
::true_p
($it): undef;
577 =head2 enable_syspref_cache
579 C4::Context->enable_syspref_cache();
581 Enable the in-memory syspref cache used by C4::Context. This is the
586 sub enable_syspref_cache
{
588 $use_syspref_cache = 1;
591 =head2 disable_syspref_cache
593 C4::Context->disable_syspref_cache();
595 Disable the in-memory syspref cache used by C4::Context. This should be
596 used with Plack and other persistent environments.
600 sub disable_syspref_cache
{
602 $use_syspref_cache = 0;
603 $self->clear_syspref_cache();
606 =head2 clear_syspref_cache
608 C4::Context->clear_syspref_cache();
610 cleans the internal cache of sysprefs. Please call this method if
611 you update the systempreferences table. Otherwise, your new changes
612 will not be seen by this process.
616 sub clear_syspref_cache
{
620 =head2 set_preference
622 C4::Context->set_preference( $variable, $value );
624 This updates a preference's value both in the systempreferences table and in
634 my $dbh = C4
::Context
->dbh or return 0;
636 my $type = $dbh->selectrow_array( "SELECT type FROM systempreferences WHERE variable = ?", {}, $var );
638 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
640 my $sth = $dbh->prepare( "
641 INSERT INTO systempreferences
644 ON DUPLICATE KEY UPDATE value = VALUES(value)
647 if($sth->execute( $var, $value )) {
648 $sysprefs{$var} = $value;
654 # This implements C4::Config->foo, and simply returns
655 # C4::Context->config("foo"), as described in the documentation for
658 # FIXME - Perhaps this should be extended to check &config first, and
659 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
660 # code, so it'd probably be best to delete it altogether so as not to
661 # encourage people to use it.
666 $AUTOLOAD =~ s/.*:://; # Chop off the package name,
667 # leaving only the function name.
668 return $self->config($AUTOLOAD);
673 $Zconn = C4::Context->Zconn
675 Returns a connection to the Zebra database
679 C<$server> one of the servers defined in the koha-conf.xml file
681 C<$async> whether this is a asynchronous connection
686 my ($self, $server, $async ) = @_;
687 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
688 if ( (!defined($ENV{GATEWAY_INTERFACE
})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
689 # if we are running the script from the commandline, lets try to use the caching
690 return $context->{"Zconn"}->{$cache_key};
692 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
693 $context->{"Zconn"}->{$cache_key} = &_new_Zconn
( $server, $async );
694 return $context->{"Zconn"}->{$cache_key};
699 $context->{"Zconn"} = &_new_Zconn($server,$async);
701 Internal function. Creates a new database connection from the data given in the current context and returns it.
703 C<$server> one of the servers defined in the koha-conf.xml file
705 C<$async> whether this is a asynchronous connection
707 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
712 my ( $server, $async ) = @_;
714 my $tried=0; # first attempt
715 my $Zconn; # connection object
720 $server //= "biblioserver";
722 if ( $server eq 'biblioserver' ) {
723 $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'grs1';
724 } elsif ( $server eq 'authorityserver' ) {
725 $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
728 if ( $index_mode eq 'grs1' ) {
729 $elementSetName = 'F';
730 $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
734 } else { # $index_mode eq 'dom'
736 $elementSetName = 'marcxml';
739 my $host = $context->{'listen'}->{$server}->{'content'};
740 my $user = $context->{"serverinfo"}->{$server}->{"user"};
741 my $password = $context->{"serverinfo"}->{$server}->{"password"};
744 my $o = new ZOOM
::Options
();
745 $o->option(user
=> $user) if $user && $password;
746 $o->option(password
=> $password) if $user && $password;
747 $o->option(async
=> 1) if $async;
748 $o->option(cqlfile
=> $context->{"server"}->{$server}->{"cql2rpn"});
749 $o->option(cclfile
=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
750 $o->option(preferredRecordSyntax
=> $syntax);
751 $o->option(elementSetName
=> $elementSetName) if $elementSetName;
752 $o->option(databaseName
=> $context->{"config"}->{$server}||"biblios");
754 # create a new connection object
755 $Zconn= create ZOOM
::Connection
($o);
758 $Zconn->connect($host, 0);
760 # check for errors and warn
761 if ($Zconn->errcode() !=0) {
762 warn "something wrong with the connection: ". $Zconn->errmsg();
769 # Internal helper function (not a method!). This creates a new
770 # database connection from the data given in the current context, and
776 ## correct name for db_scheme
777 my $db_driver = $context->{db_driver
};
779 my $db_name = $context->config("database");
780 my $db_host = $context->config("hostname");
781 my $db_port = $context->config("port") || '';
782 my $db_user = $context->config("user");
783 my $db_passwd = $context->config("pass");
784 # MJR added or die here, as we can't work without dbh
785 my $dbh = DBI
->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
786 $db_user, $db_passwd, {'RaiseError' => $ENV{DEBUG
}?
1:0 }) or die $DBI::errstr
;
788 # Check for the existence of a systempreference table; if we don't have this, we don't
789 # have a valid database and should not set RaiseError in order to allow the installer
790 # to run; installer will not run otherwise since we raise all db errors
793 local $dbh->{PrintError
} = 0;
794 local $dbh->{RaiseError
} = 1;
795 $dbh->do(qq{SELECT
* FROM systempreferences WHERE
1 = 0 });
799 $dbh->{RaiseError
} = 0;
802 if ( $db_driver eq 'mysql' ) {
803 $dbh->{mysql_auto_reconnect
} = 1;
807 if ( $db_driver eq 'mysql' ) {
808 # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
809 # this is better than modifying my.cnf (and forcing all communications to be in utf8)
810 $dbh->{'mysql_enable_utf8'}=1; #enable
811 $dbh->do("set NAMES 'utf8'");
812 ($tz) and $dbh->do(qq(SET time_zone
= "$tz"));
814 elsif ( $db_driver eq 'Pg' ) {
815 $dbh->do( "set client_encoding = 'UTF8';" );
816 ($tz) and $dbh->do(qq(SET TIME ZONE
= "$tz"));
823 $dbh = C4::Context->dbh;
825 Returns a database handle connected to the Koha database for the
826 current context. If no connection has yet been made, this method
827 creates one, and connects to the database.
829 This database handle is cached for future use: if you call
830 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
831 times. If you need a second database handle, use C<&new_dbh> and
832 possibly C<&set_dbh>.
843 unless ( $params->{new
} ) {
844 if ( defined($context->{db_driver
}) && $context->{db_driver
} eq 'mysql' && $context->{"dbh"} ) {
845 return $context->{"dbh"};
846 } elsif ( defined($context->{"dbh"}) && $context->{"dbh"}->ping() ) {
847 return $context->{"dbh"};
851 # No database handle or it died . Create one.
852 $context->{"dbh"} = &_new_dbh
();
854 return $context->{"dbh"};
859 $dbh = C4::Context->new_dbh;
861 Creates a new connection to the Koha database for the current context,
862 and returns the database handle (a C<DBI::db> object).
864 The handle is not saved anywhere: this method is strictly a
865 convenience function; the point is that it knows which database to
866 connect to so that the caller doesn't have to know.
880 $my_dbh = C4::Connect->new_dbh;
881 C4::Connect->set_dbh($my_dbh);
883 C4::Connect->restore_dbh;
885 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
886 C<&set_context> and C<&restore_context>.
888 C<&set_dbh> saves the current database handle on a stack, then sets
889 the current database handle to C<$my_dbh>.
891 C<$my_dbh> is assumed to be a good database handle.
901 # Save the current database handle on the handle stack.
902 # We assume that $new_dbh is all good: if the caller wants to
903 # screw himself by passing an invalid handle, that's fine by
905 push @
{$context->{"dbh_stack"}}, $context->{"dbh"};
906 $context->{"dbh"} = $new_dbh;
911 C4::Context->restore_dbh;
913 Restores the database handle saved by an earlier call to
914 C<C4::Context-E<gt>set_dbh>.
923 if ($#{$context->{"dbh_stack"}} < 0)
926 die "DBH stack underflow";
929 # Pop the old database handle and set it.
930 $context->{"dbh"} = pop @
{$context->{"dbh_stack"}};
932 # FIXME - If it is determined that restore_context should
933 # return something, then this function should, too.
938 $queryparser = C4::Context->queryparser
940 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
946 unless (defined $context->{"queryparser"}) {
947 $context->{"queryparser"} = &_new_queryparser
();
951 defined( $context->{"queryparser"} )
952 ?
$context->{"queryparser"}->new
956 =head2 _new_queryparser
958 Internal helper function to create a new QueryParser object. QueryParser
959 is loaded dynamically so as to keep the lack of the QueryParser library from
960 getting in anyone's way.
964 sub _new_queryparser
{
966 'OpenILS::QueryParser' => undef,
967 'Koha::QueryParser::Driver::PQF' => undef
969 if ( can_load
( 'modules' => $qpmodules ) ) {
970 my $QParser = Koha
::QueryParser
::Driver
::PQF
->new();
971 my $config_file = $context->config('queryparser_config');
972 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
973 if ( $QParser->load_config($config_file) ) {
974 # Set 'keyword' as the default search class
975 $QParser->default_search_class('keyword');
976 # TODO: allow indexes to be configured in the database
983 =head2 marcfromkohafield
985 $dbh = C4::Context->marcfromkohafield;
987 Returns a hash with marcfromkohafield.
989 This hash is cached for future use: if you call
990 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
995 sub marcfromkohafield
999 # If the hash already exists, return it.
1000 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
1002 # No hash. Create one.
1003 $context->{"marcfromkohafield"} = &_new_marcfromkohafield
();
1005 return $context->{"marcfromkohafield"};
1008 # _new_marcfromkohafield
1009 # Internal helper function (not a method!). This creates a new
1010 # hash with stopwords
1011 sub _new_marcfromkohafield
1013 my $dbh = C4
::Context
->dbh;
1014 my $marcfromkohafield;
1015 my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
1017 while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
1019 $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
1021 return $marcfromkohafield;
1026 $dbh = C4::Context->stopwords;
1028 Returns a hash with stopwords.
1030 This hash is cached for future use: if you call
1031 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
1040 # If the hash already exists, return it.
1041 return $context->{"stopwords"} if defined($context->{"stopwords"});
1043 # No hash. Create one.
1044 $context->{"stopwords"} = &_new_stopwords
();
1046 return $context->{"stopwords"};
1050 # Internal helper function (not a method!). This creates a new
1051 # hash with stopwords
1054 my $dbh = C4
::Context
->dbh;
1056 my $sth = $dbh->prepare("select word from stopwords");
1058 while (my $stopword = $sth->fetchrow_array) {
1059 $stopwordlist->{$stopword} = uc($stopword);
1061 $stopwordlist->{A
} = "A" unless $stopwordlist;
1062 return $stopwordlist;
1067 C4::Context->userenv;
1069 Retrieves a hash for user environment variables.
1071 This hash shall be cached for future use: if you call
1072 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1078 my $var = $context->{"activeuser"};
1079 if (defined $var and defined $context->{"userenv"}->{$var}) {
1080 return $context->{"userenv"}->{$var};
1088 C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname,
1089 $usersurname, $userbranch, $userflags, $emailaddress, $branchprinter,
1092 Establish a hash of user environment variables.
1094 set_userenv is called in Auth.pm
1100 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)= @_;
1101 my $var=$context->{"activeuser"} || '';
1103 "number" => $usernum,
1105 "cardnumber" => $usercnum,
1106 "firstname" => $userfirstname,
1107 "surname" => $usersurname,
1108 #possibly a law problem
1109 "branch" => $userbranch,
1110 "branchname" => $branchname,
1111 "flags" => $userflags,
1112 "emailaddress" => $emailaddress,
1113 "branchprinter" => $branchprinter,
1114 "persona" => $persona,
1115 "shibboleth" => $shibboleth,
1117 $context->{userenv
}->{$var} = $cell;
1121 sub set_shelves_userenv
{
1122 my ($type, $shelves) = @_ or return;
1123 my $activeuser = $context->{activeuser
} or return;
1124 $context->{userenv
}->{$activeuser}->{barshelves
} = $shelves if $type eq 'bar';
1125 $context->{userenv
}->{$activeuser}->{pubshelves
} = $shelves if $type eq 'pub';
1126 $context->{userenv
}->{$activeuser}->{totshelves
} = $shelves if $type eq 'tot';
1129 sub get_shelves_userenv
{
1131 unless ($active = $context->{userenv
}->{$context->{activeuser
}}) {
1132 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1135 my $totshelves = $active->{totshelves
} or undef;
1136 my $pubshelves = $active->{pubshelves
} or undef;
1137 my $barshelves = $active->{barshelves
} or undef;
1138 return ($totshelves, $pubshelves, $barshelves);
1143 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
1145 Builds a hash for user environment variables.
1147 This hash shall be cached for future use: if you call
1148 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1150 _new_userenv is called in Auth.pm
1157 shift; # Useless except it compensates for bad calling style
1158 my ($sessionID)= @_;
1159 $context->{"activeuser"}=$sessionID;
1162 =head2 _unset_userenv
1164 C4::Context->_unset_userenv;
1166 Destroys the hash for activeuser user environment variables.
1174 my ($sessionID)= @_;
1175 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1181 C4::Context->get_versions
1183 Gets various version info, for core Koha packages, Currently called from carp handle_errors() sub, to send to browser if 'DebugLevel' syspref is set to '2'.
1189 # A little example sub to show more debugging info for CGI::Carp
1192 $versions{kohaVersion
} = KOHAVERSION
();
1193 $versions{kohaDbVersion
} = C4
::Context
->preference('version');
1194 $versions{osVersion
} = join(" ", POSIX
::uname
());
1195 $versions{perlVersion
} = $];
1197 no warnings
qw(exec); # suppress warnings if unable to find a program in $PATH
1198 $versions{mysqlVersion
} = `mysql -V`;
1199 $versions{apacheVersion
} = `httpd -v`;
1200 $versions{apacheVersion
} = `httpd2 -v` unless $versions{apacheVersion
} ;
1201 $versions{apacheVersion
} = `apache2 -v` unless $versions{apacheVersion
} ;
1202 $versions{apacheVersion
} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion
} ;
1212 Returns a DateTime::TimeZone object for the system timezone
1218 if (!defined $context->{tz
}) {
1219 $context->{tz
} = DateTime
::TimeZone
->new(name
=> 'local');
1221 return $context->{tz
};
1225 =head2 IsSuperLibrarian
1227 C4::Context->IsSuperlibrarian();
1231 sub IsSuperLibrarian
{
1232 my $userenv = C4
::Context
->userenv;
1234 unless ( $userenv and exists $userenv->{flags
} ) {
1235 # If we reach this without a user environment,
1236 # assume that we're running from a command-line script,
1237 # and act as a superlibrarian.
1238 carp
("C4::Context->userenv not defined!");
1242 return ($userenv->{flags
}//0) % 2;
1247 Sets the current interface for later retrieval in any Perl module
1249 C4::Context->interface('opac');
1250 C4::Context->interface('intranet');
1251 my $interface = C4::Context->interface;
1256 my ($class, $interface) = @_;
1258 if (defined $interface) {
1259 $interface = lc $interface;
1260 if ($interface eq 'opac' || $interface eq 'intranet') {
1261 $context->{interface
} = $interface;
1263 warn "invalid interface : '$interface'";
1267 return $context->{interface
} // 'opac';
1277 Specifies the configuration file to read.
1285 Andrew Arensburger <arensb at ooblick dot com>
1287 Joshua Ferraro <jmf at liblime dot com>