2 # Copyright 2000-2002 Katipo Communications
3 # copyright 2010 BibLibre
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use C4::Output qw( output_html_with_http_headers );
24 use C4::Auth qw( get_template_and_user );
25 use Koha::DateUtils qw( dt_from_string output_pref );
29 use Koha::CirculationRules;
30 use Koha::Patron::Categories;
35 my $dbh = C4::Context->dbh;
38 # $flagsrequired->{circulation}=1;
39 my ($template, $loggedinuser, $cookie)
40 = get_template_and_user({template_name => "admin/smart-rules.tt",
43 flagsrequired => {parameters => 'manage_circ_rules'},
46 my $type=$input->param('type');
48 my $branch = $input->param('branch');
50 if ( C4::Context->preference('DefaultToLoggedInLibraryCircRules') ) {
51 $branch = Koha::Libraries->search->count() == 1 ? undef : C4::Context::mybranch();
54 $branch = C4::Context::only_my_library() ? ( C4::Context::mybranch() || '*' ) : '*';
58 my $logged_in_patron = Koha::Patrons->find( $loggedinuser );
60 my $can_edit_from_any_library = $logged_in_patron->has_permission( {parameters => 'manage_circ_rules_from_any_libraries' } );
61 $template->param( restricted_to_own_library => not $can_edit_from_any_library );
62 $branch = C4::Context::mybranch() unless $can_edit_from_any_library;
64 my $op = $input->param('op') || q{};
65 my $language = C4::Languages::getlanguage();
67 my $cache = Koha::Caches->get_instance;
68 $cache->clear_from_cache( Koha::CirculationRules::GUESSED_ITEMTYPES_KEY );
70 if ($op eq 'delete') {
71 my $itemtype = $input->param('itemtype');
72 my $categorycode = $input->param('categorycode');
74 Koha::CirculationRules->set_rules(
76 categorycode => $categorycode eq '*' ? undef : $categorycode,
77 branchcode => $branch eq '*' ? undef : $branch,
78 itemtype => $itemtype eq '*' ? undef : $itemtype,
81 maxonsiteissueqty => undef,
82 rentaldiscount => undef,
85 maxsuspensiondays => undef,
86 suspension_chargeperiod => undef,
88 chargeperiod => undef,
89 chargeperiod_charge_at => undef,
94 hardduedatecompare => undef,
95 renewalsallowed => undef,
96 unseen_renewals_allowed => undef,
97 renewalperiod => undef,
98 norenewalbefore => undef,
100 no_auto_renewal_after => undef,
101 no_auto_renewal_after_hard_limit => undef,
102 reservesallowed => undef,
103 holds_per_record => undef,
104 holds_per_day => undef,
105 onshelfholds => undef,
106 opacitemholds => undef,
107 overduefinescap => undef,
108 cap_fine_to_replacement_price => undef,
109 article_requests => undef,
115 elsif ($op eq 'delete-branch-cat') {
116 my $categorycode = $input->param('categorycode');
117 if ($branch eq "*") {
118 if ($categorycode eq "*") {
119 Koha::CirculationRules->set_rules(
122 categorycode => undef,
125 patron_maxissueqty => undef,
126 patron_maxonsiteissueqty => undef,
130 Koha::CirculationRules->set_rules(
135 holdallowed => undef,
136 hold_fulfillment_policy => undef,
137 returnbranch => undef,
142 Koha::CirculationRules->set_rules(
144 categorycode => $categorycode,
148 patron_maxissueqty => undef,
149 patron_maxonsiteissueqty => undef,
154 } elsif ($categorycode eq "*") {
155 Koha::CirculationRules->set_rules(
157 branchcode => $branch,
158 categorycode => undef,
161 patron_maxissueqty => undef,
162 patron_maxonsiteissueqty => undef,
166 Koha::CirculationRules->set_rules(
168 branchcode => $branch,
171 holdallowed => undef,
172 hold_fulfillment_policy => undef,
173 returnbranch => undef,
178 Koha::CirculationRules->set_rules(
180 categorycode => $categorycode,
181 branchcode => $branch,
184 patron_maxissueqty => undef,
185 patron_maxonsiteissueqty => undef,
191 elsif ($op eq 'delete-branch-item') {
192 my $itemtype = $input->param('itemtype');
193 if ($branch eq "*") {
194 if ($itemtype eq "*") {
195 Koha::CirculationRules->set_rules(
200 holdallowed => undef,
201 hold_fulfillment_policy => undef,
202 returnbranch => undef,
207 Koha::CirculationRules->set_rules(
210 itemtype => $itemtype,
212 holdallowed => undef,
213 hold_fulfillment_policy => undef,
214 returnbranch => undef,
219 } elsif ($itemtype eq "*") {
220 Koha::CirculationRules->set_rules(
222 branchcode => $branch,
225 holdallowed => undef,
226 hold_fulfillment_policy => undef,
227 returnbranch => undef,
232 Koha::CirculationRules->set_rules(
234 branchcode => $branch,
235 itemtype => $itemtype,
237 holdallowed => undef,
238 hold_fulfillment_policy => undef,
239 returnbranch => undef,
245 # save the values entered
246 elsif ($op eq 'add') {
247 my $br = $branch; # branch
248 my $bor = $input->param('categorycode'); # borrower category
249 my $itemtype = $input->param('itemtype'); # item type
250 my $fine = $input->param('fine');
251 my $finedays = $input->param('finedays');
252 my $maxsuspensiondays = $input->param('maxsuspensiondays') || '';
253 my $suspension_chargeperiod = $input->param('suspension_chargeperiod') || 1;
254 my $firstremind = $input->param('firstremind');
255 my $chargeperiod = $input->param('chargeperiod');
256 my $chargeperiod_charge_at = $input->param('chargeperiod_charge_at');
257 my $maxissueqty = strip_non_numeric( scalar $input->param('maxissueqty') );
258 my $maxonsiteissueqty = strip_non_numeric( scalar $input->param('maxonsiteissueqty') );
259 my $renewalsallowed = $input->param('renewalsallowed');
260 my $unseen_renewals_allowed = $input->param('unseen_renewals_allowed');
261 my $renewalperiod = $input->param('renewalperiod');
262 my $norenewalbefore = $input->param('norenewalbefore');
263 $norenewalbefore = '' if $norenewalbefore =~ /^\s*$/;
264 my $auto_renew = $input->param('auto_renew') eq 'yes' ? 1 : 0;
265 my $no_auto_renewal_after = $input->param('no_auto_renewal_after');
266 $no_auto_renewal_after = '' if $no_auto_renewal_after =~ /^\s*$/;
267 my $no_auto_renewal_after_hard_limit = $input->param('no_auto_renewal_after_hard_limit') || '';
268 $no_auto_renewal_after_hard_limit = eval { dt_from_string( scalar $no_auto_renewal_after_hard_limit ) } if ( $no_auto_renewal_after_hard_limit );
269 $no_auto_renewal_after_hard_limit = output_pref( { dt => $no_auto_renewal_after_hard_limit, dateonly => 1, dateformat => 'iso' } ) if ( $no_auto_renewal_after_hard_limit );
270 my $reservesallowed = strip_non_numeric( scalar $input->param('reservesallowed') );
271 my $holds_per_record = strip_non_numeric( scalar $input->param('holds_per_record') );
272 my $holds_per_day = strip_non_numeric( scalar $input->param('holds_per_day') );
273 my $onshelfholds = $input->param('onshelfholds') || 0;
274 my $issuelength = $input->param('issuelength');
275 $issuelength = $issuelength eq q{} ? undef : $issuelength;
276 my $daysmode = $input->param('daysmode');
277 my $lengthunit = $input->param('lengthunit');
278 my $hardduedate = $input->param('hardduedate') || undef;
279 $hardduedate = eval { dt_from_string( scalar $hardduedate ) } if ( $hardduedate );
280 $hardduedate = output_pref( { dt => $hardduedate, dateonly => 1, dateformat => 'iso' } ) if ( $hardduedate );
281 my $hardduedatecompare = $input->param('hardduedatecompare');
282 my $rentaldiscount = $input->param('rentaldiscount');
283 my $opacitemholds = $input->param('opacitemholds') || 0;
284 my $article_requests = $input->param('article_requests') || 'no';
285 my $overduefinescap = $input->param('overduefinescap') || '';
286 my $cap_fine_to_replacement_price = ($input->param('cap_fine_to_replacement_price') || '') eq 'on';
287 my $note = $input->param('note');
288 my $decreaseloanholds = $input->param('decreaseloanholds') || undef;
291 maxissueqty => $maxissueqty,
292 maxonsiteissueqty => $maxonsiteissueqty,
293 rentaldiscount => $rentaldiscount,
295 finedays => $finedays,
296 maxsuspensiondays => $maxsuspensiondays,
297 suspension_chargeperiod => $suspension_chargeperiod,
298 firstremind => $firstremind,
299 chargeperiod => $chargeperiod,
300 chargeperiod_charge_at => $chargeperiod_charge_at,
301 issuelength => $issuelength,
302 daysmode => $daysmode,
303 lengthunit => $lengthunit,
304 hardduedate => $hardduedate,
305 hardduedatecompare => $hardduedatecompare,
306 renewalsallowed => $renewalsallowed,
307 unseen_renewals_allowed => $unseen_renewals_allowed,
308 renewalperiod => $renewalperiod,
309 norenewalbefore => $norenewalbefore,
310 auto_renew => $auto_renew,
311 no_auto_renewal_after => $no_auto_renewal_after,
312 no_auto_renewal_after_hard_limit => $no_auto_renewal_after_hard_limit,
313 reservesallowed => $reservesallowed,
314 holds_per_record => $holds_per_record,
315 holds_per_day => $holds_per_day,
316 onshelfholds => $onshelfholds,
317 opacitemholds => $opacitemholds,
318 overduefinescap => $overduefinescap,
319 cap_fine_to_replacement_price => $cap_fine_to_replacement_price,
320 article_requests => $article_requests,
322 decreaseloanholds => $decreaseloanholds,
325 Koha::CirculationRules->set_rules(
327 categorycode => $bor eq '*' ? undef : $bor,
328 itemtype => $itemtype eq '*' ? undef : $itemtype,
329 branchcode => $br eq '*' ? undef : $br,
335 elsif ($op eq "set-branch-defaults") {
336 my $categorycode = $input->param('categorycode');
337 my $patron_maxissueqty = strip_non_numeric( scalar $input->param('patron_maxissueqty') );
338 my $patron_maxonsiteissueqty = $input->param('patron_maxonsiteissueqty');
339 $patron_maxonsiteissueqty = strip_non_numeric($patron_maxonsiteissueqty);
340 my $holdallowed = $input->param('holdallowed');
341 my $hold_fulfillment_policy = $input->param('hold_fulfillment_policy');
342 my $returnbranch = $input->param('returnbranch');
343 my $max_holds = strip_non_numeric( scalar $input->param('max_holds') );
345 if ($branch eq "*") {
346 Koha::CirculationRules->set_rules(
351 holdallowed => $holdallowed,
352 hold_fulfillment_policy => $hold_fulfillment_policy,
353 returnbranch => $returnbranch,
357 Koha::CirculationRules->set_rules(
359 categorycode => undef,
362 patron_maxissueqty => $patron_maxissueqty,
363 patron_maxonsiteissueqty => $patron_maxonsiteissueqty,
368 Koha::CirculationRules->set_rules(
371 branchcode => $branch,
373 holdallowed => $holdallowed,
374 hold_fulfillment_policy => $hold_fulfillment_policy,
375 returnbranch => $returnbranch,
379 Koha::CirculationRules->set_rules(
381 categorycode => undef,
382 branchcode => $branch,
384 patron_maxissueqty => $patron_maxissueqty,
385 patron_maxonsiteissueqty => $patron_maxonsiteissueqty,
390 Koha::CirculationRules->set_rule(
392 branchcode => $branch,
393 categorycode => undef,
394 rule_name => 'max_holds',
395 rule_value => $max_holds,
399 elsif ($op eq "add-branch-cat") {
400 my $categorycode = $input->param('categorycode');
401 my $patron_maxissueqty = strip_non_numeric( scalar $input->param('patron_maxissueqty') );
402 my $patron_maxonsiteissueqty = $input->param('patron_maxonsiteissueqty');
403 $patron_maxonsiteissueqty = strip_non_numeric($patron_maxonsiteissueqty);
404 my $max_holds = $input->param('max_holds');
405 $max_holds =~ s/\s//g;
406 $max_holds = undef if $max_holds !~ /^\d+/;
408 if ($branch eq "*") {
409 if ($categorycode eq "*") {
410 Koha::CirculationRules->set_rules(
412 categorycode => undef,
415 max_holds => $max_holds,
416 patron_maxissueqty => $patron_maxissueqty,
417 patron_maxonsiteissueqty => $patron_maxonsiteissueqty,
422 Koha::CirculationRules->set_rules(
424 categorycode => $categorycode,
427 max_holds => $max_holds,
428 patron_maxissueqty => $patron_maxissueqty,
429 patron_maxonsiteissueqty => $patron_maxonsiteissueqty,
434 } elsif ($categorycode eq "*") {
435 Koha::CirculationRules->set_rules(
437 categorycode => undef,
438 branchcode => $branch,
440 max_holds => $max_holds,
441 patron_maxissueqty => $patron_maxissueqty,
442 patron_maxonsiteissueqty => $patron_maxonsiteissueqty,
447 Koha::CirculationRules->set_rules(
449 categorycode => $categorycode,
450 branchcode => $branch,
452 max_holds => $max_holds,
453 patron_maxissueqty => $patron_maxissueqty,
454 patron_maxonsiteissueqty => $patron_maxonsiteissueqty,
460 elsif ($op eq "add-branch-item") {
461 my $itemtype = $input->param('itemtype');
462 my $holdallowed = $input->param('holdallowed');
463 my $hold_fulfillment_policy = $input->param('hold_fulfillment_policy');
464 my $returnbranch = $input->param('returnbranch');
466 if ($branch eq "*") {
467 if ($itemtype eq "*") {
468 Koha::CirculationRules->set_rules(
473 holdallowed => $holdallowed,
474 hold_fulfillment_policy => $hold_fulfillment_policy,
475 returnbranch => $returnbranch,
480 Koha::CirculationRules->set_rules(
482 itemtype => $itemtype,
485 holdallowed => $holdallowed,
486 hold_fulfillment_policy => $hold_fulfillment_policy,
487 returnbranch => $returnbranch,
492 } elsif ($itemtype eq "*") {
493 Koha::CirculationRules->set_rules(
496 branchcode => $branch,
498 holdallowed => $holdallowed,
499 hold_fulfillment_policy => $hold_fulfillment_policy,
500 returnbranch => $returnbranch,
505 Koha::CirculationRules->set_rules(
507 itemtype => $itemtype,
508 branchcode => $branch,
510 holdallowed => $holdallowed,
511 hold_fulfillment_policy => $hold_fulfillment_policy,
512 returnbranch => $returnbranch,
518 elsif ( $op eq 'mod-refund-lost-item-fee-rule' ) {
520 my $lostreturn = $input->param('lostreturn');
522 if ( $lostreturn eq '*' ) {
523 if ( $branch ne '*' ) {
524 # only do something for $lostreturn eq '*' if branch-specific
525 Koha::CirculationRules->set_rules(
527 branchcode => $branch,
535 Koha::CirculationRules->set_rules(
537 branchcode => $branch,
539 lostreturn => $lostreturn
546 my $refundLostItemFeeRule = Koha::CirculationRules->find({ branchcode => ($branch eq '*') ? undef : $branch, rule_name => 'lostreturn' });
547 my $defaultLostItemFeeRule = Koha::CirculationRules->find({ branchcode => undef, rule_name => 'lostreturn' });
549 refundLostItemFeeRule => $refundLostItemFeeRule,
550 defaultRefundRule => $defaultLostItemFeeRule ? $defaultLostItemFeeRule->rule_value : 'refund'
553 my $patron_categories = Koha::Patron::Categories->search({}, { order_by => ['description'] });
555 my $itemtypes = Koha::ItemTypes->search_with_localization;
557 my $humanbranch = ( $branch ne '*' ? $branch : undef );
559 my $all_rules = Koha::CirculationRules->search({ branchcode => $humanbranch });
560 my $definedbranch = $all_rules->count ? 1 : 0;
563 while ( my $r = $all_rules->next ) {
565 $rules->{ $r->{categorycode} // '' }->{ $r->{itemtype} // '' }->{ $r->{rule_name} } = $r->{rule_value};
568 $template->param(show_branch_cat_rule_form => 1);
571 patron_categories => $patron_categories,
572 itemtypeloop => $itemtypes,
573 humanbranch => $humanbranch,
574 current_branch => $branch,
575 definedbranch => $definedbranch,
578 output_html_with_http_headers $input, $cookie, $template->output;
582 # sort by patron category, then item type, putting
583 # default entries at the bottom
584 sub by_category_and_itemtype {
585 unless (by_category($a, $b)) {
586 return by_itemtype($a, $b);
592 if ($a->{'default_humancategorycode'}) {
593 return ($b->{'default_humancategorycode'} ? 0 : 1);
594 } elsif ($b->{'default_humancategorycode'}) {
597 return $a->{'humancategorycode'} cmp $b->{'humancategorycode'};
603 if ($a->{default_translated_description}) {
604 return ($b->{'default_translated_description'} ? 0 : 1);
605 } elsif ($b->{'default_translated_description'}) {
608 return lc $a->{'translated_description'} cmp lc $b->{'translated_description'};
612 sub strip_non_numeric {
615 $string = '' if $string !~ /^\d+/;