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>.
21 use vars qw($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;
80 # Redefine multi_param if cgi version is < 4.08
81 # Remove the "CGI::param called in list context" warning in this case
82 require CGI; # Can't check version without the require.
83 if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {
84 no warnings 'redefine';
85 *CGI::multi_param = \&CGI::param;
86 use warnings 'redefine';
87 $CGI::LIST_CONTEXT_WARN = 0;
89 } # else there is no browser to send fatals to!
91 # Check if there are memcached servers set
92 $servers = $ENV{'MEMCACHED_SERVERS'};
94 # Load required libraries and create the memcached object
95 require Cache::Memcached;
96 $memcached = Cache::Memcached->new({
97 servers => [ $servers ],
99 compress_threshold => 10_000,
101 namespace => $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
103 # Verify memcached available (set a variable and test the output)
104 $ismemcached = $memcached->set('ismemcached','1');
114 use DateTime::TimeZone;
115 use Module::Load::Conditional qw(can_load);
121 use Koha::Config::SysPref;
122 use Koha::Config::SysPrefs;
126 C4::Context - Maintain and manipulate the context of a Koha script
132 use C4::Context("/path/to/koha-conf.xml");
134 $config_value = C4::Context->config("config_variable");
136 $koha_preference = C4::Context->preference("preference");
138 $db_handle = C4::Context->dbh;
140 $Zconn = C4::Context->Zconn;
144 When a Koha script runs, it makes use of a certain number of things:
145 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
146 databases, and so forth. These things make up the I<context> in which
149 This module takes care of setting up the context for a script:
150 figuring out which configuration file to load, and loading it, opening
151 a connection to the right database, and so forth.
153 Most scripts will only use one context. They can simply have
159 Other scripts may need to use several contexts. For instance, if a
160 library has two databases, one for a certain collection, and the other
161 for everything else, it might be necessary for a script to use two
162 different contexts to search both databases. Such scripts should use
163 the C<&set_context> and C<&restore_context> functions, below.
165 By default, C4::Context reads the configuration from
166 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
167 environment variable to the pathname of a configuration file to use.
174 # In addition to what is said in the POD above, a Context object is a
175 # reference-to-hash with the following fields:
178 # A reference-to-hash whose keys and values are the
179 # configuration variables and values specified in the config
180 # file (/etc/koha/koha-conf.xml).
182 # A handle to the appropriate database for this context.
184 # Used by &set_dbh and &restore_dbh to hold other database
185 # handles for this context.
187 # A connection object for the Zebra server
189 # Koha's main configuration file koha-conf.xml
190 # is searched for according to this priority list:
192 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
193 # 2. Path supplied in KOHA_CONF environment variable.
194 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
195 # as value has changed from its default of
196 # '__KOHA_CONF_DIR__/koha-conf.xml', as happens
197 # when Koha is installed in 'standard' or 'single'
199 # 4. Path supplied in CONFIG_FNAME.
201 # The first entry that refers to a readable file is used.
203 use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
204 # Default config file, if none is specified
206 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
207 # path to config file set by installer
208 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
209 # when Koha is installed in 'standard' or 'single'
210 # mode. If Koha was installed in 'dev' mode,
211 # __KOHA_CONF_DIR__ is *not* rewritten; instead
212 # developers should set the KOHA_CONF environment variable
214 $context = undef; # Initially, no context is set
215 @context_stack = (); # Initially, no saved contexts
218 =head2 read_config_file
220 Reads the specified Koha config file.
222 Returns an object containing the configuration variables. The object's
223 structure is a bit complex to the uninitiated ... take a look at the
224 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
225 here are a few examples that may give you what you need:
227 The simple elements nested within the <config> element:
229 my $pass = $koha->{'config'}->{'pass'};
231 The <listen> elements:
233 my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
235 The elements nested within the <server> element:
237 my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
239 Returns undef in case of error.
243 sub read_config_file { # Pass argument naming config file to read
244 my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo'], suppressempty => '');
247 $memcached->set('kohaconf',$koha);
250 return $koha; # Return value: ref-to-hash holding the configuration
255 Returns the value of the $ismemcached variable (0/1)
265 If $ismemcached is true, returns the $memcache variable.
266 Returns undef otherwise
280 my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
282 This routines translates a database type to part of the name
283 of the appropriate DBD driver to use when establishing a new
284 database connection. It recognizes 'mysql' and 'Pg'; if any
285 other scheme is supplied it defaults to 'mysql'.
290 my $scheme = shift // '';
291 return $scheme eq 'Pg' ? $scheme : 'mysql';
295 # Create the default context ($C4::Context::Context)
296 # the first time the module is called
297 # (a config file can be optionaly passed)
299 # default context already exists?
303 my ($pkg,$config_file) = @_ ;
304 my $new_ctx = __PACKAGE__->new($config_file);
305 return unless $new_ctx;
307 # if successfully loaded, use it by default
308 $new_ctx->set_context;
314 $context = new C4::Context;
315 $context = new C4::Context("/path/to/koha-conf.xml");
317 Allocates a new context. Initializes the context from the specified
318 file, which defaults to either the file given by the C<$KOHA_CONF>
319 environment variable, or F</etc/koha/koha-conf.xml>.
321 It saves the koha-conf.xml values in the declared memcached server(s)
322 if currently available and uses those values until them expire and
325 C<&new> does not set this context as the new default context; for
326 that, use C<&set_context>.
332 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
335 my $conf_fname = shift; # Config file to load
338 # check that the specified config file exists and is not empty
339 undef $conf_fname unless
340 (defined $conf_fname && -s $conf_fname);
341 # Figure out a good config file to load if none was specified.
342 if (!defined($conf_fname))
344 # If the $KOHA_CONF environment variable is set, use
345 # that. Otherwise, use the built-in default.
346 if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s $ENV{"KOHA_CONF"}) {
347 $conf_fname = $ENV{"KOHA_CONF"};
348 } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
349 # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
350 # regex to anything else -- don't want installer to rewrite it
351 $conf_fname = $INSTALLED_CONFIG_FNAME;
352 } elsif (-s CONFIG_FNAME) {
353 $conf_fname = CONFIG_FNAME;
355 warn "unable to locate Koha configuration file koha-conf.xml";
361 # retrieve from memcached
362 $self = $memcached->get('kohaconf');
363 if (not defined $self) {
364 # not in memcached yet
365 $self = read_config_file($conf_fname);
368 # non-memcached env, read from file
369 $self = read_config_file($conf_fname);
372 $self->{"config_file"} = $conf_fname;
373 warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
374 return if !defined($self->{"config"});
376 $self->{"Zconn"} = undef; # Zebra Connections
377 $self->{"userenv"} = undef; # User env
378 $self->{"activeuser"} = undef; # current active user
379 $self->{"shelves"} = undef;
380 $self->{tz} = undef; # local timezone object
383 $self->{db_driver} = db_scheme2dbi($self->config('db_scheme')); # cache database driver
389 $context = new C4::Context;
390 $context->set_context();
392 set_context C4::Context $context;
395 restore_context C4::Context;
397 In some cases, it might be necessary for a script to use multiple
398 contexts. C<&set_context> saves the current context on a stack, then
399 sets the context to C<$context>, which will be used in future
400 operations. To restore the previous context, use C<&restore_context>.
408 my $new_context; # The context to set
410 # Figure out whether this is a class or instance method call.
412 # We're going to make the assumption that control got here
413 # through valid means, i.e., that the caller used an instance
414 # or class method call, and that control got here through the
415 # usual inheritance mechanisms. The caller can, of course,
416 # break this assumption by playing silly buggers, but that's
417 # harder to do than doing it properly, and harder to check
419 if (ref($self) eq "")
421 # Class method. The new context is the next argument.
422 $new_context = shift;
424 # Instance method. The new context is $self.
425 $new_context = $self;
428 # Save the old context, if any, on the stack
429 push @context_stack, $context if defined($context);
431 # Set the new context
432 $context = $new_context;
435 =head2 restore_context
439 Restores the context set by C<&set_context>.
448 if ($#context_stack < 0)
451 die "Context stack underflow";
454 # Pop the old context and set it.
455 $context = pop @context_stack;
457 # FIXME - Should this return something, like maybe the context
458 # that was current when this was called?
463 $value = C4::Context->config("config_variable");
465 $value = C4::Context->config_variable;
467 Returns the value of a variable specified in the configuration file
468 from which the current context was created.
470 The second form is more compact, but of course may conflict with
471 method names. If there is a configuration variable called "new", then
472 C<C4::Config-E<gt>new> will not return it.
479 return if !defined($context->{$term});
480 # Presumably $self->{$term} might be
481 # undefined if the config file given to &new
482 # didn't exist, and the caller didn't bother
483 # to check the return value.
485 # Return the value of the requested config variable
486 return $context->{$term}->{$var};
490 return _common_config($_[1],'config');
493 return _common_config($_[1],'server');
496 return _common_config($_[1],'serverinfo');
501 $sys_preference = C4::Context->preference('some_variable');
503 Looks up the value of the given system preference in the
504 systempreferences table of the Koha database, and returns it. If the
505 variable is not set or does not exist, undef is returned.
507 In case of an error, this may return 0.
509 Note: It is impossible to tell the difference between system
510 preferences which do not exist, and those whose values are set to NULL
515 my $syspref_cache = Koha::Cache->get_instance();
516 my $use_syspref_cache = 1;
519 my $var = shift; # The system preference to return
523 return $ENV{"OVERRIDE_SYSPREF_$var"}
524 if defined $ENV{"OVERRIDE_SYSPREF_$var"};
526 my $cached_var = $use_syspref_cache
527 ? $syspref_cache->get_from_cache("syspref_$var")
529 return $cached_var if defined $cached_var;
532 eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
533 my $value = $syspref ? $syspref->value() : undef;
535 if ( $use_syspref_cache ) {
536 $syspref_cache->set_in_cache("syspref_$var", $value);
541 sub boolean_preference {
543 my $var = shift; # The system preference to return
544 my $it = preference($self, $var);
545 return defined($it)? C4::Boolean::true_p($it): undef;
548 =head2 enable_syspref_cache
550 C4::Context->enable_syspref_cache();
552 Enable the in-memory syspref cache used by C4::Context. This is the
557 sub enable_syspref_cache {
559 $use_syspref_cache = 1;
560 # We need to clear the cache to have it up-to-date
561 $self->clear_syspref_cache();
564 =head2 disable_syspref_cache
566 C4::Context->disable_syspref_cache();
568 Disable the in-memory syspref cache used by C4::Context. This should be
569 used with Plack and other persistent environments.
573 sub disable_syspref_cache {
575 $use_syspref_cache = 0;
576 $self->clear_syspref_cache();
579 =head2 clear_syspref_cache
581 C4::Context->clear_syspref_cache();
583 cleans the internal cache of sysprefs. Please call this method if
584 you update the systempreferences table. Otherwise, your new changes
585 will not be seen by this process.
589 sub clear_syspref_cache {
590 return unless $use_syspref_cache;
591 $syspref_cache->flush_all;
594 =head2 set_preference
596 C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
598 This updates a preference's value both in the systempreferences table and in
599 the sysprefs cache. If the optional parameters are provided, then the query
600 becomes a create. It won't update the parameters (except value) for an existing
606 my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
608 $variable = lc $variable;
610 my $syspref = Koha::Config::SysPrefs->find($variable);
613 : $syspref ? $syspref->type
616 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
618 # force explicit protocol on OPACBaseURL
619 if ( $variable eq 'opacbaseurl' && $value && substr( $value, 0, 4 ) !~ /http/ ) {
620 $value = 'http://' . $value;
625 { ( defined $value ? ( value => $value ) : () ),
626 ( $explanation ? ( explanation => $explanation ) : () ),
627 ( $type ? ( type => $type ) : () ),
628 ( $options ? ( options => $options ) : () ),
632 $syspref = Koha::Config::SysPref->new(
633 { variable => $variable,
635 explanation => $explanation || undef,
637 options => $options || undef,
642 if ( $use_syspref_cache ) {
643 $syspref_cache->set_in_cache( "syspref_$variable", $value );
649 =head2 delete_preference
651 C4::Context->delete_preference( $variable );
653 This deletes a system preference from the database. Returns a true value on
654 success. Failure means there was an issue with the database, not that there
655 was no syspref of the name.
659 sub delete_preference {
660 my ( $self, $var ) = @_;
662 if ( Koha::Config::SysPrefs->find( $var )->delete ) {
663 if ( $use_syspref_cache ) {
664 $syspref_cache->clear_from_cache("syspref_$var");
674 $Zconn = C4::Context->Zconn
676 Returns a connection to the Zebra database
680 C<$server> one of the servers defined in the koha-conf.xml file
682 C<$async> whether this is a asynchronous connection
687 my ($self, $server, $async ) = @_;
688 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
689 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
690 # if we are running the script from the commandline, lets try to use the caching
691 return $context->{"Zconn"}->{$cache_key};
693 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
694 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
695 return $context->{"Zconn"}->{$cache_key};
700 $context->{"Zconn"} = &_new_Zconn($server,$async);
702 Internal function. Creates a new database connection from the data given in the current context and returns it.
704 C<$server> one of the servers defined in the koha-conf.xml file
706 C<$async> whether this is a asynchronous connection
708 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
713 my ( $server, $async ) = @_;
715 my $tried=0; # first attempt
716 my $Zconn; # connection object
721 $server //= "biblioserver";
723 if ( $server eq 'biblioserver' ) {
724 $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
725 } elsif ( $server eq 'authorityserver' ) {
726 $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
729 if ( $index_mode eq 'grs1' ) {
730 $elementSetName = 'F';
731 $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
735 } else { # $index_mode eq 'dom'
737 $elementSetName = 'marcxml';
740 my $host = $context->{'listen'}->{$server}->{'content'};
741 my $user = $context->{"serverinfo"}->{$server}->{"user"};
742 my $password = $context->{"serverinfo"}->{$server}->{"password"};
745 my $o = new ZOOM::Options();
746 $o->option(user => $user) if $user && $password;
747 $o->option(password => $password) if $user && $password;
748 $o->option(async => 1) if $async;
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 => $elementSetName) if $elementSetName;
753 $o->option(databaseName => $context->{"config"}->{$server}||"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();
770 # Internal helper function (not a method!). This creates a new
771 # database connection from the data given in the current context, and
776 Koha::Database->schema({ new => 1 })->storage->dbh;
781 $dbh = C4::Context->dbh;
783 Returns a database handle connected to the Koha database for the
784 current context. If no connection has yet been made, this method
785 creates one, and connects to the database.
787 This database handle is cached for future use: if you call
788 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
789 times. If you need a second database handle, use C<&new_dbh> and
790 possibly C<&set_dbh>.
801 unless ( $params->{new} ) {
802 return Koha::Database->schema->storage->dbh;
805 return Koha::Database->schema({ new => 1 })->storage->dbh;
810 $dbh = C4::Context->new_dbh;
812 Creates a new connection to the Koha database for the current context,
813 and returns the database handle (a C<DBI::db> object).
815 The handle is not saved anywhere: this method is strictly a
816 convenience function; the point is that it knows which database to
817 connect to so that the caller doesn't have to know.
826 return &dbh({ new => 1 });
831 $my_dbh = C4::Connect->new_dbh;
832 C4::Connect->set_dbh($my_dbh);
834 C4::Connect->restore_dbh;
836 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
837 C<&set_context> and C<&restore_context>.
839 C<&set_dbh> saves the current database handle on a stack, then sets
840 the current database handle to C<$my_dbh>.
842 C<$my_dbh> is assumed to be a good database handle.
852 # Save the current database handle on the handle stack.
853 # We assume that $new_dbh is all good: if the caller wants to
854 # screw himself by passing an invalid handle, that's fine by
856 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
857 $context->{"dbh"} = $new_dbh;
862 C4::Context->restore_dbh;
864 Restores the database handle saved by an earlier call to
865 C<C4::Context-E<gt>set_dbh>.
874 if ($#{$context->{"dbh_stack"}} < 0)
877 die "DBH stack underflow";
880 # Pop the old database handle and set it.
881 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
883 # FIXME - If it is determined that restore_context should
884 # return something, then this function should, too.
889 $queryparser = C4::Context->queryparser
891 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
897 unless (defined $context->{"queryparser"}) {
898 $context->{"queryparser"} = &_new_queryparser();
902 defined( $context->{"queryparser"} )
903 ? $context->{"queryparser"}->new
907 =head2 _new_queryparser
909 Internal helper function to create a new QueryParser object. QueryParser
910 is loaded dynamically so as to keep the lack of the QueryParser library from
911 getting in anyone's way.
915 sub _new_queryparser {
917 'OpenILS::QueryParser' => undef,
918 'Koha::QueryParser::Driver::PQF' => undef
920 if ( can_load( 'modules' => $qpmodules ) ) {
921 my $QParser = Koha::QueryParser::Driver::PQF->new();
922 my $config_file = $context->config('queryparser_config');
923 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
924 if ( $QParser->load_config($config_file) ) {
925 # Set 'keyword' as the default search class
926 $QParser->default_search_class('keyword');
927 # TODO: allow indexes to be configured in the database
936 C4::Context->userenv;
938 Retrieves a hash for user environment variables.
940 This hash shall be cached for future use: if you call
941 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
947 my $var = $context->{"activeuser"};
948 if (defined $var and defined $context->{"userenv"}->{$var}) {
949 return $context->{"userenv"}->{$var};
957 C4::Context->set_userenv($usernum, $userid, $usercnum,
958 $userfirstname, $usersurname,
959 $userbranch, $branchname, $userflags,
960 $emailaddress, $branchprinter, $persona);
962 Establish a hash of user environment variables.
964 set_userenv is called in Auth.pm
971 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
972 map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
974 my $var=$context->{"activeuser"} || '';
976 "number" => $usernum,
978 "cardnumber" => $usercnum,
979 "firstname" => $userfirstname,
980 "surname" => $usersurname,
981 #possibly a law problem
982 "branch" => $userbranch,
983 "branchname" => $branchname,
984 "flags" => $userflags,
985 "emailaddress" => $emailaddress,
986 "branchprinter" => $branchprinter,
987 "persona" => $persona,
988 "shibboleth" => $shibboleth,
990 $context->{userenv}->{$var} = $cell;
994 sub set_shelves_userenv {
995 my ($type, $shelves) = @_ or return;
996 my $activeuser = $context->{activeuser} or return;
997 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
998 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
999 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1002 sub get_shelves_userenv {
1004 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1005 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1008 my $totshelves = $active->{totshelves} or undef;
1009 my $pubshelves = $active->{pubshelves} or undef;
1010 my $barshelves = $active->{barshelves} or undef;
1011 return ($totshelves, $pubshelves, $barshelves);
1016 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
1018 Builds a hash for user environment variables.
1020 This hash shall be cached for future use: if you call
1021 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1023 _new_userenv is called in Auth.pm
1030 shift; # Useless except it compensates for bad calling style
1031 my ($sessionID)= @_;
1032 $context->{"activeuser"}=$sessionID;
1035 =head2 _unset_userenv
1037 C4::Context->_unset_userenv;
1039 Destroys the hash for activeuser user environment variables.
1047 my ($sessionID)= @_;
1048 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1054 C4::Context->get_versions
1056 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'.
1062 # A little example sub to show more debugging info for CGI::Carp
1065 $versions{kohaVersion} = Koha::version();
1066 $versions{kohaDbVersion} = C4::Context->preference('version');
1067 $versions{osVersion} = join(" ", POSIX::uname());
1068 $versions{perlVersion} = $];
1070 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1071 $versions{mysqlVersion} = `mysql -V`;
1072 $versions{apacheVersion} = (`apache2ctl -v`)[0];
1073 $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
1074 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
1075 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
1076 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
1086 Returns a DateTime::TimeZone object for the system timezone
1092 if (!defined $context->{tz}) {
1093 $context->{tz} = DateTime::TimeZone->new(name => 'local');
1095 return $context->{tz};
1099 =head2 IsSuperLibrarian
1101 C4::Context->IsSuperLibrarian();
1105 sub IsSuperLibrarian {
1106 my $userenv = C4::Context->userenv;
1108 unless ( $userenv and exists $userenv->{flags} ) {
1109 # If we reach this without a user environment,
1110 # assume that we're running from a command-line script,
1111 # and act as a superlibrarian.
1112 carp("C4::Context->userenv not defined!");
1116 return ($userenv->{flags}//0) % 2;
1121 Sets the current interface for later retrieval in any Perl module
1123 C4::Context->interface('opac');
1124 C4::Context->interface('intranet');
1125 my $interface = C4::Context->interface;
1130 my ($class, $interface) = @_;
1132 if (defined $interface) {
1133 $interface = lc $interface;
1134 if ($interface eq 'opac' || $interface eq 'intranet' || $interface eq 'sip' || $interface eq 'commandline') {
1135 $context->{interface} = $interface;
1137 warn "invalid interface : '$interface'";
1141 return $context->{interface} // 'opac';
1151 Specifies the configuration file to read.
1159 Andrew Arensburger <arensb at ooblick dot com>
1161 Joshua Ferraro <jmf at liblime dot com>