Problem : circulation.pl cannot compile
[koha.git] / reserve / request.pl
1 #!/usr/bin/perl
2
3
4 #writen 2/1/00 by chris@katipo.oc.nz
5 # Copyright 2000-2002 Katipo Communications
6 #
7 # This file is part of Koha.
8 #
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
12 # version.
13 #
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License along with
19 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
20 # Suite 330, Boston, MA  02111-1307 USA
21
22 =head1 request.pl
23
24 script to place reserves/requests
25
26 =cut
27
28 use strict;
29 use warnings;
30 use C4::Branch; # GetBranches get_branchinfos_of
31 use CGI;
32 use List::MoreUtils qw/uniq/;
33 use Date::Calc qw/Date_to_Days/;
34 use C4::Output;
35 use C4::Auth;
36 use C4::Reserves;
37 use C4::Biblio;
38 use C4::Items;
39 use C4::Koha;
40 use C4::Circulation;
41 use C4::Dates qw/format_date/;
42 use C4::Members;
43 use C4::Search;         # enabled_staff_search_views
44
45 my $dbh = C4::Context->dbh;
46 my $sth;
47 my $input = new CGI;
48 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
49     {
50         template_name   => "reserve/request.tmpl",
51         query           => $input,
52         type            => "intranet",
53         authnotrequired => 0,
54         flagsrequired   => { reserveforothers => 1 },
55     }
56 );
57
58 my $multihold = $input->param('multi_hold');
59 $template->param(multi_hold => $multihold);
60
61 # get Branches and Itemtypes
62 my $branches = GetBranches();
63 my $itemtypes = GetItemTypes();
64     
65 my $default = C4::Context->userenv->{branch};
66 my @values;
67 my %label_of;
68     
69 foreach my $branchcode (sort keys %{$branches} ) {
70     push @values, $branchcode;
71     $label_of{$branchcode} = $branches->{$branchcode}->{branchname};
72 }
73 my $CGIbranch = CGI::scrolling_list(
74                                     -name     => 'pickup',
75                                     -id          => 'pickup',
76                                     -values   => \@values,
77                                     -default  => $default,
78                                     -labels   => \%label_of,
79                                     -size     => 1,
80                                     -multiple => 0,
81                                    );
82
83 # Select borrowers infos
84 my $findborrower = $input->param('findborrower');
85 $findborrower =~ s|,| |g;
86 my $cardnumber = $input->param('cardnumber');
87 my $borrowerslist;
88 my $messageborrower;
89 my $warnings;
90 my $messages;
91 my $maxreserves;
92
93 my $date = C4::Dates->today('iso');
94
95 if ($findborrower) {
96     my ( $count, $borrowers ) =
97       SearchMember($findborrower, 'cardnumber', 'web' );
98
99     my @borrowers = @$borrowers;
100
101     if ( $#borrowers == -1 ) {
102         $input->param( 'findborrower', '' );
103         $messageborrower = "'$findborrower'";
104     }
105     elsif ( $#borrowers == 0 ) {
106         $input->param( 'cardnumber', $borrowers[0]->{'cardnumber'} );
107         $cardnumber = $borrowers[0]->{'cardnumber'};
108     }
109     else {
110         $borrowerslist = \@borrowers;
111     }
112 }
113
114 if ($cardnumber) {
115     my $borrowerinfo = GetMemberDetails( 0, $cardnumber );
116     my $diffbranch;
117     my @getreservloop;
118     my $count_reserv = 0;
119
120 #   we check the reserves of the borrower, and if he can reserv a document
121 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
122
123     
124
125     my $number_reserves =
126       GetReserveCount( $borrowerinfo->{'borrowernumber'} );
127     
128     # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
129     my $expiry_date = $borrowerinfo->{dateexpiry};
130     my $expiry = 0; # flag set if patron account has expired
131     if ($expiry_date and $expiry_date ne '0000-00-00' and
132             Date_to_Days(split (/-/,$date)) > Date_to_Days(split (/-/,$expiry_date))) {
133                 $messages = $expiry = 1;
134     }else{
135         $expiry = 0;
136     }
137
138
139     # check if the borrower make the reserv in a different branch
140     if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
141                 $messages = 1;
142         $diffbranch = 1;
143     }
144
145     $template->param(
146                 borrowernumber => $borrowerinfo->{'borrowernumber'},
147                 borrowersurname   => $borrowerinfo->{'surname'},
148                 borrowerfirstname => $borrowerinfo->{'firstname'},
149                 borrowerstreetaddress => $borrowerinfo->{'address'},
150                 borrowercity => $borrowerinfo->{'city'},
151                 borrowerphone => $borrowerinfo->{'phone'},
152                 borrowermobile => $borrowerinfo->{'mobile'},
153                 borrowerfax => $borrowerinfo->{'fax'},
154                 borrowerphonepro => $borrowerinfo->{'phonepro'},
155                 borroweremail => $borrowerinfo->{'email'},
156                 borroweremailpro => $borrowerinfo->{'emailpro'},
157                 borrowercategory => $borrowerinfo->{'category'},
158                 borrowerreservs   => $count_reserv,
159                 expiry            => $expiry,
160                 diffbranch        => $diffbranch,
161                                 messages => $messages,
162                                 warnings => $warnings
163     );
164 }
165
166 $template->param( messageborrower => $messageborrower );
167
168 my $CGIselectborrower;
169 if ($borrowerslist) {
170     my @values;
171     my %labels;
172
173     foreach my $borrower (
174         sort {
175                 $a->{surname}
176               . $a->{firstname} cmp $b->{surname}
177               . $b->{firstname}
178         } @{$borrowerslist}
179       )
180     {
181         push @values, $borrower->{cardnumber};
182
183         $labels{ $borrower->{cardnumber} } = sprintf(
184             '%s, %s ... (%s - %s) ... %s',
185             $borrower->{surname},    $borrower->{firstname},
186             $borrower->{cardnumber}, $borrower->{categorycode},
187             $borrower->{address},
188         );
189     }
190
191     $CGIselectborrower = CGI::scrolling_list(
192         -name     => 'cardnumber',
193         -values   => \@values,
194         -labels   => \%labels,
195         -size     => 7,
196         -multiple => 0,
197     );
198 }
199
200 # FIXME launch another time GetMemberDetails perhaps until
201 my $borrowerinfo = GetMemberDetails( 0, $cardnumber );
202
203 my @biblionumbers = ();
204 my $biblionumbers = $input->param('biblionumbers');
205 if ($multihold) {
206     @biblionumbers = split '/', $biblionumbers;
207 } else {
208     push @biblionumbers, $input->param('biblionumber');
209 }
210
211 my @biblioloop = ();
212 foreach my $biblionumber (@biblionumbers) {
213
214     if ( not CanBookBeReserved($borrowerinfo->{borrowernumber}, $biblionumber) ) {
215                 $warnings = 1;
216         $maxreserves = 1;
217     }
218
219     my %biblioloopiter = ();
220
221     my $dat          = GetBiblioData($biblionumber);
222
223     # get existing reserves .....
224     my ( $count, $reserves ) = GetReservesFromBiblionumber($biblionumber);
225     my $totalcount = $count;
226     my $alreadyreserved;
227
228     foreach my $res (@$reserves) {
229         if ( ( $res->{found} eq 'W' ) ) {
230             $count--;
231         }
232
233         if ( $borrowerinfo->{borrowernumber} eq $res->{borrowernumber} ) {
234             $warnings = 1;
235             $alreadyreserved = 1;
236             $biblioloopiter{warn} = 1;
237             $biblioloopiter{alreadyres} = 1;
238         }
239     }
240
241     $template->param( alreadyreserved => $alreadyreserved,
242                       messages => $messages,
243                       warnings => $warnings );
244     
245     
246     # FIXME think @optionloop, is maybe obsolete, or  must be switchable by a systeme preference fixed rank or not
247     # make priorities options
248     
249     my @optionloop;
250     for ( 1 .. $count + 1 ) {
251         push(
252              @optionloop,
253              {
254               num      => $_,
255               selected => ( $_ == $count + 1 ),
256              }
257             );
258     }
259     # adding a fixed value for priority options
260     my $fixedRank = $count+1;
261
262     my @branchcodes;
263     my %itemnumbers_of_biblioitem;
264     my @itemnumbers;
265     
266     ## $items is array of 'item' table numbers
267     if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
268         @itemnumbers  = @$items;
269     }
270     else {
271         $template->param('noitems' => 1);
272         $biblioloopiter{noitems} = 1;
273     }
274     
275     ## Hash of item number to 'item' table fields
276     my $iteminfos_of = GetItemInfosOf(@itemnumbers);
277     
278     ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
279     ## when by definition all of the itemnumber have the same biblioitemnumber
280     foreach my $itemnumber (@itemnumbers) {
281         my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
282         push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
283     }
284     
285     ## Should be same as biblionumber
286     my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
287     
288     my $notforloan_label_of = get_notforloan_label_of();
289     
290     ## Hash of biblioitemnumber to 'biblioitem' table records
291     my $biblioiteminfos_of  = GetBiblioItemInfosOf(@biblioitemnumbers);
292     
293     my @bibitemloop;
294     
295     foreach my $biblioitemnumber (@biblioitemnumbers) {
296         my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
297         my $num_available;
298         my $num_override;
299         
300         $biblioitem->{description} =
301           $itemtypes->{ $biblioitem->{itemtype} }{description};
302         $biblioloopiter{description} = $biblioitem->{description};
303         $biblioloopiter{itypename} = $biblioitem->{description};
304         $biblioloopiter{imageurl} =
305           getitemtypeimagelocation('intranet', $itemtypes->{$biblioitem->{itemtype}}{imageurl});
306         
307         foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } )    {
308             my $item = $iteminfos_of->{$itemnumber};
309             
310             unless (C4::Context->preference('item-level_itypes')) {
311                 $item->{itype} = $biblioitem->{itemtype};
312             }
313             
314             $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
315             $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
316             $item->{homebranchname} = $branches->{ $item->{homebranch} }{branchname};
317             
318             # if the holdingbranch is different than the homebranch, we show the
319             # holdingbranch of the document too
320             if ( $item->{homebranch} ne $item->{holdingbranch} ) {
321                 $item->{holdingbranchname} =
322                   $branches->{ $item->{holdingbranch} }{branchname};
323             }
324             
325             #   add information
326             $item->{itemcallnumber} = $item->{itemcallnumber};
327             
328             # if the item is currently on loan, we display its return date and
329             # change the background color
330             my $issues= GetItemIssue($itemnumber);
331             if ( $issues->{'date_due'} ) {
332                 $item->{date_due} = format_date($issues->{'date_due'});
333                 $item->{backgroundcolor} = 'onloan';
334             }
335             
336             # checking reserve
337             my ($reservedate,$reservedfor,$expectedAt) = GetReservesFromItemnumber($itemnumber);
338             my $ItemBorrowerReserveInfo = GetMemberDetails( $reservedfor, 0);
339             
340             if ( defined $reservedate ) {
341                 $item->{backgroundcolor} = 'reserved';
342                 $item->{reservedate}     = format_date($reservedate);
343                 $item->{ReservedForBorrowernumber}     = $reservedfor;
344                 $item->{ReservedForSurname}     = $ItemBorrowerReserveInfo->{'surname'};
345                 $item->{ReservedForFirstname}     = $ItemBorrowerReserveInfo->{'firstname'};
346                 $item->{ExpectedAtLibrary}     = $branches->{$expectedAt}{branchname};
347                 
348             }
349             
350             # Management of the notforloan document
351             if ( $item->{notforloan} ) {
352                 $item->{backgroundcolor} = 'other';
353                 $item->{notforloanvalue} =
354                   $notforloan_label_of->{ $item->{notforloan} };
355             }
356             
357             # Management of lost or long overdue items
358             if ( $item->{itemlost} ) {
359                 
360                 # FIXME localized strings should never be in Perl code
361                 $item->{message} =
362                   $item->{itemlost} == 1 ? "(lost)"
363                     : $item->{itemlost} == 2 ? "(long overdue)"
364                       : "";
365                 $item->{backgroundcolor} = 'other';
366             }
367             
368             # Check the transit status
369             my ( $transfertwhen, $transfertfrom, $transfertto ) =
370               GetTransfers($itemnumber);
371             
372             if ( $transfertwhen ne '' ) {
373                 $item->{transfertwhen} = format_date($transfertwhen);
374                 $item->{transfertfrom} =
375                   $branches->{$transfertfrom}{branchname};
376                 $item->{transfertto} = $branches->{$transfertto}{branchname};
377                 $item->{nocancel} = 1;
378             }
379             
380             # If there is no loan, return and transfer, we show a checkbox.
381             $item->{notforloan} = $item->{notforloan} || 0;
382             
383             # if independent branches is on we need to check if the person can reserve
384             # for branches they arent logged in to
385             if ( C4::Context->preference("IndependantBranches") ) { 
386                 if (! C4::Context->preference("canreservefromotherbranches")){
387                     # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
388                     my $userenv = C4::Context->userenv;
389                     if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
390                         $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
391                     }
392                 }
393             }
394             
395             my $branchitemrule = GetBranchItemRule( $item->{'homebranch'}, $item->{'itype'} );
396             my $policy_holdallowed = 1;
397             
398             $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
399             
400             if ( $branchitemrule->{'holdallowed'} == 0 ||
401                  ( $branchitemrule->{'holdallowed'} == 1 && $borrowerinfo->{'branchcode'} ne $item->{'homebranch'} ) ) {
402                 $policy_holdallowed = 0;
403             }
404             
405             if (IsAvailableForItemLevelRequest($itemnumber) and not $item->{cantreserve} and CanItemBeReserved($borrowerinfo->{borrowernumber}, $itemnumber) ) {
406                 if ( not $policy_holdallowed and C4::Context->preference( 'AllowHoldPolicyOverride' ) ) {
407                     $item->{override} = 1;
408                     $num_override++;
409                 } elsif ( $policy_holdallowed ) {
410                     $item->{available} = 1;
411                     $num_available++;
412                 }
413             }
414             # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
415             
416             # FIXME: move this to a pm
417             my $sth2 = $dbh->prepare("SELECT * FROM reserves WHERE borrowernumber=? AND itemnumber=? AND found='W'");
418             $sth2->execute($item->{ReservedForBorrowernumber},$item->{itemnumber});
419             while (my $wait_hashref = $sth2->fetchrow_hashref) {
420                 $item->{waitingdate} = format_date($wait_hashref->{waitingdate});
421             }
422             push @{ $biblioitem->{itemloop} }, $item;
423         }
424         
425         if ( $num_override == scalar( @{ $biblioitem->{itemloop} } ) ) { # That is, if all items require an override
426             $template->param( override_required => 1 );
427         } elsif ( $num_available == 0 ) {
428             $template->param( none_available => 1 );
429             $template->param( warnings => 1 );
430             $biblioloopiter{warn} = 1;
431             $biblioloopiter{none_avail} = 1;
432         }
433         
434         push @bibitemloop, $biblioitem;
435     }
436
437     # existingreserves building
438     my @reserveloop;
439     ( $count, $reserves ) = GetReservesFromBiblionumber($biblionumber);
440     foreach my $res ( sort { $a->{found} cmp $b->{found} } @$reserves ) {
441         my %reserve;
442         my @optionloop;
443         for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
444             push(
445                  @optionloop,
446                  {
447                   num      => $i,
448                   selected => ( $i == $res->{priority} ),
449                  }
450                 );
451         }
452         my @branchloop;
453         foreach my $br ( keys %$branches ) {
454             my %abranch;
455             $abranch{'selected'}   = ( $br eq $res->{'branchcode'} );
456             $abranch{'branch'}     = $br;
457             $abranch{'branchname'} = $branches->{$br}->{'branchname'};
458             push( @branchloop, \%abranch );
459         }
460         
461         if ( ( $res->{'found'} eq 'W' ) ) {
462             my $item = $res->{'itemnumber'};
463             $item = GetBiblioFromItemNumber($item,undef);
464             $reserve{'wait'}= 1; 
465             $reserve{'holdingbranch'}=$item->{'holdingbranch'};
466             $reserve{'biblionumber'}=$item->{'biblionumber'};
467             $reserve{'barcodenumber'}   = $item->{'barcode'};
468             $reserve{'wbrcode'} = $res->{'branchcode'};
469             $reserve{'itemnumber'}  = $res->{'itemnumber'};
470             $reserve{'wbrname'} = $branches->{$res->{'branchcode'}}->{'branchname'};
471             if($reserve{'holdingbranch'} eq $reserve{'wbrcode'}){
472                 $reserve{'atdestination'} = 1;
473             }
474             # set found to 1 if reserve is waiting for patron pickup
475             $reserve{'found'} = 1 if $res->{'found'} eq 'W';
476         } elsif ($res->{priority} > 0) {
477             if (defined($res->{itemnumber})) {
478                 my $item = GetItem($res->{itemnumber});
479                 $reserve{'itemnumber'}  = $res->{'itemnumber'};
480                 $reserve{'barcodenumber'}   = $item->{'barcode'};
481                 $reserve{'item_level_hold'} = 1;
482             }
483         }
484         
485         #     get borrowers reserve info
486         my $reserveborrowerinfo = GetMemberDetails( $res->{'borrowernumber'}, 0);
487         
488         $reserve{'date'}           = format_date( $res->{'reservedate'} );
489         $reserve{'borrowernumber'} = $res->{'borrowernumber'};
490         $reserve{'biblionumber'}   = $res->{'biblionumber'};
491         $reserve{'borrowernumber'} = $res->{'borrowernumber'};
492         $reserve{'firstname'}      = $reserveborrowerinfo->{'firstname'};
493         $reserve{'surname'}        = $reserveborrowerinfo->{'surname'};
494         $reserve{'notes'}          = $res->{'reservenotes'};
495         $reserve{'wait'}           =
496           ( ( $res->{'found'} eq 'W' ) or ( $res->{'priority'} eq '0' ) );
497         $reserve{'constrainttypea'} = ( $res->{'constrainttype'} eq 'a' );
498         $reserve{'constrainttypeo'} = ( $res->{'constrainttype'} eq 'o' );
499         $reserve{'voldesc'}         = $res->{'volumeddesc'};
500         $reserve{'ccode'}           = $res->{'ccode'};
501         $reserve{'barcode'}         = $res->{'barcode'};
502         $reserve{'priority'}    = $res->{'priority'};
503         $reserve{'branchloop'} = \@branchloop;
504         $reserve{'optionloop'} = \@optionloop;
505         
506         push( @reserveloop, \%reserve );
507     }
508     
509     # get the time for the form name...
510     my $time = time();
511     
512     $template->param(
513                      CGIbranch   => $CGIbranch,
514
515                      time        => $time,
516                      fixedRank   => $fixedRank,
517                     );
518     
519     # display infos
520     $template->param(
521                      optionloop        => \@optionloop,
522                      bibitemloop       => \@bibitemloop,
523                      date              => $date,
524                      biblionumber      => $biblionumber,
525                      findborrower      => $findborrower,
526                      cardnumber        => $cardnumber,
527                      CGIselectborrower => $CGIselectborrower,
528                      title             => $dat->{title},
529                      author            => $dat->{author},
530                      holdsview => 1,
531                      borrower_branchname => $branches->{$borrowerinfo->{'branchcode'}}->{'branchname'},
532                      borrower_branchcode => $borrowerinfo->{'branchcode'},
533                      C4::Search::enabled_staff_search_views,
534                     );
535
536     $biblioloopiter{biblionumber} = $biblionumber;
537     $biblioloopiter{title} = $dat->{title};
538     $biblioloopiter{rank} = $fixedRank;
539     $biblioloopiter{reserveloop} = \@reserveloop;
540
541     if (@reserveloop) {
542         $template->param( reserveloop => \@reserveloop );
543     }
544     
545
546     push @biblioloop, \%biblioloopiter;
547 }
548
549 $template->param( biblioloop => \@biblioloop );
550 $template->param( biblionumbers => $biblionumbers );
551 $template->param( maxreserves => $maxreserves );
552
553 if ($multihold) {
554     $template->param( multi_hold => 1 );
555 }
556     
557 # printout the page
558 output_html_with_http_headers $input, $cookie, $template->output;