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 with
  16 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  17 # Suite 330, Boston, MA  02111-1307 USA
  18
  19 use strict;
  20 use vars qw($VERSION $AUTOLOAD $context @context_stack);
  21
  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         $VERSION = '3.00.00.036';
  81 }
  82
  83 use DBI;
  84 use ZOOM;
  85 use XML::Simple;
  86 use C4::Boolean;
  87 use C4::Debug;
  88
  89 =head1 NAME
  90
  91 C4::Context - Maintain and manipulate the context of a Koha script
  92
  93 =head1 SYNOPSIS
  94
  95   use C4::Context;
  96
  97   use C4::Context("/path/to/koha-conf.xml");
  98
  99   $config_value = C4::Context->config("config_variable");
 100
 101   $koha_preference = C4::Context->preference("preference");
 102
 103   $db_handle = C4::Context->dbh;
 104
 105   $Zconn = C4::Context->Zconn;
 106
 107   $stopwordhash = C4::Context->stopwords;
 108
 109 =head1 DESCRIPTION
 110
 111 When a Koha script runs, it makes use of a certain number of things:
 112 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
 113 databases, and so forth. These things make up the I<context> in which
 114 the script runs.
 115
 116 This module takes care of setting up the context for a script:
 117 figuring out which configuration file to load, and loading it, opening
 118 a connection to the right database, and so forth.
 119
 120 Most scripts will only use one context. They can simply have
 121
 122   use C4::Context;
 123
 124 at the top.
 125
 126 Other scripts may need to use several contexts. For instance, if a
 127 library has two databases, one for a certain collection, and the other
 128 for everything else, it might be necessary for a script to use two
 129 different contexts to search both databases. Such scripts should use
 130 the C<&set_context> and C<&restore_context> functions, below.
 131
 132 By default, C4::Context reads the configuration from
 133 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
 134 environment variable to the pathname of a configuration file to use.
 135
 136 =head1 METHODS
 137
 138 =over 2
 139
 140 =cut
 141
 142 #'
 143 # In addition to what is said in the POD above, a Context object is a
 144 # reference-to-hash with the following fields:
 145 #
 146 # config
 147 #    A reference-to-hash whose keys and values are the
 148 #    configuration variables and values specified in the config
 149 #    file (/etc/koha/koha-conf.xml).
 150 # dbh
 151 #    A handle to the appropriate database for this context.
 152 # dbh_stack
 153 #    Used by &set_dbh and &restore_dbh to hold other database
 154 #    handles for this context.
 155 # Zconn
 156 #     A connection object for the Zebra server
 157
 158 # Koha's main configuration file koha-conf.xml
 159 # is searched for according to this priority list:
 160 #
 161 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
 162 # 2. Path supplied in KOHA_CONF environment variable.
 163 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
 164 #    as value has changed from its default of
 165 #    '__KOHA_CONF_DIR__/koha-conf.xml', as happens
 166 #    when Koha is installed in 'standard' or 'single'
 167 #    mode.
 168 # 4. Path supplied in CONFIG_FNAME.
 169 #
 170 # The first entry that refers to a readable file is used.
 171
 172 use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
 173                 # Default config file, if none is specified
 174
 175 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
 176                 # path to config file set by installer
 177                 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
 178                 # when Koha is installed in 'standard' or 'single'
 179                 # mode.  If Koha was installed in 'dev' mode,
 180                 # __KOHA_CONF_DIR__ is *not* rewritten; instead
 181                 # developers should set the KOHA_CONF environment variable
 182
 183 $context = undef;        # Initially, no context is set
 184 @context_stack = ();        # Initially, no saved contexts
 185
 186
 187 =item KOHAVERSION
 188     returns the kohaversion stored in kohaversion.pl file
 189
 190 =cut
 191
 192 sub KOHAVERSION {
 193     my $cgidir = C4::Context->intranetdir ."/cgi-bin";
 194
 195     # 2 cases here : on CVS install, $cgidir does not need a /cgi-bin
 196     # on a standard install, /cgi-bin need to be added.
 197     # test one, then the other
 198     # FIXME - is this all really necessary?
 199     unless (opendir(DIR, "$cgidir/cataloguing/value_builder")) {
 200         $cgidir = C4::Context->intranetdir;
 201         closedir(DIR);
 202     }
 203
 204     do $cgidir."/kohaversion.pl" || die "NO $cgidir/kohaversion.pl";
 205     return kohaversion();
 206 }
 207 =item read_config_file
 208
 209 =over 4
 210
 211 Reads the specified Koha config file.
 212
 213 Returns an object containing the configuration variables. The object's
 214 structure is a bit complex to the uninitiated ... take a look at the
 215 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
 216 here are a few examples that may give you what you need:
 217
 218 The simple elements nested within the <config> element:
 219
 220     my $pass = $koha->{'config'}->{'pass'};
 221
 222 The <listen> elements:
 223
 224     my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
 225
 226 The elements nested within the <server> element:
 227
 228     my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
 229
 230 Returns undef in case of error.
 231
 232 =back
 233
 234 =cut
 235
 236 sub read_config_file {          # Pass argument naming config file to read
 237     my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo']);
 238     return $koha;                       # Return value: ref-to-hash holding the configuration
 239 }
 240
 241 # db_scheme2dbi
 242 # Translates the full text name of a database into de appropiate dbi name
 243 #
 244 sub db_scheme2dbi {
 245     my $name = shift;
 246
 247     for ($name) {
 248 # FIXME - Should have other databases.
 249         if (/mysql/i) { return("mysql"); }
 250         if (/Postgres|Pg|PostgresSQL/) { return("Pg"); }
 251         if (/oracle/i) { return("Oracle"); }
 252     }
 253     return undef;         # Just in case
 254 }
 255
 256 sub import {
 257     my $package = shift;
 258     my $conf_fname = shift;        # Config file name
 259
 260     # Create a new context from the given config file name, if
 261     # any, then set it as the current context.
 262     $context = new C4::Context($conf_fname) unless $context;
 263     return undef if !defined($context);
 264     $context->set_context;
 265 }
 266
 267 =item new
 268
 269   $context = new C4::Context;
 270   $context = new C4::Context("/path/to/koha-conf.xml");
 271
 272 Allocates a new context. Initializes the context from the specified
 273 file, which defaults to either the file given by the C<$KOHA_CONF>
 274 environment variable, or F</etc/koha/koha-conf.xml>.
 275
 276 C<&new> does not set this context as the new default context; for
 277 that, use C<&set_context>.
 278
 279 =cut
 280
 281 #'
 282 # Revision History:
 283 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
 284 sub new {
 285     my $class = shift;
 286     my $conf_fname = shift;        # Config file to load
 287     my $self = {};
 288
 289     # check that the specified config file exists and is not empty
 290     undef $conf_fname unless
 291         (defined $conf_fname && -s $conf_fname);
 292     # Figure out a good config file to load if none was specified.
 293     if (!defined($conf_fname))
 294     {
 295         # If the $KOHA_CONF environment variable is set, use
 296         # that. Otherwise, use the built-in default.
 297         if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s  $ENV{"KOHA_CONF"}) {
 298             $conf_fname = $ENV{"KOHA_CONF"};
 299         } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
 300             # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
 301             # regex to anything else -- don't want installer to rewrite it
 302             $conf_fname = $INSTALLED_CONFIG_FNAME;
 303         } elsif (-s CONFIG_FNAME) {
 304             $conf_fname = CONFIG_FNAME;
 305         } else {
 306             warn "unable to locate Koha configuration file koha-conf.xml";
 307             return undef;
 308         }
 309     }
 310         # Load the desired config file.
 311     $self = read_config_file($conf_fname);
 312     $self->{"config_file"} = $conf_fname;
 313
 314     warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
 315     return undef if !defined($self->{"config"});
 316
 317     $self->{"dbh"} = undef;        # Database handle
 318     $self->{"Zconn"} = undef;    # Zebra Connections
 319     $self->{"stopwords"} = undef; # stopwords list
 320     $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
 321     $self->{"userenv"} = undef;        # User env
 322     $self->{"activeuser"} = undef;        # current active user
 323     $self->{"shelves"} = undef;
 324
 325     bless $self, $class;
 326     return $self;
 327 }
 328
 329 =item set_context
 330
 331   $context = new C4::Context;
 332   $context->set_context();
 333 or
 334   set_context C4::Context $context;
 335
 336   ...
 337   restore_context C4::Context;
 338
 339 In some cases, it might be necessary for a script to use multiple
 340 contexts. C<&set_context> saves the current context on a stack, then
 341 sets the context to C<$context>, which will be used in future
 342 operations. To restore the previous context, use C<&restore_context>.
 343
 344 =cut
 345
 346 #'
 347 sub set_context
 348 {
 349     my $self = shift;
 350     my $new_context;    # The context to set
 351
 352     # Figure out whether this is a class or instance method call.
 353     #
 354     # We're going to make the assumption that control got here
 355     # through valid means, i.e., that the caller used an instance
 356     # or class method call, and that control got here through the
 357     # usual inheritance mechanisms. The caller can, of course,
 358     # break this assumption by playing silly buggers, but that's
 359     # harder to do than doing it properly, and harder to check
 360     # for.
 361     if (ref($self) eq "")
 362     {
 363         # Class method. The new context is the next argument.
 364         $new_context = shift;
 365     } else {
 366         # Instance method. The new context is $self.
 367         $new_context = $self;
 368     }
 369
 370     # Save the old context, if any, on the stack
 371     push @context_stack, $context if defined($context);
 372
 373     # Set the new context
 374     $context = $new_context;
 375 }
 376
 377 =item restore_context
 378
 379   &restore_context;
 380
 381 Restores the context set by C<&set_context>.
 382
 383 =cut
 384
 385 #'
 386 sub restore_context
 387 {
 388     my $self = shift;
 389
 390     if ($#context_stack < 0)
 391     {
 392         # Stack underflow.
 393         die "Context stack underflow";
 394     }
 395
 396     # Pop the old context and set it.
 397     $context = pop @context_stack;
 398
 399     # FIXME - Should this return something, like maybe the context
 400     # that was current when this was called?
 401 }
 402
 403 =item config
 404
 405   $value = C4::Context->config("config_variable");
 406
 407   $value = C4::Context->config_variable;
 408
 409 Returns the value of a variable specified in the configuration file
 410 from which the current context was created.
 411
 412 The second form is more compact, but of course may conflict with
 413 method names. If there is a configuration variable called "new", then
 414 C<C4::Config-E<gt>new> will not return it.
 415
 416 =cut
 417
 418 sub _common_config ($$) {
 419         my $var = shift;
 420         my $term = shift;
 421     return undef if !defined($context->{$term});
 422        # Presumably $self->{$term} might be
 423        # undefined if the config file given to &new
 424        # didn't exist, and the caller didn't bother
 425        # to check the return value.
 426
 427     # Return the value of the requested config variable
 428     return $context->{$term}->{$var};
 429 }
 430
 431 sub config {
 432         return _common_config($_[1],'config');
 433 }
 434 sub zebraconfig {
 435         return _common_config($_[1],'server');
 436 }
 437 sub ModZebrations {
 438         return _common_config($_[1],'serverinfo');
 439 }
 440
 441 =item preference
 442
 443   $sys_preference = C4::Context->preference("some_variable");
 444
 445 Looks up the value of the given system preference in the
 446 systempreferences table of the Koha database, and returns it. If the
 447 variable is not set, or in case of error, returns the undefined value.
 448
 449 =cut
 450
 451 #'
 452 # FIXME - The preferences aren't likely to change over the lifetime of
 453 # the script (and things might break if they did change), so perhaps
 454 # this function should cache the results it finds.
 455 sub preference
 456 {
 457     my $self = shift;
 458     my $var = shift;        # The system preference to return
 459     my $retval;            # Return value
 460     my $dbh = C4::Context->dbh or return 0;
 461     # Look up systempreferences.variable==$var
 462     $retval = $dbh->selectrow_array(<<EOT);
 463         SELECT    value
 464         FROM    systempreferences
 465         WHERE    variable='$var'
 466         LIMIT    1
 467 EOT
 468     return $retval;
 469 }
 470
 471 sub boolean_preference ($) {
 472     my $self = shift;
 473     my $var = shift;        # The system preference to return
 474     my $it = preference($self, $var);
 475     return defined($it)? C4::Boolean::true_p($it): undef;
 476 }
 477
 478 # AUTOLOAD
 479 # This implements C4::Config->foo, and simply returns
 480 # C4::Context->config("foo"), as described in the documentation for
 481 # &config, above.
 482
 483 # FIXME - Perhaps this should be extended to check &config first, and
 484 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
 485 # code, so it'd probably be best to delete it altogether so as not to
 486 # encourage people to use it.
 487 sub AUTOLOAD
 488 {
 489     my $self = shift;
 490
 491     $AUTOLOAD =~ s/.*:://;        # Chop off the package name,
 492                     # leaving only the function name.
 493     return $self->config($AUTOLOAD);
 494 }
 495
 496 =item Zconn
 497
 498 $Zconn = C4::Context->Zconn
 499
 500 Returns a connection to the Zebra database for the current
 501 context. If no connection has yet been made, this method
 502 creates one and connects.
 503
 504 C<$self>
 505
 506 C<$server> one of the servers defined in the koha-conf.xml file
 507
 508 C<$async> whether this is a asynchronous connection
 509
 510 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
 511
 512
 513 =cut
 514
 515 sub Zconn {
 516     my $self=shift;
 517     my $server=shift;
 518     my $async=shift;
 519     my $auth=shift;
 520     my $piggyback=shift;
 521     my $syntax=shift;
 522     if ( defined($context->{"Zconn"}->{$server}) && (0 == $context->{"Zconn"}->{$server}->errcode()) ) {
 523         return $context->{"Zconn"}->{$server};
 524     # No connection object or it died. Create one.
 525     }else {
 526         # release resources if we're closing a connection and making a new one
 527         # FIXME: this needs to be smarter -- an error due to a malformed query or
 528         # a missing index does not necessarily require us to close the connection
 529         # and make a new one, particularly for a batch job.  However, at
 530         # first glance it does not look like there's a way to easily check
 531         # the basic health of a ZOOM::Connection
 532         $context->{"Zconn"}->{$server}->destroy() if defined($context->{"Zconn"}->{$server});
 533
 534         $context->{"Zconn"}->{$server} = &_new_Zconn($server,$async,$auth,$piggyback,$syntax);
 535         return $context->{"Zconn"}->{$server};
 536     }
 537 }
 538
 539 =item _new_Zconn
 540
 541 $context->{"Zconn"} = &_new_Zconn($server,$async);
 542
 543 Internal function. Creates a new database connection from the data given in the current context and returns it.
 544
 545 C<$server> one of the servers defined in the koha-conf.xml file
 546
 547 C<$async> whether this is a asynchronous connection
 548
 549 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
 550
 551 =cut
 552
 553 sub _new_Zconn {
 554     my ($server,$async,$auth,$piggyback,$syntax) = @_;
 555
 556     my $tried=0; # first attempt
 557     my $Zconn; # connection object
 558     $server = "biblioserver" unless $server;
 559     $syntax = "usmarc" unless $syntax;
 560
 561     my $host = $context->{'listen'}->{$server}->{'content'};
 562     my $servername = $context->{"config"}->{$server};
 563     my $user = $context->{"serverinfo"}->{$server}->{"user"};
 564     my $password = $context->{"serverinfo"}->{$server}->{"password"};
 565  $auth = 1 if($user && $password);
 566     retry:
 567     eval {
 568         # set options
 569         my $o = new ZOOM::Options();
 570         $o->option(user=>$user) if $auth;
 571         $o->option(password=>$password) if $auth;
 572         $o->option(async => 1) if $async;
 573         $o->option(count => $piggyback) if $piggyback;
 574         $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
 575         $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
 576         $o->option(preferredRecordSyntax => $syntax);
 577         $o->option(elementSetName => "F"); # F for 'full' as opposed to B for 'brief'
 578         $o->option(databaseName => ($servername?$servername:"biblios"));
 579
 580         # create a new connection object
 581         $Zconn= create ZOOM::Connection($o);
 582
 583         # forge to server
 584         $Zconn->connect($host, 0);
 585
 586         # check for errors and warn
 587         if ($Zconn->errcode() !=0) {
 588             warn "something wrong with the connection: ". $Zconn->errmsg();
 589         }
 590
 591     };
 592 #     if ($@) {
 593 #         # Koha manages the Zebra server -- this doesn't work currently for me because of permissions issues
 594 #         # Also, I'm skeptical about whether it's the best approach
 595 #         warn "problem with Zebra";
 596 #         if ( C4::Context->preference("ManageZebra") ) {
 597 #             if ($@->code==10000 && $tried==0) { ##No connection try restarting Zebra
 598 #                 $tried=1;
 599 #                 warn "trying to restart Zebra";
 600 #                 my $res=system("zebrasrv -f $ENV{'KOHA_CONF'} >/koha/log/zebra-error.log");
 601 #                 goto "retry";
 602 #             } else {
 603 #                 warn "Error ", $@->code(), ": ", $@->message(), "\n";
 604 #                 $Zconn="error";
 605 #                 return $Zconn;
 606 #             }
 607 #         }
 608 #     }
 609     return $Zconn;
 610 }
 611
 612 # _new_dbh
 613 # Internal helper function (not a method!). This creates a new
 614 # database connection from the data given in the current context, and
 615 # returns it.
 616 sub _new_dbh
 617 {
 618
 619 ### $context
 620     ##correct name for db_schme
 621     my $db_driver;
 622     if ($context->config("db_scheme")){
 623     $db_driver=db_scheme2dbi($context->config("db_scheme"));
 624     }else{
 625     $db_driver="mysql";
 626     }
 627
 628     my $db_name   = $context->config("database");
 629     my $db_host   = $context->config("hostname");
 630     my $db_port   = $context->config("port");
 631     $db_port = "" unless defined $db_port;
 632     my $db_user   = $context->config("user");
 633     my $db_passwd = $context->config("pass");
 634     # MJR added or die here, as we can't work without dbh
 635     my $dbh= DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
 636         $db_user, $db_passwd) or die $DBI::errstr;
 637     if ( $db_driver eq 'mysql' ) {
 638         # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
 639         # this is better than modifying my.cnf (and forcing all communications to be in utf8)
 640         $dbh->{'mysql_enable_utf8'}=1; #enable
 641         $dbh->do("set NAMES 'utf8'");
 642     }
 643     elsif ( $db_driver eq 'Pg' ) {
 644             $dbh->do( "set client_encoding = 'UTF8';" );
 645     }
 646     return $dbh;
 647 }
 648
 649 =item dbh
 650
 651   $dbh = C4::Context->dbh;
 652
 653 Returns a database handle connected to the Koha database for the
 654 current context. If no connection has yet been made, this method
 655 creates one, and connects to the database.
 656
 657 This database handle is cached for future use: if you call
 658 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
 659 times. If you need a second database handle, use C<&new_dbh> and
 660 possibly C<&set_dbh>.
 661
 662 =cut
 663
 664 #'
 665 sub dbh
 666 {
 667     my $self = shift;
 668     my $sth;
 669
 670     if (defined($context->{"dbh"})) {
 671         $sth=$context->{"dbh"}->prepare("select 1");
 672         return $context->{"dbh"} if (defined($sth->execute));
 673     }
 674
 675     # No database handle or it died . Create one.
 676     $context->{"dbh"} = &_new_dbh();
 677
 678     return $context->{"dbh"};
 679 }
 680
 681 =item new_dbh
 682
 683   $dbh = C4::Context->new_dbh;
 684
 685 Creates a new connection to the Koha database for the current context,
 686 and returns the database handle (a C<DBI::db> object).
 687
 688 The handle is not saved anywhere: this method is strictly a
 689 convenience function; the point is that it knows which database to
 690 connect to so that the caller doesn't have to know.
 691
 692 =cut
 693
 694 #'
 695 sub new_dbh
 696 {
 697     my $self = shift;
 698
 699     return &_new_dbh();
 700 }
 701
 702 =item set_dbh
 703
 704   $my_dbh = C4::Connect->new_dbh;
 705   C4::Connect->set_dbh($my_dbh);
 706   ...
 707   C4::Connect->restore_dbh;
 708
 709 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
 710 C<&set_context> and C<&restore_context>.
 711
 712 C<&set_dbh> saves the current database handle on a stack, then sets
 713 the current database handle to C<$my_dbh>.
 714
 715 C<$my_dbh> is assumed to be a good database handle.
 716
 717 =cut
 718
 719 #'
 720 sub set_dbh
 721 {
 722     my $self = shift;
 723     my $new_dbh = shift;
 724
 725     # Save the current database handle on the handle stack.
 726     # We assume that $new_dbh is all good: if the caller wants to
 727     # screw himself by passing an invalid handle, that's fine by
 728     # us.
 729     push @{$context->{"dbh_stack"}}, $context->{"dbh"};
 730     $context->{"dbh"} = $new_dbh;
 731 }
 732
 733 =item restore_dbh
 734
 735   C4::Context->restore_dbh;
 736
 737 Restores the database handle saved by an earlier call to
 738 C<C4::Context-E<gt>set_dbh>.
 739
 740 =cut
 741
 742 #'
 743 sub restore_dbh
 744 {
 745     my $self = shift;
 746
 747     if ($#{$context->{"dbh_stack"}} < 0)
 748     {
 749         # Stack underflow
 750         die "DBH stack underflow";
 751     }
 752
 753     # Pop the old database handle and set it.
 754     $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
 755
 756     # FIXME - If it is determined that restore_context should
 757     # return something, then this function should, too.
 758 }
 759
 760 =item marcfromkohafield
 761
 762   $dbh = C4::Context->marcfromkohafield;
 763
 764 Returns a hash with marcfromkohafield.
 765
 766 This hash is cached for future use: if you call
 767 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
 768
 769 =cut
 770
 771 #'
 772 sub marcfromkohafield
 773 {
 774     my $retval = {};
 775
 776     # If the hash already exists, return it.
 777     return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
 778
 779     # No hash. Create one.
 780     $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
 781
 782     return $context->{"marcfromkohafield"};
 783 }
 784
 785 # _new_marcfromkohafield
 786 # Internal helper function (not a method!). This creates a new
 787 # hash with stopwords
 788 sub _new_marcfromkohafield
 789 {
 790     my $dbh = C4::Context->dbh;
 791     my $marcfromkohafield;
 792     my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
 793     $sth->execute;
 794     while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
 795         my $retval = {};
 796         $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
 797     }
 798     return $marcfromkohafield;
 799 }
 800
 801 =item stopwords
 802
 803   $dbh = C4::Context->stopwords;
 804
 805 Returns a hash with stopwords.
 806
 807 This hash is cached for future use: if you call
 808 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
 809
 810 =cut
 811
 812 #'
 813 sub stopwords
 814 {
 815     my $retval = {};
 816
 817     # If the hash already exists, return it.
 818     return $context->{"stopwords"} if defined($context->{"stopwords"});
 819
 820     # No hash. Create one.
 821     $context->{"stopwords"} = &_new_stopwords();
 822
 823     return $context->{"stopwords"};
 824 }
 825
 826 # _new_stopwords
 827 # Internal helper function (not a method!). This creates a new
 828 # hash with stopwords
 829 sub _new_stopwords
 830 {
 831     my $dbh = C4::Context->dbh;
 832     my $stopwordlist;
 833     my $sth = $dbh->prepare("select word from stopwords");
 834     $sth->execute;
 835     while (my $stopword = $sth->fetchrow_array) {
 836         my $retval = {};
 837         $stopwordlist->{$stopword} = uc($stopword);
 838     }
 839     $stopwordlist->{A} = "A" unless $stopwordlist;
 840     return $stopwordlist;
 841 }
 842
 843 =item userenv
 844
 845   C4::Context->userenv;
 846
 847 Builds a hash for user environment variables.
 848
 849 This hash shall be cached for future use: if you call
 850 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 851
 852 set_userenv is called in Auth.pm
 853
 854 =cut
 855
 856 #'
 857 sub userenv
 858 {
 859     my $var = $context->{"activeuser"};
 860     return $context->{"userenv"}->{$var} if (defined $context->{"userenv"}->{$var});
 861     # insecure=1 management
 862     if ($context->{"dbh"} && $context->preference('insecure')) {
 863         my %insecure;
 864         $insecure{flags} = '16382';
 865         $insecure{branchname} ='Insecure';
 866         $insecure{number} ='0';
 867         $insecure{cardnumber} ='0';
 868         $insecure{id} = 'insecure';
 869         $insecure{branch} = 'INS';
 870         $insecure{emailaddress} = 'test@mode.insecure.com';
 871         return \%insecure;
 872     } else {
 873         return 0;
 874     }
 875 }
 876
 877 =item set_userenv
 878
 879   C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $userflags, $emailaddress);
 880
 881 Informs a hash for user environment variables.
 882
 883 This hash shall be cached for future use: if you call
 884 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 885
 886 set_userenv is called in Auth.pm
 887
 888 =cut
 889
 890 #'
 891 sub set_userenv{
 892     my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter)= @_;
 893     my $var=$context->{"activeuser"};
 894     my $cell = {
 895         "number"     => $usernum,
 896         "id"         => $userid,
 897         "cardnumber" => $usercnum,
 898         "firstname"  => $userfirstname,
 899         "surname"    => $usersurname,
 900 #possibly a law problem
 901         "branch"     => $userbranch,
 902         "branchname" => $branchname,
 903         "flags"      => $userflags,
 904         "emailaddress"    => $emailaddress,
 905                 "branchprinter"    => $branchprinter
 906     };
 907     $context->{userenv}->{$var} = $cell;
 908     return $cell;
 909 }
 910
 911 sub set_shelves_userenv ($$) {
 912         my ($type, $shelves) = @_ or return undef;
 913         my $activeuser = $context->{activeuser} or return undef;
 914         $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
 915         $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
 916         $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
 917 }
 918
 919 sub get_shelves_userenv () {
 920         my $active;
 921         unless ($active = $context->{userenv}->{$context->{activeuser}}) {
 922                 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
 923                 return undef;
 924         }
 925         my $totshelves = $active->{totshelves} or undef;
 926         my $pubshelves = $active->{pubshelves} or undef;
 927         my $barshelves = $active->{barshelves} or undef;
 928         return ($totshelves, $pubshelves, $barshelves);
 929 }
 930
 931 =item _new_userenv
 932
 933   C4::Context->_new_userenv($session);
 934
 935 Builds a hash for user environment variables.
 936
 937 This hash shall be cached for future use: if you call
 938 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 939
 940 _new_userenv is called in Auth.pm
 941
 942 =cut
 943
 944 #'
 945 sub _new_userenv
 946 {
 947     shift;
 948     my ($sessionID)= @_;
 949      $context->{"activeuser"}=$sessionID;
 950 }
 951
 952 =item _unset_userenv
 953
 954   C4::Context->_unset_userenv;
 955
 956 Destroys the hash for activeuser user environment variables.
 957
 958 =cut
 959
 960 #'
 961
 962 sub _unset_userenv
 963 {
 964     my ($sessionID)= @_;
 965     undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
 966 }
 967
 968
 969 =item get_versions
 970
 971   C4::Context->get_versions
 972
 973 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'.
 974
 975 =cut
 976
 977 #'
 978
 979 # A little example sub to show more debugging info for CGI::Carp
 980 sub get_versions {
 981     my %versions;
 982     $versions{kohaVersion}  = KOHAVERSION();
 983     $versions{kohaDbVersion} = C4::Context->preference('version');
 984     $versions{osVersion} = `uname -a`;
 985     $versions{perlVersion} = $];
 986     $versions{mysqlVersion} = `mysql -V`;
 987     $versions{apacheVersion} =  `httpd -v`;
 988     $versions{apacheVersion} =  `httpd2 -v`            unless  $versions{apacheVersion} ;
 989     $versions{apacheVersion} =  `apache2 -v`           unless  $versions{apacheVersion} ;
 990     $versions{apacheVersion} =  `/usr/sbin/apache2 -v` unless  $versions{apacheVersion} ;
 991     return %versions;
 992 }
 993
 994
 995 1;
 996 __END__
 997
 998 =back
 999
