SimpleSystemSetting: Controller für die ganzen trivialen CRUD-Masken im System-Menü
[kivitendo-erp.git] / SL / Mailer.pm
index 2857e1c..6bb3517 100644 (file)
 # GNU General Public License for more details.
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1335, USA.
 #======================================================================
 
 package Mailer;
 
 use Email::Address;
-use Email::MIME::Creator;
+use MIME::Entity;
+use MIME::Parser;
+use File::MimeInfo::Magic;
 use File::Slurp;
+use List::UtilsBy qw(bundle_by);
 
 use SL::Common;
-use SL::MIME;
+use SL::DB::EmailJournal;
+use SL::DB::EmailJournalAttachment;
+use SL::DB::Employee;
 use SL::Template;
 
 use strict;
+use Encode;
 
 my $num_sent = 0;
+my $parser;
+
+my %mail_delivery_modules = (
+  sendmail => 'SL::Mailer::Sendmail',
+  smtp     => 'SL::Mailer::SMTP',
+);
 
 sub new {
   my ($type, %params) = @_;
   my $self = { %params };
+  $parser = new MIME::Parser;
+  $parser->output_under("users");
 
   bless $self, $type;
 }
@@ -50,7 +65,7 @@ sub _create_driver {
     myconfig => \%::myconfig,
   );
 
-  my $module = ($::lx_office_conf{mail_delivery}->{method} || 'smtp') ne 'smtp' ? 'SL::Mailer::Sendmail' : 'SL::Mailer::SMTP';
+  my $module = $mail_delivery_modules{ $::lx_office_conf{mail_delivery}->{method} };
   eval "require $module" or return undef;
 
   return $module->new(%params);
