Bug 14880: Keyboard shortcuts don't work after setting CircAutocompl to "Don't try"
[koha.git] / reserve / request.pl
blob4544ad283f6c13e42a0f25b4d262ef31be65a4d6
1 #!/usr/bin/perl
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>.
23 =head1 request.pl
25 script to place reserves/requests
27 =cut
29 use strict;
30 use warnings;
31 use C4::Branch;
32 use CGI qw ( -utf8 );
33 use List::MoreUtils qw/uniq/;
34 use Date::Calc qw/Date_to_Days/;
35 use C4::Output;
36 use C4::Auth;
37 use C4::Reserves;
38 use C4::Biblio;
39 use C4::Items;
40 use C4::Koha;
41 use C4::Circulation;
42 use Koha::DateUtils;
43 use C4::Utils::DataTables::Members;
44 use C4::Members;
45 use C4::Search; # enabled_staff_search_views
46 use Koha::DateUtils;
47 use Koha::Borrower::Debarments qw(IsDebarred);
49 my $dbh = C4::Context->dbh;
50 my $sth;
51 my $input = new CGI;
52 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
54 template_name => "reserve/request.tt",
55 query => $input,
56 type => "intranet",
57 authnotrequired => 0,
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 # get Branches and Itemtypes
67 my $branches = GetBranches();
68 my $itemtypes = GetItemTypes();
70 my $userbranch = '';
71 if (C4::Context->userenv && C4::Context->userenv->{'branch'}) {
72 $userbranch = C4::Context->userenv->{'branch'};
76 # Select borrowers infos
77 my $findborrower = $input->param('findborrower');
78 $findborrower = '' unless defined $findborrower;
79 $findborrower =~ s|,| |g;
80 my $borrowernumber_hold = $input->param('borrowernumber') || '';
81 my $messageborrower;
82 my $maxreserves;
83 my $warnings;
84 my $messages;
86 my $date = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
87 my $action = $input->param('action');
88 $action ||= q{};
90 if ( $action eq 'move' ) {
91 my $where = $input->param('where');
92 my $reserve_id = $input->param('reserve_id');
93 AlterPriority( $where, $reserve_id );
94 } elsif ( $action eq 'cancel' ) {
95 my $reserve_id = $input->param('reserve_id');
96 CancelReserve({ reserve_id => $reserve_id });
97 } elsif ( $action eq 'setLowestPriority' ) {
98 my $reserve_id = $input->param('reserve_id');
99 ToggleLowestPriority( $reserve_id );
100 } elsif ( $action eq 'toggleSuspend' ) {
101 my $reserve_id = $input->param('reserve_id');
102 my $suspend_until = $input->param('suspend_until');
103 ToggleSuspend( $reserve_id, $suspend_until );
106 if ($findborrower) {
107 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
108 if ( $borrower ) {
109 $borrowernumber_hold = $borrower->{borrowernumber};
110 } else {
111 my $dt_params = { iDisplayLength => -1 };
112 my $results = C4::Utils::DataTables::Members::search(
114 searchmember => $findborrower,
115 dt_params => $dt_params,
118 my $borrowers = $results->{patrons};
119 if ( scalar @$borrowers == 1 ) {
120 $borrowernumber_hold = $borrowers->[0]->{borrowernumber};
121 } elsif ( @$borrowers ) {
122 $template->param( borrowers => $borrowers );
123 } else {
124 $messageborrower = "'$findborrower'";
129 # If we have the borrowernumber because we've performed an action, then we
130 # don't want to try to place another reserve.
131 if ($borrowernumber_hold && !$action) {
132 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
133 my $diffbranch;
134 my @getreservloop;
135 my $count_reserv = 0;
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" ...
140 my $number_reserves =
141 GetReserveCount( $borrowerinfo->{'borrowernumber'} );
143 if ( C4::Context->preference('maxreserves') && ($number_reserves >= C4::Context->preference('maxreserves')) ) {
144 $warnings = 1;
145 $maxreserves = 1;
148 # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
149 my $expiry_date = $borrowerinfo->{dateexpiry};
150 my $expiry = 0; # flag set if patron account has expired
151 if ($expiry_date and $expiry_date ne '0000-00-00' and
152 Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
153 $expiry = 1;
156 # check if the borrower make the reserv in a different branch
157 if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
158 $diffbranch = 1;
161 $template->param(
162 borrowernumber => $borrowerinfo->{'borrowernumber'},
163 borrowersurname => $borrowerinfo->{'surname'},
164 borrowerfirstname => $borrowerinfo->{'firstname'},
165 borrowerstreetaddress => $borrowerinfo->{'address'},
166 borrowercity => $borrowerinfo->{'city'},
167 borrowerphone => $borrowerinfo->{'phone'},
168 borrowermobile => $borrowerinfo->{'mobile'},
169 borrowerfax => $borrowerinfo->{'fax'},
170 borrowerphonepro => $borrowerinfo->{'phonepro'},
171 borroweremail => $borrowerinfo->{'email'},
172 borroweremailpro => $borrowerinfo->{'emailpro'},
173 borrowercategory => $borrowerinfo->{'category'},
174 borrowerreservs => $count_reserv,
175 cardnumber => $borrowerinfo->{'cardnumber'},
176 expiry => $expiry,
177 diffbranch => $diffbranch,
178 messages => $messages,
179 warnings => $warnings,
180 restricted => IsDebarred($borrowerinfo->{'borrowernumber'}),
181 amount_outstanding => GetMemberAccountRecords($borrowerinfo->{borrowernumber}),
185 $template->param( messageborrower => $messageborrower );
187 # FIXME launch another time GetMember perhaps until
188 my $borrowerinfo = GetMember( borrowernumber => $borrowernumber_hold );
190 my @biblionumbers = ();
191 my $biblionumbers = $input->param('biblionumbers');
192 if ($multihold) {
193 @biblionumbers = split '/', $biblionumbers;
194 } else {
195 push @biblionumbers, $input->param('biblionumber');
198 my $itemdata_enumchron = 0;
199 my @biblioloop = ();
200 foreach my $biblionumber (@biblionumbers) {
202 my %biblioloopiter = ();
204 my $dat = GetBiblioData($biblionumber);
206 my $canReserve = CanBookBeReserved( $borrowerinfo->{borrowernumber}, $biblionumber );
207 $canReserve //= '';
208 if ( $canReserve eq 'OK' ) {
210 #All is OK and we can continue
212 elsif ( $canReserve eq 'tooManyReserves' ) {
213 $maxreserves = 1;
215 elsif ( $canReserve eq 'ageRestricted' ) {
216 $template->param( $canReserve => 1 );
217 $biblioloopiter{$canReserve} = 1;
219 else {
220 $biblioloopiter{$canReserve} = 1;
223 my $alreadypossession;
224 if (not C4::Context->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron($borrowerinfo->{borrowernumber},$biblionumber)) {
225 $alreadypossession = 1;
228 # get existing reserves .....
229 my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
230 my $count = scalar( @$reserves );
231 my $totalcount = $count;
232 my $holds_count = 0;
233 my $alreadyreserved = 0;
235 foreach my $res (@$reserves) {
236 if ( defined $res->{found} ) { # found can be 'W' or 'T'
237 $count--;
240 if ( defined $borrowerinfo && defined($borrowerinfo->{borrowernumber}) && ($borrowerinfo->{borrowernumber} eq $res->{borrowernumber}) ) {
241 $holds_count++;
245 if ( $holds_count ) {
246 $alreadyreserved = 1;
247 $biblioloopiter{warn} = 1;
248 $biblioloopiter{alreadyres} = 1;
251 $template->param(
252 alreadyreserved => $alreadyreserved,
253 alreadypossession => $alreadypossession,
256 # FIXME think @optionloop, is maybe obsolete, or must be switchable by a systeme preference fixed rank or not
257 # make priorities options
259 my @optionloop;
260 for ( 1 .. $count + 1 ) {
261 push(
262 @optionloop,
264 num => $_,
265 selected => ( $_ == $count + 1 ),
269 # adding a fixed value for priority options
270 my $fixedRank = $count+1;
272 my @branchcodes;
273 my %itemnumbers_of_biblioitem;
274 my @itemnumbers;
276 ## $items is array of 'item' table numbers
277 if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
278 @itemnumbers = @$items;
280 my @hostitems = get_hostitemnumbers_of($biblionumber);
281 if (@hostitems){
282 $template->param('hostitemsflag' => 1);
283 push(@itemnumbers, @hostitems);
286 if (!@itemnumbers) {
287 $template->param('noitems' => 1);
288 $biblioloopiter{noitems} = 1;
291 ## Hash of item number to 'item' table fields
292 my $iteminfos_of = GetItemInfosOf(@itemnumbers);
294 ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
295 ## when by definition all of the itemnumber have the same biblioitemnumber
296 foreach my $itemnumber (@itemnumbers) {
297 my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
298 push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
301 ## Should be same as biblionumber
302 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
304 my $notforloan_label_of = get_notforloan_label_of();
306 ## Hash of biblioitemnumber to 'biblioitem' table records
307 my $biblioiteminfos_of = GetBiblioItemInfosOf(@biblioitemnumbers);
309 my @bibitemloop;
311 foreach my $biblioitemnumber (@biblioitemnumbers) {
312 my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
313 my $num_available = 0;
314 my $num_override = 0;
315 my $hiddencount = 0;
317 $biblioitem->{description} =
318 $itemtypes->{ $biblioitem->{itemtype} }{description};
319 if($biblioitem->{biblioitemnumber} ne $biblionumber){
320 $biblioitem->{hostitemsflag}=1;
322 $biblioloopiter{description} = $biblioitem->{description};
323 $biblioloopiter{itypename} = $biblioitem->{description};
324 $biblioloopiter{imageurl} =
325 getitemtypeimagelocation('intranet', $itemtypes->{$biblioitem->{itemtype}}{imageurl});
327 foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } ) {
328 my $item = $iteminfos_of->{$itemnumber};
330 unless (C4::Context->preference('item-level_itypes')) {
331 $item->{itype} = $biblioitem->{itemtype};
334 $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
335 $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
336 $item->{homebranchname} = $branches->{ $item->{homebranch} }{branchname};
338 # if the holdingbranch is different than the homebranch, we show the
339 # holdingbranch of the document too
340 if ( $item->{homebranch} ne $item->{holdingbranch} ) {
341 $item->{holdingbranchname} =
342 $branches->{ $item->{holdingbranch} }{branchname};
345 if($item->{biblionumber} ne $biblionumber){
346 $item->{hostitemsflag}=1;
347 $item->{hosttitle} = GetBiblioData($item->{biblionumber})->{title};
350 # if the item is currently on loan, we display its return date and
351 # change the background color
352 my $issues= GetItemIssue($itemnumber);
353 if ( $issues->{'date_due'} ) {
354 $item->{date_due} = $issues->{date_due_sql};
355 $item->{backgroundcolor} = 'onloan';
358 # checking reserve
359 my ($reservedate,$reservedfor,$expectedAt,$reserve_id,$wait) = GetReservesFromItemnumber($itemnumber);
360 if ( defined $reservedate ) {
361 my $ItemBorrowerReserveInfo = GetMember( borrowernumber => $reservedfor );
363 $item->{backgroundcolor} = 'reserved';
364 $item->{reservedate} = output_pref({ dt => dt_from_string( $reservedate ), dateonly => 1 });
365 $item->{ReservedForBorrowernumber} = $reservedfor;
366 $item->{ReservedForSurname} = $ItemBorrowerReserveInfo->{'surname'};
367 $item->{ReservedForFirstname} = $ItemBorrowerReserveInfo->{'firstname'};
368 $item->{ExpectedAtLibrary} = $branches->{$expectedAt}{branchname};
369 $item->{waitingdate} = $wait;
372 # Management of the notforloan document
373 if ( $item->{notforloan} ) {
374 $item->{backgroundcolor} = 'other';
375 $item->{notforloanvalue} =
376 $notforloan_label_of->{ $item->{notforloan} };
379 # Management of lost or long overdue items
380 if ( $item->{itemlost} ) {
382 # FIXME localized strings should never be in Perl code
383 $item->{message} =
384 $item->{itemlost} == 1 ? "(lost)"
385 : $item->{itemlost} == 2 ? "(long overdue)"
386 : "";
387 $item->{backgroundcolor} = 'other';
388 if (GetHideLostItemsPreference($borrowernumber) && !$showallitems) {
389 $item->{hide} = 1;
390 $hiddencount++;
394 # Check the transit status
395 my ( $transfertwhen, $transfertfrom, $transfertto ) =
396 GetTransfers($itemnumber);
398 if ( defined $transfertwhen && $transfertwhen ne '' ) {
399 $item->{transfertwhen} = output_pref({ dt => dt_from_string( $transfertwhen ), dateonly => 1 });
400 $item->{transfertfrom} =
401 $branches->{$transfertfrom}{branchname};
402 $item->{transfertto} = $branches->{$transfertto}{branchname};
403 $item->{nocancel} = 1;
406 # If there is no loan, return and transfer, we show a checkbox.
407 $item->{notforloan} ||= 0;
409 # if independent branches is on we need to check if the person can reserve
410 # for branches they arent logged in to
411 if ( C4::Context->preference("IndependentBranches") ) {
412 if (! C4::Context->preference("canreservefromotherbranches")){
413 # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
414 my $userenv = C4::Context->userenv;
415 unless ( C4::Context->IsSuperLibrarian ) {
416 $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
421 my $branch = C4::Circulation::_GetCircControlBranch($item, $borrowerinfo);
423 my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
425 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
427 if (
428 !$item->{cantreserve}
429 && IsAvailableForItemLevelRequest($item, $borrowerinfo)
430 && CanItemBeReserved(
431 $borrowerinfo->{borrowernumber}, $itemnumber
432 ) eq 'OK'
435 $item->{available} = 1;
436 $num_available++;
438 elsif ( C4::Context->preference('AllowHoldPolicyOverride') ) {
439 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
440 $item->{override} = 1;
441 $num_override++;
444 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
446 # Show serial enumeration when needed
447 if ($item->{enumchron}) {
448 $itemdata_enumchron = 1;
451 push @{ $biblioitem->{itemloop} }, $item;
454 if ( $num_override == scalar( @{ $biblioitem->{itemloop} } ) ) { # That is, if all items require an override
455 $template->param( override_required => 1 );
456 } elsif ( $num_available == 0 ) {
457 $template->param( none_available => 1 );
458 $biblioloopiter{warn} = 1;
459 $biblioloopiter{none_avail} = 1;
461 $template->param( hiddencount => $hiddencount);
463 push @bibitemloop, $biblioitem;
466 # existingreserves building
467 my @reserveloop;
468 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
469 foreach my $res ( sort {
470 my $a_found = $a->{found} || '';
471 my $b_found = $a->{found} || '';
472 $a_found cmp $b_found;
473 } @$reserves ) {
474 my %reserve;
475 my @optionloop;
476 for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
477 push(
478 @optionloop,
480 num => $i,
481 selected => ( $i == $res->{priority} ),
486 if ( defined $res->{'found'} && ($res->{'found'} eq 'W' || $res->{'found'} eq 'T' )) {
487 my $item = $res->{'itemnumber'};
488 $item = GetBiblioFromItemNumber($item,undef);
489 $reserve{'wait'}= 1;
490 $reserve{'holdingbranch'}=$item->{'holdingbranch'};
491 $reserve{'biblionumber'}=$item->{'biblionumber'};
492 $reserve{'barcodenumber'} = $item->{'barcode'};
493 $reserve{'wbrcode'} = $res->{'branchcode'};
494 $reserve{'itemnumber'} = $res->{'itemnumber'};
495 $reserve{'wbrname'} = $branches->{$res->{'branchcode'}}->{'branchname'};
496 if($reserve{'holdingbranch'} eq $reserve{'wbrcode'}){
497 # Just because the holdingbranch matches the reserve branch doesn't mean the item
498 # has arrived at the destination, check for an open transfer for the item as well
499 my ( $transfertwhen, $transfertfrom, $transferto ) = C4::Circulation::GetTransfers( $res->{itemnumber} );
500 if ( not $transferto or $transferto ne $res->{branchcode} ) {
501 $reserve{'atdestination'} = 1;
504 # set found to 1 if reserve is waiting for patron pickup
505 $reserve{'found'} = 1 if $res->{'found'} eq 'W';
506 $reserve{'intransit'} = 1 if $res->{'found'} eq 'T';
507 } elsif ($res->{priority} > 0) {
508 if (defined($res->{itemnumber})) {
509 my $item = GetItem($res->{itemnumber});
510 $reserve{'itemnumber'} = $res->{'itemnumber'};
511 $reserve{'barcodenumber'} = $item->{'barcode'};
512 $reserve{'item_level_hold'} = 1;
516 # get borrowers reserve info
517 my $reserveborrowerinfo = GetMember( borrowernumber => $res->{'borrowernumber'} );
518 if (C4::Context->preference('HidePatronName')){
519 $reserve{'hidename'} = 1;
520 $reserve{'cardnumber'} = $reserveborrowerinfo->{'cardnumber'};
522 $reserve{'expirationdate'} = output_pref({ dt => dt_from_string( $res->{'expirationdate'} ), dateonly => 1 })
523 unless ( !defined($res->{'expirationdate'}) || $res->{'expirationdate'} eq '0000-00-00' );
524 $reserve{'date'} = output_pref({ dt => dt_from_string( $res->{'reservedate'} ), dateonly => 1 });
525 $reserve{'borrowernumber'} = $res->{'borrowernumber'};
526 $reserve{'biblionumber'} = $res->{'biblionumber'};
527 $reserve{'borrowernumber'} = $res->{'borrowernumber'};
528 $reserve{'firstname'} = $reserveborrowerinfo->{'firstname'};
529 $reserve{'surname'} = $reserveborrowerinfo->{'surname'};
530 $reserve{'notes'} = $res->{'reservenotes'};
531 $reserve{'wait'} =
532 ( ( defined $res->{'found'} and $res->{'found'} eq 'W' ) or ( $res->{'priority'} eq '0' ) );
533 $reserve{'voldesc'} = $res->{'volumeddesc'};
534 $reserve{'ccode'} = $res->{'ccode'};
535 $reserve{'barcode'} = $res->{'barcode'};
536 $reserve{'priority'} = $res->{'priority'};
537 $reserve{'lowestPriority'} = $res->{'lowestPriority'};
538 $reserve{'optionloop'} = \@optionloop;
539 $reserve{'suspend'} = $res->{'suspend'};
540 $reserve{'suspend_until'} = $res->{'suspend_until'};
541 $reserve{'reserve_id'} = $res->{'reserve_id'};
543 if ( C4::Context->preference('IndependentBranches') && $flags->{'superlibrarian'} != 1 ) {
544 $reserve{'branchloop'} = [ GetBranchDetail($res->{'branchcode'}) ];
545 } else {
546 $reserve{'branchloop'} = GetBranchesLoop($res->{'branchcode'});
549 push( @reserveloop, \%reserve );
552 # get the time for the form name...
553 my $time = time();
555 $template->param(
556 branchloop => GetBranchesLoop($userbranch),
557 time => $time,
558 fixedRank => $fixedRank,
561 # display infos
562 $template->param(
563 optionloop => \@optionloop,
564 bibitemloop => \@bibitemloop,
565 itemdata_enumchron => $itemdata_enumchron,
566 date => $date,
567 biblionumber => $biblionumber,
568 findborrower => $findborrower,
569 title => $dat->{title},
570 author => $dat->{author},
571 holdsview => 1,
572 C4::Search::enabled_staff_search_views,
574 if (defined $borrowerinfo && exists $borrowerinfo->{'branchcode'}) {
575 $template->param(
576 borrower_branchname => $branches->{$borrowerinfo->{'branchcode'}}->{'branchname'},
577 borrower_branchcode => $borrowerinfo->{'branchcode'},
581 $biblioloopiter{biblionumber} = $biblionumber;
582 $biblioloopiter{title} = $dat->{title};
583 $biblioloopiter{rank} = $fixedRank;
584 $biblioloopiter{reserveloop} = \@reserveloop;
586 if (@reserveloop) {
587 $template->param( reserveloop => \@reserveloop );
590 push @biblioloop, \%biblioloopiter;
593 $template->param( biblioloop => \@biblioloop );
594 $template->param( biblionumbers => $biblionumbers );
595 $template->param( maxreserves => $maxreserves );
597 if ($multihold) {
598 $template->param( multi_hold => 1 );
601 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
602 $template->param( reserve_in_future => 1 );
605 $template->param(
606 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
607 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
610 # printout the page
611 output_html_with_http_headers $input, $cookie, $template->output;
613 sub sort_borrowerlist {
614 my $borrowerslist = shift;
615 my $ref = [];
616 push @{$ref}, sort {
617 uc( $a->{surname} . $a->{firstname} ) cmp
618 uc( $b->{surname} . $b->{firstname} )
619 } @{$borrowerslist};
620 return $ref;