1 #=====================================================================
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
7 #=====================================================================
8 # SQL-Ledger Accounting
9 # Copyright (c) 1998-2002
11 # Author: Dieter Simader
12 # Email: dsimader@sql-ledger.org
13 # Web: http://www.sql-ledger.org
16 # This program is free software; you can redistribute it and/or modify
17 # it under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 2 of the License, or
19 # (at your option) any later version.
21 # This program is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software
27 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
29 #======================================================================
31 # Dunning process module
33 #======================================================================
35 use POSIX qw(strftime);
37 use List::Util qw(notall);
38 use List::MoreUtils qw(none);
42 use SL::DB::Department;
45 use SL::Helper::Flash qw(flash);
46 use SL::Locale::String qw(t8);
47 use SL::Presenter::FileObject;
48 use SL::Presenter::WebdavObject;
49 use SL::ReportGenerator;
51 require "bin/mozilla/common.pl";
52 require "bin/mozilla/reportgenerator.pl";
53 require "bin/mozilla/io.pl";
60 $main::lxdebug->enter_sub();
62 my $form = $main::form;
63 my %myconfig = %main::myconfig;
64 my $locale = $main::locale;
66 $main::auth->assert('config');
68 DN->get_config(\%myconfig, \%$form);
69 $form->get_lists('charts' => { 'key' => 'ALL_CHARTS',
70 'transdate' => 'current_date' });
72 $form->{SELECT_AR_AMOUNT} = [];
73 $form->{SELECT_AR} = [];
75 foreach my $chart (@{ $form->{ALL_CHARTS} }) {
76 $chart->{LINKS} = { map { $_, 1 } split m/:/, $chart->{link} };
78 if ($chart->{LINKS}->{AR}) {
79 $chart->{AR_selected} = "selected" if $chart->{id} == $form->{AR};
80 push @{ $form->{SELECT_AR} }, $chart;
83 if ($chart->{LINKS}->{AR_amount}) {
84 $chart->{AR_amount_fee_selected} = "selected" if $chart->{id} == $form->{AR_amount_fee};
85 $chart->{AR_amount_interest_selected} = "selected" if $chart->{id} == $form->{AR_amount_interest};
86 push @{ $form->{SELECT_AR_AMOUNT} }, $chart;
90 $form->{title} = $locale->text('Edit Dunning Process Config');
91 $form->{callback} ||= build_std_url("action=edit_config");
93 setup_dn_edit_config_action_bar();
96 print $form->parse_html_template("dunning/edit_config");
98 $main::lxdebug->leave_sub();
102 $main::lxdebug->enter_sub();
104 my $form = $main::form;
105 my %myconfig = %main::myconfig;
106 my $locale = $main::locale;
108 $main::auth->assert('dunning_edit');
110 DN->get_config(\%myconfig, \%$form);
112 $form->get_lists("departments" => "ALL_DEPARTMENTS");
114 $form->{SHOW_DUNNING_LEVEL_SELECTION} = $form->{DUNNING} && scalar @{ $form->{DUNNING} };
115 $form->{SHOW_DEPARTMENT_SELECTION} = $form->{ALL_DEPARTMENTS} && scalar @{ $form->{ALL_DEPARTMENTS} || [] };
117 $form->{title} = $locale->text('Start Dunning Process');
119 setup_dn_add_action_bar();
122 print $form->parse_html_template("dunning/add");
124 $main::lxdebug->leave_sub();
128 $main::lxdebug->enter_sub();
130 my $form = $main::form;
131 my %myconfig = %main::myconfig;
132 my $locale = $main::locale;
134 $main::auth->assert('dunning_edit');
136 DN->get_invoices(\%myconfig, \%$form);
137 $form->{title} = $locale->text('Start Dunning Process');
139 foreach my $row (@{ $form->{DUNNINGS} }) {
140 $row->{DUNNING_CONFIG} = [ map +{ %{ $_ } }, @{ $form->{DUNNING_CONFIG} } ];
142 if ($row->{next_dunning_config_id}) {
143 map { $_->{SELECTED} = $_->{id} == $row->{next_dunning_config_id} } @{ $row->{DUNNING_CONFIG } };
145 map { $row->{$_} = $form->format_amount(\%myconfig, $row->{$_} * 1, 2) } qw(amount open_amount fee interest);
147 if ($row->{'language_id'}) {
148 $row->{language} = SL::DB::Manager::Language->find_by_or_create('id' => $row->{'language_id'})->{'description'};
152 $form->get_lists('printers' => 'printers',
153 'languages' => 'languages');
155 $form->{type} = 'dunning';
156 $form->{rowcount} = scalar @{ $form->{DUNNINGS} };
157 $form->{callback} ||= build_std_url("action=show_invoices", qw(customer invnumber ordnumber groupinvoices minamount dunning_level notes));
159 $form->{PRINT_OPTIONS} = print_options('inline' => 1,
161 'no_postscript' => 1,
163 'no_opendocument' => 1,);
165 setup_dn_show_invoices_action_bar();
167 print $form->parse_html_template("dunning/show_invoices");
169 $main::lxdebug->leave_sub();
173 $main::lxdebug->enter_sub();
175 my $form = $main::form;
176 my %myconfig = %main::myconfig;
177 my $locale = $main::locale;
179 $main::auth->assert('config');
181 for my $i (1 .. $form->{rowcount}) {
182 if ($form->{"dunning_description_$i"} ne "") {
183 $form->isblank("dunning_level_$i", $locale->text('Dunning Level missing in row '). $i);
184 $form->isblank("dunning_description_$i", $locale->text('Dunning Description missing in row '). $i);
185 $form->isblank("terms_$i", $locale->text('Terms missing in row '). $i);
186 $form->isblank("payment_terms_$i", $locale->text('Payment Terms missing in row '). $i);
190 DN->save_config(\%myconfig, \%$form);
192 if(!exists $form->{addition} && $form->{id} ne "") {
193 $form->{snumbers} = qq|dunning_id_| . $form->{"dunning_id"};
194 $form->{addition} = "SAVED FOR DUNNING";
197 # /saving the history
198 $form->redirect($locale->text('Dunning Process Config saved!'));
200 $main::lxdebug->leave_sub();
204 $main::lxdebug->enter_sub();
206 my $form = $main::form;
207 my %myconfig = %main::myconfig;
208 my $locale = $main::locale;
210 $main::auth->assert('dunning_edit');
215 undef($form->{DUNNING_PDFS});
217 my $saved_language_id = $form->{language_id};
219 if ($form->{groupinvoices} || $form->{l_include_credit_notes}) {
222 for my $i (1 .. $form->{rowcount}) {
223 next unless ($form->{"active_$i"});
225 $dunnings_for{$form->{"customer_id_$i"}} ||= {};
226 my $dunning_levels = $dunnings_for{$form->{"customer_id_$i"}};
228 $dunning_levels->{$form->{"next_dunning_config_id_$i"}} ||= [];
229 my $level = $dunning_levels->{$form->{"next_dunning_config_id_$i"}};
231 push @{ $level }, { "row" => $i,
232 "invoice_id" => $form->{"inv_id_$i"},
233 "credit_note" => $form->{"credit_note_$i"},
234 "customer_id" => $form->{"customer_id_$i"},
235 "language_id" => $form->{"language_id_$i"},
236 "next_dunning_config_id" => $form->{"next_dunning_config_id_$i"},
237 "print_invoice" => $form->{"include_invoice_$i"},
238 "email" => $form->{"email_$i"}, };
241 foreach my $levels (values %dunnings_for) {
242 foreach my $level (values %{ $levels }) {
243 next unless scalar @{ $level };
244 if (!$form->{force_lang}) {
245 $form->{language_id} = @{$level}[0]->{language_id};
247 my $rc = DN->save_dunning(\%myconfig, $form, $level);
248 $rc->{error} =~ s{\n}{<br />}g if $rc->{error};
249 push @status, { invnumbers => [map { $form->{'invnumber_' . $_->{row}} } @$level],
250 map { ( $_ => $rc->{$_} ) } qw(error dunning_id print_original_invoice send_email), };
255 for my $i (1 .. $form->{rowcount}) {
256 next unless $form->{"active_$i"};
258 my $level = [ { "row" => $i,
259 "invoice_id" => $form->{"inv_id_$i"},
260 "customer_id" => $form->{"customer_id_$i"},
261 "language_id" => $form->{"language_id_$i"},
262 "next_dunning_config_id" => $form->{"next_dunning_config_id_$i"},
263 "print_invoice" => $form->{"include_invoice_$i"},
264 "email" => $form->{"email_$i"}, } ];
265 if (!$form->{force_lang}) {
266 $form->{language_id} = @{$level}[0]->{language_id};
268 my $rc = DN->save_dunning(\%myconfig, $form, $level);
269 $rc->{error} =~ s{\n}{<br />}g if $rc->{error};
270 push @status, { invnumbers => [map { $form->{'invnumber_' . $_->{row}} } @$level],
271 map { ( $_ => $rc->{$_} ) } qw(error dunning_id print_original_invoice send_email), };
275 $form->{language_id} = $saved_language_id;
279 if ($form->{DUNNING_PDFS} && scalar @{ $form->{DUNNING_PDFS} }) {
280 $form->{dunning_id} = strftime("%Y%m%d", localtime time) if scalar @{ $form->{DUNNING_PDFS}} > 1;
281 ($pdf_filename, $pdf_content) = DN->melt_pdfs(\%myconfig, $form, $form->{copies}, return_content => $form->{media} ne 'printer');
283 flash('info', t8('Dunning Process started for selected invoices!'));
284 if ($form->{media} eq 'printer') {
285 flash('info', t8('The PDF has been printed'));
287 flash('info', t8('The PDF has been created'));
292 if(!exists $form->{addition} && $form->{id} ne "") {
293 $form->{snumbers} = qq|dunning_id_| . $form->{"dunning_id"};
294 $form->{addition} = "DUNNING STARTED";
297 # /saving the history
299 setup_dn_status_action_bar();
300 $form->{"title"} = $locale->text("Dunning status");
302 print $form->parse_html_template('dunning/status', {
303 pdf_filename => $pdf_filename,
304 pdf_content => $pdf_content,
305 status => \@status, });
307 $main::lxdebug->leave_sub();
311 $main::lxdebug->enter_sub();
313 my $form = $main::form;
314 my $locale = $main::locale;
316 $main::auth->assert('dunning_edit');
318 $form->{"title"} = $locale->text("Set eMail text");
319 $form->header(no_layout => 1);
320 print($form->parse_html_template("dunning/set_email"));
322 $main::lxdebug->leave_sub();
326 $main::lxdebug->enter_sub();
328 my $form = $main::form;
329 my %myconfig = %main::myconfig;
330 my $locale = $main::locale;
332 $main::auth->assert('dunning_edit');
334 $form->get_lists("customers" => "ALL_CUSTOMERS",
335 "departments" => "ALL_DEPARTMENTS");
336 $form->{ALL_EMPLOYEES} = SL::DB::Manager::Employee->get_all_sorted(query => [ deleted => 0 ]);
338 DN->get_config(\%myconfig, \%$form);
340 $form->{SHOW_DUNNING_LEVELS} = scalar @{ $form->{DUNNING} };
342 $form->{title} = $locale->text('Dunnings');
344 setup_dn_search_action_bar();
347 print $form->parse_html_template("dunning/search");
349 $main::lxdebug->leave_sub();
354 $main::lxdebug->enter_sub();
356 my $form = $main::form;
357 my %myconfig = %main::myconfig;
358 my $locale = $main::locale;
359 my $cgi = $::request->{cgi};
361 $main::auth->assert('dunning_edit');
363 my @filter_field_list = qw(customer_id customer dunning_id dunning_level department_id invnumber ordnumber
364 transdatefrom transdateto dunningfrom dunningto notes showold l_salesman salesman_id);
366 report_generator_set_default_sort('customername', 1);
368 DN->get_dunning(\%myconfig, \%$form);
370 if (!$form->{callback}) {
371 $form->{callback} = build_std_url("action=show_dunning", @filter_field_list);
374 $form->get_lists('printers' => 'printers',
375 'languages' => 'languages');
377 $form->{type} = 'dunning';
378 $form->{PRINT_OPTIONS} = print_options('inline' => 1,
380 'no_postscript' => 1,
382 'no_opendocument' => 1,);
383 $form->{title} = $locale->text('Dunning overview');
385 my $report = SL::ReportGenerator->new(\%myconfig, $form);
387 $report->set_options('std_column_visibility' => 1,
388 'title' => $form->{title});
389 $report->set_export_options('show_dunning', @filter_field_list, qw(sort sortdir));
392 'checkbox' => { 'text' => '', 'visible' => 'HTML' },
393 'dunning_description' => { 'text' => $locale->text('Dunning Level') },
394 'customername' => { 'text' => $locale->text('Customername') },
395 'departmentname' => { 'text' => $locale->text('Department') },
396 'language' => { 'text' => $locale->text('Language') },
397 'invnumber' => { 'text' => $locale->text('Invnumber') },
398 'transdate' => { 'text' => $locale->text('Invdate') },
399 'duedate' => { 'text' => $locale->text('Invoice Duedate') },
400 'amount' => { 'text' => $locale->text('Amount') },
401 'dunning_id' => { 'text' => $locale->text('Dunning number') },
402 'dunning_date' => { 'text' => $locale->text('Dunning Date') },
403 'dunning_duedate' => { 'text' => $locale->text('Dunning Duedate') },
404 'fee' => { 'text' => $locale->text('Total Fees') },
405 'interest' => { 'text' => $locale->text('Interest') },
406 'salesman' => { 'text' => $locale->text('Salesperson'), 'visible' => $form->{l_salesman} ? 1 : 0 },
407 'documents' => { 'text' => $locale->text('Documents'), 'visible' => $::instance_conf->get_doc_storage ? 1 : 0 },
408 'webdav' => { 'text' => $locale->text('WebDAV'), 'visible' => $::instance_conf->get_webdav ? 1 : 0 },
411 $report->set_columns(%column_defs);
412 $report->set_column_order(qw(checkbox dunning_description dunning_id customername language invnumber transdate
413 duedate amount dunning_date dunning_duedate fee interest salesman));
414 $report->set_sort_indicator($form->{sort}, $form->{sortdir});
416 my $edit_url = sub { build_std_url('script=' . ($_[0]->{invoice} ? 'is' : 'ar') . '.pl', 'action=edit', 'callback') . '&id=' . $::form->escape($_[0]->{id}) };
417 my $print_url = sub { build_std_url('action=print_dunning', 'format=pdf', 'media=screen', 'dunning_id='.$_[0]->{dunning_id}, 'language_id=' . $_[0]->{language_id}) };
418 my $sort_url = build_std_url('action=show_dunning', grep { $form->{$_} } @filter_field_list);
420 foreach my $name (qw(dunning_description customername invnumber transdate duedate dunning_date dunning_duedate salesman dunning_id)) {
421 my $sortdir = $form->{sort} eq $name ? 1 - $form->{sortdir} : $form->{sortdir};
422 $column_defs{$name}->{link} = $sort_url . "&sort=$name&sortdir=$sortdir";
425 my %alignment = map { $_ => 'right' } qw(transdate duedate amount dunning_date dunning_duedate fee interest salesman dunning_id);
427 my ($current_dunning_rows, $previous_dunning_id, $first_row_for_dunning);
429 $current_dunning_rows = [];
430 $first_row_for_dunning = 1;
431 $form->{rowcount} = scalar @{ $form->{DUNNINGS} };
435 foreach my $ref (@{ $form->{DUNNINGS} }) {
438 if ($previous_dunning_id != $ref->{dunning_id}) {
439 $report->add_data($current_dunning_rows) if (scalar @{ $current_dunning_rows });
440 $current_dunning_rows = [];
441 $first_row_for_dunning = 1;
444 if ($ref->{'language_id'}) {
445 $ref->{language} = SL::DB::Manager::Language->find_by('id' => $ref->{'language_id'})->{'description'};
449 foreach my $column (keys %{ $ref }) {
451 'data' => $first_row_for_dunning || (none { $_ eq $column } qw(dunning_description customername dunning_id)) ? $ref->{$column} : '',
453 'align' => $alignment{$column},
455 'link' => ( $column eq 'invnumber' ? $edit_url->($ref)
456 : $column eq 'dunning_description' ? $print_url->($ref)
457 : $column eq 'dunning_id' ? $print_url->($ref)
462 $row->{checkbox} = !$first_row_for_dunning ? { } : {
463 'raw_data' => $cgi->hidden('-name' => "dunning_id_$i", '-value' => $ref->{dunning_id})
464 . $cgi->checkbox('-name' => "selected_$i", '-value' => 1, '-label' => ''),
465 'valign' => 'center',
469 if ($first_row_for_dunning) {
470 $row->{language} = {'raw_data' => $cgi->hidden('-name' => "language_id_$i", '-value' => $ref->{language_id})
471 . " $ref->{language}" };
473 $row->{language} = { };
476 if ($::instance_conf->get_doc_storage && $first_row_for_dunning) {
477 my @files = SL::File->get_all_versions(object_id => $ref->{dunning_id},
478 object_type => 'dunning',
479 file_type => 'document',);
481 my $html = join '<br>', map { SL::Presenter::FileObject::file_object($_) } @files;
482 my $text = join "\n", map { $_->file_name } @files;
483 $row->{documents} = { 'raw_data' => $html, data => $text };
485 $row->{documents} = { };
488 if ($::instance_conf->get_webdav && $first_row_for_dunning) {
489 my $webdav = SL::Webdav->new(
491 number => $ref->{dunning_id},
493 my @all_objects = $webdav->get_all_objects;
494 if (scalar @all_objects) {
495 my $html = join '<br>', map { SL::Presenter::WebdavObject::webdav_object($_) } @all_objects;
496 my $text = join "\n", map { $_->filename } @all_objects;
497 $row->{webdav} = { 'raw_data' => $html, data => $text };
499 $row->{webdav} = { };
503 push @{ $current_dunning_rows }, $row;
505 $previous_dunning_id = $ref->{dunning_id};
506 $first_row_for_dunning = 0;
509 $report->add_data($current_dunning_rows) if (scalar @{ $current_dunning_rows });
511 $report->set_options('raw_top_info_text' => $form->parse_html_template('dunning/show_dunning_top'),
512 'raw_bottom_info_text' => $form->parse_html_template('dunning/show_dunning_bottom'),
513 'output_format' => 'HTML',
514 'attachment_basename' => $locale->text('dunning_list') . strftime('_%Y%m%d', localtime time),
517 $report->set_options_from_form();
519 setup_dn_show_dunning_action_bar();
520 $report->generate_with_headers();
522 $main::lxdebug->leave_sub();
527 $main::lxdebug->enter_sub();
529 my $form = $main::form;
531 $main::auth->assert('dunning_edit');
533 $form->{rowcount} = 1;
534 $form->{selected_1} = 1;
535 $form->{dunning_id_1} = $form->{dunning_id};
536 $form->{language_id_1} = $form->{language_id};
540 $main::lxdebug->leave_sub();
544 $main::auth->assert('dunning_edit');
546 my @dunning_ids = map { $::form->{"dunning_id_$_"} } grep { $::form->{"selected_$_"} } (1..$::form->{rowcount});
548 if (!scalar @dunning_ids) {
549 $::form->error($::locale->text('No dunnings have been selected for printing.'));
552 my $dunnings = SL::DB::Manager::Dunning->get_all(query => [ dunning_id => \@dunning_ids ]);
554 SL::DB::Dunning->new->db->with_transaction(sub {
555 for my $dunning (@$dunnings) {
556 SL::DB::Manager::Invoice->find_by(id => $dunning->trans_id)->update_attributes(dunning_config_id => undef);
561 flash('info', t8('#1 dunnings have been deleted', scalar @$dunnings));
567 $main::lxdebug->enter_sub();
569 my $form = $main::form;
570 my %myconfig = %main::myconfig;
571 my $locale = $main::locale;
573 $main::auth->assert('dunning_edit');
575 $form->{title} = $locale->text('Print dunnings');
577 my @dunning_ids = map { $form->{"dunning_id_$_"} } grep { $form->{"selected_$_"} } (1..$form->{rowcount});
578 my @language_ids = map { $form->{"language_id_$_"} } grep { $form->{"selected_$_"} } (1..$form->{rowcount});
580 if (!scalar @dunning_ids) {
581 $form->error($locale->text('No dunnings have been selected for printing.'));
584 $form->{DUNNING_PDFS} = [];
586 my $saved_language_id = $form->{language_id};
588 foreach my $dunning_id (@dunning_ids) {
589 if (!$form->{force_lang}) {
590 $form->{language_id} = $language_ids[$i];
592 $form->{dunning_id} = $dunning_id;
593 DN->print_invoice_for_fees(\%myconfig, $form, $dunning_id);
594 DN->print_dunning(\%myconfig, $form, $dunning_id);
596 # print original dunned invoices, if they where printed on dunning run
597 my $dunnings = SL::DB::Manager::Dunning->get_all(where => [dunning_id => $dunning_id, original_invoice_printed => 1]);
598 DN->print_original_invoice(\%myconfig, $form, $dunning_id, $_->trans_id) for @$dunnings;
602 $form->{language_id} = $saved_language_id;
604 if (scalar @{ $form->{DUNNING_PDFS} }) {
605 $form->{dunning_id} = strftime("%Y%m%d", localtime time) if scalar @{ $form->{DUNNING_PDFS}} > 1;
606 DN->melt_pdfs(\%myconfig, $form, $form->{copies});
608 if ($form->{media} eq 'printer') {
610 $form->info($locale->text('The dunnings have been printed.'));
614 $form->redirect($locale->text('Could not print dunning.'));
617 $main::lxdebug->leave_sub();
621 call_sub($main::form->{nextsub});
625 foreach my $action (qw(delete print_multiple)) {
626 if ($::form->{"action_${action}"}) {
632 $::form->error($::locale->text('No action defined.'));
635 sub setup_dn_add_action_bar {
638 for my $bar ($::request->layout->get('actionbar')) {
642 submit => [ '#form', { action => "show_invoices" } ],
643 accesskey => 'enter',
649 sub setup_dn_show_invoices_action_bar {
652 for my $bar ($::request->layout->get('actionbar')) {
656 submit => [ '#form', { action => "save_dunning" } ],
657 checks => [ [ 'kivi.check_if_entries_selected', '[name^=active_]' ] ],
658 accesskey => 'enter',
665 sub setup_dn_search_action_bar {
668 for my $bar ($::request->layout->get('actionbar')) {
672 submit => [ '#form', { action => "show_dunning" } ],
673 accesskey => 'enter',
679 sub setup_dn_show_dunning_action_bar {
682 for my $bar ($::request->layout->get('actionbar')) {
686 submit => [ '#form', { action => "print_multiple" } ],
687 checks => [ [ 'kivi.check_if_entries_selected', '[name^=selected_]' ] ],
688 accesskey => 'enter',
693 submit => [ '#form', { action => "delete" } ],
694 checks => [ [ 'kivi.check_if_entries_selected', '[name^=selected_]' ] ],
695 confirm => $::locale->text('This resets the dunning process for the selected invoices. Posted dunning invoices will not be changed!'),
701 sub setup_dn_edit_config_action_bar {
704 for my $bar ($::request->layout->get('actionbar')) {
708 submit => [ '#form', { action => "save" } ],
709 accesskey => 'enter',
715 sub setup_dn_status_action_bar {
716 for my $bar ($::request->layout->get('actionbar')) {
720 link => $::form->{callback},
721 accesskey => 'enter',