Bug 9573: Lost items report - Add a new itemlost_on column
[koha.git] / admin / aqbudgets.pl
index 229606e..5aeb8b9 100755 (executable)
@@ -6,43 +6,41 @@
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use Modern::Perl;
 
-use CGI;
+use CGI qw ( -utf8 );
 use List::Util qw/min/;
-use Number::Format qw(format_price);
 
+use Koha::Database;
 use C4::Auth qw/get_user_subpermissions/;
-use C4::Branch; # GetBranches
-use C4::Dates qw/format_date format_date_in_iso/;
 use C4::Auth;
 use C4::Acquisition;
-use C4::Budgets;   #
-use C4::Members;  # calls GetSortDetails()
+use C4::Budgets;
 use C4::Context;
 use C4::Output;
 use C4::Koha;
 use C4::Debug;
-#use POSIX qw(locale_h);
+use Koha::Acquisition::Currencies;
+use Koha::Patrons;
 
 my $input = new CGI;
 my $dbh     = C4::Context->dbh;
 
 my ($template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
-    {   template_name   => "admin/aqbudgets.tmpl",
+    {   template_name   => "admin/aqbudgets.tt",
         query           => $input,
         type            => "intranet",
         authnotrequired => 0,
@@ -51,75 +49,59 @@ my ($template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
     }
 );
 
-my $cur = GetCurrency();
-$template->param( symbol => $cur->{symbol},
-                  currency => $cur->{currency}
-               );
+my $active_currency = Koha::Acquisition::Currencies->get_active;
+if ( $active_currency ) {
+    $template->param( symbol => $active_currency->symbol,
+                      currency => $active_currency->currency
+                   );
+}
 
-my $op = $input->param('op') // '';
+my $op = $input->param('op') || 'list';
 
-# see if the user want to see all budgets or only owned ones
-my $show_mine    = 1; #SHOW BY DEFAULT
-my $show         = $input->param('show') // 0; # SET TO 1, BY A FORM SUMBIT
-$show_mine       = $input->param('show_mine') if $show == 1;
+# see if the user want to see all budgets or only owned ones by default
+my $show_mine = $input->param('show_mine') // 0;
 
-# IF USER DOESNT HAVE PERM FOR AN 'ADD', THEN REDIRECT TO THE DEFAULT VIEW...
+# IF USER DOESN'T HAVE PERM FOR AN 'ADD', THEN REDIRECT TO THE DEFAULT VIEW...
 if (not defined $template->{VARS}->{'CAN_user_acquisition_budget_add_del'}
     and $op eq 'add_form')
 {
-    $op = '';
+    $op = 'list';
 }
-my $num=FormatNumber;
 
-my $script_name               = "/cgi-bin/koha/admin/aqbudgets.pl";
-my $budget_hash               = $input->Vars;
-my $budget_id                 = $$budget_hash{budget_id};
+# get only the columns of aqbudgets in budget_hash
+my @columns = Koha::Database->new()->schema->source('Aqbudget')->columns;
+my $budget_hash = { map { join(' ',@columns) =~ /$_/ ? ( $_ => scalar $input->param($_) )  : () } keys( %{$input->Vars()}) } ;
+
+my $budget_id                 = $input->param('budget_id');
+my $budget_period_id          = $input->param('budget_period_id');
 my $budget_permission         = $input->param('budget_permission');
+my $budget_users_ids          = $input->param('budget_users_ids');
 my $filter_budgetbranch       = $input->param('filter_budgetbranch') // '';
 my $filter_budgetname         = $input->param('filter_budgetname');
-#filtering non budget keys
-delete $$budget_hash{$_} foreach grep {/filter|^op$|show/} keys %$budget_hash;
 
-$template->param(
-    notree => ($filter_budgetbranch or $show_mine)
-);
+
 # ' ------- get periods stuff ------------------'
 # IF PERIODID IS DEFINED,  GET THE PERIOD - ELSE JUST GET THE ACTIVE PERIOD BY DEFAULT
-my $period = GetBudgetPeriod($$budget_hash{budget_period_id});
+my $period;
+if ( $budget_period_id ) {
+    $period = GetBudgetPeriod( $budget_period_id );
+}
 
-$template->param(
-       %$period
-);
 # ------- get periods stuff ------------------
 
 # USED FOR PERMISSION COMPARISON LATER
-my $borrower_id         = $template->{VARS}->{'USER_INFO'}[0]->{'borrowernumber'};
-my $user                = GetMemberDetails($borrower_id);
-my $user_branchcode     = $user->{'branchcode'};
+my $borrower_id         = $template->{VARS}->{'USER_INFO'}->{'borrowernumber'};
 
 $template->param(
-    action      => $script_name,
-    script_name => $script_name,
     show_mine   => $show_mine,
-    $op || else => 1,
+    op  => $op,
+    selected_branchcode => $filter_budgetbranch,
 );
 
+my $budget;
 
-# retrieve branches
-my ( $budget, );
-
-my $branches = GetBranches($show_mine);
-my @branchloop2;
-foreach my $thisbranch (keys %$branches) {
-    my %row = (
-        value      => $thisbranch,
-        branchname => $branches->{$thisbranch}->{'branchname'},
-    );
-    $row{selected} = 1 if $thisbranch eq $filter_budgetbranch;
-    push @branchloop2, \%row;
-}
-
-$template->param(auth_cats_loop => GetBudgetAuthCats($$period{budget_period_id}) );
+$template->param(auth_cats_loop => GetBudgetAuthCats( $budget_period_id ))
+    if $budget_period_id;
 
 # Used to create form to add or  modify a record
 if ($op eq 'add_form') {
@@ -135,9 +117,7 @@ if ($op eq 'add_form') {
             exit;
         }
         $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|encumb|expend/ } keys %$budget;
+        $budget->{budget_owner} = Koha::Patrons->find( $budget->{budget_owner_id} );
     }
 
     # build budget hierarchy
@@ -145,8 +125,7 @@ if ($op eq 'add_form') {
     my @values;
     my $hier = GetBudgetHierarchy($$period{budget_period_id});
     foreach my $r (@$hier) {
-        $r->{budget_code_indent} =~ s/&nbsp;/\~/g;    #
-        $labels{"$r->{budget_id}"} = $r->{budget_code_indent};
+        $labels{"$r->{budget_id}"} = $r->{budget_code};
         push @values, $r->{budget_id};
     }
     push @values, '';
@@ -160,36 +139,11 @@ if ($op eq 'add_form') {
     }
     $budget_parent = GetBudget($budget_parent_id);
 
-    # build branches select
-    my $branches = GetBranches;
-    my @branchloop_select;
-    foreach my $thisbranch ( sort keys %$branches ) {
-        my %row = (
-            value      => $thisbranch,
-            branchname => $branches->{$thisbranch}->{'branchname'},
-        );
-        $row{selected} = 1 if $thisbranch eq $budget->{'budget_branchcode'};
-        push @branchloop_select, \%row;
-    }
-    
-    # populates the YUI planning button
-    my $categories = GetAuthorisedValueCategories();
-    my @auth_cats_loop1 = ();
-    foreach my $category (@$categories) {
-        my $entry = { category => $category,
-                        selected => $budget->{sort1_authcat} eq $category ?1:0,
-                    };
-        push @auth_cats_loop1, $entry;
-    }
-    my @auth_cats_loop2 = ();
-    foreach my $category (@$categories) {
-        my $entry = { category => $category,
-                        selected => $budget->{sort2_authcat} eq $category ?1:0,
-                    };
-        push @auth_cats_loop2, $entry;
-    }
-    $template->param(authorised_value_categories1 => \@auth_cats_loop1);
-    $template->param(authorised_value_categories2 => \@auth_cats_loop2);
+    # populates the planning button
+    $template->param(
+        sort1_auth => $budget->{sort1_authcat},
+        sort2_auth => $budget->{sort2_authcat},
+    );
 
     if($budget->{'budget_permission'}){
         my $budget_permission = "budget_perm_".$budget->{'budget_permission'};
@@ -200,11 +154,10 @@ if ($op eq 'add_form') {
         my @budgetusers = GetBudgetUsers($budget->{budget_id});
         my @budgetusers_loop;
         foreach my $borrowernumber (@budgetusers) {
-            my $member = C4::Members::GetMember(
-                borrowernumber => $borrowernumber);
+            my $patron = Koha::Patrons->find( $borrowernumber );
             push @budgetusers_loop, {
-                firstname => $member->{firstname},
-                surname => $member->{surname},
+                firstname => $patron->firstname, # FIXME Should pass the patron object
+                surname => $patron->surname,
                 borrowernumber => $borrowernumber
             };
         }
@@ -216,10 +169,9 @@ if ($op eq 'add_form') {
 
     # if no buget_id is passed then its an add
     $template->param(
-        add_validate                  => 1,
+        budget_has_children => BudgetHasChildren( $budget->{budget_id} ),
         budget_parent_id                 => $budget_parent->{'budget_id'},
         budget_parent_name               => $budget_parent->{'budget_name'},
-        branchloop_select         => \@branchloop_select,
                %$period,
                %$budget,
     );
@@ -234,62 +186,72 @@ if ($op eq 'add_form') {
         budget_id     => $budget->{'budget_id'},
         budget_code   => $budget->{'budget_code'},
         budget_name   => $budget->{'budget_name'},
-        budget_amount => $num->format_price(  $budget->{'budget_amount'} ),
+        budget_amount => $budget->{'budget_amount'},
     );
                                                     # END $OP eq DELETE_CONFIRM
 # called by delete_confirm, used to effectively confirm deletion of data in DB
-}  else{
-    if ( $op eq 'delete_confirmed' ) {
-        my $rc = DelBudget($budget_id);
-    }elsif( $op eq 'add_validate' ) {
-        my @budgetusersid;
-        if (defined $$budget_hash{'budget_users_ids'}){
-            @budgetusersid = split(':', $budget_hash->{'budget_users_ids'});
-        }
+} elsif ( $op eq 'delete_confirmed' ) {
+    if ( BudgetHasChildren( $budget_id ) ) {
+        # We should never be here, the interface does not provide this action.
+        die("Delete a fund with children is not possible");
+    }
+    my $rc = DelBudget($budget_id);
+    $op = 'list';
+} elsif( $op eq 'add_validate' ) {
+    my @budgetusersid;
+    if (defined $budget_users_ids){
+        @budgetusersid = split(':', $budget_users_ids);
+    }
 
-        if ( defined $$budget_hash{budget_id} ) {
-            if (CanUserModifyBudget($borrowernumber, $budget_hash->{budget_id},
-                $staffflags)
-            ) {
-                ModBudget( $budget_hash );
-                ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
-            }
-            else {
-                $template->param(error_not_authorised_to_modify => 1);
-            }
-        } else {
-            AddBudget( $budget_hash );
+    my $budget_modified = 0;
+    if (defined $budget_id) {
+        if (CanUserModifyBudget($borrowernumber, $budget_hash->{budget_id},
+            $staffflags)
+        ) {
+            ModBudget( $budget_hash );
             ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
+            $budget_modified = 1;
+        }
+        else {
+            $template->param(error_not_authorised_to_modify => 1);
         }
+    } else {
+        $budget_hash->{budget_id} = AddBudget( $budget_hash );
+        ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
+        $budget_modified = 1;
     }
-    my $branches = GetBranches();
+
+    my $set_owner_to_children = $input->param('set_owner_to_children');
+    if ( $set_owner_to_children and $budget_modified ) {
+        C4::Budgets::SetOwnerToFundHierarchy( $budget_hash->{budget_id}, $budget_hash->{budget_owner_id} );
+    }
+    $op = 'list';
+}
+
+if ( $op eq 'list' ) {
     $template->param(
-        budget_id                 => $budget_id,
+        budget_id => $budget_id,
         %$period,
     );
 
     my @budgets = @{
-        GetBudgetHierarchy($$period{budget_period_id},
-            C4::Context->userenv->{branchcode}, $show_mine ? $borrower_id : '')
+        GetBudgetHierarchy( $$period{budget_period_id}, undef, ( $show_mine ? $borrower_id : 0 ))
     };
 
-    my $toggle = 0;
-    my @loop;
     my $period_total = 0;
-    my ( $period_alloc_total, $base_spent_total );
+    my ($period_alloc_total, $spent_total, $ordered_total, $available_total) = (0,0,0,0);
 
        #This Looks WEIRD to me : should budgets be filtered in such a way ppl who donot own it would not see the amount spent on the budget by others ?
 
+    my @budgets_to_display;
     foreach my $budget (@budgets) {
-        #Level and sublevels total spent
-        $budget->{'total_levels_spent'} = GetChildBudgetsSpent($budget->{"budget_id"});
-
         # PERMISSIONS
+        next unless CanUserUseBudget($borrowernumber, $budget, $staffflags);
         unless(CanUserModifyBudget($borrowernumber, $budget, $staffflags)) {
             $budget->{'budget_lock'} = 1;
         }
 
-        # if a budget search doesnt match, next
+        # if a budget search doesn't match, next
         if ($filter_budgetname) {
             next
               unless $budget->{budget_code} =~ m/$filter_budgetname/i
@@ -300,28 +262,24 @@ if ($op eq 'add_form') {
         }
 
 ## TOTALS
+        $budget->{'budget_remaining'} = $budget->{'budget_amount'} - $budget->{'budget_spent'} - $budget->{budget_ordered};
+        $budget->{'total_remaining'} = $budget->{'budget_amount'} - $budget->{'total_spent'} - $budget->{total_ordered};
         # adds to total  - only if budget is a 'top-level' budget
-        $period_alloc_total += $budget->{'budget_amount_total'} if $budget->{'depth'} == 0;
-        $base_spent_total += $budget->{'budget_spent'};
-        $budget->{'budget_remaining'} = $budget->{'budget_amount'} - $budget->{'total_levels_spent'};
+        unless ( defined $budget->{budget_parent_id} ) {
+            $period_alloc_total += $budget->{'budget_amount'};
+            $spent_total += $budget->{total_spent};
+            $ordered_total += $budget->{total_ordered};
+            $available_total += $budget->{total_remaining};
+        }
 
-# if amount == 0 dont display...
+# if amount == 0 don't display...
         delete $budget->{'budget_unalloc_sublevel'}
             if (!defined $budget->{'budget_unalloc_sublevel'}
             or $budget->{'budget_unalloc_sublevel'} == 0);
 
-        $budget->{'remaining_pos'} = 1 if $budget->{'budget_remaining'} > 0;
-        $budget->{'remaining_neg'} = 1 if $budget->{'budget_remaining'} < 0;
-               for (grep {/total_levels_spent|budget_spent|budget_amount|budget_remaining|budget_unalloc/} keys %$budget){
-            $budget->{$_}               = $num->format_price( $budget->{$_} ) if defined($budget->{$_})
-               }
-
         # Value of budget_spent equals 0 instead of undefined value
-        $budget->{"budget_spent"} = $num->format_price(0) unless defined($budget->{"budget_spent"});
-
-        my $borrower = &GetMember( borrowernumber=>$budget->{budget_owner_id} );
-        $budget->{"budget_owner_name"}     = $borrower->{'firstname'} . ' ' . $borrower->{'surname'};
-        $budget->{"budget_borrowernumber"} = $borrower->{'borrowernumber'};
+        $budget->{budget_spent} = 0 unless defined($budget->{budget_spent});
+        $budget->{budget_ordered} = 0 unless defined($budget->{budget_ordered});
 
         #Make a list of parents of the bugdet
         my @budget_hierarchy;
@@ -335,36 +293,28 @@ if ($op eq 'add_form') {
         push  @budget_hierarchy, { element_name => $period->{"budget_period_description"} };
         @budget_hierarchy = reverse(@budget_hierarchy);
 
-        push( @loop, {  %{$budget},
-                        branchname  => $branches->{ $budget->{branchcode} }->{branchname},
-                        budget_hierarchy => \@budget_hierarchy,
-                    }
-        );
-    }
+        $budget->{budget_hierarchy} = \@budget_hierarchy;
 
-    my $budget_period_total;
-    if ( $period->{budget_period_total} ) {
-        $budget_period_total =
-          $num->format_price( $period->{budget_period_total} );
+        $budget->{budget_has_children} = BudgetHasChildren( $budget->{budget_id} );
+        push @budgets_to_display, $budget;
     }
 
-    if ($period_alloc_total) {
-        $period_alloc_total = $num->format_price($period_alloc_total);
-    }
+    my $budget_period_total = $period->{budget_period_total};
 
-    if ($base_spent_total) {
-        $base_spent_total = $num->format_price($base_spent_total);
-    }
+    my $periods = GetBudgetPeriods();
 
     $template->param(
-        else                   => 1,
-        budget                 => \@loop,
+        op                     => 'list',
+        budgets                => \@budgets_to_display,
+        periods                => $periods,
         budget_period_total    => $budget_period_total,
         period_alloc_total     => $period_alloc_total,
-        base_spent_total       => $base_spent_total,
-        branchloop             => \@branchloop2,
+        spent_total            => $spent_total,
+        ordered_total          => $ordered_total,
+        available_total        => $available_total,
+        filter_budgetname      => $filter_budgetname,
     );
 
-} #---- END $OP eq DEFAULT
+} #---- END list
 
 output_html_with_http_headers $input, $cookie, $template->output;