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