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