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 => 58;
28 my $module = new Test::MockModule('Mail::Sendmail');
37 use_ok('C4::Context');
38 use_ok('C4::Members');
40 use_ok('C4::Acquisition');
42 use_ok('C4::Bookseller');
43 use_ok('C4::Letters');
45 use Koha::DateUtils qw( dt_from_string output_pref );
47 my $dbh = C4::Context->dbh;
50 $dbh->{AutoCommit} = 0;
51 $dbh->{RaiseError} = 1;
53 $dbh->do(q|DELETE FROM letter|);
54 $dbh->do(q|DELETE FROM message_queue|);
55 $dbh->do(q|DELETE FROM message_transport_types|);
57 my $date = dt_from_string;
58 my $borrowernumber = AddMember(
66 my $marc_record = MARC::Record->new;
67 my( $biblionumber, $biblioitemnumber ) = AddBiblio( $marc_record, '' );
69 # GetMessageTransportTypes
70 my $mtts = C4::Letters::GetMessageTransportTypes();
71 is( @$mtts, 0, 'GetMessageTransportTypes returns the correct number of message types' );
74 INSERT INTO message_transport_types( message_transport_type ) VALUES ('email'), ('phone'), ('print'), ('sms')
76 $mtts = C4::Letters::GetMessageTransportTypes();
77 is_deeply( $mtts, ['email', 'phone', 'print', 'sms'], 'GetMessageTransportTypes returns all values' );
81 is( C4::Letters::EnqueueLetter(), undef, 'EnqueueLetter without argument returns undef' );
84 borrowernumber => $borrowernumber,
85 message_transport_type => 'sms',
86 to_address => 'to@example.com',
87 from_address => 'from@example.com',
89 my $message_id = C4::Letters::EnqueueLetter($my_message);
90 is( $message_id, undef, 'EnqueueLetter without the letter argument returns undef' );
92 delete $my_message->{message_transport_type};
93 $my_message->{letter} = {
94 content => 'a message',
95 title => 'message title',
96 metadata => 'metadata',
97 code => 'TEST_MESSAGE',
98 content_type => 'text/plain',
100 $message_id = C4::Letters::EnqueueLetter($my_message);
101 is( $message_id, undef, 'EnqueueLetter without the message type argument argument returns undef' );
103 $my_message->{message_transport_type} = 'sms';
104 $message_id = C4::Letters::EnqueueLetter($my_message);
105 ok(defined $message_id && $message_id > 0, 'new message successfully queued');
109 my $messages = C4::Letters::GetQueuedMessages();
110 is( @$messages, 1, 'GetQueuedMessages without argument returns all the entries' );
112 $messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber });
113 is( @$messages, 1, 'one message stored for the borrower' );
114 is( $messages->[0]->{message_id}, $message_id, 'EnqueueLetter returns the message id correctly' );
115 is( $messages->[0]->{borrowernumber}, $borrowernumber, 'EnqueueLetter stores the borrower number correctly' );
116 is( $messages->[0]->{subject}, $my_message->{letter}->{title}, 'EnqueueLetter stores the subject correctly' );
117 is( $messages->[0]->{content}, $my_message->{letter}->{content}, 'EnqueueLetter stores the content correctly' );
118 is( $messages->[0]->{message_transport_type}, $my_message->{message_transport_type}, 'EnqueueLetter stores the message type correctly' );
119 is( $messages->[0]->{status}, 'pending', 'EnqueueLetter stores the status pending correctly' );
123 my $messages_processed = C4::Letters::SendQueuedMessages();
124 is($messages_processed, 1, 'all queued messages processed');
126 $messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber });
128 $messages->[0]->{status},
130 'message marked failed if tried to send SMS message for borrower with no smsalertnumber set (bug 11208)'
134 my $letters = C4::Letters::GetLetters();
135 is( @$letters, 0, 'GetLetters returns the correct number of letters' );
137 my $title = q|<<branches.branchname>> - <<status>>|;
138 my $content = q|Dear <<borrowers.firstname>> <<borrowers.surname>>,
139 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.
141 <<branches.branchname>>
142 <<branches.branchaddress1>>
145 The following item(s) is/are currently <<status>>:
147 <item> <<count>>. <<items.itemcallnumber>>, Barcode: <<items.barcode>> </item>
149 Thank-you for your prompt attention to this matter.
150 Don't forget your date of birth: <<borrowers.dateofbirth>>.
151 Look at this wonderful biblio timestamp: <<biblio.timestamp>>.
154 $dbh->do( q|INSERT INTO letter(branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES ('CPL','my module','my code','my name',1,?,?,'email')|, undef, $title, $content );
155 $letters = C4::Letters::GetLetters();
156 is( @$letters, 1, 'GetLetters returns the correct number of letters' );
157 is( $letters->[0]->{branchcode}, 'CPL', 'GetLetters gets the branch code correctly' );
158 is( $letters->[0]->{module}, 'my module', 'GetLetters gets the module correctly' );
159 is( $letters->[0]->{code}, 'my code', 'GetLetters gets the code correctly' );
160 is( $letters->[0]->{name}, 'my name', 'GetLetters gets the name correctly' );
164 my $letter = C4::Letters::getletter('my module', 'my code', 'CPL', 'email');
165 is( $letter->{branchcode}, 'CPL', 'GetLetters gets the branch code correctly' );
166 is( $letter->{module}, 'my module', 'GetLetters gets the module correctly' );
167 is( $letter->{code}, 'my code', 'GetLetters gets the code correctly' );
168 is( $letter->{name}, 'my name', 'GetLetters gets the name correctly' );
169 is( $letter->{is_html}, 1, 'GetLetters gets the boolean is_html correctly' );
170 is( $letter->{title}, $title, 'GetLetters gets the title correctly' );
171 is( $letter->{content}, $content, 'GetLetters gets the content correctly' );
172 is( $letter->{message_transport_type}, 'email', 'GetLetters gets the message type correctly' );
176 my $type = 'my type';
177 my $externalid = 'my external id';
178 my $alert_id = C4::Letters::addalert($borrowernumber, $type, $externalid);
179 isnt( $alert_id, undef, 'addalert does not return undef' );
181 my $alerts = C4::Letters::getalert($borrowernumber);
182 is( @$alerts, 1, 'addalert adds an alert' );
183 is( $alerts->[0]->{alertid}, $alert_id, 'addalert returns the alert id correctly' );
184 is( $alerts->[0]->{type}, $type, 'addalert stores the type correctly' );
185 is( $alerts->[0]->{externalid}, $externalid, 'addalert stores the externalid correctly' );
189 $alerts = C4::Letters::getalert($borrowernumber, $type);
190 is( @$alerts, 1, 'getalert returns the correct number of alerts' );
191 $alerts = C4::Letters::getalert($borrowernumber, $type, $externalid);
192 is( @$alerts, 1, 'getalert returns the correct number of alerts' );
193 $alerts = C4::Letters::getalert($borrowernumber, 'another type');
194 is( @$alerts, 0, 'getalert returns the correct number of alerts' );
195 $alerts = C4::Letters::getalert($borrowernumber, $type, 'another external id');
196 is( @$alerts, 0, 'getalert returns the correct number of alerts' );
201 C4::Letters::delalert();
203 isnt( $@, undef, 'delalert without argument returns an error' );
204 $alerts = C4::Letters::getalert($borrowernumber);
205 is( @$alerts, 1, 'delalert without argument does not remove an alert' );
207 C4::Letters::delalert($alert_id);
208 $alerts = C4::Letters::getalert($borrowernumber);
209 is( @$alerts, 0, 'delalert removes an alert' );
213 t::lib::Mocks::mock_preference('OPACBaseURL', 'http://thisisatest.com');
215 my $sms_content = 'This is a SMS for an <<status>>';
216 $dbh->do( q|INSERT INTO letter(branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES ('CPL','my module','my code','my name',1,'my title',?,'sms')|, undef, $sms_content );
219 borrowers => $borrowernumber,
221 biblio => $biblionumber,
228 itemcallnumber => 'my callnumber1',
232 itemcallnumber => 'my callnumber2',
236 my $prepared_letter = GetPreparedLetter((
237 module => 'my module',
239 letter_code => 'my code',
241 substitute => $substitute,
244 my $branch = GetBranchDetail('CPL');
245 my $my_title_letter = qq|$branch->{branchname} - $substitute->{status}|;
246 my $my_content_letter = qq|Dear Jane Smith,
247 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.
249 $branch->{branchname}
250 $branch->{branchaddress1}
251 URL: http://thisisatest.com
253 The following item(s) is/are currently $substitute->{status}:
255 <item> 1. $repeat->[0]->{itemcallnumber}, Barcode: $repeat->[0]->{barcode} </item>
256 <item> 2. $repeat->[1]->{itemcallnumber}, Barcode: $repeat->[1]->{barcode} </item>
258 Thank-you for your prompt attention to this matter.
259 Don't forget your date of birth: | . output_pref({ dt => $date, dateonly => 1 }) . q|.
260 Look at this wonderful biblio timestamp: | . output_pref({ dt => $date }) . ".\n";
261 is( $prepared_letter->{title}, $my_title_letter, 'GetPreparedLetter returns the title correctly' );
262 is( $prepared_letter->{content}, $my_content_letter, 'GetPreparedLetter returns the content correctly' );
264 $prepared_letter = GetPreparedLetter((
265 module => 'my module',
267 letter_code => 'my code',
269 substitute => $substitute,
271 message_transport_type => 'sms',
273 $my_content_letter = qq|This is a SMS for an $substitute->{status}|;
274 is( $prepared_letter->{content}, $my_content_letter, 'GetPreparedLetter returns the content correctly' );
276 $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>');});
278 my $booksellerid = C4::Bookseller::AddBookseller(
281 address1 => "bookseller's address",
287 { name => 'John Smith', phone => '0123456x1', claimacquisition => 1 },
288 { name => 'Leo Tolstoy', phone => '0123456x2', claimissues => 1 },
291 my $basketno = NewBasket($booksellerid, 1);
293 my $budgetid = C4::Budgets::AddBudget({
294 budget_code => "budget_code_test_letters",
295 budget_name => "budget_name_test_letters",
299 my $bib = MARC::Record->new();
300 if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
302 MARC::Field->new('200', ' ', ' ', a => 'Silence in the library'),
306 MARC::Field->new('245', ' ', ' ', a => 'Silence in the library'),
310 ($biblionumber, $biblioitemnumber) = AddBiblio($bib, '');
311 ( undef, $ordernumber ) = C4::Acquisition::NewOrder(
313 basketno => $basketno,
315 biblionumber => $biblionumber,
316 budget_id => $budgetid,
320 C4::Acquisition::CloseBasket( $basketno );
323 $err = SendAlerts( 'claimacquisition', [ $ordernumber ], 'TESTACQCLAIM' ) }
324 qr/^Bookseller .* without emails at/,
325 "SendAlerts prints a warning";
326 is($err->{'error'}, 'no_email', "Trying to send an alert when there's no e-mail results in an error");
328 my $bookseller = C4::Bookseller::GetBookSellerFromId($booksellerid);
329 $bookseller->{'contacts'}->[0]->email('testemail@mydomain.com');
330 C4::Bookseller::ModBookseller($bookseller);
331 $bookseller = C4::Bookseller::GetBookSellerFromId($booksellerid);
334 $err = SendAlerts( 'claimacquisition', [ $ordernumber ], 'TESTACQCLAIM' ) }
336 "SendAlerts is using the mocked sendmail routine";
338 is($err, 1, "Successfully sent claim");
339 is($mail{'To'}, 'testemail@mydomain.com', "mailto correct in sent claim");
340 is($mail{'Message'}, 'my vendor|John Smith|<order>Ordernumber ' . $ordernumber . ' (Silence in the library) (1 ordered)</order>', 'Claim notice text constructed successfully');