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);
105 use Koha::Config::SysPref;
106 use Koha::Config::SysPrefs;
112 C4::Context - Maintain and manipulate the context of a Koha script
118 use C4::Context("/path/to/koha-conf.xml");
120 $config_value = C4::Context->config("config_variable");
122 $koha_preference = C4::Context->preference("preference");
124 $db_handle = C4::Context->dbh;
126 $Zconn = C4::Context->Zconn;
130 When a Koha script runs, it makes use of a certain number of things:
131 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
132 databases, and so forth. These things make up the I<context> in which
135 This module takes care of setting up the context for a script:
136 figuring out which configuration file to load, and loading it, opening
137 a connection to the right database, and so forth.
139 Most scripts will only use one context. They can simply have
145 Other scripts may need to use several contexts. For instance, if a
146 library has two databases, one for a certain collection, and the other
147 for everything else, it might be necessary for a script to use two
148 different contexts to search both databases. Such scripts should use
149 the C<&set_context> and C<&restore_context> functions, below.
151 By default, C4::Context reads the configuration from
152 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
153 environment variable to the pathname of a configuration file to use.
160 # In addition to what is said in the POD above, a Context object is a
161 # reference-to-hash with the following fields:
164 # A reference-to-hash whose keys and values are the
165 # configuration variables and values specified in the config
166 # file (/etc/koha/koha-conf.xml).
168 # A handle to the appropriate database for this context.
170 # Used by &set_dbh and &restore_dbh to hold other database
171 # handles for this context.
173 # A connection object for the Zebra server
175 $context = undef; # Initially, no context is set
176 @context_stack = (); # Initially, no saved contexts
180 my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
182 This routines translates a database type to part of the name
183 of the appropriate DBD driver to use when establishing a new
184 database connection. It recognizes 'mysql' and 'Pg'; if any
185 other scheme is supplied it defaults to 'mysql'.
190 my $scheme = shift // '';
191 return $scheme eq 'Pg' ? $scheme : 'mysql';
195 # Create the default context ($C4::Context::Context)
196 # the first time the module is called
197 # (a config file can be optionaly passed)
199 # default context already exists?
203 my ($pkg,$config_file) = @_ ;
204 my $new_ctx = __PACKAGE__->new($config_file);
205 return unless $new_ctx;
207 # if successfully loaded, use it by default
208 $new_ctx->set_context;
214 $context = C4::Context->new;
215 $context = C4::Context->new("/path/to/koha-conf.xml");
217 Allocates a new context. Initializes the context from the specified
218 file, which defaults to either the file given by the C<$KOHA_CONF>
219 environment variable, or F</etc/koha/koha-conf.xml>.
221 It saves the koha-conf.xml values in the declared memcached server(s)
222 if currently available and uses those values until them expire and
225 C<&new> does not set this context as the new default context; for
226 that, use C<&set_context>.
232 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
235 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 $self = Koha::Config->read_from_file($conf_fname);
250 unless ( exists $self->{config} or defined $self->{config} ) {
251 warn "The config file ($conf_fname) has not been parsed correctly";
255 $self->{"Zconn"} = undef; # Zebra Connections
256 $self->{"userenv"} = undef; # User env
257 $self->{"activeuser"} = undef; # current active user
258 $self->{"shelves"} = undef;
259 $self->{tz} = undef; # local timezone object
262 $self->{db_driver} = db_scheme2dbi($self->config('db_scheme')); # cache database driver
268 $context = new C4::Context;
269 $context->set_context();
271 set_context C4::Context $context;
274 restore_context C4::Context;
276 In some cases, it might be necessary for a script to use multiple
277 contexts. C<&set_context> saves the current context on a stack, then
278 sets the context to C<$context>, which will be used in future
279 operations. To restore the previous context, use C<&restore_context>.
287 my $new_context; # The context to set
289 # Figure out whether this is a class or instance method call.
291 # We're going to make the assumption that control got here
292 # through valid means, i.e., that the caller used an instance
293 # or class method call, and that control got here through the
294 # usual inheritance mechanisms. The caller can, of course,
295 # break this assumption by playing silly buggers, but that's
296 # harder to do than doing it properly, and harder to check
298 if (ref($self) eq "")
300 # Class method. The new context is the next argument.
301 $new_context = shift;
303 # Instance method. The new context is $self.
304 $new_context = $self;
307 # Save the old context, if any, on the stack
308 push @context_stack, $context if defined($context);
310 # Set the new context
311 $context = $new_context;
314 =head2 restore_context
318 Restores the context set by C<&set_context>.
327 if ($#context_stack < 0)
330 die "Context stack underflow";
333 # Pop the old context and set it.
334 $context = pop @context_stack;
336 # FIXME - Should this return something, like maybe the context
337 # that was current when this was called?
342 $value = C4::Context->config("config_variable");
344 $value = C4::Context->config_variable;
346 Returns the value of a variable specified in the configuration file
347 from which the current context was created.
349 The second form is more compact, but of course may conflict with
350 method names. If there is a configuration variable called "new", then
351 C<C4::Config-E<gt>new> will not return it.
358 return unless defined $context and defined $context->{$term};
359 # Presumably $self->{$term} might be
360 # undefined if the config file given to &new
361 # didn't exist, and the caller didn't bother
362 # to check the return value.
364 # Return the value of the requested config variable
365 return $context->{$term}->{$var};
369 return _common_config($_[1],'config');
372 return _common_config($_[1],'server');
377 $sys_preference = C4::Context->preference('some_variable');
379 Looks up the value of the given system preference in the
380 systempreferences table of the Koha database, and returns it. If the
381 variable is not set or does not exist, undef is returned.
383 In case of an error, this may return 0.
385 Note: It is impossible to tell the difference between system
386 preferences which do not exist, and those whose values are set to NULL
391 my $use_syspref_cache = 1;
394 my $var = shift; # The system preference to return
396 return Encode::decode_utf8($ENV{"OVERRIDE_SYSPREF_$var"})
397 if defined $ENV{"OVERRIDE_SYSPREF_$var"};
401 if ($use_syspref_cache) {
402 my $syspref_cache = Koha::Caches->get_instance('syspref');
403 my $cached_var = $syspref_cache->get_from_cache("syspref_$var");
404 return $cached_var if defined $cached_var;
408 eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
409 my $value = $syspref ? $syspref->value() : undef;
411 if ( $use_syspref_cache ) {
412 my $syspref_cache = Koha::Caches->get_instance('syspref');
413 $syspref_cache->set_in_cache("syspref_$var", $value);
418 sub boolean_preference {
420 my $var = shift; # The system preference to return
421 my $it = preference($self, $var);
422 return defined($it)? C4::Boolean::true_p($it): undef;
425 =head2 yaml_preference
427 Retrieves the required system preference value, and converts it
428 from YAML into a Perl data structure. It throws an exception if
429 the value cannot be properly decoded as YAML.
433 sub yaml_preference {
434 my ( $self, $preference ) = @_;
436 my $yaml = eval { YAML::Load( $self->preference( $preference ) ); };
438 warn "Unable to parse $preference syspref : $@";
445 =head2 enable_syspref_cache
447 C4::Context->enable_syspref_cache();
449 Enable the in-memory syspref cache used by C4::Context. This is the
454 sub enable_syspref_cache {
456 $use_syspref_cache = 1;
457 # We need to clear the cache to have it up-to-date
458 $self->clear_syspref_cache();
461 =head2 disable_syspref_cache
463 C4::Context->disable_syspref_cache();
465 Disable the in-memory syspref cache used by C4::Context. This should be
466 used with Plack and other persistent environments.
470 sub disable_syspref_cache {
472 $use_syspref_cache = 0;
473 $self->clear_syspref_cache();
476 =head2 clear_syspref_cache
478 C4::Context->clear_syspref_cache();
480 cleans the internal cache of sysprefs. Please call this method if
481 you update the systempreferences table. Otherwise, your new changes
482 will not be seen by this process.
486 sub clear_syspref_cache {
487 return unless $use_syspref_cache;
488 my $syspref_cache = Koha::Caches->get_instance('syspref');
489 $syspref_cache->flush_all;
492 =head2 set_preference
494 C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
496 This updates a preference's value both in the systempreferences table and in
497 the sysprefs cache. If the optional parameters are provided, then the query
498 becomes a create. It won't update the parameters (except value) for an existing
504 my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
506 my $variable_case = $variable;
507 $variable = lc $variable;
509 my $syspref = Koha::Config::SysPrefs->find($variable);
512 : $syspref ? $syspref->type
515 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
517 # force explicit protocol on OPACBaseURL
518 if ( $variable eq 'opacbaseurl' && $value && substr( $value, 0, 4 ) !~ /http/ ) {
519 $value = 'http://' . $value;
524 { ( defined $value ? ( value => $value ) : () ),
525 ( $explanation ? ( explanation => $explanation ) : () ),
526 ( $type ? ( type => $type ) : () ),
527 ( $options ? ( options => $options ) : () ),
531 $syspref = Koha::Config::SysPref->new(
532 { variable => $variable_case,
534 explanation => $explanation || undef,
536 options => $options || undef,
541 if ( $use_syspref_cache ) {
542 my $syspref_cache = Koha::Caches->get_instance('syspref');
543 $syspref_cache->set_in_cache( "syspref_$variable", $value );
549 =head2 delete_preference
551 C4::Context->delete_preference( $variable );
553 This deletes a system preference from the database. Returns a true value on
554 success. Failure means there was an issue with the database, not that there
555 was no syspref of the name.
559 sub delete_preference {
560 my ( $self, $var ) = @_;
562 if ( Koha::Config::SysPrefs->find( $var )->delete ) {
563 if ( $use_syspref_cache ) {
564 my $syspref_cache = Koha::Caches->get_instance('syspref');
565 $syspref_cache->clear_from_cache("syspref_$var");
575 $Zconn = C4::Context->Zconn
577 Returns a connection to the Zebra database
581 C<$server> one of the servers defined in the koha-conf.xml file
583 C<$async> whether this is a asynchronous connection
588 my ($self, $server, $async ) = @_;
589 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
590 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
591 # if we are running the script from the commandline, lets try to use the caching
592 return $context->{"Zconn"}->{$cache_key};
594 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
595 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
596 return $context->{"Zconn"}->{$cache_key};
601 $context->{"Zconn"} = &_new_Zconn($server,$async);
603 Internal function. Creates a new database connection from the data given in the current context and returns it.
605 C<$server> one of the servers defined in the koha-conf.xml file
607 C<$async> whether this is a asynchronous connection
609 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
614 my ( $server, $async ) = @_;
616 my $tried=0; # first attempt
617 my $Zconn; # connection object
621 $server //= "biblioserver";
624 $elementSetName = 'marcxml';
626 my $host = $context->{'listen'}->{$server}->{'content'};
627 my $user = $context->{"serverinfo"}->{$server}->{"user"};
628 my $password = $context->{"serverinfo"}->{$server}->{"password"};
631 my $o = ZOOM::Options->new();
632 $o->option(user => $user) if $user && $password;
633 $o->option(password => $password) if $user && $password;
634 $o->option(async => 1) if $async;
635 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
636 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
637 $o->option(preferredRecordSyntax => $syntax);
638 $o->option(elementSetName => $elementSetName) if $elementSetName;
639 $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
641 # create a new connection object
642 $Zconn= create ZOOM::Connection($o);
645 $Zconn->connect($host, 0);
647 # check for errors and warn
648 if ($Zconn->errcode() !=0) {
649 warn "something wrong with the connection: ". $Zconn->errmsg();
656 # Internal helper function (not a method!). This creates a new
657 # database connection from the data given in the current context, and
662 Koha::Database->schema({ new => 1 })->storage->dbh;
667 $dbh = C4::Context->dbh;
669 Returns a database handle connected to the Koha database for the
670 current context. If no connection has yet been made, this method
671 creates one, and connects to the database.
673 This database handle is cached for future use: if you call
674 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
675 times. If you need a second database handle, use C<&new_dbh> and
676 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 C4::Context->userenv;
776 Retrieves a hash for user environment variables.
778 This hash shall be cached for future use: if you call
779 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
785 my $var = $context->{"activeuser"};
786 if (defined $var and defined $context->{"userenv"}->{$var}) {
787 return $context->{"userenv"}->{$var};
795 C4::Context->set_userenv($usernum, $userid, $usercnum,
796 $userfirstname, $usersurname,
797 $userbranch, $branchname, $userflags,
798 $emailaddress, $shibboleth
799 $desk_id, $desk_name,
800 $register_id, $register_name);
802 Establish a hash of user environment variables.
804 set_userenv is called in Auth.pm
811 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $shibboleth, $desk_id, $desk_name, $register_id, $register_name)=
812 map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
814 my $var=$context->{"activeuser"} || '';
816 "number" => $usernum,
818 "cardnumber" => $usercnum,
819 "firstname" => $userfirstname,
820 "surname" => $usersurname,
822 #possibly a law problem
823 "branch" => $userbranch,
824 "branchname" => $branchname,
825 "flags" => $userflags,
826 "emailaddress" => $emailaddress,
827 "shibboleth" => $shibboleth,
828 "desk_id" => $desk_id,
829 "desk_name" => $desk_name,
830 "register_id" => $register_id,
831 "register_name" => $register_name
833 $context->{userenv}->{$var} = $cell;
837 sub set_shelves_userenv {
838 my ($type, $shelves) = @_ or return;
839 my $activeuser = $context->{activeuser} or return;
840 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
841 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
842 $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
845 sub get_shelves_userenv {
847 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
848 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
851 my $totshelves = $active->{totshelves} or undef;
852 my $pubshelves = $active->{pubshelves} or undef;
853 my $barshelves = $active->{barshelves} or undef;
854 return ($totshelves, $pubshelves, $barshelves);
859 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
861 Builds a hash for user environment variables.
863 This hash shall be cached for future use: if you call
864 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
866 _new_userenv is called in Auth.pm
873 shift; # Useless except it compensates for bad calling style
875 $context->{"activeuser"}=$sessionID;
878 =head2 _unset_userenv
880 C4::Context->_unset_userenv;
882 Destroys the hash for activeuser user environment variables.
891 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
897 C4::Context->get_versions
899 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'.
905 # A little example sub to show more debugging info for CGI::Carp
908 $versions{kohaVersion} = Koha::version();
909 $versions{kohaDbVersion} = C4::Context->preference('version');
910 $versions{osVersion} = join(" ", POSIX::uname());
911 $versions{perlVersion} = $];
913 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
914 $versions{mysqlVersion} = `mysql -V`;
915 $versions{apacheVersion} = (`apache2ctl -v`)[0];
916 $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
917 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
918 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
919 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
926 my $C4::Context->timzone
928 Returns a timezone code for the instance of Koha
935 my $timezone = C4::Context->config('timezone') || $ENV{TZ} || 'local';
936 if ( !DateTime::TimeZone->is_valid_name( $timezone ) ) {
937 warn "Invalid timezone in koha-conf.xml ($timezone)";
948 Returns a DateTime::TimeZone object for the system timezone
954 if (!defined $context->{tz}) {
955 my $timezone = $self->timezone;
956 $context->{tz} = DateTime::TimeZone->new(name => $timezone);
958 return $context->{tz};
962 =head2 IsSuperLibrarian
964 C4::Context->IsSuperLibrarian();
968 sub IsSuperLibrarian {
969 my $userenv = C4::Context->userenv;
971 unless ( $userenv and exists $userenv->{flags} ) {
972 # If we reach this without a user environment,
973 # assume that we're running from a command-line script,
974 # and act as a superlibrarian.
975 carp("C4::Context->userenv not defined!");
979 return ($userenv->{flags}//0) % 2;
984 Sets the current interface for later retrieval in any Perl module
986 C4::Context->interface('opac');
987 C4::Context->interface('intranet');
988 my $interface = C4::Context->interface;
993 my ($class, $interface) = @_;
995 if (defined $interface) {
996 $interface = lc $interface;
997 if ( $interface eq 'api'
998 || $interface eq 'opac'
999 || $interface eq 'intranet'
1000 || $interface eq 'sip'
1001 || $interface eq 'cron'
1002 || $interface eq 'commandline' )
1004 $context->{interface} = $interface;
1006 warn "invalid interface : '$interface'";
1010 return $context->{interface} // 'opac';
1013 # always returns a string for OK comparison via "eq" or "ne"
1015 C4::Context->userenv or return '';
1016 return C4::Context->userenv->{branch} || '';
1019 =head2 only_my_library
1021 my $test = C4::Context->only_my_library;
1023 Returns true if you enabled IndependentBranches and the current user
1024 does not have superlibrarian permissions.
1028 sub only_my_library {
1030 C4::Context->preference('IndependentBranches')
1031 && C4::Context->userenv
1032 && !C4::Context->IsSuperLibrarian()
1033 && C4::Context->userenv->{branch};
1036 =head3 temporary_directory
1038 Returns root directory for temporary storage
1042 sub temporary_directory {
1044 return C4::Context->config('tmp_path') || File::Spec->tmpdir;
1047 =head3 set_remote_address
1049 set_remote_address should be called at the beginning of every script
1050 that is *not* running under plack in order to the REMOTE_ADDR environment
1051 variable to be set correctly.
1055 sub set_remote_address {
1056 if ( C4::Context->config('koha_trusted_proxies') ) {
1058 my $header = CGI->http('HTTP_X_FORWARDED_FOR');
1061 require Koha::Middleware::RealIP;
1062 $ENV{REMOTE_ADDR} = Koha::Middleware::RealIP::get_real_ip( $ENV{REMOTE_ADDR}, $header );
1067 =head3 https_enabled
1069 https_enabled should be called when checking if a HTTPS connection
1072 Note that this depends on a HTTPS environmental variable being defined
1073 by the web server. This function may not return the expected result,
1074 if your web server or reverse proxies are not setting the correct
1075 X-Forwarded-Proto headers and HTTPS environmental variable.
1077 Note too that the HTTPS value can vary from web server to web server.
1078 We are relying on the convention of the value being "on" or "ON" here.
1083 my $https_enabled = 0;
1084 my $env_https = $ENV{HTTPS};
1086 if ($env_https =~ /^ON$/i){
1090 return $https_enabled;
1095 =head3 needs_install
1097 if ( $context->needs_install ) { ... }
1099 This method returns a boolean representing the install status of the Koha instance.
1105 return ($self->preference('Version')) ? 0 : 1;
1114 Specifies the configuration file to read.
1122 Andrew Arensburger <arensb at ooblick dot com>
1124 Joshua Ferraro <jmf at liblime dot com>