Bug 7935: Introduce sys pref to control 'browse results' in OPAC
[koha_gimpoz] / C4 / Context.pm
index 3fc51f6..67d31ee 100644 (file)
@@ -1,3 +1,4 @@
+package C4::Context;
 # Copyright 2002 Katipo Communications
 #
 # This file is part of Koha.
 # Copyright 2002 Katipo Communications
 #
 # This file is part of Koha.
 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 #
 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
-
-# $Id$
-# Revision History:
-# 2004-08-11 A. Tarallo: Added the function db_escheme2dbi, tested my bugfixes,
-# further  details about them in the code.
-# 2004-11-23 A. Tarallo, E. Silva: Bugfixes for running in a mod_perl environment.
-# Clean up of previous bugfixes, better documentation of what was done. 
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 
-package C4::Context;
 use strict;
 use strict;
+use warnings;
+use vars qw($VERSION $AUTOLOAD $context @context_stack $servers $memcached $ismemcached);
+
+BEGIN {
+       if ($ENV{'HTTP_USER_AGENT'})    {
+               require CGI::Carp;
+        # FIXME for future reference, CGI::Carp doc says
+        #  "Note that fatalsToBrowser does not work with mod_perl version 2.0 and higher."
+               import CGI::Carp qw(fatalsToBrowser);
+                       sub handle_errors {
+                           my $msg = shift;
+                           my $debug_level;
+                           eval {C4::Context->dbh();};
+                           if ($@){
+                               $debug_level = 1;
+                           } 
+                           else {
+                               $debug_level =  C4::Context->preference("DebugLevel");
+                           }
+
+                print q(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+                            "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+                       <html lang="en" xml:lang="en"  xmlns="http://www.w3.org/1999/xhtml">
+                       <head><title>Koha Error</title></head>
+                       <body>
+                );
+                               if ($debug_level eq "2"){
+                                       # debug 2 , print extra info too.
+                                       my %versions = get_versions();
+
+               # a little example table with various version info";
+                                       print "
+                                               <h1>Koha error</h1>
+                                               <p>The following fatal error has occurred:</p> 
+                        <pre><code>$msg</code></pre>
+                                               <table>
+                                               <tr><th>Apache</th><td>  $versions{apacheVersion}</td></tr>
+                                               <tr><th>Koha</th><td>    $versions{kohaVersion}</td></tr>
+                                               <tr><th>Koha DB</th><td> $versions{kohaDbVersion}</td></tr>
+                                               <tr><th>MySQL</th><td>   $versions{mysqlVersion}</td></tr>
+                                               <tr><th>OS</th><td>      $versions{osVersion}</td></tr>
+                                               <tr><th>Perl</th><td>    $versions{perlVersion}</td></tr>
+                                               </table>";
+
+                               } elsif ($debug_level eq "1"){
+                                       print "
+                                               <h1>Koha error</h1>
+                                               <p>The following fatal error has occurred:</p> 
+                        <pre><code>$msg</code></pre>";
+                               } else {
+                                       print "<p>production mode - trapped fatal error</p>";
+                               }       
+                print "</body></html>";
+                       }
+               #CGI::Carp::set_message(\&handle_errors);
+               ## give a stack backtrace if KOHA_BACKTRACES is set
+               ## can't rely on DebugLevel for this, as we're not yet connected
+               if ($ENV{KOHA_BACKTRACES}) {
+                       $main::SIG{__DIE__} = \&CGI::Carp::confess;
+               }
+    }          # else there is no browser to send fatals to!
+
+    # Check if there are memcached servers set
+    $servers = $ENV{'MEMCACHED_SERVERS'};
+    if ($servers) {
+        # Load required libraries and create the memcached object
+        require Cache::Memcached;
+        $memcached = Cache::Memcached->new({
+        servers => [ $servers ],
+        debug   => 0,
+        compress_threshold => 10_000,
+        expire_time => 600,
+        namespace => $ENV{'MEMCACHED_NAMESPACE'} || 'koha'
+    });
+        # Verify memcached available (set a variable and test the output)
+    $ismemcached = $memcached->set('ismemcached','1');
+    }
+
+    $VERSION = '3.00.00.036';
+}
+
 use DBI;
 use DBI;
+use ZOOM;
+use XML::Simple;
 use C4::Boolean;
 use C4::Boolean;
-
-use vars qw($VERSION $AUTOLOAD),
-       qw($context),
-       qw(@context_stack);
-
-$VERSION = do { my @v = '$Revision$' =~ /\d+/g;
-               shift(@v) . "." . join("_", map {sprintf "%03d", $_ } @v); };
+use C4::Debug;
+use POSIX ();
+use DateTime::TimeZone;
 
 =head1 NAME
 
 
 =head1 NAME
 
@@ -42,17 +114,23 @@ C4::Context - Maintain and manipulate the context of a Koha script
 
   use C4::Context;
 
 
   use C4::Context;
 
-  use C4::Context("/path/to/koha.conf");
+  use C4::Context("/path/to/koha-conf.xml");
 
   $config_value = C4::Context->config("config_variable");
 
   $config_value = C4::Context->config("config_variable");
+
+  $koha_preference = C4::Context->preference("preference");
+
   $db_handle = C4::Context->dbh;
   $db_handle = C4::Context->dbh;
+
+  $Zconn = C4::Context->Zconn;
+
   $stopwordhash = C4::Context->stopwords;
 
 =head1 DESCRIPTION
 
 When a Koha script runs, it makes use of a certain number of things:
   $stopwordhash = C4::Context->stopwords;
 
 =head1 DESCRIPTION
 
 When a Koha script runs, it makes use of a certain number of things:
-configuration settings in F</etc/koha.conf>, a connection to the Koha
-database, and so forth. These things make up the I<context> in which
+configuration settings in F</etc/koha/koha-conf.xml>, a connection to the Koha
+databases, and so forth. These things make up the I<context> in which
 the script runs.
 
 This module takes care of setting up the context for a script:
 the script runs.
 
 This module takes care of setting up the context for a script:
@@ -72,174 +150,248 @@ different contexts to search both databases. Such scripts should use
 the C<&set_context> and C<&restore_context> functions, below.
 
 By default, C4::Context reads the configuration from
 the C<&set_context> and C<&restore_context> functions, below.
 
 By default, C4::Context reads the configuration from
