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 %syspref_L1_cache;
517 my $use_syspref_cache = 1;
520 my $var = shift; # The system preference to return
524 # Return the value if the var has already been accessed
525 if ($use_syspref_cache && exists $syspref_L1_cache{$var}) {
526 return $syspref_L1_cache{$var};
529 my $cached_var = $use_syspref_cache
530 ? $syspref_cache->get_from_cache("syspref_$var")
532 return $cached_var if defined $cached_var;
535 if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
536 $value = $ENV{"OVERRIDE_SYSPREF_$var"};
539 eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
540 $value = $syspref ? $syspref->value() : undef;
543 if ( $use_syspref_cache ) {
544 $syspref_cache->set_in_cache("syspref_$var", $value);
545 $syspref_L1_cache{$var} = $value;
550 sub boolean_preference {
552 my $var = shift; # The system preference to return
553 my $it = preference($self, $var);
554 return defined($it)? C4::Boolean::true_p($it): undef;
557 =head2 enable_syspref_cache
559 C4::Context->enable_syspref_cache();
561 Enable the in-memory syspref cache used by C4::Context. This is the
566 sub enable_syspref_cache {
568 $use_syspref_cache = 1;
569 # We need to clear the cache to have it up-to-date
570 $self->clear_syspref_cache();
573 =head2 disable_syspref_cache
575 C4::Context->disable_syspref_cache();
577 Disable the in-memory syspref cache used by C4::Context. This should be
578 used with Plack and other persistent environments.
582 sub disable_syspref_cache {
584 $use_syspref_cache = 0;
585 $self->clear_syspref_cache();
588 =head2 clear_syspref_cache
590 C4::Context->clear_syspref_cache();
592 cleans the internal cache of sysprefs. Please call this method if
593 you update the systempreferences table. Otherwise, your new changes
594 will not be seen by this process.
598 sub clear_syspref_cache {
599 return unless $use_syspref_cache;
600 $syspref_cache->flush_all;
601 clear_syspref_L1_cache()
604 sub clear_syspref_L1_cache {
605 %syspref_L1_cache = ();
608 =head2 set_preference
610 C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
612 This updates a preference's value both in the systempreferences table and in
613 the sysprefs cache. If the optional parameters are provided, then the query
614 becomes a create. It won't update the parameters (except value) for an existing
620 my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
622 $variable = lc $variable;
624 my $syspref = Koha::Config::SysPrefs->find($variable);
627 : $syspref ? $syspref->type
630 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
632 # force explicit protocol on OPACBaseURL
633 if ( $variable eq 'opacbaseurl' && substr( $value, 0, 4 ) !~ /http/ ) {
634 $value = 'http://' . $value;
639 { ( defined $value ? ( value => $value ) : () ),
640 ( $explanation ? ( explanation => $explanation ) : () ),
641 ( $type ? ( type => $type ) : () ),
642 ( $options ? ( options => $options ) : () ),
646 $syspref = Koha::Config::SysPref->new(
647 { variable => $variable,
649 explanation => $explanation || undef,
651 options => $options || undef,
656 if ( $use_syspref_cache ) {
657 $syspref_cache->set_in_cache( "syspref_$variable", $value );
658 $syspref_L1_cache{$variable} = $value;
664 =head2 delete_preference
666 C4::Context->delete_preference( $variable );
668 This deletes a system preference from the database. Returns a true value on
669 success. Failure means there was an issue with the database, not that there
670 was no syspref of the name.
674 sub delete_preference {
675 my ( $self, $var ) = @_;
677 if ( Koha::Config::SysPrefs->find( $var )->delete ) {
678 if ( $use_syspref_cache ) {
679 $syspref_cache->clear_from_cache("syspref_$var");
680 delete $syspref_L1_cache{$var};
690 $Zconn = C4::Context->Zconn
692 Returns a connection to the Zebra database
696 C<$server> one of the servers defined in the koha-conf.xml file
698 C<$async> whether this is a asynchronous connection
703 my ($self, $server, $async ) = @_;
704 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
705 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
706 # if we are running the script from the commandline, lets try to use the caching
707 return $context->{"Zconn"}->{$cache_key};
709 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
710 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
711 return $context->{"Zconn"}->{$cache_key};
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 ) = @_;
731 my $tried=0; # first attempt
732 my $Zconn; # connection object
737 $server //= "biblioserver";
739 if ( $server eq 'biblioserver' ) {
740 $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
741 } elsif ( $server eq 'authorityserver' ) {
742 $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
745 if ( $index_mode eq 'grs1' ) {
746 $elementSetName = 'F';
747 $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
751 } else { # $index_mode eq 'dom'
753 $elementSetName = 'marcxml';
756 my $host = $context->{'listen'}->{$server}->{'content'};
757 my $user = $context->{"serverinfo"}->{$server}->{"user"};
758 my $password = $context->{"serverinfo"}->{$server}->{"password"};
761 my $o = new ZOOM::Options();
762 $o->option(user => $user) if $user && $password;
763 $o->option(password => $password) if $user && $password;
764 $o->option(async => 1) if $async;
765 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
766 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
767 $o->option(preferredRecordSyntax => $syntax);
768 $o->option(elementSetName => $elementSetName) if $elementSetName;
769 $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
771 # create a new connection object
772 $Zconn= create ZOOM::Connection($o);
775 $Zconn->connect($host, 0);
777 # check for errors and warn
778 if ($Zconn->errcode() !=0) {
779 warn "something wrong with the connection: ". $Zconn->errmsg();
786 # Internal helper function (not a method!). This creates a new
787 # database connection from the data given in the current context, and
792 Koha::Database->schema({ new => 1 })->storage->dbh;
797 $dbh = C4::Context->dbh;
799 Returns a database handle connected to the Koha database for the
800 current context. If no connection has yet been made, this method
801 creates one, and connects to the database.
803 This database handle is cached for future use: if you call
804 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
805 times. If you need a second database handle, use C<&new_dbh> and
806 possibly C<&set_dbh>.
817 unless ( $params->{new} ) {
818 return Koha::Database->schema->storage->dbh;
821 return Koha::Database->schema({ new => 1 })->storage->dbh;
826 $dbh = C4::Context->new_dbh;
828 Creates a new connection to the Koha database for the current context,
829 and returns the database handle (a C<DBI::db> object).
831 The handle is not saved anywhere: this method is strictly a
832 convenience function; the point is that it knows which database to
833 connect to so that the caller doesn't have to know.
842 return &dbh({ new => 1 });
847 $my_dbh = C4::Connect->new_dbh;
848 C4::Connect->set_dbh($my_dbh);
850 C4::Connect->restore_dbh;
852 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
853 C<&set_context> and C<&restore_context>.
855 C<&set_dbh> saves the current database handle on a stack, then sets
856 the current database handle to C<$my_dbh>.
858 C<$my_dbh> is assumed to be a good database handle.
868 # Save the current database handle on the handle stack.
869 # We assume that $new_dbh is all good: if the caller wants to
870 # screw himself by passing an invalid handle, that's fine by
872 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
873 $context->{"dbh"} = $new_dbh;
878 C4::Context->restore_dbh;
880 Restores the database handle saved by an earlier call to
881 C<C4::Context-E<gt>set_dbh>.
890 if ($#{$context->{"dbh_stack"}} < 0)
893 die "DBH stack underflow";
896 # Pop the old database handle and set it.
897 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
899 # FIXME - If it is determined that restore_context should
900 # return something, then this function should, too.
905 $queryparser = C4::Context->queryparser
907 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
913 unless (defined $context->{"queryparser"}) {
914 $context->{"queryparser"} = &_new_queryparser();
918 defined( $context->{"queryparser"} )
919 ? $context->{"queryparser"}->new
923 =head2 _new_queryparser
925 Internal helper function to create a new QueryParser object. QueryParser
926 is loaded dynamically so as to keep the lack of the QueryParser library from
927 getting in anyone's way.
931 sub _new_queryparser {
933 'OpenILS::QueryParser' => undef,
934 'Koha::QueryParser::Driver::PQF' => undef
936 if ( can_load( 'modules' => $qpmodules ) ) {
937 my $QParser = Koha::QueryParser::Driver::PQF->new();
938 my $config_file = $context->config('queryparser_config');
939 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
940 if ( $QParser->load_config($config_file) ) {
941 # Set 'keyword' as the default search class
942 $QParser->default_search_class('keyword');
943 # TODO: allow indexes to be configured in the database
950 =head2 marcfromkohafield
952 $dbh = C4::Context->marcfromkohafield;
954 Returns a hash with marcfromkohafield.
956 This hash is cached for future use: if you call
957 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
962 sub marcfromkohafield
966 # If the hash already exists, return it.
967 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
969 # No hash. Create one.
970 $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
972 return $context->{"marcfromkohafield"};
975 # _new_marcfromkohafield
976 sub _new_marcfromkohafield
978 my $dbh = C4::Context->dbh;
979 my $marcfromkohafield;
980 my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
982 while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
984 $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
986 return $marcfromkohafield;
991 C4::Context->userenv;
993 Retrieves a hash for user environment variables.
995 This hash shall be cached for future use: if you call
996 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1002 my $var = $context->{"activeuser"};
1003 if (defined $var and defined $context->{"userenv"}->{$var}) {
1004 return $context->{"userenv"}->{$var};
1012 C4::Context->set_userenv($usernum, $userid, $usercnum,
1013 $userfirstname, $usersurname,
1014 $userbranch, $branchname, $userflags,
1015 $emailaddress, $branchprinter, $persona);
1017 Establish a hash of user environment variables.
1019 set_userenv is called in Auth.pm
1026 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
1027 map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
1029 my $var=$context->{"activeuser"} || '';
1031 "number" => $usernum,
1033 "cardnumber" => $usercnum,
1034 "firstname" => $userfirstname,
1035 "surname" => $usersurname,
1036 #possibly a law problem
1037 "branch" => $userbranch,
1038 "branchname" => $branchname,
1039 "flags" => $userflags,
1040 "emailaddress" => $emailaddress,
1041 "branchprinter" => $branchprinter,
1042 "persona" => $persona,
1043 "shibboleth" => $shibboleth,
1045 $context->{userenv}->{$var} = $cell;
1049 sub set_shelves_userenv {
1050 my ($type, $shelves) = @_ or return;
1051 my $activeuser = $context->{activeuser} or return;
1052 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1053 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1054 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1057 sub get_shelves_userenv {
1059 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1060 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1063 my $totshelves = $active->{totshelves} or undef;
1064 my $pubshelves = $active->{pubshelves} or undef;
1065 my $barshelves = $active->{barshelves} or undef;
1066 return ($totshelves, $pubshelves, $barshelves);
1071 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
1073 Builds a hash for user environment variables.
1075 This hash shall be cached for future use: if you call
1076 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1078 _new_userenv is called in Auth.pm
1085 shift; # Useless except it compensates for bad calling style
1086 my ($sessionID)= @_;
1087 $context->{"activeuser"}=$sessionID;
1090 =head2 _unset_userenv
1092 C4::Context->_unset_userenv;
1094 Destroys the hash for activeuser user environment variables.
1102 my ($sessionID)= @_;
1103 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1109 C4::Context->get_versions
1111 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'.
1117 # A little example sub to show more debugging info for CGI::Carp
1120 $versions{kohaVersion} = Koha::version();
1121 $versions{kohaDbVersion} = C4::Context->preference('version');
1122 $versions{osVersion} = join(" ", POSIX::uname());
1123 $versions{perlVersion} = $];
1125 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1126 $versions{mysqlVersion} = `mysql -V`;
1127 $versions{apacheVersion} = (`apache2ctl -v`)[0];
1128 $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
1129 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
1130 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
1131 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
1141 Returns a DateTime::TimeZone object for the system timezone
1147 if (!defined $context->{tz}) {
1148 $context->{tz} = DateTime::TimeZone->new(name => 'local');
1150 return $context->{tz};
1154 =head2 IsSuperLibrarian
1156 C4::Context->IsSuperLibrarian();
1160 sub IsSuperLibrarian {
1161 my $userenv = C4::Context->userenv;
1163 unless ( $userenv and exists $userenv->{flags} ) {
1164 # If we reach this without a user environment,
1165 # assume that we're running from a command-line script,
1166 # and act as a superlibrarian.
1167 carp("C4::Context->userenv not defined!");
1171 return ($userenv->{flags}//0) % 2;
1176 Sets the current interface for later retrieval in any Perl module
1178 C4::Context->interface('opac');
1179 C4::Context->interface('intranet');
1180 my $interface = C4::Context->interface;
1185 my ($class, $interface) = @_;
1187 if (defined $interface) {
1188 $interface = lc $interface;
1189 if ($interface eq 'opac' || $interface eq 'intranet' || $interface eq 'sip' || $interface eq 'commandline') {
1190 $context->{interface} = $interface;
1192 warn "invalid interface : '$interface'";
1196 return $context->{interface} // 'opac';
1206 Specifies the configuration file to read.
1214 Andrew Arensburger <arensb at ooblick dot com>
1216 Joshua Ferraro <jmf at liblime dot com>