Projekt

Allgemein

Profil

Herunterladen (27,5 KB) Statistiken
| Zweig: | Markierung: | Revision:
package SL::DB::Order;

use utf8;
use strict;

use Carp;
use DateTime;
use List::Util qw(max);
use List::MoreUtils qw(any);

use SL::DBUtils ();
use SL::DB::MetaSetup::Order;
use SL::DB::Manager::Order;
use SL::DB::Helper::Attr;
use SL::DB::Helper::AttrHTML;
use SL::DB::Helper::AttrSorted;
use SL::DB::Helper::FlattenToForm;
use SL::DB::Helper::LinkedRecords;
use SL::DB::Helper::PriceTaxCalculator;
use SL::DB::Helper::PriceUpdater;
use SL::DB::Helper::TypeDataProxy;
use SL::DB::Helper::TransNumberGenerator;
use SL::DB::Helper::Payment qw(forex);
use SL::DB::Helper::RecordLink qw(RECORD_ID RECORD_TYPE_REF RECORD_ITEM_ID RECORD_ITEM_TYPE_REF);
use SL::Locale::String qw(t8);
use SL::RecordLinks;
use Rose::DB::Object::Helpers qw(as_tree strip);

use SL::DB::Order::TypeData qw(:types);
use SL::DB::Reclamation::TypeData qw(:types);

__PACKAGE__->meta->add_relationship(
orderitems => {
type => 'one to many',
class => 'SL::DB::OrderItem',
column_map => { id => 'trans_id' },
manager_args => {
with_objects => [ 'part' ]
}
},
periodic_invoices_config => {
type => 'one to one',
class => 'SL::DB::PeriodicInvoicesConfig',
column_map => { id => 'oe_id' },
},
custom_shipto => {
type => 'one to one',
class => 'SL::DB::Shipto',
column_map => { id => 'trans_id' },
query_args => [ module => 'OE' ],
},
exchangerate_obj => {
type => 'one to one',
class => 'SL::DB::Exchangerate',
column_map => { currency_id => 'currency_id', transdate => 'transdate' },
},
phone_notes => {
type => 'one to many',
class => 'SL::DB::Note',
column_map => { id => 'trans_id' },
query_args => [ trans_module => 'oe' ],
manager_args => {
with_objects => [ 'employee' ],
sort_by => 'notes.itime',
}
},
order_version => {
type => 'one to many',
class => 'SL::DB::OrderVersion',
column_map => { id => 'oe_id' },
},
);

SL::DB::Helper::Attr::make(__PACKAGE__, daily_exchangerate => 'numeric');

__PACKAGE__->meta->initialize;

__PACKAGE__->attr_html('notes');
__PACKAGE__->attr_sorted('items');

__PACKAGE__->before_save('_before_save_set_ord_quo_number');
__PACKAGE__->before_save('_before_save_create_new_project');
__PACKAGE__->before_save('_before_save_remove_empty_custom_shipto');
__PACKAGE__->before_save('_before_save_set_custom_shipto_module');
__PACKAGE__->after_save('_after_save_link_records');

# hooks

sub _before_save_set_ord_quo_number {
my ($self) = @_;

# ordnumber is 'NOT NULL'. Therefore make sure it's always set to at
# least an empty string, even if we're saving a quotation.
$self->ordnumber('') if !$self->ordnumber;

$self->create_trans_number if !$self->record_number;

return 1;
}
sub _before_save_create_new_project {
my ($self) = @_;

# force new project, if not set yet
if ($::instance_conf->get_order_always_project && !$self->globalproject_id && ($self->type eq SALES_ORDER_TYPE())) {

die t8("Error while creating project with project number of new order number, project number #1 already exists!", $self->ordnumber)
if SL::DB::Manager::Project->find_by(projectnumber => $self->ordnumber);

eval {
my $new_project = SL::DB::Project->new(
projectnumber => $self->ordnumber,
description => $self->customer->name,
customer_id => $self->customer->id,
active => 1,
project_type_id => $::instance_conf->get_project_type_id,
project_status_id => $::instance_conf->get_project_status_id,
);
$new_project->save;
$self->globalproject_id($new_project->id);
} or die t8('Could not create new project #1', $@);
}
return 1;
}


