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 # USED FOR PERMISSION COMPARISON LATER
  93 my $borrower_id         = $template->{VARS}->{'USER_INFO'}->{'borrowernumber'};
  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 $patron = Koha::Patrons->find( $budget->{budget_owner_id} );
 121         $budget->{budget_owner_name} = ( $patron ? $patron->firstname . ' ' . $patron->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 planning button
 144     $template->param(
 145         sort1_auth => $budget->{sort1_authcat},
 146         sort2_auth => $budget->{sort2_authcat},
 147     );
 148
 149     if($budget->{'budget_permission'}){
 150         my $budget_permission = "budget_perm_".$budget->{'budget_permission'};
 151         $template->param($budget_permission => 1);
 152     }
 153
 154     if ($budget) {
 155         my @budgetusers = GetBudgetUsers($budget->{budget_id});
 156         my @budgetusers_loop;
 157         foreach my $borrowernumber (@budgetusers) {
 158             my $patron = Koha::Patrons->find( $borrowernumber );
 159             push @budgetusers_loop, {
 160                 firstname => $patron->firstname, # FIXME Should pass the patron object
 161                 surname => $patron->surname,
 162                 borrowernumber => $borrowernumber
 163             };
 164         }
 165         $template->param(
 166             budget_users => \@budgetusers_loop,
 167             budget_users_ids => join ':', @budgetusers
 168         );
 169     }
 170
 171     # if no buget_id is passed then its an add
 172     $template->param(
 173         budget_has_children => BudgetHasChildren( $budget->{budget_id} ),
 174         budget_parent_id                  => $budget_parent->{'budget_id'},
 175         budget_parent_name                => $budget_parent->{'budget_name'},
 176                 %$period,
 177                 %$budget,
 178     );
 179                                                     # END $OP eq ADD_FORM
 180 #---------------------- DEFAULT DISPLAY BELOW ---------------------
 181
 182 # called by default form, used to confirm deletion of data in DB
 183 } elsif ($op eq 'delete_confirm') {
 184
 185     my $budget = GetBudget($budget_id);
 186     $template->param(
 187         budget_id     => $budget->{'budget_id'},
 188         budget_code   => $budget->{'budget_code'},
 189         budget_name   => $budget->{'budget_name'},
 190         budget_amount => $budget->{'budget_amount'},
 191     );
 192                                                     # END $OP eq DELETE_CONFIRM
 193 # called by delete_confirm, used to effectively confirm deletion of data in DB
 194 } elsif ( $op eq 'delete_confirmed' ) {
 195     if ( BudgetHasChildren( $budget_id ) ) {
 196         # We should never be here, the interface does not provide this action.
 197         die("Delete a fund with children is not possible");
 198     }
 199     my $rc = DelBudget($budget_id);
 200     $op = 'list';
 201 } elsif( $op eq 'add_validate' ) {
 202     my @budgetusersid;
 203     if (defined $budget_users_ids){
 204         @budgetusersid = split(':', $budget_users_ids);
 205     }
 206
 207     my $budget_modified = 0;
 208     if (defined $budget_id) {
 209         if (CanUserModifyBudget($borrowernumber, $budget_hash->{budget_id},
 210             $staffflags)
 211         ) {
 212             ModBudget( $budget_hash );
 213             ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
 214             $budget_modified = 1;
 215         }
 216         else {
 217             $template->param(error_not_authorised_to_modify => 1);
 218         }
 219     } else {
 220         $budget_hash->{budget_id} = AddBudget( $budget_hash );
 221         ModBudgetUsers($budget_hash->{budget_id}, @budgetusersid);
 222         $budget_modified = 1;
 223     }
 224
 225     my $set_owner_to_children = $input->param('set_owner_to_children');
 226     if ( $set_owner_to_children and $budget_modified ) {
 227         C4::Budgets::SetOwnerToFundHierarchy( $budget_hash->{budget_id}, $budget_hash->{budget_owner_id} );
 228     }
 229     $op = 'list';
 230 }
 231
 232 if ( $op eq 'list' ) {
 233     $template->param(
 234         budget_id => $budget_id,
 235         %$period,
 236     );
 237
 238     my @budgets = @{
 239         GetBudgetHierarchy( $$period{budget_period_id}, undef, ( $show_mine ? $borrower_id : 0 ))
 240     };
 241
 242     my $period_total = 0;
 243     my ($period_alloc_total, $spent_total, $ordered_total, $available_total) = (0,0,0,0);
 244
 245         #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 ?
 246
 247     my @budgets_to_display;
 248     foreach my $budget (@budgets) {
 249         # PERMISSIONS
 250         next unless CanUserUseBudget($borrowernumber, $budget, $staffflags);
 251         unless(CanUserModifyBudget($borrowernumber, $budget, $staffflags)) {
 252             $budget->{'budget_lock'} = 1;
 253         }
 254
 255         # if a budget search doesn't match, next
 256         if ($filter_budgetname) {
 257             next
 258               unless $budget->{budget_code} =~ m/$filter_budgetname/i
 259                   || $budget->{budget_name} =~ m/$filter_budgetname/i;
 260         }
 261         if ($filter_budgetbranch ) {
 262             next unless  $budget->{budget_branchcode} eq $filter_budgetbranch;
 263         }
 264
 265 ## TOTALS
 266         $budget->{'budget_remaining'} = $budget->{'budget_amount'} - $budget->{'budget_spent'} - $budget->{budget_ordered};
 267         $budget->{'total_remaining'} = $budget->{'budget_amount'} - $budget->{'total_spent'} - $budget->{total_ordered};
 268         # adds to total  - only if budget is a 'top-level' budget
 269         unless ( defined $budget->{budget_parent_id} ) {
 270             $period_alloc_total += $budget->{'budget_amount'};
 271             $spent_total += $budget->{total_spent};
 272             $ordered_total += $budget->{total_ordered};
 273             $available_total += $budget->{total_remaining};
 274         }
 275
 276 # if amount == 0 don't display...
 277         delete $budget->{'budget_unalloc_sublevel'}
 278             if (!defined $budget->{'budget_unalloc_sublevel'}
 279             or $budget->{'budget_unalloc_sublevel'} == 0);
 280
 281         # Value of budget_spent equals 0 instead of undefined value
 282         $budget->{budget_spent} = 0 unless defined($budget->{budget_spent});
 283         $budget->{budget_ordered} = 0 unless defined($budget->{budget_ordered});
 284
 285         #Make a list of parents of the bugdet
 286         my @budget_hierarchy;
 287         push  @budget_hierarchy, { element_name => $budget->{"budget_name"}, element_id => $budget->{"budget_id"} };
 288         my $parent_id = $budget->{"budget_parent_id"};
 289         while ($parent_id) {
 290             my $parent = GetBudget($parent_id);
 291             push @budget_hierarchy, { element_name => $parent->{"budget_name"}, element_id => $parent->{"budget_id"} };
 292             $parent_id = $parent->{"budget_parent_id"};
 293         }
 294         push  @budget_hierarchy, { element_name => $period->{"budget_period_description"} };
 295         @budget_hierarchy = reverse(@budget_hierarchy);
 296
 297         $budget->{budget_hierarchy} = \@budget_hierarchy;
 298
 299         $budget->{budget_has_children} = BudgetHasChildren( $budget->{budget_id} );
 300         push @budgets_to_display, $budget;
 301     }
 302
 303     my $budget_period_total = $period->{budget_period_total};
 304
 305     my $periods = GetBudgetPeriods();
 306
 307     $template->param(
 308         op                     => 'list',
 309         budgets                => \@budgets_to_display,
 310         periods                => $periods,
 311         budget_period_total    => $budget_period_total,
 312         period_alloc_total     => $period_alloc_total,
 313         spent_total            => $spent_total,
 314         ordered_total          => $ordered_total,
 315         available_total        => $available_total,
 316         filter_budgetname      => $filter_budgetname,
 317     );
 318
 319 } #---- END list
 320
 321 output_html_with_http_headers $input, $cookie, $template->output;