Consolidation and extended test runs

[mfinanz.git] / SL / Mailer.pm

diff --git a/SL/Mailer.pm b/SL/Mailer.pm
index c4cea35f20181affeed2bd1be867520eb4b84bfa..6536850581a0b611669c39c8e5e697a5b1a799c1 100644 (file)
--- a/SL/Mailer.pm
+++ b/SL/Mailer.pm
@@ -5,14 +5,6 @@
 # Web http://www.lx-office.org
 #
 #=====================================================================
 # Web http://www.lx-office.org
 #
 #=====================================================================

-# SQL-Ledger Accounting
-# Copyright (C) 2001
-#
-#  Author: Dieter Simader
-#   Email: dsimader@sql-ledger.org
-#     Web: http://www.sql-ledger.org
-#
-# Contributors:

 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by


@@ -31,9 +23,14 @@
 package Mailer;
 
 use Email::Address;
 package Mailer;
 
 use Email::Address;

-use Encode;
+use Email::MIME::Creator;
+use File::Slurp;
+use List::UtilsBy qw(bundle_by);

 
 use SL::Common;
 
 use SL::Common;

+use SL::DB::EmailJournal;
+use SL::DB::EmailJournalAttachment;
+use SL::DB::Employee;

 use SL::MIME;
 use SL::Template;
 
 use SL::MIME;
 use SL::Template;
 


@@ -42,236 +39,239 @@ use strict;
 my $num_sent = 0;
 
 sub new {
 my $num_sent = 0;
 
 sub new {

-  $main::lxdebug->enter_sub();
-
-  my ($type) = @_;
-  my $self = {};
-
-  $main::lxdebug->leave_sub();
+  my ($type, %params) = @_;
+  my $self = { %params };

 
   bless $self, $type;
 }
 
 
   bless $self, $type;
 }
 

-sub mime_quote_text {
-  $main::lxdebug->enter_sub();
-
-  my ($self, $text, $chars_left) = @_;
-
-  my $q_start = "=?$self->{charset}?Q?";
-  my $l_start = length($q_start);
+sub _create_driver {
+  my ($self) = @_;

 
 

-  my $new_text = "$q_start";
-  $chars_left -= $l_start if (defined $chars_left);
+  my %params = (
+    mailer   => $self,
+    form     => $::form,
+    myconfig => \%::myconfig,
+  );

 
 

-  for (my $i = 0; $i < length($text); $i++) {
-    my $char = ord(substr($text, $i, 1));
+  my $module = ($::lx_office_conf{mail_delivery}->{method} || 'smtp') ne 'smtp' ? 'SL::Mailer::Sendmail' : 'SL::Mailer::SMTP';
+  eval "require $module" or return undef;

 
 

-    if (($char < 32) || ($char > 127) || ($char == ord('?')) || ($char == ord('_'))) {
-      if ((defined $chars_left) && ($chars_left < 5)) {
-        $new_text .= "?=\n $q_start";
-        $chars_left = 75 - $l_start;
-      }
+  return $module->new(%params);
+}

 
 

-      $new_text .= sprintf("=%02X", $char);
-      $chars_left -= 3 if (defined $chars_left);
+sub _cleanup_addresses {
+  my ($self) = @_;

 
 

-    } else {
-      $char = ord('_') if ($char == ord(' '));
-      if ((defined $chars_left) && ($chars_left < 5)) {
-        $new_text .= "?=\n $q_start";
-        $chars_left = 75 - $l_start;
-      }
+  foreach my $item (qw(to cc bcc)) {
+    next unless $self->{$item};

 
 

-      $new_text .= chr($char);
-      $chars_left-- if (defined $chars_left);
-    }
+    $self->{$item} =~ s/\&lt;/</g;
+    $self->{$item} =~ s/\$<\$/</g;
+    $self->{$item} =~ s/\&gt;/>/g;
+    $self->{$item} =~ s/\$>\$/>/g;

   }
   }

-
-  $new_text .= "?=";
-
-  $main::lxdebug->leave_sub();
-
-  return $new_text;

 }
 
 }
 

