3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
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.
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.
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>.
21 #use warnings; FIXME - Bug 2505
25 use Koha::Acquisition::Invoice::Adjustments;
27 use vars qw(@ISA @EXPORT);
35 &GetBudgetByOrderNumber
49 GetBudgetHierarchySpent
50 GetBudgetHierarchyOrdered
70 &CheckBudgetParentPerm
77 # ----------------------------BUDGETS.PM-----------------------------";
79 =head1 FUNCTIONS ABOUT BUDGETS
84 my ( $authcat, @hide_cols ) = @_;
85 my $dbh = C4::Context->dbh;
87 my $sth1 = $dbh->prepare(
89 UPDATE aqbudgets_planning SET display = 0
93 foreach my $authvalue (@hide_cols) {
94 # $sth1->{TraceLevel} = 3;
95 $sth1->execute( $authcat, $authvalue );
100 my ( $authcat, $authvalue ) = @_;
102 my $dbh = C4::Context->dbh;
103 my $sth = $dbh->prepare(
105 SELECT count(display) as cnt from aqbudgets_planning
107 AND authvalue = ? and display = 0 |
110 # $sth->{TraceLevel} = 3;
111 $sth->execute( $authcat, $authvalue );
112 my $res = $sth->fetchrow_hashref;
114 return $res->{cnt} > 0 ? 0: 1
118 sub CheckBudgetParentPerm {
119 my ( $budget, $borrower_id ) = @_;
120 my $depth = $budget->{depth};
121 my $parent_id = $budget->{budget_parent_id};
123 my $parent = GetBudget($parent_id);
124 $parent_id = $parent->{budget_parent_id};
125 if ( $parent->{budget_owner_id} == $borrower_id ) {
133 sub AddBudgetPeriod {
134 my ($budgetperiod) = @_;
135 return unless($budgetperiod->{budget_period_startdate} && $budgetperiod->{budget_period_enddate});
137 undef $budgetperiod->{budget_period_id};
138 my $resultset = Koha::Database->new()->schema->resultset('Aqbudgetperiod');
139 return $resultset->create($budgetperiod)->id;
141 # -------------------------------------------------------------------
142 sub GetPeriodsCount {
143 my $dbh = C4::Context->dbh;
144 my $sth = $dbh->prepare("
145 SELECT COUNT(*) AS sum FROM aqbudgetperiods ");
147 my $res = $sth->fetchrow_hashref;
148 return $res->{'sum'};
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;
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 = ? | );
164 $sth->execute($parent_id_tmp);
165 my $res = $sth->fetchrow_hashref;
166 if ( $res->{'budget_parent_id'} == $budget_id ) {
169 if ( not defined $res->{'budget_parent_id'} ) {
172 $parent_id_tmp = $res->{'budget_parent_id'};
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'};
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 );
197 sub SetOwnerToFundHierarchy {
198 my ( $budget_id, $borrowernumber ) = @_;
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 );
209 # -------------------------------------------------------------------
210 sub GetBudgetsPlanCell {
211 my ( $cell, $period, $budget ) = @_; #FIXME we don't use $period or $budget
213 my $dbh = C4::Context->dbh;
214 my $roundsql = _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|
220 SELECT SUM(| . $roundsql . qq|) AS actual FROM aqorders
221 WHERE budget_id = ? AND
222 entrydate like "$cell->{'authvalue'}%" |
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|
230 SELECT SUM(| . $roundsql . qq|) FROM aqorders
231 LEFT JOIN aqorders_items
232 ON (aqorders.ordernumber = aqorders_items.ordernumber)
234 ON (aqorders_items.itemnumber = items.itemnumber)
235 WHERE budget_id = ? AND homebranch = ? | );
237 $sth->execute( $cell->{'budget_id'}, $cell->{'authvalue'} );
238 } elsif ( $cell->{'authcat'} eq 'ITEMTYPES' ) {
239 # get the actual amount
240 $sth = $dbh->prepare( qq|
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 = ? |
247 $sth->execute( $cell->{'budget_id'},
248 $cell->{'authvalue'} );
250 # ELSE GENERIC ORDERS SORT1/SORT2 STAT COUNT.
252 # get the actual amount
253 $sth = $dbh->prepare( qq|
255 SELECT SUM(| . $roundsql . qq| * quantity) AS actual
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 =?)) |
262 $sth->execute( $cell->{'budget_id'},
263 $budget->{'sort1_authcat'},
264 $cell->{'authvalue'},
265 $budget->{'sort2_authcat'},
269 $actual = $sth->fetchrow_array;
271 # get the estimated amount
272 $sth = $dbh->prepare( qq|
274 SELECT estimated_amount AS estimated, display FROM aqbudgets_planning
275 WHERE budget_period_id = ? AND
280 $sth->execute( $cell->{'budget_period_id'},
281 $cell->{'budget_id'},
282 $cell->{'authvalue'},
287 my $res = $sth->fetchrow_hashref;
288 # my $display = $res->{'display'};
289 my $estimated = $res->{'estimated'};
292 return $actual, $estimated;
295 # -------------------------------------------------------------------
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
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 );
311 foreach my $cell (@$lines) {
312 my $sth = $dbh->prepare( qq|
314 INSERT INTO aqbudgets_planning
316 budget_period_id = ?,
318 estimated_amount = ?,
322 $cell->{'budget_id'},
323 $cell->{'budget_period_id'},
325 $cell->{'estimated_amount'},
326 $cell->{'authvalue'},
332 # -------------------------------------------------------------------
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( | . _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
344 $sth->execute($budget_id);
345 my $sum = 0 + $sth->fetchrow_array;
347 $sth = $dbh->prepare(qq|
348 SELECT SUM(shipmentcost) AS sum
350 WHERE shipmentcost_budgetid = ?
353 $sth->execute($budget_id);
354 my ($shipmentcost_sum) = $sth->fetchrow_array;
355 $sum += $shipmentcost_sum;
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;
365 # -------------------------------------------------------------------
366 sub GetBudgetOrdered {
367 my ($budget_id) = @_;
368 my $dbh = C4::Context->dbh;
369 my $sth = $dbh->prepare(qq|
370 SELECT SUM(| . _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
375 $sth->execute($budget_id);
376 my $sum = 0 + $sth->fetchrow_array;
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;
388 my $budget_name = &GetBudgetName($budget_id);
390 get the budget_name for a given budget_id
395 my ( $budget_id ) = @_;
396 my $dbh = C4::Context->dbh;
397 my $sth = $dbh->prepare(
404 $sth->execute($budget_id);
405 return $sth->fetchrow_array;
408 =head2 GetBudgetAuthCats
410 my $auth_cats = &GetBudgetAuthCats($budget_period_id);
412 Return the list of authcat for a given budget_period_id
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);
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;
428 return [ sort keys %authcats ];
431 # -------------------------------------------------------------------
432 sub GetBudgetPeriods {
433 my ($filters,$orderby) = @_;
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');
440 # -------------------------------------------------------------------
441 sub GetBudgetPeriod {
442 my ($budget_period_id) = @_;
443 my $dbh = C4::Context->dbh;
444 ## $total = number of records linked to the record that must be deleted
446 ## get information about the record that will be deleted
448 if ($budget_period_id) {
449 $sth = $dbh->prepare( qq|
452 WHERE budget_period_id=? |
454 $sth->execute($budget_period_id);
455 } else { # ACTIVE BUDGET
456 $sth = $dbh->prepare(qq|
459 WHERE budget_period_active=1 |
463 my $data = $sth->fetchrow_hashref;
468 my ($budget_period_id) = @_;
469 my $dbh = C4::Context->dbh;
470 ; ## $total = number of records linked to the record that must be deleted
473 ## get information about the record that will be deleted
474 my $sth = $dbh->prepare(qq|
477 WHERE budget_period_id=? |
479 return $sth->execute($budget_period_id);
482 # -------------------------------------------------------------------
483 sub ModBudgetPeriod {
484 my ($budget_period) = @_;
485 my $result = Koha::Database->new()->schema->resultset('Aqbudgetperiod')->find($budget_period);
486 return unless($result);
488 $result = $result->update($budget_period);
489 return $result->in_storage;
492 # -------------------------------------------------------------------
493 sub GetBudgetHierarchy {
494 my ( $budget_period_id, $branchcode, $owner ) = @_;
496 my $dbh = C4::Context->dbh;
498 SELECT aqbudgets.*, aqbudgetperiods.budget_period_active, aqbudgetperiods.budget_period_description,
499 b.firstname as budget_owner_firstname, b.surname as budget_owner_surname, b.borrowernumber as budget_owner_borrowernumber
501 LEFT JOIN borrowers b on b.borrowernumber = aqbudgets.budget_owner_id
502 JOIN aqbudgetperiods USING (budget_period_id)|;
505 # show only period X if requested
506 if ($budget_period_id) {
507 push @where_strings," aqbudgets.budget_period_id = ?";
508 push @bind_params, $budget_period_id;
510 # show only budgets owned by me, my branch or everyone
514 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="")))};
515 push @bind_params, ( $owner, $branchcode );
517 push @where_strings, ' (budget_owner_id = ? OR budget_owner_id IS NULL or budget_owner_id ="") ';
518 push @bind_params, $owner;
522 push @where_strings," (budget_branchcode =? or budget_branchcode is NULL OR budget_branchcode='')";
523 push @bind_params, $branchcode;
526 $query.=" WHERE ".join(' AND ', @where_strings) if @where_strings;
527 $debug && warn $query,join(",",@bind_params);
528 my $sth = $dbh->prepare($query);
529 $sth->execute(@bind_params);
532 # create hash with budget_id has key
533 while ( my $data = $sth->fetchrow_hashref ) {
534 $links{ $data->{'budget_id'} } = $data;
537 # link child to parent
539 foreach my $budget ( sort { $a->{budget_code} cmp $b->{budget_code} } values %links ) {
540 my $child = $links{$budget->{budget_id}};
541 if ( $child->{'budget_parent_id'} ) {
542 my $parent = $links{ $child->{'budget_parent_id'} };
544 unless ( $parent->{'children'} ) {
545 # init child arrayref
546 $parent->{'children'} = [];
549 push @{ $parent->{'children'} }, $child;
552 push @first_parents, $child;
557 foreach my $first_parent (@first_parents) {
558 _add_budget_children(\@sort, $first_parent, 0);
561 # Get all the budgets totals in as few queries as possible
562 my $hr_budget_spent = $dbh->selectall_hashref(q|
563 SELECT aqorders.budget_id, aqbudgets.budget_parent_id,
564 SUM( COALESCE(unitprice_tax_included, ecost_tax_included) * quantity ) AS budget_spent
565 FROM aqorders JOIN aqbudgets USING (budget_id)
566 WHERE quantityreceived > 0 AND datecancellationprinted IS NULL
567 GROUP BY budget_id, budget_parent_id
569 my $hr_budget_ordered = $dbh->selectall_hashref(q|
570 SELECT aqorders.budget_id, aqbudgets.budget_parent_id,
571 SUM(ecost_tax_included * quantity) AS budget_ordered
572 FROM aqorders JOIN aqbudgets USING (budget_id)
573 WHERE quantityreceived = 0 AND datecancellationprinted IS NULL
574 GROUP BY budget_id, budget_parent_id
576 my $hr_budget_spent_shipment = $dbh->selectall_hashref(q|
577 SELECT shipmentcost_budgetid as budget_id,
578 SUM(shipmentcost) as shipmentcost
580 WHERE closedate IS NOT NULL
581 GROUP BY shipmentcost_budgetid
583 my $hr_budget_ordered_shipment = $dbh->selectall_hashref(q|
584 SELECT shipmentcost_budgetid as budget_id,
585 SUM(shipmentcost) as shipmentcost
587 WHERE closedate IS NULL
588 GROUP BY shipmentcost_budgetid
590 my $hr_budget_spent_adjustment = $dbh->selectall_hashref(q|
592 SUM(adjustment) as adjustments
593 FROM aqinvoice_adjustments
594 JOIN aqinvoices USING (invoiceid)
595 WHERE closedate IS NOT NULL
598 my $hr_budget_ordered_adjustment = $dbh->selectall_hashref(q|
600 SUM(adjustment) as adjustments
601 FROM aqinvoice_adjustments
602 JOIN aqinvoices USING (invoiceid)
603 WHERE closedate IS NULL AND encumber_open = 1
608 foreach my $budget (@sort) {
609 if ( not defined $budget->{budget_parent_id} ) {
610 _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 );
617 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 ) = @_;
619 foreach my $child (@{$budget->{children}}){
620 _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 );
623 $budget->{budget_spent} += $hr_budget_spent->{$budget->{budget_id}}->{budget_spent};
624 $budget->{budget_spent} += $hr_budget_spent_shipment->{$budget->{budget_id}}->{shipmentcost};
625 $budget->{budget_spent} += $hr_budget_spent_adjustment->{$budget->{budget_id}}->{adjustments};
626 $budget->{budget_ordered} += $hr_budget_ordered->{$budget->{budget_id}}->{budget_ordered};
627 $budget->{budget_ordered} += $hr_budget_ordered_shipment->{$budget->{budget_id}}->{shipmentcost};
628 $budget->{budget_ordered} += $hr_budget_ordered_adjustment->{$budget->{budget_id}}->{adjustments};
630 $budget->{total_spent} += $budget->{budget_spent};
631 $budget->{total_ordered} += $budget->{budget_ordered};
634 $parent->{total_spent} += $budget->{total_spent};
635 $parent->{total_ordered} += $budget->{total_ordered};
639 # Recursive method to add a budget and its chidren to an array
640 sub _add_budget_children {
643 $budget->{budget_level} = shift;
645 my $children = $budget->{'children'} || [];
646 return unless @$children; # break recursivity
647 foreach my $child (@$children) {
648 _add_budget_children($res, $child, $budget->{budget_level} + 1);
652 # -------------------------------------------------------------------
656 return unless ($budget);
658 undef $budget->{budget_encumb} if $budget->{budget_encumb} eq '';
659 undef $budget->{budget_owner_id} if $budget->{budget_owner_id} eq '';
660 my $resultset = Koha::Database->new()->schema->resultset('Aqbudget');
661 return $resultset->create($budget)->id;
664 # -------------------------------------------------------------------
667 my $result = Koha::Database->new()->schema->resultset('Aqbudget')->find($budget);
668 return unless($result);
670 undef $budget->{budget_encumb} if $budget->{budget_encumb} eq '';
671 undef $budget->{budget_owner_id} if $budget->{budget_owner_id} eq '';
672 $result = $result->update($budget);
673 return $result->in_storage;
676 # -------------------------------------------------------------------
678 my ($budget_id) = @_;
679 my $dbh = C4::Context->dbh;
680 my $sth = $dbh->prepare("delete from aqbudgets where budget_id=?");
681 my $rc = $sth->execute($budget_id);
686 # -------------------------------------------------------------------
690 &GetBudget($budget_id);
692 get a specific budget
697 my ( $budget_id ) = @_;
698 my $dbh = C4::Context->dbh;
704 my $sth = $dbh->prepare($query);
705 $sth->execute( $budget_id );
706 my $result = $sth->fetchrow_hashref;
710 # -------------------------------------------------------------------
712 =head2 GetBudgetByOrderNumber
714 &GetBudgetByOrderNumber($ordernumber);
716 get a specific budget by order number
720 sub GetBudgetByOrderNumber {
721 my ( $ordernumber ) = @_;
722 my $dbh = C4::Context->dbh;
725 FROM aqbudgets, aqorders
727 AND aqorders.budget_id = aqbudgets.budget_id
729 my $sth = $dbh->prepare($query);
730 $sth->execute( $ordernumber );
731 my $result = $sth->fetchrow_hashref;
735 =head2 GetBudgetReport
737 &GetBudgetReport( [$budget_id] );
739 Get all orders for a specific budget, without cancelled orders.
741 Returns an array of hashrefs.
745 # --------------------------------------------------------------------
746 sub GetBudgetReport {
747 my ( $budget_id ) = @_;
748 my $dbh = C4::Context->dbh;
750 SELECT o.*, b.budget_name
752 INNER JOIN aqorders o
753 ON b.budget_id = o.budget_id
755 AND (o.orderstatus != "cancelled")
756 ORDER BY b.budget_name';
758 my $sth = $dbh->prepare($query);
759 $sth->execute( $budget_id );
762 while ( my $data = $sth->fetchrow_hashref ) {
763 push( @results, $data );
768 =head2 GetBudgetsByActivity
770 &GetBudgetsByActivity( $budget_period_active );
772 Get all active or inactive budgets, depending of the value
780 # --------------------------------------------------------------------
781 sub GetBudgetsByActivity {
782 my ( $budget_period_active ) = @_;
783 my $dbh = C4::Context->dbh;
786 FROM aqbudgetperiods bp
787 INNER JOIN aqbudgets b
788 ON bp.budget_period_id = b.budget_period_id
789 WHERE bp.budget_period_active=?
791 my $sth = $dbh->prepare($query);
792 $sth->execute( $budget_period_active );
794 while ( my $data = $sth->fetchrow_hashref ) {
795 push( @results, $data );
799 # --------------------------------------------------------------------
801 =head2 GetBudgetsReport
803 &GetBudgetsReport( [$activity] );
805 Get all but cancelled orders for all funds.
807 If the optionnal activity parameter is passed, returns orders for active/inactive budgets only.
812 Returns an array of hashrefs.
816 sub GetBudgetsReport {
818 my $dbh = C4::Context->dbh;
820 SELECT o.*, b.budget_name
821 FROM aqbudgetperiods bp
822 INNER JOIN aqbudgets b
823 ON bp.budget_period_id = b.budget_period_id
824 INNER JOIN aqorders o
825 ON b.budget_id = o.budget_id ';
827 $query .= 'WHERE bp.budget_period_active=? ';
829 $query .= 'AND (o.orderstatus != "cancelled")
830 ORDER BY b.budget_name';
832 my $sth = $dbh->prepare($query);
834 $sth->execute($activity);
840 while ( my $data = $sth->fetchrow_hashref ) {
841 push( @results, $data );
846 =head2 GetBudgetByCode
848 my $budget = &GetBudgetByCode($budget_code);
850 Retrieve all aqbudgets fields as a hashref for the budget that has
855 sub GetBudgetByCode {
856 my ( $budget_code ) = @_;
858 my $dbh = C4::Context->dbh;
862 JOIN aqbudgetperiods USING (budget_period_id)
863 WHERE budget_code = ?
864 ORDER BY budget_period_active DESC, budget_id DESC
867 my $sth = $dbh->prepare( $query );
868 $sth->execute( $budget_code );
869 return $sth->fetchrow_hashref;
872 =head2 GetBudgetHierarchySpent
874 my $spent = GetBudgetHierarchySpent( $budget_id );
876 Gets the total spent of the level and sublevels of $budget_id
880 sub GetBudgetHierarchySpent {
881 my ( $budget_id ) = @_;
882 my $dbh = C4::Context->dbh;
883 my $children_ids = $dbh->selectcol_arrayref(q|
886 WHERE budget_parent_id = ?
889 my $total_spent = GetBudgetSpent( $budget_id );
890 for my $child_id ( @$children_ids ) {
891 $total_spent += GetBudgetHierarchySpent( $child_id );
896 =head2 GetBudgetHierarchyOrdered
898 my $ordered = GetBudgetHierarchyOrdered( $budget_id );
900 Gets the total ordered of the level and sublevels of $budget_id
904 sub GetBudgetHierarchyOrdered {
905 my ( $budget_id ) = @_;
906 my $dbh = C4::Context->dbh;
907 my $children_ids = $dbh->selectcol_arrayref(q|
910 WHERE budget_parent_id = ?
913 my $total_ordered = GetBudgetOrdered( $budget_id );
914 for my $child_id ( @$children_ids ) {
915 $total_ordered += GetBudgetHierarchyOrdered( $child_id );
917 return $total_ordered;
922 &GetBudgets($filter, $order_by);
928 # -------------------------------------------------------------------
930 my ($filters, $orderby) = @_;
931 $orderby = 'budget_name' unless($orderby);
933 my $rs = Koha::Database->new()->schema->resultset('Aqbudget');
934 $rs = $rs->search( $filters, { order_by => $orderby } );
935 $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
939 =head2 GetBudgetUsers
941 my @borrowernumbers = &GetBudgetUsers($budget_id);
943 Return the list of borrowernumbers linked to a budget
948 my ($budget_id) = @_;
950 my $dbh = C4::Context->dbh;
952 SELECT borrowernumber
953 FROM aqbudgetborrowers
956 my $sth = $dbh->prepare($query);
957 $sth->execute($budget_id);
960 while (my ($borrowernumber) = $sth->fetchrow_array) {
961 push @borrowernumbers, $borrowernumber
964 return @borrowernumbers;
967 =head2 ModBudgetUsers
969 &ModBudgetUsers($budget_id, @borrowernumbers);
971 Modify the list of borrowernumbers linked to a budget
976 my ($budget_id, @budget_users_id) = @_;
978 return unless $budget_id;
980 my $dbh = C4::Context->dbh;
981 my $query = "DELETE FROM aqbudgetborrowers WHERE budget_id = ?";
982 my $sth = $dbh->prepare($query);
983 $sth->execute($budget_id);
986 INSERT INTO aqbudgetborrowers (budget_id, borrowernumber)
989 $sth = $dbh->prepare($query);
990 foreach my $borrowernumber (@budget_users_id) {
991 next unless $borrowernumber;
992 $sth->execute($budget_id, $borrowernumber);
996 sub CanUserUseBudget {
997 my ($borrower, $budget, $userflags) = @_;
999 if (not ref $borrower) {
1000 $borrower = Koha::Patrons->find( $borrower );
1001 return 0 unless $borrower;
1002 $borrower = $borrower->unblessed;
1004 if (not ref $budget) {
1005 $budget = GetBudget($budget);
1008 return 0 unless ($borrower and $budget);
1010 if (not defined $userflags) {
1011 $userflags = C4::Auth::getuserflags($borrower->{flags},
1012 $borrower->{userid});
1015 unless ($userflags->{superlibrarian}
1016 || (ref $userflags->{acquisition}
1017 && $userflags->{acquisition}->{budget_manage_all})
1018 || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
1020 if (not exists $userflags->{acquisition}) {
1024 if (!ref $userflags->{acquisition} && !$userflags->{acquisition}) {
1028 # Budget restricted to owner
1029 if ( $budget->{budget_permission} == 1 ) {
1030 if ( $budget->{budget_owner_id}
1031 and $budget->{budget_owner_id} != $borrower->{borrowernumber} )
1037 # Budget restricted to owner, users and library
1038 elsif ( $budget->{budget_permission} == 2 ) {
1039 my @budget_users = GetBudgetUsers( $budget->{budget_id} );
1043 $budget->{budget_owner_id}
1044 and $budget->{budget_owner_id} !=
1045 $borrower->{borrowernumber}
1046 or not $budget->{budget_owner_id}
1048 and ( 0 == grep { $borrower->{borrowernumber} == $_ }
1050 and defined $budget->{budget_branchcode}
1051 and $budget->{budget_branchcode} ne
1052 C4::Context->userenv->{branch}
1059 # Budget restricted to owner and users
1060 elsif ( $budget->{budget_permission} == 3 ) {
1061 my @budget_users = GetBudgetUsers( $budget->{budget_id} );
1064 $budget->{budget_owner_id}
1065 and $budget->{budget_owner_id} !=
1066 $borrower->{borrowernumber}
1067 or not $budget->{budget_owner_id}
1069 and ( 0 == grep { $borrower->{borrowernumber} == $_ }
1081 sub CanUserModifyBudget {
1082 my ($borrower, $budget, $userflags) = @_;
1084 if (not ref $borrower) {
1085 $borrower = Koha::Patrons->find( $borrower );
1086 return 0 unless $borrower;
1087 $borrower = $borrower->unblessed;
1089 if (not ref $budget) {
1090 $budget = GetBudget($budget);
1093 return 0 unless ($borrower and $budget);
1095 if (not defined $userflags) {
1096 $userflags = C4::Auth::getuserflags($borrower->{flags},
1097 $borrower->{userid});
1100 unless ($userflags->{superlibrarian}
1101 || (ref $userflags->{acquisition}
1102 && $userflags->{acquisition}->{budget_manage_all})
1103 || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
1105 if (!CanUserUseBudget($borrower, $budget, $userflags)) {
1109 if (ref $userflags->{acquisition}
1110 && !$userflags->{acquisition}->{budget_modify}) {
1119 my ($value, $increment) = @_;
1121 if ($increment && $increment != 0) {
1122 $value = int($value / $increment) * $increment;
1128 =head2 CloneBudgetPeriod
1130 my $new_budget_period_id = CloneBudgetPeriod({
1131 budget_period_id => $budget_period_id,
1132 budget_period_startdate => $budget_period_startdate,
1133 budget_period_enddate => $budget_period_enddate,
1134 mark_original_budget_as_inactive => 1n
1135 reset_all_budgets => 1,
1138 Clone a budget period with all budgets.
1139 If the mark_origin_budget_as_inactive is set (0 by default),
1140 the original budget will be marked as inactive.
1142 If the reset_all_budgets is set (0 by default), all budget (fund)
1143 amounts will be reset.
1147 sub CloneBudgetPeriod {
1149 my $budget_period_id = $params->{budget_period_id};
1150 my $budget_period_startdate = $params->{budget_period_startdate};
1151 my $budget_period_enddate = $params->{budget_period_enddate};
1152 my $budget_period_description = $params->{budget_period_description};
1153 my $amount_change_percentage = $params->{amount_change_percentage};
1154 my $amount_change_round_increment = $params->{amount_change_round_increment};
1155 my $mark_original_budget_as_inactive =
1156 $params->{mark_original_budget_as_inactive} || 0;
1157 my $reset_all_budgets = $params->{reset_all_budgets} || 0;
1159 my $budget_period = GetBudgetPeriod($budget_period_id);
1161 $budget_period->{budget_period_startdate} = $budget_period_startdate;
1162 $budget_period->{budget_period_enddate} = $budget_period_enddate;
1163 $budget_period->{budget_period_description} = $budget_period_description;
1164 # The new budget (budget_period) should be active by default
1165 $budget_period->{budget_period_active} = 1;
1167 if ($amount_change_percentage) {
1168 my $total = $budget_period->{budget_period_total};
1169 $total += $total * $amount_change_percentage / 100;
1170 $total = _round($total, $amount_change_round_increment);
1171 $budget_period->{budget_period_total} = $total;
1174 my $original_budget_period_id = $budget_period->{budget_period_id};
1175 delete $budget_period->{budget_period_id};
1176 my $new_budget_period_id = AddBudgetPeriod( $budget_period );
1178 my $budgets = GetBudgetHierarchy($budget_period_id);
1179 CloneBudgetHierarchy(
1181 budgets => $budgets,
1182 new_budget_period_id => $new_budget_period_id
1186 if ($mark_original_budget_as_inactive) {
1189 budget_period_id => $budget_period_id,
1190 budget_period_active => 0,
1195 if ( $reset_all_budgets ) {
1196 my $budgets = GetBudgets({ budget_period_id => $new_budget_period_id });
1197 for my $budget ( @$budgets ) {
1198 $budget->{budget_amount} = 0;
1199 ModBudget( $budget );
1201 } elsif ($amount_change_percentage) {
1202 my $budgets = GetBudgets({ budget_period_id => $new_budget_period_id });
1203 for my $budget ( @$budgets ) {
1204 my $amount = $budget->{budget_amount};
1205 $amount += $amount * $amount_change_percentage / 100;
1206 $amount = _round($amount, $amount_change_round_increment);
1207 $budget->{budget_amount} = $amount;
1208 ModBudget( $budget );
1212 return $new_budget_period_id;
1215 =head2 CloneBudgetHierarchy
1217 CloneBudgetHierarchy({
1218 budgets => $budgets,
1219 new_budget_period_id => $new_budget_period_id;
1222 Clone a budget hierarchy.
1226 sub CloneBudgetHierarchy {
1228 my $budgets = $params->{budgets};
1229 my $new_budget_period_id = $params->{new_budget_period_id};
1230 next unless @$budgets or $new_budget_period_id;
1232 my $children_of = $params->{children_of};
1233 my $new_parent_id = $params->{new_parent_id};
1235 my @first_level_budgets =
1236 ( not defined $children_of )
1237 ? map { ( not $_->{budget_parent_id} ) ? $_ : () } @$budgets
1238 : map { ( $_->{budget_parent_id} == $children_of ) ? $_ : () } @$budgets;
1240 # get only the columns of aqbudgets
1241 my @columns = Koha::Database->new()->schema->source('Aqbudget')->columns;
1243 for my $budget ( sort { $a->{budget_id} <=> $b->{budget_id} }
1244 @first_level_budgets )
1248 { map { join( ' ', @columns ) =~ /$_/ ? ( $_ => $budget->{$_} ) : () }
1250 delete $tidy_budget->{timestamp};
1251 my $new_budget_id = AddBudget(
1255 budget_parent_id => $new_parent_id,
1256 budget_period_id => $new_budget_period_id
1259 CloneBudgetHierarchy(
1261 budgets => $budgets,
1262 new_budget_period_id => $new_budget_period_id,
1263 children_of => $budget->{budget_id},
1264 new_parent_id => $new_budget_id
1272 my $report = MoveOrders({
1273 from_budget_period_id => $from_budget_period_id,
1274 to_budget_period_id => $to_budget_period_id,
1277 Move orders from one budget period to another.
1283 my $from_budget_period_id = $params->{from_budget_period_id};
1284 my $to_budget_period_id = $params->{to_budget_period_id};
1285 my $move_remaining_unspent = $params->{move_remaining_unspent};
1287 if not $from_budget_period_id
1288 or not $to_budget_period_id
1289 or $from_budget_period_id == $to_budget_period_id;
1291 # Can't move orders to an inactive budget (budgetperiod)
1292 my $budget_period = GetBudgetPeriod($to_budget_period_id);
1293 return unless $budget_period->{budget_period_active};
1296 my $dbh = C4::Context->dbh;
1297 my $sth_update_aqorders = $dbh->prepare(
1301 WHERE ordernumber = ?
1304 my $sth_update_budget_amount = $dbh->prepare(
1307 SET budget_amount = ?
1311 my $from_budgets = GetBudgetHierarchy($from_budget_period_id);
1312 for my $from_budget (@$from_budgets) {
1313 my $new_budget_id = $dbh->selectcol_arrayref(
1317 WHERE budget_period_id = ?
1319 |, {}, $to_budget_period_id, $from_budget->{budget_code}
1321 $new_budget_id = $new_budget_id->[0];
1322 my $new_budget = GetBudget( $new_budget_id );
1323 unless ( $new_budget ) {
1327 budget => $from_budget,
1328 error => 'budget_code_not_exists',
1332 my $orders_to_move = C4::Acquisition::SearchOrders(
1334 budget_id => $from_budget->{budget_id},
1340 for my $order (@$orders_to_move) {
1341 $sth_update_aqorders->execute( $new_budget->{budget_id}, $order->{ordernumber} );
1342 push @orders_moved, $order;
1345 my $unspent_moved = 0;
1346 if ($move_remaining_unspent) {
1347 my $spent = GetBudgetHierarchySpent( $from_budget->{budget_id} );
1348 my $unspent = $from_budget->{budget_amount} - $spent;
1349 my $new_budget_amount = $new_budget->{budget_amount};
1350 if ( $unspent > 0 ) {
1351 $new_budget_amount += $unspent;
1352 $unspent_moved = $unspent;
1354 $new_budget->{budget_amount} = $new_budget_amount;
1355 $sth_update_budget_amount->execute( $new_budget_amount,
1356 $new_budget->{budget_id} );
1361 budget => $new_budget,
1362 orders_moved => \@orders_moved,
1364 unspent_moved => $unspent_moved,
1370 =head1 INTERNAL FUNCTIONS
1374 =head3 _get_rounding_sql
1376 $rounding_sql = _get_rounding_sql("mysql_variable_to_round_string");
1378 returns the correct SQL routine based on OrderPriceRounding system preference.
1382 sub _get_rounding_sql {
1383 my $to_round = shift;
1384 my $rounding_pref = C4::Context->preference('OrderPriceRounding');
1385 if ($rounding_pref eq 'nearest_cent') { return "CAST($to_round*100 AS INTEGER)/100"; }
1386 else { return "$to_round"; }
1389 END { } # module clean-up code here (global destructor)
1396 Koha Development Team <http://koha-community.org/>