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'} ) { # Only hit when plack is not enabled
26 # Redefine multi_param if cgi version is < 4.08
27 # Remove the "CGI::param called in list context" warning in this case
28 require CGI; # Can't check version without the require.
29 if ( !defined($CGI::VERSION) || $CGI::VERSION < 4.08 ) {
30 no warnings 'redefine';
31 *CGI::multi_param = \&CGI::param;
32 use warnings 'redefine';
33 $CGI::LIST_CONTEXT_WARN = 0;
39 use DateTime::TimeZone;
45 use List::MoreUtils qw(any);
48 use Koha::Config::SysPref;
49 use Koha::Config::SysPrefs;
55 C4::Context - Maintain and manipulate the context of a Koha script
61 use C4::Context("/path/to/koha-conf.xml");
63 $config_value = C4::Context->config("config_variable");
65 $koha_preference = C4::Context->preference("preference");
67 $db_handle = C4::Context->dbh;
69 $Zconn = C4::Context->Zconn;
73 When a Koha script runs, it makes use of a certain number of things:
74 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
75 databases, and so forth. These things make up the I<context> in which
78 This module takes care of setting up the context for a script:
79 figuring out which configuration file to load, and loading it, opening
80 a connection to the right database, and so forth.
82 Most scripts will only use one context. They can simply have
88 Other scripts may need to use several contexts. For instance, if a
89 library has two databases, one for a certain collection, and the other
90 for everything else, it might be necessary for a script to use two
91 different contexts to search both databases. Such scripts should use
92 the C<&set_context> and C<&restore_context> functions, below.
94 By default, C4::Context reads the configuration from
95 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
96 environment variable to the pathname of a configuration file to use.
103 # In addition to what is said in the POD above, a Context object is a
104 # reference-to-hash with the following fields:
107 # A reference-to-hash whose keys and values are the
108 # configuration variables and values specified in the config
109 # file (/etc/koha/koha-conf.xml).
111 # A handle to the appropriate database for this context.
113 # Used by &set_dbh and &restore_dbh to hold other database
114 # handles for this context.
116 # A connection object for the Zebra server
118 $context = undef; # Initially, no context is set
119 @context_stack = (); # Initially, no saved contexts
122 # Create the default context ($C4::Context::Context)
123 # the first time the module is called
124 # (a config file can be optionaly passed)
126 # default context already exists?
130 my ($pkg,$config_file) = @_ ;
131 my $new_ctx = __PACKAGE__->new($config_file);
132 return unless $new_ctx;
134 # if successfully loaded, use it by default
135 $new_ctx->set_context;
141 $context = C4::Context->new;
142 $context = C4::Context->new("/path/to/koha-conf.xml");
144 Allocates a new context. Initializes the context from the specified
145 file, which defaults to either the file given by the C<$KOHA_CONF>
146 environment variable, or F</etc/koha/koha-conf.xml>.
148 It saves the koha-conf.xml values in the declared memcached server(s)
149 if currently available and uses those values until them expire and
152 C<&new> does not set this context as the new default context; for
153 that, use C<&set_context>.
159 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
162 my $conf_fname = shift; # Config file to load
164 # check that the specified config file exists and is not empty
165 undef $conf_fname unless
166 (defined $conf_fname && -s $conf_fname);
167 # Figure out a good config file to load if none was specified.
168 unless ( defined $conf_fname ) {
169 $conf_fname = Koha::Config->guess_koha_conf;
170 unless ( $conf_fname ) {
171 warn "unable to locate Koha configuration file koha-conf.xml";
177 $self->{config} = Koha::Config->get_instance($conf_fname);
178 unless ( defined $self->{config} ) {
179 warn "The config file ($conf_fname) has not been parsed correctly";
183 $self->{"Zconn"} = undef; # Zebra Connections
184 $self->{"userenv"} = undef; # User env
185 $self->{"activeuser"} = undef; # current active user
186 $self->{"shelves"} = undef;
187 $self->{tz} = undef; # local timezone object
195 $context = new C4::Context;
196 $context->set_context();
198 set_context C4::Context $context;
201 restore_context C4::Context;
203 In some cases, it might be necessary for a script to use multiple
204 contexts. C<&set_context> saves the current context on a stack, then
205 sets the context to C<$context>, which will be used in future
206 operations. To restore the previous context, use C<&restore_context>.
214 my $new_context; # The context to set
216 # Figure out whether this is a class or instance method call.
218 # We're going to make the assumption that control got here
219 # through valid means, i.e., that the caller used an instance
220 # or class method call, and that control got here through the
221 # usual inheritance mechanisms. The caller can, of course,
222 # break this assumption by playing silly buggers, but that's
223 # harder to do than doing it properly, and harder to check
225 if (ref($self) eq "")
227 # Class method. The new context is the next argument.
228 $new_context = shift;
230 # Instance method. The new context is $self.
231 $new_context = $self;
234 # Save the old context, if any, on the stack
235 push @context_stack, $context if defined($context);
237 # Set the new context
238 $context = $new_context;
241 =head2 restore_context
245 Restores the context set by C<&set_context>.
254 if ($#context_stack < 0)
257 die "Context stack underflow";
260 # Pop the old context and set it.
261 $context = pop @context_stack;
263 # FIXME - Should this return something, like maybe the context
264 # that was current when this was called?
269 $value = C4::Context->config("config_variable");
271 Returns the value of a variable specified in the configuration file
272 from which the current context was created.
277 my ($var, $term) = @_;
279 return unless defined $context and defined $context->{config};
281 return $context->{config}->get($var, $term);
285 return _common_config($_[1],'config');
288 return _common_config($_[1],'server');
293 $sys_preference = C4::Context->preference('some_variable');
295 Looks up the value of the given system preference in the
296 systempreferences table of the Koha database, and returns it. If the
297 variable is not set or does not exist, undef is returned.
299 In case of an error, this may return 0.
301 Note: It is impossible to tell the difference between system
302 preferences which do not exist, and those whose values are set to NULL
307 my $use_syspref_cache = 1;
310 my $var = shift; # The system preference to return
312 return Encode::decode_utf8($ENV{"OVERRIDE_SYSPREF_$var"})
313 if defined $ENV{"OVERRIDE_SYSPREF_$var"};
317 if ($use_syspref_cache) {
318 my $syspref_cache = Koha::Caches->get_instance('syspref');
319 my $cached_var = $syspref_cache->get_from_cache("syspref_$var");
320 return $cached_var if defined $cached_var;
324 eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
325 my $value = $syspref ? $syspref->value() : undef;
327 if ( $use_syspref_cache ) {
328 my $syspref_cache = Koha::Caches->get_instance('syspref');
329 $syspref_cache->set_in_cache("syspref_$var", $value);
334 =head2 yaml_preference
336 Retrieves the required system preference value, and converts it
337 from YAML into a Perl data structure. It throws an exception if
338 the value cannot be properly decoded as YAML.
342 sub yaml_preference {
343 my ( $self, $preference ) = @_;
345 my $yaml = eval { YAML::XS::Load( Encode::encode_utf8( $self->preference( $preference ) ) ); };
347 warn "Unable to parse $preference syspref : $@";
354 =head2 enable_syspref_cache
356 C4::Context->enable_syspref_cache();
358 Enable the in-memory syspref cache used by C4::Context. This is the
363 sub enable_syspref_cache {
365 $use_syspref_cache = 1;
366 # We need to clear the cache to have it up-to-date
367 $self->clear_syspref_cache();
370 =head2 disable_syspref_cache
372 C4::Context->disable_syspref_cache();
374 Disable the in-memory syspref cache used by C4::Context. This should be
375 used with Plack and other persistent environments.
379 sub disable_syspref_cache {
381 $use_syspref_cache = 0;
382 $self->clear_syspref_cache();
385 =head2 clear_syspref_cache
387 C4::Context->clear_syspref_cache();
389 cleans the internal cache of sysprefs. Please call this method if
390 you update the systempreferences table. Otherwise, your new changes
391 will not be seen by this process.
395 sub clear_syspref_cache {
396 return unless $use_syspref_cache;
397 my $syspref_cache = Koha::Caches->get_instance('syspref');
398 $syspref_cache->flush_all;
401 =head2 set_preference
403 C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
405 This updates a preference's value both in the systempreferences table and in
406 the sysprefs cache. If the optional parameters are provided, then the query
407 becomes a create. It won't update the parameters (except value) for an existing
413 my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
415 my $variable_case = $variable;
416 $variable = lc $variable;
418 my $syspref = Koha::Config::SysPrefs->find($variable);
421 : $syspref ? $syspref->type
424 $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
426 # force explicit protocol on OPACBaseURL
427 if ( $variable eq 'opacbaseurl' && $value && substr( $value, 0, 4 ) !~ /http/ ) {
428 $value = 'http://' . $value;
433 { ( defined $value ? ( value => $value ) : () ),
434 ( $explanation ? ( explanation => $explanation ) : () ),
435 ( $type ? ( type => $type ) : () ),
436 ( $options ? ( options => $options ) : () ),
440 $syspref = Koha::Config::SysPref->new(
441 { variable => $variable_case,
443 explanation => $explanation || undef,
445 options => $options || undef,
450 if ( $use_syspref_cache ) {
451 my $syspref_cache = Koha::Caches->get_instance('syspref');
452 $syspref_cache->set_in_cache( "syspref_$variable", $value );
458 =head2 delete_preference
460 C4::Context->delete_preference( $variable );
462 This deletes a system preference from the database. Returns a true value on
463 success. Failure means there was an issue with the database, not that there
464 was no syspref of the name.
468 sub delete_preference {
469 my ( $self, $var ) = @_;
471 if ( Koha::Config::SysPrefs->find( $var )->delete ) {
472 if ( $use_syspref_cache ) {
473 my $syspref_cache = Koha::Caches->get_instance('syspref');
474 $syspref_cache->clear_from_cache("syspref_$var");
484 $delimiter = C4::Context->csv_delimiter;
486 Returns prefered CSV delimiter, using system preference 'CSVDelimiter'.
487 If this preference is missing or empty semicolon will be returned.
488 This method is needed because of special behavior for tabulation.
490 You can, optionally, pass a value parameter to this routine
491 in the case of existing delimiter.
496 my ( $self, $value ) = @_;
497 my $delimiter = $value || $self->preference('CSVDelimiter') || ';';
498 $delimiter = "\t" if $delimiter eq 'tabulation';
504 $Zconn = C4::Context->Zconn
506 Returns a connection to the Zebra database
510 C<$server> one of the servers defined in the koha-conf.xml file
512 C<$async> whether this is a asynchronous connection
517 my ($self, $server, $async ) = @_;
518 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
519 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
520 # if we are running the script from the commandline, lets try to use the caching
521 return $context->{"Zconn"}->{$cache_key};
523 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
524 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
525 return $context->{"Zconn"}->{$cache_key};
530 $context->{"Zconn"} = &_new_Zconn($server,$async);
532 Internal function. Creates a new database connection from the data given in the current context and returns it.
534 C<$server> one of the servers defined in the koha-conf.xml file
536 C<$async> whether this is a asynchronous connection
538 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
543 my ( $server, $async ) = @_;
545 my $tried=0; # first attempt
546 my $Zconn; # connection object
550 $server //= "biblioserver";
553 $elementSetName = 'marcxml';
555 my $host = _common_config($server, 'listen')->{content};
556 my $serverinfo = _common_config($server, 'serverinfo');
557 my $user = $serverinfo->{user};
558 my $password = $serverinfo->{password};
561 my $o = ZOOM::Options->new();
562 $o->option(user => $user) if $user && $password;
563 $o->option(password => $password) if $user && $password;
564 $o->option(async => 1) if $async;
565 $o->option(cqlfile=> _common_config($server, 'server')->{cql2rpn});
566 $o->option(cclfile=> $serverinfo->{ccl2rpn});
567 $o->option(preferredRecordSyntax => $syntax);
568 $o->option(elementSetName => $elementSetName) if $elementSetName;
569 $o->option(databaseName => _common_config($server, 'config') || 'biblios');
571 # create a new connection object
572 $Zconn= create ZOOM::Connection($o);
575 $Zconn->connect($host, 0);
577 # check for errors and warn
578 if ($Zconn->errcode() !=0) {
579 warn "something wrong with the connection: ". $Zconn->errmsg();
586 # Internal helper function (not a method!). This creates a new
587 # database connection from the data given in the current context, and
592 Koha::Database->schema({ new => 1 })->storage->dbh;
597 $dbh = C4::Context->dbh;
599 Returns a database handle connected to the Koha database for the
600 current context. If no connection has yet been made, this method
601 creates one, and connects to the database.
603 This database handle is cached for future use: if you call
604 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
605 times. If you need a second database handle, use C<&new_dbh> and
606 possibly C<&set_dbh>.
616 unless ( $params->{new} ) {
617 return Koha::Database->schema->storage->dbh;
620 return Koha::Database->schema({ new => 1 })->storage->dbh;
625 $dbh = C4::Context->new_dbh;
627 Creates a new connection to the Koha database for the current context,
628 and returns the database handle (a C<DBI::db> object).
630 The handle is not saved anywhere: this method is strictly a
631 convenience function; the point is that it knows which database to
632 connect to so that the caller doesn't have to know.
641 return &dbh({ new => 1 });
646 $my_dbh = C4::Connect->new_dbh;
647 C4::Connect->set_dbh($my_dbh);
649 C4::Connect->restore_dbh;
651 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
652 C<&set_context> and C<&restore_context>.
654 C<&set_dbh> saves the current database handle on a stack, then sets
655 the current database handle to C<$my_dbh>.
657 C<$my_dbh> is assumed to be a good database handle.
667 # Save the current database handle on the handle stack.
668 # We assume that $new_dbh is all good: if the caller wants to
669 # screw himself by passing an invalid handle, that's fine by
671 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
672 $context->{"dbh"} = $new_dbh;
677 C4::Context->restore_dbh;
679 Restores the database handle saved by an earlier call to
680 C<C4::Context-E<gt>set_dbh>.
689 if ($#{$context->{"dbh_stack"}} < 0)
692 die "DBH stack underflow";
695 # Pop the old database handle and set it.
696 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
698 # FIXME - If it is determined that restore_context should
699 # return something, then this function should, too.
704 C4::Context->userenv;
706 Retrieves a hash for user environment variables.
708 This hash shall be cached for future use: if you call
709 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
715 my $var = $context->{"activeuser"};
716 if (defined $var and defined $context->{"userenv"}->{$var}) {
717 return $context->{"userenv"}->{$var};
725 C4::Context->set_userenv($usernum, $userid, $usercnum,
726 $userfirstname, $usersurname,
727 $userbranch, $branchname, $userflags,
728 $emailaddress, $shibboleth
729 $desk_id, $desk_name,
730 $register_id, $register_name);
732 Establish a hash of user environment variables.
734 set_userenv is called in Auth.pm
742 $usernum, $userid, $usercnum, $userfirstname,
743 $usersurname, $userbranch, $branchname, $userflags,
744 $emailaddress, $shibboleth, $desk_id, $desk_name,
745 $register_id, $register_name
748 my $var=$context->{"activeuser"} || '';
750 "number" => $usernum,
752 "cardnumber" => $usercnum,
753 "firstname" => $userfirstname,
754 "surname" => $usersurname,
756 #possibly a law problem
757 "branch" => $userbranch,
758 "branchname" => $branchname,
759 "flags" => $userflags,
760 "emailaddress" => $emailaddress,
761 "shibboleth" => $shibboleth,
762 "desk_id" => $desk_id,
763 "desk_name" => $desk_name,
764 "register_id" => $register_id,
765 "register_name" => $register_name
767 $context->{userenv}->{$var} = $cell;
773 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
775 Builds a hash for user environment variables.
777 This hash shall be cached for future use: if you call
778 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
780 _new_userenv is called in Auth.pm
787 shift; # Useless except it compensates for bad calling style
789 $context->{"activeuser"}=$sessionID;
792 =head2 _unset_userenv
794 C4::Context->_unset_userenv;
796 Destroys the hash for activeuser user environment variables.
805 undef $context->{activeuser} if $sessionID && $context->{activeuser} && $context->{activeuser} eq $sessionID;
811 C4::Context->get_versions
813 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'.
819 # A little example sub to show more debugging info for CGI::Carp
822 $versions{kohaVersion} = Koha::version();
823 $versions{kohaDbVersion} = C4::Context->preference('version');
824 $versions{osVersion} = join(" ", POSIX::uname());
825 $versions{perlVersion} = $];
827 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
828 $versions{mysqlVersion} = `mysql -V`;
829 $versions{apacheVersion} = (`apache2ctl -v`)[0];
830 $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
831 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
832 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
833 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
842 Returns a DateTime::TimeZone object for the system timezone
848 if (!defined $context->{tz}) {
849 my $timezone = $context->{config}->timezone;
850 $context->{tz} = DateTime::TimeZone->new(name => $timezone);
852 return $context->{tz};
856 =head2 IsSuperLibrarian
858 C4::Context->IsSuperLibrarian();
862 sub IsSuperLibrarian {
863 my $userenv = C4::Context->userenv;
865 unless ( $userenv and exists $userenv->{flags} ) {
866 # If we reach this without a user environment,
867 # assume that we're running from a command-line script,
868 # and act as a superlibrarian.
869 carp("C4::Context->userenv not defined!");
873 return ($userenv->{flags}//0) % 2;
878 Sets the current interface for later retrieval in any Perl module
880 C4::Context->interface('opac');
881 C4::Context->interface('intranet');
882 my $interface = C4::Context->interface;
887 my ($class, $interface) = @_;
889 if (defined $interface) {
890 $interface = lc $interface;
891 if ( $interface eq 'api'
892 || $interface eq 'opac'
893 || $interface eq 'intranet'
894 || $interface eq 'sip'
895 || $interface eq 'cron'
896 || $interface eq 'commandline' )
898 $context->{interface} = $interface;
900 warn "invalid interface : '$interface'";
904 return $context->{interface} // 'opac';
907 # always returns a string for OK comparison via "eq" or "ne"
909 C4::Context->userenv or return '';
910 return C4::Context->userenv->{branch} || '';
913 =head2 only_my_library
915 my $test = C4::Context->only_my_library;
917 Returns true if you enabled IndependentBranches and the current user
918 does not have superlibrarian permissions.
922 sub only_my_library {
924 C4::Context->preference('IndependentBranches')
925 && C4::Context->userenv
926 && !C4::Context->IsSuperLibrarian()
927 && C4::Context->userenv->{branch};
930 =head3 temporary_directory
932 Returns root directory for temporary storage
936 sub temporary_directory {
938 return C4::Context->config('tmp_path') || File::Spec->tmpdir;
941 =head3 set_remote_address
943 set_remote_address should be called at the beginning of every script
944 that is *not* running under plack in order to the REMOTE_ADDR environment
945 variable to be set correctly.
949 sub set_remote_address {
950 if ( C4::Context->config('koha_trusted_proxies') ) {
952 my $header = CGI->http('HTTP_X_FORWARDED_FOR');
955 require Koha::Middleware::RealIP;
956 $ENV{REMOTE_ADDR} = Koha::Middleware::RealIP::get_real_ip( $ENV{REMOTE_ADDR}, $header );
963 https_enabled should be called when checking if a HTTPS connection
966 Note that this depends on a HTTPS environmental variable being defined
967 by the web server. This function may not return the expected result,
968 if your web server or reverse proxies are not setting the correct
969 X-Forwarded-Proto headers and HTTPS environmental variable.
971 Note too that the HTTPS value can vary from web server to web server.
972 We are relying on the convention of the value being "on" or "ON" here.
977 my $https_enabled = 0;
978 my $env_https = $ENV{HTTPS};
980 if ($env_https =~ /^ON$/i){
984 return $https_enabled;
991 if ( $context->needs_install ) { ... }
993 This method returns a boolean representing the install status of the Koha instance.
999 return ($self->preference('Version')) ? 0 : 1;
1002 =head3 is_psgi_or_plack
1004 is_psgi_or_plack returns true if there is an environmental variable
1005 prefixed with "psgi" or "plack". This is useful for detecting whether
1006 this is a PSGI app or a CGI app, and implementing code as appropriate.
1010 sub is_psgi_or_plack {
1011 my $is_psgi_or_plack = 0;
1012 if ( any { /(^psgi\.|^plack\.)/i } keys %ENV ) {
1013 $is_psgi_or_plack = 1;
1015 return $is_psgi_or_plack;
1018 =head3 is_internal_PSGI_request
1020 is_internal_PSGI_request is used to detect if this request was made
1021 from within the individual PSGI app or externally from the mounted PSGI
1026 #NOTE: This is not a very robust method but it's the best we have so far
1027 sub is_internal_PSGI_request {
1028 my $is_internal = 0;
1029 if ( (__PACKAGE__->is_psgi_or_plack) && ( $ENV{REQUEST_URI} !~ /^(\/intranet|\/opac)/ ) ){
1032 return $is_internal;
1041 Specifies the configuration file to read.
1045 Andrew Arensburger <arensb at ooblick dot com>
1047 Joshua Ferraro <jmf at liblime dot com>