@@ -, +, @@ --email is provided. --- C4/Letters.pm | 133 ++++++++++++++++++--------------------- C4/Members.pm | 45 +++++++------ C4/Message.pm | 26 -------- C4/Reserves.pm | 12 ++-- misc/cronjobs/overdue_notices.pl | 10 +-- opac/opac-memberentry.pl | 4 +- opac/opac-shareshelf.pl | 10 ++- t/db_dependent/Letters.t | 75 +++++++++++++++++++--- t/db_dependent/Members.t | 16 +++-- 9 files changed, 180 insertions(+), 151 deletions(-) --- a/C4/Letters.pm +++ a/C4/Letters.pm @@ -34,7 +34,7 @@ use C4::SMS; use C4::Debug; use Koha::DateUtils; use Koha::SMS::Providers; - +use Koha::Database; use Koha::Email; use Koha::DateUtils qw( format_sqldatetime dt_from_string ); @@ -977,7 +977,6 @@ sub EnqueueLetter { my $params = shift or return; return unless exists $params->{'letter'}; -# return unless exists $params->{'borrowernumber'}; return unless exists $params->{'message_transport_type'}; my $content = $params->{letter}->{content}; @@ -997,28 +996,41 @@ sub EnqueueLetter { ); } - 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 ) -VALUES -( ?, ?, ?, ?, ?, ?, ?, NOW(), ?, ?, ? ) -ENDSQL + my @to_addresses; + if ( $params->{to_address} ) { + @to_addresses = ( $params->{to_address} ); + } elsif ( $params->{borrowernumber} and $params->{message_transport_type} eq 'email' ) { + @to_addresses = @{ C4::Members::GetNoticeEmailAddresses( $params->{borrowernumber} ) }; + } - my $sth = $dbh->prepare($statement); - my $result = $sth->execute( - $params->{'borrowernumber'}, # borrowernumber - $params->{'letter'}->{'title'}, # subject - $params->{'letter'}->{'content'}, # content - $params->{'letter'}->{'metadata'} || '', # metadata - $params->{'letter'}->{'code'} || '', # letter_code - $params->{'message_transport_type'}, # message_transport_type - 'pending', # status - $params->{'to_address'}, # to_address - $params->{'from_address'}, # from_address - $params->{'letter'}->{'content-type'}, # content_type - ); - return $dbh->last_insert_id(undef,undef,'message_queue', undef); + my $from_address; + if ( $params->{from_address} ) { + $from_address = $params->{from_address}; + } elsif ( $params->{message_transport_type} eq 'email' ) { + if ( $params->{borrowernumber} ) { + my $rs = Koha::Database->new->schema->resultset('Borrower')->search({ borrowernumber => $params->{borrowernumber} }, {join => 'branchcode'}); + $from_address = $rs->next->branchcode->branchemail; + } + + $from_address ||= C4::Context->preference('KohaAdminEmailAddress'); + } + + my $rs = Koha::Database->new->schema->resultset('MessageQueue'); + for my $to_address ( @to_addresses ) { + $rs->create({ + borrowernumber => $params->{borrowernumber}, + subject => $params->{letter}{title}, + content => $params->{letter}{content}, + metadata => ( $params->{letter}{metadata} || '' ), + letter_code => ( $params->{letter}{code} || ''), + message_transport_type => $params->{message_transport_type}, + status => 'pending', + to_address => $to_address, + from_address => $from_address, + content_type => $params->{letter}{'content-type'}, + }); + } + return scalar( @to_addresses ); } =head2 SendQueuedMessages ([$hashref]) @@ -1043,6 +1055,7 @@ sub SendQueuedMessages { if $params->{'verbose'} or $debug; # This is just begging for subclassing next MESSAGE if ( lc($message->{'message_transport_type'}) eq 'rss' ); + if ( lc( $message->{'message_transport_type'} ) eq 'email' ) { _send_message_by_email( $message, $params->{'username'}, $params->{'password'}, $params->{'method'} ); } @@ -1111,31 +1124,24 @@ list of hashes, each has represents a message in the message queue. sub GetQueuedMessages { my $params = shift; - my $dbh = C4::Context->dbh(); - my $statement = << 'ENDSQL'; -SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued -FROM message_queue -ENDSQL - - my @query_params; - my @whereclauses; - if ( exists $params->{'borrowernumber'} ) { - push @whereclauses, ' borrowernumber = ? '; - push @query_params, $params->{'borrowernumber'}; - } - - if ( @whereclauses ) { - $statement .= ' WHERE ' . join( 'AND', @whereclauses ); - } - - if ( defined $params->{'limit'} ) { - $statement .= ' LIMIT ? '; - push @query_params, $params->{'limit'}; - } - - my $sth = $dbh->prepare( $statement ); - my $result = $sth->execute( @query_params ); - return $sth->fetchall_arrayref({}); + my $rs = Koha::Database->new->schema->resultset('MessageQueue')->search( + { + ( + $params->{borrowernumber} + ? ( borrowernumber => $params->{borrowernumber} ) + : () + ), + }, + { + ( + $params->{limit} + ? ( rows => $params->{limit} ) + : () + ), + }, + ); + $rs->result_class('DBIx::Class::ResultClass::HashRefInflator'); + return [ $rs->all ]; } =head2 GetMessageTransportTypes @@ -1291,22 +1297,14 @@ sub _send_message_by_email { my ($username, $password, $method) = @_; my $member = C4::Members::GetMember( 'borrowernumber' => $message->{'borrowernumber'} ); - my $to_address = $message->{'to_address'}; - unless ($to_address) { - unless ($member) { - warn "FAIL: No 'to_address' and INVALID borrowernumber ($message->{borrowernumber})"; - _set_message_status( { message_id => $message->{'message_id'}, - status => 'failed' } ); - return; - } - $to_address = C4::Members::GetNoticeEmailAddress( $message->{'borrowernumber'} ); - 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' } ); - return; - } + + unless ( $member and $message->{to_address} ) { + warn "FAIL: No 'to_address' and INVALID borrowernumber ($message->{borrowernumber})" unless $member; + _set_message_status({ + message_id => $message->{'message_id'}, + status => 'failed' + }); + return; } my $utf8 = decode('MIME-Header', $message->{'subject'} ); @@ -1327,7 +1325,6 @@ sub _send_message_by_email { my $email = Koha::Email->new(); my %sendmail_params = $email->create_message_headers( { - to => $to_address, from => $message->{'from_address'} || $branch_email, replyto => $branch_replyto, sender => $branch_returnpath, @@ -1417,12 +1414,6 @@ sub _send_message_by_sms { return $success; } -sub _update_message_to_address { - my ($id, $to)= @_; - my $dbh = C4::Context->dbh(); - $dbh->do('UPDATE message_queue SET to_address=? WHERE message_id=?',undef,($to,$id)); -} - sub _set_message_status { my $params = shift or return; --- a/C4/Members.pm +++ a/C4/Members.pm @@ -66,7 +66,7 @@ BEGIN { &GetAllIssues &GetFirstValidEmailAddress - &GetNoticeEmailAddress + &GetNoticeEmailAddresses &GetMemberAccountRecords &GetBorNotifyAcctRecord @@ -990,33 +990,38 @@ sub GetFirstValidEmailAddress { } } -=head2 GetNoticeEmailAddress +=head2 GetNoticeEmailAddresses - $email = GetNoticeEmailAddress($borrowernumber); + $emails = GetNoticeEmailAddresses( borrowernumber ); -Return the email address of borrower used for notices, given the borrowernumber. -Returns the empty string if no email address. +Return the email addresses of borrower used for notices, given the borrowernumber. +Returns an empty arrayref if no email address. =cut -sub GetNoticeEmailAddress { +sub GetNoticeEmailAddresses { my $borrowernumber = shift; - my $which_address = C4::Context->preference("AutoEmailPrimaryAddress"); - # if syspref is set to 'first valid' (value == OFF), look up email address - if ( $which_address eq 'OFF' ) { - return GetFirstValidEmailAddress($borrowernumber); + my $which_addresses = C4::Context->preference("AutoEmailPrimaryAddress"); + my @email_addresses; + for my $email_address_field ( split /,/, $which_addresses ) { + + # if syspref is set to 'first valid' (value == OFF), look up email address + if ( $email_address_field eq 'OFF' ) { + return [ GetFirstValidEmailAddress($borrowernumber) ]; + } + + # specified email address field + my $email_address = C4::Context->dbh->selectcol_arrayref( + qq| + SELECT $email_address_field AS email + FROM borrowers + WHERE borrowernumber = ? + |, {}, $borrowernumber + ); + push @email_addresses, $email_address->[0] if $email_address->[0]; } - # specified email address field - my $dbh = C4::Context->dbh; - my $sth = $dbh->prepare( qq{ - SELECT $which_address AS primaryemail - FROM borrowers - WHERE borrowernumber=? - } ); - $sth->execute($borrowernumber); - my $data = $sth->fetchrow_hashref; - return $data->{'primaryemail'} || ''; + return \@email_addresses; } =head2 GetBorrowersToExpunge --- a/C4/Message.pm +++ a/C4/Message.pm @@ -158,7 +158,6 @@ the message. sub enqueue { my ($class, $letter, $borrower, $transport) = @_; my $metadata = _metadata($letter); - my $to_address = _to_address($borrower, $transport); # Same as render_metadata my $format ||= sub { $_[0] || "" }; @@ -170,34 +169,9 @@ sub enqueue { letter => $letter, borrowernumber => $borrower->{borrowernumber}, message_transport_type => $transport, - to_address => $to_address, }); } -# based on message $transport, pick an appropriate address to send to -sub _to_address { - my ($borrower, $transport) = @_; - my $address; - if ($transport eq 'email') { - $address = $borrower->{email} - || $borrower->{emailpro} - || $borrower->{B_email}; - } elsif ($transport eq 'sms') { - $address = $borrower->{smsalertnumber} - || $borrower->{phone} - || $borrower->{phonepro} - || $borrower->{B_phone}; - } else { - warn "'$transport' is an unknown message transport."; - } - if (not defined $address) { - warn "An appropriate $transport address " - . "for borrower $borrower->{userid} " - . "could not be found."; - } - return $address; -} - # _metadata($letter) -- return the letter split into head/body/footer sub _metadata { my ($letter) = @_; --- a/C4/Reserves.pm +++ a/C4/Reserves.pm @@ -250,8 +250,7 @@ sub AddReserve { { letter => $letter, borrowernumber => $borrowernumber, message_transport_type => 'email', - from_address => $admin_email_address, - to_address => $admin_email_address, + to_address => $admin_email_address, } ); } @@ -1927,9 +1926,6 @@ sub _koha_notify_reserve { my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber); - # Try to get the borrower's email address - my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber); - my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'Hold_Filled' @@ -1968,14 +1964,16 @@ sub _koha_notify_reserve { C4::Letters::EnqueueLetter( { letter => $letter, borrowernumber => $borrowernumber, - from_address => $admin_email_address, message_transport_type => $mtt, } ); }; + # Try to get the borrower's email addresses + my $to_addresses = C4::Members::GetNoticeEmailAddresses($borrowernumber); + while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) { next if ( - ( $mtt eq 'email' and not $to_address ) # No email address + ( $mtt eq 'email' and not @$to_addresses ) # No email address or ( $mtt eq 'sms' and not $borrower->{smsalertnumber} ) # No SMS number or ( $mtt eq 'phone' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl ); --- a/misc/cronjobs/overdue_notices.pl +++ a/misc/cronjobs/overdue_notices.pl @@ -579,8 +579,6 @@ END_SQL and warn "borrower $borr has items triggering level $i."; @emails_to_use = (); - my $notice_email = - C4::Members::GetNoticeEmailAddress($borrowernumber); unless ($nomail) { if (@emails) { foreach (@emails) { @@ -588,7 +586,9 @@ END_SQL } } else { - push @emails_to_use, $notice_email if ($notice_email); + my $notice_emails = + C4::Members::GetNoticeEmailAddresses($borrowernumber); + push @emails_to_use, @$notice_emails; } } @@ -733,7 +733,7 @@ END_SQL letternumber => $i, postcode => $data->{'zipcode'}, country => $data->{'country'}, - email => $notice_email, + email => $notice_emails, itemcount => $itemcount, titles => $titles, outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '', @@ -752,7 +752,7 @@ END_SQL city => $data->{'city'}, postcode => $data->{'zipcode'}, country => $data->{'country'}, - email => $notice_email, + email => ( scalar( @emails_to_use ) ? $emails_to_use[0] : undef ), itemcount => $itemcount, titles => $titles, outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '', --- a/opac/opac-memberentry.pl +++ a/opac/opac-memberentry.pl @@ -181,11 +181,9 @@ if ( $action eq 'create' ) { C4::Letters::EnqueueLetter( { + borrowernumber => $borrower{borrowernumber}, letter => $letter, message_transport_type => 'email', - to_address => $borrower{'email'}, - from_address => - C4::Context->preference('KohaAdminEmailAddress'), } ); } --- a/opac/opac-shareshelf.pl +++ a/opac/opac-shareshelf.pl @@ -166,8 +166,9 @@ sub show_accept { sub notify_owner { my ($param) = @_; - my $toaddr = C4::Members::GetNoticeEmailAddress( $param->{owner} ); - return if !$toaddr; + my $toaddr = C4::Members::GetNoticeEmailAddresses( $param->{owner} ); + return unless scalar( @$toaddr ); + #prepare letter my $letter = C4::Letters::GetPreparedLetter( @@ -181,10 +182,9 @@ sub notify_owner { #send letter to queue C4::Letters::EnqueueLetter( { + borrowernumber => $param->{owner}, letter => $letter, message_transport_type => 'email', - from_address => C4::Context->preference('KohaAdminEmailAddress'), - to_address => $toaddr, } ); } @@ -210,7 +210,6 @@ sub process_addrlist { sub send_invitekey { my ($param) = @_; - my $fromaddr = C4::Context->preference('KohaAdminEmailAddress'); my $url = C4::Context->preference('OPACBaseURL') . "/cgi-bin/koha/opac-shareshelf.pl?shelfnumber=" @@ -251,7 +250,6 @@ sub send_invitekey { { letter => $letter, message_transport_type => 'email', - from_address => $fromaddr, to_address => $a, } ); --- a/t/db_dependent/Letters.t +++ a/t/db_dependent/Letters.t @@ -18,7 +18,7 @@ # along with Koha; if not, see . use Modern::Perl; -use Test::More tests => 80; +use Test::More tests => 86; use Test::MockModule; use Test::Warn; @@ -64,12 +64,15 @@ my $library = $builder->build({ }); my $patron_category = $builder->build({ source => 'Category' }); my $date = dt_from_string; +my ( $email, $emailpro ) = ( 'email@example.org', 'emailpro@example.org' ); my $borrowernumber = AddMember( firstname => 'Jane', surname => 'Smith', categorycode => $patron_category,, branchcode => $library->{branchcode}, dateofbirth => $date, + email => $email, + emailpro => $emailpro, ); my $marc_record = MARC::Record->new; @@ -95,8 +98,7 @@ my $my_message = { to_address => 'to@example.com', from_address => 'from@example.com', }; -my $message_id = C4::Letters::EnqueueLetter($my_message); -is( $message_id, undef, 'EnqueueLetter without the letter argument returns undef' ); +is( C4::Letters::EnqueueLetter($my_message), undef, 'EnqueueLetter without the letter argument returns undef' ); delete $my_message->{message_transport_type}; $my_message->{letter} = { @@ -106,13 +108,11 @@ $my_message->{letter} = { code => 'TEST_MESSAGE', content_type => 'text/plain', }; -$message_id = C4::Letters::EnqueueLetter($my_message); -is( $message_id, undef, 'EnqueueLetter without the message type argument argument returns undef' ); +is( C4::Letters::EnqueueLetter($my_message), undef, 'EnqueueLetter without the message_transport_type argument returns undef' ); $my_message->{message_transport_type} = 'sms'; -$message_id = C4::Letters::EnqueueLetter($my_message); -ok(defined $message_id && $message_id > 0, 'new message successfully queued'); - +my $messages_queued = C4::Letters::EnqueueLetter($my_message); +is($messages_queued, 1, 'new message successfully queued'); # GetQueuedMessages my $messages = C4::Letters::GetQueuedMessages(); @@ -120,7 +120,6 @@ is( @$messages, 1, 'GetQueuedMessages without argument returns all the entries' $messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber }); is( @$messages, 1, 'one message stored for the borrower' ); -is( $messages->[0]->{message_id}, $message_id, 'EnqueueLetter returns the message id correctly' ); is( $messages->[0]->{borrowernumber}, $borrowernumber, 'EnqueueLetter stores the borrower number correctly' ); is( $messages->[0]->{subject}, $my_message->{letter}->{title}, 'EnqueueLetter stores the subject correctly' ); is( $messages->[0]->{content}, $my_message->{letter}->{content}, 'EnqueueLetter stores the content correctly' ); @@ -490,6 +489,64 @@ is($mail{'To'}, 'testemail@mydomain.com', "mailto correct in sent claim"); is($mail{'Message'}, 'my vendor|John Smith|Ordernumber ' . $ordernumber . ' (Silence in the library) (1 ordered)', 'Claim notice text constructed successfully'); } +# EnqueueLetter and AutoEmailPrimaryAddress +$my_message = { + borrowernumber => $borrowernumber, + message_transport_type => 'email', + to_address => 'to@example.com', + from_address => 'from@example.com', + letter => { + content => 'a message', + title => 'message title', + metadata => 'metadata', + code => 'TEST_MESSAGE', + content_type => 'text/plain', + }, +}; + +$dbh->do(q|DELETE FROM message_queue|); +t::lib::Mocks::mock_preference('AutoEmailPrimaryAddress', 'email'); +is( C4::Letters::EnqueueLetter($my_message), 1, 'message successfully queued' ); +$messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber }); +is( scalar( @$messages ), 1, 'The message has been queued for the expected patron' ); +is( $messages->[0]{to_address}, 'to@example.com', 'AutoEmailPrimaryAddress=email, EnqueueLetter used the to_address given in parameter' ); + +$dbh->do(q|DELETE FROM message_queue|); +delete $my_message->{to_address}; +is( C4::Letters::EnqueueLetter($my_message), 1, 'message successfully queued' ); +$messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber }); +is( scalar( @$messages ), 1, 'The message has been queued for the expected patron' ); +is( $messages->[0]{to_address}, $email, 'AutoEmailPrimaryAddress=email, EnqueueLetter used the patron email address if no to_address is given in parameter' ); + +$dbh->do(q|DELETE FROM message_queue|); +t::lib::Mocks::mock_preference('AutoEmailPrimaryAddress', 'emailpro'); +is( C4::Letters::EnqueueLetter($my_message), 1, 'message successfully queued' ); +$messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber }); +is( scalar( @$messages ), 1, 'The message has been queued for the expected patron' ); +is( $messages->[0]{to_address}, $emailpro, 'AutoEmailPrimaryAddress=emailpro, EnqueueLetter used the patron emailpro address if no to_address is given in parameter' ); + +$dbh->do(q|DELETE FROM message_queue|); +t::lib::Mocks::mock_preference('AutoEmailPrimaryAddress', 'OFF'); +is( C4::Letters::EnqueueLetter($my_message), 1, 'message successfully queued' ); +$messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber }); +is( scalar( @$messages ), 1, 'The message has been queued for the expected patron' ); +is( $messages->[0]{to_address}, $email, 'AutoEmailPrimaryAddress=OFF, EnqueueLetter used the patron email address if no to_address is given in parameter' ); + +$dbh->do(q|DELETE FROM message_queue|); +t::lib::Mocks::mock_preference('AutoEmailPrimaryAddress', 'email|OFF|emailpro'); # This is no consistent. OFF should be alone. +is( C4::Letters::EnqueueLetter($my_message), 1, 'message successfully queued' ); +$messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber }); +is( scalar( @$messages ), 1, 'The message has been queued for the expected patron' ); +is( $messages->[0]{to_address}, $email, 'AutoEmailPrimaryAddress=email|OFF|emailpro, EnqueueLetter used the patron email address if no to_address is given in parameter' ); + +$dbh->do(q|DELETE FROM message_queue|); +t::lib::Mocks::mock_preference('AutoEmailPrimaryAddress', 'email|emailpro'); +is( C4::Letters::EnqueueLetter($my_message), 2, 'messages successfully queued' ); +$messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber }); +is( scalar( @$messages ), 2, 'The messages have been queued for the expected patron' ); +is( $messages->[0]{to_address}, $email, 'AutoEmailPrimaryAddress=email|emailpro, EnqueueLetter used the patron email address for the first letter' ); +is( $messages->[1]{to_address}, $emailpro, 'AutoEmailPrimaryAddress=email|emailpro, EnqueueLetter used the patron emailpro address for the second letter' ); + { use C4::Serials; --- a/t/db_dependent/Members.t +++ a/t/db_dependent/Members.t @@ -139,15 +139,23 @@ is ($checkcardnum, "2", "Card number is too long"); t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'OFF' ); C4::Context->clear_syspref_cache(); +my $notice_emails = GetNoticeEmailAddresses($member->{'borrowernumber'}); +is_deeply( $notice_emails, [ $EMAIL ], "GetNoticeEmailAddresses returns correct value when AutoEmailPrimaryAddress is off" ); -my $notice_email = GetNoticeEmailAddress($member->{'borrowernumber'}); -is ($notice_email, $EMAIL, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is off"); +C4::Context->set_preference( 'AutoEmailPrimaryAddress', 'emailpro,OFF' ); +C4::Context->clear_syspref_cache(); +$notice_emails = GetNoticeEmailAddresses($member->{'borrowernumber'}); +is_deeply( $notice_emails, [ $EMAIL ], "GetNoticeEmailAddresses returns correct value when AutoEmailPrimaryAddress contains off" ); t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'emailpro' ); C4::Context->clear_syspref_cache(); +$notice_emails = GetNoticeEmailAddresses($member->{'borrowernumber'}); +is_deeply ($notice_emails, [ $EMAILPRO ], "GetNoticeEmailAddresses returns correct value when AutoEmailPrimaryAddress is emailpro"); -$notice_email = GetNoticeEmailAddress($member->{'borrowernumber'}); -is ($notice_email, $EMAILPRO, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is emailpro"); +C4::Context->set_preference( 'AutoEmailPrimaryAddress', 'emailpro,email' ); +C4::Context->clear_syspref_cache(); +$notice_emails = GetNoticeEmailAddresses($member->{'borrowernumber'}); +is_deeply ($notice_emails, [ $EMAILPRO, $EMAIL ], "GetNoticeEmailAddresses returns correct value when AutoEmailPrimaryAddress is emailpro|email"); # Check_Userid tests %data = ( --