X-Git-Url: http://koha-dev.rot13.org:8081/gitweb/?a=blobdiff_plain;f=Koha%2FCirculationRules.pm;h=f96df496fb502fa9b2bb4b8b63549e0ba67f4736;hb=fccf6acc043b0dd95b992762bdc8182a4d6eae74;hp=5b63998a8b8f84509f5d8b7e3e4fc6dba9494af8;hpb=039adae9aa4fa3be76e16633cb64a45ca7d7ed46;p=koha-ffzg.git diff --git a/Koha/CirculationRules.pm b/Koha/CirculationRules.pm index 5b63998a8b..f96df496fb 100644 --- a/Koha/CirculationRules.pm +++ b/Koha/CirculationRules.pm @@ -18,14 +18,16 @@ package Koha::CirculationRules; # along with Koha; if not, see . use Modern::Perl; -use Carp qw(croak); +use Carp qw( croak ); use Koha::Exceptions; use Koha::CirculationRule; +use Koha::Caches; +use Koha::Cache::Memory::Lite; use base qw(Koha::Objects); -use constant GUESSED_ITEMTYPES_KEY => 'Koha_IssuingRules_last_guess'; +use constant GUESSED_ITEMTYPES_KEY => 'Koha_CirculationRules_last_guess'; =head1 NAME @@ -46,10 +48,12 @@ Any attempt to set a rule with a nonsensical scope (for instance, setting the C< =cut our $RULE_KINDS = { - refund => { + lostreturn => { + scope => [ 'branchcode' ], + }, + processingreturn => { scope => [ 'branchcode' ], }, - patron_maxissueqty => { scope => [ 'branchcode', 'categorycode' ], }, @@ -76,6 +80,13 @@ our $RULE_KINDS = { article_requests => { scope => [ 'branchcode', 'categorycode', 'itemtype' ], }, + article_request_fee => { + scope => [ 'branchcode', 'categorycode' ], + }, + open_article_requests_limit => { + scope => [ 'branchcode', 'categorycode' ], + }, + auto_renew => { scope => [ 'branchcode', 'categorycode', 'itemtype' ], }, @@ -103,6 +114,10 @@ our $RULE_KINDS = { hardduedatecompare => { scope => [ 'branchcode', 'categorycode', 'itemtype' ], }, + waiting_hold_cancellation => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + can_be_blank => 0, + }, holds_per_day => { scope => [ 'branchcode', 'categorycode', 'itemtype' ], }, @@ -151,8 +166,12 @@ our $RULE_KINDS = { renewalsallowed => { scope => [ 'branchcode', 'categorycode', 'itemtype' ], }, + unseen_renewals_allowed => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, rentaldiscount => { scope => [ 'branchcode', 'categorycode', 'itemtype' ], + can_be_blank => 0, }, reservesallowed => { scope => [ 'branchcode', 'categorycode', 'itemtype' ], @@ -163,6 +182,27 @@ our $RULE_KINDS = { note => { # This is not really a rule. Maybe we will want to separate this later. scope => [ 'branchcode', 'categorycode', 'itemtype' ], }, + decreaseloanholds => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, + recalls_allowed => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, + recalls_per_record => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, + on_shelf_recalls => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, + recall_due_date_interval => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, + recall_overdue_fine => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, + recall_shelf_time => { + scope => [ 'branchcode', 'categorycode', 'itemtype' ], + }, # Not included (deprecated?): # * accountsent # * reservecharge @@ -175,6 +215,18 @@ sub rule_kinds { =head3 get_effective_rule + my $effective_rule = Koha::CirculationRules->get_effective_rule( + { + rule_name => $name, + categorycode => $categorycode, + itemtype => $itemtype, + branchcode => $branchcode + } + ); + +Return the effective rule object for the rule associated with the criteria passed. + + =cut sub get_effective_rule { @@ -218,6 +270,46 @@ sub get_effective_rule { return $rule; } +=head3 get_effective_rule_value + + my $effective_rule_value = Koha::CirculationRules->get_effective_rule_value( + { + rule_name => $name, + categorycode => $categorycode, + itemtype => $itemtype, + branchcode => $branchcode + } + ); + +Return the effective value for the rule associated with the criteria passed. + +This is a cached method so should be used in preference to get_effective_rule where possible +to aid performance. + +=cut + +sub get_effective_rule_value { + my ( $self, $params ) = @_; + + my $rule_name = $params->{rule_name}; + my $categorycode = $params->{categorycode}; + my $itemtype = $params->{itemtype}; + my $branchcode = $params->{branchcode}; + + my $memory_cache = Koha::Cache::Memory::Lite->get_instance; + my $cache_key = sprintf "CircRules:%s:%s:%s:%s", $rule_name // q{}, + $categorycode // q{}, $branchcode // q{}, $itemtype // q{}; + + my $cached = $memory_cache->get_from_cache($cache_key); + return $cached if $cached; + + my $rule = $self->get_effective_rule($params); + + my $value= $rule ? $rule->rule_value : undef; + $memory_cache->set_in_cache( $cache_key, $value ); + return $value; +} + =head3 get_effective_rules =cut @@ -232,7 +324,7 @@ sub get_effective_rules { my $r; foreach my $rule (@$rules) { - my $effective_rule = $self->get_effective_rule( + my $effective_rule = $self->get_effective_rule_value( { rule_name => $rule, categorycode => $categorycode, @@ -241,7 +333,7 @@ sub get_effective_rules { } ); - $r->{$rule} = $effective_rule->rule_value if $effective_rule; + $r->{$rule} = $effective_rule if defined $effective_rule; } return $r; @@ -282,7 +374,7 @@ sub set_rule { my $rule_name = $params->{rule_name}; my $rule_value = $params->{rule_value}; my $can_be_blank = defined $kind_info->{can_be_blank} ? $kind_info->{can_be_blank} : 1; - $rule_value = undef if $rule_value eq "" && !$can_be_blank; + $rule_value = undef if defined $rule_value && $rule_value eq "" && !$can_be_blank; for my $v ( $branchcode, $categorycode, $itemtype ) { $v = undef if $v and $v eq '*'; @@ -320,6 +412,11 @@ sub set_rule { } } + my $memory_cache = Koha::Cache::Memory::Lite->get_instance; + for my $k ( $memory_cache->all_keys ) { + $memory_cache->clear_from_cache($k) if $k =~ m{^CircRules:}; + } + return $rule; } @@ -379,6 +476,53 @@ sub clone { } } +=head2 get_return_branch_policy + + my $returnbranch = Koha::CirculationRules->get_return_branch_policy($item); + +Returns the branch to use for returning the item based on the +item type, and a branch selected via CircControlReturnsBranch. + +The return value is the branch to which to return the item. Possible values: + noreturn: do not return, let item remain where checked in (floating collections) + homebranch: return to item's home branch + holdingbranch: return to issuer branch + +This searches branchitemrules in the following order: + * Same branchcode and itemtype + * Same branchcode, itemtype '*' + * branchcode '*', same itemtype + * branchcode '*' and itemtype '*' + +=cut + +sub get_return_branch_policy { + my ( $self, $item ) = @_; + + my $pref = C4::Context->preference('CircControlReturnsBranch'); + + my $branchcode = + $pref eq 'ItemHomeLibrary' ? $item->homebranch + : $pref eq 'ItemHoldingLibrary' ? $item->holdingbranch + : $pref eq 'CheckInLibrary' ? C4::Context->userenv + ? C4::Context->userenv->{branch} + : $item->homebranch + : $item->homebranch; + + my $itemtype = $item->effective_itemtype; + + my $rule = Koha::CirculationRules->get_effective_rule( + { + rule_name => 'returnbranch', + itemtype => $itemtype, + branchcode => $branchcode, + } + ); + + return $rule ? $rule->rule_value : 'homebranch'; +} + + =head3 get_opacitemholds_policy my $can_place_a_hold_at_item_level = Koha::CirculationRules->get_opacitemholds_policy( { patron => $patron, item => $item } ); @@ -433,7 +577,36 @@ sub get_onshelfholds_policy { =head3 get_lostreturn_policy - my $refund = Koha::CirculationRules->get_lostreturn_policy( { return_branch => $return_branch, item => $item } ); + my $lost_proc_refund_policy = Koha::CirculationRules->get_lostreturn_policy( { return_branch => $return_branch, item => $item } ); + +lostreturn return values are: + +=over 2 + +=item '0' - Do not refund + +=item 'refund' - Refund the lost item charge + +=item 'restore' - Refund the lost item charge and restore the original overdue fine + +=item 'charge' - Refund the lost item charge and charge a new overdue fine + +=back + +processing return return values are: + +=over 2 + +=item '0' - Do not refund + +=item 'refund' - Refund the lost item processing charge + +=item 'restore' - Refund the lost item processing charge and restore the original overdue fine + +=item 'charge' - Refund the lost item processing charge and charge a new overdue fine + +=back + =cut @@ -451,14 +624,16 @@ sub get_lostreturn_policy { my $branch = $behaviour_mapping->{ $behaviour }; - my $rule = Koha::CirculationRules->get_effective_rule( + my $rules = Koha::CirculationRules->get_effective_rules( { branchcode => $branch, - rule_name => 'refund', + rules => ['lostreturn','processingreturn'] } ); - return $rule ? $rule->rule_value : 1; + $rules->{lostreturn} //= 'refund'; + $rules->{processingreturn} //= 'refund'; + return $rules; } =head3 article_requestable_rules @@ -525,7 +700,7 @@ sub guess_article_requestable_itemtypes { return $res; } -=head3 get_daysmode_effective_value +=head3 get_effective_daysmode Return the value for daysmode defined in the circulation rules. If not defined (or empty string), the value of the system preference useDaysMode is returned