C4/Bookfund.pm

   1 package C4::Bookfund;
   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 under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  18 # Suite 330, Boston, MA  02111-1307 USA
  19
  20
  21 use strict;
  22 # use Smart::Comments;
  23
  24 use vars qw($VERSION @ISA @EXPORT);
  25
  26 # set the version for version checking
  27 $VERSION = 3.00;
  28
  29 =head1 NAME
  30
  31 C4::Bookfund - Koha functions for dealing with bookfund, currency & money.
  32
  33 =head1 SYNOPSIS
  34
  35 use C4::Bookfund;
  36
  37 =head1 DESCRIPTION
  38
  39 the functions in this modules deal with bookfund, currency and money.
  40 They allow to get and/or set some informations for a specific budget or currency.
  41
  42 =cut
  43
  44 @ISA    = qw(Exporter);
  45 @EXPORT = qw(
  46     &GetBookFund &GetBookFunds &GetBookFundsId &GetBookFundBreakdown &GetCurrencies
  47     &NewBookFund
  48     &ModBookFund &ModCurrencies
  49     &SearchBookFund
  50     &Countbookfund
  51     &ConvertCurrency
  52     &DelBookFund
  53 );
  54
  55 =head1 FUNCTIONS
  56
  57 =cut
  58
  59 #-------------------------------------------------------------#
  60
  61 =head2 GetBookFund
  62
  63 $dataaqbookfund = &GetBookFund($bookfundid);
  64
  65 this function get the bookfundid, bookfundname, the bookfundgroup,  the branchcode
  66 from aqbookfund table for bookfundid given on input arg.
  67 return:
  68 C<$dataaqbookfund> is a hashref full of bookfundid, bookfundname, bookfundgroup,
  69 and branchcode.
  70
  71 =cut
  72
  73 sub GetBookFund {
  74     my $bookfundid = shift;
  75     my $branchcode = shift;
  76     $branchcode=($branchcode?$branchcode:'');
  77     my $dbh = C4::Context->dbh;
  78     my $query = "
  79         SELECT
  80             bookfundid,
  81             bookfundname,
  82             bookfundgroup,
  83             branchcode
  84         FROM aqbookfund
  85         WHERE bookfundid = ?
  86         AND branchcode = ?";
  87     my $sth=$dbh->prepare($query);
  88     $sth->execute($bookfundid,$branchcode);
  89     my $data=$sth->fetchrow_hashref;
  90     return $data;
  91 }
  92
  93
  94 =head3 GetBookFundsId
  95
  96 $sth = &GetBookFundsId
  97 Read on aqbookfund table and execute a simple SQL query.
  98
  99 return:
 100 $sth->execute. Don't forget to fetch row from the database after using
 101 this function by using, for example, $sth->fetchrow_hashref;
 102
 103 C<@results> is an array of id existing on the database.
 104
 105 =cut
 106
 107 sub GetBookFundsId {
 108     my @bookfundids_loop;
 109     my $dbh= C4::Context->dbh;
 110     my $query = "
 111         SELECT bookfundid,branchcode
 112         FROM aqbookfund
 113     ";
 114     my $sth = $dbh->prepare($query);
 115     $sth->execute;
 116     return $sth;
 117 }
 118
 119 #-------------------------------------------------------------#
 120
 121 =head3 GetBookFunds
 122
 123 @results = &GetBookFunds;
 124
 125 Returns a list of all book funds.
 126
 127 C<@results> is an array of references-to-hash, whose keys are fields from the aqbookfund and aqbudget tables of the Koha database. Results are ordered
 128 alphabetically by book fund name.
 129
 130 =cut
 131
 132 sub GetBookFunds {
 133     my ($branch) = @_;
 134     my $dbh      = C4::Context->dbh;
 135     my $userenv  = C4::Context->userenv;
 136     my $strsth;
 137
 138     if ( $branch ne '' ) {
 139         $strsth = "
 140         SELECT *
 141         FROM   aqbookfund
 142         LEFT JOIN aqbudget ON aqbookfund.bookfundid=aqbudget.bookfundid
 143         WHERE  startdate<now()
 144             AND enddate>now()
 145             AND (aqbookfund.branchcode='' OR aqbookfund.branchcode= ? )
 146       GROUP BY aqbookfund.bookfundid ORDER BY bookfundname";
 147     }
 148     else {
 149         $strsth = "
 150             SELECT *
 151             FROM   aqbookfund
 152             LEFT JOIN aqbudget ON aqbookfund.bookfundid=aqbudget.bookfundid
 153             WHERE startdate<now()
 154                 AND enddate>now()
 155             GROUP BY aqbookfund.bookfundid ORDER BY bookfundname
 156         ";
 157     }
 158     my $sth = $dbh->prepare($strsth);
 159     if ( $branch ne '' ) {
 160         $sth->execute($branch);
 161     }
 162     else {
 163         $sth->execute;
 164     }
 165     my @results = ();
 166     while ( my $data = $sth->fetchrow_hashref ) {
 167         push( @results, $data );
 168     }
 169     $sth->finish;
 170     return @results;
 171 }
 172
 173 #-------------------------------------------------------------#
 174
 175 =head3 GetCurrencies
 176
 177 @currencies = &GetCurrencies;
 178
 179 Returns the list of all known currencies.
 180
 181 C<$currencies> is a array; its elements are references-to-hash, whose
 182 keys are the fields from the currency table in the Koha database.
 183
 184 =cut
 185
 186 sub GetCurrencies {
 187     my $dbh = C4::Context->dbh;
 188     my $query = "
 189         SELECT *
 190         FROM   currency
 191     ";
 192     my $sth = $dbh->prepare($query);
 193     $sth->execute;
 194     my @results = ();
 195     while ( my $data = $sth->fetchrow_hashref ) {
 196         push( @results, $data );
 197     }
 198     $sth->finish;
 199     return @results;
 200 }
 201
 202 #-------------------------------------------------------------#
 203
 204 =head3 GetBookFundBreakdown
 205
 206 ( $spent, $comtd ) = &GetBookFundBreakdown( $id, $start, $end );
 207
 208 returns the total comtd & spent for a given bookfund, and a given year
 209 used in acqui-home.pl
 210
 211 =cut
 212
 213 sub GetBookFundBreakdown {
 214     my ( $id, $start, $end ) = @_;
 215     my $dbh = C4::Context->dbh;
 216
 217     # if no start/end dates given defaut to everything
 218     if ( !$start ) {
 219         $start = '0000-00-00';
 220         $end   = 'now()';
 221     }
 222
 223     # do a query for spent totals.
 224     my $query = "
 225         SELECT quantity,datereceived,freight,unitprice,listprice,ecost,
 226                quantityreceived,subscription
 227         FROM   aqorders
 228         LEFT JOIN aqorderbreakdown ON aqorders.ordernumber=aqorderbreakdown.ordernumber
 229         LEFT JOIN aqbookfund ON (aqorderbreakdown.bookfundid=aqbookfund.bookfundid and aqorderbreakdown.branchcode=aqbookfund.branchcode)
 230         LEFT JOIN aqbudget ON (aqbudget.bookfundid=aqbookfund.bookfundid and aqbudget.branchcode=aqbookfund.branchcode)
 231         WHERE  aqorderbreakdown.bookfundid=?
 232             AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
 233             AND ((budgetdate >= ? and budgetdate < ?) OR (startdate>=? and enddate<=?))
 234     ";
 235     my $sth = $dbh->prepare($query);
 236     $sth->execute( $id, $start, $end, $start, $end );
 237
 238     my ($spent) = 0;
 239     while ( my $data = $sth->fetchrow_hashref ) {
 240         if ( $data->{'subscription'} == 1 ) {
 241             $spent += $data->{'quantity'} * $data->{'unitprice'};
 242         }
 243         else {
 244             $spent += ( $data->{'unitprice'} ) * ($data->{'quantityreceived'}?$data->{'quantityreceived'}:0);
 245
 246         }
 247     }
 248
 249     # then do a seperate query for commited totals, (pervious single query was
 250     # returning incorrect comitted results.
 251
 252     $query = "
 253         SELECT  quantity,datereceived,freight,unitprice,
 254                 listprice,ecost,quantityreceived AS qrev,
 255                 subscription,title,itemtype,aqorders.biblionumber,
 256                 aqorders.booksellerinvoicenumber,
 257                 quantity-quantityreceived AS tleft,
 258                 aqorders.ordernumber AS ordnum,entrydate,budgetdate
 259         FROM    aqorders
 260         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber=aqorders.biblioitemnumber
 261         LEFT JOIN aqorderbreakdown ON aqorders.ordernumber=aqorderbreakdown.ordernumber
 262         WHERE   bookfundid=?
 263             AND (budgetdate >= ? AND budgetdate < ?)
 264             AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
 265     ";
 266
 267     $sth = $dbh->prepare($query);
 268 #      warn "$start $end";
 269     $sth->execute( $id, $start, $end );
 270
 271     my $comtd=0;
 272
 273     while ( my $data = $sth->fetchrow_hashref ) {
 274         my $left = $data->{'tleft'};
 275         if ( (!$left && (!$data->{'datereceived'}||$data->{'datereceived'} eq '0000-00-00') ) || $left eq '' ) {
 276             $left = $data->{'quantity'};
 277         }
 278         if ( $left && $left > 0 ) {
 279             my $subtotal = $left * $data->{'ecost'};
 280             $data->{subtotal} = $subtotal;
 281             $data->{'left'} = $left;
 282             $comtd += $subtotal;
 283         }
 284 #         use Data::Dumper; warn Dumper($data);
 285     }
 286
 287     $sth->finish;
 288     return ( $spent, $comtd );
 289 }
 290
 291 =head3 NewBookFund
 292
 293 &NewBookFund(bookfundid, bookfundname, branchcode);
 294
 295 this function create a new bookfund into the database.
 296
 297 =cut
 298
 299 sub NewBookFund{
 300     my ($bookfundid, $bookfundname, $branchcode) = @_;
 301     $branchcode = undef unless $branchcode;
 302     my $dbh = C4::Context->dbh;
 303     my $query = "
 304         INSERT
 305         INTO aqbookfund
 306             (bookfundid, bookfundname, branchcode)
 307         VALUES
 308             (?, ?, ?)
 309     ";
 310     my $sth=$dbh->prepare($query);
 311     $sth->execute($bookfundid,$bookfundname,"$branchcode");
 312 }
 313
 314 #-------------------------------------------------------------#
 315
 316 =head3 ModBookFund
 317
 318 &ModBookFund($bookfundname,$bookfundid,$current_branch, $branchcode) =
 319 this function update the bookfundname and the branchcode on aqbookfund table on database.
 320
 321 =cut
 322
 323
 324 sub ModBookFund {
 325     my ($bookfundname,$bookfundid,$current_branch, $branchcode) = @_;
 326
 327     my $dbh = C4::Context->dbh;
 328
 329     my $retval = $dbh->do("
 330      UPDATE aqbookfund
 331         SET    bookfundname = '$bookfundname',
 332                branchcode = '$branchcode'
 333         WHERE  bookfundid = '$bookfundid'
 334         AND branchcode = '$current_branch'
 335     ");
 336
 337     ### $retval
 338
 339     # budgets depending on a bookfund must have the same branchcode
 340
 341     # if the bookfund branchcode is set, and previous update is successfull, then update aqbudget.branchcode too.
 342     if (defined $branchcode && $retval > 0) {
 343         my $query = "UPDATE  aqbudget
 344             SET     branchcode = ?
 345             WHERE   bookfundid = ? ";
 346
 347         my $sth=$dbh->prepare($query);
 348         $sth->execute($branchcode, $bookfundid) ;
 349     }
 350 }
 351
 352
 353
 354 #-------------------------------------------------------------#
 355
 356 =head3 SearchBookFund
 357
 358 @results = SearchBookFund(
 359         $bookfundid,$filter,$filter_bookfundid,
 360         $filter_bookfundname,$filter_branchcode);
 361
 362 this function searchs among the bookfunds corresponding to our filtering rules.
 363
 364 =cut
 365
 366 sub SearchBookFund {
 367     my $dbh = C4::Context->dbh;
 368     my ($filter,
 369         $filter_bookfundid,
 370         $filter_bookfundname,
 371         $filter_branchcode
 372        ) = @_;
 373
 374     my @bindings;
 375
 376     my $query = "
 377         SELECT  bookfundid,
 378                 bookfundname,
 379                 bookfundgroup,
 380                 branchcode
 381         FROM aqbookfund
 382         WHERE 1 ";
 383
 384     if ($filter) {
 385         if ($filter_bookfundid) {
 386             $query.= "AND bookfundid = ?";
 387             push @bindings, $filter_bookfundid;
 388         }
 389         if ($filter_bookfundname) {
 390             $query.= "AND bookfundname like ?";
 391             push @bindings, '%'.$filter_bookfundname.'%';
 392         }
 393         if ($filter_branchcode) {
 394             $query.= "AND branchcode = ?";
 395             push @bindings, $filter_branchcode;
 396         }
 397     }
 398     $query.= "ORDER BY bookfundid";
 399
 400     my $sth = $dbh->prepare($query);
 401     $sth->execute(@bindings);
 402     my @results;
 403     while (my $row = $sth->fetchrow_hashref) {
 404         push @results, $row;
 405     }
 406     return @results;
 407 }
 408
 409 #-------------------------------------------------------------#
 410
 411 =head3 ModCurrencies
 412
 413 &ModCurrencies($currency, $newrate);
 414
 415 Sets the exchange rate for C<$currency> to be C<$newrate>.
 416
 417 =cut
 418
 419 sub ModCurrencies {
 420     my ( $currency, $rate ) = @_;
 421     my $dbh = C4::Context->dbh;
 422     my $query = "
 423         UPDATE currency
 424         SET    rate=?
 425         WHERE  currency=?
 426     ";
 427     my $sth = $dbh->prepare($query);
 428     $sth->execute( $rate, $currency );
 429 }
 430
 431 #-------------------------------------------------------------#
 432
 433 =head3 Countbookfund
 434
 435 $number = Countbookfund($bookfundid);
 436
 437 this function count the number of bookfund with id given on input arg.
 438 return :
 439 the result of the SQL query as a number.
 440
 441 =cut
 442
 443 sub Countbookfund {
 444     my $bookfundid = shift;
 445     my $branchcode = shift;
 446     my $dbh = C4::Context->dbh;
 447     my $query ="
 448         SELECT COUNT(*)
 449         FROM  aqbookfund
 450         WHERE bookfundid = ?
 451         AND   branchcode = ?
 452     ";
 453     my $sth = $dbh->prepare($query);
 454     $sth->execute($bookfundid,"$branchcode");
 455     return $sth->fetchrow;
 456 }
 457
 458
 459 #-------------------------------------------------------------#
 460
 461 =head3 ConvertCurrency
 462
 463 $foreignprice = &ConvertCurrency($currency, $localprice);
 464
 465 Converts the price C<$localprice> to foreign currency C<$currency> by
 466 dividing by the exchange rate, and returns the result.
 467
 468 If no exchange rate is found, C<&ConvertCurrency> assumes the rate is one
 469 to one.
 470
 471 =cut
 472
 473 sub ConvertCurrency {
 474     my ( $currency, $price ) = @_;
 475     my $dbh = C4::Context->dbh;
 476     my $query = "
 477         SELECT rate
 478         FROM   currency
 479         WHERE  currency=?
 480     ";
 481     my $sth = $dbh->prepare($query);
 482     $sth->execute($currency);
 483     my $cur = ( $sth->fetchrow_array() )[0];
 484     unless($cur) {
 485         $cur = 1;
 486     }
 487     return ( $price / $cur );
 488 }
 489
 490 #-------------------------------------------------------------#
 491
 492 =head3 DelBookFund
 493
 494 &DelBookFund($bookfundid);
 495 this function delete a bookfund which has $bokfundid as parameter on aqbookfund table and delete the approriate budget.
 496
 497 =cut
 498
 499 sub DelBookFund {
 500     my $bookfundid = shift;
 501     my $branchcode=shift;
 502     my $dbh = C4::Context->dbh;
 503     my $query = "
 504         DELETE FROM aqbookfund
 505         WHERE bookfundid=?
 506         AND branchcode=?
 507     ";
 508     my $sth=$dbh->prepare($query);
 509     $sth->execute($bookfundid,$branchcode);
 510     $sth->finish;
 511     $query = "
 512         DELETE FROM aqbudget where bookfundid=? and branchcode=?
 513     ";
 514     $sth=$dbh->prepare($query);
 515     $sth->execute($bookfundid,$branchcode);
 516     $sth->finish;
 517 }
 518
 519 END { }    # module clean-up code here (global destructor)
 520
 521 1;
 522
 523 __END__
 524
 525 =head1 AUTHOR
 526
 527 Koha Developement team <info@koha.org>
 528
 529 =cut