4 #written 2/1/00 by chris@katipo.oc.nz
5 # Copyright 2000-2002 Katipo Communications
6 # Parts Copyright 2011 Catalyst IT
8 # This file is part of Koha.
10 # Koha is free software; you can redistribute it and/or modify it
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 script to place reserves/requests
32 use List
::MoreUtils qw
/uniq/;
33 use Date
::Calc qw
/Date_to_Days/;
43 use C4
::Utils
::DataTables
::Members
;
45 use C4
::Search
; # enabled_staff_search_views
51 use Koha
::IssuingRules
;
57 my $dbh = C4
::Context
->dbh;
59 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user
(
61 template_name
=> "reserve/request.tt",
65 flagsrequired
=> { reserveforothers
=> 'place_holds' },
69 my $showallitems = $input->param('showallitems');
70 my $pickup = $input->param('pickup') || C4
::Context
->userenv->{'branch'};
72 my $itemtypes = { map { $_->{itemtype
} => $_ } @
{ Koha
::ItemTypes
->search_with_localization->unblessed } };
74 # Select borrowers infos
75 my $findborrower = $input->param('findborrower');
76 $findborrower = '' unless defined $findborrower;
77 $findborrower =~ s
|,| |g
;
78 my $borrowernumber_hold = $input->param('borrowernumber') || '';
82 my $exceeded_maxreserves;
83 my $exceeded_holds_per_record;
85 my $date = output_pref
({ dt
=> dt_from_string
, dateformat
=> 'iso', dateonly
=> 1 });
86 my $action = $input->param('action');
89 if ( $action eq 'move' ) {
90 my $where = $input->param('where');
91 my $reserve_id = $input->param('reserve_id');
92 my $prev_priority = $input->param('prev_priority');
93 my $next_priority = $input->param('next_priority');
94 my $first_priority = $input->param('first_priority');
95 my $last_priority = $input->param('last_priority');
96 my $hold_itemnumber = $input->param('itemnumber');
97 if ( $prev_priority == 0 && $next_priority == 1 ){
98 C4
::Reserves
::RevertWaitingStatus
({ itemnumber
=> $hold_itemnumber });
100 AlterPriority
( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
102 } elsif ( $action eq 'cancel' ) {
103 my $reserve_id = $input->param('reserve_id');
104 my $hold = Koha
::Holds
->find( $reserve_id );
105 $hold->cancel if $hold;
106 } elsif ( $action eq 'setLowestPriority' ) {
107 my $reserve_id = $input->param('reserve_id');
108 ToggleLowestPriority
( $reserve_id );
109 } elsif ( $action eq 'toggleSuspend' ) {
110 my $reserve_id = $input->param('reserve_id');
111 my $suspend_until = $input->param('suspend_until');
112 ToggleSuspend
( $reserve_id, $suspend_until );
116 my $patron = Koha
::Patrons
->find( { cardnumber
=> $findborrower } );
118 $borrowernumber_hold = $patron->borrowernumber;
120 my $dt_params = { iDisplayLength
=> -1 };
121 my $results = C4
::Utils
::DataTables
::Members
::search
(
123 searchmember
=> $findborrower,
124 dt_params
=> $dt_params,
127 my $borrowers = $results->{patrons
};
128 if ( scalar @
$borrowers == 1 ) {
129 $borrowernumber_hold = $borrowers->[0]->{borrowernumber
};
130 } elsif ( @
$borrowers ) {
131 $template->param( borrowers
=> $borrowers );
133 $messageborrower = "'$findborrower'";
138 my @biblionumbers = ();
139 my $biblionumber = $input->param('biblionumber');
140 my $biblionumbers = $input->param('biblionumbers');
141 if ( $biblionumbers ) {
142 @biblionumbers = split '/', $biblionumbers;
144 push @biblionumbers, $input->multi_param('biblionumber');
147 # FIXME multi_hold should not be a variable but depends on the number of elements in @biblionumbers
148 $template->param(multi_hold
=> scalar $input->param('multi_hold'));
150 # If we have the borrowernumber because we've performed an action, then we
151 # don't want to try to place another reserve.
152 if ($borrowernumber_hold && !$action) {
153 my $patron = Koha
::Patrons
->find( $borrowernumber_hold );
156 # we check the reserves of the user, and if they can reserve a document
157 # FIXME At this time we have a simple count of reservs, but, later, we could improve the infos "title" ...
159 my $reserves_count = $patron->holds->count;
161 my $new_reserves_count = scalar( @biblionumbers );
163 my $maxreserves = C4
::Context
->preference('maxreserves');
165 && ( $reserves_count + $new_reserves_count > $maxreserves ) )
167 my $new_reserves_allowed =
168 $maxreserves - $reserves_count > 0
169 ?
$maxreserves - $reserves_count
172 $exceeded_maxreserves = 1;
174 new_reserves_allowed
=> $new_reserves_allowed,
175 new_reserves_count
=> $new_reserves_count,
176 reserves_count
=> $reserves_count,
177 maxreserves
=> $maxreserves,
181 # we check the date expiry of the borrower (only if there is an expiry date, otherwise, set to 1 (warn)
182 my $expiry_date = $patron->dateexpiry;
183 my $expiry = 0; # flag set if patron account has expired
184 if ($expiry_date and $expiry_date ne '0000-00-00' and
185 Date_to_Days
(split /-/,$date) > Date_to_Days
(split /-/,$expiry_date)) {
189 # check if the borrower make the reserv in a different branch
190 if ( $patron->branchcode ne C4
::Context
->userenv->{'branch'} ) {
194 my $amount_outstanding = $patron->account->balance;
198 diffbranch
=> $diffbranch,
199 messages
=> $messages,
200 warnings
=> $warnings,
201 amount_outstanding
=> $amount_outstanding,
205 $template->param( messageborrower
=> $messageborrower );
207 # FIXME launch another time GetMember perhaps until (Joubu: Why?)
208 my $patron = Koha
::Patrons
->find( $borrowernumber_hold );
210 my $logged_in_patron = Koha
::Patrons
->find( $borrowernumber );
212 my $itemdata_enumchron = 0;
213 my $itemdata_ccode = 0;
215 foreach my $biblionumber (@biblionumbers) {
216 next unless $biblionumber =~ m
|^\d
+$|;
218 my %biblioloopiter = ();
220 my $biblio = Koha
::Biblios
->find( $biblionumber );
222 my $force_hold_level;
224 { # CanBookBeReserved
225 my $canReserve = CanBookBeReserved
( $patron->borrowernumber, $biblionumber, $pickup );
226 if ( $canReserve->{status
} eq 'OK' ) {
228 #All is OK and we can continue
230 elsif ( $canReserve->{status
} eq 'tooManyReserves' ) {
231 $exceeded_maxreserves = 1;
232 $template->param( maxreserves
=> $canReserve->{limit
} );
234 elsif ( $canReserve->{status
} eq 'tooManyHoldsForThisRecord' ) {
235 $exceeded_holds_per_record = 1;
236 $biblioloopiter{ $canReserve->{status
} } = 1;
238 elsif ( $canReserve->{status
} eq 'ageRestricted' ) {
239 $template->param( $canReserve->{status
} => 1 );
240 $biblioloopiter{ $canReserve->{status
} } = 1;
243 $biblioloopiter{ $canReserve->{status
} } = 1;
247 # For multiple holds per record, if a patron has previously placed a hold,
248 # the patron can only place more holds of the same type. That is, if the
249 # patron placed a record level hold, all the holds the patron places must
250 # be record level. If the patron placed an item level hold, all holds
251 # the patron places must be item level
252 my $holds = Koha
::Holds
->search(
254 borrowernumber
=> $patron->borrowernumber,
255 biblionumber
=> $biblionumber,
259 $force_hold_level = $holds->forced_hold_level();
260 $biblioloopiter{force_hold_level
} = $force_hold_level;
261 $template->param( force_hold_level
=> $force_hold_level );
263 # For a librarian to be able to place multiple record holds for a patron for a record,
264 # we must find out what the maximum number of holds they can place for the patron is
265 my $max_holds_for_record = GetMaxPatronHoldsForRecord
( $patron->borrowernumber, $biblionumber );
266 my $remaining_holds_for_record = $max_holds_for_record - $holds->count();
267 $biblioloopiter{remaining_holds_for_record
} = $max_holds_for_record;
268 $template->param( max_holds_for_record
=> $max_holds_for_record );
269 $template->param( remaining_holds_for_record
=> $remaining_holds_for_record );
271 { # alreadypossession
272 # Check to see if patron is allowed to place holds on records where the
273 # patron already has an item from that record checked out
274 if ( !C4
::Context
->preference('AllowHoldsOnPatronsPossessions')
275 && CheckIfIssuedToPatron
( $patron->borrowernumber, $biblionumber ) )
277 $template->param( alreadypossession
=> 1, );
283 my $count = Koha
::Holds
->search( { biblionumber
=> $biblionumber } )->count();
284 my $totalcount = $count;
286 # FIXME think @optionloop, is maybe obsolete, or must be switchable by a systeme preference fixed rank or not
287 # make priorities options
290 for ( 1 .. $count + 1 ) {
295 selected
=> ( $_ == $count + 1 ),
299 # adding a fixed value for priority options
300 my $fixedRank = $count+1;
302 my %itemnumbers_of_biblioitem;
304 my @hostitems = get_hostitemnumbers_of
($biblionumber);
307 $template->param('hostitemsflag' => 1);
308 push(@itemnumbers, @hostitems);
311 my $items = Koha
::Items
->search({ -or => { biblionumber
=> $biblionumber, itemnumber
=> { in => \
@itemnumbers } } });
313 unless ( $items->count ) {
314 # FIXME Then why do we continue?
315 $template->param('noitems' => 1);
316 $biblioloopiter{noitems
} = 1;
319 ## Here we go backwards again to create hash of biblioitemnumber to itemnumbers,
320 ## when by definition all of the itemnumber have the same biblioitemnumber
321 my ( $iteminfos_of );
322 while ( my $item = $items->next ) {
323 $item = $item->unblessed;
324 my $biblioitemnumber = $item->{biblioitemnumber
};
325 my $itemnumber = $item->{itemnumber
};
326 push( @
{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
327 $iteminfos_of->{$itemnumber} = $item;
330 ## Should be same as biblionumber
331 my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
333 my $biblioiteminfos_of = {
336 ( $biblioitem->{biblioitemnumber
} => $biblioitem )
337 } @
{ Koha
::Biblioitems
->search(
338 { biblioitemnumber
=> { -in => \
@biblioitemnumbers } },
339 { select => ['biblioitemnumber', 'publicationyear', 'itemtype']}
344 my $frameworkcode = GetFrameworkCode
( $biblionumber );
345 my @notforloan_avs = Koha
::AuthorisedValues
->search_by_koha_field({ kohafield
=> 'items.notforloan', frameworkcode
=> $frameworkcode });
346 my $notforloan_label_of = { map { $_->authorised_value => $_->lib } @notforloan_avs };
350 my @available_itemtypes;
351 foreach my $biblioitemnumber (@biblioitemnumbers) {
352 my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
353 my $num_available = 0;
354 my $num_override = 0;
357 $biblioitem->{force_hold_level
} = $force_hold_level;
359 if ( $biblioitem->{biblioitemnumber
} ne $biblionumber ) {
360 $biblioitem->{hostitemsflag
} = 1;
363 $biblioloopiter{description
} = $biblioitem->{description
};
364 $biblioloopiter{itypename
} = $biblioitem->{description
};
365 if ( $biblioitem->{itemtype
} ) {
367 $biblioitem->{description
} =
368 $itemtypes->{ $biblioitem->{itemtype
} }{description
};
370 $biblioloopiter{imageurl
} =
371 getitemtypeimagelocation
( 'intranet',
372 $itemtypes->{ $biblioitem->{itemtype
} }{imageurl
} );
375 foreach my $itemnumber ( @
{ $itemnumbers_of_biblioitem{$biblioitemnumber} } ) {
376 my $item = $iteminfos_of->{$itemnumber};
378 $item->{force_hold_level
} = $force_hold_level;
380 unless (C4
::Context
->preference('item-level_itypes')) {
381 $item->{itype
} = $biblioitem->{itemtype
};
384 $item->{itypename
} = $itemtypes->{ $item->{itype
} }{description
};
385 $item->{imageurl
} = getitemtypeimagelocation
( 'intranet', $itemtypes->{ $item->{itype
} }{imageurl
} );
386 $item->{homebranch
} = $item->{homebranch
};
388 # if the holdingbranch is different than the homebranch, we show the
389 # holdingbranch of the document too
390 if ( $item->{homebranch
} ne $item->{holdingbranch
} ) {
391 $item->{holdingbranch
} = $item->{holdingbranch
};
394 if($item->{biblionumber
} ne $biblionumber){
395 $item->{hostitemsflag
} = 1;
396 $item->{hosttitle
} = Koha
::Biblios
->find( $item->{biblionumber
} )->title;
399 # if the item is currently on loan, we display its return date and
400 # change the background color
401 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $itemnumber } );
403 $item->{date_due
} = $issue->date_due;
404 $item->{backgroundcolor
} = 'onloan';
408 my $item_object = Koha
::Items
->find( $itemnumber );
409 my $holds = $item_object->current_holds;
410 if ( my $first_hold = $holds->next ) {
411 my $p = Koha
::Patrons
->find( $first_hold->borrowernumber );
413 $item->{backgroundcolor
} = 'reserved';
414 $item->{reservedate
} = output_pref
({ dt
=> dt_from_string
( $first_hold->reservedate ), dateonly
=> 1 }); # FIXME Should be formatted in the template
415 $item->{ReservedFor
} = $p;
416 $item->{ExpectedAtLibrary
} = $first_hold->branchcode;
417 $item->{waitingdate
} = $first_hold->waitingdate;
420 # Management of the notforloan document
421 if ( $item->{notforloan
} ) {
422 $item->{backgroundcolor
} = 'other';
423 $item->{notforloanvalue
} =
424 $notforloan_label_of->{ $item->{notforloan
} };
427 # Management of lost or long overdue items
428 if ( $item->{itemlost
} ) {
430 # FIXME localized strings should never be in Perl code
432 $item->{itemlost
} == 1 ?
"(lost)"
433 : $item->{itemlost
} == 2 ?
"(long overdue)"
435 $item->{backgroundcolor
} = 'other';
436 if ($logged_in_patron->category->hidelostitems && !$showallitems) {
442 # Check the transit status
443 my ( $transfertwhen, $transfertfrom, $transfertto ) =
444 GetTransfers
($itemnumber);
446 if ( defined $transfertwhen && $transfertwhen ne '' ) {
447 $item->{transfertwhen
} = output_pref
({ dt
=> dt_from_string
( $transfertwhen ), dateonly
=> 1 });
448 $item->{transfertfrom
} = $transfertfrom;
449 $item->{transfertto
} = $transfertto;
450 $item->{nocancel
} = 1;
453 # If there is no loan, return and transfer, we show a checkbox.
454 $item->{notforloan
} ||= 0;
456 # if independent branches is on we need to check if the person can reserve
457 # for branches they arent logged in to
458 if ( C4
::Context
->preference("IndependentBranches") ) {
459 if (! C4
::Context
->preference("canreservefromotherbranches")){
460 # can't reserve items so need to check if item homebranch and userenv branch match if not we can't reserve
461 my $userenv = C4
::Context
->userenv;
462 unless ( C4
::Context
->IsSuperLibrarian ) {
463 $item->{cantreserve
} = 1 if ( $item->{homebranch
} ne $userenv->{branch
} );
469 my $patron_unblessed = $patron->unblessed;
470 my $branch = C4
::Circulation
::_GetCircControlBranch
($item, $patron_unblessed);
472 my $branchitemrule = GetBranchItemRule
( $branch, $item->{'itype'} );
474 $item->{'holdallowed'} = $branchitemrule->{'holdallowed'};
476 my $can_item_be_reserved = CanItemBeReserved
( $patron->borrowernumber, $itemnumber, $pickup );
477 $item->{not_holdable
} = $can_item_be_reserved->{status
} unless ( $can_item_be_reserved->{status
} eq 'OK' );
479 $item->{item_level_holds
} = Koha
::IssuingRules
->get_opacitemholds_policy( { item
=> $item_object, patron
=> $patron } );
482 !$item->{cantreserve
}
483 && !$exceeded_maxreserves
484 && IsAvailableForItemLevelRequest
($item, $patron_unblessed)
485 && $can_item_be_reserved->{status
} eq 'OK'
488 $item->{available
} = 1;
491 push( @available_itemtypes, $item->{itype
} );
493 elsif ( C4
::Context
->preference('AllowHoldPolicyOverride') ) {
494 # If AllowHoldPolicyOverride is set, it should override EVERY restriction, not just branch item rules
495 $item->{override
} = 1;
498 push( @available_itemtypes, $item->{itype
} );
501 # If none of the conditions hold true, then neither override nor available is set and the item cannot be checked
503 # Show serial enumeration when needed
504 if ($item->{enumchron
}) {
505 $itemdata_enumchron = 1;
507 # Show collection when needed
508 if ($item->{ccode
}) {
513 push @
{ $biblioitem->{itemloop
} }, $item;
516 if ( $num_override == scalar( @
{ $biblioitem->{itemloop
} } ) ) { # That is, if all items require an override
517 $template->param( override_required
=> 1 );
518 } elsif ( $num_available == 0 ) {
519 $template->param( none_available
=> 1 );
520 $biblioloopiter{warn} = 1;
521 $biblioloopiter{none_avail
} = 1;
523 $template->param( hiddencount
=> $hiddencount);
525 push @bibitemloop, $biblioitem;
528 @available_itemtypes = uniq
( @available_itemtypes );
529 $template->param( available_itemtypes
=> \
@available_itemtypes );
531 # existingreserves building
533 my @reserves = Koha
::Holds
->search( { biblionumber
=> $biblionumber }, { order_by
=> 'priority' } );
536 my $a_found = $a->found() || '';
537 my $b_found = $a->found() || '';
538 $a_found cmp $b_found;
542 my $priority = $res->priority();
545 for ( my $i = 1 ; $i <= $totalcount ; $i++ ) {
550 selected
=> ( $i == $priority ),
555 if ( $res->is_found() ) {
556 $reserve{'holdingbranch'} = $res->item()->holdingbranch();
557 $reserve{'biblionumber'} = $res->item()->biblionumber();
558 $reserve{'barcodenumber'} = $res->item()->barcode();
559 $reserve{'wbrcode'} = $res->branchcode();
560 $reserve{'itemnumber'} = $res->itemnumber();
561 $reserve{'wbrname'} = $res->branch()->branchname();
563 if ( $reserve{'holdingbranch'} eq $reserve{'wbrcode'} ) {
565 # Just because the holdingbranch matches the reserve branch doesn't mean the item
566 # has arrived at the destination, check for an open transfer for the item as well
567 my ( $transfertwhen, $transfertfrom, $transferto ) =
568 C4
::Circulation
::GetTransfers
( $res->itemnumber() );
569 if ( not $transferto or $transferto ne $res->branchcode() ) {
570 $reserve{'atdestination'} = 1;
574 # set found to 1 if reserve is waiting for patron pickup
575 $reserve{'found'} = $res->is_found();
576 $reserve{'intransit'} = $res->is_in_transit();
578 elsif ( $res->priority() > 0 ) {
579 if ( my $item = $res->item() ) {
580 $reserve{'itemnumber'} = $item->id();
581 $reserve{'barcodenumber'} = $item->barcode();
582 $reserve{'item_level_hold'} = 1;
586 $reserve{'expirationdate'} = output_pref
( { dt
=> dt_from_string
( $res->expirationdate ), dateonly
=> 1 } )
587 unless ( !defined( $res->expirationdate ) || $res->expirationdate eq '0000-00-00' );
588 $reserve{'date'} = output_pref
( { dt
=> dt_from_string
( $res->reservedate ), dateonly
=> 1 } );
589 $reserve{'borrowernumber'} = $res->borrowernumber();
590 $reserve{'biblionumber'} = $res->biblionumber();
591 $reserve{'patron'} = $res->borrower;
592 $reserve{'notes'} = $res->reservenotes();
593 $reserve{'waiting_date'} = $res->waitingdate();
594 $reserve{'ccode'} = $res->item() ?
$res->item()->ccode() : undef;
595 $reserve{'barcode'} = $res->item() ?
$res->item()->barcode() : undef;
596 $reserve{'priority'} = $res->priority();
597 $reserve{'lowestPriority'} = $res->lowestPriority();
598 $reserve{'optionloop'} = \
@optionloop;
599 $reserve{'suspend'} = $res->suspend();
600 $reserve{'suspend_until'} = $res->suspend_until();
601 $reserve{'reserve_id'} = $res->reserve_id();
602 $reserve{itemtype
} = $res->itemtype();
603 $reserve{branchcode
} = $res->branchcode();
604 $reserve{object
} = $res;
606 push( @reserveloop, \
%reserve );
609 # get the time for the form name...
614 fixedRank
=> $fixedRank,
619 optionloop
=> \
@optionloop,
620 bibitemloop
=> \
@bibitemloop,
621 itemdata_enumchron
=> $itemdata_enumchron,
622 itemdata_ccode
=> $itemdata_ccode,
624 biblionumber
=> $biblionumber,
625 findborrower
=> $findborrower,
626 title
=> $biblio->title,
627 author
=> $biblio->author,
629 C4
::Search
::enabled_staff_search_views
,
632 $biblioloopiter{biblionumber
} = $biblionumber;
633 $biblioloopiter{title
} = $biblio->title;
634 $biblioloopiter{rank
} = $fixedRank;
635 $biblioloopiter{reserveloop
} = \
@reserveloop;
638 $template->param( reserveloop
=> \
@reserveloop );
641 push @biblioloop, \
%biblioloopiter;
644 $template->param( biblioloop
=> \
@biblioloop );
645 $template->param( biblionumbers
=> $biblionumbers );
646 $template->param( exceeded_maxreserves
=> $exceeded_maxreserves );
647 $template->param( exceeded_holds_per_record
=> $exceeded_holds_per_record );
648 $template->param( subscriptionsnumber
=> CountSubscriptionFromBiblionumber
($biblionumber));
649 $template->param( pickup
=> $pickup );
651 if ( C4
::Context
->preference( 'AllowHoldDateInFuture' ) ) {
652 $template->param( reserve_in_future
=> 1 );
656 SuspendHoldsIntranet
=> C4
::Context
->preference('SuspendHoldsIntranet'),
657 AutoResumeSuspendedHolds
=> C4
::Context
->preference('AutoResumeSuspendedHolds'),
661 output_html_with_http_headers
$input, $cookie, $template->output;
663 sub sort_borrowerlist
{
664 my $borrowerslist = shift;
667 uc( $a->{surname
} . $a->{firstname
} ) cmp
668 uc( $b->{surname
} . $b->{firstname
} )