SimpleSystemSetting: Umstellung von »Warengruppen«
[kivitendo-erp.git] / SL / Controller / Order.pm
index 508fdfe..fce6e23 100644 (file)
@@ -9,6 +9,7 @@ use SL::Locale::String qw(t8);
 use SL::SessionFile::Random;
 use SL::PriceSource;
 use SL::Webdav;
+use SL::File;
 
 use SL::DB::Order;
 use SL::DB::Default;
@@ -93,7 +94,7 @@ sub action_delete {
 
   flash_later('info', $::locale->text('The order has been deleted'));
   my @redirect_params = (
-    action => 'edit',
+    action => 'add',
     type   => $self->type,
   );
 
@@ -209,7 +210,15 @@ sub action_print {
       $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
     }
   }
-
+  if ($self->order->ordnumber && $::instance_conf->get_doc_storage) {
+    SL::File->store( object_id     => $self->order->id,
+                     object_type   => $self->type,
+                     mime_type     => 'application/pdf',
+                     source        => 'created',
+                     file_type     => 'document',
+                     file_name     => $pdf_filename,
+                     file_contents => $pdf);
+  }
   $self->js->render;
 }
 
@@ -326,7 +335,7 @@ sub action_save_and_delivery_order {
   $self->redirect_to(@redirect_params);
 }
 
-# set form elements in respect of a changed customer or vendor
+# 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 {
@@ -387,7 +396,7 @@ sub action_unit_changed {
 
   $self->js
     ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
-  $self->_js_redisplay_linetotals;
+  $self->_js_redisplay_line_values;
   $self->_js_redisplay_amounts_and_taxes;
   $self->js->render();
 }
@@ -401,6 +410,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();
@@ -413,7 +423,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')
@@ -452,7 +490,7 @@ sub action_multi_items_update_result {
   }
 }
 
-# add item rows for multiple items add once
+# add item rows for multiple items at once
 sub action_add_multi_items {
   my ($self) = @_;
 
@@ -461,7 +499,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);
 
@@ -495,12 +548,12 @@ sub action_recalc_amounts_and_taxes {
 
   $self->_recalc();
 
-  $self->_js_redisplay_linetotals;
+  $self->_js_redisplay_line_values;
   $self->_js_redisplay_amounts_and_taxes;
   $self->js->render();
 }
 
