Handling vom initialen SQL (SET DateStyle ...) zentralisiert
[kivitendo-erp.git] / SL / DB.pm
index 67888ef..54214c8 100644 (file)
--- a/SL/DB.pm
+++ b/SL/DB.pm
@@ -4,95 +4,86 @@ use strict;
 
 use Carp;
 use Data::Dumper;
+use SL::DBConnect;
 use English qw(-no_match_vars);
 use Rose::DB;
+use Rose::DBx::Cache::Anywhere;
 
 use base qw(Rose::DB);
 
+__PACKAGE__->db_cache_class('Rose::DBx::Cache::Anywhere');
 __PACKAGE__->use_private_registry;
 
-my (%_db_registered, %_initial_sql_executed);
+my (%_db_registered);
 
 sub dbi_connect {
   shift;
 
-  return DBI->connect(@_) unless $::lx_office_conf{debug} && $::lx_office_conf{debug}->{dbix_log4perl};
-
-  require Log::Log4perl;
-  require DBIx::Log4perl;
-
-  my $filename =  $LXDebug::file_name;
-  my $config   =  $::lx_office_conf{debug}->{dbix_log4perl_config};
-  $config      =~ s/LXDEBUGFILE/${filename}/g;
-
-  Log::Log4perl->init(\$config);
-  return DBIx::Log4perl->connect(@_);
+  return SL::DBConnect->connect(@_);
 }
 
 sub create {
   my $domain = shift || SL::DB->default_domain;
   my $type   = shift || SL::DB->default_type;
 
-  my ($domain, $type) = _register_db($domain, $type);
+  ($domain, $type) = _register_db($domain, $type);
 
   my $db = __PACKAGE__->new_or_cached(domain => $domain, type => $type);
 
-  _execute_initial_sql($db);
-
   return $db;
 }
 
