SEPA-Export rückgängig machen
[kivitendo-erp.git] / bin / mozilla / sepa.pl
index ac018e2..36f2ff4 100755 (executable)
@@ -4,12 +4,13 @@ use List::MoreUtils qw(any none uniq);
 use List::Util qw(sum first);
 use POSIX qw(strftime);
 
-use Data::Dumper;
 use SL::DB::BankAccount;
+use SL::DB::SepaExport;
 use SL::Chart;
 use SL::CT;
 use SL::Form;
 use SL::GenericTranslations;
+use SL::Locale::String qw(t8);
 use SL::ReportGenerator;
 use SL::SEPA;
 use SL::SEPA::XML;
@@ -23,6 +24,7 @@ sub bank_transfer_add {
   my $form          = $main::form;
   my $locale        = $main::locale;
   my $vc            = $form->{vc} eq 'customer' ? 'customer' : 'vendor';
+  my $vc_no         = $form->{vc} eq 'customer' ? $::locale->text('VN') : $::locale->text('CN');
 
   $form->{title}    = $vc eq 'customer' ? $::locale->text('Prepare bank collection via SEPA XML') : $locale->text('Prepare bank transfer via SEPA XML');
 
@@ -55,8 +57,17 @@ sub bank_transfer_add {
     my $prefix                    = $translations{ $invoice->{language_id} } || $translations{default} || $::locale->text('Invoice');
     $prefix                      .= ' ' unless $prefix =~ m/ $/;
     $invoice->{reference_prefix}  = $prefix;
+
+    # add c_vendor_id or v_vendor_id as a prefix if a entry exists
+    next unless $invoice->{vc_vc_id};
+
+    my $prefix_vc_number             = $translations{ $invoice->{language_id} } || $translations{default} || $vc_no;
+    $prefix_vc_number               .= ' ' unless $prefix_vc_number =~ m/ $/;
+    $invoice->{reference_prefix_vc}  = ' '  . $prefix_vc_number unless $prefix_vc_number =~ m/^ /;
   }
 
+  setup_sepa_add_transfer_action_bar();
+
   $form->header();
   print $form->parse_html_template('sepa/bank_transfer_add',
                                    { 'INVOICES'           => $invoices,
@@ -95,10 +106,11 @@ sub bank_transfer_create {
   # all the information from retrieve_open_invoices is then ADDED to what was passed via @{ $form->{bank_transfers} }
   # parse amount from the entry in the form, but take skonto_amount from PT again
   # the map inserts the values of invoice_map directly into the array of hashes
+  my %selected_ids   = map { ($_ => 1) } @{ $form->{ids} || [] };
   my %invoices_map   = map { $_->{id} => $_ } @{ $invoices };
   my @bank_transfers =
     map  +{ %{ $invoices_map{ $_->{$arap_id} } }, %{ $_ } },
-    grep  { $_->{selected} && (0 < $_->{amount}) && $invoices_map{ $_->{$arap_id} } }
+    grep  { ($_->{selected} || $selected_ids{$_->{$arap_id}}) && (0 < $_->{amount}) && $invoices_map{ $_->{$arap_id} } }
     map   { $_->{amount} = $form->parse_amount($myconfig, $_->{amount}); $_ }
           @{ $form->{bank_transfers} || [] };
 
@@ -143,6 +155,8 @@ sub bank_transfer_create {
                                                    'id' => \@vc_ids);
     my @vc_bank_info           = sort { lc $a->{name} cmp lc $b->{name} } values %{ $vc_bank_info };
 
+    setup_sepa_create_transfer_action_bar(is_vendor => $vc eq 'vendor');
+
     $form->header();
     print $form->parse_html_template('sepa/bank_transfer_create',
                                      { 'BANK_TRANSFERS'     => \@bank_transfers,
@@ -184,6 +198,8 @@ sub bank_transfer_search {
 
   $form->{title}    = $vc eq 'customer' ? $::locale->text('List of bank collections') : $locale->text('List of bank transfers');
 
+  setup_sepa_search_transfer_action_bar();
+
   $form->header();
   print $form->parse_html_template('sepa/bank_transfer_search', { vc => $vc });
 
@@ -208,7 +224,7 @@ sub bank_transfer_list {
 
   my %filter         = map  +( $_ => $form->{"f_${_}"} ),
                        grep  { $form->{"f_${_}"} }
-                             (qw(vc invnumber),
+                             (qw(vc invnumber message_id),
                               map { ("${_}_date_from", "${_}_date_to") }
                                   qw(export requested_execution execution));
   $filter{executed}  = $form->{l_executed} ? 1 : 0 if ($form->{l_executed} != $form->{l_not_executed});
@@ -236,9 +252,10 @@ sub bank_transfer_list {
     'closed'      => { 'text' => $locale->text('Closed'), },
     num_invoices  => { 'text' => $locale->text('Number of invoices'), },
     sum_amounts   => { 'text' => $locale->text('Sum of all amounts'), },
+    message_ids   => { 'text' => $locale->text('SEPA message IDs'), },
   );
 
-  my @columns = qw(selected id export_date employee executed closed invoices netamount);
+  my @columns = qw(selected id export_date employee executed closed num_invoices sum_amounts message_ids);
   my %column_alignment = map { ($_ => 'right') } qw(num_invoices sum_amounts);
 
   foreach my $name (qw(id export_date employee executed closed)) {
@@ -254,6 +271,7 @@ sub bank_transfer_list {
   my @options = ();
   push @options, ($vc eq 'customer' ? $::locale->text('Customer') : $locale->text('Vendor')) . ' : ' . $form->{f_vc} if ($form->{f_vc});
   push @options, $locale->text('Invoice number')                . ' : ' . $form->{f_invnumber}                     if ($form->{f_invnumber});
+  push @options, $locale->text('SEPA message ID')               . ' : ' . $form->{f_message_id}                    if (length $form->{f_message_id});
   push @options, $locale->text('Export date from')              . ' : ' . $form->{f_export_date_from}              if ($form->{f_export_date_from});
   push @options, $locale->text('Export date to')                . ' : ' . $form->{f_export_date_to}                if ($form->{f_export_date_to});
   push @options, $locale->text('Requested execution date from') . ' : ' . $form->{f_requested_execution_date_from} if ($form->{f_requested_execution_date_from});
@@ -291,14 +309,14 @@ sub bank_transfer_list {
     $row->{$_}->{data} = $::form->format_amount(\%::myconfig, $row->{$_}->{data}, 2) for qw(sum_amounts);
 
     if (!$export->{closed}) {
-      $row->{selected}->{raw_data} =
-          $cgi->hidden(-name => "exports[+].id", -value => $export->{id})
-        . $cgi->checkbox(-name => "exports[].selected", -value => 1, -label => '');
+      $row->{selected}->{raw_data} = $cgi->checkbox(-name => "ids[]", -value => $export->{id}, -label => '');
     }
 
     $report->add_data($row);
   }
 
+  setup_sepa_list_transfers_action_bar(show_buttons => $open_available, is_vendor => $vc eq 'vendor');
+
   $report->generate_with_headers();
 
   $main::lxdebug->leave_sub();
@@ -315,10 +333,10 @@ sub bank_transfer_edit {
   if (!$form->{mode} || ($form->{mode} eq 'single')) {
     push @ids, $form->{id};
   } else {
-    @ids = map $_->{id}, grep { $_->{selected} } @{ $form->{exports} || [] };
+    @ids = @{ $form->{ids} || [] };
 
     if (!@ids) {
-      $form->show_generic_error($locale->text('You have not selected any export.'), 'back_button' => 1);
+      $form->show_generic_error($locale->text('You have not selected any export.'));
     }
   }
 
@@ -342,20 +360,28 @@ sub bank_transfer_edit {
     $export->{items} = [ grep { !$_->{export_closed} && !$_->{executed} } @{ $export->{items} } ];
 
     if (!@{ $export->{items} }) {
-      $form->show_generic_error($locale->text('All the selected exports have already been closed, or all of their items have already been executed.'), 'back_button' => 1);
+      $form->show_generic_error($locale->text('All the selected exports have already been closed, or all of their items have already been executed.'));
     }
 
   } elsif (!$export) {
     $form->error($locale->text('That export does not exist.'));
   }
 
+  my $show_post_payments_button = any { !$_->{export_closed} && !$_->{executed} } @{ $export->{items} };
+  my $has_executed              = any { $_->{executed}                          } @{ $export->{items} };
+
+  setup_sepa_edit_transfer_action_bar(
+    show_post_payments_button => $show_post_payments_button,
+    has_executed              => $has_executed,
+  );
+
   $form->{title}    = $locale->text('View SEPA export');
   $form->header();
   print $form->parse_html_template('sepa/bank_transfer_edit',
-                                   { 'ids'                       => \@ids,
-                                     'export'                    => $export,
-                                     'current_date'              => $form->current_date(\%main::myconfig),
-                                     'show_post_payments_button' => any { !$_->{export_closed} && !$_->{executed} } @{ $export->{items} },
+                                   { ids                       => \@ids,
+                                     export                    => $export,
+                                     current_date              => $form->current_date(\%main::myconfig),
+                                     show_post_payments_button => $show_post_payments_button,
                                    });
 
   $main::lxdebug->leave_sub();
@@ -368,10 +394,11 @@ sub bank_transfer_post_payments {
   my $locale = $main::locale;
   my $vc     = $form->{vc} eq 'customer' ? 'customer' : 'vendor';
 
-  my @items  = grep { $_->{selected} } @{ $form->{items} || [] };
+  my %selected = map { ($_ => 1) } @{ $form->{ids} || [] };
+  my @items    = grep { $selected{$_->{id}} } @{ $form->{items} || [] };
 
   if (!@items) {
-    $form->show_generic_error($locale->text('You have not selected any item.'), 'back_button' => 1);
+    $form->show_generic_error($locale->text('You have not selected any item.'));
   }
   my @export_ids    = uniq map { $_->{sepa_export_id} } @items;
   my %exports       = map { $_ => SL::SEPA->retrieve_export('id' => $_, 'details' => 1, vc => $vc) } @export_ids;
@@ -385,11 +412,11 @@ sub bank_transfer_post_payments {
   }
 
   if (!@items_to_post) {
-    $form->show_generic_error($locale->text('All the selected exports have already been closed, or all of their items have already been executed.'), 'back_button' => 1);
+    $form->show_generic_error($locale->text('All the selected exports have already been closed, or all of their items have already been executed.'));
   }
 
   if (any { !$_->{execution_date} } @items_to_post) {
-    $form->show_generic_error($locale->text('You have to specify an execution date for each antry.'), 'back_button' => 1);
+    $form->show_generic_error($locale->text('You have to specify an execution date for each antry.'));
   }
 
   SL::SEPA->post_payment('items' => \@items_to_post, vc => $vc);
@@ -407,20 +434,20 @@ sub bank_transfer_payment_list_as_pdf {
   my $locale     = $main::locale;
   my $vc         = $form->{vc} eq 'customer' ? 'customer' : 'vendor';
 
-  my @ids        = @{ $form->{items} || [] };
-  my @export_ids = uniq map { $_->{export_id} } @ids;
+  my @ids        = @{ $form->{ids} || [] };
+  my @export_ids = uniq map { $_->{sepa_export_id} } @{ $form->{items} || [] };
 
-  $form->show_generic_error($locale->text('Multi mode not supported.'), 'back_button' => 1) if 1 != scalar @export_ids;
+  $form->show_generic_error($locale->text('Multi mode not supported.')) if 1 != scalar @export_ids;
 
   my $export = SL::SEPA->retrieve_export('id' => $export_ids[0], 'details' => 1, vc => $vc);
   my @items  = ();
 
   foreach my $id (@ids) {
-    my $item = first { $_->{id} == $id->{id} } @{ $export->{items} };
+    my $item = first { $_->{id} == $id } @{ $export->{items} };
     push @items, $item if $item;
   }
 
-  $form->show_generic_error($locale->text('No transfers were executed in this export.'), 'back_button' => 1) if 1 > scalar @items;
+  $form->show_generic_error($locale->text('No transfers were executed in this export.')) if 1 > scalar @items;
 
   my $report         =  SL::ReportGenerator->new(\%main::myconfig, $form);
 
@@ -473,23 +500,23 @@ sub bank_transfer_download_sepa_xml {
   my $defaults = SL::DB::Default->get;
 
   if (!$defaults->company) {
-    $form->show_generic_error($locale->text('You have to enter a company name in the client configuration.'), 'back_button' => 1);
+    $form->show_generic_error($locale->text('You have to enter a company name in the client configuration.'));
   }
 
   if (($vc eq 'customer') && !$defaults->sepa_creditor_id) {
-    $form->show_generic_error($locale->text('You have to enter the SEPA creditor ID in the client configuration.'), 'back_button' => 1);
+    $form->show_generic_error($locale->text('You have to enter the SEPA creditor ID in the client configuration.'));
   }
 
   my @ids;
   if ($form->{mode} && ($form->{mode} eq 'multi')) {
-     @ids = map $_->{id}, grep { $_->{selected} } @{ $form->{exports} || [] };
+     @ids = @{ $form->{ids} || [] };
 
   } else {
     @ids = ($form->{id});
   }
 
   if (!@ids) {
-    $form->show_generic_error($locale->text('You have not selected any export.'), 'back_button' => 1);
+    $form->show_generic_error($locale->text('You have not selected any export.'));
   }
 
   my @items = ();
@@ -500,7 +527,7 @@ sub bank_transfer_download_sepa_xml {
   }
 
   if (!@items) {
-    $form->show_generic_error($locale->text('All the selected exports have already been closed, or all of their items have already been executed.'), 'back_button' => 1);
+    $form->show_generic_error($locale->text('All the selected exports have already been closed, or all of their items have already been executed.'));
   }
 
   my $message_id = strftime('MSG%Y%m%d%H%M%S', localtime) . sprintf('%06d', $$);
@@ -546,6 +573,15 @@ sub bank_transfer_download_sepa_xml {
                                  'date_of_signature' => $item->{mandate_date_of_signature}, });
   }
 
+  # Store the message ID used in each of the entries in order to
+  # facilitate finding them by looking at bank statements.
+  foreach my $id (@ids) {
+    SL::DB::SepaExportMessageId->new(
+      sepa_export_id => $id,
+      message_id     => $message_id,
+    )->save;
+  }
+
   my $xml = $sepa_xml->to_xml();
 
   print $cgi->header('-type'                => 'application/octet-stream',
@@ -556,47 +592,32 @@ sub bank_transfer_download_sepa_xml {
   $main::lxdebug->leave_sub();
 }
 
-sub bank_transfer_mark_as_closed_step1 {
+sub bank_transfer_mark_as_closed {
   $main::lxdebug->enter_sub();
 
   my $form       = $main::form;
   my $locale     = $main::locale;
-  my $vc         = $form->{vc} eq 'customer' ? 'customer' : 'vendor';
-
-  my @export_ids = map { $_->{id} } grep { $_->{selected} } @{ $form->{exports} || [] };
 
-  if (!@export_ids) {
-    $form->show_generic_error($locale->text('You have not selected any export.'), 'back_button' => 1);
-  }
-
-  my @open_export_ids = ();
-  foreach my $id (@export_ids) {
-    my $export = SL::SEPA->retrieve_export('id' => $id, vc => $vc);
-    push @open_export_ids, $id if (!$export->{closed});
-  }
-
-  if (!@open_export_ids) {
-    $form->show_generic_error($locale->text('All of the exports you have selected were already closed.'), 'back_button' => 1);
-  }
+  map { SL::SEPA->close_export('id' => $_); } @{ $form->{ids} || [] };
 
   $form->{title} = $locale->text('Close SEPA exports');
   $form->header();
-  print $form->parse_html_template('sepa/bank_transfer_mark_as_closed_step1', { 'OPEN_EXPORT_IDS' => \@open_export_ids, vc => $vc });
+  $form->show_generic_information($locale->text('The selected exports have been closed.'));
 
   $main::lxdebug->leave_sub();
 }
 
-sub bank_transfer_mark_as_closed_step2 {
+sub bank_transfer_undo_sepa_xml {
   $main::lxdebug->enter_sub();
 
   my $form       = $main::form;
   my $locale     = $main::locale;
 
-  map { SL::SEPA->close_export('id' => $_); } @{ $form->{open_export_ids} || [] };
+  map { SL::SEPA->undo_export('id' => $_); } @{ $form->{ids} || [] };
 
-  $form->{title} = $locale->text('Close SEPA exports');
+  $form->{title} = $locale->text('Undo SEPA exports');
   $form->header();
-  $form->show_generic_information($locale->text('The selected exports have been closed.'));
+  $form->show_generic_information($locale->text('The selected exports have been undone.'));
 
   $main::lxdebug->leave_sub();
 }
@@ -607,7 +628,7 @@ sub dispatcher {
   foreach my $action (qw(bank_transfer_create bank_transfer_edit bank_transfer_list
                          bank_transfer_post_payments bank_transfer_download_sepa_xml
                          bank_transfer_mark_as_closed_step1 bank_transfer_mark_as_closed_step2
-                         bank_transfer_payment_list_as_pdf)) {
+                         bank_transfer_payment_list_as_pdf bank_transfer_undo_sepa_xml)) {
     if ($form->{"action_${action}"}) {
       call_sub($action);
       return;
@@ -617,4 +638,114 @@ sub dispatcher {
   $form->error($main::locale->text('No action defined.'));
 }
 
+sub setup_sepa_add_transfer_action_bar {
+  my (%params) = @_;
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      action => [
+        t8('Step 2'),
+        submit    => [ '#form', { action => "bank_transfer_create" } ],
+        accesskey => 'enter',
+        checks    => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
+      ],
+    );
+  }
+}
+
+sub setup_sepa_create_transfer_action_bar {
+  my (%params) = @_;
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      action => [
+        t8('Create'),
+        submit    => [ '#form', { action => "bank_transfer_create" } ],
+        accesskey => 'enter',
+        tooltip   => $params{is_vendor} ? t8('Create bank transfer') : t8('Create bank collection'),
+      ],
+      action => [
+        t8('Back'),
+        call => [ 'kivi.history_back' ],
+      ],
+    );
+  }
+}
+
+sub setup_sepa_search_transfer_action_bar {
+  my (%params) = @_;
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      action => [
+        t8('Search'),
+        submit    => [ '#form', { action => 'bank_transfer_list' } ],
+        accesskey => 'enter',
+      ],
+    );
+  }
+}
+
+sub setup_sepa_list_transfers_action_bar {
+  my (%params) = @_;
+
+  return unless $params{show_buttons};
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      combobox => [
+        action => [ t8('Actions') ],
+        action => [
+          t8('SEPA XML download'),
+          submit => [ '#form', { action => 'bank_transfer_download_sepa_xml' } ],
+          checks => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
+        ],
+        action => [
+          t8('Post payments'),
+          submit => [ '#form', { action => 'bank_transfer_edit' } ],
+          checks => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
+        ],
+        action => [
+          t8('Mark as closed'),
+          submit => [ '#form', { action => 'bank_transfer_mark_as_closed' } ],
+          checks => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
+          confirm => [ $params{is_vendor} ? t8('Do you really want to close the selected SEPA exports? No payment will be recorded for bank transfers that haven\'t been marked as executed yet.')
+                                          : t8('Do you really want to close the selected SEPA exports? No payment will be recorded for bank collections that haven\'t been marked as executed yet.') ],
+        ],
+        action => [
+          t8('Undo SEPA exports'),
+          submit => [ '#form', { action => 'bank_transfer_undo_sepa_xml' } ],
+          checks => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
+          confirm => [ t8('Do you really want to undo the selected SEPA exports? You have to reassign the export again.') ],
+        ],
+      ], # end of combobox "Actions"
+    );
+  }
+}
+
+sub setup_sepa_edit_transfer_action_bar {
+  my (%params) = @_;
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      action => [
+        t8('Post'),
+        submit    => [ '#form', { action => 'bank_transfer_post_payments' } ],
+        accesskey => 'enter',
+        tooltip   => t8('Post payments for selected invoices'),
+        checks    => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
+        only_if   => $params{show_post_payments_button},
+      ],
+      action => [
+        t8('Payment list'),
+        submit    => [ '#form', { action => 'bank_transfer_payment_list_as_pdf' } ],
+        accesskey => 'enter',
+        tooltip   => t8('Download list of payments as PDF'),
+        checks    => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
+        not_if    => $params{show_post_payments_button},
+      ],
+    );
+  }
+}
+
 1;