1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
6 use SL::Helper::Flash qw(flash_later);
7 use SL::Presenter::Tag qw(select_tag);
8 use SL::Locale::String qw(t8);
9 use SL::SessionFile::Random;
21 use SL::Helper::CreatePDF qw(:all);
22 use SL::Helper::PrintOptions;
24 use SL::Controller::Helper::GetModels;
26 use List::Util qw(first);
27 use List::MoreUtils qw(none pairwise first_index);
28 use English qw(-no_match_vars);
31 use Rose::Object::MakeMethods::Generic
33 scalar => [ qw(item_ids_to_delete) ],
34 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors) ],
39 __PACKAGE__->run_before('_check_auth');
41 __PACKAGE__->run_before('_recalc',
42 only => [ qw(save save_and_delivery_order save_and_invoice print create_pdf send_email) ]);
44 __PACKAGE__->run_before('_get_unalterable_data',
45 only => [ qw(save save_and_delivery_order save_and_invoice print create_pdf send_email) ]);
55 $self->order->transdate(DateTime->now_local());
56 $self->order->reqdate(DateTime->today_local->next_workday) if !$self->order->reqdate;
61 title => $self->type eq _sales_order_type() ? $::locale->text('Add Sales Order')
62 : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
64 %{$self->{template_args}}
68 # edit an existing order
77 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
78 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
80 %{$self->{template_args}}
88 my $errors = $self->_delete();
90 if (scalar @{ $errors }) {
91 $self->js->flash('error', $_) foreach @{ $errors };
92 return $self->js->render();
95 flash_later('info', $::locale->text('The order has been deleted'));
96 my @redirect_params = (
101 $self->redirect_to(@redirect_params);
108 my $errors = $self->_save();
110 if (scalar @{ $errors }) {
111 $self->js->flash('error', $_) foreach @{ $errors };
112 return $self->js->render();
115 flash_later('info', $::locale->text('The order has been saved'));
116 my @redirect_params = (
119 id => $self->order->id,
122 $self->redirect_to(@redirect_params);
127 # This is called if "print" is pressed in the print dialog.
128 # If PDF creation was requested and succeeded, the pdf is stored in a session
129 # file and the filename is stored as session value with an unique key. A
130 # javascript function with this key is then called. This function calls the
131 # download action below (action_download_pdf), which offers the file for
136 my $format = $::form->{print_options}->{format};
137 my $media = $::form->{print_options}->{media};
138 my $formname = $::form->{print_options}->{formname};
139 my $copies = $::form->{print_options}->{copies};
140 my $groupitems = $::form->{print_options}->{groupitems};
143 if (none { $format eq $_ } qw(pdf)) {
144 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
147 # only screen or printer by now
148 if (none { $media eq $_ } qw(screen printer)) {
149 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
153 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
155 my $form = Form->new;
156 $form->{ordnumber} = $self->order->ordnumber;
157 $form->{type} = $self->type;
158 $form->{format} = $format;
159 $form->{formname} = $formname;
160 $form->{language} = '_' . $language->template_code if $language;
161 my $pdf_filename = $form->generate_attachment_filename();
164 my @errors = _create_pdf($self->order, \$pdf, { format => $format,
165 formname => $formname,
166 language => $language,
167 groupitems => $groupitems });
168 if (scalar @errors) {
169 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
172 if ($media eq 'screen') {
174 my $sfile = SL::SessionFile::Random->new(mode => "w");
175 $sfile->fh->print($pdf);
178 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
179 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
182 ->run('kivi.Order.download_pdf', $pdf_filename, $key)
183 ->flash('info', t8('The PDF has been created'));
185 } elsif ($media eq 'printer') {
187 my $printer_id = $::form->{print_options}->{printer_id};
188 SL::DB::Printer->new(id => $printer_id)->load->print_document(
193 $self->js->flash('info', t8('The PDF has been printed'));
196 # copy file to webdav folder
197 if ($self->order->ordnumber && $::instance_conf->get_webdav_documents) {
198 my $webdav = SL::Webdav->new(
200 number => $self->order->ordnumber,
202 my $webdav_file = SL::Webdav::File->new(
204 filename => $pdf_filename,
207 $webdav_file->store(data => \$pdf);
210 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
213 if ($self->order->ordnumber && $::instance_conf->get_doc_storage) {
215 SL::File->save(object_id => $self->order->id,
216 object_type => $self->type,
217 mime_type => 'application/pdf',
219 file_type => 'document',
220 file_name => $pdf_filename,
221 file_contents => $pdf);
224 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
230 # offer pdf for download
232 # It needs to get the key for the session value to get the pdf file.
233 sub action_download_pdf {
236 my $key = $::form->{key};
237 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
238 return $self->send_file(
240 type => 'application/pdf',
241 name => $::form->{pdf_filename},
245 # open the email dialog
246 sub action_show_email_dialog {
249 my $cv_method = $self->cv;
251 if (!$self->order->$cv_method) {
252 return $self->js->flash('error', $self->cv eq 'customer' ? t8('Cannot send E-mail without customer given') : t8('Cannot send E-mail without vendor given'))
256 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
257 $self->{email}->{to} ||= $self->order->$cv_method->email;
258 $self->{email}->{cc} = $self->order->$cv_method->cc;
259 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
260 # Todo: get addresses from shipto, if any
262 my $form = Form->new;
263 $form->{ordnumber} = $self->order->ordnumber;
264 $form->{formname} = $self->type;
265 $form->{type} = $self->type;
266 $form->{language} = 'de';
267 $form->{format} = 'pdf';
269 $self->{email}->{subject} = $form->generate_email_subject();
270 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
271 $self->{email}->{message} = $form->create_email_signature();
273 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
275 ->run('kivi.Order.show_email_dialog', $dialog_html)
282 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
283 sub action_send_email {
286 my $mail = Mailer->new;
287 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
288 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
291 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
292 if (scalar @errors) {
293 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
296 $mail->{attachments} = [{ "content" => $pdf,
297 "name" => $::form->{email}->{attachment_filename} }];
299 if (my $err = $mail->send) {
300 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
305 my $intnotes = $self->order->intnotes;
306 $intnotes .= "\n\n" if $self->order->intnotes;
307 $intnotes .= t8('[email]') . "\n";
308 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
309 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
310 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
311 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
312 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
313 $intnotes .= t8('Message') . ": " . $mail->{message};
316 ->val('#order_intnotes', $intnotes)
317 ->run('kivi.Order.close_email_dialog')
321 # save the order and redirect to the frontend subroutine for a new
323 sub action_save_and_delivery_order {
326 my $errors = $self->_save();
328 if (scalar @{ $errors }) {
329 $self->js->flash('error', $_) foreach @{ $errors };
330 return $self->js->render();
332 flash_later('info', $::locale->text('The order has been saved'));
334 my @redirect_params = (
335 controller => 'oe.pl',
336 action => 'oe_delivery_order_from_order',
337 id => $self->order->id,
340 $self->redirect_to(@redirect_params);
343 # save the order and redirect to the frontend subroutine for a new
345 sub action_save_and_invoice {
348 my $errors = $self->_save();
350 if (scalar @{ $errors }) {
351 $self->js->flash('error', $_) foreach @{ $errors };
352 return $self->js->render();
354 flash_later('info', $::locale->text('The order has been saved'));
356 my @redirect_params = (
357 controller => 'oe.pl',
358 action => 'oe_invoice_from_order',
359 id => $self->order->id,
362 $self->redirect_to(@redirect_params);
365 # set form elements in respect to a changed customer or vendor
367 # This action is called on an change of the customer/vendor picker.
368 sub action_customer_vendor_changed {
371 my $cv_method = $self->cv;
373 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
374 $self->js->show('#cp_row');
376 $self->js->hide('#cp_row');
379 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
380 $self->js->show('#shipto_row');
382 $self->js->hide('#shipto_row');
385 $self->order->taxzone_id($self->order->$cv_method->taxzone_id);
387 if ($self->order->is_sales) {
388 $self->order->taxincluded(defined($self->order->$cv_method->taxincluded_checked)
389 ? $self->order->$cv_method->taxincluded_checked
390 : $::myconfig{taxincluded_checked});
391 $self->js->val('#order_salesman_id', $self->order->$cv_method->salesman_id);
394 $self->order->payment_id($self->order->$cv_method->payment_id);
395 $self->order->delivery_term_id($self->order->$cv_method->delivery_term_id);
400 ->replaceWith('#order_cp_id', $self->build_contact_select)
401 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
402 ->val( '#order_taxzone_id', $self->order->taxzone_id)
403 ->val( '#order_taxincluded', $self->order->taxincluded)
404 ->val( '#order_payment_id', $self->order->payment_id)
405 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
406 ->val( '#order_intnotes', $self->order->$cv_method->notes)
407 ->focus( '#order_' . $self->cv . '_id');
409 $self->_js_redisplay_amounts_and_taxes;
413 # called if a unit in an existing item row is changed
414 sub action_unit_changed {
417 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
418 my $item = $self->order->items_sorted->[$idx];
420 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
421 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
426 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
427 $self->_js_redisplay_line_values;
428 $self->_js_redisplay_amounts_and_taxes;
432 # add an item row for a new item entered in the input row
433 sub action_add_item {
436 my $form_attr = $::form->{add_item};
438 return unless $form_attr->{parts_id};
440 my $item = _new_item($self->order, $form_attr);
442 $self->order->add_items($item);
446 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
447 my $row_as_html = $self->p->render('order/tabs/_row',
450 ALL_PRICE_FACTORS => $self->all_price_factors
454 ->append('#row_table_id', $row_as_html);
456 if ( $item->part->is_assortment ) {
457 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
458 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
459 my $attr = { parts_id => $assortment_item->parts_id,
460 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
461 unit => $assortment_item->unit,
462 description => $assortment_item->part->description,
464 my $item = _new_item($self->order, $attr);
466 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
467 $item->discount(1) unless $assortment_item->charge;
469 $self->order->add_items( $item );
471 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
472 my $row_as_html = $self->p->render('order/tabs/_row',
475 ALL_PRICE_FACTORS => $self->all_price_factors
478 ->append('#row_table_id', $row_as_html);
483 ->val('.add_item_input', '')
484 ->run('kivi.Order.init_row_handlers')
485 ->run('kivi.Order.row_table_scroll_down')
486 ->run('kivi.Order.renumber_positions')
487 ->focus('#add_item_parts_id_name');
489 $self->_js_redisplay_amounts_and_taxes;
493 # open the dialog for entering multiple items at once
494 sub action_show_multi_items_dialog {
495 require SL::DB::PartsGroup;
496 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
497 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
500 # update the filter results in the multi item dialog
501 sub action_multi_items_update_result {
504 $::form->{multi_items}->{filter}->{obsolete} = 0;
506 my $count = $_[0]->multi_items_models->count;
509 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
510 $_[0]->render($text, { layout => 0 });
511 } elsif ($count > $max_count) {
512 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
513 $_[0]->render($text, { layout => 0 });
515 my $multi_items = $_[0]->multi_items_models->get;
516 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
517 multi_items => $multi_items);
521 # add item rows for multiple items at once
522 sub action_add_multi_items {
525 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
526 return $self->js->render() unless scalar @form_attr;
529 foreach my $attr (@form_attr) {
530 my $item = _new_item($self->order, $attr);
532 if ( $item->part->is_assortment ) {
533 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
534 my $attr = { parts_id => $assortment_item->parts_id,
535 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
536 unit => $assortment_item->unit,
537 description => $assortment_item->part->description,
539 my $item = _new_item($self->order, $attr);
541 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
542 $item->discount(1) unless $assortment_item->charge;
547 $self->order->add_items(@items);
551 foreach my $item (@items) {
552 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
553 my $row_as_html = $self->p->render('order/tabs/_row',
556 ALL_PRICE_FACTORS => $self->all_price_factors
559 $self->js->append('#row_table_id', $row_as_html);
563 ->run('kivi.Order.close_multi_items_dialog')
564 ->run('kivi.Order.init_row_handlers')
565 ->run('kivi.Order.row_table_scroll_down')
566 ->run('kivi.Order.renumber_positions')
567 ->focus('#add_item_parts_id_name');
569 $self->_js_redisplay_amounts_and_taxes;
573 # recalculate all linetotals, amounts and taxes and redisplay them
574 sub action_recalc_amounts_and_taxes {
579 $self->_js_redisplay_line_values;
580 $self->_js_redisplay_amounts_and_taxes;
584 # redisplay item rows if they are sorted by an attribute
585 sub action_reorder_items {
589 partnumber => sub { $_[0]->part->partnumber },
590 description => sub { $_[0]->description },
591 qty => sub { $_[0]->qty },
592 sellprice => sub { $_[0]->sellprice },
593 discount => sub { $_[0]->discount },
596 my $method = $sort_keys{$::form->{order_by}};
597 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
598 if ($::form->{sort_dir}) {
599 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
601 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
604 ->run('kivi.Order.redisplay_items', \@to_sort)
608 # show the popup to choose a price/discount source
609 sub action_price_popup {
612 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
613 my $item = $self->order->items_sorted->[$idx];
615 $self->render_price_dialog($item);
618 # get the longdescription for an item if the dialog to enter/change the
619 # longdescription was opened and the longdescription is empty
621 # If this item is new, get the longdescription from Part.
622 # Otherwise get it from OrderItem.
623 sub action_get_item_longdescription {
626 if ($::form->{item_id}) {
627 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
628 } elsif ($::form->{parts_id}) {
629 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
631 $_[0]->render(\ $longdescription, { type => 'text' });
634 # load the second row for one or more items
636 # This action gets the html code for all items second rows by rendering a template for
637 # the second row and sets the html code via client js.
638 sub action_load_second_rows {
641 $self->_recalc() if $self->order->is_sales; # for margin calculation
643 foreach my $item_id (@{ $::form->{item_ids} }) {
644 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
645 my $item = $self->order->items_sorted->[$idx];
647 $self->_js_load_second_row($item, $item_id, 0);
650 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
655 sub _js_load_second_row {
656 my ($self, $item, $item_id, $do_parse) = @_;
659 # Parse values from form (they are formated while rendering (template)).
660 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
661 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
662 foreach my $var (@{ $item->cvars_by_config }) {
663 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
665 $item->parse_custom_variable_values;
668 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item);
671 ->html('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', $row_as_html)
672 ->data('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', 'loaded', 1);
675 sub _js_redisplay_line_values {
678 my $is_sales = $self->order->is_sales;
680 # sales orders with margins
685 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
686 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
687 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
688 ]} @{ $self->order->items_sorted };
692 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
693 ]} @{ $self->order->items_sorted };
697 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
700 sub _js_redisplay_amounts_and_taxes {
703 if (scalar @{ $self->{taxes} }) {
704 $self->js->show('#taxincluded_row_id');
706 $self->js->hide('#taxincluded_row_id');
709 if ($self->order->taxincluded) {
710 $self->js->hide('#subtotal_row_id');
712 $self->js->show('#subtotal_row_id');
716 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
717 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
719 ->insertBefore($self->build_tax_rows, '#amount_row_id');
726 sub init_valid_types {
727 [ _sales_order_type(), _purchase_order_type() ];
733 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
734 die "Not a valid type for order";
737 $self->type($::form->{type});
743 my $cv = $self->type eq _sales_order_type() ? 'customer'
744 : $self->type eq _purchase_order_type() ? 'vendor'
745 : die "Not a valid type for order";
758 # model used to filter/display the parts in the multi-items dialog
759 sub init_multi_items_models {
760 SL::Controller::Helper::GetModels->new(
763 with_objects => [ qw(unit_obj) ],
764 disable_plugin => 'paginated',
765 source => $::form->{multi_items},
771 partnumber => t8('Partnumber'),
772 description => t8('Description')}
776 sub init_all_price_factors {
777 SL::DB::Manager::PriceFactor->get_all;
783 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
785 my $right = $right_for->{ $self->type };
786 $right ||= 'DOES_NOT_EXIST';
788 $::auth->assert($right);
791 # build the selection box for contacts
793 # Needed, if customer/vendor changed.
794 sub build_contact_select {
797 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
798 value_key => 'cp_id',
799 title_key => 'full_name_dep',
800 default => $self->order->cp_id,
802 style => 'width: 300px',
806 # build the selection box for shiptos
808 # Needed, if customer/vendor changed.
809 sub build_shipto_select {
812 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
813 value_key => 'shipto_id',
814 title_key => 'displayable_id',
815 default => $self->order->shipto_id,
817 style => 'width: 300px',
821 # build the rows for displaying taxes
823 # Called if amounts where recalculated and redisplayed.
828 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
829 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
831 return $rows_as_html;
835 sub render_price_dialog {
836 my ($self, $record_item) = @_;
838 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
842 'kivi.io.price_chooser_dialog',
843 t8('Available Prices'),
844 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
849 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
850 # $self->js->show('#dialog_flash_error');
859 return if !$::form->{id};
861 $self->order(SL::DB::Manager::Order->find_by(id => $::form->{id}));
864 # load or create a new order object
866 # And assign changes from the for to this object.
867 # If the order is loaded from db, check if items are deleted in the form,
868 # remove them form the object and collect them for removing from db on saving.
869 # Then create/update items from form (via _make_item) and add them.
873 # add_items adds items to an order with no items for saving, but they cannot
874 # be retrieved via items until the order is saved. Adding empty items to new
875 # order here solves this problem.
877 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
878 $order ||= SL::DB::Order->new(orderitems => []);
880 my $form_orderitems = delete $::form->{order}->{orderitems};
881 $order->assign_attributes(%{$::form->{order}});
883 # remove deleted items
884 $self->item_ids_to_delete([]);
885 foreach my $idx (reverse 0..$#{$order->orderitems}) {
886 my $item = $order->orderitems->[$idx];
887 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
888 splice @{$order->orderitems}, $idx, 1;
889 push @{$self->item_ids_to_delete}, $item->id;
895 foreach my $form_attr (@{$form_orderitems}) {
896 my $item = _make_item($order, $form_attr);
897 $item->position($pos);
901 $order->add_items(grep {!$_->id} @items);
906 # create or update items from form
908 # Make item objects from form values. For items already existing read from db.
909 # Create a new item else. And assign attributes.
911 my ($record, $attr) = @_;
914 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
918 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
919 # they cannot be retrieved via custom_variables until the order/orderitem is
920 # saved. Adding empty custom_variables to new orderitem here solves this problem.
921 $item ||= SL::DB::OrderItem->new(custom_variables => []);
923 $item->assign_attributes(%$attr);
924 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
925 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
926 $item->lastcost($item->part->lastcost) if $is_new && !defined $attr->{lastcost_as_number};
933 # This is used to add one item
935 my ($record, $attr) = @_;
937 my $item = SL::DB::OrderItem->new;
938 $item->assign_attributes(%$attr);
940 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
941 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
943 $item->unit($part->unit) if !$item->unit;
946 if ( $part->is_assortment ) {
947 # add assortment items with price 0, as the components carry the price
948 $price_src = $price_source->price_from_source("");
949 $price_src->price(0);
950 } elsif ($item->sellprice) {
951 $price_src = $price_source->price_from_source("");
952 $price_src->price($item->sellprice);
954 $price_src = $price_source->best_price
955 ? $price_source->best_price
956 : $price_source->price_from_source("");
957 $price_src->price(0) if !$price_source->best_price;
961 if ($item->discount) {
962 $discount_src = $price_source->discount_from_source("");
963 $discount_src->discount($item->discount);
965 $discount_src = $price_source->best_discount
966 ? $price_source->best_discount
967 : $price_source->discount_from_source("");
968 $discount_src->discount(0) if !$price_source->best_discount;
972 $new_attr{part} = $part;
973 $new_attr{description} = $part->description if ! $item->description;
974 $new_attr{qty} = 1.0 if ! $item->qty;
975 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
976 $new_attr{sellprice} = $price_src->price;
977 $new_attr{discount} = $discount_src->discount;
978 $new_attr{active_price_source} = $price_src;
979 $new_attr{active_discount_source} = $discount_src;
980 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
981 $new_attr{project_id} = $record->globalproject_id;
982 $new_attr{lastcost} = $part->lastcost;
984 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
985 # they cannot be retrieved via custom_variables until the order/orderitem is
986 # saved. Adding empty custom_variables to new orderitem here solves this problem.
987 $new_attr{custom_variables} = [];
989 $item->assign_attributes(%new_attr);
994 # recalculate prices and taxes
996 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1000 # bb: todo: currency later
1001 $self->order->currency_id($::instance_conf->get_currency_id());
1003 my %pat = $self->order->calculate_prices_and_taxes();
1004 $self->{taxes} = [];
1005 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
1006 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
1008 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
1009 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
1010 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
1014 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
1017 # get data for saving, printing, ..., that is not changed in the form
1019 # Only cvars for now.
1020 sub _get_unalterable_data {
1023 foreach my $item (@{ $self->order->items }) {
1024 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1025 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1026 foreach my $var (@{ $item->cvars_by_config }) {
1027 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1029 $item->parse_custom_variable_values;
1035 # And remove related files in the spool directory
1040 my $db = $self->order->db;
1042 $db->with_transaction(
1044 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1045 $self->order->delete;
1046 my $spool = $::lx_office_conf{paths}->{spool};
1047 unlink map { "$spool/$_" } @spoolfiles if $spool;
1050 }) || push(@{$errors}, $db->error);
1057 # And delete items that are deleted in the form.
1062 my $db = $self->order->db;
1064 $db->with_transaction(sub {
1065 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete};
1066 $self->order->save(cascade => 1);
1067 }) || push(@{$errors}, $db->error);
1076 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1077 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1078 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1081 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1084 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
1086 sort_by => 'projectnumber');
1087 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1090 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1092 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1094 my $print_form = Form->new('');
1095 $print_form->{type} = $self->type;
1096 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1097 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1098 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1099 form => $print_form,
1100 options => {dialog_name_prefix => 'print_options.',
1104 no_opendocument => 1,
1108 foreach my $item (@{$self->order->orderitems}) {
1109 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1110 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1111 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1114 if ($self->order->ordnumber && $::instance_conf->get_webdav) {
1115 my $webdav = SL::Webdav->new(
1116 type => $self->type,
1117 number => $self->order->ordnumber,
1119 my @all_objects = $webdav->get_all_objects;
1120 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1122 link => File::Spec->catfile($_->full_filedescriptor),
1126 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery);
1127 $self->_setup_edit_action_bar;
1130 sub _setup_edit_action_bar {
1131 my ($self, %params) = @_;
1133 my $deletion_allowed = (($self->cv eq 'customer') && $::instance_conf->get_sales_order_show_delete)
1134 || (($self->cv eq 'vendor') && $::instance_conf->get_purchase_order_show_delete);
1136 for my $bar ($::request->layout->get('actionbar')) {
1141 call => [ 'kivi.Order.save', $::instance_conf->get_order_warn_duplicate_parts ],
1142 accesskey => 'enter',
1145 t8('Save and Delivery Order'),
1146 call => [ 'kivi.Order.save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts ],
1149 t8('Save and Invoice'),
1150 call => [ 'kivi.Order.save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1153 ], # end of combobox "Save"
1161 call => [ 'kivi.Order.show_print_options' ],
1165 call => [ 'kivi.Order.email' ],
1168 t8('Download attachments of all parts'),
1169 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1170 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1171 only_if => $::instance_conf->get_doc_storage,
1173 ], # end of combobox "Export"
1177 call => [ 'kivi.Order.delete_order' ],
1178 confirm => $::locale->text('Do you really want to delete this object?'),
1179 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1180 only_if => $deletion_allowed,
1187 my ($order, $pdf_ref, $params) = @_;
1191 my $print_form = Form->new('');
1192 $print_form->{type} = $order->type;
1193 $print_form->{formname} = $params->{formname} || $order->type;
1194 $print_form->{format} = $params->{format} || 'pdf';
1195 $print_form->{media} = $params->{media} || 'file';
1196 $print_form->{groupitems} = $params->{groupitems};
1197 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1198 $print_form->{language} = $params->{language}->template_code if $print_form->{language};
1199 $print_form->{language_id} = $params->{language}->id if $print_form->{language};
1201 $order->flatten_to_form($print_form, format_amounts => 1);
1203 # search for the template
1204 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1205 name => $print_form->{formname},
1206 email => $print_form->{media} eq 'email',
1207 language => $params->{language},
1208 printer_id => $print_form->{printer_id}, # todo
1211 if (!defined $template_file) {
1212 push @errors, $::locale->text('Cannot find matching template for this print request. Please contact your template maintainer. I tried these: #1.', join ', ', map { "'$_'"} @template_files);
1215 return @errors if scalar @errors;
1217 $print_form->throw_on_error(sub {
1219 $print_form->prepare_for_printing;
1221 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1222 template => $template_file,
1223 variables => $print_form,
1224 variable_content_types => {
1225 longdescription => 'html',
1226 partnotes => 'html',
1231 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
1237 sub _sales_order_type {
1241 sub _purchase_order_type {
1253 SL::Controller::Order - controller for orders
1257 This is a new form to enter orders, completely rewritten with the use
1258 of controller and java script techniques.
1260 The aim is to provide the user a better expirience and a faster flow
1261 of work. Also the code should be more readable, more reliable and
1270 One input row, so that input happens every time at the same place.
1274 Use of pickers where possible.
1278 Possibility to enter more than one item at once.
1282 Save order only on "save" (and "save and delivery order"-workflow). No
1283 hidden save on "print" or "email".
1287 Item list in a scrollable area, so that the workflow buttons stay at
1292 Reordering item rows with drag and drop is possible. Sorting item rows is
1293 possible (by partnumber, description, qty, sellprice and discount for now).
1297 No C<update> is necessary. All entries and calculations are managed
1298 with ajax-calls and the page does only reload on C<save>.
1302 User can see changes immediately, because of the use of java script
1313 =item * C<SL/Controller/Order.pm>
1317 =item * C<template/webpages/order/form.html>
1321 =item * C<template/webpages/order/tabs/basic_data.html>
1323 Main tab for basic_data.
1325 This is the only tab here for now. "linked records" and "webdav" tabs are
1326 reused from generic code.
1330 =item * C<template/webpages/order/tabs/_item_input.html>
1332 The input line for items
1334 =item * C<template/webpages/order/tabs/_row.html>
1336 One row for already entered items
1338 =item * C<template/webpages/order/tabs/_tax_row.html>
1340 Displaying tax information
1342 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
1344 Dialog for entering more than one item at once
1346 =item * C<template/webpages/order/tabs/_multi_items_result.html>
1348 Results for the filter in the multi items dialog
1350 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
1352 Dialog for selecting price and discount sources
1354 =item * C<template/webpages/order/tabs/_email_dialog.html>
1360 =item * C<js/kivi.Order.js>
1362 java script functions
1374 =item * customer/vendor details ('D'-button)
1376 =item * credit limit
1378 =item * more workflows (save as new, quotation, purchase order)
1380 =item * price sources: little symbols showing better price / better discount
1382 =item * select units in input row?
1384 =item * custom shipto address
1386 =item * periodic invoices
1388 =item * language / part translations
1390 =item * access rights
1392 =item * display weights
1398 =item * optional client/user behaviour
1400 (transactions has to be set - department has to be set -
1401 force project if enabled in client config - transport cost reminder)
1405 =head1 KNOWN BUGS AND CAVEATS
1411 Customer discount is not displayed as a valid discount in price source popup
1412 (this might be a bug in price sources)
1414 (I cannot reproduce this (Bernd))
1418 No indication that <shift>-up/down expands/collapses second row.
1422 Inline creation of parts is not currently supported
1426 Table header is not sticky in the scrolling area.
1430 Sorting does not include C<position>, neither does reordering.
1432 This behavior was implemented intentionally. But we can discuss, which behavior
1433 should be implemented.
1437 C<show_multi_items_dialog> does not use the currently inserted string for
1442 =head1 To discuss / Nice to have
1448 How to expand/collapse second row. Now it can be done clicking the icon or
1453 Possibility to change longdescription in input row?
1457 Possibility to select PriceSources in input row?
1461 This controller uses a (changed) copy of the template for the PriceSource
1462 dialog. Maybe there could be used one code source.
1466 Rounding-differences between this controller (PriceTaxCalculator) and the old
1467 form. This is not only a problem here, but also in all parts using the PTC.
1468 There exists a ticket and a patch. This patch should be testet.
1472 An indicator, if the actual inputs are saved (like in an
1473 editor or on text processing application).
1477 A warning when leaving the page without saveing unchanged inputs.
1481 Workflows for delivery order and invoice are in the menu "Save", because the
1482 order is saved before opening the new document form. Nevertheless perhaps these
1483 workflow buttons should be put under "Workflows".
1490 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>