X-Git-Url: http://wagnertech.de/gitweb/gitweb.cgi/mfinanz.git/blobdiff_plain/7a244bebf207c4d50a5b519c0c0fe5d05d4e879e..9eb765a5e78cea60962849c8bf0879da85adeff1:/SL/Controller/Order.pm

diff --git a/SL/Controller/Order.pm b/SL/Controller/Order.pm
index 78b3b096b..b11e364b9 100644
--- a/SL/Controller/Order.pm
+++ b/SL/Controller/Order.pm
@@ -3,36 +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::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;
 
-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;
@@ -57,6 +47,7 @@ __PACKAGE__->run_before('_get_unalterable_data',
 # actions
 #
 
+# add a new order
 sub action_add {
   my ($self) = @_;
 
@@ -73,6 +64,7 @@ sub action_add {
   );
 }
 
+# edit an existing order
 sub action_edit {
   my ($self) = @_;
 
@@ -88,6 +80,7 @@ sub action_edit {
   );
 }
 
+# delete the order
 sub action_delete {
   my ($self) = @_;
 
@@ -100,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) = @_;
 
@@ -127,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) = @_;
 
@@ -211,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) = @_;
 
@@ -223,6 +228,7 @@ sub action_download_pdf {
   );
 }
 
+# open the email dialog
 sub action_show_email_dialog {
   my ($self) = @_;
 
@@ -257,6 +263,8 @@ sub action_show_email_dialog {
       ->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) = @_;
@@ -296,6 +304,8 @@ sub action_send_email {
       ->render($self);
 }
 
+# save the order and redirect to the frontend subroutine for a new
+# delivery order
 sub action_save_and_delivery_order {
   my ($self) = @_;
 
@@ -316,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) = @_;
 
@@ -360,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) = @_;
 
@@ -378,6 +392,7 @@ sub action_unit_changed {
   $self->js->render();
 }
 
