1 package SL::Controller::Letter;
4 use parent qw(SL::Controller::Base);
7 use POSIX qw(strftime);
8 use SL::Controller::Helper::GetModels;
9 use SL::Controller::Helper::ReportGenerator;
12 use SL::DB::LetterDraft;
14 use SL::Helper::Flash qw(flash);
15 use SL::Helper::CreatePDF;
16 use SL::Helper::PrintOptions;
17 use SL::Locale::String qw(t8);
19 use SL::ReportGenerator;
21 use Rose::Object::MakeMethods::Generic (
22 'scalar --get_set_init' => [ qw(letter all_employees models) ],
25 __PACKAGE__->run_before('check_auth_edit');
26 __PACKAGE__->run_before('check_auth_report', only => [ qw(list) ]);
28 use constant TEXT_CREATED_FOR_VALUES => (qw(presskit fax letter));
29 use constant PAGE_CREATED_FOR_VALUES => (qw(sketch 1 2));
33 subject => t8('Subject'),
34 letternumber => t8('Letternumber'),
35 vc_id => t8('Customer'),
36 contact => t8('Contact'),
40 my ($self, %params) = @_;
42 return if $self->load_letter_draft(%params);
44 $self->letter->employee_id(SL::DB::Manager::Employee->current->id);
45 $self->letter->salesman_id(SL::DB::Manager::Employee->current->id);
48 title => t8('Add Letter'),
49 language_id => $params{language_id},
54 my ($self, %params) = @_;
56 return $self->action_add
57 unless $::form->{letter} || $::form->{draft};
59 $self->letter(SL::DB::Letter->new_from_draft($::form->{draft}{id}))
63 title => t8('Edit Letter'),
68 my ($self, %params) = @_;
70 my $letter = $self->_update;
72 if (!$self->check_letter($letter)) {
73 return $self->_display;
79 flash('error', t8('There was an error saving the letter'));
80 return $self->_display;
83 flash('info', t8('Letter saved!'));
88 sub action_update_contacts {
91 my $letter = $self->letter;
93 if (!$self->letter->vc_id || !$self->letter->customer) {
97 SL::Presenter->get->select_tag('letter.cp_id', [], value_key => 'cp_id', title_key => 'full_name')
102 my $contacts = $letter->customer->contacts;
105 if ( $letter->contact
106 && $letter->contact->cp_cv_id
107 && $letter->contact->cp_cv_id == $letter->vc_id) {
108 $default = $letter->contact->cp_id;
116 SL::Presenter->get->select_tag('letter.cp_id', $contacts, default => $default, value_key => 'cp_id', title_key => 'full_name')
121 sub action_save_letter_draft {
122 my ($self, %params) = @_;
126 my $letter_draft = SL::DB::LetterDraft->new_from_letter($self->_update);
128 if (!$letter_draft->save) {
129 flash('error', t8('There was an error saving the letter draft'));
130 return $self->_display;
133 flash('info', t8('Draft for this Letter saved!'));
139 my ($self, %params) = @_;
141 if (!$self->letter->delete) {
142 flash('error', t8('An error occured. Letter could not be deleted.'));
143 return $self->action_update;
146 flash_later('info', t8('Letter deleted'));
147 $self->redirect_to(action => 'list');
150 sub action_delete_letter_drafts {
151 my ($self, %params) = @_;
153 my @ids = grep { /^checked_(.*)/ && $::form->{$_} } keys %$::form;
155 SL::DB::Manager::LetterDraft->delete_all(query => [ ids => \@ids ]) if @ids;
157 $self->redirect_to(action => 'add');
161 my ($self, %params) = @_;
163 $self->make_filter_summary;
164 $self->prepare_report;
166 my $letters = $self->models->get;
167 $self->report_generator_list_objects(report => $self->{report}, objects => $letters);
171 sub action_print_letter {
172 my ($self, $old_form) = @_;
174 my $display_form = $::form->{display_form} || "display_form";
175 my $letter = $self->_update;
177 $self->export_letter_to_form($letter);
178 $::form->{formname} = "letter";
179 $::form->{type} = "letter";
180 $::form->{format} = "pdf";
182 my $language_saved = $::form->{language_id};
183 my $greeting_saved = $::form->{greeting};
184 my $cp_id_saved = $::form->{cp_id};
186 $::form->{customer_id} = $self->letter->vc_id;
187 IS->customer_details(\%::myconfig, $::form);
190 # No contact was selected. Delete all contact variables because
191 # IS->customer_details() and IR->vendor_details() get the default
193 map({ delete($::form->{$_}); } grep(/^cp_/, keys(%{ $::form })));
196 $::form->{greeting} = $greeting_saved;
197 $::form->{language_id} = $language_saved;
199 if ($::form->{cp_id}) {
200 CT->get_contact(\%::myconfig, $::form);
203 $::form->{cp_contact_formal} = ($::form->{cp_greeting} ? "$::form->{cp_greeting} " : '') . ($::form->{cp_givenname} ? "$::form->{cp_givenname} " : '') . $::form->{cp_name};
205 $::form->get_employee_data('prefix' => 'employee', 'id' => $letter->{employee_id});
206 $::form->get_employee_data('prefix' => 'salesman', 'id' => $letter->{salesman_id});
208 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
210 printer_id => $::form->{printer_id},
211 language_id => $::form->{language_id},
212 formname => 'letter',
216 if (!defined $template_file) {
217 $::form->error($::locale->text('Cannot find matching template for this print request. Please contact your template maintainer. I tried these: #1.', join ', ', map { "'$_'"} @template_files));
220 my %create_params = (
221 template => $template_file,
222 variables => $::form,
223 return => 'file_name',
224 variable_content_types => {
231 $pdf_file_name = SL::Helper::CreatePDF->create_pdf(%create_params);
233 # set some form defaults for printing webdav copy variables
234 if ( $::form->{media} eq 'email') {
235 my $mail = Mailer->new;
236 my $signature = $::myconfig{signature};
237 $mail->{$_} = $::form->{$_} for qw(cc subject message bcc to);
238 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
239 $mail->{fileid} = time() . '.' . $$ . '.';
240 $mail->{attachments} = [{ "filename" => $pdf_file_name,
241 "name" => $::form->{attachment_name} }];
242 $mail->{message} .= "\n-- \n$signature";
243 $mail->{message} =~ s/\r//g;
245 # copy_file_to_webdav was already done via io.pl -> edit_e_mail
246 my $err = $mail->send;
250 if (!$::form->{printer_id} || $::form->{media} eq 'screen') {
252 my $file = IO::File->new($pdf_file_name, 'r') || croak("Cannot open file '$pdf_file_name'");
253 my $size = -s $pdf_file_name;
254 my $content_type = 'application/pdf';
255 $::form->{letternumber} = $self->letter->letternumber;
256 my $attachment_name = $::form->generate_attachment_filename;
257 $attachment_name =~ s:.*//::g;
259 print $::form->create_http_response(content_type => $content_type,
260 content_disposition => 'attachment; filename="' . $attachment_name . '"',
261 content_length => $size);
263 $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
266 Common::copy_file_to_webdav_folder($::form) if $::instance_conf->get_webdav_documents;
267 unlink $pdf_file_name;
271 my $printer = SL::DB::Printer->new(id => $::form->{printer_id})->load;
272 my $command = SL::Template::create(type => 'ShellCommand', form => Form->new(''))->parse($printer->printer_command);
274 open my $out, '|-', $command or die $!;
276 print $out scalar(read_file($pdf_file_name));
278 Common::copy_file_to_webdav_folder($::form) if $::instance_conf->get_webdav_documents;
280 flash_later('info', t8('The documents have been sent to the printer \'#1\'.', $printer->printer_description));
281 $self->redirect_to(action => 'edit', id => $letter->{id}, 'printer_id' => $::form->{printer_id});
284 unlink $pdf_file_name;
285 $::form->error(t8("Creating the PDF failed:") . " " . $@);
291 my ($self, $name_selected) = @_;
294 letter => $self->_update,
298 sub action_skip_draft {
300 $self->action_add(skip_drafts => 1);
303 sub action_delete_drafts {
305 delete_letter_drafts();
306 $self->action_add(skip_drafts => 1);
310 my ($self, %params) = @_;
312 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
314 my $letter = $self->letter;
316 $params{title} ||= t8('Edit Letter');
318 $::form->{type} = 'letter'; # needed for print_options
319 $::form->{vc} = 'customer'; # needs to be for _get_contacts...
321 $::request->layout->add_javascripts('customer_or_vendor_selection.js');
322 $::request->layout->add_javascripts('edit_part_window.js');
324 $::form->{language_id} ||= $params{language_id};
326 $self->render('letter/edit',
328 TCF => [ map { key => $_, value => t8(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ],
329 PCF => [ map { key => $_, value => t8(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ],
331 employees => $self->all_employees,
332 print_options => SL::Helper::PrintOptions->get_print_options (
333 options => { no_postscript => 1,
334 no_opendocument => 1,
342 my ($self, %params) = @_;
344 my $letter = $self->letter;
347 $self->set_greetings;
355 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
356 $self->{report} = $report;
358 my @columns = qw(date subject letternumber vc_id contact date);
359 my @sortable = qw(date subject letternumber vc_id contact date);
362 date => { text => t8('Date'), sub => sub { $_[0]->date_as_date } },
363 subject => { text => t8('Subject'), sub => sub { $_[0]->subject },
364 obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) } },
365 letternumber => { text => t8('Letternumber'), sub => sub { $_[0]->letternumber },
366 obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) } },
367 vc_id => { text => t8('Customer'), sub => sub { SL::DB::Manager::Customer->find_by_or_create(id => $_[0]->vc_id)->displayable_name } },
368 contact => { text => t8('Contact'), sub => sub { $_[0]->contact ? $_[0]->contact->full_name : '' } },
371 $column_defs{$_}{text} = $sort_columns{$_} for keys %column_defs;
373 $report->set_options(
374 std_column_visibility => 1,
375 controller_class => 'Letter',
376 output_format => 'HTML',
377 top_info_text => t8('Letters'),
378 title => t8('Letters'),
379 allow_pdf_export => 1,
380 allow_csv_export => 1,
383 $report->set_columns(%column_defs);
384 $report->set_column_order(@columns);
385 $report->set_export_options(qw(list filter));
386 $report->set_options_from_form;
388 $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
389 $self->models->finalize;
390 $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
392 $report->set_options(
393 raw_top_info_text => $self->render('letter/report_top', { output => 0 }),
394 raw_bottom_info_text => $self->render('letter/report_bottom', { output => 0 }, models => $self->models),
395 attachment_basename => t8('letters_list') . strftime('_%Y%m%d', localtime time),
399 sub make_filter_summary {
402 my $filter = $::form->{filter} || {};
405 my $employee = $filter->{employee_id} ? SL::DB::Employee->new(id => $filter->{employee_id})->load->name : '';
406 my $salesman = $filter->{salesman_id} ? SL::DB::Employee->new(id => $filter->{salesman_id})->load->name : '';
409 [ $filter->{"letternumber:substr::ilike"}, t8('Number') ],
410 [ $filter->{"subject:substr::ilike"}, t8('Subject') ],
411 [ $filter->{"body:substr::ilike"}, t8('Body') ],
412 [ $filter->{"date:date::ge"}, t8('From Date') ],
413 [ $filter->{"date:date::le"}, t8('To Date') ],
414 [ $employee, t8('Employee') ],
415 [ $salesman, t8('Salesman') ],
420 my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
423 push @filter_strings, $_ if $_;
426 push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
429 $self->{filter_summary} = join ', ', @filter_strings;
433 my $letter = _update();
435 $letter->check_number;
438 $::form->{formname} = "letter";
439 $letter->export_to($::form);
441 $::form->{id} = $letter->{id};
445 sub load_letter_draft {
446 my ($self, %params) = @_;
448 return 0 if $params{skip_drafts};
450 my $letter_drafts = SL::DB::Manager::LetterDraft->get_all;
452 return unless @$letter_drafts;
454 $self->render('letter/load_drafts',
455 title => t8('Letter Draft'),
456 LETTER_DRAFTS => $letter_drafts,
464 my $letter = $self->letter;
466 return unless $letter;
467 return if $letter->date;
469 $letter->date(DateTime->today)
473 my ($self, $letter) = @_;
475 $letter ||= $self->letter;
479 if (!$letter->subject) {
480 flash('error', t8('The subject is missing.'));
483 if (!$letter->body) {
484 flash('error', t8('The body is missing.'));
487 if (!$letter->employee_id) {
488 flash('error', t8('The employee is missing.'));
496 my ($self, $letter) = @_;
498 $letter ||= $self->letter;
500 return if $letter->letternumber;
502 $letter->letternumber(SL::TransNumber->new(type => 'letter', id => $self->{id}, number => $self->{letternumber})->create_unique);
507 my $letter = $self->letter;
509 return unless $letter;
510 return if $letter->greeting;
512 $letter->greeting(t8('Dear Sir or Madam,'));
515 sub export_letter_to_form {
516 my ($self, $letter) = @_;
519 $letter ||= $self->letter;
521 for ($letter->meta->columns) {
522 if ((ref $_) =~ /Date/i) {
523 $::form->{$_->name} = $letter->$_->to_kivitendo;
525 $::form->{$_->name} = $letter->$_;
533 my $letter = SL::DB::Manager::Letter->find_by_or_create(id => $::form->{letter}{id} || 0)
534 ->assign_attributes(%{ $::form->{letter} });
536 if ($letter->cp_id) {
537 # $letter->vc_id($letter->contact->cp_cv_id);
538 # contacts don't have language_id yet
539 # $letter->greeting(GenericTranslations->get(
540 # translation_type => 'greetings::' . ($letter->contact->cp_gender eq 'f' ? 'female' : 'male'),
541 # language_id => $letter->contact->language_id,
542 # allow_fallback => 1
552 SL::Controller::Helper::GetModels->new(
555 sorted => \%sort_columns,
556 with_objects => [ 'contact', 'salesman', 'employee' ],
560 sub init_all_employees {
561 SL::DB::Manager::Employee->get_all(query => [ deleted => 0 ]);
564 sub check_auth_edit {
565 $::auth->assert('sales_letter_edit');
568 sub check_auth_report {
569 $::auth->assert('sales_letter_report');
580 SL::Controller::Letter - Letters CRUD and printing
584 Simple letter CRUD controller with drafting capabilities.
588 Customer/Vendor switch for dealing with vendor letters
590 copy to webdav is crap
592 customer/vendor stuff
596 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>