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