X-Git-Url: http://wagnertech.de/gitweb/gitweb.cgi/mfinanz.git/blobdiff_plain/ed04f337a0e565a3d0621a10bd273298e33c7fa1..5ef1fa848d2be3dd91478f86587a97060ed30cac:/SL/Controller/Order.pm diff --git a/SL/Controller/Order.pm b/SL/Controller/Order.pm index 68b5ca95e..c129999b0 100644 --- a/SL/Controller/Order.pm +++ b/SL/Controller/Order.pm @@ -10,6 +10,7 @@ use SL::SessionFile::Random; use SL::PriceSource; use SL::Form; use SL::Webdav; +use SL::Template; use SL::DB::Order; use SL::DB::Customer; @@ -20,10 +21,14 @@ use SL::DB::Project; use SL::DB::Default; use SL::DB::Unit; use SL::DB::Price; +use SL::DB::PriceFactor; 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; @@ -35,7 +40,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) ], ); @@ -43,15 +48,16 @@ use Rose::Object::MakeMethods::Generic __PACKAGE__->run_before('_check_auth'); __PACKAGE__->run_before('_recalc', - only => [ qw(update save save_and_delivery_order 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 create_pdf send_email) ]); + only => [ qw(save save_and_delivery_order print create_pdf send_email) ]); # # actions # +# add a new order sub action_add { my ($self) = @_; @@ -68,6 +74,7 @@ sub action_add { ); } +# edit an existing order sub action_edit { my ($self) = @_; @@ -83,19 +90,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) = @_; @@ -115,6 +110,7 @@ sub action_delete { $self->redirect_to(@redirect_params); } +# save the order sub action_save { my ($self) = @_; @@ -135,30 +131,76 @@ sub action_save { $self->redirect_to(@redirect_params); } -sub action_create_pdf { +# 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) = @_; - my $pdf; - my @errors = _create_pdf($self->order, \$pdf); - if (scalar @errors) { - return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self); + my $format = $::form->{print_options}->{format}; + my $media = $::form->{print_options}->{media}; + my $formname = $::form->{print_options}->{formname}; + my $copies = $::form->{print_options}->{copies}; + my $groupitems = $::form->{print_options}->{groupitems}; + + # only pdf by now + if (none { $format eq $_ } qw(pdf)) { + return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render; } - my $sfile = SL::SessionFile::Random->new(mode => "w"); - $sfile->fh->print($pdf); - $sfile->fh->close; + # only screen or printer by now + if (none { $media eq $_ } qw(screen printer)) { + return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render; + } - my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000); - $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name); + my $language; + $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id}; my $form = Form->new; $form->{ordnumber} = $self->order->ordnumber; - $form->{formname} = $self->type; $form->{type} = $self->type; - $form->{language} = 'de'; - $form->{format} = 'pdf'; + $form->{format} = $format; + $form->{formname} = $formname; + $form->{language} = '_' . $language->template_code if $language; + my $pdf_filename = $form->generate_attachment_filename(); - my $pdf_filename = $form->generate_attachment_filename(); + my $pdf; + my @errors = _create_pdf($self->order, \$pdf, { format => $format, + formname => $formname, + language => $language, + groupitems => $groupitems }); + if (scalar @errors) { + return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render; + } + + if ($media eq 'screen') { + # screen/download + my $sfile = SL::SessionFile::Random->new(mode => "w"); + $sfile->fh->print($pdf); + $sfile->fh->close; + + my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000); + $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name); + + $self->js + ->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}; + SL::DB::Printer->new(id => $printer_id)->load->print_document( + copies => $copies, + content => $pdf, + ); + + $self->js->flash('info', t8('The PDF has been printed')); + } # copy file to webdav folder if ($self->order->ordnumber && $::instance_conf->get_webdav_documents) { @@ -178,11 +220,12 @@ sub action_create_pdf { } } - $self->js - ->run('download_pdf', $pdf_filename, $key) - ->flash('info', t8('The PDF has been created'))->render($self); + $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) = @_; @@ -195,6 +238,7 @@ sub action_download_pdf { ); } +# open the email dialog sub action_show_email_dialog { my ($self) = @_; @@ -224,11 +268,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) = @_; @@ -264,10 +310,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) = @_; @@ -288,6 +336,9 @@ sub action_save_and_delivery_order { $self->redirect_to(@redirect_params); } +# set form elements in respect of a changed customer or vendor +# +# This action is called on an change of the customer/vendor picker. sub action_customer_vendor_changed { my ($self) = @_; @@ -332,6 +383,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) = @_; @@ -344,12 +396,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) = @_; @@ -363,31 +416,37 @@ sub action_add_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) ->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; + + $::form->{multi_items}->{filter}->{obsolete} = 0; + my $count = $_[0]->multi_items_models->count; if ($count == 0) { @@ -403,6 +462,7 @@ sub action_multi_items_update_result { } } +# add item rows for multiple items add once sub action_add_multi_items { my ($self) = @_; @@ -419,26 +479,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) = @_; @@ -449,6 +510,7 @@ sub action_recalc_amounts_and_taxes { $self->js->render(); } +# redisplay item rows if the are sorted by an attribute sub action_reorder_items { my ($self) = @_; @@ -468,10 +530,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) = @_; @@ -481,6 +544,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. +# Get it from OrderItem else. sub action_get_item_longdescription { my $longdescription; @@ -492,13 +560,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 { @@ -559,6 +626,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], @@ -576,6 +644,10 @@ sub init_multi_items_models { ); } +sub init_all_price_factors { + SL::DB::Manager::PriceFactor->get_all; +} + sub _check_auth { my ($self) = @_; @@ -587,6 +659,9 @@ sub _check_auth { $::auth->assert($right); } +# build the selection box for contacts +# +# Needed, if customer/vendor changed. sub build_contact_select { my ($self) = @_; @@ -599,6 +674,9 @@ sub build_contact_select { ); } +# build the selection box for shiptos +# +# Needed, if customer/vendor changed. sub build_shipto_select { my ($self) = @_; @@ -611,6 +689,9 @@ sub build_shipto_select { ); } +# build the rows for displaying taxes +# +# Called if amounts where recalculated and redisplayed. sub build_tax_rows { my ($self) = @_; @@ -651,6 +732,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) = @_; @@ -687,7 +774,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 { @@ -709,6 +797,9 @@ sub _make_item { return $item; } +# create a new item +# +# This is used to add one (or more) items sub _new_item { my ($record, $attr) = @_; @@ -744,8 +835,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; @@ -763,6 +855,9 @@ sub _new_item { return $item; } +# recalculate prices and taxes +# +# Using the PriceTaxCalclulator. Store linetotals in the item objects. sub _recalc { my ($self) = @_; @@ -783,7 +878,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) = @_; @@ -797,7 +894,9 @@ sub _get_unalterable_data { } } - +# delete the order +# +# And remove related files in the spool directory sub _delete { my ($self) = @_; @@ -817,7 +916,9 @@ sub _delete { return $errors; } - +# save the order +# +# And delete items that are deleted in the form. sub _save { my ($self) = @_; @@ -853,6 +954,20 @@ sub _pre_render { $self->{current_employee_id} = SL::DB::Manager::Employee->current->id; + my $print_form = Form->new(''); + $print_form->{type} = $self->type; + $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted; + $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted; + $self->{print_options} = SL::Helper::PrintOptions->get_print_options( + form => $print_form, + options => {dialog_name_prefix => 'print_options.', + show_headers => 1, + no_queue => 1, + no_postscript => 1, + no_opendocument => 1, + no_html => 1}, + ); + foreach my $item (@{$self->order->orderitems}) { my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order); $item->active_price_source( $price_source->price_from_source( $item->active_price_source )); @@ -872,29 +987,46 @@ 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 { my ($order, $pdf_ref, $params) = @_; + my @errors = (); + my $print_form = Form->new(''); - $print_form->{type} = $order->type; - $print_form->{formname} = $order->type; - $print_form->{format} = $params->{format} || 'pdf', - $print_form->{media} = $params->{media} || 'file'; + $print_form->{type} = $order->type; + $print_form->{formname} = $params->{formname} || $order->type; + $print_form->{format} = $params->{format} || 'pdf'; + $print_form->{media} = $params->{media} || 'file'; + $print_form->{groupitems} = $params->{groupitems}; + $print_form->{media} = 'file' if $print_form->{media} eq 'screen'; + $print_form->{language} = $params->{language}->template_code if $print_form->{language}; + $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}; - my @errors = (); + # search for the template + my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template( + name => $print_form->{formname}, + email => $print_form->{media} eq 'email', + language => $params->{language}, + printer_id => $print_form->{printer_id}, # todo + ); + + if (!defined $template_file) { + 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); + } + + return @errors if scalar @errors; + $print_form->throw_on_error(sub { eval { $print_form->prepare_for_printing; $$pdf_ref = SL::Helper::CreatePDF->create_pdf( - template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}), + template => $template_file, variables => $print_form, variable_content_types => { longdescription => 'html', @@ -918,3 +1050,188 @@ 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 2 + +=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 "update" is necessary. All entries and calculations are managed +with ajax-calls and the page does only reload on "save". + +=item * +User can see changes immediately, because of the use of java script +and ajax. + +=back + +=head1 CODE + +=head2 layout + +=over 2 + +=item * +SL/Controller/Order.pm: the controller + +=item * +template/webpages/order/form.html: main form + +=item * +template/webpages/order/tabs/basic_data.html: main tab for basic_data + +This is the only tab here for now. "linked records" and "webdav" tabs are reused +from generic code. + +=over 3 + +=item * +template/webpages/order/tabs/_item_input.html: the input line for items + +=item * +template/webpages/order/tabs/_row.html: one row for already entered items + +=item * +template/webpages/order/tabs/_tax_row.html: displaying tax information + +=item * +template/webpages/order/tabs/_multi_items_dialog.html: dialog for entering more +than one item at once + +=item * +template/webpages/order/tabs/_multi_items_result.html: results for the filter in +the multi items dialog + +=item * +template/webpages/order/tabs/_price_sources_dialog.html: dialog for selecting +price and discount sources + +=item * +template/webpages/order/tabs/_email_dialog.html: email dialog + +=back + +=item * +js/kivi.Order.js: java script functions + +=back + +=head1 TODO + +=over 2 + +=item * + +testing + + +=item * + +currency + + +=item * + +customer/vendor details ('D'-button) + + +=item * + +credit limit + + +=item * + +more workflows (save as new / invoice) + + +=item * + +price sources: little symbols showing better price / better discount + + +=item * + +custom shipto address + + +=item * + +periodic invoices + + +=item * + +more details on second row (marge, ...) + + +=item * + +language / part translations + + +=item * + +access rights + + +=item * + +preset salesman from customer + + +=item * + +display weights + + +=item * + +force project if enabled in client config + + +=back + +=head1 AUTHOR + +Bernd Bleßmann Ebernd@kivitendo-premium.deE + +=cut