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
  23 BEGIN {
  24         if ($ENV{'HTTP_USER_AGENT'})    {
  25                 require CGI::Carp;
  26         # FIXME for future reference, CGI::Carp doc says
  27         #  "Note that fatalsToBrowser does not work with mod_perl version 2.0 and higher."
  28                 import CGI::Carp qw(fatalsToBrowser);
  29                         sub handle_errors {
  30                             my $msg = shift;
  31                             my $debug_level;
  32                             eval {C4::Context->dbh();};
  33                             if ($@){
  34                                 $debug_level = 1;
  35                             }
  36                             else {
  37                                 $debug_level =  C4::Context->preference("DebugLevel");
  38                             }
  39
  40                 print q(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  41                             "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  42                        <html lang="en" xml:lang="en"  xmlns="http://www.w3.org/1999/xhtml">
  43                        <head><title>Koha Error</title></head>
  44                        <body>
  45                 );
  46                                 if ($debug_level eq "2"){
  47                                         # debug 2 , print extra info too.
  48                                         my %versions = get_versions();
  49
  50                 # a little example table with various version info";
  51                                         print "
  52                                                 <h1>Koha error</h1>
  53                                                 <p>The following fatal error has occurred:</p>
  54                         <pre><code>$msg</code></pre>
  55                                                 <table>
  56                                                 <tr><th>Apache</th><td>  $versions{apacheVersion}</td></tr>
  57                                                 <tr><th>Koha</th><td>    $versions{kohaVersion}</td></tr>
  58                                                 <tr><th>Koha DB</th><td> $versions{kohaDbVersion}</td></tr>
  59                                                 <tr><th>MySQL</th><td>   $versions{mysqlVersion}</td></tr>
  60                                                 <tr><th>OS</th><td>      $versions{osVersion}</td></tr>
  61                                                 <tr><th>Perl</th><td>    $versions{perlVersion}</td></tr>
  62                                                 </table>";
  63
  64                                 } elsif ($debug_level eq "1"){
  65                                         print "
  66                                                 <h1>Koha error</h1>
  67                                                 <p>The following fatal error has occurred:</p>
  68                         <pre><code>$msg</code></pre>";
  69                                 } else {
  70                                         print "<p>production mode - trapped fatal error</p>";
  71                                 }
  72                 print "</body></html>";
  73                         }
  74                 #CGI::Carp::set_message(\&handle_errors);
  75                 ## give a stack backtrace if KOHA_BACKTRACES is set
  76                 ## can't rely on DebugLevel for this, as we're not yet connected
  77                 if ($ENV{KOHA_BACKTRACES}) {
  78                         $main::SIG{__DIE__} = \&CGI::Carp::confess;
  79                 }
  80     }   # else there is no browser to send fatals to!
  81
  82     # Check if there are memcached servers set
  83     $servers = $ENV{'MEMCACHED_SERVERS'};
  84     if ($servers) {
  85         # Load required libraries and create the memcached object
  86         require Cache::Memcached;
  87         $memcached = Cache::Memcached->new({
  88         servers => [ $servers ],
  89         debug   => 0,
  90         compress_threshold => 10_000,
  91         expire_time => 600,
  92         namespace => $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
  93     });
  94         # Verify memcached available (set a variable and test the output)
  95     $ismemcached = $memcached->set('ismemcached','1');
  96     }
  97
  98     $VERSION = '3.07.00.049';
  99 }
 100
 101 use DBI;
 102 use ZOOM;
 103 use XML::Simple;
 104 use C4::Boolean;
 105 use C4::Debug;
 106 use POSIX ();
 107 use DateTime::TimeZone;
 108 use Module::Load::Conditional qw(can_load);
 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 # db_scheme2dbi
 297 # Translates the full text name of a database into de appropiate dbi name
 298 #
 299 sub db_scheme2dbi {
 300     my $name = shift;
 301     # for instance, we support only mysql, so don't care checking
 302     return "mysql";
 303     for ($name) {
 304 # FIXME - Should have other databases.
 305         if (/mysql/) { return("mysql"); }
 306         if (/Postgres|Pg|PostgresSQL/) { return("Pg"); }
 307         if (/oracle/) { return("Oracle"); }
 308     }
 309     return;         # Just in case
 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     return $self;
 405 }
 406
 407 =head2 set_context
 408
 409   $context = new C4::Context;
 410   $context->set_context();
 411 or
 412   set_context C4::Context $context;
 413
 414   ...
 415   restore_context C4::Context;
 416
 417 In some cases, it might be necessary for a script to use multiple
 418 contexts. C<&set_context> saves the current context on a stack, then
 419 sets the context to C<$context>, which will be used in future
 420 operations. To restore the previous context, use C<&restore_context>.
 421
 422 =cut
 423
 424 #'
 425 sub set_context
 426 {
 427     my $self = shift;
 428     my $new_context;    # The context to set
 429
 430     # Figure out whether this is a class or instance method call.
 431     #
 432     # We're going to make the assumption that control got here
 433     # through valid means, i.e., that the caller used an instance
 434     # or class method call, and that control got here through the
 435     # usual inheritance mechanisms. The caller can, of course,
 436     # break this assumption by playing silly buggers, but that's
 437     # harder to do than doing it properly, and harder to check
 438     # for.
 439     if (ref($self) eq "")
 440     {
 441         # Class method. The new context is the next argument.
 442         $new_context = shift;
 443     } else {
 444         # Instance method. The new context is $self.
 445         $new_context = $self;
 446     }
 447
 448     # Save the old context, if any, on the stack
 449     push @context_stack, $context if defined($context);
 450
 451     # Set the new context
 452     $context = $new_context;
 453 }
 454
 455 =head2 restore_context
 456
 457   &restore_context;
 458
 459 Restores the context set by C<&set_context>.
 460
 461 =cut
 462
 463 #'
 464 sub restore_context
 465 {
 466     my $self = shift;
 467
 468     if ($#context_stack < 0)
 469     {
 470         # Stack underflow.
 471         die "Context stack underflow";
 472     }
 473
 474     # Pop the old context and set it.
 475     $context = pop @context_stack;
 476
 477     # FIXME - Should this return something, like maybe the context
 478     # that was current when this was called?
 479 }
 480
 481 =head2 config
 482
 483   $value = C4::Context->config("config_variable");
 484
 485   $value = C4::Context->config_variable;
 486
 487 Returns the value of a variable specified in the configuration file
 488 from which the current context was created.
 489
 490 The second form is more compact, but of course may conflict with
 491 method names. If there is a configuration variable called "new", then
 492 C<C4::Config-E<gt>new> will not return it.
 493
 494 =cut
 495
 496 sub _common_config {
 497         my $var = shift;
 498         my $term = shift;
 499     return if !defined($context->{$term});
 500        # Presumably $self->{$term} might be
 501        # undefined if the config file given to &new
 502        # didn't exist, and the caller didn't bother
 503        # to check the return value.
 504
 505     # Return the value of the requested config variable
 506     return $context->{$term}->{$var};
 507 }
 508
 509 sub config {
 510         return _common_config($_[1],'config');
 511 }
 512 sub zebraconfig {
 513         return _common_config($_[1],'server');
 514 }
 515 sub ModZebrations {
 516         return _common_config($_[1],'serverinfo');
 517 }
 518
 519 =head2 preference
 520
 521   $sys_preference = C4::Context->preference('some_variable');
 522
 523 Looks up the value of the given system preference in the
 524 systempreferences table of the Koha database, and returns it. If the
 525 variable is not set or does not exist, undef is returned.
 526
 527 In case of an error, this may return 0.
 528
 529 Note: It is impossible to tell the difference between system
 530 preferences which do not exist, and those whose values are set to NULL
 531 with this method.
 532
 533 =cut
 534
 535 # FIXME: running this under mod_perl will require a means of
 536 # flushing the caching mechanism.
 537
 538 my %sysprefs;
 539 my $use_syspref_cache = 1;
 540
 541 sub preference {
 542     my $self = shift;
 543     my $var  = lc(shift);                          # The system preference to return
 544
 545     if ($use_syspref_cache && exists $sysprefs{$var}) {
 546         return $sysprefs{$var};
 547     }
 548
 549     my $dbh  = C4::Context->dbh or return 0;
 550
 551     # Look up systempreferences.variable==$var
 552     my $sql = <<'END_SQL';
 553         SELECT    value
 554         FROM    systempreferences
 555         WHERE    variable=?
 556         LIMIT    1
 557 END_SQL
 558     $sysprefs{$var} = $dbh->selectrow_array( $sql, {}, $var );
 559     return $sysprefs{$var};
 560 }
 561
 562 sub boolean_preference {
 563     my $self = shift;
 564     my $var = shift;        # The system preference to return
 565     my $it = preference($self, $var);
 566     return defined($it)? C4::Boolean::true_p($it): undef;
 567 }
 568
 569 =head2 enable_syspref_cache
 570
 571   C4::Context->enable_syspref_cache();
 572
 573 Enable the in-memory syspref cache used by C4::Context. This is the
 574 default behavior.
 575
 576 =cut
 577
 578 sub enable_syspref_cache {
 579     my ($self) = @_;
 580     $use_syspref_cache = 1;
 581 }
 582
 583 =head2 disable_syspref_cache
 584
 585   C4::Context->disable_syspref_cache();
 586
 587 Disable the in-memory syspref cache used by C4::Context. This should be
 588 used with Plack and other persistent environments.
 589
 590 =cut
 591
 592 sub disable_syspref_cache {
 593     my ($self) = @_;
 594     $use_syspref_cache = 0;
 595     $self->clear_syspref_cache();
 596 }
 597
 598 =head2 clear_syspref_cache
 599
 600   C4::Context->clear_syspref_cache();
 601
 602 cleans the internal cache of sysprefs. Please call this method if
 603 you update the systempreferences table. Otherwise, your new changes
 604 will not be seen by this process.
 605
 606 =cut
 607
 608 sub clear_syspref_cache {
 609     %sysprefs = ();
 610 }
 611
 612 =head2 set_preference
 613
 614   C4::Context->set_preference( $variable, $value );
 615
 616 This updates a preference's value both in the systempreferences table and in
 617 the sysprefs cache.
 618
 619 =cut
 620
 621 sub set_preference {
 622     my $self = shift;
 623     my $var = lc(shift);
 624     my $value = shift;
 625
 626     my $dbh = C4::Context->dbh or return 0;
 627
 628     my $type = $dbh->selectrow_array( "SELECT type FROM systempreferences WHERE variable = ?", {}, $var );
 629
 630     $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
 631
 632     my $sth = $dbh->prepare( "
 633       INSERT INTO systempreferences
 634         ( variable, value )
 635         VALUES( ?, ? )
 636         ON DUPLICATE KEY UPDATE value = VALUES(value)
 637     " );
 638
 639     if($sth->execute( $var, $value )) {
 640         $sysprefs{$var} = $value;
 641     }
 642     $sth->finish;
 643 }
 644
 645 # AUTOLOAD
 646 # This implements C4::Config->foo, and simply returns
 647 # C4::Context->config("foo"), as described in the documentation for
 648 # &config, above.
 649
 650 # FIXME - Perhaps this should be extended to check &config first, and
 651 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
 652 # code, so it'd probably be best to delete it altogether so as not to
 653 # encourage people to use it.
 654 sub AUTOLOAD
 655 {
 656     my $self = shift;
 657
 658     $AUTOLOAD =~ s/.*:://;        # Chop off the package name,
 659                     # leaving only the function name.
 660     return $self->config($AUTOLOAD);
 661 }
 662
 663 =head2 Zconn
 664
 665   $Zconn = C4::Context->Zconn
 666
 667 Returns a connection to the Zebra database for the current
 668 context. If no connection has yet been made, this method
 669 creates one and connects.
 670
 671 C<$self>
 672
 673 C<$server> one of the servers defined in the koha-conf.xml file
 674
 675 C<$async> whether this is a asynchronous connection
 676
 677 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
 678
 679
 680 =cut
 681
 682 sub Zconn {
 683     my $self=shift;
 684     my $server=shift;
 685     my $async=shift;
 686     my $auth=shift;
 687     my $piggyback=shift;
 688     my $syntax=shift;
 689     if ( defined($context->{"Zconn"}->{$server}) && (0 == $context->{"Zconn"}->{$server}->errcode()) ) {
 690         return $context->{"Zconn"}->{$server};
 691     # No connection object or it died. Create one.
 692     }else {
 693         # release resources if we're closing a connection and making a new one
 694         # FIXME: this needs to be smarter -- an error due to a malformed query or
 695         # a missing index does not necessarily require us to close the connection
 696         # and make a new one, particularly for a batch job.  However, at
 697         # first glance it does not look like there's a way to easily check
 698         # the basic health of a ZOOM::Connection
 699         $context->{"Zconn"}->{$server}->destroy() if defined($context->{"Zconn"}->{$server});
 700
 701         $context->{"Zconn"}->{$server} = &_new_Zconn($server,$async,$auth,$piggyback,$syntax);
 702         $context->{ Zconn }->{ $server }->option(
 703             preferredRecordSyntax => C4::Context->preference("marcflavour") );
 704         return $context->{"Zconn"}->{$server};
 705     }
 706 }
 707
 708 =head2 _new_Zconn
 709
 710 $context->{"Zconn"} = &_new_Zconn($server,$async);
 711
 712 Internal function. Creates a new database connection from the data given in the current context and returns it.
 713
 714 C<$server> one of the servers defined in the koha-conf.xml file
 715
 716 C<$async> whether this is a asynchronous connection
 717
 718 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
 719
 720 =cut
 721
 722 sub _new_Zconn {
 723     my ($server,$async,$auth,$piggyback,$syntax) = @_;
 724
 725     my $tried=0; # first attempt
 726     my $Zconn; # connection object
 727     $server = "biblioserver" unless $server;
 728     $syntax = "usmarc" unless $syntax;
 729
 730     my $host = $context->{'listen'}->{$server}->{'content'};
 731     my $servername = $context->{"config"}->{$server};
 732     my $user = $context->{"serverinfo"}->{$server}->{"user"};
 733     my $password = $context->{"serverinfo"}->{$server}->{"password"};
 734  $auth = 1 if($user && $password);
 735     retry:
 736     eval {
 737         # set options
 738         my $o = new ZOOM::Options();
 739         $o->option(user=>$user) if $auth;
 740         $o->option(password=>$password) if $auth;
 741         $o->option(async => 1) if $async;
 742         $o->option(count => $piggyback) if $piggyback;
 743         $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
 744         $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
 745         $o->option(preferredRecordSyntax => $syntax);
 746         $o->option(elementSetName => "F"); # F for 'full' as opposed to B for 'brief'
 747         $o->option(databaseName => ($servername?$servername:"biblios"));
 748
 749         # create a new connection object
 750         $Zconn= create ZOOM::Connection($o);
 751
 752         # forge to server
 753         $Zconn->connect($host, 0);
 754
 755         # check for errors and warn
 756         if ($Zconn->errcode() !=0) {
 757             warn "something wrong with the connection: ". $Zconn->errmsg();
 758         }
 759
 760     };
 761 #     if ($@) {
 762 #         # Koha manages the Zebra server -- this doesn't work currently for me because of permissions issues
 763 #         # Also, I'm skeptical about whether it's the best approach
 764 #         warn "problem with Zebra";
 765 #         if ( C4::Context->preference("ManageZebra") ) {
 766 #             if ($@->code==10000 && $tried==0) { ##No connection try restarting Zebra
 767 #                 $tried=1;
 768 #                 warn "trying to restart Zebra";
 769 #                 my $res=system("zebrasrv -f $ENV{'KOHA_CONF'} >/koha/log/zebra-error.log");
 770 #                 goto "retry";
 771 #             } else {
 772 #                 warn "Error ", $@->code(), ": ", $@->message(), "\n";
 773 #                 $Zconn="error";
 774 #                 return $Zconn;
 775 #             }
 776 #         }
 777 #     }
 778     return $Zconn;
 779 }
 780
 781 # _new_dbh
 782 # Internal helper function (not a method!). This creates a new
 783 # database connection from the data given in the current context, and
 784 # returns it.
 785 sub _new_dbh
 786 {
 787
 788     ## $context
 789     ## correct name for db_schme
 790     my $db_driver;
 791     if ($context->config("db_scheme")){
 792         $db_driver=db_scheme2dbi($context->config("db_scheme"));
 793     }else{
 794         $db_driver="mysql";
 795     }
 796
 797     my $db_name   = $context->config("database");
 798     my $db_host   = $context->config("hostname");
 799     my $db_port   = $context->config("port") || '';
 800     my $db_user   = $context->config("user");
 801     my $db_passwd = $context->config("pass");
 802     # MJR added or die here, as we can't work without dbh
 803     my $dbh = DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
 804     $db_user, $db_passwd, {'RaiseError' => $ENV{DEBUG}?1:0 }) or die $DBI::errstr;
 805
 806     # Check for the existence of a systempreference table; if we don't have this, we don't
 807     # have a valid database and should not set RaiseError in order to allow the installer
 808     # to run; installer will not run otherwise since we raise all db errors
 809
 810     eval {
 811                 local $dbh->{PrintError} = 0;
 812                 local $dbh->{RaiseError} = 1;
 813                 $dbh->do(qq{SELECT * FROM systempreferences WHERE 1 = 0 });
 814     };
 815
 816     if ($@) {
 817         $dbh->{RaiseError} = 0;
 818     }
 819
 820         my $tz = $ENV{TZ};
 821     if ( $db_driver eq 'mysql' ) {
 822         # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
 823         # this is better than modifying my.cnf (and forcing all communications to be in utf8)
 824         $dbh->{'mysql_enable_utf8'}=1; #enable
 825         $dbh->do("set NAMES 'utf8'");
 826         ($tz) and $dbh->do(qq(SET time_zone = "$tz"));
 827     }
 828     elsif ( $db_driver eq 'Pg' ) {
 829             $dbh->do( "set client_encoding = 'UTF8';" );
 830         ($tz) and $dbh->do(qq(SET TIME ZONE = "$tz"));
 831     }
 832     return $dbh;
 833 }
 834
 835 =head2 dbh
 836
 837   $dbh = C4::Context->dbh;
 838
 839 Returns a database handle connected to the Koha database for the
 840 current context. If no connection has yet been made, this method
 841 creates one, and connects to the database.
 842
 843 This database handle is cached for future use: if you call
 844 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
 845 times. If you need a second database handle, use C<&new_dbh> and
 846 possibly C<&set_dbh>.
 847
 848 =cut
 849
 850 #'
 851 sub dbh
 852 {
 853     my $self = shift;
 854     my $sth;
 855
 856     if (defined($context->{"dbh"}) && $context->{"dbh"}->ping()) {
 857         return $context->{"dbh"};
 858     }
 859
 860     # No database handle or it died . Create one.
 861     $context->{"dbh"} = &_new_dbh();
 862
 863     return $context->{"dbh"};
 864 }
 865
 866 =head2 new_dbh
 867
 868   $dbh = C4::Context->new_dbh;
 869
 870 Creates a new connection to the Koha database for the current context,
 871 and returns the database handle (a C<DBI::db> object).
 872
 873 The handle is not saved anywhere: this method is strictly a
 874 convenience function; the point is that it knows which database to
 875 connect to so that the caller doesn't have to know.
 876
 877 =cut
 878
 879 #'
 880 sub new_dbh
 881 {
 882     my $self = shift;
 883
 884     return &_new_dbh();
 885 }
 886
 887 =head2 set_dbh
 888
 889   $my_dbh = C4::Connect->new_dbh;
 890   C4::Connect->set_dbh($my_dbh);
 891   ...
 892   C4::Connect->restore_dbh;
 893
 894 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
 895 C<&set_context> and C<&restore_context>.
 896
 897 C<&set_dbh> saves the current database handle on a stack, then sets
 898 the current database handle to C<$my_dbh>.
 899
 900 C<$my_dbh> is assumed to be a good database handle.
 901
 902 =cut
 903
 904 #'
 905 sub set_dbh
 906 {
 907     my $self = shift;
 908     my $new_dbh = shift;
 909
 910     # Save the current database handle on the handle stack.
 911     # We assume that $new_dbh is all good: if the caller wants to
 912     # screw himself by passing an invalid handle, that's fine by
 913     # us.
 914     push @{$context->{"dbh_stack"}}, $context->{"dbh"};
 915     $context->{"dbh"} = $new_dbh;
 916 }
 917
 918 =head2 restore_dbh
 919
 920   C4::Context->restore_dbh;
 921
 922 Restores the database handle saved by an earlier call to
 923 C<C4::Context-E<gt>set_dbh>.
 924
 925 =cut
 926
 927 #'
 928 sub restore_dbh
 929 {
 930     my $self = shift;
 931
 932     if ($#{$context->{"dbh_stack"}} < 0)
 933     {
 934         # Stack underflow
 935         die "DBH stack underflow";
 936     }
 937
 938     # Pop the old database handle and set it.
 939     $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
 940
 941     # FIXME - If it is determined that restore_context should
 942     # return something, then this function should, too.
 943 }
 944
 945 =head2 queryparser
 946
 947   $queryparser = C4::Context->queryparser
 948
 949 Returns a handle to an initialized Koha::QueryParser::Driver::PQF object.
 950
 951 =cut
 952
 953 sub queryparser {
 954     my $self = shift;
 955     unless (defined $context->{"queryparser"}) {
 956         $context->{"queryparser"} = &_new_queryparser();
 957     }
 958
 959     return
 960       defined( $context->{"queryparser"} )
 961       ? $context->{"queryparser"}->new
 962       : undef;
 963 }
 964
 965 =head2 _new_queryparser
 966
 967 Internal helper function to create a new QueryParser object. QueryParser
 968 is loaded dynamically so as to keep the lack of the QueryParser library from
 969 getting in anyone's way.
 970
 971 =cut
 972
 973 sub _new_queryparser {
 974     my $qpmodules = {
 975         'OpenILS::QueryParser'           => undef,
 976         'Koha::QueryParser::Driver::PQF' => undef
 977     };
 978     if ( can_load( 'modules' => $qpmodules ) ) {
 979         my $QParser     = Koha::QueryParser::Driver::PQF->new();
 980         my $config_file = $context->config('queryparser_config');
 981         $config_file ||= '/etc/koha/searchengine/queryparser.yaml';
 982         if ( $QParser->load_config($config_file) ) {
 983             # TODO: allow indexes to be configured in the database
 984             return $QParser;
 985         }
 986     }
 987     return;
 988 }
 989
 990 =head2 marcfromkohafield
 991
 992   $dbh = C4::Context->marcfromkohafield;
 993
 994 Returns a hash with marcfromkohafield.
 995
 996 This hash is cached for future use: if you call
 997 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
 998
 999 =cut
1000
1001 #'
1002 sub marcfromkohafield
1003 {
1004     my $retval = {};
1005
1006     # If the hash already exists, return it.
1007     return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
1008
1009     # No hash. Create one.
1010     $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
1011
1012     return $context->{"marcfromkohafield"};
1013 }
1014
1015 # _new_marcfromkohafield
1016 # Internal helper function (not a method!). This creates a new
1017 # hash with stopwords
1018 sub _new_marcfromkohafield
1019 {
1020     my $dbh = C4::Context->dbh;
1021     my $marcfromkohafield;
1022     my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
1023     $sth->execute;
1024     while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
1025         my $retval = {};
1026         $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
1027     }
1028     return $marcfromkohafield;
1029 }
1030
1031 =head2 stopwords
1032
1033   $dbh = C4::Context->stopwords;
1034
1035 Returns a hash with stopwords.
1036
1037 This hash is cached for future use: if you call
1038 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
1039
1040 =cut
1041
1042 #'
1043 sub stopwords
1044 {
1045     my $retval = {};
1046
1047     # If the hash already exists, return it.
1048     return $context->{"stopwords"} if defined($context->{"stopwords"});
1049
1050     # No hash. Create one.
1051     $context->{"stopwords"} = &_new_stopwords();
1052
1053     return $context->{"stopwords"};
1054 }
1055
1056 # _new_stopwords
1057 # Internal helper function (not a method!). This creates a new
1058 # hash with stopwords
1059 sub _new_stopwords
1060 {
1061     my $dbh = C4::Context->dbh;
1062     my $stopwordlist;
1063     my $sth = $dbh->prepare("select word from stopwords");
1064     $sth->execute;
1065     while (my $stopword = $sth->fetchrow_array) {
1066         $stopwordlist->{$stopword} = uc($stopword);
1067     }
1068     $stopwordlist->{A} = "A" unless $stopwordlist;
1069     return $stopwordlist;
1070 }
1071
1072 =head2 userenv
1073
1074   C4::Context->userenv;
1075
1076 Retrieves a hash for user environment variables.
1077
1078 This hash shall be cached for future use: if you call
1079 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1080
1081 =cut
1082
1083 #'
1084 sub userenv {
1085     my $var = $context->{"activeuser"};
1086     if (defined $var and defined $context->{"userenv"}->{$var}) {
1087         return $context->{"userenv"}->{$var};
1088     } else {
1089         return;
1090     }
1091 }
1092
1093 =head2 set_userenv
1094
1095   C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname,
1096                   $usersurname, $userbranch, $userflags, $emailaddress, $branchprinter,
1097                   $persona);
1098
1099 Establish a hash of user environment variables.
1100
1101 set_userenv is called in Auth.pm
1102
1103 =cut
1104
1105 #'
1106 sub set_userenv {
1107     my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona)= @_;
1108     my $var=$context->{"activeuser"} || '';
1109     my $cell = {
1110         "number"     => $usernum,
1111         "id"         => $userid,
1112         "cardnumber" => $usercnum,
1113         "firstname"  => $userfirstname,
1114         "surname"    => $usersurname,
1115         #possibly a law problem
1116         "branch"     => $userbranch,
1117         "branchname" => $branchname,
1118         "flags"      => $userflags,
1119         "emailaddress"     => $emailaddress,
1120         "branchprinter"    => $branchprinter,
1121         "persona"    => $persona,
1122     };
1123     $context->{userenv}->{$var} = $cell;
1124     return $cell;
1125 }
1126
1127 sub set_shelves_userenv {
1128         my ($type, $shelves) = @_ or return;
1129         my $activeuser = $context->{activeuser} or return;
1130         $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
1131         $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
1132         $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
1133 }
1134
1135 sub get_shelves_userenv {
1136         my $active;
1137         unless ($active = $context->{userenv}->{$context->{activeuser}}) {
1138                 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
1139                 return;
1140         }
1141         my $totshelves = $active->{totshelves} or undef;
1142         my $pubshelves = $active->{pubshelves} or undef;
1143         my $barshelves = $active->{barshelves} or undef;
1144         return ($totshelves, $pubshelves, $barshelves);
1145 }
1146
1147 =head2 _new_userenv
1148
1149   C4::Context->_new_userenv($session);  # FIXME: This calling style is wrong for what looks like an _internal function
1150
1151 Builds a hash for user environment variables.
1152
1153 This hash shall be cached for future use: if you call
1154 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
1155
1156 _new_userenv is called in Auth.pm
1157
1158 =cut
1159
1160 #'
1161 sub _new_userenv
1162 {
1163     shift;  # Useless except it compensates for bad calling style
1164     my ($sessionID)= @_;
1165      $context->{"activeuser"}=$sessionID;
1166 }
1167
1168 =head2 _unset_userenv
1169
1170   C4::Context->_unset_userenv;
1171
1172 Destroys the hash for activeuser user environment variables.
1173
1174 =cut
1175
1176 #'
1177
1178 sub _unset_userenv
1179 {
1180     my ($sessionID)= @_;
1181     undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
1182 }
1183
1184
1185 =head2 get_versions
1186
1187   C4::Context->get_versions
1188
1189 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'.
1190
1191 =cut
1192
1193 #'
1194
1195 # A little example sub to show more debugging info for CGI::Carp
1196 sub get_versions {
1197     my %versions;
1198     $versions{kohaVersion}  = KOHAVERSION();
1199     $versions{kohaDbVersion} = C4::Context->preference('version');
1200     $versions{osVersion} = join(" ", POSIX::uname());
1201     $versions{perlVersion} = $];
1202     {
1203         no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
1204         $versions{mysqlVersion}  = `mysql -V`;
1205         $versions{apacheVersion} = `httpd -v`;
1206         $versions{apacheVersion} = `httpd2 -v`            unless  $versions{apacheVersion} ;
1207         $versions{apacheVersion} = `apache2 -v`           unless  $versions{apacheVersion} ;
1208         $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless  $versions{apacheVersion} ;
1209     }
1210     return %versions;
1211 }
1212
1213
1214 =head2 tz
1215
1216   C4::Context->tz
1217
1218   Returns a DateTime::TimeZone object for the system timezone
1219
1220 =cut
1221
1222 sub tz {
1223     my $self = shift;
1224     if (!defined $context->{tz}) {
1225         $context->{tz} = DateTime::TimeZone->new(name => 'local');
1226     }
1227     return $context->{tz};
1228 }
1229
1230
1231
1232 1;
1233 __END__
1234
1235 =head1 ENVIRONMENT
1236
1237 =head2 C<KOHA_CONF>
1238
1239 Specifies the configuration file to read.
1240
1241 =head1 SEE ALSO
1242
1243 XML::Simple
1244
1245 =head1 AUTHORS
1246
1247 Andrew Arensburger <arensb at ooblick dot com>
1248
1249 Joshua Ferraro <jmf at liblime dot com>
1250
1251 =cut