+# add an item row for a new item entered in the input row
 sub action_add_item {
   my ($self) = @_;
 
@@ -386,6 +401,7 @@ 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();
@@ -398,7 +414,35 @@ sub action_add_item {
   );
 
   $self->js
-    ->append('#row_table_id', $row_as_html)
+    ->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
     ->val('.add_item_input', '')
     ->run('kivi.Order.init_row_handlers')
     ->run('kivi.Order.row_table_scroll_down')
@@ -409,12 +453,14 @@ sub action_add_item {
   $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;
 
@@ -435,6 +481,7 @@ sub action_multi_items_update_result {
   }
 }
 
+# add item rows for multiple items at once
 sub action_add_multi_items {
   my ($self) = @_;
 
@@ -443,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);
 
@@ -471,6 +533,7 @@ sub action_add_multi_items {
   $self->js->render();
 }
 
+# recalculate all linetotals, amounts and taxes and redisplay them
 sub action_recalc_amounts_and_taxes {
   my ($self) = @_;
 
@@ -481,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) = @_;
 
@@ -504,6 +568,7 @@ sub action_reorder_items {
     ->render;
 }
 
+# show the popup to choose a price/discount source
 sub action_price_popup {
   my ($self) = @_;
 
@@ -513,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;
 
@@ -524,6 +594,42 @@ sub action_get_item_longdescription {
   $_[0]->render(\ $longdescription, { type => 'text' });
 }
 
+# load the second row for one or more items (cvars only for now)
+#
+# This action gets the html code for all items second rows by rendering a template for
+# the second row and sets the html code via client js.
+sub action_load_second_rows {
+  my ($self) = @_;
+
+  foreach my $item_id (@{ $::form->{item_ids} }) {
+    my $idx  = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
+    my $item = $self->order->items_sorted->[$idx];
+
+    $self->_js_load_second_row($item, $item_id, 0);
+  }
+
+  $self->js->render();
+}
+
+sub _js_load_second_row {
+  my ($self, $item, $item_id, $do_parse) = @_;
+
+  if ($do_parse) {
+    # Parse values from form (they are formated while rendering (template)).
+    # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
+    # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
+    foreach my $var (@{ $item->cvars_by_config }) {
+      $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
+    }
+    $item->parse_custom_variable_values;
+  }
+
+  my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item);
+
+  $self->js
+    ->html('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', $row_as_html)
+    ->data('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', 'loaded', 1);
+}
 
 sub _js_redisplay_linetotals {
   my ($self) = @_;
@@ -591,6 +697,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],
@@ -623,6 +730,9 @@ sub _check_auth {
   $::auth->assert($right);
 }
 
+# build the selection box for contacts
+#
+# Needed, if customer/vendor changed.
 sub build_contact_select {
   my ($self) = @_;
 
@@ -635,6 +745,9 @@ sub build_contact_select {
   );
 }
 
+# build the selection box for shiptos
+#
+# Needed, if customer/vendor changed.
 sub build_shipto_select {
   my ($self) = @_;
 
@@ -647,6 +760,9 @@ sub build_shipto_select {
   );
 }
 
+# build the rows for displaying taxes
+#
+# Called if amounts where recalculated and redisplayed.
 sub build_tax_rows {
   my ($self) = @_;
 
@@ -687,6 +803,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) = @_;
 
@@ -723,7 +845,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 {
@@ -741,10 +864,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) = @_;
 
@@ -757,7 +885,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 {
@@ -800,6 +932,9 @@ sub _new_item {
   return $item;
 }
 
+# recalculate prices and taxes
+#
+# Using the PriceTaxCalculator. Store linetotals in the item objects.
 sub _recalc {
   my ($self) = @_;
 
@@ -820,7 +955,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) = @_;
 
@@ -834,14 +971,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;
@@ -854,17 +993,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;
@@ -995,79 +1135,196 @@ __END__
 
 SL::Controller::Order - controller for orders
 
-=head1 TODO
+=head1 SYNOPSIS
 
-=over 2
+This is a new form to enter orders, completely rewritten with the use
+of controller and java script techniques.
 
-=item *
+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.
 
-testing
+=head2 Key Features
 
+=over 4
 
 =item *
 
-currency
-
+One input row, so that input happens every time at the same place.
 
 =item *
 
-customer/vendor details ('D'-button)
+Use of pickers where possible.
+
+=item *
 
+Possibility to enter more than one item at once.
 
 =item *
 
-credit limit
+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 *
 
-more workflows (save as new / invoice)
+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<update> is necessary. All entries and calculations are managed
+with ajax-calls and the page does only reload on C<save>.
 
 =item *
 
-price sources: little symbols showing better price / better discount
+User can see changes immediately, because of the use of java script
+and ajax.
 
+=back
 
-=item *
+=head1 CODE
 
-custom shipto address
+=head2 Layout
 
+=over 4
 
-=item *
+=item * C<SL/Controller/Order.pm>
 
-periodic invoices
+the controller
 
+=item * C<template/webpages/order/form.html>
 
-=item *
+main form
 
-more details on second row (marge, ...)
+=item * C<template/webpages/order/tabs/basic_data.html>
 
+Main tab for basic_data.
 
-=item *
+This is the only tab here for now. "linked records" and "webdav" tabs are
+reused from generic code.
+
+=over 4
+
+=item * C<template/webpages/order/tabs/_item_input.html>
+
+The input line for items
+
+=item * C<template/webpages/order/tabs/_row.html>
+
+One row for already entered items
+
+=item * C<template/webpages/order/tabs/_tax_row.html>
+
+Displaying tax information
+
+=item * C<template/webpages/order/tabs/_multi_items_dialog.html>
+
+Dialog for entering more than one item at once
+
+=item * C<template/webpages/order/tabs/_multi_items_result.html>
+
+Results for the filter in the multi items dialog
+
+=item * C<template/webpages/order/tabs/_price_sources_dialog.html>
+
+Dialog for selecting price and discount sources
+
+=item * C<template/webpages/order/tabs/_email_dialog.html>
+
+Email dialog
+
+=back
+
+=item * C<js/kivi.Order.js>
+
+java script functions
+
+=back
+
+=head1 TODO
 
-language / part translations
+=over 4
 
+=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
+
+=item * history
+
+=item * mtime check
+
+=back
+
+=head1 KNOWN BUGS AND CAVEATS
+
+=over 4
 
 =item *
 
-access rights
+Customer discount is not displayed as a valid discount in price source popup
+(this might be a bug in price sources)
+
+=item *
 
+No indication that double click expands second row, no exand all button
 
 =item *
 
-preset salesman from customer
+Implementation of second row with a tbody for every item is not supported by
+our css.
 
+=item *
+
+As a consequence row striping does not currently work
 
 =item *
 
-display weights
+Inline creation of parts is not currently supported
+
+=item *
 
+Table header is not sticky in the scrolling area.
 
 =item *
 
-force project if enabled in client config
+Sorting does not include C<position>, neither does reordering.
+
+This behavior was implemented intentionally. But we can discuss, which behavior
+should be implemented.
+
+=item *
 
+C<show_multi_items_dialog> does not use the currently inserted string for
+filtering.
 
 =back