X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FDB%2FHelper%2FLinkedRecords.pm;h=bb21ecf27c5a565f98c399c03eac14576b412664;hb=b2f713102369a59726b6fb128dbb0be2fc7dc8e6;hp=c1d31338b28835969b24b7b5fc2d858f97352499;hpb=f203aa21ad0ff71285b354e5565b7a0ba275dc88;p=kivitendo-erp.git diff --git a/SL/DB/Helper/LinkedRecords.pm b/SL/DB/Helper/LinkedRecords.pm index c1d31338b..bb21ecf27 100644 --- a/SL/DB/Helper/LinkedRecords.pm +++ b/SL/DB/Helper/LinkedRecords.pm @@ -1,45 +1,284 @@ -package SL::DB::Helpers::LinkedRecords; +package SL::DB::Helper::LinkedRecords; + +use strict; require Exporter; our @ISA = qw(Exporter); -our @EXPORT = qw(linked_records); +our @EXPORT = qw(linked_records link_to_record); use Carp; +use Sort::Naturally; +use SL::DBUtils; -use SL::DB::Helpers::Mappings; +use SL::DB::Helper::Mappings; use SL::DB::RecordLink; sub linked_records { + my ($self, %params) = @_; + + my %sort_spec = ( by => delete($params{sort_by}), + dir => delete($params{sort_dir}) ); + my $filter = delete $params{filter}; + + my $records = _linked_records_implementation($self, %params); + $records = filter_linked_records($self, $filter, @{ $records }) if $filter; + $records = sort_linked_records($self, $sort_spec{by}, $sort_spec{dir}, @{ $records }) if $sort_spec{by}; + + return $records; +} + +sub _linked_records_implementation { my $self = shift; my %params = @_; - my $wanted = $params{direction} || croak("Missing parameter `direction'"); - my $myself = $wanted eq 'from' ? 'to' : $wanted eq 'to' ? 'from' : croak("Invalid parameter `direction'"); + my $wanted = $params{direction}; + + if (!$wanted) { + if ($params{to} && $params{from}) { + $wanted = 'both'; + } elsif ($params{to}) { + $wanted = 'to'; + } elsif ($params{from}) { + $wanted = 'from'; + } else { + $wanted = 'both'; + } + } - my $my_table = SL::DB::Helpers::Mappings::get_table_for_package(ref($self)); + if ($wanted eq 'both') { + my $both = delete($params{both}); + my %from_to = ( from => delete($params{from}) || $both, + to => delete($params{to}) || $both); - my @query = ( "${myself}_table" => $my_table, - "${myself}_id" => $self->id ); + my @records = (@{ _linked_records_implementation($self, %params, direction => 'from', from => $from_to{from}) }, + @{ _linked_records_implementation($self, %params, direction => 'to', to => $from_to{to} ) }); - if ($params{$wanted}) { - my $wanted_table = SL::DB::Helpers::Mappings::get_table_for_package($params{$wanted}) || croak("Invalid parameter `${wanted}'"); - push @query, ("${wanted}_table" => $wanted_table); + my %record_map = map { ( ref($_) . $_->id => $_ ) } @records; + + return [ values %record_map ]; } - my $links = SL::DB::Manager::RecordLink->get_all(query => [ and => \@query ]); + if ($params{via}) { + croak("Cannot use 'via' without '${wanted}_table'") if !$params{$wanted}; + croak("Cannot use 'via' with '${wanted}_table' being an array") if ref $params{$wanted}; + } + + my $myself = $wanted eq 'from' ? 'to' : $wanted eq 'to' ? 'from' : croak("Invalid parameter `direction'"); + my $my_table = SL::DB::Helper::Mappings::get_table_for_package(ref($self)); my $sub_wanted_table = "${wanted}_table"; my $sub_wanted_id = "${wanted}_id"; - my $records = []; - @query = ref($params{query}) eq 'ARRAY' ? @{ $params{query} } : (); + my ($wanted_classes, $wanted_tables); + if ($params{$wanted}) { + $wanted_classes = ref($params{$wanted}) eq 'ARRAY' ? $params{$wanted} : [ $params{$wanted} ]; + $wanted_tables = [ map { SL::DB::Helper::Mappings::get_table_for_package($_) || croak("Invalid parameter `${wanted}'") } @{ $wanted_classes } ]; + } + + my @get_objects_query = ref($params{query}) eq 'ARRAY' ? @{ $params{query} } : (); + my $get_objects = sub { + my ($link) = @_; + my $manager_class = SL::DB::Helper::Mappings::get_manager_package_for_table($link->$sub_wanted_table); + my $object_class = SL::DB::Helper::Mappings::get_package_for_table($link->$sub_wanted_table); + eval "require " . $object_class . "; 1;"; + return map { + $_->{_record_link_direction} = $wanted; + $_->{_record_link} = $link; + $_ + } @{ $manager_class->get_all(query => [ id => $link->$sub_wanted_id, @get_objects_query ]) }; + }; + + # If no 'via' is given then use a simple(r) method for querying the wanted objects. + if (!$params{via} && !$params{recursive}) { + my @query = ( "${myself}_table" => $my_table, + "${myself}_id" => $self->id ); + push @query, ( "${wanted}_table" => $wanted_tables ) if $wanted_tables; + + return [ map { $get_objects->($_) } @{ SL::DB::Manager::RecordLink->get_all(query => [ and => \@query ]) } ]; + } - foreach my $link (@{ $links }) { - my $class = SL::DB::Helpers::Mappings::get_manager_package_for_table($link->$sub_wanted_table); - push @{ $records }, @{ $class->get_all(query => [ id => $link->$sub_wanted_id, @query ]) }; + # More complex handling for the 'via' case. + if ($params{via}) { + my @sources = ( $self ); + my @targets = map { SL::DB::Helper::Mappings::get_table_for_package($_) } @{ ref($params{via}) ? $params{via} : [ $params{via} ] }; + push @targets, @{ $wanted_tables } if $wanted_tables; + + my %seen = map { ($_->meta->table . $_->id => 1) } @sources; + + while (@targets) { + my @new_sources = @sources; + foreach my $src (@sources) { + my @query = ( "${myself}_table" => $src->meta->table, + "${myself}_id" => $src->id, + "${wanted}_table" => \@targets ); + push @new_sources, + map { $get_objects->($_) } + grep { !$seen{$_->$sub_wanted_table . $_->$sub_wanted_id} } + @{ SL::DB::Manager::RecordLink->get_all(query => [ and => \@query ]) }; + } + + @sources = @new_sources; + %seen = map { ($_->meta->table . $_->id => 1) } @sources; + shift @targets; + } + + my %wanted_tables_map = map { ($_ => 1) } @{ $wanted_tables }; + return [ grep { $wanted_tables_map{$_->meta->table} } @sources ]; } - return $records; + # And lastly recursive mode + if ($params{recursive}) { + # don't use rose retrieval here. too slow. + # instead use recursive sql to get all the linked record_links entrys, and retrieve the objects from there + my $query = <<""; + WITH RECURSIVE record_links_rec_${wanted}(id, from_table, from_id, to_table, to_id, depth, path, cycle) AS ( + SELECT id, from_table, from_id, to_table, to_id, + 1, ARRAY[id], false + FROM record_links + WHERE ${myself}_id = ? and ${myself}_table = ? + UNION ALL + SELECT rl.id, rl.from_table, rl.from_id, rl.to_table, rl.to_id, + rlr.depth + 1, path || rl.id, rl.id = ANY(path) + FROM record_links rl, record_links_rec_${wanted} rlr + WHERE rlr.${wanted}_id = rl.${myself}_id AND rlr.${wanted}_table = rl.${myself}_table AND NOT cycle + ) + SELECT DISTINCT ON (${wanted}_table, ${wanted}_id) + id, from_table, from_id, to_table, to_id, path, depth FROM record_links_rec_${wanted} + WHERE NOT cycle + ORDER BY ${wanted}_table, ${wanted}_id, depth ASC; + + my $links = selectall_hashref_query($::form, $::form->get_standard_dbh, $query, $self->id, $self->meta->table); + + return [] unless @$links; + + my $link_objs = SL::DB::Manager::RecordLink->get_all(query => [ id => [ map { $_->{id} } @$links ] ]); + my @objects = map { $get_objects->($_) } @$link_objs; + + if ($params{save_path}) { + my %links_by_id = map { $_->{id} => $_ } @$links; + for (@objects) { + my $link = $links_by_id{$_->{_record_link}->id}; + my $intermediate_links = SL::DB::Manager::RecordLink->get_all(query => [ id => $link->{path} ]); + $_->{_record_link_path} = $link->{path}; + $_->{_record_link_obj_path} = [ map { $get_objects->($_) } @$intermediate_links ]; + $_->{_record_link_depth} = $link->{depth}; + } + } + + return \@objects; + } +} + +sub link_to_record { + my $self = shift; + my $other = shift; + my %params = @_; + + croak "self has no id" unless $self->id; + croak "other has no id" unless $other->id; + + my @directions = ([ 'from', 'to' ]); + push @directions, [ 'to', 'from' ] if $params{bidirectional}; + my @links; + + foreach my $direction (@directions) { + my %data = ( $direction->[0] . "_table" => SL::DB::Helper::Mappings::get_table_for_package(ref($self)), + $direction->[0] . "_id" => $self->id, + $direction->[1] . "_table" => SL::DB::Helper::Mappings::get_table_for_package(ref($other)), + $direction->[1] . "_id" => $other->id, + ); + + my $link = SL::DB::Manager::RecordLink->find_by(and => [ %data ]); + push @links, $link ? $link : SL::DB::RecordLink->new(%data)->save; + } + + return wantarray ? @links : $links[0]; +} + +sub sort_linked_records { + my ($self_or_class, $sort_by, $sort_dir, @records) = @_; + + @records = @{ $records[0] } if (1 == scalar(@records)) && (ref($records[0]) eq 'ARRAY'); + $sort_dir = $sort_dir * 1 ? 1 : -1; + + my %numbers = ( 'SL::DB::SalesProcess' => sub { $_[0]->id }, + 'SL::DB::Order' => sub { $_[0]->quotation ? $_[0]->quonumber : $_[0]->ordnumber }, + 'SL::DB::DeliveryOrder' => sub { $_[0]->donumber }, + 'SL::DB::Invoice' => sub { $_[0]->invnumber }, + 'SL::DB::PurchaseInvoice' => sub { $_[0]->invnumber }, + 'SL::DB::RequirementSpec' => sub { $_[0]->id }, + UNKNOWN => '9999999999999999', + ); + my $number_xtor = sub { + my $number = $numbers{ ref($_[0]) }; + $number = $number->($_[0]) if ref($number) eq 'CODE'; + return $number || $numbers{UNKNOWN}; + }; + my $number_comparator = sub { + my $number_a = $number_xtor->($a); + my $number_b = $number_xtor->($b); + + ncmp($number_a, $number_b) * $sort_dir; + }; + + my %scores; + %scores = ( 'SL::DB::SalesProcess' => 10, + 'SL::DB::RequirementSpec' => 15, + 'SL::DB::Order' => sub { $scores{ $_[0]->type } }, + sales_quotation => 20, + sales_order => 30, + sales_delivery_order => 40, + 'SL::DB::DeliveryOrder' => sub { $scores{ $_[0]->type } }, + 'SL::DB::Invoice' => 50, + request_quotation => 120, + purchase_order => 130, + purchase_delivery_order => 140, + 'SL::DB::PurchaseInvoice' => 150, + UNKNOWN => 999, + ); + my $score_xtor = sub { + my $score = $scores{ ref($_[0]) }; + $score = $score->($_[0]) if ref($score) eq 'CODE'; + return $score || $scores{UNKNOWN}; + }; + my $type_comparator = sub { + my $score_a = $score_xtor->($a); + my $score_b = $score_xtor->($b); + + $score_a == $score_b ? $number_comparator->() : ($score_a <=> $score_b) * $sort_dir; + }; + + my $today = DateTime->today_local; + my $date_xtor = sub { + $_[0]->can('transdate_as_date') ? $_[0]->transdate + : $_[0]->can('itime_as_date') ? $_[0]->itime->clone->truncate(to => 'day') + : $today; + }; + my $date_comparator = sub { + my $date_a = $date_xtor->($a); + my $date_b = $date_xtor->($b); + + ($date_a <=> $date_b) * $sort_dir; + }; + + my $comparator = $sort_by eq 'number' ? $number_comparator + : $sort_by eq 'date' ? $date_comparator + : $type_comparator; + + return [ sort($comparator @records) ]; +} + +sub filter_linked_records { + my ($self_or_class, $filter, @records) = @_; + + if ($filter eq 'accessible') { + my $employee = SL::DB::Manager::Employee->current; + @records = grep { !$_->can('may_be_accessed') || $_->may_be_accessed($employee) } @records; + } else { + croak "Unsupported filter parameter '${filter}'"; + } + + return \@records; } 1; @@ -50,7 +289,65 @@ __END__ =head1 NAME -SL::DB::Helpers::LinkedRecords - Mixin for retrieving linked records via the table C +SL::DB::Helper::LinkedRecords - Mixin for retrieving linked records via the table C + +SYNOPSIS + + # In SL::DB:: + use SL::DB::Helper::LinkedRecords; + + # later in consumer code + # retrieve all links in both directions + my @linked_objects = $order->linked_records; + + # only links to Invoices + my @linked_objects = $order->linked_records( + to => 'Invoice', + ); + + # more than one target + my @linked_objects = $order->linked_records( + to => [ 'Invoice', 'Order' ], + ); + + # more than one direction + my @linked_objects = $order->linked_records( + both => 'Invoice', + ); + + # more than one direction and different targets + my @linked_objects = $order->linked_records( + to => 'Invoice', + from => 'Order', + ); + + # via over known classes + my @linked_objects = $order->linked_records( + to => 'Invoice', + via => 'DeliveryOrder', + ); + my @linked_objects = $order->linked_records( + to => 'Invoice', + via => [ 'Order', 'DeliveryOrder' ], + ); + + # recursive + my @linked_objects = $order->linked_records( + recursive => 1, + ); + + + # limit direction when further params contain additional keys + my %params = (to => 'Invoice', from => 'Order'); + my @linked_objects = $order->linked_records( + direction => 'to', + %params, + ); + + # add a new link + $order->link_to_record($invoice); + $order->link_to_record($purchase_order, bidirectional => 1); + =head1 FUNCTIONS @@ -58,38 +355,217 @@ SL::DB::Helpers::LinkedRecords - Mixin for retrieving linked records via the tab =item C -Retrieves records linked from or to C<$self> via the table -C. The mandatory parameter C (either C -or C) determines whether the function retrieves records that link -to C<$self> (for C = C) or that are linked from -C<$self> (for C = C). +Retrieves records linked from or to C<$self> via the table C. + +The optional parameter C (either C, C or C) +determines whether the function retrieves records that link to C<$self> (for +C = C) or that are linked from C<$self> (for C = +C). For C all records linked from or to C<$self> are +returned. + +The optional parameter C or C (same as C) contains the +package names of Rose models for table limitation (the prefix C is +optional). It can be a single model name as a single scalar or multiple model +names in an array reference in which case all links matching any of the model +names will be returned. + +If no parameter C is given, but any of C, C or C, +then C is inferred accordingly. If neither are given, C is +set to C. -The optional parameter C or C (same as C) -contains the package name of a Rose model for table limitation. If you -only need invoices created from an order C<$order> then the call could -look like this: +The optional parameter C can be used to retrieve all documents that may +have intermediate documents inbetween. It is an array reference of Rose package +names for the models that may be intermediate link targets. One example is +retrieving all invoices for a given quotation no matter whether or not orders +and delivery orders have been created. If C is given then C or C +(depending on C) must be given as well, and it must then not be an +array reference. - my $invoices = $order->linked_records(direction => 'to', - to => 'SL::DB::Invoice'); +Examples: + +If you only need invoices created directly from an order C<$order> (no +delivery orders inbetween) then the call could look like this: + + my $invoices = $order->linked_records( + direction => 'to', + to => 'Invoice', + ); + +Retrieving all invoices from a quotation no matter whether or not +orders or delivery orders were created: + + my $invoices = $quotation->linked_records( + direction => 'to', + to => 'Invoice', + via => [ 'Order', 'DeliveryOrder' ], + ); The optional parameter C can be used to limit the records returned. The following call limits the earlier example to invoices created today: - my $invoices = $order->linked_records(direction => 'to', - to => 'SL::DB::Invoice', - query => [ transdate => DateTime->today ]); + my $invoices = $order->linked_records( + direction => 'to', + to => 'Invoice', + query => [ transdate => DateTime->today_local ], + ); + +In case you don't know or care which or how many objects are visited the flag +C can be used. It searches all reachable objects in the given direction: + + my $records = $order->linked_records( + direction => 'to', + recursive => 1, + ); + +Only link chains of the same type will be considered. So even with direction +both, this + + order 1 ---> invoice <--- order 2 + +started from order 1 will only find invoice. If an object is found both in each +direction, only one copy will be returned. The recursion is cycle protected, +and will not recurse infinitely. Cycles are defined by the same link being +visited twice, so this + + + order 1 ---> order 2 <--> delivery order + | + `--------> invoice + +will find the path o1 -> o2 -> do -> o2 -> i without considering it a cycle. + +The optional extra flag C will give you extra information saved in +the returned objects: + + my $records = $order->linked_records( + direction => 'to', + recursive => 1, + save_path => 1, + ); + +Every record will have two fields set: + +=over 2 + +=item C<_record_link_path> + +An array with the ids of the visited links. The shortest paths will be +preferred, so in the previous example this would contain the ids of o1-o2 and +o2-i. + +=item C<_record_link_depth> + +Recursion depth when this object was found. Equal to the number of ids in +C<_record_link_path> + +=back + + +The optional parameters C<$params{sort_by}> and C<$params{sort_dir}> +can be used in order to sort the result. If C<$params{sort_by}> is +trueish then the result is sorted by calling L. + +The optional parameter C<$params{filter}> controls whether or not the +result is filtered. Supported values are: + +=over 2 + +=item C + +Removes all objects for which the function C from the +mixin L exists and returns falsish for +the current employee. + +=back + +Returns an array reference. Each element returned is a Rose::DB +instance. Additionally several elements in the element returned are +set to special values: + +=over 2 + +=item C<_record_link_direction> + +Either C or C indicating the direction. C means that +this object is the source in the link. + +=item C<_record_link> + +The actual database link object (an instance of L). + +=back + +=item C + +Will create an entry in the table C with the C +side being C<$self> and the C side being C<$record>. Will only +insert a new entry if such a link does not already exist. + +If C<$params{bidirectional}> is trueish then another link will be +created with the roles of C and C reversed. This link will +also only be created if it doesn't exist already. + +In scalar context returns either the existing link or the newly +created one as an instance of C. In array context +it returns an array of links (one entry if C<$params{bidirectional}> +is falsish and two entries if it is trueish). + +=item C + +Sorts linked records by C<$sort_by> in the direction given by +C<$sort_dir> (trueish = ascending, falsish = descending). C<@records> +can be either a single array reference or or normal array. + +C<$sort_by> can be one of the following strings: + +=over 2 + +=item * C + +Sort by type first and by record number second. The type order +reflects the order in which records are usually processed by the +employees: sales processes, sales quotations, sales orders, sales +delivery orders, invoices; requests for quotation, purchase orders, +purchase delivery orders, purchase invoices. + +=item * C + +Sort by the record's running number. + +=item * C + +Sort by the transdate of the record was created or applies to. + +Note: If the latter has a default setting it will always mask the creation time. + +=back Returns an array reference. +Can only be called both as a class function since it is not exported. + =back +=head1 EXPORTS + +This mixin exports the functions L and +L. + =head1 BUGS Nothing here yet. +=head1 TODO + + * C should take a query param depth and cut off there + * C uses partial distinct which is known to be not terribly fast on + a million entry table. replace with a better statement if this ever becomes + an issue. + =head1 AUTHOR Moritz Bunkus Em.bunkus@linet-services.deE +Sven Schöling Es.schoeling@linet-services.deE =cut