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::Context;
  33 use C4::Output;
  34 use C4::Koha;
  35 use C4::Debug;
  36 use Koha::Acquisition::Currencies;
  37 use Koha::Patrons;
  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 if ( $active_currency ) {
  54     $template->param( symbol => $active_currency->symbol,
  55                       currency => $active_currency->currency
  56                    );
  57 }
  58
  59 my $op = $input->param('op') || 'list';
  60
  61 # see if the user want to see all budgets or only owned ones by default
  62 my $show_mine = $input->param('show_mine') // 0;
  63
  64 # IF USER DOESN'T HAVE PERM FOR AN 'ADD', THEN REDIRECT TO THE DEFAULT VIEW...
  65 if (not defined $template->{VARS}->{'CAN_user_acquisition_budget_add_del'}
  66     and $op eq 'add_form')
  67 {
  68     $op = 'list';
  69 }
  70
  71 # get only the columns of aqbudgets in budget_hash
  72 my @columns = Koha::Database->new()->schema->source('Aqbudget')->columns;
  73 my $budget_hash = { map { join(' ',@columns) =~ /$_/ ? ( $_ => scalar $input->param($_) )  : () } keys( %{$input->Vars()}) } ;
  74
  75 my $budget_id                 = $input->param('budget_id');
  76 my $budget_period_id          = $input->param('budget_period_id');
  77 my $budget_permission         = $input->param('budget_permission');
  78 my $budget_users_ids          = $input->param('budget_users_ids');
  79 my $filter_budgetbranch       = $input->param('filter_budgetbranch') // '';
  80 my $filter_budgetname         = $input->param('filter_budgetname');
  81
  82
  83 # ' ------- get periods stuff ------------------'
  84 # IF PERIODID IS DEFINED,  GET THE PERIOD - ELSE JUST GET THE ACTIVE PERIOD BY DEFAULT
  85 my $period;
  86 if ( $budget_period_id ) {
  87     $period = GetBudgetPeriod( $budget_period_id );
  88 }
  89
  90 # ------- get periods stuff ------------------
  91
  92 $template->param(
  93     show_mine   => $show_mine,
  94     op  => $op,
  95     selected_branchcode => $filter_budgetbranch,
  96 );
  97
  98 my $budget;
  99
 100 $template->param(auth_cats_loop => GetBudgetAuthCats( $budget_period_id ))
 101     if $budget_period_id;
 102
 103 # Used to create form to add or  modify a record
 104 if ($op eq 'add_form') {
 105 #### ------------------- ADD_FORM -------------------------
 106     # if no buget_id is passed then its an add
 107     #  pass the period_id to build the dropbox - because we only want to show  budgets from this period
 108     my $dropbox_disabled;
 109     if (defined $budget_id ) {    ### MOD
 110         $budget = GetBudget($budget_id);
 111         if (!CanUserModifyBudget($borrowernumber, $budget, $staffflags)) {
 112             $template->param(error_not_authorised_to_modify => 1);
 113             output_html_with_http_headers $input, $cookie, $template->output;
 114             exit;
 115         }
 116         $dropbox_disabled = BudgetHasChildren($budget_id);
 117         $budget->{budget_owner} = Koha::Patrons->find( $budget->{budget_owner_id} );
 118     }
 119
 120     # build budget hierarchy
 121     my %labels;
 122     my @values;
 123     my $hier = GetBudgetHierarchy($$period{budget_period_id});
 124     foreach my $r (@$hier) {
 125         $labels{"$r->{budget_id}"} = $r->{budget_code};
 126         push @values, $r->{budget_id};
 127     }
 128     push @values, '';
 129     # if no buget_id is passed then its an add
 130     my $budget_parent;
 131     my $budget_parent_id;
 132     if ($budget){
 133         $budget_parent_id = $budget->{'budget_parent_id'} ;
 134     }else{
 135         $budget_parent_id = $input->param('budget_parent_id');
 136     }
 137     $budget_parent = GetBudget($budget_parent_id);
 138
 139     # populates the planning button
 140     $template->param(
 141         sort1_auth => $budget->{sort1_authcat},
 142         sort2_auth => $budget->{sort2_authcat},
 143     );
 144
 145     if($budget->{'budget_permission'}){
 146         my $budget_permission = "budget_perm_".$budget->{'budget_permission'};
 147         $template->param($budget_permission => 1);
 148     }
 149
 150     if ($budget) {
 151         my @budgetusers = GetBudgetUsers($budget->{budget_id});
 152         my @budgetusers_loop;
 153         foreach my $borrowernumber (@budgetusers) {
 154             my $patron = Koha::Patrons->find( $borrowernumber );
 155             push @budgetusers_loop, {
 156                 firstname => $patron->firstname, # FIXME Should pass the patron object
 157                 surname => $patron->surname,
 158                 borrowernumber => $borrowernumber
 159             };
 160         }
 161         $template->param(
 162             budget_users => \@budgetusers_loop,
 163             budget_users_ids => join ':', @budgetusers
 164         );
 165     }
 166
 167     # if no buget_id is passed then its an add
 168     $template->param(
 169         budget_has_children => BudgetHasChildren( $budget->{budget_id} ),
 170         budget_parent_id                  => $budget_parent->{'budget_id'},
 171         budget_parent_name                => $budget_parent->{'budget_name'},
 172                 %$period,
 173                 %$budget,
 174     );
 175                                                     # END $OP eq ADD_FORM
 176 #---------------------- DEFAULT DISPLAY BELOW ---------------------
 177
 178 # called by default form, used to confirm deletion of data in DB
 179 } elsif ($op eq 'delete_confirm') {
 180
 181     my $budget = GetBudget($budget_id);
 182     $template->param(
 183         budget_id     => $budget->{'budget_id'},
 184         budget_code   => $budget->{'budget_code'},
 185         budget_name   => $budget->{'budget_name'},
 186         budget_amount => $budget->{'budget_amount'},
 187     );
 188                                                     # END $OP eq DELETE_CONFIRM
 189 # called by delete_confirm, used to effectively confirm deletion of data in DB
 190 } elsif ( $op eq 'delete_confirmed' ) {
 191     if ( BudgetHasChildren( $budget_id ) ) {
 192         # We should never be here, the interface does not provide this action.
 193         die("Delete a fund with children is not possible");
 194     }
 195     my $rc = DelBudget($budget_id);
 196     $op = 'list';
 197 } elsif( $op eq 'add_validate' ) {
 198     my @budgetusersid;
 199     if (defined $budget_users_ids){
 200         @budgetusersid = split(':', $budget_users_ids);
 201     }
 202
 203     my $budget_modified = 0;
 204     if (defined $budget_id) {
 205         if (CanUserModifyBudget($borrowernumber, $budget_hash->{budget_id},
 206             $staffflags)
 207         ) {
 208             ModBudget( $budget_hash );
 209             ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
 210             $budget_modified = 1;
 211         }
 212         else {
 213             $template->param(error_not_authorised_to_modify => 1);
 214         }
 215     } else {
 216         $budget_hash->{budget_id} = AddBudget( $budget_hash );
 217         ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
 218         $budget_modified = 1;
 219     }
 220
 221     my $set_owner_to_children = $input->param('set_owner_to_children');
 222     if ( $set_owner_to_children and $budget_modified ) {
 223         C4::Budgets::SetOwnerToFundHierarchy( $budget_hash->{budget_id}, $budget_hash->{budget_owner_id} );
 224     }
 225     $op = 'list';
 226 }
 227
 228 if ( $op eq 'list' ) {
 229     $template->param(
 230         budget_id => $budget_id,
 231         %$period,
 232     );
 233
 234     my @budgets = @{
 235         GetBudgetHierarchy( $$period{budget_period_id}, undef, ( $show_mine ? $borrowernumber : 0 ))
 236     };
 237
 238     my $period_total = 0;
 239     my ($period_alloc_total, $spent_total, $ordered_total, $available_total) = (0,0,0,0);
 240
 241         #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 ?
 242
 243     my @budgets_to_display;
 244     foreach my $budget (@budgets) {
 245         # PERMISSIONS
 246         next unless CanUserUseBudget($borrowernumber, $budget, $staffflags);
 247         unless(CanUserModifyBudget($borrowernumber, $budget, $staffflags)) {
 248             $budget->{'budget_lock'} = 1;
 249         }
 250
 251         # if a budget search doesn't match, next
 252         if ($filter_budgetname) {
 253             next
 254               unless $budget->{budget_code} =~ m/$filter_budgetname/i
 255                   || $budget->{budget_name} =~ m/$filter_budgetname/i;
 256         }
 257         if ($filter_budgetbranch ) {
 258             next unless  $budget->{budget_branchcode} eq $filter_budgetbranch;
 259         }
 260
 261 ## TOTALS
 262         $budget->{'budget_remaining'} = $budget->{'budget_amount'} - $budget->{'budget_spent'} - $budget->{budget_ordered};
 263         $budget->{'total_remaining'} = $budget->{'budget_amount'} - $budget->{'total_spent'} - $budget->{total_ordered};
 264         # adds to total  - only if budget is a 'top-level' budget
 265         unless ( defined $budget->{budget_parent_id} ) {
 266             $period_alloc_total += $budget->{'budget_amount'};
 267             $spent_total += $budget->{total_spent};
 268             $ordered_total += $budget->{total_ordered};
 269             $available_total += $budget->{total_remaining};
 270         }
 271
 272 # if amount == 0 don't display...
 273         delete $budget->{'budget_unalloc_sublevel'}
 274             if (!defined $budget->{'budget_unalloc_sublevel'}
 275             or $budget->{'budget_unalloc_sublevel'} == 0);
 276
 277         # Value of budget_spent equals 0 instead of undefined value
 278         $budget->{budget_spent} = 0 unless defined($budget->{budget_spent});
 279         $budget->{budget_ordered} = 0 unless defined($budget->{budget_ordered});
 280
 281         #Make a list of parents of the bugdet
 282         my @budget_hierarchy;
 283         push  @budget_hierarchy, { element_name => $budget->{"budget_name"}, element_id => $budget->{"budget_id"} };
 284         my $parent_id = $budget->{"budget_parent_id"};
 285         while ($parent_id) {
 286             my $parent = GetBudget($parent_id);
 287             push @budget_hierarchy, { element_name => $parent->{"budget_name"}, element_id => $parent->{"budget_id"} };
 288             $parent_id = $parent->{"budget_parent_id"};
 289         }
 290         push  @budget_hierarchy, { element_name => $period->{"budget_period_description"} };
 291         @budget_hierarchy = reverse(@budget_hierarchy);
 292
 293         $budget->{budget_hierarchy} = \@budget_hierarchy;
 294
 295         $budget->{budget_has_children} = BudgetHasChildren( $budget->{budget_id} );
 296         push @budgets_to_display, $budget;
 297     }
 298
 299     my $budget_period_total = $period->{budget_period_total};
 300
 301     my $periods = GetBudgetPeriods();
 302
 303     $template->param(
 304         op                     => 'list',
 305         budgets                => \@budgets_to_display,
 306         periods                => $periods,
 307         budget_period_total    => $budget_period_total,
 308         period_alloc_total     => $period_alloc_total,
 309         spent_total            => $spent_total,
 310         ordered_total          => $ordered_total,
 311         available_total        => $available_total,
 312         filter_budgetname      => $filter_budgetname,
 313     );
 314
 315 } #---- END list
 316
 317 output_html_with_http_headers $input, $cookie, $template->output;