admin/aqbudgetperiods.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2008 BibLibre, BibLibre, Paul POULAIN
   4 #                SAN Ouest Provence
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it under the
   9 # terms of the GNU General Public License as published by the Free Software
  10 # Foundation; either version 2 of the License, or (at your option) any later
  11 # version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along
  18 # with Koha; if not, write to the Free Software Foundation, Inc.,
  19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20
  21 =head1 admin/aqbudgetperiods.pl
  22
  23 script to administer the budget periods table
  24  This software is placed under the gnu General Public License, v2 (http://www.gnu.org/licenses/gpl.html)
  25
  26  ALGO :
  27  this script use an $op to know what to do.
  28  if $op is empty or none of the above values,
  29         - the default screen is build (with all records, or filtered datas).
  30         - the   user can clic on add, modify or delete record.
  31  if $op=add_form
  32         - if primkey exists, this is a modification,so we read the $primkey record
  33         - builds the add/modify form
  34  if $op=add_validate
  35         - the user has just send datas, so we create/modify the record
  36  if $op=delete_confirm
  37         - we show the record having primkey=$primkey and ask for deletion validation form
  38  if $op=delete_confirmed
  39         - we delete the record having primkey=$primkey
  40  if $op=duplicate_form
  41   - displays the duplication of budget period form (allowing specification of dates)
  42  if $op=duplicate_budget
  43   - we perform the duplication of the budget period specified as budget_period_id
  44
  45 =cut
  46
  47 use Modern::Perl;
  48
  49 use Number::Format qw(format_price);
  50 use CGI;
  51 use List::Util qw/min/;
  52 use Koha::DateUtils;
  53 use Koha::Database;
  54 use C4::Koha;
  55 use C4::Context;
  56 use C4::Auth;
  57 use C4::Output;
  58 use C4::Acquisition;
  59 use C4::Budgets;
  60 use C4::Debug;
  61
  62 my $dbh = C4::Context->dbh;
  63
  64 my $input       = new CGI;
  65
  66 my $searchfield          = $input->param('searchfield') // '';
  67 my $budget_period_id     = $input->param('budget_period_id');
  68 my $op                   = $input->param('op')||"else";
  69 #my $sort1_authcat = $input->param('sort1_authcat');
  70 #my $sort2_authcat = $input->param('sort2_authcat');
  71
  72 # get only the columns of aqbudgetperiods in budget_period_hashref
  73 my @columns = Koha::Database->new()->schema->source('Aqbudgetperiod')->columns;
  74 my $budget_period_hashref = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $input->param($_) )  : () } keys( %{$input->Vars()} ) } ;
  75 $budget_period_hashref->{budget_period_startdate} = dt_from_string( $input->param('budget_period_startdate') );
  76 $budget_period_hashref->{budget_period_enddate}   = dt_from_string( $input->param('budget_period_enddate') );
  77
  78 my $activepagesize = 20;
  79 my $inactivepagesize = 20;
  80 $searchfield =~ s/\,//g;
  81
  82 my ($template, $borrowernumber, $cookie, $staff_flags ) = get_template_and_user(
  83     {
  84         template_name   => "admin/aqbudgetperiods.tt",
  85         query           => $input,
  86         type            => "intranet",
  87         authnotrequired => 0,
  88         flagsrequired   => { acquisition => 'period_manage' },
  89         debug           => 1,
  90     }
  91 );
  92
  93
  94 my $cur = GetCurrency();
  95 $template->param( symbol => $cur->{symbol},
  96                   currency => $cur->{currency}
  97                );
  98 my $cur_format = C4::Context->preference("CurrencyFormat");
  99 my $num;
 100
 101 if ( $cur_format eq 'US' ) {
 102     $num = new Number::Format(
 103         'int_curr_symbol'   => '',
 104         'mon_thousands_sep' => ',',
 105         'mon_decimal_point' => '.'
 106     );
 107 } elsif ( $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 }
 117
 118
 119 # ADD OR MODIFY A BUDGET PERIOD - BUILD SCREEN
 120 if ( $op eq 'add_form' ) {
 121     ## add or modify a budget period (preparation)
 122     ## get information about the budget period that must be modified
 123
 124     if ($budget_period_id) {    # MOD
 125                 my $budgetperiod_hash=GetBudgetPeriod($budget_period_id);
 126         # get dropboxes
 127
 128         my $editnum = new Number::Format(
 129             'int_curr_symbol'   => '',
 130             'thousands_sep'     => '',
 131             'mon_thousands_sep' => '',
 132             'mon_decimal_point' => '.'
 133         );
 134
 135         $$budgetperiod_hash{budget_period_total}= $editnum->format_price($$budgetperiod_hash{'budget_period_total'});
 136         $template->param(
 137                         %$budgetperiod_hash
 138         );
 139     } # IF-MOD
 140 }
 141
 142 elsif ( $op eq 'add_validate' ) {
 143 ## add or modify a budget period (confirmation)
 144
 145     ## update budget period data
 146         if ( $budget_period_id ne '' ) {
 147                 $$budget_period_hashref{$_}||=0 for qw(budget_period_active budget_period_locked);
 148                 my $status=ModBudgetPeriod($budget_period_hashref);
 149         }
 150         else {    # ELSE ITS AN ADD
 151                 my $budget_period_id=AddBudgetPeriod($budget_period_hashref);
 152         }
 153         $op='else';
 154 }
 155
 156 #--------------------------------------------------
 157 elsif ( $op eq 'delete_confirm' ) {
 158 ## delete a budget period (preparation)
 159     my $dbh = C4::Context->dbh;
 160     ## $total = number of records linked to the record that must be deleted
 161     my $total = 0;
 162     my $data = GetBudgetPeriod( $budget_period_id);
 163
 164         $$data{'budget_period_total'}=$num->format_price(  $data->{'budget_period_total'});
 165     $template->param(
 166                 %$data
 167     );
 168 }
 169
 170 elsif ( $op eq 'delete_confirmed' ) {
 171 ## delete the budget period record
 172
 173     my $data = GetBudgetPeriod( $budget_period_id);
 174     DelBudgetPeriod($budget_period_id);
 175         $op='else';
 176 }
 177
 178 # display the form for duplicating
 179 elsif ( $op eq 'duplicate_form'){
 180     my $budgetperiod = GetBudgetPeriod($budget_period_id, $input);
 181     $template->param(
 182         'duplicate_form' => '1',
 183         'budget_period_id' => $budget_period_id,
 184         'budgetperiod' => $budgetperiod,
 185     );
 186 }
 187
 188 # handle the actual duplication
 189 elsif ( $op eq 'duplicate_budget' ){
 190     die "please specify a budget period id\n" if( !defined $budget_period_id || $budget_period_id eq '' );
 191
 192     my $budget_period_startdate = dt_from_string $input->param('budget_period_startdate');
 193     my $budget_period_enddate   = dt_from_string $input->param('budget_period_enddate');
 194     my $budget_period_description = $input->param('budget_period_description');
 195     my $mark_original_budget_as_inactive = $input->param('mark_original_budget_as_inactive');
 196     my $reset_all_budgets = $input->param('reset_all_budgets');
 197
 198     my $new_budget_period_id = C4::Budgets::CloneBudgetPeriod(
 199         {
 200             budget_period_id        => $budget_period_id,
 201             budget_period_startdate => $budget_period_startdate,
 202             budget_period_enddate   => $budget_period_enddate,
 203             budget_period_description => $budget_period_description,
 204             mark_original_budget_as_inactive => $mark_original_budget_as_inactive,
 205             reset_all_budgets => $reset_all_budgets,
 206         }
 207     );
 208
 209     # display the list of budgets
 210     $op = 'else';
 211 }
 212
 213 elsif ( $op eq 'close_form' ) {
 214
 215     my $budget_period = GetBudgetPeriod($budget_period_id);
 216
 217     my $active_budget_periods =
 218       C4::Budgets::GetBudgetPeriods( { budget_period_active => 1 } );
 219
 220     # Remove the budget period from the list
 221     $active_budget_periods =
 222       [ map { ( $_->{budget_period_id} == $budget_period_id ) ? () : $_ }
 223           @$active_budget_periods ];
 224
 225     my $budgets_to_move = GetBudgetHierarchy($budget_period_id);
 226
 227     # C4::Context->userenv->{branchcode}, $show_mine ? $borrower_id : '')
 228
 229     my $number_of_unreceived_orders = 0;
 230     for my $budget (@$budgets_to_move) {
 231
 232         # We want to move funds from this budget
 233         my $unreceived_orders = C4::Acquisition::SearchOrders(
 234             {
 235                 budget_id => $budget->{budget_id},
 236                 pending   => 1,
 237             }
 238         );
 239         $budget->{unreceived_orders} = $unreceived_orders;
 240         $number_of_unreceived_orders += scalar(@$unreceived_orders);
 241     }
 242
 243     $template->param(
 244         close_form       => 1,
 245         budget_period_id => $budget_period_id,
 246         budget_period_description =>
 247           $budget_period->{budget_period_description},
 248         budget_periods              => $active_budget_periods,
 249         budgets_to_move             => $budgets_to_move,
 250         number_of_unreceived_orders => $number_of_unreceived_orders,
 251     );
 252 }
 253
 254 elsif ( $op eq 'close_confirmed' ) {
 255     my $to_budget_period_id    = $input->param('to_budget_period_id');
 256     my $move_remaining_unspent = $input->param('move_remaining_unspent');
 257     my $report                 = C4::Budgets::MoveOrders(
 258         {
 259             from_budget_period_id  => $budget_period_id,
 260             to_budget_period_id    => $to_budget_period_id,
 261             move_remaining_unspent => $move_remaining_unspent,
 262         }
 263     );
 264
 265     my $from_budget_period = GetBudgetPeriod($budget_period_id);
 266     my $to_budget_period   = GetBudgetPeriod($to_budget_period_id);
 267     $template->param(
 268         closed           => 1,
 269         budget_period_id => $from_budget_period->{budget_period_id},
 270         budget_period_description => $from_budget_period->{budget_period_description},
 271         from_budget_period => $from_budget_period,
 272         to_budget_period   => $to_budget_period,
 273         report             => $report,
 274     );
 275 }
 276
 277 # DEFAULT - DISPLAY AQPERIODS TABLE
 278 # -------------------------------------------------------------------
 279 # display the list of budget periods
 280
 281 my $activepage = $input->param('apage') || 1;
 282 my $inactivepage = $input->param('ipage') || 1;
 283 # Get active budget periods
 284 my $results = GetBudgetPeriods(
 285     { budget_period_active => 1 },
 286     { -asc => 'budget_period_description' },
 287 );
 288 my $first = ( $activepage - 1 ) * $activepagesize;
 289 my $last = min( $first + $activepagesize - 1, scalar @{$results} - 1, );
 290 my @period_active_loop;
 291
 292 foreach my $result ( @{$results}[ $first .. $last ] ) {
 293     my $budgetperiod = $result;
 294     $budgetperiod->{'budget_period_total'}     = $num->format_price( $budgetperiod->{'budget_period_total'} );
 295     $budgetperiod->{budget_active} = 1;
 296     push( @period_active_loop, $budgetperiod );
 297 }
 298 my $url = "aqbudgetperiods.pl";
 299 $url .=  "?ipage=$inactivepage" if($inactivepage != 1);
 300 my $active_pagination_bar = pagination_bar ($url, getnbpages( scalar(@$results), $activepagesize), $activepage, "apage");
 301
 302 # Get inactive budget periods
 303 $results = GetBudgetPeriods(
 304     { budget_period_active => 0 },
 305     { -desc => 'budget_period_enddate' },
 306 );
 307
 308 $first = ( $inactivepage - 1 ) * $inactivepagesize;
 309 $last = min( $first + $inactivepagesize - 1, scalar @{$results} - 1, );
 310 my @period_inactive_loop;
 311 foreach my $result ( @{$results}[ $first .. $last ] ) {
 312     my $budgetperiod = $result;
 313     $budgetperiod->{'budget_period_total'} = $num->format_price( $budgetperiod->{'budget_period_total'} );
 314     $budgetperiod->{budget_active} = 1;
 315     push( @period_inactive_loop, $budgetperiod );
 316 }
 317 $url = "aqbudgetperiods.pl?tab=2";
 318 $url .= "&apage=$activepage" if($activepage != 1);
 319 my $inactive_pagination_bar = pagination_bar ($url, getnbpages( scalar(@$results), $inactivepagesize), $inactivepage, "ipage");
 320
 321 my $tab = $input->param('tab') ? $input->param('tab') - 1 : 0;
 322 $template->param(
 323     period_active_loop      => \@period_active_loop,
 324     period_inactive_loop    => \@period_inactive_loop,
 325     active_pagination_bar   => $active_pagination_bar,
 326     inactive_pagination_bar => $inactive_pagination_bar,
 327     tab                     => $tab,
 328 );
 329
 330 $template->param($op=>1);
 331 output_html_with_http_headers $input, $cookie, $template->output;