sub _before_save_remove_empty_custom_shipto {
my ($self) = @_;

$self->custom_shipto(undef) if $self->custom_shipto && $self->custom_shipto->is_empty;

return 1;
}

sub _before_save_set_custom_shipto_module {
my ($self) = @_;

$self->custom_shipto->module('OE') if $self->custom_shipto;

return 1;
}

sub _after_save_link_records {
my ($self) = @_;

my @allowed_record_sources = qw(SL::DB::Reclamation SL::DB::Order);
my @allowed_item_sources = qw(SL::DB::ReclamationItem SL::DB::OrderItem);

SL::DB::Helper::RecordLink::link_records(
$self,
\@allowed_record_sources,
\@allowed_item_sources,
);
}


# methods

sub items { goto &orderitems; }
sub add_items { goto &add_orderitems; }
sub record_number { goto &number; }

sub type {
my $self = shift;
die "invalid type: " . $self->record_type if (!any { $self->record_type eq $_ } (
SALES_ORDER_TYPE(),
PURCHASE_ORDER_TYPE(),
REQUEST_QUOTATION_TYPE(),
SALES_QUOTATION_TYPE(),
));
return $self->record_type;
}

sub is_type {
return shift->type eq shift;
}

sub quotation {
my $type = shift->type();
if (any { $type eq $_ } (
SALES_QUOTATION_TYPE(),
REQUEST_QUOTATION_TYPE(),
)) {
return 1;
};
return 0;
}

sub deliverydate {
# oe doesn't have deliverydate, but it does have reqdate.
# But this has a different meaning for sales quotations.
# deliverydate can be used to determine tax if tax_point isn't set.

return $_[0]->reqdate if $_[0]->type ne SALES_QUOTATION_TYPE();
}

sub effective_tax_point {
my ($self) = @_;

return $self->tax_point || $self->deliverydate || $self->transdate;
}

sub displayable_type {
my $type = shift->type;

return $::locale->text('Sales quotation') if $type eq SALES_QUOTATION_TYPE();
return $::locale->text('Request quotation') if $type eq REQUEST_QUOTATION_TYPE();
return $::locale->text('Sales Order') if $type eq SALES_ORDER_TYPE();
return $::locale->text('Purchase Order') if $type eq PURCHASE_ORDER_TYPE();

die 'invalid type';
}

sub displayable_name {
join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
};

sub is_sales {
croak 'not an accessor' if @_ > 1;
my $type = shift->type();
if (any { $type eq $_ } (
SALES_ORDER_TYPE(),
SALES_QUOTATION_TYPE(),
)) {
return 1;
};
return 0;
}

sub daily_exchangerate {
my ($self, $val) = @_;

return 1 if $self->currency_id == $::instance_conf->get_currency_id;

my $rate = (any { $self->is_type($_) } (SALES_QUOTATION_TYPE(), SALES_ORDER_TYPE())) ? 'buy'
: (any { $self->is_type($_) } (REQUEST_QUOTATION_TYPE(), PURCHASE_ORDER_TYPE())) ? 'sell'
: undef;
return if !$rate;

if (defined $val) {
croak t8('exchange rate has to be positive') if $val <= 0;
if (!$self->exchangerate_obj) {
$self->exchangerate_obj(SL::DB::Exchangerate->new(
currency_id => $self->currency_id,
transdate => $self->transdate,
$rate => $val,
));
} elsif (!defined $self->exchangerate_obj->$rate) {
$self->exchangerate_obj->$rate($val);
} else {
croak t8('exchange rate already exists, no update allowed');
}
}
return $self->exchangerate_obj->$rate if $self->exchangerate_obj;
}

sub invoices {
my $self = shift;
my %params = @_;

if ($self->quotation) {
return [];
} else {
require SL::DB::Invoice;
return SL::DB::Manager::Invoice->get_all(
query => [
ordnumber => $self->ordnumber,
@{ $params{query} || [] },
]
);
}
}

sub displayable_state {
my ($self) = @_;

return $self->closed ? $::locale->text('closed') : $::locale->text('open');
}

