2 # Copyright 2002 Katipo Communications
4 # This file is part of Koha.
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
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.
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
20 use vars qw($VERSION $AUTOLOAD $context @context_stack);
23 if ($ENV{'HTTP_USER_AGENT'}) {
25 # FIXME for future reference, CGI::Carp doc says
26 # "Note that fatalsToBrowser does not work with mod_perl version 2.0 and higher."
27 import CGI::Carp qw(fatalsToBrowser);
30 my $debug_level = C4::Context->preference("DebugLevel");
32 print q(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
33 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
34 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
35 <head><title>Koha Error</title></head>
38 if ($debug_level eq "2"){
39 # debug 2 , print extra info too.
40 my %versions = get_versions();
42 # a little example table with various version info";
45 <p>The following fatal error has occurred:</p>
46 <pre><code>$msg</code></pre>
48 <tr><th>Apache</th><td> $versions{apacheVersion}</td></tr>
49 <tr><th>Koha</th><td> $versions{kohaVersion}</td></tr>
50 <tr><th>Koha DB</th><td> $versions{kohaDbVersion}</td></tr>
51 <tr><th>MySQL</th><td> $versions{mysqlVersion}</td></tr>
52 <tr><th>OS</th><td> $versions{osVersion}</td></tr>
53 <tr><th>Perl</th><td> $versions{perlVersion}</td></tr>
56 } elsif ($debug_level eq "1"){
59 <p>The following fatal error has occurred:</p>
60 <pre><code>$msg</code></pre>";
62 print "<p>production mode - trapped fatal error</p>";
64 print "</body></html>";
66 CGI::Carp::set_message(\&handle_errors);
67 ## give a stack backtrace if KOHA_BACKTRACES is set
68 ## can't rely on DebugLevel for this, as we're not yet connected
69 if ($ENV{KOHA_BACKTRACES}) {
70 $main::SIG{__DIE__} = \&CGI::Carp::confess;
72 } # else there is no browser to send fatals to!
73 $VERSION = '3.00.00.036';
84 C4::Context - Maintain and manipulate the context of a Koha script
90 use C4::Context("/path/to/koha-conf.xml");
92 $config_value = C4::Context->config("config_variable");
94 $koha_preference = C4::Context->preference("preference");
96 $db_handle = C4::Context->dbh;
98 $Zconn = C4::Context->Zconn;
100 $stopwordhash = C4::Context->stopwords;
104 When a Koha script runs, it makes use of a certain number of things:
105 configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
106 databases, and so forth. These things make up the I<context> in which
109 This module takes care of setting up the context for a script:
110 figuring out which configuration file to load, and loading it, opening
111 a connection to the right database, and so forth.
113 Most scripts will only use one context. They can simply have
119 Other scripts may need to use several contexts. For instance, if a
120 library has two databases, one for a certain collection, and the other
121 for everything else, it might be necessary for a script to use two
122 different contexts to search both databases. Such scripts should use
123 the C<&set_context> and C<&restore_context> functions, below.
125 By default, C4::Context reads the configuration from
126 F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
127 environment variable to the pathname of a configuration file to use.
136 # In addition to what is said in the POD above, a Context object is a
137 # reference-to-hash with the following fields:
140 # A reference-to-hash whose keys and values are the
141 # configuration variables and values specified in the config
142 # file (/etc/koha/koha-conf.xml).
144 # A handle to the appropriate database for this context.
146 # Used by &set_dbh and &restore_dbh to hold other database
147 # handles for this context.
149 # A connection object for the Zebra server
151 # Koha's main configuration file koha-conf.xml
152 # is searched for according to this priority list:
154 # 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
155 # 2. Path supplied in KOHA_CONF environment variable.
156 # 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
157 # as value has changed from its default of
158 # '__KOHA_CONF_DIR__/koha-conf.xml', as happens
159 # when Koha is installed in 'standard' or 'single'
161 # 4. Path supplied in CONFIG_FNAME.
163 # The first entry that refers to a readable file is used.
165 use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
166 # Default config file, if none is specified
168 my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
169 # path to config file set by installer
170 # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
171 # when Koha is installed in 'standard' or 'single'
172 # mode. If Koha was installed in 'dev' mode,
173 # __KOHA_CONF_DIR__ is *not* rewritten; instead
174 # developers should set the KOHA_CONF environment variable
176 $context = undef; # Initially, no context is set
177 @context_stack = (); # Initially, no saved contexts
181 returns the kohaversion stored in kohaversion.pl file
186 my $cgidir = C4::Context->intranetdir ."/cgi-bin";
188 # 2 cases here : on CVS install, $cgidir does not need a /cgi-bin
189 # on a standard install, /cgi-bin need to be added.
190 # test one, then the other
191 # FIXME - is this all really necessary?
192 unless (opendir(DIR, "$cgidir/cataloguing/value_builder")) {
193 $cgidir = C4::Context->intranetdir;
197 do $cgidir."/kohaversion.pl" || die "NO $cgidir/kohaversion.pl";
198 return kohaversion();
200 =item read_config_file
204 Reads the specified Koha config file.
206 Returns an object containing the configuration variables. The object's
207 structure is a bit complex to the uninitiated ... take a look at the
208 koha-conf.xml file as well as the XML::Simple documentation for details. Or,
209 here are a few examples that may give you what you need:
211 The simple elements nested within the <config> element:
213 my $pass = $koha->{'config'}->{'pass'};
215 The <listen> elements:
217 my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
219 The elements nested within the <server> element:
221 my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
223 Returns undef in case of error.
229 sub read_config_file { # Pass argument naming config file to read
230 my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo']);
231 return $koha; # Return value: ref-to-hash holding the configuration
235 # Translates the full text name of a database into de appropiate dbi name
241 # FIXME - Should have other databases.
242 if (/mysql/i) { return("mysql"); }
243 if (/Postgres|Pg|PostgresSQL/) { return("Pg"); }
244 if (/oracle/i) { return("Oracle"); }
246 return undef; # Just in case
251 my $conf_fname = shift; # Config file name
254 # Create a new context from the given config file name, if
255 # any, then set it as the current context.
256 $context = new C4::Context($conf_fname) unless $context;
257 return undef if !defined($context);
258 $context->set_context;
263 $context = new C4::Context;
264 $context = new C4::Context("/path/to/koha-conf.xml");
266 Allocates a new context. Initializes the context from the specified
267 file, which defaults to either the file given by the C<$KOHA_CONF>
268 environment variable, or F</etc/koha/koha-conf.xml>.
270 C<&new> does not set this context as the new default context; for
271 that, use C<&set_context>.
277 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
280 my $conf_fname = shift; # Config file to load
283 # check that the specified config file exists and is not empty
284 undef $conf_fname unless
285 (defined $conf_fname && -s $conf_fname);
286 # Figure out a good config file to load if none was specified.
287 if (!defined($conf_fname))
289 # If the $KOHA_CONF environment variable is set, use
290 # that. Otherwise, use the built-in default.
291 if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s $ENV{"KOHA_CONF"}) {
292 $conf_fname = $ENV{"KOHA_CONF"};
293 } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
294 # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
295 # regex to anything else -- don't want installer to rewrite it
296 $conf_fname = $INSTALLED_CONFIG_FNAME;
297 } elsif (-s CONFIG_FNAME) {
298 $conf_fname = CONFIG_FNAME;
300 warn "unable to locate Koha configuration file koha-conf.xml";
304 # Load the desired config file.
305 $self = read_config_file($conf_fname);
306 $self->{"config_file"} = $conf_fname;
308 warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
309 return undef if !defined($self->{"config"});
311 $self->{"dbh"} = undef; # Database handle
312 $self->{"Zconn"} = undef; # Zebra Connections
313 $self->{"stopwords"} = undef; # stopwords list
314 $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
315 $self->{"userenv"} = undef; # User env
316 $self->{"activeuser"} = undef; # current active user
317 $self->{"shelves"} = undef;
325 $context = new C4::Context;
326 $context->set_context();
328 set_context C4::Context $context;
331 restore_context C4::Context;
333 In some cases, it might be necessary for a script to use multiple
334 contexts. C<&set_context> saves the current context on a stack, then
335 sets the context to C<$context>, which will be used in future
336 operations. To restore the previous context, use C<&restore_context>.
344 my $new_context; # The context to set
346 # Figure out whether this is a class or instance method call.
348 # We're going to make the assumption that control got here
349 # through valid means, i.e., that the caller used an instance
350 # or class method call, and that control got here through the
351 # usual inheritance mechanisms. The caller can, of course,
352 # break this assumption by playing silly buggers, but that's
353 # harder to do than doing it properly, and harder to check
355 if (ref($self) eq "")
357 # Class method. The new context is the next argument.
358 $new_context = shift;
360 # Instance method. The new context is $self.
361 $new_context = $self;
364 # Save the old context, if any, on the stack
365 push @context_stack, $context if defined($context);
367 # Set the new context
368 $context = $new_context;
371 =item restore_context
375 Restores the context set by C<&set_context>.
384 if ($#context_stack < 0)
387 die "Context stack underflow";
390 # Pop the old context and set it.
391 $context = pop @context_stack;
393 # FIXME - Should this return something, like maybe the context
394 # that was current when this was called?
399 $value = C4::Context->config("config_variable");
401 $value = C4::Context->config_variable;
403 Returns the value of a variable specified in the configuration file
404 from which the current context was created.
406 The second form is more compact, but of course may conflict with
407 method names. If there is a configuration variable called "new", then
408 C<C4::Config-E<gt>new> will not return it.
412 sub _common_config ($$) {
415 return undef if !defined($context->{$term});
416 # Presumably $self->{$term} might be
417 # undefined if the config file given to &new
418 # didn't exist, and the caller didn't bother
419 # to check the return value.
421 # Return the value of the requested config variable
422 return $context->{$term}->{$var};
426 return _common_config($_[1],'config');
429 return _common_config($_[1],'server');
432 return _common_config($_[1],'serverinfo');
437 $sys_preference = C4::Context->preference("some_variable");
439 Looks up the value of the given system preference in the
440 systempreferences table of the Koha database, and returns it. If the
441 variable is not set, or in case of error, returns the undefined value.
446 # FIXME - The preferences aren't likely to change over the lifetime of
447 # the script (and things might break if they did change), so perhaps
448 # this function should cache the results it finds.
452 my $var = shift; # The system preference to return
453 my $retval; # Return value
454 my $dbh = C4::Context->dbh or return 0;
455 # Look up systempreferences.variable==$var
456 $retval = $dbh->selectrow_array(<<EOT);
458 FROM systempreferences
459 WHERE variable='$var'
465 sub boolean_preference ($) {
467 my $var = shift; # The system preference to return
468 my $it = preference($self, $var);
469 return defined($it)? C4::Boolean::true_p($it): undef;
473 # This implements C4::Config->foo, and simply returns
474 # C4::Context->config("foo"), as described in the documentation for
477 # FIXME - Perhaps this should be extended to check &config first, and
478 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
479 # code, so it'd probably be best to delete it altogether so as not to
480 # encourage people to use it.
485 $AUTOLOAD =~ s/.*:://; # Chop off the package name,
486 # leaving only the function name.
487 return $self->config($AUTOLOAD);
492 $Zconn = C4::Context->Zconn
494 Returns a connection to the Zebra database for the current
495 context. If no connection has yet been made, this method
496 creates one and connects.
500 C<$server> one of the servers defined in the koha-conf.xml file
502 C<$async> whether this is a asynchronous connection
504 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
516 if ( defined($context->{"Zconn"}->{$server}) && (0 == $context->{"Zconn"}->{$server}->errcode()) ) {
517 return $context->{"Zconn"}->{$server};
518 # No connection object or it died. Create one.
520 # release resources if we're closing a connection and making a new one
521 # FIXME: this needs to be smarter -- an error due to a malformed query or
522 # a missing index does not necessarily require us to close the connection
523 # and make a new one, particularly for a batch job. However, at
524 # first glance it does not look like there's a way to easily check
525 # the basic health of a ZOOM::Connection
526 $context->{"Zconn"}->{$server}->destroy() if defined($context->{"Zconn"}->{$server});
528 $context->{"Zconn"}->{$server} = &_new_Zconn($server,$async,$auth,$piggyback,$syntax);
529 return $context->{"Zconn"}->{$server};
535 $context->{"Zconn"} = &_new_Zconn($server,$async);
537 Internal function. Creates a new database connection from the data given in the current context and returns it.
539 C<$server> one of the servers defined in the koha-conf.xml file
541 C<$async> whether this is a asynchronous connection
543 C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
548 my ($server,$async,$auth,$piggyback,$syntax) = @_;
550 my $tried=0; # first attempt
551 my $Zconn; # connection object
552 $server = "biblioserver" unless $server;
553 $syntax = "usmarc" unless $syntax;
555 my $host = $context->{'listen'}->{$server}->{'content'};
556 my $servername = $context->{"config"}->{$server};
557 my $user = $context->{"serverinfo"}->{$server}->{"user"};
558 my $password = $context->{"serverinfo"}->{$server}->{"password"};
559 $auth = 1 if($user && $password);
563 my $o = new ZOOM::Options();
564 $o->option(user=>$user) if $auth;
565 $o->option(password=>$password) if $auth;
566 $o->option(async => 1) if $async;
567 $o->option(count => $piggyback) if $piggyback;
568 $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
569 $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
570 $o->option(preferredRecordSyntax => $syntax);
571 $o->option(elementSetName => "F"); # F for 'full' as opposed to B for 'brief'
572 $o->option(databaseName => ($servername?$servername:"biblios"));
574 # create a new connection object
575 $Zconn= create ZOOM::Connection($o);
578 $Zconn->connect($host, 0);
580 # check for errors and warn
581 if ($Zconn->errcode() !=0) {
582 warn "something wrong with the connection: ". $Zconn->errmsg();
587 # # Koha manages the Zebra server -- this doesn't work currently for me because of permissions issues
588 # # Also, I'm skeptical about whether it's the best approach
589 # warn "problem with Zebra";
590 # if ( C4::Context->preference("ManageZebra") ) {
591 # if ($@->code==10000 && $tried==0) { ##No connection try restarting Zebra
593 # warn "trying to restart Zebra";
594 # my $res=system("zebrasrv -f $ENV{'KOHA_CONF'} >/koha/log/zebra-error.log");
597 # warn "Error ", $@->code(), ": ", $@->message(), "\n";
607 # Internal helper function (not a method!). This creates a new
608 # database connection from the data given in the current context, and
614 ##correct name for db_schme
616 if ($context->config("db_scheme")){
617 $db_driver=db_scheme2dbi($context->config("db_scheme"));
622 my $db_name = $context->config("database");
623 my $db_host = $context->config("hostname");
624 my $db_port = $context->config("port");
625 $db_port = "" unless defined $db_port;
626 my $db_user = $context->config("user");
627 my $db_passwd = $context->config("pass");
628 # MJR added or die here, as we can't work without dbh
629 my $dbh= DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
630 $db_user, $db_passwd) or die $DBI::errstr;
631 if ( $db_driver eq 'mysql' ) {
632 # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
633 # this is better than modifying my.cnf (and forcing all communications to be in utf8)
634 $dbh->{'mysql_enable_utf8'}=1; #enable
635 $dbh->do("set NAMES 'utf8'");
637 elsif ( $db_driver eq 'Pg' ) {
638 $dbh->do( "set client_encoding = 'UTF8';" );
645 $dbh = C4::Context->dbh;
647 Returns a database handle connected to the Koha database for the
648 current context. If no connection has yet been made, this method
649 creates one, and connects to the database.
651 This database handle is cached for future use: if you call
652 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
653 times. If you need a second database handle, use C<&new_dbh> and
654 possibly C<&set_dbh>.
664 if (defined($context->{"dbh"})) {
665 $sth=$context->{"dbh"}->prepare("select 1");
666 return $context->{"dbh"} if (defined($sth->execute));
669 # No database handle or it died . Create one.
670 $context->{"dbh"} = &_new_dbh();
672 return $context->{"dbh"};
677 $dbh = C4::Context->new_dbh;
679 Creates a new connection to the Koha database for the current context,
680 and returns the database handle (a C<DBI::db> object).
682 The handle is not saved anywhere: this method is strictly a
683 convenience function; the point is that it knows which database to
684 connect to so that the caller doesn't have to know.
698 $my_dbh = C4::Connect->new_dbh;
699 C4::Connect->set_dbh($my_dbh);
701 C4::Connect->restore_dbh;
703 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
704 C<&set_context> and C<&restore_context>.
706 C<&set_dbh> saves the current database handle on a stack, then sets
707 the current database handle to C<$my_dbh>.
709 C<$my_dbh> is assumed to be a good database handle.
719 # Save the current database handle on the handle stack.
720 # We assume that $new_dbh is all good: if the caller wants to
721 # screw himself by passing an invalid handle, that's fine by
723 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
724 $context->{"dbh"} = $new_dbh;
729 C4::Context->restore_dbh;
731 Restores the database handle saved by an earlier call to
732 C<C4::Context-E<gt>set_dbh>.
741 if ($#{$context->{"dbh_stack"}} < 0)
744 die "DBH stack underflow";
747 # Pop the old database handle and set it.
748 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
750 # FIXME - If it is determined that restore_context should
751 # return something, then this function should, too.
754 =item marcfromkohafield
756 $dbh = C4::Context->marcfromkohafield;
758 Returns a hash with marcfromkohafield.
760 This hash is cached for future use: if you call
761 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
766 sub marcfromkohafield
770 # If the hash already exists, return it.
771 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
773 # No hash. Create one.
774 $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
776 return $context->{"marcfromkohafield"};
779 # _new_marcfromkohafield
780 # Internal helper function (not a method!). This creates a new
781 # hash with stopwords
782 sub _new_marcfromkohafield
784 my $dbh = C4::Context->dbh;
785 my $marcfromkohafield;
786 my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
788 while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
790 $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
792 return $marcfromkohafield;
797 $dbh = C4::Context->stopwords;
799 Returns a hash with stopwords.
801 This hash is cached for future use: if you call
802 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
811 # If the hash already exists, return it.
812 return $context->{"stopwords"} if defined($context->{"stopwords"});
814 # No hash. Create one.
815 $context->{"stopwords"} = &_new_stopwords();
817 return $context->{"stopwords"};
821 # Internal helper function (not a method!). This creates a new
822 # hash with stopwords
825 my $dbh = C4::Context->dbh;
827 my $sth = $dbh->prepare("select word from stopwords");
829 while (my $stopword = $sth->fetchrow_array) {
831 $stopwordlist->{$stopword} = uc($stopword);
833 $stopwordlist->{A} = "A" unless $stopwordlist;
834 return $stopwordlist;
839 C4::Context->userenv;
841 Builds a hash for user environment variables.
843 This hash shall be cached for future use: if you call
844 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
846 set_userenv is called in Auth.pm
853 my $var = $context->{"activeuser"};
854 return $context->{"userenv"}->{$var} if (defined $context->{"userenv"}->{$var});
855 # insecure=1 management
856 if ($context->{"dbh"} && $context->preference('insecure')) {
858 $insecure{flags} = '16382';
859 $insecure{branchname} ='Insecure';
860 $insecure{number} ='0';
861 $insecure{cardnumber} ='0';
862 $insecure{id} = 'insecure';
863 $insecure{branch} = 'INS';
864 $insecure{emailaddress} = 'test@mode.insecure.com';
873 C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $userflags, $emailaddress);
875 Informs a hash for user environment variables.
877 This hash shall be cached for future use: if you call
878 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
880 set_userenv is called in Auth.pm
886 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter)= @_;
887 my $var=$context->{"activeuser"};
889 "number" => $usernum,
891 "cardnumber" => $usercnum,
892 "firstname" => $userfirstname,
893 "surname" => $usersurname,
894 #possibly a law problem
895 "branch" => $userbranch,
896 "branchname" => $branchname,
897 "flags" => $userflags,
898 "emailaddress" => $emailaddress,
899 "branchprinter" => $branchprinter
901 $context->{userenv}->{$var} = $cell;
905 sub set_shelves_userenv ($$) {
906 my ($type, $shelves) = @_ or return undef;
907 my $activeuser = $context->{activeuser} or return undef;
908 $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
909 $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
912 sub get_shelves_userenv () {
914 unless ($active = $context->{userenv}->{$context->{activeuser}}) {
915 $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
918 my $pubshelves = $active->{pubshelves} or undef;
919 my $barshelves = $active->{barshelves} or undef;# die "get_shelves_userenv: activeenv has no ->{shelves}";
920 return $pubshelves, $barshelves;
925 C4::Context->_new_userenv($session);
927 Builds a hash for user environment variables.
929 This hash shall be cached for future use: if you call
930 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
932 _new_userenv is called in Auth.pm
941 $context->{"activeuser"}=$sessionID;
946 C4::Context->_unset_userenv;
948 Destroys the hash for activeuser user environment variables.
957 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
963 C4::Context->get_versions
965 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'.
971 # A little example sub to show more debugging info for CGI::Carp
974 $versions{kohaVersion} = KOHAVERSION();
975 $versions{kohaDbVersion} = C4::Context->preference('version');
976 $versions{osVersion} = `uname -a`;
977 $versions{perlVersion} = $];
978 $versions{mysqlVersion} = `mysql -V`;
979 $versions{apacheVersion} = `httpd -v`;
980 $versions{apacheVersion} = `httpd2 -v` unless $versions{apacheVersion} ;
981 $versions{apacheVersion} = `apache2 -v` unless $versions{apacheVersion} ;
982 $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless $versions{apacheVersion} ;
998 Specifies the configuration file to read.
1008 Andrew Arensburger <arensb at ooblick dot com>
1010 Joshua Ferraro <jmf at liblime dot com>
1014 # Revision 1.57 2007/05/22 09:13:55 tipaul
1015 # Bugfixes & improvements (various and minor) :
1016 # - updating templates to have tmpl_process3.pl running without any errors
1017 # - adding a drupal-like css for prog templates (with 3 small images)
1018 # - fixing some bugs in circulation & other scripts
1019 # - updating french translation
1020 # - fixing some typos in templates
1022 # Revision 1.56 2007/04/23 15:21:17 tipaul
1023 # renaming currenttransfers to transferstoreceive
1025 # Revision 1.55 2007/04/17 08:48:00 tipaul
1026 # circulation cleaning continued: bufixing
1028 # Revision 1.54 2007/03/29 16:45:53 tipaul
1029 # Code cleaning of Biblio.pm (continued)
1031 # All subs have be cleaned :
1034 # - reordering Biblio.pm completly
1035 # - using only naming conventions
1037 # Seems to have broken nothing, but it still has to be heavily tested.
1038 # Note that Biblio.pm is now much more efficient than previously & probably more reliable as well.
1040 # Revision 1.53 2007/03/29 13:30:31 tipaul
1042 # == Biblio.pm cleaning (useless) ==
1043 # * some sub declaration dropped
1044 # * removed modbiblio sub
1045 # * removed moditem sub
1046 # * removed newitems. It was used only in finishrecieve. Replaced by a TransformKohaToMarc+AddItem, that is better.
1047 # * removed MARCkoha2marcItem
1048 # * removed MARCdelsubfield declaration
1049 # * removed MARCkoha2marcBiblio
1051 # == Biblio.pm cleaning (naming conventions) ==
1052 # * MARCgettagslib renamed to GetMarcStructure
1053 # * MARCgetitems renamed to GetMarcItem
1054 # * MARCfind_frameworkcode renamed to GetFrameworkCode
1055 # * MARCmarc2koha renamed to TransformMarcToKoha
1056 # * MARChtml2marc renamed to TransformHtmlToMarc
1057 # * MARChtml2xml renamed to TranformeHtmlToXml
1058 # * zebraop renamed to ModZebra
1061 # * removing MARC=OFF related scripts (in cataloguing directory)
1062 # * removed checkitems (function related to MARC=off feature, that is completly broken in head. If someone want to reintroduce it, hard work coming...)
1063 # * removed getitemsbybiblioitem (used only by MARC=OFF scripts, that is removed as well)
1065 # Revision 1.52 2007/03/16 01:25:08 kados
1066 # Using my precrash CVS copy I did the following:
1068 # cvs -z3 -d:ext:kados@cvs.savannah.nongnu.org:/sources/koha co -P koha
1069 # find koha.precrash -type d -name "CVS" -exec rm -v {} \;
1070 # cp -r koha.precrash/* koha/
1074 # This should in theory put us right back where we were before the crash
1076 # Revision 1.52 2007/03/12 21:17:05 rych
1077 # add server, serverinfo as arrays from config
1079 # Revision 1.51 2007/03/09 14:31:47 tipaul
1080 # rel_3_0 moved to HEAD
1082 # Revision 1.43.2.10 2007/02/09 17:17:56 hdl
1083 # Managing a little better database absence.
1084 # (preventing from BIG 550)
1086 # Revision 1.43.2.9 2006/12/20 16:50:48 tipaul
1087 # improving "insecure" management
1090 # you told me that you had some libraries with insecure=ON (behind a firewall).
1091 # 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.
1093 # Revision 1.43.2.8 2006/12/19 16:48:16 alaurin
1094 # reident programs, and adding branchcode value in reserves
1096 # Revision 1.43.2.7 2006/12/06 21:55:38 hdl
1097 # Adding ModZebrations for servers to get serverinfos in Context.pm
1098 # Using this function in rebuild_zebra.pl
1100 # Revision 1.43.2.6 2006/11/24 21:18:31 kados
1101 # very minor changes, no functional ones, just comments, etc.
1103 # Revision 1.43.2.5 2006/10/30 13:24:16 toins
1104 # fix some minor POD error.
1106 # Revision 1.43.2.4 2006/10/12 21:42:49 hdl
1107 # Managing multiple zebra connections
1109 # Revision 1.43.2.3 2006/10/11 14:27:26 tipaul
1110 # removing a warning
1112 # Revision 1.43.2.2 2006/10/10 15:28:16 hdl
1113 # BUG FIXING : using database name in Zconn if defined and not hard coded value
1115 # Revision 1.43.2.1 2006/10/06 13:47:28 toins
1116 # Synch with dev_week.
1117 # /!\ WARNING :: Please now use the new version of koha.xml.
1119 # Revision 1.18.2.5.2.14 2006/09/24 15:24:06 kados
1120 # remove Zebraauth routine, fold the functionality into Zconn
1121 # Zconn can now take several arguments ... this will probably
1122 # change soon as I'm not completely happy with the readability
1123 # of the current format ... see the POD for details.
1125 # cleaning up Biblio.pm, removing unnecessary routines.
1127 # DeleteBiblio - used to delete a biblio from zebra and koha tables
1128 # -- checks to make sure there are no existing issues
1129 # -- saves backups of biblio,biblioitems,items in deleted* tables
1130 # -- does commit operation
1132 # getRecord - used to retrieve one record from zebra in piggyback mode using biblionumber
1133 # brought back z3950_extended_services routine
1135 # Lots of modifications to Context.pm, you can now store user and pass info for
1136 # multiple servers (for federated searching) using the <serverinfo> element.
1137 # I'll commit my koha.xml to demonstrate this or you can refer to the POD in
1138 # Context.pm (which I also expanded on).
1140 # Revision 1.18.2.5.2.13 2006/08/10 02:10:21 kados
1141 # Turned warnings on, and running a search turned up lots of warnings.
1142 # Cleaned up those ...
1144 # removed getitemtypes from Koha.pm (one in Search.pm looks newer)
1145 # removed itemcount from Biblio.pm
1147 # made some local subs local with a _ prefix (as they were redefined
1150 # Add two new search subs to Search.pm the start of a new search API
1151 # that's a bit more scalable
1153 # Revision 1.18.2.5.2.10 2006/07/21 17:50:51 kados
1154 # moving the *.properties files to intranetdir/etc dir
1156 # Revision 1.18.2.5.2.9 2006/07/17 08:05:20 tipaul
1157 # there was a hardcoded link to /koha/etc/ I replaced it with intranetdir config value
1159 # Revision 1.18.2.5.2.8 2006/07/11 12:20:37 kados
1160 # adding ccl and cql files ... Tumer, if you want to fit these into the
1161 # config file by all means do.
1163 # Revision 1.18.2.5.2.7 2006/06/04 22:50:33 tgarip1957
1164 # We do not hard code cql2rpn conversion file in context.pm our koha.xml configuration file already describes the path for this file.
1165 # At cql searching we use method CQL not CQL2RPN as the cql2rpn conversion file is defined at server level
1167 # Revision 1.18.2.5.2.6 2006/06/02 23:11:24 kados
1168 # Committing my working dev_week. It's been tested only with
1169 # searching, and there's quite a lot of config stuff to set up
1170 # beforehand. As things get closer to a release, we'll be making
1171 # some scripts to do it for us
1173 # Revision 1.18.2.5.2.5 2006/05/28 18:49:12 tgarip1957
1174 # This is an unusual commit. The main purpose is a working model of Zebra on a modified rel2_2.
1175 # Any questions regarding these commits should be asked to Joshua Ferraro unless you are Joshua whom I'll report to
1177 # Revision 1.36 2006/05/09 13:28:08 tipaul
1178 # adding the branchname and the librarian name in every page :
1179 # - modified userenv to add branchname
1180 # - modifier menus.inc to have the librarian name & userenv displayed on every page. they are in a librarian_information div.
1182 # Revision 1.35 2006/04/13 08:40:11 plg
1183 # bug fixed: typo on Zconnauth name
1185 # Revision 1.34 2006/04/10 21:40:23 tgarip1957
1186 # 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:
1188 # zebraport=<your port>
1189 # zebrauser=<username>
1190 # zebrapass=<password>
1192 # The zebra.cfg file should read:
1195 # passw.c:<yourpasswordfile>
1197 # Password file should be prepared with Apaches htpasswd utility in encrypted mode and should exist in a folder zebra.cfg can read
1199 # Revision 1.33 2006/03/15 11:21:56 plg
1200 # bug fixed: utf-8 data where not displayed correctly in screens. Supposing
1201 # your data are truely utf-8 encoded in your database, they should be
1202 # correctly displayed. "set names 'UTF8'" on mysql connection (C4/Context.pm)
1203 # is mandatory and "binmode" to utf8 (C4/Interface/CGI/Output.pm) seemed to
1204 # converted data twice, so it was removed.
1206 # Revision 1.32 2006/03/03 17:25:01 hdl
1207 # Bug fixing : a line missed a comment sign.
1209 # Revision 1.31 2006/03/03 16:45:36 kados
1210 # Remove the search that tests the Zconn -- warning, still no fault
1213 # Revision 1.30 2006/02/22 00:56:59 kados
1214 # First go at a connection object for Zebra. You can now get a
1215 # connection object by doing:
1217 # my $Zconn = C4::Context->Zconn;
1219 # My initial tests indicate that as soon as your funcion ends
1220 # (ie, when you're done doing something) the connection will be
1221 # closed automatically. There may be some other way to make the
1222 # connection more stateful, I'm not sure...