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
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
28 my $database = Koha::Database->new();
29 my $schema = $database->schema();
37 use base qw(Class::Accessor);
39 use vars qw($database);
41 __PACKAGE__->mk_accessors(qw( ));
44 # Internal helper function (not a method!). This creates a new
45 # database connection from the data given in the current context, and
51 my $db_driver = C4::Context::db_scheme2dbi(C4::Context->config('db_scheme'));;
53 my $db_name = C4::Context->config("database");
54 my $db_host = C4::Context->config("hostname");
55 my $db_port = C4::Context->config("port") || '';
56 my $db_user = C4::Context->config("user");
57 my $db_passwd = C4::Context->config("pass");
58 my $tls = C4::Context->config("tls");
60 if( $tls && $tls eq 'yes' ) {
61 my $ca = C4::Context->config('ca');
62 my $cert = C4::Context->config('cert');
63 my $key = C4::Context->config('key');
64 $tls_options = ";mysql_ssl=1;mysql_ssl_client_key=".$key.";mysql_ssl_client_cert=".$cert.";mysql_ssl_ca_file=".$ca;
69 my ( %encoding_attr, $encoding_query, $tz_query, $sql_mode_query );
70 my $tz = C4::Context->timezone;
71 $tz = q{} if ( $tz eq 'local' );
72 if ( $db_driver eq 'mysql' ) {
73 %encoding_attr = ( mysql_enable_utf8 => 1 );
74 $encoding_query = "set NAMES 'utf8mb4'";
75 $tz_query = qq(SET time_zone = "$tz") if $tz;
76 if ( C4::Context->config('strict_sql_modes')
77 || ( exists $ENV{_} && $ENV{_} =~ m|prove| )
80 $sql_mode_query = q{SET sql_mode = 'ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION'};
82 $sql_mode_query = q{SET sql_mode = 'IGNORE_SPACE,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION'};
85 elsif ( $db_driver eq 'Pg' ) {
86 $encoding_query = "set client_encoding = 'UTF8';";
87 $tz_query = qq(SET TIME ZONE = "$tz") if $tz;
90 my $schema = Koha::Schema->connect(
92 dsn => "dbi:$db_driver:database=$db_name;host=$db_host;port=$db_port".($tls_options? $tls_options : ""),
94 password => $db_passwd,
101 $encoding_query || (),
103 $sql_mode_query || (),
108 my $dbh = $schema->storage->dbh;
110 my $HandleError = $dbh->{HandleError};
111 if ( $ENV{KOHA_DB_DO_NOT_RAISE_OR_PRINT_ERROR} ) {
112 $dbh->{HandleError} = sub { return 1 };
115 SELECT * FROM systempreferences WHERE 1 = 0 |
117 $dbh->{HandleError} = $HandleError;
121 $dbh->{HandleError} = sub { warn $_[0]; return 1 };
129 $schema = $database->schema;
131 Returns a database handle connected to the Koha database for the
132 current context. If no connection has yet been made, this method
133 creates one, and connects to the database.
135 This database handle is cached for future use: if you call
136 C<$database-E<gt>schema> twice, you will get the same handle both
137 times. If you need a second database handle, use C<&new_schema> and
138 possibly C<&set_schema>.
146 unless ( $params->{new} ) {
147 return $database->{schema} if defined $database->{schema};
150 $database->{schema} = &_new_schema();
151 return $database->{schema};
156 $schema = $database->new_schema;
158 Creates a new connection to the Koha database for the current context,
159 and returns the database handle (a C<DBI::db> object).
161 The handle is not saved anywhere: this method is strictly a
162 convenience function; the point is that it knows which database to
163 connect to so that the caller doesn't have to know.
171 return &_new_schema();
176 $my_schema = $database->new_schema;
177 $database->set_schema($my_schema);
179 $database->restore_schema;
181 C<&set_schema> and C<&restore_schema> work in a manner analogous to
182 C<&set_context> and C<&restore_context>.
184 C<&set_schema> saves the current database handle on a stack, then sets
185 the current database handle to C<$my_schema>.
187 C<$my_schema> is assumed to be a good database handle.
193 my $new_schema = shift;
195 # Save the current database handle on the handle stack.
196 # We assume that $new_schema is all good: if the caller wants to
197 # screw himself by passing an invalid handle, that's fine by
199 push @{ $database->{schema_stack} }, $database->{schema};
200 $database->{schema} = $new_schema;
203 =head2 restore_schema
205 $database->restore_schema;
207 Restores the database handle saved by an earlier call to
208 C<$database-E<gt>set_schema>.
215 if ( $#{ $database->{schema_stack} } < 0 ) {
218 die "SCHEMA stack underflow";
221 # Pop the old database handle and set it.
222 $database->{schema} = pop @{ $database->{schema_stack} };
224 # FIXME - If it is determined that restore_context should
225 # return something, then this function should, too.
228 =head2 get_schema_cached
232 sub get_schema_cached {
233 return $database->{schema};
236 =head2 flush_schema_cache
240 sub flush_schema_cache {
241 delete $database->{schema};
252 Chris Cormack, E<lt>chrisc@catalyst.net.nzE<gt>