Bug 6547: Add id attributes to messages in opac-reserve.tt
[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
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 => 'place_holds' },
55     }
56 );
57
58 my $multihold = $input->param('multi_hold');
59 $template->param(multi_hold => $multihold);
60 my $showallitems = $input->param('showallitems');
61
62 # get Branches and Itemtypes
63 my $branches = GetBranches();
64 my $itemtypes = GetItemTypes();
65     
66 my $default = C4::Context->userenv->{branch};
67 my @values;
68 my %label_of;
69     
70 foreach my $branchcode (sort keys %{$branches} ) {
71     push @values, $branchcode;
72     $label_of{$branchcode} = $branches->{$branchcode}->{branchname};
73 }
74 my $CGIbranch = CGI::scrolling_list(
75                                     -name     => 'pickup',
76                                     -id          => 'pickup',
77                                     -values   => \@values,
78                                     -default  => $default,
79                                     -labels   => \%label_of,
80                                     -size     => 1,
81                                     -multiple => 0,
82                                    );
83
84 # Select borrowers infos
85 my $findborrower = $input->param('findborrower');
86 $findborrower = '' unless defined $findborrower;
87 $findborrower =~ s|,| |g;
88 my $borrowernumber_hold = $input->param('borrowernumber') || '';
89 my $borrowerslist;
90 my $messageborrower;
91 my $warnings;
92 my $messages;
93
94 my $date = C4::Dates->today('iso');
95 my $action = $input->param('action');
96
97 if ( $action eq 'move' ) {
98   my $where = $input->param('where');
99   my $borrowernumber = $input->param('borrowernumber');
100   my $biblionumber = $input->param('biblionumber');
101                      
102   AlterPriority( $where, $borrowernumber, $biblionumber );
103
104 } elsif ( $action eq 'cancel' ) {
105   my $borrowernumber = $input->param('borrowernumber');
106   my $biblionumber = $input->param('biblionumber');
107   CancelReserve( $biblionumber, '', $borrowernumber );
108 } elsif ( $action eq 'setLowestPriority' ) {
109   my $borrowernumber = $input->param('borrowernumber');
110   my $biblionumber   = $input->param('biblionumber');
111   ToggleLowestPriority( $borrowernumber, $biblionumber );
112 }
113
114 if ($findborrower) {
115     my ( $count, $borrowers ) =
116       SearchMember($findborrower, 'cardnumber', 'web' );
117
118     my @borrowers = @$borrowers;
119
120     if ( !@borrowers ) {
121         $messageborrower = "'$findborrower'";
122     }
123     elsif ( @borrowers == 1 ) {
124         $borrowernumber_hold = $borrowers[0]->{'borrowernumber'};
125     }
126     else {
127         $borrowerslist = \@borrowers;
128     }
129 }
130
131 if ($borrowernumber_hold) {
132     my $borrowerinfo = GetMemberDetails( $borrowernumber_hold );
133     my $diffbranch;
134     my @getreservloop;
135     my $count_reserv = 0;
136     my $maxreserves;
137
138 #   we check the reserves of the borrower, and if he can reserv a document
139 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
140
141     my $number_reserves =
142       GetReserveCount( $borrowerinfo->{'borrowernumber'} );
143
144     if ( C4::Context->preference('maxreserves') && ($number_reserves >= C4::Context->preference('maxreserves')) ) {
145                 $warnings = 1;
146         $maxreserves = 1;
147     }
148
149     # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
150     my $expiry_date = $borrowerinfo->{dateexpiry};
151     my $expiry = 0; # flag set if patron account has expired
152     if ($expiry_date and $expiry_date ne '0000-00-00' and
153             Date_to_Days(split /-/,$date) > Date_to_Days(split /-/,$expiry_date)) {
154                 $messages = $expiry = 1;
155     }
156      
157
158     # check if the borrower make the reserv in a different branch
159     if ( $borrowerinfo->{'branchcode'} ne C4::Context->userenv->{'branch'} ) {
160                 $messages = 1;
161         $diffbranch = 1;
162     }
163
164     $template->param(
165                 borrowernumber      => $borrowerinfo->{'borrowernumber'},
166                 borrowersurname     => $borrowerinfo->{'surname'},
167                 borrowerfirstname   => $borrowerinfo->{'firstname'},
168                 borrowerstreetaddress   => $borrowerinfo->{'address'},
169                 borrowercity        => $borrowerinfo->{'city'},
170                 borrowerphone       => $borrowerinfo->{'phone'},
171                 borrowermobile      => $borrowerinfo->{'mobile'},
172                 borrowerfax         => $borrowerinfo->{'fax'},
173                 borrowerphonepro    => $borrowerinfo->{'phonepro'},
174                 borroweremail       => $borrowerinfo->{'email'},
175                 borroweremailpro    => $borrowerinfo->{'emailpro'},
176                 borrowercategory    => $borrowerinfo->{'category'},
177                 borrowerreservs     => $count_reserv,
178                 cardnumber          => $borrowerinfo->{'cardnumber'},
179                 maxreserves         => $maxreserves,
180                 expiry              => $expiry,
181                 diffbranch          => $diffbranch,
182                                 messages            => $messages,
183                                 warnings            => $warnings
184     );
185 }
186
187 $template->param( messageborrower => $messageborrower );
188
189 my $CGIselectborrower;
190 if ($borrowerslist) {
191     my @values;
192     my %labels;
193
194     foreach my $borrower (
195         sort {
196                 $a->{surname}
197               . $a->{firstname} cmp $b->{surname}
198               . $b->{firstname}
199         } @{$borrowerslist}
200       )
201     {
202         push @values, $borrower->{borrowernumber};
203
204         $labels{ $borrower->{borrowernumber} } = sprintf(
205             '%s, %s ... (%s - %s) ... %s',
206             $borrower->{surname} ||'',    $borrower->{firstname} || '',
207             $borrower->{cardnumber} || '', $borrower->{categorycode} || '',
208             $borrower->{address} || '',
209         );
210     }
211
212     $CGIselectborrower = CGI::scrolling_list(
213         -name     => 'borrowernumber',
214         -values   => \@values,
215         -labels   => \%labels,
216         -size     => 7,
217         -multiple => 0,
218     );
219 }
220
221 # FIXME launch another time GetMemberDetails perhaps until
222 my $borrowerinfo = GetMemberDetails( $borrowernumber_hold );
223
224 my @biblionumbers = ();
225 my $biblionumbers = $input->param('biblionumbers');
226 if ($multihold) {
227     @biblionumbers = split '/', $biblionumbers;
228 } else {
229     push @biblionumbers, $input->param('biblionumber');
230 }
231
232 my @biblioloop = ();
233 foreach my $biblionumber (@biblionumbers) {
234
235     my %biblioloopiter = ();
236         my $maxreserves;
237
238     my $dat          = GetBiblioData($biblionumber);
239
240     unless ( CanBookBeReserved($borrowerinfo->{borrowernumber}, $biblionumber) ) {
241                 $warnings = 1;
242         $maxreserves = 1;
243     }
244     # get existing reserves .....
245     my ( $count, $reserves ) = GetReservesFromBiblionumber($biblionumber,1);
246     my $totalcount = $count;
247     my $alreadyreserved;
248
249     foreach my $res (@$reserves) {
250         if ( defined $res->{found} && $res->{found} eq 'W' ) {
251             $count--;
252         }
253
254         if ( defined $borrowerinfo && ($borrowerinfo->{borrowernumber} eq $res->{borrowernumber}) ) {
255             $warnings = 1;
256             $alreadyreserved = 1;
257             $biblioloopiter{warn} = 1;
258             $biblioloopiter{alreadyres} = 1;
259         }
260     }
261
262     $template->param( alreadyreserved => $alreadyreserved,
263                       messages => $messages,
264                       warnings => $warnings,
265                                           maxreserves=>$maxreserves
266                                           );
267     
268     
269     # FIXME think @optionloop, is maybe obsolete, or  must be switchable by a systeme preference fixed rank or not
270     # make priorities options
271     
272     my @optionloop;
273     for ( 1 .. $count + 1 ) {
274         push(
275              @optionloop,
276              {
277               num      => $_,
278               selected => ( $_ == $count + 1 ),
279              }
280             );
281     }
282     # adding a fixed value for priority options
283     my $fixedRank = $count+1;
284
285     my @branchcodes;
286     my %itemnumbers_of_biblioitem;
287     my @itemnumbers;
288     
289     ## $items is array of 'item' table numbers
290     if (my $items = get_itemnumbers_of($biblionumber)->{$biblionumber}){
291         @itemnumbers  = @$items;
292     }
293     else {
294         $template->param('noitems' => 1);
295         $biblioloopiter{noitems} = 1;
296     }
297     
298     ## Hash of item number to 'item' table fields
299     my $iteminfos_of = GetItemInfosOf(@itemnumbers);
300     
301     ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
302     ## when by definition all of the itemnumber have the same biblioitemnumber
303     foreach my $itemnumber (@itemnumbers) {
304         my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
305         push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
306     }
307     
308     ## Should be same as biblionumber
309     my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
310     
311     my $notforloan_label_of = get_notforloan_label_of();
312     
313     ## Hash of biblioitemnumber to 'biblioitem' table records
314     my $biblioiteminfos_of  = GetBiblioItemInfosOf(@biblioitemnumbers);
315     
316     my @bibitemloop;
317     
318     foreach my $biblioitemnumber (@biblioitemnumbers) {
319         my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
320         my $num_available = 0;
321         my $num_override  = 0;
322         my $hiddencount   = 0;
323         
324         $biblioitem->{description} =
325           $itemtypes->{ $biblioitem->{itemtype} }{description};
326         $biblioloopiter{description} = $biblioitem->{description};
327         $biblioloopiter{itypename} = $biblioitem->{description};
328         $biblioloopiter{imageurl} =
329           getitemtypeimagelocation('intranet', $itemtypes->{$biblioitem->{itemtype}}{imageurl});
330         
331         foreach my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } )    {
332             my $item = $iteminfos_of->{$itemnumber};
333             
334             unless (C4::Context->preference('item-level_itypes')) {
335                 $item->{itype} = $biblioitem->{itemtype};
336             }
337             
338             $item->{itypename} = $itemtypes->{ $item->{itype} }{description};
339             $item->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $item->{itype} }{imageurl} );
340             $item->{homebranchname} = $branches->{ $item->{homebranch} }{branchname};
341             
342             # if the holdingbranch is different than the homebranch, we show the
343             # holdingbranch of the document too
344             if ( $item->{homebranch} ne $item->{holdingbranch} ) {
345                 $item->{holdingbranchname} =
346                   $branches->{ $item->{holdingbranch} }{branchname};
347             }
348             
349             #   add information
350             $item->{itemcallnumber} = $item->{itemcallnumber};
351             
352             # if the item is currently on loan, we display its return date and
353             # change the background color
354             my $issues= GetItemIssue($itemnumber);
355             if ( $issues->{'date_due'} ) {
356                 $item->{date_due} = format_date($issues->{'date_due'});
357                 $item->{backgroundcolor} = 'onloan';
358             }
359             
360             # checking reserve
361             my ($reservedate,$reservedfor,$expectedAt) = GetReservesFromItemnumber($itemnumber);
362             my $ItemBorrowerReserveInfo = GetMemberDetails( $reservedfor, 0);
363             
364             if ( defined $reservedate ) {
365                 $item->{backgroundcolor} = 'reserved';
366                 $item->{reservedate}     = format_date($reservedate);
367                 $item->{ReservedForBorrowernumber}     = $reservedfor;
368                 $item->{ReservedForSurname}     = $ItemBorrowerReserveInfo->{'surname'};
369                 $item->{ReservedForFirstname}     = $ItemBorrowerReserveInfo->{'firstname'};
370                 $item->{ExpectedAtLibrary}     = $branches->{$expectedAt}{branchname};
371                 
372             }
373             
374             # Management of the notforloan document
375             if ( $item->{notforloan} ) {
376                 $item->{backgroundcolor} = 'other';
377                 $item->{notforloanvalue} =
378                   $notforloan_label_of->{ $item->{notforloan} };
379             }
380      
381             # Management of lost or long overdue items
382             if ( $item->{itemlost} ) {
383                 
384                 # FIXME localized strings should never be in Perl code
385                 $item->{message} =
386                   $item->{itemlost} == 1 ? "(lost)"
387                     : $item->{itemlost} == 2 ? "(long overdue)"
388                       : "";
389                 $item->{backgroundcolor} = 'other';
390                 if (GetHideLostItemsPreference($borrowernumber) && !$showallitems) {
391                     $item->{hide} = 1;
392                     $hiddencount++;
393                 }
394             }
395             
396             # Check the transit status
397             my ( $transfertwhen, $transfertfrom, $transfertto ) =
398               GetTransfers($itemnumber);
399             
400             if ( defined $transfertwhen && $transfertwhen ne '' ) {
401                 $item->{transfertwhen} = format_date($transfertwhen);
402                 $item->{transfertfrom} =
403                   $branches->{$transfertfrom}{branchname};
404                 $item->{transfertto} = $branches->{$transfertto}{branchname};
405                 $item->{nocancel} = 1;
406             }
407             
408             # If there is no loan, return and transfer, we show a checkbox.
409             $item->{notforloan} = $item->{notforloan} || 0;
410             
411             # if independent branches is on we need to check if the person can reserve
412             # for branches they arent logged in to
413             if ( C4::Context->preference("IndependantBranches") ) { 
414                 if (! C4::Context->preference("canreservefromotherbranches")){
415                     # cant reserve items so need to check if item homebranch and userenv branch match if not we cant reserve
416                     my $userenv = C4::Context->userenv;
417                     if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
418                         $item->{cantreserve} = 1 if ( $item->{homebranch} ne $userenv->{branch} );
419                     }
420                 }
421             }
422             
423             my $branch = C4::Circulation::_GetCircControlBranch($item, $borrowerinfo);
424
425             my $branchitemrule = GetBranchItemRule( $branch, $item->{'itype'} );
426             my $policy_holdallowed = 1;
427             
428             $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
429             
430             if ( $branchitemrule->{'holdallowed'} == 0 ||
431                  ( $branchitemrule->{'holdallowed'} == 1 && 
432                      $borrowerinfo->{'branchcode'} ne $item->{'homebranch'} ) ) {
433                 $policy_holdallowed = 0;
434             }
435             
436             if (IsAvailableForItemLevelRequest($itemnumber) and 
437                 not $item->{cantreserve} and 
438                 CanItemBeReserved($borrowerinfo->{borrowernumber}, $itemnumber) ) {
439                 if ( $policy_holdallowed ) {
440                     $item->{available} = 1;
441                     $num_available++;
442                 }
443             } elsif (C4::Context->preference( 'AllowHoldPolicyOverride' ) ) {
444                     $item->{override} = 1;
445                     $num_override++;
446             }
447             # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
448             if (C4::Context->preference( 'AllowHoldPolicyOverride' ) && !$item->{available} ) {
449                 $item->{override} = 1;
450                 $num_override++;
451             }   
452
453             # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
454             
455             # FIXME: move this to a pm
456             my $sth2 = $dbh->prepare("SELECT * FROM reserves WHERE borrowernumber=? AND itemnumber=? AND found='W'");
457             $sth2->execute($item->{ReservedForBorrowernumber},$item->{itemnumber});
458             while (my $wait_hashref = $sth2->fetchrow_hashref) {
459                 $item->{waitingdate} = format_date($wait_hashref->{waitingdate});
460             }
461             push @{ $biblioitem->{itemloop} }, $item;
462         }
463         
464         if ( $num_override == scalar( @{ $biblioitem->{itemloop} } ) ) { # That is, if all items require an override
465             $template->param( override_required => 1 );
466         } elsif ( $num_available == 0 ) {
467             $template->param( none_available => 1 );
468             $template->param( warnings => 1 );
469             $biblioloopiter{warn} = 1;
470             $biblioloopiter{none_avail} = 1;
471         }
472         $template->param( hiddencount => $hiddencount);
473         
474         push @bibitemloop, $biblioitem;
475     }
476
477     # existingreserves building
478     my @reserveloop;
479     ( $count, $reserves ) = GetReservesFromBiblionumber($biblionumber,1);
480     foreach my $res ( sort { 
481             my $a_found = $a->{found} || '';
482             my $b_found = $a->{found} || '';
483             $a_found cmp $b_found; 
484         } @$reserves ) {
485         my %reserve;
486         my @optionloop;
487         for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
488             push(
489                  @optionloop,
490                  {
491                   num      => $i,
492                   selected => ( $i == $res->{priority} ),
493                  }
494                 );
495         }
496         
497         if ( defined $res->{'found'} && $res->{'found'} eq 'W' || $res->{'found'} eq 'T' ) {
498             my $item = $res->{'itemnumber'};
499             $item = GetBiblioFromItemNumber($item,undef);
500             $reserve{'wait'}= 1; 
501             $reserve{'holdingbranch'}=$item->{'holdingbranch'};
502             $reserve{'biblionumber'}=$item->{'biblionumber'};
503             $reserve{'barcodenumber'}   = $item->{'barcode'};
504             $reserve{'wbrcode'} = $res->{'branchcode'};
505             $reserve{'itemnumber'}  = $res->{'itemnumber'};
506             $reserve{'wbrname'} = $branches->{$res->{'branchcode'}}->{'branchname'};
507             if($reserve{'holdingbranch'} eq $reserve{'wbrcode'}){
508                 $reserve{'atdestination'} = 1;
509             }
510             # set found to 1 if reserve is waiting for patron pickup
511             $reserve{'found'} = 1 if $res->{'found'} eq 'W';
512             $reserve{'intransit'} = 1 if $res->{'found'} eq 'T';
513         } elsif ($res->{priority} > 0) {
514             if (defined($res->{itemnumber})) {
515                 my $item = GetItem($res->{itemnumber});
516                 $reserve{'itemnumber'}  = $res->{'itemnumber'};
517                 $reserve{'barcodenumber'}   = $item->{'barcode'};
518                 $reserve{'item_level_hold'} = 1;
519             }
520         }
521         
522         #     get borrowers reserve info
523         my $reserveborrowerinfo = GetMemberDetails( $res->{'borrowernumber'}, 0);
524         if (C4::Context->preference('HidePatronName')){
525             $reserve{'hidename'} = 1;
526             $reserve{'cardnumber'} = $reserveborrowerinfo->{'cardnumber'};
527         }
528         $reserve{'expirationdate'} = format_date( $res->{'expirationdate'} ) 
529             unless ( !defined($res->{'expirationdate'}) || $res->{'expirationdate'} eq '0000-00-00' );
530         $reserve{'date'}           = format_date( $res->{'reservedate'} );
531         $reserve{'borrowernumber'} = $res->{'borrowernumber'};
532         $reserve{'biblionumber'}   = $res->{'biblionumber'};
533         $reserve{'borrowernumber'} = $res->{'borrowernumber'};
534         $reserve{'firstname'}      = $reserveborrowerinfo->{'firstname'};
535         $reserve{'surname'}        = $reserveborrowerinfo->{'surname'};     
536         $reserve{'notes'}          = $res->{'reservenotes'};
537         $reserve{'wait'}           =
538           ( ( defined $res->{'found'} and $res->{'found'} eq 'W' ) or ( $res->{'priority'} eq '0' ) );
539         $reserve{'constrainttypea'} = ( $res->{'constrainttype'} eq 'a' );
540         $reserve{'constrainttypeo'} = ( $res->{'constrainttype'} eq 'o' );
541         $reserve{'voldesc'}         = $res->{'volumeddesc'};
542         $reserve{'ccode'}           = $res->{'ccode'};
543         $reserve{'barcode'}         = $res->{'barcode'};
544         $reserve{'priority'}    = $res->{'priority'};
545         $reserve{'lowestPriority'}    = $res->{'lowestPriority'};
546         $reserve{'branchloop'} = GetBranchesLoop($res->{'branchcode'});
547         $reserve{'optionloop'} = \@optionloop;
548         
549         push( @reserveloop, \%reserve );
550     }
551     
552     # get the time for the form name...
553     my $time = time();
554     
555     $template->param(
556                      CGIbranch   => $CGIbranch,
557
558                      time        => $time,
559                      fixedRank   => $fixedRank,
560                     );
561     
562     # display infos
563     $template->param(
564                      optionloop        => \@optionloop,
565                      bibitemloop       => \@bibitemloop,
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,
573                     );
574     if (defined $borrowerinfo && exists $borrowerinfo->{'branchcode'}) {
575         $template->param(
576                      borrower_branchname => $branches->{$borrowerinfo->{'branchcode'}}->{'branchname'},
577                      borrower_branchcode => $borrowerinfo->{'branchcode'},
578         );
579     }
580     $template->param(CGIselectborrower => $CGIselectborrower) if defined $CGIselectborrower;
581
582     $biblioloopiter{biblionumber} = $biblionumber;
583     $biblioloopiter{title} = $dat->{title};
584     $biblioloopiter{rank} = $fixedRank;
585     $biblioloopiter{reserveloop} = \@reserveloop;
586
587     if (@reserveloop) {
588         $template->param( reserveloop => \@reserveloop );
589     }
590     
591
592     push @biblioloop, \%biblioloopiter;
593 }
594
595 $template->param( biblioloop => \@biblioloop );
596 $template->param( biblionumbers => $biblionumbers );
597 $template->param( DHTMLcalendar_dateformat  => C4::Dates->DHTMLcalendar() );
598
599 if ($multihold) {
600     $template->param( multi_hold => 1 );
601 }
602
603 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
604     $template->param( reserve_in_future => 1 );
605 }
606     
607 # printout the page
608 output_html_with_http_headers $input, $cookie, $template->output;