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.032';
  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     $db_port = "" unless defined $db_port;
 588     my $db_user   = $context->config("user");
 589     my $db_passwd = $context->config("pass");
 590     my $dbh= DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
 591          $db_user, $db_passwd);
 592     if ( $db_driver eq 'mysql' ) {
 593         # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
 594         # this is better than modifying my.cnf (and forcing all communications to be in utf8)
 595         $dbh->do("set NAMES 'utf8'") if ($dbh);
 596         $dbh->{'mysql_enable_utf8'}=1; #enable
 597     }
 598     elsif ( $db_driver eq 'Pg' ) {
 599             $dbh->do( "set client_encoding = 'UTF8';" );
 600     }
 601     return $dbh;
 602 }
 603
 604 =item dbh
 605
 606   $dbh = C4::Context->dbh;
 607
 608 Returns a database handle connected to the Koha database for the
 609 current context. If no connection has yet been made, this method
 610 creates one, and connects to the database.
 611
 612 This database handle is cached for future use: if you call
 613 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
 614 times. If you need a second database handle, use C<&new_dbh> and
 615 possibly C<&set_dbh>.
 616
 617 =cut
 618
 619 #'
 620 sub dbh
 621 {
 622     my $self = shift;
 623     my $sth;
 624
 625     if (defined($context->{"dbh"})) {
 626         $sth=$context->{"dbh"}->prepare("select 1");
 627         return $context->{"dbh"} if (defined($sth->execute));
 628     }
 629
 630     # No database handle or it died . Create one.
 631     $context->{"dbh"} = &_new_dbh();
 632
 633     return $context->{"dbh"};
 634 }
 635
 636 =item new_dbh
 637
 638   $dbh = C4::Context->new_dbh;
 639
 640 Creates a new connection to the Koha database for the current context,
 641 and returns the database handle (a C<DBI::db> object).
 642
 643 The handle is not saved anywhere: this method is strictly a
 644 convenience function; the point is that it knows which database to
 645 connect to so that the caller doesn't have to know.
 646
 647 =cut
 648
 649 #'
 650 sub new_dbh
 651 {
 652     my $self = shift;
 653
 654     return &_new_dbh();
 655 }
 656
 657 =item set_dbh
 658
 659   $my_dbh = C4::Connect->new_dbh;
 660   C4::Connect->set_dbh($my_dbh);
 661   ...
 662   C4::Connect->restore_dbh;
 663
 664 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
 665 C<&set_context> and C<&restore_context>.
 666
 667 C<&set_dbh> saves the current database handle on a stack, then sets
 668 the current database handle to C<$my_dbh>.
 669
 670 C<$my_dbh> is assumed to be a good database handle.
 671
 672 =cut
 673
 674 #'
 675 sub set_dbh
 676 {
 677     my $self = shift;
 678     my $new_dbh = shift;
 679
 680     # Save the current database handle on the handle stack.
 681     # We assume that $new_dbh is all good: if the caller wants to
 682     # screw himself by passing an invalid handle, that's fine by
 683     # us.
 684     push @{$context->{"dbh_stack"}}, $context->{"dbh"};
 685     $context->{"dbh"} = $new_dbh;
 686 }
 687
 688 =item restore_dbh
 689
 690   C4::Context->restore_dbh;
 691
 692 Restores the database handle saved by an earlier call to
 693 C<C4::Context-E<gt>set_dbh>.
 694
 695 =cut
 696
 697 #'
 698 sub restore_dbh
 699 {
 700     my $self = shift;
 701
 702     if ($#{$context->{"dbh_stack"}} < 0)
 703     {
 704         # Stack underflow
 705         die "DBH stack underflow";
 706     }
 707
 708     # Pop the old database handle and set it.
 709     $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
 710
 711     # FIXME - If it is determined that restore_context should
 712     # return something, then this function should, too.
 713 }
 714
 715 =item marcfromkohafield
 716
 717   $dbh = C4::Context->marcfromkohafield;
 718
 719 Returns a hash with marcfromkohafield.
 720
 721 This hash is cached for future use: if you call
 722 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
 723
 724 =cut
 725
 726 #'
 727 sub marcfromkohafield
 728 {
 729     my $retval = {};
 730
 731     # If the hash already exists, return it.
 732     return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
 733
 734     # No hash. Create one.
 735     $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
 736
 737     return $context->{"marcfromkohafield"};
 738 }
 739
 740 # _new_marcfromkohafield
 741 # Internal helper function (not a method!). This creates a new
 742 # hash with stopwords
 743 sub _new_marcfromkohafield
 744 {
 745     my $dbh = C4::Context->dbh;
 746     my $marcfromkohafield;
 747     my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
 748     $sth->execute;
 749     while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
 750         my $retval = {};
 751         $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
 752     }
 753     return $marcfromkohafield;
 754 }
 755
 756 =item stopwords
 757
 758   $dbh = C4::Context->stopwords;
 759
 760 Returns a hash with stopwords.
 761
 762 This hash is cached for future use: if you call
 763 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
 764
 765 =cut
 766
 767 #'
 768 sub stopwords
 769 {
 770     my $retval = {};
 771
 772     # If the hash already exists, return it.
 773     return $context->{"stopwords"} if defined($context->{"stopwords"});
 774
 775     # No hash. Create one.
 776     $context->{"stopwords"} = &_new_stopwords();
 777
 778     return $context->{"stopwords"};
 779 }
 780
 781 # _new_stopwords
 782 # Internal helper function (not a method!). This creates a new
 783 # hash with stopwords
 784 sub _new_stopwords
 785 {
 786     my $dbh = C4::Context->dbh;
 787     my $stopwordlist;
 788     my $sth = $dbh->prepare("select word from stopwords");
 789     $sth->execute;
 790     while (my $stopword = $sth->fetchrow_array) {
 791         my $retval = {};
 792         $stopwordlist->{$stopword} = uc($stopword);
 793     }
 794     $stopwordlist->{A} = "A" unless $stopwordlist;
 795     return $stopwordlist;
 796 }
 797
 798 =item userenv
 799
 800   C4::Context->userenv;
 801
 802 Builds a hash for user environment variables.
 803
 804 This hash shall be cached for future use: if you call
 805 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 806
 807 set_userenv is called in Auth.pm
 808
 809 =cut
 810
 811 #'
 812 sub userenv
 813 {
 814     my $var = $context->{"activeuser"};
 815     return $context->{"userenv"}->{$var} if (defined $context->{"userenv"}->{$var});
 816     # insecure=1 management
 817     if ($context->{"dbh"} && $context->preference('insecure')) {
 818         my %insecure;
 819         $insecure{flags} = '16382';
 820         $insecure{branchname} ='Insecure',
 821         $insecure{number} ='0';
 822         $insecure{cardnumber} ='0';
 823         $insecure{id} = 'insecure';
 824         $insecure{branch} = 'INS';
 825         $insecure{emailaddress} = 'test@mode.insecure.com';
 826         return \%insecure;
 827     } else {
 828         return 0;
 829     }
 830 }
 831
 832 =item set_userenv
 833
 834   C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $userflags, $emailaddress);
 835
 836 Informs a hash for user environment variables.
 837
 838 This hash shall be cached for future use: if you call
 839 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 840
 841 set_userenv is called in Auth.pm
 842
 843 =cut
 844
 845 #'
 846 sub set_userenv{
 847     my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter)= @_;
 848     my $var=$context->{"activeuser"};
 849     my $cell = {
 850         "number"     => $usernum,
 851         "id"         => $userid,
 852         "cardnumber" => $usercnum,
 853         "firstname"  => $userfirstname,
 854         "surname"    => $usersurname,
 855 #possibly a law problem
 856         "branch"     => $userbranch,
 857         "branchname" => $branchname,
 858         "flags"      => $userflags,
 859         "emailaddress"    => $emailaddress,
 860                 "branchprinter"    => $branchprinter
 861     };
 862     $context->{userenv}->{$var} = $cell;
 863     return $cell;
 864 }
 865
 866 =item _new_userenv
 867
 868   C4::Context->_new_userenv($session);
 869
 870 Builds a hash for user environment variables.
 871
 872 This hash shall be cached for future use: if you call
 873 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 874
 875 _new_userenv is called in Auth.pm
 876
 877 =cut
 878
 879 #'
 880 sub _new_userenv
 881 {
 882     shift;
 883     my ($sessionID)= @_;
 884      $context->{"activeuser"}=$sessionID;
 885 }
 886
 887 =item _unset_userenv
 888
 889   C4::Context->_unset_userenv;
 890
 891 Destroys the hash for activeuser user environment variables.
 892
 893 =cut
 894
 895 #'
 896
 897 sub _unset_userenv
 898 {
 899     my ($sessionID)= @_;
 900     undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
 901 }
 902
 903
 904 =item get_versions
 905
 906   C4::Context->get_versions
 907
 908 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'.
 909
 910 =cut
 911
 912 #'
 913
 914 # A little example sub to show more debugging info for CGI::Carp
 915 sub get_versions {
 916     my %versions;
 917     $versions{kohaVersion}  = C4::Context->config("kohaversion");
 918     $versions{osVersion} = `uname -a`;
 919     $versions{perlVersion} = $];
 920     $versions{mysqlVersion} = `mysql -V`;
 921     $versions{apacheVersion} =  `httpd -v`;
 922     $versions{apacheVersion} =  `httpd2 -v`            unless  $versions{apacheVersion} ;
 923     $versions{apacheVersion} =  `apache2 -v`           unless  $versions{apacheVersion} ;
 924     $versions{apacheVersion} =  `/usr/sbin/apache2 -v` unless  $versions{apacheVersion} ;
 925     return %versions;
 926 }
 927
 928
 929 1;
 930 __END__
 931
 932 =back
 933
 934 =head1 ENVIRONMENT
 935
 936 =over 4
 937
 938 =item C<KOHA_CONF>
 939
 940 Specifies the configuration file to read.
 941
 942 =back
 943
 944 =head1 SEE ALSO
 945
 946 =head1 AUTHORS
 947
 948 Andrew Arensburger <arensb at ooblick dot com>
 949
 950 Joshua Ferraro <jmf at liblime dot com>
 951
 952 =cut
 953
 954 # Revision 1.57  2007/05/22 09:13:55  tipaul
 955 # Bugfixes & improvements (various and minor) :
 956 # - updating templates to have tmpl_process3.pl running without any errors
 957 # - adding a drupal-like css for prog templates (with 3 small images)
 958 # - fixing some bugs in circulation & other scripts
 959 # - updating french translation
 960 # - fixing some typos in templates
 961 #
 962 # Revision 1.56  2007/04/23 15:21:17  tipaul
 963 # renaming currenttransfers to transferstoreceive
 964 #
 965 # Revision 1.55  2007/04/17 08:48:00  tipaul
 966 # circulation cleaning continued: bufixing
 967 #
 968 # Revision 1.54  2007/03/29 16:45:53  tipaul
 969 # Code cleaning of Biblio.pm (continued)
 970 #
 971 # All subs have be cleaned :
 972 # - removed useless
 973 # - merged some
 974 # - reordering Biblio.pm completly
 975 # - using only naming conventions
 976 #
 977 # Seems to have broken nothing, but it still has to be heavily tested.
 978 # Note that Biblio.pm is now much more efficient than previously & probably more reliable as well.
 979 #
 980 # Revision 1.53  2007/03/29 13:30:31  tipaul
 981 # Code cleaning :
 982 # == Biblio.pm cleaning (useless) ==
 983 # * some sub declaration dropped
 984 # * removed modbiblio sub
 985 # * removed moditem sub
 986 # * removed newitems. It was used only in finishrecieve. Replaced by a TransformKohaToMarc+AddItem, that is better.
 987 # * removed MARCkoha2marcItem
 988 # * removed MARCdelsubfield declaration
 989 # * removed MARCkoha2marcBiblio
 990 #
 991 # == Biblio.pm cleaning (naming conventions) ==
 992 # * MARCgettagslib renamed to GetMarcStructure
 993 # * MARCgetitems renamed to GetMarcItem
 994 # * MARCfind_frameworkcode renamed to GetFrameworkCode
 995 # * MARCmarc2koha renamed to TransformMarcToKoha
 996 # * MARChtml2marc renamed to TransformHtmlToMarc
 997 # * MARChtml2xml renamed to TranformeHtmlToXml
 998 # * zebraop renamed to ModZebra
 999 #