-# redisplay item rows if the are sorted by an attribute
+# redisplay item rows if they are sorted by an attribute
 sub action_reorder_items {
   my ($self) = @_;
 
@@ -538,7 +591,7 @@ sub action_price_popup {
 # longdescription was opened and the longdescription is empty
 #
 # If this item is new, get the longdescription from Part.
-# Get it from OrderItem else.
+# Otherwise get it from OrderItem.
 sub action_get_item_longdescription {
   my $longdescription;
 
@@ -550,12 +603,70 @@ sub action_get_item_longdescription {
   $_[0]->render(\ $longdescription, { type => 'text' });
 }
 
-sub _js_redisplay_linetotals {
+# load the second row for one or more items
+#
+# 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) = @_;
+
+  $self->_recalc() if $self->order->is_sales; # for margin calculation
+
+  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->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
+
+  $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_line_values {
   my ($self) = @_;
 
-  my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items_sorted };
+  my $is_sales = $self->order->is_sales;
+
+  # sales orders with margins
+  my @data;
+  if ($is_sales) {
+    @data = map {
+      [
+       $::form->format_amount(\%::myconfig, $_->{linetotal},     2, 0),
+       $::form->format_amount(\%::myconfig, $_->{marge_total},   2, 0),
+       $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
+      ]} @{ $self->order->items_sorted };
+  } else {
+    @data = map {
+      [
+       $::form->format_amount(\%::myconfig, $_->{linetotal},     2, 0),
+      ]} @{ $self->order->items_sorted };
+  }
+
   $self->js
-    ->run('kivi.Order.redisplay_linetotals', \@data);
+    ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
 }
 
 sub _js_redisplay_amounts_and_taxes {
@@ -782,14 +893,16 @@ sub _make_item {
   $item ||= SL::DB::OrderItem->new(custom_variables => []);
 
   $item->assign_attributes(%$attr);
-  $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
+  $item->longdescription($item->part->notes)   if $is_new && !defined $attr->{longdescription};
+  $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
+  $item->lastcost($item->part->lastcost)       if $is_new && !defined $attr->{lastcost_as_number};
 
   return $item;
 }
 
 # create a new item
 #
-# This is used to add one (or more) items
+# This is used to add one item
 sub _new_item {
   my ($record, $attr) = @_;
 
@@ -802,7 +915,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 {
@@ -832,8 +949,9 @@ sub _new_item {
   $new_attr{discount}               = $discount_src->discount;
   $new_attr{active_price_source}    = $price_src;
   $new_attr{active_discount_source} = $discount_src;
-
-  $new_attr{longdescription}        = $part->notes if ! defined $attr->{longdescription};
+  $new_attr{longdescription}        = $part->notes           if ! defined $attr->{longdescription};
+  $new_attr{project_id}             = $record->globalproject_id;
+  $new_attr{lastcost}               = $part->lastcost;
 
   # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
   # they cannot be retrieved via custom_variables until the order/orderitem is
@@ -847,7 +965,7 @@ sub _new_item {
 
 # recalculate prices and taxes
 #
-# Using the PriceTaxCalclulator. Store linetotals in the item objects.
+# Using the PriceTaxCalculator. Store linetotals in the item objects.
 sub _recalc {
   my ($self) = @_;
 
@@ -891,9 +1009,9 @@ 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;
@@ -913,12 +1031,11 @@ 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 +1056,9 @@ sub _pre_render {
   $self->{all_projects}        = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
                                                                                       active => 1 ] ],
                                                                    sort_by => 'projectnumber');
-  $self->{all_payment_terms}   = SL::DB::Manager::PaymentTerm->get_all_sorted();
+  $self->{all_payment_terms}   = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
+                                                                                                 obsolete => 0 ] ]);
+
   $self->{all_delivery_terms}  = SL::DB::Manager::DeliveryTerm->get_all_sorted();
 
   $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
@@ -973,11 +1092,11 @@ sub _pre_render {
     my @all_objects = $webdav->get_all_objects;
     @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
                                                     type => t8('File'),
-                                                    link => File::Spec->catdir($webdav_path, $_->filename),
+                                                    link => File::Spec->catfile($_->full_filedescriptor),
                                                 } } @all_objects;
   }
 
-  $::request->{layout}->use_javascript("${_}.js")  for qw(kivi.SalesPurchase kivi.Order ckeditor/ckeditor ckeditor/adapters/jquery);
+  $::request->{layout}->use_javascript("${_}.js")  for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery);
 }
 
 sub _create_pdf {
@@ -1058,36 +1177,44 @@ 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
+=head2 Key Features
 
-=over 2
+=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". 
+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".
+
+No C<update> is necessary. All entries and calculations are managed
+with ajax-calls and the page does only reload on C<save>.
 
 =item *
+
 User can see changes immediately, because of the use of java script
 and ajax.
 
@@ -1095,128 +1222,175 @@ and ajax.
 
 =head1 CODE
 
-=head2 layout
+=head2 Layout
 
-=over 2
+=over 4
 
-=item *
-SL/Controller/Order.pm: the controller
+=item * C<SL/Controller/Order.pm>
 
-=item *
-template/webpages/order/form.html: main form
+the controller
 
-=item *
-template/webpages/order/tabs/basic_data.html: main tab for basic_data
+=item * C<template/webpages/order/form.html>
 
-This is the only tab here for now. "linked records" and "webdav" tabs are reused
-from generic code.
+main form
 
-=over 3
+=item * C<template/webpages/order/tabs/basic_data.html>
 
-=item *
-template/webpages/order/tabs/_item_input.html: the input line for items
+Main tab for basic_data.
 
-=item *
-template/webpages/order/tabs/_row.html: one row for already entered items
+This is the only tab here for now. "linked records" and "webdav" tabs are
+reused from generic code.
 
-=item *
-template/webpages/order/tabs/_tax_row.html: displaying tax information
+=over 4
 
-=item *
-template/webpages/order/tabs/_multi_items_dialog.html: dialog for entering more
-than one item at once
+=item * C<template/webpages/order/tabs/_item_input.html>
 
-=item *
-template/webpages/order/tabs/_multi_items_result.html: results for the filter in
-the multi items dialog
+The input line for items
 
-=item *
-template/webpages/order/tabs/_price_sources_dialog.html: dialog for selecting
-price and discount sources
+=item * C<template/webpages/order/tabs/_row.html>
 
-=item *
-template/webpages/order/tabs/_email_dialog.html: email dialog
+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 *
-js/kivi.Order.js: java script functions
+=item * C<js/kivi.Order.js>
+
+java script functions
 
 =back
 
 =head1 TODO
 
-=over 2
+=over 4
 
-=item *
+=item * testing
 
-testing
+=item * currency
 
+=item * customer/vendor details ('D'-button)
 
-=item *
+=item * credit limit
 
-currency
+=item * more workflows (save as new / invoice)
 
+=item * price sources: little symbols showing better price / better discount
 
-=item *
+=item * select units in input row?
 
-customer/vendor details ('D'-button)
+=item * custom shipto address
 
+=item * periodic invoices
 
-=item *
+=item * language / part translations
 
-credit limit
+=item * access rights
 
+=item * preset salesman from customer
 
-=item *
+=item * display weights
 
-more workflows (save as new / invoice)
+=item * history
 
+=item * mtime check
 
-=item *
+=item * optional client/user behaviour
 
-price sources: little symbols showing better price / better discount
+(transactions has to be set - department has to be set -
+ force project if enabled in client config - transport cost reminder)
 
+=back
+
+=head1 KNOWN BUGS AND CAVEATS
+
+=over 4
 
 =item *
 
-custom shipto address
+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 <shift>-up/down expands/collapses second row.
 
 =item *
 
-periodic invoices
+Inline creation of parts is not currently supported
+
+=item *
 
+Table header is not sticky in the scrolling area.
 
 =item *
 
-more details on second row (marge, ...)
+Sorting does not include C<position>, neither does reordering.
 
+This behavior was implemented intentionally. But we can discuss, which behavior
+should be implemented.
 
 =item *
 
-language / part translations
+C<show_multi_items_dialog> does not use the currently inserted string for
+filtering.
 
+=back
 
-=item *
+=head1 To discuss / Nice to have
 
-access rights
+=over 4
 
+=item *
+
+How to expand/collapse second row. Now it can be done clicking the icon or
+<shift>-up/down.
 
 =item *
 
-preset salesman from customer
+Possibility to change longdescription in input row?
 
+=item *
+
+Possibility to select PriceSources in input row?
 
 =item *
 
-display weights
+This controller uses a (changed) copy of the template for the PriceSource
+dialog. Maybe there could be used one code source.
+
+=item *
 
+Rounding-differences between this controller (PriceTaxCalculator) and the old
+form. This is not only a problem here, but also in all parts using the PTC.
+There exists a ticket and a patch. This patch should be testet.
 
 =item *
 
-force project if enabled in client config
+An indicator, if the actual inputs are saved (like in an
+editor or on text processing application).
+
+=item *
 
+A warning when leaving the page without saveing unchanged inputs.
 
 =back