X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FMailer.pm;h=f242120a964c89ec1593303556a7b49431ff46c4;hb=2a0cbd885790174fa0f212e6661b30362650a42c;hp=2857e1c755b7882b730ef2d20aa3ef0f94f44584;hpb=9981de23726fdc95f753cc7e5cba15999c8ab507;p=kivitendo-erp.git diff --git a/SL/Mailer.pm b/SL/Mailer.pm index 2857e1c75..f242120a9 100644 --- a/SL/Mailer.pm +++ b/SL/Mailer.pm @@ -17,23 +17,51 @@ # 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 Encode; +use File::MimeInfo::Magic; use File::Slurp; +use List::UtilsBy qw(bundle_by); +use List::Util qw(sum); use SL::Common; -use SL::MIME; +use SL::DB::EmailJournal; +use SL::DB::EmailJournalAttachment; +use SL::DB::Employee; +use SL::Locale::String qw(t8); use SL::Template; +use SL::Version; use strict; my $num_sent = 0; +my %mail_delivery_modules = ( + sendmail => 'SL::Mailer::Sendmail', + smtp => 'SL::Mailer::SMTP', +); + +my %type_to_table = ( + sales_quotation => 'oe', + request_quotation => 'oe', + sales_order => 'oe', + purchase_order => 'oe', + invoice => 'ar', + credit_note => 'ar', + purchase_invoice => 'ap', + letter => 'letter', + purchase_delivery_order => 'delivery_orders', + sales_delivery_order => 'delivery_orders', + dunning => 'dunning', +); + sub new { my ($type, %params) = @_; my $self = { %params }; @@ -50,7 +78,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); @@ -77,22 +105,42 @@ sub _create_message_id { $domain =~ s/.*\@//; $domain =~ s/>.*//; - return "kivitendo-$self->{version}-" . time() . "-${$}-${num_sent}\@$domain"; + return "kivitendo-" . SL::Version->get_version . "-" . time() . "-${$}-${num_sent}\@$domain"; } 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; + my @addresses = Email::Address->parse($self->{$item}); + + # if either no address was parsed or + # there are more than 3 characters per parsed email extra, assume the the user has entered bunk + if (!@addresses) { + die t8('"#1" seems to be a faulty list of email addresses. No addresses could be extracted.', + $self->{$item}, + ); + } elsif ((length($self->{$item}) - sum map { length $_->original } @addresses) / @addresses > 3) { + die t8('"#1" seems to be a faulty list of email addresses. After extracing addresses (#2) too many characters are left.', + $self->{$item}, join ', ', map { $_->original } @addresses, + ); + } - foreach my $addr_obj (Email::Address->parse($self->{$item})) { + foreach my $addr_obj (@addresses) { push @{ $self->{addresses}->{$item} }, $addr_obj->address; + next if $self->{driver}->keep_from_header($item); + my $phrase = $addr_obj->phrase(); if ($phrase) { $phrase =~ s/^\"//; @@ -110,38 +158,64 @@ sub _create_address_headers { sub _create_attachment_part { my ($self, $attachment) = @_; - my $source_file_name; - my %attributes = ( disposition => 'attachment', encoding => 'base64', ); + my $attachment_content; + my $file_id = 0; + my $email_journal = $::instance_conf->get_email_journal; + if (ref($attachment) eq "HASH") { - $attributes{filename} = $attachment->{name}; - $source_file_name = $attachment->{filename}; + $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; } else { - # strip path $attributes{filename} = $attachment; $attributes{filename} =~ s:.*\Q$self->{fileid}\E:: if $self->{fileid}; $attributes{filename} =~ s:.*/::g; - $source_file_name = $attachment; + + 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 $attachment_content = eval { read_file($source_file_name) }; - return undef if !defined $attachment_content; + return undef if $email_journal > 1 && !defined $attachment_content; - 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}; + $attachment_content ||= ' '; + $attributes{charset} = $self->{charset} if $self->{charset} && ($attributes{content_type} =~ m{^text/}); - return Email::MIME->create( - attributes => \%attributes, - body => $attachment_content, + my $ent; + if ( $attributes{content_type} eq 'message/rfc822' ) { + $ent = Email::MIME->new($attachment_content); + } else { + $ent = Email::MIME->create( + attributes => \%attributes, + body => $attachment_content, + ); + } + + # Due to a bug in Email::MIME it's not enough to hand over the encoded file name in the "attributes" hash in the + # "create" call. Email::MIME iterates over the keys in the hash, and depending on which key it has already seen during + # the iteration it might revert the encoding. As Perl's hash key order is randomized for each Perl run, this means + # that the file name stays unencoded sometimes. + # Setting the header manually after the "create" call circumvents this problem. + $ent->header_set('Content-disposition' => 'attachment; filename="' . encode('MIME-Q', $attributes{filename}) . '"'); + + 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, ); + + return $ent; } sub _create_message { @@ -152,7 +226,7 @@ sub _create_message { if ($self->{message}) { push @parts, Email::MIME->create( attributes => { - content_type => $self->{contenttype}, + content_type => $self->{content_type}, charset => $self->{charset}, encoding => 'quoted-printable', }, @@ -160,15 +234,15 @@ sub _create_message { ); push @{ $self->{headers} }, ( - 'Content-Type' => qq|$self->{contenttype}; charset="$self->{charset}"|, + 'Content-Type' => qq|$self->{content_type}; charset="$self->{charset}"|, ); } push @parts, grep { $_ } map { $self->_create_attachment_part($_) } @{ $self->{attachments} || [] }; return Email::MIME->create( - header_str => $self->{headers}, - parts => \@parts, + header_str => $self->{headers}, + parts => \@parts, ); } @@ -178,33 +252,205 @@ sub send { # Create driver for delivery method (sendmail/SMTP) $self->{driver} = eval { $self->_create_driver }; if (!$self->{driver}) { - $::lxdebug->leave_sub(); - return "send email : $@"; + 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"); + + return $error; } # Set defaults & headers - $self->{charset} ||= Common::DEFAULT_CHARSET; - $self->{contenttype} ||= "text/plain"; - $self->{headers} = [ - Subject => $self->{subject}, - 'Message-ID' => $self->_create_message_id, - 'X-Mailer' => "kivitendo $self->{version}", - ]; + $self->{charset} = 'UTF-8'; + $self->{content_type} ||= "text/plain"; + $self->{headers} ||= []; + push @{ $self->{headers} }, ( + Subject => $self->{subject}, + 'Message-ID' => '<' . $self->_create_message_id . '>', + 'X-Mailer' => "kivitendo " . SL::Version->get_version, + ); + $self->{mail_attachments} = []; - # Clean up To/Cc/Bcc address fields - $self->_cleanup_addresses; - $self->_create_address_headers; + my $error; + my $ok = eval { + # Clean up To/Cc/Bcc address fields + $self->_cleanup_addresses; + $self->_create_address_headers; - my $email = $self->_create_message; + my $email = $self->_create_message; - # $::lxdebug->message(0, "message: " . $email->as_string); - # return "boom"; + my $from_obj = (Email::Address->parse($self->{from}))[0]; - $self->{driver}->start_mail(from => $self->{from}, to => [ map { @{ $self->{addresses}->{$_} } } qw(to cc bcc) ]); - $self->{driver}->print($email->as_string); - $self->{driver}->send; + $self->{driver}->start_mail(from => $from_obj->address, to => [ $self->_all_recipients ]); + $self->{driver}->print($email->as_string); + $self->{driver}->send; - return ''; + 1; + }; + + $error = $@ if !$ok; + + # create journal and link to record + $self->{journalentry} = $self->_store_in_journal; + $self->_create_record_link if $self->{journalentry}; + + return $ok ? '' : ($error || "undefined error"); +} + +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; +} + + +sub _create_record_link { + my ($self) = @_; + + # check for custom/overloaded types and ids (form != controller) + my $record_type = $self->{record_type} || $::form->{type}; + my $record_id = $self->{record_id} || $::form->{id}; + + # you may send mails for unsaved objects (no record_id => unlinkable case) + if ($self->{journalentry} && $record_id && exists($type_to_table{$record_type})) { + RecordLinks->create_links( + mode => 'ids', + from_table => $type_to_table{$record_type}, + from_ids => $record_id, + to_table => 'email_journal', + to_id => $self->{journalentry}, + ); + } } 1; + + +__END__ + +=pod + +=encoding utf8 + +=head1 NAME + +SL::Mailer - Base class for sending mails from kivitendo + +=head1 SYNOPSIS + + package SL::BackgroundJob::CreatePeriodicInvoices; + + use SL::Mailer; + + my $mail = Mailer->new; + $mail->{from} = $config{periodic_invoices}->{email_from}; + $mail->{to} = $email; + $mail->{subject} = $config{periodic_invoices}->{email_subject}; + $mail->{content_type} = $filename =~ m/.html$/ ? 'text/html' : 'text/plain'; + $mail->{message} = $output; + + $mail->send; + +=head1 OVERVIEW + +Mail can be sent from kivitendo via the sendmail command or the smtp protocol. + + +=head1 INTERNAL DATA TYPES + + +=over 2 + +=item C<%mail_delivery_modules> + + Currently two modules are supported: smtp or sendmail. + +=item C<%type_to_table> + + Due to the lack of a single global mapping for $form->{type}, + type is mapped to the corresponding database table. All types which + implement a mail action are currently mapped and should be mapped. + Type is either the value of the old form or the newer controller + based object type. + +=back + +=head1 FUNCTIONS + +=over 4 + +=item C + +=item C<_create_driver> + +=item C<_cleanup_addresses> + +=item C<_create_address_headers> + +=item C<_create_message_id> + +=item C<_create_attachment_part> + +=item C<_create_message> + +=item C + + If a mail was sent successfully the internal function _store_in_journal + is called if email journaling is enabled. If _store_in_journal was executed + successfully and the calling form is already persistent (database id) a + record_link will be created. + +=item C<_all_recipients> + +=item C<_store_in_journal> + +=item C<_create_record_link $self->{journalentry}, $::form->{id}, $self->{record_id}> + + + If $self->{journalentry} and either $self->{record_id} or $::form->{id} (checked in + this order) exist a record link from record to email journal is created. + It is possible to provide an array reference with more than one id in + $self->{record_id} or $::form->{id}. In this case all records are linked to + the mail. + Will fail silently if record_link creation wasn't successful (same behaviour as + _store_in_journal). + +=item C + +=back + +=head1 BUGS + +Nothing here yet. + +=head1 AUTHOR + +=cut