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
48 my $dbh = C4::Context->dbh;
51 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
53 template_name => "reserve/request.tt",
57 flagsrequired => { reserveforothers => 'place_holds' },
61 my $multihold = $input->param('multi_hold');
62 $template->param(multi_hold => $multihold);
63 my $showallitems = $input->param('showallitems');
65 # get Branches and Itemtypes
66 my $branches = GetBranches();
67 my $itemtypes = GetItemTypes();
70 if (C4::Context->userenv && C4::Context->userenv->{'branch'}) {
71 $userbranch = C4::Context->userenv->{'branch'};
75 # Select borrowers infos
76 my $findborrower = $input->param('findborrower');
77 $findborrower = '' unless defined $findborrower;
78 $findborrower =~ s|,| |g;
79 my $borrowernumber_hold = $input->param('borrowernumber') || '';
85 my $date = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
86 my $action = $input->param('action');
89 if ( $action eq 'move' ) {
90 my $where = $input->param('where');
91 my $reserve_id = $input->param('reserve_id');
92 AlterPriority( $where, $reserve_id );
93 } elsif ( $action eq 'cancel' ) {
94 my $reserve_id = $input->param('reserve_id');
95 CancelReserve({ reserve_id => $reserve_id });
96 } elsif ( $action eq 'setLowestPriority' ) {
97 my $reserve_id = $input->param('reserve_id');
98 ToggleLowestPriority( $reserve_id );
99 } elsif ( $action eq 'toggleSuspend' ) {
100 my $reserve_id = $input->param('reserve_id');
101 my $suspend_until = $input->param('suspend_until');
102 ToggleSuspend( $reserve_id, $suspend_until );
106 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
108 $borrowernumber_hold = $borrower->{borrowernumber};
110 my $dt_params = { iDisplayLength => -1 };
111 my $results = C4::Utils::DataTables::Members::search(
113 searchmember => $findborrower,
114 dt_params => $dt_params,
117 my $borrowers = $results->{patrons};
118 if ( scalar @$borrowers == 1 ) {
119 $borrowernumber_hold = $borrowers->[0]->{borrowernumber};
120 } elsif ( @$borrowers ) {
121 $template->param( borrowers => $borrowers );
123 $messageborrower = "'$findborrower'";
128 # If we have the borrowernumber because we've performed an action, then we
129 # don't want to try to place another reserve.
130 if ($borrowernumber_hold && !$action) {
131 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
134 my $count_reserv = 0;
136 # we check the reserves of the borrower, and if he can reserv a document
137 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
139 my $number_reserves =
140 GetReserveCount( $borrowerinfo->{'borrowernumber'} );
142 if ( C4::Context->preference('maxreserves') && ($number_reserves >= C4::Context->preference('maxreserves')) ) {
147 # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
148 my $expiry_date = $borrowerinfo->{dateexpiry};
149 my $expiry = 0; # flag set if patron account has expired
150 if ($expiry_date and $expiry_date ne '0000-00-00' and
151 Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
155 # check if the borrower make the reserv in a different branch
156 if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
161 borrowernumber => $borrowerinfo->{'borrowernumber'},
162 borrowersurname => $borrowerinfo->{'surname'},
163 borrowerfirstname => $borrowerinfo->{'firstname'},
164 borrowerstreetaddress => $borrowerinfo->{'address'},
165 borrowercity => $borrowerinfo->{'city'},
166 borrowerphone => $borrowerinfo->{'phone'},
167 borrowermobile => $borrowerinfo->{'mobile'},
168 borrowerfax => $borrowerinfo->{'fax'},
169 borrowerphonepro => $borrowerinfo->{'phonepro'},
170 borroweremail => $borrowerinfo->{'email'},
171 borroweremailpro => $borrowerinfo->{'emailpro'},
172 borrowercategory => $borrowerinfo->{'category'},
173 borrowerreservs => $count_reserv,
174 cardnumber => $borrowerinfo->{'cardnumber'},
176 diffbranch => $diffbranch,
177 messages => $messages,
178 warnings => $warnings,
179 amount_outstanding => GetMemberAccountRecords($borrowerinfo->{borrowernumber}),
183 $template->param( messageborrower => $messageborrower );
185 # FIXME launch another time GetMember perhaps until
186 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
188 my @biblionumbers = ();
189 my $biblionumbers = $input->param('biblionumbers');
191 @biblionumbers = split '/', $biblionumbers;
193 push @biblionumbers, $input->param('biblionumber');
196 my $itemdata_enumchron = 0;
198 foreach my $biblionumber (@biblionumbers) {
200 my %biblioloopiter = ();
202 my $dat = GetBiblioData($biblionumber);
204 my $canReserve = CanBookBeReserved( $borrowerinfo->{borrowernumber}, $biblionumber );
206 if ( $canReserve eq 'OK' ) {
208 #All is OK and we can continue
210 elsif ( $canReserve eq 'tooManyReserves' ) {
213 elsif ( $canReserve eq 'ageRestricted' ) {
214 $template->param( $canReserve => 1 );
215 $biblioloopiter{$canReserve} = 1;
218 $biblioloopiter{$canReserve} = 1;
221 my $alreadypossession;
222 if (not C4::Context->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron($borrowerinfo->{borrowernumber},$biblionumber)) {
223 $alreadypossession = 1;
226 # get existing reserves .....
227 my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
228 my $count = scalar( @$reserves );
229 my $totalcount = $count;
231 my $alreadyreserved = 0;
233 foreach my $res (@$reserves) {
234 if ( defined $res->{found} ) { # found can be 'W' or 'T'
238 if ( defined $borrowerinfo && defined($borrowerinfo->{borrowernumber}) && ($borrowerinfo->{borrowernumber} eq $res->{borrowernumber}) ) {
243 if ( $holds_count ) {
244 $alreadyreserved = 1;
245 $biblioloopiter{warn} = 1;
246 $biblioloopiter{alreadyres} = 1;
250 alreadyreserved => $alreadyreserved,
251 alreadypossession => $alreadypossession,
254 # FIXME think @optionloop, is maybe obsolete, or must be switchable by a systeme preference fixed rank or not
255 # make priorities options
258 for ( 1 .. $count + 1 ) {
263 selected => ( $_ == $count + 1 ),
267 # adding a fixed value for priority options
268 my $fixedRank = $count+1;
271 my %itemnumbers_of_biblioitem;
274 ## $items is array of 'item' table numbers
275 if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
276 @itemnumbers = @$items;
278 my @hostitems = get_hostitemnumbers_of($biblionumber);
280 $template->param('hostitemsflag' => 1);
281 push(@itemnumbers, @hostitems);
285 $template->param('noitems' => 1);
286 $biblioloopiter{noitems} = 1;
289 ## Hash of item number to 'item' table fields
290 my $iteminfos_of = GetItemInfosOf(@itemnumbers);
292 ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
293 ## when by definition all of the itemnumber have the same biblioitemnumber
294 foreach my $itemnumber (@itemnumbers) {
295 my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
296 push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
299 ## Should be same as biblionumber
300 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
302 my $notforloan_label_of = get_notforloan_label_of();
304 ## Hash of biblioitemnumber to 'biblioitem' table records
305 my $biblioiteminfos_of = GetBiblioItemInfosOf(@biblioitemnumbers);
309 foreach my $biblioitemnumber (@biblioitemnumbers) {
310 my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
311 my $num_available = 0;
312 my $num_override = 0;
315 $biblioitem->{description} =
316 $itemtypes->{ $biblioitem->{itemtype} }{description};
317 if($biblioitem->{biblioitemnumber} ne $biblionumber){
318 $biblioitem->{hostitemsflag}=1;
320 $biblioloopiter{description} = $biblioitem->{description};
321 $biblioloopiter{itypename} = $biblioitem->{description};
322 $biblioloopiter{imageurl} =
323 getitemtypeimagelocation('intranet', $itemtypes->{$biblioitem->{itemtype}}{imageurl});
325 foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } ) {
326 my $item = $iteminfos_of->{$itemnumber};
328 unless (C4::Context->preference('item-level_itypes')) {
329 $item->{itype} = $biblioitem->{itemtype};
332 $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
333 $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
334 $item->{homebranchname} = $branches->{ $item->{homebranch} }{branchname};
336 # if the holdingbranch is different than the homebranch, we show the
337 # holdingbranch of the document too
338 if ( $item->{homebranch} ne $item->{holdingbranch} ) {
339 $item->{holdingbranchname} =
340 $branches->{ $item->{holdingbranch} }{branchname};
343 if($item->{biblionumber} ne $biblionumber){
344 $item->{hostitemsflag}=1;
345 $item->{hosttitle} = GetBiblioData($item->{biblionumber})->{title};
348 # if the item is currently on loan, we display its return date and
349 # change the background color
350 my $issues= GetItemIssue($itemnumber);
351 if ( $issues->{'date_due'} ) {
352 $item->{date_due} = $issues->{date_due_sql};
353 $item->{backgroundcolor} = 'onloan';
357 my ($reservedate,$reservedfor,$expectedAt,$reserve_id,$wait) = GetReservesFromItemnumber($itemnumber);
358 if ( defined $reservedate ) {
359 my $ItemBorrowerReserveInfo = GetMember( borrowernumber => $reservedfor );
361 $item->{backgroundcolor} = 'reserved';
362 $item->{reservedate} = output_pref({ dt => dt_from_string( $reservedate ), dateonly => 1 });
363 $item->{ReservedForBorrowernumber} = $reservedfor;
364 $item->{ReservedForSurname} = $ItemBorrowerReserveInfo->{'surname'};
365 $item->{ReservedForFirstname} = $ItemBorrowerReserveInfo->{'firstname'};
366 $item->{ExpectedAtLibrary} = $branches->{$expectedAt}{branchname};
367 $item->{waitingdate} = $wait;
370 # Management of the notforloan document
371 if ( $item->{notforloan} ) {
372 $item->{backgroundcolor} = 'other';
373 $item->{notforloanvalue} =
374 $notforloan_label_of->{ $item->{notforloan} };
377 # Management of lost or long overdue items
378 if ( $item->{itemlost} ) {
380 # FIXME localized strings should never be in Perl code
382 $item->{itemlost} == 1 ? "(lost)"
383 : $item->{itemlost} == 2 ? "(long overdue)"
385 $item->{backgroundcolor} = 'other';
386 if (GetHideLostItemsPreference($borrowernumber) && !$showallitems) {
392 # Check the transit status
393 my ( $transfertwhen, $transfertfrom, $transfertto ) =
394 GetTransfers($itemnumber);
396 if ( defined $transfertwhen && $transfertwhen ne '' ) {
397 $item->{transfertwhen} = output_pref({ dt => dt_from_string( $transfertwhen ), dateonly => 1 });
398 $item->{transfertfrom} =
399 $branches->{$transfertfrom}{branchname};
400 $item->{transfertto} = $branches->{$transfertto}{branchname};
401 $item->{nocancel} = 1;
404 # If there is no loan, return and transfer, we show a checkbox.
405 $item->{notforloan} ||= 0;
407 # if independent branches is on we need to check if the person can reserve
408 # for branches they arent logged in to
409 if ( C4::Context->preference("IndependentBranches") ) {
410 if (! C4::Context->preference("canreservefromotherbranches")){
411 # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
412 my $userenv = C4::Context->userenv;
413 unless ( C4::Context->IsSuperLibrarian ) {
414 $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
419 my $branch = C4::Circulation::_GetCircControlBranch($item, $borrowerinfo);
421 my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
423 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
426 !$item->{cantreserve}
427 && IsAvailableForItemLevelRequest($item, $borrowerinfo)
428 && CanItemBeReserved(
429 $borrowerinfo->{borrowernumber}, $itemnumber
433 $item->{available} = 1;
436 elsif ( C4::Context->preference('AllowHoldPolicyOverride') ) {
437 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
438 $item->{override} = 1;
442 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
444 # Show serial enumeration when needed
445 if ($item->{enumchron}) {
446 $itemdata_enumchron = 1;
449 push @{ $biblioitem->{itemloop} }, $item;
452 if ( $num_override == scalar( @{ $biblioitem->{itemloop} } ) ) { # That is, if all items require an override
453 $template->param( override_required => 1 );
454 } elsif ( $num_available == 0 ) {
455 $template->param( none_available => 1 );
456 $biblioloopiter{warn} = 1;
457 $biblioloopiter{none_avail} = 1;
459 $template->param( hiddencount => $hiddencount);
461 push @bibitemloop, $biblioitem;
464 # existingreserves building
466 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
467 foreach my $res ( sort {
468 my $a_found = $a->{found} || '';
469 my $b_found = $a->{found} || '';
470 $a_found cmp $b_found;
474 for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
479 selected => ( $i == $res->{priority} ),
484 if ( defined $res->{'found'} && ($res->{'found'} eq 'W' || $res->{'found'} eq 'T' )) {
485 my $item = $res->{'itemnumber'};
486 $item = GetBiblioFromItemNumber($item,undef);
488 $reserve{'holdingbranch'}=$item->{'holdingbranch'};
489 $reserve{'biblionumber'}=$item->{'biblionumber'};
490 $reserve{'barcodenumber'} = $item->{'barcode'};
491 $reserve{'wbrcode'} = $res->{'branchcode'};
492 $reserve{'itemnumber'} = $res->{'itemnumber'};
493 $reserve{'wbrname'} = $branches->{$res->{'branchcode'}}->{'branchname'};
494 if($reserve{'holdingbranch'} eq $reserve{'wbrcode'}){
495 # Just because the holdingbranch matches the reserve branch doesn't mean the item
496 # has arrived at the destination, check for an open transfer for the item as well
497 my ( $transfertwhen, $transfertfrom, $transferto ) = C4::Circulation::GetTransfers( $res->{itemnumber} );
498 if ( not $transferto or $transferto ne $res->{branchcode} ) {
499 $reserve{'atdestination'} = 1;
502 # set found to 1 if reserve is waiting for patron pickup
503 $reserve{'found'} = 1 if $res->{'found'} eq 'W';
504 $reserve{'intransit'} = 1 if $res->{'found'} eq 'T';
505 } elsif ($res->{priority} > 0) {
506 if (defined($res->{itemnumber})) {
507 my $item = GetItem($res->{itemnumber});
508 $reserve{'itemnumber'} = $res->{'itemnumber'};
509 $reserve{'barcodenumber'} = $item->{'barcode'};
510 $reserve{'item_level_hold'} = 1;
514 # get borrowers reserve info
515 my $reserveborrowerinfo = GetMember( borrowernumber => $res->{'borrowernumber'} );
516 if (C4::Context->preference('HidePatronName')){
517 $reserve{'hidename'} = 1;
518 $reserve{'cardnumber'} = $reserveborrowerinfo->{'cardnumber'};
520 $reserve{'expirationdate'} = output_pref({ dt => dt_from_string( $res->{'expirationdate'} ), dateonly => 1 })
521 unless ( !defined($res->{'expirationdate'}) || $res->{'expirationdate'} eq '0000-00-00' );
522 $reserve{'date'} = output_pref({ dt => dt_from_string( $res->{'reservedate'} ), dateonly => 1 });
523 $reserve{'borrowernumber'} = $res->{'borrowernumber'};
524 $reserve{'biblionumber'} = $res->{'biblionumber'};
525 $reserve{'borrowernumber'} = $res->{'borrowernumber'};
526 $reserve{'firstname'} = $reserveborrowerinfo->{'firstname'};
527 $reserve{'surname'} = $reserveborrowerinfo->{'surname'};
528 $reserve{'notes'} = $res->{'reservenotes'};
530 ( ( defined $res->{'found'} and $res->{'found'} eq 'W' ) or ( $res->{'priority'} eq '0' ) );
531 $reserve{'voldesc'} = $res->{'volumeddesc'};
532 $reserve{'ccode'} = $res->{'ccode'};
533 $reserve{'barcode'} = $res->{'barcode'};
534 $reserve{'priority'} = $res->{'priority'};
535 $reserve{'lowestPriority'} = $res->{'lowestPriority'};
536 $reserve{'optionloop'} = \@optionloop;
537 $reserve{'suspend'} = $res->{'suspend'};
538 $reserve{'suspend_until'} = $res->{'suspend_until'};
539 $reserve{'reserve_id'} = $res->{'reserve_id'};
541 if ( C4::Context->preference('IndependentBranches') && $flags->{'superlibrarian'} != 1 ) {
542 $reserve{'branchloop'} = [ GetBranchDetail($res->{'branchcode'}) ];
544 $reserve{'branchloop'} = GetBranchesLoop($res->{'branchcode'});
547 push( @reserveloop, \%reserve );
550 # get the time for the form name...
554 branchloop => GetBranchesLoop($userbranch),
556 fixedRank => $fixedRank,
561 optionloop => \@optionloop,
562 bibitemloop => \@bibitemloop,
563 itemdata_enumchron => $itemdata_enumchron,
565 biblionumber => $biblionumber,
566 findborrower => $findborrower,
567 title => $dat->{title},
568 author => $dat->{author},
570 C4::Search::enabled_staff_search_views,
572 if (defined $borrowerinfo && exists $borrowerinfo->{'branchcode'}) {
574 borrower_branchname => $branches->{$borrowerinfo->{'branchcode'}}->{'branchname'},
575 borrower_branchcode => $borrowerinfo->{'branchcode'},
579 $biblioloopiter{biblionumber} = $biblionumber;
580 $biblioloopiter{title} = $dat->{title};
581 $biblioloopiter{rank} = $fixedRank;
582 $biblioloopiter{reserveloop} = \@reserveloop;
585 $template->param( reserveloop => \@reserveloop );
588 push @biblioloop, \%biblioloopiter;
591 $template->param( biblioloop => \@biblioloop );
592 $template->param( biblionumbers => $biblionumbers );
593 $template->param( maxreserves => $maxreserves );
596 $template->param( multi_hold => 1 );
599 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
600 $template->param( reserve_in_future => 1 );
604 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
605 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
609 output_html_with_http_headers $input, $cookie, $template->output;
611 sub sort_borrowerlist {
612 my $borrowerslist = shift;
615 uc( $a->{surname} . $a->{firstname} ) cmp
616 uc( $b->{surname} . $b->{firstname} )