-F</etc/koha.conf>. This may be overridden by setting the C<$KOHA_CONF>
+F</etc/koha/koha-conf.xml>. This may be overridden by setting the C<$KOHA_CONF>
 environment variable to the pathname of a configuration file to use.
 
 =head1 METHODS
 
 environment variable to the pathname of a configuration file to use.
 
 =head1 METHODS
 
-=over 2
-
 =cut
 =cut
+
 #'
 # In addition to what is said in the POD above, a Context object is a
 # reference-to-hash with the following fields:
 #
 # config
 #'
 # In addition to what is said in the POD above, a Context object is a
 # reference-to-hash with the following fields:
 #
 # config
-#      A reference-to-hash whose keys and values are the
-#      configuration variables and values specified in the config
-#      file (/etc/koha.conf).
+#    A reference-to-hash whose keys and values are the
+#    configuration variables and values specified in the config
+#    file (/etc/koha/koha-conf.xml).
 # dbh
 # dbh
-#      A handle to the appropriate database for this context.
+#    A handle to the appropriate database for this context.
 # dbh_stack
 # dbh_stack
-#      Used by &set_dbh and &restore_dbh to hold other database
-#      handles for this context.
+#    Used by &set_dbh and &restore_dbh to hold other database
+#    handles for this context.
+# Zconn
+#     A connection object for the Zebra server
 
 
-use constant CONFIG_FNAME => "/etc/koha.conf";
-                               # Default config file, if none is specified
-
-$context = undef;              # Initially, no context is set
-@context_stack = ();           # Initially, no saved contexts
-
-# read_config_file
-# Reads the specified Koha config file. Returns a reference-to-hash
-# whose keys are the configuration variables, and whose values are the
-# configuration values (duh).
-# Returns undef in case of error.
+# Koha's main configuration file koha-conf.xml
+# is searched for according to this priority list:
 #
 #
-# Revision History:
-# 2004-08-10 A. Tarallo: Added code that checks if a variable is already
-# assigned and prints a message, otherwise create a new entry in the hash to
-# be returned. 
-# Also added code that complaints if finds a line that isn't a variable 
-# assignmet and skips the line.
-# Added a quick hack that makes the translation between the db_schema
-# and the DBI driver for that schema.
+# 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
+# 2. Path supplied in KOHA_CONF environment variable.
+# 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
+#    as value has changed from its default of 
+#    '__KOHA_CONF_DIR__/koha-conf.xml', as happens
+#    when Koha is installed in 'standard' or 'single'
+#    mode.
+# 4. Path supplied in CONFIG_FNAME.
 #
 #
-sub read_config_file
-{
-       my $fname = shift;      # Config file to read
-       my $retval = {};        # Return value: ref-to-hash holding the
-                               # configuration
-
-       open (CONF, $fname) or return undef;
-
-       while (<CONF>)
-       {
-               my $var;                # Variable name
-               my $value;              # Variable value
-
-               chomp;
-               s/#.*//;                # Strip comments
-               next if /^\s*$/;        # Ignore blank lines
-
-               # Look for a line of the form
-               #       var = value
-               if (!/^\s*(\w+)\s*=\s*(.*?)\s*$/)
-               {
-                       print STDERR 
-                               "$_ isn't a variable assignment, skipping it";
-                       next;
-               }
+# The first entry that refers to a readable file is used.
 
 
-               # Found a variable assignment
-               if ( exists $retval->{$1} )
-               {
-                       print STDERR "$var was already defined, ignoring\n";
-               }else{
-               # Quick hack for allowing databases name in full text
-                       if ( $1 eq "db_scheme" )
-                       {
-                               $value = db_scheme2dbi($2);
-                       }else {
-                               $value = $2;
-                       }
-                        $retval->{$1} = $value;
-               }
-       }
-       close CONF;
+use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
+                # Default config file, if none is specified
+                
+my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
+                # path to config file set by installer
+                # __KOHA_CONF_DIR__ is set by rewrite-confg.PL
+                # when Koha is installed in 'standard' or 'single'
+                # mode.  If Koha was installed in 'dev' mode, 
+                # __KOHA_CONF_DIR__ is *not* rewritten; instead
+                # developers should set the KOHA_CONF environment variable 
+
+$context = undef;        # Initially, no context is set
+@context_stack = ();        # Initially, no saved contexts
+
+
+=head2 KOHAVERSION
+
+returns the kohaversion stored in kohaversion.pl file
+
+=cut
+
+sub KOHAVERSION {
+    my $cgidir = C4::Context->intranetdir;
+
+    # Apparently the GIT code does not run out of a CGI-BIN subdirectory
+    # but distribution code does?  (Stan, 1jan08)
+    if(-d $cgidir . "/cgi-bin"){
+        my $cgidir .= "/cgi-bin";
+    }
+    
+    do $cgidir."/kohaversion.pl" || die "NO $cgidir/kohaversion.pl";
+    return kohaversion();
+}
+=head2 read_config_file
+
+Reads the specified Koha config file. 
+
+Returns an object containing the configuration variables. The object's
+structure is a bit complex to the uninitiated ... take a look at the
+koha-conf.xml file as well as the XML::Simple documentation for details. Or,
+here are a few examples that may give you what you need:
+
+The simple elements nested within the <config> element:
+
+    my $pass = $koha->{'config'}->{'pass'};
+
+The <listen> elements:
+
+    my $listen = $koha->{'listen'}->{'biblioserver'}->{'content'};
+
+The elements nested within the <server> element:
+
+    my $ccl2rpn = $koha->{'server'}->{'biblioserver'}->{'cql2rpn'};
+
+Returns undef in case of error.
+
+=cut
+
+sub read_config_file {         # Pass argument naming config file to read
+    my $koha = XMLin(shift, keyattr => ['id'], forcearray => ['listen', 'server', 'serverinfo'], suppressempty => '');
+
+    if ($ismemcached) {
+      $memcached->set('kohaconf',$koha);
+    }
+
+    return $koha;                      # Return value: ref-to-hash holding the configuration
+}
+
+=head2 ismemcached
+
+Returns the value of the $ismemcached variable (0/1)
 
 
-       return $retval;
+=cut
+
+sub ismemcached {
+    return $ismemcached;
+}
+
+=head2 memcached
+
+If $ismemcached is true, returns the $memcache variable.
+Returns undef otherwise
+
+=cut
+
+sub memcached {
+    if ($ismemcached) {
+      return $memcached;
+    } else {
+      return undef;
+    }
 }
 
 # db_scheme2dbi
 # Translates the full text name of a database into de appropiate dbi name
 # 
 }
 
 # db_scheme2dbi
 # Translates the full text name of a database into de appropiate dbi name
 # 
