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 under the
  10 # terms of the GNU General Public License as published by the Free Software
  11 # Foundation; either version 2 of the License, or (at your option) any later
  12 # version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License along
  19 # with Koha; if not, write to the Free Software Foundation, Inc.,
  20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21
  22 use strict;
  23 #use warnings; FIXME - Bug 2505
  24 use CGI;
  25 use List::Util qw/min/;
  26 use Number::Format qw(format_price);
  27
  28 use C4::Auth qw/get_user_subpermissions/;
  29 use C4::Branch; # GetBranches
  30 use C4::Dates qw/format_date format_date_in_iso/;
  31 use C4::Auth;
  32 use C4::Acquisition;
  33 use C4::Budgets;   #
  34 use C4::Members;  # calls GetSortDetails()
  35 use C4::Context;
  36 use C4::Output;
  37 use C4::Koha;
  38 use C4::Debug;
  39 #use POSIX qw(locale_h);
  40
  41 my $input = new CGI;
  42 my $dbh     = C4::Context->dbh;
  43
  44 my ($template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
  45     {   template_name   => "admin/aqbudgets.tmpl",
  46         query           => $input,
  47         type            => "intranet",
  48         authnotrequired => 0,
  49         flagsrequired   => { acquisition => 'budget_manage' },
  50         debug           => 0,
  51     }
  52 );
  53
  54 my $cur = GetCurrency();
  55 $template->param( symbol => $cur->{symbol},
  56                   currency => $cur->{currency}
  57                );
  58
  59 my $op = $input->param('op');
  60
  61 # see if the user want to see all budgets or only owned ones
  62 my $show_mine    = 1; #SHOW BY DEFAULT
  63 my $show         = $input->param('show'); # SET TO 1, BY A FORM SUMBIT
  64 $show_mine       = $input->param('show_mine') if $show == 1;
  65
  66 # IF USER DOESNT HAVE PERM FOR AN 'ADD', THEN REDIRECT TO THE DEFAULT VIEW...
  67 if  (  not defined $template->{VARS}->{'CAN_user_acquisition_budget_add_del'}  &&  $op ==  'add_form'  )   {
  68     $op = '';
  69 }
  70 my $num=FormatNumber;
  71
  72 my $script_name               = "/cgi-bin/koha/admin/aqbudgets.pl";
  73 my $budget_hash               = $input->Vars;
  74 my $budget_id                 = $$budget_hash{budget_id};
  75 my $budget_permission         = $input->param('budget_permission');
  76 my $filter_budgetbranch       = $input->param('filter_budgetbranch');
  77 my $filter_budgetname         = $input->param('filter_budgetname');
  78 #filtering non budget keys
  79 delete $$budget_hash{$_} foreach grep {/filter|^op$|show/} keys %$budget_hash;
  80
  81 $template->param(
  82     notree => ($filter_budgetbranch or $show_mine)
  83 );
  84 # ' ------- get periods stuff ------------------'
  85 # IF PERIODID IS DEFINED,  GET THE PERIOD - ELSE JUST GET THE ACTIVE PERIOD BY DEFAULT
  86 my $period = GetBudgetPeriod($$budget_hash{budget_period_id});
  87
  88 $template->param(
  89         %$period
  90 );
  91 # ------- get periods stuff ------------------
  92
  93 # USED FOR PERMISSION COMPARISON LATER
  94 my $borrower_id         = $template->{VARS}->{'USER_INFO'}[0]->{'borrowernumber'};
  95 my $user                = GetMemberDetails($borrower_id);
  96 my $user_branchcode     = $user->{'branchcode'};
  97
  98 $template->param(
  99     action      => $script_name,
 100     script_name => $script_name,
 101     show_mine   => $show_mine,
 102     $op || else => 1,
 103 );
 104
 105
 106 # retrieve branches
 107 my ( $budget, );
 108
 109 my $branches = GetBranches($show_mine);
 110 my @branchloop2;
 111 foreach my $thisbranch (keys %$branches) {
 112     my %row = (
 113         value      => $thisbranch,
 114         branchname => $branches->{$thisbranch}->{'branchname'},
 115     );
 116     $row{selected} = 1 if $thisbranch eq $filter_budgetbranch;
 117     push @branchloop2, \%row;
 118 }
 119
 120 $template->param(auth_cats_loop => GetBudgetAuthCats($$period{budget_period_id}) );
 121
 122 # Used to create form to add or  modify a record
 123 if ($op eq 'add_form') {
 124 #### ------------------- ADD_FORM -------------------------
 125     # if no buget_id is passed then its an add
 126     #  pass the period_id to build the dropbox - because we only want to show  budgets from this period
 127     my $dropbox_disabled;
 128     if (defined $budget_id ) {    ### MOD
 129         $budget           = GetBudget($budget_id);
 130         $dropbox_disabled = BudgetHasChildren($budget_id);
 131         my $borrower = &GetMember( borrowernumber=>$budget->{budget_owner_id} );
 132         $budget->{budget_owner_name} = $borrower->{'firstname'} . ' ' . $borrower->{'surname'};
 133         $$budget{$_}= sprintf("%.2f", $budget->{$_}) for grep{/amount/} keys %$budget;
 134     }
 135
 136     # build budget hierarchy
 137     my %labels;
 138     my @values;
 139     my $hier = GetBudgetHierarchy($$period{budget_period_id});
 140     foreach my $r (@$hier) {
 141         $r->{budget_code_indent} =~ s/&nbsp;/\~/g;    #
 142         $labels{"$r->{budget_id}"} = $r->{budget_code_indent};
 143         push @values, $r->{budget_id};
 144     }
 145     push @values, '';
 146     # if no buget_id is passed then its an add
 147     my $budget_parent;
 148     my $budget_parent_id;
 149     if ($budget){
 150         $budget_parent_id = $budget->{'budget_parent_id'} ;
 151     }else{
 152         $budget_parent_id = $input->param('budget_parent_id');
 153     }
 154     $budget_parent = GetBudget($budget_parent_id);
 155
 156     # build branches select
 157     my $branches = GetBranches;
 158     my @branchloop_select;
 159     foreach my $thisbranch ( sort keys %$branches ) {
 160         my %row = (
 161             value      => $thisbranch,
 162             branchname => $branches->{$thisbranch}->{'branchname'},
 163         );
 164         $row{selected} = 1 if $thisbranch eq $budget->{'budget_branchcode'};
 165         push @branchloop_select, \%row;
 166     }
 167
 168     # populates the YUI planning button
 169     my $categories = GetAuthorisedValueCategories();
 170     my @auth_cats_loop1 = ();
 171     foreach my $category (@$categories) {
 172         my $entry = { category => $category,
 173                         selected => $budget->{sort1_authcat} eq $category ?1:0,
 174                     };
 175         push @auth_cats_loop1, $entry;
 176     }
 177     my @auth_cats_loop2 = ();
 178     foreach my $category (@$categories) {
 179         my $entry = { category => $category,
 180                         selected => $budget->{sort2_authcat} eq $category ?1:0,
 181                     };
 182         push @auth_cats_loop2, $entry;
 183     }
 184     $template->param(authorised_value_categories1 => \@auth_cats_loop1);
 185     $template->param(authorised_value_categories2 => \@auth_cats_loop2);
 186
 187     if($budget->{'budget_permission'}){
 188         my $budget_permission = "budget_perm_".$budget->{'budget_permission'};
 189         $template->param($budget_permission => 1);
 190     }
 191
 192     # if no buget_id is passed then its an add
 193     $template->param(
 194         add_validate                  => 1,
 195         dateformat                => C4::Dates->new()->visual(),
 196         budget_parent_id                  => $budget_parent->{'budget_id'},
 197         budget_parent_name                => $budget_parent->{'budget_name'},
 198         branchloop_select         => \@branchloop_select,
 199                 %$period,
 200                 %$budget,
 201     );
 202                                                     # END $OP eq ADD_FORM
 203 #---------------------- DEFAULT DISPLAY BELOW ---------------------
 204
 205 # called by default form, used to confirm deletion of data in DB
 206 } elsif ($op eq 'delete_confirm') {
 207
 208     my $budget = GetBudget($budget_id);
 209     $template->param(
 210         budget_id     => $budget->{'budget_id'},
 211         budget_code   => $budget->{'budget_code'},
 212         budget_name   => $budget->{'budget_name'},
 213         budget_amount => $num->format_price(  $budget->{'budget_amount'} ),
 214     );
 215                                                     # END $OP eq DELETE_CONFIRM
 216 # called by delete_confirm, used to effectively confirm deletion of data in DB
 217 }  else{
 218     if ( $op eq 'delete_confirmed' ) {
 219         my $rc = DelBudget($budget_id);
 220     }elsif( $op eq 'add_validate' ) {
 221         if ( defined $$budget_hash{budget_id} ) {
 222             ModBudget( $budget_hash );
 223         } else {
 224             AddBudget( $budget_hash );
 225         }
 226     }
 227     my $branches = GetBranches();
 228     $template->param(
 229         budget_id                 => $budget_id,
 230         %$period,
 231     );
 232
 233     my $moo = GetBudgetHierarchy($$period{budget_period_id}, C4::Context->userenv->{branchcode}, $show_mine?$borrower_id:'');
 234     my @budgets = @$moo; #FIXME
 235
 236     my $toggle = 0;
 237     my @loop;
 238     my $period_total = 0;
 239     my ( $period_alloc_total, $base_spent_total );
 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     foreach my $budget (@budgets) {
 244         #Level and sublevels total spent
 245         $budget->{'total_levels_spent'} = GetChildBudgetsSpent($budget->{"budget_id"});
 246
 247         # PERMISSIONS
 248         unless($staffflags->{'superlibrarian'} % 2   == 1 ) {
 249             #IF NO PERMS, THEN DISABLE EDIT/DELETE
 250             unless ( $template->{VARS}->{'CAN_user_acquisition_budget_modify'} ) {
 251                 $budget->{'budget_lock'} = 1;
 252             }
 253             # check budget permission
 254             if ( $$period{budget_period_locked} == 1 ) {
 255                 $budget->{'budget_lock'} = 1;
 256
 257             } elsif ( $budget->{budget_permission} == 1 ) {
 258
 259                 if ( $borrower_id != $budget->{'budget_owner_id'} ) {
 260                     $budget->{'budget_lock'} = 1;
 261                 }
 262                 # check parent perms too
 263                 my $parents_perm = 0;
 264                 if ( $budget->{depth} > 0 ) {
 265                     $parents_perm = CheckBudgetParentPerm( $budget, $borrower_id );
 266                     delete $budget->{'budget_lock'} if $parents_perm == '1';
 267                 }
 268             } elsif ( $budget->{budget_permission} == 2 ) {
 269
 270                 $budget->{'budget_lock'} = 1 if $user_branchcode ne $budget->{budget_branchcode};
 271             }
 272         }    # ...SUPER_LIB END
 273
 274         # if a budget search doesnt match, next
 275         if ($filter_budgetname) {
 276             next
 277               unless $budget->{budget_code} =~ m/$filter_budgetname/i
 278                   || $budget->{budget_name} =~ m/$filter_budgetname/i;
 279         }
 280         if ($filter_budgetbranch ) {
 281             next unless  $budget->{budget_branchcode}  =~ m/$filter_budgetbranch/;
 282         }
 283
 284 ## TOTALS
 285         # adds to total  - only if budget is a 'top-level' budget
 286         $period_alloc_total += $budget->{'budget_amount_total'} if $budget->{'depth'} == 0;
 287         $base_spent_total += $budget->{'budget_spent'};
 288         $budget->{'budget_remaining'} = $budget->{'budget_amount'} - $budget->{'total_levels_spent'};
 289
 290 # if amount == 0 dont display...
 291         delete  $budget->{'budget_unalloc_sublevel'} if  $budget->{'budget_unalloc_sublevel'} == 0 ;
 292
 293         $budget->{'remaining_pos'} = 1 if $budget->{'budget_remaining'} > 0;
 294         $budget->{'remaining_neg'} = 1 if $budget->{'budget_remaining'} < 0;
 295                 for (grep {/total_levels_spent|budget_spent|budget_amount|budget_remaining|budget_unalloc/} keys %$budget){
 296             $budget->{$_}               = $num->format_price( $budget->{$_} ) if defined($budget->{$_})
 297                 }
 298
 299         # Value of budget_spent equals 0 instead of undefined value
 300         $budget->{"budget_spent"} = $num->format_price(0) unless defined($budget->{"budget_spent"});
 301
 302         my $borrower = &GetMember( borrowernumber=>$budget->{budget_owner_id} );
 303         $budget->{"budget_owner_name"}     = $borrower->{'firstname'} . ' ' . $borrower->{'surname'};
 304         $budget->{"budget_borrowernumber"} = $borrower->{'borrowernumber'};
 305
 306         #Make a list of parents of the bugdet
 307         my @budget_hierarchy;
 308         push  @budget_hierarchy, { element_name => $budget->{"budget_name"}, element_id => $budget->{"budget_id"} };
 309         my $parent_id = $budget->{"budget_parent_id"};
 310         while ($parent_id) {
 311             my $parent = GetBudget($parent_id);
 312             push @budget_hierarchy, { element_name => $parent->{"budget_name"}, element_id => $parent->{"budget_id"} };
 313             $parent_id = $parent->{"budget_parent_id"};
 314         }
 315         push  @budget_hierarchy, { element_name => $period->{"budget_period_description"} };
 316         @budget_hierarchy = reverse(@budget_hierarchy);
 317
 318         push( @loop, {  %{$budget},
 319                         branchname  => $branches->{ $budget->{branchcode} }->{branchname},
 320                         budget_hierarchy => \@budget_hierarchy,
 321                     }
 322         );
 323     }
 324
 325     my $budget_period_total;
 326     if ( $period->{budget_period_total} ) {
 327         $budget_period_total =
 328           $num->format_price( $period->{budget_period_total} );
 329     }
 330
 331     if ($period_alloc_total) {
 332         $period_alloc_total = $num->format_price($period_alloc_total);
 333     }
 334
 335     if ($base_spent_total) {
 336         $base_spent_total = $num->format_price($base_spent_total);
 337     }
 338
 339     $template->param(
 340         else                   => 1,
 341         budget                 => \@loop,
 342         budget_period_total    => $budget_period_total,
 343         period_alloc_total     => $period_alloc_total,
 344         base_spent_total       => $base_spent_total,
 345         branchloop             => \@branchloop2,
 346     );
 347
 348 } #---- END $OP eq DEFAULT
 349
 350 output_html_with_http_headers $input, $cookie, $template->output;