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