1000 # == MARC=OFF ==
1001 # * removing MARC=OFF related scripts (in cataloguing directory)
1002 # * removed checkitems (function related to MARC=off feature, that is completly broken in head. If someone want to reintroduce it, hard work coming...)
1003 # * removed getitemsbybiblioitem (used only by MARC=OFF scripts, that is removed as well)
1004 #
1005 # Revision 1.52  2007/03/16 01:25:08  kados
1006 # Using my precrash CVS copy I did the following:
1007 #
1008 # cvs -z3 -d:ext:kados@cvs.savannah.nongnu.org:/sources/koha co -P koha
1009 # find koha.precrash -type d -name "CVS" -exec rm -v {} \;
1010 # cp -r koha.precrash/* koha/
1011 # cd koha/
1012 # cvs commit
1013 #
1014 # This should in theory put us right back where we were before the crash
1015 #
1016 # Revision 1.52  2007/03/12 21:17:05  rych
1017 # add server, serverinfo as arrays from config
1018 #
1019 # Revision 1.51  2007/03/09 14:31:47  tipaul
1020 # rel_3_0 moved to HEAD
1021 #
1022 # Revision 1.43.2.10  2007/02/09 17:17:56  hdl
1023 # Managing a little better database absence.
1024 # (preventing from BIG 550)
1025 #
1026 # Revision 1.43.2.9  2006/12/20 16:50:48  tipaul
1027 # improving "insecure" management
1028 #
1029 # WARNING KADOS :
1030 # you told me that you had some libraries with insecure=ON (behind a firewall).
1031 # 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.
1032 #
1033 # Revision 1.43.2.8  2006/12/19 16:48:16  alaurin
1034 # reident programs, and adding branchcode value in reserves
1035 #
1036 # Revision 1.43.2.7  2006/12/06 21:55:38  hdl
1037 # Adding ModZebrations for servers to get serverinfos in Context.pm
1038 # Using this function in rebuild_zebra.pl
1039 #
1040 # Revision 1.43.2.6  2006/11/24 21:18:31  kados
1041 # very minor changes, no functional ones, just comments, etc.
1042 #
1043 # Revision 1.43.2.5  2006/10/30 13:24:16  toins
1044 # fix some minor POD error.
1045 #
1046 # Revision 1.43.2.4  2006/10/12 21:42:49  hdl
1047 # Managing multiple zebra connections
1048 #
1049 # Revision 1.43.2.3  2006/10/11 14:27:26  tipaul
1050 # removing a warning
1051 #
1052 # Revision 1.43.2.2  2006/10/10 15:28:16  hdl
1053 # BUG FIXING : using database name in Zconn if defined and not hard coded value
1054 #
1055 # Revision 1.43.2.1  2006/10/06 13:47:28  toins
1056 # Synch with dev_week.
1057 #  /!\ WARNING :: Please now use the new version of koha.xml.
1058 #
1059 # Revision 1.18.2.5.2.14  2006/09/24 15:24:06  kados
1060 # remove Zebraauth routine, fold the functionality into Zconn
1061 # Zconn can now take several arguments ... this will probably
1062 # change soon as I'm not completely happy with the readability
1063 # of the current format ... see the POD for details.
1064 #
1065 # cleaning up Biblio.pm, removing unnecessary routines.
1066 #
1067 # DeleteBiblio - used to delete a biblio from zebra and koha tables
1068 #     -- checks to make sure there are no existing issues
1069 #     -- saves backups of biblio,biblioitems,items in deleted* tables
1070 #     -- does commit operation
1071 #
1072 # getRecord - used to retrieve one record from zebra in piggyback mode using biblionumber
1073 # brought back z3950_extended_services routine
1074 #
1075 # Lots of modifications to Context.pm, you can now store user and pass info for
1076 # multiple servers (for federated searching) using the <serverinfo> element.
1077 # I'll commit my koha.xml to demonstrate this or you can refer to the POD in
1078 # Context.pm (which I also expanded on).
1079 #
1080 # Revision 1.18.2.5.2.13  2006/08/10 02:10:21  kados
1081 # Turned warnings on, and running a search turned up lots of warnings.
1082 # Cleaned up those ...
1083 #
1084 # removed getitemtypes from Koha.pm (one in Search.pm looks newer)
1085 # removed itemcount from Biblio.pm
1086 #
1087 # made some local subs local with a _ prefix (as they were redefined
1088 # elsewhere)
1089 #
1090 # Add two new search subs to Search.pm the start of a new search API
1091 # that's a bit more scalable
1092 #
1093 # Revision 1.18.2.5.2.10  2006/07/21 17:50:51  kados
1094 # moving the *.properties files to intranetdir/etc dir
1095 #
1096 # Revision 1.18.2.5.2.9  2006/07/17 08:05:20  tipaul
1097 # there was a hardcoded link to /koha/etc/ I replaced it with intranetdir config value
1098 #
1099 # Revision 1.18.2.5.2.8  2006/07/11 12:20:37  kados
1100 # adding ccl and cql files ... Tumer, if you want to fit these into the
1101 # config file by all means do.
1102 #
1103 # Revision 1.18.2.5.2.7  2006/06/04 22:50:33  tgarip1957
1104 # We do not hard code cql2rpn conversion file in context.pm our koha.xml configuration file already describes the path for this file.
1105 # At cql searching we use method CQL not CQL2RPN as the cql2rpn conversion file is defined at server level
1106 #
1107 # Revision 1.18.2.5.2.6  2006/06/02 23:11:24  kados
1108 # Committing my working dev_week. It's been tested only with
1109 # searching, and there's quite a lot of config stuff to set up
1110 # beforehand. As things get closer to a release, we'll be making
1111 # some scripts to do it for us
1112 #
1113 # Revision 1.18.2.5.2.5  2006/05/28 18:49:12  tgarip1957
1114 # This is an unusual commit. The main purpose is a working model of Zebra on a modified rel2_2.
1115 # Any questions regarding these commits should be asked to Joshua Ferraro unless you are Joshua whom I'll report to
1116 #
1117 # Revision 1.36  2006/05/09 13:28:08  tipaul
1118 # adding the branchname and the librarian name in every page :
1119 # - modified userenv to add branchname
1120 # - modifier menus.inc to have the librarian name & userenv displayed on every page. they are in a librarian_information div.
1121 #
1122 # Revision 1.35  2006/04/13 08:40:11  plg
1123 # bug fixed: typo on Zconnauth name
1124 #
1125 # Revision 1.34  2006/04/10 21:40:23  tgarip1957
1126 # 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:
1127 # zebradb=localhost
1128 # zebraport=<your port>
1129 # zebrauser=<username>
1130 # zebrapass=<password>
1131 #
1132 # The zebra.cfg file should read:
1133 # perm.anonymous:r
1134 # perm.username:rw
1135 # passw.c:<yourpasswordfile>
1136 #
1137 # Password file should be prepared with Apaches htpasswd utility in encrypted mode and should exist in a folder zebra.cfg can read
1138 #
1139 # Revision 1.33  2006/03/15 11:21:56  plg
1140 # bug fixed: utf-8 data where not displayed correctly in screens. Supposing
1141 # your data are truely utf-8 encoded in your database, they should be
1142 # correctly displayed. "set names 'UTF8'" on mysql connection (C4/Context.pm)
1143 # is mandatory and "binmode" to utf8 (C4/Interface/CGI/Output.pm) seemed to
1144 # converted data twice, so it was removed.
1145 #
1146 # Revision 1.32  2006/03/03 17:25:01  hdl
1147 # Bug fixing : a line missed a comment sign.
1148 #
1149 # Revision 1.31  2006/03/03 16:45:36  kados
1150 # Remove the search that tests the Zconn -- warning, still no fault
1151 # tollerance
1152 #
1153 # Revision 1.30  2006/02/22 00:56:59  kados
1154 # First go at a connection object for Zebra. You can now get a
1155 # connection object by doing:
1156 #
1157 # my $Zconn = C4::Context->Zconn;
1158 #
1159 # My initial tests indicate that as soon as your funcion ends
1160 # (ie, when you're done doing something) the connection will be
1161 # closed automatically. There may be some other way to make the
1162 # connection more stateful, I'm not sure...
1163 #
1164 # Local Variables:
1165 # tab-width: 4
1166 # End: