kivitendo/SL/DB.pm @ 16455a4f
| 82515b2d | Sven Schöling | package SL::DB;
|
||
use strict;
|
||||
use Carp;
|
||||
use Data::Dumper;
|
||||
| 37d7b869 | Sven Schöling | use SL::DBConnect;
|
||
| 82515b2d | Sven Schöling | use English qw(-no_match_vars);
|
||
use Rose::DB;
|
||||
| 37d7b869 | Sven Schöling | use Rose::DBx::Cache::Anywhere;
|
||
| 82515b2d | Sven Schöling | |||
use base qw(Rose::DB);
|
||||
| 37d7b869 | Sven Schöling | __PACKAGE__->db_cache_class('Rose::DBx::Cache::Anywhere');
|
||
| 82515b2d | Sven Schöling | __PACKAGE__->use_private_registry;
|
||
my (%_db_registered, %_initial_sql_executed);
|
||||
| 54d656bd | Moritz Bunkus | sub dbi_connect {
|
||
shift;
|
||||
| 22c02125 | Moritz Bunkus | return SL::DBConnect->connect(@_);
|
||
| 54d656bd | Moritz Bunkus | }
|
||
| 82515b2d | Sven Schöling | sub create {
|
||
my $domain = shift || SL::DB->default_domain;
|
||||
my $type = shift || SL::DB->default_type;
|
||||
| 45aeeb13 | Moritz Bunkus | ($domain, $type) = _register_db($domain, $type);
|
||
| 82515b2d | Sven Schöling | |||
my $db = __PACKAGE__->new_or_cached(domain => $domain, type => $type);
|
||||
| ea502a0b | Moritz Bunkus | _execute_initial_sql($db);
|
||
| 82515b2d | Sven Schöling | return $db;
|
||
}
|
||||
| ea502a0b | Moritz Bunkus | my %_dateformats = ( 'yy-mm-dd' => 'ISO',
|
||
'yyyy-mm-dd' => 'ISO',
|
||||
'mm/dd/yy' => 'SQL, US',
|
||||
'dd/mm/yy' => 'SQL, EUROPEAN',
|
||||
'dd.mm.yy' => 'GERMAN'
|
||||
);
|
||||
| 82515b2d | Sven Schöling | sub _register_db {
|
||
my $domain = shift;
|
||||
my $type = shift;
|
||||
| f9c88c3f | Moritz Bunkus | my %specific_connect_settings;
|
||
my %common_connect_settings = (
|
||||
driver => 'Pg',
|
||||
connect_options => {
|
||||
pg_enable_utf8 => $::locale && $::locale->is_utf8,
|
||||
},
|
||||
);
|
||||
if ($::myconfig{dateformat}) {
|
||||
$common_connect_settings{european_dates} = 1 if ($_dateformats{ $::myconfig{dateformat} } || '') =~ m/european/i;
|
||||
| d8ac0828 | Moritz Bunkus | }
|
||
| 738fb45b | Moritz Bunkus | |||
| f9c88c3f | Moritz Bunkus | 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 {
|
||||
| d8ac0828 | Moritz Bunkus | $type = 'KIVITENDO_EMPTY';
|
||
}
|
||||
| f9c88c3f | Moritz Bunkus | my %connect_settings = (%common_connect_settings, %specific_connect_settings);
|
||
| 18a9b190 | Moritz Bunkus | my %flattened_settings = _flatten_settings(%connect_settings);
|
||
| f9c88c3f | Moritz Bunkus | $domain = 'KIVITENDO' if $type =~ m/^KIVITENDO/;
|
||
$type .= join($SUBSCRIPT_SEPARATOR, map { ($_, $flattened_settings{$_} || '') } sort grep { $_ ne 'dbpasswd' } keys %flattened_settings);
|
||||
my $idx = "${domain}::${type}";
|
||||
| a97d97a0 | Moritz Bunkus | |||
if (!$_db_registered{$idx}) {
|
||||
$_db_registered{$idx} = 1;
|
||||
__PACKAGE__->register_db(domain => $domain,
|
||||
type => $type,
|
||||
%connect_settings,
|
||||
);
|
||||
}
|
||||
return ($domain, $type);
|
||||
| 82515b2d | Sven Schöling | }
|
||
| ea502a0b | Moritz Bunkus | 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;
|
||||
}
|
||||
| 18a9b190 | Moritz Bunkus | 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;
|
||||
}
|
||||
| 7cfa1f2a | Moritz Bunkus | sub with_transaction {
|
||
my ($self, $code, @args) = @_;
|
||||
| 0ade6272 | Moritz Bunkus | 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;
|
||||
}
|
||||
| 7cfa1f2a | Moritz Bunkus | }
|
||
| 82515b2d | Sven Schöling | 1;
|
||
| 7cfa1f2a | Moritz Bunkus | __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>
|
||||
| 0ade6272 | Moritz Bunkus | Executes C<$code_ref> with parameters C<@args> within a transaction,
|
||
starting one if none is currently active. Example:
|
||||
| 7cfa1f2a | Moritz Bunkus | |||
return $self->db->with_transaction(sub {
|
||||
# do stuff with $self
|
||||
});
|
||||
| 0ade6272 | Moritz Bunkus | 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.
|
||||
| 7cfa1f2a | Moritz Bunkus | =back
|
||
=head1 BUGS
|
||||
Nothing here yet.
|
||||
=head1 AUTHOR
|
||||
Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
|
||||
=cut
|