Bug 14045: Change prototype of TooMany to raise a better warning
[koha.git] / C4 / Context.pm
index 6f77466..26eeb40 100644 (file)
@@ -3,18 +3,18 @@ package C4::Context;
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY 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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use strict;
 use warnings;
@@ -97,16 +97,20 @@ BEGIN {
     $VERSION = '3.07.00.049';
 }
 
-use DBI;
+use DBIx::Connector;
+use Encode;
 use ZOOM;
 use XML::Simple;
-use C4::Boolean;
-use C4::Debug;
 use POSIX ();
 use DateTime::TimeZone;
 use Module::Load::Conditional qw(can_load);
 use Carp;
 
+use C4::Boolean;
+use C4::Debug;
+use Koha;
+use Koha::Config::SysPrefs;
+
 =head1 NAME
 
 C4::Context - Maintain and manipulate the context of a Koha script
@@ -203,36 +207,6 @@ $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 final_linear_version
-
-Returns the version number of the final update to run in updatedatabase.pl.
-This number is equal to the version in kohaversion.pl
-
-=cut
-
-sub final_linear_version {
-    return KOHAVERSION;
-}
-
 =head2 read_config_file
 
 Reads the specified Koha config file. 
@@ -314,7 +288,7 @@ sub import {
     # the first time the module is called
     # (a config file can be optionaly passed)
 
-    # default context allready exists? 
+    # default context already exists?
     return if $context;
 
     # no ? so load it!
@@ -376,7 +350,7 @@ sub new {
     }
     
     if ($ismemcached) {
-        # retreive from memcached
+        # retrieve from memcached
         $self = $memcached->get('kohaconf');
         if (not defined $self) {
             # not in memcached yet
@@ -553,14 +527,9 @@ sub preference {
     if ( defined $ENV{"OVERRIDE_SYSPREF_$var"} ) {
         $value = $ENV{"OVERRIDE_SYSPREF_$var"};
     } else {
-        # Look up systempreferences.variable==$var
-        my $sql = q{
-            SELECT  value
-            FROM    systempreferences
-            WHERE   variable = ?
-            LIMIT   1
-        };
-        $value = $dbh->selectrow_array( $sql, {}, lc $var );
+        my $syspref;
+        eval { $syspref = Koha::Config::SysPrefs->find( lc $var ) };
+        $value = $syspref ? $syspref->value() : undef;
     }
 
     $sysprefs{lc $var} = $value;
@@ -631,50 +600,33 @@ sub set_preference {
     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 );
+    my $syspref = Koha::Config::SysPrefs->find( $var );
+    my $type = $syspref ? $syspref->type() : undef;
 
     $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;
+    # force explicit protocol on OPACBaseURL
+    if ($var eq 'opacbaseurl' && substr($value,0,4) !~ /http/) {
+        $value = 'http://' . $value;
     }
-    $sth->finish;
-}
 
-# AUTOLOAD
-# This implements C4::Config->foo, and simply returns
-# C4::Context->config("foo"), as described in the documentation for
-# &config, above.
-
-# FIXME - Perhaps this should be extended to check &config first, and
-# then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
-# code, so it'd probably be best to delete it altogether so as not to
-# encourage people to use it.
-sub AUTOLOAD
-{
-    my $self = shift;
+    if ($syspref) {
+        $syspref = $syspref->set( { value => $value } )->store();
+    }
+    else {
+        $syspref = Koha::Config::SysPref->new( { variable => $var, value => $value } )->store();
+    }
 
-    $AUTOLOAD =~ s/.*:://;        # Chop off the package name,
-                    # leaving only the function name.
-    return $self->config($AUTOLOAD);
+    if ($syspref) {
+        $sysprefs{$var} = $value;
+    }
 }
 
 =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.
+Returns a connection to the Zebra database
 
 C<$self> 
 
@@ -682,32 +634,18 @@ 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, $server, $async, $auth, $piggyback, $syntax) = @_;
-    #TODO: We actually just ignore the auth and syntax parameter
-    #It also looks like we are not passing auth, piggyback, syntax anywhere
-
-    my $cache_key = join ('::', (map { $_ // '' } ($server, $async, $auth, $piggyback, $syntax)));
-    if ( defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
-        return $context->{"Zconn"}->{$cache_key};
-    # 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"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key});
-
-        $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async, $piggyback );
+    my ($self, $server, $async ) = @_;
+    my $cache_key = join ('::', (map { $_ // '' } ($server, $async )));
+    if ( (!defined($ENV{GATEWAY_INTERFACE})) && defined($context->{"Zconn"}->{$cache_key}) && (0 == $context->{"Zconn"}->{$cache_key}->errcode()) ) {
+        # if we are running the script from the commandline, lets try to use the caching
         return $context->{"Zconn"}->{$cache_key};
     }
+    $context->{"Zconn"}->{$cache_key}->destroy() if defined($context->{"Zconn"}->{$cache_key}); #destroy old connection before making a new one
+    $context->{"Zconn"}->{$cache_key} = &_new_Zconn( $server, $async );
+    return $context->{"Zconn"}->{$cache_key};
 }
 
 =head2 _new_Zconn
@@ -725,7 +663,7 @@ C<$auth> whether this connection has rw access (1) or just r access (0 or NULL)
 =cut
 
 sub _new_Zconn {
-    my ( $server, $async, $piggyback ) = @_;
+    my ( $server, $async ) = @_;
 
     my $tried=0; # first attempt
     my $Zconn; # connection object
@@ -736,7 +674,7 @@ sub _new_Zconn {
     $server //= "biblioserver";
 
     if ( $server eq 'biblioserver' ) {
-        $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'grs1';
+        $index_mode = $context->{'config'}->{'zebra_bib_index_mode'} // 'dom';
     } elsif ( $server eq 'authorityserver' ) {
         $index_mode = $context->{'config'}->{'zebra_auth_index_mode'} // 'dom';
     }
@@ -761,7 +699,6 @@ sub _new_Zconn {
         $o->option(user => $user) if $user && $password;
         $o->option(password => $password) if $user && $password;
         $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);
@@ -799,8 +736,13 @@ sub _new_dbh
     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 $dbh = DBIx::Connector->connect(
+        "dbi:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
+        $db_user, $db_passwd,
+        {
+            'RaiseError' => $ENV{DEBUG} ? 1 : 0
+        }
+    );
 
     # Check for the existence of a systempreference table; if we don't have this, we don't
     # have a valid database and should not set RaiseError in order to allow the installer
@@ -1102,9 +1044,10 @@ sub userenv {
 
 =head2 set_userenv
 
-  C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname, 
-                  $usersurname, $userbranch, $userflags, $emailaddress, $branchprinter,
-                  $persona);
+  C4::Context->set_userenv($usernum, $userid, $usercnum,
+                           $userfirstname, $usersurname,
+                           $userbranch, $branchname, $userflags,
+                           $emailaddress, $branchprinter, $persona);
 
 Establish a hash of user environment variables.
 
@@ -1114,7 +1057,10 @@ set_userenv is called in Auth.pm
 
 #'
 sub set_userenv {
-    my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)= @_;
+    shift @_;
+    my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter, $persona, $shibboleth)=
+    map { Encode::is_utf8( $_ ) ? $_ : Encode::decode('UTF-8', $_) } # CGI::Session doesn't handle utf-8, so we decode it here
+    @_;
     my $var=$context->{"activeuser"} || '';
     my $cell = {
         "number"     => $usernum,
@@ -1206,7 +1152,7 @@ Gets various version info, for core Koha packages, Currently called from carp ha
 # A little example sub to show more debugging info for CGI::Carp
 sub get_versions {
     my %versions;
-    $versions{kohaVersion}  = KOHAVERSION();
+    $versions{kohaVersion}  = Koha::version();
     $versions{kohaDbVersion} = C4::Context->preference('version');
     $versions{osVersion} = join(" ", POSIX::uname());
     $versions{perlVersion} = $];
@@ -1241,7 +1187,7 @@ sub tz {
 
 =head2 IsSuperLibrarian
 
-    C4::Context->IsSuperlibrarian();
+    C4::Context->IsSuperLibrarian();
 
 =cut