4 #writen 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
33 use List::MoreUtils qw/uniq/;
34 use Date::Calc qw/Date_to_Days/;
43 use C4::Utils::DataTables::Members;
45 use C4::Search; # enabled_staff_search_views
47 use Koha::Borrower::Debarments qw(IsDebarred);
50 my $dbh = C4::Context->dbh;
53 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
55 template_name => "reserve/request.tt",
59 flagsrequired => { reserveforothers => 'place_holds' },
63 my $multihold = $input->param('multi_hold');
64 $template->param(multi_hold => $multihold);
65 my $showallitems = $input->param('showallitems');
67 # get Branches and Itemtypes
68 my $branches = GetBranches();
69 my $itemtypes = GetItemTypes();
72 if (C4::Context->userenv && C4::Context->userenv->{'branch'}) {
73 $userbranch = C4::Context->userenv->{'branch'};
77 # Select borrowers infos
78 my $findborrower = $input->param('findborrower');
79 $findborrower = '' unless defined $findborrower;
80 $findborrower =~ s|,| |g;
81 my $borrowernumber_hold = $input->param('borrowernumber') || '';
85 my $exceeded_maxreserves;
87 my $date = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
88 my $action = $input->param('action');
91 if ( $action eq 'move' ) {
92 my $where = $input->param('where');
93 my $reserve_id = $input->param('reserve_id');
94 AlterPriority( $where, $reserve_id );
95 } elsif ( $action eq 'cancel' ) {
96 my $reserve_id = $input->param('reserve_id');
97 CancelReserve({ reserve_id => $reserve_id });
98 } elsif ( $action eq 'setLowestPriority' ) {
99 my $reserve_id = $input->param('reserve_id');
100 ToggleLowestPriority( $reserve_id );
101 } elsif ( $action eq 'toggleSuspend' ) {
102 my $reserve_id = $input->param('reserve_id');
103 my $suspend_until = $input->param('suspend_until');
104 ToggleSuspend( $reserve_id, $suspend_until );
108 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
110 $borrowernumber_hold = $borrower->{borrowernumber};
112 my $dt_params = { iDisplayLength => -1 };
113 my $results = C4::Utils::DataTables::Members::search(
115 searchmember => $findborrower,
116 dt_params => $dt_params,
119 my $borrowers = $results->{patrons};
120 if ( scalar @$borrowers == 1 ) {
121 $borrowernumber_hold = $borrowers->[0]->{borrowernumber};
122 } elsif ( @$borrowers ) {
123 $template->param( borrowers => $borrowers );
125 $messageborrower = "'$findborrower'";
130 my @biblionumbers = ();
131 my $biblionumbers = $input->param('biblionumbers');
133 @biblionumbers = split '/', $biblionumbers;
135 push @biblionumbers, $input->param('biblionumber');
139 # If we have the borrowernumber because we've performed an action, then we
140 # don't want to try to place another reserve.
141 if ($borrowernumber_hold && !$action) {
142 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
146 # we check the reserves of the borrower, and if he can reserv a document
147 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
150 GetReserveCount( $borrowerinfo->{'borrowernumber'} );
152 my $new_reserves_count = scalar( @biblionumbers );
154 my $maxreserves = C4::Context->preference('maxreserves');
156 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
158 my $new_reserves_allowed =
159 $maxreserves - $reserves_count > 0
160 ? $maxreserves - $reserves_count
163 $exceeded_maxreserves = 1;
165 new_reserves_allowed => $new_reserves_allowed,
166 new_reserves_count => $new_reserves_count,
167 reserves_count => $reserves_count,
168 maxreserves => $maxreserves,
172 # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
173 my $expiry_date = $borrowerinfo->{dateexpiry};
174 my $expiry = 0; # flag set if patron account has expired
175 if ($expiry_date and $expiry_date ne '0000-00-00' and
176 Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
180 # check if the borrower make the reserv in a different branch
181 if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
186 borrowernumber => $borrowerinfo->{'borrowernumber'},
187 borrowersurname => $borrowerinfo->{'surname'},
188 borrowerfirstname => $borrowerinfo->{'firstname'},
189 borrowerstreetaddress => $borrowerinfo->{'address'},
190 borrowercity => $borrowerinfo->{'city'},
191 borrowerphone => $borrowerinfo->{'phone'},
192 borrowermobile => $borrowerinfo->{'mobile'},
193 borrowerfax => $borrowerinfo->{'fax'},
194 borrowerphonepro => $borrowerinfo->{'phonepro'},
195 borroweremail => $borrowerinfo->{'email'},
196 borroweremailpro => $borrowerinfo->{'emailpro'},
197 borrowercategory => $borrowerinfo->{'category'},
198 cardnumber => $borrowerinfo->{'cardnumber'},
200 diffbranch => $diffbranch,
201 messages => $messages,
202 warnings => $warnings,
203 restricted => IsDebarred($borrowerinfo->{'borrowernumber'}),
204 amount_outstanding => GetMemberAccountRecords($borrowerinfo->{borrowernumber}),
208 $template->param( messageborrower => $messageborrower );
210 # FIXME launch another time GetMember perhaps until
211 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
213 my $itemdata_enumchron = 0;
215 foreach my $biblionumber (@biblionumbers) {
217 my %biblioloopiter = ();
219 my $dat = GetBiblioData($biblionumber);
221 my $canReserve = CanBookBeReserved( $borrowerinfo->{borrowernumber}, $biblionumber );
223 if ( $canReserve eq 'OK' ) {
225 #All is OK and we can continue
227 elsif ( $canReserve eq 'tooManyReserves' ) {
228 $exceeded_maxreserves = 1;
230 elsif ( $canReserve eq 'ageRestricted' ) {
231 $template->param( $canReserve => 1 );
232 $biblioloopiter{$canReserve} = 1;
235 $biblioloopiter{$canReserve} = 1;
238 my $alreadypossession;
239 if (not C4::Context->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron($borrowerinfo->{borrowernumber},$biblionumber)) {
240 $alreadypossession = 1;
243 # get existing reserves .....
244 my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
245 my $count = scalar( @$reserves );
246 my $totalcount = $count;
248 my $alreadyreserved = 0;
250 foreach my $res (@$reserves) {
251 if ( defined $res->{found} ) { # found can be 'W' or 'T'
255 if ( defined $borrowerinfo && defined($borrowerinfo->{borrowernumber}) && ($borrowerinfo->{borrowernumber} eq $res->{borrowernumber}) ) {
260 if ( $holds_count ) {
261 $alreadyreserved = 1;
262 $biblioloopiter{warn} = 1;
263 $biblioloopiter{alreadyres} = 1;
267 alreadyreserved => $alreadyreserved,
268 alreadypossession => $alreadypossession,
271 # FIXME think @optionloop, is maybe obsolete, or must be switchable by a systeme preference fixed rank or not
272 # make priorities options
275 for ( 1 .. $count + 1 ) {
280 selected => ( $_ == $count + 1 ),
284 # adding a fixed value for priority options
285 my $fixedRank = $count+1;
288 my %itemnumbers_of_biblioitem;
291 ## $items is array of 'item' table numbers
292 if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
293 @itemnumbers = @$items;
295 my @hostitems = get_hostitemnumbers_of($biblionumber);
297 $template->param('hostitemsflag' => 1);
298 push(@itemnumbers, @hostitems);
302 $template->param('noitems' => 1);
303 $biblioloopiter{noitems} = 1;
306 ## Hash of item number to 'item' table fields
307 my $iteminfos_of = GetItemInfosOf(@itemnumbers);
309 ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
310 ## when by definition all of the itemnumber have the same biblioitemnumber
311 foreach my $itemnumber (@itemnumbers) {
312 my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
313 push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
316 ## Should be same as biblionumber
317 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
319 my $notforloan_label_of = get_notforloan_label_of();
321 ## Hash of biblioitemnumber to 'biblioitem' table records
322 my $biblioiteminfos_of = GetBiblioItemInfosOf(@biblioitemnumbers);
326 foreach my $biblioitemnumber (@biblioitemnumbers) {
327 my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
328 my $num_available = 0;
329 my $num_override = 0;
332 if ( $biblioitem->{biblioitemnumber} ne $biblionumber ) {
333 $biblioitem->{hostitemsflag} = 1;
336 $biblioloopiter{description} = $biblioitem->{description};
337 $biblioloopiter{itypename} = $biblioitem->{description};
338 if ( $biblioitem->{itemtype} ) {
340 $biblioitem->{description} =
341 $itemtypes->{ $biblioitem->{itemtype} }{description};
343 $biblioloopiter{imageurl} =
344 getitemtypeimagelocation( 'intranet',
345 $itemtypes->{ $biblioitem->{itemtype} }{imageurl} );
348 foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } ) {
349 my $item = $iteminfos_of->{$itemnumber};
351 unless (C4::Context->preference('item-level_itypes')) {
352 $item->{itype} = $biblioitem->{itemtype};
355 $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
356 $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
357 $item->{homebranchname} = $branches->{ $item->{homebranch} }{branchname};
359 # if the holdingbranch is different than the homebranch, we show the
360 # holdingbranch of the document too
361 if ( $item->{homebranch} ne $item->{holdingbranch} ) {
362 $item->{holdingbranchname} =
363 $branches->{ $item->{holdingbranch} }{branchname};
366 if($item->{biblionumber} ne $biblionumber){
367 $item->{hostitemsflag}=1;
368 $item->{hosttitle} = GetBiblioData($item->{biblionumber})->{title};
371 # if the item is currently on loan, we display its return date and
372 # change the background color
373 my $issues= GetItemIssue($itemnumber);
374 if ( $issues->{'date_due'} ) {
375 $item->{date_due} = $issues->{date_due_sql};
376 $item->{backgroundcolor} = 'onloan';
380 my ($reservedate,$reservedfor,$expectedAt,$reserve_id,$wait) = GetReservesFromItemnumber($itemnumber);
381 if ( defined $reservedate ) {
382 my $ItemBorrowerReserveInfo = GetMember( borrowernumber => $reservedfor );
384 $item->{backgroundcolor} = 'reserved';
385 $item->{reservedate} = output_pref({ dt => dt_from_string( $reservedate ), dateonly => 1 });
386 $item->{ReservedForBorrowernumber} = $reservedfor;
387 $item->{ReservedForSurname} = $ItemBorrowerReserveInfo->{'surname'};
388 $item->{ReservedForFirstname} = $ItemBorrowerReserveInfo->{'firstname'};
389 $item->{ExpectedAtLibrary} = $branches->{$expectedAt}{branchname};
390 $item->{waitingdate} = $wait;
393 # Management of the notforloan document
394 if ( $item->{notforloan} ) {
395 $item->{backgroundcolor} = 'other';
396 $item->{notforloanvalue} =
397 $notforloan_label_of->{ $item->{notforloan} };
400 # Management of lost or long overdue items
401 if ( $item->{itemlost} ) {
403 # FIXME localized strings should never be in Perl code
405 $item->{itemlost} == 1 ? "(lost)"
406 : $item->{itemlost} == 2 ? "(long overdue)"
408 $item->{backgroundcolor} = 'other';
409 if (GetHideLostItemsPreference($borrowernumber) && !$showallitems) {
415 # Check the transit status
416 my ( $transfertwhen, $transfertfrom, $transfertto ) =
417 GetTransfers($itemnumber);
419 if ( defined $transfertwhen && $transfertwhen ne '' ) {
420 $item->{transfertwhen} = output_pref({ dt => dt_from_string( $transfertwhen ), dateonly => 1 });
421 $item->{transfertfrom} =
422 $branches->{$transfertfrom}{branchname};
423 $item->{transfertto} = $branches->{$transfertto}{branchname};
424 $item->{nocancel} = 1;
427 # If there is no loan, return and transfer, we show a checkbox.
428 $item->{notforloan} ||= 0;
430 # if independent branches is on we need to check if the person can reserve
431 # for branches they arent logged in to
432 if ( C4::Context->preference("IndependentBranches") ) {
433 if (! C4::Context->preference("canreservefromotherbranches")){
434 # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
435 my $userenv = C4::Context->userenv;
436 unless ( C4::Context->IsSuperLibrarian ) {
437 $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
442 my $branch = C4::Circulation::_GetCircControlBranch($item, $borrowerinfo);
444 my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
446 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
449 !$item->{cantreserve}
450 && !$exceeded_maxreserves
451 && IsAvailableForItemLevelRequest($item, $borrowerinfo)
452 && CanItemBeReserved(
453 $borrowerinfo->{borrowernumber}, $itemnumber
457 $item->{available} = 1;
460 elsif ( C4::Context->preference('AllowHoldPolicyOverride') ) {
461 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
462 $item->{override} = 1;
466 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
468 # Show serial enumeration when needed
469 if ($item->{enumchron}) {
470 $itemdata_enumchron = 1;
473 push @{ $biblioitem->{itemloop} }, $item;
476 if ( $num_override == scalar( @{ $biblioitem->{itemloop} } ) ) { # That is, if all items require an override
477 $template->param( override_required => 1 );
478 } elsif ( $num_available == 0 ) {
479 $template->param( none_available => 1 );
480 $biblioloopiter{warn} = 1;
481 $biblioloopiter{none_avail} = 1;
483 $template->param( hiddencount => $hiddencount);
485 push @bibitemloop, $biblioitem;
488 # existingreserves building
490 my @reserves = Koha::Holds->search( { biblionumber => $biblionumber }, { order_by => 'priority' } );
493 my $a_found = $a->found() || '';
494 my $b_found = $a->found() || '';
495 $a_found cmp $b_found;
501 for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
506 selected => ( $i == $res->priority() ),
511 if ( $res->is_found() ) {
512 $reserve{'wait'} = 1;
513 $reserve{'holdingbranch'} = $res->item()->holdingbranch();
514 $reserve{'biblionumber'} = $res->item()->biblionumber();
515 $reserve{'barcodenumber'} = $res->item()->barcode();
516 $reserve{'wbrcode'} = $res->branchcode();
517 $reserve{'itemnumber'} = $res->itemnumber();
518 $reserve{'wbrname'} = $res->branch()->branchname();
520 if ( $reserve{'holdingbranch'} eq $reserve{'wbrcode'} ) {
522 # Just because the holdingbranch matches the reserve branch doesn't mean the item
523 # has arrived at the destination, check for an open transfer for the item as well
524 my ( $transfertwhen, $transfertfrom, $transferto ) =
525 C4::Circulation::GetTransfers( $res->itemnumber() );
526 if ( not $transferto or $transferto ne $res->branchcode() ) {
527 $reserve{'atdestination'} = 1;
531 # set found to 1 if reserve is waiting for patron pickup
532 $reserve{'found'} = $res->is_found();
533 $reserve{'intransit'} = $res->is_in_transit();
535 elsif ( $res->priority() > 0 ) {
536 if ( my $item = $res->item() ) {
537 $reserve{'itemnumber'} = $item->id();
538 $reserve{'barcodenumber'} = $item->barcode();
539 $reserve{'item_level_hold'} = 1;
543 # get borrowers reserve info
544 if ( C4::Context->preference('HidePatronName') ) {
545 $reserve{'hidename'} = 1;
546 $reserve{'cardnumber'} = $res->borrower()->cardnumber();
548 $reserve{'expirationdate'} = output_pref( { dt => dt_from_string( $res->expirationdate ), dateonly => 1 } )
549 unless ( !defined( $res->expirationdate ) || $res->expirationdate eq '0000-00-00' );
550 $reserve{'date'} = output_pref( { dt => dt_from_string( $res->reservedate ), dateonly => 1 } );
551 $reserve{'borrowernumber'} = $res->borrowernumber();
552 $reserve{'biblionumber'} = $res->biblionumber();
553 $reserve{'borrowernumber'} = $res->borrowernumber();
554 $reserve{'firstname'} = $res->borrower()->firstname();
555 $reserve{'surname'} = $res->borrower()->surname();
556 $reserve{'notes'} = $res->reservenotes();
557 $reserve{'wait'} = $res->is_waiting();
558 $reserve{'waiting_date'} = $res->waitingdate();
559 $reserve{'waiting_until'} = $res->is_waiting() ? $res->waiting_expires_on() : undef;
560 $reserve{'ccode'} = $res->item() ? $res->item()->ccode() : undef;
561 $reserve{'barcode'} = $res->item() ? $res->item()->barcode() : undef;
562 $reserve{'priority'} = $res->priority();
563 $reserve{'lowestPriority'} = $res->lowestPriority();
564 $reserve{'optionloop'} = \@optionloop;
565 $reserve{'suspend'} = $res->suspend();
566 $reserve{'suspend_until'} = $res->suspend_until();
567 $reserve{'reserve_id'} = $res->reserve_id();
569 if ( C4::Context->preference('IndependentBranches') && $flags->{'superlibrarian'} != 1 ) {
570 $reserve{'branchloop'} = [ GetBranchDetail( $res->branchcode() ) ];
573 $reserve{'branchloop'} = GetBranchesLoop( $res->branchcode() );
576 push( @reserveloop, \%reserve );
579 # get the time for the form name...
583 branchloop => GetBranchesLoop($userbranch),
585 fixedRank => $fixedRank,
590 optionloop => \@optionloop,
591 bibitemloop => \@bibitemloop,
592 itemdata_enumchron => $itemdata_enumchron,
594 biblionumber => $biblionumber,
595 findborrower => $findborrower,
596 title => $dat->{title},
597 author => $dat->{author},
599 C4::Search::enabled_staff_search_views,
601 if (defined $borrowerinfo && exists $borrowerinfo->{'branchcode'}) {
603 borrower_branchname => $branches->{$borrowerinfo->{'branchcode'}}->{'branchname'},
604 borrower_branchcode => $borrowerinfo->{'branchcode'},
608 $biblioloopiter{biblionumber} = $biblionumber;
609 $biblioloopiter{title} = $dat->{title};
610 $biblioloopiter{rank} = $fixedRank;
611 $biblioloopiter{reserveloop} = \@reserveloop;
614 $template->param( reserveloop => \@reserveloop );
617 push @biblioloop, \%biblioloopiter;
620 $template->param( biblioloop => \@biblioloop );
621 $template->param( biblionumbers => $biblionumbers );
622 $template->param( exceeded_maxreserves => $exceeded_maxreserves );
625 $template->param( multi_hold => 1 );
628 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
629 $template->param( reserve_in_future => 1 );
633 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
634 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
638 output_html_with_http_headers $input, $cookie, $template->output;
640 sub sort_borrowerlist {
641 my $borrowerslist = shift;
644 uc( $a->{surname} . $a->{firstname} ) cmp
645 uc( $b->{surname} . $b->{firstname} )