3 # Copyright 2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 use vars qw($AUTOLOAD $context @context_stack);
24 if ($ENV{'HTTP_USER_AGENT'}) {
26 # FIXME for future reference, CGI::Carp doc says
27 # "Note that fatalsToBrowser does not work with mod_perl version 2.0 and higher."
28 import CGI::Carp qw(fatalsToBrowser);
32 eval {C4::Context->dbh();};
37 $debug_level = C4::Context->preference("DebugLevel");
40 print q(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
41 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
42 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
43 <head><title>Koha Error</title></head>
46 if ($debug_level eq "2"){
47 # debug 2 , print extra info too.
48 my %versions = get_versions();
50 # a little example table with various version info";
53 <p>The following fatal error has occurred:</p>
54 <pre><code>$msg</code></pre>
56 <tr><th>Apache</th><td> $versions{apacheVersion}</td></tr>
57 <tr><th>Koha</th><td> $versions{kohaVersion}</td></tr>
58 <tr><th>Koha DB</th><td> $versions{kohaDbVersion}</td></tr>
59 <tr><th>MySQL</th><td> $versions{mysqlVersion}</td></tr>
60 <tr><th>OS</th><td> $versions{osVersion}</td></tr>
61 <tr><th>Perl</th><td> $versions{perlVersion}</td></tr>
64 } elsif ($debug_level eq "1"){
67 <p>The following fatal error has occurred:</p>
68 <pre><code>$msg</code></pre>";
70 print "<p>production mode - trapped fatal error</p>";
72 print "</body></html>";
74 #CGI::Carp::set_message(\&handle_errors);
75 ## give a stack backtrace if KOHA_BACKTRACES is set
76 ## can't rely on DebugLevel for this, as we're not yet connected
77 if ($ENV{KOHA_BACKTRACES}) {
78 $main::SIG{__DIE__} = \&CGI::Carp::confess;
81 # Redefine multi_param if cgi version is < 4.08
82 # Remove the "CGI::param called in list context" warning in this case
83 require CGI; # Can't check version without the require.
84 if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {
85 no warnings 'redefine';
86 *CGI::multi_param = \&CGI::param;
87 use warnings 'redefine';
88 $CGI::LIST_CONTEXT_WARN = 0;
90 } # else there is no browser to send fatals to!
94 use DateTime::TimeZone;
97 use Module::Load::Conditional qw(can_load);
104 use Koha::Config::SysPref;
105 use Koha::Config::SysPrefs;
111 C4::Context - Maintain and manipulate the context of a Koha script
117 use C4::Context("/path/to/koha-conf.xml");
119 $config_value = C4::Context->config("config_variable");
121 $koha_preference = C4::Context->preference("preference");
123 $db_handle = C4::Context->dbh;
125 $Zconn = C4::Context->Zconn;
129 When a Koha script runs, it makes use of a certain number of things:
130 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
131 databases, and so forth. These things make up the I<context> in which
134 This module takes care of setting up the context for a script:
135 figuring out which configuration file to load, and loading it, opening
136 a connection to the right database, and so forth.
138 Most scripts will only use one context. They can simply have
144 Other scripts may need to use several contexts. For instance, if a
145 library has two databases, one for a certain collection, and the other
146 for everything else, it might be necessary for a script to use two
147 different contexts to search both databases. Such scripts should use
148 the C<&set_context> and C<&restore_context> functions, below.
150 By default, C4::Context reads the configuration from
151 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
152 environment variable to the pathname of a configuration file to use.
159 # In addition to what is said in the POD above, a Context object is a
160 # reference-to-hash with the following fields:
163 # A reference-to-hash whose keys and values are the
164 # configuration variables and values specified in the config
165 # file (/etc/koha/koha-conf.xml).
167 # A handle to the appropriate database for this context.
169 # Used by &set_dbh and &restore_dbh to hold other database
170 # handles for this context.
172 # A connection object for the Zebra server
174 $context = undef; # Initially, no context is set
175 @context_stack = (); # Initially, no saved contexts
179 my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
181 This routines translates a database type to part of the name
182 of the appropriate DBD driver to use when establishing a new
183 database connection. It recognizes 'mysql' and 'Pg'; if any
184 other scheme is supplied it defaults to 'mysql'.
189 my $scheme = shift // '';
190 return $scheme eq 'Pg' ? $scheme : 'mysql';
194 # Create the default context ($C4::Context::Context)
195 # the first time the module is called
196 # (a config file can be optionaly passed)
198 # default context already exists?
202 my ($pkg,$config_file) = @_ ;
203 my $new_ctx = __PACKAGE__->new($config_file);
204 return unless $new_ctx;
206 # if successfully loaded, use it by default
207 $new_ctx->set_context;
213 $context = new C4::Context;
214 $context = new C4::Context("/path/to/koha-conf.xml");
216 Allocates a new context. Initializes the context from the specified
217 file, which defaults to either the file given by the C<$KOHA_CONF>
218 environment variable, or F</etc/koha/koha-conf.xml>.
220 It saves the koha-conf.xml values in the declared memcached server(s)
221 if currently available and uses those values until them expire and
224 C<&new> does not set this context as the new default context; for
225 that, use C<&set_context>.
231 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
234 my $conf_fname = shift; # Config file to load
237 # check that the specified config file exists and is not empty
238 undef $conf_fname unless
239 (defined $conf_fname && -s $conf_fname);
240 # Figure out a good config file to load if none was specified.
241 unless ( defined $conf_fname ) {
242 $conf_fname = Koha::Config->guess_koha_conf;
243 unless ( $conf_fname ) {
244 warn "unable to locate Koha configuration file koha-conf.xml";
249 my $conf_cache = Koha::Caches->get_instance('config');
250 my $config_from_cache;
251 if ( $conf_cache->cache ) {
252 $self = $conf_cache->get_from_cache('koha_conf');
254 unless ( $self and %$self ) {
255 $self = Koha::Config->read_from_file($conf_fname);
256 if ( $conf_cache->memcached_cache ) {
257 # FIXME it may be better to use the memcached servers from the config file
259 $conf_cache->set_in_cache('koha_conf', $self)
262 unless ( exists $self->{config} or defined $self->{config} ) {
263 warn "The config file ($conf_fname) has not been parsed correctly";
267 $self->{"Zconn"} = undef; # Zebra Connections
268 $self->{"userenv"} = undef; # User env
269 $self->{"activeuser"} = undef; # current active user
270 $self->{"shelves"} = undef;
271 $self->{tz} = undef; # local timezone object
274 $self->{db_driver} = db_scheme2dbi($self->config('db_scheme')); # cache database driver
280 $context = new C4::Context;
281 $context->set_context();
283 set_context C4::Context $context;
286 restore_context C4::Context;
288 In some cases, it might be necessary for a script to use multiple
289 contexts. C<&set_context> saves the current context on a stack, then
290 sets the context to C<$context>, which will be used in future
291 operations. To restore the previous context, use C<&restore_context>.
299 my $new_context; # The context to set
301 # Figure out whether this is a class or instance method call.
303 # We're going to make the assumption that control got here
304 # through valid means, i.e., that the caller used an instance
305 # or class method call, and that control got here through the
306 # usual inheritance mechanisms. The caller can, of course,
307 # break this assumption by playing silly buggers, but that's
308 # harder to do than doing it properly, and harder to check
310 if (ref($self) eq "")
312 # Class method. The new context is the next argument.
313 $new_context = shift;
315 # Instance method. The new context is $self.
316 $new_context = $self;
319 # Save the old context, if any, on the stack
320 push @context_stack, $context if defined($context);
322 # Set the new context
323 $context = $new_context;
326 =head2 restore_context
330 Restores the context set by C<&set_context>.
339 if ($#context_stack < 0)
342 die "Context stack underflow";
345 # Pop the old context and set it.
346 $context = pop @context_stack;
348 # FIXME - Should this return something, like maybe the context
349 # that was current when this was called?
354 $value = C4::Context->config("config_variable");
356 $value = C4::Context->config_variable;
358 Returns the value of a variable specified in the configuration file
359 from which the current context was created.
361 The second form is more compact, but of course may conflict with
362 method names. If there is a configuration variable called "new", then
363 C<C4::Config-E<gt>new> will not return it.
370 return if !defined($context->{$term});
371 # Presumably $self->{$term} might be
372 # undefined if the config file given to &new
373 # didn't exist, and the caller didn't bother
374 # to check the return value.
376 # Return the value of the requested config variable
377 return $context->{$term}->{$var};
381 return _common_config($_[1],'config');
384 return _common_config($_[1],'server');
387 return _common_config($_[1],'serverinfo');
392 $sys_preference = C4::Context->preference('some_variable');
394 Looks up the value of the given system preference in the
395 systempreferences table of the Koha database, and returns it. If the
396 variable is not set or does not exist, undef is returned.
398 In case of an error, this may return 0.
400 Note: It is impossible to tell the difference between system
401 preferences which do not exist, and those whose values are set to NULL
406 my $syspref_cache = Koha::Caches->get_instance('syspref');
407 my $use_syspref_cache = 1;
410 my $var = shift; # The system preference to return
412 return $ENV{"OVERRIDE_SYSPREF_$var"}
413 if defined $ENV{"OVERRIDE_SYSPREF_$var"};
417 if ($use_syspref_cache) {
418 $syspref_cache = Koha::Caches->get_instance('syspref') unless $syspref_cache;
419 my $cached_var = $syspref_cache->get_from_cache("syspref_$var");
420 return $cached_var if defined $cached_var;
424 eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
425 my $value = $syspref ? $syspref->value() : undef;
427 if ( $use_syspref_cache ) {
428 $syspref_cache->set_in_cache("syspref_$var", $value);
433 sub boolean_preference {
435 my $var = shift; # The system preference to return
436 my $it = preference($self, $var);
437 return defined($it)? C4::Boolean::true_p($it): undef;
440 =head2 enable_syspref_cache
442 C4::Context->enable_syspref_cache();
444 Enable the in-memory syspref cache used by C4::Context. This is the
449 sub enable_syspref_cache {
451 $use_syspref_cache = 1;
452 # We need to clear the cache to have it up-to-date
453 $self->clear_syspref_cache();
456 =head2 disable_syspref_cache
458 C4::Context->disable_syspref_cache();
460 Disable the in-memory syspref cache used by C4::Context. This should be
461 used with Plack and other persistent environments.
465 sub disable_syspref_cache {
467 $use_syspref_cache = 0;
468 $self->clear_syspref_cache();
471 =head2 clear_syspref_cache
473 C4::Context->clear_syspref_cache();
475 cleans the internal cache of sysprefs. Please call this method if
476 you update the systempreferences table. Otherwise, your new changes
477 will not be seen by this process.
481 sub clear_syspref_cache {
482 return unless $use_syspref_cache;
483 $syspref_cache->flush_all;
486 =head2 set_preference
488 C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
490 This updates a preference's value both in the systempreferences table and in
491 the sysprefs cache. If the optional parameters are provided, then the query
492 becomes a create. It won't update the parameters (except value) for an existing
498 my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
500 my $variable_case = $variable;
501 $variable = lc $variable;
503 my $syspref = Koha::Config::SysPrefs->find($variable);
506 : $syspref ? $syspref->type
509 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
511 # force explicit protocol on OPACBaseURL
512 if ( $variable eq 'opacbaseurl' && $value && substr( $value, 0, 4 ) !~ /http/ ) {
513 $value = 'http://' . $value;
518 { ( defined $value ? ( value => $value ) : () ),
519 ( $explanation ? ( explanation => $explanation ) : () ),
520 ( $type ? ( type => $type ) : () ),
521 ( $options ? ( options => $options ) : () ),
525 $syspref = Koha::Config::SysPref->new(
526 { variable => $variable_case,
528 explanation => $explanation || undef,
530 options => $options || undef,
535 if ( $use_syspref_cache ) {
536 $syspref_cache->set_in_cache( "syspref_$variable", $value );
542 =head2 delete_preference
544 C4::Context->delete_preference( $variable );
546 This deletes a system preference from the database. Returns a true value on
547 success. Failure means there was an issue with the database, not that there
548 was no syspref of the name.
552 sub delete_preference {
553 my ( $self, $var ) = @_;
555 if ( Koha::Config::SysPrefs->find( $var )->delete ) {
556 if ( $use_syspref_cache ) {
557 $syspref_cache->clear_from_cache("syspref_$var");
567 $Zconn = C4::Context->Zconn
569 Returns a connection to the Zebra database
573 C<$server> one of the servers defined in the koha-conf.xml file
575 C<$async> whether this is a asynchronous connection
580 my ($self, $server, $async ) = @_;
581 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
582 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
583 # if we are running the script from the commandline, lets try to use the caching
584 return $context->{"Zconn"}->{$cache_key};
586 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
587 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
588 return $context->{"Zconn"}->{$cache_key};
593 $context->{"Zconn"} = &_new_Zconn($server,$async);
595 Internal function. Creates a new database connection from the data given in the current context and returns it.
597 C<$server> one of the servers defined in the koha-conf.xml file
599 C<$async> whether this is a asynchronous connection
601 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
606 my ( $server, $async ) = @_;
608 my $tried=0; # first attempt
609 my $Zconn; # connection object
614 $server //= "biblioserver";
616 if ( $server eq 'biblioserver' ) {
617 $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
618 } elsif ( $server eq 'authorityserver' ) {
619 $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
623 $elementSetName = 'marcxml';
625 my $host = $context->{'listen'}->{$server}->{'content'};
626 my $user = $context->{"serverinfo"}->{$server}->{"user"};
627 my $password = $context->{"serverinfo"}->{$server}->{"password"};
630 my $o = new ZOOM::Options();
631 $o->option(user => $user) if $user && $password;
632 $o->option(password => $password) if $user && $password;
633 $o->option(async => 1) if $async;
634 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
635 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
636 $o->option(preferredRecordSyntax => $syntax);
637 $o->option(elementSetName => $elementSetName) if $elementSetName;
638 $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
640 # create a new connection object
641 $Zconn= create ZOOM::Connection($o);
644 $Zconn->connect($host, 0);
646 # check for errors and warn
647 if ($Zconn->errcode() !=0) {
648 warn "something wrong with the connection: ". $Zconn->errmsg();
655 # Internal helper function (not a method!). This creates a new
656 # database connection from the data given in the current context, and
661 Koha::Database->schema({ new => 1 })->storage->dbh;
666 $dbh = C4::Context->dbh;
668 Returns a database handle connected to the Koha database for the
669 current context. If no connection has yet been made, this method
670 creates one, and connects to the database.
672 This database handle is cached for future use: if you call
673 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
674 times. If you need a second database handle, use C<&new_dbh> and
675 possibly C<&set_dbh>.
686 unless ( $params->{new} ) {
687 return Koha::Database->schema->storage->dbh;
690 return Koha::Database->schema({ new => 1 })->storage->dbh;
695 $dbh = C4::Context->new_dbh;
697 Creates a new connection to the Koha database for the current context,
698 and returns the database handle (a C<DBI::db> object).
700 The handle is not saved anywhere: this method is strictly a
701 convenience function; the point is that it knows which database to
702 connect to so that the caller doesn't have to know.
711 return &dbh({ new => 1 });
716 $my_dbh = C4::Connect->new_dbh;
717 C4::Connect->set_dbh($my_dbh);
719 C4::Connect->restore_dbh;
721 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
722 C<&set_context> and C<&restore_context>.
724 C<&set_dbh> saves the current database handle on a stack, then sets
725 the current database handle to C<$my_dbh>.
727 C<$my_dbh> is assumed to be a good database handle.
737 # Save the current database handle on the handle stack.
738 # We assume that $new_dbh is all good: if the caller wants to
739 # screw himself by passing an invalid handle, that's fine by
741 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
742 $context->{"dbh"} = $new_dbh;
747 C4::Context->restore_dbh;
749 Restores the database handle saved by an earlier call to
750 C<C4::Context-E<gt>set_dbh>.
759 if ($#{$context->{"dbh_stack"}} < 0)
762 die "DBH stack underflow";
765 # Pop the old database handle and set it.
766 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
768 # FIXME - If it is determined that restore_context should
769 # return something, then this function should, too.
774 $queryparser = C4::Context->queryparser
776 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
782 unless (defined $context->{"queryparser"}) {
783 $context->{"queryparser"} = &_new_queryparser();
787 defined( $context->{"queryparser"} )
788 ? $context->{"queryparser"}->new
792 =head2 _new_queryparser
794 Internal helper function to create a new QueryParser object. QueryParser
795 is loaded dynamically so as to keep the lack of the QueryParser library from
796 getting in anyone's way.
800 sub _new_queryparser {
802 'OpenILS::QueryParser' => undef,
803 'Koha::QueryParser::Driver::PQF' => undef
805 if ( can_load( 'modules' => $qpmodules ) ) {
806 my $QParser = Koha::QueryParser::Driver::PQF->new();
807 my $config_file = $context->config('queryparser_config');
808 $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
809 if ( $QParser->load_config($config_file) ) {
810 # Set 'keyword' as the default search class
811 $QParser->default_search_class('keyword');
812 # TODO: allow indexes to be configured in the database
821 C4::Context->userenv;
823 Retrieves a hash for user environment variables.
825 This hash shall be cached for future use: if you call
826 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
832 my $var = $context->{"activeuser"};
833 if (defined $var and defined $context->{"userenv"}->{$var}) {
834 return $context->{"userenv"}->{$var};
842 C4::Context->set_userenv($usernum, $userid, $usercnum,
843 $userfirstname, $usersurname,
844 $userbranch, $branchname, $userflags,
845 $emailaddress, $branchprinter, $shibboleth);
847 Establish a hash of user environment variables.
849 set_userenv is called in Auth.pm
856 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $shibboleth)=
857 map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
859 my $var=$context->{"activeuser"} || '';
861 "number" => $usernum,
863 "cardnumber" => $usercnum,
864 "firstname" => $userfirstname,
865 "surname" => $usersurname,
866 #possibly a law problem
867 "branch" => $userbranch,
868 "branchname" => $branchname,
869 "flags" => $userflags,
870 "emailaddress" => $emailaddress,
871 "branchprinter" => $branchprinter,
872 "shibboleth" => $shibboleth,
874 $context->{userenv}->{$var} = $cell;
878 sub set_shelves_userenv {
879 my ($type, $shelves) = @_ or return;
880 my $activeuser = $context->{activeuser} or return;
881 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
882 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
883 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
886 sub get_shelves_userenv {
888 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
889 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
892 my $totshelves = $active->{totshelves} or undef;
893 my $pubshelves = $active->{pubshelves} or undef;
894 my $barshelves = $active->{barshelves} or undef;
895 return ($totshelves, $pubshelves, $barshelves);
900 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
902 Builds a hash for user environment variables.
904 This hash shall be cached for future use: if you call
905 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
907 _new_userenv is called in Auth.pm
914 shift; # Useless except it compensates for bad calling style
916 $context->{"activeuser"}=$sessionID;
919 =head2 _unset_userenv
921 C4::Context->_unset_userenv;
923 Destroys the hash for activeuser user environment variables.
932 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
938 C4::Context->get_versions
940 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'.
946 # A little example sub to show more debugging info for CGI::Carp
949 $versions{kohaVersion} = Koha::version();
950 $versions{kohaDbVersion} = C4::Context->preference('version');
951 $versions{osVersion} = join(" ", POSIX::uname());
952 $versions{perlVersion} = $];
954 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
955 $versions{mysqlVersion} = `mysql -V`;
956 $versions{apacheVersion} = (`apache2ctl -v`)[0];
957 $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
958 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
959 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
960 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
967 my $C4::Context->timzone
969 Returns a timezone code for the instance of Koha
976 my $timezone = C4::Context->config('timezone') || $ENV{TZ} || 'local';
977 if ( !DateTime::TimeZone->is_valid_name( $timezone ) ) {
978 warn "Invalid timezone in koha-conf.xml ($timezone)";
989 Returns a DateTime::TimeZone object for the system timezone
995 if (!defined $context->{tz}) {
996 my $timezone = $self->timezone;
997 $context->{tz} = DateTime::TimeZone->new(name => $timezone);
999 return $context->{tz};
1003 =head2 IsSuperLibrarian
1005 C4::Context->IsSuperLibrarian();
1009 sub IsSuperLibrarian {
1010 my $userenv = C4::Context->userenv;
1012 unless ( $userenv and exists $userenv->{flags} ) {
1013 # If we reach this without a user environment,
1014 # assume that we're running from a command-line script,
1015 # and act as a superlibrarian.
1016 carp("C4::Context->userenv not defined!");
1020 return ($userenv->{flags}//0) % 2;
1025 Sets the current interface for later retrieval in any Perl module
1027 C4::Context->interface('opac');
1028 C4::Context->interface('intranet');
1029 my $interface = C4::Context->interface;
1034 my ($class, $interface) = @_;
1036 if (defined $interface) {
1037 $interface = lc $interface;
1038 if ($interface eq 'opac' || $interface eq 'intranet' || $interface eq 'sip' || $interface eq 'commandline') {
1039 $context->{interface} = $interface;
1041 warn "invalid interface : '$interface'";
1045 return $context->{interface} // 'opac';
1048 # always returns a string for OK comparison via "eq" or "ne"
1050 C4::Context->userenv or return '';
1051 return C4::Context->userenv->{branch} || '';
1054 =head2 only_my_library
1056 my $test = C4::Context->only_my_library;
1058 Returns true if you enabled IndependentBranches and the current user
1059 does not have superlibrarian permissions.
1063 sub only_my_library {
1065 C4::Context->preference('IndependentBranches')
1066 && C4::Context->userenv
1067 && !C4::Context->IsSuperLibrarian()
1068 && C4::Context->userenv->{branch};
1071 =head3 temporary_directory
1073 Returns root directory for temporary storage
1077 sub temporary_directory {
1079 return C4::Context->config('tmp_path') || File::Spec->tmpdir;
1091 Specifies the configuration file to read.
1099 Andrew Arensburger <arensb at ooblick dot com>
1101 Joshua Ferraro <jmf at liblime dot com>