sub abschlag_invoices {
return shift()->invoices(query => [ abschlag => 1 ]);
}

sub end_invoice {
return shift()->invoices(query => [ abschlag => 0 ]);
}

sub convert_to_invoice {
my ($self, %params) = @_;

croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;

my $invoice;
if (!$self->db->with_transaction(sub {
require SL::DB::Invoice;
$invoice = SL::DB::Invoice->new_from($self, %params)->post || die;
$self->update_attributes(closed => 1);
1;
})) {
return undef;
}

return $invoice;
}

sub convert_to_delivery_order {
my ($self, @args) = @_;

my $delivery_order;
if (!$self->db->with_transaction(sub {
require SL::DB::DeliveryOrder;
$delivery_order = SL::DB::DeliveryOrder->new_from($self, @args);
$delivery_order->save;

$self->update_attributes(delivered => 1) unless $::instance_conf->get_shipped_qty_require_stock_out;
1;
})) {
return undef;
}

return $delivery_order;
}

sub convert_to_reclamation {
my ($self, %params) = @_;
$params{destination_type} = $self->is_sales ? SALES_RECLAMATION_TYPE()
: PURCHASE_RECLAMATION_TYPE();

require SL::DB::Reclamation;
my $reclamation = SL::DB::Reclamation->new_from($self, %params);

return $reclamation;
}

sub _clone_orderitem_cvar {
my ($cvar) = @_;

my $cloned = $_->clone_and_reset;
$cloned->sub_module('orderitems');

return $cloned;
}

