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 $Zconn = C4::Context->Zconn
486 Returns a connection to the Zebra database
490 C<$server> one of the servers defined in the koha-conf.xml file
492 C<$async> whether this is a asynchronous connection
497 my ($self, $server, $async ) = @_;
498 my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
499 if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
500 # if we are running the script from the commandline, lets try to use the caching
501 return $context->{"Zconn"}->{$cache_key};
503 $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
504 $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
505 return $context->{"Zconn"}->{$cache_key};
510 $context->{"Zconn"} = &_new_Zconn($server,$async);
512 Internal function. Creates a new database connection from the data given in the current context and returns it.
514 C<$server> one of the servers defined in the koha-conf.xml file
516 C<$async> whether this is a asynchronous connection
518 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
523 my ( $server, $async ) = @_;
525 my $tried=0; # first attempt
526 my $Zconn; # connection object
530 $server //= "biblioserver";
533 $elementSetName = 'marcxml';
535 my $host = _common_config($server, 'listen')->{content};
536 my $serverinfo = _common_config($server, 'serverinfo');
537 my $user = $serverinfo->{user};
538 my $password = $serverinfo->{password};
541 my $o = ZOOM::Options->new();
542 $o->option(user => $user) if $user && $password;
543 $o->option(password => $password) if $user && $password;
544 $o->option(async => 1) if $async;
545 $o->option(cqlfile=> _common_config($server, 'server')->{cql2rpn});
546 $o->option(cclfile=> $serverinfo->{ccl2rpn});
547 $o->option(preferredRecordSyntax => $syntax);
548 $o->option(elementSetName => $elementSetName) if $elementSetName;
549 $o->option(databaseName => _common_config($server, 'config') || 'biblios');
551 # create a new connection object
552 $Zconn= create ZOOM::Connection($o);
555 $Zconn->connect($host, 0);
557 # check for errors and warn
558 if ($Zconn->errcode() !=0) {
559 warn "something wrong with the connection: ". $Zconn->errmsg();
566 # Internal helper function (not a method!). This creates a new
567 # database connection from the data given in the current context, and
572 Koha::Database->schema({ new => 1 })->storage->dbh;
577 $dbh = C4::Context->dbh;
579 Returns a database handle connected to the Koha database for the
580 current context. If no connection has yet been made, this method
581 creates one, and connects to the database.
583 This database handle is cached for future use: if you call
584 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
585 times. If you need a second database handle, use C<&new_dbh> and
586 possibly C<&set_dbh>.
596 unless ( $params->{new} ) {
597 return Koha::Database->schema->storage->dbh;
600 return Koha::Database->schema({ new => 1 })->storage->dbh;
605 $dbh = C4::Context->new_dbh;
607 Creates a new connection to the Koha database for the current context,
608 and returns the database handle (a C<DBI::db> object).
610 The handle is not saved anywhere: this method is strictly a
611 convenience function; the point is that it knows which database to
612 connect to so that the caller doesn't have to know.
621 return &dbh({ new => 1 });
626 $my_dbh = C4::Connect->new_dbh;
627 C4::Connect->set_dbh($my_dbh);
629 C4::Connect->restore_dbh;
631 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
632 C<&set_context> and C<&restore_context>.
634 C<&set_dbh> saves the current database handle on a stack, then sets
635 the current database handle to C<$my_dbh>.
637 C<$my_dbh> is assumed to be a good database handle.
647 # Save the current database handle on the handle stack.
648 # We assume that $new_dbh is all good: if the caller wants to
649 # screw himself by passing an invalid handle, that's fine by
651 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
652 $context->{"dbh"} = $new_dbh;
657 C4::Context->restore_dbh;
659 Restores the database handle saved by an earlier call to
660 C<C4::Context-E<gt>set_dbh>.
669 if ($#{$context->{"dbh_stack"}} < 0)
672 die "DBH stack underflow";
675 # Pop the old database handle and set it.
676 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
678 # FIXME - If it is determined that restore_context should
679 # return something, then this function should, too.
684 C4::Context->userenv;
686 Retrieves a hash for user environment variables.
688 This hash shall be cached for future use: if you call
689 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
695 my $var = $context->{"activeuser"};
696 if (defined $var and defined $context->{"userenv"}->{$var}) {
697 return $context->{"userenv"}->{$var};
705 C4::Context->set_userenv($usernum, $userid, $usercnum,
706 $userfirstname, $usersurname,
707 $userbranch, $branchname, $userflags,
708 $emailaddress, $shibboleth
709 $desk_id, $desk_name,
710 $register_id, $register_name);
712 Establish a hash of user environment variables.
714 set_userenv is called in Auth.pm
722 $usernum, $userid, $usercnum, $userfirstname,
723 $usersurname, $userbranch, $branchname, $userflags,
724 $emailaddress, $shibboleth, $desk_id, $desk_name,
725 $register_id, $register_name
728 my $var=$context->{"activeuser"} || '';
730 "number" => $usernum,
732 "cardnumber" => $usercnum,
733 "firstname" => $userfirstname,
734 "surname" => $usersurname,
736 #possibly a law problem
737 "branch" => $userbranch,
738 "branchname" => $branchname,
739 "flags" => $userflags,
740 "emailaddress" => $emailaddress,
741 "shibboleth" => $shibboleth,
742 "desk_id" => $desk_id,
743 "desk_name" => $desk_name,
744 "register_id" => $register_id,
745 "register_name" => $register_name
747 $context->{userenv}->{$var} = $cell;
753 C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
755 Builds a hash for user environment variables.
757 This hash shall be cached for future use: if you call
758 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
760 _new_userenv is called in Auth.pm
767 shift; # Useless except it compensates for bad calling style
769 $context->{"activeuser"}=$sessionID;
772 =head2 _unset_userenv
774 C4::Context->_unset_userenv;
776 Destroys the hash for activeuser user environment variables.
785 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
791 C4::Context->get_versions
793 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'.
799 # A little example sub to show more debugging info for CGI::Carp
802 $versions{kohaVersion} = Koha::version();
803 $versions{kohaDbVersion} = C4::Context->preference('version');
804 $versions{osVersion} = join(" ", POSIX::uname());
805 $versions{perlVersion} = $];
807 no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
808 $versions{mysqlVersion} = `mysql -V`;
809 $versions{apacheVersion} = (`apache2ctl -v`)[0];
810 $versions{apacheVersion} = `httpd -v` unless $versions{apacheVersion} ;
811 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
812 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
813 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
822 Returns a DateTime::TimeZone object for the system timezone
828 if (!defined $context->{tz}) {
829 my $timezone = $context->{config}->timezone;
830 $context->{tz} = DateTime::TimeZone->new(name => $timezone);
832 return $context->{tz};
836 =head2 IsSuperLibrarian
838 C4::Context->IsSuperLibrarian();
842 sub IsSuperLibrarian {
843 my $userenv = C4::Context->userenv;
845 unless ( $userenv and exists $userenv->{flags} ) {
846 # If we reach this without a user environment,
847 # assume that we're running from a command-line script,
848 # and act as a superlibrarian.
849 carp("C4::Context->userenv not defined!");
853 return ($userenv->{flags}//0) % 2;
858 Sets the current interface for later retrieval in any Perl module
860 C4::Context->interface('opac');
861 C4::Context->interface('intranet');
862 my $interface = C4::Context->interface;
867 my ($class, $interface) = @_;
869 if (defined $interface) {
870 $interface = lc $interface;
871 if ( $interface eq 'api'
872 || $interface eq 'opac'
873 || $interface eq 'intranet'
874 || $interface eq 'sip'
875 || $interface eq 'cron'
876 || $interface eq 'commandline' )
878 $context->{interface} = $interface;
880 warn "invalid interface : '$interface'";
884 return $context->{interface} // 'opac';
887 # always returns a string for OK comparison via "eq" or "ne"
889 C4::Context->userenv or return '';
890 return C4::Context->userenv->{branch} || '';
893 =head2 only_my_library
895 my $test = C4::Context->only_my_library;
897 Returns true if you enabled IndependentBranches and the current user
898 does not have superlibrarian permissions.
902 sub only_my_library {
904 C4::Context->preference('IndependentBranches')
905 && C4::Context->userenv
906 && !C4::Context->IsSuperLibrarian()
907 && C4::Context->userenv->{branch};
910 =head3 temporary_directory
912 Returns root directory for temporary storage
916 sub temporary_directory {
918 return C4::Context->config('tmp_path') || File::Spec->tmpdir;
921 =head3 set_remote_address
923 set_remote_address should be called at the beginning of every script
924 that is *not* running under plack in order to the REMOTE_ADDR environment
925 variable to be set correctly.
929 sub set_remote_address {
930 if ( C4::Context->config('koha_trusted_proxies') ) {
932 my $header = CGI->http('HTTP_X_FORWARDED_FOR');
935 require Koha::Middleware::RealIP;
936 $ENV{REMOTE_ADDR} = Koha::Middleware::RealIP::get_real_ip( $ENV{REMOTE_ADDR}, $header );
943 https_enabled should be called when checking if a HTTPS connection
946 Note that this depends on a HTTPS environmental variable being defined
947 by the web server. This function may not return the expected result,
948 if your web server or reverse proxies are not setting the correct
949 X-Forwarded-Proto headers and HTTPS environmental variable.
951 Note too that the HTTPS value can vary from web server to web server.
952 We are relying on the convention of the value being "on" or "ON" here.
957 my $https_enabled = 0;
958 my $env_https = $ENV{HTTPS};
960 if ($env_https =~ /^ON$/i){
964 return $https_enabled;
971 if ( $context->needs_install ) { ... }
973 This method returns a boolean representing the install status of the Koha instance.
979 return ($self->preference('Version')) ? 0 : 1;
982 =head3 is_psgi_or_plack
984 is_psgi_or_plack returns true if there is an environmental variable
985 prefixed with "psgi" or "plack". This is useful for detecting whether
986 this is a PSGI app or a CGI app, and implementing code as appropriate.
990 sub is_psgi_or_plack {
991 my $is_psgi_or_plack = 0;
992 if ( any { /(^psgi\.|^plack\.)/i } keys %ENV ) {
993 $is_psgi_or_plack = 1;
995 return $is_psgi_or_plack;
998 =head3 is_internal_PSGI_request
1000 is_internal_PSGI_request is used to detect if this request was made
1001 from within the individual PSGI app or externally from the mounted PSGI
1006 #NOTE: This is not a very robust method but it's the best we have so far
1007 sub is_internal_PSGI_request {
1008 my $is_internal = 0;
1009 if ( (__PACKAGE__->is_psgi_or_plack) && ( $ENV{REQUEST_URI} !~ /^(\/intranet|\/opac)/ ) ){
1012 return $is_internal;
1021 Specifies the configuration file to read.
1025 Andrew Arensburger <arensb at ooblick dot com>
1027 Joshua Ferraro <jmf at liblime dot com>