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