1 package Koha::Database;
3 # Copyright 2013 Catalyst IT
4 # chrisc@catalyst.net.nz
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 3 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 my $database = Koha::Database->new();
29 my $schema = $database->schema();
38 use base qw(Class::Accessor);
40 use vars qw($database);
42 __PACKAGE__->mk_accessors(qw( ));
45 # Internal helper function (not a method!). This creates a new
46 # database connection from the data given in the current context, and
52 my $context = C4::Context->new();
54 my $db_driver = $context->{db_driver};
56 my $db_name = $context->config("database");
57 my $db_host = $context->config("hostname");
58 my $db_port = $context->config("port") || '';
59 my $db_user = $context->config("user");
60 my $db_passwd = $context->config("pass");
61 my $tls = $context->config("tls");
64 my $ca = $context->config('ca');
65 my $cert = $context->config('cert');
66 my $key = $context->config('key');
67 $tls_options = ";mysql_ssl=1;mysql_ssl_client_key=".$key.";mysql_ssl_client_cert=".$cert.";mysql_ssl_ca_file=".$ca;
72 my ( %encoding_attr, $encoding_query, $tz_query );
74 if ( $db_driver eq 'mysql' ) {
75 %encoding_attr = ( mysql_enable_utf8 => 1 );
76 $encoding_query = "set NAMES 'utf8'";
77 $tz_query = qq(SET time_zone = "$tz") if $tz;
79 elsif ( $db_driver eq 'Pg' ) {
80 $encoding_query = "set client_encoding = 'UTF8';";
81 $tz_query = qq(SET TIME ZONE = "$tz") if $tz;
83 my $schema = Koha::Schema->connect(
85 dsn => "dbi:$db_driver:database=$db_name;host=$db_host;port=$db_port".($tls_options? $tls_options : ""),
87 password => $db_passwd,
89 RaiseError => $ENV{DEBUG} ? 1 : 0,
94 $encoding_query || (),
100 my $dbh = $schema->storage->dbh;
102 $dbh->{RaiseError} = 1;
103 if ( $ENV{KOHA_DB_DO_NOT_RAISE_OR_PRINT_ERROR} ) {
104 $dbh->{RaiseError} = 0;
105 $dbh->{PrintError} = 0;
108 SELECT * FROM systempreferences WHERE 1 = 0 |
110 $dbh->{RaiseError} = $ENV{DEBUG} ? 1 : 0;
112 $dbh->{RaiseError} = 0 if $@;
119 $schema = $database->schema;
121 Returns a database handle connected to the Koha database for the
122 current context. If no connection has yet been made, this method
123 creates one, and connects to the database.
125 This database handle is cached for future use: if you call
126 C<$database-E<gt>schema> twice, you will get the same handle both
127 times. If you need a second database handle, use C<&new_schema> and
128 possibly C<&set_schema>.
136 unless ( $params->{new} ) {
137 return $database->{schema} if defined $database->{schema};
140 $database->{schema} = &_new_schema();
141 return $database->{schema};
146 $schema = $database->new_schema;
148 Creates a new connection to the Koha database for the current context,
149 and returns the database handle (a C<DBI::db> object).
151 The handle is not saved anywhere: this method is strictly a
152 convenience function; the point is that it knows which database to
153 connect to so that the caller doesn't have to know.
161 return &_new_schema();
166 $my_schema = $database->new_schema;
167 $database->set_schema($my_schema);
169 $database->restore_schema;
171 C<&set_schema> and C<&restore_schema> work in a manner analogous to
172 C<&set_context> and C<&restore_context>.
174 C<&set_schema> saves the current database handle on a stack, then sets
175 the current database handle to C<$my_schema>.
177 C<$my_schema> is assumed to be a good database handle.
183 my $new_schema = shift;
185 # Save the current database handle on the handle stack.
186 # We assume that $new_schema is all good: if the caller wants to
187 # screw himself by passing an invalid handle, that's fine by
189 push @{ $database->{schema_stack} }, $database->{schema};
190 $database->{schema} = $new_schema;
193 =head2 restore_schema
195 $database->restore_schema;
197 Restores the database handle saved by an earlier call to
198 C<$database-E<gt>set_schema>.
205 if ( $#{ $database->{schema_stack} } < 0 ) {
208 die "SCHEMA stack underflow";
211 # Pop the old database handle and set it.
212 $database->{schema} = pop @{ $database->{schema_stack} };
214 # FIXME - If it is determined that restore_context should
215 # return something, then this function should, too.
225 Chris Cormack, E<lt>chrisc@catalyst.net.nzE<gt>