-my %_dateformats = ( 'yy-mm-dd'   => 'ISO',
-                     'yyyy-mm-dd' => 'ISO',
-                     'mm/dd/yy'   => 'SQL, US',
-                     'mm-dd-yy'   => 'POSTGRES, US',
-                     'dd/mm/yy'   => 'SQL, EUROPEAN',
-                     'dd-mm-yy'   => 'POSTGRES, EUROPEAN',
-                     'dd.mm.yy'   => 'GERMAN'
-                   );
-
 sub _register_db {
   my $domain = shift;
   my $type   = shift;
 
-  my %connect_settings;
-  my $initial_sql;
-
-  if (!%::myconfig) {
-    $type = 'LXOFFICE_EMPTY';
-    %connect_settings = ( driver => 'Pg' );
-
-  } elsif ($type eq 'LXOFFICE_AUTH') {
-    %connect_settings = ( driver          => $::myconfig{dbdriver} || 'Pg',
-                          database        => $::auth->{DB_config}->{db},
-                          host            => $::auth->{DB_config}->{host} || 'localhost',
-                          port            => $::auth->{DB_config}->{port} || 5432,
-                          username        => $::auth->{DB_config}->{user},
-                          password        => $::auth->{DB_config}->{password},
-                          connect_options => { pg_enable_utf8 => $::locale && $::locale->is_utf8,
-                                             });
-  } else {
-    my $european_dates = 0;
-    if ($::myconfig{dateformat}) {
-      $european_dates = 1 if $_dateformats{ $::myconfig{dateformat} } =~ m/european/i;
-    }
+  my %specific_connect_settings;
+  my %common_connect_settings = (
+    driver           => 'Pg',
+    european_dates   => ((SL::DBConnect->get_datestyle || '') =~ m/european/i) ? 1 : 0,
+    connect_options  => {
+      pg_enable_utf8 => $::locale && $::locale->is_utf8,
+    },
+  );
+
+  if (($type eq 'KIVITENDO_AUTH') && $::auth && $::auth->{DB_config} && $::auth->session_tables_present) {
+    %specific_connect_settings = (
+      database        => $::auth->{DB_config}->{db},
+      host            => $::auth->{DB_config}->{host} || 'localhost',
+      port            => $::auth->{DB_config}->{port} || 5432,
+      username        => $::auth->{DB_config}->{user},
+      password        => $::auth->{DB_config}->{password},
+    );
+
+  } elsif ($::auth && $::auth->client) {
+    my $client        = $::auth->client;
+    %specific_connect_settings = (
+      database        => $client->{dbname},
+      host            => $client->{dbhost} || 'localhost',
+      port            => $client->{dbport} || 5432,
+      username        => $client->{dbuser},
+      password        => $client->{dbpasswd},
+    );
+
+  } elsif (%::myconfig && $::myconfig{dbname}) {
+    %specific_connect_settings = (
+      database        => $::myconfig{dbname},
+      host            => $::myconfig{dbhost} || 'localhost',
+      port            => $::myconfig{dbport} || 5432,
+      username        => $::myconfig{dbuser},
+      password        => $::myconfig{dbpasswd},
+    );
 
-    %connect_settings = ( driver          => $::myconfig{dbdriver} || 'Pg',
-                          database        => $::myconfig{dbname},
-                          host            => $::myconfig{dbhost} || 'localhost',
-                          port            => $::myconfig{dbport} || 5432,
-                          username        => $::myconfig{dbuser},
-                          password        => $::myconfig{dbpasswd},
-                          connect_options => { pg_enable_utf8 => $::locale && $::locale->is_utf8,
-                                             },
-                          european_dates  => $european_dates);
+  } else {
+    $type = 'KIVITENDO_EMPTY';
   }
 
+  my %connect_settings   = (%common_connect_settings, %specific_connect_settings);
   my %flattened_settings = _flatten_settings(%connect_settings);
 
-  $domain = 'LXOFFICE' if $type =~ m/^LXOFFICE/;
-  $type  .= join($SUBSCRIPT_SEPARATOR, map { ($_, $flattened_settings{$_}) } sort keys %flattened_settings);
-  my $idx = "${domain}::${type}";
+  $domain                = 'KIVITENDO' if $type =~ m/^KIVITENDO/;
+  $type                 .= join($SUBSCRIPT_SEPARATOR, map { ($_, $flattened_settings{$_} || '') } sort grep { $_ ne 'dbpasswd' } keys %flattened_settings);
+  my $idx                = "${domain}::${type}";
 
   if (!$_db_registered{$idx}) {
     $_db_registered{$idx} = 1;
@@ -106,19 +97,6 @@ sub _register_db {
   return ($domain, $type);
 }
 
-sub _execute_initial_sql {
-  my ($db) = @_;
-
-  return if $_initial_sql_executed{$db} || !%::myconfig || !$::myconfig{dateformat};
-
-  $_initial_sql_executed{$db} = 1;
-
-  # Don't rely on dboptions being set properly. Chose them from
-  # dateformat instead.
-  my $pg_dateformat = $_dateformats{ $::myconfig{dateformat} };
-  $db->dbh->do("set DateStyle to '${pg_dateformat}'") if $pg_dateformat;
-}
-
 sub _flatten_settings {
   my %settings  = @_;
   my %flattened = ();
@@ -134,4 +112,79 @@ sub _flatten_settings {
   return %flattened;
 }
 
+sub with_transaction {
+  my ($self, $code, @args) = @_;
+
+  return $code->(@args) if $self->in_transaction;
+  if (wantarray) {
+    my @result;
+    return $self->do_transaction(sub { @result = $code->(@args) }) ? @result : ();
+
+  } else {
+    my $result;
+    return $self->do_transaction(sub { $result = $code->(@args) }) ? $result : undef;
+  }
+}
+
 1;
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+SL::DB - Database access class for all RDB objects
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<create $domain, $type>
+
+Registers the database information with Rose, creates a cached
+connection and executes initial SQL statements. Those can include
+setting the time & date format to the user's preferences.
+
+=item C<dbi_connect $dsn, $login, $password, $options>
+
+Forwards the call to L<SL::DBConnect/connect> which connects to the
+database. This indirection allows L<SL::DBConnect/connect> to route
+the calls through L<DBIx::Log4Perl> if this is enabled in the
+configuration.
+
+=item C<with_transaction $code_ref, @args>
+
+Executes C<$code_ref> with parameters C<@args> within a transaction,
+starting one if none is currently active. Example:
+
+  return $self->db->with_transaction(sub {
+    # do stuff with $self
+  });
+
+One big difference to L<Rose::DB/do_transaction> is the return code
+handling. If a transaction is already active then C<with_transcation>
+simply returns the result of calling C<$code_ref> as-is.
+
+Otherwise the return value depends on the result of the underlying
+transaction. If the transaction fails then C<undef> is returned in
+scalar context and an empty list in list context. If the transaction
+succeeds then the return value of C<$code_ref> is returned preserving
+context.
+
+So if you want to differentiate between "transaction failed" and
+"succeeded" then your C<$code_ref> should never return C<undef>
+itself.
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
+
+=cut