epic-ts
[kivitendo-erp.git] / bin / mozilla / letter.pl
1 #=====================================================================
2 # LX-Office ERP
3 # Copyright (C) 2008
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
6 #
7 #=====================================================================
8 #
9 # Letter module
10 #
11 #======================================================================
12
13 use strict;
14 use POSIX qw(strftime);
15
16 use SL::GenericTranslations;
17 use SL::ReportGenerator;
18 use SL::Letter;
19 use SL::CT;
20 use SL::DB::Contact;
21 use SL::DB::Default;
22 use SL::Helper::CreatePDF;
23 use SL::Helper::Flash;
24 use SL::Common;
25 use Cwd;
26 require "bin/mozilla/reportgenerator.pl";
27 require "bin/mozilla/io.pl";
28 require "bin/mozilla/arap.pl";
29
30 use constant TEXT_CREATED_FOR_VALUES => (qw(presskit fax letter));
31 use constant PAGE_CREATED_FOR_VALUES => (qw(sketch 1 2));
32
33 our ($form, %myconfig, $locale, $lxdebug);
34
35 # parserhappy(R)
36 # $locale->text('Presskit')
37 # $locale->text('Sketch')
38 # $locale->text('Fax')
39 # $locale->text('Letter')
40
41 sub add {
42   $::lxdebug->enter_sub;
43
44   $main::auth->assert('sales_letter_edit');
45   my %params = @_;
46
47   return $main::lxdebug->leave_sub if load_letter_draft();
48
49   my $letter = SL::Letter->new(%params);
50
51   if (my $cp_id = delete $::form->{contact_id}) {
52     my $contact = SL::DB::Manager::Contact->find_by(cp_id => $cp_id);
53     $letter->{cp_id}     = $contact->cp_id;
54     $letter->{vc_id}     = $contact->cp_cv_id;
55     $letter->{greeting}  = GenericTranslations->get(
56       translation_type => 'greetings::' . ($contact->{cp_gender} eq 'f' ? 'female' : 'male'),
57       language_id      => $contact->language_id,
58       allow_fallback   => 1
59     );
60     $params{language_id} = $contact->language_id;
61   }
62
63   $letter->check_date;
64
65   _display(
66     letter      => $letter,
67     title       => $locale->text('Add Letter'),
68     language_id => $params{language_id},
69   );
70
71   $::lxdebug->leave_sub;
72 }
73
74 sub edit {
75   $::lxdebug->enter_sub;
76
77   $main::auth->assert('sales_letter_edit');
78   add() unless ($form->{id});
79
80   my $letter = SL::Letter->new( id => $form->{id}, draft => $form->{draft} )->load;
81
82   add() unless $letter && ($letter->{id} || $letter->{draft_id});
83
84   _display(
85     letter => $letter,
86     title  => $locale->text('Edit Letter'),
87   );
88
89   $::lxdebug->leave_sub;
90 }
91
92 sub save {
93   $::lxdebug->enter_sub;
94
95   $main::auth->assert('sales_letter_edit');
96   my %params = @_;
97
98
99   $::form->error(t8('The subject is missing.')) unless $form->{letter}->{subject};
100   $::form->error(t8('The body is missing.')) unless $form->{letter}->{body};
101   $::form->error(t8('The employee is missing.')) unless $form->{letter}->{employee_id};
102
103   my $letter = _update();
104
105   $letter->check_number;
106   $letter->save;
107
108   $form->{SAVED_MESSAGE} = $locale->text('Letter saved!');
109
110   _display(
111     letter => $letter,
112   );
113
114   $::lxdebug->leave_sub;
115 }
116
117 sub save_letter_draft {
118   $::lxdebug->enter_sub;
119
120   $main::auth->assert('sales_letter_edit');
121
122   $::form->error(t8('The subject is missing.')) unless $form->{letter}->{subject};
123   $::form->error(t8('The body is missing.')) unless $form->{letter}->{body};
124   $::form->error(t8('The employee is missing.')) unless $form->{letter}->{employee_id};
125   $::form->error(t8('Already as letter saved.')) if $form->{letter}->{letternumber};
126
127   my $letter_draft = _update();
128   $letter_draft->{draft_id} = delete $letter_draft->{id}; # if we have one
129   $letter_draft->save(draft => '1');
130   $letter_draft->{vergiss_mich_nicht} = 'nicht vergessen';
131   $form->{SAVED_MESSAGE} = $locale->text('Draft for this Letter saved!');
132
133   _display(
134     letter => $letter_draft,
135   );
136
137   $::lxdebug->leave_sub;
138 }
139
140 sub delete {
141   $main::lxdebug->enter_sub();
142
143   $main::auth->assert('sales_letter_edit');
144   # NYI
145   $form->{SAVED_MESSAGE} = $locale->text('Not yet implemented!');
146   _display();
147
148   $main::lxdebug->leave_sub();
149 }
150
151 sub delete_letter_drafts {
152   $main::lxdebug->enter_sub();
153
154   $main::auth->assert('sales_letter_edit');
155
156   my @ids;
157   foreach (keys %{$form}) {
158     push @ids, $1 if (/^checked_(.*)/ && $form->{$_});
159   }
160
161   SL::Letter->delete_drafts(@ids) if (@ids); #->{id});
162
163   add();
164
165   $main::lxdebug->leave_sub();
166 }
167
168 sub _display {
169   $main::lxdebug->enter_sub();
170
171   $main::auth->assert('sales_letter_edit');
172   my %params = @_;
173
174   my $letter = $params{letter};
175
176   my %TMPL_VAR;
177
178   $form->{type}             = 'letter';   # needed for print_options
179   $form->{vc}               = 'customer'; # needs to be for _get_contacts...
180   $form->{"$form->{vc}_id"} ||= $letter->{customer_id};
181   $form->{jsscript}         = 1;
182   $form->{javascript}       =
183      qq|<script type="text/javascript" src="js/customer_or_vendor_selection.js"></script>
184         <script type="text/javascript" src="js/edit_part_window.js"></script>|;
185
186   $form->get_lists("contacts"      => "ALL_CONTACTS",
187   "employees"     => "ALL_EMPLOYEES",
188                    "salesmen"      => "ALL_SALESMEN",
189                    "departments"   => "ALL_DEPARTMENTS",
190                    "languages"     => "languages",
191                    "customers"     => { key   => "ALL_CUSTOMERS",
192                                         limit => $myconfig{vclimit} + 1 },
193                    "vc"            => 'customer',
194                    );
195
196   $TMPL_VAR{vc_keys}       = sub { "$_[0]->{name}--$_[0]->{id}" };
197   $TMPL_VAR{vc_select}     = "customer_or_vendor_selection_window('letter.customer', '', 0, 0)";
198   $TMPL_VAR{ct_labels}     = sub { ($_[0]->{cp_greeting} ? "$_[0]->{cp_greeting} " : '') .  $_[0]->{cp_name} .  ($_[0]->{cp_givenname} ? ", $_[0]->{cp_givenname}" : '') };
199   $TMPL_VAR{TCF}           = [ map { key => $_, value => $locale->text(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ];
200   $TMPL_VAR{PCF}           = [ map { key => $_, value => $locale->text(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ];
201
202   $form->header();
203
204   $form->{language_id} ||= $params{language_id};
205
206   print $form->parse_html_template('letter/edit', {
207     %params,
208     %TMPL_VAR,
209     letter        => $letter,
210     print_options => print_options(inline => 1),
211   });
212
213   $main::lxdebug->leave_sub();
214 }
215
216 sub search {
217   $lxdebug->enter_sub();
218
219   $main::auth->assert('sales_letter_report');
220
221   $form->get_lists("employees" => "EMPLOYEES",
222                    "salesmen"  => "SALESMEN",
223                    "customers" => "ALL_CUSTOMERS");
224
225   $form->{jsscript} = 1;
226   $form->{title}    = $locale->text('Letters');
227
228   $form->header();
229   print $form->parse_html_template('letter/search');
230
231   $lxdebug->leave_sub();
232 }
233
234 sub report {
235   $lxdebug->enter_sub();
236
237   $main::auth->assert('sales_letter_report');
238
239   my %params = @_;
240
241   my @report_params = qw(letternumber subject body contact date_from date_to cp_id);
242
243   if ($form->{selectcustomer}) {
244     push @report_params, 'customer_id';
245     $form->{customer_id} = $form->{customer};
246   } else {
247     push @report_params, 'customer';
248   }
249
250   report_generator_set_default_sort('date', 1);
251
252   %params = (%params, map { $_ => $form->{$_} } @report_params);
253
254   my @letters       = SL::Letter->find(%params);
255
256   $form->{rowcount} = @letters;
257   $form->{title}    = $locale->text('Letters');
258
259   my %column_defs = (
260     'date'                  => { 'text' => $locale->text('Date'), },
261     'subject'               => { 'text' => $locale->text('Subject'), },
262     'letternumber'          => { 'text' => $locale->text('Letternumber'), },
263     'customer'              => { 'text' => $locale->text('Customer') },
264     'contact'               => { 'text' => $locale->text('Contact') },
265     'date'                  => { 'text' => $locale->text('Date') },
266   );
267
268   my @columns = qw(date subject letternumber customer contact date);
269   my $href    = build_std_url('action=report', grep { $form->{$_} } @report_params);
270
271   my @sortable_columns = qw(date subject letternumber customer contact date);
272
273   foreach my $name (@sortable_columns) {
274     my $sortdir                 = $form->{sort} eq $name ? 1 - $form->{sortdir} : $form->{sortdir};
275     $column_defs{$name}->{link} = $href . "&sort=$name&sortdir=$sortdir";
276   }
277
278   my @options;
279
280   # option line
281
282   push @options, $locale->text('Subject')                  . " : $form->{subject}"   if ($form->{subject});
283   push @options, $locale->text('Body')                     . " : $form->{body}"      if ($form->{body});
284
285   my @hidden_report_params = map { +{ 'key' => $_, 'value' => $form->{$_} } } @report_params;
286
287   my $report = SL::ReportGenerator->new(\%myconfig, $form, 'std_column_visibility' => 1);
288
289   $report->set_columns(%column_defs);
290   $report->set_column_order(@columns);
291
292   $report->set_export_options('report', @report_params);
293
294   $report->set_sort_indicator($form->{sort}, $form->{sortdir});
295
296   $report->set_options('raw_top_info_text'    => $form->parse_html_template('letter/report_top',    { 'OPTIONS' => \@options }),
297                        'raw_bottom_info_text' => $form->parse_html_template('letter/report_bottom', { 'HIDDEN'  => \@hidden_report_params }),
298                        'output_format'        => 'HTML',
299                        'title'                => $form->{title},
300                        'attachment_basename'  => $locale->text('letters_list') . strftime('_%Y%m%d', localtime time),
301     );
302   $report->set_options_from_form();
303
304   my $idx      = 0;
305   my $callback = build_std_url('action=report', grep { $form->{$_} } @report_params);
306   my $edit_url = build_std_url('action=edit', 'callback=' . E($callback));
307
308   foreach my $l (@letters) {
309     $idx++;
310
311     my $row = { map { $_ => { 'data' => $l->{$_} } } keys %{ $l } };
312
313     $row->{subject}->{link}      = $edit_url . '&id=' . Q($l->{id});
314     $row->{letternumber}->{link} = $edit_url . '&id=' . Q($l->{id});
315
316     $report->add_data($row);
317   }
318
319   $report->generate_with_headers();
320
321   $lxdebug->leave_sub();
322 }
323
324 sub print_letter {
325   $lxdebug->enter_sub();
326
327   $main::auth->assert('sales_letter_edit');
328
329   my ($old_form) = @_;
330
331   my $display_form = $form->{display_form} || "display_form";
332   my $letter       = _update();
333
334   $letter->export_to($form);
335   $form->{formname} = "letter";
336   $form->{format} = "pdf";
337
338   my $language_saved      = $form->{language_id};
339   my $greeting_saved      = $form->{greeting};
340   my $cp_id_saved         = $form->{cp_id};
341
342   call_sub("customer_details");
343
344   if (!$cp_id_saved) {
345     # No contact was selected. Delete all contact variables because
346     # IS->customer_details() and IR->vendor_details() get the default
347     # contact anyway.
348     map({ delete($form->{$_}); } grep(/^cp_/, keys(%{ $form })));
349   }
350
351   $form->{greeting} = $greeting_saved;
352   $form->{language_id} = $language_saved;
353
354   if ($form->{cp_id}) {
355     CT->get_contact(\%myconfig, $form);
356   }
357
358   $form->{cp_contact_formal} = ($form->{cp_greeting} ? "$form->{cp_greeting} " : '') . ($form->{cp_givenname} ? "$form->{cp_givenname} " : '') . $form->{cp_name};
359
360   $form->get_employee_data('prefix' => 'employee', 'id' => $letter->{employee_id});
361   $form->get_employee_data('prefix' => 'salesman', 'id' => $letter->{salesman_id});
362
363   my %create_params = (
364     template  => scalar(SL::Helper::CreatePDF->find_template(
365       name        => 'letter',
366       printer_id  => $::form->{printer_id},
367       language_id => $::form->{language_id},
368       formname    => 'letter',
369       format      => 'pdf',
370     )),
371     variables => $::form,
372     return    => 'file_name',
373   );
374   my $pdf_file_name;
375   eval {
376     # catch LaTeX template not found error
377     my $tex_templates  = $::instance_conf->get_templates . '/letter.tex';
378     die( t8('Please create/copy a template named letter.tex in your client template dir') ) unless (-e $tex_templates);
379
380     $pdf_file_name = SL::Helper::CreatePDF->create_pdf(%create_params);
381
382     # set some form defaults for printing webdav copy variables
383     $form->{tmpfile} = $pdf_file_name;
384     $form->{tmpdir} = 'users';
385     $form->{type} = 'letter';
386     $form->{cwd}        = getcwd();
387     if ( $::form->{media} eq 'email') {
388       my $mail             = Mailer->new;
389       my $signature        = $::myconfig{signature};
390       $mail->{$_}          = $::form->{$_}               for qw(cc subject message bcc to);
391       $mail->{from}        = qq|"$::myconfig{name}" <$::myconfig{email}>|;
392       $mail->{fileid}      = time() . '.' . $$ . '.';
393       $mail->{attachments} =  [{ "filename" => $pdf_file_name,
394                                  "name"     => $::form->{attachment_name} }];
395       $mail->{message}    .=  "\n-- \n$signature";
396       $mail->{message}     =~ s/\r//g;
397
398       # copy_file_to_webdav was already done via io.pl -> edit_e_mail
399       my $err = $mail->send;
400       # TODO
401       #       $self
402       #           ->js
403       #           ->flash($err?'error':'info',
404       #                   $err?t8('A mail error occurred: #1', $err):
405       #                        t8('The document have been sent to \'#1\'.', $mail->{to}))
406       #           ->render($self);
407       return $err?0:1;
408     }
409
410     if (!$::form->{printer_id} || $::form->{media} eq 'screen') {
411
412       my $file = IO::File->new($pdf_file_name, 'r') || croak("Cannot open file '$pdf_file_name'");
413       my $size = -s $pdf_file_name;
414       my $content_type    =  'application/pdf';
415       my $attachment_name =  $::form->generate_attachment_filename;
416       $attachment_name    =~ s:.*//::g;
417
418       print $::form->create_http_response(content_type        => $content_type,
419                                           content_disposition => 'attachment; filename="' . $attachment_name . '"',
420                                           content_length      => $size);
421
422       $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
423       $file->close;
424       Common::copy_file_to_webdav_folder($form) if $::instance_conf->get_webdav_documents;
425       unlink $pdf_file_name;
426       return 1;
427     }
428
429     my $printer = SL::DB::Printer->new(id => $::form->{printer_id})->load;
430     my $command = SL::Template::create(type => 'ShellCommand', form => Form->new(''))->parse($printer->printer_command);
431
432     open my $out, '|-', $command or die $!;
433     binmode $out;
434     print $out scalar(read_file($pdf_file_name));
435     close $out;
436     Common::copy_file_to_webdav_folder($form) if $::instance_conf->get_webdav_documents;
437
438     flash_later('info', t8('The documents have been sent to the printer \'#1\'.', $printer->printer_description));
439     my $callback = build_std_url('letter.pl', 'action=edit', 'id=' . $letter->{id}, 'printer_id');
440     $::form->redirect;
441     1;
442   } or do {
443     unlink $pdf_file_name;
444     $::form->error(t8("Creating the PDF failed:") . " " . $@);
445   };
446
447   $lxdebug->leave_sub();
448 }
449
450 sub update {
451   $::lxdebug->enter_sub;
452
453   $main::auth->assert('sales_letter_edit');
454
455   my $name_selected = shift;
456
457   _display(
458     letter => _update(
459       _name_selected => $name_selected,
460     ),
461   );
462
463   $::lxdebug->leave_sub;
464 }
465
466 sub _update {
467   $::lxdebug->enter_sub;
468
469   $main::auth->assert('sales_letter_edit');
470
471   my %params = @_;
472
473   my $from_letter = $::form->{letter};
474
475   my $letter      = SL::Letter->new( id => $from_letter->{id} )
476                               ->load
477                               ->update_from($from_letter);
478
479   $letter->check_name(%params);
480   $letter->check_date;
481   $letter->set_greetings;
482
483   $::lxdebug->leave_sub;
484
485   return $letter;
486 }
487
488 sub letter_tab {
489   $::lxdebug->enter_sub;
490
491   $main::auth->assert('sales_letter_edit');
492
493   my @report_params = qw(letternumber subject contact date);
494
495   my @letters       = SL::Letter->find(map { $_ => $form->{$_} } @report_params);
496
497   $::lxdebug->leave_sub;
498 }
499
500 sub e_mail {
501   $::lxdebug->enter_sub;
502
503   $main::auth->assert('sales_letter_edit');
504   my $letter = _update();
505
506   $letter->check_number;
507   $letter->save;
508
509   $form->{formname} = "letter";
510   $letter->export_to($::form);
511
512   $::form->{id} = $letter->{id};
513   edit_e_mail();
514
515   $::lxdebug->leave_sub;
516 }
517
518 sub dispatcher {
519   $main::lxdebug->enter_sub();
520   # dispatch drafts
521   my $locale   = $main::locale;
522
523
524   if ($form->{letter_draft_action} eq $locale->text("Skip")) {
525     $form->{DONT_LOAD_DRAFT} = 1;
526     add();
527     return 1;
528   } elsif ($form->{letter_draft_action} eq $locale->text("Delete drafts")) {
529     delete_letter_drafts();
530     return 1;
531   }
532
533   foreach my $action (qw(e_mail print save update save_letter_draft)) {
534     if ($::form->{"action_${action}"}) {
535       $::form->{dispatched_action} = $action;
536       call_sub($action);
537       return;
538     }
539   }
540
541   $::form->error($::locale->text('No action defined.'));
542   $::lxdebug->leave_sub;
543 }
544
545 sub continue {
546   call_sub($form->{nextsub});
547 }
548
549
550 sub load_letter_draft {
551   $lxdebug->enter_sub();
552
553   $main::auth->assert('sales_letter_edit');
554  $main::lxdebug->leave_sub() and return 0 if ($form->{DONT_LOAD_DRAFT});
555  $form->{title}    = $locale->text('Letter Draft');
556  $form->{script}   = 'letter.pl';
557
558   my @letter_drafts = SL::Letter->find(draft => 1);
559
560   return unless @letter_drafts;
561   $form->header();
562   print $form->parse_html_template('letter/load_drafts', { LETTER_DRAFTS => \@letter_drafts });
563
564   return 1;
565   $lxdebug->leave_sub();
566 }
567
568 1;