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::ReportGenerator;
 
  27 use Rose::Object::MakeMethods::Generic (
 
  28   'scalar --get_set_init' => [ qw(letter all_employees models webdav_objects is_sales) ],
 
  31 __PACKAGE__->run_before('check_auth_edit');
 
  32 __PACKAGE__->run_before('check_auth_report', only => [ qw(list) ]);
 
  34 use constant TEXT_CREATED_FOR_VALUES => (qw(presskit fax letter));
 
  35 use constant PAGE_CREATED_FOR_VALUES => (qw(sketch 1 2));
 
  39   subject               => t8('Subject'),
 
  40   letternumber          => t8('Letternumber'),
 
  41   customer_id           => t8('Customer'),
 
  42   vendor_id             => t8('Vendor'),
 
  43   contact               => t8('Contact'),
 
  49   my ($self, %params) = @_;
 
  51   return if $self->load_letter_draft(%params);
 
  53   $self->letter->employee_id(SL::DB::Manager::Employee->current->id);
 
  54   $self->letter->salesman_id(SL::DB::Manager::Employee->current->id);
 
  57     title       => t8('Add Letter'),
 
  58     language_id => $params{language_id},
 
  63   my ($self, %params) = @_;
 
  65   return $self->action_add
 
  66     unless $::form->{letter} || $::form->{draft};
 
  68   if ($::form->{draft}) {
 
  69     $self->letter(SL::DB::Letter->new_from_draft($::form->{draft}{id}));
 
  70     $self->is_sales($self->letter->is_sales);
 
  74     title  => t8('Edit Letter'),
 
  79   my ($self, %params) = @_;
 
  81   my $letter = $self->_update;
 
  83   if (!$self->check_letter($letter)) {
 
  84     return $self->_display;
 
  90     flash('error', t8('There was an error saving the letter'));
 
  91     return $self->_display;
 
  94   flash('info', t8('Letter saved!'));
 
  99 sub action_update_contacts {
 
 102   my $letter = $self->letter;
 
 104   if (!$self->letter->has_customer_vendor) {
 
 108         SL::Presenter->get->select_tag('letter.cp_id', [], value_key => 'cp_id', title_key => 'full_name')
 
 113   my $contacts = $letter->customer_vendor->contacts;
 
 116   if (   $letter->contact
 
 117       && $letter->contact->cp_cv_id
 
 118       && $letter->contact->cp_cv_id == $letter->customer_vendor_id) {
 
 119     $default = $letter->contact->cp_id;
 
 127       SL::Presenter->get->select_tag('letter.cp_id', $contacts, default => $default, value_key => 'cp_id', title_key => 'full_name')
 
 132 sub action_save_letter_draft {
 
 133   my ($self, %params) = @_;
 
 137   my $letter_draft = SL::DB::LetterDraft->new_from_letter($self->_update);
 
 139   if (!$letter_draft->save) {
 
 140     flash('error', t8('There was an error saving the letter draft'));
 
 141     return $self->_display;
 
 144   flash('info', t8('Draft for this Letter saved!'));
 
 150   my ($self, %params) = @_;
 
 152   if (!$self->letter->delete) {
 
 153     flash('error', t8('An error occured. Letter could not be deleted.'));
 
 154     return $self->action_update;
 
 157   flash_later('info', t8('Letter deleted'));
 
 158   $self->redirect_to(action => 'list');
 
 161 sub action_delete_letter_drafts {
 
 162   my ($self, %params) = @_;
 
 164   my @ids =  grep { /^checked_(.*)/ && $::form->{$_} } keys %$::form;
 
 166   SL::DB::Manager::LetterDraft->delete_all(query => [ ids => \@ids ]) if @ids;
 
 168   $self->redirect_to(action => 'add');
 
 172   my ($self, %params) = @_;
 
 174   $self->setup_list_action_bar;
 
 175   $self->make_filter_summary;
 
 176   $self->prepare_report;
 
 178   my $letters = $self->models->get;
 
 179   $self->report_generator_list_objects(report => $self->{report}, objects => $letters, action_bar => 1);
 
 183 sub action_print_letter {
 
 184   my ($self, %params) = @_;
 
 186   my $display_form = $::form->{display_form} || "display_form";
 
 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::Language->new,
 
 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} = [{ filename => $result{file_name},
 
 245                                 name     => $params{email}->{attachment_filename} }];
 
 246       $mail->{message}    .=  "\n-- \n$signature";
 
 247       $mail->{message}     =~ s/\r//g;
 
 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_edit_email {
 
 307   my $letter = $self->_update;
 
 308   $self->export_letter_to_form($letter);
 
 310   $::form->{formname}     = "letter";
 
 311   $::form->{type}         = "letter";
 
 312   $::form->{letternumber} = $self->letter->letternumber;
 
 315     my $value = $letter->$_;
 
 316     $value    = $value->to_kivitendo if ref($_) =~ m{Date};
 
 318     { name => "letter.$_", value => $value }
 
 319   } ($letter->meta->columns);
 
 322     script     => 'controller.pl',
 
 323     title      => t8('Send letter via e-mail'),
 
 324     email      => $letter->contact ? $letter->contact->cp_email : '',
 
 325     subject    => $::form->generate_email_subject,
 
 326     a_filename => $::form->generate_attachment_filename,
 
 328     SHOW_BCC   => $::auth->assert('email_bcc', 'may fail'),
 
 331   $::request->layout->use_javascript("kivi.SalesPurchase.js");
 
 332   $self->setup_edit_email_action_bar;
 
 333   $self->render('letter/edit_email', %vars);
 
 336 sub action_send_email {
 
 339   $::form->{media} = 'email';
 
 340   $self->action_print_letter(
 
 342       to => $::form->{email},
 
 343       map { ($_ => $::form->{$_}) } qw(cc bcc subject attachment_filename message)
 
 351   my ($self, %params) = @_;
 
 353   $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery kivi.Letter);
 
 355   my $letter = $self->letter;
 
 357  $params{title} ||= t8('Edit Letter');
 
 359   $::form->{type}             = 'letter';   # needed for print_options
 
 360   $::form->{vc}               = $letter->is_sales ? 'customer' : 'vendor'; # needs to be for _get_contacts...
 
 362   $::request->layout->add_javascripts('customer_or_vendor_selection.js');
 
 363   $::request->layout->add_javascripts('edit_part_window.js');
 
 365   $::form->{language_id} ||= $params{language_id};
 
 366   $::form->{languages}   ||= SL::DB::Manager::Language->get_all_sorted;
 
 367   $::form->{printers}      = SL::DB::Manager::Printer->get_all_sorted;
 
 369   $self->setup_display_action_bar;
 
 370   $self->render('letter/edit',
 
 372     TCF           => [ map { key => $_, value => t8(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ],
 
 373     PCF           => [ map { key => $_, value => t8(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ],
 
 375     employees     => $self->all_employees,
 
 376     print_options => SL::Helper::PrintOptions->get_print_options (
 
 377       options => { no_postscript   => 1,
 
 378                    no_opendocument => 1,
 
 386   my ($self, %params) = @_;
 
 388   my $letter = $self->letter;
 
 391   $self->set_greetings;
 
 399   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 
 400   $self->{report} = $report;
 
 402   my @columns  = qw(date subject letternumber customer_id vendor_id contact date);
 
 403   my @sortable = qw(date subject letternumber customer_id vendor_id contact date);
 
 406     date                  => { text => t8('Date'),         sub => sub { $_[0]->date_as_date } },
 
 407     subject               => { text => t8('Subject'),      sub => sub { $_[0]->subject },
 
 408                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 
 409     letternumber          => { text => t8('Letternumber'), sub => sub { $_[0]->letternumber },
 
 410                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 
 411     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 },
 
 412     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},
 
 413     contact               => { text => t8('Contact'),       sub => sub { $_[0]->contact ? $_[0]->contact->full_name : '' } },
 
 416   $column_defs{$_}{text} = $sort_columns{$_} for keys %column_defs;
 
 418   $report->set_options(
 
 419     std_column_visibility => 1,
 
 420     controller_class      => 'Letter',
 
 421     output_format         => 'HTML',
 
 422     title                 => t8('Letters'),
 
 423     allow_pdf_export      => 1,
 
 424     allow_csv_export      => 1,
 
 427   $report->set_columns(%column_defs);
 
 428   $report->set_column_order(@columns);
 
 429   $report->set_export_options(qw(list filter is_sales));
 
 430   $report->set_options_from_form;
 
 432   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 
 433   $self->models->add_additional_url_params(is_sales => $self->is_sales);
 
 434   $self->models->finalize;
 
 435   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 
 437   $report->set_options(
 
 438     raw_top_info_text    => $self->render('letter/report_top',    { output => 0 }),
 
 439     raw_bottom_info_text => $self->render('letter/report_bottom', { output => 0 }, models => $self->models),
 
 440     attachment_basename  => t8('letters_list') . strftime('_%Y%m%d', localtime time),
 
 444 sub make_filter_summary {
 
 447   my $filter = $::form->{filter} || {};
 
 450   my $employee = $filter->{employee_id} ? SL::DB::Employee->new(id => $filter->{employee_id})->load->name : '';
 
 451   my $salesman = $filter->{salesman_id} ? SL::DB::Employee->new(id => $filter->{salesman_id})->load->name : '';
 
 454     [ $filter->{"letternumber:substr::ilike"},  t8('Number')     ],
 
 455     [ $filter->{"subject:substr::ilike"},       t8('Subject')    ],
 
 456     [ $filter->{"body:substr::ilike"},          t8('Body')       ],
 
 457     [ $filter->{"date:date::ge"},               t8('From Date')  ],
 
 458     [ $filter->{"date:date::le"},               t8('To Date')    ],
 
 459     [ $employee,                                t8('Employee')   ],
 
 460     [ $salesman,                                t8('Salesman')   ],
 
 465   my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
 
 468     push @filter_strings, $_ if $_;
 
 471     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 
 474   $self->{filter_summary} = join ', ', @filter_strings;
 
 477 sub load_letter_draft {
 
 478   my ($self, %params) = @_;
 
 480   return 0 if $params{skip_drafts};
 
 482   my $letter_drafts = SL::DB::Manager::LetterDraft->get_all(
 
 484       SL::DB::Manager::Letter->is_sales_filter($self->is_sales),
 
 488   return unless @$letter_drafts;
 
 490   $self->setup_load_letter_draft_action_bar;
 
 491   $self->render('letter/load_drafts',
 
 492     title         => t8('Letter Draft'),
 
 493     LETTER_DRAFTS => $letter_drafts,
 
 501   my $letter = $self->letter;
 
 503   return unless $letter;
 
 504   return if $letter->date;
 
 506   $letter->date(DateTime->today)
 
 510   my ($self, $letter) = @_;
 
 512   $letter ||= $self->letter;
 
 516   if (!$letter->subject) {
 
 517     flash('error', t8('The subject is missing.'));
 
 520   if (!$letter->body) {
 
 521     flash('error', t8('The body is missing.'));
 
 524   if (!$letter->employee_id) {
 
 525     flash('error', t8('The employee is missing.'));
 
 533   my ($self, $letter) = @_;
 
 535   $letter ||= $self->letter;
 
 537   return if $letter->letternumber;
 
 539   $letter->letternumber(SL::TransNumber->new(type => 'letter', id => $self->{id}, number => $self->{letternumber})->create_unique);
 
 544   my $letter = $self->letter;
 
 546   return unless $letter;
 
 547   return if $letter->greeting;
 
 549   $letter->greeting(t8('Dear Sir or Madam,'));
 
 552 sub export_letter_to_form {
 
 553   my ($self, $letter) = @_;
 
 556   $letter ||= $self->letter;
 
 558   for ($letter->meta->columns) {
 
 559     if ((ref $_) =~ /Date/i) {
 
 560       $::form->{$_->name} = $letter->$_->to_kivitendo;
 
 562       $::form->{$_->name} = $letter->$_;
 
 570   my $letter      = SL::DB::Manager::Letter->find_by_or_create(id => $::form->{letter}{id} || 0)
 
 571                                            ->assign_attributes(%{ $::form->{letter} });
 
 573   if ($letter->cp_id) {
 
 574 #     $letter->customer_vendor_id($letter->contact->cp_cv_id);
 
 575       # contacts don't have language_id yet
 
 576 #     $letter->greeting(GenericTranslations->get(
 
 577 #       translation_type => 'greetings::' . ($letter->contact->cp_gender eq 'f' ? 'female' : 'male'),
 
 578 #       language_id      => $letter->contact->language_id,
 
 579 #       allow_fallback   => 1
 
 583   $self->is_sales($letter->is_sales) if $letter->id;
 
 591   SL::Controller::Helper::GetModels->new(
 
 595       SL::DB::Manager::Letter->is_sales_filter($self->is_sales),
 
 597     sorted       => \%sort_columns,
 
 598     with_objects => [ 'contact', 'salesman', 'employee' ],
 
 602 sub init_all_employees {
 
 603   SL::DB::Manager::Employee->get_all(query => [ deleted => 0 ]);
 
 606 sub init_webdav_objects {
 
 609   return [] if !$self->letter || !$self->letter->letternumber || !$::instance_conf->get_webdav;
 
 611   my $webdav = SL::Webdav->new(
 
 613     number   => $self->letter->letternumber,
 
 616   my $webdav_path = $webdav->webdav_path;
 
 617   my @all_objects = $webdav->get_all_objects;
 
 620     +{ name => $_->filename,
 
 622        link => File::Spec->catfile($_->full_filedescriptor),
 
 628   die 'is_sales must be set' unless defined $::form->{is_sales};
 
 632 sub check_auth_edit {
 
 633   $::auth->assert('sales_letter_edit');
 
 636 sub check_auth_report {
 
 637   $::auth->assert('sales_letter_report');
 
 640 sub setup_load_letter_draft_action_bar {
 
 641   my ($self, %params) = @_;
 
 643   for my $bar ($::request->layout->get('actionbar')) {
 
 647         link      => $self->url_for(action => 'skip_draft', is_sales => $self->is_sales),
 
 648         accesskey => 'enter',
 
 652         submit  => [ '#form', { action => 'delete_drafts' } ],
 
 653         checks  => [ [ 'kivi.check_if_entries_selected', '[name="ids[+]"]' ] ],
 
 654         confirm => t8('Do you really want to delete this draft?'),
 
 660 sub setup_display_action_bar {
 
 661   my ($self, %params) = @_;
 
 663   for my $bar ($::request->layout->get('actionbar')) {
 
 667         submit    => [ '#form', { action => 'Letter/update' } ],
 
 668         accesskey => 'enter',
 
 674           submit => [ '#form', { action => 'Letter/save' } ],
 
 678           submit => [ '#form', { action => 'Letter/save_letter_draft' } ],
 
 680       ], # end of combobox "Save"
 
 684         submit   => [ '#form', { action => 'Letter/delete' } ],
 
 685         confirm  => t8('Are you sure you want to delete this letter?'),
 
 686         disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
 
 690         action => [ t8('Export') ],
 
 693           submit   => [ '#form', { action => 'Letter/print_letter' } ],
 
 694           disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
 
 698           submit   => [ '#form', { action => 'Letter/edit_email' } ],
 
 699           disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
 
 706 sub setup_edit_email_action_bar {
 
 707   my ($self, %params) = @_;
 
 709   for my $bar ($::request->layout->get('actionbar')) {
 
 713         submit    => [ '#form', { action => 'Letter/send_email' } ],
 
 714         checks    => [ 'kivi.SalesPurchase.check_required_email_fields' ],
 
 715         accesskey => 'enter',
 
 721 sub setup_list_action_bar {
 
 722   my ($self, %params) = @_;
 
 724   for my $bar ($::request->layout->get('actionbar')) {
 
 728         submit    => [ '#form', { action => 'Letter/list' } ],
 
 729         checks    => [ 'kivi.SalesPurchase.check_required_email_fields' ],
 
 730         accesskey => 'enter',
 
 734         call => [ 'kivi.call_jquery', '#form', 'resetForm' ],
 
 748 SL::Controller::Letter - Letters CRUD and printing
 
 752 Simple letter CRUD controller with drafting capabilities.
 
 754 copy to webdav is crap
 
 758 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>