-sub send {
-  $main::lxdebug->enter_sub();
-
+sub _create_message_id {

   my ($self) = @_;
 
   my ($self) = @_;
 

-  local (*IN, *OUT);
-
-  $num_sent++;
-  my $boundary    = time() . "-$$-${num_sent}";
-  $boundary       =  "LxOffice-$self->{version}-$boundary";
-  my $domain      =  $self->recode($self->{from});
-  $domain         =~ s/(.*?\@|>)//g;
-  my $msgid       =  "$boundary\@$domain";
-
-  my $form        =  $main::form;
-  my $myconfig    =  \%main::myconfig;
+  $num_sent  +=  1;
+  my $domain  =  $self->{from};
+  $domain     =~ s/.*\@//;
+  $domain     =~ s/>.*//;

 
 

-  my $email       =  $self->recode($myconfig->{email});
-  $email          =~ s/[^\w\.\-\+=@]//ig;
+  return  "kivitendo-$self->{version}-" . time() . "-${$}-${num_sent}\@$domain";
+}

 
 

-  my %temp_form   = ( %{ $form }, 'myconfig_email' => $email );
-  my $template    = SL::Template::create(type => 'PlainText', form => \%temp_form);
-  my $sendmail    = $template->parse_block($::lx_office_conf{applications}->{sendmail});
+sub _create_address_headers {
+  my ($self) = @_;

 
 

-  if (!open(OUT, "|$sendmail")) {
-    $main::lxdebug->leave_sub();
-    return "$sendmail : $!";
-  }
+  # $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->{charset}     ||= Common::DEFAULT_CHARSET;
-  $self->{contenttype} ||= "text/plain";
+  $self->{addresses} = {};

 
 

-  foreach my $item (qw(to cc bcc)) {
-    next unless ($self->{$item});
-    $self->{$item} =  $self->recode($self->{$item});
-    $self->{$item} =~ s/\&lt;/</g;
-    $self->{$item} =~ s/\$<\$/</g;
-    $self->{$item} =~ s/\&gt;/>/g;
-    $self->{$item} =~ s/\$>\$/>/g;
-  }
+  foreach my $item (qw(from to cc bcc)) {
+    $self->{addresses}->{$item} = [];
+    next if !$self->{$item};

 
 

-  $self->{from} = $self->recode($self->{from});
+    my @header_addresses;

 
 

-  my $headers = '';
-  foreach my $item (qw(from to cc bcc)) {
-    next unless ($self->{$item});
-    my (@addr_objects) = Email::Address->parse($self->{$item});
-    next unless (scalar @addr_objects);
+    foreach my $addr_obj (Email::Address->parse($self->{$item})) {
+      push @{ $self->{addresses}->{$item} }, $addr_obj->address;
+      next if $self->{driver}->keep_from_header($item);

 
 

-    foreach my $addr_obj (@addr_objects) {

       my $phrase = $addr_obj->phrase();
       if ($phrase) {
         $phrase =~ s/^\"//;
         $phrase =~ s/\"$//;
       my $phrase = $addr_obj->phrase();
       if ($phrase) {
         $phrase =~ s/^\"//;
         $phrase =~ s/\"$//;

-        $addr_obj->phrase($self->mime_quote_text($phrase));
+        $addr_obj->phrase($phrase);

       }
 
       }
 

-      $headers .= sprintf("%s: %s\n", ucfirst($item), $addr_obj->format());
+      push @header_addresses, $addr_obj->format;

     }
     }

+
+    push @{ $self->{headers} }, ( ucfirst($item) => join(', ', @header_addresses) ) if @header_addresses;

   }
   }

+}

 
 

-  $headers .= sprintf("Subject: %s\n", $self->mime_quote_text($self->recode($self->{subject}), 60));
+sub _create_attachment_part {
+  my ($self, $attachment) = @_;

 
 

-  print OUT qq|${headers}Message-ID: <$msgid>
-X-Mailer: Lx-Office $self->{version}
-MIME-Version: 1.0
-|;
+  my %attributes = (
+    disposition  => 'attachment',
+    encoding     => 'base64',
+  );

 
 

-  if ($self->{attachments}) {
-    print OUT qq|Content-Type: multipart/mixed; boundary="$boundary"
+  my $attachment_content;

 
 

-|;
-    if ($self->{message}) {
-      print OUT qq|--${boundary}
-Content-Type: $self->{contenttype}; charset="$self->{charset}"
+  if (ref($attachment) eq "HASH") {
+    $attributes{filename} = $attachment->{name};
+    $attachment_content   = $attachment->{content} // eval { read_file($attachment->{filename}) };

 
 

-| . $self->recode($self->{message}) . qq|
+  } else {
+    # strip path
+    $attributes{filename} =  $attachment;
+    $attributes{filename} =~ s:.*\Q$self->{fileid}\E:: if $self->{fileid};
+    $attributes{filename} =~ s:.*/::g;
+    $attachment_content   =  eval { read_file($attachment) };
+  }

 
 

-|;
-    }
+  return undef if !defined $attachment_content;

 
 

-    foreach my $attachment (@{ $self->{attachments} }) {
+  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};

 
 

-      my $filename;
+  return Email::MIME->create(
+    attributes => \%attributes,
+    body       => $attachment_content,
+  );
+}

 
 

-      if (ref($attachment) eq "HASH") {
-        $filename = $attachment->{"name"};
-        $attachment = $attachment->{"filename"};
-      } else {
-        $filename = $attachment;
-        # strip path
-        $filename =~ s/(.*\/|\Q$self->{fileid}\E)//g;
-      }
+sub _create_message {
+  my ($self) = @_;

 
 

-      my $application    = ($attachment =~ /(^\w+$)|\.(html|text|txt|sql)$/) ? "text" : "application";
-      my $content_type   = SL::MIME->mime_type_from_ext($filename);
-      $content_type      = "${application}/$self->{format}" if (!$content_type && $self->{format});
-      $content_type    ||= 'application/octet-stream';
+  my @parts;
+
+  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}"|,
+    );
+  }

 
 

