|
package SL::DB;
|
|
|
|
use strict;
|
|
|
|
use Carp;
|
|
use Data::Dumper;
|
|
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);
|
|
|
|
sub dbi_connect {
|
|
shift;
|
|
|
|
# runtime require to break circular include
|
|
require SL::DBConnect;
|
|
return SL::DBConnect->connect(@_);
|
|
}
|
|
|
|
sub create {
|
|
my $domain = shift || SL::DB->default_domain;
|
|
my $type = shift || SL::DB->default_type;
|
|
|
|
($domain, $type) = _register_db($domain, $type);
|
|
|
|
my $db = __PACKAGE__->new_or_cached(domain => $domain, type => $type);
|
|
|
|
return $db;
|
|
}
|
|
|
|
sub client {
|
|
create(undef, 'KIVITENDO');
|
|
}
|
|
|
|
sub auth {
|
|
create(undef, 'KIVITENDO_AUTH');
|
|
}
|
|
|
|
sub _register_db {
|
|
my $domain = shift;
|
|
my $type = shift;
|
|
|
|
require SL::DBConnect;
|
|
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 => 1,
|
|
},
|
|
);
|
|
|
|
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},
|
|
);
|
|
|
|
} else {
|
|
$type = 'KIVITENDO_EMPTY';
|
|
}
|
|
|
|
my %connect_settings = (%common_connect_settings, %specific_connect_settings);
|
|
my %flattened_settings = _flatten_settings(%connect_settings);
|
|
|
|
$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;
|
|
|
|
__PACKAGE__->register_db(domain => $domain,
|
|
type => $type,
|
|
%connect_settings,
|
|
);
|
|
}
|
|
|
|
return ($domain, $type);
|
|
}
|
|
|
|
sub _flatten_settings {
|
|
my %settings = @_;
|
|
my %flattened = ();
|
|
|
|
while (my ($key, $value) = each %settings) {
|
|
if ('HASH' eq ref $value) {
|
|
%flattened = ( %flattened, _flatten_settings(%{ $value }) );
|
|
} else {
|
|
$flattened{$key} = $value;
|
|
}
|
|
}
|
|
|
|
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 only if none is currently active. Example:
|
|
|
|
return $self->db->with_transaction(sub {
|
|
# do stuff with $self
|
|
});
|
|
|
|
There are two big differences between C<with_transaction> and
|
|
L<Rose::DB/do_transaction>: the handling of an already-running
|
|
transaction and the handling of return values.
|
|
|
|
The first difference revolves around when a transaction is started and
|
|
committed/rolled back. Rose's C<do_transaction> will always start one,
|
|
then execute the code reference and commit afterwards (or roll back if
|
|
an exception occurs).
|
|
|
|
This prevents the caller from combining several pieces of code using
|
|
C<do_transaction> reliably as results committed by an inner
|
|
transaction will be permanent even if the outer transaction is rolled
|
|
back.
|
|
|
|
Therefore our C<with_transaction> works differently: it will only
|
|
start a transaction if no transaction is currently active on the
|
|
database connection.
|
|
|
|
The second big difference to L<Rose::DB/do_transaction> is the
|
|
handling of returned values. Basically our C<with_transaction> will
|
|
return the values that the code reference C<$code_ref> returns (or
|
|
C<undef> if the transaction was rolled back). Rose's C<do_transaction>
|
|
on the other hand will only return a value signaling the transaction's
|
|
status.
|
|
|
|
In more detail:
|
|
|
|
=over 2
|
|
|
|
=item * If a transaction is already active then C<with_transaction>
|
|
will simply return the result of calling C<$code_ref> as-is preserving
|
|
context.
|
|
|
|
=item * If no transaction is started then C<$code_ref> will be wrapped
|
|
in one. C<with_transaction>'s return value depends on the result of
|
|
that transaction. If the it succeeds then the return value of
|
|
C<$code_ref> will be returned preserving context. Otherwise C<undef>
|
|
will be returned in scalar context and an empty list in list context.
|
|
|
|
=back
|
|
|
|
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
|