From fbf0ba1a2c9184a74bee1b1f0c53481cc6f44a94 Mon Sep 17 00:00:00 2001
From: Kyle M Hall <kyle@bywatersolutions.com>
Date: Wed, 21 Nov 2012 14:54:17 -0500
Subject: [PATCH] Bug 9129 - Add the ability to set the maximum fine for an
 item to its replacement price

Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>

Original test plan

Test plan:
1) Apply patch
2) Run updatedatabase.pl
3) Enable MaxFineIsReplacementPrice
4) Pick an item, set it's replacementprice to some amount ( e.g. $6.50 )
5) Check it out to a patron, back date the due date by an amount such
that the fine should exceed the replacement price ( a year ago should be good ).
6) Run fines.pl
7) Verify the fine for the item is not exceeded the replacement price.

Added:

Max sure you have maximum fine amount to be higher than the
replacement price you set, otherwise it will stop at that amount
---
 C4/Overdues.pm                                         |   16 +++++++++++++++-
 installer/data/mysql/sysprefs.sql                      |    1 +
 installer/data/mysql/updatedatabase.pl                 |    8 ++++++++
 .../prog/en/modules/admin/preferences/patrons.pref     |    6 ++++++
 4 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/C4/Overdues.pm b/C4/Overdues.pm
index ac66c36..582ae62 100644
--- a/C4/Overdues.pm
+++ b/C4/Overdues.pm
@@ -268,8 +268,12 @@ sub CalcFine {
     } else {
         # a zero (or null) chargeperiod or negative units_minus_grace value means no charge.
     }
+
     $amount = $data->{overduefinescap} if $data->{overduefinescap} && $amount > $data->{overduefinescap};
+    $amount = $item->{'replacementprice'} if ( C4::Context->preference('MaxFineIsReplacementPrice') && $item->{'replacementprice'} && $amount > $item->{'replacementprice'} );
+
     $debug and warn sprintf("CalcFine returning (%s, %s, %s, %s)", $amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
+
     return ($amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
     # FIXME: chargename is NEVER populated anywhere.
 }
@@ -542,16 +546,26 @@ sub UpdateFine {
         }
         $total_amount_other += $rec->{'amount'};
     }
+
+    if ( C4::Context->preference('MaxFineIsReplacementPrice') ) {
+        my $item = C4::Items::GetItem( $itemnum );
+        if ( $item->{'replacementprice'} && $amount > $item->{'replacementprice'} ) {
+            $debug && warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $item->{'replacementprice'} - Fine exceeds replacement price";            
+            $amount = $item->{'replacementprice'};
+        }
+    }
+
     if (my $maxfine = C4::Context->preference('MaxFine')) {
         if ($total_amount_other + $amount > $maxfine) {
             my $new_amount = $maxfine - $total_amount_other;
-            warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $new_amount - MaxFine reached";
+            $debug && warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $new_amount - MaxFine reached";
             return if $new_amount <= 0.00;
 
             $amount = $new_amount;
         }
     }
 
+
     if ( $data ) {
 
 		# we're updating an existing fine.  Only modify if amount changed
diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql
index d5d15d7..e940a05 100644
--- a/installer/data/mysql/sysprefs.sql
+++ b/installer/data/mysql/sysprefs.sql
@@ -406,3 +406,4 @@ INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('
 INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('NotesBlacklist','','List of notes fields that should not appear in the title notes/description separator of details',NULL,'free');
 INSERT INTO systempreferences (variable,value,options,explanation,type) VALUES ('SCOUserCSS', '', NULL, 'Add CSS to be included in the SCO module in an embedded <style> tag.', 'free');
 INSERT INTO systempreferences (variable,value,options,explanation,type) VALUES ('SCOUserJS', '', NULL, 'Define custom javascript for inclusion in the SCO module', 'free');
+INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('MaxFineIsReplacementPrice',0,'Make the replacement price a second max fine ceiling.',NULL,'YesNo');
diff --git a/installer/data/mysql/updatedatabase.pl b/installer/data/mysql/updatedatabase.pl
index 77265f4..1502e39 100755
--- a/installer/data/mysql/updatedatabase.pl
+++ b/installer/data/mysql/updatedatabase.pl
@@ -6339,6 +6339,14 @@ if ( CheckVersion($DBversion) ) {
    SetVersion ($DBversion);
 }
 
+$DBversion = "3.09.00.XXX";
+if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
+   $dbh->do("INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES('MaxFineIsReplacementPrice',0,'Make the replacement price a second max fine ceiling.',NULL,'YesNo')");
+   print "Upgrade to $DBversion done (Bug 9129: Add syspref MaxFineIsReplacementPrice)\n";
+   SetVersion ($DBversion);
+}
+
+
 =head1 FUNCTIONS
 
 =head2 TableExists($table)
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
index 74d14af..33cb821 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
@@ -80,6 +80,12 @@ Patrons:
          - '[% local_currency %].'
          - Empty value means no limit. Single item caps are specified in the circulation rules matrix.
      -
+         - pref: MaxFineIsReplacementPrice
+           choices:
+               yes: Allow
+               no: "Don't allow"
+         - the maximum fine for an item to exceed the replacement price for that item.
+     -
          - pref: memberofinstitution
            choices:
                yes: Do
-- 
1.7.10.4