-      open(IN, $attachment);
-      if ($?) {
-        close(OUT);
-        $main::lxdebug->leave_sub();
-        return "$attachment : $!";
-      }
+  push @parts, grep { $_ } map { $self->_create_attachment_part($_) } @{ $self->{attachments} || [] };

 
 

-      # only set charset for attachements of type text. every other type should not have this field
-      # refer to bug 883 for detailed information
-      my $attachment_charset;
-      if (lc $application eq 'text' && $self->{charset}) {
-        $attachment_charset = qq|; charset="$self->{charset}" |;
-      }
+  return Email::MIME->create(
+    header_str => $self->{headers},
+    parts      => \@parts,
+  );
+}

 
 

-      print OUT qq|--${boundary}
-Content-Type: ${content_type}; name="$filename"$attachment_charset
-Content-Transfer-Encoding: BASE64
-Content-Disposition: attachment; filename="$filename"\n\n|;
+sub send {
+  my ($self) = @_;

 
 

-      my $msg = "";
-      while (<IN>) {
-        ;
-        $msg .= $_;
-      }
-      print OUT &encode_base64($msg);
+  # Create driver for delivery method (sendmail/SMTP)
+  $self->{driver} = eval { $self->_create_driver };
+  if (!$self->{driver}) {
+    $self->_store_in_journal('failed', 'driver could not be created; check your configuration');
+    return "send email : $@";
+  }

 
 

-      close(IN);
+  # Set defaults & headers
+  $self->{charset}       =  'UTF-8';
+  $self->{contenttype} ||=  "text/plain";
+  $self->{headers}       =  [
+    Subject              => $self->{subject},
+    'Message-ID'         => '<' . $self->_create_message_id . '>',
+    'X-Mailer'           => "kivitendo $self->{version}",
+  ];

 
 

-    }
-    print OUT qq|--${boundary}--\n|;
+  my $error;
+  my $ok = eval {
+    # Clean up To/Cc/Bcc address fields
+    $self->_cleanup_addresses;
+    $self->_create_address_headers;

 
 

-  } else {
-    print OUT qq|Content-Type: $self->{contenttype}; charset="$self->{charset}"
+    my $email = $self->_create_message;

 
 

-| . $self->recode($self->{message}) . qq|
-|;
-  }
+    # $::lxdebug->message(0, "message: " . $email->as_string);
+    # return "boom";

 
 