sub new_from {
my ($class, $source, %params) = @_;

unless (any {ref($source) eq $_} qw(
SL::DB::Order
SL::DB::Reclamation
)) {
croak("Unsupported source object type '" . ref($source) . "'");
}
croak("A destination type must be given as parameter") unless $params{destination_type};

my $destination_type = delete $params{destination_type};

my @from_tos = (
{ from => SALES_QUOTATION_TYPE(), to => SALES_ORDER_TYPE(), abbr => 'sqso' },
{ from => REQUEST_QUOTATION_TYPE(), to => PURCHASE_ORDER_TYPE(), abbr => 'rqpo' },
{ from => SALES_QUOTATION_TYPE(), to => SALES_QUOTATION_TYPE(), abbr => 'sqsq' },
{ from => SALES_ORDER_TYPE(), to => SALES_ORDER_TYPE(), abbr => 'soso' },
{ from => REQUEST_QUOTATION_TYPE(), to => REQUEST_QUOTATION_TYPE(), abbr => 'rqrq' },
{ from => PURCHASE_ORDER_TYPE(), to => PURCHASE_ORDER_TYPE(), abbr => 'popo' },
{ from => SALES_ORDER_TYPE(), to => PURCHASE_ORDER_TYPE(), abbr => 'sopo' },
{ from => PURCHASE_ORDER_TYPE(), to => SALES_ORDER_TYPE(), abbr => 'poso' },
{ from => SALES_ORDER_TYPE(), to => SALES_QUOTATION_TYPE(), abbr => 'sosq' },
{ from => PURCHASE_ORDER_TYPE(), to => REQUEST_QUOTATION_TYPE(), abbr => 'porq' },
{ from => REQUEST_QUOTATION_TYPE(), to => SALES_QUOTATION_TYPE(), abbr => 'rqsq' },
{ from => REQUEST_QUOTATION_TYPE(), to => SALES_ORDER_TYPE(), abbr => 'rqso' },
{ from => SALES_QUOTATION_TYPE(), to => REQUEST_QUOTATION_TYPE(), abbr => 'sqrq' },
{ from => SALES_ORDER_TYPE(), to => REQUEST_QUOTATION_TYPE(), abbr => 'sorq' },
{ from => SALES_RECLAMATION_TYPE(), to => SALES_ORDER_TYPE(), abbr => 'srso' },
{ from => PURCHASE_RECLAMATION_TYPE(), to => PURCHASE_ORDER_TYPE(), abbr => 'prpo' },
);
my $from_to = (grep { $_->{from} eq $source->type && $_->{to} eq $destination_type} @from_tos)[0];
croak("Cannot convert from '" . $source->type . "' to '" . $destination_type . "'") if !$from_to;

my $is_abbr_any = sub {
any { $from_to->{abbr} eq $_ } @_;
};

my ($item_parent_id_column, $item_parent_column);

if (ref($source) eq 'SL::DB::Order') {
$item_parent_id_column = 'trans_id';
$item_parent_column = 'order';
} elsif ( ref($source) eq 'SL::DB::Reclamation') {
$item_parent_id_column = 'reclamation_id';
$item_parent_column = 'reclamation';
}

my %args;
if (ref($source) eq 'SL::DB::Order') {
%args = ( map({ ( $_ => $source->$_ ) } qw(amount cp_id currency_id cusordnumber customer_id delivery_customer_id delivery_term_id delivery_vendor_id
department_id exchangerate globalproject_id intnotes marge_percent marge_total language_id netamount notes
ordnumber payment_id quonumber reqdate salesman_id shippingpoint shipvia taxincluded tax_point taxzone_id
transaction_description vendor_id billing_address_id
)),
closed => 0,
delivered => 0,
transdate => DateTime->today_local,
employee => SL::DB::Manager::Employee->current,
);
# reqdate in quotation is 'offer is valid until reqdate'
# reqdate in order is 'will be delivered until reqdate'
# both dates are setable (on|off)
# and may have a additional interval in days (+ n days)
# dies if this convention will change
$args{reqdate} = $from_to->{to} =~ m/_quotation$/
? $::instance_conf->get_reqdate_on
? DateTime->today_local->next_workday(extra_days => $::instance_conf->get_reqdate_interval)->to_kivitendo
: undef
: $from_to->{to} =~ m/_order$/
? $::instance_conf->get_deliverydate_on
? DateTime->today_local->next_workday(extra_days => $::instance_conf->get_delivery_date_interval)->to_kivitendo
: undef
: die "Wrong state for reqdate";
} elsif ( ref($source) eq 'SL::DB::Reclamation') {
%args = ( map({ ( $_ => $source->$_ ) } qw(
amount billing_address_id currency_id customer_id delivery_term_id department_id
exchangerate globalproject_id intnotes language_id netamount
notes payment_id reqdate salesman_id shippingpoint shipvia taxincluded
tax_point taxzone_id transaction_description vendor_id
)),
cp_id => $source->{contact_id},
closed => 0,
delivered => 0,
transdate => DateTime->today_local,
employee => SL::DB::Manager::Employee->current,
);
}

if ( $is_abbr_any->(qw(sopo poso rqso sosq porq rqsq sqrq sorq)) ) {
$args{ordnumber} = undef;
$args{quonumber} = undef;
}
if ( $is_abbr_any->(qw(sopo sqrq sorq)) ) {
$args{customer_id} = undef;
$args{salesman_id} = undef;
$args{payment_id} = undef;
$args{delivery_term_id} = undef;
}
if ( $is_abbr_any->(qw(poso rqsq)) ) {
$args{vendor_id} = undef;
}
if ( $is_abbr_any->(qw(soso)) ) {
$args{periodic_invoices_config} = $source->periodic_invoices_config->clone_and_reset if $source->periodic_invoices_config;
}
if ( $is_abbr_any->(qw(sqrq sorq)) ) {
$args{cusordnumber} = undef;
}

# Custom shipto addresses (the ones specific to the sales/purchase
# record and not to the customer/vendor) are only linked from
# shipto → order. Meaning order.shipto_id
# will not be filled in that case.
if (!$source->shipto_id && $source->id) {
$args{custom_shipto} = $source->custom_shipto->clone($class) if $source->can('custom_shipto') && $source->custom_shipto;

} else {
$args{shipto_id} = $source->shipto_id;
}

$args{record_type} = $destination_type;

my $order = $class->new(%args);
$order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
my $items = delete($params{items}) || $source->items_sorted;

my %item_parents;

my @items = map {
my $source_item = $_;
my $source_item_id = $_->$item_parent_id_column;
my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };

$item_parents{$source_item_id} ||= $source_item->$item_parent_column;
my $item_parent = $item_parents{$source_item_id};

my $current_oe_item;
if (ref($source) eq 'SL::DB::Order') {
$current_oe_item = SL::DB::OrderItem->new(map({ ( $_ => $source_item->$_ ) }
qw(active_discount_source active_price_source base_qty cusordnumber
description discount lastcost longdescription
marge_percent marge_price_factor marge_total
ordnumber parts_id price_factor price_factor_id pricegroup_id
project_id qty reqdate sellprice serialnumber ship subtotal transdate unit
optional recurring_billing_mode
)),
custom_variables => \@custom_variables,
);
} elsif (ref($source) eq 'SL::DB::Reclamation') {
$current_oe_item = SL::DB::OrderItem->new(
map({ ( $_ => $source_item->$_ ) } qw(
active_discount_source active_price_source base_qty description
discount lastcost longdescription parts_id price_factor
price_factor_id pricegroup_id project_id qty reqdate sellprice
serialnumber unit
)),
custom_variables => \@custom_variables,
);
}
if ( $is_abbr_any->(qw(sopo)) ) {
$current_oe_item->sellprice($source_item->lastcost);
$current_oe_item->discount(0);
}
if ( $is_abbr_any->(qw(poso rqsq rqso)) ) {
$current_oe_item->lastcost($source_item->sellprice);
}
unless ($params{no_linked_records}) {
$current_oe_item->{ RECORD_ITEM_ID() } = $_->{id};
$current_oe_item->{ RECORD_ITEM_TYPE_REF() } = ref($source_item);
}
$current_oe_item;
} @{ $items };

