From 8bbf82f904adb1430d1d695de0847f37ce3d47fc Mon Sep 17 00:00:00 2001
From: Jonathan Druart <jonathan.druart@biblibre.com>
Date: Fri, 15 Mar 2013 11:20:45 +0100
Subject: [PATCH] Bug 9822: Alert on adding an order to a basket if budget has
 exceeded

2 DB fields are not used: aqbudgets.encumb and aqbudgets.expend.

This patch uses these fields in order to show a warning message if the
budget selected for an order has exceeded.

Test plan:
- Create a new active fund with at least 1 of both warning fields
  ('Warning at (%)' and 'Warning at (amount)').
- Create a new order for a basket with this new fund and a cost >
  warning amount defined for the fund (or using %).
- Save and check that a warning message appears
- Retry playing with all combinations of warning fields
---
 acqui/addorder.pl                                  |  100 +++++++++++++++++++-
 admin/aqbudgets.pl                                 |    2 +-
 .../prog/en/modules/acqui/addorder.tt              |   57 +++++++++++
 .../prog/en/modules/admin/aqbudgets.tt             |   14 +--
 4 files changed, 165 insertions(+), 8 deletions(-)
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/acqui/addorder.tt

diff --git a/acqui/addorder.pl b/acqui/addorder.pl
index 3fa7620..02e9663 100755
--- a/acqui/addorder.pl
+++ b/acqui/addorder.pl
@@ -126,6 +126,7 @@ use C4::Auth;			# get_template_and_user
 use C4::Acquisition;	# NewOrder DelOrder ModOrder
 use C4::Suggestions;	# ModStatus
 use C4::Biblio;			# AddBiblio TransformKohaToMarc
+use C4::Budgets;
 use C4::Items;
 use C4::Output;
 
@@ -135,7 +136,104 @@ use C4::Output;
 # not just blindly call C4 functions and print a redirect.  
 
 my $input = new CGI;
-### $input 
+
+# Check if order total amount exceed allowed budget
+my $confirm_budget_exceeding = $input->param('confirm_budget_exceeding');
+unless($confirm_budget_exceeding) {
+    my $budget_id = $input->param('budget_id');
+    my $total = $input->param('total');
+    my $budget = GetBudget($budget_id);
+    my $budget_spent = GetBudgetSpent($budget_id);
+    my $budget_ordered = GetBudgetOrdered($budget_id);
+    my $budget_used = $budget_spent + $budget_ordered;
+    my $budget_remaining = $budget->{budget_amount} - $budget_used;
+    my $budget_encumbrance = $budget->{budget_amount} * $budget->{budget_encumb} / 100;
+    my $budget_expenditure = $budget->{budget_expend};
+
+    if ( $total > $budget_remaining
+      || ( ($budget_encumbrance+0) && ($budget_used + $total) > $budget_encumbrance)
+      || ( ($budget_expenditure+0) && ($budget_used + $total) > $budget_expenditure) )
+    {
+        my ($template, $loggedinuser, $cookie) = get_template_and_user({
+            template_name   => "acqui/addorder.tmpl",
+            query           => $input,
+            type            => "intranet",
+            authnotrequired => 0,
+            flagsrequired   => {acquisition => 'order_manage'},
+        });
+
+        my $url = $input->referer();
+        unless ( defined $url ) {
+            my $basketno = $input->param('basketno');
+            $url = "/cgi-bin/koha/acqui/basket.pl?basketno=$basketno";
+        }
+
+        my $vars = $input->Vars;
+        my @vars_loop;
+        foreach (keys %$vars) {
+            unless($_ eq "field_value" || $_ eq "itemid" || $_ eq "kohafield" || $_ eq "tag" || $_ eq "subfield" || $_ eq "mandatory") {
+                push @vars_loop, {
+                    name => $_,
+                    value => $vars->{$_},
+                };
+            }
+        }
+
+        my @field_value_loop;
+        push @field_value_loop, {value => $_} for $input->param('field_value');
+
+        my @itemid_loop;
+        push @itemid_loop, {value => $_} for $input->param('itemid');
+
+        my @kohafield_loop;
+        push @kohafield_loop, {value => $_} for $input->param('kohafield');
+
+        my @tag_loop;
+        push @tag_loop, {value => $_} for $input->param('tag');
+
+        my @subfield_loop;
+        push @subfield_loop, {value => $_} for $input->param('subfield');
+
+        my @mandatory_loop;
+        push @mandatory_loop, {value => $_} for $input->param('mandatory');
+
+        if( ($budget_encumbrance+0) && ($budget_used + $total) > $budget_encumbrance
+          && $total <= $budget_remaining)
+        {
+            $template->param(
+                encumbrance_exceeded => 1,
+                encumbrance => sprintf("%.2f", $budget->{'budget_encumb'}),
+            );
+        }
+        if( ($budget_expenditure+0) && ($budget_used + $total) > $budget_expenditure
+          && $total <= $budget_remaining )
+        {
+            my $currency = GetCurrency;
+            $template->param(
+                expenditure_exceeded => 1,
+                expenditure => sprintf("%.2f", $budget_expenditure),
+                currency => ($currency) ? $currency->{'symbol'} : '',
+            );
+        }
+        if($total > $budget_remaining){
+            $template->param(budget_exceeded => 1);
+        }
+
+        $template->param(
+            not_enough_budget => 1,
+            referer => $url,
+            vars_loop => \@vars_loop,
+            field_value => \@field_value_loop,
+            itemid => \@itemid_loop,
+            kohafield => \@kohafield_loop,
+            tag => \@tag_loop,
+            subfield => \@subfield_loop,
+            mandatory => \@mandatory_loop,
+        );
+        output_html_with_http_headers $input, $cookie, $template->output;
+        exit;
+    }
+}
 
 # get_template_and_user used only to check auth & get user id
 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