-sub db_scheme2dbi
-{
-       my $name = shift;
-
-       for ($name) {
+sub db_scheme2dbi {
+    my $name = shift;
+    # for instance, we support only mysql, so don't care checking
+    return "mysql";
+    for ($name) {
 # FIXME - Should have other databases. 
 # FIXME - Should have other databases. 
-               if (/mysql/i) { return("mysql"); }
-               if (/Postgres|Pg|PostgresSQL/) { return("Pg"); }
-               if (/oracle/i) { return("Oracle"); }
-       }
-       return undef;           # Just in case
+        if (/mysql/) { return("mysql"); }
+        if (/Postgres|Pg|PostgresSQL/) { return("Pg"); }
+        if (/oracle/) { return("Oracle"); }
+    }
+    return undef;         # Just in case
 }
 
 }
 
-sub import
-{
-       my $package = shift;
-       my $conf_fname = shift;         # Config file name
-       my $context;
+sub import {
+    # Create the default context ($C4::Context::Context)
+    # the first time the module is called
+    # (a config file can be optionaly passed)
+
+    # default context allready exists? 
+    return if $context;
 
 
-       # Create a new context from the given config file name, if
-       # any, then set it as the current context.
-       $context = new C4::Context($conf_fname);
-       return undef if !defined($context);
-       $context->set_context;
+    # no ? so load it!
+    my ($pkg,$config_file) = @_ ;
+    my $new_ctx = __PACKAGE__->new($config_file);
+    return unless $new_ctx;
+
+    # if successfully loaded, use it by default
+    $new_ctx->set_context;
+    1;
 }
 
 }
 
-=item new
+=head2 new
 
   $context = new C4::Context;
 
   $context = new C4::Context;
-  $context = new C4::Context("/path/to/koha.conf");
+  $context = new C4::Context("/path/to/koha-conf.xml");
 
 Allocates a new context. Initializes the context from the specified
 file, which defaults to either the file given by the C<$KOHA_CONF>
 
 Allocates a new context. Initializes the context from the specified
 file, which defaults to either the file given by the C<$KOHA_CONF>
-environment variable, or F</etc/koha.conf>.
+environment variable, or F</etc/koha/koha-conf.xml>.
+
+It saves the koha-conf.xml values in the declared memcached server(s)
+if currently available and uses those values until them expire and
+re-reads them.
 
 C<&new> does not set this context as the new default context; for
 that, use C<&set_context>.
 
 =cut
 
 C<&new> does not set this context as the new default context; for
 that, use C<&set_context>.
 
 =cut
+
 #'
 # Revision History:
 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
 #'
 # Revision History:
 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
-sub new
-{
-       my $class = shift;
-       my $conf_fname = shift;         # Config file to load
-       my $self = {};
-
-       # check that the specified config file exists and is not empty
-       undef $conf_fname unless 
-           (defined $conf_fname && -e $conf_fname && -s $conf_fname);
-       # Figure out a good config file to load if none was specified.
-       if (!defined($conf_fname))
-       {
-               # If the $KOHA_CONF environment variable is set, use
-               # that. Otherwise, use the built-in default.
-               $conf_fname = $ENV{"KOHA_CONF"} || CONFIG_FNAME;
-       }
-       $self->{"config_file"} = $conf_fname;
-
-       # Load the desired config file.
-       $self->{"config"} = &read_config_file($conf_fname);
-       warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
-       return undef if !defined($self->{"config"});
-
-       $self->{"dbh"} = undef;         # Database handle
-       $self->{"stopwords"} = undef; # stopwords list
-       $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
-       $self->{"userenv"} = undef;             # User env
-       $self->{"activeuser"} = undef;          # current active user
-
-       bless $self, $class;
-       return $self;
+sub new {
+    my $class = shift;
+    my $conf_fname = shift;        # Config file to load
+    my $self = {};
+
+    # check that the specified config file exists and is not empty
+    undef $conf_fname unless 
+        (defined $conf_fname && -s $conf_fname);
+    # Figure out a good config file to load if none was specified.
+    if (!defined($conf_fname))
+    {
+        # If the $KOHA_CONF environment variable is set, use
+        # that. Otherwise, use the built-in default.
+        if (exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s  $ENV{"KOHA_CONF"}) {
+            $conf_fname = $ENV{"KOHA_CONF"};
+        } elsif ($INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME) {
+            # NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
+            # regex to anything else -- don't want installer to rewrite it
+            $conf_fname = $INSTALLED_CONFIG_FNAME;
+        } elsif (-s CONFIG_FNAME) {
+            $conf_fname = CONFIG_FNAME;
+        } else {
+            warn "unable to locate Koha configuration file koha-conf.xml";
+            return undef;
+        }
+    }
+    
+    if ($ismemcached) {
+        # retreive from memcached
+        $self = $memcached->get('kohaconf');
+        if (not defined $self) {
+            # not in memcached yet
+            $self = read_config_file($conf_fname);
+        }
+    } else {
+        # non-memcached env, read from file
+        $self = read_config_file($conf_fname);
+    }
+
+    $self->{"config_file"} = $conf_fname;
+    warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
+    return undef if !defined($self->{"config"});
+
+    $self->{"dbh"} = undef;        # Database handle
+    $self->{"Zconn"} = undef;    # Zebra Connections
+    $self->{"stopwords"} = undef; # stopwords list
+    $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
+    $self->{"userenv"} = undef;        # User env
+    $self->{"activeuser"} = undef;        # current active user
+    $self->{"shelves"} = undef;
+    $self->{tz} = undef; # local timezone object
+
+    bless $self, $class;
+    return $self;
 }
 
 }
 
