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 if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {
83 no warnings 'redefine';
84 *CGI::multi_param = \&CGI::param;
85 use warnings 'redefine';
86 $CGI::LIST_CONTEXT_WARN = 0;
88 } # else there is no browser to send fatals to!
90 # Check if there are memcached servers set
91 $servers = $ENV{'MEMCACHED_SERVERS'};
93 # Load required libraries and create the memcached object
94 require Cache::Memcached;
95 $memcached = Cache::Memcached->new({
96 servers => [ $servers ],
98 compress_threshold => 10_000,
100 namespace => $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
102 # Verify memcached available (set a variable and test the output)
103 $ismemcached = $memcached->set('ismemcached','1');
113 use DateTime::TimeZone;
114 use Module::Load::Conditional qw(can_load);
120 use Koha::Config::SysPref;
121 use Koha::Config::SysPrefs;
125 C4::Context - Maintain and manipulate the context of a Koha script
131 use C4::Context("/path/to/koha-conf.xml");
133 $config_value = C4::Context->config("config_variable");
135 $koha_preference = C4::Context->preference("preference");
137 $db_handle = C4::Context->dbh;
139 $Zconn = C4::Context->Zconn;
143 When a Koha script runs, it makes use of a certain number of things:
144 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
145 databases, and so forth. These things make up the I<context> in which
148 This module takes care of setting up the context for a script:
149 figuring out which configuration file to load, and loading it, opening
150 a connection to the right database, and so forth.
152 Most scripts will only use one context. They can simply have
158 Other scripts may need to use several contexts. For instance, if a
159 library has two databases, one for a certain collection, and the other
160 for everything else, it might be necessary for a script to use two
161 different contexts to search both databases. Such scripts should use
162 the C<&set_context> and C<&restore_context> functions, below.
164 By default, C4::Context reads the configuration from
165 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
166 environment variable to the pathname of a configuration file to use.
173 # In addition to what is said in the POD above, a Context object is a
174 # reference-to-hash with the following fields:
177 # A reference-to-hash whose keys and values are the
178 # configuration variables and values specified in the config
179 # file (/etc/koha/koha-conf.xml).
181 # A handle to the appropriate database for this context.
183 # Used by &set_dbh and &restore_dbh to hold other database
184 # handles for this context.
186 # A connection object for the Zebra server
188 # Koha's main configuration file koha-conf.xml
189 # is searched for according to this priority list:
191 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
192 # 2. Path supplied in KOHA_CONF environment variable.
193 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
194 # as value has changed from its default of
195 # '__KOHA_CONF_DIR__/koha-conf.xml', as happens
196 # when Koha is installed in 'standard' or 'single'
198 # 4. Path supplied in CONFIG_FNAME.
200 # The first entry that refers to a readable file is used.
202 use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
203 # Default config file, if none is specified
205 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
206 # path to config file set by installer
207 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
208 # when Koha is installed in 'standard' or 'single'
209 # mode. If Koha was installed in 'dev' mode,
210 # __KOHA_CONF_DIR__ is *not* rewritten; instead
211 # developers should set the KOHA_CONF environment variable
213 $context = undef; # Initially, no context is set
214 @context_stack = (); # Initially, no saved contexts
217 =head2 read_config_file
219 Reads the specified Koha config file.
221 Returns an object containing the configuration variables. The object's
222 structure is a bit complex to the uninitiated ... take a look at the
223 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
224 here are a few examples that may give you what you need:
226 The simple elements nested within the <config> element:
228 my $pass = $koha->{'config'}->{'pass'};
230 The <listen> elements:
232 my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
234 The elements nested within the <server> element:
236 my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
238 Returns undef in case of error.
242 sub read_config_file { # Pass argument naming config file to read
243 my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo'], suppressempty => '');
246 $memcached->set('kohaconf',$koha);
249 return $koha; # Return value: ref-to-hash holding the configuration
254 Returns the value of the $ismemcached variable (0/1)
264 If $ismemcached is true, returns the $memcache variable.
265 Returns undef otherwise
279 my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
281 This routines translates a database type to part of the name
282 of the appropriate DBD driver to use when establishing a new
283 database connection. It recognizes 'mysql' and 'Pg'; if any
284 other scheme is supplied it defaults to 'mysql'.
289 my $scheme = shift // '';
290 return $scheme eq 'Pg' ? $scheme : 'mysql';
294 # Create the default context ($C4::Context::Context)
295 # the first time the module is called
296 # (a config file can be optionaly passed)
298 # default context already exists?
302 my ($pkg,$config_file) = @_ ;
303 my $new_ctx = __PACKAGE__->new($config_file);
304 return unless $new_ctx;
306 # if successfully loaded, use it by default
307 $new_ctx->set_context;
313 $context = new C4::Context;
314 $context = new C4::Context("/path/to/koha-conf.xml");
316 Allocates a new context. Initializes the context from the specified
317 file, which defaults to either the file given by the C<$KOHA_CONF>
318 environment variable, or F</etc/koha/koha-conf.xml>.
320 It saves the koha-conf.xml values in the declared memcached server(s)
321 if currently available and uses those values until them expire and
324 C<&new> does not set this context as the new default context; for
325 that, use C<&set_context>.
331 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
334 my $conf_fname = shift; # Config file to load
337 # check that the specified config file exists and is not empty
338 undef $conf_fname unless
339 (defined $conf_fname && -s $conf_fname);
340 # Figure out a good config file to load if none was specified.
341 if (!defined($conf_fname))
343 # If the $KOHA_CONF environment variable is set, use
344 # that. Otherwise, use the built-in default.
345 if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s $ENV{"KOHA_CONF"}) {
346 $conf_fname = $ENV{"KOHA_CONF"};
347 } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
348 # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
349 # regex to anything else -- don't want installer to rewrite it
350 $conf_fname = $INSTALLED_CONFIG_FNAME;
351 } elsif (-s CONFIG_FNAME) {
352 $conf_fname = CONFIG_FNAME;
354 warn "unable to locate Koha configuration file koha-conf.xml";
360 # retrieve from memcached
361 $self = $memcached->get('kohaconf');
362 if (not defined $self) {
363 # not in memcached yet
364 $self = read_config_file($conf_fname);
367 # non-memcached env, read from file
368 $self = read_config_file($conf_fname);
371 $self->{"config_file"} = $conf_fname;
372 warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
373 return if !defined($self->{"config"});
375 $self->{"Zconn"} = undef; # Zebra Connections
376 $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
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 my $cached_var = $use_syspref_cache
524 ? $syspref_cache->get_from_cache("syspref_$var")
526 return $cached_var if defined $cached_var;
529 if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
530 $value = $ENV{"OVERRIDE_SYSPREF_$var"};
533 eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
534 $value = $syspref ? $syspref->value() : undef;
537 if ( $use_syspref_cache ) {
538 $syspref_cache->set_in_cache("syspref_$var", $value);
543 sub boolean_preference {
545 my $var = shift; # The system preference to return
546 my $it = preference($self, $var);
547 return defined($it)? C4::Boolean::true_p($it): undef;
550 =head2 enable_syspref_cache
552 C4::Context->enable_syspref_cache();
554 Enable the in-memory syspref cache used by C4::Context. This is the
559 sub enable_syspref_cache {
561 $use_syspref_cache = 1;
562 # We need to clear the cache to have it up-to-date
563 $self->clear_syspref_cache();
566 =head2 disable_syspref_cache
568 C4::Context->disable_syspref_cache();
570 Disable the in-memory syspref cache used by C4::Context. This should be
571 used with Plack and other persistent environments.
575 sub disable_syspref_cache {
577 $use_syspref_cache = 0;
578 $self->clear_syspref_cache();
581 =head2 clear_syspref_cache
583 C4::Context->clear_syspref_cache();
585 cleans the internal cache of sysprefs. Please call this method if
586 you update the systempreferences table. Otherwise, your new changes
587 will not be seen by this process.
591 sub clear_syspref_cache {
592 return unless $use_syspref_cache;
593 $syspref_cache->flush_all;
596 =head2 set_preference
598 C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
600 This updates a preference's value both in the systempreferences table and in
601 the sysprefs cache. If the optional parameters are provided, then the query
602 becomes a create. It won't update the parameters (except value) for an existing
608 my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
610 $variable = lc $variable;
612 my $syspref = Koha::Config::SysPrefs->find($variable);
615 : $syspref ? $syspref->type
618 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
620 # force explicit protocol on OPACBaseURL
621 if ( $variable eq 'opacbaseurl' && substr( $value, 0, 4 ) !~ /http/ ) {
622 $value = 'http://' . $value;
627 { ( defined $value ? ( value => $value ) : () ),
628 ( $explanation ? ( explanation => $explanation ) : () ),
629 ( $type ? ( type => $type ) : () ),
630 ( $options ? ( options => $options ) : () ),
634 $syspref = Koha::Config::SysPref->new(
635 { variable => $variable,
637 explanation => $explanation || undef,
639 options => $options || undef,
644 if ( $use_syspref_cache ) {
645 $syspref_cache->set_in_cache( "syspref_$variable", $value );
651 =head2 delete_preference
653 C4::Context->delete_preference( $variable );
655 This deletes a system preference from the database. Returns a true value on
656 success. Failure means there was an issue with the database, not that there
657 was no syspref of the name.
661 sub delete_preference {
662 my ( $self, $var ) = @_;
664 if ( Koha::Config::SysPrefs->find( $var )->delete ) {
665 if ( $use_syspref_cache ) {
666 $syspref_cache->clear_from_cache("syspref_$var");
676 $Zconn = C4::Context->Zconn
678 Returns a connection to the Zebra database
682 C<$server> one of the servers defined in the koha-conf.xml file
684 C<$async> whether this is a asynchronous connection
689 my ($self, $server, $async ) = @_;
690 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
691 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
692 # if we are running the script from the commandline, lets try to use the caching
693 return $context->{"Zconn"}->{$cache_key};
695 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
696 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
697 return $context->{"Zconn"}->{$cache_key};
702 $context->{"Zconn"} = &_new_Zconn($server,$async);
704 Internal function. Creates a new database connection from the data given in the current context and returns it.
706 C<$server> one of the servers defined in the koha-conf.xml file
708 C<$async> whether this is a asynchronous connection
710 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
715 my ( $server, $async ) = @_;
717 my $tried=0; # first attempt
718 my $Zconn; # connection object
723 $server //= "biblioserver";
725 if ( $server eq 'biblioserver' ) {
726 $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
727 } elsif ( $server eq 'authorityserver' ) {
728 $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
731 if ( $index_mode eq 'grs1' ) {
732 $elementSetName = 'F';
733 $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
737 } else { # $index_mode eq 'dom'
739 $elementSetName = 'marcxml';
742 my $host = $context->{'listen'}->{$server}->{'content'};
743 my $user = $context->{"serverinfo"}->{$server}->{"user"};
744 my $password = $context->{"serverinfo"}->{$server}->{"password"};
747 my $o = new ZOOM::Options();
748 $o->option(user => $user) if $user && $password;
749 $o->option(password => $password) if $user && $password;
750 $o->option(async => 1) if $async;
751 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
752 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
753 $o->option(preferredRecordSyntax => $syntax);
754 $o->option(elementSetName => $elementSetName) if $elementSetName;
755 $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
757 # create a new connection object
758 $Zconn= create ZOOM::Connection($o);
761 $Zconn->connect($host, 0);
763 # check for errors and warn
764 if ($Zconn->errcode() !=0) {
765 warn "something wrong with the connection: ". $Zconn->errmsg();
772 # Internal helper function (not a method!). This creates a new
773 # database connection from the data given in the current context, and
778 Koha::Database->schema({ new => 1 })->storage->dbh;
783 $dbh = C4::Context->dbh;
785 Returns a database handle connected to the Koha database for the
786 current context. If no connection has yet been made, this method
787 creates one, and connects to the database.
789 This database handle is cached for future use: if you call
790 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
791 times. If you need a second database handle, use C<&new_dbh> and
792 possibly C<&set_dbh>.
803 unless ( $params->{new} ) {
804 return Koha::Database->schema->storage->dbh;
807 return Koha::Database->schema({ new => 1 })->storage->dbh;
812 $dbh = C4::Context->new_dbh;
814 Creates a new connection to the Koha database for the current context,
815 and returns the database handle (a C<DBI::db> object).
817 The handle is not saved anywhere: this method is strictly a
818 convenience function; the point is that it knows which database to
819 connect to so that the caller doesn't have to know.
828 return &dbh({ new => 1 });
833 $my_dbh = C4::Connect->new_dbh;
834 C4::Connect->set_dbh($my_dbh);
836 C4::Connect->restore_dbh;
838 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
839 C<&set_context> and C<&restore_context>.
841 C<&set_dbh> saves the current database handle on a stack, then sets
842 the current database handle to C<$my_dbh>.
844 C<$my_dbh> is assumed to be a good database handle.
854 # Save the current database handle on the handle stack.
855 # We assume that $new_dbh is all good: if the caller wants to
856 # screw himself by passing an invalid handle, that's fine by
858 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
859 $context->{"dbh"} = $new_dbh;
864 C4::Context->restore_dbh;
866 Restores the database handle saved by an earlier call to
867 C<C4::Context-E<gt>set_dbh>.
876 if ($#{$context->{"dbh_stack"}} < 0)
879 die "DBH stack underflow";
882 # Pop the old database handle and set it.
883 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
885 # FIXME - If it is determined that restore_context should
886 # return something, then this function should, too.
891 $queryparser = C4::Context->queryparser
893 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
899 unless (defined $context->{"queryparser"}) {
900 $context->{"queryparser"} = &_new_queryparser();
904 defined( $context->{"queryparser"} )
905 ? $context->{"queryparser"}->new
909 =head2 _new_queryparser
911 Internal helper function to create a new QueryParser object. QueryParser
912 is loaded dynamically so as to keep the lack of the QueryParser library from
913 getting in anyone's way.
917 sub _new_queryparser {
919 'OpenILS::QueryParser' => undef,
920 'Koha::QueryParser::Driver::PQF' => undef
922 if ( can_load( 'modules' => $qpmodules ) ) {
923 my $QParser = Koha::QueryParser::Driver::PQF->new();
924 my $config_file = $context->config('queryparser_config');
925 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
926 if ( $QParser->load_config($config_file) ) {
927 # Set 'keyword' as the default search class
928 $QParser->default_search_class('keyword');
929 # TODO: allow indexes to be configured in the database
936 =head2 marcfromkohafield
938 $dbh = C4::Context->marcfromkohafield;
940 Returns a hash with marcfromkohafield.
942 This hash is cached for future use: if you call
943 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
948 sub marcfromkohafield
952 # If the hash already exists, return it.
953 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
955 # No hash. Create one.
956 $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
958 return $context->{"marcfromkohafield"};
961 # _new_marcfromkohafield
962 sub _new_marcfromkohafield
964 my $dbh = C4::Context->dbh;
965 my $marcfromkohafield;
966 my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
968 while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
970 $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
972 return $marcfromkohafield;
977 C4::Context->userenv;
979 Retrieves a hash for user environment variables.
981 This hash shall be cached for future use: if you call
982 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
988 my $var = $context->{"activeuser"};
989 if (defined $var and defined $context->{"userenv"}->{$var}) {
990 return $context->{"userenv"}->{$var};
998 C4::Context->set_userenv($usernum, $userid, $usercnum,
999 $userfirstname, $usersurname,
1000 $userbranch, $branchname, $userflags,
1001 $emailaddress, $branchprinter, $persona);
1003 Establish a hash of user environment variables.
1005 set_userenv is called in Auth.pm
1012 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
1013 map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
1015 my $var=$context->{"activeuser"} || '';
1017 "number" => $usernum,
1019 "cardnumber" => $usercnum,
1020 "firstname" => $userfirstname,
1021 "surname" => $usersurname,
1022 #possibly a law problem
1023 "branch" => $userbranch,
1024 "branchname" => $branchname,
1025 "flags" => $userflags,
1026 "emailaddress" => $emailaddress,
1027 "branchprinter" => $branchprinter,
1028 "persona" => $persona,
1029 "shibboleth" => $shibboleth,
1031 $context->{userenv}->{$var} = $cell;
1035 sub set_shelves_userenv {
1036 my ($type, $shelves) = @_ or return;
1037 my $activeuser = $context->{activeuser} or return;
1038 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1039 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1040 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1043 sub get_shelves_userenv {
1045 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1046 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1049 my $totshelves = $active->{totshelves} or undef;
1050 my $pubshelves = $active->{pubshelves} or undef;
1051 my $barshelves = $active->{barshelves} or undef;
1052 return ($totshelves, $pubshelves, $barshelves);
1057 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
1059 Builds a hash for user environment variables.
1061 This hash shall be cached for future use: if you call
1062 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1064 _new_userenv is called in Auth.pm
1071 shift; # Useless except it compensates for bad calling style
1072 my ($sessionID)= @_;
1073 $context->{"activeuser"}=$sessionID;
1076 =head2 _unset_userenv
1078 C4::Context->_unset_userenv;
1080 Destroys the hash for activeuser user environment variables.
1088 my ($sessionID)= @_;
1089 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1095 C4::Context->get_versions
1097 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'.
1103 # A little example sub to show more debugging info for CGI::Carp
1106 $versions{kohaVersion} = Koha::version();
1107 $versions{kohaDbVersion} = C4::Context->preference('version');
1108 $versions{osVersion} = join(" ", POSIX::uname());
1109 $versions{perlVersion} = $];
1111 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1112 $versions{mysqlVersion} = `mysql -V`;
1113 $versions{apacheVersion} = (`apache2ctl -v`)[0];
1114 $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
1115 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
1116 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
1117 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
1127 Returns a DateTime::TimeZone object for the system timezone
1133 if (!defined $context->{tz}) {
1134 $context->{tz} = DateTime::TimeZone->new(name => 'local');
1136 return $context->{tz};
1140 =head2 IsSuperLibrarian
1142 C4::Context->IsSuperLibrarian();
1146 sub IsSuperLibrarian {
1147 my $userenv = C4::Context->userenv;
1149 unless ( $userenv and exists $userenv->{flags} ) {
1150 # If we reach this without a user environment,
1151 # assume that we're running from a command-line script,
1152 # and act as a superlibrarian.
1153 carp("C4::Context->userenv not defined!");
1157 return ($userenv->{flags}//0) % 2;
1162 Sets the current interface for later retrieval in any Perl module
1164 C4::Context->interface('opac');
1165 C4::Context->interface('intranet');
1166 my $interface = C4::Context->interface;
1171 my ($class, $interface) = @_;
1173 if (defined $interface) {
1174 $interface = lc $interface;
1175 if ($interface eq 'opac' || $interface eq 'intranet' || $interface eq 'sip' || $interface eq 'commandline') {
1176 $context->{interface} = $interface;
1178 warn "invalid interface : '$interface'";
1182 return $context->{interface} // 'opac';
1192 Specifies the configuration file to read.
1200 Andrew Arensburger <arensb at ooblick dot com>
1202 Joshua Ferraro <jmf at liblime dot com>