4 #written 2/1/00 by chris@katipo.oc.nz
5 # Copyright 2000-2002 Katipo Communications
6 # Parts Copyright 2011 Catalyst IT
8 # This file is part of Koha.
10 # Koha is free software; you can redistribute it and/or modify it
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 script to place reserves/requests
32 use List::MoreUtils qw/uniq/;
33 use Date::Calc qw/Date_to_Days/;
43 use C4::Utils::DataTables::Members;
45 use C4::Search; # enabled_staff_search_views
51 use Koha::IssuingRules;
58 my $dbh = C4::Context->dbh;
60 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
62 template_name => "reserve/request.tt",
65 flagsrequired => { reserveforothers => 'place_holds' },
69 my $showallitems = $input->param('showallitems');
70 my $pickup = $input->param('pickup') || C4::Context->userenv->{'branch'};
72 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
74 # Select borrowers infos
75 my $findborrower = $input->param('findborrower');
76 $findborrower = '' unless defined $findborrower;
77 $findborrower =~ s|,| |g;
78 my $findclub = $input->param('findclub');
79 $findclub = '' unless defined $findclub && !$findborrower;
80 my $borrowernumber_hold = $input->param('borrowernumber') || '';
81 my $club_hold = $input->param('club')||'';
86 my $exceeded_maxreserves;
87 my $exceeded_holds_per_record;
89 my $date = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
90 my $action = $input->param('action');
93 if ( $action eq 'move' ) {
94 my $where = $input->param('where');
95 my $reserve_id = $input->param('reserve_id');
96 my $prev_priority = $input->param('prev_priority');
97 my $next_priority = $input->param('next_priority');
98 my $first_priority = $input->param('first_priority');
99 my $last_priority = $input->param('last_priority');
100 my $hold_itemnumber = $input->param('itemnumber');
101 if ( $prev_priority == 0 && $next_priority == 1 ){
102 C4::Reserves::RevertWaitingStatus({ itemnumber => $hold_itemnumber });
104 AlterPriority( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
106 } elsif ( $action eq 'cancel' ) {
107 my $reserve_id = $input->param('reserve_id');
108 my $hold = Koha::Holds->find( $reserve_id );
109 $hold->cancel if $hold;
110 } elsif ( $action eq 'setLowestPriority' ) {
111 my $reserve_id = $input->param('reserve_id');
112 ToggleLowestPriority( $reserve_id );
113 } elsif ( $action eq 'toggleSuspend' ) {
114 my $reserve_id = $input->param('reserve_id');
115 my $suspend_until = $input->param('suspend_until');
116 ToggleSuspend( $reserve_id, $suspend_until );
120 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
122 $borrowernumber_hold = $patron->borrowernumber;
124 my $dt_params = { iDisplayLength => -1 };
125 my $results = C4::Utils::DataTables::Members::search(
127 searchmember => $findborrower,
128 dt_params => $dt_params,
131 my $borrowers = $results->{patrons};
132 if ( scalar @$borrowers == 1 ) {
133 $borrowernumber_hold = $borrowers->[0]->{borrowernumber};
134 } elsif ( @$borrowers ) {
135 $template->param( borrowers => $borrowers );
137 $messageborrower = "'$findborrower'";
143 my $club = Koha::Clubs->find( { name => $findclub } );
145 $club_hold = $club->id;
147 my @clubs = Koha::Clubs->search( [
148 { name => { like => '%'.$findclub.'%' } },
149 { description => { like => '%'.$findclub.'%' } }
151 if( scalar @clubs == 1 ) {
152 $club_hold = $clubs[0]->id;
154 $template->param( clubs => \@clubs );
156 $messageclub = "'$findclub'";
161 my @biblionumbers = ();
162 my $biblionumber = $input->param('biblionumber');
163 my $biblionumbers = $input->param('biblionumbers');
164 if ( $biblionumbers ) {
165 @biblionumbers = split '/', $biblionumbers;
167 push @biblionumbers, $input->multi_param('biblionumber');
170 my $multihold = scalar $input->param('multi_hold');
171 # FIXME multi_hold should not be a variable but depends on the number of elements in @biblionumbers
172 $template->param(multi_hold => scalar $input->param('multi_hold'));
174 # If we have the borrowernumber because we've performed an action, then we
175 # don't want to try to place another reserve.
176 if ($borrowernumber_hold && !$action) {
177 my $patron = Koha::Patrons->find( $borrowernumber_hold );
180 # we check the reserves of the user, and if they can reserve a document
181 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
183 my $reserves_count = $patron->holds->count;
185 my $new_reserves_count = scalar( @biblionumbers );
187 my $maxreserves = C4::Context->preference('maxreserves');
189 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
191 my $new_reserves_allowed =
192 $maxreserves - $reserves_count > 0
193 ? $maxreserves - $reserves_count
196 $exceeded_maxreserves = 1;
198 new_reserves_allowed => $new_reserves_allowed,
199 new_reserves_count => $new_reserves_count,
200 reserves_count => $reserves_count,
201 maxreserves => $maxreserves,
205 # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
206 my $expiry_date = $patron->dateexpiry;
207 my $expiry = 0; # flag set if patron account has expired
208 if ($expiry_date and $expiry_date ne '0000-00-00' and
209 Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
213 # check if the borrower make the reserv in a different branch
214 if ( $patron->branchcode ne C4::Context->userenv->{'branch'} ) {
218 my $amount_outstanding = $patron->account->balance;
222 diffbranch => $diffbranch,
223 messages => $messages,
224 warnings => $warnings,
225 amount_outstanding => $amount_outstanding,
229 if ($club_hold && !$borrowernumber_hold && !$action) {
230 my $club = Koha::Clubs->find($club_hold);
232 my $enrollments = $club->club_enrollments;
234 my $maxreserves = C4::Context->preference('maxreserves');
235 my $new_reserves_count = scalar( @biblionumbers );
239 while(my $enrollment = $enrollments->next) {
240 next if $enrollment->is_canceled;
241 my $member = { patron => $enrollment->patron->unblessed };
242 my $reserves_count = $enrollment->patron->holds->count;
244 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
246 $member->{new_reserves_allowed} = $maxreserves - $reserves_count > 0
247 ? $maxreserves - $reserves_count
249 $member->{exceeded_maxreserves} = 1;
251 my $expiry_date = $enrollment->patron->dateexpiry;
252 $member->{expiry} = 0; # flag set if patron account has expired
253 if ($expiry_date and $expiry_date ne '0000-00-00' and
254 Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
255 $member->{expiry} = 1;
257 $member->{amount_outstanding} = $enrollment->patron->account->balance;
258 if ( $enrollment->patron->branchcode ne C4::Context->userenv->{'branch'} ) {
259 $member->{diffbranch} = 1;
262 push @members, $member;
267 members => \@members,
268 maxreserves => $maxreserves,
269 new_reserves_count => $new_reserves_count
274 messageborrower => $messageborrower,
275 messageclub => $messageclub
278 # FIXME launch another time GetMember perhaps until (Joubu: Why?)
279 my $patron = Koha::Patrons->find( $borrowernumber_hold );
281 my $logged_in_patron = Koha::Patrons->find( $borrowernumber );
285 $wants_check = $patron->wants_check_for_previous_checkout;
287 my $itemdata_enumchron = 0;
288 my $itemdata_ccode = 0;
290 foreach my $biblionumber (@biblionumbers) {
291 next unless $biblionumber =~ m|^\d+$|;
293 my %biblioloopiter = ();
295 my $biblio = Koha::Biblios->find( $biblionumber );
297 my $force_hold_level;
299 { # CanBookBeReserved
300 my $canReserve = CanBookBeReserved( $patron->borrowernumber, $biblionumber, $pickup );
301 if ( $canReserve->{status} eq 'OK' ) {
303 #All is OK and we can continue
305 elsif ( $canReserve->{status} eq 'tooManyReserves' ) {
306 $exceeded_maxreserves = 1;
307 $template->param( maxreserves => $canReserve->{limit} );
309 elsif ( $canReserve->{status} eq 'tooManyHoldsForThisRecord' ) {
310 $exceeded_holds_per_record = 1;
311 $biblioloopiter{ $canReserve->{status} } = 1;
313 elsif ( $canReserve->{status} eq 'ageRestricted' ) {
314 $template->param( $canReserve->{status} => 1 );
315 $biblioloopiter{ $canReserve->{status} } = 1;
318 $biblioloopiter{ $canReserve->{status} } = 1;
322 # For multiple holds per record, if a patron has previously placed a hold,
323 # the patron can only place more holds of the same type. That is, if the
324 # patron placed a record level hold, all the holds the patron places must
325 # be record level. If the patron placed an item level hold, all holds
326 # the patron places must be item level
327 my $holds = Koha::Holds->search(
329 borrowernumber => $patron->borrowernumber,
330 biblionumber => $biblionumber,
334 $force_hold_level = $holds->forced_hold_level();
335 $biblioloopiter{force_hold_level} = $force_hold_level;
336 $template->param( force_hold_level => $force_hold_level );
338 # For a librarian to be able to place multiple record holds for a patron for a record,
339 # we must find out what the maximum number of holds they can place for the patron is
340 my $max_holds_for_record = GetMaxPatronHoldsForRecord( $patron->borrowernumber, $biblionumber );
341 my $remaining_holds_for_record = $max_holds_for_record - $holds->count();
342 $biblioloopiter{remaining_holds_for_record} = $max_holds_for_record;
343 $template->param( max_holds_for_record => $max_holds_for_record );
344 $template->param( remaining_holds_for_record => $remaining_holds_for_record );
346 { # alreadypossession
347 # Check to see if patron is allowed to place holds on records where the
348 # patron already has an item from that record checked out
349 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
350 && CheckIfIssuedToPatron( $patron->borrowernumber, $biblionumber ) )
352 $template->param( alreadypossession => 1, );
358 my $count = Koha::Holds->search( { biblionumber => $biblionumber } )->count();
359 my $totalcount = $count;
361 # FIXME think @optionloop, is maybe obsolete, or must be switchable by a systeme preference fixed rank or not
362 # make priorities options
365 for ( 1 .. $count + 1 ) {
370 selected => ( $_ == $count + 1 ),
374 # adding a fixed value for priority options
375 my $fixedRank = $count+1;
377 my %itemnumbers_of_biblioitem;
379 my @hostitems = get_hostitemnumbers_of($biblionumber);
382 $template->param('hostitemsflag' => 1);
383 push(@itemnumbers, @hostitems);
386 my $items = Koha::Items->search({ -or => { biblionumber => $biblionumber, itemnumber => { in => \@itemnumbers } } });
388 unless ( $items->count ) {
389 # FIXME Then why do we continue?
390 $template->param('noitems' => 1);
391 $biblioloopiter{noitems} = 1;
394 ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
395 ## when by definition all of the itemnumber have the same biblioitemnumber
396 my ( $iteminfos_of );
397 while ( my $item = $items->next ) {
398 $item = $item->unblessed;
399 my $biblioitemnumber = $item->{biblioitemnumber};
400 my $itemnumber = $item->{itemnumber};
401 push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
402 $iteminfos_of->{$itemnumber} = $item;
405 ## Should be same as biblionumber
406 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
408 my $biblioiteminfos_of = {
411 ( $biblioitem->{biblioitemnumber} => $biblioitem )
412 } @{ Koha::Biblioitems->search(
413 { biblioitemnumber => { -in => \@biblioitemnumbers } },
414 { select => ['biblioitemnumber', 'publicationyear', 'itemtype']}
421 my @available_itemtypes;
422 foreach my $biblioitemnumber (@biblioitemnumbers) {
423 my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
424 my $num_available = 0;
425 my $num_override = 0;
427 my $num_alreadyheld = 0;
429 $biblioitem->{force_hold_level} = $force_hold_level;
431 if ( $biblioitem->{biblioitemnumber} ne $biblionumber ) {
432 $biblioitem->{hostitemsflag} = 1;
435 $biblioloopiter{description} = $biblioitem->{description};
436 $biblioloopiter{itypename} = $biblioitem->{description};
437 if ( $biblioitem->{itemtype} ) {
439 $biblioitem->{description} =
440 $itemtypes->{ $biblioitem->{itemtype} }{description};
442 $biblioloopiter{imageurl} =
443 getitemtypeimagelocation( 'intranet',
444 $itemtypes->{ $biblioitem->{itemtype} }{imageurl} );
447 foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } ) {
448 my $item = $iteminfos_of->{$itemnumber};
451 $do_check = $patron->do_check_for_previous_checkout($item) if $wants_check;
452 if ( $do_check && $wants_check ) {
453 $item->{checked_previously} = $do_check;
455 $biblioloopiter{checked_previously} = $do_check;
457 $template->param( checked_previously => $do_check );
461 $item->{force_hold_level} = $force_hold_level;
463 unless (C4::Context->preference('item-level_itypes')) {
464 $item->{itype} = $biblioitem->{itemtype};
467 $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
468 $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
469 $item->{homebranch} = $item->{homebranch};
471 # if the holdingbranch is different than the homebranch, we show the
472 # holdingbranch of the document too
473 if ( $item->{homebranch} ne $item->{holdingbranch} ) {
474 $item->{holdingbranch} = $item->{holdingbranch};
477 if($item->{biblionumber} ne $biblionumber){
478 $item->{hostitemsflag} = 1;
479 $item->{hosttitle} = Koha::Biblios->find( $item->{biblionumber} )->title;
482 # if the item is currently on loan, we display its return date and
483 # change the background color
484 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
486 $item->{date_due} = $issue->date_due;
487 $item->{backgroundcolor} = 'onloan';
491 my $item_object = Koha::Items->find( $itemnumber );
492 my $holds = $item_object->current_holds;
493 if ( my $first_hold = $holds->next ) {
494 my $p = Koha::Patrons->find( $first_hold->borrowernumber );
496 $item->{backgroundcolor} = 'reserved';
497 $item->{reservedate} = output_pref({ dt => dt_from_string( $first_hold->reservedate ), dateonly => 1 }); # FIXME Should be formatted in the template
498 $item->{ReservedFor} = $p;
499 $item->{ExpectedAtLibrary} = $first_hold->branchcode;
500 $item->{waitingdate} = $first_hold->waitingdate;
503 # Management of the notforloan document
504 if ( $item->{notforloan} ) {
505 $item->{backgroundcolor} = 'other';
508 # Management of lost or long overdue items
509 if ( $item->{itemlost} ) {
510 $item->{backgroundcolor} = 'other';
511 if ($logged_in_patron->category->hidelostitems && !$showallitems) {
517 # Check the transit status
518 my ( $transfertwhen, $transfertfrom, $transfertto ) =
519 GetTransfers($itemnumber);
521 if ( defined $transfertwhen && $transfertwhen ne '' ) {
522 $item->{transfertwhen} = output_pref({ dt => dt_from_string( $transfertwhen ), dateonly => 1 });
523 $item->{transfertfrom} = $transfertfrom;
524 $item->{transfertto} = $transfertto;
525 $item->{nocancel} = 1;
528 # If there is no loan, return and transfer, we show a checkbox.
529 $item->{notforloan} ||= 0;
531 # if independent branches is on we need to check if the person can reserve
532 # for branches they arent logged in to
533 if ( C4::Context->preference("IndependentBranches") ) {
534 if (! C4::Context->preference("canreservefromotherbranches")){
535 # can't reserve items so need to check if item homebranch and userenv branch match if not we can't reserve
536 my $userenv = C4::Context->userenv;
537 unless ( C4::Context->IsSuperLibrarian ) {
538 $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
544 my $patron_unblessed = $patron->unblessed;
545 my $branch = C4::Circulation::_GetCircControlBranch($item, $patron_unblessed);
547 my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
549 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
551 my $can_item_be_reserved = CanItemBeReserved( $patron->borrowernumber, $itemnumber, $pickup )->{status};
552 $item->{not_holdable} = $can_item_be_reserved unless $can_item_be_reserved eq 'OK';
554 $item->{item_level_holds} = Koha::IssuingRules->get_opacitemholds_policy( { item => $item_object, patron => $patron } );
557 !$item->{cantreserve}
558 && !$exceeded_maxreserves
559 && IsAvailableForItemLevelRequest($item_object, $patron)
560 && $can_item_be_reserved eq 'OK'
563 $item->{available} = 1;
566 push( @available_itemtypes, $item->{itype} );
568 elsif ( C4::Context->preference('AllowHoldPolicyOverride') ) {
569 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
570 # with the exception of itemAlreadyOnHold because, you know, the item is already on hold
571 if ( $can_item_be_reserved ne 'itemAlreadyOnHold' ) {
572 $item->{override} = 1;
574 } else { $num_alreadyheld++ }
576 push( @available_itemtypes, $item->{itype} );
579 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
581 # Show serial enumeration when needed
582 if ($item->{enumchron}) {
583 $itemdata_enumchron = 1;
585 # Show collection when needed
586 if ($item->{ccode}) {
591 push @{ $biblioitem->{itemloop} }, $item;
594 # While we can't override an alreay held item, we should be able to override the others
595 # Unless all items are already held
596 if ( $num_override > 0 && ($num_override + $num_alreadyheld) == scalar( @{ $biblioitem->{itemloop} } ) ) {
597 # That is, if all items require an override
598 $template->param( override_required => 1 );
599 } elsif ( $num_available == 0 ) {
600 $template->param( none_available => 1 );
601 $biblioloopiter{warn} = 1;
602 $biblioloopiter{none_avail} = 1;
604 $template->param( hiddencount => $hiddencount);
606 push @bibitemloop, $biblioitem;
609 @available_itemtypes = uniq( @available_itemtypes );
610 $template->param( available_itemtypes => \@available_itemtypes );
612 # existingreserves building
614 my @reserves = Koha::Holds->search( { biblionumber => $biblionumber }, { order_by => 'priority' } );
617 my $a_found = $a->found() || '';
618 my $b_found = $a->found() || '';
619 $a_found cmp $b_found;
623 my $priority = $res->priority();
626 for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
631 selected => ( $i == $priority ),
636 if ( $res->is_found() ) {
637 $reserve{'holdingbranch'} = $res->item()->holdingbranch();
638 $reserve{'biblionumber'} = $res->item()->biblionumber();
639 $reserve{'barcodenumber'} = $res->item()->barcode();
640 $reserve{'wbrcode'} = $res->branchcode();
641 $reserve{'itemnumber'} = $res->itemnumber();
642 $reserve{'wbrname'} = $res->branch()->branchname();
644 if ( $reserve{'holdingbranch'} eq $reserve{'wbrcode'} ) {
646 # Just because the holdingbranch matches the reserve branch doesn't mean the item
647 # has arrived at the destination, check for an open transfer for the item as well
648 my ( $transfertwhen, $transfertfrom, $transferto ) =
649 C4::Circulation::GetTransfers( $res->itemnumber() );
650 if ( not $transferto or $transferto ne $res->branchcode() ) {
651 $reserve{'atdestination'} = 1;
655 # set found to 1 if reserve is waiting for patron pickup
656 $reserve{'found'} = $res->is_found();
657 $reserve{'intransit'} = $res->is_in_transit();
659 elsif ( $res->priority() > 0 ) {
660 if ( my $item = $res->item() ) {
661 $reserve{'itemnumber'} = $item->id();
662 $reserve{'barcodenumber'} = $item->barcode();
663 $reserve{'item_level_hold'} = 1;
667 $reserve{'expirationdate'} = $res->expirationdate;
668 $reserve{'date'} = $res->reservedate;
669 $reserve{'borrowernumber'} = $res->borrowernumber();
670 $reserve{'biblionumber'} = $res->biblionumber();
671 $reserve{'patron'} = $res->borrower;
672 $reserve{'notes'} = $res->reservenotes();
673 $reserve{'waiting_date'} = $res->waitingdate();
674 $reserve{'ccode'} = $res->item() ? $res->item()->ccode() : undef;
675 $reserve{'barcode'} = $res->item() ? $res->item()->barcode() : undef;
676 $reserve{'priority'} = $res->priority();
677 $reserve{'lowestPriority'} = $res->lowestPriority();
678 $reserve{'optionloop'} = \@optionloop;
679 $reserve{'suspend'} = $res->suspend();
680 $reserve{'suspend_until'} = $res->suspend_until();
681 $reserve{'reserve_id'} = $res->reserve_id();
682 $reserve{itemtype} = $res->itemtype();
683 $reserve{branchcode} = $res->branchcode();
684 $reserve{object} = $res;
686 push( @reserveloop, \%reserve );
689 # get the time for the form name...
694 fixedRank => $fixedRank,
699 optionloop => \@optionloop,
700 bibitemloop => \@bibitemloop,
701 itemdata_enumchron => $itemdata_enumchron,
702 itemdata_ccode => $itemdata_ccode,
704 biblionumber => $biblionumber,
705 findborrower => $findborrower,
708 C4::Search::enabled_staff_search_views,
711 $biblioloopiter{biblionumber} = $biblionumber;
712 $biblioloopiter{title} = $biblio->title;
713 $biblioloopiter{rank} = $fixedRank;
714 $biblioloopiter{reserveloop} = \@reserveloop;
717 $template->param( reserveloop => \@reserveloop );
720 push @biblioloop, \%biblioloopiter;
723 $template->param( biblioloop => \@biblioloop );
724 $template->param( biblionumbers => $biblionumbers );
725 $template->param( exceeded_maxreserves => $exceeded_maxreserves );
726 $template->param( exceeded_holds_per_record => $exceeded_holds_per_record );
727 $template->param( subscriptionsnumber => CountSubscriptionFromBiblionumber($biblionumber));
728 $template->param( pickup => $pickup );
730 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
731 $template->param( reserve_in_future => 1 );
735 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
736 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
740 output_html_with_http_headers $input, $cookie, $template->output;
742 sub sort_borrowerlist {
743 my $borrowerslist = shift;
746 uc( $a->{surname} . $a->{firstname} ) cmp
747 uc( $b->{surname} . $b->{firstname} )