1 package SL::Controller::Letter;
4 use parent qw(SL::Controller::Base);
8 use POSIX qw(strftime);
9 use SL::Controller::Helper::GetModels;
10 use SL::Controller::Helper::ReportGenerator;
15 use SL::DB::LetterDraft;
17 use SL::Helper::Flash qw(flash flash_later);
18 use SL::Helper::CreatePDF;
19 use SL::Helper::PrintOptions;
20 use SL::Locale::String qw(t8);
23 use SL::Presenter::Tag qw(select_tag);
24 use SL::ReportGenerator;
28 use Rose::Object::MakeMethods::Generic (
29 'scalar --get_set_init' => [ qw(letter all_employees models webdav_objects is_sales) ],
32 __PACKAGE__->run_before('check_auth_edit');
33 __PACKAGE__->run_before('check_auth_report', only => [ qw(list) ]);
35 use constant TEXT_CREATED_FOR_VALUES => (qw(presskit fax letter));
36 use constant PAGE_CREATED_FOR_VALUES => (qw(sketch 1 2));
40 subject => t8('Subject'),
41 letternumber => t8('Letternumber'),
42 customer_id => t8('Customer'),
43 vendor_id => t8('Vendor'),
44 contact => t8('Contact'),
50 my ($self, %params) = @_;
52 return if $self->load_letter_draft(%params);
54 $self->letter->employee_id(SL::DB::Manager::Employee->current->id);
55 $self->letter->salesman_id(SL::DB::Manager::Employee->current->id);
58 title => t8('Add Letter'),
59 language_id => $params{language_id},
64 my ($self, %params) = @_;
66 return $self->action_add
67 unless $::form->{letter} || $::form->{draft};
69 if ($::form->{draft}) {
70 $self->letter(SL::DB::Letter->new_from_draft($::form->{draft}{id}));
71 $self->is_sales($self->letter->is_sales);
75 title => t8('Edit Letter'),
80 my ($self, %params) = @_;
82 my $letter = $self->_update;
84 if (!$self->check_letter($letter)) {
85 return $self->_display;
91 flash('error', t8('There was an error saving the letter'));
92 return $self->_display;
95 flash('info', t8('Letter saved!'));
100 sub action_update_contacts {
103 my $letter = $self->letter;
105 if (!$self->letter->has_customer_vendor) {
109 select_tag('letter.cp_id', [], value_key => 'cp_id', title_key => 'full_name')
114 my $contacts = $letter->customer_vendor->contacts;
117 if ( $letter->contact
118 && $letter->contact->cp_cv_id
119 && $letter->contact->cp_cv_id == $letter->customer_vendor_id) {
120 $default = $letter->contact->cp_id;
128 select_tag('letter.cp_id', $contacts, default => $default, value_key => 'cp_id', title_key => 'full_name')
133 sub action_save_letter_draft {
134 my ($self, %params) = @_;
138 my $letter_draft = SL::DB::LetterDraft->new_from_letter($self->_update);
140 if (!$letter_draft->save) {
141 flash('error', t8('There was an error saving the letter draft'));
142 return $self->_display;
145 flash('info', t8('Draft for this Letter saved!'));
151 my ($self, %params) = @_;
153 if (!$self->letter->delete) {
154 flash('error', t8('An error occurred. Letter could not be deleted.'));
155 return $self->action_update;
158 flash_later('info', t8('Letter deleted'));
159 $self->redirect_to(action => 'list');
162 sub action_delete_letter_drafts {
163 my ($self, %params) = @_;
165 my @ids = grep { /^checked_(.*)/ && $::form->{$_} } keys %$::form;
167 SL::DB::Manager::LetterDraft->delete_all(query => [ ids => \@ids ]) if @ids;
169 $self->redirect_to(action => 'add');
173 my ($self, %params) = @_;
175 $self->setup_list_action_bar;
176 $self->make_filter_summary;
177 $self->prepare_report;
179 my $letters = $self->models->get;
180 $self->report_generator_list_objects(report => $self->{report}, objects => $letters);
184 sub action_print_letter {
185 my ($self, %params) = @_;
187 my $letter = $self->_update;
189 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
191 printer_id => $::form->{printer_id},
192 language_id => $::form->{language_id},
193 formname => 'letter',
197 if (!defined $template_file) {
198 $::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));
203 %result = SL::Template::LaTeX->parse_and_create_pdf(
209 formname => 'letter',
210 language => SL::DB::Manager::Language->find_by_or_create(id => $::form->{language_id}*1),
212 format => $::form->{format},
213 media => $::form->{media},
214 printer => SL::DB::Manager::Printer->find_by_or_create(id => $::form->{printer_id} || undef),
215 today => DateTime->today,
219 die $result{error} if $result{error};
221 $::form->{type} = 'letter';
222 $::form->{formname} = 'letter';
223 $::form->{letternumber} = $letter->letternumber;
224 my $attachment_name = $::form->generate_attachment_filename;
226 if ($::instance_conf->get_webdav_documents) {
227 my $webdav_file = SL::Webdav::File->new(
228 filename => $attachment_name,
229 webdav => SL::Webdav->new(
231 number => $letter->letternumber,
235 $webdav_file->store(file => $result{file_name});
238 # set some form defaults for printing webdav copy variables
239 if ( $::form->{media} eq 'email') {
240 my $mail = Mailer->new;
241 my $signature = $::myconfig{signature};
242 $mail->{$_} = $params{email}->{$_} for qw(to cc subject message bcc);
243 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
244 $mail->{attachments} = [{ path => $result{file_name},
245 name => $params{email}->{attachment_filename} }];
246 $mail->{message} .= "\n-- \n$signature";
247 $mail->{message} =~ s/\r//g;
248 $mail->{record_id} = $letter->id;
250 unlink $result{file_name};
252 flash_later('info', t8('The email has been sent.'));
253 $self->redirect_to(action => 'edit', 'letter.id' => $letter->id);
258 if (!$::form->{printer_id} || $::form->{media} eq 'screen') {
259 $self->send_file($result{file_name}, name => $attachment_name);
260 unlink $result{file_name};
265 my $printer = SL::DB::Printer->new(id => $::form->{printer_id})->load;
266 $printer->print_document(
267 copies => $::form->{copies},
268 file_name => $result{file_name},
271 unlink $result{file_name};
273 flash_later('info', t8('The documents have been sent to the printer \'#1\'.', $printer->printer_description));
274 $self->redirect_to(action => 'edit', 'letter.id' => $letter->id, media => 'printer', printer_id => $::form->{printer_id});
277 unlink $result{file_name} if $result{file_name};
278 $::form->error(t8("Creating the PDF failed:") . " " . $@);
283 my ($self, $name_selected) = @_;
286 letter => $self->_update,
290 sub action_skip_draft {
292 $self->action_add(skip_drafts => 1);
295 sub action_delete_drafts {
298 my @ids = @{ $::form->{ids} || [] };
299 SL::DB::Manager::LetterDraft->delete_all(where => [ id => \@ids ]) if @ids;
301 $self->action_add(skip_drafts => 1);
304 sub action_send_email {
307 $::form->{media} = 'email';
308 $self->action_print_letter(email => $::form->{email_form});
314 my ($self, %params) = @_;
316 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery kivi.Letter kivi.SalesPurchase);
318 my $letter = $self->letter;
320 $params{title} ||= t8('Edit Letter');
322 $::form->{type} = 'letter'; # needed for print_options
323 $::form->{vc} = $letter->is_sales ? 'customer' : 'vendor'; # needs to be for _get_contacts...
325 $::form->{language_id} ||= $params{language_id};
326 $::form->{languages} ||= SL::DB::Manager::Language->get_all_sorted;
327 $::form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
329 $self->setup_display_action_bar;
330 $self->render('letter/edit',
332 TCF => [ map { key => $_, value => t8(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ],
333 PCF => [ map { key => $_, value => t8(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ],
335 employees => $self->all_employees,
336 print_options => SL::Helper::PrintOptions->get_print_options (
337 options => { no_postscript => 1,
338 no_opendocument => 1,
348 my ($self, %params) = @_;
350 my $letter = $self->letter;
353 $self->set_greetings;
361 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
362 $self->{report} = $report;
364 my @columns = qw(date subject letternumber customer_id vendor_id contact date);
365 my @sortable = qw(date subject letternumber customer_id vendor_id contact date);
368 date => { text => t8('Date'), sub => sub { $_[0]->date_as_date } },
369 subject => { text => t8('Subject'), sub => sub { $_[0]->subject },
370 obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) } },
371 letternumber => { text => t8('Letternumber'), sub => sub { $_[0]->letternumber },
372 obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) } },
373 customer_id => { text => t8('Customer'), sub => sub { SL::DB::Manager::Customer->find_by_or_create(id => $_[0]->customer_id)->displayable_name }, visible => $self->is_sales },
374 vendor_id => { text => t8('Vendor'), sub => sub { SL::DB::Manager::Vendor->find_by_or_create(id => $_[0]->vendor_id)->displayable_name }, visible => !$self->is_sales},
375 contact => { text => t8('Contact'), sub => sub { $_[0]->contact ? $_[0]->contact->full_name : '' } },
378 $column_defs{$_}{text} = $sort_columns{$_} for keys %column_defs;
380 $report->set_options(
381 std_column_visibility => 1,
382 controller_class => 'Letter',
383 output_format => 'HTML',
384 title => t8('Letters'),
385 allow_pdf_export => 1,
386 allow_csv_export => 1,
389 $report->set_columns(%column_defs);
390 $report->set_column_order(@columns);
391 $report->set_export_options(qw(list filter is_sales));
392 $report->set_options_from_form;
394 $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
395 $self->models->add_additional_url_params(is_sales => $self->is_sales);
396 $self->models->finalize;
397 $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
399 $report->set_options(
400 raw_top_info_text => $self->render('letter/report_top', { output => 0 }),
401 raw_bottom_info_text => $self->render('letter/report_bottom', { output => 0 }, models => $self->models),
402 attachment_basename => t8('letters_list') . strftime('_%Y%m%d', localtime time),
406 sub make_filter_summary {
409 my $filter = $::form->{filter} || {};
412 my $employee = $filter->{employee_id} ? SL::DB::Employee->new(id => $filter->{employee_id})->load->name : '';
413 my $salesman = $filter->{salesman_id} ? SL::DB::Employee->new(id => $filter->{salesman_id})->load->name : '';
416 [ $filter->{"letternumber:substr::ilike"}, t8('Number') ],
417 [ $filter->{"subject:substr::ilike"}, t8('Subject') ],
418 [ $filter->{"body:substr::ilike"}, t8('Body') ],
419 [ $filter->{"date:date::ge"}, t8('From Date') ],
420 [ $filter->{"date:date::le"}, t8('To Date') ],
421 [ $employee, t8('Employee') ],
422 [ $salesman, t8('Salesman') ],
427 my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
430 push @filter_strings, $_ if $_;
433 push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
436 $self->{filter_summary} = join ', ', @filter_strings;
439 sub load_letter_draft {
440 my ($self, %params) = @_;
442 return 0 if $params{skip_drafts};
444 my $letter_drafts = SL::DB::Manager::LetterDraft->get_all(
446 SL::DB::Manager::Letter->is_sales_filter($self->is_sales),
450 return unless @$letter_drafts;
452 $self->setup_load_letter_draft_action_bar;
453 $self->render('letter/load_drafts',
454 title => t8('Letter Draft'),
455 LETTER_DRAFTS => $letter_drafts,
463 my $letter = $self->letter;
465 return unless $letter;
466 return if $letter->date;
468 $letter->date(DateTime->today)
472 my ($self, $letter) = @_;
474 $letter ||= $self->letter;
478 if (!$letter->subject) {
479 flash('error', t8('The subject is missing.'));
482 if (!$letter->body) {
483 flash('error', t8('The body is missing.'));
486 if (!$letter->employee_id) {
487 flash('error', t8('The employee is missing.'));
495 my ($self, $letter) = @_;
497 $letter ||= $self->letter;
499 return if $letter->letternumber;
501 $letter->letternumber(SL::TransNumber->new(type => 'letter', id => $self->{id}, number => $self->{letternumber})->create_unique);
506 my $letter = $self->letter;
508 return unless $letter;
509 return if $letter->greeting;
511 $letter->greeting(t8('Dear Sir or Madam,'));
517 my $letter = SL::DB::Manager::Letter->find_by_or_create(id => $::form->{letter}{id} || 0)
518 ->assign_attributes(%{ $::form->{letter} });
520 if ($letter->cp_id) {
521 # $letter->customer_vendor_id($letter->contact->cp_cv_id);
522 # contacts don't have language_id yet
523 # $letter->greeting(GenericTranslations->get(
524 # translation_type => 'greetings::' . ($letter->contact->cp_gender eq 'f' ? 'female' : 'male'),
525 # language_id => $letter->contact->language_id,
526 # allow_fallback => 1
530 $self->is_sales($letter->is_sales) if $letter->id;
538 SL::Controller::Helper::GetModels->new(
542 SL::DB::Manager::Letter->is_sales_filter($self->is_sales),
544 sorted => \%sort_columns,
545 with_objects => [ 'contact', 'salesman', 'employee' ],
549 sub init_all_employees {
550 SL::DB::Manager::Employee->get_all(query => [ deleted => 0 ]);
553 sub init_webdav_objects {
556 return [] if !$self->letter || !$self->letter->letternumber || !$::instance_conf->get_webdav;
558 my $webdav = SL::Webdav->new(
560 number => $self->letter->letternumber,
563 my @all_objects = $webdav->get_all_objects;
566 +{ name => $_->filename,
568 link => File::Spec->catfile($_->full_filedescriptor),
574 die 'is_sales must be set' unless defined $::form->{is_sales};
578 sub check_auth_edit {
579 $::form->{is_sales} ? $::auth->assert('sales_letter_edit')
580 : $::auth->assert('purchase_letter_edit');
583 sub check_auth_report {
584 $::form->{is_sales} ? $::auth->assert('sales_letter_report')
585 : $::auth->assert('purchase_letter_report');
588 sub setup_load_letter_draft_action_bar {
589 my ($self, %params) = @_;
591 for my $bar ($::request->layout->get('actionbar')) {
595 link => $self->url_for(action => 'skip_draft', is_sales => $self->is_sales),
596 accesskey => 'enter',
600 submit => [ '#form', { action => 'delete_drafts' } ],
601 checks => [ [ 'kivi.check_if_entries_selected', '[name="ids[+]"]' ] ],
602 confirm => t8('Do you really want to delete this draft?'),
608 sub setup_display_action_bar {
609 my ($self, %params) = @_;
611 for my $bar ($::request->layout->get('actionbar')) {
615 submit => [ '#form', { action => 'Letter/update' } ],
616 accesskey => 'enter',
622 submit => [ '#form', { action => 'Letter/save' } ],
626 submit => [ '#form', { action => 'Letter/save_letter_draft' } ],
628 ], # end of combobox "Save"
632 submit => [ '#form', { action => 'Letter/delete' } ],
633 confirm => t8('Are you sure you want to delete this letter?'),
634 disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
638 action => [ t8('Export') ],
641 call => [ 'kivi.SalesPurchase.show_print_dialog', 'Letter/print_letter' ],
642 disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
646 call => [ 'kivi.SalesPurchase.show_email_dialog', 'Letter/send_email' ],
647 disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
654 sub setup_list_action_bar {
655 my ($self, %params) = @_;
657 for my $bar ($::request->layout->get('actionbar')) {
661 submit => [ '#search_form', { action => 'Letter/list' } ],
662 accesskey => 'enter',
676 SL::Controller::Letter - Letters CRUD and printing
680 Simple letter CRUD controller with drafting capabilities.
682 copy to webdav is crap
686 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>