admin/aqplan.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2008-2009 BibLibre SARL
   4 # This file is part of Koha.
   5 #
   6 # Koha is free software; you can redistribute it and/or modify it under the
   7 # terms of the GNU General Public License as published by the Free Software
   8 # Foundation; either version 2 of the License, or (at your option) any later
   9 # version.
  10 #
  11 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  12 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  13 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along
  16 # with Koha; if not, write to the Free Software Foundation, Inc.,
  17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19 #script to administer the aqbudgets0 table
  20 #written 20/02/2002 by paul.poulain@free.fr
  21 # This software is placed under the gnu General Public License, v2 (http://www.gnu.org/licenses/gpl.html)
  22
  23 use strict;
  24 #use warnings; FIXME - Bug 2505
  25 use CGI;
  26 use List::Util qw/min/;
  27 use Date::Calc qw/Delta_YMD Easter_Sunday Today Decode_Date_EU/;
  28 use Date::Manip qw/ ParseDate UnixDate DateCalc/;
  29 use C4::Dates qw/format_date format_date_in_iso/;
  30 use Number::Format qw(format_price);
  31 use Text::CSV_XS;
  32
  33 use C4::Acquisition;
  34 use C4::Budgets;
  35 use C4::Context;
  36 use C4::Output;
  37 use C4::Koha;
  38 use C4::Auth;
  39 use C4::Input;
  40 use C4::Debug;
  41
  42 my $input = new CGI;
  43 ####  $input
  44
  45 my $dbh = C4::Context->dbh;
  46
  47 my ( $template, $borrowernumber, $cookie, $staff_flags ) = get_template_and_user(
  48     {   template_name   => "admin/aqplan.tmpl",
  49         query           => $input,
  50         type            => "intranet",
  51         authnotrequired => 0,
  52         flagsrequired   => { acquisition => 'planning_manage' },
  53         debug           => 0,
  54     }
  55 );
  56
  57 my $budget_period_id = $input->param('budget_period_id');
  58 # ' ------- get periods stuff ------------------'
  59 # IF PERIOD_ID IS DEFINED,  GET THE PERIOD - ELSE GET THE ACTIVE PERIOD BY DEFAULT
  60 my $period = GetBudgetPeriod($budget_period_id);
  61 my $count  = GetPeriodsCount();
  62 my $cur    = GetCurrency;
  63 $template->param( symbol => $cur->{symbol},
  64                   currency => $cur->{currency}
  65                );
  66 $template->param( period_button_only => 1 ) if $count == 0;
  67
  68
  69
  70 # authcats_loop populates the YUI planning button
  71 my $auth_cats_loop            = GetBudgetAuthCats($budget_period_id);
  72 my $budget_period_id          = $period->{'budget_period_id'};
  73 my $budget_period_startdate   = $period->{'budget_period_startdate'};
  74 my $budget_period_enddate     = $period->{'budget_period_enddate'};
  75 my $budget_period_locked      = $period->{'budget_period_locked'};
  76 my $budget_period_description = $period->{'budget_period_description'};
  77
  78
  79 $template->param(
  80     budget_period_id          => $budget_period_id,
  81     budget_period_locked      => $budget_period_locked,
  82     budget_period_description => $budget_period_description,
  83     auth_cats_loop            => $auth_cats_loop,
  84 );
  85
  86 # ------- get periods stuff ------------------
  87
  88 my $borrower_id         = $template->{VARS}->{'USER_INFO'}[0]->{'borrowernumber'};
  89 my $borrower_branchcode = $template->{VARS}->{'USER_INFO'}[0]->{'branchcode'};
  90
  91 my $periods;
  92 my $authcat      = $input->param('authcat');
  93 my $show_active  = $input->param('show_active');
  94 my $show_actual  = $input->param('show_actual');
  95 my $show_percent = $input->param('show_percent');
  96 my $output       = $input->param("output");
  97 my $basename     = $input->param("basename");
  98 my $del          = $input->param("sep");
  99
 100 my $show_mine       = $input->param('show_mine') ;
 101
 102 my @hide_cols      = $input->param('hide_cols');
 103
 104 my $cur_format = C4::Context->preference("CurrencyFormat");
 105 my $num;
 106
 107 if ( $cur_format eq 'FR' ) {
 108     $num = new Number::Format(
 109         'decimal_fill'      => '2',
 110         'decimal_point'     => ',',
 111         'int_curr_symbol'   => '',
 112         'mon_thousands_sep' => ' ',
 113         'thousands_sep'     => ' ',
 114         'mon_decimal_point' => ','
 115     );
 116 } else {  # US by default..
 117     $num = new Number::Format(
 118         'int_curr_symbol'   => '',
 119         'mon_thousands_sep' => ',',
 120         'mon_decimal_point' => '.'
 121     );
 122 }
 123
 124 if ( $budget_period_locked == 1  && not defined  $show_actual ) {
 125      $show_actual  = 1;
 126 }
 127
 128 $authcat = 'Asort1' if  not defined $authcat; # defaults to Asort if no authcat given
 129
 130 my $budget_id = $input->param('budget_id');
 131 my $op        = $input->param("op");
 132
 133 my $budget_branchcode;
 134
 135 my $budgets_ref = GetBudgetHierarchy( $budget_period_id, $show_mine?$template->{VARS}->{'USER_INFO'}[0]->{'branchcode'}:'', $show_mine?$template->{VARS}->{'USER_INFO'}[0]->{'borrowernumber'}:'' );
 136
 137 # build categories list
 138 my $sth = $dbh->prepare("select distinct category from authorised_values where category like 'A%' ");
 139 $sth->execute;
 140
 141 # the list
 142 my @category_list;
 143
 144 # a hash, to check that some hardcoded categories exist.
 145 my %categories;
 146 while ( my ($category) = $sth->fetchrow_array ) {
 147     push( @category_list, $category );
 148     $categories{$category} = 1;
 149 }
 150
 151 # push koha system categories
 152 push( @category_list, 'MONTHS' );
 153 push( @category_list, 'ITEMTYPES' );
 154 push( @category_list, 'BRANCHES' );
 155 push( @category_list, $$_{'authcat'} ) foreach @$auth_cats_loop;
 156
 157 #reorder the list
 158 @category_list = sort { $a cmp $b } @category_list;
 159 my $tab_list = CGI::scrolling_list(
 160     -name     => 'authcat',
 161     -id       => 'authcat',
 162     -values   => \@category_list,
 163     -default  => $authcat,
 164     -size     => 1,
 165     -tabindex => '',
 166     -multiple => 0,
 167 );
 168
 169 $template->param( authcat_dropbox => $tab_list );
 170
 171 my @budgets = @$budgets_ref;
 172 my $CGISort;
 173 my @authvals;
 174 my %labels;
 175
 176 my @names = $input->param();
 177 # ------------------------------------------------------------
 178 if ( $op eq 'save' ) {
 179     #get budgets
 180     my ( @buds, @auth_values );
 181     foreach my $n (@names) {
 182         next if $n =~ m/^[^0-9]/;
 183         my @moo = split( ',', $n );
 184         push @buds, $moo[0];
 185         push @auth_values, $moo[1];
 186     }
 187
 188     #uniq buds and auth
 189     my %seen;
 190     @buds        = grep { !$seen{$_}++ } @buds;
 191     @auth_values = grep { !$seen{$_}++ } @auth_values;
 192     my @budget_ids;
 193     my @budget_lines;
 194
 195     foreach my $budget (@buds) {
 196         my %budget_line;
 197         my @cells_line;
 198         my %cell_hash;
 199
 200         foreach my $authvalue (@auth_values) {
 201             # get actual stats
 202             my $cell_name        = "$budget,$authvalue";
 203             my $estimated_amount = $input->param("$cell_name");
 204             my %cell_hash = (
 205                 estimated_amount => $estimated_amount,
 206                 authvalue        => $authvalue,
 207                 authcat          => $authcat,
 208                 budget_id        => $budget,
 209                 budget_period_id => $budget_period_id,
 210             );
 211             push( @cells_line, \%cell_hash );
 212         }
 213
 214         %budget_line = (
 215             lines => \@cells_line,
 216         );
 217         push( @budget_lines, \%budget_line );
 218     }
 219     my $plan = \@budget_lines;
 220     ModBudgetPlan( $plan, $budget_period_id, $authcat );
 221
 222 HideCols($authcat, @hide_cols);
 223
 224
 225 }
 226 # ------------------------------------------------------------
 227 if ( $authcat =~ m/^Asort/ ) {
 228     # ----------- copied from C4::Input::buildCGIsort()
 229    my $query = qq{ SELECT * FROM authorised_values WHERE category=? order by lib };
 230     my $sth   = $dbh->prepare($query);
 231     $sth->execute($authcat  );
 232     if ( $sth->rows > 0 ) {
 233         for ( my $i = 0 ; $i < $sth->rows ; $i++ ) {
 234             my $results = $sth->fetchrow_hashref;
 235             push @authvals, $results->{authorised_value};
 236             $labels{ $results->{authorised_value} } = $results->{lib};
 237         }
 238     }
 239     $sth->finish;
 240     @authvals = sort { $a <=> $b } @authvals;
 241 }
 242 elsif ( $authcat eq 'MONTHS' ) {
 243
 244     # build months
 245     my @start_date = UnixDate( $budget_period_startdate, ( '%Y', '%m', '%d' ) );
 246     my @end_date   = UnixDate( $budget_period_enddate,   ( '%Y', '%m', '%d' ) );
 247
 248     my ( $Dy, $Dm, $Dd ) = Delta_YMD( @start_date, @end_date );
 249
 250     #calc number of months between
 251     my $months      = ( $Dy * 12 ) + $Dm;
 252     my $start_month = @start_date[1];
 253     my $end_month   = ( $Dy * 12 ) + $Dm;
 254
 255     for my $mth ( 0 ... $months ) {
 256         $mth = DateCalc( $budget_period_startdate, "+ $mth months" );
 257         $mth = UnixDate( $mth, "%Y-%m" );
 258         push( @authvals, $mth );
 259     }
 260     foreach my $vv (@authvals) {
 261         $labels{$vv} = $vv;
 262     }
 263 }
 264
 265 elsif ( $authcat eq 'ITEMTYPES' ) {
 266     my $query = qq| SELECT itemtype, description FROM itemtypes |;
 267     my $sth   = $dbh->prepare($query);
 268     $sth->execute(  );
 269
 270     if ( $sth->rows > 0 ) {
 271         for ( my $i = 0 ; $i < $sth->rows ; $i++ ) {
 272             my $results = $sth->fetchrow_hashref;
 273             push @authvals, $results->{itemtype};
 274             $labels{ $results->{itemtype} } = $results->{description};
 275         }
 276     }
 277     $sth->finish;
 278
 279 } elsif ( $authcat eq 'BRANCHES' ) {
 280
 281     my $query = qq| SELECT branchcode, branchname FROM branches |;
 282     my $sth   = $dbh->prepare($query);
 283     $sth->execute();
 284
 285     if ( $sth->rows > 0 ) {
 286         for ( my $i = 0 ; $i < $sth->rows ; $i++ ) {
 287             my $results = $sth->fetchrow_hashref;
 288             push @authvals, $results->{branchcode};
 289             $labels{ $results->{branchcode} } = $results->{branchname};
 290         }
 291     }
 292     $sth->finish;
 293 } elsif ($authcat) {
 294     my $query = qq{ SELECT * FROM authorised_values WHERE category=? order by lib };
 295     my $sth   = $dbh->prepare($query);
 296     $sth->execute($authcat);
 297     if ( $sth->rows > 0 ) {
 298         for ( my $i = 0 ; $i < $sth->rows ; $i++ ) {
 299             my $results = $sth->fetchrow_hashref;
 300             push @authvals, $results->{authorised_value};
 301             $labels{ $results->{authorised_value} } = $results->{lib};
 302         }
 303     }
 304     $sth->finish;
 305 }
 306
 307 my @authvals_row;
 308 my $i=1;
 309 foreach my $val (@authvals) {
 310     my %auth_hash;
 311     $auth_hash{val} =   $labels{$val};
 312     $auth_hash{code} =   $val;
 313     $auth_hash{colnum} =   $i++;
 314
 315     # display lookup
 316     $auth_hash{display} = GetCols( $authcat,  $auth_hash{code});
 317
 318     push( @authvals_row, \%auth_hash );
 319 }
 320
 321 #get budgets
 322 my ( @buds, @auth_values );
 323 foreach my $n (@names) {
 324     next if $n =~ m/^[^0-9]/;
 325     $n =~ m/(\d*),(.*)/;
 326     push @buds, $1;
 327     push @auth_values, $2;
 328 }
 329
 330
 331 # ------------------------------------------------------------
 332 #         DEFAULT DISPLAY BEGINS
 333
 334 my $CGIextChoice = CGI::scrolling_list(
 335     -name     => 'MIME',
 336     -id       => 'MIME',
 337     -values   => ['CSV'], # FIXME translation
 338     -size     => 1,
 339     -multiple => 0
 340 );
 341
 342 my @dels         = ( C4::Context->preference("delimiter") );
 343 my $CGIsepChoice = CGI::scrolling_list(
 344     -name     => 'sep',
 345     -id       => 'sep',
 346     -values   => \@dels,
 347     -size     => 1,
 348     -multiple => 0
 349 );
 350
 351 my ( @budget_lines, %cell_hash );
 352
 353
 354 foreach my $budget (@budgets) {
 355     my $budget_lock;
 356
 357     unless (CanUserUseBudget($borrowernumber, $budget, $staff_flags)) {
 358         $budget_lock = 1
 359     }
 360
 361     # check budget permission
 362     if ( $period->{budget_period_locked} == 1 ) {
 363         $budget_lock = 1;
 364     } elsif ( $budget->{budget_permission} == 1 ) {
 365         $budget_lock = 1 if $borrower_id != $budget->{'budget_owner_id'};
 366     } elsif ( $budget->{budget_permission} == 2 ) {
 367         $budget_lock = 1 if $borrower_branchcode ne $budget->{budget_branchcode};
 368     }
 369
 370     # allow hard-coded itemtype and branch planning
 371     unless ( $authcat eq 'ITEMTYPES'
 372         or  $authcat eq 'BRANCHES'
 373         or  $authcat eq 'MONTHS' ) {
 374
 375         # but skip budgets that dont match the current auth-category
 376         next if ( $budget->{'sort1_authcat'} ne $authcat
 377             && $budget->{'sort2_authcat'} ne $authcat );
 378     }
 379
 380     my %budget_line; # each row of the  table
 381     my @cells_line;
 382     my $actual_spent;
 383     my $estimated_spent;
 384
 385     my $i = 0;
 386     foreach my $authvalue (@authvals) {
 387
 388         # get actual stats
 389         my %cell = (
 390             budget_id        => $budget->{'budget_id'},
 391             budget_period_id => $budget->{'budget_period_id'},
 392             cell_name        => $budget->{'budget_id'} . ',' . $authvalue,
 393             authvalue        => $authvalue,
 394             authcat          => $authcat,
 395             cell_authvalue   => $authvalue,
 396             budget_lock      => $budget_lock,
 397         );
 398
 399         my ( $actual, $estimated, $display ) = GetBudgetsPlanCell( \%cell, $period, $budget );
 400         $cell{actual_amount}    = sprintf( "%.2f", $actual );
 401         $cell{estimated_amount} = sprintf( "%.2f", $estimated );
 402         $cell{display}          = $authvals_row[$i]{display};
 403         $cell{colnum}           = $i;
 404
 405         $actual_spent    += $cell{actual_amount};
 406         $estimated_spent += $cell{estimated_amount};
 407
 408
 409         push( @cells_line, \%cell );
 410         $i++;
 411     }
 412
 413     my $budget_act_remain = $budget->{budget_amount} - $actual_spent;
 414     my $budget_est_remain = $budget->{budget_amount} - $estimated_spent;
 415
 416     %budget_line = (
 417         lines                   => \@cells_line,
 418         budget_name_indent      => $budget->{budget_name_indent},
 419         budget_amount_formatted => $num->format_price( $budget->{budget_amount} ),
 420         budget_amount           => $budget->{budget_amount},
 421         budget_alloc            => $budget->{budget_alloc},
 422         budget_act_remain       => sprintf( "%.2f", $budget_act_remain ),
 423         budget_est_remain       => sprintf( "%.2f", $budget_est_remain ),
 424         budget_id               => $budget->{budget_id},
 425         budget_lock             => $budget_lock,
 426     );
 427
 428
 429
 430     $budget_line{est_negative} = '1' if $budget_est_remain < 0;
 431     $budget_line{est_positive} = '1' if $budget_est_remain > 0;
 432     $budget_line{act_negative} = '1' if $budget_act_remain < 0;
 433     $budget_line{act_positive} = '1' if $budget_act_remain > 0;
 434
 435     # skip if active set , and spent == 0
 436     next if ( $show_active == '1' && ( $actual_spent == 0 ) );
 437
 438     push( @budget_lines, \%budget_line );
 439 }
 440
 441 if ( $output eq "file" ) {
 442     _print_to_csv(\@authvals_row, \@budget_lines);
 443     exit(1);
 444 }
 445
 446 $template->param(
 447     authvals_row              => \@authvals_row,
 448     budget_lines              => \@budget_lines,
 449     budget_period_description => $period->{'budget_period_description'},
 450     budget_period_locked      => $period->{'budget_period_locked'},
 451     budget_period_id          => $budget_period_id,
 452     authcat                   => $authcat,
 453     show_active               => $show_active,
 454     show_actual               => $show_actual,
 455     show_percent              => $show_percent,
 456     show_mine                 => $show_mine,
 457     cur_format                => $cur_format,
 458     CGIextChoice              => $CGIextChoice,
 459     CGIsepChoice              => $CGIsepChoice,
 460
 461     authvals              => \@authvals_row,
 462     hide_cols_loop              => \@hide_cols
 463 );
 464
 465 output_html_with_http_headers $input, $cookie, $template->output;
 466
 467 sub _print_to_csv {
 468     my ( $header, $results ) = @_;
 469
 470     binmode STDOUT, ':encoding(UTF-8)';
 471
 472     my $csv = Text::CSV_XS->new(
 473         {   sep_char     => $del,
 474             always_quote => 'TRUE',
 475         }
 476     );
 477     print $input->header(
 478         -type       => 'application/vnd.sun.xml.calc',
 479         -encoding   => 'utf-8',
 480         -attachment => "$basename.csv",
 481         -name       => "$basename.csv"
 482     );
 483     my @col = ( 'Budget name', 'Budget total' );
 484     foreach my $row (@$header) {
 485         push @col, $row->{'val'};
 486     }
 487     push @col, 'Budget remaining';
 488
 489     $csv->combine(@col);
 490     my $str = $csv->string;
 491     print "$str\n";
 492
 493     foreach my $row (@$results) {
 494         $row->{'budget_name_indent'} =~ s/&nbsp;/ /g;
 495         my @col = ( $row->{'budget_name_indent'}, $row->{'budget_amount'} );
 496         my $l = $row->{'lines'};
 497         foreach my $line (@$l) {
 498             push @col, $line->{'estimated_amount'};
 499         }
 500         push @col, $row->{'budget_est_remain'};
 501         $csv->combine(@col);
 502         my $str = $csv->string;
 503         print "$str\n";
 504     }
 505 }