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