SL/Controller/Letter.pm

   1 package SL::Controller::Letter;
   2
   3 use strict;
   4 use parent qw(SL::Controller::Base);
   5
   6 use POSIX qw(strftime);
   7 use SL::Controller::Helper::GetModels;
   8 use SL::Controller::Helper::ReportGenerator;
   9 use SL::DB::Letter;
  10 use SL::DB::LetterDraft;
  11 use SL::DB::Employee;
  12 use SL::Helper::Flash qw(flash);
  13 use SL::Helper::CreatePDF;
  14 use SL::Helper::PrintOptions;
  15 use SL::Locale::String qw(t8);
  16 use SL::IS;
  17 use SL::ReportGenerator;
  18
  19 use Rose::Object::MakeMethods::Generic (
  20   'scalar --get_set_init' => [ qw(letter all_employees models) ],
  21 );
  22
  23 __PACKAGE__->run_before('check_auth_edit');
  24 __PACKAGE__->run_before('check_auth_report', only => [ qw(list) ]);
  25
  26 use constant TEXT_CREATED_FOR_VALUES => (qw(presskit fax letter));
  27 use constant PAGE_CREATED_FOR_VALUES => (qw(sketch 1 2));
  28
  29 my %sort_columns = (
  30   date                  => t8('Date'),
  31   subject               => t8('Subject'),
  32   letternumber          => t8('Letternumber'),
  33   vc_id                 => t8('Customer'),
  34   contact               => t8('Contact'),
  35 );
  36
  37 sub action_add {
  38   my ($self, %params) = @_;
  39
  40   return if $self->load_letter_draft(%params);
  41
  42   $self->letter->employee_id(SL::DB::Manager::Employee->current->id);
  43   $self->letter->salesman_id(SL::DB::Manager::Employee->current->id);
  44
  45   $self->_display(
  46     title       => t8('Add Letter'),
  47     language_id => $params{language_id},
  48   );
  49 }
  50
  51 sub action_edit {
  52   my ($self, %params) = @_;
  53
  54   return $self->action_add
  55     unless $::form->{letter} || $::form->{draft};
  56
  57   $self->letter(SL::DB::Letter->new_from_draft($::form->{draft}{id}))
  58     if $::form->{draft};
  59
  60   $self->_display(
  61     title  => t8('Edit Letter'),
  62   );
  63 }
  64
  65 sub action_save {
  66   my ($self, %params) = @_;
  67
  68   my $letter = $self->_update;
  69
  70   if (!$self->check_letter($letter)) {
  71     return $self->_display;
  72   }
  73
  74   $self->check_number;
  75
  76   if (!$letter->save) {
  77     flash('error', t8('There was an error saving the letter'));
  78     return $self->_display;
  79   }
  80
  81   flash('info', t8('Letter saved!'));
  82
  83   $self->_display;
  84 }
  85
  86 sub action_update_contacts {
  87   my ($self) = @_;
  88
  89   my $letter = $self->letter;
  90
  91   if (!$self->letter->vc_id || !$self->letter->customer) {
  92     return $self->js
  93       ->replaceWith(
  94         '#letter_cp_id',
  95         SL::Presenter->get->select_tag('letter.cp_id', [], value_key => 'cp_id', title_key => 'full_name')
  96       )
  97       ->render;
  98   }
  99
 100   my $contacts = $letter->customer->contacts;
 101
 102   my $default;
 103   if (   $letter->contact
 104       && $letter->contact->cp_cv_id
 105       && $letter->contact->cp_cv_id == $letter->vc_id) {
 106     $default = $letter->contact->cp_id;
 107   } else {
 108     $default = '';
 109   }
 110
 111   $self->js
 112     ->replaceWith(
 113       '#letter_cp_id',
 114       SL::Presenter->get->select_tag('letter.cp_id', $contacts, default => $default, value_key => 'cp_id', title_key => 'full_name')
 115     )
 116     ->render;
 117 }
 118
 119 sub action_save_letter_draft {
 120   my ($self, %params) = @_;
 121
 122   $self->check_letter;
 123
 124   my $letter_draft = SL::DB::LetterDraft->new_from_letter($self->_update);
 125
 126   if (!$letter_draft->save) {
 127     flash('error', t8('There was an error saving the letter draft'));
 128     return $self->_display;
 129   }
 130
 131   flash('info', t8('Draft for this Letter saved!'));
 132
 133   $self->_display;
 134 }
 135
 136 sub action_delete {
 137   my ($self, %params) = @_;
 138
 139   if (!$self->letter->delete) {
 140     flash('error', t8('An error occured. Letter could not be deleted.'));
 141     return $self->action_update;
 142   }
 143
 144   flash_later('info', t8('Letter deleted'));
 145   $self->redirect_to(action => 'list');
 146 }
 147
 148 sub action_delete_letter_drafts {
 149   my ($self, %params) = @_;
 150
 151   my @ids =  grep { /^checked_(.*)/ && $::form->{$_} } keys %$::form;
 152
 153   SL::DB::Manager::LetterDraft->delete_all(query => [ ids => \@ids ]) if @ids;
 154
 155   $self->redirect_to(action => 'add');
 156 }
 157
 158 sub action_list {
 159   my ($self, %params) = @_;
 160
 161   $self->make_filter_summary;
 162   $self->prepare_report;
 163
 164   my $letters = $self->models->get;
 165   $self->report_generator_list_objects(report => $self->{report}, objects => $letters);
 166
 167 }
 168
 169 sub action_print_letter {
 170   my ($self, $old_form) = @_;
 171
 172   my $display_form = $::form->{display_form} || "display_form";
 173   my $letter       = $self->_update;
 174
 175   $self->export_letter_to_form($letter);
 176   $::form->{formname} = "letter";
 177   $::form->{type}     = "letter";
 178   $::form->{format}   = "pdf";
 179
 180   my $language_saved      = $::form->{language_id};
 181   my $greeting_saved      = $::form->{greeting};
 182   my $cp_id_saved         = $::form->{cp_id};
 183
 184   $::form->{customer_id} = $self->letter->vc_id;
 185   IS->customer_details(\%::myconfig, $::form);
 186
 187   if (!$cp_id_saved) {
 188     # No contact was selected. Delete all contact variables because
 189     # IS->customer_details() and IR->vendor_details() get the default
 190     # contact anyway.
 191     map({ delete($::form->{$_}); } grep(/^cp_/, keys(%{ $::form })));
 192   }
 193
 194   $::form->{greeting} = $greeting_saved;
 195   $::form->{language_id} = $language_saved;
 196
 197   if ($::form->{cp_id}) {
 198     CT->get_contact(\%::myconfig, $::form);
 199   }
 200
 201   $::form->{cp_contact_formal} = ($::form->{cp_greeting} ? "$::form->{cp_greeting} " : '') . ($::form->{cp_givenname} ? "$::form->{cp_givenname} " : '') . $::form->{cp_name};
 202
 203   $::form->get_employee_data('prefix' => 'employee', 'id' => $letter->{employee_id});
 204   $::form->get_employee_data('prefix' => 'salesman', 'id' => $letter->{salesman_id});
 205
 206   my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
 207     name        => 'letter',
 208     printer_id  => $::form->{printer_id},
 209     language_id => $::form->{language_id},
 210     formname    => 'letter',
 211     format      => 'pdf',
 212   );
 213
 214   if (!defined $template_file) {
 215     $::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));
 216   }
 217
 218   my %create_params = (
 219     template  => $template_file,
 220     variables => $::form,
 221     return    => 'file_name',
 222   );
 223
 224   my $pdf_file_name;
 225   eval {
 226     $pdf_file_name = SL::Helper::CreatePDF->create_pdf(%create_params);
 227
 228     # set some form defaults for printing webdav copy variables
 229     if ( $::form->{media} eq 'email') {
 230       my $mail             = Mailer->new;
 231       my $signature        = $::myconfig{signature};
 232       $mail->{$_}          = $::form->{$_}               for qw(cc subject message bcc to);
 233       $mail->{from}        = qq|"$::myconfig{name}" <$::myconfig{email}>|;
 234       $mail->{fileid}      = time() . '.' . $$ . '.';
 235       $mail->{attachments} =  [{ "filename" => $pdf_file_name,
 236                                  "name"     => $::form->{attachment_name} }];
 237       $mail->{message}    .=  "\n-- \n$signature";
 238       $mail->{message}     =~ s/\r//g;
 239
 240       # copy_file_to_webdav was already done via io.pl -> edit_e_mail
 241       my $err = $mail->send;
 242       return !$err;
 243     }
 244
 245     if (!$::form->{printer_id} || $::form->{media} eq 'screen') {
 246
 247       my $file = IO::File->new($pdf_file_name, 'r') || croak("Cannot open file '$pdf_file_name'");
 248       my $size = -s $pdf_file_name;
 249       my $content_type    =  'application/pdf';
 250       $::form->{letternumber} = $self->letter->letternumber;
 251       my $attachment_name =  $::form->generate_attachment_filename;
 252       $attachment_name    =~ s:.*//::g;
 253
 254       print $::form->create_http_response(content_type        => $content_type,
 255                                           content_disposition => 'attachment; filename="' . $attachment_name . '"',
 256                                           content_length      => $size);
 257
 258       $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
 259       $file->close;
 260
 261       Common::copy_file_to_webdav_folder($::form) if $::instance_conf->get_webdav_documents;
 262       unlink $pdf_file_name;
 263       return 1;
 264     }
 265
 266     my $printer = SL::DB::Printer->new(id => $::form->{printer_id})->load;
 267     my $command = SL::Template::create(type => 'ShellCommand', form => Form->new(''))->parse($printer->printer_command);
 268
 269     open my $out, '|-', $command or die $!;
 270     binmode $out;
 271     print $out scalar(read_file($pdf_file_name));
 272     close $out;
 273     Common::copy_file_to_webdav_folder($::form) if $::instance_conf->get_webdav_documents;
 274
 275     flash_later('info', t8('The documents have been sent to the printer \'#1\'.', $printer->printer_description));
 276     $self->redirect_to(action => 'edit', id => $letter->{id}, 'printer_id' => $::form->{printer_id});
 277     1;
 278   } or do {
 279     unlink $pdf_file_name;
 280     $::form->error(t8("Creating the PDF failed:") . " " . $@);
 281   };
 282
 283 }
 284
 285 sub action_update {
 286   my ($self, $name_selected) = @_;
 287
 288   $self->_display(
 289     letter => $self->_update,
 290   );
 291 }
 292
 293 sub action_skip_draft {
 294   my ($self) = @_;
 295   $self->action_add(skip_drafts => 1);
 296 }
 297
 298 sub action_delete_drafts {
 299   my ($self) = @_;
 300   delete_letter_drafts();
 301   $self->action_add(skip_drafts => 1);
 302 }
 303
 304 sub _display {
 305   my ($self, %params) = @_;
 306
 307   my $letter = $self->letter;
 308
 309  $params{title} ||= t8('Edit Letter');
 310
 311   $::form->{type}             = 'letter';   # needed for print_options
 312   $::form->{vc}               = 'customer'; # needs to be for _get_contacts...
 313
 314   $::request->layout->add_javascripts('customer_or_vendor_selection.js');
 315   $::request->layout->add_javascripts('edit_part_window.js');
 316
 317   $::form->{language_id} ||= $params{language_id};
 318
 319   $self->render('letter/edit',
 320     %params,
 321     TCF           => [ map { key => $_, value => t8(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ],
 322     PCF           => [ map { key => $_, value => t8(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ],
 323     letter        => $letter,
 324     employees     => $self->all_employees,
 325     print_options => SL::Helper::PrintOptions->get_print_options (
 326       options => { no_postscript   => 1,
 327                    no_opendocument => 1,
 328                    no_html         => 1,
 329                    no_queue        => 1 }),
 330
 331   );
 332 }
 333
 334 sub _update {
 335   my ($self, %params) = @_;
 336
 337   my $letter = $self->letter;
 338
 339   $self->check_date;
 340   $self->set_greetings;
 341
 342   return $letter;
 343 }
 344
 345 sub prepare_report {
 346   my ($self) = @_;
 347
 348   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 349   $self->{report} = $report;
 350
 351   my @columns  = qw(date subject letternumber vc_id contact date);
 352   my @sortable = qw(date subject letternumber vc_id contact date);
 353
 354   my %column_defs = (
 355     date                  => { text => t8('Date'),         sub => sub { $_[0]->date_as_date } },
 356     subject               => { text => t8('Subject'),      sub => sub { $_[0]->subject },
 357                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 358     letternumber          => { text => t8('Letternumber'), sub => sub { $_[0]->letternumber },
 359                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 360     vc_id                 => { text => t8('Customer'),      sub => sub { SL::DB::Manager::Customer->find_by_or_create(id => $_[0]->vc_id)->displayable_name } },
 361     contact               => { text => t8('Contact'),       sub => sub { $_[0]->contact ? $_[0]->contact->full_name : '' } },
 362   );
 363
 364   $column_defs{$_}{text} = $sort_columns{$_} for keys %column_defs;
 365
 366   $report->set_options(
 367     std_column_visibility => 1,
 368     controller_class      => 'Letter',
 369     output_format         => 'HTML',
 370     top_info_text         => t8('Letters'),
 371     title                 => t8('Letters'),
 372     allow_pdf_export      => 1,
 373     allow_csv_export      => 1,
 374   );
 375
 376   $report->set_columns(%column_defs);
 377   $report->set_column_order(@columns);
 378   $report->set_export_options(qw(list filter));
 379   $report->set_options_from_form;
 380
 381   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 382   $self->models->finalize;
 383   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 384
 385   $report->set_options(
 386     raw_top_info_text    => $self->render('letter/report_top',    { output => 0 }),
 387     raw_bottom_info_text => $self->render('letter/report_bottom', { output => 0 }, models => $self->models),
 388     attachment_basename  => t8('letters_list') . strftime('_%Y%m%d', localtime time),
 389   );
 390 }
 391
 392 sub make_filter_summary {
 393   my ($self) = @_;
 394
 395   my $filter = $::form->{filter} || {};
 396   my @filter_strings;
 397
 398   my $employee = $filter->{employee_id} ? SL::DB::Employee->new(id => $filter->{employee_id})->load->name : '';
 399   my $salesman = $filter->{salesman_id} ? SL::DB::Employee->new(id => $filter->{salesman_id})->load->name : '';
 400
 401   my @filters = (
 402     [ $filter->{"letternumber:substr::ilike"},  t8('Number')     ],
 403     [ $filter->{"subject:substr::ilike"},       t8('Subject')    ],
 404     [ $filter->{"body:substr::ilike"},          t8('Body')       ],
 405     [ $filter->{"date:date::ge"},               t8('From Date')  ],
 406     [ $filter->{"date:date::le"},               t8('To Date')    ],
 407     [ $employee,                                t8('Employee')   ],
 408     [ $salesman,                                t8('Salesman')   ],
 409   );
 410
 411   my %flags = (
 412   );
 413   my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
 414
 415   for (@flags) {
 416     push @filter_strings, $_ if $_;
 417   }
 418   for (@filters) {
 419     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 420   }
 421
 422   $self->{filter_summary} = join ', ', @filter_strings;
 423 }
 424
 425 sub e_mail {
 426   my $letter = _update();
 427
 428   $letter->check_number;
 429   $letter->save;
 430
 431   $::form->{formname} = "letter";
 432   $letter->export_to($::form);
 433
 434   $::form->{id} = $letter->{id};
 435   edit_e_mail();
 436 }
 437
 438 sub load_letter_draft {
 439   my ($self, %params) = @_;
 440
 441   return 0 if $params{skip_drafts};
 442
 443   my $letter_drafts = SL::DB::Manager::LetterDraft->get_all;
 444
 445   return unless @$letter_drafts;
 446
 447   $self->render('letter/load_drafts',
 448     title         => t8('Letter Draft'),
 449     LETTER_DRAFTS => $letter_drafts,
 450   );
 451
 452   return 1;
 453 }
 454
 455 sub check_date {
 456   my ($self) = @_;
 457   my $letter = $self->letter;
 458
 459   return unless $letter;
 460   return if $letter->date;
 461
 462   $letter->date(DateTime->today)
 463 }
 464
 465 sub check_letter {
 466   my ($self, $letter) = @_;
 467
 468   $letter ||= $self->letter;
 469
 470   my $error;
 471
 472   if (!$letter->subject) {
 473     flash('error', t8('The subject is missing.'));
 474     $error = 1;
 475   }
 476   if (!$letter->body) {
 477     flash('error', t8('The body is missing.'));
 478     $error = 1;
 479   }
 480   if (!$letter->employee_id) {
 481     flash('error', t8('The employee is missing.'));
 482     $error = 1;
 483   }
 484
 485   return !$error;
 486 }
 487
 488 sub check_number {
 489   my ($self, $letter) = @_;
 490
 491   $letter ||= $self->letter;
 492
 493   return if $letter->letternumber;
 494
 495   $letter->letternumber(SL::TransNumber->new(type => 'letter', id => $self->{id}, number => $self->{letternumber})->create_unique);
 496 }
 497
 498 sub set_greetings {
 499   my ($self) = @_;
 500   my $letter = $self->letter;
 501
 502   return unless $letter;
 503   return if $letter->greeting;
 504
 505   $letter->greeting(t8('Dear Sir or Madam,'));
 506 }
 507
 508 sub export_letter_to_form {
 509   my ($self, $letter) = @_;
 510   # nope, not pretty.
 511
 512   $letter ||= $self->letter;
 513
 514   for ($letter->meta->columns) {
 515     if ((ref $_) =~ /Date/i) {
 516       $::form->{$_->name} = $letter->$_->to_kivitendo;
 517     } else {
 518       $::form->{$_->name} = $letter->$_;
 519     }
 520   }
 521 }
 522
 523 sub init_letter {
 524   my ($self) = @_;
 525
 526   my $letter      = SL::DB::Manager::Letter->find_by_or_create(id => $::form->{letter}{id} || 0)
 527                                            ->assign_attributes(%{ $::form->{letter} });
 528
 529   if ($letter->cp_id) {
 530 #     $letter->vc_id($letter->contact->cp_cv_id);
 531       # contacts don't have language_id yet
 532 #     $letter->greeting(GenericTranslations->get(
 533 #       translation_type => 'greetings::' . ($letter->contact->cp_gender eq 'f' ? 'female' : 'male'),
 534 #       language_id      => $letter->contact->language_id,
 535 #       allow_fallback   => 1
 536 #     ));
 537   }
 538
 539   $letter;
 540 }
 541
 542 sub init_models {
 543   my ($self) = @_;
 544
 545   SL::Controller::Helper::GetModels->new(
 546     controller   => $self,
 547     model        => 'Letter',
 548     sorted       => \%sort_columns,
 549     with_objects => [ 'contact', 'salesman', 'employee' ],
 550   );
 551 }
 552
 553 sub init_all_employees {
 554   SL::DB::Manager::Employee->get_all(query => [ deleted => 0 ]);
 555 }
 556
 557 sub check_auth_edit {
 558   $::auth->assert('sales_letter_edit');
 559 }
 560
 561 sub check_auth_report {
 562   $::auth->assert('sales_letter_report');
 563 }
 564
 565 1;
 566
 567 __END__
 568
 569 =encoding utf-8
 570
 571 =head1 NAME
 572
 573 SL::Controller::Letter - Letters CRUD and printing
 574
 575 =head1 DESCRIPTION
 576
 577 Simple letter CRUD controller with drafting capabilities.
 578
 579 =head1 TODO
 580
 581   Customer/Vendor switch for dealing with vendor letters
 582
 583 copy to webdav is crap
 584
 585 customer/vendor stuff
 586
 587 =head1 AUTHOR
 588
 589 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
 590
 591 =cut