Bug 13687: Move hold policy check into CanItemBeReserved
[koha.git] / t / db_dependent / Holds.t
1 #!/usr/bin/perl
2
3 use Modern::Perl;
4
5 use t::lib::Mocks;
6 use C4::Context;
7 use C4::Branch;
8
9 use Test::More tests => 41;
10 use MARC::Record;
11 use C4::Biblio;
12 use C4::Items;
13 use C4::Members;
14 use C4::Calendar;
15
16 use Koha::DateUtils qw( dt_from_string output_pref );
17
18 BEGIN {
19     use FindBin;
20     use lib $FindBin::Bin;
21     use_ok('C4::Reserves');
22 }
23
24 my $dbh = C4::Context->dbh;
25
26 # Start transaction
27 $dbh->{AutoCommit} = 0;
28 $dbh->{RaiseError} = 1;
29
30 my $borrowers_count = 5;
31
32 $dbh->do('DELETE FROM itemtypes');
33 my $insert_sth = $dbh->prepare('INSERT INTO itemtypes (itemtype) VALUES (?)');
34 $insert_sth->execute('CAN');
35 $insert_sth->execute('CANNOT');
36 $insert_sth->execute('DUMMY');
37
38 # Setup Test------------------------
39 # Create a biblio instance for testing
40 my ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
41
42 # Create item instance for testing.
43 my ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
44
45 # Create some borrowers
46 my @borrowernumbers;
47 foreach (1..$borrowers_count) {
48     my $borrowernumber = AddMember(
49         firstname =>  'my firstname',
50         surname => 'my surname ' . $_,
51         categorycode => 'S',
52         branchcode => 'CPL',
53     );
54     push @borrowernumbers, $borrowernumber;
55 }
56
57 my $biblionumber   = $bibnum;
58
59 my @branches = GetBranchesLoop();
60 my $branch = $branches[0][0]{value};
61
62 # Create five item level holds
63 foreach my $borrowernumber ( @borrowernumbers ) {
64     AddReserve(
65         $branch,
66         $borrowernumber,
67         $biblionumber,
68         my $constraint = 'a',
69         my $bibitems = q{},
70         my $priority,
71         my $resdate,
72         my $expdate,
73         my $notes = q{},
74         $title,
75         my $checkitem = $itemnumber,
76         my $found,
77     );
78 }
79
80
81 my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
82 is( scalar(@$reserves), $borrowers_count, "Test GetReserves()" );
83
84
85 my ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
86 is( $reservedate, output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 }), "GetReservesFromItemnumber should return a valid reserve date");
87 is( $borrowernumber, $borrowernumbers[0], "GetReservesFromItemnumber should return a valid borrowernumber");
88 is( $branchcode, 'CPL', "GetReservesFromItemnumber should return a valid branchcode");
89 ok($reserve_id, "Test GetReservesFromItemnumber()");
90
91
92 my ( $reserve ) = GetReservesFromBorrowernumber($borrowernumbers[0]);
93 ok( $reserve->{'borrowernumber'} eq $borrowernumbers[0], "Test GetReservesFromBorrowernumber()");
94
95
96 ok( GetReserveCount( $borrowernumbers[0] ), "Test GetReserveCount()" );
97
98
99 CancelReserve({ 'reserve_id' => $reserve_id });
100 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
101 is( scalar(@$reserves), $borrowers_count - 1, "Test CancelReserve()" );
102
103
104 ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
105 ModReserve({
106     reserve_id    => $reserve_id,
107     rank          => '4',
108     branchcode    => $branch,
109     itemnumber    => $itemnumber,
110     suspend_until => C4::Dates->new("2013-01-01","iso")->output(),
111 });
112 $reserve = GetReserve( $reserve_id );
113 ok( $reserve->{'priority'} eq '4', "Test GetReserve(), priority changed correctly" );
114 ok( $reserve->{'suspend'}, "Test GetReserve(), suspend hold" );
115 ok( $reserve->{'suspend_until'} eq '2013-01-01 00:00:00', "Test GetReserve(), suspend until date" );
116
117 ToggleSuspend( $reserve_id );
118 $reserve = GetReserve( $reserve_id );
119 ok( !$reserve->{'suspend'}, "Test ToggleSuspend(), no date" );
120
121 ToggleSuspend( $reserve_id, '2012-01-01' );
122 $reserve = GetReserve( $reserve_id );
123 ok( $reserve->{'suspend_until'} eq '2012-01-01 00:00:00', "Test ToggleSuspend(), with date" );
124
125 AutoUnsuspendReserves();
126 $reserve = GetReserve( $reserve_id );
127 ok( !$reserve->{'suspend'}, "Test AutoUnsuspendReserves()" );
128
129 # Add a new hold for the borrower whose hold we canceled earlier, this time at the bib level
130 AddReserve(
131     $branch,
132     $borrowernumber,
133     $biblionumber,
134     my $constraint = 'a',
135     my $bibitems = q{},
136     my $priority,
137     my $resdate,
138     my $expdate,
139     my $notes = q{},
140     $title,
141     my $checkitem,
142     my $found,
143 );
144 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
145 my $reserveid = C4::Reserves::GetReserveId(
146     {
147         biblionumber => $biblionumber,
148         borrowernumber => $borrowernumber
149     }
150 );
151 is( $reserveid, $reserve->{reserve_id}, "Test GetReserveId" );
152 ModReserveMinusPriority( $itemnumber, $reserve->{'reserve_id'} );
153 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
154 ok( $reserve->{'itemnumber'} eq $itemnumber, "Test ModReserveMinusPriority()" );
155
156
157 my $reserve2 = GetReserveInfo( $reserve->{'reserve_id'} );
158 ok( $reserve->{'reserve_id'} eq $reserve2->{'reserve_id'}, "Test GetReserveInfo()" );
159
160
161 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
162 $reserve = $reserves->[1];
163 AlterPriority( 'top', $reserve->{'reserve_id'} );
164 $reserve = GetReserve( $reserve->{'reserve_id'} );
165 ok( $reserve->{'priority'} eq '1', "Test AlterPriority(), move to top" );
166
167 AlterPriority( 'down', $reserve->{'reserve_id'} );
168 $reserve = GetReserve( $reserve->{'reserve_id'} );
169 ok( $reserve->{'priority'} eq '2', "Test AlterPriority(), move down" );
170
171 AlterPriority( 'up', $reserve->{'reserve_id'} );
172 $reserve = GetReserve( $reserve->{'reserve_id'} );
173 ok( $reserve->{'priority'} eq '1', "Test AlterPriority(), move up" );
174
175 AlterPriority( 'bottom', $reserve->{'reserve_id'} );
176 $reserve = GetReserve( $reserve->{'reserve_id'} );
177 ok( $reserve->{'priority'} eq '5', "Test AlterPriority(), move to bottom" );
178
179 # Regression test for bug 2394
180 #
181 # If IndependentBranches is ON and canreservefromotherbranches is OFF,
182 # a patron is not permittedo to request an item whose homebranch (i.e.,
183 # owner of the item) is different from the patron's own library.
184 # However, if canreservefromotherbranches is turned ON, the patron can
185 # create such hold requests.
186 #
187 # Note that canreservefromotherbranches has no effect if
188 # IndependentBranches is OFF.
189
190 my ($foreign_bibnum, $foreign_title, $foreign_bibitemnum) = create_helper_biblio('DUMMY');
191 my ($foreign_item_bibnum, $foreign_item_bibitemnum, $foreign_itemnumber)
192   = AddItem({ homebranch => 'MPL', holdingbranch => 'MPL' } , $foreign_bibnum);
193 $dbh->do('DELETE FROM issuingrules');
194 $dbh->do(
195     q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
196       VALUES (?, ?, ?, ?)}, 
197     {},
198     '*', '*', '*', 25
199 );
200 $dbh->do(
201     q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
202       VALUES (?, ?, ?, ?)}, 
203     {},
204     '*', '*', 'CANNOT', 0 
205 );
206
207 # make sure some basic sysprefs are set
208 t::lib::Mocks::mock_preference('ReservesControlBranch', 'homebranch');
209 t::lib::Mocks::mock_preference('item-level_itypes', 1);
210
211 # if IndependentBranches is OFF, a CPL patron can reserve an MPL item
212 t::lib::Mocks::mock_preference('IndependentBranches', 0);
213 ok(
214     CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
215     'CPL patron allowed to reserve MPL item with IndependentBranches OFF (bug 2394)'
216 );
217
218 # if IndependentBranches is OFF, a CPL patron cannot reserve an MPL item
219 t::lib::Mocks::mock_preference('IndependentBranches', 1);
220 t::lib::Mocks::mock_preference('canreservefromotherbranches', 0);
221 ok(
222     CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'cannotReserveFromOtherBranches',
223     'CPL patron NOT allowed to reserve MPL item with IndependentBranches ON ... (bug 2394)'
224 );
225
226 # ... unless canreservefromotherbranches is ON
227 t::lib::Mocks::mock_preference('canreservefromotherbranches', 1);
228 ok(
229     CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
230     '... unless canreservefromotherbranches is ON (bug 2394)'
231 );
232
233 # Regression test for bug 11336
234 ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
235 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
236 AddReserve(
237     $branch,
238     $borrowernumbers[0],
239     $bibnum,
240     'a',
241     '',
242     1,
243 );
244
245 my $reserveid1 = C4::Reserves::GetReserveId(
246     {
247         biblionumber => $bibnum,
248         borrowernumber => $borrowernumbers[0]
249     }
250 );
251
252 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
253 AddReserve(
254     $branch,
255     $borrowernumbers[1],
256     $bibnum,
257     'a',
258     '',
259     2,
260 );
261 my $reserveid2 = C4::Reserves::GetReserveId(
262     {
263         biblionumber => $bibnum,
264         borrowernumber => $borrowernumbers[1]
265     }
266 );
267
268 CancelReserve({ reserve_id => $reserveid1 });
269
270 $reserve2 = GetReserve( $reserveid2 );
271 is( $reserve2->{priority}, 1, "After cancelreserve, the 2nd reserve becomes the first on the waiting list" );
272
273 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
274 AddReserve(
275     $branch,
276     $borrowernumbers[0],
277     $bibnum,
278     'a',
279     '',
280     2,
281 );
282 my $reserveid3 = C4::Reserves::GetReserveId(
283     {
284         biblionumber => $bibnum,
285         borrowernumber => $borrowernumbers[0]
286     }
287 );
288
289 my $reserve3 = GetReserve( $reserveid3 );
290 is( $reserve3->{priority}, 2, "New reserve for patron 0, the reserve has a priority = 2" );
291
292 ModReserve({ reserve_id => $reserveid2, rank => 'del' });
293 $reserve3 = GetReserve( $reserveid3 );
294 is( $reserve3->{priority}, 1, "After ModReserve, the 3rd reserve becomes the first on the waiting list" );
295
296 ModItem({ damaged => 1 }, $item_bibnum, $itemnumber);
297 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 1 );
298 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK', "Patron can reserve damaged item with AllowHoldsOnDamagedItems enabled" );
299 ok( defined( ( CheckReserves($itemnumber) )[1] ), "Hold can be trapped for damaged item with AllowHoldsOnDamagedItems enabled" );
300 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 0 );
301 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'damaged', "Patron cannot reserve damaged item with AllowHoldsOnDamagedItems disabled" );
302 ok( !defined( ( CheckReserves($itemnumber) )[1] ), "Hold cannot be trapped for damaged item with AllowHoldsOnDamagedItems disabled" );
303
304 # Regression test for bug 9532
305 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
306 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL', itype => 'CANNOT' } , $bibnum);
307 AddReserve(
308     $branch,
309     $borrowernumbers[0],
310     $bibnum,
311     'a',
312     '',
313     1,
314 );
315 ok(
316     CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
317     "cannot request item if policy that matches on item-level item type forbids it"
318 );
319 ModItem({ itype => 'CAN' }, $item_bibnum, $itemnumber);
320 ok(
321     CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK',
322     "can request item if policy that matches on item type allows it"
323 );
324
325 t::lib::Mocks::mock_preference('item-level_itypes', 0);
326 ModItem({ itype => undef }, $item_bibnum, $itemnumber);
327 ok(
328     CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
329     "cannot request item if policy that matches on bib-level item type forbids it (bug 9532)"
330 );
331
332
333 # Test branch item rules
334
335 $dbh->do('DELETE FROM issuingrules');
336 $dbh->do(
337     q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
338       VALUES (?, ?, ?, ?)},
339     {},
340     '*', '*', '*', 25
341 );
342 $dbh->do('DELETE FROM branch_item_rules');
343 $dbh->do('DELETE FROM default_branch_circ_rules');
344 $dbh->do('DELETE FROM default_branch_item_rules');
345 $dbh->do('DELETE FROM default_circ_rules');
346 $dbh->do(q{
347     INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
348     VALUES (?, ?, ?, ?)
349 }, {}, 'CPL', 'CANNOT', 0, 'homebranch');
350 $dbh->do(q{
351     INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
352     VALUES (?, ?, ?, ?)
353 }, {}, 'CPL', 'CAN', 1, 'homebranch');
354 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
355 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
356     { homebranch => 'CPL', holdingbranch => 'CPL', itype => 'CANNOT' } , $bibnum);
357 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'notReservable',
358     "CanItemBeReserved should returns 'notReservable'");
359
360 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
361     { homebranch => 'MPL', holdingbranch => 'CPL', itype => 'CAN' } , $bibnum);
362 is(CanItemBeReserved($borrowernumbers[0], $itemnumber),
363     'cannotReserveFromOtherBranches',
364     "CanItemBeReserved should returns 'cannotReserveFromOtherBranches'");
365
366 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
367     { homebranch => 'CPL', holdingbranch => 'CPL', itype => 'CAN' } , $bibnum);
368 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'OK',
369     "CanItemBeReserved should returns 'OK'");
370
371
372 # Test CancelExpiredReserves
373 C4::Context->set_preference('ExpireReservesMaxPickUpDelay', 1);
374 C4::Context->set_preference('ReservesMaxPickUpDelay', 1);
375
376 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime(time);
377 $year += 1900;
378 $mon += 1;
379 $reserves = $dbh->selectall_arrayref('SELECT * FROM reserves', { Slice => {} });
380 $reserve = $reserves->[0];
381 my $calendar = C4::Calendar->new(branchcode => $reserve->{branchcode});
382 $calendar->insert_single_holiday(
383     day         => $mday,
384     month       => $mon,
385     year        => $year,
386     title       => 'Test',
387     description => 'Test',
388 );
389 $reserve_id = $reserve->{reserve_id};
390 $dbh->do("UPDATE reserves SET waitingdate = DATE_SUB( NOW(), INTERVAL 5 DAY ), found = 'W', priority = 0 WHERE reserve_id = ?", undef, $reserve_id );
391 C4::Context->set_preference('ExpireReservesOnHolidays', 0);
392 CancelExpiredReserves();
393 my $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
394 is( $count, 1, "Waiting reserve beyond max pickup delay *not* canceled on holiday" );
395 C4::Context->set_preference('ExpireReservesOnHolidays', 1);
396 CancelExpiredReserves();
397 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
398 is( $count, 0, "Waiting reserve beyond max pickup delay canceled on holiday" );
399
400 # Test expirationdate
401 $reserve = $reserves->[1];
402 $reserve_id = $reserve->{reserve_id};
403 $dbh->do("UPDATE reserves SET expirationdate = DATE_SUB( NOW(), INTERVAL 1 DAY ) WHERE reserve_id = ?", undef, $reserve_id );
404 CancelExpiredReserves();
405 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
406 is( $count, 0, "Reserve with manual expiration date canceled correctly" );
407
408 # Helper method to set up a Biblio.
409 sub create_helper_biblio {
410     my $itemtype = shift;
411     my $bib = MARC::Record->new();
412     my $title = 'Silence in the library';
413     $bib->append_fields(
414         MARC::Field->new('100', ' ', ' ', a => 'Moffat, Steven'),
415         MARC::Field->new('245', ' ', ' ', a => $title),
416         MARC::Field->new('942', ' ', ' ', c => $itemtype),
417     );
418     return ($bibnum, $title, $bibitemnum) = AddBiblio($bib, '');
419 }