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 Koha::DateUtils qw( dt_from_string );
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 GetBudgetPeriods ModBudgetPeriod AddBudgetPeriod GetBudgets DelBudgetPeriod CloneBudgetPeriod MoveOrders );
58 use Koha::Acquisition::Currencies;
60 my $dbh = C4::Context->dbh;
64 my $searchfield = $input->param('searchfield') // '';
65 my $budget_period_id = $input->param('budget_period_id');
66 my $op = $input->param('op')||"else";
67 #my $sort1_authcat = $input->param('sort1_authcat');
68 #my $sort2_authcat = $input->param('sort2_authcat');
70 # get only the columns of aqbudgetperiods in budget_period_hashref
71 my @columns = Koha::Database->new()->schema->source('Aqbudgetperiod')->columns;
72 my $budget_period_hashref = { map { join(' ',@columns) =~ /$_/ ? ( $_ => scalar $input->param($_) ) : () } keys( %{$input->Vars()} ) } ;
73 $budget_period_hashref->{budget_period_startdate} = dt_from_string( scalar $input->param('budget_period_startdate') );
74 $budget_period_hashref->{budget_period_enddate} = dt_from_string( scalar $input->param('budget_period_enddate') );
76 $searchfield =~ s/\,//g;
78 my ($template, $borrowernumber, $cookie, $staff_flags ) = get_template_and_user(
80 template_name => "admin/aqbudgetperiods.tt",
83 flagsrequired => { acquisition => 'period_manage' },
88 # This is used in incbudgets-active-currency.inc
89 my $active_currency = Koha::Acquisition::Currencies->get_active;
90 if ( $active_currency ) {
91 $template->param( symbol => $active_currency->symbol,
92 currency => $active_currency->currency
96 # ADD OR MODIFY A BUDGET PERIOD - BUILD SCREEN
97 if ( $op eq 'add_form' ) {
98 ## add or modify a budget period (preparation)
99 ## get information about the budget period that must be modified
101 if ($budget_period_id) { # MOD
102 my $budgetperiod_hash=GetBudgetPeriod($budget_period_id);
111 elsif ( $op eq 'add_validate' ) {
112 ## add or modify a budget period (confirmation)
114 ## update budget period data
115 if ( $budget_period_id ne '' ) {
116 $$budget_period_hashref{$_}||=0 for qw(budget_period_active budget_period_locked);
117 my $status=ModBudgetPeriod($budget_period_hashref);
119 else { # ELSE ITS AN ADD
120 my $budget_period_id=AddBudgetPeriod($budget_period_hashref);
125 #--------------------------------------------------
126 elsif ( $op eq 'delete_confirm' ) {
127 ## delete a budget period (preparation)
128 my $funds = GetBudgets({ budget_period_id => $budget_period_id });
129 my $fund_count = scalar @$funds;
130 if ( $fund_count > 0 ) {
131 $template->param( funds_exist => 1 );
134 #$total = number of records linked to the record that must be deleted
136 my $data = GetBudgetPeriod( $budget_period_id);
142 elsif ( $op eq 'delete_confirmed' ) {
143 ## confirm no funds have been added to budget
144 my $funds = GetBudgets({ budget_period_id => $budget_period_id });
145 my $fund_count = scalar @$funds;
146 if ( $fund_count > 0 ) {
147 $template->param( failed_delete_funds_exist => 1 );
149 ## delete the budget period record
150 my $data = GetBudgetPeriod( $budget_period_id);
151 DelBudgetPeriod($budget_period_id);
156 # display the form for duplicating
157 elsif ( $op eq 'duplicate_form'){
158 my $budgetperiod = GetBudgetPeriod($budget_period_id);
160 'duplicate_form' => '1',
161 'budget_period_id' => $budget_period_id,
162 'budgetperiod' => $budgetperiod,
166 # handle the actual duplication
167 elsif ( $op eq 'duplicate_budget' ){
168 die "please specify a budget period id\n" if( !defined $budget_period_id || $budget_period_id eq '' );
170 my $budget_period_startdate = dt_from_string scalar $input->param('budget_period_startdate');
171 my $budget_period_enddate = dt_from_string scalar $input->param('budget_period_enddate');
172 my $budget_period_description = $input->param('budget_period_description');
173 my $amount_change_percentage = $input->param('amount_change_percentage');
174 my $amount_change_round_increment = $input->param('amount_change_round_increment');
175 my $mark_original_budget_as_inactive = $input->param('mark_original_budget_as_inactive');
176 my $reset_all_budgets = $input->param('reset_all_budgets');
178 my $new_budget_period_id = CloneBudgetPeriod(
180 budget_period_id => $budget_period_id,
181 budget_period_startdate => $budget_period_startdate,
182 budget_period_enddate => $budget_period_enddate,
183 budget_period_description => $budget_period_description,
184 amount_change_percentage => $amount_change_percentage,
185 amount_change_round_increment => $amount_change_round_increment,
186 mark_original_budget_as_inactive => $mark_original_budget_as_inactive,
187 reset_all_budgets => $reset_all_budgets,
191 # display the list of budgets
195 elsif ( $op eq 'close_form' ) {
197 my $budget_period = GetBudgetPeriod($budget_period_id);
199 my $active_budget_periods =
200 GetBudgetPeriods( { budget_period_active => 1 } );
202 # Remove the budget period from the list
203 $active_budget_periods =
204 [ map { ( $_->{budget_period_id} == $budget_period_id ) ? () : $_ }
205 @$active_budget_periods ];
207 my $budgets_to_move = GetBudgetHierarchy($budget_period_id);
209 my $number_of_unreceived_orders = 0;
210 for my $budget (@$budgets_to_move) {
212 # We want to move funds from this budget
213 my $unreceived_orders = C4::Acquisition::SearchOrders(
215 budget_id => $budget->{budget_id},
219 $budget->{unreceived_orders} = $unreceived_orders;
220 $number_of_unreceived_orders += scalar(@$unreceived_orders);
225 budget_period_id => $budget_period_id,
226 budget_period_description =>
227 $budget_period->{budget_period_description},
228 budget_periods => $active_budget_periods,
229 budgets_to_move => $budgets_to_move,
230 number_of_unreceived_orders => $number_of_unreceived_orders,
234 elsif ( $op eq 'close_confirmed' ) {
235 my $to_budget_period_id = $input->param('to_budget_period_id');
236 my $move_remaining_unspent = $input->param('move_remaining_unspent');
237 my $report = MoveOrders(
239 from_budget_period_id => $budget_period_id,
240 to_budget_period_id => $to_budget_period_id,
241 move_remaining_unspent => $move_remaining_unspent,
245 my $from_budget_period = GetBudgetPeriod($budget_period_id);
246 my $to_budget_period = GetBudgetPeriod($to_budget_period_id);
249 budget_period_id => $from_budget_period->{budget_period_id},
250 budget_period_description => $from_budget_period->{budget_period_description},
251 from_budget_period => $from_budget_period,
252 to_budget_period => $to_budget_period,
257 # DEFAULT - DISPLAY AQPERIODS TABLE
258 # -------------------------------------------------------------------
259 # display the list of budget periods
261 my $activepage = $input->param('apage') || 1;
262 my $inactivepage = $input->param('ipage') || 1;
263 # Get active budget periods
264 my $results = GetBudgetPeriods(
265 { budget_period_active => 1 },
266 { -asc => 'budget_period_description' },
269 my @period_active_loop;
271 foreach my $result ( @{$results} ) {
272 my $budgetperiod = $result;
273 $budgetperiod->{budget_active} = 1;
274 my $funds = GetBudgets({ budget_period_id => $budgetperiod->{budget_period_id} });
275 $budgetperiod->{count} = scalar @$funds;
276 push( @period_active_loop, $budgetperiod );
279 # Get inactive budget periods
280 $results = GetBudgetPeriods(
281 { budget_period_active => 0 },
282 { -desc => 'budget_period_enddate' },
285 my @period_inactive_loop;
286 foreach my $result ( @{$results} ) {
287 my $budgetperiod = $result;
288 $budgetperiod->{budget_active} = 1;
289 my $funds = GetBudgets({ budget_period_id => $budgetperiod->{budget_period_id} });
290 $budgetperiod->{count} = scalar @$funds;
291 push( @period_inactive_loop, $budgetperiod );
294 my $tab = $input->param('tab') ? $input->param('tab') - 1 : 0;
296 period_active_loop => \@period_active_loop,
297 period_inactive_loop => \@period_inactive_loop,
301 $template->param($op=>1);
302 output_html_with_http_headers $input, $cookie, $template->output;