returns informations about letters.
if needed, $module filters for letters given module
+ DEPRECATED - You must use Koha::Notice::Templates instead
+ The group by clause is confusing and can lead to issues
+
=cut
sub GetLetters {
my $dbh = C4::Context->dbh;
my $letters = $dbh->selectall_arrayref(
q|
- SELECT module, code, branchcode, name
+ SELECT code, module, name
FROM letter
WHERE 1
|
. ( $module ? q| AND module = ?| : q|| )
. ( $code ? q| AND code = ?| : q|| )
. ( defined $branchcode ? q| AND branchcode = ?| : q|| )
- . q| GROUP BY code ORDER BY name|, { Slice => {} }
+ . q| GROUP BY code, module, name ORDER BY name|, { Slice => {} }
, ( $module ? $module : () )
, ( $code ? $code : () )
, ( defined $branchcode ? $branchcode : () )
: 'text/plain; charset="utf-8"',
}
);
- unless( sendmail(%mail) ) {
+ unless( Mail::Sendmail::sendmail(%mail) ) {
carp $Mail::Sendmail::error;
return { error => $Mail::Sendmail::error };
}
if C4::Context->preference("ClaimsBccCopy");
}
- unless ( sendmail(%mail) ) {
+ unless ( Mail::Sendmail::sendmail(%mail) ) {
carp $Mail::Sendmail::error;
return { error => $Mail::Sendmail::error };
}
: 'text/plain; charset="utf-8"',
}
);
- unless( sendmail(%mail) ) {
+ unless( Mail::Sendmail::sendmail(%mail) ) {
carp $Mail::Sendmail::error;
return { error => $Mail::Sendmail::error };
}
=head2 SendQueuedMessages ([$hashref])
- my $sent = SendQueuedMessages( { verbose => 1 } );
+ my $sent = SendQueuedMessages({
+ letter_code => $letter_code,
+ borrowernumber => $who_letter_is_for,
+ limit => 50,
+ verbose => 1,
+ type => 'sms',
+ });
+
+Sends all of the 'pending' items in the message queue, unless
+parameters are passed.
-sends all of the 'pending' items in the message queue.
+The letter_code, borrowernumber and limit parameters are used
+to build a parameter set for _get_unsent_messages, thus limiting
+which pending messages will be processed. They are all optional.
-returns number of messages sent.
+The verbose parameter can be used to generate debugging output.
+It is also optional.
+
+Returns number of messages sent.
=cut
sub SendQueuedMessages {
my $params = shift;
- my $unsent_messages = _get_unsent_messages();
+ my $which_unsent_messages = {
+ 'limit' => $params->{'limit'} // 0,
+ 'borrowernumber' => $params->{'borrowernumber'} // q{},
+ 'letter_code' => $params->{'letter_code'} // q{},
+ 'type' => $params->{'type'} // q{},
+ };
+ my $unsent_messages = _get_unsent_messages( $which_unsent_messages );
MESSAGE: foreach my $message ( @$unsent_messages ) {
# warn Data::Dumper->Dump( [ $message ], [ 'message' ] );
warn sprintf( 'sending %s message to patron: %s',
_set_message_status( { message_id => $message->{'message_id'}, status => 'failed' } );
next MESSAGE;
}
- $message->{to_address} ||= $patron->smsalertnumber;
- unless ( $message->{to_address} && $patron->smsalertnumber ) {
+ 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;
next MESSAGE;
}
+ $message->{to_address} = $patron->smsalertnumber; #Sometime this is set to email - sms should always use smsalertnumber
$message->{to_address} .= '@' . $sms_provider->domain();
_update_message_to_address($message->{'message_id'},$message->{to_address});
_send_message_by_email( $message, $params->{'username'}, $params->{'password'}, $params->{'method'} );
=head2 _add_attachements
-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.
+ 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.
+ returns your letter object, with the content updated.
=cut
}
+=head2 _get_unsent_messages
+
+ This function's parameter hash reference takes the following
+ optional named parameters:
+ message_transport_type: method of message sending (e.g. email, sms, etc.)
+ borrowernumber : who the message is to be sent
+ letter_code : type of message being sent (e.g. PASSWORD_RESET)
+ limit : maximum number of messages to send
+
+ This function returns an array of matching hash referenced rows from
+ message_queue with some borrower information added.
+
+=cut
+
sub _get_unsent_messages {
my $params = shift;
my $dbh = C4::Context->dbh();
- my $statement = << 'ENDSQL';
-SELECT mq.message_id, mq.borrowernumber, mq.subject, mq.content, mq.message_transport_type, mq.status, mq.time_queued, mq.from_address, mq.to_address, mq.content_type, b.branchcode, mq.letter_code
- FROM message_queue mq
- LEFT JOIN borrowers b ON b.borrowernumber = mq.borrowernumber
- WHERE status = ?
-ENDSQL
+ 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.to_address, mq.content_type, b.branchcode, mq.letter_code
+ FROM message_queue mq
+ LEFT JOIN borrowers b ON b.borrowernumber = mq.borrowernumber
+ WHERE status = ?
+ };
my @query_params = ('pending');
if ( ref $params ) {
if ( $params->{'message_transport_type'} ) {
- $statement .= ' AND message_transport_type = ? ';
+ $statement .= ' AND mq.message_transport_type = ? ';
push @query_params, $params->{'message_transport_type'};
}
if ( $params->{'borrowernumber'} ) {
- $statement .= ' AND borrowernumber = ? ';
+ $statement .= ' AND mq.borrowernumber = ? ';
push @query_params, $params->{'borrowernumber'};
}
+ if ( $params->{'letter_code'} ) {
+ $statement .= ' AND mq.letter_code = ? ';
+ push @query_params, $params->{'letter_code'};
+ }
+ if ( $params->{'type'} ) {
+ $statement .= ' AND message_transport_type = ? ';
+ push @query_params, $params->{'type'};
+ }
if ( $params->{'limit'} ) {
$statement .= ' limit ? ';
push @query_params, $params->{'limit'};
status => 'failed' } );
return;
}
- $to_address = C4::Members::GetNoticeEmailAddress( $message->{'borrowernumber'} );
+ $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?
_update_message_to_address($message->{'message_id'},$to_address) unless $message->{to_address}; #if initial message address was empty, coming here means that a to address was found and queue should be updated
- if ( sendmail( %sendmail_params ) ) {
+ if ( Mail::Sendmail::sendmail( %sendmail_params ) ) {
_set_message_status( { message_id => $message->{'message_id'},
status => 'sent' } );
return 1;
my $tt_params = { %{ _get_tt_params( $tables ) }, %{ _get_tt_params( $loops, 'is_a_loop' ) }, %$substitute };
- $content = qq|[% USE KohaDates %]$content|;
+ $content = add_tt_filters( $content );
+ $content = qq|[% USE KohaDates %][% USE Remove_MARC_punctuation %]$content|;
my $output;
$template->process( \$content, $tt_params, \$output ) || croak "ERROR PROCESSING TEMPLATE: " . $template->error();
plural => 'biblios',
pk => 'biblionumber',
},
+ biblioitems => {
+ module => 'Koha::Biblioitems',
+ singular => 'biblioitem',
+ plural => 'biblioitems',
+ pk => 'biblioitemnumber',
+ },
borrowers => {
module => 'Koha::Patrons',
singular => 'borrower',
return $params;
}
+=head3 add_tt_filters
+
+$content = add_tt_filters( $content );
+
+Add TT filters to some specific fields if needed.
+
+For now we only add the Remove_MARC_punctuation TT filter to biblio and biblioitem fields
+
+=cut
+
+sub add_tt_filters {
+ my ( $content ) = @_;
+ $content =~ s|\[%\s*biblio\.(.*?)\s*%\]|[% biblio.$1 \| \$Remove_MARC_punctuation %]|gxms;
+ $content =~ s|\[%\s*biblioitem\.(.*?)\s*%\]|[% biblioitem.$1 \| \$Remove_MARC_punctuation %]|gxms;
+ return $content;
+}
+
=head2 get_item_content
my $item = Koha::Items->find(...)->unblessed;