C4/Context.pm

   1 package C4::Context;
   2 # Copyright 2002 Katipo Communications
   3 #
   4 # This file is part of Koha.
   5 #
   6 # Koha is free software; you can redistribute it and/or modify it
   7 # under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # Koha is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  18
  19 use strict;
  20 use warnings;
  21 use vars qw($AUTOLOAD $context @context_stack $servers $memcached $ismemcached);
  22 BEGIN {
  23         if ($ENV{'HTTP_USER_AGENT'})    {
  24                 require CGI::Carp;
  25         # FIXME for future reference, CGI::Carp doc says
  26         #  "Note that fatalsToBrowser does not work with mod_perl version 2.0 and higher."
  27                 import CGI::Carp qw(fatalsToBrowser);
  28                         sub handle_errors {
  29                             my $msg = shift;
  30                             my $debug_level;
  31                             eval {C4::Context->dbh();};
  32                             if ($@){
  33                                 $debug_level = 1;
  34                             }
  35                             else {
  36                                 $debug_level =  C4::Context->preference("DebugLevel");
  37                             }
  38
  39                 print q(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  40                             "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  41                        <html lang="en" xml:lang="en"  xmlns="http://www.w3.org/1999/xhtml">
  42                        <head><title>Koha Error</title></head>
  43                        <body>
  44                 );
  45                                 if ($debug_level eq "2"){
  46                                         # debug 2 , print extra info too.
  47                                         my %versions = get_versions();
  48
  49                 # a little example table with various version info";
  50                                         print "
  51                                                 <h1>Koha error</h1>
  52                                                 <p>The following fatal error has occurred:</p>
  53                         <pre><code>$msg</code></pre>
  54                                                 <table>
  55                                                 <tr><th>Apache</th><td>  $versions{apacheVersion}</td></tr>
  56                                                 <tr><th>Koha</th><td>    $versions{kohaVersion}</td></tr>
  57                                                 <tr><th>Koha DB</th><td> $versions{kohaDbVersion}</td></tr>
  58                                                 <tr><th>MySQL</th><td>   $versions{mysqlVersion}</td></tr>
  59                                                 <tr><th>OS</th><td>      $versions{osVersion}</td></tr>
  60                                                 <tr><th>Perl</th><td>    $versions{perlVersion}</td></tr>
  61                                                 </table>";
  62
  63                                 } elsif ($debug_level eq "1"){
  64                                         print "
  65                                                 <h1>Koha error</h1>
  66                                                 <p>The following fatal error has occurred:</p>
  67                         <pre><code>$msg</code></pre>";
  68                                 } else {
  69                                         print "<p>production mode - trapped fatal error</p>";
  70                                 }
  71                 print "</body></html>";
  72                         }
  73                 #CGI::Carp::set_message(\&handle_errors);
  74                 ## give a stack backtrace if KOHA_BACKTRACES is set
  75                 ## can't rely on DebugLevel for this, as we're not yet connected
  76                 if ($ENV{KOHA_BACKTRACES}) {
  77                         $main::SIG{__DIE__} = \&CGI::Carp::confess;
  78                 }
  79
  80         # Redefine multi_param if cgi version is < 4.08
  81         # Remove the "CGI::param called in list context" warning in this case
  82         if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {
  83             no warnings 'redefine';
  84             *CGI::multi_param = \&CGI::param;
  85             use warnings 'redefine';
  86             $CGI::LIST_CONTEXT_WARN = 0;
  87         }
  88     }   # else there is no browser to send fatals to!
  89
  90     # Check if there are memcached servers set
  91     $servers = $ENV{'MEMCACHED_SERVERS'};
  92     if ($servers) {
  93         # Load required libraries and create the memcached object
  94         require Cache::Memcached;
  95         $memcached = Cache::Memcached->new({
  96         servers => [ $servers ],
  97         debug   => 0,
  98         compress_threshold => 10_000,
  99         expire_time => 600,
 100         namespace => $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
 101     });
 102         # Verify memcached available (set a variable and test the output)
 103     $ismemcached = $memcached->set('ismemcached','1');
 104     }
 105
 106 }
 107
 108 use Encode;
 109 use ZOOM;
 110 use XML::Simple;
 111 use Koha::Cache;
 112 use POSIX ();
 113 use DateTime::TimeZone;
 114 use Module::Load::Conditional qw(can_load);
 115 use Carp;
 116
 117 use C4::Boolean;
 118 use C4::Debug;
 119 use Koha;
 120 use Koha::Config::SysPref;
 121 use Koha::Config::SysPrefs;
 122
 123 =head1 NAME
 124
 125 C4::Context - Maintain and manipulate the context of a Koha script
 126
 127 =head1 SYNOPSIS
 128
 129   use C4::Context;
 130
 131   use C4::Context("/path/to/koha-conf.xml");
 132
 133   $config_value = C4::Context->config("config_variable");
 134
 135   $koha_preference = C4::Context->preference("preference");
 136
 137   $db_handle = C4::Context->dbh;
 138
 139   $Zconn = C4::Context->Zconn;
 140
 141 =head1 DESCRIPTION
 142
 143 When a Koha script runs, it makes use of a certain number of things:
 144 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
 145 databases, and so forth. These things make up the I<context> in which
 146 the script runs.
 147
 148 This module takes care of setting up the context for a script:
 149 figuring out which configuration file to load, and loading it, opening
 150 a connection to the right database, and so forth.
 151
 152 Most scripts will only use one context. They can simply have
 153
 154   use C4::Context;
 155
 156 at the top.
 157
 158 Other scripts may need to use several contexts. For instance, if a
 159 library has two databases, one for a certain collection, and the other
 160 for everything else, it might be necessary for a script to use two
 161 different contexts to search both databases. Such scripts should use
 162 the C<&set_context> and C<&restore_context> functions, below.
 163
 164 By default, C4::Context reads the configuration from
 165 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
 166 environment variable to the pathname of a configuration file to use.
 167
 168 =head1 METHODS
 169
 170 =cut
 171
 172 #'
 173 # In addition to what is said in the POD above, a Context object is a
 174 # reference-to-hash with the following fields:
 175 #
 176 # config
 177 #    A reference-to-hash whose keys and values are the
 178 #    configuration variables and values specified in the config
 179 #    file (/etc/koha/koha-conf.xml).
 180 # dbh
 181 #    A handle to the appropriate database for this context.
 182 # dbh_stack
 183 #    Used by &set_dbh and &restore_dbh to hold other database
 184 #    handles for this context.
 185 # Zconn
 186 #     A connection object for the Zebra server
 187
 188 # Koha's main configuration file koha-conf.xml
 189 # is searched for according to this priority list:
 190 #
 191 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
 192 # 2. Path supplied in KOHA_CONF environment variable.
 193 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
 194 #    as value has changed from its default of
 195 #    '__KOHA_CONF_DIR__/koha-conf.xml', as happens
 196 #    when Koha is installed in 'standard' or 'single'
 197 #    mode.
 198 # 4. Path supplied in CONFIG_FNAME.
 199 #
 200 # The first entry that refers to a readable file is used.
 201
 202 use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
 203                 # Default config file, if none is specified
 204
 205 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
 206                 # path to config file set by installer
 207                 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
 208                 # when Koha is installed in 'standard' or 'single'
 209                 # mode.  If Koha was installed in 'dev' mode,
 210                 # __KOHA_CONF_DIR__ is *not* rewritten; instead
 211                 # developers should set the KOHA_CONF environment variable
 212
 213 $context = undef;        # Initially, no context is set
 214 @context_stack = ();        # Initially, no saved contexts
 215
 216
 217 =head2 read_config_file
 218
 219 Reads the specified Koha config file.
 220
 221 Returns an object containing the configuration variables. The object's
 222 structure is a bit complex to the uninitiated ... take a look at the
 223 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
 224 here are a few examples that may give you what you need:
 225
 226 The simple elements nested within the <config> element:
 227
 228     my $pass = $koha->{'config'}->{'pass'};
 229
 230 The <listen> elements:
 231
 232     my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
 233
 234 The elements nested within the <server> element:
 235
 236     my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
 237
 238 Returns undef in case of error.
 239
 240 =cut
 241
 242 sub read_config_file {          # Pass argument naming config file to read
 243     my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo'], suppressempty => '');
 244
 245     if ($ismemcached) {
 246       $memcached->set('kohaconf',$koha);
 247     }
 248
 249     return $koha;                       # Return value: ref-to-hash holding the configuration
 250 }
 251
 252 =head2 ismemcached
 253
 254 Returns the value of the $ismemcached variable (0/1)
 255
 256 =cut
 257
 258 sub ismemcached {
 259     return $ismemcached;
 260 }
 261
 262 =head2 memcached
 263
 264 If $ismemcached is true, returns the $memcache variable.
 265 Returns undef otherwise
 266
 267 =cut
 268
 269 sub memcached {
 270     if ($ismemcached) {
 271       return $memcached;
 272     } else {
 273       return;
 274     }
 275 }
 276
 277 =head2 db_scheme2dbi
 278
 279     my $dbd_driver_name = C4::Context::db_schema2dbi($scheme);
 280
 281 This routines translates a database type to part of the name
 282 of the appropriate DBD driver to use when establishing a new
 283 database connection.  It recognizes 'mysql' and 'Pg'; if any
 284 other scheme is supplied it defaults to 'mysql'.
 285
 286 =cut
 287
 288 sub db_scheme2dbi {
 289     my $scheme = shift // '';
 290     return $scheme eq 'Pg' ? $scheme : 'mysql';
 291 }
 292
 293 sub import {
 294     # Create the default context ($C4::Context::Context)
 295     # the first time the module is called
 296     # (a config file can be optionaly passed)
 297
 298     # default context already exists?
 299     return if $context;
 300
 301     # no ? so load it!
 302     my ($pkg,$config_file) = @_ ;
 303     my $new_ctx = __PACKAGE__->new($config_file);
 304     return unless $new_ctx;
 305
 306     # if successfully loaded, use it by default
 307     $new_ctx->set_context;
 308     1;
 309 }
 310
 311 =head2 new
 312
 313   $context = new C4::Context;
 314   $context = new C4::Context("/path/to/koha-conf.xml");
 315
 316 Allocates a new context. Initializes the context from the specified
 317 file, which defaults to either the file given by the C<$KOHA_CONF>
 318 environment variable, or F</etc/koha/koha-conf.xml>.
 319
 320 It saves the koha-conf.xml values in the declared memcached server(s)
 321 if currently available and uses those values until them expire and
 322 re-reads them.
 323
 324 C<&new> does not set this context as the new default context; for
 325 that, use C<&set_context>.
 326
 327 =cut
 328
 329 #'
 330 # Revision History:
 331 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
 332 sub new {
 333     my $class = shift;
 334     my $conf_fname = shift;        # Config file to load
 335     my $self = {};
 336
 337     # check that the specified config file exists and is not empty
 338     undef $conf_fname unless
 339         (defined $conf_fname && -s $conf_fname);
 340     # Figure out a good config file to load if none was specified.
 341     if (!defined($conf_fname))
 342     {
 343         # If the $KOHA_CONF environment variable is set, use
 344         # that. Otherwise, use the built-in default.
 345         if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s  $ENV{"KOHA_CONF"}) {
 346             $conf_fname = $ENV{"KOHA_CONF"};
 347         } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
 348             # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
 349             # regex to anything else -- don't want installer to rewrite it
 350             $conf_fname = $INSTALLED_CONFIG_FNAME;
 351         } elsif (-s CONFIG_FNAME) {
 352             $conf_fname = CONFIG_FNAME;
 353         } else {
 354             warn "unable to locate Koha configuration file koha-conf.xml";
 355             return;
 356         }
 357     }
 358
 359     if ($ismemcached) {
 360         # retrieve from memcached
 361         $self = $memcached->get('kohaconf');
 362         if (not defined $self) {
 363             # not in memcached yet
 364             $self = read_config_file($conf_fname);
 365         }
 366     } else {
 367         # non-memcached env, read from file
 368         $self = read_config_file($conf_fname);
 369     }
 370
 371     $self->{"config_file"} = $conf_fname;
 372     warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
 373     return if !defined($self->{"config"});
 374
 375     $self->{"Zconn"} = undef;    # Zebra Connections
 376     $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
 377     $self->{"userenv"} = undef;        # User env
 378     $self->{"activeuser"} = undef;        # current active user
 379     $self->{"shelves"} = undef;
 380     $self->{tz} = undef; # local timezone object
 381
 382     bless $self, $class;
 383     $self->{db_driver} = db_scheme2dbi($self->config('db_scheme'));  # cache database driver
 384     return $self;
 385 }
 386
 387 =head2 set_context
 388
 389   $context = new C4::Context;
 390   $context->set_context();
 391 or
 392   set_context C4::Context $context;
 393
 394   ...
 395   restore_context C4::Context;
 396
 397 In some cases, it might be necessary for a script to use multiple
 398 contexts. C<&set_context> saves the current context on a stack, then
 399 sets the context to C<$context>, which will be used in future
 400 operations. To restore the previous context, use C<&restore_context>.
 401
 402 =cut
 403
 404 #'
 405 sub set_context
 406 {
 407     my $self = shift;
 408     my $new_context;    # The context to set
 409
 410     # Figure out whether this is a class or instance method call.
 411     #
 412     # We're going to make the assumption that control got here
 413     # through valid means, i.e., that the caller used an instance
 414     # or class method call, and that control got here through the
 415     # usual inheritance mechanisms. The caller can, of course,
 416     # break this assumption by playing silly buggers, but that's
 417     # harder to do than doing it properly, and harder to check
 418     # for.
 419     if (ref($self) eq "")
 420     {
 421         # Class method. The new context is the next argument.
 422         $new_context = shift;
 423     } else {
 424         # Instance method. The new context is $self.
 425         $new_context = $self;
 426     }
 427
 428     # Save the old context, if any, on the stack
 429     push @context_stack, $context if defined($context);
 430
 431     # Set the new context
 432     $context = $new_context;
 433 }
 434
 435 =head2 restore_context
 436
 437   &restore_context;
 438
 439 Restores the context set by C<&set_context>.
 440
 441 =cut
 442
 443 #'
 444 sub restore_context
 445 {
 446     my $self = shift;
 447
 448     if ($#context_stack < 0)
 449     {
 450         # Stack underflow.
 451         die "Context stack underflow";
 452     }
 453
 454     # Pop the old context and set it.
 455     $context = pop @context_stack;
 456
 457     # FIXME - Should this return something, like maybe the context
 458     # that was current when this was called?
 459 }
 460
 461 =head2 config
 462
 463   $value = C4::Context->config("config_variable");
 464
 465   $value = C4::Context->config_variable;
 466
 467 Returns the value of a variable specified in the configuration file
 468 from which the current context was created.
 469
 470 The second form is more compact, but of course may conflict with
 471 method names. If there is a configuration variable called "new", then
 472 C<C4::Config-E<gt>new> will not return it.
 473
 474 =cut
 475
 476 sub _common_config {
 477         my $var = shift;
 478         my $term = shift;
 479     return if !defined($context->{$term});
 480        # Presumably $self->{$term} might be
 481        # undefined if the config file given to &new
 482        # didn't exist, and the caller didn't bother
 483        # to check the return value.
 484
 485     # Return the value of the requested config variable
 486     return $context->{$term}->{$var};
 487 }
 488
 489 sub config {
 490         return _common_config($_[1],'config');
 491 }
 492 sub zebraconfig {
 493         return _common_config($_[1],'server');
 494 }
 495 sub ModZebrations {
 496         return _common_config($_[1],'serverinfo');
 497 }
 498
 499 =head2 preference
 500
 501   $sys_preference = C4::Context->preference('some_variable');
 502
 503 Looks up the value of the given system preference in the
 504 systempreferences table of the Koha database, and returns it. If the
 505 variable is not set or does not exist, undef is returned.
 506
 507 In case of an error, this may return 0.
 508
 509 Note: It is impossible to tell the difference between system
 510 preferences which do not exist, and those whose values are set to NULL
 511 with this method.
 512
 513 =cut
 514
 515 my $syspref_cache = Koha::Cache->get_instance();
 516 my %syspref_L1_cache;
 517 my $use_syspref_cache = 1;
 518 sub preference {
 519     my $self = shift;
 520     my $var  = shift;    # The system preference to return
 521
 522     $var = lc $var;
 523
 524     # Return the value if the var has already been accessed
 525     if ($use_syspref_cache && exists $syspref_L1_cache{$var}) {
 526         return $syspref_L1_cache{$var};
 527     }
 528
 529     my $cached_var = $use_syspref_cache
 530         ? $syspref_cache->get_from_cache("syspref_$var")
 531         : undef;
 532     return $cached_var if defined $cached_var;
 533
 534     my $value;
 535     if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
 536         $value = $ENV{"OVERRIDE_SYSPREF_$var"};
 537     } else {
 538         my $syspref;
 539         eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
 540         $value = $syspref ? $syspref->value() : undef;
 541     }
 542
 543     if ( $use_syspref_cache ) {
 544         $syspref_cache->set_in_cache("syspref_$var", $value);
 545         $syspref_L1_cache{$var} = $value;
 546     }
 547     return $value;
 548 }
 549
 550 sub boolean_preference {
 551     my $self = shift;
 552     my $var = shift;        # The system preference to return
 553     my $it = preference($self, $var);
 554     return defined($it)? C4::Boolean::true_p($it): undef;
 555 }
 556
 557 =head2 enable_syspref_cache
 558
 559   C4::Context->enable_syspref_cache();
 560
 561 Enable the in-memory syspref cache used by C4::Context. This is the
 562 default behavior.
 563
 564 =cut
 565
 566 sub enable_syspref_cache {
 567     my ($self) = @_;
 568     $use_syspref_cache = 1;
 569     # We need to clear the cache to have it up-to-date
 570     $self->clear_syspref_cache();
 571 }
 572
 573 =head2 disable_syspref_cache
 574
 575   C4::Context->disable_syspref_cache();
 576
 577 Disable the in-memory syspref cache used by C4::Context. This should be
 578 used with Plack and other persistent environments.
 579
 580 =cut
 581
 582 sub disable_syspref_cache {
 583     my ($self) = @_;
 584     $use_syspref_cache = 0;
 585     $self->clear_syspref_cache();
 586 }
 587
 588 =head2 clear_syspref_cache
 589
 590   C4::Context->clear_syspref_cache();
 591
 592 cleans the internal cache of sysprefs. Please call this method if
 593 you update the systempreferences table. Otherwise, your new changes
 594 will not be seen by this process.
 595
 596 =cut
 597
 598 sub clear_syspref_cache {
 599     return unless $use_syspref_cache;
 600     $syspref_cache->flush_all;
 601     clear_syspref_L1_cache()
 602 }
 603
 604 sub clear_syspref_L1_cache {
 605     %syspref_L1_cache = ();
 606 }
 607
 608 =head2 set_preference
 609
 610   C4::Context->set_preference( $variable, $value, [ $explanation, $type, $options ] );
 611
 612 This updates a preference's value both in the systempreferences table and in
 613 the sysprefs cache. If the optional parameters are provided, then the query
 614 becomes a create. It won't update the parameters (except value) for an existing
 615 preference.
 616
 617 =cut
 618
 619 sub set_preference {
 620     my ( $self, $variable, $value, $explanation, $type, $options ) = @_;
 621
 622     $variable = lc $variable;
 623
 624     my $syspref = Koha::Config::SysPrefs->find($variable);
 625     $type =
 626         $type    ? $type
 627       : $syspref ? $syspref->type
 628       :            undef;
 629
 630     $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
 631
 632     # force explicit protocol on OPACBaseURL
 633     if ( $variable eq 'opacbaseurl' && substr( $value, 0, 4 ) !~ /http/ ) {
 634         $value = 'http://' . $value;
 635     }
 636
 637     if ($syspref) {
 638         $syspref->set(
 639             {   ( defined $value ? ( value       => $value )       : () ),
 640                 ( $explanation   ? ( explanation => $explanation ) : () ),
 641                 ( $type          ? ( type        => $type )        : () ),
 642                 ( $options       ? ( options     => $options )     : () ),
 643             }
 644         )->store;
 645     } else {
 646         $syspref = Koha::Config::SysPref->new(
 647             {   variable    => $variable,
 648                 value       => $value,
 649                 explanation => $explanation || undef,
 650                 type        => $type,
 651                 options     => $options || undef,
 652             }
 653         )->store();
 654     }
 655
 656     if ( $use_syspref_cache ) {
 657         $syspref_cache->set_in_cache( "syspref_$variable", $value );
 658         $syspref_L1_cache{$variable} = $value;
 659     }
 660
 661     return $syspref;
 662 }
 663
 664 =head2 delete_preference
 665
 666     C4::Context->delete_preference( $variable );
 667
 668 This deletes a system preference from the database. Returns a true value on
 669 success. Failure means there was an issue with the database, not that there
 670 was no syspref of the name.
 671
 672 =cut
 673
 674 sub delete_preference {
 675     my ( $self, $var ) = @_;
 676
 677     if ( Koha::Config::SysPrefs->find( $var )->delete ) {
 678         if ( $use_syspref_cache ) {
 679             $syspref_cache->clear_from_cache("syspref_$var");
 680             delete $syspref_L1_cache{$var};
 681         }
 682
 683         return 1;
 684     }
 685     return 0;
 686 }
 687
 688 =head2 Zconn
 689
 690   $Zconn = C4::Context->Zconn
 691
 692 Returns a connection to the Zebra database
 693
 694 C<$self>
 695
 696 C<$server> one of the servers defined in the koha-conf.xml file
 697
 698 C<$async> whether this is a asynchronous connection
 699
 700 =cut
 701
 702 sub Zconn {
 703     my ($self, $server, $async ) = @_;
 704     my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
 705     if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
 706         # if we are running the script from the commandline, lets try to use the caching
 707         return $context->{"Zconn"}->{$cache_key};
 708     }
 709     $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
 710     $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
 711     return $context->{"Zconn"}->{$cache_key};
 712 }
 713
 714 =head2 _new_Zconn
 715
 716 $context->{"Zconn"} = &_new_Zconn($server,$async);
 717
 718 Internal function. Creates a new database connection from the data given in the current context and returns it.
 719
 720 C<$server> one of the servers defined in the koha-conf.xml file
 721
 722 C<$async> whether this is a asynchronous connection
 723
 724 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
 725
 726 =cut
 727
 728 sub _new_Zconn {
 729     my ( $server, $async ) = @_;
 730
 731     my $tried=0; # first attempt
 732     my $Zconn; # connection object
 733     my $elementSetName;
 734     my $index_mode;
 735     my $syntax;
 736
 737     $server //= "biblioserver";
 738
 739     if ( $server eq 'biblioserver' ) {
 740         $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
 741     } elsif ( $server eq 'authorityserver' ) {
 742         $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
 743     }
 744
 745     if ( $index_mode eq 'grs1' ) {
 746         $elementSetName = 'F';
 747         $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
 748                 ? 'unimarc'
 749                 : 'usmarc';
 750
 751     } else { # $index_mode eq 'dom'
 752         $syntax = 'xml';
 753         $elementSetName = 'marcxml';
 754     }
 755
 756     my $host = $context->{'listen'}->{$server}->{'content'};
 757     my $user = $context->{"serverinfo"}->{$server}->{"user"};
 758     my $password = $context->{"serverinfo"}->{$server}->{"password"};
 759     eval {
 760         # set options
 761         my $o = new ZOOM::Options();
 762         $o->option(user => $user) if $user && $password;
 763         $o->option(password => $password) if $user && $password;
 764         $o->option(async => 1) if $async;
 765         $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
 766         $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
 767         $o->option(preferredRecordSyntax => $syntax);
 768         $o->option(elementSetName => $elementSetName) if $elementSetName;
 769         $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
 770
 771         # create a new connection object
 772         $Zconn= create ZOOM::Connection($o);
 773
 774         # forge to server
 775         $Zconn->connect($host, 0);
 776
 777         # check for errors and warn
 778         if ($Zconn->errcode() !=0) {
 779             warn "something wrong with the connection: ". $Zconn->errmsg();
 780         }
 781     };
 782     return $Zconn;
 783 }
 784
 785 # _new_dbh
 786 # Internal helper function (not a method!). This creates a new
 787 # database connection from the data given in the current context, and
 788 # returns it.
 789 sub _new_dbh
 790 {
 791
 792     Koha::Database->schema({ new => 1 })->storage->dbh;
 793 }
 794
 795 =head2 dbh
 796
 797   $dbh = C4::Context->dbh;
 798
 799 Returns a database handle connected to the Koha database for the
 800 current context. If no connection has yet been made, this method
 801 creates one, and connects to the database.
 802
 803 This database handle is cached for future use: if you call
 804 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
 805 times. If you need a second database handle, use C<&new_dbh> and
 806 possibly C<&set_dbh>.
 807
 808 =cut
 809
 810 #'
 811 sub dbh
 812 {
 813     my $self = shift;
 814     my $params = shift;
 815     my $sth;
 816
 817     unless ( $params->{new} ) {
 818         return Koha::Database->schema->storage->dbh;
 819     }
 820
 821     return Koha::Database->schema({ new => 1 })->storage->dbh;
 822 }
 823
 824 =head2 new_dbh
 825
 826   $dbh = C4::Context->new_dbh;
 827
 828 Creates a new connection to the Koha database for the current context,
 829 and returns the database handle (a C<DBI::db> object).
 830
 831 The handle is not saved anywhere: this method is strictly a
 832 convenience function; the point is that it knows which database to
 833 connect to so that the caller doesn't have to know.
 834
 835 =cut
 836
 837 #'
 838 sub new_dbh
 839 {
 840     my $self = shift;
 841
 842     return &dbh({ new => 1 });
 843 }
 844
 845 =head2 set_dbh
 846
 847   $my_dbh = C4::Connect->new_dbh;
 848   C4::Connect->set_dbh($my_dbh);
 849   ...
 850   C4::Connect->restore_dbh;
 851
 852 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
 853 C<&set_context> and C<&restore_context>.
 854
 855 C<&set_dbh> saves the current database handle on a stack, then sets
 856 the current database handle to C<$my_dbh>.
 857
 858 C<$my_dbh> is assumed to be a good database handle.
 859
 860 =cut
 861
 862 #'
 863 sub set_dbh
 864 {
 865     my $self = shift;
 866     my $new_dbh = shift;
 867
 868     # Save the current database handle on the handle stack.
 869     # We assume that $new_dbh is all good: if the caller wants to
 870     # screw himself by passing an invalid handle, that's fine by
 871     # us.
 872     push @{$context->{"dbh_stack"}}, $context->{"dbh"};
 873     $context->{"dbh"} = $new_dbh;
 874 }
 875
 876 =head2 restore_dbh
 877
 878   C4::Context->restore_dbh;
 879
 880 Restores the database handle saved by an earlier call to
 881 C<C4::Context-E<gt>set_dbh>.
 882
 883 =cut
 884
 885 #'
 886 sub restore_dbh
 887 {
 888     my $self = shift;
 889
 890     if ($#{$context->{"dbh_stack"}} < 0)
 891     {
 892         # Stack underflow
 893         die "DBH stack underflow";
 894     }
 895
 896     # Pop the old database handle and set it.
 897     $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
 898
 899     # FIXME - If it is determined that restore_context should
 900     # return something, then this function should, too.
 901 }
 902
 903 =head2 queryparser
 904
 905   $queryparser = C4::Context->queryparser
 906
 907 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
 908
 909 =cut
 910
 911 sub queryparser {
 912     my $self = shift;
 913     unless (defined $context->{"queryparser"}) {
 914         $context->{"queryparser"} = &_new_queryparser();
 915     }
 916
 917     return
 918       defined( $context->{"queryparser"} )
 919       ? $context->{"queryparser"}->new
 920       : undef;
 921 }
 922
 923 =head2 _new_queryparser
 924
 925 Internal helper function to create a new QueryParser object. QueryParser
 926 is loaded dynamically so as to keep the lack of the QueryParser library from
 927 getting in anyone's way.
 928
 929 =cut
 930
 931 sub _new_queryparser {
 932     my $qpmodules = {
 933         'OpenILS::QueryParser'           => undef,
 934         'Koha::QueryParser::Driver::PQF' => undef
 935     };
 936     if ( can_load( 'modules' => $qpmodules ) ) {
 937         my $QParser     = Koha::QueryParser::Driver::PQF->new();
 938         my $config_file = $context->config('queryparser_config');
 939         $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
 940         if ( $QParser->load_config($config_file) ) {
 941             # Set 'keyword' as the default search class
 942             $QParser->default_search_class('keyword');
 943             # TODO: allow indexes to be configured in the database
 944             return $QParser;
 945         }
 946     }
 947     return;
 948 }
 949
 950 =head2 marcfromkohafield
 951
 952   $dbh = C4::Context->marcfromkohafield;
 953
 954 Returns a hash with marcfromkohafield.
 955
 956 This hash is cached for future use: if you call
 957 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
 958
 959 =cut
 960
 961 #'
 962 sub marcfromkohafield
 963 {
 964     my $retval = {};
 965
 966     # If the hash already exists, return it.
 967     return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
 968
 969     # No hash. Create one.
 970     $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
 971
 972     return $context->{"marcfromkohafield"};
 973 }
 974
 975 # _new_marcfromkohafield
 976 sub _new_marcfromkohafield
 977 {
 978     my $dbh = C4::Context->dbh;
 979     my $marcfromkohafield;
 980     my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
 981     $sth->execute;
 982     while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
 983         my $retval = {};
 984         $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
 985     }
 986     return $marcfromkohafield;
 987 }
 988
 989 =head2 userenv
 990
 991   C4::Context->userenv;
 992
 993 Retrieves a hash for user environment variables.
 994
 995 This hash shall be cached for future use: if you call
 996 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 997
 998 =cut
 999