@items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
@items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
@items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};

$order->items(\@items);

unless ($params{no_linked_records}) {
$order->{ RECORD_ID() } = $source->{id};
$order->{ RECORD_TYPE_REF() } = ref($source);
}

return $order;
}

sub new_from_multi {
my ($class, $sources, %params) = @_;

croak("Unsupported object type in sources") if any { ref($_) !~ m{SL::DB::Order} } @$sources;
croak("Cannot create order for purchase records") if any { !$_->is_sales } @$sources;
croak("Cannot create order from source records of different customers") if any { $_->customer_id != $sources->[0]->customer_id } @$sources;

# bb: todo: check shipto: is it enough to check the ids or do we have to compare the entries?
if (delete $params{check_same_shipto}) {
die "check same shipto address is not implemented yet";
die "Source records do not have the same shipto" if 1;
}

# sort sources
if (defined $params{sort_sources_by}) {
my $sort_by = delete $params{sort_sources_by};
if ($sources->[0]->can($sort_by)) {
$sources = [ sort { $a->$sort_by cmp $b->$sort_by } @$sources ];
} else {
die "Cannot sort source records by $sort_by";
}
}

# set this entries to undef that yield different information
my %attributes;
foreach my $attr (qw(ordnumber transdate reqdate tax_point taxincluded shippingpoint
shipvia notes closed delivered reqdate quonumber
cusordnumber proforma transaction_description
order_probability expected_billing_date)) {
$attributes{$attr} = undef if any { ($sources->[0]->$attr//'') ne ($_->$attr//'') } @$sources;
}
foreach my $attr (qw(cp_id currency_id salesman_id department_id
delivery_customer_id delivery_vendor_id shipto_id
globalproject_id exchangerate)) {
$attributes{$attr} = undef if any { ($sources->[0]->$attr||0) != ($_->$attr||0) } @$sources;
}

# set this entries from customer that yield different information
foreach my $attr (qw(language_id taxzone_id payment_id delivery_term_id)) {
$attributes{$attr} = $sources->[0]->customervendor->$attr if any { ($sources->[0]->$attr||0) != ($_->$attr||0) } @$sources;
}
$attributes{intnotes} = $sources->[0]->customervendor->notes if any { ($sources->[0]->intnotes//'') ne ($_->intnotes//'') } @$sources;

# no periodic invoice config for new order
$attributes{periodic_invoices_config} = undef;

# set emplyee to the current one
$attributes{employee} = SL::DB::Manager::Employee->current;

# copy global ordnumber, transdate, cusordnumber into item scope
# unless already present there
foreach my $attr (qw(ordnumber transdate cusordnumber)) {
foreach my $src (@$sources) {
foreach my $item (@{ $src->items_sorted }) {
$item->$attr($src->$attr) if !$item->$attr;
}
}
}

# collect items
my @items;
push @items, @{$_->items_sorted} for @$sources;
# make order from first source and all items
my $order = $class->new_from($sources->[0],
destination_type => SALES_ORDER_TYPE(),
attributes => \%attributes,
items => \@items,
%params);

return $order;
}

sub number {
my $self = shift;

return if !$self->type;

my %number_method = (
SALES_ORDER_TYPE() => 'ordnumber',
SALES_QUOTATION_TYPE() => 'quonumber',
PURCHASE_ORDER_TYPE() => 'ordnumber',
REQUEST_QUOTATION_TYPE() => 'quonumber',
);

return $self->${ \ $number_method{$self->type} }(@_);
}

sub customervendor {
$_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
}

sub date {
goto &transdate;
}

sub digest {
my ($self) = @_;

sprintf "%s %s %s (%s)",
$self->number,
$self->customervendor->name,
$self->amount_as_number,
$self->date->to_kivitendo;
}

sub current_version_number {
my ($self) = @_;

my $query = <<EOSQL;
SELECT max(version)
FROM oe_version
WHERE (oe_id = ?)
EOSQL

my ($current_version_number) = SL::DBUtils::selectfirst_array_query($::form, $self->db->dbh, $query, ($self->id));
die "Invalid State. No version linked" unless $current_version_number;

return $current_version_number;
}

sub is_final_version {
my ($self) = @_;

my $order_versions_count = SL::DB::Manager::OrderVersion->get_all_count(where => [ oe_id => $self->id, final_version => 0 ]);
die "Invalid version state" unless $order_versions_count < 2;
my $final_version = $order_versions_count == 1 ? 0 : 1;

return $final_version;
}

sub increment_version_number {
my ($self) = @_;

die t8('This sub-version is not yet finalized') if !$self->is_final_version;

my $current_version_number = $self->current_version_number;
my $new_version_number = $current_version_number + 1;

my $new_number = $self->number;
$new_number =~ s/-$current_version_number$//;
$self->number($new_number . '-' . $new_version_number);
$self->add_order_version(SL::DB::OrderVersion->new(version => $new_version_number));
}

sub netamount_base_currency {
my ($self) = @_;

return $self->netamount unless $self->forex;

if ( defined $self->exchangerate ) {
return $self->netamount * $self->exchangerate;
} else {
return $self->netamount * $self->daily_exchangerate;
}
}

sub type_data {
SL::DB::Helper::TypeDataProxy->new(ref $_[0], $_[0]->type);
}

1;

__END__

=pod

=encoding utf8

=head1 NAME

SL::DB::Order - Order Datenbank Objekt.

=head1 FUNCTIONS

=head2 C<type>

Returns one of the following string types:

=over 4

=item sales_order

=item purchase_order

=item sales_quotation

=item request_quotation

=back

=head2 C<is_type TYPE>

Returns true if the order is of the given type.

=head2 C<daily_exchangerate $val>

Gets or sets the exchangerate object's value. This is the value from the
table C<exchangerate> depending on the order's currency, the transdate and
if it is a sales or purchase order.

The order object (respectively the table C<oe>) has an own column
C<exchangerate> which can be get or set with the accessor C<exchangerate>.

The idea is to drop the legacy table C<exchangerate> in the future and to
give all relevant tables it's own C<exchangerate> column.

So, this method is here if you need to access the "legacy" exchangerate via
an order object.

=over 4

=item C<$val>

(optional) If given, the exchangerate in the "legacy" table is set to this
value, depending on currency, transdate and sales or purchase.

=back

=head2 C<convert_to_delivery_order %params>

Creates a new delivery order with C<$self> as the basis by calling
L<SL::DB::DeliveryOrder::new_from>. That delivery order is saved, and
C<$self> is linked to the new invoice via
L<SL::DB::RecordLink>. C<$self>'s C<delivered> attribute is set to