X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FMailer.pm;h=6bb351701e762c3fce8ce256d80ae9dafa71978b;hb=916003e3c1f8edc11b79b283252aadbc59ac8757;hp=37d98b7a7d00bf12d705eab256f8c144bcec5082;hpb=3d7797630e04ddb308b11a58cd9732d502029125;p=kivitendo-erp.git diff --git a/SL/Mailer.pm b/SL/Mailer.pm index 37d98b7a7..6bb351701 100644 --- a/SL/Mailer.pm +++ b/SL/Mailer.pm @@ -5,14 +5,6 @@ # 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 @@ -25,209 +17,278 @@ # 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; -sub new { - $main::lxdebug->enter_sub(); - - my ($type) = @_; - my $self = {}; - - $main::lxdebug->leave_sub(); - - bless $self, $type; -} +use Email::Address; +use MIME::Entity; +use MIME::Parser; +use File::MimeInfo::Magic; +use File::Slurp; +use List::UtilsBy qw(bundle_by); -sub mime_quote_text { - $main::lxdebug->enter_sub(); +use SL::Common; +use SL::DB::EmailJournal; +use SL::DB::EmailJournalAttachment; +use SL::DB::Employee; +use SL::Template; - my ($self, $text, $chars_left) = @_; +use strict; +use Encode; - my $q_start = "=?$self->{charset}?Q?"; - my $l_start = length($q_start); +my $num_sent = 0; +my $parser; - my $new_text = "$q_start"; - $chars_left -= $l_start; +my %mail_delivery_modules = ( + sendmail => 'SL::Mailer::Sendmail', + smtp => 'SL::Mailer::SMTP', +); - for (my $i = 0; $i < length($text); $i++) { - my $char = ord(substr($text, $i, 1)); - - if (($char < 32) || ($char > 127) || - ($char == ord('?')) || ($char == ord('_'))) { - if ($chars_left < 5) { - $new_text .= "?=\n $q_start"; - $chars_left = 75 - $l_start; - } - - $new_text .= sprintf("=%02X", $char); - $chars_left -= 3; - - } else { - $char = ord('_') if ($char == ord(' ')); - if ($chars_left < 5) { - $new_text .= "?=\n $q_start"; - $chars_left = 75 - $l_start; - } - - $new_text .= chr($char); - $chars_left--; - } - } - - $new_text .= "?="; - - $main::lxdebug->leave_sub(); +sub new { + my ($type, %params) = @_; + my $self = { %params }; + $parser = new MIME::Parser; + $parser->output_under("users"); - return $new_text; + bless $self, $type; } -sub send { - $main::lxdebug->enter_sub(); - - my ($self, $out) = @_; +sub _create_driver { + my ($self) = @_; - my $boundary = time; - $boundary = "LxOffice-$self->{version}-$boundary"; - my $domain = $self->{from}; - $domain =~ s/(.*?\@|>)//g; - my $msgid = "$boundary\@$domain"; + my %params = ( + mailer => $self, + form => $::form, + myconfig => \%::myconfig, + ); - $self->{charset} = "ISO-8859-15" unless $self->{charset}; + my $module = $mail_delivery_modules{ $::lx_office_conf{mail_delivery}->{method} }; + eval "require $module" or return undef; - if ($out) { - if (!open(OUT, $out)) { - $main::lxdebug->leave_sub(); - return "$out : $!"; - } - } else { - if (!open(OUT, ">-")) { - $main::lxdebug->leave_sub(); - return "STDOUT : $!"; - } - } - - $self->{contenttype} = "text/plain" unless $self->{contenttype}; + return $module->new(%params); +} - my ($cc, $bcc); - $cc = "Cc: $self->{cc}\n" if $self->{cc}; - $bcc = "Bcc: $self->{bcc}\n" if $self->{bcc}; +sub _cleanup_addresses { + my ($self) = @_; foreach my $item (qw(to cc bcc)) { + next unless $self->{$item}; + $self->{$item} =~ s/\</{$item} =~ s/\$<\$/{$item} =~ s/\>/>/g; $self->{$item} =~ s/\$>\$/>/g; } +} + +sub _create_message_id { + my ($self) = @_; - my $subject = $self->mime_quote_text($self->{subject}, 60); + $num_sent += 1; + my $domain = $self->{from}; + $domain =~ s/.*\@//; + $domain =~ s/>.*//; - print OUT qq|From: $self->{from} -To: $self->{to} -${cc}${bcc}Subject: $subject -Message-ID: <$msgid> -X-Mailer: Lx-Office $self->{version} -MIME-Version: 1.0 -|; + return "kivitendo-$self->{version}-" . time() . "-${$}-${num_sent}\@$domain"; +} - if ($self->{attachments}) { - print OUT qq|Content-Type: multipart/mixed; boundary="$boundary" +sub _create_address_headers { + my ($self) = @_; -|; - if ($self->{message}) { - print OUT qq|--${boundary} -Content-Type: $self->{contenttype}; charset="$self->{charset}" + # $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->{message} + $self->{addresses} = {}; -|; - } + foreach my $item (qw(from to cc bcc)) { + $self->{addresses}->{$item} = []; + next if !$self->{$item}; - foreach my $attachment (@{ $self->{attachments} }) { + my @header_addresses; - my $filename; + foreach my $addr_obj (Email::Address->parse($self->{$item})) { + push @{ $self->{addresses}->{$item} }, $addr_obj->address; + next if $self->{driver}->keep_from_header($item); - if (ref($attachment) eq "HASH") { - $filename = $attachment->{"name"}; - $attachment = $attachment->{"filename"}; - } else { - $filename = $attachment; - # strip path - $filename =~ s/(.*\/|$self->{fileid})//g; + my $phrase = $addr_obj->phrase(); + if ($phrase) { + $phrase =~ s/^\"//; + $phrase =~ s/\"$//; + $addr_obj->phrase($phrase); } - my $application = - ($attachment =~ /(^\w+$)|\.(html|text|txt|sql)$/) - ? "text" - : "application"; + push @header_addresses, encode('MIME-Header',$addr_obj->format); + } - open(IN, $attachment); - if ($?) { - close(OUT); - $main::lxdebug->leave_sub(); - return "$attachment : $!"; - } + push @{ $self->{headers} }, ( ucfirst($item) => join(', ', @header_addresses) ) if @header_addresses; + } +} - print OUT qq|--${boundary} -Content-Type: $application/$self->{format}; name="$filename"; charset="$self->{charset}" -Content-Transfer-Encoding: BASE64 -Content-Disposition: attachment; filename="$filename"\n\n|; +sub _create_attachment_part { + my ($self, $attachment) = @_; - my $msg = ""; - while () { - ; - $msg .= $_; - } - print OUT &encode_base64($msg); + my %attributes = ( + Disposition => 'attachment', + Encoding => 'base64', + ); - close(IN); + my $file_id = 0; + my $attachment_content; + my $email_journal = $::instance_conf->get_email_journal; - } - print OUT qq|--${boundary}--\n|; + $main::lxdebug->message(LXDebug->DEBUG2(), "mail5 att=".$attachment." email_journal=". $email_journal." id=".$attachment->{id}); + if (ref($attachment) eq "HASH") { + $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 { - print OUT qq|Content-Type: $self->{contenttype}; charset="$self->{charset}" + # strip path + $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; + } -$self->{message} -|; + 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}); + +# $attributes{Charset} = $self->{charset} if lc $application eq 'text' && $self->{charset}; + $attributes{Charset} = $self->{charset} if $self->{charset}; + + 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; +} - close(OUT); +sub _create_message { + my ($self) = @_; - $main::lxdebug->leave_sub(); + push @{ $self->{headers} }, ('Type' =>"multipart/mixed" ); + my $top = MIME::Entity->build(@{$self->{headers}}); + if ($self->{message}) { + $top->attach(Data => encode($self->{charset},$self->{message}), + Charset => $self->{charset}, + Type => $self->{contenttype}, + Encoding => 'quoted-printable'); + } - return ""; + map { $top->add_part($self->_create_attachment_part($_)) } @{ $self->{attachments} || [] }; + return $top; } -sub encode_base64 ($;$) { - $main::lxdebug->enter_sub(); +sub send { + my ($self) = @_; - # this code is from the MIME-Base64-2.12 package - # Copyright 1995-1999,2001 Gisle Aas + # 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 : $@"; + } - my $res = ""; - my $eol = $_[1]; - $eol = "\n" unless defined $eol; - pos($_[0]) = 0; # ensure start at the beginning + # Set defaults & headers + $self->{charset} = 'UTF-8'; + $self->{contenttype} ||= "text/plain"; + $self->{headers} = [ + 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; - $res = join '', map(pack('u', $_) =~ /^.(\S*)/, ($_[0] =~ /(.{1,45})/gs)); + my $error; + my $ok = eval { + # Clean up To/Cc/Bcc address fields + $self->_cleanup_addresses; + $self->_create_address_headers; - $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; + my $email = $self->_create_message; - # break encoded string into lines of no more than 60 characters each - if (length $eol) { - $res =~ s/(.{1,60})/$1$eol/g; - } + #$::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; - $main::lxdebug->leave_sub(); + 1; + }; - return $res; + $error = $@ if !$ok; + + $self->{journalentry} = $self->_store_in_journal; + $parser->filer->purge; + + return $ok ? '' : "send email: $error"; } -1; +sub _all_recipients { + my ($self) = @_; + $self->{addresses} ||= {}; + return map { @{ $self->{addresses}->{$_} || [] } } qw(to cc bcc); +} +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;