-=item set_context
+=head2 set_context
 
   $context = new C4::Context;
   $context->set_context();
 
   $context = new C4::Context;
   $context->set_context();
@@ -255,63 +407,65 @@ sets the context to C<$context>, which will be used in future
 operations. To restore the previous context, use C<&restore_context>.
 
 =cut
 operations. To restore the previous context, use C<&restore_context>.
 
 =cut
+
 #'
 sub set_context
 {
 #'
 sub set_context
 {
-       my $self = shift;
-       my $new_context;        # The context to set
-
-       # Figure out whether this is a class or instance method call.
-       #
-       # We're going to make the assumption that control got here
-       # through valid means, i.e., that the caller used an instance
-       # or class method call, and that control got here through the
-       # usual inheritance mechanisms. The caller can, of course,
-       # break this assumption by playing silly buggers, but that's
-       # harder to do than doing it properly, and harder to check
-       # for.
-       if (ref($self) eq "")
-       {
-               # Class method. The new context is the next argument.
-               $new_context = shift;
-       } else {
-               # Instance method. The new context is $self.
-               $new_context = $self;
-       }
-
-       # Save the old context, if any, on the stack
-       push @context_stack, $context if defined($context);
-
-       # Set the new context
-       $context = $new_context;
+    my $self = shift;
+    my $new_context;    # The context to set
+
+    # Figure out whether this is a class or instance method call.
+    #
+    # We're going to make the assumption that control got here
+    # through valid means, i.e., that the caller used an instance
+    # or class method call, and that control got here through the
+    # usual inheritance mechanisms. The caller can, of course,
+    # break this assumption by playing silly buggers, but that's
+    # harder to do than doing it properly, and harder to check
+    # for.
+    if (ref($self) eq "")
+    {
+        # Class method. The new context is the next argument.
+        $new_context = shift;
+    } else {
+        # Instance method. The new context is $self.
+        $new_context = $self;
+    }
+
+    # Save the old context, if any, on the stack
+    push @context_stack, $context if defined($context);
+
+    # Set the new context
+    $context = $new_context;
 }
 
 }
 
-=item restore_context
+=head2 restore_context
 
   &restore_context;
 
 Restores the context set by C<&set_context>.
 
 =cut
 
   &restore_context;
 
 Restores the context set by C<&set_context>.
 
 =cut
