use Modern::Perl;
use MIME::Lite;
-use Mail::Sendmail;
use Date::Calc qw( Add_Delta_Days );
use Encode;
use Carp;
use Template;
use Module::Load::Conditional qw(can_load);
+use Try::Tiny;
+
use C4::Members;
-use C4::Members::Attributes qw(GetBorrowerAttributes);
use C4::Log;
use C4::SMS;
+use C4::Templates;
use C4::Debug;
use Koha::DateUtils;
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::Patrons;
+use Koha::SMTP::Servers;
+use Koha::Subscriptions;
use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
require Exporter;
@ISA = qw(Exporter);
@EXPORT = qw(
- &GetLetters &GetLettersAvailableForALibrary &GetLetterTemplates &DelLetter &GetPreparedLetter &GetWrappedLetter &addalert &getalert &delalert &findrelatedto &SendAlerts &GetPrintMessages &GetMessageTransportTypes
+ &EnqueueLetter &GetLetters &GetLettersAvailableForALibrary &GetLetterTemplates &DelLetter &GetPreparedLetter &GetWrappedLetter &SendAlerts &GetPrintMessages &GetMessageTransportTypes
);
}
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 : () )
my $code = $params->{code};
my $branchcode = $params->{branchcode} // '';
my $dbh = C4::Context->dbh;
- my $letters = $dbh->selectall_arrayref(
- q|
- SELECT module, code, branchcode, name, is_html, title, content, message_transport_type, lang
- FROM letter
- WHERE module = ?
- AND code = ?
- and branchcode = ?
- |
- , { Slice => {} }
- , $module, $code, $branchcode
- );
-
- return $letters;
+ return Koha::Notice::Templates->search(
+ {
+ module => $module,
+ code => $code,
+ branchcode => $branchcode,
+ (
+ C4::Context->preference('TranslateNotices')
+ ? ()
+ : ( lang => 'default' )
+ )
+ }
+ )->unblessed;
}
=head2 GetLettersAvailableForALibrary
, undef, $branchcode, $module, $code, ( $mtt ? $mtt : () ), ( $lang ? $lang : () ) );
}
-=head2 addalert ($borrowernumber, $type, $externalid)
-
- parameters :
- - $borrowernumber : the number of the borrower subscribing to the alert
- - $type : the type of alert.
- - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
-
- create an alert and return the alertid (primary key)
-
-=cut
-
-sub addalert {
- my ( $borrowernumber, $type, $externalid ) = @_;
- my $dbh = C4::Context->dbh;
- my $sth =
- $dbh->prepare(
- "insert into alert (borrowernumber, type, externalid) values (?,?,?)");
- $sth->execute( $borrowernumber, $type, $externalid );
-
- # get the alert number newly created and return it
- my $alertid = $dbh->{'mysql_insertid'};
- return $alertid;
-}
-
-=head2 delalert ($alertid)
-
- parameters :
- - alertid : the alert id
- deletes the alert
-
-=cut
-
-sub delalert {
- my $alertid = shift or die "delalert() called without valid argument (alertid)"; # it's gonna die anyway.
- $debug and warn "delalert: deleting alertid $alertid";
- my $sth = C4::Context->dbh->prepare("delete from alert where alertid=?");
- $sth->execute($alertid);
-}
-
-=head2 getalert ([$borrowernumber], [$type], [$externalid])
-
- parameters :
- - $borrowernumber : the number of the borrower subscribing to the alert
- - $type : the type of alert.
- - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
- all parameters NON mandatory. If a parameter is omitted, the query is done without the corresponding parameter. For example, without $externalid, returns all alerts for a borrower on a topic.
-
-=cut
-
-sub getalert {
- my ( $borrowernumber, $type, $externalid ) = @_;
- my $dbh = C4::Context->dbh;
- my $query = "SELECT a.*, b.branchcode FROM alert a JOIN borrowers b USING(borrowernumber) WHERE 1";
- my @bind;
- if ($borrowernumber and $borrowernumber =~ /^\d+$/) {
- $query .= " AND borrowernumber=?";
- push @bind, $borrowernumber;
- }
- if ($type) {
- $query .= " AND type=?";
- push @bind, $type;
- }
- if ($externalid) {
- $query .= " AND externalid=?";
- push @bind, $externalid;
- }
- my $sth = $dbh->prepare($query);
- $sth->execute(@bind);
- return $sth->fetchall_arrayref({});
-}
-
-=head2 findrelatedto($type, $externalid)
-
- parameters :
- - $type : the type of alert
- - $externalid : the id of the "object" to query
-
- In the table alert, a "id" is stored in the externalid field. This "id" is related to another table, depending on the type of the alert.
- When type=issue, the id is related to a subscriptionid and this sub returns the name of the biblio.
-
-=cut
-
-# outmoded POD:
-# When type=virtual, the id is related to a virtual shelf and this sub returns the name of the sub
-
-sub findrelatedto {
- my $type = shift or return;
- my $externalid = shift or return;
- my $q = ($type eq 'issue' ) ?
-"select title as result from subscription left join biblio on subscription.biblionumber=biblio.biblionumber where subscriptionid=?" :
- ($type eq 'borrower') ?
-"select concat(firstname,' ',surname) from borrowers where borrowernumber=?" : undef;
- unless ($q) {
- warn "findrelatedto(): Illegal type '$type'";
- return;
- }
- my $sth = C4::Context->dbh->prepare($q);
- $sth->execute($externalid);
- my ($result) = $sth->fetchrow;
- return $result;
-}
-
=head2 SendAlerts
my $err = &SendAlerts($type, $externalid, $letter_code);
sub SendAlerts {
my ( $type, $externalid, $letter_code ) = @_;
my $dbh = C4::Context->dbh;
+ my $error;
+
if ( $type eq 'issue' ) {
# prepare the letter...
or warn( "No biblionumber for '$subscriptionid'" ),
return;
- my %letter;
- # find the list of borrowers to alert
- my $alerts = getalert( '', 'issue', $subscriptionid );
- foreach (@$alerts) {
- my $patron = Koha::Patrons->find( $_->{borrowernumber} );
- next unless $patron; # Just in case
+ # find the list of subscribers to notify
+ my $subscription = Koha::Subscriptions->find( $subscriptionid );
+ my $subscribers = $subscription->subscribers;
+ while ( my $patron = $subscribers->next ) {
my $email = $patron->email or next;
# warn "sending issues...";
my $userenv = C4::Context->userenv;
- my $library = Koha::Libraries->find( $_->{branchcode} );
+ my $library = $patron->library;
my $letter = GetPreparedLetter (
module => 'serial',
letter_code => $letter_code,
branchcode => $userenv->{branch},
tables => {
- 'branches' => $_->{branchcode},
+ 'branches' => $library->branchcode,
'biblio' => $biblionumber,
'biblioitems' => $biblionumber,
'borrowers' => $patron->unblessed,
want_librarian => 1,
) or return;
- # ... then send mail
- my $message = Koha::Email->new();
- my %mail = $message->create_message_headers(
+ # FIXME: This 'default' behaviour should be moved to Koha::Email
+ my $mail = Koha::Email->create(
{
- to => $email,
- from => $library->branchemail,
- replyto => $library->branchreplyto,
- sender => $library->branchreturnpath,
- subject => Encode::encode( "UTF-8", "" . $letter->{title} ),
- message => $letter->{'is_html'}
- ? _wrap_html( Encode::encode( "UTF-8", $letter->{'content'} ),
- Encode::encode( "UTF-8", "" . $letter->{'title'} ))
- : Encode::encode( "UTF-8", "" . $letter->{'content'} ),
- contenttype => $letter->{'is_html'}
- ? 'text/html; charset="utf-8"'
- : 'text/plain; charset="utf-8"',
+ to => $email,
+ from => $library->branchemail,
+ reply_to => $library->branchreplyto,
+ sender => $library->branchreturnpath,
+ subject => "" . $letter->{title},
}
);
- unless( sendmail(%mail) ) {
- carp $Mail::Sendmail::error;
- return { error => $Mail::Sendmail::error };
+
+ if ( $letter->{is_html} ) {
+ $mail->html_body( _wrap_html( $letter->{content}, "" . $letter->{title} ) );
+ }
+ else {
+ $mail->text_body( $letter->{content} );
+ }
+
+ my $success = try {
+ $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;
}
}
elsif ( $type eq 'claimacquisition' or $type eq 'claimissues' or $type eq 'orderacquisition' ) {
my $sthorders;
my $dataorders;
my $action;
+ my $basketno;
if ( $type eq 'claimacquisition') {
$strsth = qq{
SELECT aqorders.*,aqbasket.*,biblio.*,biblioitems.*
if ($type eq 'claimissues') {
$strsth = qq{
- SELECT serial.*,subscription.*, biblio.*, aqbooksellers.*,
+ SELECT serial.*,subscription.*, biblio.*, biblioitems.*, aqbooksellers.*,
aqbooksellers.id AS booksellerid
FROM serial
LEFT JOIN subscription ON serial.subscriptionid=subscription.subscriptionid
LEFT JOIN biblio ON serial.biblionumber=biblio.biblionumber
+ LEFT JOIN biblioitems ON serial.biblionumber = biblioitems.biblionumber
LEFT JOIN aqbooksellers ON subscription.aqbooksellerid=aqbooksellers.id
WHERE serial.serialid IN (
};
if (!@$externalid){
- carp "No Order selected";
- return { error => "no_order_selected" };
+ carp "No issues selected";
+ return { error => "no_issues_selected" };
}
$strsth .= join( ",", ('?') x @$externalid ) . ")";
- $action = "CLAIM ISSUE";
+ $action = "SERIAL CLAIM";
$sthorders = $dbh->prepare($strsth);
$sthorders->execute( @$externalid );
$dataorders = $sthorders->fetchall_arrayref( {} );
}
if ( $type eq 'orderacquisition') {
+ my $basketno = $externalid;
$strsth = qq{
SELECT aqorders.*,aqbasket.*,biblio.*,biblioitems.*
FROM aqorders
AND orderstatus IN ('new','ordered')
};
- if (!$externalid){
+ unless ( $basketno ) {
carp "No basketnumber given";
return { error => "no_basketno" };
}
$action = "ACQUISITION ORDER";
$sthorders = $dbh->prepare($strsth);
- $sthorders->execute($externalid);
+ $sthorders->execute($basketno);
$dataorders = $sthorders->fetchall_arrayref( {} );
}
my @email;
my @cc;
- push @email, $databookseller->{bookselleremail} if $databookseller->{bookselleremail};
push @email, $datacontact->{email} if ( $datacontact && $datacontact->{email} );
unless (@email) {
warn "Bookseller $dataorders->[0]->{booksellerid} without emails";
letter_code => $letter_code,
branchcode => $userenv->{branch},
tables => {
- 'branches' => $userenv->{branch},
+ 'branches' => $userenv->{branch},
'aqbooksellers' => $databookseller,
'aqcontacts' => $datacontact,
+ 'aqbasket' => $basketno,
},
repeat => $dataorders,
want_librarian => 1,
# ... then send mail
my $library = Koha::Libraries->find( $userenv->{branch} );
- my %mail = (
- To => join( ',', @email),
- Cc => join( ',', @cc),
- From => $library->branchemail || C4::Context->preference('KohaAdminEmailAddress'),
- Subject => Encode::encode( "UTF-8", "" . $letter->{title} ),
- Message => $letter->{'is_html'}
- ? _wrap_html( Encode::encode( "UTF-8", $letter->{'content'} ),
- Encode::encode( "UTF-8", "" . $letter->{'title'} ))
- : Encode::encode( "UTF-8", "" . $letter->{'content'} ),
- 'Content-Type' => $letter->{'is_html'}
- ? 'text/html; charset="utf-8"'
- : 'text/plain; charset="utf-8"',
+ my $mail = Koha::Email->create(
+ {
+ to => join( ',', @email ),
+ cc => join( ',', @cc ),
+ (
+ (
+ C4::Context->preference("ClaimsBccCopy")
+ && ( $type eq 'claimacquisition'
+ || $type eq 'claimissues' )
+ )
+ ? ( bcc => $userenv->{emailaddress} )
+ : ()
+ ),
+ from => $library->branchemail
+ || C4::Context->preference('KohaAdminEmailAddress'),
+ subject => "" . $letter->{title},
+ }
);
- if ($type eq 'claimacquisition' || $type eq 'claimissues' ) {
- $mail{'Reply-to'} = C4::Context->preference('ReplytoDefault')
- if C4::Context->preference('ReplytoDefault');
- $mail{'Sender'} = C4::Context->preference('ReturnpathDefault')
- if C4::Context->preference('ReturnpathDefault');
- $mail{'Bcc'} = $userenv->{emailaddress}
- if C4::Context->preference("ClaimsBccCopy");
+ if ( $letter->{is_html} ) {
+ $mail->html_body( _wrap_html( $letter->{content}, "" . $letter->{title} ) );
+ }
+ else {
+ $mail->text_body( "" . $letter->{content} );
}
- unless ( sendmail(%mail) ) {
- carp $Mail::Sendmail::error;
- return { error => $Mail::Sendmail::error };
+ my $success = try {
+ $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;
logaction(
"ACQUISITION",
}
# send an "account details" notice to a newly created user
elsif ( $type eq 'members' ) {
- my $library = Koha::Libraries->find( $externalid->{branchcode} )->unblessed;
+ 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,
+ 'branches' => $library->unblessed,
'borrowers' => $externalid->{'borrowernumber'},
},
substitute => { 'borrowers.password' => $externalid->{'password'} },
want_librarian => 1,
) or return;
return { error => "no_email" } unless $externalid->{'emailaddr'};
- my $email = Koha::Email->new();
- my %mail = $email->create_message_headers(
- {
- to => $externalid->{'emailaddr'},
- from => $library->{branchemail},
- replyto => $library->{branchreplyto},
- sender => $library->{branchreturnpath},
- subject => Encode::encode( "UTF-8", "" . $letter->{'title'} ),
- message => $letter->{'is_html'}
- ? _wrap_html( Encode::encode( "UTF-8", $letter->{'content'} ),
- Encode::encode( "UTF-8", "" . $letter->{'title'} ) )
- : Encode::encode( "UTF-8", "" . $letter->{'content'} ),
- contenttype => $letter->{'is_html'}
- ? 'text/html; charset="utf-8"'
- : 'text/plain; charset="utf-8"',
+
+ 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} ) );
}
- );
- unless( sendmail(%mail) ) {
- carp $Mail::Sendmail::error;
- return { error => $Mail::Sendmail::error };
+ 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
sub GetPreparedLetter {
my %params = @_;
- my $module = $params{module} or croak "No module";
- my $letter_code = $params{letter_code} or croak "No letter_code";
- my $branchcode = $params{branchcode} || '';
- my $mtt = $params{message_transport_type} || 'email';
- my $lang = $params{lang} || 'default';
-
- my $letter = getletter( $module, $letter_code, $branchcode, $mtt, $lang );
+ my $letter = $params{letter};
+ my $lang = $params{lang} || 'default';
unless ( $letter ) {
- $letter = getletter( $module, $letter_code, $branchcode, $mtt, 'default' )
- or warn( "No $module $letter_code letter transported by " . $mtt ),
- return;
+ my $module = $params{module} or croak "No module";
+ my $letter_code = $params{letter_code} or croak "No letter_code";
+ my $branchcode = $params{branchcode} || '';
+ my $mtt = $params{message_transport_type} || 'email';
+
+ $letter = getletter( $module, $letter_code, $branchcode, $mtt, $lang );
+
+ unless ( $letter ) {
+ $letter = getletter( $module, $letter_code, $branchcode, $mtt, 'default' )
+ or warn( "No $module $letter_code letter transported by " . $mtt ),
+ return;
+ }
}
my $tables = $params{tables} || {};
tables => $tables,
loops => $loops,
substitute => $substitute,
+ lang => $lang
+ }
+ );
+
+ $letter->{title} = _process_tt(
+ {
+ content => $letter->{title},
+ tables => $tables,
+ loops => $loops,
+ substitute => $substitute,
}
);
# broke things for the rest of us. prepare_cached is a better
# way to cache statement handles anyway.
my $query =
+ ($table eq 'accountlines' ) ? "SELECT * FROM $table WHERE accountlines_id = ?" :
($table eq 'biblio' ) ? "SELECT * FROM $table WHERE biblionumber = ?" :
($table eq 'biblioitems' ) ? "SELECT * FROM $table WHERE biblionumber = ?" :
+ ($table eq 'credits' ) ? "SELECT * FROM accountlines WHERE accountlines_id = ?" :
+ ($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 'suggestions' ) ? "SELECT * FROM $table WHERE suggestionid = ?" :
($table eq 'aqbooksellers') ? "SELECT * FROM $table WHERE id = ?" :
($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 = ?" :
undef ;
unless ($query) {
warn "ERROR: No _parseletter_sth query for table '$table'";
my $values = $values_in ? { %$values_in } : {};
if ( $table eq 'borrowers' && $values->{'dateexpiry'} ){
- $values->{'dateexpiry'} = format_sqldatetime( $values->{'dateexpiry'} );
+ $values->{'dateexpiry'} = output_pref({ dt => dt_from_string( $values->{'dateexpiry'} ), dateonly => 1 });
}
if ( $table eq 'reserves' && $values->{'waitingdate'} ) {
}
if ($letter->{content} && $letter->{content} =~ /<<today>>/) {
- my $todaysdate = output_pref( DateTime->now() );
+ my $todaysdate = output_pref( dt_from_string() );
$letter->{content} =~ s/<<today>>/$todaysdate/go;
}
# Dates replacement
my $replacedby = defined ($val) ? $val : '';
if ( $replacedby
- and not $replacedby =~ m|0000-00-00|
and not $replacedby =~ m|9999-12-31|
and $replacedby =~ m|^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$| )
{
}
if ($table eq 'borrowers' && $letter->{content}) {
- if ( my $attributes = GetBorrowerAttributes($values->{borrowernumber}) ) {
+ my $patron = Koha::Patrons->find( $values->{borrowernumber} );
+ if ( $patron ) {
+ my $attributes = $patron->extended_attributes;
my %attr;
- foreach (@$attributes) {
- my $code = $_->{code};
- my $val = $_->{value_description} || $_->{value};
+ while ( my $attribute = $attributes->next ) {
+ my $code = $attribute->code;
+ my $val = $attribute->description; # FIXME - we always display intranet description here!
$val =~ s/\p{P}(?=$)//g if $val;
next unless $val gt '';
$attr{$code} ||= [];
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, content_type )
+( borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, reply_address, content_type )
VALUES
-( ?, ?, ?, ?, ?, ?, ?, NOW(), ?, ?, ? )
+( ?, ?, ?, ?, ?, ?, ?, NOW(), ?, ?, ?, ? )
ENDSQL
my $sth = $dbh->prepare($statement);
'pending', # status
$params->{'to_address'}, # to_address
$params->{'from_address'}, # from_address
+ $params->{'reply_address'}, # reply_address
$params->{'letter'}->{'content-type'}, # content_type
);
return $dbh->last_insert_id(undef,undef,'message_queue', undef);
=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.
+
+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.
-sends all of the 'pending' items in the message queue.
+The verbose parameter can be used to generate debugging output.
+It is also optional.
-returns number of messages sent.
+Returns number of messages sent.
=cut
sub SendQueuedMessages {
my $params = shift;
- my $unsent_messages = _get_unsent_messages();
+ my $which_unsent_messages = {
+ 'message_id' => $params->{'message_id'},
+ '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 ) {
+ my $message_object = Koha::Notice::Messages->find( $message->{message_id} );
+ # If this fails the database is unwritable and we won't manage to send a message that continues to be marked 'pending'
+ $message_object->make_column_dirty('status');
+ return unless $message_object->store;
+
# warn Data::Dumper->Dump( [ $message ], [ 'message' ] );
warn sprintf( 'sending %s message to patron: %s',
$message->{'message_transport_type'},
_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});
+
+ # Check for possible from_address override
+ my $from_address = C4::Context->preference('EmailSMSSendDriverFromAddress');
+ if ($from_address && $message->{from_address} ne $from_address) {
+ $message->{from_address} = $from_address;
+ _update_message_from_address($message->{'message_id'}, $message->{from_address});
+ }
+
+ _update_message_to_address($message->{'message_id'}, $message->{to_address});
_send_message_by_email( $message, $params->{'username'}, $params->{'password'}, $params->{'method'} );
} else {
_send_message_by_sms( $message );
my $messages = GetQueuedMessage( { borrowernumber => '123', limit => 20 } );
-fetches messages out of the message queue.
+Fetches a list of messages from the message queue optionally filtered by borrowernumber
+and limited to specified limit.
-returns:
-list of hashes, each has represents a message in the message queue.
+Return is an arrayref of hashes, each has represents a message in the message queue.
=cut
my $dbh = C4::Context->dbh();
my $statement = << 'ENDSQL';
-SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued
+SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued, updated_on
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, to_address, from_address, content_type
+ 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
FROM message_queue
WHERE message_id = ?
|, {}, $message_id );
=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)
+ message_id : the message_id of the message. In that case the sub will return only 1 result
+ 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.reply_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->{message_id} ) {
+ $statement .= ' AND message_id = ?';
+ push @query_params, $params->{message_id};
+ }
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?
}
}
- my $utf8 = decode('MIME-Header', $message->{'subject'} );
- $message->{subject}= encode('MIME-Header', $utf8);
- my $subject = encode('UTF-8', $message->{'subject'});
- my $content = encode('UTF-8', $message->{'content'});
+ my $subject = $message->{'subject'};
+
+ my $content = $message->{'content'};
my $content_type = $message->{'content_type'} || 'text/plain; charset="UTF-8"';
my $is_html = $content_type =~ m/html/io;
+
my $branch_email = undef;
my $branch_replyto = undef;
my $branch_returnpath = undef;
+ my $library;
+
if ($patron) {
- my $library = $patron->library;
+ $library = $patron->library;
$branch_email = $library->branchemail;
$branch_replyto = $library->branchreplyto;
$branch_returnpath = $library->branchreturnpath;
}
- my $email = Koha::Email->new();
- my %sendmail_params = $email->create_message_headers(
+
+ my $email = Koha::Email->create(
{
- to => $to_address,
- from => $message->{'from_address'} || $branch_email,
- replyto => $branch_replyto,
- sender => $branch_returnpath,
- subject => $subject,
- message => $is_html ? _wrap_html( $content, $subject ) : $content,
- contenttype => $content_type
+ to => $to_address,
+ (
+ C4::Context->preference('NoticeBcc')
+ ? ( bcc => C4::Context->preference('NoticeBcc') )
+ : ()
+ ),
+ from => $message->{'from_address'} || $branch_email,
+ reply_to => $message->{'reply_address'} || $branch_replyto,
+ sender => $branch_returnpath,
+ subject => "" . $message->{subject}
}
);
- $sendmail_params{'Auth'} = {user => $username, pass => $password, method => $method} if $username;
- if ( my $bcc = C4::Context->preference('NoticeBcc') ) {
- $sendmail_params{ Bcc } = $bcc;
+ if ( $is_html ) {
+ $email->html_body(
+ _wrap_html( $content, $subject )
+ );
+ }
+ else {
+ $email->text_body( $content );
}
- _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
+ my $smtp_server;
+ if ( $library ) {
+ $smtp_server = $library->smtp_server;
+ }
+ else {
+ $smtp_server = Koha::SMTP::Servers->get_default;
+ }
- if ( sendmail( %sendmail_params ) ) {
- _set_message_status( { message_id => $message->{'message_id'},
- status => 'sent' } );
+ if ( $username ) {
+ $smtp_server->set(
+ {
+ sasl_username => $username,
+ sasl_password => $password,
+ }
+ );
+ }
+
+# if initial message address was empty, coming here means that a to address was found and
+# queue should be updated; same if to address was overriden by Koha::Email->create
+ _update_message_to_address( $message->{'message_id'}, $email->email->header('To') )
+ if !$message->{to_address}
+ || $message->{to_address} ne $email->email->header('To');
+
+ try {
+ $email->send_or_die({ transport => $smtp_server->transport });
+
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'sent'
+ }
+ );
return 1;
- } else {
- _set_message_status( { message_id => $message->{'message_id'},
- status => 'failed' } );
- carp $Mail::Sendmail::error;
- return;
}
+ catch {
+ _set_message_status(
+ {
+ message_id => $message->{'message_id'},
+ status => 'failed'
+ }
+ );
+ carp "$_";
+ return;
+ };
}
sub _wrap_html {
WHERE message_transport_type = ?
AND borrowernumber = ?
AND letter_code = ?
- AND CAST(time_queued AS date) = CAST(NOW() AS date)
+ AND CAST(updated_on AS date) = CAST(NOW() AS date)
AND status="sent"
AND content = ?
|, {}, $message->{message_transport_type}, $message->{borrowernumber}, $message->{letter_code}, $message->{content} );
$dbh->do('UPDATE message_queue SET to_address=? WHERE message_id=?',undef,($to,$id));
}
+sub _update_message_from_address {
+ my ($message_id, $from_address) = @_;
+ my $dbh = C4::Context->dbh();
+ $dbh->do('UPDATE message_queue SET from_address = ? WHERE message_id = ?', undef, ($from_address, $message_id));
+}
+
sub _set_message_status {
my $params = shift or return;
my $tables = $params->{tables};
my $loops = $params->{loops};
my $substitute = $params->{substitute} || {};
+ my $lang = defined($params->{lang}) && $params->{lang} ne 'default' ? $params->{lang} : 'en';
+ my ($theme, $activethemes);
+
+ my $htdocs = C4::Context->config('intrahtdocs');
+ ($theme, $lang, $activethemes)= C4::Templates::activethemes( $htdocs, 'about.tt', 'intranet', $lang);
+ my @includes;
+ foreach (@$activethemes) {
+ push @includes, "$htdocs/$_/$lang/includes";
+ push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en';
+ }
my $use_template_cache = C4::Context->config('template_cache_dir') && defined $ENV{GATEWAY_INTERFACE};
my $template = Template->new(
PLUGIN_BASE => 'Koha::Template::Plugin',
COMPILE_EXT => $use_template_cache ? '.ttc' : '',
COMPILE_DIR => $use_template_cache ? C4::Context->config('template_cache_dir') : '',
+ INCLUDE_PATH => \@includes,
FILTERS => {},
ENCODING => 'UTF-8',
}
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();
singular => 'article_request',
plural => 'article_requests',
pk => 'id',
- },
+ },
+ aqbasket => {
+ module => 'Koha::Acquisition::Baskets',
+ singular => 'basket',
+ plural => 'baskets',
+ pk => 'basketno',
+ },
biblio => {
module => 'Koha::Biblios',
singular => 'biblio',
plural => 'biblios',
pk => 'biblionumber',
},
+ biblioitems => {
+ module => 'Koha::Biblioitems',
+ singular => 'biblioitem',
+ plural => 'biblioitems',
+ pk => 'biblioitemnumber',
+ },
borrowers => {
module => 'Koha::Patrons',
singular => 'borrower',
plural => 'branches',
pk => 'branchcode',
},
+ credits => {
+ module => 'Koha::Account::Lines',
+ singular => 'credit',
+ plural => 'credits',
+ pk => 'accountlines_id',
+ },
+ debits => {
+ module => 'Koha::Account::Lines',
+ singular => 'debit',
+ plural => 'debits',
+ pk => 'accountlines_id',
+ },
items => {
module => 'Koha::Items',
singular => 'item',
module => 'Koha::Holds',
singular => 'hold',
plural => 'holds',
- fk => [ 'borrowernumber', 'biblionumber' ],
+ pk => 'reserve_id',
},
serial => {
module => 'Koha::Serials',
plural => 'patron_modifications',
fk => 'verification_token',
},
+ illrequests => {
+ module => 'Koha::Illrequests',
+ singular => 'illrequest',
+ plural => 'illrequests',
+ pk => 'illrequest_id'
+ }
};
foreach my $table ( keys %$tables ) {
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;
projects / koha-ffzg.git / blobdiff