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
52 my $dbh = C4::Context->dbh;
54 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
56 template_name => "reserve/request.tt",
60 flagsrequired => { reserveforothers => 'place_holds' },
64 my $multihold = $input->param('multi_hold');
65 $template->param(multi_hold => $multihold);
66 my $showallitems = $input->param('showallitems');
68 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
70 # Select borrowers infos
71 my $findborrower = $input->param('findborrower');
72 $findborrower = '' unless defined $findborrower;
73 $findborrower =~ s|,| |g;
74 my $borrowernumber_hold = $input->param('borrowernumber') || '';
78 my $exceeded_maxreserves;
79 my $exceeded_holds_per_record;
81 my $date = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
82 my $action = $input->param('action');
85 if ( $action eq 'move' ) {
86 my $where = $input->param('where');
87 my $reserve_id = $input->param('reserve_id');
88 AlterPriority( $where, $reserve_id );
89 } elsif ( $action eq 'cancel' ) {
90 my $reserve_id = $input->param('reserve_id');
91 CancelReserve({ reserve_id => $reserve_id });
92 } elsif ( $action eq 'setLowestPriority' ) {
93 my $reserve_id = $input->param('reserve_id');
94 ToggleLowestPriority( $reserve_id );
95 } elsif ( $action eq 'toggleSuspend' ) {
96 my $reserve_id = $input->param('reserve_id');
97 my $suspend_until = $input->param('suspend_until');
98 ToggleSuspend( $reserve_id, $suspend_until );
102 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
104 $borrowernumber_hold = $borrower->{borrowernumber};
106 my $dt_params = { iDisplayLength => -1 };
107 my $results = C4::Utils::DataTables::Members::search(
109 searchmember => $findborrower,
110 dt_params => $dt_params,
113 my $borrowers = $results->{patrons};
114 if ( scalar @$borrowers == 1 ) {
115 $borrowernumber_hold = $borrowers->[0]->{borrowernumber};
116 } elsif ( @$borrowers ) {
117 $template->param( borrowers => $borrowers );
119 $messageborrower = "'$findborrower'";
124 my @biblionumbers = ();
125 my $biblionumbers = $input->param('biblionumbers');
127 @biblionumbers = split '/', $biblionumbers;
129 push @biblionumbers, $input->multi_param('biblionumber');
133 # If we have the borrowernumber because we've performed an action, then we
134 # don't want to try to place another reserve.
135 if ($borrowernumber_hold && !$action) {
136 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
139 # we check the reserves of the user, and if they can reserve a document
140 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
143 GetReserveCount( $borrowerinfo->{'borrowernumber'} );
145 my $new_reserves_count = scalar( @biblionumbers );
147 my $maxreserves = C4::Context->preference('maxreserves');
149 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
151 my $new_reserves_allowed =
152 $maxreserves - $reserves_count > 0
153 ? $maxreserves - $reserves_count
156 $exceeded_maxreserves = 1;
158 new_reserves_allowed => $new_reserves_allowed,
159 new_reserves_count => $new_reserves_count,
160 reserves_count => $reserves_count,
161 maxreserves => $maxreserves,
165 # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
166 my $expiry_date = $borrowerinfo->{dateexpiry};
167 my $expiry = 0; # flag set if patron account has expired
168 if ($expiry_date and $expiry_date ne '0000-00-00' and
169 Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
173 # check if the borrower make the reserv in a different branch
174 if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
178 my $is_debarred = Koha::Patrons->find( $borrowerinfo->{borrowernumber} )->is_debarred;
180 borrowernumber => $borrowerinfo->{'borrowernumber'},
181 borrowersurname => $borrowerinfo->{'surname'},
182 borrowerfirstname => $borrowerinfo->{'firstname'},
183 borrowerstreetaddress => $borrowerinfo->{'address'},
184 borrowercity => $borrowerinfo->{'city'},
185 borrowerphone => $borrowerinfo->{'phone'},
186 borrowermobile => $borrowerinfo->{'mobile'},
187 borrowerfax => $borrowerinfo->{'fax'},
188 borrowerphonepro => $borrowerinfo->{'phonepro'},
189 borroweremail => $borrowerinfo->{'email'},
190 borroweremailpro => $borrowerinfo->{'emailpro'},
191 borrowercategory => $borrowerinfo->{'category'},
192 cardnumber => $borrowerinfo->{'cardnumber'},
194 diffbranch => $diffbranch,
195 messages => $messages,
196 warnings => $warnings,
197 restricted => $is_debarred,
198 amount_outstanding => GetMemberAccountRecords($borrowerinfo->{borrowernumber}),
202 $template->param( messageborrower => $messageborrower );
204 # FIXME launch another time GetMember perhaps until
205 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
207 my $logged_in_patron = Koha::Patrons->find( $borrowernumber );
209 my $itemdata_enumchron = 0;
211 foreach my $biblionumber (@biblionumbers) {
212 next unless $biblionumber =~ m|^\d+$|;
214 my %biblioloopiter = ();
216 my $dat = GetBiblioData($biblionumber);
218 my $canReserve = CanBookBeReserved( $borrowerinfo->{borrowernumber}, $biblionumber );
220 if ( $canReserve eq 'OK' ) {
222 #All is OK and we can continue
224 elsif ( $canReserve eq 'tooManyReserves' ) {
225 $exceeded_maxreserves = 1;
227 elsif ( $canReserve eq 'tooManyHoldsForThisRecord' ) {
228 $exceeded_holds_per_record = 1;
229 $biblioloopiter{$canReserve} = 1;
231 elsif ( $canReserve eq 'ageRestricted' ) {
232 $template->param( $canReserve => 1 );
233 $biblioloopiter{$canReserve} = 1;
236 $biblioloopiter{$canReserve} = 1;
239 my $force_hold_level;
240 if ( $borrowerinfo->{borrowernumber} ) {
241 # For multiple holds per record, if a patron has previously placed a hold,
242 # the patron can only place more holds of the same type. That is, if the
243 # patron placed a record level hold, all the holds the patron places must
244 # be record level. If the patron placed an item level hold, all holds
245 # the patron places must be item level
246 my $holds = Koha::Holds->search(
248 borrowernumber => $borrowerinfo->{borrowernumber},
249 biblionumber => $biblionumber,
253 $force_hold_level = $holds->forced_hold_level();
254 $biblioloopiter{force_hold_level} = $force_hold_level;
255 $template->param( force_hold_level => $force_hold_level );
257 # For a librarian to be able to place multiple record holds for a patron for a record,
258 # we must find out what the maximum number of holds they can place for the patron is
259 my $max_holds_for_record = GetMaxPatronHoldsForRecord( $borrowerinfo->{borrowernumber}, $biblionumber );
260 my $remaining_holds_for_record = $max_holds_for_record - $holds->count();
261 $biblioloopiter{remaining_holds_for_record} = $max_holds_for_record;
262 $template->param( max_holds_for_record => $max_holds_for_record );
263 $template->param( remaining_holds_for_record => $remaining_holds_for_record );
266 # Check to see if patron is allowed to place holds on records where the
267 # patron already has an item from that record checked out
268 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
269 && CheckIfIssuedToPatron( $borrowerinfo->{borrowernumber}, $biblionumber ) )
271 $template->param( alreadypossession => 1, );
275 my $count = Koha::Holds->search( { biblionumber => $biblionumber } )->count();
276 my $totalcount = $count;
278 # FIXME think @optionloop, is maybe obsolete, or must be switchable by a systeme preference fixed rank or not
279 # make priorities options
282 for ( 1 .. $count + 1 ) {
287 selected => ( $_ == $count + 1 ),
291 # adding a fixed value for priority options
292 my $fixedRank = $count+1;
294 my %itemnumbers_of_biblioitem;
297 ## $items is array of 'item' table numbers
298 if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
299 @itemnumbers = @$items;
301 my @hostitems = get_hostitemnumbers_of($biblionumber);
303 $template->param('hostitemsflag' => 1);
304 push(@itemnumbers, @hostitems);
308 $template->param('noitems' => 1);
309 $biblioloopiter{noitems} = 1;
312 ## Hash of item number to 'item' table fields
313 my $iteminfos_of = GetItemInfosOf(@itemnumbers);
315 ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
316 ## when by definition all of the itemnumber have the same biblioitemnumber
317 foreach my $itemnumber (@itemnumbers) {
318 my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
319 push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
322 ## Should be same as biblionumber
323 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
325 ## Hash of biblioitemnumber to 'biblioitem' table records
326 my $biblioiteminfos_of = GetBiblioItemInfosOf(@biblioitemnumbers);
328 my $frameworkcode = GetFrameworkCode( $biblionumber );
329 my @notforloan_avs = Koha::AuthorisedValues->search_by_koha_field({ kohafield => 'items.notforloan', frameworkcode => $frameworkcode });
330 my $notforloan_label_of = { map { $_->authorised_value => $_->lib } @notforloan_avs };
334 my @available_itemtypes;
335 foreach my $biblioitemnumber (@biblioitemnumbers) {
336 my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
337 my $num_available = 0;
338 my $num_override = 0;
341 $biblioitem->{force_hold_level} = $force_hold_level;
343 if ( $biblioitem->{biblioitemnumber} ne $biblionumber ) {
344 $biblioitem->{hostitemsflag} = 1;
347 $biblioloopiter{description} = $biblioitem->{description};
348 $biblioloopiter{itypename} = $biblioitem->{description};
349 if ( $biblioitem->{itemtype} ) {
351 $biblioitem->{description} =
352 $itemtypes->{ $biblioitem->{itemtype} }{description};
354 $biblioloopiter{imageurl} =
355 getitemtypeimagelocation( 'intranet',
356 $itemtypes->{ $biblioitem->{itemtype} }{imageurl} );
359 foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } ) {
360 my $item = $iteminfos_of->{$itemnumber};
362 $item->{force_hold_level} = $force_hold_level;
364 unless (C4::Context->preference('item-level_itypes')) {
365 $item->{itype} = $biblioitem->{itemtype};
368 $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
369 $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
370 $item->{homebranch} = $item->{homebranch};
372 # if the holdingbranch is different than the homebranch, we show the
373 # holdingbranch of the document too
374 if ( $item->{homebranch} ne $item->{holdingbranch} ) {
375 $item->{holdingbranch} = $item->{holdingbranch};
378 if($item->{biblionumber} ne $biblionumber){
379 $item->{hostitemsflag}=1;
380 $item->{hosttitle} = GetBiblioData($item->{biblionumber})->{title};
383 # if the item is currently on loan, we display its return date and
384 # change the background color
385 my $issues= GetItemIssue($itemnumber);
386 if ( $issues->{'date_due'} ) {
387 $item->{date_due} = $issues->{date_due_sql};
388 $item->{backgroundcolor} = 'onloan';
392 my $holds = Koha::Items->find( $itemnumber )->current_holds;
393 if ( my $first_hold = $holds->next ) {
394 my $ItemBorrowerReserveInfo = GetMember( borrowernumber => $first_hold->borrowernumber );
396 $item->{backgroundcolor} = 'reserved';
397 $item->{reservedate} = output_pref({ dt => dt_from_string( $first_hold->reservedate ), dateonly => 1 }); # FIXME Should be formatted in the template
398 $item->{ReservedForBorrowernumber} = $first_hold->borrowernumber;
399 $item->{ReservedForSurname} = $ItemBorrowerReserveInfo->{'surname'};
400 $item->{ReservedForFirstname} = $ItemBorrowerReserveInfo->{'firstname'};
401 $item->{ExpectedAtLibrary} = $first_hold->branchcode;
402 $item->{waitingdate} = $first_hold->waitingdate;
405 # Management of the notforloan document
406 if ( $item->{notforloan} ) {
407 $item->{backgroundcolor} = 'other';
408 $item->{notforloanvalue} =
409 $notforloan_label_of->{ $item->{notforloan} };
412 # Management of lost or long overdue items
413 if ( $item->{itemlost} ) {
415 # FIXME localized strings should never be in Perl code
417 $item->{itemlost} == 1 ? "(lost)"
418 : $item->{itemlost} == 2 ? "(long overdue)"
420 $item->{backgroundcolor} = 'other';
421 if ($logged_in_patron->category->hidelostitems && !$showallitems) {
427 # Check the transit status
428 my ( $transfertwhen, $transfertfrom, $transfertto ) =
429 GetTransfers($itemnumber);
431 if ( defined $transfertwhen && $transfertwhen ne '' ) {
432 $item->{transfertwhen} = output_pref({ dt => dt_from_string( $transfertwhen ), dateonly => 1 });
433 $item->{transfertfrom} = $transfertfrom;
434 $item->{transfertto} = $transfertto;
435 $item->{nocancel} = 1;
438 # If there is no loan, return and transfer, we show a checkbox.
439 $item->{notforloan} ||= 0;
441 # if independent branches is on we need to check if the person can reserve
442 # for branches they arent logged in to
443 if ( C4::Context->preference("IndependentBranches") ) {
444 if (! C4::Context->preference("canreservefromotherbranches")){
445 # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
446 my $userenv = C4::Context->userenv;
447 unless ( C4::Context->IsSuperLibrarian ) {
448 $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
453 my $branch = C4::Circulation::_GetCircControlBranch($item, $borrowerinfo);
455 my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
457 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
459 my $can_item_be_reserved = CanItemBeReserved( $borrowerinfo->{borrowernumber}, $itemnumber );
460 $item->{not_holdable} = $can_item_be_reserved unless ( $can_item_be_reserved eq 'OK' );
462 $item->{item_level_holds} = OPACItemHoldsAllowed( $item, $borrowerinfo );
465 !$item->{cantreserve}
466 && !$exceeded_maxreserves
467 && IsAvailableForItemLevelRequest($item, $borrowerinfo)
468 && $can_item_be_reserved eq 'OK'
471 $item->{available} = 1;
474 push( @available_itemtypes, $item->{itype} );
476 elsif ( C4::Context->preference('AllowHoldPolicyOverride') ) {
477 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
478 $item->{override} = 1;
481 push( @available_itemtypes, $item->{itype} );
484 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
486 # Show serial enumeration when needed
487 if ($item->{enumchron}) {
488 $itemdata_enumchron = 1;
491 push @{ $biblioitem->{itemloop} }, $item;
494 if ( $num_override == scalar( @{ $biblioitem->{itemloop} } ) ) { # That is, if all items require an override
495 $template->param( override_required => 1 );
496 } elsif ( $num_available == 0 ) {
497 $template->param( none_available => 1 );
498 $biblioloopiter{warn} = 1;
499 $biblioloopiter{none_avail} = 1;
501 $template->param( hiddencount => $hiddencount);
503 push @bibitemloop, $biblioitem;
506 @available_itemtypes = uniq( @available_itemtypes );
507 $template->param( available_itemtypes => \@available_itemtypes );
509 # existingreserves building
511 my @reserves = Koha::Holds->search( { biblionumber => $biblionumber }, { order_by => 'priority' } );
514 my $a_found = $a->found() || '';
515 my $b_found = $a->found() || '';
516 $a_found cmp $b_found;
520 my $priority = $res->priority();
523 for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
528 selected => ( $i == $priority ),
533 if ( $res->is_found() ) {
534 $reserve{'holdingbranch'} = $res->item()->holdingbranch();
535 $reserve{'biblionumber'} = $res->item()->biblionumber();
536 $reserve{'barcodenumber'} = $res->item()->barcode();
537 $reserve{'wbrcode'} = $res->branchcode();
538 $reserve{'itemnumber'} = $res->itemnumber();
539 $reserve{'wbrname'} = $res->branch()->branchname();
541 if ( $reserve{'holdingbranch'} eq $reserve{'wbrcode'} ) {
543 # Just because the holdingbranch matches the reserve branch doesn't mean the item
544 # has arrived at the destination, check for an open transfer for the item as well
545 my ( $transfertwhen, $transfertfrom, $transferto ) =
546 C4::Circulation::GetTransfers( $res->itemnumber() );
547 if ( not $transferto or $transferto ne $res->branchcode() ) {
548 $reserve{'atdestination'} = 1;
552 # set found to 1 if reserve is waiting for patron pickup
553 $reserve{'found'} = $res->is_found();
554 $reserve{'intransit'} = $res->is_in_transit();
556 elsif ( $res->priority() > 0 ) {
557 if ( my $item = $res->item() ) {
558 $reserve{'itemnumber'} = $item->id();
559 $reserve{'barcodenumber'} = $item->barcode();
560 $reserve{'item_level_hold'} = 1;
564 # get borrowers reserve info
565 if ( C4::Context->preference('HidePatronName') ) {
566 $reserve{'hidename'} = 1;
567 $reserve{'cardnumber'} = $res->borrower()->cardnumber();
569 $reserve{'expirationdate'} = output_pref( { dt => dt_from_string( $res->expirationdate ), dateonly => 1 } )
570 unless ( !defined( $res->expirationdate ) || $res->expirationdate eq '0000-00-00' );
571 $reserve{'date'} = output_pref( { dt => dt_from_string( $res->reservedate ), dateonly => 1 } );
572 $reserve{'borrowernumber'} = $res->borrowernumber();
573 $reserve{'biblionumber'} = $res->biblionumber();
574 $reserve{'borrowernumber'} = $res->borrowernumber();
575 $reserve{'firstname'} = $res->borrower()->firstname();
576 $reserve{'surname'} = $res->borrower()->surname();
577 $reserve{'notes'} = $res->reservenotes();
578 $reserve{'waiting_date'} = $res->waitingdate();
579 $reserve{'ccode'} = $res->item() ? $res->item()->ccode() : undef;
580 $reserve{'barcode'} = $res->item() ? $res->item()->barcode() : undef;
581 $reserve{'priority'} = $res->priority();
582 $reserve{'lowestPriority'} = $res->lowestPriority();
583 $reserve{'optionloop'} = \@optionloop;
584 $reserve{'suspend'} = $res->suspend();
585 $reserve{'suspend_until'} = $res->suspend_until();
586 $reserve{'reserve_id'} = $res->reserve_id();
587 $reserve{itemtype} = $res->itemtype();
588 $reserve{branchcode} = $res->branchcode();
590 push( @reserveloop, \%reserve );
593 # get the time for the form name...
598 fixedRank => $fixedRank,
603 optionloop => \@optionloop,
604 bibitemloop => \@bibitemloop,
605 itemdata_enumchron => $itemdata_enumchron,
607 biblionumber => $biblionumber,
608 findborrower => $findborrower,
609 title => $dat->{title},
610 author => $dat->{author},
612 C4::Search::enabled_staff_search_views,
614 if (defined $borrowerinfo && exists $borrowerinfo->{'branchcode'}) {
615 $template->param( borrower_branchcode => $borrowerinfo->{'branchcode'},);
618 $biblioloopiter{biblionumber} = $biblionumber;
619 $biblioloopiter{title} = $dat->{title};
620 $biblioloopiter{rank} = $fixedRank;
621 $biblioloopiter{reserveloop} = \@reserveloop;
624 $template->param( reserveloop => \@reserveloop );
627 push @biblioloop, \%biblioloopiter;
630 $template->param( biblioloop => \@biblioloop );
631 $template->param( biblionumbers => $biblionumbers );
632 $template->param( exceeded_maxreserves => $exceeded_maxreserves );
633 $template->param( exceeded_holds_per_record => $exceeded_holds_per_record );
636 $template->param( multi_hold => 1 );
639 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
640 $template->param( reserve_in_future => 1 );
644 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
645 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
649 output_html_with_http_headers $input, $cookie, $template->output;
651 sub sort_borrowerlist {
652 my $borrowerslist = shift;
655 uc( $a->{surname} . $a->{firstname} ) cmp
656 uc( $b->{surname} . $b->{firstname} )