3 # Copyright 2008 BibLibre, BibLibre, Paul POULAIN
6 # This file is part of Koha.
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.
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.
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>.
21 =head1 admin/aqbudgetperiods.pl
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)
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.
32 - if primkey exists, this is a modification,so we read the $primkey record
33 - builds the add/modify form
35 - the user has just send datas, so we create/modify the record
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
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
50 use JSON qw( encode_json );
54 use C4::Auth qw( get_template_and_user );
55 use C4::Output qw( output_html_with_http_headers );
57 use C4::Budgets qw( GetBudgetPeriod GetBudgetHierarchy GetBudgetPeriods ModBudgetPeriod AddBudgetPeriod GetBudgets DelBudgetPeriod CloneBudgetPeriod MoveOrders );
58 use C4::Log qw(logaction);
59 use Koha::Acquisition::Currencies;
61 my $dbh = C4::Context->dbh;
65 my $searchfield = $input->param('searchfield') // '';
66 my $budget_period_id = $input->param('budget_period_id');
67 my $op = $input->param('op')||"else";
68 #my $sort1_authcat = $input->param('sort1_authcat');
69 #my $sort2_authcat = $input->param('sort2_authcat');
71 # get only the columns of aqbudgetperiods in budget_period_hashref
72 my @columns = Koha::Database->new()->schema->source('Aqbudgetperiod')->columns;
73 my $budget_period_hashref = { map { join(' ',@columns) =~ /$_/ ? ( $_ => scalar $input->param($_) ) : () } keys( %{$input->Vars()} ) } ;
74 $budget_period_hashref->{budget_period_startdate} = $input->param('budget_period_startdate');
75 $budget_period_hashref->{budget_period_enddate} = $input->param('budget_period_enddate');
77 $searchfield =~ s/\,//g;
79 my ($template, $borrowernumber, $cookie, $staff_flags ) = get_template_and_user(
81 template_name => "admin/aqbudgetperiods.tt",
84 flagsrequired => { acquisition => 'period_manage' },
89 # This is used in incbudgets-active-currency.inc
90 my $active_currency = Koha::Acquisition::Currencies->get_active;
91 if ( $active_currency ) {
92 $template->param( symbol => $active_currency->symbol,
93 currency => $active_currency->currency
97 # ADD OR MODIFY A BUDGET PERIOD - BUILD SCREEN
98 if ( $op eq 'add_form' ) {
99 ## add or modify a budget period (preparation)
100 ## get information about the budget period that must be modified
102 if ($budget_period_id) { # MOD
103 my $budgetperiod_hash=GetBudgetPeriod($budget_period_id);
112 elsif ( $op eq 'add_validate' ) {
113 ## add or modify a budget period (confirmation)
115 ## update budget period data
116 if ( $budget_period_id ne '' ) {
117 # Grab the previous values so we can log them
118 my $budgetperiod_old=GetBudgetPeriod($budget_period_id);
119 $$budget_period_hashref{$_}||=0 for qw(budget_period_active budget_period_locked);
120 my $status=ModBudgetPeriod($budget_period_hashref);
121 # Log the budget modification
122 if (C4::Context->preference("AcquisitionLog")) {
123 my $diff = 0 - ($budgetperiod_old->{budget_period_total} - $budget_period_hashref->{budget_period_total});
125 budget_period_startdate => $input->param('budget_period_startdate'),
126 budget_period_enddate => $input->param('budget_period_enddate'),
127 budget_period_total => $budget_period_hashref->{budget_period_total},
128 budget_period_startdate_old => $budgetperiod_old->{budget_period_startdate},
129 budget_period_enddate_old => $budgetperiod_old->{budget_period_enddate},
130 budget_period_total_old => $budgetperiod_old->{budget_period_total},
131 budget_period_total_change => $diff
141 else { # ELSE ITS AN ADD
142 my $budget_period_id=AddBudgetPeriod($budget_period_hashref);
147 #--------------------------------------------------
148 elsif ( $op eq 'delete_confirm' ) {
149 ## delete a budget period (preparation)
150 my $funds = GetBudgets({ budget_period_id => $budget_period_id });
151 my $fund_count = scalar @$funds;
152 if ( $fund_count > 0 ) {
153 $template->param( funds_exist => 1 );
156 #$total = number of records linked to the record that must be deleted
158 my $data = GetBudgetPeriod( $budget_period_id);
164 elsif ( $op eq 'delete_confirmed' ) {
165 ## confirm no funds have been added to budget
166 my $funds = GetBudgets({ budget_period_id => $budget_period_id });
167 my $fund_count = scalar @$funds;
168 if ( $fund_count > 0 ) {
169 $template->param( failed_delete_funds_exist => 1 );
171 ## delete the budget period record
172 my $data = GetBudgetPeriod( $budget_period_id);
173 DelBudgetPeriod($budget_period_id);
178 # display the form for duplicating
179 elsif ( $op eq 'duplicate_form'){
180 my $budgetperiod = GetBudgetPeriod($budget_period_id);
182 'duplicate_form' => '1',
183 'budget_period_id' => $budget_period_id,
184 'budgetperiod' => $budgetperiod,
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 '' );
192 my $budget_period_startdate = $input->param('budget_period_startdate');
193 my $budget_period_enddate = $input->param('budget_period_enddate');
194 my $budget_period_description = $input->param('budget_period_description');
195 my $amount_change_percentage = $input->param('amount_change_percentage');
196 my $amount_change_round_increment = $input->param('amount_change_round_increment');
197 my $mark_original_budget_as_inactive = $input->param('mark_original_budget_as_inactive');
198 my $reset_all_budgets = $input->param('reset_all_budgets');
200 my $new_budget_period_id = CloneBudgetPeriod(
202 budget_period_id => $budget_period_id,
203 budget_period_startdate => $budget_period_startdate,
204 budget_period_enddate => $budget_period_enddate,
205 budget_period_description => $budget_period_description,
206 amount_change_percentage => $amount_change_percentage,
207 amount_change_round_increment => $amount_change_round_increment,
208 mark_original_budget_as_inactive => $mark_original_budget_as_inactive,
209 reset_all_budgets => $reset_all_budgets,
213 # display the list of budgets
217 elsif ( $op eq 'close_form' ) {
219 my $budget_period = GetBudgetPeriod($budget_period_id);
221 my $active_budget_periods =
222 GetBudgetPeriods( { budget_period_active => 1 } );
224 # Remove the budget period from the list
225 $active_budget_periods =
226 [ map { ( $_->{budget_period_id} == $budget_period_id ) ? () : $_ }
227 @$active_budget_periods ];
229 my $budgets_to_move = GetBudgetHierarchy($budget_period_id);
231 my $number_of_unreceived_orders = 0;
232 for my $budget (@$budgets_to_move) {
234 # We want to move funds from this budget
235 my $unreceived_orders = C4::Acquisition::SearchOrders(
237 budget_id => $budget->{budget_id},
241 $budget->{unreceived_orders} = $unreceived_orders;
242 $number_of_unreceived_orders += scalar(@$unreceived_orders);
247 budget_period_id => $budget_period_id,
248 budget_period_description =>
249 $budget_period->{budget_period_description},
250 budget_periods => $active_budget_periods,
251 budgets_to_move => $budgets_to_move,
252 number_of_unreceived_orders => $number_of_unreceived_orders,
256 elsif ( $op eq 'close_confirmed' ) {
257 my $to_budget_period_id = $input->param('to_budget_period_id');
258 my $move_remaining_unspent = $input->param('move_remaining_unspent');
259 my $report = MoveOrders(
261 from_budget_period_id => $budget_period_id,
262 to_budget_period_id => $to_budget_period_id,
263 move_remaining_unspent => $move_remaining_unspent,
267 my $from_budget_period = GetBudgetPeriod($budget_period_id);
268 my $to_budget_period = GetBudgetPeriod($to_budget_period_id);
271 budget_period_id => $from_budget_period->{budget_period_id},
272 budget_period_description => $from_budget_period->{budget_period_description},
273 from_budget_period => $from_budget_period,
274 to_budget_period => $to_budget_period,
279 # DEFAULT - DISPLAY AQPERIODS TABLE
280 # -------------------------------------------------------------------
281 # display the list of budget periods
283 my $activepage = $input->param('apage') || 1;
284 my $inactivepage = $input->param('ipage') || 1;
285 # Get active budget periods
286 my $results = GetBudgetPeriods(
287 { budget_period_active => 1 },
288 { -asc => 'budget_period_description' },
291 my @period_active_loop;
293 foreach my $result ( @{$results} ) {
294 my $budgetperiod = $result;
295 $budgetperiod->{budget_active} = 1;
296 my $funds = GetBudgets({ budget_period_id => $budgetperiod->{budget_period_id} });
297 $budgetperiod->{count} = scalar @$funds;
298 push( @period_active_loop, $budgetperiod );
301 # Get inactive budget periods
302 $results = GetBudgetPeriods(
303 { budget_period_active => 0 },
304 { -desc => 'budget_period_enddate' },
307 my @period_inactive_loop;
308 foreach my $result ( @{$results} ) {
309 my $budgetperiod = $result;
310 $budgetperiod->{budget_active} = 1;
311 my $funds = GetBudgets({ budget_period_id => $budgetperiod->{budget_period_id} });
312 $budgetperiod->{count} = scalar @$funds;
313 push( @period_inactive_loop, $budgetperiod );
316 my $tab = $input->param('tab') ? $input->param('tab') - 1 : 0;
318 period_active_loop => \@period_active_loop,
319 period_inactive_loop => \@period_inactive_loop,
323 $template->param($op=>1);
324 output_html_with_http_headers $input, $cookie, $template->output;