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
409 $context = new C4::Context;
410 $context->set_context();
412 set_context C4::Context $context;
415 restore_context C4::Context;
417 In some cases, it might be necessary for a script to use multiple
418 contexts. C<&set_context> saves the current context on a stack, then
419 sets the context to C<$context>, which will be used in future
420 operations. To restore the previous context, use C<&restore_context>.
428 my $new_context; # The context to set
430 # Figure out whether this is a class or instance method call.
432 # We're going to make the assumption that control got here
433 # through valid means, i.e., that the caller used an instance
434 # or class method call, and that control got here through the
435 # usual inheritance mechanisms. The caller can, of course,
436 # break this assumption by playing silly buggers, but that's
437 # harder to do than doing it properly, and harder to check
439 if (ref($self) eq "")
441 # Class method. The new context is the next argument.
442 $new_context = shift;
444 # Instance method. The new context is $self.
445 $new_context = $self;
448 # Save the old context, if any, on the stack
449 push @context_stack, $context if defined($context);
451 # Set the new context
452 $context = $new_context;
455 =head2 restore_context
459 Restores the context set by C<&set_context>.
468 if ($#context_stack < 0)
471 die "Context stack underflow";
474 # Pop the old context and set it.
475 $context = pop @context_stack;
477 # FIXME - Should this return something, like maybe the context
478 # that was current when this was called?
483 $value = C4::Context->config("config_variable");
485 $value = C4::Context->config_variable;
487 Returns the value of a variable specified in the configuration file
488 from which the current context was created.
490 The second form is more compact, but of course may conflict with
491 method names. If there is a configuration variable called "new", then
492 C<C4::Config-E<gt>new> will not return it.
499 return if !defined($context->{$term});
500 # Presumably $self->{$term} might be
501 # undefined if the config file given to &new
502 # didn't exist, and the caller didn't bother
503 # to check the return value.
505 # Return the value of the requested config variable
506 return $context->{$term}->{$var};
510 return _common_config($_[1],'config');
513 return _common_config($_[1],'server');
516 return _common_config($_[1],'serverinfo');
521 $sys_preference = C4::Context->preference('some_variable');
523 Looks up the value of the given system preference in the
524 systempreferences table of the Koha database, and returns it. If the
525 variable is not set or does not exist, undef is returned.
527 In case of an error, this may return 0.
529 Note: It is impossible to tell the difference between system
530 preferences which do not exist, and those whose values are set to NULL
535 # FIXME: running this under mod_perl will require a means of
536 # flushing the caching mechanism.
539 my $use_syspref_cache = 1;
543 my $var = shift; # The system preference to return
545 if ($use_syspref_cache && exists $sysprefs{lc $var}) {
546 return $sysprefs{lc $var};
549 my $dbh = C4::Context->dbh or return 0;
552 if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
553 $value = $ENV{"OVERRIDE_SYSPREF_$var"};
555 # Look up systempreferences.variable==$var
558 FROM systempreferences
562 $value = $dbh->selectrow_array( $sql, {}, lc $var );
565 $sysprefs{lc $var} = $value;
569 sub boolean_preference {
571 my $var = shift; # The system preference to return
572 my $it = preference($self, $var);
573 return defined($it)? C4::Boolean::true_p($it): undef;
576 =head2 enable_syspref_cache
578 C4::Context->enable_syspref_cache();
580 Enable the in-memory syspref cache used by C4::Context. This is the
585 sub enable_syspref_cache {
587 $use_syspref_cache = 1;
590 =head2 disable_syspref_cache
592 C4::Context->disable_syspref_cache();
594 Disable the in-memory syspref cache used by C4::Context. This should be
595 used with Plack and other persistent environments.
599 sub disable_syspref_cache {
601 $use_syspref_cache = 0;
602 $self->clear_syspref_cache();
605 =head2 clear_syspref_cache
607 C4::Context->clear_syspref_cache();
609 cleans the internal cache of sysprefs. Please call this method if
610 you update the systempreferences table. Otherwise, your new changes
611 will not be seen by this process.
615 sub clear_syspref_cache {
619 =head2 set_preference
621 C4::Context->set_preference( $variable, $value );
623 This updates a preference's value both in the systempreferences table and in
633 my $dbh = C4::Context->dbh or return 0;
635 my $type = $dbh->selectrow_array( "SELECT type FROM systempreferences WHERE variable = ?", {}, $var );
637 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
639 my $sth = $dbh->prepare( "
640 INSERT INTO systempreferences
643 ON DUPLICATE KEY UPDATE value = VALUES(value)
646 if($sth->execute( $var, $value )) {
647 $sysprefs{$var} = $value;
653 # This implements C4::Config->foo, and simply returns
654 # C4::Context->config("foo"), as described in the documentation for
657 # FIXME - Perhaps this should be extended to check &config first, and
658 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
659 # code, so it'd probably be best to delete it altogether so as not to
660 # encourage people to use it.
665 $AUTOLOAD =~ s/.*:://; # Chop off the package name,
666 # leaving only the function name.
667 return $self->config($AUTOLOAD);
672 $Zconn = C4::Context->Zconn
674 Returns a connection to the Zebra database for the current
675 context. If no connection has yet been made, this method
676 creates one and connects.
680 C<$server> one of the servers defined in the koha-conf.xml file
682 C<$async> whether this is a asynchronous connection
684 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
696 if ( defined($context->{"Zconn"}->{$server}) && (0 == $context->{"Zconn"}->{$server}->errcode()) ) {
697 return $context->{"Zconn"}->{$server};
698 # No connection object or it died. Create one.
700 # release resources if we're closing a connection and making a new one
701 # FIXME: this needs to be smarter -- an error due to a malformed query or
702 # a missing index does not necessarily require us to close the connection
703 # and make a new one, particularly for a batch job. However, at
704 # first glance it does not look like there's a way to easily check
705 # the basic health of a ZOOM::Connection
706 $context->{"Zconn"}->{$server}->destroy() if defined($context->{"Zconn"}->{$server});
708 $context->{"Zconn"}->{$server} = &_new_Zconn($server,$async,$auth,$piggyback,$syntax);
709 return $context->{"Zconn"}->{$server};
715 $context->{"Zconn"} = &_new_Zconn($server,$async);
717 Internal function. Creates a new database connection from the data given in the current context and returns it.
719 C<$server> one of the servers defined in the koha-conf.xml file
721 C<$async> whether this is a asynchronous connection
723 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
728 my ($server,$async,$auth,$piggyback,$syntax) = @_;
730 my $tried=0; # first attempt
731 my $Zconn; # connection object
735 $server //= "biblioserver";
738 if ( $server eq 'biblioserver' ) {
739 $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'grs1';
740 } elsif ( $server eq 'authorityserver' ) {
741 $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
744 if ( $index_mode eq 'grs1' ) {
746 $elementSetName = 'F';
747 $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
753 $elementSetName = 'marcxml';
757 my $host = $context->{'listen'}->{$server}->{'content'};
758 my $servername = $context->{"config"}->{$server};
759 my $user = $context->{"serverinfo"}->{$server}->{"user"};
760 my $password = $context->{"serverinfo"}->{$server}->{"password"};
761 $auth = 1 if($user && $password);
765 my $o = new ZOOM::Options();
766 $o->option(user=>$user) if $auth;
767 $o->option(password=>$password) if $auth;
768 $o->option(async => 1) if $async;
769 $o->option(count => $piggyback) if $piggyback;
770 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
771 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
772 $o->option(preferredRecordSyntax => $syntax);
773 $o->option(elementSetName => $elementSetName);
774 $o->option(databaseName => ($servername?$servername:"biblios"));
776 # create a new connection object
777 $Zconn= create ZOOM::Connection($o);
780 $Zconn->connect($host, 0);
782 # check for errors and warn
783 if ($Zconn->errcode() !=0) {
784 warn "something wrong with the connection: ". $Zconn->errmsg();
793 # Internal helper function (not a method!). This creates a new
794 # database connection from the data given in the current context, and
796 our $db_driver = 'mysql';
801 ## correct name for db_scheme
802 my $db_driver = db_scheme2dbi($context->config("db_scheme"));
804 my $db_name = $context->config("database");
805 my $db_host = $context->config("hostname");
806 my $db_port = $context->config("port") || '';
807 my $db_user = $context->config("user");
808 my $db_passwd = $context->config("pass");
809 # MJR added or die here, as we can't work without dbh
810 my $dbh = DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
811 $db_user, $db_passwd, {'RaiseError' => $ENV{DEBUG}?1:0 }) or die $DBI::errstr;
813 # Check for the existence of a systempreference table; if we don't have this, we don't
814 # have a valid database and should not set RaiseError in order to allow the installer
815 # to run; installer will not run otherwise since we raise all db errors
818 local $dbh->{PrintError} = 0;
819 local $dbh->{RaiseError} = 1;
820 $dbh->do(qq{SELECT * FROM systempreferences WHERE 1 = 0 });
824 $dbh->{RaiseError} = 0;
827 if ( $db_driver eq 'mysql' ) {
828 $dbh->{mysql_auto_reconnect} = 1;
832 if ( $db_driver eq 'mysql' ) {
833 # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
834 # this is better than modifying my.cnf (and forcing all communications to be in utf8)
835 $dbh->{'mysql_enable_utf8'}=1; #enable
836 $dbh->do("set NAMES 'utf8'");
837 ($tz) and $dbh->do(qq(SET time_zone = "$tz"));
839 elsif ( $db_driver eq 'Pg' ) {
840 $dbh->do( "set client_encoding = 'UTF8';" );
841 ($tz) and $dbh->do(qq(SET TIME ZONE = "$tz"));
848 $dbh = C4::Context->dbh;
850 Returns a database handle connected to the Koha database for the
851 current context. If no connection has yet been made, this method
852 creates one, and connects to the database.
854 This database handle is cached for future use: if you call
855 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
856 times. If you need a second database handle, use C<&new_dbh> and
857 possibly C<&set_dbh>.
868 unless ( $params->{new} ) {
869 if ( defined $db_driver && $db_driver eq 'mysql' && $context->{"dbh"} ) {
870 return $context->{"dbh"};
871 } elsif ( defined $db_driver && defined($context->{"dbh"}) && $context->{"dbh"}->ping()) {
872 return $context->{"dbh"};
876 # No database handle or it died . Create one.
877 $context->{"dbh"} = &_new_dbh();
879 return $context->{"dbh"};
884 $dbh = C4::Context->new_dbh;
886 Creates a new connection to the Koha database for the current context,
887 and returns the database handle (a C<DBI::db> object).
889 The handle is not saved anywhere: this method is strictly a
890 convenience function; the point is that it knows which database to
891 connect to so that the caller doesn't have to know.
905 $my_dbh = C4::Connect->new_dbh;
906 C4::Connect->set_dbh($my_dbh);
908 C4::Connect->restore_dbh;
910 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
911 C<&set_context> and C<&restore_context>.
913 C<&set_dbh> saves the current database handle on a stack, then sets
914 the current database handle to C<$my_dbh>.
916 C<$my_dbh> is assumed to be a good database handle.
926 # Save the current database handle on the handle stack.
927 # We assume that $new_dbh is all good: if the caller wants to
928 # screw himself by passing an invalid handle, that's fine by
930 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
931 $context->{"dbh"} = $new_dbh;
936 C4::Context->restore_dbh;
938 Restores the database handle saved by an earlier call to
939 C<C4::Context-E<gt>set_dbh>.
948 if ($#{$context->{"dbh_stack"}} < 0)
951 die "DBH stack underflow";
954 # Pop the old database handle and set it.
955 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
957 # FIXME - If it is determined that restore_context should
958 # return something, then this function should, too.
963 $queryparser = C4::Context->queryparser
965 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
971 unless (defined $context->{"queryparser"}) {
972 $context->{"queryparser"} = &_new_queryparser();
976 defined( $context->{"queryparser"} )
977 ? $context->{"queryparser"}->new
981 =head2 _new_queryparser
983 Internal helper function to create a new QueryParser object. QueryParser
984 is loaded dynamically so as to keep the lack of the QueryParser library from
985 getting in anyone's way.
989 sub _new_queryparser {
991 'OpenILS::QueryParser' => undef,
992 'Koha::QueryParser::Driver::PQF' => undef
994 if ( can_load( 'modules' => $qpmodules ) ) {
995 my $QParser = Koha::QueryParser::Driver::PQF->new();
996 my $config_file = $context->config('queryparser_config');
997 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
998 if ( $QParser->load_config($config_file) ) {
999 # TODO: allow indexes to be configured in the database
1006 =head2 marcfromkohafield
1008 $dbh = C4::Context->marcfromkohafield;
1010 Returns a hash with marcfromkohafield.
1012 This hash is cached for future use: if you call
1013 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
1018 sub marcfromkohafield
1022 # If the hash already exists, return it.
1023 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
1025 # No hash. Create one.
1026 $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
1028 return $context->{"marcfromkohafield"};
1031 # _new_marcfromkohafield
1032 # Internal helper function (not a method!). This creates a new
1033 # hash with stopwords
1034 sub _new_marcfromkohafield
1036 my $dbh = C4::Context->dbh;
1037 my $marcfromkohafield;
1038 my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
1040 while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
1042 $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
1044 return $marcfromkohafield;
1049 $dbh = C4::Context->stopwords;
1051 Returns a hash with stopwords.
1053 This hash is cached for future use: if you call
1054 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
1063 # If the hash already exists, return it.
1064 return $context->{"stopwords"} if defined($context->{"stopwords"});
1066 # No hash. Create one.
1067 $context->{"stopwords"} = &_new_stopwords();
1069 return $context->{"stopwords"};
1073 # Internal helper function (not a method!). This creates a new
1074 # hash with stopwords
1077 my $dbh = C4::Context->dbh;
1079 my $sth = $dbh->prepare("select word from stopwords");
1081 while (my $stopword = $sth->fetchrow_array) {
1082 $stopwordlist->{$stopword} = uc($stopword);
1084 $stopwordlist->{A} = "A" unless $stopwordlist;
1085 return $stopwordlist;
1090 C4::Context->userenv;
1092 Retrieves a hash for user environment variables.
1094 This hash shall be cached for future use: if you call
1095 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1101 my $var = $context->{"activeuser"};
1102 if (defined $var and defined $context->{"userenv"}->{$var}) {
1103 return $context->{"userenv"}->{$var};
1111 C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname,
1112 $usersurname, $userbranch, $userflags, $emailaddress, $branchprinter,
1115 Establish a hash of user environment variables.
1117 set_userenv is called in Auth.pm
1123 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona)= @_;
1124 my $var=$context->{"activeuser"} || '';
1126 "number" => $usernum,
1128 "cardnumber" => $usercnum,
1129 "firstname" => $userfirstname,
1130 "surname" => $usersurname,
1131 #possibly a law problem
1132 "branch" => $userbranch,
1133 "branchname" => $branchname,
1134 "flags" => $userflags,
1135 "emailaddress" => $emailaddress,
1136 "branchprinter" => $branchprinter,
1137 "persona" => $persona,
1139 $context->{userenv}->{$var} = $cell;
1143 sub set_shelves_userenv {
1144 my ($type, $shelves) = @_ or return;
1145 my $activeuser = $context->{activeuser} or return;
1146 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1147 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1148 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1151 sub get_shelves_userenv {
1153 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1154 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1157 my $totshelves = $active->{totshelves} or undef;
1158 my $pubshelves = $active->{pubshelves} or undef;
1159 my $barshelves = $active->{barshelves} or undef;
1160 return ($totshelves, $pubshelves, $barshelves);
1165 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
1167 Builds a hash for user environment variables.
1169 This hash shall be cached for future use: if you call
1170 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1172 _new_userenv is called in Auth.pm
1179 shift; # Useless except it compensates for bad calling style
1180 my ($sessionID)= @_;
1181 $context->{"activeuser"}=$sessionID;
1184 =head2 _unset_userenv
1186 C4::Context->_unset_userenv;
1188 Destroys the hash for activeuser user environment variables.
1196 my ($sessionID)= @_;
1197 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1203 C4::Context->get_versions
1205 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'.
1211 # A little example sub to show more debugging info for CGI::Carp
1214 $versions{kohaVersion} = KOHAVERSION();
1215 $versions{kohaDbVersion} = C4::Context->preference('version');
1216 $versions{osVersion} = join(" ", POSIX::uname());
1217 $versions{perlVersion} = $];
1219 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1220 $versions{mysqlVersion} = `mysql -V`;
1221 $versions{apacheVersion} = `httpd -v`;
1222 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
1223 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
1224 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
1234 Returns a DateTime::TimeZone object for the system timezone
1240 if (!defined $context->{tz}) {
1241 $context->{tz} = DateTime::TimeZone->new(name => 'local');
1243 return $context->{tz};
1247 =head2 IsSuperLibrarian
1249 C4::Context->IsSuperlibrarian();
1253 sub IsSuperLibrarian {
1254 my $userenv = C4::Context->userenv;
1256 unless ( $userenv and exists $userenv->{flags} ) {
1257 # If we reach this without a user environment,
1258 # assume that we're running from a command-line script,
1259 # and act as a superlibrarian.
1260 carp("C4::Context->userenv not defined!");
1264 return ($userenv->{flags}//0) % 2;
1274 Specifies the configuration file to read.
1282 Andrew Arensburger <arensb at ooblick dot com>
1284 Joshua Ferraro <jmf at liblime dot com>