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($VERSION $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     $VERSION = '3.07.00.049';
 107 }
 108
 109 use DBIx::Connector;
 110 use Encode;
 111 use ZOOM;
 112 use XML::Simple;
 113 use C4::Boolean;
 114 use C4::Debug;
 115 use Koha;
 116 use POSIX ();
 117 use DateTime::TimeZone;
 118 use Module::Load::Conditional qw(can_load);
 119 use Carp;
 120
 121 =head1 NAME
 122
 123 C4::Context - Maintain and manipulate the context of a Koha script
 124
 125 =head1 SYNOPSIS
 126
 127   use C4::Context;
 128
 129   use C4::Context("/path/to/koha-conf.xml");
 130
 131   $config_value = C4::Context->config("config_variable");
 132
 133   $koha_preference = C4::Context->preference("preference");
 134
 135   $db_handle = C4::Context->dbh;
 136
 137   $Zconn = C4::Context->Zconn;
 138
 139   $stopwordhash = C4::Context->stopwords;
 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 allready 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         # retreive 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->{"dbh"} = undef;        # Database handle
 376     $self->{"Zconn"} = undef;    # Zebra Connections
 377     $self->{"stopwords"} = undef; # stopwords list
 378     $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
 379     $self->{"userenv"} = undef;        # User env
 380     $self->{"activeuser"} = undef;        # current active user
 381     $self->{"shelves"} = undef;
 382     $self->{tz} = undef; # local timezone object
 383
 384     bless $self, $class;
 385     $self->{db_driver} = db_scheme2dbi($self->config('db_scheme'));  # cache database driver
 386     return $self;
 387 }
 388
 389 =head2 set_context
 390
 391   $context = new C4::Context;
 392   $context->set_context();
 393 or
 394   set_context C4::Context $context;
 395
 396   ...
 397   restore_context C4::Context;
 398
 399 In some cases, it might be necessary for a script to use multiple
 400 contexts. C<&set_context> saves the current context on a stack, then
 401 sets the context to C<$context>, which will be used in future
 402 operations. To restore the previous context, use C<&restore_context>.
 403
 404 =cut
 405
 406 #'
 407 sub set_context
 408 {
 409     my $self = shift;
 410     my $new_context;    # The context to set
 411
 412     # Figure out whether this is a class or instance method call.
 413     #
 414     # We're going to make the assumption that control got here
 415     # through valid means, i.e., that the caller used an instance
 416     # or class method call, and that control got here through the
 417     # usual inheritance mechanisms. The caller can, of course,
 418     # break this assumption by playing silly buggers, but that's
 419     # harder to do than doing it properly, and harder to check
 420     # for.
 421     if (ref($self) eq "")
 422     {
 423         # Class method. The new context is the next argument.
 424         $new_context = shift;
 425     } else {
 426         # Instance method. The new context is $self.
 427         $new_context = $self;
 428     }
 429
 430     # Save the old context, if any, on the stack
 431     push @context_stack, $context if defined($context);
 432
 433     # Set the new context
 434     $context = $new_context;
 435 }
 436
 437 =head2 restore_context
 438
 439   &restore_context;
 440
 441 Restores the context set by C<&set_context>.
 442
 443 =cut
 444
 445 #'
 446 sub restore_context
 447 {
 448     my $self = shift;
 449
 450     if ($#context_stack < 0)
 451     {
 452         # Stack underflow.
 453         die "Context stack underflow";
 454     }
 455
 456     # Pop the old context and set it.
 457     $context = pop @context_stack;
 458
 459     # FIXME - Should this return something, like maybe the context
 460     # that was current when this was called?
 461 }
 462
 463 =head2 config
 464
 465   $value = C4::Context->config("config_variable");
 466
 467   $value = C4::Context->config_variable;
 468
 469 Returns the value of a variable specified in the configuration file
 470 from which the current context was created.
 471
 472 The second form is more compact, but of course may conflict with
 473 method names. If there is a configuration variable called "new", then
 474 C<C4::Config-E<gt>new> will not return it.
 475
 476 =cut
 477
 478 sub _common_config {
 479         my $var = shift;
 480         my $term = shift;
 481     return if !defined($context->{$term});
 482        # Presumably $self->{$term} might be
 483        # undefined if the config file given to &new
 484        # didn't exist, and the caller didn't bother
 485        # to check the return value.
 486
 487     # Return the value of the requested config variable
 488     return $context->{$term}->{$var};
 489 }
 490
 491 sub config {
 492         return _common_config($_[1],'config');
 493 }
 494 sub zebraconfig {
 495         return _common_config($_[1],'server');
 496 }
 497 sub ModZebrations {
 498         return _common_config($_[1],'serverinfo');
 499 }
 500
 501 =head2 preference
 502
 503   $sys_preference = C4::Context->preference('some_variable');
 504
 505 Looks up the value of the given system preference in the
 506 systempreferences table of the Koha database, and returns it. If the
 507 variable is not set or does not exist, undef is returned.
 508
 509 In case of an error, this may return 0.
 510
 511 Note: It is impossible to tell the difference between system
 512 preferences which do not exist, and those whose values are set to NULL
 513 with this method.
 514
 515 =cut
 516
 517 # FIXME: running this under mod_perl will require a means of
 518 # flushing the caching mechanism.
 519
 520 my %sysprefs;
 521 my $use_syspref_cache = 1;
 522
 523 sub preference {
 524     my $self = shift;
 525     my $var  = shift;    # The system preference to return
 526
 527     if ($use_syspref_cache && exists $sysprefs{lc $var}) {
 528         return $sysprefs{lc $var};
 529     }
 530
 531     my $dbh  = C4::Context->dbh or return 0;
 532
 533     my $value;
 534     if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
 535         $value = $ENV{"OVERRIDE_SYSPREF_$var"};
 536     } else {
 537         # Look up systempreferences.variable==$var
 538         my $sql = q{
 539             SELECT  value
 540             FROM    systempreferences
 541             WHERE   variable = ?
 542             LIMIT   1
 543         };
 544         $value = $dbh->selectrow_array( $sql, {}, lc $var );
 545     }
 546
 547     $sysprefs{lc $var} = $value;
 548     return $value;
 549 }
 550
 551 sub boolean_preference {
 552     my $self = shift;
 553     my $var = shift;        # The system preference to return
 554     my $it = preference($self, $var);
 555     return defined($it)? C4::Boolean::true_p($it): undef;
 556 }
 557
 558 =head2 enable_syspref_cache
 559
 560   C4::Context->enable_syspref_cache();
 561
 562 Enable the in-memory syspref cache used by C4::Context. This is the
 563 default behavior.
 564
 565 =cut
 566
 567 sub enable_syspref_cache {
 568     my ($self) = @_;
 569     $use_syspref_cache = 1;
 570 }
 571
 572 =head2 disable_syspref_cache
 573
 574   C4::Context->disable_syspref_cache();
 575
 576 Disable the in-memory syspref cache used by C4::Context. This should be
 577 used with Plack and other persistent environments.
 578
 579 =cut
 580
 581 sub disable_syspref_cache {
 582     my ($self) = @_;
 583     $use_syspref_cache = 0;
 584     $self->clear_syspref_cache();
 585 }
 586
 587 =head2 clear_syspref_cache
 588
 589   C4::Context->clear_syspref_cache();
 590
 591 cleans the internal cache of sysprefs. Please call this method if
 592 you update the systempreferences table. Otherwise, your new changes
 593 will not be seen by this process.
 594
 595 =cut
 596
 597 sub clear_syspref_cache {
 598     %sysprefs = ();
 599 }
 600
 601 =head2 set_preference
 602
 603   C4::Context->set_preference( $variable, $value );
 604
 605 This updates a preference's value both in the systempreferences table and in
 606 the sysprefs cache.
 607
 608 =cut
 609
 610 sub set_preference {
 611     my $self = shift;
 612     my $var = lc(shift);
 613     my $value = shift;
 614
 615     my $dbh = C4::Context->dbh or return 0;
 616
 617     my $type = $dbh->selectrow_array( "SELECT type FROM systempreferences WHERE variable = ?", {}, $var );
 618
 619     $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
 620
 621     # force explicit protocol on OPACBaseURL
 622     if ($var eq 'opacbaseurl' && substr($value,0,4) !~ /http/) {
 623         $value = 'http://' . $value;
 624     }
 625
 626     my $sth = $dbh->prepare( "
 627       INSERT INTO systempreferences
 628         ( variable, value )
 629         VALUES( ?, ? )
 630         ON DUPLICATE KEY UPDATE value = VALUES(value)
 631     " );
 632
 633     if($sth->execute( $var, $value )) {
 634         $sysprefs{$var} = $value;
 635     }
 636     $sth->finish;
 637 }
 638
 639 # AUTOLOAD
 640 # This implements C4::Config->foo, and simply returns
 641 # C4::Context->config("foo"), as described in the documentation for
 642 # &config, above.
 643
 644 # FIXME - Perhaps this should be extended to check &config first, and
 645 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
 646 # code, so it'd probably be best to delete it altogether so as not to
 647 # encourage people to use it.
 648 sub AUTOLOAD
 649 {
 650     my $self = shift;
 651
 652     $AUTOLOAD =~ s/.*:://;        # Chop off the package name,
 653                     # leaving only the function name.
 654     return $self->config($AUTOLOAD);
 655 }
 656
 657 =head2 Zconn
 658
 659   $Zconn = C4::Context->Zconn
 660
 661 Returns a connection to the Zebra database
 662
 663 C<$self>
 664
 665 C<$server> one of the servers defined in the koha-conf.xml file
 666
 667 C<$async> whether this is a asynchronous connection
 668
 669 =cut
 670
 671 sub Zconn {
 672     my ($self, $server, $async ) = @_;
 673     my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
 674     if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
 675         # if we are running the script from the commandline, lets try to use the caching
 676         return $context->{"Zconn"}->{$cache_key};
 677     }
 678     $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
 679     $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
 680     return $context->{"Zconn"}->{$cache_key};
 681 }
 682
 683 =head2 _new_Zconn
 684
 685 $context->{"Zconn"} = &_new_Zconn($server,$async);
 686
 687 Internal function. Creates a new database connection from the data given in the current context and returns it.
 688
 689 C<$server> one of the servers defined in the koha-conf.xml file
 690
 691 C<$async> whether this is a asynchronous connection
 692
 693 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
 694
 695 =cut
 696
 697 sub _new_Zconn {
 698     my ( $server, $async ) = @_;
 699
 700     my $tried=0; # first attempt
 701     my $Zconn; # connection object
 702     my $elementSetName;
 703     my $index_mode;
 704     my $syntax;
 705
 706     $server //= "biblioserver";
 707
 708     if ( $server eq 'biblioserver' ) {
 709         $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
 710     } elsif ( $server eq 'authorityserver' ) {
 711         $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
 712     }
 713
 714     if ( $index_mode eq 'grs1' ) {
 715         $elementSetName = 'F';
 716         $syntax = ( $context->preference("marcflavour") eq 'UNIMARC' )
 717                 ? 'unimarc'
 718                 : 'usmarc';
 719
 720     } else { # $index_mode eq 'dom'
 721         $syntax = 'xml';
 722         $elementSetName = 'marcxml';
 723     }
 724
 725     my $host = $context->{'listen'}->{$server}->{'content'};
 726     my $user = $context->{"serverinfo"}->{$server}->{"user"};
 727     my $password = $context->{"serverinfo"}->{$server}->{"password"};
 728     eval {
 729         # set options
 730         my $o = new ZOOM::Options();
 731         $o->option(user => $user) if $user && $password;
 732         $o->option(password => $password) if $user && $password;
 733         $o->option(async => 1) if $async;
 734         $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
 735         $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
 736         $o->option(preferredRecordSyntax => $syntax);
 737         $o->option(elementSetName => $elementSetName) if $elementSetName;
 738         $o->option(databaseName => $context->{"config"}->{$server}||"biblios");
 739
 740         # create a new connection object
 741         $Zconn= create ZOOM::Connection($o);
 742
 743         # forge to server
 744         $Zconn->connect($host, 0);
 745
 746         # check for errors and warn
 747         if ($Zconn->errcode() !=0) {
 748             warn "something wrong with the connection: ". $Zconn->errmsg();
 749         }
 750     };
 751     return $Zconn;
 752 }
 753
 754 # _new_dbh
 755 # Internal helper function (not a method!). This creates a new
 756 # database connection from the data given in the current context, and
 757 # returns it.
 758 sub _new_dbh
 759 {
 760
 761     ## $context
 762     ## correct name for db_scheme
 763     my $db_driver = $context->{db_driver};
 764
 765     my $db_name   = $context->config("database");
 766     my $db_host   = $context->config("hostname");
 767     my $db_port   = $context->config("port") || '';
 768     my $db_user   = $context->config("user");
 769     my $db_passwd = $context->config("pass");
 770     # MJR added or die here, as we can't work without dbh
 771     my $dbh = DBIx::Connector->connect(
 772         "dbi:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
 773         $db_user, $db_passwd,
 774         {
 775             'RaiseError' => $ENV{DEBUG} ? 1 : 0
 776         }
 777     );
 778
 779     # Check for the existence of a systempreference table; if we don't have this, we don't
 780     # have a valid database and should not set RaiseError in order to allow the installer
 781     # to run; installer will not run otherwise since we raise all db errors
 782
 783     eval {
 784                 local $dbh->{PrintError} = 0;
 785                 local $dbh->{RaiseError} = 1;
 786                 $dbh->do(qq{SELECT * FROM systempreferences WHERE 1 = 0 });
 787     };
 788
 789     if ($@) {
 790         $dbh->{RaiseError} = 0;
 791     }
 792
 793     if ( $db_driver eq 'mysql' ) {
 794         $dbh->{mysql_auto_reconnect} = 1;
 795     }
 796
 797         my $tz = $ENV{TZ};
 798     if ( $db_driver eq 'mysql' ) {
 799         # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
 800         # this is better than modifying my.cnf (and forcing all communications to be in utf8)
 801         $dbh->{'mysql_enable_utf8'}=1; #enable
 802         $dbh->do("set NAMES 'utf8'");
 803         ($tz) and $dbh->do(qq(SET time_zone = "$tz"));
 804     }
 805     elsif ( $db_driver eq 'Pg' ) {
 806             $dbh->do( "set client_encoding = 'UTF8';" );
 807         ($tz) and $dbh->do(qq(SET TIME ZONE = "$tz"));
 808     }
 809     return $dbh;
 810 }
 811
 812 =head2 dbh
 813
 814   $dbh = C4::Context->dbh;
 815
 816 Returns a database handle connected to the Koha database for the
 817 current context. If no connection has yet been made, this method
 818 creates one, and connects to the database.
 819
 820 This database handle is cached for future use: if you call
 821 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
 822 times. If you need a second database handle, use C<&new_dbh> and
 823 possibly C<&set_dbh>.
 824
 825 =cut
 826
 827 #'
 828 sub dbh
 829 {
 830     my $self = shift;
 831     my $params = shift;
 832     my $sth;
 833
 834     unless ( $params->{new} ) {
 835         if ( defined($context->{db_driver}) && $context->{db_driver} eq 'mysql' && $context->{"dbh"} ) {
 836             return $context->{"dbh"};
 837         } elsif ( defined($context->{"dbh"}) && $context->{"dbh"}->ping() ) {
 838             return $context->{"dbh"};
 839         }
 840     }
 841
 842     # No database handle or it died . Create one.
 843     $context->{"dbh"} = &_new_dbh();
 844
 845     return $context->{"dbh"};
 846 }
 847
 848 =head2 new_dbh
 849
 850   $dbh = C4::Context->new_dbh;
 851
 852 Creates a new connection to the Koha database for the current context,
 853 and returns the database handle (a C<DBI::db> object).
 854
 855 The handle is not saved anywhere: this method is strictly a
 856 convenience function; the point is that it knows which database to
 857 connect to so that the caller doesn't have to know.
 858
 859 =cut
 860
 861 #'
 862 sub new_dbh
 863 {
 864     my $self = shift;
 865
 866     return &_new_dbh();
 867 }
 868
 869 =head2 set_dbh
 870
 871   $my_dbh = C4::Connect->new_dbh;
 872   C4::Connect->set_dbh($my_dbh);
 873   ...
 874   C4::Connect->restore_dbh;
 875
 876 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
 877 C<&set_context> and C<&restore_context>.
 878
 879 C<&set_dbh> saves the current database handle on a stack, then sets
 880 the current database handle to C<$my_dbh>.
 881
 882 C<$my_dbh> is assumed to be a good database handle.
 883
 884 =cut
 885
 886 #'
 887 sub set_dbh
 888 {
 889     my $self = shift;
 890     my $new_dbh = shift;
 891
 892     # Save the current database handle on the handle stack.
 893     # We assume that $new_dbh is all good: if the caller wants to
 894     # screw himself by passing an invalid handle, that's fine by
 895     # us.
 896     push @{$context->{"dbh_stack"}}, $context->{"dbh"};
 897     $context->{"dbh"} = $new_dbh;
 898 }
 899
 900 =head2 restore_dbh
 901
 902   C4::Context->restore_dbh;
 903
 904 Restores the database handle saved by an earlier call to
 905 C<C4::Context-E<gt>set_dbh>.
 906
 907 =cut
 908
 909 #'
 910 sub restore_dbh
 911 {
 912     my $self = shift;
 913
 914     if ($#{$context->{"dbh_stack"}} < 0)
 915     {
 916         # Stack underflow
 917         die "DBH stack underflow";
 918     }
 919
 920     # Pop the old database handle and set it.
 921     $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
 922
 923     # FIXME - If it is determined that restore_context should
 924     # return something, then this function should, too.
 925 }
 926
 927 =head2 queryparser
 928
 929   $queryparser = C4::Context->queryparser
 930
 931 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
 932
 933 =cut
 934
 935 sub queryparser {
 936     my $self = shift;
 937     unless (defined $context->{"queryparser"}) {
 938         $context->{"queryparser"} = &_new_queryparser();
 939     }
 940
 941     return
 942       defined( $context->{"queryparser"} )
 943       ? $context->{"queryparser"}->new
 944       : undef;
 945 }
 946
 947 =head2 _new_queryparser
 948
 949 Internal helper function to create a new QueryParser object. QueryParser
 950 is loaded dynamically so as to keep the lack of the QueryParser library from
 951 getting in anyone's way.
 952
 953 =cut
 954
 955 sub _new_queryparser {
 956     my $qpmodules = {
 957         'OpenILS::QueryParser'           => undef,
 958         'Koha::QueryParser::Driver::PQF' => undef
 959     };
 960     if ( can_load( 'modules' => $qpmodules ) ) {
 961         my $QParser     = Koha::QueryParser::Driver::PQF->new();
 962         my $config_file = $context->config('queryparser_config');
 963         $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
 964         if ( $QParser->load_config($config_file) ) {
 965             # Set 'keyword' as the default search class
 966             $QParser->default_search_class('keyword');
 967             # TODO: allow indexes to be configured in the database
 968             return $QParser;
 969         }
 970     }
 971     return;
 972 }
 973
 974 =head2 marcfromkohafield
 975
 976   $dbh = C4::Context->marcfromkohafield;
 977
 978 Returns a hash with marcfromkohafield.
 979
 980 This hash is cached for future use: if you call
 981 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
 982
 983 =cut
 984
 985 #'
 986 sub marcfromkohafield
 987 {
 988     my $retval = {};
 989
 990     # If the hash already exists, return it.
 991     return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
 992
 993     # No hash. Create one.
 994     $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
 995
 996     return $context->{"marcfromkohafield"};
 997 }
 998
 999 # _new_marcfromkohafield
1000 # Internal helper function (not a method!). This creates a new
1001 # hash with stopwords
1002 sub _new_marcfromkohafield
1003 {
1004     my $dbh = C4::Context->dbh;
1005     my $marcfromkohafield;
1006     my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
1007     $sth->execute;
1008     while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
1009         my $retval = {};
1010         $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
1011     }
1012     return $marcfromkohafield;
1013 }
1014
1015 =head2 stopwords
1016
1017   $dbh = C4::Context->stopwords;
1018
1019 Returns a hash with stopwords.
1020
1021 This hash is cached for future use: if you call
1022 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
1023
1024 =cut
1025
1026 #'
1027 sub stopwords
1028 {
1029     my $retval = {};
1030
1031     # If the hash already exists, return it.
1032     return $context->{"stopwords"} if defined($context->{"stopwords"});
1033
1034     # No hash. Create one.
1035     $context->{"stopwords"} = &_new_stopwords();
1036
1037     return $context->{"stopwords"};
1038 }
1039
1040 # _new_stopwords
1041 # Internal helper function (not a method!). This creates a new
1042 # hash with stopwords
1043 sub _new_stopwords
1044 {
1045     my $dbh = C4::Context->dbh;
1046     my $stopwordlist;
1047     my $sth = $dbh->prepare("select word from stopwords");
1048     $sth->execute;
1049     while (my $stopword = $sth->fetchrow_array) {
1050         $stopwordlist->{$stopword} = uc($stopword);
1051     }
1052     $stopwordlist->{A} = "A" unless $stopwordlist;
1053     return $stopwordlist;
1054 }
1055
1056 =head2 userenv
1057
1058   C4::Context->userenv;
1059
1060 Retrieves a hash for user environment variables.
1061
1062 This hash shall be cached for future use: if you call
1063 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1064
1065 =cut
1066
1067 #'
1068 sub userenv {
1069     my $var = $context->{"activeuser"};
1070     if (defined $var and defined $context->{"userenv"}->{$var}) {
1071         return $context->{"userenv"}->{$var};
1072     } else {
1073         return;
1074     }
1075 }
1076
1077 =head2 set_userenv
1078
1079   C4::Context->set_userenv($usernum, $userid, $usercnum,
1080                            $userfirstname, $usersurname,
1081                            $userbranch, $branchname, $userflags,
1082                            $emailaddress, $branchprinter, $persona);
1083
1084 Establish a hash of user environment variables.
1085
1086 set_userenv is called in Auth.pm
1087
1088 =cut
1089
1090 #'
1091 sub set_userenv {
1092     shift @_;
1093     my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
1094     map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
1095     @_;
1096     my $var=$context->{"activeuser"} || '';
1097     my $cell = {
1098         "number"     => $usernum,
1099         "id"         => $userid,
1100         "cardnumber" => $usercnum,
1101         "firstname"  => $userfirstname,
1102         "surname"    => $usersurname,
1103         #possibly a law problem
1104         "branch"     => $userbranch,
1105         "branchname" => $branchname,
1106         "flags"      => $userflags,
1107         "emailaddress"     => $emailaddress,
1108         "branchprinter"    => $branchprinter,
1109         "persona"    => $persona,
1110         "shibboleth" => $shibboleth,
1111     };
1112     $context->{userenv}->{$var} = $cell;
1113     return $cell;
1114 }
1115
1116 sub set_shelves_userenv {
1117         my ($type, $shelves) = @_ or return;
1118         my $activeuser = $context->{activeuser} or return;
1119         $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1120         $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1121         $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1122 }
1123
1124 sub get_shelves_userenv {
1125         my $active;
1126         unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1127                 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1128                 return;
1129         }
1130         my $totshelves = $active->{totshelves} or undef;
1131         my $pubshelves = $active->{pubshelves} or undef;
1132         my $barshelves = $active->{barshelves} or undef;
1133         return ($totshelves, $pubshelves, $barshelves);
1134 }
1135
1136 =head2 _new_userenv
1137
1138   C4::Context->_new_userenv($session);  # FIXME: This calling style is wrong for what looks like an _internal function
1139
1140 Builds a hash for user environment variables.
1141
1142 This hash shall be cached for future use: if you call
1143 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1144
1145 _new_userenv is called in Auth.pm
1146
1147 =cut
1148
1149 #'
1150 sub _new_userenv
1151 {
1152     shift;  # Useless except it compensates for bad calling style
1153     my ($sessionID)= @_;
1154      $context->{"activeuser"}=$sessionID;
1155 }
1156
1157 =head2 _unset_userenv
1158
1159   C4::Context->_unset_userenv;
1160
1161 Destroys the hash for activeuser user environment variables.
1162
1163 =cut
1164
1165 #'
1166
1167 sub _unset_userenv
1168 {
1169     my ($sessionID)= @_;
1170     undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1171 }
1172
1173
1174 =head2 get_versions
1175
1176   C4::Context->get_versions
1177
1178 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'.
1179
1180 =cut
1181
1182 #'
1183
1184 # A little example sub to show more debugging info for CGI::Carp
1185 sub get_versions {
1186     my %versions;
1187     $versions{kohaVersion}  = Koha::version();
1188     $versions{kohaDbVersion} = C4::Context->preference('version');
1189     $versions{osVersion} = join(" ", POSIX::uname());
1190     $versions{perlVersion} = $];
1191     {
1192         no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1193         $versions{mysqlVersion}  = `mysql -V`;
1194         $versions{apacheVersion} = (`apache2ctl -v`)[0];
1195         $versions{apacheVersion} = `httpd -v`             unless  $versions{apacheVersion} ;
1196         $versions{apacheVersion} = `httpd2 -v`            unless  $versions{apacheVersion} ;
1197         $versions{apacheVersion} = `apache2 -v`           unless  $versions{apacheVersion} ;
1198         $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless  $versions{apacheVersion} ;
1199     }
1200     return %versions;
1201 }
1202
1203
1204 =head2 tz
1205
1206   C4::Context->tz
1207
1208   Returns a DateTime::TimeZone object for the system timezone
1209
1210 =cut
1211
1212 sub tz {
1213     my $self = shift;
1214     if (!defined $context->{tz}) {
1215         $context->{tz} = DateTime::TimeZone->new(name => 'local');
1216     }
1217     return $context->{tz};
1218 }
1219
1220
1221 =head2 IsSuperLibrarian
1222
1223     C4::Context->IsSuperLibrarian();
1224
1225 =cut
1226
1227 sub IsSuperLibrarian {
1228     my $userenv = C4::Context->userenv;
1229
1230     unless ( $userenv and exists $userenv->{flags} ) {
1231         # If we reach this without a user environment,
1232         # assume that we're running from a command-line script,
1233         # and act as a superlibrarian.
1234         carp("C4::Context->userenv not defined!");
1235         return 1;
1236     }
1237
1238     return ($userenv->{flags}//0) % 2;
1239 }
1240
1241 =head2 interface
1242
1243 Sets the current interface for later retrieval in any Perl module
1244
1245     C4::Context->interface('opac');
1246     C4::Context->interface('intranet');
1247     my $interface = C4::Context->interface;
1248
1249 =cut
1250
1251 sub interface {
1252     my ($class, $interface) = @_;
1253
1254     if (defined $interface) {
1255         $interface = lc $interface;
1256         if ($interface eq 'opac' || $interface eq 'intranet') {
1257             $context->{interface} = $interface;
1258         } else {
1259             warn "invalid interface : '$interface'";
1260         }
1261     }
1262
1263     return $context->{interface} // 'opac';
1264 }
1265
1266 1;
1267 __END__
1268
1269 =head1 ENVIRONMENT
1270
1271 =head2 C<KOHA_CONF>
1272
1273 Specifies the configuration file to read.
1274
1275 =head1 SEE ALSO
1276
1277 XML::Simple
1278
1279 =head1 AUTHORS
1280
1281 Andrew Arensburger <arensb at ooblick dot com>
1282
1283 Joshua Ferraro <jmf at liblime dot com>
1284