6 use t::lib::TestBuilder;
11 use Test::More tests => 56;
20 use Koha::DateUtils qw( dt_from_string output_pref );
24 use lib $FindBin::Bin;
25 use_ok('C4::Reserves');
28 my $builder = t::lib::TestBuilder->new();
29 my $dbh = C4::Context->dbh;
32 $dbh->{AutoCommit} = 0;
33 $dbh->{RaiseError} = 1;
35 # Create two random branches
36 my $branch_1 = $builder->build({ source => 'Branch' })->{ branchcode };
37 my $branch_2 = $builder->build({ source => 'Branch' })->{ branchcode };
39 my $borrowers_count = 5;
41 $dbh->do('DELETE FROM itemtypes');
42 $dbh->do('DELETE FROM reserves');
43 my $insert_sth = $dbh->prepare('INSERT INTO itemtypes (itemtype) VALUES (?)');
44 $insert_sth->execute('CAN');
45 $insert_sth->execute('CANNOT');
46 $insert_sth->execute('DUMMY');
47 $insert_sth->execute('ONLY1');
49 # Setup Test------------------------
50 # Create a biblio instance for testing
51 my ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
53 # Create item instance for testing.
54 my ($item_bibnum, $item_bibitemnum, $itemnumber)
55 = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
57 # Create some borrowers
59 foreach (1..$borrowers_count) {
60 my $borrowernumber = AddMember(
61 firstname => 'my firstname',
62 surname => 'my surname ' . $_,
64 branchcode => $branch_1,
66 push @borrowernumbers, $borrowernumber;
69 my $biblionumber = $bibnum;
71 # Create five item level holds
72 foreach my $borrowernumber ( @borrowernumbers ) {
83 my $checkitem = $itemnumber,
88 my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
89 is( scalar(@$reserves), $borrowers_count, "Test GetReserves()" );
91 is( $reserves->[0]->{priority}, 1, "Reserve 1 has a priority of 1" );
92 is( $reserves->[1]->{priority}, 2, "Reserve 2 has a priority of 2" );
93 is( $reserves->[2]->{priority}, 3, "Reserve 3 has a priority of 3" );
94 is( $reserves->[3]->{priority}, 4, "Reserve 4 has a priority of 4" );
95 is( $reserves->[4]->{priority}, 5, "Reserve 5 has a priority of 5" );
97 my ( $reservedate, $borrowernumber, $branch_1code, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
98 is( $reservedate, output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 }), "GetReservesFromItemnumber should return a valid reserve date");
99 is( $borrowernumber, $borrowernumbers[0], "GetReservesFromItemnumber should return a valid borrowernumber");
100 is( $branch_1code, $branch_1, "GetReservesFromItemnumber should return a valid branchcode");
101 ok($reserve_id, "Test GetReservesFromItemnumber()");
103 my $hold = Koha::Holds->find( $reserve_id );
104 ok( $hold, "Koha::Holds found the hold" );
105 my $hold_biblio = $hold->biblio();
106 ok( $hold_biblio, "Got biblio using biblio() method" );
107 ok( $hold_biblio == $hold->biblio(), "biblio method returns stashed biblio" );
108 my $hold_item = $hold->item();
109 ok( $hold_item, "Got item using item() method" );
110 ok( $hold_item == $hold->item(), "item method returns stashed item" );
111 my $hold_branch = $hold->branch();
112 ok( $hold_branch, "Got branch using branch() method" );
113 ok( $hold_branch == $hold->branch(), "branch method returns stashed branch" );
114 my $hold_found = $hold->found();
115 $hold->set({ found => 'W'})->store();
116 is( Koha::Holds->waiting()->count(), 1, "Koha::Holds->waiting returns waiting holds" );
118 my ( $reserve ) = GetReservesFromBorrowernumber($borrowernumbers[0]);
119 ok( $reserve->{'borrowernumber'} eq $borrowernumbers[0], "Test GetReservesFromBorrowernumber()");
122 ok( GetReserveCount( $borrowernumbers[0] ), "Test GetReserveCount()" );
125 CancelReserve({ 'reserve_id' => $reserve_id });
126 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
127 is( scalar(@$reserves), $borrowers_count - 1, "Test CancelReserve()" );
130 ( $reservedate, $borrowernumber, $branch_1code, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
132 reserve_id => $reserve_id,
134 branchcode => $branch_1,
135 itemnumber => $itemnumber,
136 suspend_until => output_pref( { dt => dt_from_string( "2013-01-01", "iso" ), dateonly => 1 } ),
139 $reserve = GetReserve( $reserve_id );
140 ok( $reserve->{'priority'} eq '4', "Test GetReserve(), priority changed correctly" );
141 ok( $reserve->{'suspend'}, "Test GetReserve(), suspend hold" );
142 ok( $reserve->{'suspend_until'} eq '2013-01-01 00:00:00', "Test GetReserve(), suspend until date" );
144 ToggleSuspend( $reserve_id );
145 $reserve = GetReserve( $reserve_id );
146 ok( !$reserve->{'suspend'}, "Test ToggleSuspend(), no date" );
148 ToggleSuspend( $reserve_id, '2012-01-01' );
149 $reserve = GetReserve( $reserve_id );
150 ok( $reserve->{'suspend_until'} eq '2012-01-01 00:00:00', "Test ToggleSuspend(), with date" );
152 AutoUnsuspendReserves();
153 $reserve = GetReserve( $reserve_id );
154 ok( !$reserve->{'suspend'}, "Test AutoUnsuspendReserves()" );
156 # Add a new hold for the borrower whose hold we canceled earlier, this time at the bib level
170 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
171 my $reserveid = C4::Reserves::GetReserveId(
173 biblionumber => $biblionumber,
174 borrowernumber => $borrowernumber
177 is( $reserveid, $reserve->{reserve_id}, "Test GetReserveId" );
178 ModReserveMinusPriority( $itemnumber, $reserve->{'reserve_id'} );
179 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
180 ok( $reserve->{'itemnumber'} eq $itemnumber, "Test ModReserveMinusPriority()" );
183 my $reserve2 = GetReserveInfo( $reserve->{'reserve_id'} );
184 ok( $reserve->{'reserve_id'} eq $reserve2->{'reserve_id'}, "Test GetReserveInfo()" );
187 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
188 $reserve = $reserves->[1];
189 AlterPriority( 'top', $reserve->{'reserve_id'} );
190 $reserve = GetReserve( $reserve->{'reserve_id'} );
191 is( $reserve->{'priority'}, '1', "Test AlterPriority(), move to top" );
193 AlterPriority( 'down', $reserve->{'reserve_id'} );
194 $reserve = GetReserve( $reserve->{'reserve_id'} );
195 is( $reserve->{'priority'}, '2', "Test AlterPriority(), move down" );
197 AlterPriority( 'up', $reserve->{'reserve_id'} );
198 $reserve = GetReserve( $reserve->{'reserve_id'} );
199 is( $reserve->{'priority'}, '1', "Test AlterPriority(), move up" );
201 AlterPriority( 'bottom', $reserve->{'reserve_id'} );
202 $reserve = GetReserve( $reserve->{'reserve_id'} );
203 is( $reserve->{'priority'}, '5', "Test AlterPriority(), move to bottom" );
205 # Regression test for bug 2394
207 # If IndependentBranches is ON and canreservefromotherbranches is OFF,
208 # a patron is not permittedo to request an item whose homebranch (i.e.,
209 # owner of the item) is different from the patron's own library.
210 # However, if canreservefromotherbranches is turned ON, the patron can
211 # create such hold requests.
213 # Note that canreservefromotherbranches has no effect if
214 # IndependentBranches is OFF.
216 my ($foreign_bibnum, $foreign_title, $foreign_bibitemnum) = create_helper_biblio('DUMMY');
217 my ($foreign_item_bibnum, $foreign_item_bibitemnum, $foreign_itemnumber)
218 = AddItem({ homebranch => $branch_2, holdingbranch => $branch_2 } , $foreign_bibnum);
219 $dbh->do('DELETE FROM issuingrules');
221 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
222 VALUES (?, ?, ?, ?)},
227 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
228 VALUES (?, ?, ?, ?)},
230 '*', '*', 'CANNOT', 0
233 # make sure some basic sysprefs are set
234 t::lib::Mocks::mock_preference('ReservesControlBranch', 'ItemHomeLibrary');
235 t::lib::Mocks::mock_preference('item-level_itypes', 1);
237 # if IndependentBranches is OFF, a $branch_1 patron can reserve an $branch_2 item
238 t::lib::Mocks::mock_preference('IndependentBranches', 0);
240 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
241 '$branch_1 patron allowed to reserve $branch_2 item with IndependentBranches OFF (bug 2394)'
244 # if IndependentBranches is OFF, a $branch_1 patron cannot reserve an $branch_2 item
245 t::lib::Mocks::mock_preference('IndependentBranches', 1);
246 t::lib::Mocks::mock_preference('canreservefromotherbranches', 0);
248 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'cannotReserveFromOtherBranches',
249 '$branch_1 patron NOT allowed to reserve $branch_2 item with IndependentBranches ON ... (bug 2394)'
252 # ... unless canreservefromotherbranches is ON
253 t::lib::Mocks::mock_preference('canreservefromotherbranches', 1);
255 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
256 '... unless canreservefromotherbranches is ON (bug 2394)'
259 # Regression test for bug 11336
260 ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
261 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
270 my $reserveid1 = C4::Reserves::GetReserveId(
272 biblionumber => $bibnum,
273 borrowernumber => $borrowernumbers[0]
277 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
285 my $reserveid2 = C4::Reserves::GetReserveId(
287 biblionumber => $bibnum,
288 borrowernumber => $borrowernumbers[1]
292 CancelReserve({ reserve_id => $reserveid1 });
294 $reserve2 = GetReserve( $reserveid2 );
295 is( $reserve2->{priority}, 1, "After cancelreserve, the 2nd reserve becomes the first on the waiting list" );
297 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
305 my $reserveid3 = C4::Reserves::GetReserveId(
307 biblionumber => $bibnum,
308 borrowernumber => $borrowernumbers[0]
312 my $reserve3 = GetReserve( $reserveid3 );
313 is( $reserve3->{priority}, 2, "New reserve for patron 0, the reserve has a priority = 2" );
315 ModReserve({ reserve_id => $reserveid2, rank => 'del' });
316 $reserve3 = GetReserve( $reserveid3 );
317 is( $reserve3->{priority}, 1, "After ModReserve, the 3rd reserve becomes the first on the waiting list" );
319 ModItem({ damaged => 1 }, $item_bibnum, $itemnumber);
320 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 1 );
321 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK', "Patron can reserve damaged item with AllowHoldsOnDamagedItems enabled" );
322 ok( defined( ( CheckReserves($itemnumber) )[1] ), "Hold can be trapped for damaged item with AllowHoldsOnDamagedItems enabled" );
323 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 0 );
324 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'damaged', "Patron cannot reserve damaged item with AllowHoldsOnDamagedItems disabled" );
325 ok( !defined( ( CheckReserves($itemnumber) )[1] ), "Hold cannot be trapped for damaged item with AllowHoldsOnDamagedItems disabled" );
327 # Regression test for bug 9532
328 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
329 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
338 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
339 "cannot request item if policy that matches on item-level item type forbids it"
341 ModItem({ itype => 'CAN' }, $item_bibnum, $itemnumber);
343 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK',
344 "can request item if policy that matches on item type allows it"
347 t::lib::Mocks::mock_preference('item-level_itypes', 0);
348 ModItem({ itype => undef }, $item_bibnum, $itemnumber);
350 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
351 "cannot request item if policy that matches on bib-level item type forbids it (bug 9532)"
355 # Test branch item rules
357 $dbh->do('DELETE FROM issuingrules');
359 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
360 VALUES (?, ?, ?, ?)},
364 $dbh->do('DELETE FROM branch_item_rules');
365 $dbh->do('DELETE FROM default_branch_circ_rules');
366 $dbh->do('DELETE FROM default_branch_item_rules');
367 $dbh->do('DELETE FROM default_circ_rules');
369 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
371 }, {}, $branch_1, 'CANNOT', 0, 'homebranch');
373 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
375 }, {}, $branch_1, 'CAN', 1, 'homebranch');
376 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
377 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
378 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
379 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'notReservable',
380 "CanItemBeReserved should returns 'notReservable'");
382 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
383 { homebranch => $branch_2, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
384 is(CanItemBeReserved($borrowernumbers[0], $itemnumber),
385 'cannotReserveFromOtherBranches',
386 "CanItemBeReserved should returns 'cannotReserveFromOtherBranches'");
388 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
389 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
390 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'OK',
391 "CanItemBeReserved should returns 'OK'");
394 # Test CancelExpiredReserves
395 C4::Context->set_preference('ExpireReservesMaxPickUpDelay', 1);
396 C4::Context->set_preference('ReservesMaxPickUpDelay', 1);
398 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime(time);
401 $reserves = $dbh->selectall_arrayref('SELECT * FROM reserves', { Slice => {} });
402 $reserve = $reserves->[0];
403 my $calendar = C4::Calendar->new(branchcode => $reserve->{branchcode});
404 $calendar->insert_single_holiday(
409 description => 'Test',
411 $reserve_id = $reserve->{reserve_id};
412 $dbh->do("UPDATE reserves SET waitingdate = DATE_SUB( NOW(), INTERVAL 5 DAY ), found = 'W', priority = 0 WHERE reserve_id = ?", undef, $reserve_id );
413 C4::Context->set_preference('ExpireReservesOnHolidays', 0);
414 CancelExpiredReserves();
415 my $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
416 is( $count, 1, "Waiting reserve beyond max pickup delay *not* canceled on holiday" );
417 C4::Context->set_preference('ExpireReservesOnHolidays', 1);
418 CancelExpiredReserves();
419 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
420 is( $count, 0, "Waiting reserve beyond max pickup delay canceled on holiday" );
422 # Test expirationdate
423 $reserve = $reserves->[1];
424 $reserve_id = $reserve->{reserve_id};
425 $dbh->do("UPDATE reserves SET expirationdate = DATE_SUB( NOW(), INTERVAL 1 DAY ) WHERE reserve_id = ?", undef, $reserve_id );
426 CancelExpiredReserves();
427 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
428 is( $count, 0, "Reserve with manual expiration date canceled correctly" );
431 t::lib::Mocks::mock_preference( 'item-level_itypes', 1 );
432 t::lib::Mocks::mock_preference( 'ReservesControlBranch', 'PatronLibrary' );
434 $dbh->do('DELETE FROM reserves');
435 $dbh->do('DELETE FROM issues');
436 $dbh->do('DELETE FROM items');
437 $dbh->do('DELETE FROM biblio');
439 ( $bibnum, $title, $bibitemnum ) = create_helper_biblio('ONLY1');
440 ( $item_bibnum, $item_bibitemnum, $itemnumber )
441 = AddItem( { homebranch => $branch_1, holdingbranch => $branch_1 }, $bibnum );
444 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
445 VALUES (?, ?, ?, ?)},
449 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber ),
450 'OK', 'Patron can reserve item with hold limit of 1, no holds placed' );
452 my $res_id = AddReserve( $branch_1, $borrowernumbers[0], $bibnum, '', 1, );
454 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber ),
455 'tooManyReserves', 'Patron cannot reserve item with hold limit of 1, 1 bib level hold placed' );
458 # Helper method to set up a Biblio.
459 sub create_helper_biblio {
460 my $itemtype = shift;
461 my $bib = MARC::Record->new();
462 my $title = 'Silence in the library';
464 MARC::Field->new('100', ' ', ' ', a => 'Moffat, Steven'),
465 MARC::Field->new('245', ' ', ' ', a => $title),
466 MARC::Field->new('942', ' ', ' ', c => $itemtype),
468 return ($bibnum, $title, $bibitemnum) = AddBiblio($bib, '');