3 # Copyright 2000-2002 Katipo Communications
4 # 2006 SAN Ouest Provence
5 # 2007-2010 BibLibre Paul POULAIN
8 # This file is part of Koha.
10 # Koha is free software; you can redistribute it and/or modify it under the
11 # terms of the GNU General Public License as published by the Free Software
12 # Foundation; either version 2 of the License, or (at your option) any later
15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License along
20 # with Koha; if not, write to the Free Software Foundation, Inc.,
21 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #use warnings; FIXME - Bug 2505
33 # for _koha_notify_reserve
34 use C4::Members::Messaging;
37 use C4::Branch qw( GetBranchDetail );
38 use C4::Dates qw( format_date_in_iso );
44 use List::MoreUtils qw( firstidx );
46 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
50 C4::Reserves - Koha functions for dealing with reservation.
58 This modules provides somes functions to deal with reservations.
60 Reserves are stored in reserves table.
61 The following columns contains important values :
62 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
63 =0 : then the reserve is being dealed
64 - found : NULL : means the patron requested the 1st available, and we haven't choosen the item
65 T(ransit) : the reserve is linked to an item but is in transit to the pickup branch
66 W(aiting) : the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf
67 F(inished) : the reserve has been completed, and is done
68 - itemnumber : empty : the reserve is still unaffected to an item
69 filled: the reserve is attached to an item
70 The complete workflow is :
71 ==== 1st use case ====
72 patron request a document, 1st available : P >0, F=NULL, I=NULL
73 a library having it run "transfertodo", and clic on the list
74 if there is no transfer to do, the reserve waiting
75 patron can pick it up P =0, F=W, I=filled
76 if there is a transfer to do, write in branchtransfer P =0, F=T, I=filled
77 The pickup library recieve the book, it check in P =0, F=W, I=filled
78 The patron borrow the book P =0, F=F, I=filled
80 ==== 2nd use case ====
81 patron requests a document, a given item,
82 If pickup is holding branch P =0, F=W, I=filled
83 If transfer needed, write in branchtransfer P =0, F=T, I=filled
84 The pickup library receive the book, it checks it in P =0, F=W, I=filled
85 The patron borrow the book P =0, F=F, I=filled
92 # set the version for version checking
93 $VERSION = 3.07.00.049;
100 &GetReservesFromItemnumber
101 &GetReservesFromBiblionumber
102 &GetReservesFromBorrowernumber
103 &GetReservesForBranch
117 &ModReserveMinusPriority
123 &CanReserveBeCanceledFromOpac
125 &CancelExpiredReserves
127 &AutoUnsuspendReserves
129 &IsAvailableForItemLevelRequest
132 &ToggleLowestPriority
138 &GetReservesControlBranch
140 @EXPORT_OK = qw( MergeHolds );
145 AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$resdate,$expdate,$notes,$title,$checkitem,$found)
151 $branch, $borrowernumber, $biblionumber,
152 $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
153 $title, $checkitem, $found
156 GetReserveFee($borrowernumber, $biblionumber, $constraint,
158 my $dbh = C4::Context->dbh;
159 my $const = lc substr( $constraint, 0, 1 );
160 $resdate = format_date_in_iso( $resdate ) if ( $resdate );
161 $resdate = C4::Dates->today( 'iso' ) unless ( $resdate );
163 $expdate = format_date_in_iso( $expdate );
165 undef $expdate; # make reserves.expirationdate default to null rather than '0000-00-00'
167 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
168 # Make room in reserves for this before those of a later reserve date
169 $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
173 # If the reserv had the waiting status, we had the value of the resdate
174 if ( $found eq 'W' ) {
175 $waitingdate = $resdate;
179 # updates take place here
181 my $nextacctno = &getnextacctno( $borrowernumber );
183 INSERT INTO accountlines
184 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
186 (?,?,now(),?,?,'Res',?)
188 my $usth = $dbh->prepare($query);
189 $usth->execute( $borrowernumber, $nextacctno, $fee,
190 "Reserve Charge - $title", $fee );
196 (borrowernumber,biblionumber,reservedate,branchcode,constrainttype,
197 priority,reservenotes,itemnumber,found,waitingdate,expirationdate)
202 my $sth = $dbh->prepare($query);
204 $borrowernumber, $biblionumber, $resdate, $branch,
205 $const, $priority, $notes, $checkitem,
206 $found, $waitingdate, $expdate
209 # Send e-mail to librarian if syspref is active
210 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
211 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
212 my $branch_details = C4::Branch::GetBranchDetail($borrower->{branchcode});
213 if ( my $letter = C4::Letters::GetPreparedLetter (
214 module => 'reserves',
215 letter_code => 'HOLDPLACED',
216 branchcode => $branch,
218 'branches' => $branch_details,
219 'borrowers' => $borrower,
220 'biblio' => $biblionumber,
221 'items' => $checkitem,
225 my $admin_email_address =$branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
227 C4::Letters::EnqueueLetter(
229 borrowernumber => $borrowernumber,
230 message_transport_type => 'email',
231 from_address => $admin_email_address,
232 to_address => $admin_email_address,
239 ($const eq "o" || $const eq "e") or return; # FIXME: why not have a useful return value?
241 INSERT INTO reserveconstraints
242 (borrowernumber,biblionumber,reservedate,biblioitemnumber)
246 $sth = $dbh->prepare($query); # keep prepare outside the loop!
247 foreach (@$bibitems) {
248 $sth->execute($borrowernumber, $biblionumber, $resdate, $_);
251 return; # FIXME: why not have a useful return value?
256 $res = GetReserve( $reserve_id );
258 Return the current reserve.
263 my ($reserve_id) = @_;
265 my $dbh = C4::Context->dbh;
266 my $query = "SELECT * FROM reserves WHERE reserve_id = ?";
267 my $sth = $dbh->prepare( $query );
268 $sth->execute( $reserve_id );
269 return $sth->fetchrow_hashref();
272 =head2 GetReservesFromBiblionumber
274 my $reserves = GetReservesFromBiblionumber({
275 biblionumber => $biblionumber,
276 [ itemnumber => $itemnumber, ]
280 This function gets the list of reservations for one C<$biblionumber>,
281 returning an arrayref pointing to the reserves for C<$biblionumber>.
283 By default, only reserves whose start date falls before the current
284 time are returned. To return all reserves, including future ones,
285 the C<all_dates> parameter can be included and set to a true value.
287 If the C<itemnumber> parameter is supplied, reserves must be targeted
288 to that item or not targeted to any item at all; otherwise, they
289 are excluded from the list.
293 sub GetReservesFromBiblionumber {
295 my $biblionumber = $params->{biblionumber} or return [];
296 my $itemnumber = $params->{itemnumber};
297 my $all_dates = $params->{all_dates} // 0;
298 my $dbh = C4::Context->dbh;
300 # Find the desired items in the reserves
305 timestamp AS rtimestamp,
319 WHERE biblionumber = ? ";
320 push( @params, $biblionumber );
321 unless ( $all_dates ) {
322 $query .= " AND reservedate <= CAST(NOW() AS DATE) ";
325 $query .= " AND ( itemnumber IS NULL OR itemnumber = ? )";
326 push( @params, $itemnumber );
328 $query .= "ORDER BY priority";
329 my $sth = $dbh->prepare($query);
330 $sth->execute( @params );
333 while ( my $data = $sth->fetchrow_hashref ) {
335 # FIXME - What is this doing? How do constraints work?
336 if ($data->{constrainttype} eq 'o') {
338 SELECT biblioitemnumber
339 FROM reserveconstraints
340 WHERE biblionumber = ?
341 AND borrowernumber = ?
344 my $csth = $dbh->prepare($query);
345 $csth->execute($data->{biblionumber}, $data->{borrowernumber}, $data->{reservedate});
347 while ( my $bibitemnos = $csth->fetchrow_array ) {
348 push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
350 my $count = scalar @bibitemno;
352 # if we have two or more different specific itemtypes
353 # reserved by same person on same day
356 $bdata = GetBiblioItemData( $bibitemno[$i] ); # FIXME: This doesn't make sense.
357 $i++; # $i can increase each pass, but the next @bibitemno might be smaller?
360 # Look up the book we just found.
361 $bdata = GetBiblioItemData( $bibitemno[0] );
363 # Add the results of this latest search to the current
365 # FIXME - An 'each' would probably be more efficient.
366 foreach my $key ( keys %$bdata ) {
367 $data->{$key} = $bdata->{$key};
370 push @results, $data;
375 =head2 GetReservesFromItemnumber
377 ( $reservedate, $borrowernumber, $branchcode, $reserve_id, $waitingdate ) = GetReservesFromItemnumber($itemnumber);
379 Get the first reserve for a specific item number (based on priority). Returns the abovementioned values for that reserve.
381 The routine does not look at future reserves (read: item level holds), but DOES include future waits (a confirmed future hold).
385 sub GetReservesFromItemnumber {
386 my ($itemnumber) = @_;
388 my $schema = Koha::Database->new()->schema();
390 my $r = $schema->resultset('Reserve')->search(
392 itemnumber => $itemnumber,
395 reservedate => \'<= CAST( NOW() AS DATE )',
396 waitingdate => { '!=', undef }
400 order_by => 'priority',
408 $r->get_column('borrowernumber'),
409 $r->get_column('branchcode'),
415 =head2 GetReservesFromBorrowernumber
417 $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
423 sub GetReservesFromBorrowernumber {
424 my ( $borrowernumber, $status ) = @_;
425 my $dbh = C4::Context->dbh;
428 $sth = $dbh->prepare("
431 WHERE borrowernumber=?
435 $sth->execute($borrowernumber,$status);
437 $sth = $dbh->prepare("
440 WHERE borrowernumber=?
443 $sth->execute($borrowernumber);
445 my $data = $sth->fetchall_arrayref({});
448 #-------------------------------------------------------------------------------------
449 =head2 CanBookBeReserved
451 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber)
452 if ($canReserve eq 'OK') { #We can reserve this Item! }
454 See CanItemBeReserved() for possible return values.
458 sub CanBookBeReserved{
459 my ($borrowernumber, $biblionumber) = @_;
461 my $items = GetItemnumbersForBiblio($biblionumber);
462 #get items linked via host records
463 my @hostitems = get_hostitemnumbers_of($biblionumber);
465 push (@$items,@hostitems);
469 foreach my $item (@$items){
470 $canReserve = CanItemBeReserved($borrowernumber, $item);
471 return 'OK' if $canReserve eq 'OK';
476 =head2 CanItemBeReserved
478 $canReserve = &CanItemBeReserved($borrowernumber, $itemnumber)
479 if ($canReserve eq 'OK') { #We can reserve this Item! }
481 @RETURNS OK, if the Item can be reserved.
482 ageRestricted, if the Item is age restricted for this borrower.
483 damaged, if the Item is damaged.
484 cannotReserveFromOtherBranches, if syspref 'canreservefromotherbranches' is OK.
485 tooManyReserves, if the borrower has exceeded his maximum reserve amount.
489 sub CanItemBeReserved{
490 my ($borrowernumber, $itemnumber) = @_;
492 my $dbh = C4::Context->dbh;
493 my $ruleitemtype; # itemtype of the matching issuing rule
494 my $allowedreserves = 0;
496 # we retrieve borrowers and items informations #
497 # item->{itype} will come for biblioitems if necessery
498 my $item = GetItem($itemnumber);
499 my $biblioData = C4::Biblio::GetBiblioData( $item->{biblionumber} );
500 my $borrower = C4::Members::GetMember('borrowernumber'=>$borrowernumber);
502 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
503 return 'damaged' if ( $item->{damaged} && !C4::Context->preference('AllowHoldsOnDamagedItems') );
505 #Check for the age restriction
506 my ($ageRestriction, $daysToAgeRestriction) = C4::Circulation::GetAgeRestriction( $biblioData->{agerestriction}, $borrower );
507 return 'ageRestricted' if $daysToAgeRestriction && $daysToAgeRestriction > 0;
509 my $controlbranch = C4::Context->preference('ReservesControlBranch');
510 my $itemtypefield = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
512 # we retrieve user rights on this itemtype and branchcode
513 my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
515 WHERE (categorycode in (?,'*') )
516 AND (itemtype IN (?,'*'))
517 AND (branchcode IN (?,'*'))
524 my $querycount ="SELECT
527 LEFT JOIN items USING (itemnumber)
528 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
529 LEFT JOIN borrowers USING (borrowernumber)
530 WHERE borrowernumber = ?
535 my $branchfield = "reserves.branchcode";
537 if( $controlbranch eq "ItemHomeLibrary" ){
538 $branchfield = "items.homebranch";
539 $branchcode = $item->{homebranch};
540 }elsif( $controlbranch eq "PatronLibrary" ){
541 $branchfield = "borrowers.branchcode";
542 $branchcode = $borrower->{branchcode};
546 $sth->execute($borrower->{'categorycode'}, $item->{'itype'}, $branchcode);
547 if(my $rights = $sth->fetchrow_hashref()){
548 $ruleitemtype = $rights->{itemtype};
549 $allowedreserves = $rights->{reservesallowed};
556 $querycount .= "AND $branchfield = ?";
558 $querycount .= " AND $itemtypefield = ?" if ($ruleitemtype ne "*");
559 my $sthcount = $dbh->prepare($querycount);
561 if($ruleitemtype eq "*"){
562 $sthcount->execute($borrowernumber, $branchcode);
564 $sthcount->execute($borrowernumber, $branchcode, $ruleitemtype);
567 my $reservecount = "0";
568 if(my $rowcount = $sthcount->fetchrow_hashref()){
569 $reservecount = $rowcount->{count};
572 # we check if it's ok or not
573 if( $reservecount >= $allowedreserves ){
574 return 'tooManyReserves';
577 # If reservecount is ok, we check item branch if IndependentBranches is ON
578 # and canreservefromotherbranches is OFF
579 if ( C4::Context->preference('IndependentBranches')
580 and !C4::Context->preference('canreservefromotherbranches') )
582 my $itembranch = $item->{homebranch};
583 if ($itembranch ne $borrower->{branchcode}) {
584 return 'cannotReserveFromOtherBranches';
591 =head2 CanReserveBeCanceledFromOpac
593 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
595 returns 1 if reserve can be cancelled by user from OPAC.
596 First check if reserve belongs to user, next checks if reserve is not in
597 transfer or waiting status
601 sub CanReserveBeCanceledFromOpac {
602 my ($reserve_id, $borrowernumber) = @_;
604 return unless $reserve_id and $borrowernumber;
605 my $reserve = GetReserve($reserve_id);
607 return 0 unless $reserve->{borrowernumber} == $borrowernumber;
608 return 0 if ( $reserve->{found} eq 'W' ) or ( $reserve->{found} eq 'T' );
614 #--------------------------------------------------------------------------------
615 =head2 GetReserveCount
617 $number = &GetReserveCount($borrowernumber);
619 this function returns the number of reservation for a borrower given on input arg.
623 sub GetReserveCount {
624 my ($borrowernumber) = @_;
626 my $dbh = C4::Context->dbh;
629 SELECT COUNT(*) AS counter
631 WHERE borrowernumber = ?
633 my $sth = $dbh->prepare($query);
634 $sth->execute($borrowernumber);
635 my $row = $sth->fetchrow_hashref;
636 return $row->{counter};
639 =head2 GetOtherReserves
641 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
643 Check queued list of this document and check if this document must be transfered
647 sub GetOtherReserves {
648 my ($itemnumber) = @_;
651 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
652 if ($checkreserves) {
653 my $iteminfo = GetItem($itemnumber);
654 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
655 $messages->{'transfert'} = $checkreserves->{'branchcode'};
656 #minus priorities of others reservs
657 ModReserveMinusPriority(
659 $checkreserves->{'reserve_id'},
662 #launch the subroutine dotransfer
663 C4::Items::ModItemTransfer(
665 $iteminfo->{'holdingbranch'},
666 $checkreserves->{'branchcode'}
671 #step 2b : case of a reservation on the same branch, set the waiting status
673 $messages->{'waiting'} = 1;
674 ModReserveMinusPriority(
676 $checkreserves->{'reserve_id'},
678 ModReserveStatus($itemnumber,'W');
681 $nextreservinfo = $checkreserves->{'borrowernumber'};
684 return ( $messages, $nextreservinfo );
689 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
691 Calculate the fee for a reserve
696 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
699 my $dbh = C4::Context->dbh;
700 my $const = lc substr( $constraint, 0, 1 );
702 SELECT * FROM borrowers
703 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
704 WHERE borrowernumber = ?
706 my $sth = $dbh->prepare($query);
707 $sth->execute($borrowernumber);
708 my $data = $sth->fetchrow_hashref;
709 my $fee = $data->{'reservefee'};
710 my $cntitems = @- > $bibitems;
714 # check for items on issue
715 # first find biblioitem records
717 my $sth1 = $dbh->prepare(
718 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
719 WHERE (biblio.biblionumber = ?)"
721 $sth1->execute($biblionumber);
722 while ( my $data1 = $sth1->fetchrow_hashref ) {
723 if ( $const eq "a" ) {
724 push @biblioitems, $data1;
729 while ( $x < $cntitems ) {
730 if ( @$bibitems->{'biblioitemnumber'} ==
731 $data->{'biblioitemnumber'} )
737 if ( $const eq 'o' ) {
739 push @biblioitems, $data1;
744 push @biblioitems, $data1;
749 my $cntitemsfound = @biblioitems;
753 while ( $x < $cntitemsfound ) {
754 my $bitdata = $biblioitems[$x];
755 my $sth2 = $dbh->prepare(
757 WHERE biblioitemnumber = ?"
759 $sth2->execute( $bitdata->{'biblioitemnumber'} );
760 while ( my $itdata = $sth2->fetchrow_hashref ) {
761 my $sth3 = $dbh->prepare(
762 "SELECT * FROM issues
763 WHERE itemnumber = ?"
765 $sth3->execute( $itdata->{'itemnumber'} );
766 if ( my $isdata = $sth3->fetchrow_hashref ) {
774 if ( $allissued == 0 ) {
776 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
777 $rsth->execute($biblionumber);
778 if ( my $rdata = $rsth->fetchrow_hashref ) {
788 =head2 GetReservesToBranch
790 @transreserv = GetReservesToBranch( $frombranch );
792 Get reserve list for a given branch
796 sub GetReservesToBranch {
797 my ( $frombranch ) = @_;
798 my $dbh = C4::Context->dbh;
799 my $sth = $dbh->prepare(
800 "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
805 $sth->execute( $frombranch );
808 while ( my $data = $sth->fetchrow_hashref ) {
809 $transreserv[$i] = $data;
812 return (@transreserv);
815 =head2 GetReservesForBranch
817 @transreserv = GetReservesForBranch($frombranch);
821 sub GetReservesForBranch {
822 my ($frombranch) = @_;
823 my $dbh = C4::Context->dbh;
826 SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate
831 $query .= " AND branchcode=? " if ( $frombranch );
832 $query .= "ORDER BY waitingdate" ;
834 my $sth = $dbh->prepare($query);
836 $sth->execute($frombranch);
843 while ( my $data = $sth->fetchrow_hashref ) {
844 $transreserv[$i] = $data;
847 return (@transreserv);
850 =head2 GetReserveStatus
852 $reservestatus = GetReserveStatus($itemnumber, $biblionumber);
854 Take an itemnumber or a biblionumber and return the status of the reserve places on it.
855 If several reserves exist, the reserve with the lower priority is given.
859 ## FIXME: I don't think this does what it thinks it does.
860 ## It only ever checks the first reserve result, even though
861 ## multiple reserves for that bib can have the itemnumber set
862 ## the sub is only used once in the codebase.
863 sub GetReserveStatus {
864 my ($itemnumber, $biblionumber) = @_;
866 my $dbh = C4::Context->dbh;
868 my ($sth, $found, $priority);
870 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
871 $sth->execute($itemnumber);
872 ($found, $priority) = $sth->fetchrow_array;
875 if ( $biblionumber and not defined $found and not defined $priority ) {
876 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE biblionumber = ? order by priority LIMIT 1");
877 $sth->execute($biblionumber);
878 ($found, $priority) = $sth->fetchrow_array;
882 return 'Waiting' if $found eq 'W' and $priority == 0;
883 return 'Finished' if $found eq 'F';
886 return 'Reserved' if $priority > 0;
888 return ''; # empty string here will remove need for checking undef, or less log lines
893 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
894 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
895 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
897 Find a book in the reserves.
899 C<$itemnumber> is the book's item number.
900 C<$lookahead> is the number of days to look in advance for future reserves.
902 As I understand it, C<&CheckReserves> looks for the given item in the
903 reserves. If it is found, that's a match, and C<$status> is set to
906 Otherwise, it finds the most important item in the reserves with the
907 same biblio number as this book (I'm not clear on this) and returns it
908 with C<$status> set to C<Reserved>.
910 C<&CheckReserves> returns a two-element list:
912 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
914 C<$reserve> is the reserve item that matched. It is a
915 reference-to-hash whose keys are mostly the fields of the reserves
916 table in the Koha database.
921 my ( $item, $barcode, $lookahead_days) = @_;
922 my $dbh = C4::Context->dbh;
925 if (C4::Context->preference('item-level_itypes')){
927 SELECT items.biblionumber,
928 items.biblioitemnumber,
929 itemtypes.notforloan,
930 items.notforloan AS itemnotforloan,
936 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
937 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
942 SELECT items.biblionumber,
943 items.biblioitemnumber,
944 itemtypes.notforloan,
945 items.notforloan AS itemnotforloan,
951 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
952 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
957 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
958 $sth->execute($item);
961 $sth = $dbh->prepare("$select WHERE barcode = ?");
962 $sth->execute($barcode);
964 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
965 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
967 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
969 return unless $itemnumber; # bail if we got nothing.
971 # if item is not for loan it cannot be reserved either.....
972 # except where items.notforloan < 0 : This indicates the item is holdable.
973 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
975 # Find this item in the reserves
976 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days);
978 # $priority and $highest are used to find the most important item
979 # in the list returned by &_Findgroupreserve. (The lower $priority,
980 # the more important the item.)
981 # $highest is the most important item we've seen so far.
983 if (scalar @reserves) {
984 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
985 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
986 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
988 my $priority = 10000000;
989 foreach my $res (@reserves) {
990 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
991 return ( "Waiting", $res, \@reserves ); # Found it
995 my $local_hold_match;
997 if ($LocalHoldsPriority) {
998 $borrowerinfo = C4::Members::GetMember( borrowernumber => $res->{'borrowernumber'} );
999 $iteminfo = C4::Items::GetItem($itemnumber);
1001 my $local_holds_priority_item_branchcode =
1002 $iteminfo->{$LocalHoldsPriorityItemControl};
1003 my $local_holds_priority_patron_branchcode =
1004 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
1005 ? $res->{branchcode}
1006 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
1007 ? $borrowerinfo->{branchcode}
1010 $local_holds_priority_item_branchcode eq
1011 $local_holds_priority_patron_branchcode;
1014 # See if this item is more important than what we've got so far
1015 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
1016 $borrowerinfo ||= C4::Members::GetMember( borrowernumber => $res->{'borrowernumber'} );
1017 $iteminfo ||= C4::Items::GetItem($itemnumber);
1018 my $branch = GetReservesControlBranch( $iteminfo, $borrowerinfo );
1019 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
1020 next if ($branchitemrule->{'holdallowed'} == 0);
1021 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $borrowerinfo->{'branchcode'}));
1022 $priority = $res->{'priority'};
1024 last if $local_hold_match;
1030 # If we get this far, then no exact match was found.
1031 # We return the most important (i.e. next) reservation.
1033 $highest->{'itemnumber'} = $item;
1034 return ( "Reserved", $highest, \@reserves );
1040 =head2 CancelExpiredReserves
1042 CancelExpiredReserves();
1044 Cancels all reserves with an expiration date from before today.
1048 sub CancelExpiredReserves {
1050 # Cancel reserves that have passed their expiration date.
1051 my $dbh = C4::Context->dbh;
1052 my $sth = $dbh->prepare( "
1053 SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
1054 AND expirationdate IS NOT NULL
1059 while ( my $res = $sth->fetchrow_hashref() ) {
1060 CancelReserve({ reserve_id => $res->{'reserve_id'} });
1063 # Cancel reserves that have been waiting too long
1064 if ( C4::Context->preference("ExpireReservesMaxPickUpDelay") ) {
1065 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
1066 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
1067 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
1069 my $today = dt_from_string();
1071 my $query = "SELECT * FROM reserves WHERE TO_DAYS( NOW() ) - TO_DAYS( waitingdate ) > ? AND found = 'W' AND priority = 0";
1072 $sth = $dbh->prepare( $query );
1073 $sth->execute( $max_pickup_delay );
1075 while ( my $res = $sth->fetchrow_hashref ) {
1077 unless ( $cancel_on_holidays ) {
1078 my $calendar = Koha::Calendar->new( branchcode => $res->{'branchcode'} );
1079 my $is_holiday = $calendar->is_holiday( $today );
1081 if ( $is_holiday ) {
1088 manualinvoice($res->{'borrowernumber'}, $res->{'itemnumber'}, 'Hold waiting too long', 'F', $charge);
1091 CancelReserve({ reserve_id => $res->{'reserve_id'} });
1098 =head2 AutoUnsuspendReserves
1100 AutoUnsuspendReserves();
1102 Unsuspends all suspended reserves with a suspend_until date from before today.
1106 sub AutoUnsuspendReserves {
1108 my $dbh = C4::Context->dbh;
1110 my $query = "UPDATE reserves SET suspend = 0, suspend_until = NULL WHERE DATE( suspend_until ) < DATE( CURDATE() )";
1111 my $sth = $dbh->prepare( $query );
1116 =head2 CancelReserve
1118 CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber ] });
1125 my ( $params ) = @_;
1127 my $reserve_id = $params->{'reserve_id'};
1128 $reserve_id = GetReserveId( $params ) unless ( $reserve_id );
1130 return unless ( $reserve_id );
1132 my $dbh = C4::Context->dbh;
1134 my $reserve = GetReserve( $reserve_id );
1138 SET cancellationdate = now(),
1141 WHERE reserve_id = ?
1143 my $sth = $dbh->prepare($query);
1144 $sth->execute( $reserve_id );
1147 INSERT INTO old_reserves
1148 SELECT * FROM reserves
1149 WHERE reserve_id = ?
1151 $sth = $dbh->prepare($query);
1152 $sth->execute( $reserve_id );
1155 DELETE FROM reserves
1156 WHERE reserve_id = ?
1158 $sth = $dbh->prepare($query);
1159 $sth->execute( $reserve_id );
1161 # now fix the priority on the others....
1162 _FixPriority({ biblionumber => $reserve->{biblionumber} });
1170 ModReserve({ rank => $rank,
1171 reserve_id => $reserve_id,
1172 branchcode => $branchcode
1173 [, itemnumber => $itemnumber ]
1174 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1177 Change a hold request's priority or cancel it.
1179 C<$rank> specifies the effect of the change. If C<$rank>
1180 is 'W' or 'n', nothing happens. This corresponds to leaving a
1181 request alone when changing its priority in the holds queue
1184 If C<$rank> is 'del', the hold request is cancelled.
1186 If C<$rank> is an integer greater than zero, the priority of
1187 the request is set to that value. Since priority != 0 means
1188 that the item is not waiting on the hold shelf, setting the
1189 priority to a non-zero value also sets the request's found
1190 status and waiting date to NULL.
1192 The optional C<$itemnumber> parameter is used only when
1193 C<$rank> is a non-zero integer; if supplied, the itemnumber
1194 of the hold request is set accordingly; if omitted, the itemnumber
1197 B<FIXME:> Note that the forgoing can have the effect of causing
1198 item-level hold requests to turn into title-level requests. This
1199 will be fixed once reserves has separate columns for requested
1200 itemnumber and supplying itemnumber.
1205 my ( $params ) = @_;
1207 my $rank = $params->{'rank'};
1208 my $reserve_id = $params->{'reserve_id'};
1209 my $branchcode = $params->{'branchcode'};
1210 my $itemnumber = $params->{'itemnumber'};
1211 my $suspend_until = $params->{'suspend_until'};
1212 my $borrowernumber = $params->{'borrowernumber'};
1213 my $biblionumber = $params->{'biblionumber'};
1215 return if $rank eq "W";
1216 return if $rank eq "n";
1218 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1219 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber }) unless ( $reserve_id );
1221 my $dbh = C4::Context->dbh;
1222 if ( $rank eq "del" ) {
1223 CancelReserve({ reserve_id => $reserve_id });
1225 elsif ($rank =~ /^\d+/ and $rank > 0) {
1227 UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
1228 WHERE reserve_id = ?
1230 my $sth = $dbh->prepare($query);
1231 $sth->execute( $rank, $branchcode, $itemnumber, $reserve_id );
1233 if ( defined( $suspend_until ) ) {
1234 if ( $suspend_until ) {
1235 $suspend_until = C4::Dates->new( $suspend_until )->output("iso");
1236 $dbh->do("UPDATE reserves SET suspend = 1, suspend_until = ? WHERE reserve_id = ?", undef, ( $suspend_until, $reserve_id ) );
1238 $dbh->do("UPDATE reserves SET suspend_until = NULL WHERE reserve_id = ?", undef, ( $reserve_id ) );
1242 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1246 =head2 ModReserveFill
1248 &ModReserveFill($reserve);
1250 Fill a reserve. If I understand this correctly, this means that the
1251 reserved book has been found and given to the patron who reserved it.
1253 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1254 whose keys are fields from the reserves table in the Koha database.
1258 sub ModReserveFill {
1260 my $dbh = C4::Context->dbh;
1261 # fill in a reserve record....
1262 my $reserve_id = $res->{'reserve_id'};
1263 my $biblionumber = $res->{'biblionumber'};
1264 my $borrowernumber = $res->{'borrowernumber'};
1265 my $resdate = $res->{'reservedate'};
1267 # get the priority on this record....
1269 my $query = "SELECT priority
1271 WHERE biblionumber = ?
1272 AND borrowernumber = ?
1273 AND reservedate = ?";
1274 my $sth = $dbh->prepare($query);
1275 $sth->execute( $biblionumber, $borrowernumber, $resdate );
1276 ($priority) = $sth->fetchrow_array;
1278 # update the database...
1279 $query = "UPDATE reserves
1282 WHERE biblionumber = ?
1284 AND borrowernumber = ?
1286 $sth = $dbh->prepare($query);
1287 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1289 # move to old_reserves
1290 $query = "INSERT INTO old_reserves
1291 SELECT * FROM reserves
1292 WHERE biblionumber = ?
1294 AND borrowernumber = ?
1296 $sth = $dbh->prepare($query);
1297 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1298 $query = "DELETE FROM reserves
1299 WHERE biblionumber = ?
1301 AND borrowernumber = ?
1303 $sth = $dbh->prepare($query);
1304 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1306 # now fix the priority on the others (if the priority wasn't
1307 # already sorted!)....
1308 unless ( $priority == 0 ) {
1309 _FixPriority({ reserve_id => $reserve_id });
1313 =head2 ModReserveStatus
1315 &ModReserveStatus($itemnumber, $newstatus);
1317 Update the reserve status for the active (priority=0) reserve.
1319 $itemnumber is the itemnumber the reserve is on
1321 $newstatus is the new status.
1325 sub ModReserveStatus {
1327 #first : check if we have a reservation for this item .
1328 my ($itemnumber, $newstatus) = @_;
1329 my $dbh = C4::Context->dbh;
1331 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1332 my $sth_set = $dbh->prepare($query);
1333 $sth_set->execute( $newstatus, $itemnumber );
1335 if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
1336 CartToShelf( $itemnumber );
1340 =head2 ModReserveAffect
1342 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
1344 This function affect an item and a status for a given reserve
1345 The itemnumber parameter is used to find the biblionumber.
1346 with the biblionumber & the borrowernumber, we can affect the itemnumber
1347 to the correct reserve.
1349 if $transferToDo is not set, then the status is set to "Waiting" as well.
1350 otherwise, a transfer is on the way, and the end of the transfer will
1351 take care of the waiting status
1355 sub ModReserveAffect {
1356 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
1357 my $dbh = C4::Context->dbh;
1359 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1360 # attached to $itemnumber
1361 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1362 $sth->execute($itemnumber);
1363 my ($biblionumber) = $sth->fetchrow;
1365 # get request - need to find out if item is already
1366 # waiting in order to not send duplicate hold filled notifications
1367 my $reserve_id = GetReserveId({
1368 borrowernumber => $borrowernumber,
1369 biblionumber => $biblionumber,
1371 return unless defined $reserve_id;
1372 my $request = GetReserveInfo($reserve_id);
1373 my $already_on_shelf = ($request && $request->{found} eq 'W') ? 1 : 0;
1375 # If we affect a reserve that has to be transfered, don't set to Waiting
1377 if ($transferToDo) {
1383 WHERE borrowernumber = ?
1384 AND biblionumber = ?
1388 # affect the reserve to Waiting as well.
1393 waitingdate = NOW(),
1395 WHERE borrowernumber = ?
1396 AND biblionumber = ?
1399 $sth = $dbh->prepare($query);
1400 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1401 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
1402 _FixPriority( { biblionumber => $biblionumber } );
1403 if ( C4::Context->preference("ReturnToShelvingCart") ) {
1404 CartToShelf( $itemnumber );
1410 =head2 ModReserveCancelAll
1412 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1414 function to cancel reserv,check other reserves, and transfer document if it's necessary
1418 sub ModReserveCancelAll {
1421 my ( $itemnumber, $borrowernumber ) = @_;
1423 #step 1 : cancel the reservation
1424 my $CancelReserve = CancelReserve({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1426 #step 2 launch the subroutine of the others reserves
1427 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1429 return ( $messages, $nextreservinfo );
1432 =head2 ModReserveMinusPriority
1434 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1436 Reduce the values of queued list
1440 sub ModReserveMinusPriority {
1441 my ( $itemnumber, $reserve_id ) = @_;
1443 #first step update the value of the first person on reserv
1444 my $dbh = C4::Context->dbh;
1447 SET priority = 0 , itemnumber = ?
1448 WHERE reserve_id = ?
1450 my $sth_upd = $dbh->prepare($query);
1451 $sth_upd->execute( $itemnumber, $reserve_id );
1452 # second step update all others reserves
1453 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1456 =head2 GetReserveInfo
1458 &GetReserveInfo($reserve_id);
1460 Get item and borrower details for a current hold.
1461 Current implementation this query should have a single result.
1465 sub GetReserveInfo {
1466 my ( $reserve_id ) = @_;
1467 my $dbh = C4::Context->dbh;
1472 reserves.borrowernumber,
1473 reserves.biblionumber,
1474 reserves.branchcode,
1475 reserves.waitingdate,
1491 items.holdingbranch,
1492 items.itemcallnumber,
1498 LEFT JOIN items USING(itemnumber)
1499 LEFT JOIN borrowers USING(borrowernumber)
1500 LEFT JOIN biblio ON (reserves.biblionumber=biblio.biblionumber)
1501 WHERE reserves.reserve_id = ?";
1502 my $sth = $dbh->prepare($strsth);
1503 $sth->execute($reserve_id);
1505 my $data = $sth->fetchrow_hashref;
1509 =head2 IsAvailableForItemLevelRequest
1511 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1513 Checks whether a given item record is available for an
1514 item-level hold request. An item is available if
1516 * it is not lost AND
1517 * it is not damaged AND
1518 * it is not withdrawn AND
1519 * does not have a not for loan value > 0
1521 Whether or not the item is currently on loan is
1522 also checked - if the AllowOnShelfHolds system preference
1523 is ON, an item can be requested even if it is currently
1524 on loan to somebody else. If the system preference
1525 is OFF, an item that is currently checked out cannot
1526 be the target of an item-level hold request.
1528 Note that IsAvailableForItemLevelRequest() does not
1529 check if the staff operator is authorized to place
1530 a request on the item - in particular,
1531 this routine does not check IndependentBranches
1532 and canreservefromotherbranches.
1536 sub IsAvailableForItemLevelRequest {
1537 my $itemnumber = shift;
1539 my $item = GetItem($itemnumber);
1541 # must check the notforloan setting of the itemtype
1542 # FIXME - a lot of places in the code do this
1543 # or something similar - need to be
1545 my $dbh = C4::Context->dbh;
1546 my $notforloan_query;
1547 if (C4::Context->preference('item-level_itypes')) {
1548 $notforloan_query = "SELECT itemtypes.notforloan
1550 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1551 WHERE itemnumber = ?";
1553 $notforloan_query = "SELECT itemtypes.notforloan
1555 JOIN biblioitems USING (biblioitemnumber)
1556 JOIN itemtypes USING (itemtype)
1557 WHERE itemnumber = ?";
1559 my $sth = $dbh->prepare($notforloan_query);
1560 $sth->execute($itemnumber);
1561 my $notforloan_per_itemtype = 0;
1562 if (my ($notforloan) = $sth->fetchrow_array) {
1563 $notforloan_per_itemtype = 1 if $notforloan;
1566 my $available_per_item = 1;
1567 $available_per_item = 0 if $item->{itemlost} or
1568 ( $item->{notforloan} > 0 ) or
1569 ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1570 $item->{withdrawn} or
1571 $notforloan_per_itemtype;
1574 if (C4::Context->preference('AllowOnShelfHolds')) {
1575 return $available_per_item;
1577 return ($available_per_item and ($item->{onloan} or GetReserveStatus($itemnumber) eq "Waiting"));
1581 =head2 AlterPriority
1583 AlterPriority( $where, $reserve_id );
1585 This function changes a reserve's priority up, down, to the top, or to the bottom.
1586 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1591 my ( $where, $reserve_id ) = @_;
1593 my $dbh = C4::Context->dbh;
1595 my $reserve = GetReserve( $reserve_id );
1597 if ( $reserve->{cancellationdate} ) {
1598 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate}.')';
1602 if ( $where eq 'up' || $where eq 'down' ) {
1604 my $priority = $reserve->{'priority'};
1605 $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1606 _FixPriority({ reserve_id => $reserve_id, rank => $priority })
1608 } elsif ( $where eq 'top' ) {
1610 _FixPriority({ reserve_id => $reserve_id, rank => '1' })
1612 } elsif ( $where eq 'bottom' ) {
1614 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1619 =head2 ToggleLowestPriority
1621 ToggleLowestPriority( $borrowernumber, $biblionumber );
1623 This function sets the lowestPriority field to true if is false, and false if it is true.
1627 sub ToggleLowestPriority {
1628 my ( $reserve_id ) = @_;
1630 my $dbh = C4::Context->dbh;
1632 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1633 $sth->execute( $reserve_id );
1635 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1638 =head2 ToggleSuspend
1640 ToggleSuspend( $reserve_id );
1642 This function sets the suspend field to true if is false, and false if it is true.
1643 If the reserve is currently suspended with a suspend_until date, that date will
1644 be cleared when it is unsuspended.
1649 my ( $reserve_id, $suspend_until ) = @_;
1651 $suspend_until = output_pref(
1653 dt => dt_from_string($suspend_until),
1654 dateformat => 'iso',
1657 ) if ($suspend_until);
1659 my $do_until = ( $suspend_until ) ? '?' : 'NULL';
1661 my $dbh = C4::Context->dbh;
1663 my $sth = $dbh->prepare(
1664 "UPDATE reserves SET suspend = NOT suspend,
1665 suspend_until = CASE WHEN suspend = 0 THEN NULL ELSE $do_until END
1666 WHERE reserve_id = ?
1670 push( @params, $suspend_until ) if ( $suspend_until );
1671 push( @params, $reserve_id );
1673 $sth->execute( @params );
1679 borrowernumber => $borrowernumber,
1680 [ biblionumber => $biblionumber, ]
1681 [ suspend_until => $suspend_until, ]
1682 [ suspend => $suspend ]
1685 This function accepts a set of hash keys as its parameters.
1686 It requires either borrowernumber or biblionumber, or both.
1688 suspend_until is wholly optional.
1695 my $borrowernumber = $params{'borrowernumber'} || undef;
1696 my $biblionumber = $params{'biblionumber'} || undef;
1697 my $suspend_until = $params{'suspend_until'} || undef;
1698 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1700 $suspend_until = C4::Dates->new( $suspend_until )->output("iso") if ( defined( $suspend_until ) );
1702 return unless ( $borrowernumber || $biblionumber );
1704 my ( $query, $sth, $dbh, @query_params );
1706 $query = "UPDATE reserves SET suspend = ? ";
1707 push( @query_params, $suspend );
1709 $query .= ", suspend_until = NULL ";
1710 } elsif ( $suspend_until ) {
1711 $query .= ", suspend_until = ? ";
1712 push( @query_params, $suspend_until );
1714 $query .= " WHERE ";
1715 if ( $borrowernumber ) {
1716 $query .= " borrowernumber = ? ";
1717 push( @query_params, $borrowernumber );
1719 $query .= " AND " if ( $borrowernumber && $biblionumber );
1720 if ( $biblionumber ) {
1721 $query .= " biblionumber = ? ";
1722 push( @query_params, $biblionumber );
1724 $query .= " AND found IS NULL ";
1726 $dbh = C4::Context->dbh;
1727 $sth = $dbh->prepare( $query );
1728 $sth->execute( @query_params );
1735 reserve_id => $reserve_id,
1737 [ignoreSetLowestRank => $ignoreSetLowestRank]
1742 _FixPriority({ biblionumber => $biblionumber});
1744 This routine adjusts the priority of a hold request and holds
1747 In the first form, where a reserve_id is passed, the priority of the
1748 hold is set to supplied rank, and other holds for that bib are adjusted
1749 accordingly. If the rank is "del", the hold is cancelled. If no rank
1750 is supplied, all of the holds on that bib have their priority adjusted
1751 as if the second form had been used.
1753 In the second form, where a biblionumber is passed, the holds on that
1754 bib (that are not captured) are sorted in order of increasing priority,
1755 then have reserves.priority set so that the first non-captured hold
1756 has its priority set to 1, the second non-captured hold has its priority
1757 set to 2, and so forth.
1759 In both cases, holds that have the lowestPriority flag on are have their
1760 priority adjusted to ensure that they remain at the end of the line.
1762 Note that the ignoreSetLowestRank parameter is meant to be used only
1763 when _FixPriority calls itself.
1768 my ( $params ) = @_;
1769 my $reserve_id = $params->{reserve_id};
1770 my $rank = $params->{rank} // '';
1771 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1772 my $biblionumber = $params->{biblionumber};
1774 my $dbh = C4::Context->dbh;
1776 unless ( $biblionumber ) {
1777 my $res = GetReserve( $reserve_id );
1778 $biblionumber = $res->{biblionumber};
1781 if ( $rank eq "del" ) {
1782 CancelReserve({ reserve_id => $reserve_id });
1784 elsif ( $rank eq "W" || $rank eq "0" ) {
1786 # make sure priority for waiting or in-transit items is 0
1790 WHERE reserve_id = ?
1791 AND found IN ('W', 'T')
1793 my $sth = $dbh->prepare($query);
1794 $sth->execute( $reserve_id );
1800 SELECT reserve_id, borrowernumber, reservedate, constrainttype
1802 WHERE biblionumber = ?
1803 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1804 ORDER BY priority ASC
1806 my $sth = $dbh->prepare($query);
1807 $sth->execute( $biblionumber );
1808 while ( my $line = $sth->fetchrow_hashref ) {
1809 push( @priority, $line );
1812 # To find the matching index
1814 my $key = -1; # to allow for 0 to be a valid result
1815 for ( $i = 0 ; $i < @priority ; $i++ ) {
1816 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1817 $key = $i; # save the index
1822 # if index exists in array then move it to new position
1823 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1824 my $new_rank = $rank -
1825 1; # $new_rank is what you want the new index to be in the array
1826 my $moving_item = splice( @priority, $key, 1 );
1827 splice( @priority, $new_rank, 0, $moving_item );
1830 # now fix the priority on those that are left....
1834 WHERE reserve_id = ?
1836 $sth = $dbh->prepare($query);
1837 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1840 $priority[$j]->{'reserve_id'}
1844 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1847 unless ( $ignoreSetLowestRank ) {
1848 while ( my $res = $sth->fetchrow_hashref() ) {
1850 reserve_id => $res->{'reserve_id'},
1852 ignoreSetLowestRank => 1
1858 =head2 _Findgroupreserve
1860 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead);
1862 Looks for an item-specific match first, then for a title-level match, returning the
1863 first match found. If neither, then we look for a 3rd kind of match based on
1864 reserve constraints.
1865 Lookahead is the number of days to look in advance.
1867 TODO: add more explanation about reserve constraints
1869 C<&_Findgroupreserve> returns :
1870 C<@results> is an array of references-to-hash whose keys are mostly
1871 fields from the reserves table of the Koha database, plus
1872 C<biblioitemnumber>.
1876 sub _Findgroupreserve {
1877 my ( $bibitem, $biblio, $itemnumber, $lookahead) = @_;
1878 my $dbh = C4::Context->dbh;
1880 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1881 # check for exact targetted match
1882 my $item_level_target_query = qq/
1883 SELECT reserves.biblionumber AS biblionumber,
1884 reserves.borrowernumber AS borrowernumber,
1885 reserves.reservedate AS reservedate,
1886 reserves.branchcode AS branchcode,
1887 reserves.cancellationdate AS cancellationdate,
1888 reserves.found AS found,
1889 reserves.reservenotes AS reservenotes,
1890 reserves.priority AS priority,
1891 reserves.timestamp AS timestamp,
1892 biblioitems.biblioitemnumber AS biblioitemnumber,
1893 reserves.itemnumber AS itemnumber,
1894 reserves.reserve_id AS reserve_id
1896 JOIN biblioitems USING (biblionumber)
1897 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1900 AND item_level_request = 1
1902 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1906 my $sth = $dbh->prepare($item_level_target_query);
1907 $sth->execute($itemnumber, $lookahead||0);
1909 if ( my $data = $sth->fetchrow_hashref ) {
1910 push( @results, $data );
1912 return @results if @results;
1914 # check for title-level targetted match
1915 my $title_level_target_query = qq/
1916 SELECT reserves.biblionumber AS biblionumber,
1917 reserves.borrowernumber AS borrowernumber,
1918 reserves.reservedate AS reservedate,
1919 reserves.branchcode AS branchcode,
1920 reserves.cancellationdate AS cancellationdate,
1921 reserves.found AS found,
1922 reserves.reservenotes AS reservenotes,
1923 reserves.priority AS priority,
1924 reserves.timestamp AS timestamp,
1925 biblioitems.biblioitemnumber AS biblioitemnumber,
1926 reserves.itemnumber AS itemnumber,
1927 reserves.reserve_id AS reserve_id
1929 JOIN biblioitems USING (biblionumber)
1930 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1933 AND item_level_request = 0
1934 AND hold_fill_targets.itemnumber = ?
1935 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1939 $sth = $dbh->prepare($title_level_target_query);
1940 $sth->execute($itemnumber, $lookahead||0);
1942 if ( my $data = $sth->fetchrow_hashref ) {
1943 push( @results, $data );
1945 return @results if @results;
1948 SELECT reserves.biblionumber AS biblionumber,
1949 reserves.borrowernumber AS borrowernumber,
1950 reserves.reservedate AS reservedate,
1951 reserves.waitingdate AS waitingdate,
1952 reserves.branchcode AS branchcode,
1953 reserves.cancellationdate AS cancellationdate,
1954 reserves.found AS found,
1955 reserves.reservenotes AS reservenotes,
1956 reserves.priority AS priority,
1957 reserves.timestamp AS timestamp,
1958 reserveconstraints.biblioitemnumber AS biblioitemnumber,
1959 reserves.itemnumber AS itemnumber,
1960 reserves.reserve_id AS reserve_id
1962 LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1963 WHERE reserves.biblionumber = ?
1964 AND ( ( reserveconstraints.biblioitemnumber = ?
1965 AND reserves.borrowernumber = reserveconstraints.borrowernumber
1966 AND reserves.reservedate = reserveconstraints.reservedate )
1967 OR reserves.constrainttype='a' )
1968 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1969 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1973 $sth = $dbh->prepare($query);
1974 $sth->execute( $biblio, $bibitem, $itemnumber, $lookahead||0);
1976 while ( my $data = $sth->fetchrow_hashref ) {
1977 push( @results, $data );
1982 =head2 _koha_notify_reserve
1984 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1986 Sends a notification to the patron that their hold has been filled (through
1987 ModReserveAffect, _not_ ModReserveFill)
1991 sub _koha_notify_reserve {
1992 my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1994 my $dbh = C4::Context->dbh;
1995 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
1997 # Try to get the borrower's email address
1998 my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber);
2000 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
2001 borrowernumber => $borrowernumber,
2002 message_name => 'Hold_Filled'
2005 my $sth = $dbh->prepare("
2008 WHERE borrowernumber = ?
2009 AND biblionumber = ?
2011 $sth->execute( $borrowernumber, $biblionumber );
2012 my $reserve = $sth->fetchrow_hashref;
2013 my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
2015 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
2017 my %letter_params = (
2018 module => 'reserves',
2019 branchcode => $reserve->{branchcode},
2021 'branches' => $branch_details,
2022 'borrowers' => $borrower,
2023 'biblio' => $biblionumber,
2024 'reserves' => $reserve,
2025 'items', $reserve->{'itemnumber'},
2027 substitute => { today => C4::Dates->new()->output() },
2030 my $notification_sent = 0; #Keeping track if a Hold_filled message is sent. If no message can be sent, then default to a print message.
2031 my $send_notification = sub {
2032 my ( $mtt, $letter_code ) = (@_);
2033 return unless defined $letter_code;
2034 $letter_params{letter_code} = $letter_code;
2035 $letter_params{message_transport_type} = $mtt;
2036 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
2038 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
2042 C4::Letters::EnqueueLetter( {
2044 borrowernumber => $borrowernumber,
2045 from_address => $admin_email_address,
2046 message_transport_type => $mtt,
2050 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
2051 if ( ($mtt eq 'email' and not $to_address) or ($mtt eq 'sms' and not $borrower->{smsalertnumber}) ) {
2052 # email or sms is requested but not exist
2055 &$send_notification($mtt, $letter_code);
2056 $notification_sent++;
2058 #Making sure that a print notification is sent if no other transport types can be utilized.
2059 if (! $notification_sent) {
2060 &$send_notification('print', 'HOLD');
2065 =head2 _ShiftPriorityByDateAndPriority
2067 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
2069 This increments the priority of all reserves after the one
2070 with either the lowest date after C<$reservedate>
2071 or the lowest priority after C<$priority>.
2073 It effectively makes room for a new reserve to be inserted with a certain
2074 priority, which is returned.
2076 This is most useful when the reservedate can be set by the user. It allows
2077 the new reserve to be placed before other reserves that have a later
2078 reservedate. Since priority also is set by the form in reserves/request.pl
2079 the sub accounts for that too.
2083 sub _ShiftPriorityByDateAndPriority {
2084 my ( $biblio, $resdate, $new_priority ) = @_;
2086 my $dbh = C4::Context->dbh;
2087 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
2088 my $sth = $dbh->prepare( $query );
2089 $sth->execute( $biblio, $resdate, $new_priority );
2090 my $min_priority = $sth->fetchrow;
2091 # if no such matches are found, $new_priority remains as original value
2092 $new_priority = $min_priority if ( $min_priority );
2094 # Shift the priority up by one; works in conjunction with the next SQL statement
2095 $query = "UPDATE reserves
2096 SET priority = priority+1
2097 WHERE biblionumber = ?
2098 AND borrowernumber = ?
2101 my $sth_update = $dbh->prepare( $query );
2103 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
2104 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
2105 $sth = $dbh->prepare( $query );
2106 $sth->execute( $new_priority, $biblio );
2107 while ( my $row = $sth->fetchrow_hashref ) {
2108 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
2111 return $new_priority; # so the caller knows what priority they wind up receiving
2116 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
2118 Use when checking out an item to handle reserves
2119 If $cancelreserve boolean is set to true, it will remove existing reserve
2124 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
2126 my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber );
2129 my $biblionumber = $res->{biblionumber};
2130 my $biblioitemnumber = $res->{biblioitemnumber};
2132 if ($res->{borrowernumber} == $borrowernumber) {
2133 ModReserveFill($res);
2137 # The item is reserved by someone else.
2138 # Find this item in the reserves
2141 foreach (@$all_reserves) {
2142 $_->{'borrowernumber'} == $borrowernumber or next;
2143 $_->{'biblionumber'} == $biblionumber or next;
2150 # The item is reserved by the current patron
2151 ModReserveFill($borr_res);
2154 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2155 RevertWaitingStatus({ itemnumber => $itemnumber });
2157 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2159 biblionumber => $res->{'biblionumber'},
2160 itemnumber => $res->{'itemnumber'},
2161 borrowernumber => $res->{'borrowernumber'}
2169 MergeHolds($dbh,$to_biblio, $from_biblio);
2171 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2176 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2177 my $sth = $dbh->prepare(
2178 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2180 $sth->execute($from_biblio);
2181 if ( my $data = $sth->fetchrow_hashref() ) {
2183 # holds exist on old record, if not we don't need to do anything
2184 $sth = $dbh->prepare(
2185 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2186 $sth->execute( $to_biblio, $from_biblio );
2189 # don't reorder those already waiting
2191 $sth = $dbh->prepare(
2192 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2194 my $upd_sth = $dbh->prepare(
2195 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2196 AND reservedate = ? AND constrainttype = ? AND (itemnumber = ? or itemnumber is NULL) "
2198 $sth->execute( $to_biblio, 'W', 'T' );
2200 while ( my $reserve = $sth->fetchrow_hashref() ) {
2202 $priority, $to_biblio,
2203 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2204 $reserve->{'constrainttype'}, $reserve->{'itemnumber'}
2211 =head2 RevertWaitingStatus
2213 RevertWaitingStatus({ itemnumber => $itemnumber });
2215 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2217 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2218 item level hold, even if it was only a bibliolevel hold to
2219 begin with. This is because we can no longer know if a hold
2220 was item-level or bib-level after a hold has been set to
2225 sub RevertWaitingStatus {
2226 my ( $params ) = @_;
2227 my $itemnumber = $params->{'itemnumber'};
2229 return unless ( $itemnumber );
2231 my $dbh = C4::Context->dbh;
2233 ## Get the waiting reserve we want to revert
2235 SELECT * FROM reserves
2236 WHERE itemnumber = ?
2237 AND found IS NOT NULL
2239 my $sth = $dbh->prepare( $query );
2240 $sth->execute( $itemnumber );
2241 my $reserve = $sth->fetchrow_hashref();
2243 ## Increment the priority of all other non-waiting
2244 ## reserves for this bib record
2248 priority = priority + 1
2254 $sth = $dbh->prepare( $query );
2255 $sth->execute( $reserve->{'biblionumber'} );
2257 ## Fix up the currently waiting reserve
2267 $sth = $dbh->prepare( $query );
2268 $sth->execute( $reserve->{'reserve_id'} );
2269 _FixPriority( { biblionumber => $reserve->{biblionumber} } );
2274 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2276 Returnes the first reserve id that matches the given criteria
2281 my ( $params ) = @_;
2283 return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2285 my $dbh = C4::Context->dbh();
2287 my $sql = "SELECT reserve_id FROM reserves WHERE ";
2291 foreach my $key ( keys %$params ) {
2292 if ( defined( $params->{$key} ) ) {
2293 push( @limits, "$key = ?" );
2294 push( @params, $params->{$key} );
2298 $sql .= join( " AND ", @limits );
2300 my $sth = $dbh->prepare( $sql );
2301 $sth->execute( @params );
2302 my $row = $sth->fetchrow_hashref();
2304 return $row->{'reserve_id'};
2309 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2311 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2316 my ($branch, $borrowernumber, $biblionumber) = @_;
2318 # return unless ( C4::Context->boolean_preference('printreserveslips') );
2320 my $reserve_id = GetReserveId({
2321 biblionumber => $biblionumber,
2322 borrowernumber => $borrowernumber
2324 my $reserve = GetReserveInfo($reserve_id) or return;
2326 return C4::Letters::GetPreparedLetter (
2327 module => 'circulation',
2328 letter_code => 'RESERVESLIP',
2329 branchcode => $branch,
2331 'reserves' => $reserve,
2332 'branches' => $reserve->{branchcode},
2333 'borrowers' => $reserve->{borrowernumber},
2334 'biblio' => $reserve->{biblionumber},
2335 'items' => $reserve->{itemnumber},
2340 =head2 GetReservesControlBranch
2342 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2344 Return the branchcode to be used to determine which reserves
2345 policy applies to a transaction.
2347 C<$item> is a hashref for an item. Only 'homebranch' is used.
2349 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2353 sub GetReservesControlBranch {
2354 my ( $item, $borrower ) = @_;
2356 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2359 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2360 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2366 =head2 CalculatePriority
2368 my $p = CalculatePriority($biblionumber, $resdate);
2370 Calculate priority for a new reserve on biblionumber, placing it at
2371 the end of the line of all holds whose start date falls before
2372 the current system time and that are neither on the hold shelf
2375 The reserve date parameter is optional; if it is supplied, the
2376 priority is based on the set of holds whose start date falls before
2377 the parameter value.
2379 After calculation of this priority, it is recommended to call
2380 _ShiftPriorityByDateAndPriority. Note that this is currently done in
2385 sub CalculatePriority {
2386 my ( $biblionumber, $resdate ) = @_;
2389 SELECT COUNT(*) FROM reserves
2390 WHERE biblionumber = ?
2392 AND (found IS NULL OR found = '')
2394 #skip found==W or found==T (waiting or transit holds)
2396 $sql.= ' AND ( reservedate <= ? )';
2399 $sql.= ' AND ( reservedate < NOW() )';
2401 my $dbh = C4::Context->dbh();
2402 my @row = $dbh->selectrow_array(
2405 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2408 return @row ? $row[0]+1 : 1;
2413 Koha Development Team <http://koha-community.org/>