Bug 8278 - Replace YUI autocomplete in UNIMARC 210c plugin
[koha.git] / opac / opac-reserve.pl
1 #!/usr/bin/perl
2
3 # Copyright Katipo Communications 2002
4 # Copyright Koha Development team 2012
5 #
6 # This file is part of Koha.
7 #
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
11 # version.
12 #
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20
21 use strict;
22 use warnings;
23 use CGI;
24 use C4::Auth;    # checkauth, getborrowernumber.
25 use C4::Koha;
26 use C4::Circulation;
27 use C4::Reserves;
28 use C4::Biblio;
29 use C4::Items;
30 use C4::Output;
31 use C4::Dates qw/format_date/;
32 use C4::Context;
33 use C4::Members;
34 use C4::Branch; # GetBranches
35 use C4::Overdues;
36 use C4::Debug;
37 use Koha::DateUtils;
38 # use Data::Dumper;
39
40 my $MAXIMUM_NUMBER_OF_RESERVES = C4::Context->preference("maxreserves");
41
42 my $query = new CGI;
43 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
44     {
45         template_name   => "opac-reserve.tmpl",
46         query           => $query,
47         type            => "opac",
48         authnotrequired => 0,
49         flagsrequired   => { borrow => 1 },
50         debug           => 1,
51     }
52 );
53
54 my ($show_holds_count, $show_priority);
55 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
56     m/holds/o and $show_holds_count = 1;
57     m/priority/ and $show_priority = 1;
58 }
59
60 sub get_out {
61         output_html_with_http_headers(shift,shift,shift); # $query, $cookie, $template->output;
62         exit;
63 }
64
65 # get borrower information ....
66 my ( $borr ) = GetMemberDetails( $borrowernumber );
67
68 # Pass through any reserve charge
69 if ($borr->{reservefee} > 0){
70     $template->param( RESERVE_CHARGE => sprintf("%.2f",$borr->{reservefee}));
71 }
72 # get branches and itemtypes
73 my $branches = GetBranches();
74 my $itemTypes = GetItemTypes();
75
76 # There are two ways of calling this script, with a single biblio num
77 # or multiple biblio nums.
78 my $biblionumbers = $query->param('biblionumbers');
79 my $reserveMode = $query->param('reserve_mode');
80 if ($reserveMode && ($reserveMode eq 'single')) {
81     my $bib = $query->param('single_bib');
82     $biblionumbers = "$bib/";
83 }
84 if (! $biblionumbers) {
85     $biblionumbers = $query->param('biblionumber');
86 }
87
88 if ((! $biblionumbers) && (! $query->param('place_reserve'))) {
89     $template->param(message=>1, no_biblionumber=>1);
90     &get_out($query, $cookie, $template->output);
91 }
92
93 # Pass the numbers to the page so they can be fed back
94 # when the hold is confirmed. TODO: Not necessary?
95 $template->param( biblionumbers => $biblionumbers );
96
97 # Each biblio number is suffixed with '/', e.g. "1/2/3/"
98 my @biblionumbers = split /\//, $biblionumbers;
99 if (($#biblionumbers < 0) && (! $query->param('place_reserve'))) {
100     # TODO: New message?
101     $template->param(message=>1, no_biblionumber=>1);
102     &get_out($query, $cookie, $template->output);
103 }
104
105 # pass the pickup branch along....
106 my $branch = $query->param('branch') || $borr->{'branchcode'} || C4::Context->userenv->{branch} || '' ;
107 ($branches->{$branch}) or $branch = "";     # Confirm branch is real
108 $template->param( branch => $branch );
109
110 # make branch selection options...
111 my $branchloop = GetBranchesLoop($branch);
112
113 # Is the person allowed to choose their branch
114 my $OPACChooseBranch = (C4::Context->preference("OPACAllowUserToChooseBranch")) ? 1 : 0;
115
116 $template->param( choose_branch => $OPACChooseBranch);
117
118 #
119 #
120 # Build hashes of the requested biblio(item)s and items.
121 #
122 #
123
124 my %biblioDataHash; # Hash of biblionumber to biblio/biblioitems record.
125 my %itemInfoHash; # Hash of itemnumber to item info.
126 foreach my $biblioNumber (@biblionumbers) {
127
128     my $biblioData = GetBiblioData($biblioNumber);
129     $biblioDataHash{$biblioNumber} = $biblioData;
130
131     my @itemInfos = GetItemsInfo($biblioNumber);
132
133     my $marcrecord= GetMarcBiblio($biblioNumber);
134
135     # flag indicating existence of at least one item linked via a host record
136     my $hostitemsflag;
137     # adding items linked via host biblios
138     my @hostitemInfos = GetHostItemsInfo($marcrecord);
139     if (@hostitemInfos){
140         $hostitemsflag =1;
141         push (@itemInfos,@hostitemInfos);
142     }
143
144     $biblioData->{itemInfos} = \@itemInfos;
145     foreach my $itemInfo (@itemInfos) {
146         $itemInfoHash{$itemInfo->{itemnumber}} = $itemInfo;
147     }
148
149     # Compute the priority rank.
150     my ( $rank, $reserves ) =
151       GetReservesFromBiblionumber( $biblioNumber, 1 );
152     $biblioData->{reservecount} = 1;    # new reserve
153     foreach my $res (@{$reserves}) {
154         my $found = $res->{found};
155         if ( $found && $found eq 'W' ) {
156             $rank--;
157         }
158         else {
159             $biblioData->{reservecount}++;
160         }
161     }
162     $biblioData->{rank} = $rank + 1;
163 }
164
165 #
166 #
167 # If this is the second time through this script, it
168 # means we are carrying out the hold request, possibly
169 # with a specific item for each biblionumber.
170 #
171 #
172 if ( $query->param('place_reserve') ) {
173     my $notes = $query->param('notes');
174     my $reserve_cnt = 0;
175     if ($MAXIMUM_NUMBER_OF_RESERVES) {
176         $reserve_cnt = GetReservesFromBorrowernumber( $borrowernumber );
177     }
178
179     # List is composed of alternating biblio/item/branch
180     my $selectedItems = $query->param('selecteditems');
181
182     if ($query->param('reserve_mode') eq 'single') {
183         # This indicates non-JavaScript mode, so there was
184         # only a single biblio number selected.
185         my $bib = $query->param('single_bib');
186         my $item = $query->param("checkitem_$bib");
187         if ($item eq 'any') {
188             $item = '';
189         }
190         my $branch = $query->param('branch');
191         $selectedItems = "$bib/$item/$branch/";
192     }
193
194     $selectedItems =~ s!/$!!;
195     my @selectedItems = split /\//, $selectedItems, -1;
196
197     # Make sure there is a biblionum/itemnum/branch triplet for each item.
198     # The itemnum can be 'any', meaning next available.
199     my $selectionCount = @selectedItems;
200     if (($selectionCount == 0) || (($selectionCount % 3) != 0)) {
201         $template->param(message=>1, bad_data=>1);
202         &get_out($query, $cookie, $template->output);
203     }
204
205     while (@selectedItems) {
206         my $biblioNum = shift(@selectedItems);
207         my $itemNum   = shift(@selectedItems);
208         my $branch    = shift(@selectedItems);    # i.e., branch code, not name
209
210         my $canreserve = 0;
211
212         my $singleBranchMode = C4::Context->preference("singleBranchMode");
213         if ( $singleBranchMode || !$OPACChooseBranch )
214         {    # single branch mode or disabled user choosing
215             $branch = $borr->{'branchcode'};
216         }
217
218 #item may belong to a host biblio, if yes change biblioNum to hosts bilbionumber
219         if ( $itemNum ne '' ) {
220             my $hostbiblioNum = GetBiblionumberFromItemnumber($itemNum);
221             if ( $hostbiblioNum ne $biblioNum ) {
222                 $biblioNum = $hostbiblioNum;
223             }
224         }
225
226         my $biblioData = $biblioDataHash{$biblioNum};
227         my $found;
228
229         # Check for user supplied reserve date
230         my $startdate;
231         if (   C4::Context->preference('AllowHoldDateInFuture')
232             && C4::Context->preference('OPACAllowHoldDateInFuture') )
233         {
234             $startdate = $query->param("reserve_date_$biblioNum");
235         }
236
237         my $expiration_date = $query->param("expiration_date_$biblioNum");
238
239       # If a specific item was selected and the pickup branch is the same as the
240       # holdingbranch, force the value $rank and $found.
241         my $rank = $biblioData->{rank};
242         if ( $itemNum ne '' ) {
243             $canreserve = 1 if CanItemBeReserved( $borrowernumber, $itemNum );
244             $rank = '0' unless C4::Context->preference('ReservesNeedReturns');
245             my $item = GetItem($itemNum);
246             if ( $item->{'holdingbranch'} eq $branch ) {
247                 $found = 'W'
248                   unless C4::Context->preference('ReservesNeedReturns');
249             }
250         }
251         else {
252             $canreserve = 1 if CanBookBeReserved( $borrowernumber, $biblioNum );
253
254             # Inserts a null into the 'itemnumber' field of 'reserves' table.
255             $itemNum = undef;
256         }
257
258         if (   $MAXIMUM_NUMBER_OF_RESERVES
259             && $reserve_cnt >= $MAXIMUM_NUMBER_OF_RESERVES )
260         {
261             $canreserve = 0;
262         }
263
264         # Here we actually do the reserveration. Stage 3.
265         if ($canreserve) {
266             AddReserve(
267                 $branch,      $borrowernumber,
268                 $biblioNum,   'a',
269                 [$biblioNum], $rank,
270                 $startdate,   $expiration_date,
271                 $notes,       $biblioData->{title},
272                 $itemNum,     $found
273             );
274             ++$reserve_cnt;
275         }
276     }
277
278     print $query->redirect("/cgi-bin/koha/opac-user.pl#opac-user-holds");
279     exit;
280 }
281
282 #
283 #
284 # Here we check that the borrower can actually make reserves Stage 1.
285 #
286 #
287 my $noreserves     = 0;
288 my $maxoutstanding = C4::Context->preference("maxoutstanding");
289 $template->param( noreserve => 1 ) unless $maxoutstanding;
290 if ( $borr->{'amountoutstanding'} && ($borr->{'amountoutstanding'} > $maxoutstanding) ) {
291     my $amount = sprintf "\$%.02f", $borr->{'amountoutstanding'};
292     $template->param( message => 1 );
293     $noreserves = 1;
294     $template->param( too_much_oweing => $amount );
295 }
296 if ( $borr->{gonenoaddress} && ($borr->{gonenoaddress} == 1) ) {
297     $noreserves = 1;
298     $template->param(
299                      message => 1,
300                      GNA     => 1
301                     );
302 }
303 if ( $borr->{lost} && ($borr->{lost} == 1) ) {
304     $noreserves = 1;
305     $template->param(
306                      message => 1,
307                      lost    => 1
308                     );
309 }
310 if ( CheckBorrowerDebarred($borrowernumber) ) {
311     $noreserves = 1;
312     $template->param(
313                      message  => 1,
314                      debarred => 1
315                     );
316 }
317
318 my @reserves = GetReservesFromBorrowernumber( $borrowernumber );
319 $template->param( RESERVES => \@reserves );
320 if ( $MAXIMUM_NUMBER_OF_RESERVES && (scalar(@reserves) >= $MAXIMUM_NUMBER_OF_RESERVES) ) {
321     $template->param( message => 1 );
322     $noreserves = 1;
323     $template->param( too_many_reserves => scalar(@reserves));
324 }
325 foreach my $res (@reserves) {
326     foreach my $biblionumber (@biblionumbers) {
327         if ( $res->{'biblionumber'} == $biblionumber && $res->{'borrowernumber'} == $borrowernumber) {
328 #            $template->param( message => 1 );
329 #            $noreserves = 1;
330 #            $template->param( already_reserved => 1 );
331             $biblioDataHash{$biblionumber}->{already_reserved} = 1;
332         }
333     }
334 }
335
336 unless ($noreserves) {
337     $template->param( select_item_types => 1 );
338 }
339
340
341 #
342 #
343 # Build the template parameters that will show the info
344 # and items for each biblionumber.
345 #
346 #
347 my $notforloan_label_of = get_notforloan_label_of();
348
349 my $biblioLoop = [];
350 my $numBibsAvailable = 0;
351 my $itemdata_enumchron = 0;
352 my $anyholdable = 0;
353 my $itemLevelTypes = C4::Context->preference('item-level_itypes');
354 $template->param('item_level_itypes' => $itemLevelTypes);
355
356 foreach my $biblioNum (@biblionumbers) {
357
358     my $record = GetMarcBiblio($biblioNum);
359     # Init the bib item with the choices for branch pickup
360     my %biblioLoopIter = ( branchloop => $branchloop );
361
362     # Get relevant biblio data.
363     my $biblioData = $biblioDataHash{$biblioNum};
364     if (! $biblioData) {
365         $template->param(message=>1, bad_biblionumber=>$biblioNum);
366         &get_out($query, $cookie, $template->output);
367     }
368
369     $biblioLoopIter{biblionumber} = $biblioData->{biblionumber};
370     $biblioLoopIter{title} = $biblioData->{title};
371     $biblioLoopIter{subtitle} = GetRecordValue('subtitle', $record, GetFrameworkCode($biblioData->{biblionumber}));
372     $biblioLoopIter{author} = $biblioData->{author};
373     $biblioLoopIter{rank} = $biblioData->{rank};
374     $biblioLoopIter{reservecount} = $biblioData->{reservecount};
375     $biblioLoopIter{already_reserved} = $biblioData->{already_reserved};
376
377     if (!$itemLevelTypes && $biblioData->{itemtype}) {
378         $biblioLoopIter{description} = $itemTypes->{$biblioData->{itemtype}}{description};
379         $biblioLoopIter{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$biblioData->{itemtype}}{imageurl};
380     }
381
382     foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
383         $debug and warn $itemInfo->{'notforloan'};
384
385         # Get reserve fee.
386         my $fee = GetReserveFee(undef, $borrowernumber, $itemInfo->{'biblionumber'}, 'a',
387                                 ( $itemInfo->{'biblioitemnumber'} ) );
388         $itemInfo->{'reservefee'} = sprintf "%.02f", ($fee ? $fee : 0.0);
389
390         if ($itemLevelTypes && $itemInfo->{itype}) {
391             $itemInfo->{description} = $itemTypes->{$itemInfo->{itype}}{description};
392             $itemInfo->{imageurl} = getitemtypeimagesrc() . "/". $itemTypes->{$itemInfo->{itype}}{imageurl};
393         }
394
395         if (!$itemInfo->{'notforloan'} && !($itemInfo->{'itemnotforloan'} > 0)) {
396             $biblioLoopIter{forloan} = 1;
397         }
398     }
399
400     $biblioLoopIter{itemLoop} = [];
401     my $numCopiesAvailable = 0;
402     foreach my $itemInfo (@{$biblioData->{itemInfos}}) {
403         my $itemNum = $itemInfo->{itemnumber};
404         my $itemLoopIter = {};
405
406         $itemLoopIter->{itemnumber} = $itemNum;
407         $itemLoopIter->{barcode} = $itemInfo->{barcode};
408         $itemLoopIter->{homeBranchName} = $branches->{$itemInfo->{homebranch}}{branchname};
409         $itemLoopIter->{callNumber} = $itemInfo->{itemcallnumber};
410         $itemLoopIter->{enumchron} = $itemInfo->{enumchron};
411         $itemLoopIter->{copynumber} = $itemInfo->{copynumber};
412         if ($itemLevelTypes) {
413             $itemLoopIter->{description} = $itemInfo->{description};
414             $itemLoopIter->{imageurl} = $itemInfo->{imageurl};
415         }
416
417         # If the holdingbranch is different than the homebranch, we show the
418         # holdingbranch of the document too.
419         if ( $itemInfo->{homebranch} ne $itemInfo->{holdingbranch} ) {
420             $itemLoopIter->{holdingBranchName} =
421               $branches->{ $itemInfo->{holdingbranch} }{branchname};
422         }
423
424         # If the item is currently on loan, we display its return date and
425         # change the background color.
426         my $issues= GetItemIssue($itemNum);
427         if ( $issues->{'date_due'} ) {
428             $itemLoopIter->{dateDue} = format_sqlduedatetime($issues->{date_due});
429             $itemLoopIter->{backgroundcolor} = 'onloan';
430         }
431
432         # checking reserve
433         my ($reservedate,$reservedfor,$expectedAt) = GetReservesFromItemnumber($itemNum);
434         my $ItemBorrowerReserveInfo = GetMemberDetails( $reservedfor, 0);
435
436         # the item could be reserved for this borrower vi a host record, flag this
437         if ($reservedfor eq $borrowernumber){
438                 $itemLoopIter->{already_reserved} = 1;
439         }
440
441         if ( defined $reservedate ) {
442             $itemLoopIter->{backgroundcolor} = 'reserved';
443             $itemLoopIter->{reservedate}     = format_date($reservedate);
444             $itemLoopIter->{ReservedForBorrowernumber} = $reservedfor;
445             $itemLoopIter->{ReservedForSurname}        = $ItemBorrowerReserveInfo->{'surname'};
446             $itemLoopIter->{ReservedForFirstname}      = $ItemBorrowerReserveInfo->{'firstname'};
447             $itemLoopIter->{ExpectedAtLibrary}         = $expectedAt;
448         }
449
450         $itemLoopIter->{notforloan} = $itemInfo->{notforloan};
451         $itemLoopIter->{itemnotforloan} = $itemInfo->{itemnotforloan};
452
453         # Management of the notforloan document
454         if ( $itemLoopIter->{notforloan} || $itemLoopIter->{itemnotforloan}) {
455             $itemLoopIter->{backgroundcolor} = 'other';
456             $itemLoopIter->{notforloanvalue} =
457               $notforloan_label_of->{ $itemLoopIter->{notforloan} };
458         }
459
460         # Management of lost or long overdue items
461         if ( $itemInfo->{itemlost} ) {
462
463             # FIXME localized strings should never be in Perl code
464             $itemLoopIter->{message} =
465                 $itemInfo->{itemlost} == 1 ? "(lost)"
466               : $itemInfo->{itemlost} == 2 ? "(long overdue)"
467               : "";
468             $itemInfo->{backgroundcolor} = 'other';
469         }
470
471         # Check of the transfered documents
472         my ( $transfertwhen, $transfertfrom, $transfertto ) =
473           GetTransfers($itemNum);
474         if ( $transfertwhen && ($transfertwhen ne '') ) {
475             $itemLoopIter->{transfertwhen} = format_date($transfertwhen);
476             $itemLoopIter->{transfertfrom} =
477               $branches->{$transfertfrom}{branchname};
478             $itemLoopIter->{transfertto} = $branches->{$transfertto}{branchname};
479             $itemLoopIter->{nocancel} = 1;
480         }
481
482         # if the items belongs to a host record, show link to host record
483         if ($itemInfo->{biblionumber} ne $biblioNum){
484                 $biblioLoopIter{hostitemsflag} = 1;
485                 $itemLoopIter->{hostbiblionumber} = $itemInfo->{biblionumber};
486                 $itemLoopIter->{hosttitle} = GetBiblioData($itemInfo->{biblionumber})->{title};
487         }
488
489         # If there is no loan, return and transfer, we show a checkbox.
490         $itemLoopIter->{notforloan} = $itemLoopIter->{notforloan} || 0;
491
492         my $branch = ( C4::Context->preference('ReservesControlBranch') eq 'ItemHomeLibrary' ) ? $itemInfo->{'homebranch'} : $borr->{'branchcode'};
493
494         my $branchitemrule = GetBranchItemRule( $branch, $itemInfo->{'itype'} );
495         my $policy_holdallowed = 1;
496
497         if ( $branchitemrule->{'holdallowed'} == 0 ||
498                 ( $branchitemrule->{'holdallowed'} == 1 && $borr->{'branchcode'} ne $itemInfo->{'homebranch'} ) ) {
499             $policy_holdallowed = 0;
500         }
501
502         if (IsAvailableForItemLevelRequest($itemNum) and $policy_holdallowed and CanItemBeReserved($borrowernumber,$itemNum) and ($itemLoopIter->{already_reserved} ne 1)) {
503             $itemLoopIter->{available} = 1;
504             $numCopiesAvailable++;
505         }
506
507         # FIXME: move this to a pm
508         my $dbh = C4::Context->dbh;
509         my $sth2 = $dbh->prepare("SELECT * FROM reserves WHERE borrowernumber=? AND itemnumber=? AND found='W'");
510         $sth2->execute($itemLoopIter->{ReservedForBorrowernumber}, $itemNum);
511         while (my $wait_hashref = $sth2->fetchrow_hashref) {
512             $itemLoopIter->{waitingdate} = format_date($wait_hashref->{waitingdate});
513         }
514         $itemLoopIter->{imageurl} = getitemtypeimagelocation( 'opac', $itemTypes->{ $itemInfo->{itype} }{imageurl} );
515
516     # Show serial enumeration when needed
517         if ($itemLoopIter->{enumchron}) {
518             $itemdata_enumchron = 1;
519         }
520
521         push @{$biblioLoopIter{itemLoop}}, $itemLoopIter;
522     }
523     $template->param( itemdata_enumchron => $itemdata_enumchron );
524
525     if ($numCopiesAvailable > 0) {
526         $numBibsAvailable++;
527         $biblioLoopIter{bib_available} = 1;
528         $biblioLoopIter{holdable} = 1;
529     }
530     if ($biblioLoopIter{already_reserved}) {
531         $biblioLoopIter{holdable} = undef;
532     }
533     if(not CanBookBeReserved($borrowernumber,$biblioNum)){
534         $biblioLoopIter{holdable} = undef;
535     }
536     if(not C4::Context->preference('AllowHoldsOnPatronsPossessions') and CheckIfIssuedToPatron($borrowernumber,$biblioNum)) {
537         $biblioLoopIter{holdable} = undef;
538         $biblioLoopIter{already_patron_possession} = 1;
539     }
540
541     if( $biblioLoopIter{holdable} ){ $anyholdable++; }
542
543     push @$biblioLoop, \%biblioLoopIter;
544 }
545
546 if ( $numBibsAvailable == 0 || $anyholdable == 0) {
547     $template->param( none_available => 1 );
548 }
549
550 my $itemTableColspan = 7;
551 if (! $template->{VARS}->{'OPACItemHolds'}) {
552     $itemTableColspan--;
553 }
554 if (! $template->{VARS}->{'singleBranchMode'}) {
555     $itemTableColspan--;
556 }
557 $template->param(itemtable_colspan => $itemTableColspan);
558
559 # display infos
560 $template->param(bibitemloop => $biblioLoop);
561 $template->param( showholds=>$show_holds_count);
562 $template->param( showpriority=>$show_priority);
563 # can set reserve date in future
564 if (
565     C4::Context->preference( 'AllowHoldDateInFuture' ) &&
566     C4::Context->preference( 'OPACAllowHoldDateInFuture' )
567     ) {
568     $template->param(
569             reserve_in_future         => 1,
570     );
571 }
572
573 output_html_with_http_headers $query, $cookie, $template->output;
574