Bug 24217: use Modern::Perl for modules when strict is missing
[koha.git] / C4 / Budgets.pm
1 package C4::Budgets;
2
3 # Copyright 2000-2002 Katipo Communications
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
19
20 use Modern::Perl;
21 use C4::Context;
22 use Koha::Database;
23 use Koha::Patrons;
24 use Koha::Acquisition::Invoice::Adjustments;
25 use C4::Debug;
26 use C4::Acquisition;
27 use vars qw(@ISA @EXPORT);
28
29 BEGIN {
30         require Exporter;
31         @ISA    = qw(Exporter);
32         @EXPORT = qw(
33
34         &GetBudget
35         &GetBudgetByOrderNumber
36         &GetBudgetByCode
37         &GetBudgets
38         &BudgetsByActivity
39         &GetBudgetsReport
40         &GetBudgetReport
41         &GetBudgetHierarchy
42             &AddBudget
43         &ModBudget
44         &DelBudget
45         &GetBudgetSpent
46         &GetBudgetOrdered
47         &GetBudgetName
48         &GetPeriodsCount
49         GetBudgetHierarchySpent
50         GetBudgetHierarchyOrdered
51
52         &GetBudgetUsers
53         &ModBudgetUsers
54         &CanUserUseBudget
55         &CanUserModifyBudget
56
57             &GetBudgetPeriod
58         &GetBudgetPeriods
59         &ModBudgetPeriod
60         &AddBudgetPeriod
61             &DelBudgetPeriod
62
63         &ModBudgetPlan
64
65                 &GetBudgetsPlanCell
66         &AddBudgetPlanValue
67         &GetBudgetAuthCats
68         &BudgetHasChildren
69         &CheckBudgetParent
70         &CheckBudgetParentPerm
71
72         &HideCols
73         &GetCols
74         );
75 }
76
77 # ----------------------------BUDGETS.PM-----------------------------";
78
79 =head1 FUNCTIONS ABOUT BUDGETS
80
81 =cut
82
83 sub HideCols {
84     my ( $authcat, @hide_cols ) = @_;
85     my $dbh = C4::Context->dbh;
86
87     my $sth1 = $dbh->prepare(
88         qq|
89         UPDATE aqbudgets_planning SET display = 0 
90         WHERE authcat = ? 
91         AND  authvalue = ? |
92     );
93     foreach my $authvalue (@hide_cols) {
94 #        $sth1->{TraceLevel} = 3;
95         $sth1->execute(  $authcat, $authvalue );
96     }
97 }
98
99 sub GetCols {
100     my ( $authcat, $authvalue ) = @_;
101
102     my $dbh = C4::Context->dbh;
103     my $sth = $dbh->prepare(
104         qq|
105         SELECT count(display) as cnt from aqbudgets_planning
106         WHERE  authcat = ? 
107         AND authvalue = ? and display  = 0   |
108     );
109
110 #    $sth->{TraceLevel} = 3;
111     $sth->execute( $authcat, $authvalue );
112     my $res  = $sth->fetchrow_hashref;
113
114     return  $res->{cnt} > 0 ? 0: 1
115
116 }
117
118 sub CheckBudgetParentPerm {
119     my ( $budget, $borrower_id ) = @_;
120     my $depth = $budget->{depth};
121     my $parent_id = $budget->{budget_parent_id};
122     while ($depth) {
123         my $parent = GetBudget($parent_id);
124         $parent_id = $parent->{budget_parent_id};
125         if ( $parent->{budget_owner_id} == $borrower_id ) {
126             return 1;
127         }
128         $depth--
129     }
130     return 0;
131 }
132
133 sub AddBudgetPeriod {
134     my ($budgetperiod) = @_;
135     return unless($budgetperiod->{budget_period_startdate} && $budgetperiod->{budget_period_enddate});
136
137     undef $budgetperiod->{budget_period_id};
138     my $resultset = Koha::Database->new()->schema->resultset('Aqbudgetperiod');
139     return $resultset->create($budgetperiod)->id;
140 }
141 # -------------------------------------------------------------------
142 sub GetPeriodsCount {
143     my $dbh = C4::Context->dbh;
144     my $sth = $dbh->prepare("
145         SELECT COUNT(*) AS sum FROM aqbudgetperiods ");
146     $sth->execute();
147     my $res = $sth->fetchrow_hashref;
148     return $res->{'sum'};
149 }
150
151 # -------------------------------------------------------------------
152 sub CheckBudgetParent {
153     my ( $new_parent, $budget ) = @_;
154     my $new_parent_id = $new_parent->{'budget_id'};
155     my $budget_id     = $budget->{'budget_id'};
156     my $dbh           = C4::Context->dbh;
157     my $parent_id_tmp = $new_parent_id;
158
159     # check new-parent is not a child (or a child's child ;)
160     my $sth = $dbh->prepare(qq|
161         SELECT budget_parent_id FROM
162             aqbudgets where budget_id = ? | );
163     while (1) {
164         $sth->execute($parent_id_tmp);
165         my $res = $sth->fetchrow_hashref;
166         if ( $res->{'budget_parent_id'} == $budget_id ) {
167             return 1;
168         }
169         if ( not defined $res->{'budget_parent_id'} ) {
170             return 0;
171         }
172         $parent_id_tmp = $res->{'budget_parent_id'};
173     }
174 }
175
176 # -------------------------------------------------------------------
177 sub BudgetHasChildren {
178     my ( $budget_id  ) = @_;
179     my $dbh = C4::Context->dbh;
180     my $sth = $dbh->prepare(qq|
181        SELECT count(*) as sum FROM  aqbudgets
182         WHERE budget_parent_id = ?   | );
183     $sth->execute( $budget_id );
184     my $sum = $sth->fetchrow_hashref;
185     return $sum->{'sum'};
186 }
187
188 sub GetBudgetChildren {
189     my ( $budget_id ) = @_;
190     my $dbh = C4::Context->dbh;
191     return $dbh->selectall_arrayref(q|
192        SELECT  * FROM  aqbudgets
193         WHERE budget_parent_id = ?
194     |, { Slice => {} }, $budget_id );
195 }
196
197 sub SetOwnerToFundHierarchy {
198     my ( $budget_id, $borrowernumber ) = @_;
199
200     my $budget = GetBudget( $budget_id );
201     $budget->{budget_owner_id} = $borrowernumber;
202     ModBudget( $budget );
203     my $children = GetBudgetChildren( $budget_id );
204     for my $child ( @$children ) {
205         SetOwnerToFundHierarchy( $child->{budget_id}, $borrowernumber );
206     }
207 }
208
209 # -------------------------------------------------------------------
210 sub GetBudgetsPlanCell {
211     my ( $cell, $period, $budget ) = @_; #FIXME we don't use $period
212     my ($actual, $sth);
213     my $dbh = C4::Context->dbh;
214     my $roundsql = C4::Acquisition::get_rounding_sql(qq|ecost_tax_included|);
215     if ( $cell->{'authcat'} eq 'MONTHS' ) {
216         # get the actual amount
217         # FIXME we should consider quantity
218         $sth = $dbh->prepare( qq|
219
220             SELECT SUM(| .  $roundsql . qq|) AS actual FROM aqorders
221                 WHERE    budget_id = ? AND
222                 entrydate like "$cell->{'authvalue'}%"  |
223         );
224         $sth->execute( $cell->{'budget_id'} );
225     } elsif ( $cell->{'authcat'} eq 'BRANCHES' ) {
226         # get the actual amount
227         # FIXME we should consider quantity
228         $sth = $dbh->prepare( qq|
229
230             SELECT SUM(| . $roundsql . qq|) FROM aqorders
231                 LEFT JOIN aqorders_items
232                 ON (aqorders.ordernumber = aqorders_items.ordernumber)
233                 LEFT JOIN items
234                 ON (aqorders_items.itemnumber = items.itemnumber)
235                 WHERE budget_id = ? AND homebranch = ? |          );
236
237         $sth->execute( $cell->{'budget_id'}, $cell->{'authvalue'} );
238     } elsif ( $cell->{'authcat'} eq 'ITEMTYPES' ) {
239         # get the actual amount
240         $sth = $dbh->prepare(  qq|
241
242             SELECT SUM( | . $roundsql . qq| *  quantity) AS actual
243                 FROM aqorders JOIN biblioitems
244                 ON (biblioitems.biblionumber = aqorders.biblionumber )
245                 WHERE aqorders.budget_id = ? and itemtype  = ? |
246         );
247         $sth->execute(  $cell->{'budget_id'},
248                         $cell->{'authvalue'} );
249     }
250     # ELSE GENERIC ORDERS SORT1/SORT2 STAT COUNT.
251     else {
252         # get the actual amount
253         $sth = $dbh->prepare( qq|
254
255         SELECT  SUM(| . $roundsql . qq| * quantity) AS actual
256             FROM aqorders
257             JOIN aqbudgets ON (aqbudgets.budget_id = aqorders.budget_id )
258             WHERE  aqorders.budget_id = ? AND
259                 ((aqbudgets.sort1_authcat = ? AND sort1 =?) OR
260                 (aqbudgets.sort2_authcat = ? AND sort2 =?))    |
261         );
262         $sth->execute(  $cell->{'budget_id'},
263                         $budget->{'sort1_authcat'},
264                         $cell->{'authvalue'},
265                         $budget->{'sort2_authcat'},
266                         $cell->{'authvalue'}
267         );
268     }
269     $actual = $sth->fetchrow_array;
270
271     # get the estimated amount
272     $sth = $dbh->prepare( qq|
273
274         SELECT estimated_amount AS estimated, display FROM aqbudgets_planning
275             WHERE budget_period_id = ? AND
276                 budget_id = ? AND
277                 authvalue = ? AND
278                 authcat = ?         |
279     );
280     $sth->execute(  $cell->{'budget_period_id'},
281                     $cell->{'budget_id'},
282                     $cell->{'authvalue'},
283                     $cell->{'authcat'},
284     );
285
286
287     my $res  = $sth->fetchrow_hashref;
288   #  my $display = $res->{'display'};
289     my $estimated = $res->{'estimated'};
290
291
292     return $actual, $estimated;
293 }
294
295 # -------------------------------------------------------------------
296 sub ModBudgetPlan {
297     my ( $budget_plan, $budget_period_id, $authcat ) = @_;
298     my $dbh = C4::Context->dbh;
299     foreach my $buds (@$budget_plan) {
300         my $lines = $buds->{lines};
301         my $sth = $dbh->prepare( qq|
302                 DELETE FROM aqbudgets_planning
303                     WHERE   budget_period_id   = ? AND
304                             budget_id   = ? AND
305                             authcat            = ? |
306         );
307     #delete a aqplan line of cells, then insert new cells, 
308     # these could be UPDATES rather than DEL/INSERTS...
309         $sth->execute( $budget_period_id,  $lines->[0]{budget_id}   , $authcat );
310
311         foreach my $cell (@$lines) {
312             my $sth = $dbh->prepare( qq|
313
314                 INSERT INTO aqbudgets_planning
315                      SET   budget_id     = ?,
316                      budget_period_id  = ?,
317                      authcat          = ?,
318                      estimated_amount  = ?,
319                      authvalue       = ?  |
320             );
321             $sth->execute(
322                             $cell->{'budget_id'},
323                             $cell->{'budget_period_id'},
324                             $cell->{'authcat'},
325                             $cell->{'estimated_amount'},
326                             $cell->{'authvalue'},
327             );
328         }
329     }
330 }
331
332 # -------------------------------------------------------------------
333 sub GetBudgetSpent {
334     my ($budget_id) = @_;
335     my $dbh = C4::Context->dbh;
336     # unitprice_tax_included should always been set here
337     # we should not need to retrieve ecost_tax_included
338     my $sth = $dbh->prepare(qq|
339         SELECT SUM( | . C4::Acquisition::get_rounding_sql("COALESCE(unitprice_tax_included, ecost_tax_included)") . qq| * quantity ) AS sum FROM aqorders
340             WHERE budget_id = ? AND
341             quantityreceived > 0 AND
342             datecancellationprinted IS NULL
343     |);
344         $sth->execute($budget_id);
345     my $sum = 0 + $sth->fetchrow_array;
346
347     $sth = $dbh->prepare(qq|
348         SELECT SUM(shipmentcost) AS sum
349         FROM aqinvoices
350         WHERE shipmentcost_budgetid = ?
351     |);
352
353     $sth->execute($budget_id);
354     my ($shipmentcost_sum) = $sth->fetchrow_array;
355     $sum += $shipmentcost_sum;
356
357     my $adjustments = Koha::Acquisition::Invoice::Adjustments->search({budget_id => $budget_id, closedate => { '!=' => undef } },{ join => 'invoiceid' });
358     while ( my $adj = $adjustments->next ){
359         $sum += $adj->adjustment;
360     }
361
362         return $sum;
363 }
364
365 # -------------------------------------------------------------------
366 sub GetBudgetOrdered {
367         my ($budget_id) = @_;
368         my $dbh = C4::Context->dbh;
369         my $sth = $dbh->prepare(qq|
370         SELECT SUM(| . C4::Acquisition::get_rounding_sql(qq|ecost_tax_included|) . qq| *  quantity) AS sum FROM aqorders
371             WHERE budget_id = ? AND
372             quantityreceived = 0 AND
373             datecancellationprinted IS NULL
374     |);
375         $sth->execute($budget_id);
376     my $sum =  0 + $sth->fetchrow_array;
377
378     my $adjustments = Koha::Acquisition::Invoice::Adjustments->search({budget_id => $budget_id, encumber_open => 1, closedate => undef},{ join => 'invoiceid' });
379     while ( my $adj = $adjustments->next ){
380         $sum += $adj->adjustment;
381     }
382
383         return $sum;
384 }
385
386 =head2 GetBudgetName
387
388   my $budget_name = &GetBudgetName($budget_id);
389
390 get the budget_name for a given budget_id
391
392 =cut
393
394 sub GetBudgetName {
395     my ( $budget_id ) = @_;
396     my $dbh         = C4::Context->dbh;
397     my $sth         = $dbh->prepare(
398         qq|
399         SELECT budget_name
400         FROM aqbudgets
401         WHERE budget_id = ?
402     |);
403
404     $sth->execute($budget_id);
405     return $sth->fetchrow_array;
406 }
407
408 =head2 GetBudgetAuthCats
409
410   my $auth_cats = &GetBudgetAuthCats($budget_period_id);
411
412 Return the list of authcat for a given budget_period_id
413
414 =cut
415
416 sub GetBudgetAuthCats  {
417     my ($budget_period_id) = shift;
418     # now, populate the auth_cats_loop used in the budget planning button
419     # we must retrieve all auth values used by at least one budget
420     my $dbh = C4::Context->dbh;
421     my $sth=$dbh->prepare("SELECT sort1_authcat,sort2_authcat FROM aqbudgets WHERE budget_period_id=?");
422     $sth->execute($budget_period_id);
423     my %authcats;
424     while (my ($sort1_authcat,$sort2_authcat) = $sth->fetchrow) {
425         $authcats{$sort1_authcat}=1 if $sort1_authcat;
426         $authcats{$sort2_authcat}=1 if $sort2_authcat;
427     }
428     return [ sort keys %authcats ];
429 }
430
431 # -------------------------------------------------------------------
432 sub GetBudgetPeriods {
433         my ($filters,$orderby) = @_;
434
435     my $rs = Koha::Database->new()->schema->resultset('Aqbudgetperiod');
436     $rs = $rs->search( $filters, { order_by => $orderby } );
437     $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
438     return [ $rs->all ];
439 }
440 # -------------------------------------------------------------------
441 sub GetBudgetPeriod {
442     my ($budget_period_id) = @_;
443     my $dbh = C4::Context->dbh;
444     my $sth = $dbh->prepare( qq|
445         SELECT      *
446         FROM aqbudgetperiods
447         WHERE budget_period_id=? |
448     );
449     $sth->execute($budget_period_id);
450     return $sth->fetchrow_hashref;
451 }
452
453 sub DelBudgetPeriod{
454         my ($budget_period_id) = @_;
455         my $dbh = C4::Context->dbh;
456           ; ## $total = number of records linked to the record that must be deleted
457     my $total = 0;
458
459         ## get information about the record that will be deleted
460         my $sth = $dbh->prepare(qq|
461                 DELETE 
462          FROM aqbudgetperiods
463          WHERE budget_period_id=? |
464         );
465         return $sth->execute($budget_period_id);
466 }
467
468 # -------------------------------------------------------------------
469 sub ModBudgetPeriod {
470     my ($budget_period) = @_;
471     my $result = Koha::Database->new()->schema->resultset('Aqbudgetperiod')->find($budget_period);
472     return unless($result);
473
474     $result = $result->update($budget_period);
475     return $result->in_storage;
476 }
477
478 # -------------------------------------------------------------------
479 sub GetBudgetHierarchy {
480     my ( $budget_period_id, $branchcode, $owner ) = @_;
481     my @bind_params;
482     my $dbh   = C4::Context->dbh;
483     my $query = qq|
484                     SELECT aqbudgets.*, aqbudgetperiods.budget_period_active, aqbudgetperiods.budget_period_description,
485                            b.firstname as budget_owner_firstname, b.surname as budget_owner_surname, b.borrowernumber as budget_owner_borrowernumber
486                     FROM aqbudgets 
487                     LEFT JOIN borrowers b on b.borrowernumber = aqbudgets.budget_owner_id
488                     JOIN aqbudgetperiods USING (budget_period_id)|;
489
490         my @where_strings;
491     # show only period X if requested
492     if ($budget_period_id) {
493         push @where_strings," aqbudgets.budget_period_id = ?";
494         push @bind_params, $budget_period_id;
495     }
496         # show only budgets owned by me, my branch or everyone
497     if ($owner) {
498         if ($branchcode) {
499             push @where_strings,
500             qq{ (budget_owner_id = ? OR budget_branchcode = ? OR ((budget_branchcode IS NULL or budget_branchcode="") AND (budget_owner_id IS NULL OR budget_owner_id="")))};
501             push @bind_params, ( $owner, $branchcode );
502         } else {
503             push @where_strings, ' (budget_owner_id = ? OR budget_owner_id IS NULL or budget_owner_id ="") ';
504             push @bind_params, $owner;
505         }
506     } else {
507         if ($branchcode) {
508             push @where_strings," (budget_branchcode =? or budget_branchcode is NULL OR budget_branchcode='')";
509             push @bind_params, $branchcode;
510         }
511     }
512         $query.=" WHERE ".join(' AND ', @where_strings) if @where_strings;
513         $debug && warn $query,join(",",@bind_params);
514         my $sth = $dbh->prepare($query);
515         $sth->execute(@bind_params);
516
517     my %links;
518     # create hash with budget_id has key
519     while ( my $data = $sth->fetchrow_hashref ) {
520         $links{ $data->{'budget_id'} } = $data;
521     }
522
523     # link child to parent
524     my @first_parents;
525     foreach my $budget ( sort { $a->{budget_code} cmp $b->{budget_code} } values %links ) {
526         my $child = $links{$budget->{budget_id}};
527         if ( $child->{'budget_parent_id'} ) {
528             my $parent = $links{ $child->{'budget_parent_id'} };
529             if ($parent) {
530                 unless ( $parent->{'children'} ) {
531                     # init child arrayref
532                     $parent->{'children'} = [];
533                 }
534                 # add as child
535                 push @{ $parent->{'children'} }, $child;
536             }
537         } else {
538             push @first_parents, $child;
539         }
540     }
541
542     my @sort = ();
543     foreach my $first_parent (@first_parents) {
544         _add_budget_children(\@sort, $first_parent, 0);
545     }
546
547     # Get all the budgets totals in as few queries as possible
548     my $hr_budget_spent = $dbh->selectall_hashref(q|
549         SELECT aqorders.budget_id, aqbudgets.budget_parent_id,
550                SUM( | . C4::Acquisition::get_rounding_sql(qq|COALESCE(unitprice_tax_included, ecost_tax_included)|) . q| * quantity ) AS budget_spent
551         FROM aqorders JOIN aqbudgets USING (budget_id)
552         WHERE quantityreceived > 0 AND datecancellationprinted IS NULL
553         GROUP BY budget_id, budget_parent_id
554         |, 'budget_id');
555     my $hr_budget_ordered = $dbh->selectall_hashref(q|
556         SELECT aqorders.budget_id, aqbudgets.budget_parent_id,
557                SUM( | . C4::Acquisition::get_rounding_sql(qq|ecost_tax_included|) . q| *  quantity) AS budget_ordered
558         FROM aqorders JOIN aqbudgets USING (budget_id)
559         WHERE quantityreceived = 0 AND datecancellationprinted IS NULL
560         GROUP BY budget_id, budget_parent_id
561         |, 'budget_id');
562     my $hr_budget_spent_shipment = $dbh->selectall_hashref(q|
563         SELECT shipmentcost_budgetid as budget_id,
564                SUM(shipmentcost) as shipmentcost
565         FROM aqinvoices
566         WHERE closedate IS NOT NULL
567         GROUP BY shipmentcost_budgetid
568         |, 'budget_id');
569     my $hr_budget_ordered_shipment = $dbh->selectall_hashref(q|
570         SELECT shipmentcost_budgetid as budget_id,
571                SUM(shipmentcost) as shipmentcost
572         FROM aqinvoices
573         WHERE closedate IS NULL
574         GROUP BY shipmentcost_budgetid
575         |, 'budget_id');
576     my $hr_budget_spent_adjustment = $dbh->selectall_hashref(q|
577         SELECT budget_id,
578                SUM(adjustment) as adjustments
579         FROM aqinvoice_adjustments
580         JOIN aqinvoices USING (invoiceid)
581         WHERE closedate IS NOT NULL
582         GROUP BY budget_id
583         |, 'budget_id');
584     my $hr_budget_ordered_adjustment = $dbh->selectall_hashref(q|
585         SELECT budget_id,
586                SUM(adjustment) as adjustments
587         FROM aqinvoice_adjustments
588         JOIN aqinvoices USING (invoiceid)
589         WHERE closedate IS NULL AND encumber_open = 1
590         GROUP BY budget_id
591         |, 'budget_id');
592
593
594     foreach my $budget (@sort) {
595         if ( not defined $budget->{budget_parent_id} ) {
596             _recursiveAdd( $budget, undef, $hr_budget_spent, $hr_budget_spent_shipment, $hr_budget_ordered, $hr_budget_ordered_shipment, $hr_budget_spent_adjustment, $hr_budget_ordered_adjustment );
597         }
598     }
599     return \@sort;
600 }
601
602 sub _recursiveAdd {
603     my ($budget, $parent, $hr_budget_spent, $hr_budget_spent_shipment, $hr_budget_ordered, $hr_budget_ordered_shipment, $hr_budget_spent_adjustment, $hr_budget_ordered_adjustment ) = @_;
604
605     foreach my $child (@{$budget->{children}}){
606         _recursiveAdd($child, $budget, $hr_budget_spent, $hr_budget_spent_shipment, $hr_budget_ordered, $hr_budget_ordered_shipment, $hr_budget_spent_adjustment, $hr_budget_ordered_adjustment );
607     }
608
609     $budget->{budget_spent} += $hr_budget_spent->{$budget->{budget_id}}->{budget_spent};
610     $budget->{budget_spent} += $hr_budget_spent_shipment->{$budget->{budget_id}}->{shipmentcost};
611     $budget->{budget_spent} += $hr_budget_spent_adjustment->{$budget->{budget_id}}->{adjustments};
612     $budget->{budget_ordered} += $hr_budget_ordered->{$budget->{budget_id}}->{budget_ordered};
613     $budget->{budget_ordered} += $hr_budget_ordered_shipment->{$budget->{budget_id}}->{shipmentcost};
614     $budget->{budget_ordered} += $hr_budget_ordered_adjustment->{$budget->{budget_id}}->{adjustments};
615
616     $budget->{total_spent} += $budget->{budget_spent};
617     $budget->{total_ordered} += $budget->{budget_ordered};
618
619     if ($parent) {
620         $parent->{total_spent} += $budget->{total_spent};
621         $parent->{total_ordered} += $budget->{total_ordered};
622     }
623 }
624
625 # Recursive method to add a budget and its chidren to an array
626 sub _add_budget_children {
627     my $res = shift;
628     my $budget = shift;
629     $budget->{budget_level} = shift;
630     push @$res, $budget;
631     my $children = $budget->{'children'} || [];
632     return unless @$children; # break recursivity
633     foreach my $child (@$children) {
634         _add_budget_children($res, $child, $budget->{budget_level} + 1);
635     }
636 }
637
638 # -------------------------------------------------------------------
639
640 sub AddBudget {
641     my ($budget) = @_;
642     return unless ($budget);
643
644     undef $budget->{budget_encumb} if $budget->{budget_encumb} eq '';
645     undef $budget->{budget_owner_id} if $budget->{budget_owner_id} eq '';
646     my $resultset = Koha::Database->new()->schema->resultset('Aqbudget');
647     return $resultset->create($budget)->id;
648 }
649
650 # -------------------------------------------------------------------
651 sub ModBudget {
652     my ($budget) = @_;
653     my $result = Koha::Database->new()->schema->resultset('Aqbudget')->find($budget);
654     return unless($result);
655
656     undef $budget->{budget_encumb} if $budget->{budget_encumb} eq '';
657     undef $budget->{budget_owner_id} if $budget->{budget_owner_id} eq '';
658     $result = $result->update($budget);
659     return $result->in_storage;
660 }
661
662 # -------------------------------------------------------------------
663 sub DelBudget {
664         my ($budget_id) = @_;
665         my $dbh         = C4::Context->dbh;
666         my $sth         = $dbh->prepare("delete from aqbudgets where budget_id=?");
667         my $rc          = $sth->execute($budget_id);
668         return $rc;
669 }
670
671
672 # -------------------------------------------------------------------
673
674 =head2 GetBudget
675
676   &GetBudget($budget_id);
677
678 get a specific budget
679
680 =cut
681
682 sub GetBudget {
683     my ( $budget_id ) = @_;
684     my $dbh = C4::Context->dbh;
685     my $query = "
686         SELECT *
687         FROM   aqbudgets
688         WHERE  budget_id=?
689         ";
690     my $sth = $dbh->prepare($query);
691     $sth->execute( $budget_id );
692     my $result = $sth->fetchrow_hashref;
693     return $result;
694 }
695
696 # -------------------------------------------------------------------
697
698 =head2 GetBudgetByOrderNumber
699
700   &GetBudgetByOrderNumber($ordernumber);
701
702 get a specific budget by order number
703
704 =cut
705
706 sub GetBudgetByOrderNumber {
707     my ( $ordernumber ) = @_;
708     my $dbh = C4::Context->dbh;
709     my $query = "
710         SELECT aqbudgets.*
711         FROM   aqbudgets, aqorders
712         WHERE  ordernumber=?
713         AND    aqorders.budget_id = aqbudgets.budget_id
714         ";
715     my $sth = $dbh->prepare($query);
716     $sth->execute( $ordernumber );
717     my $result = $sth->fetchrow_hashref;
718     return $result;
719 }
720
721 =head2 GetBudgetReport
722
723   &GetBudgetReport( [$budget_id] );
724
725 Get all orders for a specific budget, without cancelled orders.
726
727 Returns an array of hashrefs.
728
729 =cut
730
731 # --------------------------------------------------------------------
732 sub GetBudgetReport {
733     my ( $budget_id ) = @_;
734     my $dbh = C4::Context->dbh;
735     my $query = '
736         SELECT o.*, b.budget_name
737         FROM   aqbudgets b
738         INNER JOIN aqorders o
739         ON b.budget_id = o.budget_id
740         WHERE  b.budget_id=?
741         AND (o.orderstatus != "cancelled")
742         ORDER BY b.budget_name';
743
744     my $sth = $dbh->prepare($query);
745     $sth->execute( $budget_id );
746
747     my @results = ();
748     while ( my $data = $sth->fetchrow_hashref ) {
749         push( @results, $data );
750     }
751     return @results;
752 }
753
754 =head2 GetBudgetsByActivity
755
756   &GetBudgetsByActivity( $budget_period_active );
757
758 Get all active or inactive budgets, depending of the value
759 of the parameter.
760
761 1 = active
762 0 = inactive
763
764 =cut
765
766 # --------------------------------------------------------------------
767 sub GetBudgetsByActivity {
768     my ( $budget_period_active ) = @_;
769     my $dbh = C4::Context->dbh;
770     my $query = "
771         SELECT DISTINCT b.*
772         FROM   aqbudgetperiods bp
773         INNER JOIN aqbudgets b
774         ON bp.budget_period_id = b.budget_period_id
775         WHERE  bp.budget_period_active=?
776         ";
777     my $sth = $dbh->prepare($query);
778     $sth->execute( $budget_period_active );
779     my @results = ();
780     while ( my $data = $sth->fetchrow_hashref ) {
781         push( @results, $data );
782     }
783     return @results;
784 }
785 # --------------------------------------------------------------------
786
787 =head2 GetBudgetsReport
788
789   &GetBudgetsReport( [$activity] );
790
791 Get all but cancelled orders for all funds.
792
793 If the optionnal activity parameter is passed, returns orders for active/inactive budgets only.
794
795 active = 1
796 inactive = 0
797
798 Returns an array of hashrefs.
799
800 =cut
801
802 sub GetBudgetsReport {
803     my ($activity) = @_;
804     my $dbh = C4::Context->dbh;
805     my $query = '
806         SELECT o.*, b.budget_name
807         FROM   aqbudgetperiods bp
808         INNER JOIN aqbudgets b
809         ON bp.budget_period_id = b.budget_period_id
810         INNER JOIN aqorders o
811         ON b.budget_id = o.budget_id ';
812     if($activity ne ''){
813         $query .= 'WHERE  bp.budget_period_active=? ';
814     }
815     $query .= 'AND (o.orderstatus != "cancelled")
816                ORDER BY b.budget_name';
817
818     my $sth = $dbh->prepare($query);
819     if($activity ne ''){
820         $sth->execute($activity);
821     }
822     else{
823         $sth->execute;
824     }
825     my @results = ();
826     while ( my $data = $sth->fetchrow_hashref ) {
827         push( @results, $data );
828     }
829     return @results;
830 }
831
832 =head2 GetBudgetByCode
833
834     my $budget = &GetBudgetByCode($budget_code);
835
836 Retrieve all aqbudgets fields as a hashref for the budget that has
837 given budget_code
838
839 =cut
840
841 sub GetBudgetByCode {
842     my ( $budget_code ) = @_;
843
844     my $dbh = C4::Context->dbh;
845     my $query = qq{
846         SELECT aqbudgets.*
847         FROM aqbudgets
848         JOIN aqbudgetperiods USING (budget_period_id)
849         WHERE budget_code = ?
850         ORDER BY budget_period_active DESC, budget_id DESC
851         LIMIT 1
852     };
853     my $sth = $dbh->prepare( $query );
854     $sth->execute( $budget_code );
855     return $sth->fetchrow_hashref;
856 }
857
858 =head2 GetBudgetHierarchySpent
859
860   my $spent = GetBudgetHierarchySpent( $budget_id );
861
862 Gets the total spent of the level and sublevels of $budget_id
863
864 =cut
865
866 sub GetBudgetHierarchySpent {
867     my ( $budget_id ) = @_;
868     my $dbh = C4::Context->dbh;
869     my $children_ids = $dbh->selectcol_arrayref(q|
870         SELECT budget_id
871         FROM   aqbudgets
872         WHERE  budget_parent_id = ?
873     |, {}, $budget_id );
874
875     my $total_spent = GetBudgetSpent( $budget_id );
876     for my $child_id ( @$children_ids ) {
877         $total_spent += GetBudgetHierarchySpent( $child_id );
878     }
879     return $total_spent;
880 }
881
882 =head2 GetBudgetHierarchyOrdered
883
884   my $ordered = GetBudgetHierarchyOrdered( $budget_id );
885
886 Gets the total ordered of the level and sublevels of $budget_id
887
888 =cut
889
890 sub GetBudgetHierarchyOrdered {
891     my ( $budget_id ) = @_;
892     my $dbh = C4::Context->dbh;
893     my $children_ids = $dbh->selectcol_arrayref(q|
894         SELECT budget_id
895         FROM   aqbudgets
896         WHERE  budget_parent_id = ?
897     |, {}, $budget_id );
898
899     my $total_ordered = GetBudgetOrdered( $budget_id );
900     for my $child_id ( @$children_ids ) {
901         $total_ordered += GetBudgetHierarchyOrdered( $child_id );
902     }
903     return $total_ordered;
904 }
905
906 =head2 GetBudgets
907
908   &GetBudgets($filter, $order_by);
909
910 gets all budgets
911
912 =cut
913
914 # -------------------------------------------------------------------
915 sub GetBudgets {
916     my ($filters, $orderby) = @_;
917     $orderby = 'budget_name' unless($orderby);
918
919     my $rs = Koha::Database->new()->schema->resultset('Aqbudget');
920     $rs = $rs->search( $filters, { order_by => $orderby } );
921     $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
922     return [ $rs->all  ];
923 }
924
925 =head2 GetBudgetUsers
926
927     my @borrowernumbers = &GetBudgetUsers($budget_id);
928
929 Return the list of borrowernumbers linked to a budget
930
931 =cut
932
933 sub GetBudgetUsers {
934     my ($budget_id) = @_;
935
936     my $dbh = C4::Context->dbh;
937     my $query = qq{
938         SELECT borrowernumber
939         FROM aqbudgetborrowers
940         WHERE budget_id = ?
941     };
942     my $sth = $dbh->prepare($query);
943     $sth->execute($budget_id);
944
945     my @borrowernumbers;
946     while (my ($borrowernumber) = $sth->fetchrow_array) {
947         push @borrowernumbers, $borrowernumber
948     }
949
950     return @borrowernumbers;
951 }
952
953 =head2 ModBudgetUsers
954
955     &ModBudgetUsers($budget_id, @borrowernumbers);
956
957 Modify the list of borrowernumbers linked to a budget
958
959 =cut
960
961 sub ModBudgetUsers {
962     my ($budget_id, @budget_users_id) = @_;
963
964     return unless $budget_id;
965
966     my $dbh = C4::Context->dbh;
967     my $query = "DELETE FROM aqbudgetborrowers WHERE budget_id = ?";
968     my $sth = $dbh->prepare($query);
969     $sth->execute($budget_id);
970
971     $query = qq{
972         INSERT INTO aqbudgetborrowers (budget_id, borrowernumber)
973         VALUES (?,?)
974     };
975     $sth = $dbh->prepare($query);
976     foreach my $borrowernumber (@budget_users_id) {
977         next unless $borrowernumber;
978         $sth->execute($budget_id, $borrowernumber);
979     }
980 }
981
982 sub CanUserUseBudget {
983     my ($borrower, $budget, $userflags) = @_;
984
985     if (not ref $borrower) {
986         $borrower = Koha::Patrons->find( $borrower );
987         return 0 unless $borrower;
988         $borrower = $borrower->unblessed;
989     }
990     if (not ref $budget) {
991         $budget = GetBudget($budget);
992     }
993
994     return 0 unless ($borrower and $budget);
995
996     if (not defined $userflags) {
997         $userflags = C4::Auth::getuserflags($borrower->{flags},
998             $borrower->{userid});
999     }
1000
1001     unless ($userflags->{superlibrarian}
1002     || (ref $userflags->{acquisition}
1003         && $userflags->{acquisition}->{budget_manage_all})
1004     || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
1005     {
1006         if (not exists $userflags->{acquisition}) {
1007             return 0;
1008         }
1009
1010         if (!ref $userflags->{acquisition} && !$userflags->{acquisition}) {
1011             return 0;
1012         }
1013
1014         # Budget restricted to owner
1015         if ( $budget->{budget_permission} == 1 ) {
1016             if (    $budget->{budget_owner_id}
1017                 and $budget->{budget_owner_id} != $borrower->{borrowernumber} )
1018             {
1019                 return 0;
1020             }
1021         }
1022
1023         # Budget restricted to owner, users and library
1024         elsif ( $budget->{budget_permission} == 2 ) {
1025             my @budget_users = GetBudgetUsers( $budget->{budget_id} );
1026
1027             if (
1028                 (
1029                         $budget->{budget_owner_id}
1030                     and $budget->{budget_owner_id} !=
1031                     $borrower->{borrowernumber}
1032                     or not $budget->{budget_owner_id}
1033                 )
1034                 and ( 0 == grep { $borrower->{borrowernumber} == $_ }
1035                     @budget_users )
1036                 and defined $budget->{budget_branchcode}
1037                 and $budget->{budget_branchcode} ne
1038                 C4::Context->userenv->{branch}
1039               )
1040             {
1041                 return 0;
1042             }
1043         }
1044
1045         # Budget restricted to owner and users
1046         elsif ( $budget->{budget_permission} == 3 ) {
1047             my @budget_users = GetBudgetUsers( $budget->{budget_id} );
1048             if (
1049                 (
1050                         $budget->{budget_owner_id}
1051                     and $budget->{budget_owner_id} !=
1052                     $borrower->{borrowernumber}
1053                     or not $budget->{budget_owner_id}
1054                 )
1055                 and ( 0 == grep { $borrower->{borrowernumber} == $_ }
1056                     @budget_users )
1057               )
1058             {
1059                 return 0;
1060             }
1061         }
1062     }
1063
1064     return 1;
1065 }
1066
1067 sub CanUserModifyBudget {
1068     my ($borrower, $budget, $userflags) = @_;
1069
1070     if (not ref $borrower) {
1071         $borrower = Koha::Patrons->find( $borrower );
1072         return 0 unless $borrower;
1073         $borrower = $borrower->unblessed;
1074     }
1075     if (not ref $budget) {
1076         $budget = GetBudget($budget);
1077     }
1078
1079     return 0 unless ($borrower and $budget);
1080
1081     if (not defined $userflags) {
1082         $userflags = C4::Auth::getuserflags($borrower->{flags},
1083             $borrower->{userid});
1084     }
1085
1086     unless ($userflags->{superlibrarian}
1087     || (ref $userflags->{acquisition}
1088         && $userflags->{acquisition}->{budget_manage_all})
1089     || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
1090     {
1091         if (!CanUserUseBudget($borrower, $budget, $userflags)) {
1092             return 0;
1093         }
1094
1095         if (ref $userflags->{acquisition}
1096         && !$userflags->{acquisition}->{budget_modify}) {
1097             return 0;
1098         }
1099     }
1100
1101     return 1;
1102 }
1103
1104 sub _round {
1105     my ($value, $increment) = @_;
1106
1107     if ($increment && $increment != 0) {
1108         $value = int($value / $increment) * $increment;
1109     }
1110
1111     return $value;
1112 }
1113
1114 =head2 CloneBudgetPeriod
1115
1116   my $new_budget_period_id = CloneBudgetPeriod({
1117     budget_period_id => $budget_period_id,
1118     budget_period_startdate => $budget_period_startdate,
1119     budget_period_enddate   => $budget_period_enddate,
1120     mark_original_budget_as_inactive => 1n
1121     reset_all_budgets => 1,
1122   });
1123
1124 Clone a budget period with all budgets.
1125 If the mark_origin_budget_as_inactive is set (0 by default),
1126 the original budget will be marked as inactive.
1127
1128 If the reset_all_budgets is set (0 by default), all budget (fund)
1129 amounts will be reset.
1130
1131 =cut
1132
1133 sub CloneBudgetPeriod {
1134     my ($params)                  = @_;
1135     my $budget_period_id          = $params->{budget_period_id};
1136     my $budget_period_startdate   = $params->{budget_period_startdate};
1137     my $budget_period_enddate     = $params->{budget_period_enddate};
1138     my $budget_period_description = $params->{budget_period_description};
1139     my $amount_change_percentage  = $params->{amount_change_percentage};
1140     my $amount_change_round_increment = $params->{amount_change_round_increment};
1141     my $mark_original_budget_as_inactive =
1142       $params->{mark_original_budget_as_inactive} || 0;
1143     my $reset_all_budgets = $params->{reset_all_budgets} || 0;
1144
1145     my $budget_period = GetBudgetPeriod($budget_period_id);
1146
1147     $budget_period->{budget_period_startdate}   = $budget_period_startdate;
1148     $budget_period->{budget_period_enddate}     = $budget_period_enddate;
1149     $budget_period->{budget_period_description} = $budget_period_description;
1150     # The new budget (budget_period) should be active by default
1151     $budget_period->{budget_period_active}    = 1;
1152
1153     if ($amount_change_percentage) {
1154         my $total = $budget_period->{budget_period_total};
1155         $total += $total * $amount_change_percentage / 100;
1156         $total = _round($total, $amount_change_round_increment);
1157         $budget_period->{budget_period_total} = $total;
1158     }
1159
1160     my $original_budget_period_id = $budget_period->{budget_period_id};
1161     delete $budget_period->{budget_period_id};
1162     my $new_budget_period_id = AddBudgetPeriod( $budget_period );
1163
1164     my $budgets = GetBudgetHierarchy($budget_period_id);
1165     CloneBudgetHierarchy(
1166         {
1167             budgets              => $budgets,
1168             new_budget_period_id => $new_budget_period_id
1169         }
1170     );
1171
1172     if ($mark_original_budget_as_inactive) {
1173         ModBudgetPeriod(
1174             {
1175                 budget_period_id     => $budget_period_id,
1176                 budget_period_active => 0,
1177             }
1178         );
1179     }
1180
1181     if ( $reset_all_budgets ) {
1182         my $budgets = GetBudgets({ budget_period_id => $new_budget_period_id });
1183         for my $budget ( @$budgets ) {
1184             $budget->{budget_amount} = 0;
1185             ModBudget( $budget );
1186         }
1187     } elsif ($amount_change_percentage) {
1188         my $budgets = GetBudgets({ budget_period_id => $new_budget_period_id });
1189         for my $budget ( @$budgets ) {
1190             my $amount = $budget->{budget_amount};
1191             $amount += $amount * $amount_change_percentage / 100;
1192             $amount = _round($amount, $amount_change_round_increment);
1193             $budget->{budget_amount} = $amount;
1194             ModBudget( $budget );
1195         }
1196     }
1197
1198     return $new_budget_period_id;
1199 }
1200
1201 =head2 CloneBudgetHierarchy
1202
1203   CloneBudgetHierarchy({
1204     budgets => $budgets,
1205     new_budget_period_id => $new_budget_period_id;
1206   });
1207
1208 Clone a budget hierarchy.
1209
1210 =cut
1211
1212 sub CloneBudgetHierarchy {
1213     my ($params)             = @_;
1214     my $budgets              = $params->{budgets};
1215     my $new_budget_period_id = $params->{new_budget_period_id};
1216     next unless @$budgets or $new_budget_period_id;
1217
1218     my $children_of   = $params->{children_of};
1219     my $new_parent_id = $params->{new_parent_id};
1220
1221     my @first_level_budgets =
1222       ( not defined $children_of )
1223       ? map { ( not $_->{budget_parent_id} )             ? $_ : () } @$budgets
1224       : map { ( $_->{budget_parent_id} == $children_of ) ? $_ : () } @$budgets;
1225
1226     # get only the columns of aqbudgets
1227     my @columns = Koha::Database->new()->schema->source('Aqbudget')->columns;
1228
1229     for my $budget ( sort { $a->{budget_id} <=> $b->{budget_id} }
1230         @first_level_budgets )
1231     {
1232
1233         my $tidy_budget =
1234           { map { join( ' ', @columns ) =~ /$_/ ? ( $_ => $budget->{$_} ) : () }
1235               keys %$budget };
1236         delete $tidy_budget->{timestamp};
1237         my $new_budget_id = AddBudget(
1238             {
1239                 %$tidy_budget,
1240                 budget_id        => undef,
1241                 budget_parent_id => $new_parent_id,
1242                 budget_period_id => $new_budget_period_id
1243             }
1244         );
1245         CloneBudgetHierarchy(
1246             {
1247                 budgets              => $budgets,
1248                 new_budget_period_id => $new_budget_period_id,
1249                 children_of          => $budget->{budget_id},
1250                 new_parent_id        => $new_budget_id
1251             }
1252         );
1253     }
1254 }
1255
1256 =head2 MoveOrders
1257
1258   my $report = MoveOrders({
1259     from_budget_period_id => $from_budget_period_id,
1260     to_budget_period_id   => $to_budget_period_id,
1261   });
1262
1263 Move orders from one budget period to another.
1264
1265 =cut
1266
1267 sub MoveOrders {
1268     my ($params)              = @_;
1269     my $from_budget_period_id = $params->{from_budget_period_id};
1270     my $to_budget_period_id   = $params->{to_budget_period_id};
1271     my $move_remaining_unspent = $params->{move_remaining_unspent};
1272     return
1273       if not $from_budget_period_id
1274           or not $to_budget_period_id
1275           or $from_budget_period_id == $to_budget_period_id;
1276
1277     # Can't move orders to an inactive budget (budgetperiod)
1278     my $budget_period = GetBudgetPeriod($to_budget_period_id);
1279     return unless $budget_period->{budget_period_active};
1280
1281     my @report;
1282     my $dbh     = C4::Context->dbh;
1283     my $sth_update_aqorders = $dbh->prepare(
1284         q|
1285             UPDATE aqorders
1286             SET budget_id = ?
1287             WHERE ordernumber = ?
1288         |
1289     );
1290     my $sth_update_budget_amount = $dbh->prepare(
1291         q|
1292             UPDATE aqbudgets
1293             SET budget_amount = ?
1294             WHERE budget_id = ?
1295         |
1296     );
1297     my $from_budgets = GetBudgetHierarchy($from_budget_period_id);
1298     for my $from_budget (@$from_budgets) {
1299         my $new_budget_id = $dbh->selectcol_arrayref(
1300             q|
1301                 SELECT budget_id
1302                 FROM aqbudgets
1303                 WHERE budget_period_id = ?
1304                     AND budget_code = ?
1305             |, {}, $to_budget_period_id, $from_budget->{budget_code}
1306         );
1307         $new_budget_id = $new_budget_id->[0];
1308         my $new_budget = GetBudget( $new_budget_id );
1309         unless ( $new_budget ) {
1310             push @report,
1311               {
1312                 moved       => 0,
1313                 budget      => $from_budget,
1314                 error       => 'budget_code_not_exists',
1315               };
1316             next;
1317         }
1318         my $orders_to_move = C4::Acquisition::SearchOrders(
1319             {
1320                 budget_id => $from_budget->{budget_id},
1321                 pending   => 1,
1322             }
1323         );
1324
1325         my @orders_moved;
1326         for my $order (@$orders_to_move) {
1327             $sth_update_aqorders->execute( $new_budget->{budget_id}, $order->{ordernumber} );
1328             push @orders_moved, $order;
1329         }
1330
1331         my $unspent_moved = 0;
1332         if ($move_remaining_unspent) {
1333             my $spent   = GetBudgetHierarchySpent( $from_budget->{budget_id} );
1334             my $unspent = $from_budget->{budget_amount} - $spent;
1335             my $new_budget_amount = $new_budget->{budget_amount};
1336             if ( $unspent > 0 ) {
1337                 $new_budget_amount += $unspent;
1338                 $unspent_moved = $unspent;
1339             }
1340             $new_budget->{budget_amount} = $new_budget_amount;
1341             $sth_update_budget_amount->execute( $new_budget_amount,
1342                 $new_budget->{budget_id} );
1343         }
1344
1345         push @report,
1346           {
1347             budget        => $new_budget,
1348             orders_moved  => \@orders_moved,
1349             moved         => 1,
1350             unspent_moved => $unspent_moved,
1351           };
1352     }
1353     return \@report;
1354 }
1355
1356 END { }    # module clean-up code here (global destructor)
1357
1358 1;
1359 __END__
1360
1361 =head1 AUTHOR
1362
1363 Koha Development Team <http://koha-community.org/>
1364
1365 =cut