1000 #'
1001 sub userenv {
1002     my $var = $context->{"activeuser"};
1003     if (defined $var and defined $context->{"userenv"}->{$var}) {
1004         return $context->{"userenv"}->{$var};
1005     } else {
1006         return;
1007     }
1008 }
1009
1010 =head2 set_userenv
1011
1012   C4::Context->set_userenv($usernum, $userid, $usercnum,
1013                            $userfirstname, $usersurname,
1014                            $userbranch, $branchname, $userflags,
1015                            $emailaddress, $branchprinter, $persona);
1016
1017 Establish a hash of user environment variables.
1018
1019 set_userenv is called in Auth.pm
1020
1021 =cut
1022
1023 #'
1024 sub set_userenv {
1025     shift @_;
1026     my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
1027     map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
1028     @_;
1029     my $var=$context->{"activeuser"} || '';
1030     my $cell = {
1031         "number"     => $usernum,
1032         "id"         => $userid,
1033         "cardnumber" => $usercnum,
1034         "firstname"  => $userfirstname,
1035         "surname"    => $usersurname,
1036         #possibly a law problem
1037         "branch"     => $userbranch,
1038         "branchname" => $branchname,
1039         "flags"      => $userflags,
1040         "emailaddress"     => $emailaddress,
1041         "branchprinter"    => $branchprinter,
1042         "persona"    => $persona,
1043         "shibboleth" => $shibboleth,
1044     };
1045     $context->{userenv}->{$var} = $cell;
1046     return $cell;
1047 }
1048
1049 sub set_shelves_userenv {
1050         my ($type, $shelves) = @_ or return;
1051         my $activeuser = $context->{activeuser} or return;
1052         $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1053         $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1054         $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1055 }
1056
1057 sub get_shelves_userenv {
1058         my $active;
1059         unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1060                 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1061                 return;
1062         }
1063         my $totshelves = $active->{totshelves} or undef;
1064         my $pubshelves = $active->{pubshelves} or undef;
1065         my $barshelves = $active->{barshelves} or undef;
1066         return ($totshelves, $pubshelves, $barshelves);
1067 }
1068
1069 =head2 _new_userenv
1070
1071   C4::Context->_new_userenv($session);  # FIXME: This calling style is wrong for what looks like an _internal function
1072
1073 Builds a hash for user environment variables.
1074
1075 This hash shall be cached for future use: if you call
1076 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1077
1078 _new_userenv is called in Auth.pm
1079
1080 =cut
1081
1082 #'
1083 sub _new_userenv
1084 {
1085     shift;  # Useless except it compensates for bad calling style
1086     my ($sessionID)= @_;
1087      $context->{"activeuser"}=$sessionID;
1088 }
1089
1090 =head2 _unset_userenv
1091
1092   C4::Context->_unset_userenv;
1093
1094 Destroys the hash for activeuser user environment variables.
1095
1096 =cut
1097
1098 #'
1099
1100 sub _unset_userenv
1101 {
1102     my ($sessionID)= @_;
1103     undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1104 }
1105
1106
1107 =head2 get_versions
1108
1109   C4::Context->get_versions
1110
1111 Gets various version info, for core Koha packages, Currently called from carp handle_errors() sub, to send to browser if 'DebugLevel' syspref is set to '2'.
1112
1113 =cut
1114
1115 #'
1116
1117 # A little example sub to show more debugging info for CGI::Carp
1118 sub get_versions {
1119     my %versions;
1120     $versions{kohaVersion}  = Koha::version();
1121     $versions{kohaDbVersion} = C4::Context->preference('version');
1122     $versions{osVersion} = join(" ", POSIX::uname());
1123     $versions{perlVersion} = $];
1124     {
1125         no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1126         $versions{mysqlVersion}  = `mysql -V`;
1127         $versions{apacheVersion} = (`apache2ctl -v`)[0];
1128         $versions{apacheVersion} = `httpd -v`             unless  $versions{apacheVersion} ;
1129         $versions{apacheVersion} = `httpd2 -v`            unless  $versions{apacheVersion} ;
1130         $versions{apacheVersion} = `apache2 -v`           unless  $versions{apacheVersion} ;
1131         $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless  $versions{apacheVersion} ;
1132     }
1133     return %versions;
1134 }
1135
1136
1137 =head2 tz
1138
1139   C4::Context->tz
1140
1141   Returns a DateTime::TimeZone object for the system timezone
1142
1143 =cut
1144
1145 sub tz {
1146     my $self = shift;
1147     if (!defined $context->{tz}) {
1148         $context->{tz} = DateTime::TimeZone->new(name => 'local');
1149     }
1150     return $context->{tz};
1151 }
1152
1153
1154 =head2 IsSuperLibrarian
1155
1156     C4::Context->IsSuperLibrarian();
1157
1158 =cut
1159
1160 sub IsSuperLibrarian {
1161     my $userenv = C4::Context->userenv;
1162
1163     unless ( $userenv and exists $userenv->{flags} ) {
1164         # If we reach this without a user environment,
1165         # assume that we're running from a command-line script,
1166         # and act as a superlibrarian.
1167         carp("C4::Context->userenv not defined!");
1168         return 1;
1169     }
1170
1171     return ($userenv->{flags}//0) % 2;
1172 }
1173
1174 =head2 interface
1175
1176 Sets the current interface for later retrieval in any Perl module
1177
1178     C4::Context->interface('opac');
1179     C4::Context->interface('intranet');
1180     my $interface = C4::Context->interface;
1181
1182 =cut
1183
1184 sub interface {
1185     my ($class, $interface) = @_;
1186
1187     if (defined $interface) {
1188         $interface = lc $interface;
1189         if ($interface eq 'opac' || $interface eq 'intranet' || $interface eq 'sip' || $interface eq 'commandline') {
1190             $context->{interface} = $interface;
1191         } else {
1192             warn "invalid interface : '$interface'";
1193         }
1194     }
1195
1196     return $context->{interface} // 'opac';
1197 }
1198
1199 1;
1200 __END__
1201
1202 =head1 ENVIRONMENT
1203
1204 =head2 C<KOHA_CONF>
1205
1206 Specifies the configuration file to read.
1207
1208 =head1 SEE ALSO
1209
1210 XML::Simple
1211
1212 =head1 AUTHORS
1213
1214 Andrew Arensburger <arensb at ooblick dot com>
1215
1216 Joshua Ferraro <jmf at liblime dot com>
1217