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