SL/Controller/Letter.pm

   1 package SL::Controller::Letter;
   2
   3 use strict;
   4 use parent qw(SL::Controller::Base);
   5
   6 use Carp;
   7 use File::Basename;
   8 use POSIX qw(strftime);
   9 use SL::Controller::Helper::GetModels;
  10 use SL::Controller::Helper::ReportGenerator;
  11 use SL::CT;
  12 use SL::DB::Employee;
  13 use SL::DB::Language;
  14 use SL::DB::Letter;
  15 use SL::DB::LetterDraft;
  16 use SL::DB::Printer;
  17 use SL::File;
  18 use SL::Helper::Flash qw(flash flash_later);
  19 use SL::Helper::CreatePDF;
  20 use SL::Helper::PrintOptions;
  21 use SL::Locale::String qw(t8);
  22 use SL::Mailer;
  23 use SL::IS;
  24 use SL::Presenter::Tag qw(select_tag);
  25 use SL::ReportGenerator;
  26 use SL::Webdav;
  27 use SL::Webdav::File;
  28
  29 use Rose::Object::MakeMethods::Generic (
  30   'scalar --get_set_init' => [ qw(letter all_employees models webdav_objects is_sales) ],
  31 );
  32
  33 __PACKAGE__->run_before('check_auth_edit');
  34 __PACKAGE__->run_before('check_auth_report', only => [ qw(list) ]);
  35
  36 use constant TEXT_CREATED_FOR_VALUES => (qw(presskit fax letter));
  37 use constant PAGE_CREATED_FOR_VALUES => (qw(sketch 1 2));
  38
  39 my %sort_columns = (
  40   date                  => t8('Date'),
  41   subject               => t8('Subject'),
  42   letternumber          => t8('Letternumber'),
  43   customer_id           => t8('Customer'),
  44   vendor_id             => t8('Vendor'),
  45   contact               => t8('Contact'),
  46 );
  47
  48 ### actions
  49
  50 sub action_add {
  51   my ($self, %params) = @_;
  52
  53   return if $self->load_letter_draft(%params);
  54
  55   $self->letter->employee_id(SL::DB::Manager::Employee->current->id);
  56   $self->letter->salesman_id(SL::DB::Manager::Employee->current->id);
  57
  58   $self->_display(
  59     title       => t8('Add Letter'),
  60     language_id => $params{language_id},
  61   );
  62 }
  63
  64 sub action_edit {
  65   my ($self, %params) = @_;
  66
  67   return $self->action_add
  68     unless $::form->{letter} || $::form->{draft};
  69
  70   if ($::form->{draft}) {
  71     $self->letter(SL::DB::Letter->new_from_draft($::form->{draft}{id}));
  72     $self->is_sales($self->letter->is_sales);
  73   }
  74
  75   $self->_display(
  76     title  => t8('Edit Letter'),
  77   );
  78 }
  79
  80 sub action_save {
  81   my ($self, %params) = @_;
  82
  83   my $letter = $self->_update;
  84
  85   if (!$self->check_letter($letter)) {
  86     return $self->_display;
  87   }
  88
  89   $self->check_number;
  90
  91   if (!$letter->save) {
  92     flash('error', t8('There was an error saving the letter'));
  93     return $self->_display;
  94   }
  95
  96   flash('info', t8('Letter saved!'));
  97
  98   $self->_display;
  99 }
 100
 101 sub action_update_contacts {
 102   my ($self) = @_;
 103
 104   my $letter = $self->letter;
 105
 106   if (!$self->letter->has_customer_vendor) {
 107     return $self->js
 108       ->replaceWith(
 109         '#letter_cp_id',
 110         select_tag('letter.cp_id', [], value_key => 'cp_id', title_key => 'full_name')
 111       )
 112       ->render;
 113   }
 114
 115   my $contacts = $letter->customer_vendor->contacts;
 116
 117   my $default;
 118   if (   $letter->contact
 119       && $letter->contact->cp_cv_id
 120       && $letter->contact->cp_cv_id == $letter->customer_vendor_id) {
 121     $default = $letter->contact->cp_id;
 122   } else {
 123     $default = '';
 124   }
 125
 126   $self->js
 127     ->replaceWith(
 128       '#letter_cp_id',
 129       select_tag('letter.cp_id', $contacts, default => $default, value_key => 'cp_id', title_key => 'full_name')
 130     )
 131     ->render;
 132 }
 133
 134 sub action_save_letter_draft {
 135   my ($self, %params) = @_;
 136
 137   $self->check_letter;
 138
 139   my $letter_draft = SL::DB::LetterDraft->new_from_letter($self->_update);
 140
 141   if (!$letter_draft->save) {
 142     flash('error', t8('There was an error saving the letter draft'));
 143     return $self->_display;
 144   }
 145
 146   flash('info', t8('Draft for this Letter saved!'));
 147
 148   $self->_display;
 149 }
 150
 151 sub action_delete {
 152   my ($self, %params) = @_;
 153
 154   if (!$self->letter->delete) {
 155     flash('error', t8('An error occurred. Letter could not be deleted.'));
 156     return $self->action_update;
 157   }
 158
 159   flash_later('info', t8('Letter deleted'));
 160   $self->redirect_to(action => 'list');
 161 }
 162
 163 sub action_list {
 164   my ($self, %params) = @_;
 165
 166   $self->setup_list_action_bar;
 167   $self->make_filter_summary;
 168   $self->prepare_report;
 169
 170   my $letters = $self->models->get;
 171   $self->report_generator_list_objects(report => $self->{report}, objects => $letters);
 172
 173 }
 174
 175 sub action_print_letter {
 176   my ($self, %params) = @_;
 177
 178   my $letter = $self->_update;
 179
 180   my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
 181     name        => 'letter',
 182     printer_id  => $::form->{printer_id},
 183     language_id => $::form->{language_id},
 184     formname    => 'letter',
 185     format      => 'pdf',
 186   );
 187
 188   if (!defined $template_file) {
 189     $::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));
 190   }
 191
 192   my %result;
 193   eval {
 194     %result = SL::Template::LaTeX->parse_and_create_pdf(
 195       $template_file,
 196       SELF          => $self,
 197       FORM          => $::form,
 198       letter        => $letter,
 199       template_meta => {
 200         formname  => 'letter',
 201         language  => SL::DB::Manager::Language->find_by_or_create(id => $::form->{language_id}*1),
 202         extension => 'pdf',
 203         format    => $::form->{format},
 204         media     => $::form->{media},
 205         printer   => SL::DB::Manager::Printer->find_by_or_create(id => $::form->{printer_id} || undef),
 206         today     => DateTime->today,
 207       },
 208     );
 209
 210     die $result{error} if $result{error};
 211
 212     $::form->{type}         = 'letter';
 213     $::form->{formname}     = 'letter';
 214     $::form->{letternumber} = $letter->letternumber;
 215     my $attachment_name     = $::form->generate_attachment_filename;
 216
 217     if ($::instance_conf->get_webdav_documents) {
 218       my $webdav_file = SL::Webdav::File->new(
 219         filename => $attachment_name,
 220         webdav   => SL::Webdav->new(
 221           type   => 'letter',
 222           number => $letter->letternumber,
 223         ),
 224       );
 225
 226       $webdav_file->store(file => $result{file_name});
 227     }
 228
 229     if ($::instance_conf->get_doc_storage) {
 230       my %save_params = (object_id    => $letter->id,
 231                          object_type  => 'letter',
 232                          mime_type    => 'application/pdf',
 233                          source       => 'created',
 234                          file_type    => 'document',
 235                          file_name    => $attachment_name,
 236                          file_path    => $result{file_name});
 237       SL::File->save(%save_params);
 238     }
 239
 240     # set some form defaults for printing webdav copy variables
 241     if ( $::form->{media} eq 'email') {
 242       my $mail              = Mailer->new;
 243       $mail->{$_}           = $params{email}->{$_} for qw(to cc subject message bcc);
 244       $mail->{from}         = qq|"$::myconfig{name}" <$::myconfig{email}>|;
 245       $mail->{attachments}  = [{ path => $result{file_name},
 246                                  name => $params{email}->{attachment_filename} }];
 247       $mail->{message}      =~ s/\r//g;
 248       $mail->{message}     .=  $::form->create_email_signature();
 249       $mail->{record_id}    =  $letter->id;
 250       $mail->{content_type} = 'text/html';
 251       $mail->send;
 252       unlink $result{file_name};
 253
 254       flash_later('info', t8('The email has been sent.'));
 255       $self->redirect_to(action => 'edit', 'letter.id' => $letter->id);
 256
 257       return 1;
 258     }
 259
 260     if (!$::form->{printer_id} || $::form->{media} eq 'screen') {
 261       $self->send_file($result{file_name}, name => $attachment_name);
 262       unlink $result{file_name};
 263
 264       return 1;
 265     }
 266
 267     my $printer = SL::DB::Printer->new(id => $::form->{printer_id})->load;
 268     $printer->print_document(
 269       copies    => $::form->{copies},
 270       file_name => $result{file_name},
 271     );
 272
 273     unlink $result{file_name};
 274
 275     flash_later('info', t8('The documents have been sent to the printer \'#1\'.', $printer->printer_description));
 276     $self->redirect_to(action => 'edit', 'letter.id' => $letter->id, media => 'printer', printer_id => $::form->{printer_id});
 277     1;
 278   } or do {
 279     unlink $result{file_name} if $result{file_name};
 280     $::form->error(t8("Creating the PDF failed:") . " " . $@);
 281   };
 282 }
 283
 284 sub action_update {
 285   my ($self, $name_selected) = @_;
 286
 287   $self->_display(
 288     letter => $self->_update,
 289   );
 290 }
 291
 292 sub action_skip_draft {
 293   my ($self) = @_;
 294   $self->action_add(skip_drafts => 1);
 295 }
 296
 297 sub action_delete_drafts {
 298   my ($self) = @_;
 299
 300   my @ids = @{ $::form->{ids} || [] };
 301   SL::DB::Manager::LetterDraft->delete_all(where => [ id => \@ids ]) if @ids;
 302
 303   flash('info', t8('Draft deleted'));
 304   $self->action_add(skip_drafts => 1);
 305 }
 306
 307 sub action_send_email {
 308   my ($self) = @_;
 309
 310   $::form->{media} = 'email';
 311   $self->action_print_letter(email => $::form->{email_form});
 312 }
 313
 314 ### internal methods
 315
 316 sub _display {
 317   my ($self, %params) = @_;
 318
 319   $::request->{layout}->use_javascript("${_}.js") for qw(kivi.Letter kivi.SalesPurchase kivi.File);
 320
 321   my $letter = $self->letter;
 322
 323  $params{title} ||= t8('Edit Letter');
 324
 325   $::form->{type}             = 'letter';   # needed for print_options
 326   $::form->{vc}               = $letter->is_sales ? 'customer' : 'vendor'; # needs to be for _get_contacts...
 327
 328   $::form->{language_id} ||= $params{language_id};
 329   $::form->{languages}   ||= SL::DB::Manager::Language->get_all_sorted;
 330   $::form->{printers}      = SL::DB::Manager::Printer->get_all_sorted;
 331
 332   $self->setup_display_action_bar;
 333   $self->render('letter/edit',
 334     %params,
 335     TCF           => [ map { key => $_, value => t8(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ],
 336     PCF           => [ map { key => $_, value => t8(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ],
 337     letter        => $letter,
 338     employees     => $self->all_employees,
 339     print_options => SL::Helper::PrintOptions->get_print_options (
 340       options => { no_postscript   => 1,
 341                    no_opendocument => 1,
 342                    no_html         => 1,
 343                    no_queue        => 1,
 344                    show_headers    => 1,
 345                  }),
 346
 347   );
 348 }
 349
 350 sub _update {
 351   my ($self, %params) = @_;
 352
 353   my $letter = $self->letter;
 354
 355   $self->check_date;
 356   $self->set_greetings;
 357
 358   return $letter;
 359 }
 360
 361 sub prepare_report {
 362   my ($self) = @_;
 363
 364   my $report       = SL::ReportGenerator->new(\%::myconfig, $::form);
 365   $report->{title} = t8('Letters');
 366   $self->{report}  = $report;
 367
 368   my @columns  = qw(date subject letternumber customer_id vendor_id contact date);
 369   my @sortable = qw(date subject letternumber customer_id vendor_id contact date);
 370
 371   my %column_defs = (
 372     date                  => { text => t8('Date'),         sub => sub { $_[0]->date_as_date } },
 373     subject               => { text => t8('Subject'),      sub => sub { $_[0]->subject },
 374                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 375     letternumber          => { text => t8('Letternumber'), sub => sub { $_[0]->letternumber },
 376                                obj_link => sub { $self->url_for(action => 'edit', 'letter.id' => $_[0]->id, callback => $self->models->get_callback) }  },
 377     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 },
 378     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},
 379     contact               => { text => t8('Contact'),       sub => sub { $_[0]->contact ? $_[0]->contact->full_name : '' } },
 380   );
 381
 382   $column_defs{$_}{text} = $sort_columns{$_} for keys %column_defs;
 383
 384   $report->set_options(
 385     std_column_visibility => 1,
 386     controller_class      => 'Letter',
 387     output_format         => 'HTML',
 388     title                 => t8('Letters'),
 389     allow_pdf_export      => 1,
 390     allow_csv_export      => 1,
 391   );
 392
 393   $report->set_columns(%column_defs);
 394   $report->set_column_order(@columns);
 395   $report->set_export_options(qw(list filter is_sales));
 396   $report->set_options_from_form;
 397
 398   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 399   $self->models->add_additional_url_params(is_sales => $self->is_sales);
 400   $self->models->finalize;
 401   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 402
 403   $report->set_options(
 404     raw_top_info_text    => $self->render('letter/report_top',    { output => 0 }),
 405     raw_bottom_info_text => $self->render('letter/report_bottom', { output => 0 }, models => $self->models),
 406     attachment_basename  => t8('letters_list') . strftime('_%Y%m%d', localtime time),
 407   );
 408 }
 409
 410 sub make_filter_summary {
 411   my ($self) = @_;
 412
 413   my $filter = $::form->{filter} || {};
 414   my @filter_strings;
 415
 416   my $employee = $filter->{employee_id} ? SL::DB::Employee->new(id => $filter->{employee_id})->load->name : '';
 417   my $salesman = $filter->{salesman_id} ? SL::DB::Employee->new(id => $filter->{salesman_id})->load->name : '';
 418
 419   my @filters = (
 420     [ $filter->{"letternumber:substr::ilike"},  t8('Number')     ],
 421     [ $filter->{"subject:substr::ilike"},       t8('Subject')    ],
 422     [ $filter->{"body:substr::ilike"},          t8('Body')       ],
 423     [ $filter->{"date:date::ge"},               t8('From Date')  ],
 424     [ $filter->{"date:date::le"},               t8('To Date')    ],
 425     [ $employee,                                t8('Employee')   ],
 426     [ $salesman,                                t8('Salesman')   ],
 427   );
 428
 429   my %flags = (
 430   );
 431   my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
 432
 433   for (@flags) {
 434     push @filter_strings, $_ if $_;
 435   }
 436   for (@filters) {
 437     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 438   }
 439
 440   $self->{filter_summary} = join ', ', @filter_strings;
 441 }
 442
 443 sub load_letter_draft {
 444   my ($self, %params) = @_;
 445
 446   return 0 if $params{skip_drafts};
 447
 448   my $letter_drafts = SL::DB::Manager::LetterDraft->get_all(
 449     query => [
 450       SL::DB::Manager::Letter->is_sales_filter($self->is_sales),
 451     ]
 452   );
 453
 454   return unless @$letter_drafts;
 455
 456   $self->setup_load_letter_draft_action_bar;
 457   $self->render('letter/load_drafts',
 458     title         => t8('Letter Draft'),
 459     LETTER_DRAFTS => $letter_drafts,
 460   );
 461
 462   return 1;
 463 }
 464
 465 sub check_date {
 466   my ($self) = @_;
 467   my $letter = $self->letter;
 468
 469   return unless $letter;
 470   return if $letter->date;
 471
 472   $letter->date(DateTime->today)
 473 }
 474
 475 sub check_letter {
 476   my ($self, $letter) = @_;
 477
 478   $letter ||= $self->letter;
 479
 480   my $error;
 481
 482   if (!$letter->subject) {
 483     flash('error', t8('The subject is missing.'));
 484     $error = 1;
 485   }
 486   if (!$letter->body) {
 487     flash('error', t8('The body is missing.'));
 488     $error = 1;
 489   }
 490   if (!$letter->employee_id) {
 491     flash('error', t8('The employee is missing.'));
 492     $error = 1;
 493   }
 494
 495   return !$error;
 496 }
 497
 498 sub check_number {
 499   my ($self, $letter) = @_;
 500
 501   $letter ||= $self->letter;
 502
 503   return if $letter->letternumber;
 504
 505   $letter->letternumber(SL::TransNumber->new(type => 'letter', id => $self->{id}, number => $self->{letternumber})->create_unique);
 506 }
 507
 508 sub set_greetings {
 509   my ($self) = @_;
 510   my $letter = $self->letter;
 511
 512   return unless $letter;
 513   return if $letter->greeting;
 514
 515   $letter->greeting(t8('Dear Sir or Madam,'));
 516 }
 517
 518 sub init_letter {
 519   my ($self) = @_;
 520
 521   my $letter      = SL::DB::Manager::Letter->find_by_or_create(id => $::form->{letter}{id} || 0)
 522                                            ->assign_attributes(%{ $::form->{letter} });
 523
 524   if ($letter->cp_id) {
 525 #     $letter->customer_vendor_id($letter->contact->cp_cv_id);
 526       # contacts don't have language_id yet
 527 #     $letter->greeting(GenericTranslations->get(
 528 #       translation_type => 'greetings::' . ($letter->contact->cp_gender eq 'f' ? 'female' : 'male'),
 529 #       language_id      => $letter->contact->language_id,
 530 #       allow_fallback   => 1
 531 #     ));
 532   }
 533
 534   $self->is_sales($letter->is_sales) if $letter->id;
 535
 536   $letter;
 537 }
 538
 539 sub init_models {
 540   my ($self) = @_;
 541
 542   SL::Controller::Helper::GetModels->new(
 543     controller   => $self,
 544     model        => 'Letter',
 545     query        => [
 546       SL::DB::Manager::Letter->is_sales_filter($self->is_sales),
 547     ],
 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 init_webdav_objects {
 558   my ($self) = @_;
 559
 560   return [] if !$self->letter || !$self->letter->letternumber || !$::instance_conf->get_webdav;
 561
 562   my $webdav = SL::Webdav->new(
 563     type     => 'letter',
 564     number   => $self->letter->letternumber,
 565   );
 566
 567   my @all_objects = $webdav->get_all_objects;
 568
 569   return [ map {
 570     +{ name => $_->filename,
 571        type => t8('File'),
 572        link => File::Spec->catfile($_->full_filedescriptor),
 573      }
 574   } @all_objects ];
 575 }
 576
 577 sub init_is_sales {
 578   die 'is_sales must be set' unless defined $::form->{is_sales};
 579   $::form->{is_sales};
 580 }
 581
 582 sub check_auth_edit {
 583   $::form->{is_sales} ? $::auth->assert('sales_letter_edit')
 584                       : $::auth->assert('purchase_letter_edit');
 585 }
 586
 587 sub check_auth_report {
 588   $::form->{is_sales} ? $::auth->assert('sales_letter_report')
 589                       : $::auth->assert('purchase_letter_report');
 590 }
 591
 592 sub setup_load_letter_draft_action_bar {
 593   my ($self, %params) = @_;
 594
 595   for my $bar ($::request->layout->get('actionbar')) {
 596     $bar->add(
 597       link => [
 598         t8('Skip'),
 599         link      => $self->url_for(action => 'skip_draft', is_sales => $self->is_sales),
 600         accesskey => 'enter',
 601       ],
 602       action => [
 603         t8('Delete'),
 604         submit  => [ '#form', { action => 'Letter/delete_drafts' } ],
 605         checks  => [ [ 'kivi.check_if_entries_selected', '[name="ids[+]"]' ] ],
 606         confirm => t8('Do you really want to delete this draft?'),
 607       ],
 608     );
 609   }
 610 }
 611
 612 sub setup_display_action_bar {
 613   my ($self, %params) = @_;
 614
 615   my $vc = $self->is_sales ? 'customer' : 'vendor'; # needed for show_email_dialog
 616
 617   for my $bar ($::request->layout->get('actionbar')) {
 618     $bar->add(
 619       action => [
 620         t8('Update'),
 621         submit    => [ '#form', { action => 'Letter/update' } ],
 622         accesskey => 'enter',
 623       ],
 624
 625       combobox => [
 626         action => [
 627           t8('Save'),
 628           submit => [ '#form', { action => 'Letter/save' } ],
 629         ],
 630         action => [
 631           t8('Save Draft'),
 632           submit => [ '#form', { action => 'Letter/save_letter_draft' } ],
 633         ],
 634       ], # end of combobox "Save"
 635
 636       action => [
 637         t8('Delete'),
 638         submit   => [ '#form', { action => 'Letter/delete' } ],
 639         confirm  => t8('Are you sure you want to delete this letter?'),
 640         disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
 641       ],
 642
 643       combobox => [
 644         action => [ t8('Export') ],
 645         action => [
 646           t8('Print'),
 647           call     => [ 'kivi.SalesPurchase.show_print_dialog', 'Letter/print_letter' ],
 648           disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
 649         ],
 650         action => [
 651           t8('E-mail'),
 652           call     => [ 'kivi.SalesPurchase.show_email_dialog', 'Letter/send_email', $vc, '#letter_' . $vc . '_id' ],
 653           disabled => !$self->letter->id ? t8('The object has not been saved yet.') : undef,
 654         ],
 655       ],
 656     );
 657   }
 658 }
 659
 660 sub setup_list_action_bar {
 661   my ($self, %params) = @_;
 662
 663   for my $bar ($::request->layout->get('actionbar')) {
 664     $bar->add(
 665       action => [
 666         t8('Update'),
 667         submit    => [ '#search_form', { action => 'Letter/list' } ],
 668         accesskey => 'enter',
 669       ],
 670     );
 671   }
 672 }
 673
 674 1;
 675
 676 __END__
 677
 678 =encoding utf-8
 679
 680 =head1 NAME
 681
 682 SL::Controller::Letter - Letters CRUD and printing
 683
 684 =head1 DESCRIPTION
 685
 686 Simple letter CRUD controller with drafting capabilities.
 687
 688 copy to webdav is crap
 689
 690 =head1 AUTHOR
 691
 692 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
 693
 694 =cut