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 $error = &CanBookBeReserved($borrowernumber, $biblionumber)
455 sub CanBookBeReserved{
456 my ($borrowernumber, $biblionumber) = @_;
458 my $items = GetItemnumbersForBiblio($biblionumber);
459 #get items linked via host records
460 my @hostitems = get_hostitemnumbers_of($biblionumber);
462 push (@$items,@hostitems);
465 foreach my $item (@$items){
466 return 1 if CanItemBeReserved($borrowernumber, $item);
471 =head2 CanItemBeReserved
473 $error = &CanItemBeReserved($borrowernumber, $itemnumber)
475 This function return 1 if an item can be issued by this borrower.
479 sub CanItemBeReserved{
480 my ($borrowernumber, $itemnumber) = @_;
482 my $dbh = C4::Context->dbh;
483 my $ruleitemtype; # itemtype of the matching issuing rule
484 my $allowedreserves = 0;
486 # we retrieve borrowers and items informations #
487 # item->{itype} will come for biblioitems if necessery
488 my $item = GetItem($itemnumber);
490 # If an item is damaged and we don't allow holds on damaged items
, we can stop right here
491 return 0 if ( $item->{damaged
} && !C4
::Context
->preference('AllowHoldsOnDamagedItems') );
493 my $borrower = C4
::Members
::GetMember
('borrowernumber'=>$borrowernumber);
495 my $controlbranch = C4
::Context
->preference('ReservesControlBranch');
496 my $itemtypefield = C4
::Context
->preference('item-level_itypes') ?
"itype" : "itemtype";
498 # we retrieve user rights on this itemtype and branchcode
499 my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
501 WHERE (categorycode in (?,'*') )
502 AND (itemtype IN (?,'*'))
503 AND (branchcode IN (?,'*'))
510 my $querycount ="SELECT
513 LEFT JOIN items USING (itemnumber)
514 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
515 LEFT JOIN borrowers USING (borrowernumber)
516 WHERE borrowernumber = ?
521 my $branchfield = "reserves.branchcode";
523 if( $controlbranch eq "ItemHomeLibrary" ){
524 $branchfield = "items.homebranch";
525 $branchcode = $item->{homebranch
};
526 }elsif( $controlbranch eq "PatronLibrary" ){
527 $branchfield = "borrowers.branchcode";
528 $branchcode = $borrower->{branchcode
};
532 $sth->execute($borrower->{'categorycode'}, $item->{'itype'}, $branchcode);
533 if(my $rights = $sth->fetchrow_hashref()){
534 $ruleitemtype = $rights->{itemtype
};
535 $allowedreserves = $rights->{reservesallowed
};
542 $querycount .= "AND $branchfield = ?";
544 $querycount .= " AND $itemtypefield = ?" if ($ruleitemtype ne "*");
545 my $sthcount = $dbh->prepare($querycount);
547 if($ruleitemtype eq "*"){
548 $sthcount->execute($borrowernumber, $branchcode);
550 $sthcount->execute($borrowernumber, $branchcode, $ruleitemtype);
553 my $reservecount = "0";
554 if(my $rowcount = $sthcount->fetchrow_hashref()){
555 $reservecount = $rowcount->{count
};
558 # we check if it's ok or not
559 if( $reservecount >= $allowedreserves ){
563 # If reservecount is ok, we check item branch if IndependentBranches is ON
564 # and canreservefromotherbranches is OFF
565 if ( C4
::Context
->preference('IndependentBranches')
566 and !C4
::Context
->preference('canreservefromotherbranches') )
568 my $itembranch = $item->{homebranch
};
569 if ($itembranch ne $borrower->{branchcode
}) {
577 =head2 CanReserveBeCanceledFromOpac
579 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
581 returns 1 if reserve can be cancelled by user from OPAC.
582 First check if reserve belongs to user, next checks if reserve is not in
583 transfer or waiting status
587 sub CanReserveBeCanceledFromOpac
{
588 my ($reserve_id, $borrowernumber) = @_;
590 return unless $reserve_id and $borrowernumber;
591 my $reserve = GetReserve
($reserve_id);
593 return 0 unless $reserve->{borrowernumber
} == $borrowernumber;
594 return 0 if ( $reserve->{found
} eq 'W' ) or ( $reserve->{found
} eq 'T' );
600 #--------------------------------------------------------------------------------
601 =head2 GetReserveCount
603 $number = &GetReserveCount($borrowernumber);
605 this function returns the number of reservation for a borrower given on input arg.
609 sub GetReserveCount
{
610 my ($borrowernumber) = @_;
612 my $dbh = C4
::Context
->dbh;
615 SELECT COUNT(*) AS counter
617 WHERE borrowernumber = ?
619 my $sth = $dbh->prepare($query);
620 $sth->execute($borrowernumber);
621 my $row = $sth->fetchrow_hashref;
622 return $row->{counter
};
625 =head2 GetOtherReserves
627 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
629 Check queued list of this document and check if this document must be transfered
633 sub GetOtherReserves
{
634 my ($itemnumber) = @_;
637 my ( undef, $checkreserves, undef ) = CheckReserves
($itemnumber);
638 if ($checkreserves) {
639 my $iteminfo = GetItem
($itemnumber);
640 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
641 $messages->{'transfert'} = $checkreserves->{'branchcode'};
642 #minus priorities of others reservs
643 ModReserveMinusPriority
(
645 $checkreserves->{'reserve_id'},
648 #launch the subroutine dotransfer
649 C4
::Items
::ModItemTransfer
(
651 $iteminfo->{'holdingbranch'},
652 $checkreserves->{'branchcode'}
657 #step 2b : case of a reservation on the same branch, set the waiting status
659 $messages->{'waiting'} = 1;
660 ModReserveMinusPriority
(
662 $checkreserves->{'reserve_id'},
664 ModReserveStatus
($itemnumber,'W');
667 $nextreservinfo = $checkreserves->{'borrowernumber'};
670 return ( $messages, $nextreservinfo );
675 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
677 Calculate the fee for a reserve
682 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
685 my $dbh = C4
::Context
->dbh;
686 my $const = lc substr( $constraint, 0, 1 );
688 SELECT
* FROM borrowers
689 LEFT JOIN categories ON borrowers
.categorycode
= categories
.categorycode
690 WHERE borrowernumber
= ?
692 my $sth = $dbh->prepare($query);
693 $sth->execute($borrowernumber);
694 my $data = $sth->fetchrow_hashref;
695 my $fee = $data->{'reservefee'};
696 my $cntitems = @
- > $bibitems;
700 # check for items on issue
701 # first find biblioitem records
703 my $sth1 = $dbh->prepare(
704 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
705 WHERE (biblio.biblionumber = ?)"
707 $sth1->execute($biblionumber);
708 while ( my $data1 = $sth1->fetchrow_hashref ) {
709 if ( $const eq "a" ) {
710 push @biblioitems, $data1;
715 while ( $x < $cntitems ) {
716 if ( @
$bibitems->{'biblioitemnumber'} ==
717 $data->{'biblioitemnumber'} )
723 if ( $const eq 'o' ) {
725 push @biblioitems, $data1;
730 push @biblioitems, $data1;
735 my $cntitemsfound = @biblioitems;
739 while ( $x < $cntitemsfound ) {
740 my $bitdata = $biblioitems[$x];
741 my $sth2 = $dbh->prepare(
743 WHERE biblioitemnumber = ?"
745 $sth2->execute( $bitdata->{'biblioitemnumber'} );
746 while ( my $itdata = $sth2->fetchrow_hashref ) {
747 my $sth3 = $dbh->prepare(
748 "SELECT * FROM issues
749 WHERE itemnumber = ?"
751 $sth3->execute( $itdata->{'itemnumber'} );
752 if ( my $isdata = $sth3->fetchrow_hashref ) {
760 if ( $allissued == 0 ) {
762 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
763 $rsth->execute($biblionumber);
764 if ( my $rdata = $rsth->fetchrow_hashref ) {
774 =head2 GetReservesToBranch
776 @transreserv = GetReservesToBranch( $frombranch );
778 Get reserve list for a given branch
782 sub GetReservesToBranch
{
783 my ( $frombranch ) = @_;
784 my $dbh = C4
::Context
->dbh;
785 my $sth = $dbh->prepare(
786 "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
791 $sth->execute( $frombranch );
794 while ( my $data = $sth->fetchrow_hashref ) {
795 $transreserv[$i] = $data;
798 return (@transreserv);
801 =head2 GetReservesForBranch
803 @transreserv = GetReservesForBranch($frombranch);
807 sub GetReservesForBranch
{
808 my ($frombranch) = @_;
809 my $dbh = C4
::Context
->dbh;
812 SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate
817 $query .= " AND branchcode=? " if ( $frombranch );
818 $query .= "ORDER BY waitingdate" ;
820 my $sth = $dbh->prepare($query);
822 $sth->execute($frombranch);
829 while ( my $data = $sth->fetchrow_hashref ) {
830 $transreserv[$i] = $data;
833 return (@transreserv);
836 =head2 GetReserveStatus
838 $reservestatus = GetReserveStatus($itemnumber, $biblionumber);
840 Take an itemnumber or a biblionumber and return the status of the reserve places on it.
841 If several reserves exist, the reserve with the lower priority is given.
845 ## FIXME: I don't think this does what it thinks it does.
846 ## It only ever checks the first reserve result, even though
847 ## multiple reserves for that bib can have the itemnumber set
848 ## the sub is only used once in the codebase.
849 sub GetReserveStatus
{
850 my ($itemnumber, $biblionumber) = @_;
852 my $dbh = C4
::Context
->dbh;
854 my ($sth, $found, $priority);
856 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
857 $sth->execute($itemnumber);
858 ($found, $priority) = $sth->fetchrow_array;
861 if ( $biblionumber and not defined $found and not defined $priority ) {
862 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE biblionumber = ? order by priority LIMIT 1");
863 $sth->execute($biblionumber);
864 ($found, $priority) = $sth->fetchrow_array;
868 return 'Waiting' if $found eq 'W' and $priority == 0;
869 return 'Finished' if $found eq 'F';
872 return 'Reserved' if $priority > 0;
874 return ''; # empty string here will remove need for checking undef, or less log lines
879 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
880 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
881 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
883 Find a book in the reserves.
885 C<$itemnumber> is the book's item number.
886 C<$lookahead> is the number of days to look in advance for future reserves.
888 As I understand it, C<&CheckReserves> looks for the given item in the
889 reserves. If it is found, that's a match, and C<$status> is set to
892 Otherwise, it finds the most important item in the reserves with the
893 same biblio number as this book (I'm not clear on this) and returns it
894 with C<$status> set to C<Reserved>.
896 C<&CheckReserves> returns a two-element list:
898 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
900 C<$reserve> is the reserve item that matched. It is a
901 reference-to-hash whose keys are mostly the fields of the reserves
902 table in the Koha database.
907 my ( $item, $barcode, $lookahead_days) = @_;
908 my $dbh = C4
::Context
->dbh;
911 if (C4
::Context
->preference('item-level_itypes')){
913 SELECT items.biblionumber,
914 items.biblioitemnumber,
915 itemtypes.notforloan,
916 items.notforloan AS itemnotforloan,
920 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
921 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
926 SELECT items.biblionumber,
927 items.biblioitemnumber,
928 itemtypes.notforloan,
929 items.notforloan AS itemnotforloan,
933 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
934 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
939 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
940 $sth->execute($item);
943 $sth = $dbh->prepare("$select WHERE barcode = ?");
944 $sth->execute($barcode);
946 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
947 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged ) = $sth->fetchrow_array;
949 return if ( $damaged && !C4
::Context
->preference('AllowHoldsOnDamagedItems') );
951 return unless $itemnumber; # bail if we got nothing.
953 # if item is not for loan it cannot be reserved either.....
954 # execpt where items.notforloan < 0 : This indicates the item is holdable.
955 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
957 # Find this item in the reserves
958 my @reserves = _Findgroupreserve
( $bibitem, $biblio, $itemnumber, $lookahead_days);
960 # $priority and $highest are used to find the most important item
961 # in the list returned by &_Findgroupreserve. (The lower $priority,
962 # the more important the item.)
963 # $highest is the most important item we've seen so far.
965 if (scalar @reserves) {
966 my $priority = 10000000;
967 foreach my $res (@reserves) {
968 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
969 return ( "Waiting", $res, \
@reserves ); # Found it
971 # See if this item is more important than what we've got so far
972 if ( $res->{'priority'} && $res->{'priority'} < $priority ) {
973 my $borrowerinfo=C4
::Members
::GetMember
(borrowernumber
=> $res->{'borrowernumber'});
974 my $iteminfo=C4
::Items
::GetItem
($itemnumber);
975 my $branch = GetReservesControlBranch
( $iteminfo, $borrowerinfo );
976 my $branchitemrule = C4
::Circulation
::GetBranchItemRule
($branch,$iteminfo->{'itype'});
977 next if ($branchitemrule->{'holdallowed'} == 0);
978 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $borrowerinfo->{'branchcode'}));
979 $priority = $res->{'priority'};
986 # If we get this far, then no exact match was found.
987 # We return the most important (i.e. next) reservation.
989 $highest->{'itemnumber'} = $item;
990 return ( "Reserved", $highest, \
@reserves );
996 =head2 CancelExpiredReserves
998 CancelExpiredReserves();
1000 Cancels all reserves with an expiration date from before today.
1004 sub CancelExpiredReserves
{
1006 # Cancel reserves that have passed their expiration date.
1007 my $dbh = C4
::Context
->dbh;
1008 my $sth = $dbh->prepare( "
1009 SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
1010 AND expirationdate IS NOT NULL
1015 while ( my $res = $sth->fetchrow_hashref() ) {
1016 CancelReserve
({ reserve_id
=> $res->{'reserve_id'} });
1019 # Cancel reserves that have been waiting too long
1020 if ( C4
::Context
->preference("ExpireReservesMaxPickUpDelay") ) {
1021 my $max_pickup_delay = C4
::Context
->preference("ReservesMaxPickUpDelay");
1022 my $charge = C4
::Context
->preference("ExpireReservesMaxPickUpDelayCharge");
1023 my $cancel_on_holidays = C4
::Context
->preference('ExpireReservesOnHolidays');
1025 my $today = dt_from_string
();
1027 my $query = "SELECT * FROM reserves WHERE TO_DAYS( NOW() ) - TO_DAYS( waitingdate ) > ? AND found = 'W' AND priority = 0";
1028 $sth = $dbh->prepare( $query );
1029 $sth->execute( $max_pickup_delay );
1031 while ( my $res = $sth->fetchrow_hashref ) {
1033 unless ( $cancel_on_holidays ) {
1034 my $calendar = Koha
::Calendar
->new( branchcode
=> $res->{'branchcode'} );
1035 my $is_holiday = $calendar->is_holiday( $today );
1037 if ( $is_holiday ) {
1044 manualinvoice
($res->{'borrowernumber'}, $res->{'itemnumber'}, 'Hold waiting too long', 'F', $charge);
1047 CancelReserve
({ reserve_id
=> $res->{'reserve_id'} });
1054 =head2 AutoUnsuspendReserves
1056 AutoUnsuspendReserves();
1058 Unsuspends all suspended reserves with a suspend_until date from before today.
1062 sub AutoUnsuspendReserves
{
1064 my $dbh = C4
::Context
->dbh;
1066 my $query = "UPDATE reserves SET suspend = 0, suspend_until = NULL WHERE DATE( suspend_until ) < DATE( CURDATE() )";
1067 my $sth = $dbh->prepare( $query );
1072 =head2 CancelReserve
1074 CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber ] });
1081 my ( $params ) = @_;
1083 my $reserve_id = $params->{'reserve_id'};
1084 $reserve_id = GetReserveId
( $params ) unless ( $reserve_id );
1086 return unless ( $reserve_id );
1088 my $dbh = C4
::Context
->dbh;
1090 my $reserve = GetReserve
( $reserve_id );
1094 SET cancellationdate = now(),
1097 WHERE reserve_id = ?
1099 my $sth = $dbh->prepare($query);
1100 $sth->execute( $reserve_id );
1103 INSERT INTO old_reserves
1104 SELECT * FROM reserves
1105 WHERE reserve_id = ?
1107 $sth = $dbh->prepare($query);
1108 $sth->execute( $reserve_id );
1111 DELETE FROM reserves
1112 WHERE reserve_id = ?
1114 $sth = $dbh->prepare($query);
1115 $sth->execute( $reserve_id );
1117 # now fix the priority on the others....
1118 _FixPriority
({ biblionumber
=> $reserve->{biblionumber
} });
1126 ModReserve({ rank => $rank,
1127 reserve_id => $reserve_id,
1128 branchcode => $branchcode
1129 [, itemnumber => $itemnumber ]
1130 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1133 Change a hold request's priority or cancel it.
1135 C<$rank> specifies the effect of the change. If C<$rank>
1136 is 'W' or 'n', nothing happens. This corresponds to leaving a
1137 request alone when changing its priority in the holds queue
1140 If C<$rank> is 'del', the hold request is cancelled.
1142 If C<$rank> is an integer greater than zero, the priority of
1143 the request is set to that value. Since priority != 0 means
1144 that the item is not waiting on the hold shelf, setting the
1145 priority to a non-zero value also sets the request's found
1146 status and waiting date to NULL.
1148 The optional C<$itemnumber> parameter is used only when
1149 C<$rank> is a non-zero integer; if supplied, the itemnumber
1150 of the hold request is set accordingly; if omitted, the itemnumber
1153 B<FIXME:> Note that the forgoing can have the effect of causing
1154 item-level hold requests to turn into title-level requests. This
1155 will be fixed once reserves has separate columns for requested
1156 itemnumber and supplying itemnumber.
1161 my ( $params ) = @_;
1163 my $rank = $params->{'rank'};
1164 my $reserve_id = $params->{'reserve_id'};
1165 my $branchcode = $params->{'branchcode'};
1166 my $itemnumber = $params->{'itemnumber'};
1167 my $suspend_until = $params->{'suspend_until'};
1168 my $borrowernumber = $params->{'borrowernumber'};
1169 my $biblionumber = $params->{'biblionumber'};
1171 return if $rank eq "W";
1172 return if $rank eq "n";
1174 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1175 $reserve_id = GetReserveId
({ biblionumber
=> $biblionumber, borrowernumber
=> $borrowernumber, itemnumber
=> $itemnumber }) unless ( $reserve_id );
1177 my $dbh = C4
::Context
->dbh;
1178 if ( $rank eq "del" ) {
1179 CancelReserve
({ reserve_id
=> $reserve_id });
1181 elsif ($rank =~ /^\d+/ and $rank > 0) {
1183 UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
1184 WHERE reserve_id = ?
1186 my $sth = $dbh->prepare($query);
1187 $sth->execute( $rank, $branchcode, $itemnumber, $reserve_id );
1189 if ( defined( $suspend_until ) ) {
1190 if ( $suspend_until ) {
1191 $suspend_until = C4
::Dates
->new( $suspend_until )->output("iso");
1192 $dbh->do("UPDATE reserves SET suspend = 1, suspend_until = ? WHERE reserve_id = ?", undef, ( $suspend_until, $reserve_id ) );
1194 $dbh->do("UPDATE reserves SET suspend_until = NULL WHERE reserve_id = ?", undef, ( $reserve_id ) );
1198 _FixPriority
({ reserve_id
=> $reserve_id, rank
=>$rank });
1202 =head2 ModReserveFill
1204 &ModReserveFill($reserve);
1206 Fill a reserve. If I understand this correctly, this means that the
1207 reserved book has been found and given to the patron who reserved it.
1209 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1210 whose keys are fields from the reserves table in the Koha database.
1214 sub ModReserveFill
{
1216 my $dbh = C4
::Context
->dbh;
1217 # fill in a reserve record....
1218 my $reserve_id = $res->{'reserve_id'};
1219 my $biblionumber = $res->{'biblionumber'};
1220 my $borrowernumber = $res->{'borrowernumber'};
1221 my $resdate = $res->{'reservedate'};
1223 # get the priority on this record....
1225 my $query = "SELECT priority
1227 WHERE biblionumber = ?
1228 AND borrowernumber = ?
1229 AND reservedate = ?";
1230 my $sth = $dbh->prepare($query);
1231 $sth->execute( $biblionumber, $borrowernumber, $resdate );
1232 ($priority) = $sth->fetchrow_array;
1234 # update the database...
1235 $query = "UPDATE reserves
1238 WHERE biblionumber = ?
1240 AND borrowernumber = ?
1242 $sth = $dbh->prepare($query);
1243 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1245 # move to old_reserves
1246 $query = "INSERT INTO old_reserves
1247 SELECT * FROM reserves
1248 WHERE biblionumber = ?
1250 AND borrowernumber = ?
1252 $sth = $dbh->prepare($query);
1253 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1254 $query = "DELETE FROM reserves
1255 WHERE biblionumber = ?
1257 AND borrowernumber = ?
1259 $sth = $dbh->prepare($query);
1260 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1262 # now fix the priority on the others (if the priority wasn't
1263 # already sorted!)....
1264 unless ( $priority == 0 ) {
1265 _FixPriority
({ reserve_id
=> $reserve_id });
1269 =head2 ModReserveStatus
1271 &ModReserveStatus($itemnumber, $newstatus);
1273 Update the reserve status for the active (priority=0) reserve.
1275 $itemnumber is the itemnumber the reserve is on
1277 $newstatus is the new status.
1281 sub ModReserveStatus
{
1283 #first : check if we have a reservation for this item .
1284 my ($itemnumber, $newstatus) = @_;
1285 my $dbh = C4
::Context
->dbh;
1287 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1288 my $sth_set = $dbh->prepare($query);
1289 $sth_set->execute( $newstatus, $itemnumber );
1291 if ( C4
::Context
->preference("ReturnToShelvingCart") && $newstatus ) {
1292 CartToShelf
( $itemnumber );
1296 =head2 ModReserveAffect
1298 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
1300 This function affect an item and a status for a given reserve
1301 The itemnumber parameter is used to find the biblionumber.
1302 with the biblionumber & the borrowernumber, we can affect the itemnumber
1303 to the correct reserve.
1305 if $transferToDo is not set, then the status is set to "Waiting" as well.
1306 otherwise, a transfer is on the way, and the end of the transfer will
1307 take care of the waiting status
1311 sub ModReserveAffect
{
1312 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
1313 my $dbh = C4
::Context
->dbh;
1315 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1316 # attached to $itemnumber
1317 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1318 $sth->execute($itemnumber);
1319 my ($biblionumber) = $sth->fetchrow;
1321 # get request - need to find out if item is already
1322 # waiting in order to not send duplicate hold filled notifications
1323 my $reserve_id = GetReserveId
({
1324 borrowernumber
=> $borrowernumber,
1325 biblionumber
=> $biblionumber,
1327 return unless defined $reserve_id;
1328 my $request = GetReserveInfo
($reserve_id);
1329 my $already_on_shelf = ($request && $request->{found
} eq 'W') ?
1 : 0;
1331 # If we affect a reserve that has to be transfered, don't set to Waiting
1333 if ($transferToDo) {
1339 WHERE borrowernumber = ?
1340 AND biblionumber = ?
1344 # affect the reserve to Waiting as well.
1349 waitingdate = NOW(),
1351 WHERE borrowernumber = ?
1352 AND biblionumber = ?
1355 $sth = $dbh->prepare($query);
1356 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1357 _koha_notify_reserve
( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
1358 _FixPriority
( { biblionumber
=> $biblionumber } );
1359 if ( C4
::Context
->preference("ReturnToShelvingCart") ) {
1360 CartToShelf
( $itemnumber );
1366 =head2 ModReserveCancelAll
1368 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1370 function to cancel reserv,check other reserves, and transfer document if it's necessary
1374 sub ModReserveCancelAll
{
1377 my ( $itemnumber, $borrowernumber ) = @_;
1379 #step 1 : cancel the reservation
1380 my $CancelReserve = CancelReserve
({ itemnumber
=> $itemnumber, borrowernumber
=> $borrowernumber });
1382 #step 2 launch the subroutine of the others reserves
1383 ( $messages, $nextreservinfo ) = GetOtherReserves
($itemnumber);
1385 return ( $messages, $nextreservinfo );
1388 =head2 ModReserveMinusPriority
1390 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1392 Reduce the values of queued list
1396 sub ModReserveMinusPriority
{
1397 my ( $itemnumber, $reserve_id ) = @_;
1399 #first step update the value of the first person on reserv
1400 my $dbh = C4
::Context
->dbh;
1403 SET priority = 0 , itemnumber = ?
1404 WHERE reserve_id = ?
1406 my $sth_upd = $dbh->prepare($query);
1407 $sth_upd->execute( $itemnumber, $reserve_id );
1408 # second step update all others reserves
1409 _FixPriority
({ reserve_id
=> $reserve_id, rank
=> '0' });
1412 =head2 GetReserveInfo
1414 &GetReserveInfo($reserve_id);
1416 Get item and borrower details for a current hold.
1417 Current implementation this query should have a single result.
1421 sub GetReserveInfo
{
1422 my ( $reserve_id ) = @_;
1423 my $dbh = C4
::Context
->dbh;
1428 reserves.borrowernumber,
1429 reserves.biblionumber,
1430 reserves.branchcode,
1431 reserves.waitingdate,
1447 items.holdingbranch,
1448 items.itemcallnumber,
1454 LEFT JOIN items USING(itemnumber)
1455 LEFT JOIN borrowers USING(borrowernumber)
1456 LEFT JOIN biblio ON (reserves.biblionumber=biblio.biblionumber)
1457 WHERE reserves.reserve_id = ?";
1458 my $sth = $dbh->prepare($strsth);
1459 $sth->execute($reserve_id);
1461 my $data = $sth->fetchrow_hashref;
1465 =head2 IsAvailableForItemLevelRequest
1467 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1469 Checks whether a given item record is available for an
1470 item-level hold request. An item is available if
1472 * it is not lost AND
1473 * it is not damaged AND
1474 * it is not withdrawn AND
1475 * does not have a not for loan value > 0
1477 Whether or not the item is currently on loan is
1478 also checked - if the AllowOnShelfHolds system preference
1479 is ON, an item can be requested even if it is currently
1480 on loan to somebody else. If the system preference
1481 is OFF, an item that is currently checked out cannot
1482 be the target of an item-level hold request.
1484 Note that IsAvailableForItemLevelRequest() does not
1485 check if the staff operator is authorized to place
1486 a request on the item - in particular,
1487 this routine does not check IndependentBranches
1488 and canreservefromotherbranches.
1492 sub IsAvailableForItemLevelRequest
{
1493 my $itemnumber = shift;
1495 my $item = GetItem
($itemnumber);
1497 # must check the notforloan setting of the itemtype
1498 # FIXME - a lot of places in the code do this
1499 # or something similar - need to be
1501 my $dbh = C4
::Context
->dbh;
1502 my $notforloan_query;
1503 if (C4
::Context
->preference('item-level_itypes')) {
1504 $notforloan_query = "SELECT itemtypes.notforloan
1506 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1507 WHERE itemnumber = ?";
1509 $notforloan_query = "SELECT itemtypes.notforloan
1511 JOIN biblioitems USING (biblioitemnumber)
1512 JOIN itemtypes USING (itemtype)
1513 WHERE itemnumber = ?";
1515 my $sth = $dbh->prepare($notforloan_query);
1516 $sth->execute($itemnumber);
1517 my $notforloan_per_itemtype = 0;
1518 if (my ($notforloan) = $sth->fetchrow_array) {
1519 $notforloan_per_itemtype = 1 if $notforloan;
1522 my $available_per_item = 1;
1523 $available_per_item = 0 if $item->{itemlost
} or
1524 ( $item->{notforloan
} > 0 ) or
1525 ($item->{damaged
} and not C4
::Context
->preference('AllowHoldsOnDamagedItems')) or
1526 $item->{withdrawn
} or
1527 $notforloan_per_itemtype;
1530 if (C4
::Context
->preference('AllowOnShelfHolds')) {
1531 return $available_per_item;
1533 return ($available_per_item and ($item->{onloan
} or GetReserveStatus
($itemnumber) eq "Waiting"));
1537 =head2 AlterPriority
1539 AlterPriority( $where, $reserve_id );
1541 This function changes a reserve's priority up, down, to the top, or to the bottom.
1542 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1547 my ( $where, $reserve_id ) = @_;
1549 my $dbh = C4
::Context
->dbh;
1551 my $reserve = GetReserve
( $reserve_id );
1553 if ( $reserve->{cancellationdate
} ) {
1554 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate
}.')';
1558 if ( $where eq 'up' || $where eq 'down' ) {
1560 my $priority = $reserve->{'priority'};
1561 $priority = $where eq 'up' ?
$priority - 1 : $priority + 1;
1562 _FixPriority
({ reserve_id
=> $reserve_id, rank
=> $priority })
1564 } elsif ( $where eq 'top' ) {
1566 _FixPriority
({ reserve_id
=> $reserve_id, rank
=> '1' })
1568 } elsif ( $where eq 'bottom' ) {
1570 _FixPriority
({ reserve_id
=> $reserve_id, rank
=> '999999' });
1575 =head2 ToggleLowestPriority
1577 ToggleLowestPriority( $borrowernumber, $biblionumber );
1579 This function sets the lowestPriority field to true if is false, and false if it is true.
1583 sub ToggleLowestPriority
{
1584 my ( $reserve_id ) = @_;
1586 my $dbh = C4
::Context
->dbh;
1588 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1589 $sth->execute( $reserve_id );
1591 _FixPriority
({ reserve_id
=> $reserve_id, rank
=> '999999' });
1594 =head2 ToggleSuspend
1596 ToggleSuspend( $reserve_id );
1598 This function sets the suspend field to true if is false, and false if it is true.
1599 If the reserve is currently suspended with a suspend_until date, that date will
1600 be cleared when it is unsuspended.
1605 my ( $reserve_id, $suspend_until ) = @_;
1607 $suspend_until = output_pref
(
1609 dt
=> dt_from_string
($suspend_until),
1610 dateformat
=> 'iso',
1613 ) if ($suspend_until);
1615 my $do_until = ( $suspend_until ) ?
'?' : 'NULL';
1617 my $dbh = C4
::Context
->dbh;
1619 my $sth = $dbh->prepare(
1620 "UPDATE reserves SET suspend = NOT suspend,
1621 suspend_until = CASE WHEN suspend = 0 THEN NULL ELSE $do_until END
1622 WHERE reserve_id = ?
1626 push( @params, $suspend_until ) if ( $suspend_until );
1627 push( @params, $reserve_id );
1629 $sth->execute( @params );
1635 borrowernumber => $borrowernumber,
1636 [ biblionumber => $biblionumber, ]
1637 [ suspend_until => $suspend_until, ]
1638 [ suspend => $suspend ]
1641 This function accepts a set of hash keys as its parameters.
1642 It requires either borrowernumber or biblionumber, or both.
1644 suspend_until is wholly optional.
1651 my $borrowernumber = $params{'borrowernumber'} || undef;
1652 my $biblionumber = $params{'biblionumber'} || undef;
1653 my $suspend_until = $params{'suspend_until'} || undef;
1654 my $suspend = defined( $params{'suspend'} ) ?
$params{'suspend'} : 1;
1656 $suspend_until = C4
::Dates
->new( $suspend_until )->output("iso") if ( defined( $suspend_until ) );
1658 return unless ( $borrowernumber || $biblionumber );
1660 my ( $query, $sth, $dbh, @query_params );
1662 $query = "UPDATE reserves SET suspend = ? ";
1663 push( @query_params, $suspend );
1665 $query .= ", suspend_until = NULL ";
1666 } elsif ( $suspend_until ) {
1667 $query .= ", suspend_until = ? ";
1668 push( @query_params, $suspend_until );
1670 $query .= " WHERE ";
1671 if ( $borrowernumber ) {
1672 $query .= " borrowernumber = ? ";
1673 push( @query_params, $borrowernumber );
1675 $query .= " AND " if ( $borrowernumber && $biblionumber );
1676 if ( $biblionumber ) {
1677 $query .= " biblionumber = ? ";
1678 push( @query_params, $biblionumber );
1680 $query .= " AND found IS NULL ";
1682 $dbh = C4
::Context
->dbh;
1683 $sth = $dbh->prepare( $query );
1684 $sth->execute( @query_params );
1691 reserve_id => $reserve_id,
1693 [ignoreSetLowestRank => $ignoreSetLowestRank]
1698 _FixPriority({ biblionumber => $biblionumber});
1700 This routine adjusts the priority of a hold request and holds
1703 In the first form, where a reserve_id is passed, the priority of the
1704 hold is set to supplied rank, and other holds for that bib are adjusted
1705 accordingly. If the rank is "del", the hold is cancelled. If no rank
1706 is supplied, all of the holds on that bib have their priority adjusted
1707 as if the second form had been used.
1709 In the second form, where a biblionumber is passed, the holds on that
1710 bib (that are not captured) are sorted in order of increasing priority,
1711 then have reserves.priority set so that the first non-captured hold
1712 has its priority set to 1, the second non-captured hold has its priority
1713 set to 2, and so forth.
1715 In both cases, holds that have the lowestPriority flag on are have their
1716 priority adjusted to ensure that they remain at the end of the line.
1718 Note that the ignoreSetLowestRank parameter is meant to be used only
1719 when _FixPriority calls itself.
1724 my ( $params ) = @_;
1725 my $reserve_id = $params->{reserve_id
};
1726 my $rank = $params->{rank
} // '';
1727 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank
};
1728 my $biblionumber = $params->{biblionumber
};
1730 my $dbh = C4
::Context
->dbh;
1732 unless ( $biblionumber ) {
1733 my $res = GetReserve
( $reserve_id );
1734 $biblionumber = $res->{biblionumber
};
1737 if ( $rank eq "del" ) {
1738 CancelReserve
({ reserve_id
=> $reserve_id });
1740 elsif ( $rank eq "W" || $rank eq "0" ) {
1742 # make sure priority for waiting or in-transit items is 0
1746 WHERE reserve_id = ?
1747 AND found IN ('W', 'T')
1749 my $sth = $dbh->prepare($query);
1750 $sth->execute( $reserve_id );
1756 SELECT reserve_id, borrowernumber, reservedate, constrainttype
1758 WHERE biblionumber = ?
1759 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1760 ORDER BY priority ASC
1762 my $sth = $dbh->prepare($query);
1763 $sth->execute( $biblionumber );
1764 while ( my $line = $sth->fetchrow_hashref ) {
1765 push( @priority, $line );
1768 # To find the matching index
1770 my $key = -1; # to allow for 0 to be a valid result
1771 for ( $i = 0 ; $i < @priority ; $i++ ) {
1772 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1773 $key = $i; # save the index
1778 # if index exists in array then move it to new position
1779 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1780 my $new_rank = $rank -
1781 1; # $new_rank is what you want the new index to be in the array
1782 my $moving_item = splice( @priority, $key, 1 );
1783 splice( @priority, $new_rank, 0, $moving_item );
1786 # now fix the priority on those that are left....
1790 WHERE reserve_id = ?
1792 $sth = $dbh->prepare($query);
1793 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1796 $priority[$j]->{'reserve_id'}
1800 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1803 unless ( $ignoreSetLowestRank ) {
1804 while ( my $res = $sth->fetchrow_hashref() ) {
1806 reserve_id
=> $res->{'reserve_id'},
1808 ignoreSetLowestRank
=> 1
1814 =head2 _Findgroupreserve
1816 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead);
1818 Looks for an item-specific match first, then for a title-level match, returning the
1819 first match found. If neither, then we look for a 3rd kind of match based on
1820 reserve constraints.
1821 Lookahead is the number of days to look in advance.
1823 TODO: add more explanation about reserve constraints
1825 C<&_Findgroupreserve> returns :
1826 C<@results> is an array of references-to-hash whose keys are mostly
1827 fields from the reserves table of the Koha database, plus
1828 C<biblioitemnumber>.
1832 sub _Findgroupreserve
{
1833 my ( $bibitem, $biblio, $itemnumber, $lookahead) = @_;
1834 my $dbh = C4
::Context
->dbh;
1836 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1837 # check for exact targetted match
1838 my $item_level_target_query = qq/
1839 SELECT reserves
.biblionumber AS biblionumber
,
1840 reserves
.borrowernumber AS borrowernumber
,
1841 reserves
.reservedate AS reservedate
,
1842 reserves
.branchcode AS branchcode
,
1843 reserves
.cancellationdate AS cancellationdate
,
1844 reserves
.found AS found
,
1845 reserves
.reservenotes AS reservenotes
,
1846 reserves
.priority AS priority
,
1847 reserves
.timestamp AS timestamp
,
1848 biblioitems
.biblioitemnumber AS biblioitemnumber
,
1849 reserves
.itemnumber AS itemnumber
,
1850 reserves
.reserve_id AS reserve_id
1852 JOIN biblioitems USING
(biblionumber
)
1853 JOIN hold_fill_targets USING
(biblionumber
, borrowernumber
, itemnumber
)
1856 AND item_level_request
= 1
1858 AND reservedate
<= DATE_ADD
(NOW
(),INTERVAL ? DAY
)
1861 my $sth = $dbh->prepare($item_level_target_query);
1862 $sth->execute($itemnumber, $lookahead||0);
1864 if ( my $data = $sth->fetchrow_hashref ) {
1865 push( @results, $data );
1867 return @results if @results;
1869 # check for title-level targetted match
1870 my $title_level_target_query = qq/
1871 SELECT reserves
.biblionumber AS biblionumber
,
1872 reserves
.borrowernumber AS borrowernumber
,
1873 reserves
.reservedate AS reservedate
,
1874 reserves
.branchcode AS branchcode
,
1875 reserves
.cancellationdate AS cancellationdate
,
1876 reserves
.found AS found
,
1877 reserves
.reservenotes AS reservenotes
,
1878 reserves
.priority AS priority
,
1879 reserves
.timestamp AS timestamp
,
1880 biblioitems
.biblioitemnumber AS biblioitemnumber
,
1881 reserves
.itemnumber AS itemnumber
,
1882 reserves
.reserve_id AS reserve_id
1884 JOIN biblioitems USING
(biblionumber
)
1885 JOIN hold_fill_targets USING
(biblionumber
, borrowernumber
)
1888 AND item_level_request
= 0
1889 AND hold_fill_targets
.itemnumber
= ?
1890 AND reservedate
<= DATE_ADD
(NOW
(),INTERVAL ? DAY
)
1893 $sth = $dbh->prepare($title_level_target_query);
1894 $sth->execute($itemnumber, $lookahead||0);
1896 if ( my $data = $sth->fetchrow_hashref ) {
1897 push( @results, $data );
1899 return @results if @results;
1902 SELECT reserves
.biblionumber AS biblionumber
,
1903 reserves
.borrowernumber AS borrowernumber
,
1904 reserves
.reservedate AS reservedate
,
1905 reserves
.waitingdate AS waitingdate
,
1906 reserves
.branchcode AS branchcode
,
1907 reserves
.cancellationdate AS cancellationdate
,
1908 reserves
.found AS found
,
1909 reserves
.reservenotes AS reservenotes
,
1910 reserves
.priority AS priority
,
1911 reserves
.timestamp AS timestamp
,
1912 reserveconstraints
.biblioitemnumber AS biblioitemnumber
,
1913 reserves
.itemnumber AS itemnumber
,
1914 reserves
.reserve_id AS reserve_id
1916 LEFT JOIN reserveconstraints ON reserves
.biblionumber
= reserveconstraints
.biblionumber
1917 WHERE reserves
.biblionumber
= ?
1918 AND
( ( reserveconstraints
.biblioitemnumber
= ?
1919 AND reserves
.borrowernumber
= reserveconstraints
.borrowernumber
1920 AND reserves
.reservedate
= reserveconstraints
.reservedate
)
1921 OR reserves
.constrainttype
='a' )
1922 AND
(reserves
.itemnumber IS NULL OR reserves
.itemnumber
= ?
)
1923 AND reserves
.reservedate
<= DATE_ADD
(NOW
(),INTERVAL ? DAY
)
1926 $sth = $dbh->prepare($query);
1927 $sth->execute( $biblio, $bibitem, $itemnumber, $lookahead||0);
1929 while ( my $data = $sth->fetchrow_hashref ) {
1930 push( @results, $data );
1935 =head2 _koha_notify_reserve
1937 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1939 Sends a notification to the patron that their hold has been filled (through
1940 ModReserveAffect, _not_ ModReserveFill)
1944 sub _koha_notify_reserve
{
1945 my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1947 my $dbh = C4
::Context
->dbh;
1948 my $borrower = C4
::Members
::GetMember
(borrowernumber
=> $borrowernumber);
1950 # Try to get the borrower's email address
1951 my $to_address = C4
::Members
::GetNoticeEmailAddress
($borrowernumber);
1953 my $messagingprefs = C4
::Members
::Messaging
::GetMessagingPreferences
( {
1954 borrowernumber
=> $borrowernumber,
1955 message_name
=> 'Hold_Filled'
1958 my $sth = $dbh->prepare("
1961 WHERE borrowernumber = ?
1962 AND biblionumber = ?
1964 $sth->execute( $borrowernumber, $biblionumber );
1965 my $reserve = $sth->fetchrow_hashref;
1966 my $branch_details = GetBranchDetail
( $reserve->{'branchcode'} );
1968 my $admin_email_address = $branch_details->{'branchemail'} || C4
::Context
->preference('KohaAdminEmailAddress');
1970 my %letter_params = (
1971 module
=> 'reserves',
1972 branchcode
=> $reserve->{branchcode
},
1974 'branches' => $branch_details,
1975 'borrowers' => $borrower,
1976 'biblio' => $biblionumber,
1977 'reserves' => $reserve,
1978 'items', $reserve->{'itemnumber'},
1980 substitute
=> { today
=> C4
::Dates
->new()->output() },
1983 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.
1984 my $send_notification = sub {
1985 my ( $mtt, $letter_code ) = (@_);
1986 return unless defined $letter_code;
1987 $letter_params{letter_code
} = $letter_code;
1988 $letter_params{message_transport_type
} = $mtt;
1989 my $letter = C4
::Letters
::GetPreparedLetter
( %letter_params );
1991 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1995 C4
::Letters
::EnqueueLetter
( {
1997 borrowernumber
=> $borrowernumber,
1998 from_address
=> $admin_email_address,
1999 message_transport_type
=> $mtt,
2003 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports
} } ) {
2004 if ( ($mtt eq 'email' and not $to_address) or ($mtt eq 'sms' and not $borrower->{smsalertnumber
}) ) {
2005 # email or sms is requested but not exist
2008 &$send_notification($mtt, $letter_code);
2009 $notification_sent++;
2011 #Making sure that a print notification is sent if no other transport types can be utilized.
2012 if (! $notification_sent) {
2013 &$send_notification('print', 'HOLD');
2018 =head2 _ShiftPriorityByDateAndPriority
2020 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
2022 This increments the priority of all reserves after the one
2023 with either the lowest date after C<$reservedate>
2024 or the lowest priority after C<$priority>.
2026 It effectively makes room for a new reserve to be inserted with a certain
2027 priority, which is returned.
2029 This is most useful when the reservedate can be set by the user. It allows
2030 the new reserve to be placed before other reserves that have a later
2031 reservedate. Since priority also is set by the form in reserves/request.pl
2032 the sub accounts for that too.
2036 sub _ShiftPriorityByDateAndPriority
{
2037 my ( $biblio, $resdate, $new_priority ) = @_;
2039 my $dbh = C4
::Context
->dbh;
2040 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
2041 my $sth = $dbh->prepare( $query );
2042 $sth->execute( $biblio, $resdate, $new_priority );
2043 my $min_priority = $sth->fetchrow;
2044 # if no such matches are found, $new_priority remains as original value
2045 $new_priority = $min_priority if ( $min_priority );
2047 # Shift the priority up by one; works in conjunction with the next SQL statement
2048 $query = "UPDATE reserves
2049 SET priority = priority+1
2050 WHERE biblionumber = ?
2051 AND borrowernumber = ?
2054 my $sth_update = $dbh->prepare( $query );
2056 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
2057 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
2058 $sth = $dbh->prepare( $query );
2059 $sth->execute( $new_priority, $biblio );
2060 while ( my $row = $sth->fetchrow_hashref ) {
2061 $sth_update->execute( $biblio, $row->{borrowernumber
}, $row->{reservedate
} );
2064 return $new_priority; # so the caller knows what priority they wind up receiving
2069 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
2071 Use when checking out an item to handle reserves
2072 If $cancelreserve boolean is set to true, it will remove existing reserve
2077 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
2079 my ( $restype, $res, $all_reserves ) = CheckReserves
( $itemnumber );
2082 my $biblionumber = $res->{biblionumber
};
2083 my $biblioitemnumber = $res->{biblioitemnumber
};
2085 if ($res->{borrowernumber
} == $borrowernumber) {
2086 ModReserveFill
($res);
2090 # The item is reserved by someone else.
2091 # Find this item in the reserves
2094 foreach (@
$all_reserves) {
2095 $_->{'borrowernumber'} == $borrowernumber or next;
2096 $_->{'biblionumber'} == $biblionumber or next;
2103 # The item is reserved by the current patron
2104 ModReserveFill
($borr_res);
2107 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2108 RevertWaitingStatus
({ itemnumber
=> $itemnumber });
2110 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2112 biblionumber
=> $res->{'biblionumber'},
2113 itemnumber
=> $res->{'itemnumber'},
2114 borrowernumber
=> $res->{'borrowernumber'}
2122 MergeHolds($dbh,$to_biblio, $from_biblio);
2124 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2129 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2130 my $sth = $dbh->prepare(
2131 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2133 $sth->execute($from_biblio);
2134 if ( my $data = $sth->fetchrow_hashref() ) {
2136 # holds exist on old record, if not we don't need to do anything
2137 $sth = $dbh->prepare(
2138 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2139 $sth->execute( $to_biblio, $from_biblio );
2142 # don't reorder those already waiting
2144 $sth = $dbh->prepare(
2145 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2147 my $upd_sth = $dbh->prepare(
2148 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2149 AND reservedate = ? AND constrainttype = ? AND (itemnumber = ? or itemnumber is NULL) "
2151 $sth->execute( $to_biblio, 'W', 'T' );
2153 while ( my $reserve = $sth->fetchrow_hashref() ) {
2155 $priority, $to_biblio,
2156 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2157 $reserve->{'constrainttype'}, $reserve->{'itemnumber'}
2164 =head2 RevertWaitingStatus
2166 RevertWaitingStatus({ itemnumber => $itemnumber });
2168 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2170 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2171 item level hold, even if it was only a bibliolevel hold to
2172 begin with. This is because we can no longer know if a hold
2173 was item-level or bib-level after a hold has been set to
2178 sub RevertWaitingStatus
{
2179 my ( $params ) = @_;
2180 my $itemnumber = $params->{'itemnumber'};
2182 return unless ( $itemnumber );
2184 my $dbh = C4
::Context
->dbh;
2186 ## Get the waiting reserve we want to revert
2188 SELECT * FROM reserves
2189 WHERE itemnumber = ?
2190 AND found IS NOT NULL
2192 my $sth = $dbh->prepare( $query );
2193 $sth->execute( $itemnumber );
2194 my $reserve = $sth->fetchrow_hashref();
2196 ## Increment the priority of all other non-waiting
2197 ## reserves for this bib record
2201 priority = priority + 1
2207 $sth = $dbh->prepare( $query );
2208 $sth->execute( $reserve->{'biblionumber'} );
2210 ## Fix up the currently waiting reserve
2220 $sth = $dbh->prepare( $query );
2221 $sth->execute( $reserve->{'reserve_id'} );
2222 _FixPriority
( { biblionumber
=> $reserve->{biblionumber
} } );
2227 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2229 Returnes the first reserve id that matches the given criteria
2234 my ( $params ) = @_;
2236 return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2238 my $dbh = C4
::Context
->dbh();
2240 my $sql = "SELECT reserve_id FROM reserves WHERE ";
2244 foreach my $key ( keys %$params ) {
2245 if ( defined( $params->{$key} ) ) {
2246 push( @limits, "$key = ?" );
2247 push( @params, $params->{$key} );
2251 $sql .= join( " AND ", @limits );
2253 my $sth = $dbh->prepare( $sql );
2254 $sth->execute( @params );
2255 my $row = $sth->fetchrow_hashref();
2257 return $row->{'reserve_id'};
2262 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2264 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2269 my ($branch, $borrowernumber, $biblionumber) = @_;
2271 # return unless ( C4::Context->boolean_preference('printreserveslips') );
2273 my $reserve_id = GetReserveId
({
2274 biblionumber
=> $biblionumber,
2275 borrowernumber
=> $borrowernumber
2277 my $reserve = GetReserveInfo
($reserve_id) or return;
2279 return C4
::Letters
::GetPreparedLetter
(
2280 module
=> 'circulation',
2281 letter_code
=> 'RESERVESLIP',
2282 branchcode
=> $branch,
2284 'reserves' => $reserve,
2285 'branches' => $reserve->{branchcode
},
2286 'borrowers' => $reserve->{borrowernumber
},
2287 'biblio' => $reserve->{biblionumber
},
2288 'items' => $reserve->{itemnumber
},
2293 =head2 GetReservesControlBranch
2295 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2297 Return the branchcode to be used to determine which reserves
2298 policy applies to a transaction.
2300 C<$item> is a hashref for an item. Only 'homebranch' is used.
2302 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2306 sub GetReservesControlBranch
{
2307 my ( $item, $borrower ) = @_;
2309 my $reserves_control = C4
::Context
->preference('ReservesControlBranch');
2312 ( $reserves_control eq 'ItemHomeLibrary' ) ?
$item->{'homebranch'}
2313 : ( $reserves_control eq 'PatronLibrary' ) ?
$borrower->{'branchcode'}
2319 =head2 CalculatePriority
2321 my $p = CalculatePriority($biblionumber, $resdate);
2323 Calculate priority for a new reserve on biblionumber, placing it at
2324 the end of the line of all holds whose start date falls before
2325 the current system time and that are neither on the hold shelf
2328 The reserve date parameter is optional; if it is supplied, the
2329 priority is based on the set of holds whose start date falls before
2330 the parameter value.
2332 After calculation of this priority, it is recommended to call
2333 _ShiftPriorityByDateAndPriority. Note that this is currently done in
2338 sub CalculatePriority
{
2339 my ( $biblionumber, $resdate ) = @_;
2342 SELECT COUNT(*) FROM reserves
2343 WHERE biblionumber = ?
2345 AND (found IS NULL OR found = '')
2347 #skip found==W or found==T (waiting or transit holds)
2349 $sql.= ' AND ( reservedate <= ? )';
2352 $sql.= ' AND ( reservedate < NOW() )';
2354 my $dbh = C4
::Context
->dbh();
2355 my @row = $dbh->selectrow_array(
2358 $resdate ?
($biblionumber, $resdate) : ($biblionumber)
2361 return @row ?
$row[0]+1 : 1;
2366 Koha Development Team <http://koha-community.org/>