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
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  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 CGI qw ( -utf8 );
  50 use List::Util qw/min/;
  51 use Koha::DateUtils;
  52 use Koha::Database;
  53 use C4::Koha;
  54 use C4::Context;
  55 use C4::Auth;
  56 use C4::Output;
  57 use C4::Acquisition;
  58 use C4::Budgets;
  59 use C4::Debug;
  60 use Koha::Acquisition::Currencies;
  61
  62 my $dbh = C4::Context->dbh;
  63
  64 my $input       = CGI->new;
  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) =~ /$_/ ? ( $_ => scalar $input->param($_) )  : () } keys( %{$input->Vars()} ) } ;
  75 $budget_period_hashref->{budget_period_startdate} = dt_from_string( scalar $input->param('budget_period_startdate') );
  76 $budget_period_hashref->{budget_period_enddate}   = dt_from_string( scalar $input->param('budget_period_enddate') );
  77
  78 $searchfield =~ s/\,//g;
  79
  80 my ($template, $borrowernumber, $cookie, $staff_flags ) = get_template_and_user(
  81     {
  82         template_name   => "admin/aqbudgetperiods.tt",
  83         query           => $input,
  84         type            => "intranet",
  85         flagsrequired   => { acquisition => 'period_manage' },
  86         debug           => 1,
  87     }
  88 );
  89
  90
  91 # This is used in incbudgets-active-currency.inc
  92 my $active_currency = Koha::Acquisition::Currencies->get_active;
  93 if ( $active_currency ) {
  94     $template->param( symbol => $active_currency->symbol,
  95                       currency => $active_currency->currency
  96                    );
  97 }
  98
  99 # ADD OR MODIFY A BUDGET PERIOD - BUILD SCREEN
 100 if ( $op eq 'add_form' ) {
 101     ## add or modify a budget period (preparation)
 102     ## get information about the budget period that must be modified
 103
 104     if ($budget_period_id) {    # MOD
 105                 my $budgetperiod_hash=GetBudgetPeriod($budget_period_id);
 106         # get dropboxes
 107
 108         $template->param(
 109                         %$budgetperiod_hash
 110         );
 111     } # IF-MOD
 112 }
 113
 114 elsif ( $op eq 'add_validate' ) {
 115 ## add or modify a budget period (confirmation)
 116
 117     ## update budget period data
 118         if ( $budget_period_id ne '' ) {
 119                 $$budget_period_hashref{$_}||=0 for qw(budget_period_active budget_period_locked);
 120                 my $status=ModBudgetPeriod($budget_period_hashref);
 121         }
 122         else {    # ELSE ITS AN ADD
 123                 my $budget_period_id=AddBudgetPeriod($budget_period_hashref);
 124         }
 125         $op='else';
 126 }
 127
 128 #--------------------------------------------------
 129 elsif ( $op eq 'delete_confirm' ) {
 130 ## delete a budget period (preparation)
 131     my $funds = GetBudgets({ budget_period_id => $budget_period_id });
 132     my $fund_count = scalar @$funds;
 133     if ( $fund_count > 0 ) {
 134         $template->param( funds_exist => 1 );
 135     }
 136
 137     #$total = number of records linked to the record that must be deleted
 138     my $total = 0;
 139     my $data = GetBudgetPeriod( $budget_period_id);
 140     $template->param(
 141         %$data
 142     );
 143 }
 144
 145 elsif ( $op eq 'delete_confirmed' ) {
 146     ## confirm no funds have been added to budget
 147     my $funds = GetBudgets({ budget_period_id => $budget_period_id });
 148     my $fund_count = scalar @$funds;
 149     if ( $fund_count > 0 ) {
 150         $template->param( failed_delete_funds_exist => 1 );
 151     } else {
 152         ## delete the budget period record
 153         my $data = GetBudgetPeriod( $budget_period_id);
 154         DelBudgetPeriod($budget_period_id);
 155     }
 156         $op='else';
 157 }
 158
 159 # display the form for duplicating
 160 elsif ( $op eq 'duplicate_form'){
 161     my $budgetperiod = GetBudgetPeriod($budget_period_id);
 162     $template->param(
 163         'duplicate_form' => '1',
 164         'budget_period_id' => $budget_period_id,
 165         'budgetperiod' => $budgetperiod,
 166     );
 167 }
 168
 169 # handle the actual duplication
 170 elsif ( $op eq 'duplicate_budget' ){
 171     die "please specify a budget period id\n" if( !defined $budget_period_id || $budget_period_id eq '' );
 172
 173     my $budget_period_startdate = dt_from_string scalar $input->param('budget_period_startdate');
 174     my $budget_period_enddate   = dt_from_string scalar $input->param('budget_period_enddate');
 175     my $budget_period_description = $input->param('budget_period_description');
 176     my $amount_change_percentage = $input->param('amount_change_percentage');
 177     my $amount_change_round_increment = $input->param('amount_change_round_increment');
 178     my $mark_original_budget_as_inactive = $input->param('mark_original_budget_as_inactive');
 179     my $reset_all_budgets = $input->param('reset_all_budgets');
 180
 181     my $new_budget_period_id = C4::Budgets::CloneBudgetPeriod(
 182         {
 183             budget_period_id        => $budget_period_id,
 184             budget_period_startdate => $budget_period_startdate,
 185             budget_period_enddate   => $budget_period_enddate,
 186             budget_period_description => $budget_period_description,
 187             amount_change_percentage => $amount_change_percentage,
 188             amount_change_round_increment => $amount_change_round_increment,
 189             mark_original_budget_as_inactive => $mark_original_budget_as_inactive,
 190             reset_all_budgets => $reset_all_budgets,
 191         }
 192     );
 193
 194     # display the list of budgets
 195     $op = 'else';
 196 }
 197
 198 elsif ( $op eq 'close_form' ) {
 199
 200     my $budget_period = GetBudgetPeriod($budget_period_id);
 201
 202     my $active_budget_periods =
 203       C4::Budgets::GetBudgetPeriods( { budget_period_active => 1 } );
 204
 205     # Remove the budget period from the list
 206     $active_budget_periods =
 207       [ map { ( $_->{budget_period_id} == $budget_period_id ) ? () : $_ }
 208           @$active_budget_periods ];
 209
 210     my $budgets_to_move = GetBudgetHierarchy($budget_period_id);
 211
 212     my $number_of_unreceived_orders = 0;
 213     for my $budget (@$budgets_to_move) {
 214
 215         # We want to move funds from this budget
 216         my $unreceived_orders = C4::Acquisition::SearchOrders(
 217             {
 218                 budget_id => $budget->{budget_id},
 219                 pending   => 1,
 220             }
 221         );
 222         $budget->{unreceived_orders} = $unreceived_orders;
 223         $number_of_unreceived_orders += scalar(@$unreceived_orders);
 224     }
 225
 226     $template->param(
 227         close_form       => 1,
 228         budget_period_id => $budget_period_id,
 229         budget_period_description =>
 230           $budget_period->{budget_period_description},
 231         budget_periods              => $active_budget_periods,
 232         budgets_to_move             => $budgets_to_move,
 233         number_of_unreceived_orders => $number_of_unreceived_orders,
 234     );
 235 }
 236
 237 elsif ( $op eq 'close_confirmed' ) {
 238     my $to_budget_period_id    = $input->param('to_budget_period_id');
 239     my $move_remaining_unspent = $input->param('move_remaining_unspent');
 240     my $report                 = C4::Budgets::MoveOrders(
 241         {
 242             from_budget_period_id  => $budget_period_id,
 243             to_budget_period_id    => $to_budget_period_id,
 244             move_remaining_unspent => $move_remaining_unspent,
 245         }
 246     );
 247
 248     my $from_budget_period = GetBudgetPeriod($budget_period_id);
 249     my $to_budget_period   = GetBudgetPeriod($to_budget_period_id);
 250     $template->param(
 251         closed           => 1,
 252         budget_period_id => $from_budget_period->{budget_period_id},
 253         budget_period_description => $from_budget_period->{budget_period_description},
 254         from_budget_period => $from_budget_period,
 255         to_budget_period   => $to_budget_period,
 256         report             => $report,
 257     );
 258 }
 259
 260 # DEFAULT - DISPLAY AQPERIODS TABLE
 261 # -------------------------------------------------------------------
 262 # display the list of budget periods
 263
 264 my $activepage = $input->param('apage') || 1;
 265 my $inactivepage = $input->param('ipage') || 1;
 266 # Get active budget periods
 267 my $results = GetBudgetPeriods(
 268     { budget_period_active => 1 },
 269     { -asc => 'budget_period_description' },
 270 );
 271
 272 my @period_active_loop;
 273
 274 foreach my $result ( @{$results} ) {
 275     my $budgetperiod = $result;
 276     $budgetperiod->{budget_active} = 1;
 277     my $funds = GetBudgets({ budget_period_id => $budgetperiod->{budget_period_id} });
 278     $budgetperiod->{count} = scalar @$funds;
 279     push( @period_active_loop, $budgetperiod );
 280 }
 281
 282 # Get inactive budget periods
 283 $results = GetBudgetPeriods(
 284     { budget_period_active => 0 },
 285     { -desc => 'budget_period_enddate' },
 286 );
 287
 288 my @period_inactive_loop;
 289 foreach my $result ( @{$results} ) {
 290     my $budgetperiod = $result;
 291     $budgetperiod->{budget_active} = 1;
 292     my $funds = GetBudgets({ budget_period_id => $budgetperiod->{budget_period_id} });
 293     $budgetperiod->{count} = scalar @$funds;
 294     push( @period_inactive_loop, $budgetperiod );
 295 }
 296
 297 my $tab = $input->param('tab') ? $input->param('tab') - 1 : 0;
 298 $template->param(
 299     period_active_loop      => \@period_active_loop,
 300     period_inactive_loop    => \@period_inactive_loop,
 301     tab                     => $tab,
 302 );
 303
 304 $template->param($op=>1);
 305 output_html_with_http_headers $input, $cookie, $template->output;