@@ -83,16 +98,23 @@ sub _create_message_id {
 sub _create_address_headers {
   my ($self) = @_;
 
+  # $self->{addresses} collects the recipients for use in e.g. the
+  # SMTP 'RCPT TO:' envelope command. $self->{headers} collects the
+  # headers that make up the actual email. 'BCC' should not be
+  # included there for certain transportation methods (SMTP).
+
   $self->{addresses} = {};
 
   foreach my $item (qw(from to cc bcc)) {
     $self->{addresses}->{$item} = [];
-    next if !$self->{$item} || $self->{driver}->keep_from_header($item);
+    next if !$self->{$item};
 
     my @header_addresses;
 
     foreach my $addr_obj (Email::Address->parse($self->{$item})) {
       push @{ $self->{addresses}->{$item} }, $addr_obj->address;
+      next if $self->{driver}->keep_from_header($item);
+
       my $phrase = $addr_obj->phrase();
       if ($phrase) {
         $phrase =~ s/^\"//;
@@ -100,7 +122,7 @@ sub _create_address_headers {
         $addr_obj->phrase($phrase);
       }
 
-      push @header_addresses, $addr_obj->format;
+      push @header_addresses, encode('MIME-Header',$addr_obj->format);
     }
 
     push @{ $self->{headers} }, ( ucfirst($item) => join(', ', @header_addresses) ) if @header_addresses;
@@ -110,66 +132,81 @@ sub _create_address_headers {
 sub _create_attachment_part {
   my ($self, $attachment) = @_;
 
-  my $source_file_name;
-
   my %attributes = (
-    disposition  => 'attachment',
-    encoding     => 'base64',
+    Disposition  => 'attachment',
+    Encoding     => 'base64',
   );
 
+  my $file_id = 0;
+  my $attachment_content;
+  my $email_journal = $::instance_conf->get_email_journal;
+
+  $main::lxdebug->message(LXDebug->DEBUG2(), "mail5 att=".$attachment." email_journal=". $email_journal." id=".$attachment->{id});
   if (ref($attachment) eq "HASH") {
-    $attributes{filename} = $attachment->{name};
-    $source_file_name     = $attachment->{filename};
+    $attributes{Path}     = $attachment->{path} || $attachment->{filename};
+    $attributes{Filename} = $attachment->{name};
+    $file_id              = $attachment->{id}   || '0';
+    $attributes{Type}     = $attachment->{type} || 'application/pdf';
+    $attachment_content   = eval { read_file($attachment->{path}) } if $email_journal > 1;
 
   } else {
     # strip path
-    $attributes{filename} =  $attachment;
-    $attributes{filename} =~ s:.*\Q$self->{fileid}\E:: if $self->{fileid};
-    $attributes{filename} =~ s:.*/::g;
-    $source_file_name     =  $attachment;
+    $attributes{Path}     =  $attachment;
+    $attributes{Filename} =  $attachment;
+    $attributes{Filename} =~ s:.*\Q$self->{fileid}\E:: if $self->{fileid};
+    $attributes{Filename} =~ s:.*/::g;
+
+    my $application     = ($attachment =~ /(^\w+$)|\.(html|text|txt|sql)$/) ? 'text' : 'application';
+    $attributes{Type}   = File::MimeInfo::Magic::magic($attachment);
+    $attributes{Type} ||= "${application}/$self->{format}" if $self->{format};
+    $attributes{Type} ||= 'application/octet-stream';
+    $attachment_content = eval { read_file($attachment) } if $email_journal > 1;
   }
 
-  my $attachment_content = eval { read_file($source_file_name) };
-  return undef if !defined $attachment_content;
+  return undef if $email_journal > 1 && !defined $attachment_content;
+  $attachment_content ||= ' ';
+  $main::lxdebug->message(LXDebug->DEBUG2(), "mail6 mtype=".$attributes{Type}." path=".
+                            $attributes{Path}." filename=".$attributes{Filename});
 
-  my $application             = ($attachment =~ /(^\w+$)|\.(html|text|txt|sql)$/) ? 'text' : 'application';
-  $attributes{content_type}   = SL::MIME->mime_type_from_ext($attributes{filename});
-  $attributes{content_type} ||= "${application}/$self->{format}" if $self->{format};
-  $attributes{content_type} ||= 'application/octet-stream';
-  $attributes{charset}        = $self->{charset} if lc $application eq 'text' && $self->{charset};
+# $attributes{Charset}  = $self->{charset} if lc $application eq 'text' && $self->{charset};
+  $attributes{Charset}  = $self->{charset} if $self->{charset};
 
-  return Email::MIME->create(
-    attributes => \%attributes,
-    body       => $attachment_content,
+  my $ent;
+  if ( $attributes{Type} eq 'message/rfc822' ) {
+    my $fh = IO::File->new($attributes{Path}, "r");
+    if (! defined $fh) {
+      return undef;
+    }
+    $ent = $parser->parse($fh);
+    undef $fh;
+    my $head = $ent->head;
+    $head->replace('Content-disposition','attachment; filename='.$attributes{Filename});
+  } else {
+    $ent = MIME::Entity->build(%attributes);
+  }
+  push @{ $self->{mail_attachments}} , SL::DB::EmailJournalAttachment->new(
+    name      => $attributes{Filename},
+    mime_type => $attributes{Type},
+    content   => ( $email_journal > 1 ? $attachment_content : ' '),
+    file_id   => $file_id,
   );
+  return $ent;
 }
 
 sub _create_message {
   my ($self) = @_;
 
-  my @parts;
-
+  push @{ $self->{headers} }, ('Type'    =>"multipart/mixed" );
+  my  $top = MIME::Entity->build(@{$self->{headers}});
   if ($self->{message}) {
-    push @parts, Email::MIME->create(
-      attributes => {
-        content_type => $self->{contenttype},
-        charset      => $self->{charset},
-        encoding     => 'quoted-printable',
-      },
-      body_str => $self->{message},
-    );
-
-    push @{ $self->{headers} }, (
-      'Content-Type' => qq|$self->{contenttype}; charset="$self->{charset}"|,
-    );
+    $top->attach(Data => encode($self->{charset},$self->{message}),
+                 Charset => $self->{charset},
+                 Type => $self->{contenttype},
+                 Encoding    => 'quoted-printable');
   }
 
-  push @parts, grep { $_ } map { $self->_create_attachment_part($_) } @{ $self->{attachments} || [] };
-
-  return Email::MIME->create(
-    header_str => $self->{headers},
-    parts      => \@parts,
-  );
+  map { $top->add_part($self->_create_attachment_part($_)) } @{ $self->{attachments} || [] };
+  return $top;
 }
 
 sub send {
@@ -178,33 +215,80 @@ sub send {
   # Create driver for delivery method (sendmail/SMTP)
   $self->{driver} = eval { $self->_create_driver };
   if (!$self->{driver}) {
-    $::lxdebug->leave_sub();
+    $self->_store_in_journal('failed', 'driver could not be created; check your configuration');
     return "send email : $@";
   }
 
   # Set defaults & headers
-  $self->{charset}     ||=  Common::DEFAULT_CHARSET;
+  $self->{charset}       =  'UTF-8';
   $self->{contenttype} ||=  "text/plain";
   $self->{headers}       =  [
-    Subject              => $self->{subject},
-    'Message-ID'         => $self->_create_message_id,
+    Subject              => encode('MIME-Header',$self->{subject}),
+    'Message-ID'         => '<' . $self->_create_message_id . '>',
     'X-Mailer'           => "kivitendo $self->{version}",
   ];
+  $self->{mail_attachments} = [];
+  $self->{content_by_name}  = $::instance_conf->get_email_journal == 1 && $::instance_conf->get_doc_files;
+
+  my $error;
+  my $ok = eval {
+    # Clean up To/Cc/Bcc address fields
+    $self->_cleanup_addresses;
+    $self->_create_address_headers;
+
+    my $email = $self->_create_message;
+
+    #$::lxdebug->message(0, "message: " . $email->as_string);
+    # return "boom";
+
+    $self->{driver}->start_mail(from => encode('MIME-Header',$self->{from}), to => [ $self->_all_recipients ]);
+    $self->{driver}->print($email->as_string);
+    $self->{driver}->send;
 
-  # Clean up To/Cc/Bcc address fields
-  $self->_cleanup_addresses;
-  $self->_create_address_headers;
+    1;
+  };
 
-  my $email = $self->_create_message;
+  $error = $@ if !$ok;
 
-  # $::lxdebug->message(0, "message: " . $email->as_string);
-  # return "boom";
+  $self->{journalentry} = $self->_store_in_journal;
+  $parser->filer->purge;
 
-  $self->{driver}->start_mail(from => $self->{from}, to => [ map { @{ $self->{addresses}->{$_} } } qw(to cc bcc) ]);
-  $self->{driver}->print($email->as_string);
-  $self->{driver}->send;
+  return $ok ? '' : "send email: $error";
+}
+
+sub _all_recipients {
+  my ($self) = @_;
+  $self->{addresses} ||= {};
+  return map { @{ $self->{addresses}->{$_} || [] } } qw(to cc bcc);
+}
 
-  return '';
+sub _store_in_journal {
+  my ($self, $status, $extended_status) = @_;
+
+  my $journal_enable = $::instance_conf->get_email_journal;
+
+  return if $journal_enable == 0;
+
+  $status          //= $self->{driver}->status if $self->{driver};
+  $status          //= 'failed';
+  $extended_status //= $self->{driver}->extended_status if $self->{driver};
+  $extended_status //= 'unknown error';
+
+  my $headers = join "\r\n", (bundle_by { join(': ', @_) } 2, @{ $self->{headers} || [] });
+
+  my $jentry = SL::DB::EmailJournal->new(
+    sender          => SL::DB::Manager::Employee->current,
+    from            => $self->{from}    // '',
+    recipients      => join(', ', $self->_all_recipients),
+    subject         => $self->{subject} // '',
+    headers         => $headers,
+    body            => $self->{message} // '',
+    sent_on         => DateTime->now_local,
+    attachments     => \@{ $self->{mail_attachments} },
+    status          => $status,
+    extended_status => $extended_status,
+  )->save;
+  return $jentry->id;
 }
 
 1;