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