1000 =head1 ENVIRONMENT
1001
1002 =over 4
1003
1004 =item C<KOHA_CONF>
1005
1006 Specifies the configuration file to read.
1007
1008 =back
1009
1010 =head1 SEE ALSO
1011
1012 XML::Simple
1013
1014 =head1 AUTHORS
1015
1016 Andrew Arensburger <arensb at ooblick dot com>
1017
1018 Joshua Ferraro <jmf at liblime dot com>
1019
1020 =cut
1021
1022 # Revision 1.57  2007/05/22 09:13:55  tipaul
1023 # Bugfixes & improvements (various and minor) :
1024 # - updating templates to have tmpl_process3.pl running without any errors
1025 # - adding a drupal-like css for prog templates (with 3 small images)
1026 # - fixing some bugs in circulation & other scripts
1027 # - updating french translation
1028 # - fixing some typos in templates
1029 #
1030 # Revision 1.56  2007/04/23 15:21:17  tipaul
1031 # renaming currenttransfers to transferstoreceive
1032 #
1033 # Revision 1.55  2007/04/17 08:48:00  tipaul
1034 # circulation cleaning continued: bufixing
1035 #
1036 # Revision 1.54  2007/03/29 16:45:53  tipaul
1037 # Code cleaning of Biblio.pm (continued)
1038 #
1039 # All subs have be cleaned :
1040 # - removed useless
1041 # - merged some
1042 # - reordering Biblio.pm completly
1043 # - using only naming conventions
1044 #
1045 # Seems to have broken nothing, but it still has to be heavily tested.
1046 # Note that Biblio.pm is now much more efficient than previously & probably more reliable as well.
1047 #
1048 # Revision 1.53  2007/03/29 13:30:31  tipaul
1049 # Code cleaning :
1050 # == Biblio.pm cleaning (useless) ==
1051 # * some sub declaration dropped
1052 # * removed modbiblio sub
1053 # * removed moditem sub
1054 # * removed newitems. It was used only in finishrecieve. Replaced by a TransformKohaToMarc+AddItem, that is better.
1055 # * removed MARCkoha2marcItem
1056 # * removed MARCdelsubfield declaration
1057 # * removed MARCkoha2marcBiblio
1058 #
1059 # == Biblio.pm cleaning (naming conventions) ==
1060 # * MARCgettagslib renamed to GetMarcStructure
1061 # * MARCgetitems renamed to GetMarcItem
1062 # * MARCfind_frameworkcode renamed to GetFrameworkCode
1063 # * MARCmarc2koha renamed to TransformMarcToKoha
1064 # * MARChtml2marc renamed to TransformHtmlToMarc
1065 # * MARChtml2xml renamed to TranformeHtmlToXml
1066 # * zebraop renamed to ModZebra
1067 #
1068 # == MARC=OFF ==
1069 # * removing MARC=OFF related scripts (in cataloguing directory)
1070 # * removed checkitems (function related to MARC=off feature, that is completly broken in head. If someone want to reintroduce it, hard work coming...)
1071 # * removed getitemsbybiblioitem (used only by MARC=OFF scripts, that is removed as well)
1072 #
1073 # Revision 1.52  2007/03/16 01:25:08  kados
1074 # Using my precrash CVS copy I did the following:
1075 #
1076 # cvs -z3 -d:ext:kados@cvs.savannah.nongnu.org:/sources/koha co -P koha
1077 # find koha.precrash -type d -name "CVS" -exec rm -v {} \;
1078 # cp -r koha.precrash/* koha/
1079 # cd koha/
1080 # cvs commit
1081 #
1082 # This should in theory put us right back where we were before the crash
1083 #
1084 # Revision 1.52  2007/03/12 21:17:05  rych
1085 # add server, serverinfo as arrays from config
1086 #
1087 # Revision 1.51  2007/03/09 14:31:47  tipaul
1088 # rel_3_0 moved to HEAD
1089 #
1090 # Revision 1.43.2.10  2007/02/09 17:17:56  hdl
1091 # Managing a little better database absence.
1092 # (preventing from BIG 550)
1093 #
1094 # Revision 1.43.2.9  2006/12/20 16:50:48  tipaul
1095 # improving "insecure" management
1096 #
1097 # WARNING KADOS :
1098 # you told me that you had some libraries with insecure=ON (behind a firewall).
1099 # In this commit, I created a "fake" user when insecure=ON. It has a fake branch. You may find better to have the 1st branch in branch table instead of a fake one.
1100 #
1101 # Revision 1.43.2.8  2006/12/19 16:48:16  alaurin
1102 # reident programs, and adding branchcode value in reserves
1103 #
1104 # Revision 1.43.2.7  2006/12/06 21:55:38  hdl
1105 # Adding ModZebrations for servers to get serverinfos in Context.pm
1106 # Using this function in rebuild_zebra.pl
1107 #
1108 # Revision 1.43.2.6  2006/11/24 21:18:31  kados
1109 # very minor changes, no functional ones, just comments, etc.
1110 #
1111 # Revision 1.43.2.5  2006/10/30 13:24:16  toins
1112 # fix some minor POD error.
1113 #
1114 # Revision 1.43.2.4  2006/10/12 21:42:49  hdl
1115 # Managing multiple zebra connections
1116 #
1117 # Revision 1.43.2.3  2006/10/11 14:27:26  tipaul
1118 # removing a warning
1119 #
1120 # Revision 1.43.2.2  2006/10/10 15:28:16  hdl
1121 # BUG FIXING : using database name in Zconn if defined and not hard coded value
1122 #
1123 # Revision 1.43.2.1  2006/10/06 13:47:28  toins
1124 # Synch with dev_week.
1125 #  /!\ WARNING :: Please now use the new version of koha.xml.
1126 #
1127 # Revision 1.18.2.5.2.14  2006/09/24 15:24:06  kados
1128 # remove Zebraauth routine, fold the functionality into Zconn
1129 # Zconn can now take several arguments ... this will probably
1130 # change soon as I'm not completely happy with the readability
1131 # of the current format ... see the POD for details.
1132 #
1133 # cleaning up Biblio.pm, removing unnecessary routines.
1134 #
1135 # DeleteBiblio - used to delete a biblio from zebra and koha tables
1136 #     -- checks to make sure there are no existing issues
1137 #     -- saves backups of biblio,biblioitems,items in deleted* tables
1138 #     -- does commit operation
1139 #
1140 # getRecord - used to retrieve one record from zebra in piggyback mode using biblionumber
1141 # brought back z3950_extended_services routine
1142 #
1143 # Lots of modifications to Context.pm, you can now store user and pass info for
1144 # multiple servers (for federated searching) using the <serverinfo> element.
1145 # I'll commit my koha.xml to demonstrate this or you can refer to the POD in
1146 # Context.pm (which I also expanded on).
1147 #
1148 # Revision 1.18.2.5.2.13  2006/08/10 02:10:21  kados
1149 # Turned warnings on, and running a search turned up lots of warnings.
1150 # Cleaned up those ...
1151 #
1152 # removed getitemtypes from Koha.pm (one in Search.pm looks newer)
1153 # removed itemcount from Biblio.pm
1154 #
1155 # made some local subs local with a _ prefix (as they were redefined
1156 # elsewhere)
1157 #
1158 # Add two new search subs to Search.pm the start of a new search API
1159 # that's a bit more scalable
1160 #
1161 # Revision 1.18.2.5.2.10  2006/07/21 17:50:51  kados
1162 # moving the *.properties files to intranetdir/etc dir
1163 #
1164 # Revision 1.18.2.5.2.9  2006/07/17 08:05:20  tipaul
1165 # there was a hardcoded link to /koha/etc/ I replaced it with intranetdir config value
1166 #
1167 # Revision 1.18.2.5.2.8  2006/07/11 12:20:37  kados
1168 # adding ccl and cql files ... Tumer, if you want to fit these into the
1169 # config file by all means do.
1170 #
1171 # Revision 1.18.2.5.2.7  2006/06/04 22:50:33  tgarip1957
1172 # We do not hard code cql2rpn conversion file in context.pm our koha.xml configuration file already describes the path for this file.
1173 # At cql searching we use method CQL not CQL2RPN as the cql2rpn conversion file is defined at server level
1174 #
1175 # Revision 1.18.2.5.2.6  2006/06/02 23:11:24  kados
1176 # Committing my working dev_week. It's been tested only with
1177 # searching, and there's quite a lot of config stuff to set up
1178 # beforehand. As things get closer to a release, we'll be making
1179 # some scripts to do it for us
1180 #
1181 # Revision 1.18.2.5.2.5  2006/05/28 18:49:12  tgarip1957
1182 # This is an unusual commit. The main purpose is a working model of Zebra on a modified rel2_2.
1183 # Any questions regarding these commits should be asked to Joshua Ferraro unless you are Joshua whom I'll report to
1184 #
1185 # Revision 1.36  2006/05/09 13:28:08  tipaul
1186 # adding the branchname and the librarian name in every page :
1187 # - modified userenv to add branchname
1188 # - modifier menus.inc to have the librarian name & userenv displayed on every page. they are in a librarian_information div.
1189 #
1190 # Revision 1.35  2006/04/13 08:40:11  plg
1191 # bug fixed: typo on Zconnauth name
1192 #
1193 # Revision 1.34  2006/04/10 21:40:23  tgarip1957
1194 # A new handler defined for zebra Zconnauth with read/write permission. Zconnauth should only be called in biblio.pm where write operations are. Use of this handler will break things unless koha.conf contains new variables:
1195 # zebradb=localhost
1196 # zebraport=<your port>
1197 # zebrauser=<username>
1198 # zebrapass=<password>
1199 #
1200 # The zebra.cfg file should read:
1201 # perm.anonymous:r
1202 # perm.username:rw
1203 # passw.c:<yourpasswordfile>
1204 #
1205 # Password file should be prepared with Apaches htpasswd utility in encrypted mode and should exist in a folder zebra.cfg can read
1206 #
1207 # Revision 1.33  2006/03/15 11:21:56  plg
1208 # bug fixed: utf-8 data where not displayed correctly in screens. Supposing
1209 # your data are truely utf-8 encoded in your database, they should be
1210 # correctly displayed. "set names 'UTF8'" on mysql connection (C4/Context.pm)
1211 # is mandatory and "binmode" to utf8 (C4/Interface/CGI/Output.pm) seemed to
1212 # converted data twice, so it was removed.
1213 #
1214 # Revision 1.32  2006/03/03 17:25:01  hdl
1215 # Bug fixing : a line missed a comment sign.
1216 #
1217 # Revision 1.31  2006/03/03 16:45:36  kados
1218 # Remove the search that tests the Zconn -- warning, still no fault
1219 # tollerance
1220 #
1221 # Revision 1.30  2006/02/22 00:56:59  kados
1222 # First go at a connection object for Zebra. You can now get a
1223 # connection object by doing:
1224 #
1225 # my $Zconn = C4::Context->Zconn;
1226 #
1227 # My initial tests indicate that as soon as your funcion ends
1228 # (ie, when you're done doing something) the connection will be
1229 # closed automatically. There may be some other way to make the
1230 # connection more stateful, I'm not sure...
1231 #
1232 # Local Variables:
1233 # tab-width: 4
1234 # End: