use Modern::Perl;
-use MIME::Lite;
-use Date::Calc qw( Add_Delta_Days );
-use Encode;
-use Carp;
+use Carp qw( carp croak );
use Template;
-use Module::Load::Conditional qw(can_load);
+use Module::Load::Conditional qw( can_load );
-use Try::Tiny;
+use Try::Tiny qw( catch try );
use C4::Members;
-use C4::Log;
+use C4::Log qw( logaction );
use C4::SMS;
use C4::Templates;
-use C4::Debug;
-use Koha::DateUtils;
+use Koha::DateUtils qw( dt_from_string output_pref );
use Koha::SMS::Providers;
use Koha::Email;
use Koha::Notice::Messages;
use Koha::Notice::Templates;
-use Koha::DateUtils qw( format_sqldatetime dt_from_string );
+use Koha::DateUtils qw( dt_from_string output_pref );
use Koha::Patrons;
use Koha::SMTP::Servers;
use Koha::Subscriptions;
-use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use constant SERIALIZED_EMAIL_CONTENT_TYPE => 'message/rfc822';
+our (@ISA, @EXPORT_OK);
BEGIN {
require Exporter;
@ISA = qw(Exporter);
- @EXPORT = qw(
- &EnqueueLetter &GetLetters &GetLettersAvailableForALibrary &GetLetterTemplates &DelLetter &GetPreparedLetter &GetWrappedLetter &SendAlerts &GetPrintMessages &GetMessageTransportTypes
+ @EXPORT_OK = qw(
+ GetLetters
+ GetLettersAvailableForALibrary
+ GetLetterTemplates
+ DelLetter
+ GetPreparedLetter
+ GetWrappedLetter
+ SendAlerts
+ GetPrintMessages
+ GetQueuedMessages
+ GetMessage
+ GetMessageTransportTypes
+
+ EnqueueLetter
+ SendQueuedMessages
+ ResendMessage
);
}
. $letter->{content}
) if C4::Context->preference("ClaimsLog");
}
- # send an "account details" notice to a newly created user
- elsif ( $type eq 'members' ) {
- my $library = Koha::Libraries->find( $externalid->{branchcode} );
- my $letter = GetPreparedLetter (
- module => 'members',
- letter_code => $letter_code,
- branchcode => $externalid->{'branchcode'},
- lang => $externalid->{lang} || 'default',
- tables => {
- 'branches' => $library->unblessed,
- 'borrowers' => $externalid->{'borrowernumber'},
- },
- substitute => { 'borrowers.password' => $externalid->{'password'} },
- want_librarian => 1,
- ) or return;
- return { error => "no_email" } unless $externalid->{'emailaddr'};
-
- my $success = try {
-
- # FIXME: This 'default' behaviour should be moved to Koha::Email
- my $mail = Koha::Email->create(
- {
- to => $externalid->{'emailaddr'},
- from => $library->branchemail,
- reply_to => $library->branchreplyto,
- sender => $library->branchreturnpath,
- subject => "" . $letter->{'title'},
- }
- );
-
- if ( $letter->{is_html} ) {
- $mail->html_body( _wrap_html( $letter->{content}, "" . $letter->{title} ) );
- }
- else {
- $mail->text_body( $letter->{content} );
- }
-
- $mail->send_or_die({ transport => $library->smtp_server->transport });
- }
- catch {
- # We expect ref($_) eq 'Email::Sender::Failure'
- $error = $_->message;
-
- carp "$_";
- return;
- };
-
- return { error => $error }
- unless $success;
- }
# If we come here, return an OK status
return 1;
if (%$substitute) {
while ( my ($token, $val) = each %$substitute ) {
+ $val //= q{};
if ( $token eq 'items.content' ) {
$val =~ s|\n|<br/>|g if $letter->{is_html};
}
($table eq 'debits' ) ? "SELECT * FROM accountlines WHERE accountlines_id = ?" :
($table eq 'items' ) ? "SELECT * FROM $table WHERE itemnumber = ?" :
($table eq 'issues' ) ? "SELECT * FROM $table WHERE itemnumber = ?" :
- ($table eq 'old_issues' ) ? "SELECT * FROM $table WHERE itemnumber = ? ORDER BY timestamp DESC LIMIT 1" :
+ ($table eq 'old_issues' ) ? "SELECT * FROM $table WHERE issue_id = ?" :
($table eq 'reserves' ) ? "SELECT * FROM $table WHERE borrowernumber = ? and biblionumber = ?" :
($table eq 'borrowers' ) ? "SELECT * FROM $table WHERE borrowernumber = ?" :
($table eq 'branches' ) ? "SELECT * FROM $table WHERE branchcode = ?" :
($table eq 'aqorders' ) ? "SELECT * FROM $table WHERE ordernumber = ?" :
($table eq 'aqbasket' ) ? "SELECT * FROM $table WHERE basketno = ?" :
($table eq 'illrequests' ) ? "SELECT * FROM $table WHERE illrequest_id = ?" :
- ($table eq 'opac_news' ) ? "SELECT * FROM $table WHERE idnew = ?" :
($table eq 'article_requests') ? "SELECT * FROM $table WHERE id = ?" :
($table eq 'borrower_modifications') ? "SELECT * FROM $table WHERE verification_token = ?" :
($table eq 'subscription') ? "SELECT * FROM $table WHERE subscriptionid = ?" :
($table eq 'serial') ? "SELECT * FROM $table WHERE serialid = ?" :
($table eq 'problem_reports') ? "SELECT * FROM $table WHERE reportid = ?" :
+ ($table eq 'additional_contents' || $table eq 'opac_news') ? "SELECT * FROM additional_contents WHERE idnew = ?" :
+ ($table eq 'recalls') ? "SELECT * FROM $table WHERE recall_id = ?" :
undef ;
unless ($query) {
warn "ERROR: No _parseletter_sth query for table '$table'";
$dateonly = $1 unless $dateonly;
}
my $replacedby_date = eval {
- output_pref({ dt => dt_from_string( $replacedby ), dateonly => $dateonly });
+ output_pref({ dt => scalar dt_from_string( $replacedby ), dateonly => $dateonly });
};
+ $replacedby_date //= q{};
if ( $letter->{ $letter_field } ) {
$letter->{ $letter_field } =~ s/\Q<<$table.$field$filter_string_used>>\E/$replacedby_date/g;
my $success = EnqueueLetter( { letter => $letter,
borrowernumber => '12', message_transport_type => 'email' } )
-places a letter in the message_queue database table, which will
+Places a letter in the message_queue database table, which will
eventually get processed (sent) by the process_message_queue.pl
cronjob when it calls SendQueuedMessages.
-return message_id on success
+Return message_id on success
+
+Parameters
+* letter - required; A letter hashref as returned from GetPreparedLetter
+* message_transport_type - required; One of the available mtts
+* borrowernumber - optional if 'to_address' is passed; The borrowernumber of the patron we enqueuing the notice for
+* to_address - optional if 'borrowernumber' is passed; The destination email address for the notice (defaults to patron->notice_email_address)
+* from_address - optional; The from address for the notice, defaults to patron->library->from_email_address
+* reply_address - optional; The reply address for the notice, defaults to patron->library->reply_to
=cut
my $content = $params->{letter}->{content};
$content =~ s/\s+//g if(defined $content);
if ( not defined $content or $content eq '' ) {
- warn "Trying to add an empty message to the message queue" if $debug;
+ Koha::Logger->get->info("Trying to add an empty message to the message queue");
return;
}
$params->{'letter'} = _add_attachments(
{ letter => $params->{'letter'},
attachments => $params->{'attachments'},
- message => MIME::Lite->new( Type => 'multipart/mixed' ),
}
);
}
my $dbh = C4::Context->dbh();
my $statement = << 'ENDSQL';
INSERT INTO message_queue
-( borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, reply_address, content_type, delivery_note )
+( borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, reply_address, content_type, failure_code )
VALUES
( ?, ?, ?, ?, ?, ?, ?, CAST(NOW() AS DATETIME), ?, ?, ?, ?, ? )
ENDSQL
$params->{'from_address'}, # from_address
$params->{'reply_address'}, # reply_address
$params->{'letter'}->{'content-type'}, # content_type
- $params->{'delivery_note'} || '', # delivery_note
+ $params->{'failure_code'} || '', # failure_code
);
return $dbh->last_insert_id(undef,undef,'message_queue', undef);
}
warn sprintf( 'sending %s message to patron: %s',
$message->{'message_transport_type'},
$message->{'borrowernumber'} || 'Admin' )
- if $params->{'verbose'} or $debug;
+ if $params->{'verbose'};
# This is just begging for subclassing
next MESSAGE if ( lc($message->{'message_transport_type'}) eq 'rss' );
if ( lc( $message->{'message_transport_type'} ) eq 'email' ) {
my $patron = Koha::Patrons->find( $message->{borrowernumber} );
my $sms_provider = Koha::SMS::Providers->find( $patron->sms_provider_id );
unless ( $sms_provider ) {
- warn sprintf( "Patron %s has no sms provider id set!", $message->{'borrowernumber'} ) if $params->{'verbose'} or $debug;
+ warn sprintf( "Patron %s has no sms provider id set!", $message->{'borrowernumber'} ) if $params->{'verbose'};
_set_message_status( { message_id => $message->{'message_id'}, status => 'failed' } );
next MESSAGE;
}
unless ( $patron->smsalertnumber ) {
_set_message_status( { message_id => $message->{'message_id'}, status => 'failed' } );
- warn sprintf( "No smsalertnumber found for patron %s!", $message->{'borrowernumber'} ) if $params->{'verbose'} or $debug;
+ warn sprintf( "No smsalertnumber found for patron %s!", $message->{'borrowernumber'} ) if $params->{'verbose'};
next MESSAGE;
}
$message->{to_address} = $patron->smsalertnumber; #Sometime this is set to email - sms should always use smsalertnumber
my $dbh = C4::Context->dbh();
my $statement = << 'ENDSQL';
-SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued, updated_on, delivery_note
+SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued, updated_on, failure_code
FROM message_queue
ENDSQL
return unless $message_id;
my $dbh = C4::Context->dbh;
return $dbh->selectrow_hashref(q|
- SELECT message_id, borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, updated_on, to_address, from_address, reply_address, content_type, delivery_note
+ SELECT message_id, borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, updated_on, to_address, from_address, reply_address, content_type, failure_code
FROM message_queue
WHERE message_id = ?
|, {}, $message_id );
=head2 _add_attachements
+ _add_attachments({ letter => $letter, attachments => $attachments });
+
named parameters:
letter - the standard letter hashref
attachments - listref of attachments. each attachment is a hashref of:
type - the mime type, like 'text/plain'
content - the actual attachment
filename - the name of the attachment.
- message - a MIME::Lite object to attach these to.
returns your letter object, with the content updated.
+ This routine picks the I<content> of I<letter> and generates a MIME
+ email, attaching the passed I<attachments> using Koha::Email. The
+ content is replaced by the string representation of the MIME object,
+ and the content-type is updated for later handling.
=cut
sub _add_attachments {
my $params = shift;
- my $letter = $params->{'letter'};
- my $attachments = $params->{'attachments'};
+ my $letter = $params->{letter};
+ my $attachments = $params->{attachments};
return $letter unless @$attachments;
- my $message = $params->{'message'};
-
- # First, we have to put the body in as the first attachment
- $message->attach(
- Type => $letter->{'content-type'} || 'TEXT',
- Data => $letter->{'is_html'}
- ? _wrap_html($letter->{'content'}, $letter->{'title'})
- : $letter->{'content'},
- );
+
+ my $message = Koha::Email->new;
+
+ if ( $letter->{is_html} ) {
+ $message->html_body( _wrap_html( $letter->{content}, $letter->{title} ) );
+ }
+ else {
+ $message->text_body( $letter->{content} );
+ }
foreach my $attachment ( @$attachments ) {
$message->attach(
- Type => $attachment->{'type'},
- Data => $attachment->{'content'},
- Filename => $attachment->{'filename'},
+ Encode::encode( "UTF-8", $attachment->{content} ),
+ content_type => $attachment->{type} || 'application/octet-stream',
+ name => $attachment->{filename},
+ disposition => 'attachment',
);
}
- # we're forcing list context here to get the header, not the count back from grep.
- ( $letter->{'content-type'} ) = grep( /^Content-Type:/, split( /\n/, $params->{'message'}->header_as_string ) );
- $letter->{'content-type'} =~ s/^Content-Type:\s+//;
- $letter->{'content'} = $message->body_as_string;
+
+ $letter->{'content-type'} = SERIALIZED_EMAIL_CONTENT_TYPE;
+ $letter->{content} = $message->as_string;
return $letter;
my $dbh = C4::Context->dbh();
my $statement = qq{
- SELECT mq.message_id, mq.borrowernumber, mq.subject, mq.content, mq.message_transport_type, mq.status, mq.time_queued, mq.from_address, mq.reply_address, mq.to_address, mq.content_type, b.branchcode, mq.letter_code, mq.delivery_note
+ SELECT mq.message_id, mq.borrowernumber, mq.subject, mq.content, mq.message_transport_type, mq.status, mq.time_queued, mq.from_address, mq.reply_address, mq.to_address, mq.content_type, b.branchcode, mq.letter_code, mq.failure_code
FROM message_queue mq
LEFT JOIN borrowers b ON b.borrowernumber = mq.borrowernumber
WHERE status = ?
}
}
- $debug and warn "_get_unsent_messages SQL: $statement";
- $debug and warn "_get_unsent_messages params: " . join(',',@query_params);
my $sth = $dbh->prepare( $statement );
my $result = $sth->execute( @query_params );
return $sth->fetchall_arrayref({});
unless ($to_address) {
unless ($patron) {
warn "FAIL: No 'to_address' and INVALID borrowernumber ($message->{borrowernumber})";
- _set_message_status( { message_id => $message->{'message_id'},
- status => 'failed',
- delivery_note => 'Invalid borrowernumber '.$message->{borrowernumber},
- error_code => 'INVALID_BORNUMBER' } );
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed',
+ failure_code => 'INVALID_BORNUMBER'
+ }
+ );
return;
}
$to_address = $patron->notice_email_address;
unless ($to_address) {
# warn "FAIL: No 'to_address' and no email for " . ($member->{surname} ||'') . ", borrowernumber ($message->{borrowernumber})";
# warning too verbose for this more common case?
- _set_message_status( { message_id => $message->{'message_id'},
- status => 'failed',
- delivery_note => 'Unable to find an email address for this borrower',
- error_code => 'NO_EMAIL' } );
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed',
+ failure_code => 'NO_EMAIL'
+ }
+ );
return;
}
}
if ($patron) {
$library = $patron->library;
- $branch_email = $library->branchemail;
+ $branch_email = $library->from_email_address;
$branch_replyto = $library->branchreplyto;
$branch_returnpath = $library->branchreturnpath;
}
- my $email = Koha::Email->create(
- {
+ # NOTE: Patron may not be defined above so branch_email may be undefined still
+ # so we need to fallback to KohaAdminEmailAddress as a last resort.
+ my $from_address =
+ $message->{'from_address'}
+ || $branch_email
+ || C4::Context->preference('KohaAdminEmailAddress');
+ if( !$from_address ) {
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed',
+ failure_code => 'NO_FROM',
+ }
+ );
+ return;
+ };
+ my $email;
+
+ try {
+
+ my $params = {
to => $to_address,
(
C4::Context->preference('NoticeBcc')
? ( bcc => C4::Context->preference('NoticeBcc') )
: ()
),
- from => $message->{'from_address'} || $branch_email,
+ from => $from_address,
reply_to => $message->{'reply_address'} || $branch_replyto,
sender => $branch_returnpath,
subject => "" . $message->{subject}
- }
- );
+ };
- if ( $is_html ) {
- $email->html_body(
- _wrap_html( $content, $subject )
- );
- }
- else {
- $email->text_body( $content );
+ if ( $message->{'content_type'} && $message->{'content_type'} eq SERIALIZED_EMAIL_CONTENT_TYPE ) {
+
+ # The message has been previously composed as a valid MIME object
+ # and serialized as a string on the DB
+ $email = Koha::Email->new_from_string($content);
+ $email->create($params);
+ } else {
+ $email = Koha::Email->create($params);
+ if ($is_html) {
+ $email->html_body( _wrap_html( $content, $subject ) );
+ } else {
+ $email->text_body($content);
+ }
+ }
}
+ catch {
+ if ( ref($_) eq 'Koha::Exceptions::BadParameter' ) {
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed',
+ failure_code => "INVALID_EMAIL:".$_->parameter
+ }
+ );
+ } else {
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed',
+ failure_code => 'UNKNOWN_ERROR'
+ }
+ );
+ }
+ return 0;
+ };
+ return unless $email;
my $smtp_server;
if ( $library ) {
{
message_id => $message->{'message_id'},
status => 'sent',
- delivery_note => ''
+ failure_code => ''
}
);
return 1;
{
message_id => $message->{'message_id'},
status => 'failed',
- delivery_note => $Mail::Sendmail::error
+ failure_code => 'SENDMAIL'
}
);
carp "$_";
+ carp "$Mail::Sendmail::error";
return;
};
}
unless ( $patron and $patron->smsalertnumber ) {
_set_message_status( { message_id => $message->{'message_id'},
status => 'failed',
- delivery_note => 'Missing SMS number',
- error_code => 'MISSING_SMS' } );
+ failure_code => 'MISSING_SMS' } );
return;
}
if ( _is_duplicate( $message ) ) {
- _set_message_status( { message_id => $message->{'message_id'},
- status => 'failed',
- delivery_note => 'Message is duplicate',
- error_code => 'DUPLICATE_MESSAGE' } );
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed',
+ failure_code => 'DUPLICATE_MESSAGE'
+ }
+ );
return;
}
- my $success = C4::SMS->send_sms( { destination => $patron->smsalertnumber,
- message => $message->{'content'},
- } );
- _set_message_status( { message_id => $message->{'message_id'},
- status => ($success ? 'sent' : 'failed'),
- delivery_note => ($success ? '' : 'No notes from SMS driver'),
- error_code => 'NO_NOTES' } );
+ my $success = C4::SMS->send_sms(
+ {
+ destination => $patron->smsalertnumber,
+ message => $message->{'content'},
+ }
+ );
+
+ if ($success) {
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'sent',
+ failure_code => ''
+ }
+ );
+ }
+ else {
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed',
+ failure_code => 'NO_NOTES'
+ }
+ );
+ }
return $success;
}
}
my $dbh = C4::Context->dbh();
- my $statement = 'UPDATE message_queue SET status= ?, delivery_note= ? WHERE message_id = ?';
+ my $statement = 'UPDATE message_queue SET status= ?, failure_code= ? WHERE message_id = ?';
my $sth = $dbh->prepare( $statement );
my $result = $sth->execute( $params->{'status'},
- $params->{'delivery_note'} || '',
+ $params->{'failure_code'} || '',
$params->{'message_id'} );
return $result;
}
plural => 'items',
pk => 'itemnumber',
},
+ additional_contents => {
+ module => 'Koha::AdditionalContents',
+ singular => 'additional_content',
+ plural => 'additional_contents',
+ pk => 'idnew',
+ },
opac_news => {
- module => 'Koha::News',
+ module => 'Koha::AdditionalContents',
singular => 'news',
plural => 'news',
pk => 'idnew',
module => 'Koha::Old::Checkouts',
singular => 'old_checkout',
plural => 'old_checkouts',
- fk => 'itemnumber',
+ pk => 'issue_id',
},
overdues => {
module => 'Koha::Checkouts',