diff --git a/admin/aqbudgets.pl b/admin/aqbudgets.pl
index c5f99e3..d232976 100755
--- a/admin/aqbudgets.pl
+++ b/admin/aqbudgets.pl
@@ -137,7 +137,7 @@ if ($op eq 'add_form') {
         $dropbox_disabled = BudgetHasChildren($budget_id);
         my $borrower = &GetMember( borrowernumber=>$budget->{budget_owner_id} );
         $budget->{budget_owner_name} = $borrower->{'firstname'} . ' ' . $borrower->{'surname'};
-        $$budget{$_}= sprintf("%.2f", $budget->{$_}) for grep{/amount/} keys %$budget;
+        $$budget{$_}= sprintf("%.2f", $budget->{$_}) for grep{ /amount|encumb|expend/ } keys %$budget;
     }
 
     # build budget hierarchy
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/addorder.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/addorder.tt
new file mode 100644
index 0000000..9cb7b24
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/addorder.tt
@@ -0,0 +1,57 @@
+[% INCLUDE "doc-head-open.inc" %]
+<title>Koha &rsaquo; Acquisition &rsaquo; Add order</title>
+[% INCLUDE "doc-head-close.inc" %]
+</head>
+
+<body>
+[% INCLUDE "header.inc" %]
+
+<div id="doc3" class="yui-t7">
+
+<div id="bd">
+  <div id="yui-main">
+    <div class="yui-b">
+      [% IF (not_enough_budget) %]
+        <form action="/cgi-bin/koha/acqui/addorder.pl" method="post">
+          [% FOREACH var IN vars_loop %]
+            <input type="hidden" name="[% var.name %]" value="[% var.value |html %]" />
+          [% END %]
+          [% FOREACH f IN field_value %]
+            <input type="hidden" name="field_value" value="[% f.value %]" />
+          [% END %]
+          [% FOREACH i IN itemid %]
+            <input type="hidden" name="itemid" value="[% i.value %]" />
+          [% END %]
+          [% FOREACH f IN kohafield %]
+            <input type="hidden" name="kohafield" value="[% f.value %]" />
+          [% END %]
+          [% FOREACH t IN tag %]
+            <input type="hidden" name="tag" value="[% value %]" />
+          [% END %]
+          [% FOREACH s IN subfield %]
+            <input type="hidden" name="subfield" value="[% s.value %]" />
+          [% END %]
+          [% FOREACH m IN mandatory %]
+            <input type="hidden" name="mandatory" value="[% m.value %]" />
+          [% END %]
+          <input type="hidden" name="confirm_budget_exceeding" value="1" />
+          <div class="dialog">
+            [% IF (budget_exceeded) %]
+              <p>Warning! Order total amount exceeds allowed budget.</p>
+            [% END %]
+            [% IF (encumbrance_exceeded) %]
+              <p>Warning! You will exceed [% encumbrance %]% of your fund.</p>
+            [% END %]
+            [% IF (expenditure_exceeded) %]
+              <p>Warning! You will exceed maximum limit ([% expenditure %][% IF (currency) %] [% currency %][% END %]) for your fund.</p>
+            [% END %]
+            <p>Do you want to confirm this order?</p>
+            <input type="submit" class="approve" value="Yes, I confirm" />
+            <input type="button" class="deny" value="No, I don't confirm" onclick="window.location.href = '[% referer %]'" />
+          </div>
+        </form>
+      [% END %]
+    </div>
+  </div>
+</div>
+[% INCLUDE "intranet-bottom.inc" %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/aqbudgets.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/aqbudgets.tt
index af0f086..a45a8bd 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/aqbudgets.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/aqbudgets.tt
@@ -341,14 +341,16 @@
     <input type="text" name="budget_amount" id="budget_amount" value="[% budget_amount %]" size="8" />
     </li>
 
-    <li style="display:none;">
-    <label for="budget_encumb">Encumbrance: </label>
-    <input type="text" name="budget_encumb" id="budget_encumb" value="[% budget_encumb %]" size="8" />
+    <li>
+      <label for="budget_encumb">Warning at (%): </label>
+      <input type="text" name="budget_encumb" id="budget_encumb" value="[% budget_encumb %]" size="10" />
+      <span style="color:grey">0 to disable</span>
     </li>
 
-    <li style="display:none;">
-    <label for="budget_expend">Expenditure: </label>
-    <input type="text" name="budget_expend" id="budget_expend" value="[% budget_expend %]" size="8" />
+    <li>
+      <label for="budget_expend">Warning at (amount): </label>
+      <input type="text" name="budget_expend" id="budget_expend" value="[% budget_expend %]" size="10" /><input type="hidden" name="budget_owner_id" id="budget_owner_id" value="[% budget_owner_id %]" />
+      <span style="color:grey">0 to disable</span>
     </li>
 
     <li>
-- 
1.7.10.4