opac/opac-reserve.pl

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