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