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 );
34 use C4::Output qw( output_html_with_http_headers );
35 use C4::Auth qw( get_template_and_user );
36 use C4::Reserves qw( RevertWaitingStatus AlterPriority ToggleLowestPriority ToggleSuspend CanBookBeReserved GetMaxPatronHoldsForRecord ItemsAnyAvailableAndNotRestricted CanItemBeReserved IsAvailableForItemLevelRequest );
37 use C4::Items qw( get_hostitemnumbers_of );
38 use C4::Koha qw( getitemtypeimagelocation );
39 use C4::Serials qw( CountSubscriptionFromBiblionumber );
40 use C4::Circulation qw( GetTransfers _GetCircControlBranch GetBranchItemRule );
41 use Koha::DateUtils qw( dt_from_string output_pref );
42 use C4::Search qw( enabled_staff_search_views );
45 use Koha::DateUtils qw( dt_from_string output_pref );
48 use Koha::CirculationRules;
53 use Koha::Patron::Attribute::Types;
55 use Koha::BackgroundJob::BatchCancelHold;
57 my $dbh = C4::Context->dbh;
59 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
61 template_name => "reserve/request.tt",
64 flagsrequired => { reserveforothers => 'place_holds' },
68 my $showallitems = $input->param('showallitems');
69 my $pickup = $input->param('pickup');
74 { %{ $_->unblessed }, image_location => $_->image_location }
75 } Koha::ItemTypes->search_with_localization->as_list
78 # Select borrowers infos
79 my $findborrower = $input->param('findborrower');
80 $findborrower = '' unless defined $findborrower;
81 $findborrower =~ s|,| |g;
82 my $findclub = $input->param('findclub');
83 $findclub = '' unless defined $findclub && !$findborrower;
84 my $borrowernumber_hold = $input->param('borrowernumber') || '';
85 my $club_hold = $input->param('club')||'';
90 my $exceeded_maxreserves;
91 my $exceeded_holds_per_record;
93 my $date = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
94 my $action = $input->param('action');
97 if ( $action eq 'move' ) {
98 my $where = $input->param('where');
99 my $reserve_id = $input->param('reserve_id');
100 my $prev_priority = $input->param('prev_priority');
101 my $next_priority = $input->param('next_priority');
102 my $first_priority = $input->param('first_priority');
103 my $last_priority = $input->param('last_priority');
104 my $hold_itemnumber = $input->param('itemnumber');
105 if ( $prev_priority == 0 && $next_priority == 1 ) {
106 C4::Reserves::RevertWaitingStatus( { itemnumber => $hold_itemnumber } );
110 $where, $reserve_id, $prev_priority,
111 $next_priority, $first_priority, $last_priority
115 elsif ( $action eq 'cancel' ) {
116 my $reserve_id = $input->param('reserve_id');
117 my $cancellation_reason = $input->param("cancellation-reason");
118 my $hold = Koha::Holds->find($reserve_id);
119 $hold->cancel( { cancellation_reason => $cancellation_reason } ) if $hold;
121 elsif ( $action eq 'setLowestPriority' ) {
122 my $reserve_id = $input->param('reserve_id');
123 ToggleLowestPriority($reserve_id);
125 elsif ( $action eq 'toggleSuspend' ) {
126 my $reserve_id = $input->param('reserve_id');
127 my $suspend_until = $input->param('suspend_until');
128 ToggleSuspend( $reserve_id, $suspend_until );
130 elsif ( $action eq 'cancelBulk' ) {
131 my $cancellation_reason = $input->param("cancellation-reason");
132 my @hold_ids = split( ',', scalar $input->param("ids"));
134 reason => $cancellation_reason,
135 hold_ids => \@hold_ids,
137 my $job_id = Koha::BackgroundJob::BatchCancelHold->new->enqueue($params);
146 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
147 $borrowernumber_hold = $patron->borrowernumber if $patron;
151 my $club = Koha::Clubs->find( { name => $findclub } );
153 $club_hold = $club->id;
155 my @clubs = Koha::Clubs->search( [
156 { name => { like => '%'.$findclub.'%' } },
157 { description => { like => '%'.$findclub.'%' } }
159 if( scalar @clubs == 1 ) {
160 $club_hold = $clubs[0]->id;
162 $template->param( clubs => \@clubs );
164 $messageclub = "'$findclub'";
169 my @biblionumbers = $input->multi_param('biblionumber');
171 my $multi_hold = @biblionumbers > 1;
173 multi_hold => $multi_hold,
176 # If we have the borrowernumber because we've performed an action, then we
177 # don't want to try to place another reserve.
178 if ($borrowernumber_hold && !$action) {
179 my $patron = Koha::Patrons->find( $borrowernumber_hold );
182 # we check the reserves of the user, and if they can reserve a document
183 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
185 my $reserves_count = $patron->holds->count;
187 my $new_reserves_count = scalar( @biblionumbers );
189 my $maxreserves = C4::Context->preference('maxreserves');
190 $template->param( maxreserves => $maxreserves );
193 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
195 my $new_reserves_allowed =
196 $maxreserves - $reserves_count > 0
197 ? $maxreserves - $reserves_count
200 $exceeded_maxreserves = 1;
202 new_reserves_allowed => $new_reserves_allowed,
203 new_reserves_count => $new_reserves_count,
204 reserves_count => $reserves_count,
205 maxreserves => $maxreserves,
209 # check if the borrower make the reserv in a different branch
210 if ( $patron->branchcode ne C4::Context->userenv->{'branch'} ) {
214 my $amount_outstanding = $patron->account->balance;
217 diffbranch => $diffbranch,
218 messages => $messages,
219 warnings => $warnings,
220 amount_outstanding => $amount_outstanding,
224 if ($club_hold && !$borrowernumber_hold && !$action) {
225 my $club = Koha::Clubs->find($club_hold);
227 my $enrollments = $club->club_enrollments;
229 my $maxreserves = C4::Context->preference('maxreserves');
230 my $new_reserves_count = scalar( @biblionumbers );
234 while(my $enrollment = $enrollments->next) {
235 next if $enrollment->is_canceled;
236 my $member = { patron => $enrollment->patron };
237 my $reserves_count = $enrollment->patron->holds->count;
239 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
241 $member->{new_reserves_allowed} = $maxreserves - $reserves_count > 0
242 ? $maxreserves - $reserves_count
244 $member->{exceeded_maxreserves} = 1;
246 $member->{amount_outstanding} = $enrollment->patron->account->balance;
247 if ( $enrollment->patron->branchcode ne C4::Context->userenv->{'branch'} ) {
248 $member->{diffbranch} = 1;
251 push @members, $member;
256 members => \@members,
257 maxreserves => $maxreserves,
258 new_reserves_count => $new_reserves_count
262 unless ( $club_hold or $borrowernumber_hold ) {
263 $template->param( clubcount => Koha::Clubs->search->count );
267 messageborrower => $messageborrower,
268 messageclub => $messageclub
271 # Load the hold list if
272 # - we are searching for a patron or club and found one
273 # - we are not searching for anything
274 if ( ( $findborrower && $borrowernumber_hold || $findclub && $club_hold )
275 || ( !$findborrower && !$findclub ) )
277 # FIXME launch another time GetMember perhaps until (Joubu: Why?)
278 my $patron = Koha::Patrons->find( $borrowernumber_hold );
280 if ( $patron && $multi_hold ) {
281 my @multi_pickup_locations =
282 Koha::Biblios->search( { biblionumber => \@biblionumbers } )
283 ->pickup_locations( { patron => $patron } )->as_list;
284 $template->param( multi_pickup_locations => \@multi_pickup_locations );
287 my $logged_in_patron = Koha::Patrons->find( $borrowernumber );
291 $wants_check = $patron->wants_check_for_previous_checkout;
293 my $itemdata_enumchron = 0;
294 my $itemdata_ccode = 0;
296 my $no_reserves_allowed = 0;
297 foreach my $biblionumber (@biblionumbers) {
298 next unless $biblionumber =~ m|^\d+$|;
300 my %biblioloopiter = ();
302 my $biblio = Koha::Biblios->find( $biblionumber );
304 $biblioloopiter{noitems} = 1;
305 $template->param('nobiblio' => 1);
310 { # CanBookBeReserved
311 my $canReserve = CanBookBeReserved( $patron->borrowernumber, $biblionumber );
312 if ( $canReserve->{status} eq 'OK' ) {
314 #All is OK and we can continue
316 elsif ( $canReserve->{status} eq 'noReservesAllowed' || $canReserve->{status} eq 'notReservable' ) {
317 $no_reserves_allowed = 1;
319 elsif ( $canReserve->{status} eq 'tooManyReserves' ) {
320 $exceeded_maxreserves = 1;
321 $template->param( maxreserves => $canReserve->{limit} );
323 elsif ( $canReserve->{status} eq 'tooManyHoldsForThisRecord' ) {
324 $exceeded_holds_per_record = 1;
325 $biblioloopiter{ $canReserve->{status} } = 1;
327 elsif ( $canReserve->{status} eq 'ageRestricted' ) {
328 $template->param( $canReserve->{status} => 1 );
329 $biblioloopiter{ $canReserve->{status} } = 1;
331 elsif ( $canReserve->{status} eq 'alreadypossession' ) {
332 $template->param( $canReserve->{status} => 1);
333 $biblioloopiter{ $canReserve->{status} } = 1;
335 elsif ( $canReserve->{status} eq 'recall' ) {
336 $template->param( $canReserve->{status} => 1 );
337 $biblioloopiter{ $canReserve->{status} } = 1;
340 $biblioloopiter{ $canReserve->{status} } = 1;
344 # For multiple holds per record, if a patron has previously placed a hold,
345 # the patron can only place more holds of the same type. That is, if the
346 # patron placed a record level hold, all the holds the patron places must
347 # be record level. If the patron placed an item level hold, all holds
348 # the patron places must be item level
349 my $holds = Koha::Holds->search(
351 borrowernumber => $patron->borrowernumber,
352 biblionumber => $biblionumber,
356 $template->param( force_hold_level => $holds->forced_hold_level() );
358 # For a librarian to be able to place multiple record holds for a patron for a record,
359 # we must find out what the maximum number of holds they can place for the patron is
360 my $max_holds_for_record = GetMaxPatronHoldsForRecord( $patron->borrowernumber, $biblionumber );
361 my $remaining_holds_for_record = $max_holds_for_record - $holds->count();
362 $biblioloopiter{remaining_holds_for_record} = $max_holds_for_record;
363 $template->param( max_holds_for_record => $max_holds_for_record );
364 $template->param( remaining_holds_for_record => $remaining_holds_for_record );
367 # adding a fixed value for priority options
368 my $fixedRank = $biblio->holds->count + 1;
370 my @items = $biblio->items->as_list;
372 my @host_items = $biblio->host_items->as_list;
374 push @items, @host_items;
378 # FIXME Then why do we continue?
379 $template->param('noitems' => 1) unless ( $multi_hold );
380 $biblioloopiter{noitems} = 1;
383 if ( $club_hold or $borrowernumber_hold ) {
384 my @available_itemtypes;
385 my $num_available = 0;
386 my $num_override = 0;
388 my $num_alreadyheld = 0;
390 # iterating through all items first to check if any of them available
391 # to pass this value further inside down to IsAvailableForItemLevelRequest to
392 # it's complicated logic to analyse.
393 # (before this loop was inside that sub loop so it was O(n^2) )
394 my $items_any_available;
395 $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $biblio->biblionumber, patron => $patron })
398 for my $item_object ( @items ) {
400 my $item = $item_object->unblessed;
402 $do_check = $patron->do_check_for_previous_checkout($item) if $wants_check;
403 if ( $do_check && $wants_check ) {
404 $item->{checked_previously} = $do_check;
406 $biblioloopiter{checked_previously} = $do_check;
408 $template->param( checked_previously => $do_check );
413 $item->{itemtype} = $itemtypes->{ $item_object->effective_itemtype };
415 if($item->{biblionumber} ne $biblio->biblionumber){
416 $item->{hosttitle} = Koha::Biblios->find( $item->{biblionumber} )->title;
419 # if the item is currently on loan, we display its return date and
420 # change the background color
421 my $issue = $item_object->checkout;
422 if ( $issue ) { # FIXME must be moved to the template
423 $item->{date_due} = $issue->date_due;
424 $item->{backgroundcolor} = 'onloan';
428 my $holds = $item_object->current_holds;
429 if ( my $first_hold = $holds->next ) {
430 my $p = Koha::Patrons->find( $first_hold->borrowernumber );
432 $item->{backgroundcolor} = 'reserved';
433 $item->{reservedate} = output_pref({ dt => dt_from_string( $first_hold->reservedate ), dateonly => 1 }); # FIXME Should be formatted in the template
434 $item->{ReservedFor} = $p;
435 $item->{ExpectedAtLibrary} = $first_hold->branchcode;
436 $item->{waitingdate} = $first_hold->waitingdate;
439 # Management of the notforloan document
440 if ( $item->{notforloan} ) {
441 $item->{backgroundcolor} = 'other';
444 # Management of lost or long overdue items
445 if ( $item->{itemlost} ) {
446 $item->{backgroundcolor} = 'other';
447 if ($logged_in_patron->category->hidelostitems && !$showallitems) {
453 # Check the transit status
454 my ( $transfertwhen, $transfertfrom, $transfertto ) =
455 GetTransfers($item_object->itemnumber); # FIXME replace with get_transfer
457 if ( defined $transfertwhen && $transfertwhen ne '' ) {
458 $item->{transfertwhen} = output_pref({ dt => dt_from_string( $transfertwhen ), dateonly => 1 });
459 $item->{transfertfrom} = $transfertfrom;
460 $item->{transfertto} = $transfertto;
461 $item->{nocancel} = 1;
464 # If there is no loan, return and transfer, we show a checkbox.
465 $item->{notforloan} ||= 0;
467 # if independent branches is on we need to check if the person can reserve
468 # for branches they arent logged in to
469 if ( C4::Context->preference("IndependentBranches") ) {
470 if (! C4::Context->preference("canreservefromotherbranches")){
471 # can't reserve items so need to check if item homebranch and userenv branch match if not we can't reserve
472 my $userenv = C4::Context->userenv;
473 unless ( C4::Context->IsSuperLibrarian ) {
474 $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
480 my $patron_unblessed = $patron->unblessed;
481 my $branch = C4::Circulation::_GetCircControlBranch($item, $patron_unblessed);
483 my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
485 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
487 my $can_item_be_reserved = CanItemBeReserved( $patron, $item_object )->{status};
488 $item->{not_holdable} = $can_item_be_reserved unless ( $can_item_be_reserved eq 'OK' );
490 $item->{item_level_holds} = Koha::CirculationRules->get_opacitemholds_policy( { item => $item_object, patron => $patron } );
493 !$item->{cantreserve}
494 && !$exceeded_maxreserves
495 && $can_item_be_reserved eq 'OK'
496 # items_any_available defined outside of the current loop,
497 # so we avoiding loop inside IsAvailableForItemLevelRequest:
498 && IsAvailableForItemLevelRequest($item_object, $patron, undef, $items_any_available)
501 # Send the pickup locations count to the UI, the pickup locations will be pulled using the API
502 my $pickup_locations = $item_object->pickup_locations({ patron => $patron });
503 $item->{pickup_locations_count} = $pickup_locations->count;
504 if ( $item->{pickup_locations_count} > 0 ) {
506 $item->{available} = 1;
507 # pass the holding branch for use as default
508 my $default_pickup_location = $pickup_locations->search({ branchcode => $item->{holdingbranch} })->next;
509 $item->{default_pickup_location} = $default_pickup_location;
512 $item->{available} = 0;
513 $item->{not_holdable} = "no_valid_pickup_location";
516 push( @available_itemtypes, $item->{itype} );
518 elsif ( C4::Context->preference('AllowHoldPolicyOverride') ) {
519 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
520 # with the exception of itemAlreadyOnHold because, you know, the item is already on hold
521 if ( $can_item_be_reserved ne 'itemAlreadyOnHold' ) {
522 # Send the pickup locations count to the UI, the pickup locations will be pulled using the API
523 my @pickup_locations = $item_object->pickup_locations({ patron => $patron })->as_list;
524 $item->{pickup_locations_count} = scalar @pickup_locations;
526 if ( @pickup_locations ) {
528 $item->{available} = 1;
530 my $default_pickup_location;
532 # Default to logged-in, if valid
533 if ( C4::Context->userenv->{branch} ) {
534 ($default_pickup_location) = grep { $_->branchcode eq C4::Context->userenv->{branch} } @pickup_locations;
537 $item->{default_pickup_location} = $default_pickup_location;
540 $item->{available} = 0;
541 $item->{not_holdable} = "no_valid_pickup_location";
543 } else { $num_alreadyheld++ }
545 push( @available_itemtypes, $item->{itype} );
548 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
550 # Show serial enumeration when needed
551 if ($item->{enumchron}) {
552 $itemdata_enumchron = 1;
554 # Show collection when needed
555 if ($item->{ccode}) {
560 push @{ $biblioloopiter{itemloop} }, $item;
563 $biblioloopiter{biblioitem} = $biblio->biblioitem;
565 # While we can't override an alreay held item, we should be able to override the others
566 # Unless all items are already held
567 if ( $num_override > 0 && ($num_override + $num_alreadyheld) == scalar( @{ $biblioloopiter{itemloop} } ) ) {
568 # That is, if all items require an override
569 $template->param( override_required => 1 );
570 } elsif ( $num_available == 0 ) {
571 $template->param( none_available => 1 );
572 $biblioloopiter{warn} = 1;
573 $biblioloopiter{none_avail} = 1;
575 $template->param( hiddencount => $hiddencount);
577 @available_itemtypes = uniq( @available_itemtypes );
578 $template->param( available_itemtypes => \@available_itemtypes );
581 # existingreserves building
583 my $always_show_holds = $input->cookie('always_show_holds');
584 $template->param( always_show_holds => $always_show_holds );
585 my $show_holds_now = $input->param('show_holds_now');
586 unless( (defined $always_show_holds && $always_show_holds eq 'DONT') && !$show_holds_now ){
587 my @reserves = Koha::Holds->search( { biblionumber => $biblionumber }, { order_by => 'priority' } )->as_list;
590 my $a_found = $a->found() || '';
591 my $b_found = $a->found() || '';
592 $a_found cmp $b_found;
597 if ( $res->is_found() ) {
598 $reserve{'holdingbranch'} = $res->item()->holdingbranch();
599 $reserve{'biblionumber'} = $res->item()->biblionumber();
600 $reserve{'barcodenumber'} = $res->item()->barcode();
601 $reserve{'wbrcode'} = $res->branchcode();
602 $reserve{'itemnumber'} = $res->itemnumber();
603 $reserve{'wbrname'} = $res->branch()->branchname();
604 $reserve{'atdestination'} = $res->is_at_destination();
605 $reserve{'desk_name'} = ( $res->desk() ) ? $res->desk()->desk_name() : '' ;
606 $reserve{'found'} = $res->is_found();
607 $reserve{'inprocessing'} = $res->is_in_processing();
608 $reserve{'intransit'} = $res->is_in_transit();
610 elsif ( $res->priority() > 0 ) {
611 if ( my $item = $res->item() ) {
612 $reserve{'itemnumber'} = $item->id();
613 $reserve{'barcodenumber'} = $item->barcode();
614 $reserve{'item_level_hold'} = 1;
618 $reserve{'expirationdate'} = $res->expirationdate;
619 $reserve{'date'} = $res->reservedate;
620 $reserve{'borrowernumber'} = $res->borrowernumber();
621 $reserve{'biblionumber'} = $res->biblionumber();
622 $reserve{'patron'} = $res->borrower;
623 $reserve{'notes'} = $res->reservenotes();
624 $reserve{'waiting_date'} = $res->waitingdate();
625 $reserve{'ccode'} = $res->item() ? $res->item()->ccode() : undef;
626 $reserve{'barcode'} = $res->item() ? $res->item()->barcode() : undef;
627 $reserve{'priority'} = $res->priority();
628 $reserve{'lowestPriority'} = $res->lowestPriority();
629 $reserve{'suspend'} = $res->suspend();
630 $reserve{'suspend_until'} = $res->suspend_until();
631 $reserve{'reserve_id'} = $res->reserve_id();
632 $reserve{itemtype} = $res->itemtype();
633 $reserve{branchcode} = $res->branchcode();
634 $reserve{non_priority} = $res->non_priority();
635 $reserve{object} = $res;
637 push( @reserveloop, \%reserve );
641 # get the time for the form name...
646 fixedRank => $fixedRank,
651 itemdata_enumchron => $itemdata_enumchron,
652 itemdata_ccode => $itemdata_ccode,
654 biblionumber => $biblionumber,
655 findborrower => $findborrower,
658 C4::Search::enabled_staff_search_views,
661 $biblioloopiter{biblionumber} = $biblionumber;
662 $biblioloopiter{title} = $biblio->title;
663 $biblioloopiter{author} = $biblio->author;
664 $biblioloopiter{rank} = $fixedRank;
665 $biblioloopiter{reserveloop} = \@reserveloop;
668 $template->param( reserveloop => \@reserveloop );
672 # Add the valid pickup locations
673 my @pickup_locations = $biblio->pickup_locations({ patron => $patron })->as_list;
674 $biblioloopiter{pickup_locations} = \@pickup_locations;
675 $biblioloopiter{pickup_locations_codes} = [ map { $_->branchcode } @pickup_locations ];
678 push @biblioloop, \%biblioloopiter;
681 $template->param( biblioloop => \@biblioloop );
682 $template->param( no_reserves_allowed => $no_reserves_allowed );
683 $template->param( exceeded_maxreserves => $exceeded_maxreserves );
684 $template->param( exceeded_holds_per_record => $exceeded_holds_per_record );
685 # FIXME: getting just the first bib's result doesn't seem right
686 $template->param( subscriptionsnumber => CountSubscriptionFromBiblionumber($biblionumbers[0]));
687 } elsif ( ! $multi_hold ) {
688 my $biblio = Koha::Biblios->find( $biblionumbers[0] );
689 $template->param( biblio => $biblio );
691 $template->param( biblionumbers => \@biblionumbers );
694 attribute_type_codes => ( C4::Context->preference('ExtendedPatronAttributes')
695 ? [ Koha::Patron::Attribute::Types->search( { staff_searchable => 1 } )->get_column('code') ]
701 # pass the userenv branch if no pickup location selected
702 $template->param( pickup => $pickup || C4::Context->userenv->{branch} );
704 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
705 $template->param( reserve_in_future => 1 );
709 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
710 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
711 borrowernumber => $borrowernumber_hold,
715 output_html_with_http_headers $input, $cookie, $template->output;
717 sub sort_borrowerlist {
718 my $borrowerslist = shift;
721 uc( $a->{surname} . $a->{firstname} ) cmp
722 uc( $b->{surname} . $b->{firstname} )