Some refinements to statuses and messages. Beginning to standardize call number displays.
[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 C4::Branch; # GetBranches get_branchinfos_of
30 use CGI;
31 use List::MoreUtils qw/uniq/;
32 use Date::Calc qw/Today Date_to_Days/;
33 use C4::Output;
34 use C4::Auth;
35 use C4::Reserves;
36 use C4::Biblio;
37 use C4::Koha;
38 use C4::Circulation;
39 use C4::Dates qw/format_date/;
40 use C4::Members;
41
42 my $dbh = C4::Context->dbh;
43 my $sth;
44 my $input = new CGI;
45 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
46     {
47         template_name   => "reserve/request.tmpl",
48         query           => $input,
49         type            => "intranet",
50         authnotrequired => 0,
51         flagsrequired   => { reserveforothers => 1 },
52     }
53 );
54
55 # get Branches and Itemtypes
56 my $branches = GetBranches();
57 my $itemtypes = GetItemTypes();
58
59 # get biblio information....
60 my $biblionumber = $input->param('biblionumber');
61 my $dat          = GetBiblioData($biblionumber);
62
63 # Select borrowers infos
64 my $findborrower = $input->param('findborrower');
65 $findborrower =~ s|,| |g;
66 my $cardnumber = $input->param('cardnumber');
67 my $borrowerslist;
68 my $messageborrower;
69 my $warnings;
70 my $messages;
71
72 my $date = sprintf( '%04d-%02d-%02d', Today() );
73
74 if ($findborrower) {
75     my ( $count, $borrowers ) =
76       SearchMember($findborrower, 'cardnumber', 'web' );
77
78     my @borrowers = @$borrowers;
79
80     if ( $#borrowers == -1 ) {
81         $input->param( 'findborrower', '' );
82         $messageborrower = "'$findborrower'";
83     }
84     elsif ( $#borrowers == 0 ) {
85         $input->param( 'cardnumber', $borrowers[0]->{'cardnumber'} );
86         $cardnumber = $borrowers[0]->{'cardnumber'};
87     }
88     else {
89         $borrowerslist = \@borrowers;
90     }
91 }
92
93 if ($cardnumber) {
94     my $borrowerinfo = GetMemberDetails( 0, $cardnumber );
95     my $expiry;
96     my $diffbranch;
97     my @getreservloop;
98     my $count_reserv = 0;
99     my $maxreserves;
100
101 #   we check the reserves of the borrower, and if he can reserv a document
102 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
103
104     my $number_reserves =
105       GetReserveCount( $borrowerinfo->{'borrowernumber'} );
106
107     if ( $number_reserves > C4::Context->preference('maxreserves') ) {
108                 $warnings = 1;
109         $maxreserves = 1;
110     }
111
112     # we check the date expiricy of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
113     if ($borrowerinfo->{'dateexpiry'} ne '0000-00-00') {
114         my $warning = (Date_to_Days(split /-/,$date) > Date_to_Days( split /-/,$borrowerinfo->{'dateexpiry'}));
115         if ( $warning > 0 ) {
116                         $messages = 1;
117             $expiry = 1;
118         }
119     } else {
120                 $messages = 1;
121         $expiry = 1;
122     }
123      
124
125     # check if the borrower make the reserv in a different branch
126     if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
127                 $messages = 1;
128         $diffbranch = 1;
129     }
130
131     $template->param(
132                 borrowernumber => $borrowerinfo->{'borrowernumber'},
133                 borrowersurname   => $borrowerinfo->{'surname'},
134                 borrowerfirstname => $borrowerinfo->{'firstname'},
135                 borrowerstreetaddress => $borrowerinfo->{'address'},
136                 borrowercity => $borrowerinfo->{'city'},
137                 borrowerphone => $borrowerinfo->{'phone'},
138                 borrowermobile => $borrowerinfo->{'mobile'},
139                 borrowerfax => $borrowerinfo->{'fax'},
140                 borrowerphonepro => $borrowerinfo->{'phonepro'},
141                 borroweremail => $borrowerinfo->{'email'},
142                 borroweremailpro => $borrowerinfo->{'emailpro'},
143                 borrowercategory => $borrowerinfo->{'category'},
144                 borrowerreservs   => $count_reserv,
145                 maxreserves       => $maxreserves,
146                 expiry            => $expiry,
147                 diffbranch        => $diffbranch,
148                                 messages => $messages,
149                                 warnings => $warnings
150     );
151 }
152
153 $template->param( messageborrower => $messageborrower );
154
155 my $CGIselectborrower;
156 if ($borrowerslist) {
157     my @values;
158     my %labels;
159
160     foreach my $borrower (
161         sort {
162                 $a->{surname}
163               . $a->{firstname} cmp $b->{surname}
164               . $b->{firstname}
165         } @{$borrowerslist}
166       )
167     {
168         push @values, $borrower->{cardnumber};
169
170         $labels{ $borrower->{cardnumber} } = sprintf(
171             '%s, %s ... (%s - %s) ... %s',
172             $borrower->{surname},    $borrower->{firstname},
173             $borrower->{cardnumber}, $borrower->{categorycode},
174             $borrower->{streetaddress},
175         );
176     }
177
178     $CGIselectborrower = CGI::scrolling_list(
179         -name     => 'cardnumber',
180         -values   => \@values,
181         -labels   => \%labels,
182         -size     => 7,
183         -multiple => 0,
184     );
185 }
186
187 # get existing reserves .....
188 my ( $count, $reserves ) = GetReservesFromBiblionumber($biblionumber);
189 my $totalcount = $count;
190 my $alreadyreserved;
191
192 # FIXME launch another time GetMemberDetails perhaps until
193 my $borrowerinfo = GetMemberDetails( 0, $cardnumber );
194
195 foreach my $res (@$reserves) {
196     if ( ( $res->{found} eq 'W' ) ) {
197         $count--;
198     }
199
200     if ( $borrowerinfo->{borrowernumber} eq $res->{borrowernumber} ) {
201                 $warnings = 1;
202         $alreadyreserved = 1;
203     }
204 }
205
206 $template->param( alreadyreserved => $alreadyreserved,
207                                 messages => $messages,
208                                 warnings => $warnings );
209
210 # FIXME think @optionloop, is maybe obsolete, or  must be switchable by a systeme preference fixed rank or not
211 # make priorities options
212
213 my @optionloop;
214 for ( 1 .. $count + 1 ) {
215     push(
216         @optionloop,
217         {
218             num      => $_,
219             selected => ( $_ == $count + 1 ),
220         }
221     );
222 }
223 # adding a fixed value for priority options
224 my $fixedRank = $count+1;
225
226 my @branchcodes;
227 my %itemnumbers_of_biblioitem;
228 my @itemnumbers;
229
230 if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
231         @itemnumbers  = @$items;
232 }
233 else {
234         $template->param('noitems' => 1);
235 }
236         
237 my $iteminfos_of = GetItemInfosOf(@itemnumbers);
238
239 foreach my $itemnumber (@itemnumbers) {
240     my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
241     push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
242 }
243
244 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
245
246 my $notforloan_label_of = get_notforloan_label_of();
247 my $biblioiteminfos_of  = GetBiblioItemInfosOf(@biblioitemnumbers);
248
249 my @bibitemloop;
250
251 foreach my $biblioitemnumber (@biblioitemnumbers) {
252     my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
253
254     $biblioitem->{description} =
255       $itemtypes->{ $biblioitem->{itemtype} }{description};
256
257     foreach
258       my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } )
259     {
260         my $item = $iteminfos_of->{$itemnumber};
261     $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
262     $item->{imageurl} = getitemtypeimagesrc() . "/".$itemtypes->{ $item->{itype} }{imageurl};
263         $item->{homebranchname} =
264           $branches->{ $item->{homebranch} }{branchname};
265
266         # if the holdingbranch is different than the homebranch, we show the
267         # holdingbranch of the document too
268         if ( $item->{homebranch} ne $item->{holdingbranch} ) {
269             $item->{holdingbranchname} =
270               $branches->{ $item->{holdingbranch} }{branchname};
271         }
272         
273 #   add information
274     $item->{itemcallnumber} = $item->{itemcallnumber};
275     
276         # if the item is currently on loan, we display its return date and
277         # change the background color
278         my $issues= GetItemIssue($itemnumber);
279         if ( $issues->{'date_due'} ) {
280             $item->{date_due} = format_date($issues->{'date_due'});
281             $item->{backgroundcolor} = 'onloan';
282         }
283
284         # checking reserve
285         my ($reservedate,$reservedfor,$expectedAt) = GetReservesFromItemnumber($itemnumber);
286         my $ItemBorrowerReserveInfo = GetMemberDetails( $reservedfor, 0);
287
288         if ( defined $reservedate ) {
289             $item->{backgroundcolor} = 'reserved';
290             $item->{reservedate}     = format_date($reservedate);
291             $item->{ReservedForBorrowernumber}     = $reservedfor;
292             $item->{ReservedForSurname}     = $ItemBorrowerReserveInfo->{'surname'};
293             $item->{ReservedForFirstname}     = $ItemBorrowerReserveInfo->{'firstname'};
294             $item->{ExpectedAtLibrary}     = $branches->{$expectedAt}{branchname};
295             
296         }
297
298         # Management of the notforloan document
299         if ( $item->{notforloan} ) {
300             $item->{backgroundcolor} = 'other';
301             $item->{notforloanvalue} =
302               $notforloan_label_of->{ $item->{notforloan} };
303         }
304
305         # Management of lost or long overdue items
306         if ( $item->{itemlost} ) {
307
308             # FIXME localized strings should never be in Perl code
309             $item->{message} =
310                 $item->{itemlost} == 1 ? "(lost)"
311               : $item->{itemlost} == 2 ? "(long overdue)"
312               : "";
313             $item->{backgroundcolor} = 'other';
314         }
315
316         # Check the transit status
317         my ( $transfertwhen, $transfertfrom, $transfertto ) =
318           GetTransfers($itemnumber);
319
320         if ( $transfertwhen ne '' ) {
321             $item->{transfertwhen} = format_date($transfertwhen);
322             $item->{transfertfrom} =
323               $branches->{$transfertfrom}{branchname};
324             $item->{transfertto} = $branches->{$transfertto}{branchname};
325         $item->{nocancel} = 1;
326         }
327
328         # If there is no loan, return and transfer, we show a checkbox.
329         $item->{notforloan} = $item->{notforloan} || 0;
330     
331     # if independent branches is on we need to check if the person can reserve
332     # for branches they arent logged in to
333     if ( C4::Context->preference("IndependantBranches") ) { 
334         if (! C4::Context->preference("canreservefromotherbranches")){
335         # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
336         my $userenv = C4::Context->userenv; 
337         if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
338             $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
339         } 
340         }
341     }
342
343     # FIXME: every library will define this differently
344         # An item is available only if:
345         if (
346             not defined $reservedate    # not reserved yet
347             and $issues->{'date_due'} eq ''         # not currently on loan
348             and not $item->{itemlost}   # not lost
349             and not $item->{notforloan} # not forbidden to loan
350         and not $item->{cantreserve}
351             and $transfertwhen eq ''    # not currently on transfert
352           )
353         {
354             $item->{available} = 1;
355         }
356
357     # FIXME: move this to a pm
358     my $sth2 = $dbh->prepare("SELECT * FROM reserves WHERE borrowernumber=? AND itemnumber=? AND found='W' AND cancellationdate IS NULL");
359     $sth2->execute($item->{ReservedForBorrowernumber},$item->{itemnumber});
360     while (my $wait_hashref = $sth2->fetchrow_hashref) {
361         $item->{waitingdate} = format_date($wait_hashref->{waitingdate});
362     }
363         push @{ $biblioitem->{itemloop} }, $item;
364     }
365
366     push @bibitemloop, $biblioitem;
367 }
368
369 # existingreserves building
370 my @reserveloop;
371 ( $count, $reserves ) = GetReservesFromBiblionumber($biblionumber);
372 foreach my $res ( sort { $a->{found} cmp $b->{found} } @$reserves ) {
373     my %reserve;
374     my @optionloop;
375     for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
376         push(
377             @optionloop,
378             {
379                 num      => $i,
380                 selected => ( $i == $res->{priority} ),
381             }
382         );
383     }
384     my @branchloop;
385     foreach my $br ( keys %$branches ) {
386         my %abranch;
387         $abranch{'selected'}   = ( $br eq $res->{'branchcode'} );
388         $abranch{'branch'}     = $br;
389         $abranch{'branchname'} = $branches->{$br}->{'branchname'};
390         push( @branchloop, \%abranch );
391     }
392
393     if ( ( $res->{'found'} eq 'W' ) ) {
394         my $item = $res->{'itemnumber'};
395         $item = GetBiblioFromItemNumber($item,undef);
396         $reserve{'wait'}= 1; 
397         $reserve{'holdingbranch'}=$item->{'holdingbranch'};
398         $reserve{'biblionumber'}=$item->{'biblionumber'};
399         $reserve{'barcodenumber'}   = $item->{'barcode'};
400         $reserve{'wbrcode'} = $res->{'branchcode'};
401         $reserve{'itemnumber'}  = $res->{'itemnumber'};
402         $reserve{'wbrname'} = $branches->{$res->{'branchcode'}}->{'branchname'};
403         if($reserve{'holdingbranch'} eq $reserve{'wbrcode'}){
404             $reserve{'atdestination'} = 1;
405         }
406         # set found to 1 if reserve is waiting for patron pickup
407         $reserve{'found'} = 1 if $res->{'found'} eq 'W';
408     }
409     
410 #     get borrowers reserve info
411 my $reserveborrowerinfo = GetMemberDetails( $res->{'borrowernumber'}, 0);
412
413     $reserve{'date'}           = format_date( $res->{'reservedate'} );
414     $reserve{'borrowernumber'} = $res->{'borrowernumber'};
415     $reserve{'biblionumber'}   = $res->{'biblionumber'};
416     $reserve{'borrowernumber'} = $res->{'borrowernumber'};
417     $reserve{'firstname'}      = $reserveborrowerinfo->{'firstname'};
418     $reserve{'surname'}        = $reserveborrowerinfo->{'surname'};
419     $reserve{'notes'}          = $res->{'reservenotes'};
420     $reserve{'wait'}           =
421       ( ( $res->{'found'} eq 'W' ) or ( $res->{'priority'} eq '0' ) );
422     $reserve{'constrainttypea'} = ( $res->{'constrainttype'} eq 'a' );
423     $reserve{'constrainttypeo'} = ( $res->{'constrainttype'} eq 'o' );
424     $reserve{'voldesc'}         = $res->{'volumeddesc'};
425     $reserve{'ccode'}           = $res->{'ccode'};
426     $reserve{'barcode'}         = $res->{'barcode'};
427     $reserve{'priority'}    = $res->{'priority'};
428     $reserve{'branchloop'} = \@branchloop;
429     $reserve{'optionloop'} = \@optionloop;
430
431     push( @reserveloop, \%reserve );
432 }
433
434 my $default = C4::Context->userenv->{branch};
435 my @values;
436 my %label_of;
437
438 foreach my $branchcode ( keys %{$branches} ) {
439     push @values, $branchcode;
440     $label_of{$branchcode} = $branches->{$branchcode}->{branchname};
441 }
442 my $CGIbranch = CGI::scrolling_list(
443     -name     => 'pickup',
444     -id          => 'pickup',
445     -values   => \@values,
446     -default  => $default,
447     -labels   => \%label_of,
448     -size     => 1,
449     -multiple => 0,
450 );
451
452 # get the time for the form name...
453 my $time = time();
454
455 $template->param(
456     CGIbranch   => $CGIbranch,
457     reserveloop => \@reserveloop,
458     time        => $time,
459     fixedRank   => $fixedRank,
460 );
461
462 # display infos
463 $template->param(
464     optionloop        => \@optionloop,
465     bibitemloop       => \@bibitemloop,
466     date              => $date,
467     biblionumber      => $biblionumber,
468     findborrower      => $findborrower,
469     cardnumber        => $cardnumber,
470     CGIselectborrower => $CGIselectborrower,
471     title             => $dat->{title},
472     author            => $dat->{author},
473         holdsview => 1
474 );
475
476 # printout the page
477 output_html_with_http_headers $input, $cookie, $template->output;