allow parbreak \ExtraDescription
[kivitendo-erp.git] / bin / mozilla / dn.pl
1 #=====================================================================
2 # LX-Office ERP
3 # Copyright (C) 2006
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
6 #
7 #=====================================================================
8 # SQL-Ledger Accounting
9 # Copyright (c) 1998-2002
10 #
11 #  Author: Dieter Simader
12 #   Email: dsimader@sql-ledger.org
13 #     Web: http://www.sql-ledger.org
14 #
15 #
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.
20 #
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,
28 # MA 02110-1335, USA.
29 #======================================================================
30 #
31 # Dunning process module
32 #
33 #======================================================================
34
35 use POSIX qw(strftime);
36
37 use SL::IS;
38 use SL::DN;
39 use SL::DB::Department;
40 use SL::DB::Dunning;
41 use SL::Helper::Flash qw(flash);
42 use SL::Locale::String qw(t8);
43 use SL::ReportGenerator;
44
45 require "bin/mozilla/common.pl";
46 require "bin/mozilla/reportgenerator.pl";
47 require "bin/mozilla/io.pl";
48
49 use strict;
50
51 1;
52
53 sub edit_config {
54   $main::lxdebug->enter_sub();
55
56   my $form     = $main::form;
57   my %myconfig = %main::myconfig;
58   my $locale   = $main::locale;
59
60   $main::auth->assert('config');
61
62   DN->get_config(\%myconfig, \%$form);
63   $form->get_lists('charts' => { 'key'       => 'ALL_CHARTS',
64                                  'transdate' => 'current_date' });
65
66   $form->{SELECT_AR_AMOUNT} = [];
67   $form->{SELECT_AR}        = [];
68
69   foreach my $chart (@{ $form->{ALL_CHARTS} }) {
70     $chart->{LINKS} = { map { $_, 1 } split m/:/, $chart->{link} };
71
72     if ($chart->{LINKS}->{AR}) {
73       $chart->{AR_selected} = "selected" if $chart->{id} == $form->{AR};
74       push @{ $form->{SELECT_AR} }, $chart;
75     }
76
77     if ($chart->{LINKS}->{AR_amount}) {
78       $chart->{AR_amount_fee_selected}      = "selected" if $chart->{id} == $form->{AR_amount_fee};
79       $chart->{AR_amount_interest_selected} = "selected" if $chart->{id} == $form->{AR_amount_interest};
80       push @{ $form->{SELECT_AR_AMOUNT} }, $chart;
81     }
82   }
83
84   $form->{title}      = $locale->text('Edit Dunning Process Config');
85   $form->{callback} ||= build_std_url("action=edit_config");
86
87   setup_dn_edit_config_action_bar();
88
89   $form->header();
90   print $form->parse_html_template("dunning/edit_config");
91
92   $main::lxdebug->leave_sub();
93 }
94
95 sub add {
96   $main::lxdebug->enter_sub();
97
98   my $form     = $main::form;
99   my %myconfig = %main::myconfig;
100   my $locale   = $main::locale;
101
102   $main::auth->assert('dunning_edit');
103
104   DN->get_config(\%myconfig, \%$form);
105
106   $form->get_lists("departments" => "ALL_DEPARTMENTS");
107
108   $form->{SHOW_DUNNING_LEVEL_SELECTION} = $form->{DUNNING}         && scalar @{ $form->{DUNNING} };
109   $form->{SHOW_DEPARTMENT_SELECTION}    = $form->{ALL_DEPARTMENTS} && scalar @{ $form->{ALL_DEPARTMENTS} || [] };
110
111   $form->{title}    = $locale->text('Start Dunning Process');
112
113   setup_dn_add_action_bar();
114   $form->header();
115
116   print $form->parse_html_template("dunning/add");
117
118   $main::lxdebug->leave_sub();
119 }
120
121 sub show_invoices {
122   $main::lxdebug->enter_sub();
123
124   my $form     = $main::form;
125   my %myconfig = %main::myconfig;
126   my $locale   = $main::locale;
127
128   $main::auth->assert('dunning_edit');
129
130   DN->get_invoices(\%myconfig, \%$form);
131   $form->{title} = $locale->text('Start Dunning Process');
132
133   foreach my $row (@{ $form->{DUNNINGS} }) {
134     $row->{DUNNING_CONFIG} = [ map +{ %{ $_ } }, @{ $form->{DUNNING_CONFIG} } ];
135
136     if ($row->{next_dunning_config_id}) {
137       map { $_->{SELECTED} = $_->{id} == $row->{next_dunning_config_id} } @{ $row->{DUNNING_CONFIG } };
138     }
139     map { $row->{$_} = $form->format_amount(\%myconfig, $row->{$_} * 1, 2) } qw(amount open_amount fee interest);
140
141     if ($row->{'language_id'}) {
142       $row->{language} = SL::DB::Manager::Language->find_by_or_create('id' => $row->{'language_id'})->{'description'};
143     }
144   }
145
146   $form->get_lists('printers'  => 'printers',
147                    'languages' => 'languages');
148
149   $form->{type}           = 'dunning';
150   $form->{rowcount}       = scalar @{ $form->{DUNNINGS} };
151   $form->{callback}     ||= build_std_url("action=show_invoices", qw(customer invnumber ordnumber groupinvoices minamount dunning_level notes));
152
153   $form->{PRINT_OPTIONS}  = print_options('inline'          => 1,
154                                           'no_queue'        => 1,
155                                           'no_postscript'   => 1,
156                                           'no_html'         => 1,
157                                           'no_opendocument' => 1,);
158
159   setup_dn_show_invoices_action_bar();
160   $form->header();
161   print $form->parse_html_template("dunning/show_invoices");
162
163   $main::lxdebug->leave_sub();
164 }
165
166 sub save {
167   $main::lxdebug->enter_sub();
168
169   my $form     = $main::form;
170   my %myconfig = %main::myconfig;
171   my $locale   = $main::locale;
172
173   $main::auth->assert('config');
174
175   for my $i (1 .. $form->{rowcount}) {
176     if ($form->{"dunning_description_$i"} ne "") {
177       $form->isblank("dunning_level_$i", $locale->text('Dunning Level missing in row '). $i);
178       $form->isblank("dunning_description_$i", $locale->text('Dunning Description missing in row '). $i);
179       $form->isblank("terms_$i", $locale->text('Terms missing in row '). $i);
180       $form->isblank("payment_terms_$i", $locale->text('Payment Terms missing in row '). $i);
181     }
182   }
183
184   DN->save_config(\%myconfig, \%$form);
185   # saving the history
186   if(!exists $form->{addition} && $form->{id} ne "") {
187     $form->{snumbers} = qq|dunning_id_| . $form->{"dunning_id"};
188     $form->{addition} = "SAVED FOR DUNNING";
189     $form->save_history;
190   }
191   # /saving the history
192   $form->redirect($locale->text('Dunning Process Config saved!'));
193
194   $main::lxdebug->leave_sub();
195 }
196
197 sub save_dunning {
198   $main::lxdebug->enter_sub();
199
200   my $form     = $main::form;
201   my %myconfig = %main::myconfig;
202   my $locale   = $main::locale;
203
204   $main::auth->assert('dunning_edit');
205
206   my $active=1;
207   my @rows = ();
208   undef($form->{DUNNING_PDFS});
209
210   my $saved_language_id = $form->{language_id};
211
212   if ($form->{groupinvoices}) {
213     my %dunnings_for;
214
215     for my $i (1 .. $form->{rowcount}) {
216       next unless ($form->{"active_$i"});
217
218       $dunnings_for{$form->{"customer_id_$i"}} ||= {};
219       my $dunning_levels = $dunnings_for{$form->{"customer_id_$i"}};
220
221       $dunning_levels->{$form->{"next_dunning_config_id_$i"}} ||= [];
222       my $level = $dunning_levels->{$form->{"next_dunning_config_id_$i"}};
223
224       push @{ $level }, { "row"                    => $i,
225                           "invoice_id"             => $form->{"inv_id_$i"},
226                           "customer_id"            => $form->{"customer_id_$i"},
227                           "language_id"            => $form->{"language_id_$i"},
228                           "next_dunning_config_id" => $form->{"next_dunning_config_id_$i"},
229                           "email"                  => $form->{"email_$i"}, };
230     }
231
232     foreach my $levels (values %dunnings_for) {
233       foreach my $level (values %{ $levels }) {
234         next unless scalar @{ $level };
235         if (!$form->{force_lang}) {
236           $form->{language_id} = @{$level}[0]->{language_id};
237         }
238         DN->save_dunning(\%myconfig, $form, $level);
239       }
240     }
241
242   } else {
243     for my $i (1 .. $form->{rowcount}) {
244       next unless $form->{"active_$i"};
245
246       my $level = [ { "row"                    => $i,
247                       "invoice_id"             => $form->{"inv_id_$i"},
248                       "customer_id"            => $form->{"customer_id_$i"},
249                       "language_id"            => $form->{"language_id_$i"},
250                       "next_dunning_config_id" => $form->{"next_dunning_config_id_$i"},
251                       "email"                  => $form->{"email_$i"}, } ];
252       if (!$form->{force_lang}) {
253         $form->{language_id} = @{$level}[0]->{language_id};
254       }
255       DN->save_dunning(\%myconfig, $form, $level);
256     }
257   }
258
259   $form->{language_id} = $saved_language_id;
260
261   if (scalar @{ $form->{DUNNING_PDFS} }) {
262     $form->{dunning_id} = strftime("%Y%m%d", localtime time) if scalar @{ $form->{DUNNING_PDFS}} > 1;
263     DN->melt_pdfs(\%myconfig, $form, $form->{copies});
264   }
265
266   # saving the history
267   if(!exists $form->{addition} && $form->{id} ne "") {
268     $form->{snumbers} = qq|dunning_id_| . $form->{"dunning_id"};
269     $form->{addition} = "DUNNING STARTED";
270     $form->save_history;
271   }
272   # /saving the history
273
274   if ($form->{media} eq 'printer') {
275     delete $form->{callback};
276     $form->redirect($locale->text('Dunning Process started for selected invoices!'));
277   }
278
279   $main::lxdebug->leave_sub();
280 }
281
282 sub set_email {
283   $main::lxdebug->enter_sub();
284
285   my $form     = $main::form;
286   my $locale   = $main::locale;
287
288   $main::auth->assert('dunning_edit');
289
290   $form->{"title"} = $locale->text("Set eMail text");
291   $form->header(no_layout => 1);
292   print($form->parse_html_template("dunning/set_email"));
293
294   $main::lxdebug->leave_sub();
295 }
296
297 sub search {
298   $main::lxdebug->enter_sub();
299
300   my $form     = $main::form;
301   my %myconfig = %main::myconfig;
302   my $locale   = $main::locale;
303
304   $main::auth->assert('dunning_edit');
305
306   $form->get_lists("customers"   => "ALL_CUSTOMERS",
307                    "departments" => "ALL_DEPARTMENTS");
308   $form->{ALL_EMPLOYEES} = SL::DB::Manager::Employee->get_all_sorted(query => [ deleted => 0 ]);
309
310   DN->get_config(\%myconfig, \%$form);
311
312   $form->{SHOW_DUNNING_LEVELS}   = scalar @{ $form->{DUNNING} };
313
314   $form->{title}    = $locale->text('Dunnings');
315
316   setup_dn_search_action_bar();
317   $form->header();
318
319   print $form->parse_html_template("dunning/search");
320
321   $main::lxdebug->leave_sub();
322
323 }
324
325 sub show_dunning {
326   $main::lxdebug->enter_sub();
327
328   my $form     = $main::form;
329   my %myconfig = %main::myconfig;
330   my $locale   = $main::locale;
331   my $cgi      = $::request->{cgi};
332
333   $main::auth->assert('dunning_edit');
334
335   my @filter_field_list = qw(customer_id customer dunning_level department_id invnumber ordnumber
336                              transdatefrom transdateto dunningfrom dunningto notes showold l_salesman salesman_id);
337
338   report_generator_set_default_sort('customername', 1);
339
340   DN->get_dunning(\%myconfig, \%$form);
341
342   if (!$form->{callback}) {
343     $form->{callback} = build_std_url("action=show_dunning", @filter_field_list);
344   }
345
346   $form->get_lists('printers'  => 'printers',
347                    'languages' => 'languages');
348
349   $form->{type}          = 'dunning';
350   $form->{PRINT_OPTIONS} = print_options('inline'          => 1,
351                                          'no_queue'        => 1,
352                                          'no_postscript'   => 1,
353                                          'no_html'         => 1,
354                                          'no_opendocument' => 1,);
355   $form->{title}         = $locale->text('Dunning overview');
356
357   my $report = SL::ReportGenerator->new(\%myconfig, $form);
358
359   $report->set_options('std_column_visibility' => 1,
360                        'title'                 => $form->{title});
361   $report->set_export_options('show_dunning', @filter_field_list, qw(sort sortdir));
362
363   my %column_defs         =  (
364     'checkbox'            => { 'text' => '', 'visible' => 'HTML' },
365     'dunning_description' => { 'text' => $locale->text('Dunning Level') },
366     'customername'        => { 'text' => $locale->text('Customername') },
367     'departmentname'      => { 'text' => $locale->text('Department') },
368     'language'            => { 'text' => $locale->text('Language') },
369     'invnumber'           => { 'text' => $locale->text('Invnumber') },
370     'transdate'           => { 'text' => $locale->text('Invdate') },
371     'duedate'             => { 'text' => $locale->text('Invoice Duedate') },
372     'amount'              => { 'text' => $locale->text('Amount') },
373     'dunning_date'        => { 'text' => $locale->text('Dunning Date') },
374     'dunning_duedate'     => { 'text' => $locale->text('Dunning Duedate') },
375     'fee'                 => { 'text' => $locale->text('Total Fees') },
376     'interest'            => { 'text' => $locale->text('Interest') },
377     'salesman'            => { 'text' => $locale->text('Salesperson'), 'visible' => $form->{l_salesman} ? 1 : 0 },
378   );
379
380   $report->set_columns(%column_defs);
381   $report->set_column_order(qw(checkbox dunning_description customername language invnumber transdate
382                                duedate amount dunning_date dunning_duedate fee interest salesman));
383   $report->set_sort_indicator($form->{sort}, $form->{sortdir});
384
385   my $edit_url  = sub { build_std_url('script=' . ($_[0]->{invoice} ? 'is' : 'ar') . '.pl', 'action=edit', 'callback') . '&id=' . $::form->escape($_[0]->{id}) };
386   my $print_url = sub { build_std_url('action=print_dunning', 'format=pdf', 'media=screen', 'dunning_id='.$_[0]->{dunning_id}, 'language_id=' . $_[0]->{language_id}) };
387   my $sort_url  = build_std_url('action=show_dunning', grep { $form->{$_} } @filter_field_list);
388
389   foreach my $name (qw(dunning_description customername invnumber transdate duedate dunning_date dunning_duedate salesman)) {
390     my $sortdir                 = $form->{sort} eq $name ? 1 - $form->{sortdir} : $form->{sortdir};
391     $column_defs{$name}->{link} = $sort_url . "&sort=$name&sortdir=$sortdir";
392   }
393
394   my %alignment = map { $_ => 'right' } qw(transdate duedate amount dunning_date dunning_duedate fee interest salesman);
395
396   my ($current_dunning_rows, $previous_dunning_id, $first_row_for_dunning);
397
398   $current_dunning_rows  = [];
399   $first_row_for_dunning = 1;
400   $form->{rowcount}      = scalar @{ $form->{DUNNINGS} };
401
402   my $i = 0;
403
404   foreach my $ref (@{ $form->{DUNNINGS} }) {
405     $i++;
406
407     if ($previous_dunning_id != $ref->{dunning_id}) {
408       $report->add_data($current_dunning_rows) if (scalar @{ $current_dunning_rows });
409       $current_dunning_rows  = [];
410       $first_row_for_dunning = 1;
411     }
412
413     if ($ref->{'language_id'}) {
414       $ref->{language} = SL::DB::Manager::Language->find_by('id' => $ref->{'language_id'})->{'description'};
415     }
416
417     my $row = { };
418     foreach my $column (keys %{ $ref }) {
419       $row->{$column} = {
420         'data'  => $first_row_for_dunning || (($column ne 'dunning_description') && ($column ne 'customername')) ? $ref->{$column} : '',
421
422         'align' => $alignment{$column},
423
424         'link'  => (  $column eq 'invnumber'           ? $edit_url->($ref)
425                     : $column eq 'dunning_description' ? $print_url->($ref)
426                     :                                    ''),
427       };
428     }
429
430     $row->{checkbox} = !$first_row_for_dunning ? { } : {
431       'raw_data' =>   $cgi->hidden('-name' => "dunning_id_$i", '-value' => $ref->{dunning_id})
432                     . $cgi->checkbox('-name' => "selected_$i", '-value' => 1, '-label' => ''),
433       'valign'   => 'center',
434       'align'    => 'center',
435     };
436
437     if ($first_row_for_dunning) {
438       $row->{language} = {'raw_data' => $cgi->hidden('-name' => "language_id_$i", '-value' => $ref->{language_id})
439                                         . " $ref->{language}" };
440     } else {
441       $row->{language} = { };
442     }
443
444     push @{ $current_dunning_rows }, $row;
445
446     $previous_dunning_id   = $ref->{dunning_id};
447     $first_row_for_dunning = 0;
448   }
449
450   $report->add_data($current_dunning_rows) if (scalar @{ $current_dunning_rows });
451
452   $report->set_options('raw_top_info_text'    => $form->parse_html_template('dunning/show_dunning_top'),
453                        'raw_bottom_info_text' => $form->parse_html_template('dunning/show_dunning_bottom'),
454                        'output_format'        => 'HTML',
455                        'attachment_basename'  => $locale->text('dunning_list') . strftime('_%Y%m%d', localtime time),
456     );
457
458   $report->set_options_from_form();
459
460   setup_dn_show_dunning_action_bar();
461   $report->generate_with_headers();
462
463   $main::lxdebug->leave_sub();
464
465 }
466
467 sub print_dunning {
468   $main::lxdebug->enter_sub();
469
470   my $form     = $main::form;
471
472   $main::auth->assert('dunning_edit');
473
474   $form->{rowcount}     = 1;
475   $form->{selected_1}   = 1;
476   $form->{dunning_id_1} = $form->{dunning_id};
477   $form->{language_id_1} = $form->{language_id};
478
479   print_multiple();
480
481   $main::lxdebug->leave_sub();
482 }
483
484 sub delete {
485   $main::auth->assert('dunning_edit');
486
487   my @dunning_ids = map { $::form->{"dunning_id_$_"} } grep { $::form->{"selected_$_"} } (1..$::form->{rowcount});
488
489   if (!scalar @dunning_ids) {
490     $::form->error($::locale->text('No dunnings have been selected for printing.'));
491   }
492
493   my $dunnings = SL::DB::Manager::Dunning->get_all(query => [ dunning_id => \@dunning_ids ]);
494
495   SL::DB::Dunning->new->db->with_transaction(sub {
496     for my $dunning (@$dunnings) {
497       SL::DB::Manager::Invoice->find_by(id => $dunning->trans_id)->update_attributes(dunning_config_id => undef);
498       $dunning->delete;
499     }
500   });
501
502   flash('info', t8('#1 dunnings have been deleted', scalar @$dunnings));
503
504   search();
505 }
506
507 sub print_multiple {
508   $main::lxdebug->enter_sub();
509
510   my $form     = $main::form;
511   my %myconfig = %main::myconfig;
512   my $locale   = $main::locale;
513
514   $main::auth->assert('dunning_edit');
515
516   $form->{title} = $locale->text('Print dunnings');
517
518   my @dunning_ids = map { $form->{"dunning_id_$_"} } grep { $form->{"selected_$_"} } (1..$form->{rowcount});
519   my @language_ids = map { $form->{"language_id_$_"} } grep { $form->{"selected_$_"} } (1..$form->{rowcount});
520
521   if (!scalar @dunning_ids) {
522     $form->error($locale->text('No dunnings have been selected for printing.'));
523   }
524
525   $form->{DUNNING_PDFS} = [];
526
527   my $saved_language_id = $form->{language_id};
528   my $i = 0;
529   foreach my $dunning_id (@dunning_ids) {
530     if (!$form->{force_lang}) {
531       $form->{language_id} = $language_ids[$i];
532     }
533     $form->{dunning_id} = $dunning_id;
534     DN->print_invoice_for_fees(\%myconfig, $form, $dunning_id);
535     DN->print_dunning(\%myconfig, $form, $dunning_id);
536     $i++;
537   }
538   $form->{language_id} = $saved_language_id;
539
540   if (scalar @{ $form->{DUNNING_PDFS} }) {
541     $form->{dunning_id} = strftime("%Y%m%d", localtime time) if scalar @{ $form->{DUNNING_PDFS}} > 1;
542     DN->melt_pdfs(\%myconfig, $form, $form->{copies});
543
544     if ($form->{media} eq 'printer') {
545       $form->header();
546       $form->info($locale->text('The dunnings have been printed.'));
547     }
548
549   } else {
550     $form->redirect($locale->text('Could not print dunning.'));
551   }
552
553   $main::lxdebug->leave_sub();
554 }
555
556 sub continue {
557   call_sub($main::form->{nextsub});
558 }
559
560 sub dispatcher {
561   foreach my $action (qw(delete print_multiple)) {
562     if ($::form->{"action_${action}"}) {
563       call_sub($action);
564       return;
565     }
566   }
567
568   $::form->error($::locale->text('No action defined.'));
569 }
570
571 sub setup_dn_add_action_bar {
572   my %params = @_;
573
574   for my $bar ($::request->layout->get('actionbar')) {
575     $bar->add(
576       action => [
577         t8('Search'),
578         submit    => [ '#form', { action => "show_invoices" } ],
579         accesskey => 'enter',
580       ],
581     );
582   }
583 }
584
585 sub setup_dn_show_invoices_action_bar {
586   my %params = @_;
587
588   for my $bar ($::request->layout->get('actionbar')) {
589     $bar->add(
590       action => [
591         t8('Create'),
592         submit    => [ '#form', { action => "save_dunning" } ],
593         checks    => [ [ 'kivi.check_if_entries_selected', '[name^=active_]' ] ],
594         accesskey => 'enter',
595         only_once => 1,
596       ],
597     );
598   }
599 }
600
601 sub setup_dn_search_action_bar {
602   my %params = @_;
603
604   for my $bar ($::request->layout->get('actionbar')) {
605     $bar->add(
606       action => [
607         t8('Search'),
608         submit    => [ '#form', { action => "show_dunning" } ],
609         accesskey => 'enter',
610       ],
611     );
612   }
613 }
614
615 sub setup_dn_show_dunning_action_bar {
616   my %params = @_;
617
618   for my $bar ($::request->layout->get('actionbar')) {
619     $bar->add(
620       action => [
621         t8('Print'),
622         submit    => [ '#form', { action => "print_multiple" } ],
623         checks    => [ [ 'kivi.check_if_entries_selected', '[name^=selected_]' ] ],
624         accesskey => 'enter',
625       ],
626
627       action => [
628         t8('Delete'),
629         submit  => [ '#form', { action => "delete" } ],
630         checks  => [ [ 'kivi.check_if_entries_selected', '[name^=selected_]' ] ],
631         confirm => $::locale->text('This resets the dunning process for the selected invoices. Posted dunning invoices will not be changed!'),
632       ],
633     );
634   }
635 }
636
637 sub setup_dn_edit_config_action_bar {
638   my %params = @_;
639
640   for my $bar ($::request->layout->get('actionbar')) {
641     $bar->add(
642       action => [
643         t8('Save'),
644         submit    => [ '#form', { action => "save" } ],
645         accesskey => 'enter',
646       ],
647     );
648   }
649 }
650
651 # end of main