Bug 12164: Close a budget period (budget)
[koha.git] / 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     $template->param(
181         'duplicate_form' => '1',
182         'budget_period_id' => $budget_period_id,
183     );
184 }
185
186 # handle the actual duplication
187 elsif ( $op eq 'duplicate_budget' ){
188     die "please specify a budget period id\n" if( !defined $budget_period_id || $budget_period_id eq '' );
189
190     my $budget_period_startdate = dt_from_string $input->param('budget_period_startdate');
191     my $budget_period_enddate   = dt_from_string $input->param('budget_period_enddate');
192     my $mark_original_budget_as_inactive = $input->param('mark_original_budget_as_inactive');
193     my $reset_all_budgets = $input->param('reset_all_budgets');
194
195     my $new_budget_period_id = C4::Budgets::CloneBudgetPeriod(
196         {
197             budget_period_id        => $budget_period_id,
198             budget_period_startdate => $budget_period_startdate,
199             budget_period_enddate   => $budget_period_enddate,
200             mark_original_budget_as_inactive => $mark_original_budget_as_inactive,
201             reset_all_budgets => $reset_all_budgets,
202         }
203     );
204
205     # display the list of budgets
206     $op = 'else';
207 }
208
209 elsif ( $op eq 'close_form' ) {
210
211     my $budget_period = GetBudgetPeriod($budget_period_id);
212
213     my $active_budget_periods =
214       C4::Budgets::GetBudgetPeriods( { budget_period_active => 1 } );
215
216     # Remove the budget period from the list
217     $active_budget_periods =
218       [ map { ( $_->{budget_period_id} == $budget_period_id ) ? () : $_ }
219           @$active_budget_periods ];
220
221     my $budgets_to_move = GetBudgetHierarchy($budget_period_id);
222
223     # C4::Context->userenv->{branchcode}, $show_mine ? $borrower_id : '')
224
225     my $number_of_unreceived_orders = 0;
226     for my $budget (@$budgets_to_move) {
227
228         # We want to move funds from this budget
229         my $unreceived_orders = C4::Acquisition::SearchOrders(
230             { budget_id => $budget->{budget_id}, } );
231         $budget->{unreceived_orders} = $unreceived_orders;
232         $number_of_unreceived_orders += scalar(@$unreceived_orders);
233     }
234
235     $template->param(
236         close_form       => 1,
237         budget_period_id => $budget_period_id,
238         budget_period_description =>
239           $budget_period->{budget_period_description},
240         budget_periods              => $active_budget_periods,
241         budgets_to_move             => $budgets_to_move,
242         number_of_unreceived_orders => $number_of_unreceived_orders,
243     );
244 }
245
246 elsif ( $op eq 'close_confirmed' ) {
247     my $to_budget_period_id = $input->param('to_budget_period_id');
248     my $report              = C4::Budgets::MoveOrders(
249         {
250             from_budget_period_id => $budget_period_id,
251             to_budget_period_id   => $to_budget_period_id,
252         }
253     );
254 }
255
256 # DEFAULT - DISPLAY AQPERIODS TABLE
257 # -------------------------------------------------------------------
258 # display the list of budget periods
259
260 my $activepage = $input->param('apage') || 1;
261 my $inactivepage = $input->param('ipage') || 1;
262 # Get active budget periods
263 my $results = GetBudgetPeriods(
264     { budget_period_active => 1 },
265     { -asc => 'budget_period_description' },
266 );
267 my $first = ( $activepage - 1 ) * $activepagesize;
268 my $last = min( $first + $activepagesize - 1, scalar @{$results} - 1, );
269 my @period_active_loop;
270
271 foreach my $result ( @{$results}[ $first .. $last ] ) {
272     my $budgetperiod = $result;
273     $budgetperiod->{'budget_period_total'}     = $num->format_price( $budgetperiod->{'budget_period_total'} );
274     $budgetperiod->{budget_active} = 1;
275     push( @period_active_loop, $budgetperiod );
276 }
277 my $url = "aqbudgetperiods.pl";
278 $url .=  "?ipage=$inactivepage" if($inactivepage != 1);
279 my $active_pagination_bar = pagination_bar ($url, getnbpages( scalar(@$results), $activepagesize), $activepage, "apage");
280
281 # Get inactive budget periods
282 $results = GetBudgetPeriods(
283     { budget_period_active => 0 },
284     { -desc => 'budget_period_enddate' },
285 );
286
287 $first = ( $inactivepage - 1 ) * $inactivepagesize;
288 $last = min( $first + $inactivepagesize - 1, scalar @{$results} - 1, );
289 my @period_inactive_loop;
290 foreach my $result ( @{$results}[ $first .. $last ] ) {
291     my $budgetperiod = $result;
292     $budgetperiod->{'budget_period_total'} = $num->format_price( $budgetperiod->{'budget_period_total'} );
293     $budgetperiod->{budget_active} = 1;
294     push( @period_inactive_loop, $budgetperiod );
295 }
296 $url = "aqbudgetperiods.pl?tab=2";
297 $url .= "&apage=$activepage" if($activepage != 1);
298 my $inactive_pagination_bar = pagination_bar ($url, getnbpages( scalar(@$results), $inactivepagesize), $inactivepage, "ipage");
299
300 my $tab = $input->param('tab') ? $input->param('tab') - 1 : 0;
301 $template->param(
302     period_active_loop      => \@period_active_loop,
303     period_inactive_loop    => \@period_inactive_loop,
304     active_pagination_bar   => $active_pagination_bar,
305     inactive_pagination_bar => $inactive_pagination_bar,
306     tab                     => $tab,
307 );
308
309 $template->param($op=>1);
310 output_html_with_http_headers $input, $cookie, $template->output;