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->{format} = "pdf";
 178
 179   my $language_saved      = $::form->{language_id};
 180   my $greeting_saved      = $::form->{greeting};
 181   my $cp_id_saved         = $::form->{cp_id};
 182
 183   IS->customer_details(\%::myconfig, $::form);
 184
 185   if (!$cp_id_saved) {
 186     # No contact was selected. Delete all contact variables because
 187     # IS->customer_details() and IR->vendor_details() get the default
 188     # contact anyway.
 189     map({ delete($::form->{$_}); } grep(/^cp_/, keys(%{ $::form })));
 190   }
 191
 192   $::form->{greeting} = $greeting_saved;
 193   $::form->{language_id} = $language_saved;
 194
 195   if ($::form->{cp_id}) {
 196     CT->get_contact(\%::myconfig, $::form);
 197   }
 198
 199   $::form->{cp_contact_formal} = ($::form->{cp_greeting} ? "$::form->{cp_greeting} " : '') . ($::form->{cp_givenname} ? "$::form->{cp_givenname} " : '') . $::form->{cp_name};
 200
 201   $::form->get_employee_data('prefix' => 'employee', 'id' => $letter->{employee_id});
 202   $::form->get_employee_data('prefix' => 'salesman', 'id' => $letter->{salesman_id});
 203
 204   my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
 205     name        => 'letter',
 206     printer_id  => $::form->{printer_id},
 207     language_id => $::form->{language_id},
 208     formname    => 'letter',
 209     format      => 'pdf',
 210   );
 211
 212   if (!defined $template_file) {
 213     $::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));
 214   }
 215
 216   my %create_params = (
 217     template  => $template_file,
 218     variables => $::form,
 219     return    => 'file_name',
 220   );
 221
 222   my $pdf_file_name;
 223   eval {
 224     $pdf_file_name = SL::Helper::CreatePDF->create_pdf(%create_params);
 225
 226     # set some form defaults for printing webdav copy variables
 227     if ( $::form->{media} eq 'email') {
 228       my $mail             = Mailer->new;
 229       my $signature        = $::myconfig{signature};
 230       $mail->{$_}          = $::form->{$_}               for qw(cc subject message bcc to);
 231       $mail->{from}        = qq|"$::myconfig{name}" <$::myconfig{email}>|;
 232       $mail->{fileid}      = time() . '.' . $$ . '.';
 233       $mail->{attachments} =  [{ "filename" => $pdf_file_name,
 234                                  "name"     => $::form->{attachment_name} }];
 235       $mail->{message}    .=  "\n-- \n$signature";
 236       $mail->{message}     =~ s/\r//g;
 237
 238       # copy_file_to_webdav was already done via io.pl -> edit_e_mail
 239       my $err = $mail->send;
 240       return !$err;
 241     }
 242
 243     if (!$::form->{printer_id} || $::form->{media} eq 'screen') {
 244
 245       my $file = IO::File->new($pdf_file_name, 'r') || croak("Cannot open file '$pdf_file_name'");
 246       my $size = -s $pdf_file_name;
 247       my $content_type    =  'application/pdf';
 248       my $attachment_name =  $::form->generate_attachment_filename;
 249       $attachment_name    =~ s:.*//::g;
 250
 251       print $::form->create_http_response(content_type        => $content_type,
 252                                           content_disposition => 'attachment; filename="' . $attachment_name . '"',
 253                                           content_length      => $size);
 254
 255       $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
 256       $file->close;
 257
 258       Common::copy_file_to_webdav_folder($::form) if $::instance_conf->get_webdav_documents;
 259       unlink $pdf_file_name;
 260       return 1;
 261     }
 262
 263     my $printer = SL::DB::Printer->new(id => $::form->{printer_id})->load;
 264     my $command = SL::Template::create(type => 'ShellCommand', form => Form->new(''))->parse($printer->printer_command);
 265
 266     open my $out, '|-', $command or die $!;
 267     binmode $out;
 268     print $out scalar(read_file($pdf_file_name));
 269     close $out;
 270     Common::copy_file_to_webdav_folder($::form) if $::instance_conf->get_webdav_documents;
 271
 272     flash_later('info', t8('The documents have been sent to the printer \'#1\'.', $printer->printer_description));
 273     $self->redirect_to(action => 'edit', id => $letter->{id}, 'printer_id' => $::form->{printer_id});
 274     1;
 275   } or do {
 276     unlink $pdf_file_name;
 277     $::form->error(t8("Creating the PDF failed:") . " " . $@);
 278   };
 279
 280 }
 281
 282 sub action_update {
 283   my ($self, $name_selected) = @_;
 284
 285   $self->_display(
 286     letter => $self->_update,
 287   );
 288 }
 289
 290 sub action_skip_draft {
 291   my ($self) = @_;
 292   $self->action_add(skip_drafts => 1);
 293 }
 294
 295 sub action_delete_drafts {
 296   my ($self) = @_;
 297   delete_letter_drafts();
 298   $self->action_add(skip_drafts => 1);
 299 }
 300
 301 sub _display {
 302   my ($self, %params) = @_;
 303
 304   my $letter = $self->letter;
 305
 306  $params{title} ||= t8('Edit Letter');
 307
 308   $::form->{type}             = 'letter';   # needed for print_options
 309   $::form->{vc}               = 'customer'; # needs to be for _get_contacts...
 310
 311   $::request->layout->add_javascripts('customer_or_vendor_selection.js');
 312   $::request->layout->add_javascripts('edit_part_window.js');
 313
 314   $::form->{language_id} ||= $params{language_id};
 315
 316   $self->render('letter/edit',
 317     %params,
 318     TCF           => [ map { key => $_, value => t8(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ],
 319     PCF           => [ map { key => $_, value => t8(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ],
 320     letter        => $letter,
 321     employees     => $self->all_employees,
 322     print_options => SL::Helper::PrintOptions->get_print_options,
 323   );
 324 }
 325
 326 sub _update {
 327   my ($self, %params) = @_;
 328
 329   my $letter = $self->letter;
 330
 331   $self->check_date;
 332   $self->set_greetings;
 333
 334   return $letter;
 335 }
 336
 337 sub prepare_report {
 338   my ($self) = @_;
 339
 340   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 341   $self->{report} = $report;
 342
 343   my @columns  = qw(date subject letternumber vc_id contact date);
 344   my @sortable = qw(date subject letternumber vc_id contact date);
 345
 346   my %column_defs = (
 347     date                  => { text => t8('Date'),         sub => sub { $_[0]->date_as_date } },
 348     subject               => { text => t8('Subject'),      sub => sub { $_[0]->subject },
 349                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 350     letternumber          => { text => t8('Letternumber'), sub => sub { $_[0]->letternumber },
 351                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 352     vc_id                 => { text => t8('Customer'),      sub => sub { $_[0]->customer->displayable_name } },
 353     contact               => { text => t8('Contact'),       sub => sub { $_[0]->contact ? $_[0]->contact->full_name : '' } },
 354   );
 355
 356   $column_defs{$_}{text} = $sort_columns{$_} for keys %column_defs;
 357
 358   $report->set_options(
 359     std_column_visibility => 1,
 360     controller_class      => 'Letter',
 361     output_format         => 'HTML',
 362     top_info_text         => t8('Letters'),
 363     title                 => t8('Letters'),
 364     allow_pdf_export      => 1,
 365     allow_csv_export      => 1,
 366   );
 367
 368   $report->set_columns(%column_defs);
 369   $report->set_column_order(@columns);
 370   $report->set_export_options(qw(list filter));
 371   $report->set_options_from_form;
 372
 373   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 374   $self->models->finalize;
 375   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 376
 377   $report->set_options(
 378     raw_top_info_text    => $self->render('letter/report_top',    { output => 0 }),
 379     raw_bottom_info_text => $self->render('letter/report_bottom', { output => 0 }, models => $self->models),
 380     attachment_basename  => t8('letters_list') . strftime('_%Y%m%d', localtime time),
 381   );
 382 }
 383
 384 sub make_filter_summary {
 385   my ($self) = @_;
 386
 387   my $filter = $::form->{filter} || {};
 388   my @filter_strings;
 389
 390   my $employee = $filter->{employee_id} ? SL::DB::Employee->new(id => $filter->{employee_id})->load->name : '';
 391   my $salesman = $filter->{salesman_id} ? SL::DB::Employee->new(id => $filter->{salesman_id})->load->name : '';
 392
 393   my @filters = (
 394     [ $filter->{"letternumber:substr::ilike"},  t8('Number')     ],
 395     [ $filter->{"subject:substr::ilike"},       t8('Subject')    ],
 396     [ $filter->{"body:substr::ilike"},          t8('Body')       ],
 397     [ $filter->{"date:date::ge"},               t8('From Date')  ],
 398     [ $filter->{"date:date::le"},               t8('To Date')    ],
 399     [ $employee,                                t8('Employee')   ],
 400     [ $salesman,                                t8('Salesman')   ],
 401   );
 402
 403   my %flags = (
 404   );
 405   my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
 406
 407   for (@flags) {
 408     push @filter_strings, $_ if $_;
 409   }
 410   for (@filters) {
 411     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 412   }
 413
 414   $self->{filter_summary} = join ', ', @filter_strings;
 415 }
 416
 417 sub e_mail {
 418   my $letter = _update();
 419
 420   $letter->check_number;
 421   $letter->save;
 422
 423   $::form->{formname} = "letter";
 424   $letter->export_to($::form);
 425
 426   $::form->{id} = $letter->{id};
 427   edit_e_mail();
 428 }
 429
 430 sub load_letter_draft {
 431   my ($self, %params) = @_;
 432
 433   return 0 if $params{skip_drafts};
 434
 435   my $letter_drafts = SL::DB::Manager::LetterDraft->get_all;
 436
 437   return unless @$letter_drafts;
 438
 439   $self->render('letter/load_drafts',
 440     title         => t8('Letter Draft'),
 441     LETTER_DRAFTS => $letter_drafts,
 442   );
 443
 444   return 1;
 445 }
 446
 447 sub check_date {
 448   my ($self) = @_;
 449   my $letter = $self->letter;
 450
 451   return unless $letter;
 452   return if $letter->date;
 453
 454   $letter->date(DateTime->today)
 455 }
 456
 457 sub check_letter {
 458   my ($self, $letter) = @_;
 459
 460   $letter ||= $self->letter;
 461
 462   my $error;
 463
 464   if (!$letter->subject) {
 465     flash('error', t8('The subject is missing.'));
 466     $error = 1;
 467   }
 468   if (!$letter->body) {
 469     flash('error', t8('The body is missing.'));
 470     $error = 1;
 471   }
 472   if (!$letter->employee_id) {
 473     flash('error', t8('The employee is missing.'));
 474     $error = 1;
 475   }
 476
 477   return !$error;
 478 }
 479
 480 sub check_number {
 481   my ($self, $letter) = @_;
 482
 483   $letter ||= $self->letter;
 484
 485   return if $letter->letternumber;
 486
 487   $letter->letternumber(SL::TransNumber->new(type => 'letter', id => $self->{id}, number => $self->{letternumber})->create_unique);
 488 }
 489
 490 sub set_greetings {
 491   my ($self) = @_;
 492   my $letter = $self->letter;
 493
 494   return unless $letter;
 495   return if $letter->greeting;
 496
 497   $letter->greeting(t8('Dear Sir or Madam,'));
 498 }
 499
 500 sub export_letter_to_form {
 501   my ($self, $letter) = @_;
 502   # nope, not pretty.
 503
 504   $letter ||= $self->letter;
 505
 506   for ($letter->meta->columns) {
 507     if ((ref $_) =~ /Date/i) {
 508       $::form->{$_->name} = $letter->$_->to_kivitendo;
 509     } else {
 510       $::form->{$_->name} = $letter->$_;
 511     }
 512   }
 513 }
 514
 515 sub init_letter {
 516   my ($self) = @_;
 517
 518   my $letter      = SL::DB::Manager::Letter->find_by_or_create(id => $::form->{letter}{id} || 0)
 519                                            ->assign_attributes(%{ $::form->{letter} });
 520
 521   if ($letter->cp_id) {
 522 #     $letter->vc_id($letter->contact->cp_cv_id);
 523       # contacts don't have language_id yet
 524 #     $letter->greeting(GenericTranslations->get(
 525 #       translation_type => 'greetings::' . ($letter->contact->cp_gender eq 'f' ? 'female' : 'male'),
 526 #       language_id      => $letter->contact->language_id,
 527 #       allow_fallback   => 1
 528 #     ));
 529   }
 530
 531   $letter;
 532 }
 533
 534 sub init_models {
 535   my ($self) = @_;
 536
 537   SL::Controller::Helper::GetModels->new(
 538     controller   => $self,
 539     model        => 'Letter',
 540     sorted       => {
 541       _default     => {
 542         by           => 'letternumber',
 543         dir          => 1,
 544       },
 545       %sort_columns,
 546     },
 547     with_objects => [ 'contact', 'salesman', 'employee' ],
 548   );
 549 }
 550
 551 sub init_all_employees {
 552   SL::DB::Manager::Employee->get_all(query => [ deleted => 0 ]);
 553 }
 554
 555 sub check_auth_edit {
 556   $::auth->assert('sales_letter_edit');
 557 }
 558
 559 sub check_auth_report {
 560   $::auth->assert('sales_letter_report');
 561 }
 562
 563 1;
 564
 565 __END__
 566
 567 =encoding utf-8
 568
 569 =head1 NAME
 570
 571 SL::Controller::Letter - Letters CRUD and printing
 572
 573 =head1 DESCRIPTION
 574
 575 Simple letter CRUD controller with drafting capabilities.
 576
 577 =head1 TODO
 578
 579   Customer/Vendor switch for dealing with vendor letters
 580
 581 copy to webdav is crap
 582
 583 customer/vendor stuff
 584
 585 =head1 AUTHOR
 586
 587 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
 588
 589 =cut