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/;
42 use C4::Utils::DataTables::Members;
44 use C4::Search; # enabled_staff_search_views
50 my $dbh = C4::Context->dbh;
52 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
54 template_name => "reserve/request.tt",
58 flagsrequired => { reserveforothers => 'place_holds' },
62 my $multihold = $input->param('multi_hold');
63 $template->param(multi_hold => $multihold);
64 my $showallitems = $input->param('showallitems');
66 my $itemtypes = GetItemTypes();
68 # Select borrowers infos
69 my $findborrower = $input->param('findborrower');
70 $findborrower = '' unless defined $findborrower;
71 $findborrower =~ s|,| |g;
72 my $borrowernumber_hold = $input->param('borrowernumber') || '';
76 my $exceeded_maxreserves;
77 my $exceeded_holds_per_record;
79 my $date = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
80 my $action = $input->param('action');
83 if ( $action eq 'move' ) {
84 my $where = $input->param('where');
85 my $reserve_id = $input->param('reserve_id');
86 AlterPriority( $where, $reserve_id );
87 } elsif ( $action eq 'cancel' ) {
88 my $reserve_id = $input->param('reserve_id');
89 CancelReserve({ reserve_id => $reserve_id });
90 } elsif ( $action eq 'setLowestPriority' ) {
91 my $reserve_id = $input->param('reserve_id');
92 ToggleLowestPriority( $reserve_id );
93 } elsif ( $action eq 'toggleSuspend' ) {
94 my $reserve_id = $input->param('reserve_id');
95 my $suspend_until = $input->param('suspend_until');
96 ToggleSuspend( $reserve_id, $suspend_until );
100 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
102 $borrowernumber_hold = $borrower->{borrowernumber};
104 my $dt_params = { iDisplayLength => -1 };
105 my $results = C4::Utils::DataTables::Members::search(
107 searchmember => $findborrower,
108 dt_params => $dt_params,
111 my $borrowers = $results->{patrons};
112 if ( scalar @$borrowers == 1 ) {
113 $borrowernumber_hold = $borrowers->[0]->{borrowernumber};
114 } elsif ( @$borrowers ) {
115 $template->param( borrowers => $borrowers );
117 $messageborrower = "'$findborrower'";
122 my @biblionumbers = ();
123 my $biblionumbers = $input->param('biblionumbers');
125 @biblionumbers = split '/', $biblionumbers;
127 push @biblionumbers, $input->multi_param('biblionumber');
131 # If we have the borrowernumber because we've performed an action, then we
132 # don't want to try to place another reserve.
133 if ($borrowernumber_hold && !$action) {
134 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
137 # we check the reserves of the borrower, and if he can reserv a document
138 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
141 GetReserveCount( $borrowerinfo->{'borrowernumber'} );
143 my $new_reserves_count = scalar( @biblionumbers );
145 my $maxreserves = C4::Context->preference('maxreserves');
147 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
149 my $new_reserves_allowed =
150 $maxreserves - $reserves_count > 0
151 ? $maxreserves - $reserves_count
154 $exceeded_maxreserves = 1;
156 new_reserves_allowed => $new_reserves_allowed,
157 new_reserves_count => $new_reserves_count,
158 reserves_count => $reserves_count,
159 maxreserves => $maxreserves,
163 # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
164 my $expiry_date = $borrowerinfo->{dateexpiry};
165 my $expiry = 0; # flag set if patron account has expired
166 if ($expiry_date and $expiry_date ne '0000-00-00' and
167 Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
171 # check if the borrower make the reserv in a different branch
172 if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
176 my $is_debarred = Koha::Patrons->find( $borrowerinfo->{borrowernumber} )->is_debarred;
178 borrowernumber => $borrowerinfo->{'borrowernumber'},
179 borrowersurname => $borrowerinfo->{'surname'},
180 borrowerfirstname => $borrowerinfo->{'firstname'},
181 borrowerstreetaddress => $borrowerinfo->{'address'},
182 borrowercity => $borrowerinfo->{'city'},
183 borrowerphone => $borrowerinfo->{'phone'},
184 borrowermobile => $borrowerinfo->{'mobile'},
185 borrowerfax => $borrowerinfo->{'fax'},
186 borrowerphonepro => $borrowerinfo->{'phonepro'},
187 borroweremail => $borrowerinfo->{'email'},
188 borroweremailpro => $borrowerinfo->{'emailpro'},
189 borrowercategory => $borrowerinfo->{'category'},
190 cardnumber => $borrowerinfo->{'cardnumber'},
192 diffbranch => $diffbranch,
193 messages => $messages,
194 warnings => $warnings,
195 restricted => $is_debarred,
196 amount_outstanding => GetMemberAccountRecords($borrowerinfo->{borrowernumber}),
200 $template->param( messageborrower => $messageborrower );
202 # FIXME launch another time GetMember perhaps until
203 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
205 my $logged_in_patron = Koha::Patrons->find( $borrowernumber );
207 my $itemdata_enumchron = 0;
209 foreach my $biblionumber (@biblionumbers) {
210 next unless $biblionumber =~ m|^\d+$|;
212 my %biblioloopiter = ();
214 my $dat = GetBiblioData($biblionumber);
216 my $canReserve = CanBookBeReserved( $borrowerinfo->{borrowernumber}, $biblionumber );
218 if ( $canReserve eq 'OK' ) {
220 #All is OK and we can continue
222 elsif ( $canReserve eq 'tooManyReserves' ) {
223 $exceeded_maxreserves = 1;
225 elsif ( $canReserve eq 'tooManyHoldsForThisRecord' ) {
226 $exceeded_holds_per_record = 1;
227 $biblioloopiter{$canReserve} = 1;
229 elsif ( $canReserve eq 'ageRestricted' ) {
230 $template->param( $canReserve => 1 );
231 $biblioloopiter{$canReserve} = 1;
234 $biblioloopiter{$canReserve} = 1;
237 my $force_hold_level;
238 if ( $borrowerinfo->{borrowernumber} ) {
239 # For multiple holds per record, if a patron has previously placed a hold,
240 # the patron can only place more holds of the same type. That is, if the
241 # patron placed a record level hold, all the holds the patron places must
242 # be record level. If the patron placed an item level hold, all holds
243 # the patron places must be item level
244 my $holds = Koha::Holds->search(
246 borrowernumber => $borrowerinfo->{borrowernumber},
247 biblionumber => $biblionumber,
251 $force_hold_level = $holds->forced_hold_level();
252 $biblioloopiter{force_hold_level} = $force_hold_level;
253 $template->param( force_hold_level => $force_hold_level );
255 # For a librarian to be able to place multiple record holds for a patron for a record,
256 # we must find out what the maximum number of holds they can place for the patron is
257 my $max_holds_for_record = GetMaxPatronHoldsForRecord( $borrowerinfo->{borrowernumber}, $biblionumber );
258 my $remaining_holds_for_record = $max_holds_for_record - $holds->count();
259 $biblioloopiter{remaining_holds_for_record} = $max_holds_for_record;
260 $template->param( max_holds_for_record => $max_holds_for_record );
261 $template->param( remaining_holds_for_record => $remaining_holds_for_record );
264 # Check to see if patron is allowed to place holds on records where the
265 # patron already has an item from that record checked out
266 my $alreadypossession;
267 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
268 && CheckIfIssuedToPatron( $borrowerinfo->{borrowernumber}, $biblionumber ) )
270 $template->param( alreadypossession => $alreadypossession, );
274 my $count = Koha::Holds->search( { biblionumber => $biblionumber } )->count();
275 my $totalcount = $count;
277 # FIXME think @optionloop, is maybe obsolete, or must be switchable by a systeme preference fixed rank or not
278 # make priorities options
281 for ( 1 .. $count + 1 ) {
286 selected => ( $_ == $count + 1 ),
290 # adding a fixed value for priority options
291 my $fixedRank = $count+1;
293 my %itemnumbers_of_biblioitem;
296 ## $items is array of 'item' table numbers
297 if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
298 @itemnumbers = @$items;
300 my @hostitems = get_hostitemnumbers_of($biblionumber);
302 $template->param('hostitemsflag' => 1);
303 push(@itemnumbers, @hostitems);
307 $template->param('noitems' => 1);
308 $biblioloopiter{noitems} = 1;
311 ## Hash of item number to 'item' table fields
312 my $iteminfos_of = GetItemInfosOf(@itemnumbers);
314 ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
315 ## when by definition all of the itemnumber have the same biblioitemnumber
316 foreach my $itemnumber (@itemnumbers) {
317 my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
318 push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
321 ## Should be same as biblionumber
322 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
324 ## Hash of biblioitemnumber to 'biblioitem' table records
325 my $biblioiteminfos_of = GetBiblioItemInfosOf(@biblioitemnumbers);
327 my $frameworkcode = GetFrameworkCode( $biblionumber );
328 my @notforloan_avs = Koha::AuthorisedValues->search_by_koha_field({ kohafield => 'items.notforloan', frameworkcode => $frameworkcode });
329 my $notforloan_label_of = { map { $_->authorised_value => $_->lib } @notforloan_avs };
333 my @available_itemtypes;
334 foreach my $biblioitemnumber (@biblioitemnumbers) {
335 my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
336 my $num_available = 0;
337 my $num_override = 0;
340 $biblioitem->{force_hold_level} = $force_hold_level;
342 if ( $biblioitem->{biblioitemnumber} ne $biblionumber ) {
343 $biblioitem->{hostitemsflag} = 1;
346 $biblioloopiter{description} = $biblioitem->{description};
347 $biblioloopiter{itypename} = $biblioitem->{description};
348 if ( $biblioitem->{itemtype} ) {
350 $biblioitem->{description} =
351 $itemtypes->{ $biblioitem->{itemtype} }{description};
353 $biblioloopiter{imageurl} =
354 getitemtypeimagelocation( 'intranet',
355 $itemtypes->{ $biblioitem->{itemtype} }{imageurl} );
358 foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } ) {
359 my $item = $iteminfos_of->{$itemnumber};
361 $item->{force_hold_level} = $force_hold_level;
363 unless (C4::Context->preference('item-level_itypes')) {
364 $item->{itype} = $biblioitem->{itemtype};
367 $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
368 $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
369 $item->{homebranch} = $item->{homebranch};
371 # if the holdingbranch is different than the homebranch, we show the
372 # holdingbranch of the document too
373 if ( $item->{homebranch} ne $item->{holdingbranch} ) {
374 $item->{holdingbranch} = $item->{holdingbranch};
377 if($item->{biblionumber} ne $biblionumber){
378 $item->{hostitemsflag}=1;
379 $item->{hosttitle} = GetBiblioData($item->{biblionumber})->{title};
382 # if the item is currently on loan, we display its return date and
383 # change the background color
384 my $issues= GetItemIssue($itemnumber);
385 if ( $issues->{'date_due'} ) {
386 $item->{date_due} = $issues->{date_due_sql};
387 $item->{backgroundcolor} = 'onloan';
391 my ($reservedate,$reservedfor,$expectedAt,$reserve_id,$wait) = GetReservesFromItemnumber($itemnumber);
392 if ( defined $reservedate ) {
393 my $ItemBorrowerReserveInfo = GetMember( borrowernumber => $reservedfor );
395 $item->{backgroundcolor} = 'reserved';
396 $item->{reservedate} = output_pref({ dt => dt_from_string( $reservedate ), dateonly => 1 });
397 $item->{ReservedForBorrowernumber} = $reservedfor;
398 $item->{ReservedForSurname} = $ItemBorrowerReserveInfo->{'surname'};
399 $item->{ReservedForFirstname} = $ItemBorrowerReserveInfo->{'firstname'};
400 $item->{ExpectedAtLibrary} = $expectedAt;
401 $item->{waitingdate} = $wait;
404 # Management of the notforloan document
405 if ( $item->{notforloan} ) {
406 $item->{backgroundcolor} = 'other';
407 $item->{notforloanvalue} =
408 $notforloan_label_of->{ $item->{notforloan} };
411 # Management of lost or long overdue items
412 if ( $item->{itemlost} ) {
414 # FIXME localized strings should never be in Perl code
416 $item->{itemlost} == 1 ? "(lost)"
417 : $item->{itemlost} == 2 ? "(long overdue)"
419 $item->{backgroundcolor} = 'other';
420 if ($logged_in_patron->category->hidelostitems && !$showallitems) {
426 # Check the transit status
427 my ( $transfertwhen, $transfertfrom, $transfertto ) =
428 GetTransfers($itemnumber);
430 if ( defined $transfertwhen && $transfertwhen ne '' ) {
431 $item->{transfertwhen} = output_pref({ dt => dt_from_string( $transfertwhen ), dateonly => 1 });
432 $item->{transfertfrom} = $transfertfrom;
433 $item->{transfertto} = $transfertto;
434 $item->{nocancel} = 1;
437 # If there is no loan, return and transfer, we show a checkbox.
438 $item->{notforloan} ||= 0;
440 # if independent branches is on we need to check if the person can reserve
441 # for branches they arent logged in to
442 if ( C4::Context->preference("IndependentBranches") ) {
443 if (! C4::Context->preference("canreservefromotherbranches")){
444 # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
445 my $userenv = C4::Context->userenv;
446 unless ( C4::Context->IsSuperLibrarian ) {
447 $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
452 my $branch = C4::Circulation::_GetCircControlBranch($item, $borrowerinfo);
454 my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
456 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
458 my $can_item_be_reserved = CanItemBeReserved( $borrowerinfo->{borrowernumber}, $itemnumber );
459 $item->{not_holdable} = $can_item_be_reserved unless ( $can_item_be_reserved eq 'OK' );
461 $item->{item_level_holds} = OPACItemHoldsAllowed( $item, $borrowerinfo );
464 !$item->{cantreserve}
465 && !$exceeded_maxreserves
466 && IsAvailableForItemLevelRequest($item, $borrowerinfo)
467 && $can_item_be_reserved eq 'OK'
470 $item->{available} = 1;
473 push( @available_itemtypes, $item->{itype} );
475 elsif ( C4::Context->preference('AllowHoldPolicyOverride') ) {
476 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
477 $item->{override} = 1;
481 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
483 # Show serial enumeration when needed
484 if ($item->{enumchron}) {
485 $itemdata_enumchron = 1;
488 push @{ $biblioitem->{itemloop} }, $item;
491 if ( $num_override == scalar( @{ $biblioitem->{itemloop} } ) ) { # That is, if all items require an override
492 $template->param( override_required => 1 );
493 } elsif ( $num_available == 0 ) {
494 $template->param( none_available => 1 );
495 $biblioloopiter{warn} = 1;
496 $biblioloopiter{none_avail} = 1;
498 $template->param( hiddencount => $hiddencount);
500 push @bibitemloop, $biblioitem;
503 @available_itemtypes = uniq( @available_itemtypes );
504 $template->param( available_itemtypes => \@available_itemtypes );
506 # existingreserves building
508 my @reserves = Koha::Holds->search( { biblionumber => $biblionumber }, { order_by => 'priority' } );
511 my $a_found = $a->found() || '';
512 my $b_found = $a->found() || '';
513 $a_found cmp $b_found;
517 my $priority = $res->priority();
520 for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
525 selected => ( $i == $priority ),
530 if ( $res->is_found() ) {
531 $reserve{'holdingbranch'} = $res->item()->holdingbranch();
532 $reserve{'biblionumber'} = $res->item()->biblionumber();
533 $reserve{'barcodenumber'} = $res->item()->barcode();
534 $reserve{'wbrcode'} = $res->branchcode();
535 $reserve{'itemnumber'} = $res->itemnumber();
536 $reserve{'wbrname'} = $res->branch()->branchname();
538 if ( $reserve{'holdingbranch'} eq $reserve{'wbrcode'} ) {
540 # Just because the holdingbranch matches the reserve branch doesn't mean the item
541 # has arrived at the destination, check for an open transfer for the item as well
542 my ( $transfertwhen, $transfertfrom, $transferto ) =
543 C4::Circulation::GetTransfers( $res->itemnumber() );
544 if ( not $transferto or $transferto ne $res->branchcode() ) {
545 $reserve{'atdestination'} = 1;
549 # set found to 1 if reserve is waiting for patron pickup
550 $reserve{'found'} = $res->is_found();
551 $reserve{'intransit'} = $res->is_in_transit();
553 elsif ( $res->priority() > 0 ) {
554 if ( my $item = $res->item() ) {
555 $reserve{'itemnumber'} = $item->id();
556 $reserve{'barcodenumber'} = $item->barcode();
557 $reserve{'item_level_hold'} = 1;
561 # get borrowers reserve info
562 if ( C4::Context->preference('HidePatronName') ) {
563 $reserve{'hidename'} = 1;
564 $reserve{'cardnumber'} = $res->borrower()->cardnumber();
566 $reserve{'expirationdate'} = output_pref( { dt => dt_from_string( $res->expirationdate ), dateonly => 1 } )
567 unless ( !defined( $res->expirationdate ) || $res->expirationdate eq '0000-00-00' );
568 $reserve{'date'} = output_pref( { dt => dt_from_string( $res->reservedate ), dateonly => 1 } );
569 $reserve{'borrowernumber'} = $res->borrowernumber();
570 $reserve{'biblionumber'} = $res->biblionumber();
571 $reserve{'borrowernumber'} = $res->borrowernumber();
572 $reserve{'firstname'} = $res->borrower()->firstname();
573 $reserve{'surname'} = $res->borrower()->surname();
574 $reserve{'notes'} = $res->reservenotes();
575 $reserve{'waiting_date'} = $res->waitingdate();
576 $reserve{'waiting_until'} = $res->is_waiting() ? $res->waiting_expires_on() : undef;
577 $reserve{'ccode'} = $res->item() ? $res->item()->ccode() : undef;
578 $reserve{'barcode'} = $res->item() ? $res->item()->barcode() : undef;
579 $reserve{'priority'} = $res->priority();
580 $reserve{'lowestPriority'} = $res->lowestPriority();
581 $reserve{'optionloop'} = \@optionloop;
582 $reserve{'suspend'} = $res->suspend();
583 $reserve{'suspend_until'} = $res->suspend_until();
584 $reserve{'reserve_id'} = $res->reserve_id();
585 $reserve{itemtype} = $res->itemtype();
586 $reserve{branchcode} = $res->branchcode();
588 push( @reserveloop, \%reserve );
591 # get the time for the form name...
596 fixedRank => $fixedRank,
601 optionloop => \@optionloop,
602 bibitemloop => \@bibitemloop,
603 itemdata_enumchron => $itemdata_enumchron,
605 biblionumber => $biblionumber,
606 findborrower => $findborrower,
607 title => $dat->{title},
608 author => $dat->{author},
610 C4::Search::enabled_staff_search_views,
612 if (defined $borrowerinfo && exists $borrowerinfo->{'branchcode'}) {
613 $template->param( borrower_branchcode => $borrowerinfo->{'branchcode'},);
616 $biblioloopiter{biblionumber} = $biblionumber;
617 $biblioloopiter{title} = $dat->{title};
618 $biblioloopiter{rank} = $fixedRank;
619 $biblioloopiter{reserveloop} = \@reserveloop;
622 $template->param( reserveloop => \@reserveloop );
625 push @biblioloop, \%biblioloopiter;
628 $template->param( biblioloop => \@biblioloop );
629 $template->param( biblionumbers => $biblionumbers );
630 $template->param( exceeded_maxreserves => $exceeded_maxreserves );
631 $template->param( exceeded_holds_per_record => $exceeded_holds_per_record );
634 $template->param( multi_hold => 1 );
637 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
638 $template->param( reserve_in_future => 1 );
642 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
643 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
647 output_html_with_http_headers $input, $cookie, $template->output;
649 sub sort_borrowerlist {
650 my $borrowerslist = shift;
653 uc( $a->{surname} . $a->{firstname} ) cmp
654 uc( $b->{surname} . $b->{firstname} )