bin/mozilla/letter.pl

   1 #=====================================================================
   2 # LX-Office ERP
   3 # Copyright (C) 2008
   4 # Based on SQL-Ledger Version 2.1.9
   5 # Web http://www.lx-office.org
   6 #
   7 #=====================================================================
   8 #
   9 # Letter module
  10 #
  11 #======================================================================
  12
  13 use strict;
  14 use POSIX qw(strftime);
  15
  16 use SL::GenericTranslations;
  17 use SL::ReportGenerator;
  18 use SL::Letter;
  19 use SL::CT;
  20 use SL::DB::Contact;
  21 use SL::DB::Default;
  22 use SL::Helper::CreatePDF;
  23 use SL::Helper::Flash;
  24 require "bin/mozilla/reportgenerator.pl";
  25 require "bin/mozilla/io.pl";
  26 require "bin/mozilla/arap.pl";
  27
  28 use constant TEXT_CREATED_FOR_VALUES => (qw(presskit fax letter));
  29 use constant PAGE_CREATED_FOR_VALUES => (qw(sketch 1 2));
  30
  31 our ($form, %myconfig, $locale, $lxdebug);
  32
  33 # parserhappy(R)
  34 # $locale->text('Presskit')
  35 # $locale->text('Sketch')
  36 # $locale->text('Fax')
  37 # $locale->text('Letter')
  38
  39 sub add {
  40   $::lxdebug->enter_sub;
  41
  42   $main::auth->assert('sales_letter_edit');
  43   my %params = @_;
  44
  45   return $main::lxdebug->leave_sub if load_letter_draft();
  46
  47   my $letter = SL::Letter->new(%params);
  48
  49   if (my $cp_id = delete $::form->{contact_id}) {
  50     my $contact = SL::DB::Manager::Contact->find_by(cp_id => $cp_id);
  51     $letter->{cp_id}     = $contact->cp_id;
  52     $letter->{vc_id}     = $contact->cp_cv_id;
  53     $letter->{greeting}  = GenericTranslations->get(
  54       translation_type => 'greetings::' . ($contact->{cp_gender} eq 'f' ? 'female' : 'male'),
  55       language_id      => $contact->language_id,
  56       allow_fallback   => 1
  57     );
  58     $params{language_id} = $contact->language_id;
  59   }
  60
  61   $letter->check_date;
  62
  63   _display(
  64     letter      => $letter,
  65     title       => $locale->text('Add Letter'),
  66     language_id => $params{language_id},
  67   );
  68
  69   $::lxdebug->leave_sub;
  70 }
  71
  72 sub edit {
  73   $::lxdebug->enter_sub;
  74
  75   $main::auth->assert('sales_letter_edit');
  76   add() unless ($form->{id});
  77
  78   my $letter = SL::Letter->new( id => $form->{id}, draft => $form->{draft} )->load;
  79
  80   add() unless $letter && ($letter->{id} || $letter->{draft_id});
  81
  82   _display(
  83     letter => $letter,
  84     title  => $locale->text('Edit Letter'),
  85   );
  86
  87   $::lxdebug->leave_sub;
  88 }
  89
  90 sub save {
  91   $::lxdebug->enter_sub;
  92
  93   $main::auth->assert('sales_letter_edit');
  94   my %params = @_;
  95
  96
  97   $::form->error(t8('The subject is missing.')) unless $form->{letter}->{subject};
  98   $::form->error(t8('The body is missing.')) unless $form->{letter}->{body};
  99   $::form->error(t8('The employee is missing.')) unless $form->{letter}->{employee_id};
 100
 101   my $letter = _update();
 102
 103   $letter->check_number;
 104   $letter->save;
 105
 106   $form->{SAVED_MESSAGE} = $locale->text('Letter saved!');
 107
 108   _display(
 109     letter => $letter,
 110   );
 111
 112   $::lxdebug->leave_sub;
 113 }
 114
 115 sub save_letter_draft {
 116   $::lxdebug->enter_sub;
 117
 118   $main::auth->assert('sales_letter_edit');
 119
 120   $::form->error(t8('The subject is missing.')) unless $form->{letter}->{subject};
 121   $::form->error(t8('The body is missing.')) unless $form->{letter}->{body};
 122   $::form->error(t8('The employee is missing.')) unless $form->{letter}->{employee_id};
 123   $::form->error(t8('Already as letter saved.')) if $form->{letter}->{letternumber};
 124
 125   my $letter_draft = _update();
 126   $letter_draft->{draft_id} = delete $letter_draft->{id}; # if we have one
 127   $letter_draft->save(draft => '1');
 128   $letter_draft->{vergiss_mich_nicht} = 'nicht vergessen';
 129   $form->{SAVED_MESSAGE} = $locale->text('Draft for this Letter saved!');
 130
 131   _display(
 132     letter => $letter_draft,
 133   );
 134
 135   $::lxdebug->leave_sub;
 136 }
 137
 138 sub delete {
 139   $main::lxdebug->enter_sub();
 140
 141   $main::auth->assert('sales_letter_edit');
 142   # NYI
 143   $form->{SAVED_MESSAGE} = $locale->text('Not yet implemented!');
 144   _display();
 145
 146   $main::lxdebug->leave_sub();
 147 }
 148
 149 sub delete_letter_drafts {
 150   $main::lxdebug->enter_sub();
 151
 152   $main::auth->assert('sales_letter_edit');
 153
 154   my @ids;
 155   foreach (keys %{$form}) {
 156     push @ids, $1 if (/^checked_(.*)/ && $form->{$_});
 157   }
 158
 159   SL::Letter->delete_drafts(@ids) if (@ids); #->{id});
 160
 161   add();
 162
 163   $main::lxdebug->leave_sub();
 164 }
 165
 166 sub _display {
 167   $main::lxdebug->enter_sub();
 168
 169   $main::auth->assert('sales_letter_edit');
 170   my %params = @_;
 171
 172   my $letter = $params{letter};
 173
 174   my %TMPL_VAR;
 175
 176   $form->{type}             = 'letter';   # needed for print_options
 177   $form->{vc}               = 'customer'; # needs to be for _get_contacts...
 178   $form->{"$form->{vc}_id"} ||= $letter->{customer_id};
 179   $form->{jsscript}         = 1;
 180   $form->{javascript}       =
 181      qq|<script type="text/javascript" src="js/customer_or_vendor_selection.js"></script>
 182         <script type="text/javascript" src="js/edit_part_window.js"></script>|;
 183
 184   $form->get_lists("contacts"      => "ALL_CONTACTS",
 185   "employees"     => "ALL_EMPLOYEES",
 186                    "salesmen"      => "ALL_SALESMEN",
 187                    "departments"   => "ALL_DEPARTMENTS",
 188                    "languages"     => "languages",
 189                    "customers"     => { key   => "ALL_CUSTOMERS",
 190                                         limit => $myconfig{vclimit} + 1 },
 191                    "vc"            => 'customer',
 192                    );
 193
 194   $TMPL_VAR{vc_keys}       = sub { "$_[0]->{name}--$_[0]->{id}" };
 195   $TMPL_VAR{vc_select}     = "customer_or_vendor_selection_window('letter.customer', '', 0, 0)";
 196   $TMPL_VAR{ct_labels}     = sub { ($_[0]->{cp_greeting} ? "$_[0]->{cp_greeting} " : '') .  $_[0]->{cp_name} .  ($_[0]->{cp_givenname} ? ", $_[0]->{cp_givenname}" : '') };
 197   $TMPL_VAR{TCF}           = [ map { key => $_, value => $locale->text(ucfirst $_) }, TEXT_CREATED_FOR_VALUES() ];
 198   $TMPL_VAR{PCF}           = [ map { key => $_, value => $locale->text(ucfirst $_) }, PAGE_CREATED_FOR_VALUES() ];
 199
 200   $form->header();
 201
 202   $form->{language_id} ||= $params{language_id};
 203
 204   print $form->parse_html_template('letter/edit', {
 205     %params,
 206     %TMPL_VAR,
 207     letter        => $letter,
 208     print_options => print_options(inline => 1),
 209   });
 210
 211   $main::lxdebug->leave_sub();
 212 }
 213
 214 sub search {
 215   $lxdebug->enter_sub();
 216
 217   $main::auth->assert('sales_letter_report');
 218
 219   $form->get_lists("employees" => "EMPLOYEES",
 220                    "salesmen"  => "SALESMEN",
 221                    "customers" => "ALL_CUSTOMERS");
 222
 223   $form->{jsscript} = 1;
 224   $form->{title}    = $locale->text('Letters');
 225
 226   $form->header();
 227   print $form->parse_html_template('letter/search');
 228
 229   $lxdebug->leave_sub();
 230 }
 231
 232 sub report {
 233   $lxdebug->enter_sub();
 234
 235   $main::auth->assert('sales_letter_report');
 236
 237   my %params = @_;
 238
 239   my @report_params = qw(letternumber subject body contact date_from date_to cp_id);
 240
 241   if ($form->{selectcustomer}) {
 242     push @report_params, 'customer_id';
 243     $form->{customer_id} = $form->{customer};
 244   } else {
 245     push @report_params, 'customer';
 246   }
 247
 248   report_generator_set_default_sort('date', 1);
 249
 250   %params = (%params, map { $_ => $form->{$_} } @report_params);
 251
 252   my @letters       = SL::Letter->find(%params);
 253
 254   $form->{rowcount} = @letters;
 255   $form->{title}    = $locale->text('Letters');
 256
 257   my %column_defs = (
 258     'date'                  => { 'text' => $locale->text('Date'), },
 259     'subject'               => { 'text' => $locale->text('Subject'), },
 260     'letternumber'          => { 'text' => $locale->text('Letternumber'), },
 261     'customer'              => { 'text' => $locale->text('Customer') },
 262     'contact'               => { 'text' => $locale->text('Contact') },
 263     'date'                  => { 'text' => $locale->text('Date') },
 264   );
 265
 266   my @columns = qw(date subject letternumber customer contact date);
 267   my $href    = build_std_url('action=report', grep { $form->{$_} } @report_params);
 268
 269   my @sortable_columns = qw(date subject letternumber customer contact date);
 270
 271   foreach my $name (@sortable_columns) {
 272     my $sortdir                 = $form->{sort} eq $name ? 1 - $form->{sortdir} : $form->{sortdir};
 273     $column_defs{$name}->{link} = $href . "&sort=$name&sortdir=$sortdir";
 274   }
 275
 276   my @options;
 277
 278   # option line
 279
 280   push @options, $locale->text('Subject')                  . " : $form->{subject}"   if ($form->{subject});
 281   push @options, $locale->text('Body')                     . " : $form->{body}"      if ($form->{body});
 282
 283   my @hidden_report_params = map { +{ 'key' => $_, 'value' => $form->{$_} } } @report_params;
 284
 285   my $report = SL::ReportGenerator->new(\%myconfig, $form, 'std_column_visibility' => 1);
 286
 287   $report->set_columns(%column_defs);
 288   $report->set_column_order(@columns);
 289
 290   $report->set_export_options('report', @report_params);
 291
 292   $report->set_sort_indicator($form->{sort}, $form->{sortdir});
 293
 294   $report->set_options('raw_top_info_text'    => $form->parse_html_template('letter/report_top',    { 'OPTIONS' => \@options }),
 295                        'raw_bottom_info_text' => $form->parse_html_template('letter/report_bottom', { 'HIDDEN'  => \@hidden_report_params }),
 296                        'output_format'        => 'HTML',
 297                        'title'                => $form->{title},
 298                        'attachment_basename'  => $locale->text('letters_list') . strftime('_%Y%m%d', localtime time),
 299     );
 300   $report->set_options_from_form();
 301
 302   my $idx      = 0;
 303   my $callback = build_std_url('action=report', grep { $form->{$_} } @report_params);
 304   my $edit_url = build_std_url('action=edit', 'callback=' . E($callback));
 305
 306   foreach my $l (@letters) {
 307     $idx++;
 308
 309     my $row = { map { $_ => { 'data' => $l->{$_} } } keys %{ $l } };
 310
 311     $row->{subject}->{link}      = $edit_url . '&id=' . Q($l->{id});
 312     $row->{letternumber}->{link} = $edit_url . '&id=' . Q($l->{id});
 313
 314     $report->add_data($row);
 315   }
 316
 317   $report->generate_with_headers();
 318
 319   $lxdebug->leave_sub();
 320 }
 321
 322 sub print_letter {
 323   $lxdebug->enter_sub();
 324
 325   $main::auth->assert('sales_letter_edit');
 326
 327   my ($old_form) = @_;
 328
 329   my $display_form = $form->{display_form} || "display_form";
 330   my $letter       = _update();
 331
 332   $letter->export_to($form);
 333   $form->{formname} = "letter";
 334   $form->{format} = "pdf";
 335
 336   my $language_saved      = $form->{language_id};
 337   my $greeting_saved      = $form->{greeting};
 338   my $cp_id_saved         = $form->{cp_id};
 339
 340   call_sub("customer_details");
 341
 342   if (!$cp_id_saved) {
 343     # No contact was selected. Delete all contact variables because
 344     # IS->customer_details() and IR->vendor_details() get the default
 345     # contact anyway.
 346     map({ delete($form->{$_}); } grep(/^cp_/, keys(%{ $form })));
 347   }
 348
 349   $form->{greeting} = $greeting_saved;
 350   $form->{language_id} = $language_saved;
 351
 352   if ($form->{cp_id}) {
 353     CT->get_contact(\%myconfig, $form);
 354   }
 355
 356   $form->{cp_contact_formal} = ($form->{cp_greeting} ? "$form->{cp_greeting} " : '') . ($form->{cp_givenname} ? "$form->{cp_givenname} " : '') . $form->{cp_name};
 357
 358   $form->get_employee_data('prefix' => 'employee', 'id' => $letter->{employee_id});
 359   $form->get_employee_data('prefix' => 'salesman', 'id' => $letter->{salesman_id});
 360
 361   my %create_params = (
 362     template  => scalar(SL::Helper::CreatePDF->find_template(
 363       name        => 'letter',
 364       printer_id  => $::form->{printer_id},
 365       language_id => $::form->{language_id},
 366       formname    => 'letter',
 367       format      => 'pdf',
 368     )),
 369     variables => $::form,
 370     return    => 'file_name',
 371   );
 372   my $pdf_file_name;
 373   eval {
 374     # catch LaTeX template not found error
 375     my $tex_templates  = $::instance_conf->get_templates . '/letter.tex';
 376     die( t8('Please create/copy a template named letter.tex in your client template dir') ) unless (-e $tex_templates);
 377
 378     $pdf_file_name = SL::Helper::CreatePDF->create_pdf(%create_params);
 379     if ( $::form->{media} eq 'email') {
 380       my $mail             = Mailer->new;
 381       my $signature        = $::myconfig{signature};
 382       $mail->{$_}          = $::form->{$_}               for qw(cc subject message bcc to);
 383       $mail->{from}        = qq|"$::myconfig{name}" <$::myconfig{email}>|;
 384       $mail->{fileid}      = time() . '.' . $$ . '.';
 385       $mail->{attachments} =  [{ "filename" => $pdf_file_name,
 386                                  "name"     => $::form->{attachment_name} }];
 387       $mail->{message}    .=  "\n-- \n$signature";
 388       $mail->{message}     =~ s/\r//g;
 389
 390       my $err = $mail->send;
 391 # TODO
 392 #       $self
 393 #           ->js
 394 #           ->flash($err?'error':'info',
 395 #                   $err?t8('A mail error occurred: #1', $err):
 396 #                        t8('The document have been sent to \'#1\'.', $mail->{to}))
 397 #           ->render($self);
 398       return $err?0:1;
 399     }
 400
 401     if (!$::form->{printer_id} || $::form->{media} eq 'screen') {
 402
 403       my $file = IO::File->new($pdf_file_name, 'r') || croak("Cannot open file '$pdf_file_name'");
 404       my $size = -s $pdf_file_name;
 405       my $content_type    =  'application/pdf';
 406       my $attachment_name =  $::form->generate_attachment_filename;
 407       $attachment_name    =~ s:.*//::g;
 408
 409       print $::form->create_http_response(content_type        => $content_type,
 410                                           content_disposition => 'attachment; filename="' . $attachment_name . '"',
 411                                           content_length      => $size);
 412
 413       $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
 414       $file->close;
 415       unlink $pdf_file_name;
 416       return 1;
 417     }
 418
 419     my $printer = SL::DB::Printer->new(id => $::form->{printer_id})->load;
 420     my $command = SL::Template::create(type => 'ShellCommand', form => Form->new(''))->parse($printer->printer_command);
 421
 422     open my $out, '|-', $command or die $!;
 423     binmode $out;
 424     print $out scalar(read_file($pdf_file_name));
 425     close $out;
 426
 427     flash_later('info', t8('The documents have been sent to the printer \'#1\'.', $printer->printer_description));
 428     my $callback = build_std_url('letter.pl', 'action=edit', 'id=' . $letter->{id}, 'printer_id');
 429     $::form->redirect;
 430     1;
 431   } or do {
 432     unlink $pdf_file_name;
 433     $::form->error(t8("Creating the PDF failed:") . " " . $@);
 434   };
 435
 436   $lxdebug->leave_sub();
 437 }
 438
 439 sub update {
 440   $::lxdebug->enter_sub;
 441
 442   $main::auth->assert('sales_letter_edit');
 443
 444   my $name_selected = shift;
 445
 446   _display(
 447     letter => _update(
 448       _name_selected => $name_selected,
 449     ),
 450   );
 451
 452   $::lxdebug->leave_sub;
 453 }
 454
 455 sub _update {
 456   $::lxdebug->enter_sub;
 457
 458   $main::auth->assert('sales_letter_edit');
 459
 460   my %params = @_;
 461
 462   my $from_letter = $::form->{letter};
 463
 464   my $letter      = SL::Letter->new( id => $from_letter->{id} )
 465                               ->load
 466                               ->update_from($from_letter);
 467
 468   $letter->check_name(%params);
 469   $letter->check_date;
 470   $letter->set_greetings;
 471
 472   $::lxdebug->leave_sub;
 473
 474   return $letter;
 475 }
 476
 477 sub letter_tab {
 478   $::lxdebug->enter_sub;
 479
 480   $main::auth->assert('sales_letter_edit');
 481
 482   my @report_params = qw(letternumber subject contact date);
 483
 484   my @letters       = SL::Letter->find(map { $_ => $form->{$_} } @report_params);
 485
 486   $::lxdebug->leave_sub;
 487 }
 488
 489 sub e_mail {
 490   $::lxdebug->enter_sub;
 491
 492   $main::auth->assert('sales_letter_edit');
 493   my $letter = _update();
 494
 495   $letter->check_number;
 496   $letter->save;
 497
 498   $letter->export_to($::form);
 499
 500   $::form->{id} = $letter->{id};
 501   edit_e_mail();
 502
 503   $::lxdebug->leave_sub;
 504 }
 505
 506 sub dispatcher {
 507   $main::lxdebug->enter_sub();
 508   # dispatch drafts
 509   my $locale   = $main::locale;
 510
 511
 512   if ($form->{letter_draft_action} eq $locale->text("Skip")) {
 513     $form->{DONT_LOAD_DRAFT} = 1;
 514     add();
 515     return 1;
 516   } elsif ($form->{letter_draft_action} eq $locale->text("Delete drafts")) {
 517     delete_letter_drafts();
 518     return 1;
 519   }
 520
 521   foreach my $action (qw(e_mail print save update save_letter_draft)) {
 522     if ($::form->{"action_${action}"}) {
 523       $::form->{dispatched_action} = $action;
 524       call_sub($action);
 525       return;
 526     }
 527   }
 528
 529   $::form->error($::locale->text('No action defined.'));
 530   $::lxdebug->leave_sub;
 531 }
 532
 533 sub continue {
 534   call_sub($form->{nextsub});
 535 }
 536
 537
 538 sub load_letter_draft {
 539   $lxdebug->enter_sub();
 540
 541   $main::auth->assert('sales_letter_edit');
 542  $main::lxdebug->leave_sub() and return 0 if ($form->{DONT_LOAD_DRAFT});
 543  $form->{title}    = $locale->text('Letter Draft');
 544  $form->{script}   = 'letter.pl';
 545
 546   my @letter_drafts = SL::Letter->find(draft => 1);
 547
 548   return unless @letter_drafts;
 549   $form->header();
 550   print $form->parse_html_template('letter/load_drafts', { LETTER_DRAFTS => \@letter_drafts });
 551
 552   return 1;
 553   $lxdebug->leave_sub();
 554 }
 555
 556 1;