3 # This file is part of Koha.
5 # Copyright (C) 2013 Equinox Software, Inc.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 use Test::More tests => 65;
28 my $module = new Test::MockModule('Mail::Sendmail');
37 use_ok('C4::Context');
38 use_ok('C4::Members');
39 use_ok('C4::Acquisition');
41 use_ok('C4::Letters');
43 use t::lib::TestBuilder;
45 use Koha::DateUtils qw( dt_from_string output_pref );
46 use Koha::Acquisition::Booksellers;
47 use Koha::Acquisition::Bookseller::Contacts;
48 use Koha::Acquisition::Orders;
50 use Koha::Notice::Templates;
52 use Koha::Subscriptions;
53 my $schema = Koha::Database->schema;
54 $schema->storage->txn_begin();
56 my $builder = t::lib::TestBuilder->new;
57 my $dbh = C4::Context->dbh;
58 $dbh->{RaiseError} = 1;
60 $dbh->do(q|DELETE FROM letter|);
61 $dbh->do(q|DELETE FROM message_queue|);
62 $dbh->do(q|DELETE FROM message_transport_types|);
64 my $library = $builder->build({
67 my $patron_category = $builder->build({ source => 'Category' })->{categorycode};
68 my $date = dt_from_string;
69 my $borrowernumber = AddMember(
72 categorycode => $patron_category,
73 branchcode => $library->{branchcode},
75 smsalertnumber => undef,
78 my $marc_record = MARC::Record->new;
79 my( $biblionumber, $biblioitemnumber ) = AddBiblio( $marc_record, '' );
83 # GetMessageTransportTypes
84 my $mtts = C4::Letters::GetMessageTransportTypes();
85 is( @$mtts, 0, 'GetMessageTransportTypes returns the correct number of message types' );
88 INSERT INTO message_transport_types( message_transport_type ) VALUES ('email'), ('phone'), ('print'), ('sms')
90 $mtts = C4::Letters::GetMessageTransportTypes();
91 is_deeply( $mtts, ['email', 'phone', 'print', 'sms'], 'GetMessageTransportTypes returns all values' );
95 is( C4::Letters::EnqueueLetter(), undef, 'EnqueueLetter without argument returns undef' );
98 borrowernumber => $borrowernumber,
99 message_transport_type => 'sms',
101 from_address => 'from@example.com',
103 my $message_id = C4::Letters::EnqueueLetter($my_message);
104 is( $message_id, undef, 'EnqueueLetter without the letter argument returns undef' );
106 delete $my_message->{message_transport_type};
107 $my_message->{letter} = {
108 content => 'a message',
109 title => 'message title',
110 metadata => 'metadata',
111 code => 'TEST_MESSAGE',
112 content_type => 'text/plain',
115 $message_id = C4::Letters::EnqueueLetter($my_message);
116 is( $message_id, undef, 'EnqueueLetter without the message type argument argument returns undef' );
118 $my_message->{message_transport_type} = 'sms';
119 $message_id = C4::Letters::EnqueueLetter($my_message);
120 ok(defined $message_id && $message_id > 0, 'new message successfully queued');
124 my $messages = C4::Letters::GetQueuedMessages();
125 is( @$messages, 1, 'GetQueuedMessages without argument returns all the entries' );
127 $messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber });
128 is( @$messages, 1, 'one message stored for the borrower' );
129 is( $messages->[0]->{message_id}, $message_id, 'EnqueueLetter returns the message id correctly' );
130 is( $messages->[0]->{borrowernumber}, $borrowernumber, 'EnqueueLetter stores the borrower number correctly' );
131 is( $messages->[0]->{subject}, $my_message->{letter}->{title}, 'EnqueueLetter stores the subject correctly' );
132 is( $messages->[0]->{content}, $my_message->{letter}->{content}, 'EnqueueLetter stores the content correctly' );
133 is( $messages->[0]->{message_transport_type}, $my_message->{message_transport_type}, 'EnqueueLetter stores the message type correctly' );
134 is( $messages->[0]->{status}, 'pending', 'EnqueueLetter stores the status pending correctly' );
138 my $messages_processed = C4::Letters::SendQueuedMessages( { type => 'email' });
139 is($messages_processed, 0, 'No queued messages processed if type limit passed with unused type');
140 $messages_processed = C4::Letters::SendQueuedMessages( { type => 'sms' });
141 is($messages_processed, 1, 'All queued messages processed, found correct number of messages with type limit');
142 $messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber });
144 $messages->[0]->{status},
146 'message marked failed if tried to send SMS message for borrower with no smsalertnumber set (bug 11208)'
150 my $resent = C4::Letters::ResendMessage($messages->[0]->{message_id});
151 my $message = C4::Letters::GetMessage( $messages->[0]->{message_id});
152 is( $resent, 1, 'The message should have been resent' );
153 is($message->{status},'pending', 'ResendMessage sets status to pending correctly (bug 12426)');
154 $resent = C4::Letters::ResendMessage($messages->[0]->{message_id});
155 is( $resent, 0, 'The message should not have been resent again' );
156 $resent = C4::Letters::ResendMessage();
157 is( $resent, undef, 'ResendMessage should return undef if not message_id given' );
160 my $letters = C4::Letters::GetLetters();
161 is( @$letters, 0, 'GetLetters returns the correct number of letters' );
163 my $title = q|<<branches.branchname>> - <<status>>|;
164 my $content = q{Dear <<borrowers.firstname>> <<borrowers.surname>>,
165 According to our current records, you have items that are overdue.Your library does not charge late fines, but please return or renew them at the branch below as soon as possible.
167 <<branches.branchname>>
168 <<branches.branchaddress1>>
171 The following item(s) is/are currently <<status>>:
173 <item> <<count>>. <<items.itemcallnumber>>, Barcode: <<items.barcode>> </item>
175 Thank-you for your prompt attention to this matter.
176 Don't forget your date of birth: <<borrowers.dateofbirth>>.
177 Look at this wonderful biblio timestamp: <<biblio.timestamp>>.
180 $dbh->do( q|INSERT INTO letter(branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES (?,'my module','my code','my name',1,?,?,'email')|, undef, $library->{branchcode}, $title, $content );
181 $letters = C4::Letters::GetLetters();
182 is( @$letters, 1, 'GetLetters returns the correct number of letters' );
183 is( $letters->[0]->{module}, 'my module', 'GetLetters gets the module correctly' );
184 is( $letters->[0]->{code}, 'my code', 'GetLetters gets the code correctly' );
185 is( $letters->[0]->{name}, 'my name', 'GetLetters gets the name correctly' );
189 subtest 'getletter' => sub {
191 t::lib::Mocks::mock_preference('IndependentBranches', 0);
192 my $letter = C4::Letters::getletter('my module', 'my code', $library->{branchcode}, 'email');
193 is( $letter->{branchcode}, $library->{branchcode}, 'GetLetters gets the branch code correctly' );
194 is( $letter->{module}, 'my module', 'GetLetters gets the module correctly' );
195 is( $letter->{code}, 'my code', 'GetLetters gets the code correctly' );
196 is( $letter->{name}, 'my name', 'GetLetters gets the name correctly' );
197 is( $letter->{is_html}, 1, 'GetLetters gets the boolean is_html correctly' );
198 is( $letter->{title}, $title, 'GetLetters gets the title correctly' );
199 is( $letter->{content}, $content, 'GetLetters gets the content correctly' );
200 is( $letter->{message_transport_type}, 'email', 'GetLetters gets the message type correctly' );
202 my $context = Test::MockModule->new('C4::Context');
203 $context->mock( 'userenv', sub {
206 branch => "anotherlib" }
209 t::lib::Mocks::mock_preference('IndependentBranches', 1);
210 $letter = C4::Letters::getletter('my module', 'my code', $library->{branchcode}, 'email');
211 is( $letter->{branchcode}, $library->{branchcode}, 'GetLetters gets the branch code correctly' );
212 is( $letter->{module}, 'my module', 'GetLetters gets the module correctly' );
213 is( $letter->{code}, 'my code', 'GetLetters gets the code correctly' );
214 is( $letter->{name}, 'my name', 'GetLetters gets the name correctly' );
215 is( $letter->{is_html}, 1, 'GetLetters gets the boolean is_html correctly' );
216 is( $letter->{title}, $title, 'GetLetters gets the title correctly' );
217 is( $letter->{content}, $content, 'GetLetters gets the content correctly' );
218 is( $letter->{message_transport_type}, 'email', 'GetLetters gets the message type correctly' );
220 $context->unmock('userenv');
225 # Regression test for Bug 14206
226 $dbh->do( q|INSERT INTO letter(branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES ('FFL','my module','my code','my name',1,?,?,'print')|, undef, $title, $content );
227 my $letter14206_a = C4::Letters::getletter('my module', 'my code', 'FFL' );
228 is( $letter14206_a->{message_transport_type}, 'print', 'Bug 14206 - message_transport_type not passed, correct mtt detected' );
229 my $letter14206_b = C4::Letters::getletter('my module', 'my code', 'FFL', 'print');
230 is( $letter14206_b->{message_transport_type}, 'print', 'Bug 14206 - message_transport_type passed, correct mtt detected' );
232 # test for overdue_notices.pl
233 my $overdue_rules = {
234 letter1 => 'my code',
237 my $branchcode = 'FFL';
238 my $letter14206_c = C4::Letters::getletter('my module', $overdue_rules->{"letter$i"}, $branchcode);
239 is( $letter14206_c->{message_transport_type}, 'print', 'Bug 14206 - correct mtt detected for call from overdue_notices.pl' );
242 t::lib::Mocks::mock_preference('OPACBaseURL', 'http://thisisatest.com');
244 my $sms_content = 'This is a SMS for an <<status>>';
245 $dbh->do( q|INSERT INTO letter(branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES (?,'my module','my code','my name',1,'my title',?,'sms')|, undef, $library->{branchcode}, $sms_content );
248 borrowers => $borrowernumber,
249 branches => $library->{branchcode},
250 biblio => $biblionumber,
257 itemcallnumber => 'my callnumber1',
261 itemcallnumber => 'my callnumber2',
265 my $prepared_letter = GetPreparedLetter((
266 module => 'my module',
267 branchcode => $library->{branchcode},
268 letter_code => 'my code',
270 substitute => $substitute,
273 my $retrieved_library = Koha::Libraries->find($library->{branchcode});
274 my $my_title_letter = $retrieved_library->branchname . qq| - $substitute->{status}|;
275 my $biblio_timestamp = dt_from_string( GetBiblioData($biblionumber)->{timestamp} );
276 my $my_content_letter = qq|Dear Jane Smith,
277 According to our current records, you have items that are overdue.Your library does not charge late fines, but please return or renew them at the branch below as soon as possible.
279 |.$retrieved_library->branchname.qq|
280 |.$retrieved_library->branchaddress1.qq|
281 URL: http://thisisatest.com
283 The following item(s) is/are currently $substitute->{status}:
285 <item> 1. $repeat->[0]->{itemcallnumber}, Barcode: $repeat->[0]->{barcode} </item>
286 <item> 2. $repeat->[1]->{itemcallnumber}, Barcode: $repeat->[1]->{barcode} </item>
288 Thank-you for your prompt attention to this matter.
289 Don't forget your date of birth: | . output_pref({ dt => $date, dateonly => 1 }) . q|.
290 Look at this wonderful biblio timestamp: | . output_pref({ dt => $biblio_timestamp }) . ".\n";
292 is( $prepared_letter->{title}, $my_title_letter, 'GetPreparedLetter returns the title correctly' );
293 is( $prepared_letter->{content}, $my_content_letter, 'GetPreparedLetter returns the content correctly' );
295 $prepared_letter = GetPreparedLetter((
296 module => 'my module',
297 branchcode => $library->{branchcode},
298 letter_code => 'my code',
300 substitute => $substitute,
302 message_transport_type => 'sms',
304 $my_content_letter = qq|This is a SMS for an $substitute->{status}|;
305 is( $prepared_letter->{content}, $my_content_letter, 'GetPreparedLetter returns the content correctly' );
307 $dbh->do(q{INSERT INTO letter (module, code, name, title, content) VALUES ('test_date','TEST_DATE','Test dates','A title with a timestamp: <<biblio.timestamp>>','This one only contains the date: <<biblio.timestamp | dateonly>>.');});
308 $prepared_letter = GetPreparedLetter((
309 module => 'test_date',
311 letter_code => 'test_date',
313 substitute => $substitute,
316 is( $prepared_letter->{content}, q|This one only contains the date: | . output_pref({ dt => $date, dateonly => 1 }) . q|.|, 'dateonly test 1' );
318 $dbh->do(q{UPDATE letter SET content = 'And also this one:<<timestamp | dateonly>>.' WHERE code = 'test_date';});
319 $prepared_letter = GetPreparedLetter((
320 module => 'test_date',
322 letter_code => 'test_date',
324 substitute => $substitute,
327 is( $prepared_letter->{content}, q|And also this one:| . output_pref({ dt => $date, dateonly => 1 }) . q|.|, 'dateonly test 2' );
329 $dbh->do(q{UPDATE letter SET content = 'And also this one:<<timestamp|dateonly >>.' WHERE code = 'test_date';});
330 $prepared_letter = GetPreparedLetter((
331 module => 'test_date',
333 letter_code => 'test_date',
335 substitute => $substitute,
338 is( $prepared_letter->{content}, q|And also this one:| . output_pref({ dt => $date, dateonly => 1 }) . q|.|, 'dateonly test 3' );
340 t::lib::Mocks::mock_preference( 'TimeFormat', '12hr' );
341 my $yesterday_night = $date->clone->add( days => -1 )->set_hour(22);
342 $dbh->do(q|UPDATE biblio SET timestamp = ? WHERE biblionumber = ?|, undef, $yesterday_night, $biblionumber );
343 $dbh->do(q{UPDATE letter SET content = 'And also this one:<<timestamp>>.' WHERE code = 'test_date';});
344 $prepared_letter = GetPreparedLetter((
345 module => 'test_date',
347 letter_code => 'test_date',
349 substitute => $substitute,
352 is( $prepared_letter->{content}, q|And also this one:| . output_pref({ dt => $yesterday_night }) . q|.|, 'dateonly test 3' );
354 $dbh->do(q{INSERT INTO letter (module, code, name, title, content) VALUES ('claimacquisition','TESTACQCLAIM','Acquisition Claim','Item Not Received','<<aqbooksellers.name>>|<<aqcontacts.name>>|<order>Ordernumber <<aqorders.ordernumber>> (<<biblio.title>>) (<<aqorders.quantity>> ordered)</order>');});
355 $dbh->do(q{INSERT INTO letter (module, code, name, title, content) VALUES ('orderacquisition','TESTACQORDER','Acquisition Order','Order','<<aqbooksellers.name>>|<<aqcontacts.name>>|<order>Ordernumber <<aqorders.ordernumber>> (<<biblio.title>>) (<<aqorders.quantity>> ordered)</order>');});
357 # Test that _parseletter doesn't modify its parameters bug 15429
359 my $values = { dateexpiry => '2015-12-13', };
360 C4::Letters::_parseletter($prepared_letter, 'borrowers', $values);
361 is( $values->{dateexpiry}, '2015-12-13', "_parseletter doesn't modify its parameters" );
364 my $bookseller = Koha::Acquisition::Bookseller->new(
367 address1 => "bookseller's address",
373 my $booksellerid = $bookseller->id;
375 Koha::Acquisition::Bookseller::Contact->new( { name => 'John Smith', phone => '0123456x1', claimacquisition => 1, orderacquisition => 1, booksellerid => $booksellerid } )->store;
376 Koha::Acquisition::Bookseller::Contact->new( { name => 'Leo Tolstoy', phone => '0123456x2', claimissues => 1, booksellerid => $booksellerid } )->store;
377 my $basketno = NewBasket($booksellerid, 1);
379 my $budgetid = C4::Budgets::AddBudget({
380 budget_code => "budget_code_test_letters",
381 budget_name => "budget_name_test_letters",
384 my $bib = MARC::Record->new();
385 if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
387 MARC::Field->new('200', ' ', ' ', a => 'Silence in the library'),
391 MARC::Field->new('245', ' ', ' ', a => 'Silence in the library'),
395 ($biblionumber, $biblioitemnumber) = AddBiblio($bib, '');
396 my $order = Koha::Acquisition::Order->new(
398 basketno => $basketno,
400 biblionumber => $biblionumber,
401 budget_id => $budgetid,
404 my $ordernumber = $order->ordernumber;
406 C4::Acquisition::CloseBasket( $basketno );
409 $err = SendAlerts( 'claimacquisition', [ $ordernumber ], 'TESTACQCLAIM' ) }
410 qr/^Bookseller .* without emails at/,
411 "SendAlerts prints a warning";
412 is($err->{'error'}, 'no_email', "Trying to send an alert when there's no e-mail results in an error");
414 $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
415 $bookseller->contacts->next->email('testemail@mydomain.com')->store;
417 # Ensure that the preference 'LetterLog' is set to logging
418 t::lib::Mocks::mock_preference( 'LetterLog', 'on' );
420 # SendAlerts needs branchemail or KohaAdminEmailAddress as sender
421 C4::Context->_new_userenv('DUMMY');
422 C4::Context->set_userenv( 0, 0, 0, 'firstname', 'surname', $library->{branchcode}, 'My Library', 0, '', '');
423 t::lib::Mocks::mock_preference( 'KohaAdminEmailAddress', 'library@domain.com' );
427 $err = SendAlerts( 'orderacquisition', $basketno , 'TESTACQORDER' ) }
429 "SendAlerts is using the mocked sendmail routine (orderacquisition)";
430 is($err, 1, "Successfully sent order.");
431 is($mail{'To'}, 'testemail@mydomain.com', "mailto correct in sent order");
432 is($mail{'Message'}, 'my vendor|John Smith|Ordernumber ' . $ordernumber . ' (Silence in the library) (1 ordered)', 'Order notice text constructed successfully');
434 $dbh->do(q{DELETE FROM letter WHERE code = 'TESTACQORDER';});
436 $err = SendAlerts( 'orderacquisition', $basketno , 'TESTACQORDER' ) }
437 qr/No orderacquisition TESTACQORDER letter transported by email/,
438 "GetPreparedLetter warns about missing notice template";
439 is($err->{'error'}, 'no_letter', "No TESTACQORDER letter was defined.");
444 $err = SendAlerts( 'claimacquisition', [ $ordernumber ], 'TESTACQCLAIM' ) }
446 "SendAlerts is using the mocked sendmail routine";
448 is($err, 1, "Successfully sent claim");
449 is($mail{'To'}, 'testemail@mydomain.com', "mailto correct in sent claim");
450 is($mail{'Message'}, 'my vendor|John Smith|Ordernumber ' . $ordernumber . ' (Silence in the library) (1 ordered)', 'Claim notice text constructed successfully');
457 my $internalnotes = 'intnotes';
458 $dbh->do(q|UPDATE subscription_numberpatterns SET numberingmethod='No. {X}' WHERE id=1|);
459 my $subscriptionid = NewSubscription(
460 undef, "", undef, undef, undef, $biblionumber,
461 '2013-01-01', 1, undef, undef, undef,
462 undef, undef, undef, undef, undef, undef,
463 1, $notes,undef, '2013-01-01', undef, 1,
464 undef, undef, 0, $internalnotes, 0,
465 undef, undef, 0, undef, '2013-12-31', 0
467 $dbh->do(q{INSERT INTO letter (module, code, name, title, content) VALUES ('serial','RLIST','Serial issue notification','Serial issue notification','<<biblio.title>>,<<subscription.subscriptionid>>,<<serial.serialseq>>');});
468 my ($serials_count, @serials) = GetSerials($subscriptionid);
469 my $serial = $serials[0];
471 my $borrowernumber = AddMember(
474 categorycode => $patron_category,
475 branchcode => $library->{branchcode},
476 dateofbirth => $date,
477 email => 'john.smith@test.de',
479 my $subscription = Koha::Subscriptions->find( $subscriptionid );
480 $subscription->add_subscriber( scalar Koha::Patrons->find( $borrowernumber ) );
484 $err2 = SendAlerts( 'issue', $serial->{serialid}, 'RLIST' ) }
486 "SendAlerts is using the mocked sendmail routine";
487 is($err2, 1, "Successfully sent serial notification");
488 is($mail{'To'}, 'john.smith@test.de', "mailto correct in sent serial notification");
489 is($mail{'Message'}, 'Silence in the library,'.$subscriptionid.',No. 0', 'Serial notification text constructed successfully');
492 subtest 'SendAlerts - claimissue' => sub {
497 $dbh->do(q{INSERT INTO letter (module, code, name, title, content) VALUES ('claimissues','TESTSERIALCLAIM','Serial claim test','Serial claim test','<<serial.serialid>>|<<subscription.startdate>>|<<biblio.title>>|<<biblioitems.issn>>');});
499 my $bookseller = Koha::Acquisition::Bookseller->new(
502 address1 => "bookseller's address",
508 my $booksellerid = $bookseller->id;
510 Koha::Acquisition::Bookseller::Contact->new( { name => 'Leo Tolstoy', phone => '0123456x2', claimissues => 1, booksellerid => $booksellerid } )->store;
512 my $bib = MARC::Record->new();
513 if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
515 MARC::Field->new('011', ' ', ' ', a => 'xxxx-yyyy'),
516 MARC::Field->new('200', ' ', ' ', a => 'Silence in the library'),
520 MARC::Field->new('022', ' ', ' ', a => 'xxxx-yyyy'),
521 MARC::Field->new('245', ' ', ' ', a => 'Silence in the library'),
524 my ($biblionumber) = AddBiblio($bib, '');
526 $dbh->do(q|UPDATE subscription_numberpatterns SET numberingmethod='No. {X}' WHERE id=1|);
527 my $subscriptionid = NewSubscription(
528 undef, "", $booksellerid, undef, undef, $biblionumber,
529 '2013-01-01', 1, undef, undef, undef,
530 undef, undef, undef, undef, undef, undef,
531 1, 'public',undef, '2013-01-01', undef, 1,
532 undef, undef, 0, 'internal', 0,
533 undef, undef, 0, undef, '2013-12-31', 0
536 my ($serials_count, @serials) = GetSerials($subscriptionid);
537 my @serialids = ($serials[0]->{serialid});
541 $err = SendAlerts( 'claimissues', \@serialids, 'TESTSERIALCLAIM' ) }
542 qr/^Bookseller .* without emails at/,
543 "Warn on vendor without email address";
545 $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
546 $bookseller->contacts->next->email('testemail@mydomain.com')->store;
548 # Ensure that the preference 'LetterLog' is set to logging
549 t::lib::Mocks::mock_preference( 'LetterLog', 'on' );
551 # SendAlerts needs branchemail or KohaAdminEmailAddress as sender
552 C4::Context->_new_userenv('DUMMY');
553 C4::Context->set_userenv( 0, 0, 0, 'firstname', 'surname', $library->{branchcode}, 'My Library', 0, '', '');
554 t::lib::Mocks::mock_preference( 'KohaAdminEmailAddress', 'library@domain.com' );
558 $err = SendAlerts( 'claimissues', \@serialids , 'TESTSERIALCLAIM' ) }
560 "SendAlerts is using the mocked sendmail routine (claimissues)";
561 is($err, 1, "Successfully sent claim");
562 is($mail{'To'}, 'testemail@mydomain.com', "mailto correct in sent claim");
563 is($mail{'Message'}, "$serialids[0]|2013-01-01|Silence in the library|xxxx-yyyy", 'Serial claim letter for 1 issue constructed successfully');
567 my $publisheddate = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
568 my $serialexpected = ( C4::Serials::findSerialsByStatus( 1, $subscriptionid ) )[0];
569 ModSerialStatus( $serials[0]->{serialid}, "No. 1", $publisheddate, $publisheddate, $publisheddate, '3', 'a note' );
570 ($serials_count, @serials) = GetSerials($subscriptionid);
571 push @serialids, ($serials[1]->{serialid});
573 $err = SendAlerts( 'claimissues', \@serialids , 'TESTSERIALCLAIM' );
574 is($mail{'Message'}, "$serialids[0]|2013-01-01|Silence in the library|xxxx-yyyy\n$serialids[1]|2013-01-01|Silence in the library|xxxx-yyyy", "Serial claim letter for 2 issues constructed successfully");
576 $dbh->do(q{DELETE FROM letter WHERE code = 'TESTSERIALCLAIM';});
578 $err = SendAlerts( 'orderacquisition', $basketno , 'TESTSERIALCLAIM' ) }
579 qr/No orderacquisition TESTSERIALCLAIM letter transported by email/,
580 "GetPreparedLetter warns about missing notice template";
581 is($err->{'error'}, 'no_letter', "No TESTSERIALCLAIM letter was defined");
586 subtest 'GetPreparedLetter' => sub {
589 Koha::Notice::Template->new(
594 message_transport_type => 'email'
599 $letter = C4::Letters::GetPreparedLetter(
601 letter_code => 'test',
604 qr{^ERROR: nothing to substitute},
605 'GetPreparedLetter should warn if tables, substiture and repeat are not set';
607 'No letter should be returned by GetPreparedLetter if something went wrong'
611 $letter = C4::Letters::GetPreparedLetter(
613 letter_code => 'test',
617 qr{^ERROR: nothing to substitute},
618 'GetPreparedLetter should warn if tables, substiture and repeat are not set, even if the key is passed';
620 'No letter should be returned by GetPreparedLetter if something went wrong'
627 subtest 'TranslateNotices' => sub {
630 t::lib::Mocks::mock_preference( 'TranslateNotices', '1' );
634 INSERT INTO letter (module, code, branchcode, name, title, content, message_transport_type, lang) VALUES
635 ('test', 'code', '', 'test', 'a test', 'just a test', 'email', 'default'),
636 ('test', 'code', '', 'test', 'una prueba', 'solo una prueba', 'email', 'es-ES');
639 my $letter = C4::Letters::GetPreparedLetter(
642 letter_code => 'code',
643 message_transport_type => 'email',
644 substitute => $substitute,
649 'GetPreparedLetter should return the default one if the lang parameter is not provided'
652 $letter = C4::Letters::GetPreparedLetter(
655 letter_code => 'code',
656 message_transport_type => 'email',
657 substitute => $substitute,
660 is( $letter->{title}, 'una prueba',
661 'GetPreparedLetter should return the required notice if it exists' );
663 $letter = C4::Letters::GetPreparedLetter(
666 letter_code => 'code',
667 message_transport_type => 'email',
668 substitute => $substitute,
674 'GetPreparedLetter should return the default notice if the one required does not exist'
677 t::lib::Mocks::mock_preference( 'TranslateNotices', '' );
679 $letter = C4::Letters::GetPreparedLetter(
682 letter_code => 'code',
683 message_transport_type => 'email',
684 substitute => $substitute,
687 is( $letter->{title}, 'a test',
688 'GetPreparedLetter should return the default notice if pref disabled but additional language exists' );
692 subtest 'SendQueuedMessages' => sub {
695 t::lib::Mocks::mock_preference( 'SMSSendDriver', 'Email' );
696 my $patron = Koha::Patrons->find($borrowernumber);
698 INSERT INTO message_queue(borrowernumber, subject, content, message_transport_type, status, letter_code)
699 VALUES (?, 'subject', 'content', 'sms', 'pending', 'just_a_code')
700 |, undef, $borrowernumber
702 eval { C4::Letters::SendQueuedMessages(); };
703 is( $@, '', 'SendQueuedMessages should not explode if the patron does not have a sms provider set' );
705 my $sms_pro = $builder->build_object({ class => 'Koha::SMS::Providers', value => { domain => 'kidclamp.rocks' } });
706 ModMember( borrowernumber => $borrowernumber, smsalertnumber => '5555555555', sms_provider_id => $sms_pro->id() );
707 $message_id = C4::Letters::EnqueueLetter($my_message); #using datas set around line 95 and forward
708 C4::Letters::SendQueuedMessages();
709 my $sms_message_address = $schema->resultset('MessageQueue')->search({
710 borrowernumber => $borrowernumber,
712 })->next()->to_address();
713 is( $sms_message_address, '5555555555@kidclamp.rocks', 'SendQueuedMessages populates the to address correctly for SMS by email when to_address not set' );
714 $schema->resultset('MessageQueue')->search({borrowernumber => $borrowernumber,status => 'sent'})->delete(); #clear borrower queue
715 $my_message->{to_address} = 'fixme@kidclamp.iswrong';
716 $message_id = C4::Letters::EnqueueLetter($my_message);
718 my $number_attempted = C4::Letters::SendQueuedMessages({
719 borrowernumber => -1, # -1 still triggers the borrowernumber condition
720 letter_code => 'PASSWORD_RESET',
722 is ( $number_attempted, 0, 'There were no password reset messages for SendQueuedMessages to attempt.' );
724 C4::Letters::SendQueuedMessages();
725 $sms_message_address = $schema->resultset('MessageQueue')->search({
726 borrowernumber => $borrowernumber,
728 })->next()->to_address();
729 is( $sms_message_address, '5555555555@kidclamp.rocks', 'SendQueuedMessages populates the to address correctly for SMS by email when to_address is set incorrectly' );
733 subtest 'get_item_content' => sub {
736 t::lib::Mocks::mock_preference('dateformat', 'metric');
737 t::lib::Mocks::mock_preference('timeformat', '24hr');
739 {date_due => '2041-01-01 12:34', title => 'a first title', barcode => 'a_first_barcode', author => 'a_first_author', itemnumber => 1 },
740 {date_due => '2042-01-02 23:45', title => 'a second title', barcode => 'a_second_barcode', author => 'a_second_author', itemnumber => 2 },
742 my @item_content_fields = qw( date_due title barcode author itemnumber );
745 for my $item ( @items ) {
746 $items_content .= C4::Letters::get_item_content( { item => $item, item_content_fields => \@item_content_fields } );
749 my $expected_items_content = <<EOF;
750 01/01/2041 12:34\ta first title\ta_first_barcode\ta_first_author\t1
751 02/01/2042 23:45\ta second title\ta_second_barcode\ta_second_author\t2
753 is( $items_content, $expected_items_content, 'get_item_content should return correct items info with time (default)' );
756 $items_content = q||;
757 for my $item ( @items ) {
758 $items_content .= C4::Letters::get_item_content( { item => $item, item_content_fields => \@item_content_fields, dateonly => 1, } );
761 $expected_items_content = <<EOF;
762 01/01/2041\ta first title\ta_first_barcode\ta_first_author\t1
763 02/01/2042\ta second title\ta_second_barcode\ta_second_author\t2
765 is( $items_content, $expected_items_content, 'get_item_content should return correct items info without time (if dateonly => 1)' );
768 subtest 'Test limit parameter for SendQueuedMessages' => sub {
771 my $dbh = C4::Context->dbh;
773 my $borrowernumber = AddMember(
776 categorycode => $patron_category,
777 branchcode => $library->{branchcode},
778 dateofbirth => $date,
779 smsalertnumber => undef,
782 $dbh->do(q|DELETE FROM message_queue|);
785 'content' => 'a message',
786 'metadata' => 'metadata',
787 'code' => 'TEST_MESSAGE',
788 'content_type' => 'text/plain',
789 'title' => 'message title'
791 'borrowernumber' => $borrowernumber,
792 'to_address' => undef,
793 'message_transport_type' => 'sms',
794 'from_address' => 'from@example.com'
796 C4::Letters::EnqueueLetter($my_message);
797 C4::Letters::EnqueueLetter($my_message);
798 C4::Letters::EnqueueLetter($my_message);
799 C4::Letters::EnqueueLetter($my_message);
800 C4::Letters::EnqueueLetter($my_message);
801 my $messages_processed = C4::Letters::SendQueuedMessages( { limit => 1 } );
802 is( $messages_processed, 1,
803 'Processed 1 message with limit of 1 and 5 unprocessed messages' );
804 $messages_processed = C4::Letters::SendQueuedMessages( { limit => 2 } );
805 is( $messages_processed, 2,
806 'Processed 2 message with limit of 2 and 4 unprocessed messages' );
807 $messages_processed = C4::Letters::SendQueuedMessages( { limit => 3 } );
808 is( $messages_processed, 2,
809 'Processed 2 message with limit of 3 and 2 unprocessed messages' );