X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FMailer.pm;h=87b3dfc86cc08778d3735d9ae349bed0c8559634;hb=826d79929635c726f7459296fafa7e630c00e72d;hp=c4cea35f20181affeed2bd1be867520eb4b84bfa;hpb=a99b261f6a4a4b1988ce2e0ad4c27ed579378cb9;p=kivitendo-erp.git diff --git a/SL/Mailer.pm b/SL/Mailer.pm index c4cea35f2..87b3dfc86 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,253 +17,289 @@ # 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 Encode; +use Email::MIME::Creator; +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; my $num_sent = 0; -sub new { - $main::lxdebug->enter_sub(); +my %mail_delivery_modules = ( + sendmail => 'SL::Mailer::Sendmail', + smtp => 'SL::Mailer::SMTP', +); - my ($type) = @_; - my $self = {}; - - $main::lxdebug->leave_sub(); +sub new { + my ($type, %params) = @_; + my $self = { %params }; 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 = $mail_delivery_modules{ $::lx_office_conf{mail_delivery}->{method} }; + 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/\</{$item} =~ s/\$<\$/{$item} =~ s/\>/>/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) = @_; - 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/\</{$item} =~ s/\$<\$/{$item} =~ s/\>/>/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/\"$//; - $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; } - } - $headers .= sprintf("Subject: %s\n", $self->mime_quote_text($self->recode($self->{subject}), 60)); + push @{ $self->{headers} }, ( ucfirst($item) => join(', ', @header_addresses) ) if @header_addresses; + } +} - print OUT qq|${headers}Message-ID: <$msgid> -X-Mailer: Lx-Office $self->{version} -MIME-Version: 1.0 -|; +sub _create_attachment_part { + my ($self, $attachment) = @_; - if ($self->{attachments}) { - print OUT qq|Content-Type: multipart/mixed; boundary="$boundary" + my %attributes = ( + disposition => 'attachment', + encoding => 'base64', + ); -|; - if ($self->{message}) { - print OUT qq|--${boundary} -Content-Type: $self->{contenttype}; charset="$self->{charset}" + my $attachment_content; + my $file_id = 0; + my $email_journal = $::instance_conf->get_email_journal; -| . $self->recode($self->{message}) . qq| + $::lxdebug->message(LXDebug->DEBUG2(), "mail5 att=" . $attachment . " email_journal=" . $email_journal . " id=" . $attachment->{id}); -|; - } + if (ref($attachment) eq "HASH") { + $attributes{filename} = $attachment->{name}; + $file_id = $attachment->{id} || '0'; + $attributes{content_type} = $attachment->{type} || 'application/pdf'; + $attachment_content = $attachment->{content}; + $attachment_content = eval { read_file($attachment->{path}) } if !$attachment_content; - foreach my $attachment (@{ $self->{attachments} }) { + } else { + $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{content_type} = File::MimeInfo::Magic::magic($attachment); + $attributes{content_type} ||= "${application}/$self->{format}" if $self->{format}; + $attributes{content_type} ||= 'application/octet-stream'; + $attachment_content = eval { read_file($attachment) }; + } - my $filename; + return undef if $email_journal > 1 && !defined $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; - } + $attachment_content ||= ' '; + $attributes{charset} = $self->{charset} if $self->{charset} && ($attributes{content_type} =~ m{^text/}); - 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'; + $::lxdebug->message(LXDebug->DEBUG2(), "mail6 mtype=" . $attributes{content_type} . " filename=" . $attributes{filename}); - open(IN, $attachment); - if ($?) { - close(OUT); - $main::lxdebug->leave_sub(); - return "$attachment : $!"; - } + my $ent; + if ( $attributes{content_type} eq 'message/rfc822' ) { + $ent = Email::MIME->new($attachment_content); + $ent->header_str_set('Content-disposition' => 'attachment; filename='.$attributes{filename}); + } else { + $ent = Email::MIME->create( + attributes => \%attributes, + body => $attachment_content, + ); + } - # 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}" |; - } + push @{ $self->{mail_attachments}} , SL::DB::EmailJournalAttachment->new( + name => $attributes{filename}, + mime_type => $attributes{content_type}, + content => ( $email_journal > 1 ? $attachment_content : ' '), + file_id => $file_id, + ); - print OUT qq|--${boundary} -Content-Type: ${content_type}; name="$filename"$attachment_charset -Content-Transfer-Encoding: BASE64 -Content-Disposition: attachment; filename="$filename"\n\n|; + return $ent; +} - my $msg = ""; - while () { - ; - $msg .= $_; - } - print OUT &encode_base64($msg); +sub _create_message { + my ($self) = @_; - close(IN); + my @parts; - } - print OUT qq|--${boundary}--\n|; + push @{ $self->{headers} }, (Type => "multipart/mixed"); - } else { - print OUT qq|Content-Type: $self->{contenttype}; charset="$self->{charset}" + if ($self->{message}) { + push @parts, Email::MIME->create( + attributes => { + content_type => $self->{contenttype}, + charset => $self->{charset}, + encoding => 'quoted-printable', + }, + body_str => $self->{message}, + ); -| . $self->recode($self->{message}) . qq| -|; + push @{ $self->{headers} }, ( + 'Content-Type' => qq|$self->{contenttype}; charset="$self->{charset}"|, + ); } - close(OUT); - - $main::lxdebug->leave_sub(); + push @parts, grep { $_ } map { $self->_create_attachment_part($_) } @{ $self->{attachments} || [] }; - return ""; + return Email::MIME->create( + header_str => $self->{headers}, + parts => \@parts, + ); } -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}) { + my $error = $@; + $self->_store_in_journal('failed', 'driver could not be created; check your configuration & log files'); + $::lxdebug->message(LXDebug::WARN(), "Mailer error during 'send': $error"); - my $res = ""; - my $eol = $_[1]; - $eol = "\n" unless defined $eol; - pos($_[0]) = 0; # ensure start at the beginning + return $error; + } - $res = join '', map(pack('u', $_) =~ /^.(\S*)/, ($_[0] =~ /(.{1,45})/gs)); + # 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}", + ]; + $self->{mail_attachments} = []; + $self->{content_by_name} = $::instance_conf->get_email_journal == 1 && $::instance_conf->get_doc_files; - $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 $error; + my $ok = eval { + # Clean up To/Cc/Bcc address fields + $self->_cleanup_addresses; + $self->_create_address_headers; - # break encoded string into lines of no more than 60 characters each - if (length $eol) { - $res =~ s/(.{1,60})/$1$eol/g; - } + my $email = $self->_create_message; - $main::lxdebug->leave_sub(); + #$::lxdebug->message(0, "message: " . $email->as_string); + # return "boom"; - return $res; + $::lxdebug->message(LXDebug->DEBUG2(), "mail1 from=".$self->{from}." to=".$self->{to}); + my $from_obj = (Email::Address->parse($self->{from}))[0]; + + $self->{driver}->start_mail(from => $from_obj->address, to => [ $self->_all_recipients ]); + $self->{driver}->print($email->as_string); + $self->{driver}->send; + + 1; + }; + + $error = $@ if !$ok; + + $self->{journalentry} = $self->_store_in_journal; + + return $ok ? '' : ($error || "undefined error"); } -sub recode { - my $self = shift; - my $text = shift; +sub _all_recipients { + my ($self) = @_; + $self->{addresses} ||= {}; + return map { @{ $self->{addresses}->{$_} || [] } } qw(to cc bcc); +} - return $::locale->is_utf8 ? Encode::encode('utf-8-strict', $text) : $text; +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; -