-  close(OUT);
+    $self->{driver}->start_mail(from => $self->{from}, to => [ $self->_all_recipients ]);
+    $self->{driver}->print($email->as_string);
+    $self->{driver}->send;

 
 

-  $main::lxdebug->leave_sub();
+    1;
+  };

 
 

-  return "";
-}
+  $error = $@ if !$ok;

 
 

-sub encode_base64 ($;$) {
-  $main::lxdebug->enter_sub();
+  $self->_store_in_journal;

 
 

-  # this code is from the MIME-Base64-2.12 package
-  # Copyright 1995-1999,2001 Gisle Aas <gisle@ActiveState.com>
+  return $ok ? '' : "send email: $error";
+}

 
 

-  my $res = "";
-  my $eol = $_[1];
-  $eol = "\n" unless defined $eol;
-  pos($_[0]) = 0;    # ensure start at the beginning
+sub _all_recipients {
+  my ($self) = @_;

 
 

-  $res = join '', map(pack('u', $_) =~ /^.(\S*)/, ($_[0] =~ /(.{1,45})/gs));
+  $self->{addresses} ||= {};
+  return map { @{ $self->{addresses}->{$_} || [] } } qw(to cc bcc);
+}

 
 

-  $res =~ tr|` -_|AA-Za-z0-9+/|;    # `# help emacs
-                                    # fix padding at the end
-  my $padding = (3 - length($_[0]) % 3) % 3;
-  $res =~ s/.{$padding}$/'=' x $padding/e if $padding;
+sub _store_in_journal {
+  my ($self, $status, $extended_status) = @_;

 
 

-  # break encoded string into lines of no more than 60 characters each
-  if (length $eol) {
-    $res =~ s/(.{1,60})/$1$eol/g;
-  }
+  my $journal_enable = $::instance_conf->get_email_journal;

 
 

-  $main::lxdebug->leave_sub();
+  return if $journal_enable == 0;

 
 

-  return $res;
-}
+  $status          //= $self->{driver}->status if $self->{driver};
+  $status          //= 'failed';
+  $extended_status //= $self->{driver}->extended_status if $self->{driver};
+  $extended_status //= 'unknown error';

 
 

-sub recode {
-  my $self = shift;
-  my $text = shift;
+  my @attachments;

 
 

-  return $::locale->is_utf8 ? Encode::encode('utf-8-strict', $text) : $text;
+  @attachments = grep { $_ } map {
+    my $part = $self->_create_attachment_part($_);
+    if ($part) {
+      SL::DB::EmailJournalAttachment->new(
+        name      => $part->filename,
+        mime_type => $part->content_type,
+        content   => $part->body,
+      )
+    }
+  } @{ $self->{attachments} || [] } if $journal_enable > 1;
+
+  my $headers = join "\r\n", (bundle_by { join(': ', @_) } 2, @{ $self->{headers} || [] });
+
+  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     => \@attachments,
+    status          => $status,
+    extended_status => $extended_status,
+  )->save;

 }
 
 1;
 }
 
 1;

-