6 use List::MoreUtils qw(any uniq);
 
   7 use Rose::DB::Object::Helpers qw(as_tree);
 
   9 use SL::Locale::String qw(t8);
 
  11 use SL::DB::MetaSetup::Part;
 
  12 use SL::DB::Manager::Part;
 
  14 use SL::DB::Helper::AttrHTML;
 
  15 use SL::DB::Helper::AttrSorted;
 
  16 use SL::DB::Helper::TransNumberGenerator;
 
  17 use SL::DB::Helper::CustomVariables (
 
  21 use SL::DB::Helper::DisplayableNamePreferences (
 
  22   title   => t8('Article'),
 
  23   options => [ {name => 'partnumber',  title => t8('Part Number')     },
 
  24                {name => 'description', title => t8('Description')    },
 
  25                {name => 'notes',       title => t8('Notes')},
 
  26                {name => 'ean',         title => t8('EAN')            }, ],
 
  29 use List::Util qw(sum);
 
  31 __PACKAGE__->meta->add_relationships(
 
  33     type         => 'one to many',
 
  34     class        => 'SL::DB::Assembly',
 
  35     manager_args => { sort_by => 'position' },
 
  36     column_map   => { id => 'id' },
 
  39     type         => 'one to many',
 
  40     class        => 'SL::DB::Price',
 
  41     column_map   => { id => 'parts_id' },
 
  42     manager_args => { with_objects => [ 'pricegroup' ] }
 
  45     type         => 'one to many',
 
  46     class        => 'SL::DB::MakeModel',
 
  47     manager_args => { sort_by => 'sortorder' },
 
  48     column_map   => { id => 'parts_id' },
 
  51     type         => 'one to many',
 
  52     class        => 'SL::DB::PartCustomerPrice',
 
  53     column_map   => { id => 'parts_id' },
 
  56     type         => 'one to many',
 
  57     class        => 'SL::DB::Translation',
 
  58     column_map   => { id => 'parts_id' },
 
  61     type         => 'one to many',
 
  62     class        => 'SL::DB::AssortmentItem',
 
  63     column_map   => { id => 'assortment_id' },
 
  64     manager_args => { sort_by => 'position' },
 
  67     type            => 'one to many',
 
  68     class           => 'SL::DB::History',
 
  69     column_map      => { id => 'trans_id' },
 
  70     query_args      => [ what_done => 'part' ],
 
  71     manager_args    => { sort_by => 'itime' },
 
  74     type         => 'one to many',
 
  75     class        => 'SL::DB::ShopPart',
 
  76     column_map   => { id => 'part_id' },
 
  77     manager_args => { with_objects => [ 'shop' ] },
 
  81 __PACKAGE__->meta->initialize;
 
  83 __PACKAGE__->attr_html('notes');
 
  84 __PACKAGE__->attr_sorted({ unsorted => 'makemodels',     position => 'sortorder' });
 
  85 __PACKAGE__->attr_sorted({ unsorted => 'customerprices', position => 'sortorder' });
 
  87 __PACKAGE__->before_save('_before_save_set_partnumber');
 
  89 sub _before_save_set_partnumber {
 
  92   $self->create_trans_number if !$self->partnumber;
 
  99   if ( $self->part_type eq 'assembly' ) {
 
 100     return $self->assemblies;
 
 101   } elsif ( $self->part_type eq 'assortment' ) {
 
 102     return $self->assortment_items;
 
 111   # for detecting if the items of an (orphaned) assembly or assortment have
 
 112   # changed when saving
 
 114   return join(' ', sort map { $_->part->id } @{$self->items});
 
 121   push @errors, $::locale->text('The partnumber is missing.')     if $self->id and !$self->partnumber;
 
 122   push @errors, $::locale->text('The unit is missing.')           unless $self->unit;
 
 123   push @errors, $::locale->text('The buchungsgruppe is missing.') unless $self->buchungsgruppen_id or $self->buchungsgruppe;
 
 125   unless ( $self->id ) {
 
 126     push @errors, $::locale->text('The partnumber already exists.') if SL::DB::Manager::Part->get_all_count(where => [ partnumber => $self->partnumber ]);
 
 129   if ($self->is_assortment && $self->orphaned && scalar @{$self->assortment_items} == 0) {
 
 130     # when assortment isn't orphaned form doesn't contain any items
 
 131     push @errors, $::locale->text('The assortment doesn\'t have any items.');
 
 134   if ($self->is_assembly && scalar @{$self->assemblies} == 0) {
 
 135     push @errors, $::locale->text('The assembly doesn\'t have any items.');
 
 143   my $type  = lc(shift || '');
 
 144   die 'invalid type' unless $type =~ /^(?:part|service|assembly|assortment)$/;
 
 146   return $self->type eq $type ? 1 : 0;
 
 149 sub is_part       { $_[0]->part_type eq 'part'       }
 
 150 sub is_assembly   { $_[0]->part_type eq 'assembly'   }
 
 151 sub is_service    { $_[0]->part_type eq 'service'    }
 
 152 sub is_assortment { $_[0]->part_type eq 'assortment' }
 
 155   return $_[0]->part_type;
 
 156   # my ($self, $type) = @_;
 
 158   #   die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
 
 159   #   $self->assembly(          $type eq 'assembly' ? 1 : 0);
 
 160   #   $self->inventory_accno_id($type ne 'service'  ? 1 : undef);
 
 163   # return 'assembly' if $self->assembly;
 
 164   # return 'part'     if $self->inventory_accno_id;
 
 169   my ($class, %params) = @_;
 
 170   $class->new(%params, part_type => 'part');
 
 174   my ($class, %params) = @_;
 
 175   $class->new(%params, part_type => 'assembly');
 
 179   my ($class, %params) = @_;
 
 180   $class->new(%params, part_type => 'service');
 
 184   my ($class, %params) = @_;
 
 185   $class->new(%params, part_type => 'assortment');
 
 188 sub last_modification {
 
 190   return $self->mtime // $self->itime;
 
 195   die 'not an accessor' if @_ > 1;
 
 197   return 1 unless $self->id;
 
 202     SL::DB::DeliveryOrderItem
 
 205   for my $class (@relations) {
 
 206     eval "require $class";
 
 207     return 1 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
 
 213   die 'not an accessor' if @_ > 1;
 
 215   return 1 unless $self->id;
 
 220     SL::DB::DeliveryOrderItem
 
 222     SL::DB::AssortmentItem
 
 225   for my $class (@relations) {
 
 226     eval "require $class";
 
 227     return 0 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
 
 232 sub get_sellprice_info {
 
 236   confess "Missing part id" unless $self->id;
 
 238   my $object = $self->load;
 
 240   return { sellprice       => $object->sellprice,
 
 241            price_factor_id => $object->price_factor_id };
 
 244 sub get_ordered_qty {
 
 246   my %result = SL::DB::Manager::Part->get_ordered_qty($self->id);
 
 248   return $result{ $self->id };
 
 251 sub available_units {
 
 252   shift->unit_obj->convertible_units;
 
 255 # autogenerated accessor is slightly off...
 
 257   shift->buchungsgruppen(@_);
 
 261   my ($self, %params) = @_;
 
 263   my $date     = $params{date} || DateTime->today_local;
 
 264   my $is_sales = !!$params{is_sales};
 
 265   my $taxzone  = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
 
 266   my $tk_info  = $::request->cache('get_taxkey');
 
 268   $tk_info->{$self->id}                                      //= {};
 
 269   $tk_info->{$self->id}->{$taxzone}                          //= { };
 
 270   my $cache = $tk_info->{$self->id}->{$taxzone}->{$is_sales} //= { };
 
 272   if (!exists $cache->{$date}) {
 
 274       $self->get_chart(type => $is_sales ? 'income' : 'expense', taxzone => $taxzone)
 
 275       ->get_active_taxkey($date);
 
 278   return $cache->{$date};
 
 282   my ($self, %params) = @_;
 
 284   my $type    = (any { $_ eq $params{type} } qw(income expense inventory)) ? $params{type} : croak("Invalid 'type' parameter '$params{type}'");
 
 285   my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
 
 287   my $charts     = $::request->cache('get_chart_id/by_part_id_and_taxzone')->{$self->id} //= {};
 
 288   my $all_charts = $::request->cache('get_chart_id/by_id');
 
 290   $charts->{$taxzone} ||= { };
 
 292   if (!exists $charts->{$taxzone}->{$type}) {
 
 293     require SL::DB::Buchungsgruppe;
 
 294     my $bugru    = SL::DB::Buchungsgruppe->load_cached($self->buchungsgruppen_id);
 
 295     my $chart_id = ($type eq 'inventory') ? ($self->is_part ? $bugru->inventory_accno_id : undef)
 
 296                  :                          $bugru->call_sub("${type}_accno_id", $taxzone);
 
 299       my $chart                    = $all_charts->{$chart_id} // SL::DB::Chart->load_cached($chart_id)->load;
 
 300       $all_charts->{$chart_id}     = $chart;
 
 301       $charts->{$taxzone}->{$type} = $chart;
 
 305   return $charts->{$taxzone}->{$type};
 
 309   my ($self, %params) = @_;
 
 311   return undef unless $self->id;
 
 313   my $query = 'SELECT SUM(qty) FROM inventory WHERE parts_id = ?';
 
 314   my @values = ($self->id);
 
 316   if ( $params{bin_id} ) {
 
 317     $query .= ' AND bin_id = ?';
 
 318     push(@values, $params{bin_id});
 
 321   if ( $params{warehouse_id} ) {
 
 322     $query .= ' AND warehouse_id = ?';
 
 323     push(@values, $params{warehouse_id});
 
 326   if ( $params{shippingdate} ) {
 
 327     die unless ref($params{shippingdate}) eq 'DateTime';
 
 328     $query .= ' AND shippingdate <= ?';
 
 329     push(@values, $params{shippingdate});
 
 332   my ($stock) = selectrow_query($::form, $self->db->dbh, $query, @values);
 
 334   return $stock || 0; # never return undef
 
 338 # this is designed to ignore chargenumbers, expiration dates and just give a list of how much <-> where
 
 339 sub get_simple_stock {
 
 340   my ($self, %params) = @_;
 
 342   return [] unless $self->id;
 
 345     SELECT sum(qty), warehouse_id, bin_id FROM inventory WHERE parts_id = ?
 
 346     GROUP BY warehouse_id, bin_id
 
 348   my $stock_info = selectall_hashref_query($::form, $::form->get_standard_dbh, $query, $self->id);
 
 349   [ map { bless $_, 'SL::DB::Part::SimpleStock'} @$stock_info ];
 
 351 # helper class to have bin/warehouse accessors in stock result
 
 352 { package SL::DB::Part::SimpleStock;
 
 353   sub warehouse { require SL::DB::Warehouse; SL::DB::Manager::Warehouse->find_by_or_create(id => $_[0]->{warehouse_id}) }
 
 354   sub bin       { require SL::DB::Bin;       SL::DB::Manager::Bin      ->find_by_or_create(id => $_[0]->{bin_id}) }
 
 357 sub get_simple_stock_sql {
 
 358   my ($self, %params) = @_;
 
 360   return [] unless $self->id;
 
 363      SELECT w.description                         AS warehouse_description,
 
 364             b.description                         AS bin_description,
 
 366             SUM(i.qty * p.lastcost)               AS stock_value,
 
 368             LEAD(w.description)           OVER pt AS wh_lead,            -- to detect warehouse changes for subtotals in template
 
 369             SUM( SUM(i.qty) )             OVER pt AS run_qty,            -- running total of total qty
 
 370             SUM( SUM(i.qty) )             OVER wh AS wh_run_qty,         -- running total of warehouse qty
 
 371             SUM( SUM(i.qty * p.lastcost)) OVER pt AS run_stock_value,    -- running total of total stock_value
 
 372             SUM( SUM(i.qty * p.lastcost)) OVER wh AS wh_run_stock_value  -- running total of warehouse stock_value
 
 374             LEFT JOIN parts p     ON (p.id           = i.parts_id)
 
 375             LEFT JOIN warehouse w ON (i.warehouse_id = w.id)
 
 376             LEFT JOIN bin b       ON (i.bin_id       = b.id)
 
 378    GROUP BY w.description, w.sortkey, b.description, p.unit, i.parts_id
 
 380      WINDOW pt AS (PARTITION BY i.parts_id    ORDER BY w.sortkey, b.description, p.unit),
 
 381             wh AS (PARTITION by w.description ORDER BY w.sortkey, b.description, p.unit)
 
 382    ORDER BY w.sortkey, b.description, p.unit
 
 385   my $stock_info = selectall_hashref_query($::form, $self->db->dbh, $query, $self->id);
 
 389 sub get_mini_journal {
 
 392   # inventory ids of the most recent 10 inventory trans_ids
 
 394   # duplicate code copied from SL::Controller::Inventory mini_journal, except
 
 395   # for the added filter on parts_id
 
 397   my $parts_id = $self->id;
 
 399 with last_inventories as (
 
 404     where parts_id = $parts_id
 
 411      from last_inventories
 
 418  limit 20  -- so the planner knows how many ids to expect, the cte is an optimisation fence
 
 421   my $objs  = SL::DB::Manager::Inventory->get_all(
 
 422     query        => [ id => [ \"$query" ] ],
 
 423     with_objects => [ 'parts', 'trans_type', 'bin', 'bin.warehouse' ], # prevent lazy loading in template
 
 424     sort_by      => 'itime DESC',
 
 426   # remember order of trans_ids from query, for ordering hash later
 
 427   my @sorted_trans_ids = uniq map { $_->trans_id } @$objs;
 
 429   # at most 2 of them belong to a transaction and the qty determines in or out.
 
 432     $transactions{ $_->trans_id }{ $_->qty > 0 ? 'in' : 'out' } = $_;
 
 433     $transactions{ $_->trans_id }{base} = $_;
 
 436   # because the inventory transactions were built in a hash, we need to sort the
 
 437   # hash by using the original sort order of the trans_ids
 
 438   my @sorted = map { $transactions{$_} } @sorted_trans_ids;
 
 443 sub clone_and_reset_deep {
 
 446   my $clone = $self->clone_and_reset; # resets id and partnumber (primary key and unique constraint)
 
 447   $clone->makemodels(   map { $_->clone_and_reset } @{$self->makemodels}   ) if @{$self->makemodels};
 
 448   $clone->translations( map { $_->clone_and_reset } @{$self->translations} ) if @{$self->translations};
 
 450   if ( $self->is_assortment ) {
 
 451     # use clone rather than reset_and_clone because the unique constraint would also remove parts_id
 
 452     $clone->assortment_items( map { $_->clone } @{$self->assortment_items} );
 
 453     $_->assortment_id(undef) foreach @{ $clone->assortment_items }
 
 456   if ( $self->is_assembly ) {
 
 457     $clone->assemblies( map { $_->clone_and_reset } @{$self->assemblies});
 
 460   if ( $self->prices ) {
 
 461     $clone->prices( map { $_->clone } @{$self->prices}); # pricegroup_id gets reset here because it is part of a unique contraint
 
 462     if ( $clone->prices ) {
 
 463       foreach my $price ( @{$clone->prices} ) {
 
 465         $price->parts_id(undef);
 
 474   my ($self, $comparison_part) = @_;
 
 476   die "item_diffs needs a part object" unless ref($comparison_part) eq 'SL::DB::Part';
 
 477   die "part and comparison_part need to be of the same part_type" unless
 
 478         ( $self->part_type eq 'assembly' or $self->part_type eq 'assortment' )
 
 479     and ( $comparison_part->part_type eq 'assembly' or $comparison_part->part_type eq 'assortment' )
 
 480     and $self->part_type eq $comparison_part->part_type;
 
 482   # return [], [] if $self->items_checksum eq $comparison_part->items_checksum;
 
 483   my @self_part_ids       = map { $_->parts_id } $self->items;
 
 484   my @comparison_part_ids = map { $_->parts_id } $comparison_part->items;
 
 486   my %orig       = map{ $_ => 1 } @self_part_ids;
 
 487   my %comparison = map{ $_ => 1 } @comparison_part_ids;
 
 488   my (@additions, @removals);
 
 489   @additions = grep { !exists( $orig{$_}       ) } @comparison_part_ids if @comparison_part_ids;
 
 490   @removals  = grep { !exists( $comparison{$_} ) } @self_part_ids       if @self_part_ids;
 
 492   return \@additions, \@removals;
 
 495 sub items_sellprice_sum {
 
 496   my ($self, %params) = @_;
 
 498   return unless $self->is_assortment or $self->is_assembly;
 
 499   return unless $self->items;
 
 501   if ($self->is_assembly) {
 
 502     return sum map { $_->linetotal_sellprice          } @{$self->items};
 
 504     return sum map { $_->linetotal_sellprice(%params) } grep { $_->charge } @{$self->items};
 
 508 sub items_lastcost_sum {
 
 511   return unless $self->is_assortment or $self->is_assembly;
 
 512   return unless $self->items;
 
 513   sum map { $_->linetotal_lastcost } @{$self->items};
 
 526 SL::DB::Part: Model for the 'parts' table
 
 530 This is a standard Rose::DB::Object based model and can be used as one.
 
 534 Although the base class is called C<Part> we usually talk about C<Articles> if
 
 535 we mean instances of this class. This is because articles come in three
 
 540 =item Part     - a single part
 
 542 =item Service  - a part without onhand, and without inventory accounting
 
 544 =item Assembly - a collection of both parts and services
 
 546 =item Assortment - a collection of items (parts or assemblies)
 
 550 These types are sadly represented by data inside the class and cannot be
 
 551 migrated into a flag. To work around this, each C<Part> object knows what type
 
 552 it currently is. Since the type is data driven, there ist no explicit setting
 
 553 method for it, but you can construct them explicitly with C<new_part>,
 
 554 C<new_service>, C<new_assembly> and C<new_assortment>. A Buchungsgruppe should be supplied in this
 
 555 case, but it will use the default Buchungsgruppe if you don't.
 
 557 Matching these there are assorted helper methods dealing with types,
 
 558 e.g.  L</new_part>, L</new_service>, L</new_assembly>, L</type>,
 
 559 L</is_type> and others.
 
 565 =item C<new_part %PARAMS>
 
 567 =item C<new_service %PARAMS>
 
 569 =item C<new_assembly %PARAMS>
 
 571 Will set the appropriate data fields so that the resulting instance will be of
 
 572 the requested type. Since accounting targets are part of the distinction,
 
 573 providing a C<Buchungsgruppe> is recommended. If none is given the constructor
 
 574 will load a default one and set the accounting targets from it.
 
 578 Returns the type as a string. Can be one of C<part>, C<service>, C<assembly>.
 
 580 =item C<is_type $TYPE>
 
 582 Tests if the current object is a part, a service or an
 
 583 assembly. C<$type> must be one of the words 'part', 'service' or
 
 584 'assembly' (their plurals are ok, too).
 
 586 Returns 1 if the requested type matches, 0 if it doesn't and
 
 587 C<confess>es if an unknown C<$type> parameter is encountered.
 
 595 Shorthand for C<is_type('part')> etc.
 
 597 =item C<get_sellprice_info %params>
 
 599 Retrieves the C<sellprice> and C<price_factor_id> for a part under
 
 600 different conditions and returns a hash reference with those two keys.
 
 602 If C<%params> contains a key C<project_id> then a project price list
 
 603 will be consulted if one exists for that project. In this case the
 
 604 parameter C<country_id> is evaluated as well: if a price list entry
 
 605 has been created for this country then it will be used. Otherwise an
 
 606 entry without a country set will be used.
 
 608 If none of the above conditions is met then the information from
 
 611 =item C<get_ordered_qty %params>
 
 613 Retrieves the quantity that has been ordered from a vendor but that
 
 614 has not been delivered yet. Only open purchase orders are considered.
 
 616 =item C<get_taxkey %params>
 
 618 Retrieves and returns a taxkey object valid for the given date
 
 619 C<$params{date}> and tax zone C<$params{taxzone}>
 
 620 (C<$params{taxzone_id}> is also recognized). The date defaults to the
 
 621 current date if undefined.
 
 623 This function looks up the income (for trueish values of
 
 624 C<$params{is_sales}>) or expense (for falsish values of
 
 625 C<$params{is_sales}>) account for the current part. It uses the part's
 
 626 associated buchungsgruppe and uses the fields belonging to the tax
 
 627 zone given by C<$params{taxzone}>.
 
 629 The information retrieved by the function is cached.
 
 631 =item C<get_chart %params>
 
 633 Retrieves and returns a chart object valid for the given type
 
 634 C<$params{type}> and tax zone C<$params{taxzone}>
 
 635 (C<$params{taxzone_id}> is also recognized). The type must be one of
 
 636 the three key words C<income>, C<expense> and C<inventory>.
 
 638 This function uses the part's associated buchungsgruppe and uses the
 
 639 fields belonging to the tax zone given by C<$params{taxzone}>.
 
 641 The information retrieved by the function is cached.
 
 643 =item C<used_in_record>
 
 645 Checks if this article has been used in orders, invoices or delivery orders.
 
 649 Checks if this article is used in orders, invoices, delivery orders or
 
 652 =item C<buchungsgruppe BUCHUNGSGRUPPE>
 
 654 Used to set the accounting information from a L<SL:DB::Buchungsgruppe> object.
 
 655 Please note, that this is a write only accessor, the original Buchungsgruppe can
 
 656 not be retrieved from an article once set.
 
 658 =item C<get_simple_stock_sql>
 
 660 Fetches the qty and the stock value for the current part for each bin and
 
 661 warehouse where the part is in stock (or rather different from 0, might be
 
 664 Runs some additional window functions to add the running totals (total running
 
 665 total and total per warehouse) for qty and stock value to each line.
 
 667 Using the LEAD(w.description) the template can check if the warehouse
 
 668 description is about to change, i.e. the next line will contain numbers from a
 
 669 different warehouse, so that a subtotal line can be added.
 
 671 The last row will contain the running qty total (run_qty) and the running total
 
 672 stock value (run_stock_value) over all warehouses/bins and can be used to add a
 
 673 line for the grand totals.
 
 675 =item C<items_lastcost_sum>
 
 677 Non-recursive lastcost sum of all the items in an assembly or assortment.
 
 679 =item C<get_stock %params>
 
 681 Fetches stock qty in the default unit for a part.
 
 683 bin_id and warehouse_id may be passed as params. If only a bin_id is passed,
 
 684 the stock qty for that bin is returned. If only a warehouse_id is passed, the
 
 685 stock qty for all bins in that warehouse is returned.  If a shippingdate is
 
 686 passed the stock qty for that date is returned.
 
 689  my $qty = $part->get_stock(bin_id => 52);
 
 691  $part->get_stock(shippingdate => DateTime->today->add(days => -5));
 
 697 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
 
 698 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>