X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FOrder.pm;h=78e9e5436041a78664c7ae4040c84820b9a3f54f;hb=70edaa5fe6a00edcd8a2abe7ea4ba06c7893f538;hp=eba061c08d2f7f5573d84fc12a2b9d7f67b3f18b;hpb=9fff4a29dd58de6dede5665921ef7b8aa9270b98;p=kivitendo-erp.git diff --git a/SL/Controller/Order.pm b/SL/Controller/Order.pm index eba061c08..78e9e5436 100644 --- a/SL/Controller/Order.pm +++ b/SL/Controller/Order.pm @@ -3,35 +3,26 @@ package SL::Controller::Order; use strict; use parent qw(SL::Controller::Base); -use SL::Helper::Flash; +use SL::Helper::Flash qw(flash_later); use SL::Presenter; -use SL::Locale::String; +use SL::Locale::String qw(t8); use SL::SessionFile::Random; use SL::PriceSource; -use SL::Form; use SL::Webdav; -use SL::Template; use SL::DB::Order; -use SL::DB::Customer; -use SL::DB::Vendor; -use SL::DB::TaxZone; -use SL::DB::Employee; -use SL::DB::Project; use SL::DB::Default; use SL::DB::Unit; -use SL::DB::Price; use SL::DB::Part; use SL::DB::Printer; use SL::DB::Language; -use SL::Helper::DateTime; use SL::Helper::CreatePDF qw(:all); use SL::Helper::PrintOptions; use SL::Controller::Helper::GetModels; -use List::Util qw(max first); +use List::Util qw(first); use List::MoreUtils qw(none pairwise first_index); use English qw(-no_match_vars); use File::Spec; @@ -39,7 +30,7 @@ use File::Spec; use Rose::Object::MakeMethods::Generic ( scalar => [ qw(item_ids_to_delete) ], - 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models) ], + 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors) ], ); @@ -47,7 +38,7 @@ use Rose::Object::MakeMethods::Generic __PACKAGE__->run_before('_check_auth'); __PACKAGE__->run_before('_recalc', - only => [ qw(update save save_and_delivery_order print create_pdf send_email) ]); + only => [ qw(save save_and_delivery_order print create_pdf send_email) ]); __PACKAGE__->run_before('_get_unalterable_data', only => [ qw(save save_and_delivery_order print create_pdf send_email) ]); @@ -56,6 +47,7 @@ __PACKAGE__->run_before('_get_unalterable_data', # actions # +# add a new order sub action_add { my ($self) = @_; @@ -72,6 +64,7 @@ sub action_add { ); } +# edit an existing order sub action_edit { my ($self) = @_; @@ -87,19 +80,7 @@ sub action_edit { ); } -sub action_update { - my ($self) = @_; - - $self->_pre_render(); - $self->render( - 'order/form', - title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order') - : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order') - : '', - %{$self->{template_args}} - ); -} - +# delete the order sub action_delete { my ($self) = @_; @@ -112,13 +93,14 @@ sub action_delete { flash_later('info', $::locale->text('The order has been deleted')); my @redirect_params = ( - action => 'edit', + action => 'add', type => $self->type, ); $self->redirect_to(@redirect_params); } +# save the order sub action_save { my ($self) = @_; @@ -139,6 +121,14 @@ sub action_save { $self->redirect_to(@redirect_params); } +# print the order +# +# This is called if "print" is pressed in the print dialog. +# If PDF creation was requested and succeeded, the pdf is stored in a session +# file and the filename is stored as session value with an unique key. A +# javascript function with this key is then called. This function calls the +# download action below (action_download_pdf), which offers the file for +# download. sub action_print { my ($self) = @_; @@ -188,26 +178,16 @@ sub action_print { $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name); $self->js - ->run('download_pdf', $pdf_filename, $key) + ->run('kivi.Order.download_pdf', $pdf_filename, $key) ->flash('info', t8('The PDF has been created')); } elsif ($media eq 'printer') { # printer my $printer_id = $::form->{print_options}->{printer_id}; - my $printer; - $printer = SL::DB::Printer->new(id => $printer_id)->load if $printer_id; - if (!$printer) { - return $self->js->flash('error', t8('Printer not found.'))->render; - } - - my $command = SL::Template::create(type => 'ShellCommand', form => Form->new(''))->parse($printer->printer_command); - - for my $i (1 .. $copies) { - open my $out, '|-', $command or die $!; - binmode $out; - print $out $pdf; - close $out; - } + SL::DB::Printer->new(id => $printer_id)->load->print_document( + copies => $copies, + content => $pdf, + ); $self->js->flash('info', t8('The PDF has been printed')); } @@ -233,6 +213,9 @@ sub action_print { $self->js->render; } +# offer pdf for download +# +# It needs to get the key for the session value to get the pdf file. sub action_download_pdf { my ($self) = @_; @@ -245,6 +228,7 @@ sub action_download_pdf { ); } +# open the email dialog sub action_show_email_dialog { my ($self) = @_; @@ -274,11 +258,13 @@ sub action_show_email_dialog { my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 }); $self->js - ->run('show_email_dialog', $dialog_html) + ->run('kivi.Order.show_email_dialog', $dialog_html) ->reinit_widgets ->render($self); } +# send email +# # Todo: handling error messages: flash is not displayed in dialog, but in the main form sub action_send_email { my ($self) = @_; @@ -314,10 +300,12 @@ sub action_send_email { $self->js ->val('#order_intnotes', $intnotes) - ->run('close_email_dialog') + ->run('kivi.Order.close_email_dialog') ->render($self); } +# save the order and redirect to the frontend subroutine for a new +# delivery order sub action_save_and_delivery_order { my ($self) = @_; @@ -338,6 +326,9 @@ sub action_save_and_delivery_order { $self->redirect_to(@redirect_params); } +# set form elements in respect to a changed customer or vendor +# +# This action is called on an change of the customer/vendor picker. sub action_customer_vendor_changed { my ($self) = @_; @@ -382,6 +373,7 @@ sub action_customer_vendor_changed { $self->js->render(); } +# called if a unit in an existing item row is changed sub action_unit_changed { my ($self) = @_; @@ -394,12 +386,13 @@ sub action_unit_changed { $self->_recalc(); $self->js - ->run('update_sellprice', $::form->{item_id}, $item->sellprice_as_number); + ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number); $self->_js_redisplay_linetotals; $self->_js_redisplay_amounts_and_taxes; $self->js->render(); } +# add an item row for a new item entered in the input row sub action_add_item { my ($self) = @_; @@ -408,34 +401,66 @@ sub action_add_item { return unless $form_attr->{parts_id}; my $item = _new_item($self->order, $form_attr); + $self->order->add_items($item); $self->_recalc(); my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000); - my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id); + my $row_as_html = $self->p->render('order/tabs/_row', + ITEM => $item, + ID => $item_id, + ALL_PRICE_FACTORS => $self->all_price_factors + ); + + $self->js + ->append('#row_table_id', $row_as_html); + + if ( $item->part->is_assortment ) { + $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number}; + foreach my $assortment_item ( @{$item->part->assortment_items} ) { + my $attr = { parts_id => $assortment_item->parts_id, + qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit} + unit => $assortment_item->unit, + description => $assortment_item->part->description, + }; + my $item = _new_item($self->order, $attr); + + # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount + $item->discount(1) unless $assortment_item->charge; + + $self->order->add_items( $item ); + $self->_recalc(); + my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000); + my $row_as_html = $self->p->render('order/tabs/_row', + ITEM => $item, + ID => $item_id, + ALL_PRICE_FACTORS => $self->all_price_factors + ); + $self->js + ->append('#row_table_id', $row_as_html); + }; + }; $self->js - ->append('#row_table_id', $row_as_html) ->val('.add_item_input', '') - ->run('row_table_scroll_down') - ->run('row_set_keyboard_events_by_id', $item_id) - ->run('set_unit_change_with_oldval_by_id', $item_id) - ->run('renumber_positions') - ->on('.recalc', 'change', 'recalc_amounts_and_taxes') - ->on('.reformat_number', 'change', 'reformat_number') + ->run('kivi.Order.init_row_handlers') + ->run('kivi.Order.row_table_scroll_down') + ->run('kivi.Order.renumber_positions') ->focus('#add_item_parts_id_name'); $self->_js_redisplay_amounts_and_taxes; $self->js->render(); } +# open the dialog for entering multiple items at once sub action_show_multi_items_dialog { require SL::DB::PartsGroup; $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 }, all_partsgroups => SL::DB::Manager::PartsGroup->get_all); } +# update the filter results in the multi item dialog sub action_multi_items_update_result { my $max_count = 100; @@ -456,6 +481,7 @@ sub action_multi_items_update_result { } } +# add item rows for multiple items at once sub action_add_multi_items { my ($self) = @_; @@ -464,7 +490,22 @@ sub action_add_multi_items { my @items; foreach my $attr (@form_attr) { - push @items, _new_item($self->order, $attr); + my $item = _new_item($self->order, $attr); + push @items, $item; + if ( $item->part->is_assortment ) { + foreach my $assortment_item ( @{$item->part->assortment_items} ) { + my $attr = { parts_id => $assortment_item->parts_id, + qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit} + unit => $assortment_item->unit, + description => $assortment_item->part->description, + }; + my $item = _new_item($self->order, $attr); + + # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount + $item->discount(1) unless $assortment_item->charge; + push @items, $assortment_item; + } + } } $self->order->add_items(@items); @@ -472,26 +513,27 @@ sub action_add_multi_items { foreach my $item (@items) { my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000); - my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id); + my $row_as_html = $self->p->render('order/tabs/_row', + ITEM => $item, + ID => $item_id, + ALL_PRICE_FACTORS => $self->all_price_factors + ); - $self->js - ->append('#row_table_id', $row_as_html) - ->run('row_set_keyboard_events_by_id', $item_id) - ->run('set_unit_change_with_oldval_by_id', $item_id); + $self->js->append('#row_table_id', $row_as_html); } $self->js - ->run('close_multi_items_dialog') - ->run('row_table_scroll_down') - ->run('renumber_positions') - ->on('.recalc', 'change', 'recalc_amounts_and_taxes') - ->on('.reformat_number', 'change', 'reformat_number') + ->run('kivi.Order.close_multi_items_dialog') + ->run('kivi.Order.init_row_handlers') + ->run('kivi.Order.row_table_scroll_down') + ->run('kivi.Order.renumber_positions') ->focus('#add_item_parts_id_name'); $self->_js_redisplay_amounts_and_taxes; $self->js->render(); } +# recalculate all linetotals, amounts and taxes and redisplay them sub action_recalc_amounts_and_taxes { my ($self) = @_; @@ -502,6 +544,7 @@ sub action_recalc_amounts_and_taxes { $self->js->render(); } +# redisplay item rows if they are sorted by an attribute sub action_reorder_items { my ($self) = @_; @@ -521,10 +564,11 @@ sub action_reorder_items { @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort; } $self->js - ->run('redisplay_items', \@to_sort) + ->run('kivi.Order.redisplay_items', \@to_sort) ->render; } +# show the popup to choose a price/discount source sub action_price_popup { my ($self) = @_; @@ -534,6 +578,11 @@ sub action_price_popup { $self->render_price_dialog($item); } +# get the longdescription for an item if the dialog to enter/change the +# longdescription was opened and the longdescription is empty +# +# If this item is new, get the longdescription from Part. +# Otherwise get it from OrderItem. sub action_get_item_longdescription { my $longdescription; @@ -545,13 +594,12 @@ sub action_get_item_longdescription { $_[0]->render(\ $longdescription, { type => 'text' }); } - sub _js_redisplay_linetotals { my ($self) = @_; my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items_sorted }; $self->js - ->run('redisplay_linetotals', \@data); + ->run('kivi.Order.redisplay_linetotals', \@data); } sub _js_redisplay_amounts_and_taxes { @@ -612,6 +660,7 @@ sub init_order { $_[0]->_make_order; } +# model used to filter/display the parts in the multi-items dialog sub init_multi_items_models { SL::Controller::Helper::GetModels->new( controller => $_[0], @@ -629,6 +678,10 @@ sub init_multi_items_models { ); } +sub init_all_price_factors { + SL::DB::Manager::PriceFactor->get_all; +} + sub _check_auth { my ($self) = @_; @@ -640,6 +693,9 @@ sub _check_auth { $::auth->assert($right); } +# build the selection box for contacts +# +# Needed, if customer/vendor changed. sub build_contact_select { my ($self) = @_; @@ -652,6 +708,9 @@ sub build_contact_select { ); } +# build the selection box for shiptos +# +# Needed, if customer/vendor changed. sub build_shipto_select { my ($self) = @_; @@ -664,6 +723,9 @@ sub build_shipto_select { ); } +# build the rows for displaying taxes +# +# Called if amounts where recalculated and redisplayed. sub build_tax_rows { my ($self) = @_; @@ -704,6 +766,12 @@ sub _load_order { $self->order(SL::DB::Manager::Order->find_by(id => $::form->{id})); } +# load or create a new order object +# +# And assign changes from the for to this object. +# If the order is loaded from db, check if items are deleted in the form, +# remove them form the object and collect them for removing from db on saving. +# Then create/update items from form (via _make_item) and add them. sub _make_order { my ($self) = @_; @@ -740,7 +808,8 @@ sub _make_order { return $order; } - +# create or update items from form +# # Make item objects from form values. For items already existing read from db. # Create a new item else. And assign attributes. sub _make_item { @@ -758,10 +827,15 @@ sub _make_item { $item->assign_attributes(%$attr); $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription}; + # item fields that currently can't be set in in row but are needed: + $item->lastcost($item->part->lastcost) if $is_new; return $item; } +# create a new item +# +# This is used to add one (or more) items sub _new_item { my ($record, $attr) = @_; @@ -774,7 +848,11 @@ sub _new_item { $item->unit($part->unit) if !$item->unit; my $price_src; - if ($item->sellprice) { + if ( $part->is_assortment ) { + # add assortment items with price 0, as the components carry the price + $price_src = $price_source->price_from_source(""); + $price_src->price(0); + } elsif ($item->sellprice) { $price_src = $price_source->price_from_source(""); $price_src->price($item->sellprice); } else { @@ -797,8 +875,9 @@ sub _new_item { my %new_attr; $new_attr{part} = $part; - $new_attr{description} = $part->description if ! $item->description; - $new_attr{qty} = 1.0 if ! $item->qty; + $new_attr{description} = $part->description if ! $item->description; + $new_attr{qty} = 1.0 if ! $item->qty; + $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id; $new_attr{sellprice} = $price_src->price; $new_attr{discount} = $discount_src->discount; $new_attr{active_price_source} = $price_src; @@ -816,6 +895,9 @@ sub _new_item { return $item; } +# recalculate prices and taxes +# +# Using the PriceTaxCalculator. Store linetotals in the item objects. sub _recalc { my ($self) = @_; @@ -836,7 +918,9 @@ sub _recalc { pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}}; } - +# get data for saving, printing, ..., that is not changed in the form +# +# Only cvars for now. sub _get_unalterable_data { my ($self) = @_; @@ -850,14 +934,16 @@ sub _get_unalterable_data { } } - +# delete the order +# +# And remove related files in the spool directory sub _delete { my ($self) = @_; my $errors = []; - my $db = $self->order->db; + my $db = $self->order->db; - $db->do_transaction( + $db->with_transaction( sub { my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) }; $self->order->delete; @@ -870,17 +956,18 @@ sub _delete { return $errors; } - +# save the order +# +# And delete items that are deleted in the form. sub _save { my ($self) = @_; my $errors = []; - my $db = $self->order->db; + my $db = $self->order->db; - $db->do_transaction( - sub { - SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete}; - $self->order->save(cascade => 1); + $db->with_transaction(sub { + SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete}; + $self->order->save(cascade => 1); }) || push(@{$errors}, $db->error); return $errors; @@ -939,7 +1026,7 @@ sub _pre_render { } } @all_objects; } - $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase ckeditor/ckeditor ckeditor/adapters/jquery); + $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order ckeditor/ckeditor ckeditor/adapters/jquery); } sub _create_pdf { @@ -958,8 +1045,6 @@ sub _create_pdf { $print_form->{language_id} = $params->{language}->id if $print_form->{language}; $order->flatten_to_form($print_form, format_amounts => 1); - # flatten_to_form sets payment_terms from customer/vendor - we do not want that here - delete $print_form->{payment_terms} if !$print_form->{payment_id}; # search for the template my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template( @@ -1004,3 +1089,219 @@ sub _purchase_order_type { } 1; + +__END__ + +=encoding utf-8 + +=head1 NAME + +SL::Controller::Order - controller for orders + +=head1 SYNOPSIS + +This is a new form to enter orders, completely rewritten with the use +of controller and java script techniques. + +The aim is to provide the user a better expirience and a faster flow +of work. Also the code should be more readable, more reliable and +better to maintain. + +=head2 Key Features + +=over 4 + +=item * + +One input row, so that input happens every time at the same place. + +=item * + +Use of pickers where possible. + +=item * + +Possibility to enter more than one item at once. + +=item * + +Save order only on "save" (and "save and delivery order"-workflow). No +hidden save on "print" or "email". + +=item * + +Item list in a scrollable area, so that the workflow buttons stay at +the bottom. + +=item * + +Reordering item rows with drag and drop is possible. Sorting item rows is +possible (by partnumber, description, qty, sellprice and discount for now). + +=item * + +No C is necessary. All entries and calculations are managed +with ajax-calls and the page does only reload on C. + +=item * + +User can see changes immediately, because of the use of java script +and ajax. + +=back + +=head1 CODE + +=head2 Layout + +=over 4 + +=item * C + +the controller + +=item * C