Bug 10963: Simplified creation - FA framework
[koha.git] / C4 / Context.pm
blob26eeb40885383795dbb025f1d7f0c07c5335a0d8
1 package C4::Context;
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
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # Koha is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
19 use strict;
20 use warnings;
21 use vars qw($VERSION $AUTOLOAD $context @context_stack $servers $memcached $ismemcached);
22 BEGIN {
23 if ($ENV{'HTTP_USER_AGENT'}) {
24 require CGI::Carp;
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);
28 sub handle_errors {
29 my $msg = shift;
30 my $debug_level;
31 eval {C4::Context->dbh();};
32 if ($@){
33 $debug_level = 1;
35 else {
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>
43 <body>
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";
50 print "
51 <h1>Koha error</h1>
52 <p>The following fatal error has occurred:</p>
53 <pre><code>$msg</code></pre>
54 <table>
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>
61 </table>";
63 } elsif ($debug_level eq "1"){
64 print "
65 <h1>Koha error</h1>
66 <p>The following fatal error has occurred:</p>
67 <pre><code>$msg</code></pre>";
68 } else {
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'};
83 if ($servers) {
84 # Load required libraries and create the memcached object
85 require Cache::Memcached;
86 $memcached = Cache::Memcached->new({
87 servers => [ $servers ],
88 debug => 0,
89 compress_threshold => 10_000,
90 expire_time => 600,
91 namespace => $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
92 });
93 # Verify memcached available (set a variable and test the output)
94 $ismemcached = $memcached->set('ismemcached','1');
97 $VERSION = '3.07.00.049';
100 use DBIx::Connector;
101 use Encode;
102 use ZOOM;
103 use XML::Simple;
104 use POSIX ();
105 use DateTime::TimeZone;
106 use Module::Load::Conditional qw(can_load);
107 use Carp;
109 use C4::Boolean;
110 use C4::Debug;
111 use Koha;
112 use Koha::Config::SysPrefs;
114 =head1 NAME
116 C4::Context - Maintain and manipulate the context of a Koha script
118 =head1 SYNOPSIS
120 use C4::Context;
122 use C4::Context("/path/to/koha-conf.xml");
124 $config_value = C4::Context->config("config_variable");
126 $koha_preference = C4::Context->preference("preference");
128 $db_handle = C4::Context->dbh;
130 $Zconn = C4::Context->Zconn;
132 $stopwordhash = C4::Context->stopwords;
134 =head1 DESCRIPTION
136 When a Koha script runs, it makes use of a certain number of things:
137 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
138 databases, and so forth. These things make up the I<context> in which
139 the script runs.
141 This module takes care of setting up the context for a script:
142 figuring out which configuration file to load, and loading it, opening
143 a connection to the right database, and so forth.
145 Most scripts will only use one context. They can simply have
147 use C4::Context;
149 at the top.
151 Other scripts may need to use several contexts. For instance, if a
152 library has two databases, one for a certain collection, and the other
153 for everything else, it might be necessary for a script to use two
154 different contexts to search both databases. Such scripts should use
155 the C<&set_context> and C<&restore_context> functions, below.
157 By default, C4::Context reads the configuration from
158 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
159 environment variable to the pathname of a configuration file to use.
161 =head1 METHODS
163 =cut
166 # In addition to what is said in the POD above, a Context object is a
167 # reference-to-hash with the following fields:
169 # config
170 # A reference-to-hash whose keys and values are the
171 # configuration variables and values specified in the config
172 # file (/etc/koha/koha-conf.xml).
173 # dbh
174 # A handle to the appropriate database for this context.
175 # dbh_stack
176 # Used by &set_dbh and &restore_dbh to hold other database
177 # handles for this context.
178 # Zconn
179 # A connection object for the Zebra server
181 # Koha's main configuration file koha-conf.xml
182 # is searched for according to this priority list:
184 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
185 # 2. Path supplied in KOHA_CONF environment variable.
186 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
187 # as value has changed from its default of
188 # '__KOHA_CONF_DIR__/koha-conf.xml', as happens
189 # when Koha is installed in 'standard' or 'single'
190 # mode.
191 # 4. Path supplied in CONFIG_FNAME.
193 # The first entry that refers to a readable file is used.
195 use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
196 # Default config file, if none is specified
198 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
199 # path to config file set by installer
200 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
201 # when Koha is installed in 'standard' or 'single'
202 # mode. If Koha was installed in 'dev' mode,
203 # __KOHA_CONF_DIR__ is *not* rewritten; instead
204 # developers should set the KOHA_CONF environment variable
206 $context = undef; # Initially, no context is set
207 @context_stack = (); # Initially, no saved contexts
210 =head2 read_config_file
212 Reads the specified Koha config file.
214 Returns an object containing the configuration variables. The object's
215 structure is a bit complex to the uninitiated ... take a look at the
216 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
217 here are a few examples that may give you what you need:
219 The simple elements nested within the <config> element:
221 my $pass = $koha->{'config'}->{'pass'};
223 The <listen> elements:
225 my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
227 The elements nested within the <server> element:
229 my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
231 Returns undef in case of error.
233 =cut
235 sub read_config_file { # Pass argument naming config file to read
236 my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo'], suppressempty => '');
238 if ($ismemcached) {
239 $memcached->set('kohaconf',$koha);
242 return $koha; # Return value: ref-to-hash holding the configuration
245 =head2 ismemcached
247 Returns the value of the $ismemcached variable (0/1)
249 =cut
251 sub ismemcached {
252 return $ismemcached;
255 =head2 memcached
257 If $ismemcached is true, returns the $memcache variable.
258 Returns undef otherwise
260 =cut
262 sub memcached {
263 if ($ismemcached) {
264 return $memcached;
265 } else {
266 return;
270 =head2 db_scheme2dbi
272 my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
274 This routines translates a database type to part of the name
275 of the appropriate DBD driver to use when establishing a new
276 database connection. It recognizes 'mysql' and 'Pg'; if any
277 other scheme is supplied it defaults to 'mysql'.
279 =cut
281 sub db_scheme2dbi {
282 my $scheme = shift // '';
283 return $scheme eq 'Pg' ? $scheme : 'mysql';
286 sub import {
287 # Create the default context ($C4::Context::Context)
288 # the first time the module is called
289 # (a config file can be optionaly passed)
291 # default context already exists?
292 return if $context;
294 # no ? so load it!
295 my ($pkg,$config_file) = @_ ;
296 my $new_ctx = __PACKAGE__->new($config_file);
297 return unless $new_ctx;
299 # if successfully loaded, use it by default
300 $new_ctx->set_context;
304 =head2 new
306 $context = new C4::Context;
307 $context = new C4::Context("/path/to/koha-conf.xml");
309 Allocates a new context. Initializes the context from the specified
310 file, which defaults to either the file given by the C<$KOHA_CONF>
311 environment variable, or F</etc/koha/koha-conf.xml>.
313 It saves the koha-conf.xml values in the declared memcached server(s)
314 if currently available and uses those values until them expire and
315 re-reads them.
317 C<&new> does not set this context as the new default context; for
318 that, use C<&set_context>.
320 =cut
323 # Revision History:
324 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
325 sub new {
326 my $class = shift;
327 my $conf_fname = shift; # Config file to load
328 my $self = {};
330 # check that the specified config file exists and is not empty
331 undef $conf_fname unless
332 (defined $conf_fname && -s $conf_fname);
333 # Figure out a good config file to load if none was specified.
334 if (!defined($conf_fname))
336 # If the $KOHA_CONF environment variable is set, use
337 # that. Otherwise, use the built-in default.
338 if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s $ENV{"KOHA_CONF"}) {
339 $conf_fname = $ENV{"KOHA_CONF"};
340 } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
341 # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
342 # regex to anything else -- don't want installer to rewrite it
343 $conf_fname = $INSTALLED_CONFIG_FNAME;
344 } elsif (-s CONFIG_FNAME) {
345 $conf_fname = CONFIG_FNAME;
346 } else {
347 warn "unable to locate Koha configuration file koha-conf.xml";
348 return;
352 if ($ismemcached) {
353 # retrieve from memcached
354 $self = $memcached->get('kohaconf');
355 if (not defined $self) {
356 # not in memcached yet
357 $self = read_config_file($conf_fname);
359 } else {
360 # non-memcached env, read from file
361 $self = read_config_file($conf_fname);
364 $self->{"config_file"} = $conf_fname;
365 warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
366 return if !defined($self->{"config"});
368 $self->{"dbh"} = undef; # Database handle
369 $self->{"Zconn"} = undef; # Zebra Connections
370 $self->{"stopwords"} = undef; # stopwords list
371 $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
372 $self->{"userenv"} = undef; # User env
373 $self->{"activeuser"} = undef; # current active user
374 $self->{"shelves"} = undef;
375 $self->{tz} = undef; # local timezone object
377 bless $self, $class;
378 $self->{db_driver} = db_scheme2dbi($self->config('db_scheme')); # cache database driver
379 return $self;
382 =head2 set_context
384 $context = new C4::Context;
385 $context->set_context();
387 set_context C4::Context $context;
390 restore_context C4::Context;
392 In some cases, it might be necessary for a script to use multiple
393 contexts. C<&set_context> saves the current context on a stack, then
394 sets the context to C<$context>, which will be used in future
395 operations. To restore the previous context, use C<&restore_context>.
397 =cut
400 sub set_context
402 my $self = shift;
403 my $new_context; # The context to set
405 # Figure out whether this is a class or instance method call.
407 # We're going to make the assumption that control got here
408 # through valid means, i.e., that the caller used an instance
409 # or class method call, and that control got here through the
410 # usual inheritance mechanisms. The caller can, of course,
411 # break this assumption by playing silly buggers, but that's
412 # harder to do than doing it properly, and harder to check
413 # for.
414 if (ref($self) eq "")
416 # Class method. The new context is the next argument.
417 $new_context = shift;
418 } else {
419 # Instance method. The new context is $self.
420 $new_context = $self;
423 # Save the old context, if any, on the stack
424 push @context_stack, $context if defined($context);
426 # Set the new context
427 $context = $new_context;
430 =head2 restore_context
432 &restore_context;
434 Restores the context set by C<&set_context>.
436 =cut
439 sub restore_context
441 my $self = shift;
443 if ($#context_stack < 0)
445 # Stack underflow.
446 die "Context stack underflow";
449 # Pop the old context and set it.
450 $context = pop @context_stack;
452 # FIXME - Should this return something, like maybe the context
453 # that was current when this was called?
456 =head2 config
458 $value = C4::Context->config("config_variable");
460 $value = C4::Context->config_variable;
462 Returns the value of a variable specified in the configuration file
463 from which the current context was created.
465 The second form is more compact, but of course may conflict with
466 method names. If there is a configuration variable called "new", then
467 C<C4::Config-E<gt>new> will not return it.
469 =cut
471 sub _common_config {
472 my $var = shift;
473 my $term = shift;
474 return if !defined($context->{$term});
475 # Presumably $self->{$term} might be
476 # undefined if the config file given to &new
477 # didn't exist, and the caller didn't bother
478 # to check the return value.
480 # Return the value of the requested config variable
481 return $context->{$term}->{$var};
484 sub config {
485 return _common_config($_[1],'config');
487 sub zebraconfig {
488 return _common_config($_[1],'server');
490 sub ModZebrations {
491 return _common_config($_[1],'serverinfo');
494 =head2 preference
496 $sys_preference = C4::Context->preference('some_variable');
498 Looks up the value of the given system preference in the
499 systempreferences table of the Koha database, and returns it. If the
500 variable is not set or does not exist, undef is returned.
502 In case of an error, this may return 0.
504 Note: It is impossible to tell the difference between system
505 preferences which do not exist, and those whose values are set to NULL
506 with this method.
508 =cut
510 # FIXME: running this under mod_perl will require a means of
511 # flushing the caching mechanism.
513 my %sysprefs;
514 my $use_syspref_cache = 1;
516 sub preference {
517 my $self = shift;
518 my $var = shift; # The system preference to return
520 if ($use_syspref_cache && exists $sysprefs{lc $var}) {
521 return $sysprefs{lc $var};
524 my $dbh = C4::Context->dbh or return 0;
526 my $value;
527 if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
528 $value = $ENV{"OVERRIDE_SYSPREF_$var"};
529 } else {
530 my $syspref;
531 eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
532 $value = $syspref ? $syspref->value() : undef;
535 $sysprefs{lc $var} = $value;
536 return $value;
539 sub boolean_preference {
540 my $self = shift;
541 my $var = shift; # The system preference to return
542 my $it = preference($self, $var);
543 return defined($it)? C4::Boolean::true_p($it): undef;
546 =head2 enable_syspref_cache
548 C4::Context->enable_syspref_cache();
550 Enable the in-memory syspref cache used by C4::Context. This is the
551 default behavior.
553 =cut
555 sub enable_syspref_cache {
556 my ($self) = @_;
557 $use_syspref_cache = 1;
560 =head2 disable_syspref_cache
562 C4::Context->disable_syspref_cache();
564 Disable the in-memory syspref cache used by C4::Context. This should be
565 used with Plack and other persistent environments.
567 =cut
569 sub disable_syspref_cache {
570 my ($self) = @_;
571 $use_syspref_cache = 0;
572 $self->clear_syspref_cache();
575 =head2 clear_syspref_cache
577 C4::Context->clear_syspref_cache();
579 cleans the internal cache of sysprefs. Please call this method if
580 you update the systempreferences table. Otherwise, your new changes
581 will not be seen by this process.
583 =cut
585 sub clear_syspref_cache {
586 %sysprefs = ();
589 =head2 set_preference
591 C4::Context->set_preference( $variable, $value );
593 This updates a preference's value both in the systempreferences table and in
594 the sysprefs cache.
596 =cut
598 sub set_preference {
599 my $self = shift;
600 my $var = lc(shift);
601 my $value = shift;
603 my $syspref = Koha::Config::SysPrefs->find( $var );
604 my $type = $syspref ? $syspref->type() : undef;
606 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
608 # force explicit protocol on OPACBaseURL
609 if ($var eq 'opacbaseurl' && substr($value,0,4) !~ /http/) {
610 $value = 'http://' . $value;
613 if ($syspref) {
614 $syspref = $syspref->set( { value => $value } )->store();
616 else {
617 $syspref = Koha::Config::SysPref->new( { variable => $var, value => $value } )->store();
620 if ($syspref) {
621 $sysprefs{$var} = $value;
625 =head2 Zconn
627 $Zconn = C4::Context->Zconn
629 Returns a connection to the Zebra database
631 C<$self>
633 C<$server> one of the servers defined in the koha-conf.xml file
635 C<$async> whether this is a asynchronous connection
637 =cut
639 sub Zconn {
640 my ($self, $server, $async ) = @_;
641 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
642 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
643 # if we are running the script from the commandline, lets try to use the caching
644 return $context->{"Zconn"}->{$cache_key};
646 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
647 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
648 return $context->{"Zconn"}->{$cache_key};
651 =head2 _new_Zconn
653 $context->{"Zconn"} = &_new_Zconn($server,$async);
655 Internal function. Creates a new database connection from the data given in the current context and returns it.
657 C<$server> one of the servers defined in the koha-conf.xml file
659 C<$async> whether this is a asynchronous connection
661 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
663 =cut
665 sub _new_Zconn {
666 my ( $server, $async ) = @_;
668 my $tried=0; # first attempt
669 my $Zconn; # connection object
670 my $elementSetName;
671 my $index_mode;
672 my $syntax;
674 $server //= "biblioserver";
676 if ( $server eq 'biblioserver' ) {
677 $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
678 } elsif ( $server eq 'authorityserver' ) {
679 $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
682 if ( $index_mode eq 'grs1' ) {
683 $elementSetName = 'F';
684 $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
685 ? 'unimarc'
686 : 'usmarc';
688 } else { # $index_mode eq 'dom'
689 $syntax = 'xml';
690 $elementSetName = 'marcxml';
693 my $host = $context->{'listen'}->{$server}->{'content'};
694 my $user = $context->{"serverinfo"}->{$server}->{"user"};
695 my $password = $context->{"serverinfo"}->{$server}->{"password"};
696 eval {
697 # set options
698 my $o = new ZOOM::Options();
699 $o->option(user => $user) if $user && $password;
700 $o->option(password => $password) if $user && $password;
701 $o->option(async => 1) if $async;
702 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
703 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
704 $o->option(preferredRecordSyntax => $syntax);
705 $o->option(elementSetName => $elementSetName) if $elementSetName;
706 $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
708 # create a new connection object
709 $Zconn= create ZOOM::Connection($o);
711 # forge to server
712 $Zconn->connect($host, 0);
714 # check for errors and warn
715 if ($Zconn->errcode() !=0) {
716 warn "something wrong with the connection: ". $Zconn->errmsg();
719 return $Zconn;
722 # _new_dbh
723 # Internal helper function (not a method!). This creates a new
724 # database connection from the data given in the current context, and
725 # returns it.
726 sub _new_dbh
729 ## $context
730 ## correct name for db_scheme
731 my $db_driver = $context->{db_driver};
733 my $db_name = $context->config("database");
734 my $db_host = $context->config("hostname");
735 my $db_port = $context->config("port") || '';
736 my $db_user = $context->config("user");
737 my $db_passwd = $context->config("pass");
738 # MJR added or die here, as we can't work without dbh
739 my $dbh = DBIx::Connector->connect(
740 "dbi:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
741 $db_user, $db_passwd,
743 'RaiseError' => $ENV{DEBUG} ? 1 : 0
747 # Check for the existence of a systempreference table; if we don't have this, we don't
748 # have a valid database and should not set RaiseError in order to allow the installer
749 # to run; installer will not run otherwise since we raise all db errors
751 eval {
752 local $dbh->{PrintError} = 0;
753 local $dbh->{RaiseError} = 1;
754 $dbh->do(qq{SELECT * FROM systempreferences WHERE 1 = 0 });
757 if ($@) {
758 $dbh->{RaiseError} = 0;
761 if ( $db_driver eq 'mysql' ) {
762 $dbh->{mysql_auto_reconnect} = 1;
765 my $tz = $ENV{TZ};
766 if ( $db_driver eq 'mysql' ) {
767 # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
768 # this is better than modifying my.cnf (and forcing all communications to be in utf8)
769 $dbh->{'mysql_enable_utf8'}=1; #enable
770 $dbh->do("set NAMES 'utf8'");
771 ($tz) and $dbh->do(qq(SET time_zone = "$tz"));
773 elsif ( $db_driver eq 'Pg' ) {
774 $dbh->do( "set client_encoding = 'UTF8';" );
775 ($tz) and $dbh->do(qq(SET TIME ZONE = "$tz"));
777 return $dbh;
780 =head2 dbh
782 $dbh = C4::Context->dbh;
784 Returns a database handle connected to the Koha database for the
785 current context. If no connection has yet been made, this method
786 creates one, and connects to the database.
788 This database handle is cached for future use: if you call
789 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
790 times. If you need a second database handle, use C<&new_dbh> and
791 possibly C<&set_dbh>.
793 =cut
796 sub dbh
798 my $self = shift;
799 my $params = shift;
800 my $sth;
802 unless ( $params->{new} ) {
803 if ( defined($context->{db_driver}) && $context->{db_driver} eq 'mysql' && $context->{"dbh"} ) {
804 return $context->{"dbh"};
805 } elsif ( defined($context->{"dbh"}) && $context->{"dbh"}->ping() ) {
806 return $context->{"dbh"};
810 # No database handle or it died . Create one.
811 $context->{"dbh"} = &_new_dbh();
813 return $context->{"dbh"};
816 =head2 new_dbh
818 $dbh = C4::Context->new_dbh;
820 Creates a new connection to the Koha database for the current context,
821 and returns the database handle (a C<DBI::db> object).
823 The handle is not saved anywhere: this method is strictly a
824 convenience function; the point is that it knows which database to
825 connect to so that the caller doesn't have to know.
827 =cut
830 sub new_dbh
832 my $self = shift;
834 return &_new_dbh();
837 =head2 set_dbh
839 $my_dbh = C4::Connect->new_dbh;
840 C4::Connect->set_dbh($my_dbh);
842 C4::Connect->restore_dbh;
844 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
845 C<&set_context> and C<&restore_context>.
847 C<&set_dbh> saves the current database handle on a stack, then sets
848 the current database handle to C<$my_dbh>.
850 C<$my_dbh> is assumed to be a good database handle.
852 =cut
855 sub set_dbh
857 my $self = shift;
858 my $new_dbh = shift;
860 # Save the current database handle on the handle stack.
861 # We assume that $new_dbh is all good: if the caller wants to
862 # screw himself by passing an invalid handle, that's fine by
863 # us.
864 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
865 $context->{"dbh"} = $new_dbh;
868 =head2 restore_dbh
870 C4::Context->restore_dbh;
872 Restores the database handle saved by an earlier call to
873 C<C4::Context-E<gt>set_dbh>.
875 =cut
878 sub restore_dbh
880 my $self = shift;
882 if ($#{$context->{"dbh_stack"}} < 0)
884 # Stack underflow
885 die "DBH stack underflow";
888 # Pop the old database handle and set it.
889 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
891 # FIXME - If it is determined that restore_context should
892 # return something, then this function should, too.
895 =head2 queryparser
897 $queryparser = C4::Context->queryparser
899 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
901 =cut
903 sub queryparser {
904 my $self = shift;
905 unless (defined $context->{"queryparser"}) {
906 $context->{"queryparser"} = &_new_queryparser();
909 return
910 defined( $context->{"queryparser"} )
911 ? $context->{"queryparser"}->new
912 : undef;
915 =head2 _new_queryparser
917 Internal helper function to create a new QueryParser object. QueryParser
918 is loaded dynamically so as to keep the lack of the QueryParser library from
919 getting in anyone's way.
921 =cut
923 sub _new_queryparser {
924 my $qpmodules = {
925 'OpenILS::QueryParser' => undef,
926 'Koha::QueryParser::Driver::PQF' => undef
928 if ( can_load( 'modules' => $qpmodules ) ) {
929 my $QParser = Koha::QueryParser::Driver::PQF->new();
930 my $config_file = $context->config('queryparser_config');
931 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
932 if ( $QParser->load_config($config_file) ) {
933 # Set 'keyword' as the default search class
934 $QParser->default_search_class('keyword');
935 # TODO: allow indexes to be configured in the database
936 return $QParser;
939 return;
942 =head2 marcfromkohafield
944 $dbh = C4::Context->marcfromkohafield;
946 Returns a hash with marcfromkohafield.
948 This hash is cached for future use: if you call
949 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
951 =cut
954 sub marcfromkohafield
956 my $retval = {};
958 # If the hash already exists, return it.
959 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
961 # No hash. Create one.
962 $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
964 return $context->{"marcfromkohafield"};
967 # _new_marcfromkohafield
968 # Internal helper function (not a method!). This creates a new
969 # hash with stopwords
970 sub _new_marcfromkohafield
972 my $dbh = C4::Context->dbh;
973 my $marcfromkohafield;
974 my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
975 $sth->execute;
976 while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
977 my $retval = {};
978 $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
980 return $marcfromkohafield;
983 =head2 stopwords
985 $dbh = C4::Context->stopwords;
987 Returns a hash with stopwords.
989 This hash is cached for future use: if you call
990 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
992 =cut
995 sub stopwords
997 my $retval = {};
999 # If the hash already exists, return it.
1000 return $context->{"stopwords"} if defined($context->{"stopwords"});
1002 # No hash. Create one.
1003 $context->{"stopwords"} = &_new_stopwords();
1005 return $context->{"stopwords"};
1008 # _new_stopwords
1009 # Internal helper function (not a method!). This creates a new
1010 # hash with stopwords
1011 sub _new_stopwords
1013 my $dbh = C4::Context->dbh;
1014 my $stopwordlist;
1015 my $sth = $dbh->prepare("select word from stopwords");
1016 $sth->execute;
1017 while (my $stopword = $sth->fetchrow_array) {
1018 $stopwordlist->{$stopword} = uc($stopword);
1020 $stopwordlist->{A} = "A" unless $stopwordlist;
1021 return $stopwordlist;
1024 =head2 userenv
1026 C4::Context->userenv;
1028 Retrieves a hash for user environment variables.
1030 This hash shall be cached for future use: if you call
1031 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1033 =cut
1036 sub userenv {
1037 my $var = $context->{"activeuser"};
1038 if (defined $var and defined $context->{"userenv"}->{$var}) {
1039 return $context->{"userenv"}->{$var};
1040 } else {
1041 return;
1045 =head2 set_userenv
1047 C4::Context->set_userenv($usernum, $userid, $usercnum,
1048 $userfirstname, $usersurname,
1049 $userbranch, $branchname, $userflags,
1050 $emailaddress, $branchprinter, $persona);
1052 Establish a hash of user environment variables.
1054 set_userenv is called in Auth.pm
1056 =cut
1059 sub set_userenv {
1060 shift @_;
1061 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
1062 map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
1064 my $var=$context->{"activeuser"} || '';
1065 my $cell = {
1066 "number" => $usernum,
1067 "id" => $userid,
1068 "cardnumber" => $usercnum,
1069 "firstname" => $userfirstname,
1070 "surname" => $usersurname,
1071 #possibly a law problem
1072 "branch" => $userbranch,
1073 "branchname" => $branchname,
1074 "flags" => $userflags,
1075 "emailaddress" => $emailaddress,
1076 "branchprinter" => $branchprinter,
1077 "persona" => $persona,
1078 "shibboleth" => $shibboleth,
1080 $context->{userenv}->{$var} = $cell;
1081 return $cell;
1084 sub set_shelves_userenv {
1085 my ($type, $shelves) = @_ or return;
1086 my $activeuser = $context->{activeuser} or return;
1087 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1088 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1089 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1092 sub get_shelves_userenv {
1093 my $active;
1094 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1095 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1096 return;
1098 my $totshelves = $active->{totshelves} or undef;
1099 my $pubshelves = $active->{pubshelves} or undef;
1100 my $barshelves = $active->{barshelves} or undef;
1101 return ($totshelves, $pubshelves, $barshelves);
1104 =head2 _new_userenv
1106 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
1108 Builds a hash for user environment variables.
1110 This hash shall be cached for future use: if you call
1111 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1113 _new_userenv is called in Auth.pm
1115 =cut
1118 sub _new_userenv
1120 shift; # Useless except it compensates for bad calling style
1121 my ($sessionID)= @_;
1122 $context->{"activeuser"}=$sessionID;
1125 =head2 _unset_userenv
1127 C4::Context->_unset_userenv;
1129 Destroys the hash for activeuser user environment variables.
1131 =cut
1135 sub _unset_userenv
1137 my ($sessionID)= @_;
1138 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1142 =head2 get_versions
1144 C4::Context->get_versions
1146 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'.
1148 =cut
1152 # A little example sub to show more debugging info for CGI::Carp
1153 sub get_versions {
1154 my %versions;
1155 $versions{kohaVersion} = Koha::version();
1156 $versions{kohaDbVersion} = C4::Context->preference('version');
1157 $versions{osVersion} = join(" ", POSIX::uname());
1158 $versions{perlVersion} = $];
1160 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1161 $versions{mysqlVersion} = `mysql -V`;
1162 $versions{apacheVersion} = `httpd -v`;
1163 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
1164 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
1165 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
1167 return %versions;
1171 =head2 tz
1173 C4::Context->tz
1175 Returns a DateTime::TimeZone object for the system timezone
1177 =cut
1179 sub tz {
1180 my $self = shift;
1181 if (!defined $context->{tz}) {
1182 $context->{tz} = DateTime::TimeZone->new(name => 'local');
1184 return $context->{tz};
1188 =head2 IsSuperLibrarian
1190 C4::Context->IsSuperLibrarian();
1192 =cut
1194 sub IsSuperLibrarian {
1195 my $userenv = C4::Context->userenv;
1197 unless ( $userenv and exists $userenv->{flags} ) {
1198 # If we reach this without a user environment,
1199 # assume that we're running from a command-line script,
1200 # and act as a superlibrarian.
1201 carp("C4::Context->userenv not defined!");
1202 return 1;
1205 return ($userenv->{flags}//0) % 2;
1208 =head2 interface
1210 Sets the current interface for later retrieval in any Perl module
1212 C4::Context->interface('opac');
1213 C4::Context->interface('intranet');
1214 my $interface = C4::Context->interface;
1216 =cut
1218 sub interface {
1219 my ($class, $interface) = @_;
1221 if (defined $interface) {
1222 $interface = lc $interface;
1223 if ($interface eq 'opac' || $interface eq 'intranet') {
1224 $context->{interface} = $interface;
1225 } else {
1226 warn "invalid interface : '$interface'";
1230 return $context->{interface} // 'opac';
1234 __END__
1236 =head1 ENVIRONMENT
1238 =head2 C<KOHA_CONF>
1240 Specifies the configuration file to read.
1242 =head1 SEE ALSO
1244 XML::Simple
1246 =head1 AUTHORS
1248 Andrew Arensburger <arensb at ooblick dot com>
1250 Joshua Ferraro <jmf at liblime dot com>