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();
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 $db_driver = C4::Context::db_scheme2dbi(C4::Context->config('db_scheme'));;
54 my $db_name = C4::Context->config("database");
55 my $db_host = C4::Context->config("hostname");
56 my $db_port = C4::Context->config("port") || '';
57 my $db_user = C4::Context->config("user");
58 my $db_passwd = C4::Context->config("pass");
59 my $tls = C4::Context->config("tls");
61 if( $tls && $tls eq 'yes' ) {
62 my $ca = C4::Context->config('ca');
63 my $cert = C4::Context->config('cert');
64 my $key = C4::Context->config('key');
65 $tls_options = ";mysql_ssl=1;mysql_ssl_client_key=".$key.";mysql_ssl_client_cert=".$cert.";mysql_ssl_ca_file=".$ca;
70 my ( %encoding_attr, $encoding_query, $tz_query, $sql_mode_query );
71 my $tz = C4::Context->timezone;
72 $tz = q{} if ( $tz eq 'local' );
73 if ( $db_driver eq 'mysql' ) {
74 %encoding_attr = ( mysql_enable_utf8 => 1 );
75 $encoding_query = "set NAMES 'utf8mb4'";
76 $tz_query = qq(SET time_zone = "$tz") if $tz;
77 if ( C4::Context->config('strict_sql_modes')
78 || ( exists $ENV{_} && $ENV{_} =~ m|prove| )
81 $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'};
83 $sql_mode_query = q{SET sql_mode = 'IGNORE_SPACE,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION'};
86 elsif ( $db_driver eq 'Pg' ) {
87 $encoding_query = "set client_encoding = 'UTF8';";
88 $tz_query = qq(SET TIME ZONE = "$tz") if $tz;
91 my $schema = Koha::Schema->connect(
93 dsn => "dbi:$db_driver:database=$db_name;host=$db_host;port=$db_port".($tls_options? $tls_options : ""),
95 password => $db_passwd,
102 $encoding_query || (),
104 $sql_mode_query || (),
109 my $dbh = $schema->storage->dbh;
111 my $HandleError = $dbh->{HandleError};
112 if ( $ENV{KOHA_DB_DO_NOT_RAISE_OR_PRINT_ERROR} ) {
113 $dbh->{HandleError} = sub { return 1 };
116 SELECT * FROM systempreferences WHERE 1 = 0 |
118 $dbh->{HandleError} = $HandleError;
122 $dbh->{HandleError} = sub { warn $_[0]; return 1 };
130 $schema = $database->schema;
132 Returns a database handle connected to the Koha database for the
133 current context. If no connection has yet been made, this method
134 creates one, and connects to the database.
136 This database handle is cached for future use: if you call
137 C<$database-E<gt>schema> twice, you will get the same handle both
138 times. If you need a second database handle, use C<&new_schema> and
139 possibly C<&set_schema>.
147 unless ( $params->{new} ) {
148 return $database->{schema} if defined $database->{schema};
151 $database->{schema} = &_new_schema();
152 return $database->{schema};
157 $schema = $database->new_schema;
159 Creates a new connection to the Koha database for the current context,
160 and returns the database handle (a C<DBI::db> object).
162 The handle is not saved anywhere: this method is strictly a
163 convenience function; the point is that it knows which database to
164 connect to so that the caller doesn't have to know.
172 return &_new_schema();
177 $my_schema = $database->new_schema;
178 $database->set_schema($my_schema);
180 $database->restore_schema;
182 C<&set_schema> and C<&restore_schema> work in a manner analogous to
183 C<&set_context> and C<&restore_context>.
185 C<&set_schema> saves the current database handle on a stack, then sets
186 the current database handle to C<$my_schema>.
188 C<$my_schema> is assumed to be a good database handle.
194 my $new_schema = shift;
196 # Save the current database handle on the handle stack.
197 # We assume that $new_schema is all good: if the caller wants to
198 # screw himself by passing an invalid handle, that's fine by
200 push @{ $database->{schema_stack} }, $database->{schema};
201 $database->{schema} = $new_schema;
204 =head2 restore_schema
206 $database->restore_schema;
208 Restores the database handle saved by an earlier call to
209 C<$database-E<gt>set_schema>.
216 if ( $#{ $database->{schema_stack} } < 0 ) {
219 die "SCHEMA stack underflow";
222 # Pop the old database handle and set it.
223 $database->{schema} = pop @{ $database->{schema_stack} };
225 # FIXME - If it is determined that restore_context should
226 # return something, then this function should, too.
229 =head2 get_schema_cached
233 sub get_schema_cached {
234 return $database->{schema};
237 =head2 flush_schema_cache
241 sub flush_schema_cache {
242 delete $database->{schema};
253 Chris Cormack, E<lt>chrisc@catalyst.net.nzE<gt>