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);
111 C4::Context - Maintain and manipulate the context of a Koha script
117 use C4::Context("/path/to/koha-conf.xml");
119 $config_value = C4::Context->config("config_variable");
121 $koha_preference = C4::Context->preference("preference");
123 $db_handle = C4::Context->dbh;
125 $Zconn = C4::Context->Zconn;
127 $stopwordhash = C4::Context->stopwords;
131 When a Koha script runs, it makes use of a certain number of things:
132 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
133 databases, and so forth. These things make up the I<context> in which
136 This module takes care of setting up the context for a script:
137 figuring out which configuration file to load, and loading it, opening
138 a connection to the right database, and so forth.
140 Most scripts will only use one context. They can simply have
146 Other scripts may need to use several contexts. For instance, if a
147 library has two databases, one for a certain collection, and the other
148 for everything else, it might be necessary for a script to use two
149 different contexts to search both databases. Such scripts should use
150 the C<&set_context> and C<&restore_context> functions, below.
152 By default, C4::Context reads the configuration from
153 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
154 environment variable to the pathname of a configuration file to use.
161 # In addition to what is said in the POD above, a Context object is a
162 # reference-to-hash with the following fields:
165 # A reference-to-hash whose keys and values are the
166 # configuration variables and values specified in the config
167 # file (/etc/koha/koha-conf.xml).
169 # A handle to the appropriate database for this context.
171 # Used by &set_dbh and &restore_dbh to hold other database
172 # handles for this context.
174 # A connection object for the Zebra server
176 # Koha's main configuration file koha-conf.xml
177 # is searched for according to this priority list:
179 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
180 # 2. Path supplied in KOHA_CONF environment variable.
181 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
182 # as value has changed from its default of
183 # '__KOHA_CONF_DIR__/koha-conf.xml', as happens
184 # when Koha is installed in 'standard' or 'single'
186 # 4. Path supplied in CONFIG_FNAME.
188 # The first entry that refers to a readable file is used.
190 use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
191 # Default config file, if none is specified
193 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
194 # path to config file set by installer
195 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
196 # when Koha is installed in 'standard' or 'single'
197 # mode. If Koha was installed in 'dev' mode,
198 # __KOHA_CONF_DIR__ is *not* rewritten; instead
199 # developers should set the KOHA_CONF environment variable
201 $context = undef; # Initially, no context is set
202 @context_stack = (); # Initially, no saved contexts
207 returns the kohaversion stored in kohaversion.pl file
212 my $cgidir = C4::Context->intranetdir;
214 # Apparently the GIT code does not run out of a CGI-BIN subdirectory
215 # but distribution code does? (Stan, 1jan08)
216 if(-d $cgidir . "/cgi-bin"){
217 my $cgidir .= "/cgi-bin";
220 do $cgidir."/kohaversion.pl" || die "NO $cgidir/kohaversion.pl";
221 return kohaversion();
224 =head2 final_linear_version
226 Returns the version number of the final update to run in updatedatabase.pl.
227 This number is equal to the version in kohaversion.pl
231 sub final_linear_version {
235 =head2 read_config_file
237 Reads the specified Koha config file.
239 Returns an object containing the configuration variables. The object's
240 structure is a bit complex to the uninitiated ... take a look at the
241 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
242 here are a few examples that may give you what you need:
244 The simple elements nested within the <config> element:
246 my $pass = $koha->{'config'}->{'pass'};
248 The <listen> elements:
250 my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
252 The elements nested within the <server> element:
254 my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
256 Returns undef in case of error.
260 sub read_config_file { # Pass argument naming config file to read
261 my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo'], suppressempty => '');
264 $memcached->set('kohaconf',$koha);
267 return $koha; # Return value: ref-to-hash holding the configuration
272 Returns the value of the $ismemcached variable (0/1)
282 If $ismemcached is true, returns the $memcache variable.
283 Returns undef otherwise
296 # Translates the full text name of a database into de appropiate dbi name
300 # for instance, we support only mysql, so don't care checking
303 # FIXME - Should have other databases.
304 if (/mysql/) { return("mysql"); }
305 if (/Postgres|Pg|PostgresSQL/) { return("Pg"); }
306 if (/oracle/) { return("Oracle"); }
308 return; # Just in case
312 # Create the default context ($C4::Context::Context)
313 # the first time the module is called
314 # (a config file can be optionaly passed)
316 # default context allready exists?
320 my ($pkg,$config_file) = @_ ;
321 my $new_ctx = __PACKAGE__->new($config_file);
322 return unless $new_ctx;
324 # if successfully loaded, use it by default
325 $new_ctx->set_context;
331 $context = new C4::Context;
332 $context = new C4::Context("/path/to/koha-conf.xml");
334 Allocates a new context. Initializes the context from the specified
335 file, which defaults to either the file given by the C<$KOHA_CONF>
336 environment variable, or F</etc/koha/koha-conf.xml>.
338 It saves the koha-conf.xml values in the declared memcached server(s)
339 if currently available and uses those values until them expire and
342 C<&new> does not set this context as the new default context; for
343 that, use C<&set_context>.
349 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
352 my $conf_fname = shift; # Config file to load
355 # check that the specified config file exists and is not empty
356 undef $conf_fname unless
357 (defined $conf_fname && -s $conf_fname);
358 # Figure out a good config file to load if none was specified.
359 if (!defined($conf_fname))
361 # If the $KOHA_CONF environment variable is set, use
362 # that. Otherwise, use the built-in default.
363 if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s $ENV{"KOHA_CONF"}) {
364 $conf_fname = $ENV{"KOHA_CONF"};
365 } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
366 # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
367 # regex to anything else -- don't want installer to rewrite it
368 $conf_fname = $INSTALLED_CONFIG_FNAME;
369 } elsif (-s CONFIG_FNAME) {
370 $conf_fname = CONFIG_FNAME;
372 warn "unable to locate Koha configuration file koha-conf.xml";
378 # retreive from memcached
379 $self = $memcached->get('kohaconf');
380 if (not defined $self) {
381 # not in memcached yet
382 $self = read_config_file($conf_fname);
385 # non-memcached env, read from file
386 $self = read_config_file($conf_fname);
389 $self->{"config_file"} = $conf_fname;
390 warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
391 return if !defined($self->{"config"});
393 $self->{"dbh"} = undef; # Database handle
394 $self->{"Zconn"} = undef; # Zebra Connections
395 $self->{"stopwords"} = undef; # stopwords list
396 $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
397 $self->{"userenv"} = undef; # User env
398 $self->{"activeuser"} = undef; # current active user
399 $self->{"shelves"} = undef;
400 $self->{tz} = undef; # local timezone object
408 $context = new C4::Context;
409 $context->set_context();
411 set_context C4::Context $context;
414 restore_context C4::Context;
416 In some cases, it might be necessary for a script to use multiple
417 contexts. C<&set_context> saves the current context on a stack, then
418 sets the context to C<$context>, which will be used in future
419 operations. To restore the previous context, use C<&restore_context>.
427 my $new_context; # The context to set
429 # Figure out whether this is a class or instance method call.
431 # We're going to make the assumption that control got here
432 # through valid means, i.e., that the caller used an instance
433 # or class method call, and that control got here through the
434 # usual inheritance mechanisms. The caller can, of course,
435 # break this assumption by playing silly buggers, but that's
436 # harder to do than doing it properly, and harder to check
438 if (ref($self) eq "")
440 # Class method. The new context is the next argument.
441 $new_context = shift;
443 # Instance method. The new context is $self.
444 $new_context = $self;
447 # Save the old context, if any, on the stack
448 push @context_stack, $context if defined($context);
450 # Set the new context
451 $context = $new_context;
454 =head2 restore_context
458 Restores the context set by C<&set_context>.
467 if ($#context_stack < 0)
470 die "Context stack underflow";
473 # Pop the old context and set it.
474 $context = pop @context_stack;
476 # FIXME - Should this return something, like maybe the context
477 # that was current when this was called?
482 $value = C4::Context->config("config_variable");
484 $value = C4::Context->config_variable;
486 Returns the value of a variable specified in the configuration file
487 from which the current context was created.
489 The second form is more compact, but of course may conflict with
490 method names. If there is a configuration variable called "new", then
491 C<C4::Config-E<gt>new> will not return it.
498 return if !defined($context->{$term});
499 # Presumably $self->{$term} might be
500 # undefined if the config file given to &new
501 # didn't exist, and the caller didn't bother
502 # to check the return value.
504 # Return the value of the requested config variable
505 return $context->{$term}->{$var};
509 return _common_config($_[1],'config');
512 return _common_config($_[1],'server');
515 return _common_config($_[1],'serverinfo');
520 $sys_preference = C4::Context->preference('some_variable');
522 Looks up the value of the given system preference in the
523 systempreferences table of the Koha database, and returns it. If the
524 variable is not set or does not exist, undef is returned.
526 In case of an error, this may return 0.
528 Note: It is impossible to tell the difference between system
529 preferences which do not exist, and those whose values are set to NULL
534 # FIXME: running this under mod_perl will require a means of
535 # flushing the caching mechanism.
538 my $use_syspref_cache = 1;
542 my $var = shift; # The system preference to return
544 if ($use_syspref_cache && exists $sysprefs{lc $var}) {
545 return $sysprefs{lc $var};
548 my $dbh = C4::Context->dbh or return 0;
551 if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
552 $value = $ENV{"OVERRIDE_SYSPREF_$var"};
554 # Look up systempreferences.variable==$var
557 FROM systempreferences
561 $value = $dbh->selectrow_array( $sql, {}, lc $var );
564 $sysprefs{lc $var} = $value;
568 sub boolean_preference {
570 my $var = shift; # The system preference to return
571 my $it = preference($self, $var);
572 return defined($it)? C4::Boolean::true_p($it): undef;
575 =head2 enable_syspref_cache
577 C4::Context->enable_syspref_cache();
579 Enable the in-memory syspref cache used by C4::Context. This is the
584 sub enable_syspref_cache {
586 $use_syspref_cache = 1;
589 =head2 disable_syspref_cache
591 C4::Context->disable_syspref_cache();
593 Disable the in-memory syspref cache used by C4::Context. This should be
594 used with Plack and other persistent environments.
598 sub disable_syspref_cache {
600 $use_syspref_cache = 0;
601 $self->clear_syspref_cache();
604 =head2 clear_syspref_cache
606 C4::Context->clear_syspref_cache();
608 cleans the internal cache of sysprefs. Please call this method if
609 you update the systempreferences table. Otherwise, your new changes
610 will not be seen by this process.
614 sub clear_syspref_cache {
618 =head2 set_preference
620 C4::Context->set_preference( $variable, $value );
622 This updates a preference's value both in the systempreferences table and in
632 my $dbh = C4::Context->dbh or return 0;
634 my $type = $dbh->selectrow_array( "SELECT type FROM systempreferences WHERE variable = ?", {}, $var );
636 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
638 my $sth = $dbh->prepare( "
639 INSERT INTO systempreferences
642 ON DUPLICATE KEY UPDATE value = VALUES(value)
645 if($sth->execute( $var, $value )) {
646 $sysprefs{$var} = $value;
652 # This implements C4::Config->foo, and simply returns
653 # C4::Context->config("foo"), as described in the documentation for
656 # FIXME - Perhaps this should be extended to check &config first, and
657 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
658 # code, so it'd probably be best to delete it altogether so as not to
659 # encourage people to use it.
664 $AUTOLOAD =~ s/.*:://; # Chop off the package name,
665 # leaving only the function name.
666 return $self->config($AUTOLOAD);
671 $Zconn = C4::Context->Zconn
673 Returns a connection to the Zebra database for the current
674 context. If no connection has yet been made, this method
675 creates one and connects.
679 C<$server> one of the servers defined in the koha-conf.xml file
681 C<$async> whether this is a asynchronous connection
683 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
695 if ( defined($context->{"Zconn"}->{$server}) && (0 == $context->{"Zconn"}->{$server}->errcode()) ) {
696 return $context->{"Zconn"}->{$server};
697 # No connection object or it died. Create one.
699 # release resources if we're closing a connection and making a new one
700 # FIXME: this needs to be smarter -- an error due to a malformed query or
701 # a missing index does not necessarily require us to close the connection
702 # and make a new one, particularly for a batch job. However, at
703 # first glance it does not look like there's a way to easily check
704 # the basic health of a ZOOM::Connection
705 $context->{"Zconn"}->{$server}->destroy() if defined($context->{"Zconn"}->{$server});
707 $context->{"Zconn"}->{$server} = &_new_Zconn($server,$async,$auth,$piggyback,$syntax);
708 $context->{ Zconn }->{ $server }->option(
709 preferredRecordSyntax => C4::Context->preference("marcflavour") );
710 return $context->{"Zconn"}->{$server};
716 $context->{"Zconn"} = &_new_Zconn($server,$async);
718 Internal function. Creates a new database connection from the data given in the current context and returns it.
720 C<$server> one of the servers defined in the koha-conf.xml file
722 C<$async> whether this is a asynchronous connection
724 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
729 my ($server,$async,$auth,$piggyback,$syntax) = @_;
731 my $tried=0; # first attempt
732 my $Zconn; # connection object
733 $server = "biblioserver" unless $server;
734 $syntax = "usmarc" unless $syntax;
736 my $host = $context->{'listen'}->{$server}->{'content'};
737 my $servername = $context->{"config"}->{$server};
738 my $user = $context->{"serverinfo"}->{$server}->{"user"};
739 my $password = $context->{"serverinfo"}->{$server}->{"password"};
740 $auth = 1 if($user && $password);
744 my $o = new ZOOM::Options();
745 $o->option(user=>$user) if $auth;
746 $o->option(password=>$password) if $auth;
747 $o->option(async => 1) if $async;
748 $o->option(count => $piggyback) if $piggyback;
749 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
750 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
751 $o->option(preferredRecordSyntax => $syntax);
752 $o->option(elementSetName => "F"); # F for 'full' as opposed to B for 'brief'
753 $o->option(databaseName => ($servername?$servername:"biblios"));
755 # create a new connection object
756 $Zconn= create ZOOM::Connection($o);
759 $Zconn->connect($host, 0);
761 # check for errors and warn
762 if ($Zconn->errcode() !=0) {
763 warn "something wrong with the connection: ". $Zconn->errmsg();
768 # # Koha manages the Zebra server -- this doesn't work currently for me because of permissions issues
769 # # Also, I'm skeptical about whether it's the best approach
770 # warn "problem with Zebra";
771 # if ( C4::Context->preference("ManageZebra") ) {
772 # if ($@->code==10000 && $tried==0) { ##No connection try restarting Zebra
774 # warn "trying to restart Zebra";
775 # my $res=system("zebrasrv -f $ENV{'KOHA_CONF'} >/koha/log/zebra-error.log");
778 # warn "Error ", $@->code(), ": ", $@->message(), "\n";
788 # Internal helper function (not a method!). This creates a new
789 # database connection from the data given in the current context, and
795 ## correct name for db_schme
797 if ($context->config("db_scheme")){
798 $db_driver=db_scheme2dbi($context->config("db_scheme"));
803 my $db_name = $context->config("database");
804 my $db_host = $context->config("hostname");
805 my $db_port = $context->config("port") || '';
806 my $db_user = $context->config("user");
807 my $db_passwd = $context->config("pass");
808 # MJR added or die here, as we can't work without dbh
809 my $dbh = DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
810 $db_user, $db_passwd, {'RaiseError' => $ENV{DEBUG}?1:0 }) or die $DBI::errstr;
812 # Check for the existence of a systempreference table; if we don't have this, we don't
813 # have a valid database and should not set RaiseError in order to allow the installer
814 # to run; installer will not run otherwise since we raise all db errors
817 local $dbh->{PrintError} = 0;
818 local $dbh->{RaiseError} = 1;
819 $dbh->do(qq{SELECT * FROM systempreferences WHERE 1 = 0 });
823 $dbh->{RaiseError} = 0;
827 if ( $db_driver eq 'mysql' ) {
828 # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
829 # this is better than modifying my.cnf (and forcing all communications to be in utf8)
830 $dbh->{'mysql_enable_utf8'}=1; #enable
831 $dbh->do("set NAMES 'utf8'");
832 ($tz) and $dbh->do(qq(SET time_zone = "$tz"));
834 elsif ( $db_driver eq 'Pg' ) {
835 $dbh->do( "set client_encoding = 'UTF8';" );
836 ($tz) and $dbh->do(qq(SET TIME ZONE = "$tz"));
843 $dbh = C4::Context->dbh;
845 Returns a database handle connected to the Koha database for the
846 current context. If no connection has yet been made, this method
847 creates one, and connects to the database.
849 This database handle is cached for future use: if you call
850 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
851 times. If you need a second database handle, use C<&new_dbh> and
852 possibly C<&set_dbh>.
862 if (defined($context->{"dbh"}) && $context->{"dbh"}->ping()) {
863 return $context->{"dbh"};
866 # No database handle or it died . Create one.
867 $context->{"dbh"} = &_new_dbh();
869 return $context->{"dbh"};
874 $dbh = C4::Context->new_dbh;
876 Creates a new connection to the Koha database for the current context,
877 and returns the database handle (a C<DBI::db> object).
879 The handle is not saved anywhere: this method is strictly a
880 convenience function; the point is that it knows which database to
881 connect to so that the caller doesn't have to know.
895 $my_dbh = C4::Connect->new_dbh;
896 C4::Connect->set_dbh($my_dbh);
898 C4::Connect->restore_dbh;
900 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
901 C<&set_context> and C<&restore_context>.
903 C<&set_dbh> saves the current database handle on a stack, then sets
904 the current database handle to C<$my_dbh>.
906 C<$my_dbh> is assumed to be a good database handle.
916 # Save the current database handle on the handle stack.
917 # We assume that $new_dbh is all good: if the caller wants to
918 # screw himself by passing an invalid handle, that's fine by
920 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
921 $context->{"dbh"} = $new_dbh;
926 C4::Context->restore_dbh;
928 Restores the database handle saved by an earlier call to
929 C<C4::Context-E<gt>set_dbh>.
938 if ($#{$context->{"dbh_stack"}} < 0)
941 die "DBH stack underflow";
944 # Pop the old database handle and set it.
945 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
947 # FIXME - If it is determined that restore_context should
948 # return something, then this function should, too.
953 $queryparser = C4::Context->queryparser
955 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
961 unless (defined $context->{"queryparser"}) {
962 $context->{"queryparser"} = &_new_queryparser();
966 defined( $context->{"queryparser"} )
967 ? $context->{"queryparser"}->new
971 =head2 _new_queryparser
973 Internal helper function to create a new QueryParser object. QueryParser
974 is loaded dynamically so as to keep the lack of the QueryParser library from
975 getting in anyone's way.
979 sub _new_queryparser {
981 'OpenILS::QueryParser' => undef,
982 'Koha::QueryParser::Driver::PQF' => undef
984 if ( can_load( 'modules' => $qpmodules ) ) {
985 my $QParser = Koha::QueryParser::Driver::PQF->new();
986 my $config_file = $context->config('queryparser_config');
987 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
988 if ( $QParser->load_config($config_file) ) {
989 # TODO: allow indexes to be configured in the database
996 =head2 marcfromkohafield
998 $dbh = C4::Context->marcfromkohafield;
1000 Returns a hash with marcfromkohafield.
1002 This hash is cached for future use: if you call
1003 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
1008 sub marcfromkohafield
1012 # If the hash already exists, return it.
1013 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
1015 # No hash. Create one.
1016 $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
1018 return $context->{"marcfromkohafield"};
1021 # _new_marcfromkohafield
1022 # Internal helper function (not a method!). This creates a new
1023 # hash with stopwords
1024 sub _new_marcfromkohafield
1026 my $dbh = C4::Context->dbh;
1027 my $marcfromkohafield;
1028 my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
1030 while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
1032 $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
1034 return $marcfromkohafield;
1039 $dbh = C4::Context->stopwords;
1041 Returns a hash with stopwords.
1043 This hash is cached for future use: if you call
1044 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
1053 # If the hash already exists, return it.
1054 return $context->{"stopwords"} if defined($context->{"stopwords"});
1056 # No hash. Create one.
1057 $context->{"stopwords"} = &_new_stopwords();
1059 return $context->{"stopwords"};
1063 # Internal helper function (not a method!). This creates a new
1064 # hash with stopwords
1067 my $dbh = C4::Context->dbh;
1069 my $sth = $dbh->prepare("select word from stopwords");
1071 while (my $stopword = $sth->fetchrow_array) {
1072 $stopwordlist->{$stopword} = uc($stopword);
1074 $stopwordlist->{A} = "A" unless $stopwordlist;
1075 return $stopwordlist;
1080 C4::Context->userenv;
1082 Retrieves a hash for user environment variables.
1084 This hash shall be cached for future use: if you call
1085 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1091 my $var = $context->{"activeuser"};
1092 if (defined $var and defined $context->{"userenv"}->{$var}) {
1093 return $context->{"userenv"}->{$var};
1101 C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname,
1102 $usersurname, $userbranch, $userflags, $emailaddress, $branchprinter,
1105 Establish a hash of user environment variables.
1107 set_userenv is called in Auth.pm
1113 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona)= @_;
1114 my $var=$context->{"activeuser"} || '';
1116 "number" => $usernum,
1118 "cardnumber" => $usercnum,
1119 "firstname" => $userfirstname,
1120 "surname" => $usersurname,
1121 #possibly a law problem
1122 "branch" => $userbranch,
1123 "branchname" => $branchname,
1124 "flags" => $userflags,
1125 "emailaddress" => $emailaddress,
1126 "branchprinter" => $branchprinter,
1127 "persona" => $persona,
1129 $context->{userenv}->{$var} = $cell;
1133 sub set_shelves_userenv {
1134 my ($type, $shelves) = @_ or return;
1135 my $activeuser = $context->{activeuser} or return;
1136 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1137 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1138 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1141 sub get_shelves_userenv {
1143 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1144 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1147 my $totshelves = $active->{totshelves} or undef;
1148 my $pubshelves = $active->{pubshelves} or undef;
1149 my $barshelves = $active->{barshelves} or undef;
1150 return ($totshelves, $pubshelves, $barshelves);
1155 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
1157 Builds a hash for user environment variables.
1159 This hash shall be cached for future use: if you call
1160 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1162 _new_userenv is called in Auth.pm
1169 shift; # Useless except it compensates for bad calling style
1170 my ($sessionID)= @_;
1171 $context->{"activeuser"}=$sessionID;
1174 =head2 _unset_userenv
1176 C4::Context->_unset_userenv;
1178 Destroys the hash for activeuser user environment variables.
1186 my ($sessionID)= @_;
1187 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1193 C4::Context->get_versions
1195 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'.
1201 # A little example sub to show more debugging info for CGI::Carp
1204 $versions{kohaVersion} = KOHAVERSION();
1205 $versions{kohaDbVersion} = C4::Context->preference('version');
1206 $versions{osVersion} = join(" ", POSIX::uname());
1207 $versions{perlVersion} = $];
1209 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1210 $versions{mysqlVersion} = `mysql -V`;
1211 $versions{apacheVersion} = `httpd -v`;
1212 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
1213 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
1214 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
1224 Returns a DateTime::TimeZone object for the system timezone
1230 if (!defined $context->{tz}) {
1231 $context->{tz} = DateTime::TimeZone->new(name => 'local');
1233 return $context->{tz};
1245 Specifies the configuration file to read.
1253 Andrew Arensburger <arensb at ooblick dot com>
1255 Joshua Ferraro <jmf at liblime dot com>