+
 #'
 sub restore_context
 {
 #'
 sub restore_context
 {
-       my $self = shift;
+    my $self = shift;
 
 
-       if ($#context_stack < 0)
-       {
-               # Stack underflow.
-               die "Context stack underflow";
-       }
+    if ($#context_stack < 0)
+    {
+        # Stack underflow.
+        die "Context stack underflow";
+    }
 
 
-       # Pop the old context and set it.
-       $context = pop @context_stack;
+    # Pop the old context and set it.
+    $context = pop @context_stack;
 
 
-       # FIXME - Should this return something, like maybe the context
-       # that was current when this was called?
+    # FIXME - Should this return something, like maybe the context
+    # that was current when this was called?
 }
 
 }
 
-=item config
+=head2 config
 
   $value = C4::Context->config("config_variable");
 
 
   $value = C4::Context->config("config_variable");
 
@@ -325,58 +479,124 @@ method names. If there is a configuration variable called "new", then
 C<C4::Config-E<gt>new> will not return it.
 
 =cut
 C<C4::Config-E<gt>new> will not return it.
 
 =cut
-#'
-sub config
-{
-       my $self = shift;
-       my $var = shift;                # The config variable to return
 
 
-       return undef if !defined($context->{"config"});
-                       # Presumably $self->{config} might be
-                       # undefined if the config file given to &new
-                       # didn't exist, and the caller didn't bother
-                       # to check the return value.
+sub _common_config ($$) {
+       my $var = shift;
+       my $term = shift;
+    return undef if !defined($context->{$term});
+       # Presumably $self->{$term} might be
+       # undefined if the config file given to &new
+       # didn't exist, and the caller didn't bother
+       # to check the return value.
+
+    # Return the value of the requested config variable
+    return $context->{$term}->{$var};
+}
 
 
-       # Return the value of the requested config variable
-       return $context->{"config"}{$var};
+sub config {
+       return _common_config($_[1],'config');
+}
+sub zebraconfig {
+       return _common_config($_[1],'server');
+}
+sub ModZebrations {
+       return _common_config($_[1],'serverinfo');
 }
 
 }
 
-=item preference
+=head2 preference
 
 
-  $sys_preference = C4::Context->preference("some_variable");
+  $sys_preference = C4::Context->preference('some_variable');
 
 Looks up the value of the given system preference in the
 systempreferences table of the Koha database, and returns it. If the
 
 Looks up the value of the given system preference in the
 systempreferences table of the Koha database, and returns it. If the
-variable is not set, or in case of error, returns the undefined value.
+variable is not set or does not exist, undef is returned.
+
+In case of an error, this may return 0.
+
+Note: It is impossible to tell the difference between system
+preferences which do not exist, and those whose values are set to NULL
+with this method.
 
 =cut
 
 =cut
-#'
-# FIXME - The preferences aren't likely to change over the lifetime of
-# the script (and things might break if they did change), so perhaps
-# this function should cache the results it finds.
-sub preference
-{
-       my $self = shift;
-       my $var = shift;                # The system preference to return
-       my $retval;                     # Return value
-       my $dbh = C4::Context->dbh;     # Database handle
-       my $sth;                        # Database query handle
-
-       # Look up systempreferences.variable==$var
-       $retval = $dbh->selectrow_array(<<EOT);
-               SELECT  value
-               FROM    systempreferences
-               WHERE   variable='$var'
-               LIMIT   1
-EOT
-       return $retval;
+
+# FIXME: running this under mod_perl will require a means of
+# flushing the caching mechanism.
+
+my %sysprefs;
+
+sub preference {
+    my $self = shift;
+    my $var  = lc(shift);                          # The system preference to return
+
+    if (exists $sysprefs{$var}) {
+        return $sysprefs{$var};
+    }
+
+    my $dbh  = C4::Context->dbh or return 0;
+
+    # Look up systempreferences.variable==$var
+    my $sql = <<'END_SQL';
+        SELECT    value
+        FROM    systempreferences
+        WHERE    variable=?
+        LIMIT    1
+END_SQL
+    $sysprefs{$var} = $dbh->selectrow_array( $sql, {}, $var );
+    return $sysprefs{$var};
 }
 
 sub boolean_preference ($) {
 }
 
 sub boolean_preference ($) {
-       my $self = shift;
-       my $var = shift;                # The system preference to return
-       my $it = preference($self, $var);
-       return defined($it)? C4::Boolean::true_p($it): undef;
+    my $self = shift;
+    my $var = shift;        # The system preference to return
+    my $it = preference($self, $var);
+    return defined($it)? C4::Boolean::true_p($it): undef;
+}
+
+=head2 clear_syspref_cache
+
+  C4::Context->clear_syspref_cache();
+
+cleans the internal cache of sysprefs. Please call this method if
+you update the systempreferences table. Otherwise, your new changes
+will not be seen by this process.
+
+=cut
+
+sub clear_syspref_cache {
+    %sysprefs = ();
+}
+
+=head2 set_preference
+
+  C4::Context->set_preference( $variable, $value );
+
+This updates a preference's value both in the systempreferences table and in
+the sysprefs cache.
+
+=cut
+
+sub set_preference {
+    my $self = shift;
+    my $var = lc(shift);
+    my $value = shift;
+
+    my $dbh = C4::Context->dbh or return 0;
+
+    my $type = $dbh->selectrow_array( "SELECT type FROM systempreferences WHERE variable = ?", {}, $var );
+
+    $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' );
+
+    my $sth = $dbh->prepare( "
+      INSERT INTO systempreferences
+        ( variable, value )
+        VALUES( ?, ? )
+        ON DUPLICATE KEY UPDATE value = VALUES(value)
+    " );
+
+    if($sth->execute( $var, $value )) {
+        $sysprefs{$var} = $value;
+    }
+    $sth->finish;
 }
 
 # AUTOLOAD
 }
 
 # AUTOLOAD
@@ -390,11 +610,127 @@ sub boolean_preference ($) {
 # encourage people to use it.
 sub AUTOLOAD
 {
 # encourage people to use it.
 sub AUTOLOAD
 {
-       my $self = shift;
+    my $self = shift;
 
 
-       $AUTOLOAD =~ s/.*:://;          # Chop off the package name,
-                                       # leaving only the function name.
-       return $self->config($AUTOLOAD);
+    $AUTOLOAD =~ s/.*:://;        # Chop off the package name,
+                    # leaving only the function name.
+    return $self->config($AUTOLOAD);
+}
+
+=head2 Zconn
+
+  $Zconn = C4::Context->Zconn
+
+Returns a connection to the Zebra database for the current
+context. If no connection has yet been made, this method 
+creates one and connects.
+
+C<$self> 
+
+C<$server> one of the servers defined in the koha-conf.xml file
+
+C<$async> whether this is a asynchronous connection
+
+C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
+
+
+=cut
+
+sub Zconn {
+    my $self=shift;
+    my $server=shift;
+    my $async=shift;
+    my $auth=shift;
+    my $piggyback=shift;
+    my $syntax=shift;
+    if ( defined($context->{"Zconn"}->{$server}) && (0 == $context->{"Zconn"}->{$server}->errcode()) ) {
+        return $context->{"Zconn"}->{$server};
+    # No connection object or it died. Create one.
+    }else {
+        # release resources if we're closing a connection and making a new one
+        # FIXME: this needs to be smarter -- an error due to a malformed query or
+        # a missing index does not necessarily require us to close the connection
+        # and make a new one, particularly for a batch job.  However, at
+        # first glance it does not look like there's a way to easily check
+        # the basic health of a ZOOM::Connection
+        $context->{"Zconn"}->{$server}->destroy() if defined($context->{"Zconn"}->{$server});
+
+        $context->{"Zconn"}->{$server} = &_new_Zconn($server,$async,$auth,$piggyback,$syntax);
+        return $context->{"Zconn"}->{$server};
+    }
+}
+
+=head2 _new_Zconn
+
+$context->{"Zconn"} = &_new_Zconn($server,$async);
+
+Internal function. Creates a new database connection from the data given in the current context and returns it.
+
+C<$server> one of the servers defined in the koha-conf.xml file
+
+C<$async> whether this is a asynchronous connection
+
+C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
+
+=cut
+
+sub _new_Zconn {
+    my ($server,$async,$auth,$piggyback,$syntax) = @_;
+
+    my $tried=0; # first attempt
+    my $Zconn; # connection object
+    $server = "biblioserver" unless $server;
+    $syntax = "usmarc" unless $syntax;
+
+    my $host = $context->{'listen'}->{$server}->{'content'};
+    my $servername = $context->{"config"}->{$server};
+    my $user = $context->{"serverinfo"}->{$server}->{"user"};
+    my $password = $context->{"serverinfo"}->{$server}->{"password"};
+ $auth = 1 if($user && $password);   
+    retry:
+    eval {
+        # set options
+        my $o = new ZOOM::Options();
+        $o->option(user=>$user) if $auth;
+        $o->option(password=>$password) if $auth;
+        $o->option(async => 1) if $async;
+        $o->option(count => $piggyback) if $piggyback;
+        $o->option(cqlfile=> $context->{"server"}->{$server}->{"cql2rpn"});
+        $o->option(cclfile=> $context->{"serverinfo"}->{$server}->{"ccl2rpn"});
+        $o->option(preferredRecordSyntax => $syntax);
+        $o->option(elementSetName => "F"); # F for 'full' as opposed to B for 'brief'
+        $o->option(databaseName => ($servername?$servername:"biblios"));
+
+        # create a new connection object
+        $Zconn= create ZOOM::Connection($o);
+
+        # forge to server
+        $Zconn->connect($host, 0);
+
+        # check for errors and warn
+        if ($Zconn->errcode() !=0) {
+            warn "something wrong with the connection: ". $Zconn->errmsg();
+        }
+
+    };
+#     if ($@) {
+#         # Koha manages the Zebra server -- this doesn't work currently for me because of permissions issues
+#         # Also, I'm skeptical about whether it's the best approach
+#         warn "problem with Zebra";
+#         if ( C4::Context->preference("ManageZebra") ) {
+#             if ($@->code==10000 && $tried==0) { ##No connection try restarting Zebra
+#                 $tried=1;
+#                 warn "trying to restart Zebra";
+#                 my $res=system("zebrasrv -f $ENV{'KOHA_CONF'} >/koha/log/zebra-error.log");
+#                 goto "retry";
+#             } else {
+#                 warn "Error ", $@->code(), ": ", $@->message(), "\n";
+#                 $Zconn="error";
+#                 return $Zconn;
+#             }
+#         }
+#     }
+    return $Zconn;
 }
 
 # _new_dbh
 }
 
 # _new_dbh
@@ -403,16 +739,40 @@ sub AUTOLOAD
 # returns it.
 sub _new_dbh
 {
 # returns it.
 sub _new_dbh
 {
-       my $db_driver = $context->{"config"}{"db_scheme"} || "mysql";
-       my $db_name   = $context->{"config"}{"database"};
-       my $db_host   = $context->{"config"}{"hostname"};
-       my $db_user   = $context->{"config"}{"user"};
-       my $db_passwd = $context->{"config"}{"pass"};
-       return DBI->connect("DBI:$db_driver:$db_name:$db_host",
-                           $db_user, $db_passwd);
+
+    ## $context
+    ## correct name for db_schme        
+    my $db_driver;
+    if ($context->config("db_scheme")){
+        $db_driver=db_scheme2dbi($context->config("db_scheme"));
+    }else{
+        $db_driver="mysql";
+    }
+
+    my $db_name   = $context->config("database");
+    my $db_host   = $context->config("hostname");
+    my $db_port   = $context->config("port") || '';
+    my $db_user   = $context->config("user");
+    my $db_passwd = $context->config("pass");
+    # MJR added or die here, as we can't work without dbh
+    my $dbh= DBI->connect("DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
+    $db_user, $db_passwd, {'RaiseError' => $ENV{DEBUG}?1:0 }) or die $DBI::errstr;
+       my $tz = $ENV{TZ};
+    if ( $db_driver eq 'mysql' ) { 
+        # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
+        # this is better than modifying my.cnf (and forcing all communications to be in utf8)
+        $dbh->{'mysql_enable_utf8'}=1; #enable
+        $dbh->do("set NAMES 'utf8'");
+        ($tz) and $dbh->do(qq(SET time_zone = "$tz"));
+    }
+    elsif ( $db_driver eq 'Pg' ) {
+           $dbh->do( "set client_encoding = 'UTF8';" );
+        ($tz) and $dbh->do(qq(SET TIME ZONE = "$tz"));
+    }
+    return $dbh;
 }
 
 }
 
-=item dbh
+=head2 dbh
 
   $dbh = C4::Context->dbh;
 
 
   $dbh = C4::Context->dbh;
 
@@ -426,24 +786,24 @@ times. If you need a second database handle, use C<&new_dbh> and
 possibly C<&set_dbh>.
 
 =cut
 possibly C<&set_dbh>.
 
 =cut
+
 #'
 sub dbh
 {
 #'
 sub dbh
 {
-       my $self = shift;
-       my $sth;
+    my $self = shift;
+    my $sth;
 
 
-       if (defined($context->{"dbh"})) {
-           $sth=$context->{"dbh"}->prepare("select 1");
-           return $context->{"dbh"} if (defined($sth->execute));
-       }
+    if (defined($context->{"dbh"}) && $context->{"dbh"}->ping()) {
+       return $context->{"dbh"};
+    }
 
 
-       # No database handle or it died . Create one.
-       $context->{"dbh"} = &_new_dbh();
+    # No database handle or it died . Create one.
+    $context->{"dbh"} = &_new_dbh();
 
 
-       return $context->{"dbh"};
+    return $context->{"dbh"};
 }
 
 }
 
-=item new_dbh
+=head2 new_dbh
 
   $dbh = C4::Context->new_dbh;
 
 
   $dbh = C4::Context->new_dbh;
 
@@ -455,15 +815,16 @@ convenience function; the point is that it knows which database to
 connect to so that the caller doesn't have to know.
 
 =cut
 connect to so that the caller doesn't have to know.
 
 =cut
+
 #'
 sub new_dbh
 {
 #'
 sub new_dbh
 {
-       my $self = shift;
+    my $self = shift;
 
 
-       return &_new_dbh();
+    return &_new_dbh();
 }
 
 }
 
-=item set_dbh
+=head2 set_dbh
 
   $my_dbh = C4::Connect->new_dbh;
   C4::Connect->set_dbh($my_dbh);
 
   $my_dbh = C4::Connect->new_dbh;
   C4::Connect->set_dbh($my_dbh);
@@ -479,21 +840,22 @@ the current database handle to C<$my_dbh>.
 C<$my_dbh> is assumed to be a good database handle.
 
 =cut
 C<$my_dbh> is assumed to be a good database handle.
 
 =cut
+
 #'
 sub set_dbh
 {
 #'
 sub set_dbh
 {
-       my $self = shift;
-       my $new_dbh = shift;
-
-       # Save the current database handle on the handle stack.
-       # We assume that $new_dbh is all good: if the caller wants to
-       # screw himself by passing an invalid handle, that's fine by
-       # us.
-       push @{$context->{"dbh_stack"}}, $context->{"dbh"};
-       $context->{"dbh"} = $new_dbh;
+    my $self = shift;
+    my $new_dbh = shift;
+
+    # Save the current database handle on the handle stack.
+    # We assume that $new_dbh is all good: if the caller wants to
+    # screw himself by passing an invalid handle, that's fine by
+    # us.
+    push @{$context->{"dbh_stack"}}, $context->{"dbh"};
+    $context->{"dbh"} = $new_dbh;
 }
 
 }
 
-=item restore_dbh
+=head2 restore_dbh
 
   C4::Context->restore_dbh;
 
 
   C4::Context->restore_dbh;
 
@@ -501,25 +863,26 @@ Restores the database handle saved by an earlier call to
 C<C4::Context-E<gt>set_dbh>.
 
 =cut
 C<C4::Context-E<gt>set_dbh>.
 
 =cut
+
 #'
 sub restore_dbh
 {
 #'
 sub restore_dbh
 {
-       my $self = shift;
+    my $self = shift;
 
 
-       if ($#{$context->{"dbh_stack"}} < 0)
-       {
-               # Stack underflow
-               die "DBH stack underflow";
-       }
+    if ($#{$context->{"dbh_stack"}} < 0)
+    {
+        # Stack underflow
+        die "DBH stack underflow";
+    }
 
 
-       # Pop the old database handle and set it.
-       $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
+    # Pop the old database handle and set it.
+    $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
 
 
-       # FIXME - If it is determined that restore_context should
-       # return something, then this function should, too.
+    # FIXME - If it is determined that restore_context should
+    # return something, then this function should, too.
 }
 
 }
 
-=item marcfromkohafield
+=head2 marcfromkohafield
 
   $dbh = C4::Context->marcfromkohafield;
 
 
   $dbh = C4::Context->marcfromkohafield;
 
@@ -529,18 +892,19 @@ This hash is cached for future use: if you call
 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
 
 =cut
 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
 
 =cut
+
 #'
 sub marcfromkohafield
 {
 #'
 sub marcfromkohafield
 {
-       my $retval = {};
+    my $retval = {};
 
 
-       # If the hash already exists, return it.
-       return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
+    # If the hash already exists, return it.
+    return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
 
 
-       # No hash. Create one.
-       $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
+    # No hash. Create one.
+    $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
 
 
-       return $context->{"marcfromkohafield"};
+    return $context->{"marcfromkohafield"};
 }
 
 # _new_marcfromkohafield
 }
 
 # _new_marcfromkohafield
@@ -548,18 +912,18 @@ sub marcfromkohafield
 # hash with stopwords
 sub _new_marcfromkohafield
 {
 # hash with stopwords
 sub _new_marcfromkohafield
 {
-       my $dbh = C4::Context->dbh;
-       my $marcfromkohafield;
-       my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
-       $sth->execute;
-       while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
-               my $retval = {};
-               $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
-       }
-       return $marcfromkohafield;
+    my $dbh = C4::Context->dbh;
+    my $marcfromkohafield;
+    my $sth = $dbh->prepare("select frameworkcode,kohafield,tagfield,tagsubfield from marc_subfield_structure where kohafield > ''");
+    $sth->execute;
+    while (my ($frameworkcode,$kohafield,$tagfield,$tagsubfield) = $sth->fetchrow) {
+        my $retval = {};
+        $marcfromkohafield->{$frameworkcode}->{$kohafield} = [$tagfield,$tagsubfield];
+    }
+    return $marcfromkohafield;
 }
 
 }
 
-=item stopwords
+=head2 stopwords
 
   $dbh = C4::Context->stopwords;
 
 
   $dbh = C4::Context->stopwords;
 
@@ -569,18 +933,19 @@ This hash is cached for future use: if you call
 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
 
 =cut
 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
 
 =cut
+
 #'
 sub stopwords
 {
 #'
 sub stopwords
 {
-       my $retval = {};
+    my $retval = {};
 
 
-       # If the hash already exists, return it.
-       return $context->{"stopwords"} if defined($context->{"stopwords"});
+    # If the hash already exists, return it.
+    return $context->{"stopwords"} if defined($context->{"stopwords"});
 
 
-       # No hash. Create one.
-       $context->{"stopwords"} = &_new_stopwords();
+    # No hash. Create one.
+    $context->{"stopwords"} = &_new_stopwords();
 
 
-       return $context->{"stopwords"};
+    return $context->{"stopwords"};
 }
 
 # _new_stopwords
 }
 
 # _new_stopwords
@@ -588,86 +953,103 @@ sub stopwords
 # hash with stopwords
 sub _new_stopwords
 {
 # hash with stopwords
 sub _new_stopwords
 {
-       my $dbh = C4::Context->dbh;
-       my $stopwordlist;
-       my $sth = $dbh->prepare("select word from stopwords");
-       $sth->execute;
-       while (my $stopword = $sth->fetchrow_array) {
-               my $retval = {};
-               $stopwordlist->{$stopword} = uc($stopword);
-       }
-       $stopwordlist->{A} = "A" unless $stopwordlist;
-       return $stopwordlist;
+    my $dbh = C4::Context->dbh;
+    my $stopwordlist;
+    my $sth = $dbh->prepare("select word from stopwords");
+    $sth->execute;
+    while (my $stopword = $sth->fetchrow_array) {
+        $stopwordlist->{$stopword} = uc($stopword);
+    }
+    $stopwordlist->{A} = "A" unless $stopwordlist;
+    return $stopwordlist;
 }
 
 }
 
-=item userenv
+=head2 userenv
 
 
-  %userenv = C4::Context->userenv;
+  C4::Context->userenv;
 
 
-Returns a hash with userenvironment variables.
+Retrieves a hash for user environment variables.
 
 
-This hash is cached for future use: if you call
+This hash shall be cached for future use: if you call
 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 
 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
 
-Returns Null if userenv is not set.
-userenv is set in _new_userenv, called in Auth.pm
-
 =cut
 =cut
-#'
 
 
-=item userenv
+#'
+sub userenv {
+    my $var = $context->{"activeuser"};
+    return $context->{"userenv"}->{$var} if (defined $var and defined $context->{"userenv"}->{$var});
+    # insecure=1 management
+    if ($context->{"dbh"} && $context->preference('insecure') eq 'yes') {
+        my %insecure;
+        $insecure{flags} = '16382';
+        $insecure{branchname} ='Insecure';
+        $insecure{number} ='0';
+        $insecure{cardnumber} ='0';
+        $insecure{id} = 'insecure';
+        $insecure{branch} = 'INS';
+        $insecure{emailaddress} = 'test@mode.insecure.com';
+        return \%insecure;
+    } else {
+        return;
+    }
+}
 
 
-  C4::Context->userenv;
+=head2 set_userenv
 
 
-Builds a hash for user environment variables.
+  C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname, 
+                  $usersurname, $userbranch, $userflags, $emailaddress);
 
 
-This hash shall be cached for future use: if you call
-C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
+Establish a hash of user environment variables.
 
 set_userenv is called in Auth.pm
 
 =cut
 
 set_userenv is called in Auth.pm
 
 =cut
+
 #'
 #'
-sub userenv
-{
-       my $var = $context->{"activeuser"};
-       return $context->{"userenv"}->{$var} if (defined $context->{"userenv"}->{$var});
-       warn "NO CONTEXT for $var";
+sub set_userenv {
+    my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter)= @_;
+    my $var=$context->{"activeuser"};
+    my $cell = {
+        "number"     => $usernum,
+        "id"         => $userid,
+        "cardnumber" => $usercnum,
+        "firstname"  => $userfirstname,
+        "surname"    => $usersurname,
+        #possibly a law problem
+        "branch"     => $userbranch,
+        "branchname" => $branchname,
+        "flags"      => $userflags,
+        "emailaddress"     => $emailaddress,
+        "branchprinter"    => $branchprinter
+    };
+    $context->{userenv}->{$var} = $cell;
+    return $cell;
 }
 
 }
 
-=item userenv
-
-  C4::Context->set_userenv;
-
-Builds a hash for user environment variables.
+sub set_shelves_userenv ($$) {
+       my ($type, $shelves) = @_ or return undef;
+       my $activeuser = $context->{activeuser} or return undef;
+       $context->{userenv}->{$activeuser}->{barshelves} = $shelves if $type eq 'bar';
+       $context->{userenv}->{$activeuser}->{pubshelves} = $shelves if $type eq 'pub';
+       $context->{userenv}->{$activeuser}->{totshelves} = $shelves if $type eq 'tot';
+}
 
 
-This hash shall be cached for future use: if you call
-C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
+sub get_shelves_userenv () {
+       my $active;
+       unless ($active = $context->{userenv}->{$context->{activeuser}}) {
+               $debug and warn "get_shelves_userenv cannot retrieve context->{userenv}->{context->{activeuser}}";
+               return undef;
+       }
+       my $totshelves = $active->{totshelves} or undef;
+       my $pubshelves = $active->{pubshelves} or undef;
+       my $barshelves = $active->{barshelves} or undef;
+       return ($totshelves, $pubshelves, $barshelves);
+}
 
 
-set_userenv is called in Auth.pm
+=head2 _new_userenv
 
 
-=cut
-#'
-sub set_userenv{
-       my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $userflags, $emailaddress)= @_;
-       my $var=$context->{"activeuser"};
-       my $cell = {
-               "number"     => $usernum,
-               "id"         => $userid,
-               "cardnumber" => $usercnum,
-               "firstname"  => $userfirstname,
-               "surname"    => $usersurname,
-               "branch"     => $userbranch,
-               "flags"      => $userflags,
-               "emailaddress"  => $emailaddress,
-       };
-       $context->{userenv}->{$var} = $cell;
-       return $cell;
-}
-
-=item _new_userenv
-
-  C4::Context->_new_userenv($session);
+  C4::Context->_new_userenv($session);  # FIXME: This calling style is wrong for what looks like an _internal function
 
 Builds a hash for user environment variables.
 
 
 Builds a hash for user environment variables.
 
@@ -677,53 +1059,96 @@ C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB ac
 _new_userenv is called in Auth.pm
 
 =cut
 _new_userenv is called in Auth.pm
 
 =cut
+
 #'
 sub _new_userenv
 {
 #'
 sub _new_userenv
 {
-       shift;
-       my ($sessionID)= @_;
-       $context->{"activeuser"}=$sessionID;
+    shift;  # Useless except it compensates for bad calling style
+    my ($sessionID)= @_;
+     $context->{"activeuser"}=$sessionID;
 }
 
 }
 
-=item _unset_userenv
+=head2 _unset_userenv
 
   C4::Context->_unset_userenv;
 
 Destroys the hash for activeuser user environment variables.
 
 =cut
 
   C4::Context->_unset_userenv;
 
 Destroys the hash for activeuser user environment variables.
 
 =cut
+
 #'
 
 sub _unset_userenv
 {
 #'
 
 sub _unset_userenv
 {
-       my ($sessionID)= @_;
-#      undef $context->{$sessionID};
-       undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
-#      $context->{"activeuser"}--;
+    my ($sessionID)= @_;
+    undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
+}
+
+
+=head2 get_versions
+
+  C4::Context->get_versions
+
+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'.
+
+=cut
+
+#'
+
+# A little example sub to show more debugging info for CGI::Carp
+sub get_versions {
+    my %versions;
+    $versions{kohaVersion}  = KOHAVERSION();
+    $versions{kohaDbVersion} = C4::Context->preference('version');
+    $versions{osVersion} = join(" ", POSIX::uname());
+    $versions{perlVersion} = $];
+    {
+        no warnings qw(exec); # suppress warnings if unable to find a program in $PATH
+        $versions{mysqlVersion}  = `mysql -V`;
+        $versions{apacheVersion} = `httpd -v`;
+        $versions{apacheVersion} = `httpd2 -v`            unless  $versions{apacheVersion} ;
+        $versions{apacheVersion} = `apache2 -v`           unless  $versions{apacheVersion} ;
+        $versions{apacheVersion} = `/usr/sbin/apache2 -v` unless  $versions{apacheVersion} ;
+    }
+    return %versions;
+}
+
+
+=head2 tz
+
+  C4::Context->tz
+
+  Returns a DateTime::TimeZone object for the system timezone
+
+=cut
+
+sub tz {
+    my $self = shift;
+    if (!defined $context->{tz}) {
+        $context->{tz} = DateTime::TimeZone->new(name => 'local');
+    }
+    return $context->{tz};
 }
 
 
 }
 
 
+
 1;
 __END__
 
 1;
 __END__
 
-=back
-
 =head1 ENVIRONMENT
 
 =head1 ENVIRONMENT
 
-=over 4
-
-=item C<KOHA_CONF>
+=head2 C<KOHA_CONF>
 
 Specifies the configuration file to read.
 
 
 Specifies the configuration file to read.
 
-=back
-
 =head1 SEE ALSO
 
 =head1 SEE ALSO
 
-DBI(3)
+XML::Simple
 
 
-=head1 AUTHOR
+=head1 AUTHORS
 
 Andrew Arensburger <arensb at ooblick dot com>
 
 
 Andrew Arensburger <arensb at ooblick dot com>
 
+Joshua Ferraro <jmf at liblime dot com>
+
 =cut
 =cut