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>.
24 use Koha::Acquisition::Invoice::Adjustments;
27 our (@ISA, @EXPORT_OK);
34 GetBudgetByOrderNumber
49 GetBudgetHierarchySpent
50 GetBudgetHierarchyOrdered
70 SetOwnerToFundHierarchy
83 # ----------------------------BUDGETS.PM-----------------------------";
85 =head1 FUNCTIONS ABOUT BUDGETS
90 my ( $authcat, @hide_cols ) = @_;
91 my $dbh = C4::Context->dbh;
93 my $sth1 = $dbh->prepare(
95 UPDATE aqbudgets_planning SET display = 0
99 foreach my $authvalue (@hide_cols) {
100 # $sth1->{TraceLevel} = 3;
101 $sth1->execute( $authcat, $authvalue );
106 my ( $authcat, $authvalue ) = @_;
108 my $dbh = C4::Context->dbh;
109 my $sth = $dbh->prepare(
111 SELECT count(display) as cnt from aqbudgets_planning
113 AND authvalue = ? and display = 0 |
116 # $sth->{TraceLevel} = 3;
117 $sth->execute( $authcat, $authvalue );
118 my $res = $sth->fetchrow_hashref;
120 return $res->{cnt} > 0 ? 0: 1
124 sub CheckBudgetParentPerm {
125 my ( $budget, $borrower_id ) = @_;
126 my $depth = $budget->{depth};
127 my $parent_id = $budget->{budget_parent_id};
129 my $parent = GetBudget($parent_id);
130 $parent_id = $parent->{budget_parent_id};
131 if ( $parent->{budget_owner_id} == $borrower_id ) {
139 sub AddBudgetPeriod {
140 my ($budgetperiod) = @_;
141 return unless($budgetperiod->{budget_period_startdate} && $budgetperiod->{budget_period_enddate});
143 undef $budgetperiod->{budget_period_id};
144 my $resultset = Koha::Database->new()->schema->resultset('Aqbudgetperiod');
145 return $resultset->create($budgetperiod)->id;
147 # -------------------------------------------------------------------
148 sub GetPeriodsCount {
149 my $dbh = C4::Context->dbh;
150 my $sth = $dbh->prepare("
151 SELECT COUNT(*) AS sum FROM aqbudgetperiods ");
153 my $res = $sth->fetchrow_hashref;
154 return $res->{'sum'};
157 # -------------------------------------------------------------------
158 sub CheckBudgetParent {
159 my ( $new_parent, $budget ) = @_;
160 my $new_parent_id = $new_parent->{'budget_id'};
161 my $budget_id = $budget->{'budget_id'};
162 my $dbh = C4::Context->dbh;
163 my $parent_id_tmp = $new_parent_id;
165 # check new-parent is not a child (or a child's child ;)
166 my $sth = $dbh->prepare(qq|
167 SELECT budget_parent_id FROM
168 aqbudgets where budget_id = ? | );
170 $sth->execute($parent_id_tmp);
171 my $res = $sth->fetchrow_hashref;
172 if ( $res->{'budget_parent_id'} == $budget_id ) {
175 if ( not defined $res->{'budget_parent_id'} ) {
178 $parent_id_tmp = $res->{'budget_parent_id'};
182 # -------------------------------------------------------------------
183 sub BudgetHasChildren {
184 my ( $budget_id ) = @_;
185 my $dbh = C4::Context->dbh;
186 my $sth = $dbh->prepare(qq|
187 SELECT count(*) as sum FROM aqbudgets
188 WHERE budget_parent_id = ? | );
189 $sth->execute( $budget_id );
190 my $sum = $sth->fetchrow_hashref;
191 return $sum->{'sum'};
194 sub GetBudgetChildren {
195 my ( $budget_id ) = @_;
196 my $dbh = C4::Context->dbh;
197 return $dbh->selectall_arrayref(q|
198 SELECT * FROM aqbudgets
199 WHERE budget_parent_id = ?
200 |, { Slice => {} }, $budget_id );
203 sub SetOwnerToFundHierarchy {
204 my ( $budget_id, $borrowernumber ) = @_;
206 my $budget = GetBudget( $budget_id );
207 $budget->{budget_owner_id} = $borrowernumber;
208 ModBudget( $budget );
209 my $children = GetBudgetChildren( $budget_id );
210 for my $child ( @$children ) {
211 SetOwnerToFundHierarchy( $child->{budget_id}, $borrowernumber );
215 # -------------------------------------------------------------------
216 sub GetBudgetsPlanCell {
217 my ( $cell, $period, $budget ) = @_; #FIXME we don't use $period
219 my $dbh = C4::Context->dbh;
220 my $roundsql = C4::Acquisition::get_rounding_sql(qq|ecost_tax_included|);
221 if ( $cell->{'authcat'} eq 'MONTHS' ) {
222 # get the actual amount
223 # FIXME we should consider quantity
224 $sth = $dbh->prepare( qq|
226 SELECT SUM(| . $roundsql . qq|) AS actual FROM aqorders
227 WHERE budget_id = ? AND
228 entrydate like "$cell->{'authvalue'}%" |
230 $sth->execute( $cell->{'budget_id'} );
231 } elsif ( $cell->{'authcat'} eq 'BRANCHES' ) {
232 # get the actual amount
233 # FIXME we should consider quantity
234 $sth = $dbh->prepare( qq|
236 SELECT SUM(| . $roundsql . qq|) FROM aqorders
237 LEFT JOIN aqorders_items
238 ON (aqorders.ordernumber = aqorders_items.ordernumber)
240 ON (aqorders_items.itemnumber = items.itemnumber)
241 WHERE budget_id = ? AND homebranch = ? | );
243 $sth->execute( $cell->{'budget_id'}, $cell->{'authvalue'} );
244 } elsif ( $cell->{'authcat'} eq 'ITEMTYPES' ) {
245 # get the actual amount
246 $sth = $dbh->prepare( qq|
248 SELECT SUM( | . $roundsql . qq| * quantity) AS actual
249 FROM aqorders JOIN biblioitems
250 ON (biblioitems.biblionumber = aqorders.biblionumber )
251 WHERE aqorders.budget_id = ? and itemtype = ? |
253 $sth->execute( $cell->{'budget_id'},
254 $cell->{'authvalue'} );
256 # ELSE GENERIC ORDERS SORT1/SORT2 STAT COUNT.
258 # get the actual amount
259 $sth = $dbh->prepare( qq|
261 SELECT SUM(| . $roundsql . qq| * quantity) AS actual
263 JOIN aqbudgets ON (aqbudgets.budget_id = aqorders.budget_id )
264 WHERE aqorders.budget_id = ? AND
265 ((aqbudgets.sort1_authcat = ? AND sort1 =?) OR
266 (aqbudgets.sort2_authcat = ? AND sort2 =?)) |
268 $sth->execute( $cell->{'budget_id'},
269 $budget->{'sort1_authcat'},
270 $cell->{'authvalue'},
271 $budget->{'sort2_authcat'},
275 $actual = $sth->fetchrow_array;
277 # get the estimated amount
278 $sth = $dbh->prepare( qq|
280 SELECT estimated_amount AS estimated, display FROM aqbudgets_planning
281 WHERE budget_period_id = ? AND
286 $sth->execute( $cell->{'budget_period_id'},
287 $cell->{'budget_id'},
288 $cell->{'authvalue'},
293 my $res = $sth->fetchrow_hashref;
294 # my $display = $res->{'display'};
295 my $estimated = $res->{'estimated'};
298 return $actual, $estimated;
301 # -------------------------------------------------------------------
303 my ( $budget_plan, $budget_period_id, $authcat ) = @_;
304 my $dbh = C4::Context->dbh;
305 foreach my $buds (@$budget_plan) {
306 my $lines = $buds->{lines};
307 my $sth = $dbh->prepare( qq|
308 DELETE FROM aqbudgets_planning
309 WHERE budget_period_id = ? AND
313 #delete a aqplan line of cells, then insert new cells,
314 # these could be UPDATES rather than DEL/INSERTS...
315 $sth->execute( $budget_period_id, $lines->[0]{budget_id} , $authcat );
317 foreach my $cell (@$lines) {
318 my $sth = $dbh->prepare( qq|
320 INSERT INTO aqbudgets_planning
322 budget_period_id = ?,
324 estimated_amount = ?,
328 $cell->{'budget_id'},
329 $cell->{'budget_period_id'},
331 $cell->{'estimated_amount'},
332 $cell->{'authvalue'},
338 # -------------------------------------------------------------------
340 my ($budget_id) = @_;
341 my $dbh = C4::Context->dbh;
342 # unitprice_tax_included should always been set here
343 # we should not need to retrieve ecost_tax_included
344 my $sth = $dbh->prepare(qq|
345 SELECT SUM( | . C4::Acquisition::get_rounding_sql("COALESCE(unitprice_tax_included, ecost_tax_included)") . qq| * quantity ) AS sum FROM aqorders
346 WHERE budget_id = ? AND
347 quantityreceived > 0 AND
348 datecancellationprinted IS NULL
350 $sth->execute($budget_id);
351 my $sum = ( $sth->fetchrow_array || 0 ) + 0;
353 $sth = $dbh->prepare(qq|
354 SELECT SUM(shipmentcost) AS sum
356 WHERE shipmentcost_budgetid = ?
359 $sth->execute($budget_id);
360 my ($shipmentcost_sum) = $sth->fetchrow_array;
361 $sum += ( $shipmentcost_sum || 0 ) + 0;
363 my $adjustments = Koha::Acquisition::Invoice::Adjustments->search({budget_id => $budget_id, closedate => { '!=' => undef } },{ join => 'invoiceid' });
364 while ( my $adj = $adjustments->next ){
365 $sum += $adj->adjustment;
371 # -------------------------------------------------------------------
372 sub GetBudgetOrdered {
373 my ($budget_id) = @_;
374 my $dbh = C4::Context->dbh;
375 my $sth = $dbh->prepare(qq|
376 SELECT SUM(| . C4::Acquisition::get_rounding_sql(qq|ecost_tax_included|) . qq| * quantity) AS sum FROM aqorders
377 WHERE budget_id = ? AND
378 quantityreceived = 0 AND
379 datecancellationprinted IS NULL
381 $sth->execute($budget_id);
382 my $sum = ( $sth->fetchrow_array || 0 ) + 0;
384 my $adjustments = Koha::Acquisition::Invoice::Adjustments->search({budget_id => $budget_id, encumber_open => 1, closedate => undef},{ join => 'invoiceid' });
385 while ( my $adj = $adjustments->next ){
386 $sum += $adj->adjustment;
394 my $budget_name = &GetBudgetName($budget_id);
396 get the budget_name for a given budget_id
401 my ( $budget_id ) = @_;
402 my $dbh = C4::Context->dbh;
403 my $sth = $dbh->prepare(
410 $sth->execute($budget_id);
411 return $sth->fetchrow_array;
414 =head2 GetBudgetAuthCats
416 my $auth_cats = &GetBudgetAuthCats($budget_period_id);
418 Return the list of authcat for a given budget_period_id
422 sub GetBudgetAuthCats {
423 my ($budget_period_id) = shift;
424 # now, populate the auth_cats_loop used in the budget planning button
425 # we must retrieve all auth values used by at least one budget
426 my $dbh = C4::Context->dbh;
427 my $sth=$dbh->prepare("SELECT sort1_authcat,sort2_authcat FROM aqbudgets WHERE budget_period_id=?");
428 $sth->execute($budget_period_id);
430 while (my ($sort1_authcat,$sort2_authcat) = $sth->fetchrow) {
431 $authcats{$sort1_authcat}=1 if $sort1_authcat;
432 $authcats{$sort2_authcat}=1 if $sort2_authcat;
434 return [ sort keys %authcats ];
437 # -------------------------------------------------------------------
438 sub GetBudgetPeriods {
439 my ($filters,$orderby) = @_;
441 my $rs = Koha::Database->new()->schema->resultset('Aqbudgetperiod');
442 $rs = $rs->search( $filters, { order_by => $orderby } );
443 $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
446 # -------------------------------------------------------------------
447 sub GetBudgetPeriod {
448 my ($budget_period_id) = @_;
449 my $dbh = C4::Context->dbh;
450 my $sth = $dbh->prepare( qq|
453 WHERE budget_period_id=? |
455 $sth->execute($budget_period_id);
456 return $sth->fetchrow_hashref;
460 my ($budget_period_id) = @_;
461 my $dbh = C4::Context->dbh;
462 ; ## $total = number of records linked to the record that must be deleted
465 ## get information about the record that will be deleted
466 my $sth = $dbh->prepare(qq|
469 WHERE budget_period_id=? |
471 return $sth->execute($budget_period_id);
474 # -------------------------------------------------------------------
475 sub ModBudgetPeriod {
476 my ($budget_period) = @_;
477 my $result = Koha::Database->new()->schema->resultset('Aqbudgetperiod')->find($budget_period);
478 return unless($result);
480 $result = $result->update($budget_period);
481 return $result->in_storage;
484 # -------------------------------------------------------------------
485 sub GetBudgetHierarchy {
486 my ( $budget_period_id, $branchcode, $owner ) = @_;
488 my $dbh = C4::Context->dbh;
490 SELECT aqbudgets.*, aqbudgetperiods.budget_period_active, aqbudgetperiods.budget_period_description,
491 b.firstname as budget_owner_firstname, b.surname as budget_owner_surname, b.borrowernumber as budget_owner_borrowernumber
493 LEFT JOIN borrowers b on b.borrowernumber = aqbudgets.budget_owner_id
494 JOIN aqbudgetperiods USING (budget_period_id)|;
497 # show only period X if requested
498 if ($budget_period_id) {
499 push @where_strings," aqbudgets.budget_period_id = ?";
500 push @bind_params, $budget_period_id;
502 # show only budgets owned by me, my branch or everyone
506 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="")))};
507 push @bind_params, ( $owner, $branchcode );
509 push @where_strings, ' (budget_owner_id = ? OR budget_owner_id IS NULL or budget_owner_id ="") ';
510 push @bind_params, $owner;
514 push @where_strings," (budget_branchcode =? or budget_branchcode is NULL OR budget_branchcode='')";
515 push @bind_params, $branchcode;
518 $query.=" WHERE ".join(' AND ', @where_strings) if @where_strings;
519 my $sth = $dbh->prepare($query);
520 $sth->execute(@bind_params);
523 # create hash with budget_id has key
524 while ( my $data = $sth->fetchrow_hashref ) {
525 $links{ $data->{'budget_id'} } = $data;
528 # link child to parent
530 foreach my $budget ( sort { $a->{budget_code} cmp $b->{budget_code} } values %links ) {
531 my $child = $links{$budget->{budget_id}};
532 if ( $child->{'budget_parent_id'} ) {
533 my $parent = $links{ $child->{'budget_parent_id'} };
535 unless ( $parent->{'children'} ) {
536 # init child arrayref
537 $parent->{'children'} = [];
540 push @{ $parent->{'children'} }, $child;
543 push @first_parents, $child;
548 foreach my $first_parent (@first_parents) {
549 _add_budget_children(\@sort, $first_parent, 0);
552 # Get all the budgets totals in as few queries as possible
553 my $hr_budget_spent = $dbh->selectall_hashref(q|
554 SELECT aqorders.budget_id, aqbudgets.budget_parent_id,
555 SUM( | . C4::Acquisition::get_rounding_sql(qq|COALESCE(unitprice_tax_included, ecost_tax_included)|) . q| * quantity ) AS budget_spent
556 FROM aqorders JOIN aqbudgets USING (budget_id)
557 WHERE quantityreceived > 0 AND datecancellationprinted IS NULL
558 GROUP BY budget_id, budget_parent_id
560 my $hr_budget_ordered = $dbh->selectall_hashref(q|
561 SELECT aqorders.budget_id, aqbudgets.budget_parent_id,
562 SUM( | . C4::Acquisition::get_rounding_sql(qq|ecost_tax_included|) . q| * quantity) AS budget_ordered
563 FROM aqorders JOIN aqbudgets USING (budget_id)
564 WHERE quantityreceived = 0 AND datecancellationprinted IS NULL
565 GROUP BY budget_id, budget_parent_id
567 my $hr_budget_spent_shipment = $dbh->selectall_hashref(q|
568 SELECT shipmentcost_budgetid as budget_id,
569 SUM(shipmentcost) as shipmentcost
571 GROUP BY shipmentcost_budgetid
573 my $hr_budget_spent_adjustment = $dbh->selectall_hashref(q|
575 SUM(adjustment) as adjustments
576 FROM aqinvoice_adjustments
577 JOIN aqinvoices USING (invoiceid)
578 WHERE closedate IS NOT NULL
581 my $hr_budget_ordered_adjustment = $dbh->selectall_hashref(q|
583 SUM(adjustment) as adjustments
584 FROM aqinvoice_adjustments
585 JOIN aqinvoices USING (invoiceid)
586 WHERE closedate IS NULL AND encumber_open = 1
591 foreach my $budget (@sort) {
592 if ( not defined $budget->{budget_parent_id} ) {
593 _recursiveAdd( $budget, undef, $hr_budget_spent, $hr_budget_spent_shipment, $hr_budget_ordered, $hr_budget_spent_adjustment, $hr_budget_ordered_adjustment );
600 my ($budget, $parent, $hr_budget_spent, $hr_budget_spent_shipment, $hr_budget_ordered, $hr_budget_spent_adjustment, $hr_budget_ordered_adjustment ) = @_;
602 foreach my $child (@{$budget->{children}}){
603 _recursiveAdd($child, $budget, $hr_budget_spent, $hr_budget_spent_shipment, $hr_budget_ordered, $hr_budget_spent_adjustment, $hr_budget_ordered_adjustment );
606 $budget->{budget_spent} += $hr_budget_spent->{$budget->{budget_id}}->{budget_spent} || 0;
607 $budget->{budget_spent} += $hr_budget_spent_shipment->{$budget->{budget_id}}->{shipmentcost} || 0;
608 $budget->{budget_spent} += $hr_budget_spent_adjustment->{$budget->{budget_id}}->{adjustments} || 0;
609 $budget->{budget_ordered} += $hr_budget_ordered->{$budget->{budget_id}}->{budget_ordered} || 0;
610 $budget->{budget_ordered} += $hr_budget_ordered_adjustment->{$budget->{budget_id}}->{adjustments} || 0;
612 $budget->{total_spent} += $budget->{budget_spent};
613 $budget->{total_ordered} += $budget->{budget_ordered};
616 $parent->{total_spent} += $budget->{total_spent};
617 $parent->{total_ordered} += $budget->{total_ordered};
621 # Recursive method to add a budget and its chidren to an array
622 sub _add_budget_children {
625 $budget->{budget_level} = shift;
627 my $children = $budget->{'children'} || [];
628 return unless @$children; # break recursivity
629 foreach my $child (@$children) {
630 _add_budget_children($res, $child, $budget->{budget_level} + 1);
634 # -------------------------------------------------------------------
635 # FIXME Must be replaced by Koha::Acquisition::Fund->store
638 return unless ($budget);
640 undef $budget->{budget_encumb} if defined $budget->{budget_encumb} && $budget->{budget_encumb} eq '';
641 undef $budget->{budget_owner_id} if defined $budget->{budget_owner_id} && $budget->{budget_owner_id} eq '';
642 my $resultset = Koha::Database->new()->schema->resultset('Aqbudget');
643 return $resultset->create($budget)->id;
646 # -------------------------------------------------------------------
647 # FIXME Must be replaced by Koha::Acquisition::Fund->store
650 my $result = Koha::Database->new()->schema->resultset('Aqbudget')->find($budget);
651 return unless($result);
653 undef $budget->{budget_encumb} if defined $budget->{budget_encumb} && $budget->{budget_encumb} eq '';
654 undef $budget->{budget_owner_id} if defined $budget->{budget_owner_id} && $budget->{budget_owner_id} eq '';
655 $result = $result->update($budget);
656 return $result->in_storage;
659 # -------------------------------------------------------------------
660 # FIXME Must be replaced by Koha::Acquisition::Fund->delete
662 my ($budget_id) = @_;
663 my $dbh = C4::Context->dbh;
664 my $sth = $dbh->prepare("delete from aqbudgets where budget_id=?");
665 my $rc = $sth->execute($budget_id);
670 # -------------------------------------------------------------------
674 &GetBudget($budget_id);
676 get a specific budget
681 my ( $budget_id ) = @_;
682 my $dbh = C4::Context->dbh;
688 my $sth = $dbh->prepare($query);
689 $sth->execute( $budget_id );
690 my $result = $sth->fetchrow_hashref;
694 # -------------------------------------------------------------------
696 =head2 GetBudgetByOrderNumber
698 &GetBudgetByOrderNumber($ordernumber);
700 get a specific budget by order number
704 sub GetBudgetByOrderNumber {
705 my ( $ordernumber ) = @_;
706 my $dbh = C4::Context->dbh;
709 FROM aqbudgets, aqorders
711 AND aqorders.budget_id = aqbudgets.budget_id
713 my $sth = $dbh->prepare($query);
714 $sth->execute( $ordernumber );
715 my $result = $sth->fetchrow_hashref;
719 =head2 GetBudgetReport
721 &GetBudgetReport( [$budget_id] );
723 Get all orders for a specific budget, without cancelled orders.
725 Returns an array of hashrefs.
729 # --------------------------------------------------------------------
730 sub GetBudgetReport {
731 my ( $budget_id ) = @_;
732 my $dbh = C4::Context->dbh;
734 SELECT o.*, b.budget_name
736 INNER JOIN aqorders o
737 ON b.budget_id = o.budget_id
739 AND (o.orderstatus != "cancelled")
740 ORDER BY b.budget_name';
742 my $sth = $dbh->prepare($query);
743 $sth->execute( $budget_id );
746 while ( my $data = $sth->fetchrow_hashref ) {
747 push( @results, $data );
752 =head2 GetBudgetsByActivity
754 &GetBudgetsByActivity( $budget_period_active );
756 Get all active or inactive budgets, depending of the value
764 # --------------------------------------------------------------------
765 sub GetBudgetsByActivity {
766 my ( $budget_period_active ) = @_;
767 my $dbh = C4::Context->dbh;
770 FROM aqbudgetperiods bp
771 INNER JOIN aqbudgets b
772 ON bp.budget_period_id = b.budget_period_id
773 WHERE bp.budget_period_active=?
775 my $sth = $dbh->prepare($query);
776 $sth->execute( $budget_period_active );
778 while ( my $data = $sth->fetchrow_hashref ) {
779 push( @results, $data );
783 # --------------------------------------------------------------------
785 =head2 GetBudgetsReport
787 &GetBudgetsReport( [$activity] );
789 Get all but cancelled orders for all funds.
791 If the optionnal activity parameter is passed, returns orders for active/inactive budgets only.
796 Returns an array of hashrefs.
800 sub GetBudgetsReport {
802 my $dbh = C4::Context->dbh;
804 SELECT o.*, b.budget_name
805 FROM aqbudgetperiods bp
806 INNER JOIN aqbudgets b
807 ON bp.budget_period_id = b.budget_period_id
808 INNER JOIN aqorders o
809 ON b.budget_id = o.budget_id ';
810 if ( $activity && $activity ne '' ) {
811 $query .= 'WHERE bp.budget_period_active=? ';
813 $query .= 'AND (o.orderstatus != "cancelled")
814 ORDER BY b.budget_name';
816 my $sth = $dbh->prepare($query);
817 if ( $activity && $activity ne '' ) {
818 $sth->execute($activity);
824 while ( my $data = $sth->fetchrow_hashref ) {
825 push( @results, $data );
830 =head2 GetBudgetByCode
832 my $budget = &GetBudgetByCode($budget_code);
834 Retrieve all aqbudgets fields as a hashref for the budget that has
839 sub GetBudgetByCode {
840 my ( $budget_code ) = @_;
842 my $dbh = C4::Context->dbh;
846 JOIN aqbudgetperiods USING (budget_period_id)
847 WHERE budget_code = ?
848 ORDER BY budget_period_active DESC, budget_id DESC
851 my $sth = $dbh->prepare( $query );
852 $sth->execute( $budget_code );
853 return $sth->fetchrow_hashref;
856 =head2 GetBudgetHierarchySpent
858 my $spent = GetBudgetHierarchySpent( $budget_id );
860 Gets the total spent of the level and sublevels of $budget_id
864 sub GetBudgetHierarchySpent {
865 my ( $budget_id ) = @_;
866 my $dbh = C4::Context->dbh;
867 my $children_ids = $dbh->selectcol_arrayref(q|
870 WHERE budget_parent_id = ?
873 my $total_spent = GetBudgetSpent( $budget_id );
874 for my $child_id ( @$children_ids ) {
875 $total_spent += GetBudgetHierarchySpent( $child_id );
880 =head2 GetBudgetHierarchyOrdered
882 my $ordered = GetBudgetHierarchyOrdered( $budget_id );
884 Gets the total ordered of the level and sublevels of $budget_id
888 sub GetBudgetHierarchyOrdered {
889 my ( $budget_id ) = @_;
890 my $dbh = C4::Context->dbh;
891 my $children_ids = $dbh->selectcol_arrayref(q|
894 WHERE budget_parent_id = ?
897 my $total_ordered = GetBudgetOrdered( $budget_id );
898 for my $child_id ( @$children_ids ) {
899 $total_ordered += GetBudgetHierarchyOrdered( $child_id );
901 return $total_ordered;
906 &GetBudgets($filter, $order_by);
912 # -------------------------------------------------------------------
914 my ($filters, $orderby) = @_;
915 $orderby = 'budget_name' unless($orderby);
917 my $rs = Koha::Database->new()->schema->resultset('Aqbudget');
918 $rs = $rs->search( $filters, { order_by => $orderby } );
919 $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
923 =head2 GetBudgetUsers
925 my @borrowernumbers = &GetBudgetUsers($budget_id);
927 Return the list of borrowernumbers linked to a budget
932 my ($budget_id) = @_;
934 my $dbh = C4::Context->dbh;
936 SELECT borrowernumber
937 FROM aqbudgetborrowers
940 my $sth = $dbh->prepare($query);
941 $sth->execute($budget_id);
944 while (my ($borrowernumber) = $sth->fetchrow_array) {
945 push @borrowernumbers, $borrowernumber
948 return @borrowernumbers;
951 =head2 ModBudgetUsers
953 &ModBudgetUsers($budget_id, @borrowernumbers);
955 Modify the list of borrowernumbers linked to a budget
960 my ($budget_id, @budget_users_id) = @_;
962 return unless $budget_id;
964 my $dbh = C4::Context->dbh;
965 my $query = "DELETE FROM aqbudgetborrowers WHERE budget_id = ?";
966 my $sth = $dbh->prepare($query);
967 $sth->execute($budget_id);
970 INSERT INTO aqbudgetborrowers (budget_id, borrowernumber)
973 $sth = $dbh->prepare($query);
974 foreach my $borrowernumber (@budget_users_id) {
975 next unless $borrowernumber;
976 $sth->execute($budget_id, $borrowernumber);
980 sub CanUserUseBudget {
981 my ($borrower, $budget, $userflags) = @_;
983 if (not ref $borrower) {
984 $borrower = Koha::Patrons->find( $borrower );
985 return 0 unless $borrower;
986 $borrower = $borrower->unblessed;
988 if (not ref $budget) {
989 $budget = GetBudget($budget);
992 return 0 unless ($borrower and $budget);
994 if (not defined $userflags) {
995 $userflags = C4::Auth::getuserflags($borrower->{flags},
996 $borrower->{userid});
999 unless ($userflags->{superlibrarian}
1000 || (ref $userflags->{acquisition}
1001 && $userflags->{acquisition}->{budget_manage_all})
1002 || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
1004 if (not exists $userflags->{acquisition}) {
1008 if (!ref $userflags->{acquisition} && !$userflags->{acquisition}) {
1012 # Budget restricted to owner
1013 if ( $budget->{budget_permission} == 1 ) {
1014 if ( $budget->{budget_owner_id}
1015 and $budget->{budget_owner_id} != $borrower->{borrowernumber} )
1021 # Budget restricted to owner, users and library
1022 elsif ( $budget->{budget_permission} == 2 ) {
1023 my @budget_users = GetBudgetUsers( $budget->{budget_id} );
1027 $budget->{budget_owner_id}
1028 and $budget->{budget_owner_id} !=
1029 $borrower->{borrowernumber}
1030 or not $budget->{budget_owner_id}
1032 and ( 0 == grep { $borrower->{borrowernumber} == $_ }
1034 and defined $budget->{budget_branchcode}
1035 and $budget->{budget_branchcode} ne
1036 C4::Context->userenv->{branch}
1043 # Budget restricted to owner and users
1044 elsif ( $budget->{budget_permission} == 3 ) {
1045 my @budget_users = GetBudgetUsers( $budget->{budget_id} );
1048 $budget->{budget_owner_id}
1049 and $budget->{budget_owner_id} !=
1050 $borrower->{borrowernumber}
1051 or not $budget->{budget_owner_id}
1053 and ( 0 == grep { $borrower->{borrowernumber} == $_ }
1065 sub CanUserModifyBudget {
1066 my ($borrower, $budget, $userflags) = @_;
1068 if (not ref $borrower) {
1069 $borrower = Koha::Patrons->find( $borrower );
1070 return 0 unless $borrower;
1071 $borrower = $borrower->unblessed;
1073 if (not ref $budget) {
1074 $budget = GetBudget($budget);
1077 return 0 unless ($borrower and $budget);
1079 if (not defined $userflags) {
1080 $userflags = C4::Auth::getuserflags($borrower->{flags},
1081 $borrower->{userid});
1084 unless ($userflags->{superlibrarian}
1085 || (ref $userflags->{acquisition}
1086 && $userflags->{acquisition}->{budget_manage_all})
1087 || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
1089 if (!CanUserUseBudget($borrower, $budget, $userflags)) {
1093 if (ref $userflags->{acquisition}
1094 && !$userflags->{acquisition}->{budget_modify}) {
1103 my ($value, $increment) = @_;
1105 if ($increment && $increment != 0) {
1106 $value = int($value / $increment) * $increment;
1112 =head2 CloneBudgetPeriod
1114 my $new_budget_period_id = CloneBudgetPeriod({
1115 budget_period_id => $budget_period_id,
1116 budget_period_startdate => $budget_period_startdate,
1117 budget_period_enddate => $budget_period_enddate,
1118 mark_original_budget_as_inactive => 1n
1119 reset_all_budgets => 1,
1122 Clone a budget period with all budgets.
1123 If the mark_origin_budget_as_inactive is set (0 by default),
1124 the original budget will be marked as inactive.
1126 If the reset_all_budgets is set (0 by default), all budget (fund)
1127 amounts will be reset.
1131 sub CloneBudgetPeriod {
1133 my $budget_period_id = $params->{budget_period_id};
1134 my $budget_period_startdate = $params->{budget_period_startdate};
1135 my $budget_period_enddate = $params->{budget_period_enddate};
1136 my $budget_period_description = $params->{budget_period_description};
1137 my $amount_change_percentage = $params->{amount_change_percentage};
1138 my $amount_change_round_increment = $params->{amount_change_round_increment};
1139 my $mark_original_budget_as_inactive =
1140 $params->{mark_original_budget_as_inactive} || 0;
1141 my $reset_all_budgets = $params->{reset_all_budgets} || 0;
1143 my $budget_period = GetBudgetPeriod($budget_period_id);
1145 $budget_period->{budget_period_startdate} = $budget_period_startdate;
1146 $budget_period->{budget_period_enddate} = $budget_period_enddate;
1147 $budget_period->{budget_period_description} = $budget_period_description;
1148 # The new budget (budget_period) should be active by default
1149 $budget_period->{budget_period_active} = 1;
1151 if ($amount_change_percentage) {
1152 my $total = $budget_period->{budget_period_total};
1153 $total += $total * $amount_change_percentage / 100;
1154 $total = _round($total, $amount_change_round_increment);
1155 $budget_period->{budget_period_total} = $total;
1158 my $original_budget_period_id = $budget_period->{budget_period_id};
1159 delete $budget_period->{budget_period_id};
1160 my $new_budget_period_id = AddBudgetPeriod( $budget_period );
1162 my $budgets = GetBudgetHierarchy($budget_period_id);
1163 CloneBudgetHierarchy(
1165 budgets => $budgets,
1166 new_budget_period_id => $new_budget_period_id
1170 if ($mark_original_budget_as_inactive) {
1173 budget_period_id => $budget_period_id,
1174 budget_period_active => 0,
1179 if ( $reset_all_budgets ) {
1180 my $budgets = GetBudgets({ budget_period_id => $new_budget_period_id });
1181 for my $budget ( @$budgets ) {
1182 $budget->{budget_amount} = 0;
1183 ModBudget( $budget );
1185 } elsif ($amount_change_percentage) {
1186 my $budgets = GetBudgets({ budget_period_id => $new_budget_period_id });
1187 for my $budget ( @$budgets ) {
1188 my $amount = $budget->{budget_amount};
1189 $amount += $amount * $amount_change_percentage / 100;
1190 $amount = _round($amount, $amount_change_round_increment);
1191 $budget->{budget_amount} = $amount;
1192 ModBudget( $budget );
1196 return $new_budget_period_id;
1199 =head2 CloneBudgetHierarchy
1201 CloneBudgetHierarchy({
1202 budgets => $budgets,
1203 new_budget_period_id => $new_budget_period_id;
1206 Clone a budget hierarchy.
1210 sub CloneBudgetHierarchy {
1212 my $budgets = $params->{budgets};
1213 my $new_budget_period_id = $params->{new_budget_period_id};
1214 next unless @$budgets or $new_budget_period_id;
1216 my $children_of = $params->{children_of};
1217 my $new_parent_id = $params->{new_parent_id};
1219 my @first_level_budgets =
1220 ( not defined $children_of )
1221 ? map { ( not $_->{budget_parent_id} ) ? $_ : () } @$budgets
1222 : map { ( defined $_->{budget_parent_id} && $_->{budget_parent_id} == $children_of ) ? $_ : () } @$budgets;
1224 # get only the columns of aqbudgets
1225 my @columns = Koha::Database->new()->schema->source('Aqbudget')->columns;
1227 for my $budget ( sort { $a->{budget_id} <=> $b->{budget_id} }
1228 @first_level_budgets )
1232 { map { join( ' ', @columns ) =~ /$_/ ? ( $_ => $budget->{$_} ) : () }
1234 delete $tidy_budget->{timestamp};
1235 my $new_budget_id = AddBudget(
1239 budget_parent_id => $new_parent_id,
1240 budget_period_id => $new_budget_period_id
1243 CloneBudgetHierarchy(
1245 budgets => $budgets,
1246 new_budget_period_id => $new_budget_period_id,
1247 children_of => $budget->{budget_id},
1248 new_parent_id => $new_budget_id
1256 my $report = MoveOrders({
1257 from_budget_period_id => $from_budget_period_id,
1258 to_budget_period_id => $to_budget_period_id,
1261 Move orders from one budget period to another.
1267 my $from_budget_period_id = $params->{from_budget_period_id};
1268 my $to_budget_period_id = $params->{to_budget_period_id};
1269 my $move_remaining_unspent = $params->{move_remaining_unspent};
1271 if not $from_budget_period_id
1272 or not $to_budget_period_id
1273 or $from_budget_period_id == $to_budget_period_id;
1275 # Can't move orders to an inactive budget (budgetperiod)
1276 my $budget_period = GetBudgetPeriod($to_budget_period_id);
1277 return unless $budget_period->{budget_period_active};
1280 my $dbh = C4::Context->dbh;
1281 my $sth_update_aqorders = $dbh->prepare(
1285 WHERE ordernumber = ?
1288 my $sth_update_budget_amount = $dbh->prepare(
1291 SET budget_amount = ?
1295 my $from_budgets = GetBudgetHierarchy($from_budget_period_id);
1296 for my $from_budget (@$from_budgets) {
1297 my $new_budget_id = $dbh->selectcol_arrayref(
1301 WHERE budget_period_id = ?
1303 |, {}, $to_budget_period_id, $from_budget->{budget_code}
1305 $new_budget_id = $new_budget_id->[0];
1306 my $new_budget = GetBudget( $new_budget_id );
1307 unless ( $new_budget ) {
1311 budget => $from_budget,
1312 error => 'budget_code_not_exists',
1316 my $orders_to_move = C4::Acquisition::SearchOrders(
1318 budget_id => $from_budget->{budget_id},
1324 for my $order (@$orders_to_move) {
1325 $sth_update_aqorders->execute( $new_budget->{budget_id}, $order->{ordernumber} );
1326 push @orders_moved, $order;
1329 my $unspent_moved = 0;
1330 if ($move_remaining_unspent) {
1331 my $spent = GetBudgetHierarchySpent( $from_budget->{budget_id} );
1332 my $unspent = $from_budget->{budget_amount} - $spent;
1333 my $new_budget_amount = $new_budget->{budget_amount};
1334 if ( $unspent > 0 ) {
1335 $new_budget_amount += $unspent;
1336 $unspent_moved = $unspent;
1338 $new_budget->{budget_amount} = $new_budget_amount;
1339 $sth_update_budget_amount->execute( $new_budget_amount,
1340 $new_budget->{budget_id} );
1345 budget => $new_budget,
1346 orders_moved => \@orders_moved,
1348 unspent_moved => $unspent_moved,
1354 END { } # module clean-up code here (global destructor)
1361 Koha Development Team <http://koha-community.org/>