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::File;
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;
# actions
#
+# add a new order
sub action_add {
my ($self) = @_;
);
}
+# edit an existing order
sub action_edit {
my ($self) = @_;
);
}
+# delete the order
sub action_delete {
my ($self) = @_;
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) = @_;
$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) = @_;
} 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'));
}
$self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
}
}
-
+ if ($self->order->ordnumber && $::instance_conf->get_doc_storage) {
+ eval {
+ SL::File->save(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);
+ 1;
+ } or do {
+ $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
+ }
+ }
$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) = @_;
);
}
+# open the email dialog
sub action_show_email_dialog {
my ($self) = @_;
->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) = @_;
->render($self);
}
+# save the order and redirect to the frontend subroutine for a new
+# delivery order
sub action_save_and_delivery_order {
my ($self) = @_;
$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) = @_;
$self->js->render();
}
+# called if a unit in an existing item row is changed
sub action_unit_changed {
my ($self) = @_;
$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();
}
+# add an item row for a new item entered in the input row
sub action_add_item {
my ($self) = @_;
return unless $form_attr->{parts_id};
my $item = _new_item($self->order, $form_attr);
+
$self->order->add_items($item);
$self->_recalc();
);
$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')
$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;
}
}
+# add item rows for multiple items at once
sub action_add_multi_items {
my ($self) = @_;
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);
$self->js->render();
}
+# recalculate all linetotals, amounts and taxes and redisplay them
sub action_recalc_amounts_and_taxes {
my ($self) = @_;
$self->_recalc();
- $self->_js_redisplay_linetotals;
+ $self->_js_redisplay_line_values;
$self->_js_redisplay_amounts_and_taxes;
$self->js->render();
}
+# redisplay item rows if they are sorted by an attribute
sub action_reorder_items {
my ($self) = @_;
->render;
}
+# show the popup to choose a price/discount source
sub action_price_popup {
my ($self) = @_;
$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;
$_[0]->render(\ $longdescription, { type => 'text' });
}
+# 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_linetotals {
+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 {
$_[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],
$::auth->assert($right);
}
+# build the selection box for contacts
+#
+# Needed, if customer/vendor changed.
sub build_contact_select {
my ($self) = @_;
);
}
+# build the selection box for shiptos
+#
+# Needed, if customer/vendor changed.
sub build_shipto_select {
my ($self) = @_;
);
}
+# build the rows for displaying taxes
+#
+# Called if amounts where recalculated and redisplayed.
sub build_tax_rows {
my ($self) = @_;
$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) = @_;
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 {
$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 item
sub _new_item {
my ($record, $attr) = @_;
$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 {
$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
return $item;
}
+# recalculate prices and taxes
+#
+# Using the PriceTaxCalculator. Store linetotals in the item objects.
sub _recalc {
my ($self) = @_;
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) = @_;
}
}
-
+# 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;
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;
$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;
type => $self->type,
number => $self->order->ordnumber,
);
- my $webdav_path = $webdav->webdav_path;
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);
+ $self->_setup_edit_action_bar;
+}
+
+sub _setup_edit_action_bar {
+ my ($self, %params) = @_;
+
+ my $deletion_allowed = (($self->cv eq 'customer') && $::instance_conf->get_sales_order_show_delete)
+ || (($self->cv eq 'vendor') && $::instance_conf->get_purchase_order_show_delete);
+
+ for my $bar ($::request->layout->get('actionbar')) {
+ $bar->add(
+ combobox => [
+ action => [
+ t8('Save'),
+ call => [ 'kivi.Order.save', $::instance_conf->get_order_warn_duplicate_parts ],
+ accesskey => 'enter',
+ ],
+ action => [
+ t8('Save and Delivery Order'),
+ call => [ 'kivi.Order.save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts ],
+ ],
+
+ ], # end of combobox "Save"
+
+ combobox => [
+ action => [
+ t8('Export'),
+ ],
+ action => [
+ t8('Print'),
+ call => [ 'kivi.Order.show_print_options' ],
+ ],
+ action => [
+ t8('E-mail'),
+ call => [ 'kivi.Order.email' ],
+ ],
+ action => [
+ t8('Download attachments of all parts'),
+ call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
+ disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
+ only_if => $::instance_conf->get_doc_storage,
+ ],
+ ], # end of combobox "Export"
+
+ action => [
+ t8('Delete'),
+ call => [ 'kivi.Order.delete_order' ],
+ confirm => $::locale->text('Do you really want to delete this object?'),
+ disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
+ only_if => $deletion_allowed,
+ ],
+ );
+ }
}
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(
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
+=head1 CODE
-=item *
+=head2 Layout
+
+=over 4
+
+=item * C<SL/Controller/Order.pm>
+
+the controller
+
+=item * C<template/webpages/order/form.html>
+
+main form
+
+=item * C<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 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
+
+=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 * select units in input row?
+
+=item * custom shipto address
-custom shipto address
+=item * periodic invoices
+=item * language / part translations
+
+=item * access rights
+
+=item * preset salesman from customer
+
+=item * display weights
+
+=item * history
+
+=item * mtime check
+
+=item * optional client/user behaviour
+
+(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 *
-periodic invoices
+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 *
-more details on second row (marge, ...)
+Inline creation of parts is not currently supported
+=item *
+
+Table header is not sticky in the scrolling area.
=item *
-language / part translations
+Sorting does not include C<position>, neither does reordering.
+This behavior was implemented intentionally. But we can discuss, which behavior
+should be implemented.
=item *
-access rights
+C<show_multi_items_dialog> does not use the currently inserted string for
+filtering.
+
+=back
+
+=head1 To discuss / Nice to have
+=over 4
=item *
-preset salesman from customer
+How to expand/collapse second row. Now it can be done clicking the icon or
+<shift>-up/down.
+=item *
+
+Possibility to change longdescription in input row?
=item *
-display weights
+Possibility to select PriceSources in input row?
+=item *
+
+This controller uses a (changed) copy of the template for the PriceSource
+dialog. Maybe there could be used one code source.
=item *
-force project if enabled in client config
+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 *
+
+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
projects / kivitendo-erp.git / blobdiff