1 package Koha::CirculationRules;
3 # Copyright ByWater Solutions 2017
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 3 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 use Koha::CirculationRule;
26 use base qw(Koha::Objects);
28 use constant GUESSED_ITEMTYPES_KEY => 'Koha_IssuingRules_last_guess';
32 Koha::CirculationRules - Koha CirculationRule Object set class
42 This structure describes the possible rules that may be set, and what scopes they can be set at.
44 Any attempt to set a rule with a nonsensical scope (for instance, setting the C<patron_maxissueqty> for a branchcode and itemtype), is an error.
50 scope => [ 'branchcode' ],
53 patron_maxissueqty => {
54 scope => [ 'branchcode', 'categorycode' ],
56 patron_maxonsiteissueqty => {
57 scope => [ 'branchcode', 'categorycode' ],
60 scope => [ 'branchcode', 'categorycode' ],
64 scope => [ 'branchcode', 'itemtype' ],
66 hold_fulfillment_policy => {
67 scope => [ 'branchcode', 'itemtype' ],
70 scope => [ 'branchcode', 'itemtype' ],
74 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
77 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
79 cap_fine_to_replacement_price => {
80 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
83 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
85 chargeperiod_charge_at => {
86 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
89 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
92 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
95 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
98 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
100 hardduedatecompare => {
101 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
103 holds_per_record => {
104 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
107 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
110 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
113 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
115 maxonsiteissueqty => {
116 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
118 maxsuspensiondays => {
119 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
121 no_auto_renewal_after => {
122 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
124 no_auto_renewal_after_hard_limit => {
125 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
128 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
131 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
134 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
137 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
140 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
143 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
146 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
149 scope => [ 'branchcode', 'categorycode', 'itemtype' ],
151 # Not included (deprecated?):
162 =head3 get_effective_rule
166 sub get_effective_rule {
167 my ( $self, $params ) = @_;
169 $params->{categorycode} //= undef;
170 $params->{branchcode} //= undef;
171 $params->{itemtype} //= undef;
173 my $rule_name = $params->{rule_name};
174 my $categorycode = $params->{categorycode};
175 my $itemtype = $params->{itemtype};
176 my $branchcode = $params->{branchcode};
178 Koha::Exceptions::MissingParameter->throw(
179 "Required parameter 'rule_name' missing")
182 for my $v ( $branchcode, $categorycode, $itemtype ) {
183 $v = undef if $v and $v eq '*';
186 my $order_by = $params->{order_by}
187 // { -desc => [ 'branchcode', 'categorycode', 'itemtype' ] };
190 $search_params->{rule_name} = $rule_name;
192 $search_params->{categorycode} = defined $categorycode ? [ $categorycode, undef ] : undef;
193 $search_params->{itemtype} = defined $itemtype ? [ $itemtype, undef ] : undef;
194 $search_params->{branchcode} = defined $branchcode ? [ $branchcode, undef ] : undef;
196 my $rule = $self->search(
199 order_by => $order_by,
207 =head3 get_effective_rule
211 sub get_effective_rules {
212 my ( $self, $params ) = @_;
214 my $rules = $params->{rules};
215 my $categorycode = $params->{categorycode};
216 my $itemtype = $params->{itemtype};
217 my $branchcode = $params->{branchcode};
220 foreach my $rule (@$rules) {
221 my $effective_rule = $self->get_effective_rule(
224 categorycode => $categorycode,
225 itemtype => $itemtype,
226 branchcode => $branchcode,
230 $r->{$rule} = $effective_rule->rule_value if $effective_rule;
241 my ( $self, $params ) = @_;
243 for my $mandatory_parameter (qw( branchcode categorycode itemtype rule_name rule_value ) ) {
244 Koha::Exceptions::MissingParameter->throw(
245 "Required parameter 'branchcode' missing")
246 unless exists $params->{$mandatory_parameter};
249 my $kind_info = $RULE_KINDS->{ $params->{rule_name} };
250 croak "set_rule given unknown rule '$params->{rule_name}'!"
251 unless defined $kind_info;
253 # Enforce scope; a rule should be set for its defined scope, no more, no less.
254 foreach my $scope_level ( qw( branchcode categorycode itemtype ) ) {
255 if ( grep /$scope_level/, @{ $kind_info->{scope} } ) {
256 croak "set_rule needs '$scope_level' to set '$params->{rule_name}'!"
257 unless exists $params->{$scope_level};
259 croak "set_rule cannot set '$params->{rule_name}' for a '$scope_level'!"
260 if exists $params->{$scope_level};
264 my $branchcode = $params->{branchcode};
265 my $categorycode = $params->{categorycode};
266 my $itemtype = $params->{itemtype};
267 my $rule_name = $params->{rule_name};
268 my $rule_value = $params->{rule_value};
270 for my $v ( $branchcode, $categorycode, $itemtype ) {
271 $v = undef if $v and $v eq '*';
273 my $rule = $self->search(
275 rule_name => $rule_name,
276 branchcode => $branchcode,
277 categorycode => $categorycode,
278 itemtype => $itemtype,
283 if ( defined $rule_value ) {
284 $rule->rule_value($rule_value);
292 if ( defined $rule_value ) {
293 $rule = Koha::CirculationRule->new(
295 branchcode => $branchcode,
296 categorycode => $categorycode,
297 itemtype => $itemtype,
298 rule_name => $rule_name,
299 rule_value => $rule_value,
314 my ( $self, $params ) = @_;
317 $set_params{branchcode} = $params->{branchcode} if exists $params->{branchcode};
318 $set_params{categorycode} = $params->{categorycode} if exists $params->{categorycode};
319 $set_params{itemtype} = $params->{itemtype} if exists $params->{itemtype};
320 my $rules = $params->{rules};
322 my $rule_objects = [];
323 while ( my ( $rule_name, $rule_value ) = each %$rules ) {
324 my $rule_object = Koha::CirculationRules->set_rule(
327 rule_name => $rule_name,
328 rule_value => $rule_value,
331 push( @$rule_objects, $rule_object );
334 return $rule_objects;
339 Delete a set of circulation rules, needed for cleaning up when deleting issuingrules
346 while ( my $rule = $self->next ){
351 =head3 get_opacitemholds_policy
353 my $can_place_a_hold_at_item_level = Koha::CirculationRules->get_opacitemholds_policy( { patron => $patron, item => $item } );
355 Return 'Y' or 'F' if the patron can place a hold on this item according to the issuing rules
356 and the "Item level holds" (opacitemholds).
357 Can be 'N' - Don't allow, 'Y' - Allow, and 'F' - Force
361 sub get_opacitemholds_policy {
362 my ( $class, $params ) = @_;
364 my $item = $params->{item};
365 my $patron = $params->{patron};
367 return unless $item or $patron;
369 my $rule = Koha::CirculationRules->get_effective_issuing_rule(
371 categorycode => $patron->categorycode,
372 itemtype => $item->effective_itemtype,
373 branchcode => $item->homebranch,
374 rule_name => 'opacitemholds',
378 return $rule ? $rule->rule_value : undef;
381 =head3 get_onshelfholds_policy
383 my $on_shelf_holds = Koha::CirculationRules->get_onshelfholds_policy({ item => $item, patron => $patron });
387 sub get_onshelfholds_policy {
388 my ( $class, $params ) = @_;
389 my $item = $params->{item};
390 my $itemtype = $item->effective_itemtype;
391 my $patron = $params->{patron};
392 my $rule = Koha::CirculationRules->get_effective_rule(
394 categorycode => ( $patron ? $patron->categorycode : undef ),
395 itemtype => $itemtype,
396 branchcode => $item->holdingbranch,
397 rule_name => 'onshelfholds',
400 return $rule ? $rule->rule_value : undef;
403 =head3 article_requestable_rules
405 Return rules that allow article requests, optionally filtered by
408 Use with care; see guess_article_requestable_itemtypes.
412 sub article_requestable_rules {
413 my ( $class, $params ) = @_;
414 my $category = $params->{categorycode};
416 return if !C4::Context->preference('ArticleRequests');
417 return $class->search({
418 $category ? ( categorycode => [ $category, '*' ] ) : (),
419 rule_name => 'article_requests',
420 rule_value => { '!=' => 'no' },
424 =head3 guess_article_requestable_itemtypes
426 Return item types in a hashref that are likely possible to be
427 'article requested'. Constructed by an intelligent guess in the
428 issuing rules (see article_requestable_rules).
430 Note: pref ArticleRequestsLinkControl overrides the algorithm.
432 Optional parameters: categorycode.
434 Note: the routine is used in opac-search to obtain a reasonable
435 estimate within performance borders (not looking at all items but
436 just using default itemtype). Also we are not looking at the
437 branchcode here, since home or holding branch of the item is
438 leading and branch may be unknown too (anonymous opac session).
442 sub guess_article_requestable_itemtypes {
443 my ( $class, $params ) = @_;
444 my $category = $params->{categorycode};
445 return {} if !C4::Context->preference('ArticleRequests');
446 return { '*' => 1 } if C4::Context->preference('ArticleRequestsLinkControl') eq 'always';
448 my $cache = Koha::Caches->get_instance;
449 my $last_article_requestable_guesses = $cache->get_from_cache(GUESSED_ITEMTYPES_KEY);
450 my $key = $category || '*';
451 return $last_article_requestable_guesses->{$key}
452 if $last_article_requestable_guesses && exists $last_article_requestable_guesses->{$key};
455 my $rules = $class->article_requestable_rules({
456 $category ? ( categorycode => $category ) : (),
458 return $res if !$rules;
459 foreach my $rule ( $rules->as_list ) {
460 $res->{ $rule->itemtype } = 1;
462 $last_article_requestable_guesses->{$key} = $res;
463 $cache->set_in_cache(GUESSED_ITEMTYPES_KEY, $last_article_requestable_guesses);
473 return 'CirculationRule';
481 return 'Koha::CirculationRule';