6 use t::lib::TestBuilder;
10 use Test::More tests => 56;
17 use Koha::DateUtils qw( dt_from_string output_pref );
24 use lib $FindBin::Bin;
25 use_ok('C4::Reserves');
28 my $schema = Koha::Database->new->schema;
29 $schema->storage->txn_begin;
31 my $builder = t::lib::TestBuilder->new();
32 my $dbh = C4::Context->dbh;
34 # Create two random branches
35 my $branch_1 = $builder->build({ source => 'Branch' })->{ branchcode };
36 my $branch_2 = $builder->build({ source => 'Branch' })->{ branchcode };
38 my $category = $builder->build({ source => 'Category' });
40 my $borrowers_count = 5;
42 $dbh->do('DELETE FROM itemtypes');
43 $dbh->do('DELETE FROM reserves');
44 my $insert_sth = $dbh->prepare('INSERT INTO itemtypes (itemtype) VALUES (?)');
45 $insert_sth->execute('CAN');
46 $insert_sth->execute('CANNOT');
47 $insert_sth->execute('DUMMY');
48 $insert_sth->execute('ONLY1');
50 # Setup Test------------------------
51 # Create a biblio instance for testing
52 my ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
54 # Create item instance for testing.
55 my ($item_bibnum, $item_bibitemnum, $itemnumber)
56 = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
58 # Create some borrowers
60 foreach (1..$borrowers_count) {
61 my $borrowernumber = AddMember(
62 firstname => 'my firstname',
63 surname => 'my surname ' . $_,
64 categorycode => $category->{categorycode},
65 branchcode => $branch_1,
67 push @borrowernumbers, $borrowernumber;
70 my $biblionumber = $bibnum;
72 # Create five item level holds
73 foreach my $borrowernumber ( @borrowernumbers ) {
79 my $priority = C4::Reserves::CalculatePriority( $biblionumber ),
84 my $checkitem = $itemnumber,
89 my $biblio = Koha::Biblios->find( $biblionumber );
90 my $holds = $biblio->holds;
91 is( $holds->count, $borrowers_count, 'Test GetReserves()' );
92 is( $holds->next->priority, 1, "Reserve 1 has a priority of 1" );
93 is( $holds->next->priority, 2, "Reserve 2 has a priority of 2" );
94 is( $holds->next->priority, 3, "Reserve 3 has a priority of 3" );
95 is( $holds->next->priority, 4, "Reserve 4 has a priority of 4" );
96 is( $holds->next->priority, 5, "Reserve 5 has a priority of 5" );
98 my $item = Koha::Items->find( $itemnumber );
99 $holds = $item->current_holds;
100 my $first_hold = $holds->next;
101 my $reservedate = $first_hold->reservedate;
102 my $borrowernumber = $first_hold->borrowernumber;
103 my $branch_1code = $first_hold->branchcode;
104 my $reserve_id = $first_hold->reserve_id;
105 is( $reservedate, output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 }), "holds_placed_today should return a valid reserve date");
106 is( $borrowernumber, $borrowernumbers[0], "holds_placed_today should return a valid borrowernumber");
107 is( $branch_1code, $branch_1, "holds_placed_today should return a valid branchcode");
108 ok($reserve_id, "Test holds_placed_today()");
110 my $hold = Koha::Holds->find( $reserve_id );
111 ok( $hold, "Koha::Holds found the hold" );
112 my $hold_biblio = $hold->biblio();
113 ok( $hold_biblio, "Got biblio using biblio() method" );
114 ok( $hold_biblio == $hold->biblio(), "biblio method returns stashed biblio" );
115 my $hold_item = $hold->item();
116 ok( $hold_item, "Got item using item() method" );
117 ok( $hold_item == $hold->item(), "item method returns stashed item" );
118 my $hold_branch = $hold->branch();
119 ok( $hold_branch, "Got branch using branch() method" );
120 ok( $hold_branch == $hold->branch(), "branch method returns stashed branch" );
121 my $hold_found = $hold->found();
122 $hold->set({ found => 'W'})->store();
123 is( Koha::Holds->waiting()->count(), 1, "Koha::Holds->waiting returns waiting holds" );
125 my $patron = Koha::Patrons->find( $borrowernumbers[0] );
126 $holds = $patron->holds;
127 is( $holds->next->borrowernumber, $borrowernumbers[0], "Test Koha::Patron->holds");
130 CancelReserve({ 'reserve_id' => $reserve_id });
131 $holds = $biblio->holds;
132 is( $holds->count, $borrowers_count - 1, "Test CancelReserve()" );
134 $holds = $item->current_holds;
135 $first_hold = $holds->next;
136 $borrowernumber = $first_hold->borrowernumber;
137 $branch_1code = $first_hold->branchcode;
138 $reserve_id = $first_hold->reserve_id;
141 reserve_id => $reserve_id,
143 branchcode => $branch_1,
144 itemnumber => $itemnumber,
145 suspend_until => output_pref( { dt => dt_from_string( "2013-01-01", "iso" ), dateonly => 1 } ),
148 $hold = Koha::Holds->find( $reserve_id );
149 ok( $hold->priority eq '4', "Test ModReserve, priority changed correctly" );
150 ok( $hold->suspend, "Test ModReserve, suspend hold" );
151 is( $hold->suspend_until, '2013-01-01 00:00:00', "Test ModReserve, suspend until date" );
153 ToggleSuspend( $reserve_id );
154 $hold = Koha::Holds->find( $reserve_id );
155 ok( ! $hold->suspend, "Test ToggleSuspend(), no date" );
157 ToggleSuspend( $reserve_id, '2012-01-01' );
158 $hold = Koha::Holds->find( $reserve_id );
159 is( $hold->suspend_until, '2012-01-01 00:00:00', "Test ToggleSuspend(), with date" );
161 AutoUnsuspendReserves();
162 $hold = Koha::Holds->find( $reserve_id );
163 ok( ! $hold->suspend, "Test AutoUnsuspendReserves()" );
166 borrowernumber => $borrowernumber,
167 biblionumber => $biblionumber,
169 suspend_until => '2012-01-01',
171 $hold = Koha::Holds->find( $reserve_id );
172 is( $hold->suspend, 1, "Test SuspendAll()" );
173 is( $hold->suspend_until, '2012-01-01 00:00:00', "Test SuspendAll(), with date" );
176 borrowernumber => $borrowernumber,
177 biblionumber => $biblionumber,
180 $hold = Koha::Holds->find( $reserve_id );
181 is( $hold->suspend, 0, "Test resuming with SuspendAll()" );
182 is( $hold->suspend_until, undef, "Test resuming with SuspendAll(), should have no suspend until date" );
184 # Add a new hold for the borrower whose hold we canceled earlier, this time at the bib level
198 $patron = Koha::Patrons->find( $borrowernumber );
199 $holds = $patron->holds;
200 my $reserveid = C4::Reserves::GetReserveId(
202 biblionumber => $biblionumber,
203 borrowernumber => $borrowernumber
206 is( $reserveid, $holds->next->reserve_id, "Test GetReserveId" );
207 ModReserveMinusPriority( $itemnumber, $reserveid );
208 $holds = $patron->holds;
209 is( $holds->next->itemnumber, $itemnumber, "Test ModReserveMinusPriority()" );
211 $holds = $biblio->holds;
212 $hold = $holds->next;
213 AlterPriority( 'top', $hold->reserve_id );
214 $hold = Koha::Holds->find( $reserveid );
215 is( $hold->priority, '1', "Test AlterPriority(), move to top" );
217 AlterPriority( 'down', $hold->reserve_id );
218 $hold = Koha::Holds->find( $reserveid );
219 is( $hold->priority, '2', "Test AlterPriority(), move down" );
221 AlterPriority( 'up', $hold->reserve_id );
222 $hold = Koha::Holds->find( $reserveid );
223 is( $hold->priority, '1', "Test AlterPriority(), move up" );
225 AlterPriority( 'bottom', $hold->reserve_id );
226 $hold = Koha::Holds->find( $reserveid );
227 is( $hold->priority, '5', "Test AlterPriority(), move to bottom" );
229 # Regression test for bug 2394
231 # If IndependentBranches is ON and canreservefromotherbranches is OFF,
232 # a patron is not permittedo to request an item whose homebranch (i.e.,
233 # owner of the item) is different from the patron's own library.
234 # However, if canreservefromotherbranches is turned ON, the patron can
235 # create such hold requests.
237 # Note that canreservefromotherbranches has no effect if
238 # IndependentBranches is OFF.
240 my ($foreign_bibnum, $foreign_title, $foreign_bibitemnum) = create_helper_biblio('DUMMY');
241 my ($foreign_item_bibnum, $foreign_item_bibitemnum, $foreign_itemnumber)
242 = AddItem({ homebranch => $branch_2, holdingbranch => $branch_2 } , $foreign_bibnum);
243 $dbh->do('DELETE FROM issuingrules');
245 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed, holds_per_record)
246 VALUES (?, ?, ?, ?, ?)},
248 '*', '*', '*', 25, 99
251 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed, holds_per_record)
252 VALUES (?, ?, ?, ?, ?)},
254 '*', '*', 'CANNOT', 0, 99
257 # make sure some basic sysprefs are set
258 t::lib::Mocks::mock_preference('ReservesControlBranch', 'ItemHomeLibrary');
259 t::lib::Mocks::mock_preference('item-level_itypes', 1);
261 # if IndependentBranches is OFF, a $branch_1 patron can reserve an $branch_2 item
262 t::lib::Mocks::mock_preference('IndependentBranches', 0);
264 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
265 '$branch_1 patron allowed to reserve $branch_2 item with IndependentBranches OFF (bug 2394)'
268 # if IndependentBranches is OFF, a $branch_1 patron cannot reserve an $branch_2 item
269 t::lib::Mocks::mock_preference('IndependentBranches', 1);
270 t::lib::Mocks::mock_preference('canreservefromotherbranches', 0);
272 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'cannotReserveFromOtherBranches',
273 '$branch_1 patron NOT allowed to reserve $branch_2 item with IndependentBranches ON ... (bug 2394)'
276 # ... unless canreservefromotherbranches is ON
277 t::lib::Mocks::mock_preference('canreservefromotherbranches', 1);
279 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
280 '... unless canreservefromotherbranches is ON (bug 2394)'
283 # Regression test for bug 11336
284 ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
285 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
294 my $reserveid1 = C4::Reserves::GetReserveId(
296 biblionumber => $bibnum,
297 borrowernumber => $borrowernumbers[0]
301 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
309 my $reserveid2 = C4::Reserves::GetReserveId(
311 biblionumber => $bibnum,
312 borrowernumber => $borrowernumbers[1]
316 CancelReserve({ reserve_id => $reserveid1 });
318 my $hold2 = Koha::Holds->find( $reserveid2 );
319 is( $hold2->priority, 1, "After cancelreserve, the 2nd reserve becomes the first on the waiting list" );
321 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
329 my $reserveid3 = C4::Reserves::GetReserveId(
331 biblionumber => $bibnum,
332 borrowernumber => $borrowernumbers[0]
336 my $hold3 = Koha::Holds->find( $reserveid3 );
337 is( $hold3->priority, 2, "New reserve for patron 0, the reserve has a priority = 2" );
339 ModReserve({ reserve_id => $reserveid2, rank => 'del' });
340 $hold3 = Koha::Holds->find( $reserveid3 );
341 is( $hold3->priority, 1, "After ModReserve, the 3rd reserve becomes the first on the waiting list" );
343 ModItem({ damaged => 1 }, $item_bibnum, $itemnumber);
344 t::lib::Mocks::mock_preference( 'AllowHoldsOnDamagedItems', 1 );
345 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber), 'OK', "Patron can reserve damaged item with AllowHoldsOnDamagedItems enabled" );
346 ok( defined( ( CheckReserves($itemnumber) )[1] ), "Hold can be trapped for damaged item with AllowHoldsOnDamagedItems enabled" );
348 $hold = Koha::Hold->new(
350 borrowernumber => $borrowernumbers[0],
351 itemnumber => $itemnumber,
352 biblionumber => $item_bibnum,
355 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber ),
357 "Patron cannot place a second item level hold for a given item" );
360 t::lib::Mocks::mock_preference( 'AllowHoldsOnDamagedItems', 0 );
361 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'damaged', "Patron cannot reserve damaged item with AllowHoldsOnDamagedItems disabled" );
362 ok( !defined( ( CheckReserves($itemnumber) )[1] ), "Hold cannot be trapped for damaged item with AllowHoldsOnDamagedItems disabled" );
364 # Regression test for bug 9532
365 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
366 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
375 CanItemBeReserved( $borrowernumbers[0], $itemnumber), 'tooManyReserves',
376 "cannot request item if policy that matches on item-level item type forbids it"
378 ModItem({ itype => 'CAN' }, $item_bibnum, $itemnumber);
380 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK',
381 "can request item if policy that matches on item type allows it"
384 t::lib::Mocks::mock_preference('item-level_itypes', 0);
385 ModItem({ itype => undef }, $item_bibnum, $itemnumber);
387 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
388 "cannot request item if policy that matches on bib-level item type forbids it (bug 9532)"
392 # Test branch item rules
394 $dbh->do('DELETE FROM issuingrules');
396 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
397 VALUES (?, ?, ?, ?)},
401 $dbh->do('DELETE FROM branch_item_rules');
402 $dbh->do('DELETE FROM default_branch_circ_rules');
403 $dbh->do('DELETE FROM default_branch_item_rules');
404 $dbh->do('DELETE FROM default_circ_rules');
406 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
408 }, {}, $branch_1, 'CANNOT', 0, 'homebranch');
410 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
412 }, {}, $branch_1, 'CAN', 1, 'homebranch');
413 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
414 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
415 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
416 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'notReservable',
417 "CanItemBeReserved should returns 'notReservable'");
419 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
420 { homebranch => $branch_2, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
421 is(CanItemBeReserved($borrowernumbers[0], $itemnumber),
422 'cannotReserveFromOtherBranches',
423 "CanItemBeReserved should returns 'cannotReserveFromOtherBranches'");
425 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
426 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
427 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'OK',
428 "CanItemBeReserved should returns 'OK'");
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, holds_per_record)
445 VALUES (?, ?, ?, ?, ?)},
447 '*', '*', 'ONLY1', 1, 99
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, '');