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