kivitendo/SL/DB/Object.pm @ a62d4e40
| 82515b2d | Sven Schöling | package SL::DB::Object;
|
||
use strict;
|
||||
| db0ab48c | Moritz Bunkus | use Carp;
|
||
| 17e54707 | Moritz Bunkus | use English qw(-no_match_vars);
|
||
| 82515b2d | Sven Schöling | use Rose::DB::Object;
|
||
| da6a187a | Moritz Bunkus | use Rose::DB::Object::Constants qw();
|
||
use List::MoreUtils qw(any pairwise);
|
||||
| 9b16f8f8 | Moritz Bunkus | use List::Util qw(first);
|
||
| 82515b2d | Sven Schöling | |||
use SL::DB;
|
||||
| ac552280 | Moritz Bunkus | use SL::DB::Helper::Attr;
|
||
use SL::DB::Helper::Metadata;
|
||||
use SL::DB::Helper::Manager;
|
||||
| 972b8771 | Sven Schöling | use SL::DB::Helper::Presenter;
|
||
| 07d690e4 | Moritz Bunkus | use SL::DB::Object::Hooks;
|
||
| 82515b2d | Sven Schöling | |||
use base qw(Rose::DB::Object);
|
||||
| 7da9d5b6 | Sven Schöling | my @rose_reserved_methods = qw(
|
||
db dbh delete DESTROY error init_db _init_db insert load meta meta_class
|
||||
| 11dd30f1 | Sven Schöling | not_found save update import
|
||
| 7da9d5b6 | Sven Schöling | );
|
||
| 842a2e4c | Moritz Bunkus | my %db_to_presenter_mapping = (
|
||
| 5443873a | Moritz Bunkus | Customer => 'CustomerVendor',
|
||
| 66ad36d9 | Moritz Bunkus | PurchaseInvoice => 'Invoice',
|
||
| 5443873a | Moritz Bunkus | Vendor => 'CustomerVendor',
|
||
| b3346748 | Geoffrey Richardson | GLTransaction => 'GL',
|
||
| 842a2e4c | Moritz Bunkus | );
|
||
| 82515b2d | Sven Schöling | sub new {
|
||
my $class = shift;
|
||||
my $self = $class->SUPER::new();
|
||||
$self->_assign_attributes(@_) if $self;
|
||||
return $self;
|
||||
}
|
||||
sub init_db {
|
||||
my $class_or_self = shift;
|
||||
my $class = ref($class_or_self) || $class_or_self;
|
||||
| 0674bc84 | Moritz Bunkus | my $type = $class =~ m/::Auth/ ? 'KIVITENDO_AUTH' : 'KIVITENDO';
|
||
| 82515b2d | Sven Schöling | |||
return SL::DB::create(undef, $type);
|
||||
}
|
||||
sub meta_class {
|
||||
| ac552280 | Moritz Bunkus | return 'SL::DB::Helper::Metadata';
|
||
| 82515b2d | Sven Schöling | }
|
||
sub _get_manager_class {
|
||||
my $class_or_self = shift;
|
||||
my $class = ref($class_or_self) || $class_or_self;
|
||||
return $class->meta->convention_manager->auto_manager_class_name($class);
|
||||
}
|
||||
| dc04e2cb | Moritz Bunkus | my %text_column_types = (text => 1, char => 1, varchar => 1);
|
||
| 82515b2d | Sven Schöling | |||
sub assign_attributes {
|
||||
my $self = shift;
|
||||
my %attributes = @_;
|
||||
my $pk = ref($self)->meta->primary_key;
|
||||
delete @attributes{$pk->column_names} if $pk;
|
||||
| 7da9d5b6 | Sven Schöling | delete @attributes{@rose_reserved_methods};
|
||
| 82515b2d | Sven Schöling | |||
return $self->_assign_attributes(%attributes);
|
||||
}
|
||||
sub _assign_attributes {
|
||||
my $self = shift;
|
||||
my %attributes = @_;
|
||||
my %types = map { $_->name => $_->type } ref($self)->meta->columns;
|
||||
| 6395006f | Moritz Bunkus | # Special case for *_as_man_days / *_as_man_days_string /
|
||
# *_as_man_days_unit: the _unit variation must always be called
|
||||
# after the non-unit methods.
|
||||
my @man_days_attributes = grep { m/_as_man_days(?:_string)?$/ } keys %attributes;
|
||||
| 4180aaea | Moritz Bunkus | foreach my $attribute (@man_days_attributes) {
|
||
my $value = delete $attributes{$attribute};
|
||||
$self->$attribute(defined($value) && ($value eq '') ? undef : $value);
|
||||
}
|
||||
| 82515b2d | Sven Schöling | while (my ($attribute, $value) = each %attributes) {
|
||
my $type = lc($types{$attribute} || 'text');
|
||||
| 321730c8 | Moritz Bunkus | $value = $type eq 'boolean' ? ($value ? 't' : 'f')
|
||
: $text_column_types{$type} ? $value
|
||||
: defined($value) && ($value eq '') ? undef
|
||||
: $value;
|
||||
| 82515b2d | Sven Schöling | $self->$attribute($value);
|
||
}
|
||||
return $self;
|
||||
}
|
||||
sub update_attributes {
|
||||
my $self = shift;
|
||||
$self->assign_attributes(@_)->save;
|
||||
return $self;
|
||||
}
|
||||
| 9b16f8f8 | Moritz Bunkus | sub update_collection {
|
||
my ($self, $attribute, $entries) = @_;
|
||||
my $self_primary_key = "" . ($self->meta->primary_key_columns)[0];
|
||||
croak "\$self hasn't been saved yet" if !$self->$self_primary_key;
|
||||
my $relationship = first { $_->name eq $attribute } @{ $self->meta->relationships };
|
||||
croak "No relationship found for attribute '$attribute'" if !$relationship;
|
||||
my @primary_key_columns = $relationship->class->meta->primary_key_columns;
|
||||
croak "Classes with multiple primary key columns are not supported" if scalar(@primary_key_columns) > 1;
|
||||
my $class = $relationship->class;
|
||||
my $manager_class = "SL::DB::Manager::" . substr($class, 8);
|
||||
my $other_primary_key = "" . $primary_key_columns[0];
|
||||
my $column_map = $relationship->column_map;
|
||||
my @new_entries = @{ $entries // [] };
|
||||
my @existing_entries = @{ $self->$attribute // [] };
|
||||
my @to_delete = grep { my $value = $_->$other_primary_key; !any { $_->{$other_primary_key} == $value } @new_entries } @existing_entries;
|
||||
$_->delete for @to_delete;
|
||||
foreach my $entry (@new_entries) {
|
||||
if (!$entry->{$other_primary_key}) {
|
||||
my $new_instance = $class->new(%{ $entry });
|
||||
foreach my $self_attribute (keys %{ $column_map }) {
|
||||
my $other_attribute = $column_map->{$self_attribute};
|
||||
$new_instance->$other_attribute($self->$self_attribute);
|
||||
}
|
||||
$new_instance->save;
|
||||
next;
|
||||
}
|
||||
my $existing = first { $_->$other_primary_key == $entry->{$other_primary_key} } @existing_entries;
|
||||
$existing->update_attributes(%{ $entry }) if $existing;
|
||||
}
|
||||
}
|
||||
| 6fd01c3d | Moritz Bunkus | sub call_sub {
|
||
my $self = shift;
|
||||
my $sub = shift;
|
||||
return $self->$sub(@_);
|
||||
}
|
||||
| c73b2658 | Moritz Bunkus | sub call_sub_if {
|
||
my $self = shift;
|
||||
my $sub = shift;
|
||||
my $check = shift;
|
||||
$check = $check->($self) if ref($check) eq 'CODE';
|
||||
return $check ? $self->$sub(@_) : $self;
|
||||
}
|
||||
| 0b89d2ca | Moritz Bunkus | sub get_first_conflicting {
|
||
my ($self, @attributes) = @_;
|
||||
my $primary_key = ($self->meta->primary_key)[0];
|
||||
my @where = map { ($_ => $self->$_) } @attributes;
|
||||
push @where, ("!$primary_key" => $self->$primary_key) if $self->$primary_key;
|
||||
return $self->_get_manager_class->get_first(where => [ and => \@where ]);
|
||||
}
|
||||
| 07d690e4 | Moritz Bunkus | # These three functions cannot sit in SL::DB::Object::Hooks because
|
||
# mixins don't deal well with super classes (SUPER is the current
|
||||
# package's super class, not $self's).
|
||||
sub load {
|
||||
my ($self, @args) = @_;
|
||||
SL::DB::Object::Hooks::run_hooks($self, 'before_load');
|
||||
my $result = $self->SUPER::load(@args);
|
||||
SL::DB::Object::Hooks::run_hooks($self, 'after_load', $result);
|
||||
return $result;
|
||||
}
|
||||
sub save {
|
||||
my ($self, @args) = @_;
|
||||
| d49485e0 | Moritz Bunkus | |||
| 96670fe8 | Moritz Bunkus | my $result;
|
||
| d16fc161 | Sven Schöling | |||
| 96670fe8 | Moritz Bunkus | $self->db->with_transaction(sub {
|
||
SL::DB::Object::Hooks::run_hooks($self, 'before_save');
|
||||
$result = $self->SUPER::save(@args);
|
||||
SL::DB::Object::Hooks::run_hooks($self, 'after_save', $result);
|
||||
| 07d690e4 | Moritz Bunkus | |||
| 96670fe8 | Moritz Bunkus | 1;
|
||
| 660c7e53 | Sven Schöling | }) || die $self->db->error;
|
||
| 17e54707 | Moritz Bunkus | |||
| d49485e0 | Moritz Bunkus | return $result;
|
||
| 07d690e4 | Moritz Bunkus | }
|
||
sub delete {
|
||||
my ($self, @args) = @_;
|
||||
| d49485e0 | Moritz Bunkus | |||
| 96670fe8 | Moritz Bunkus | my $result;
|
||
| 07d690e4 | Moritz Bunkus | |||
| 96670fe8 | Moritz Bunkus | $self->db->with_transaction(sub {
|
||
SL::DB::Object::Hooks::run_hooks($self, 'before_delete');
|
||||
$result = $self->SUPER::delete(@args);
|
||||
SL::DB::Object::Hooks::run_hooks($self, 'after_delete', $result);
|
||||
| 17e54707 | Moritz Bunkus | |||
| 96670fe8 | Moritz Bunkus | 1;
|
||
| 660c7e53 | Sven Schöling | }) || die $self->db->error;
|
||
| 17e54707 | Moritz Bunkus | |||
| d49485e0 | Moritz Bunkus | return $result;
|
||
| 07d690e4 | Moritz Bunkus | }
|
||
| db0ab48c | Moritz Bunkus | sub load_cached {
|
||
my $class_or_self = shift;
|
||||
my @ids = @_;
|
||||
my $class = ref($class_or_self) || $class_or_self;
|
||||
my $cache = $::request->cache("::SL::DB::Object::object_cache::${class}");
|
||||
croak "Missing ID" unless @ids;
|
||||
my @missing_ids = grep { !exists $cache->{$_} } @ids;
|
||||
return $cache->{$ids[0]} if !@missing_ids;
|
||||
croak "Caching can only be used with classes with exactly one primary key column" if 1 != scalar(@{ $class->meta->primary_key_columns });
|
||||
my $primary_key = $class->meta->primary_key_columns->[0]->name;
|
||||
my $objects = $class->_get_manager_class->get_all(where => [ $primary_key => \@missing_ids ]);
|
||||
$cache->{$_->$primary_key} = $_ for @{ $objects};
|
||||
return $cache->{$ids[0]};
|
||||
}
|
||||
sub invalidate_cached {
|
||||
my ($class_or_self, @ids) = @_;
|
||||
my $class = ref($class_or_self) || $class_or_self;
|
||||
if (ref($class_or_self) && !@ids) {
|
||||
croak "Caching can only be used with classes with exactly one primary key column" if 1 != scalar(@{ $class->meta->primary_key_columns });
|
||||
my $primary_key = $class->meta->primary_key_columns->[0]->name;
|
||||
@ids = ($class_or_self->$primary_key);
|
||||
}
|
||||
delete @{ $::request->cache("::SL::DB::Object::object_cache::${class}") }{ @ids };
|
||||
return $class_or_self;
|
||||
}
|
||||
| da6a187a | Moritz Bunkus | my %_skip_fields_when_cloning = map { ($_ => 1) } qw(itime mtime);
|
||
sub clone_and_reset {
|
||||
my($self) = shift;
|
||||
my $class = ref $self;
|
||||
my $cloning = Rose::DB::Object::Constants::STATE_CLONING();
|
||||
local $self->{$cloning} = 1;
|
||||
my $meta = $class->meta;
|
||||
my @accessors = $meta->column_accessor_method_names;
|
||||
my @mutators = $meta->column_mutator_method_names;
|
||||
my @column_names =
|
||||
grep { $_->[0] && $_->[1] && !$_skip_fields_when_cloning{ $_->[0] } }
|
||||
| 1aa3ce07 | Sven Schöling | pairwise { no warnings qw(once); [ $a, $b] } @accessors, @mutators;
|
||
| da6a187a | Moritz Bunkus | |||
my $clone = $class->new(map { my $method = $_->[0]; ($_->[1] => $self->$method) } @column_names);
|
||||
# Blank all primary and unique key columns
|
||||
my @keys = (
|
||||
$meta->primary_key_column_mutator_names,
|
||||
map { my $uk = $_; map { $meta->column_mutator_method_name($_) } ($uk->columns) } ($meta->unique_keys)
|
||||
);
|
||||
$clone->$_(undef) for @keys;
|
||||
# Also copy db object, if any
|
||||
$clone->db($self->{db}) if $self->{db};
|
||||
return $clone;
|
||||
}
|
||||
| 972b8771 | Sven Schöling | sub presenter {
|
||
| 842a2e4c | Moritz Bunkus | my ($self) = @_;
|
||
my $class = ref $self;
|
||||
$class =~ s{^SL::DB::}{};
|
||||
$class = "SL::Presenter::" . ($db_to_presenter_mapping{$class} // $class);
|
||||
return SL::DB::Helper::Presenter->new($class, $self);
|
||||
| 972b8771 | Sven Schöling | }
|
||
| 7f5edaa6 | Moritz Bunkus | sub as_debug_info {
|
||
my ($self) = @_;
|
||||
return {
|
||||
map {
|
||||
my $column_name = $_->name;
|
||||
my $value = $self->$column_name;
|
||||
$value = !defined($value) ? undef : "${value}";
|
||||
($_ => $value)
|
||||
} $self->meta->columns
|
||||
};
|
||||
}
|
||||
| 82515b2d | Sven Schöling | 1;
|
||
__END__
|
||||
=pod
|
||||
| db0ab48c | Moritz Bunkus | =encoding utf8
|
||
| 82515b2d | Sven Schöling | =head1 NAME
|
||
SL::DB::Object: Base class for all of our model classes
|
||||
=head1 DESCRIPTION
|
||||
This is the base class from which all other model classes are
|
||||
derived. It contains functionality and settings required for all model
|
||||
classes.
|
||||
Several functions (e.g. C<make_manager_class>, C<init_db>) in this
|
||||
class are used for setting up the classes / base classes used for all
|
||||
model instances. They overwrite the functions from
|
||||
L<Rose::DB::Object>.
|
||||
=head1 FUNCTIONS
|
||||
=over 4
|
||||
=item assign_attributes %attributes
|
||||
=item _assign_attributes %attributes
|
||||
Assigns all elements from C<%attributes> to the columns by calling
|
||||
their setter functions. The difference between the two functions is
|
||||
that C<assign_attributes> protects primary key columns while
|
||||
C<_assign_attributes> doesn't.
|
||||
Both functions handle values that are empty strings by replacing them
|
||||
with C<undef> for non-text columns. This allows the calling functions
|
||||
to use data from HTML forms as the input for C<assign_attributes>
|
||||
without having to remove empty strings themselves (think of
|
||||
e.g. select boxes with an empty option which should be turned into
|
||||
C<NULL> in the database).
|
||||
=item update_attributes %attributes
|
||||
Assigns the attributes from C<%attributes> by calling the
|
||||
C<assign_attributes> function and saves the object afterwards. Returns
|
||||
| c637622e | Jan Büren | the object itself.
|
||
| 82515b2d | Sven Schöling | |||
| 9b16f8f8 | Moritz Bunkus | =item C<update_collection $attribute, $entries, %params>
|
||
Updates a one-to-many relationship named C<$attribute> to match the
|
||||
entries in C<$entries>. C<$entries> is supposed to be an array ref of
|
||||
hash refs.
|
||||
For each hash ref in C<$entries> that does not contain a field for the
|
||||
relationship's primary key column, this function creates a new entry
|
||||
in the database with its attributes set to the data in the entry.
|
||||
For each hash ref in C<$entries> that contains a field for the
|
||||
relationship's primary key column, this function looks up the
|
||||
corresponding entry in C<$self->$attribute> & updates its
|
||||
attributes with the data in the entry.
|
||||
All objects in C<$self->$attribute> for which no corresponding
|
||||
entry exists in C<$entries> are deleted by calling the object's
|
||||
C<delete> method.
|
||||
In all cases the relationship itself C<$self->$attribute> is not
|
||||
changed.
|
||||
| 82515b2d | Sven Schöling | =item _get_manager_class
|
||
Returns the manager package for the object or class that it is called
|
||||
on. Can be used from methods in this package for getting the actual
|
||||
object's manager.
|
||||
| 6fd01c3d | Moritz Bunkus | =item C<call_sub $name, @args>
|
||
Calls the sub C<$name> on C<$self> with the arguments C<@args> and
|
||||
returns its result. This is meant for situations in which the sub's
|
||||
name is a composite, e.g.
|
||||
my $chart_id = $buchungsgruppe->call_sub(($is_sales ? "income" : "expense") . "_accno_id_${taxzone_id}");
|
||||
| c73b2658 | Moritz Bunkus | =item C<call_sub_if $name, $check, @args>
|
||
Calls the sub C<$name> on C<$self> with the arguments C<@args> if
|
||||
C<$check> is trueish. If C<$check> is a code reference then it will be
|
||||
called with C<$self> as the only argument and its result determines
|
||||
whether or not C<$name> is called.
|
||||
Returns the sub's result if the check is positive and C<$self>
|
||||
otherwise.
|
||||
| 0b89d2ca | Moritz Bunkus | =item C<get_first_conflicting @attributes>
|
||
Returns the first object for which all properties listed in
|
||||
C<@attributes> equal those in C<$self> but which is not C<$self>. Can
|
||||
be used to check whether or not an object's columns are unique before
|
||||
saving or during validation.
|
||||
| db0ab48c | Moritz Bunkus | =item C<load_cached @ids>
|
||
Loads objects from the database which haven't been cached before and
|
||||
caches them for the duration of the current request (see
|
||||
L<SL::Request/cache>).
|
||||
| 913348ce | Moritz Bunkus | If you know in advance that you will likely need all objects of a
|
||
particular type then you can pre-cache them by calling the manager's
|
||||
C<cache_all> function. For example, if you expect to need all unit
|
||||
objects, you can use C<SL::DB::Manager::Unit-E<gt>cache_all> before
|
||||
you start the actual work. Later you can use
|
||||
C<SL::DB::Unit-E<gt>load_cached> to retrieve individual objects and be
|
||||
sure that they're already cached.
|
||||
| db0ab48c | Moritz Bunkus | This method can be called both as an instance method and a class
|
||
method. It loads objects for the corresponding class (e.g. both
|
||||
C<SL::DB::Part-E<gt>load_cached(…)> and
|
||||
C<$some_part-E<gt>load_cached(…)> will load parts).
|
||||
Currently only classes with a single primary key column are supported.
|
||||
Returns the cached object for the first ID.
|
||||
=item C<invalidate_cached @ids>
|
||||
Deletes all cached instances of this class (see L</load_cached>) for
|
||||
the given IDs.
|
||||
If called as an instance method without further arguments then the
|
||||
object's ID is used.
|
||||
Returns the object/class it was called on.
|
||||
| da6a187a | Moritz Bunkus | =item C<clone_and_reset>
|
||
This works similar to L<Rose::DB::Object::Helpers/clone_and_reset>: it
|
||||
returns a cloned instance of C<$self>. All primary and unique key
|
||||
fields have been reset.
|
||||
The difference between Rose's and this function is that this function
|
||||
will also skip setting the following fields if such columns exist for
|
||||
C<$self>: C<itime>, C<mtime>.
|
||||
| 972b8771 | Sven Schöling | =item C<presenter>
|
||
Returns a proxy wrapper that will dispatch all method calls to the presenter
|
||||
with the same name as the class of the involking object.
|
||||
For the full documentation about its capabilites see
|
||||
L<SL::DB::Helper::Presenter>
|
||||
| 7f5edaa6 | Moritz Bunkus | =item C<as_debug_info>
|
||
Returns a hash containing solely the essentials for dumping it with
|
||||
L<LXDebug/dump>. The returned hash consists of the column names with
|
||||
associated column values in stringified form.
|
||||
| 82515b2d | Sven Schöling | =back
|
||
=head1 AUTHOR
|
||||
Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
|
||||
=cut
|