admin/aqbudgets.pl

   1 #!/usr/bin/perl
   2
   3 #script to administer the aqbudget table
   4
   5 # Copyright 2008-2009 BibLibre SARL
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it
  10 # under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  21
  22 use Modern::Perl;
  23
  24 use CGI qw ( -utf8 );
  25 use List::Util qw/min/;
  26
  27 use Koha::Database;
  28 use C4::Auth qw/get_user_subpermissions/;
  29 use C4::Auth;
  30 use C4::Acquisition;
  31 use C4::Budgets;
  32 use C4::Members;  # calls GetSortDetails()
  33 use C4::Context;
  34 use C4::Output;
  35 use C4::Koha;
  36 use C4::Debug;
  37 use Koha::Acquisition::Currencies;
  38
  39 my $input = new CGI;
  40 my $dbh     = C4::Context->dbh;
  41
  42 my ($template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
  43     {   template_name   => "admin/aqbudgets.tt",
  44         query           => $input,
  45         type            => "intranet",
  46         authnotrequired => 0,
  47         flagsrequired   => { acquisition => 'budget_manage' },
  48         debug           => 0,
  49     }
  50 );
  51
  52 my $active_currency = Koha::Acquisition::Currencies->get_active;
  53 $template->param( symbol => $active_currency->symbol,
  54                   currency => $active_currency->currency
  55                );
  56
  57 my $op = $input->param('op') || 'list';
  58
  59 # see if the user want to see all budgets or only owned ones by default
  60 my $show_mine = $input->param('show_mine') // 0;
  61
  62 # IF USER DOESN'T HAVE PERM FOR AN 'ADD', THEN REDIRECT TO THE DEFAULT VIEW...
  63 if (not defined $template->{VARS}->{'CAN_user_acquisition_budget_add_del'}
  64     and $op eq 'add_form')
  65 {
  66     $op = 'list';
  67 }
  68
  69 # get only the columns of aqbudgets in budget_hash
  70 my @columns = Koha::Database->new()->schema->source('Aqbudget')->columns;
  71 my $budget_hash = { map { join(' ',@columns) =~ /$_/ ? ( $_ => scalar $input->param($_) )  : () } keys( %{$input->Vars()}) } ;
  72
  73 my $budget_id                 = $input->param('budget_id');
  74 my $budget_period_id          = $input->param('budget_period_id');
  75 my $budget_permission         = $input->param('budget_permission');
  76 my $budget_users_ids          = $input->param('budget_users_ids');
  77 my $filter_budgetbranch       = $input->param('filter_budgetbranch') // '';
  78 my $filter_budgetname         = $input->param('filter_budgetname');
  79
  80
  81 # ' ------- get periods stuff ------------------'
  82 # IF PERIODID IS DEFINED,  GET THE PERIOD - ELSE JUST GET THE ACTIVE PERIOD BY DEFAULT
  83 my $period;
  84 if ( $budget_period_id ) {
  85     $period = GetBudgetPeriod( $budget_period_id );
  86 }
  87
  88 # ------- get periods stuff ------------------
  89
  90 # USED FOR PERMISSION COMPARISON LATER
  91 my $borrower_id         = $template->{VARS}->{'USER_INFO'}->{'borrowernumber'};
  92 my $user                = C4::Members::GetMember( borrowernumber => $borrower_id );
  93 my $user_branchcode     = $user->{'branchcode'};
  94
  95 $template->param(
  96     show_mine   => $show_mine,
  97     op  => $op,
  98     selected_branchcode => $filter_budgetbranch,
  99 );
 100
 101 my $budget;
 102
 103 $template->param(auth_cats_loop => GetBudgetAuthCats( $budget_period_id ))
 104     if $budget_period_id;
 105
 106 # Used to create form to add or  modify a record
 107 if ($op eq 'add_form') {
 108 #### ------------------- ADD_FORM -------------------------
 109     # if no buget_id is passed then its an add
 110     #  pass the period_id to build the dropbox - because we only want to show  budgets from this period
 111     my $dropbox_disabled;
 112     if (defined $budget_id ) {    ### MOD
 113         $budget = GetBudget($budget_id);
 114         if (!CanUserModifyBudget($borrowernumber, $budget, $staffflags)) {
 115             $template->param(error_not_authorised_to_modify => 1);
 116             output_html_with_http_headers $input, $cookie, $template->output;
 117             exit;
 118         }
 119         $dropbox_disabled = BudgetHasChildren($budget_id);
 120         my $borrower = &GetMember( borrowernumber=>$budget->{budget_owner_id} );
 121         $budget->{budget_owner_name} = ( $borrower ? $borrower->{'firstname'} . ' ' . $borrower->{'surname'} : '' );
 122     }
 123
 124     # build budget hierarchy
 125     my %labels;
 126     my @values;
 127     my $hier = GetBudgetHierarchy($$period{budget_period_id});
 128     foreach my $r (@$hier) {
 129         $labels{"$r->{budget_id}"} = $r->{budget_code};
 130         push @values, $r->{budget_id};
 131     }
 132     push @values, '';
 133     # if no buget_id is passed then its an add
 134     my $budget_parent;
 135     my $budget_parent_id;
 136     if ($budget){
 137         $budget_parent_id = $budget->{'budget_parent_id'} ;
 138     }else{
 139         $budget_parent_id = $input->param('budget_parent_id');
 140     }
 141     $budget_parent = GetBudget($budget_parent_id);
 142
 143     # populates the YUI planning button
 144     my $categories = GetAuthorisedValueCategories();
 145     my @auth_cats_loop1 = ();
 146     foreach my $category (@$categories) {
 147         my $entry = { category => $category,
 148                         selected => ( $budget and $budget->{sort1_authcat} eq $category ? 1 : 0 ),
 149                     };
 150         push @auth_cats_loop1, $entry;
 151     }
 152     my @auth_cats_loop2 = ();
 153     foreach my $category (@$categories) {
 154         my $entry = { category => $category,
 155                         selected => ( $budget and $budget->{sort2_authcat} eq $category ? 1 : 0 ),
 156                     };
 157         push @auth_cats_loop2, $entry;
 158     }
 159     $template->param(authorised_value_categories1 => \@auth_cats_loop1);
 160     $template->param(authorised_value_categories2 => \@auth_cats_loop2);
 161
 162     if($budget->{'budget_permission'}){
 163         my $budget_permission = "budget_perm_".$budget->{'budget_permission'};
 164         $template->param($budget_permission => 1);
 165     }
 166
 167     if ($budget) {
 168         my @budgetusers = GetBudgetUsers($budget->{budget_id});
 169         my @budgetusers_loop;
 170         foreach my $borrowernumber (@budgetusers) {
 171             my $member = C4::Members::GetMember(
 172                 borrowernumber => $borrowernumber);
 173             push @budgetusers_loop, {
 174                 firstname => $member->{firstname},
 175                 surname => $member->{surname},
 176                 borrowernumber => $borrowernumber
 177             };
 178         }
 179         $template->param(
 180             budget_users => \@budgetusers_loop,
 181             budget_users_ids => join ':', @budgetusers
 182         );
 183     }
 184
 185     # if no buget_id is passed then its an add
 186     $template->param(
 187         budget_has_children => BudgetHasChildren( $budget->{budget_id} ),
 188         budget_parent_id                  => $budget_parent->{'budget_id'},
 189         budget_parent_name                => $budget_parent->{'budget_name'},
 190                 %$period,
 191                 %$budget,
 192     );
 193                                                     # END $OP eq ADD_FORM
 194 #---------------------- DEFAULT DISPLAY BELOW ---------------------
 195
 196 # called by default form, used to confirm deletion of data in DB
 197 } elsif ($op eq 'delete_confirm') {
 198
 199     my $budget = GetBudget($budget_id);
 200     $template->param(
 201         budget_id     => $budget->{'budget_id'},
 202         budget_code   => $budget->{'budget_code'},
 203         budget_name   => $budget->{'budget_name'},
 204         budget_amount => $budget->{'budget_amount'},
 205     );
 206                                                     # END $OP eq DELETE_CONFIRM
 207 # called by delete_confirm, used to effectively confirm deletion of data in DB
 208 } elsif ( $op eq 'delete_confirmed' ) {
 209     if ( BudgetHasChildren( $budget_id ) ) {
 210         # We should never be here, the interface does not provide this action.
 211         die("Delete a fund with children is not possible");
 212     }
 213     my $rc = DelBudget($budget_id);
 214     $op = 'list';
 215 } elsif( $op eq 'add_validate' ) {
 216     my @budgetusersid;
 217     if (defined $budget_users_ids){
 218         @budgetusersid = split(':', $budget_users_ids);
 219     }
 220
 221     my $budget_modified = 0;
 222     if (defined $budget_id) {
 223         if (CanUserModifyBudget($borrowernumber, $budget_hash->{budget_id},
 224             $staffflags)
 225         ) {
 226             ModBudget( $budget_hash );
 227             ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
 228             $budget_modified = 1;
 229         }
 230         else {
 231             $template->param(error_not_authorised_to_modify => 1);
 232         }
 233     } else {
 234         $budget_hash->{budget_id} = AddBudget( $budget_hash );
 235         ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
 236         $budget_modified = 1;
 237     }
 238
 239     my $set_owner_to_children = $input->param('set_owner_to_children');
 240     if ( $set_owner_to_children and $budget_modified ) {
 241         C4::Budgets::SetOwnerToFundHierarchy( $budget_hash->{budget_id}, $budget_hash->{budget_owner_id} );
 242     }
 243     $op = 'list';
 244 }
 245
 246 if ( $op eq 'list' ) {
 247     $template->param(
 248         budget_id => $budget_id,
 249         %$period,
 250     );
 251
 252     my @budgets = @{
 253         GetBudgetHierarchy($$period{budget_period_id},
 254             C4::Context->userenv->{branchcode}, $show_mine ? $borrower_id : '')
 255     };
 256
 257     my $period_total = 0;
 258     my ($period_alloc_total, $spent_total, $ordered_total, $available_total) = (0,0,0,0);
 259
 260         #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 ?
 261
 262     my @budgets_to_display;
 263     foreach my $budget (@budgets) {
 264         # PERMISSIONS
 265         unless(CanUserModifyBudget($borrowernumber, $budget, $staffflags)) {
 266             $budget->{'budget_lock'} = 1;
 267         }
 268
 269         # if a budget search doesn't match, next
 270         if ($filter_budgetname) {
 271             next
 272               unless $budget->{budget_code} =~ m/$filter_budgetname/i
 273                   || $budget->{budget_name} =~ m/$filter_budgetname/i;
 274         }
 275         if ($filter_budgetbranch ) {
 276             next unless  $budget->{budget_branchcode} eq $filter_budgetbranch;
 277         }
 278
 279 ## TOTALS
 280         $budget->{'budget_remaining'} = $budget->{'budget_amount'} - $budget->{'budget_spent'} - $budget->{budget_ordered};
 281         $budget->{'total_remaining'} = $budget->{'budget_amount'} - $budget->{'total_spent'} - $budget->{total_ordered};
 282         # adds to total  - only if budget is a 'top-level' budget
 283         unless ( defined $budget->{budget_parent_id} ) {
 284             $period_alloc_total += $budget->{'budget_amount'};
 285             $spent_total += $budget->{total_spent};
 286             $ordered_total += $budget->{total_ordered};
 287             $available_total += $budget->{total_remaining};
 288         }
 289
 290 # if amount == 0 don't display...
 291         delete $budget->{'budget_unalloc_sublevel'}
 292             if (!defined $budget->{'budget_unalloc_sublevel'}
 293             or $budget->{'budget_unalloc_sublevel'} == 0);
 294
 295         # Value of budget_spent equals 0 instead of undefined value
 296         $budget->{budget_spent} = 0 unless defined($budget->{budget_spent});
 297         $budget->{budget_ordered} = 0 unless defined($budget->{budget_ordered});
 298
 299         #Make a list of parents of the bugdet
 300         my @budget_hierarchy;
 301         push  @budget_hierarchy, { element_name => $budget->{"budget_name"}, element_id => $budget->{"budget_id"} };
 302         my $parent_id = $budget->{"budget_parent_id"};
 303         while ($parent_id) {
 304             my $parent = GetBudget($parent_id);
 305             push @budget_hierarchy, { element_name => $parent->{"budget_name"}, element_id => $parent->{"budget_id"} };
 306             $parent_id = $parent->{"budget_parent_id"};
 307         }
 308         push  @budget_hierarchy, { element_name => $period->{"budget_period_description"} };
 309         @budget_hierarchy = reverse(@budget_hierarchy);
 310
 311         $budget->{budget_hierarchy} = \@budget_hierarchy;
 312
 313         $budget->{budget_has_children} = BudgetHasChildren( $budget->{budget_id} );
 314         push @budgets_to_display, $budget;
 315     }
 316
 317     my $budget_period_total = $period->{budget_period_total};
 318
 319     my $periods = GetBudgetPeriods();
 320
 321     $template->param(
 322         op                     => 'list',
 323         budgets                => \@budgets_to_display,
 324         periods                => $periods,
 325         budget_period_total    => $budget_period_total,
 326         period_alloc_total     => $period_alloc_total,
 327         spent_total            => $spent_total,
 328         ordered_total          => $ordered_total,
 329         available_total        => $available_total,
 330         filter_budgetname      => $filter_budgetname,
 331     );
 332
 333 } #---- END list
 334
 335 output_html_with_http_headers $input, $cookie, $template->output;