package C4::Stats;
-# $Id$
# Copyright 2000-2002 Katipo Communications
#
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;
+use warnings;
require Exporter;
-use DBI;
+use Carp;
use C4::Context;
+use C4::Debug;
use vars qw($VERSION @ISA @EXPORT);
-# set the version for version checking
-$VERSION = 0.01;
+our $debug;
+
+BEGIN {
+ # set the version for version checking
+ $VERSION = 3.07.00.049;
+ @ISA = qw(Exporter);
+ @EXPORT = qw(
+ &UpdateStats
+ &TotalPaid
+ );
+}
+
=head1 NAME
=head1 DESCRIPTION
-The C<&UpdateStats> function adds an entry to the statistics table in
-the Koha database, which acts as an activity log.
+The functions of this module deals with statistics table of Koha database.
=head1 FUNCTIONS
-=over 2
-
-=cut
-
-@ISA = qw(Exporter);
-@EXPORT = qw(&UpdateStats &statsreport &TotalOwing
-&TotalPaid &getcharges &Getpaidbranch &unfilledreserves &getcredits);
+=head2 UpdateStats
-=item UpdateStats
+ &UpdateStats($params);
- &UpdateStats($env, $branch, $type, $value, $other, $itemnumber,
- $itemtype, $borrowernumber);
+Adds an entry to the statistics table in the Koha database, which acts as an activity log.
-Adds a line to the statistics table of the Koha database. In effect,
-it logs an event.
+C<$params> is an hashref whose expected keys are:
+ branch : the branch where the transaction occurred
+ type : the type of transaction (renew, issue, localuse, return, writeoff, payment
+ itemnumber : the itemnumber of the item
+ borrowernumber : the borrowernumber of the patron
+ amount : the amount of the transaction
+ other : sipmode
+ itemtype : the type of the item
+ accountno : the count
+ ccode : the collection code of the item
-C<$branch>, C<$type>, C<$value>, C<$other>, C<$itemnumber>,
-C<$itemtype>, and C<$borrowernumber> correspond to the fields of the
-statistics table in the Koha database.
+type key is mandatory.
+For types used in C4::Circulation (renew,issue,localuse,return), the following other keys are mandatory:
+branch, borrowernumber, itemnumber, ccode, itemtype
+For types used in C4::Accounts (writeoff, payment), the following other keys are mandatory:
+branch, borrowernumber, itemnumber, ccode, itemtype
+If an optional key is not provided, the value '' is used for this key.
-If C<$branch> is the empty string, the branch code will be taken from
-C<$env-E<gt>{branchcode}>.
-
-C<$env-E<gt>{usercode}> specifies the value of the C<usercode> field.
+Returns undef if no C<$param> is given
=cut
-#'
+
sub UpdateStats {
- #module to insert stats data into stats table
- my ($env,$branch,$type,$amount,$other,$itemnum,$itemtype,$borrowernumber,$accountno)=@_;
- my $dbh = C4::Context->dbh;
- if ($branch eq ''){
- $branch=$env->{'branchcode'};
- }
- my $user = $env->{'usercode'};
- print $borrowernumber;
- # FIXME - Use $dbh->do() instead
- my $sth=$dbh->prepare("Insert into statistics (datetime,branch,type,usercode,value,
- other,itemnumber,itemtype,borrowernumber,proccode) values (now(),?,?,?,?,?,?,?,?,?)");
- $sth->execute($branch,$type,$user,$amount,$other,$itemnum,$itemtype,$borrowernumber,$accountno);
- $sth->finish;
+ my ($params) = @_;
+# make some controls
+ return () if ! defined $params;
+# change these arrays if new types of transaction or new parameters are allowed
+ my @allowed_keys = qw (type branch amount other itemnumber itemtype borrowernumber accountno ccode);
+ my @allowed_circulation_types = qw (renew issue localuse return);
+ my @allowed_accounts_types = qw (writeoff payment);
+ my @circulation_mandatory_keys = qw (type branch borrowernumber itemnumber ccode itemtype);
+ my @accounts_mandatory_keys = qw (type branch borrowernumber amount);
+
+ my @mandatory_keys = ();
+ if (! exists $params->{type} or ! defined $params->{type}) {
+ croak ("UpdateStats did not received type param");
+ }
+ if (grep ($_ eq $params->{type}, @allowed_circulation_types )) {
+ @mandatory_keys = @circulation_mandatory_keys;
+ } elsif (grep ($_ eq $params->{type}, @allowed_accounts_types )) {
+ @mandatory_keys = @accounts_mandatory_keys;
+ } else {
+ croak ("UpdateStats received forbidden type param: ".$params->{type});
+ }
+ my @missing_params = ();
+ for my $mykey (@mandatory_keys ) {
+ push @missing_params, $mykey if !grep (/^$mykey/, keys %$params);
+ }
+ if (scalar @missing_params > 0 ) {
+ croak ("UpdateStats did not received mandatory param(s): ".join (", ",@missing_params ));
+ }
+ my @invalid_params = ();
+ for my $myparam (keys %$params ) {
+ push @invalid_params, $myparam unless grep (/^$myparam$/, @allowed_keys);
+ }
+ if (scalar @invalid_params > 0 ) {
+ croak ("UpdateStats received invalid param(s): ".join (", ",@invalid_params ));
+ }
+# get the parameters
+ my $branch = $params->{branch};
+ my $type = $params->{type};
+ my $borrowernumber = exists $params->{borrowernumber} ? $params->{borrowernumber} :'';
+ my $itemnumber = exists $params->{itemnumber} ? $params->{itemnumber} :'';
+ my $amount = exists $params->{amount} ? $params->{amount} :'';
+ my $other = exists $params->{other} ? $params->{other} :'';
+ my $itemtype = exists $params->{itemtype} ? $params->{itemtype} :'';
+ my $accountno = exists $params->{accountno} ? $params->{accountno} :'';
+ my $ccode = exists $params->{ccode} ? $params->{ccode} :'';
+
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare(
+ "INSERT INTO statistics
+ (datetime,
+ branch, type, value,
+ other, itemnumber, itemtype,
+ borrowernumber, proccode, ccode)
+ VALUES (now(),?,?,?,?,?,?,?,?,?)"
+ );
+ $sth->execute(
+ $branch, $type, $amount,
+ $other, $itemnumber, $itemtype,
+ $borrowernumber, $accountno, $ccode
+ );
}
-# Otherwise, it'd need a POD.
-sub TotalPaid {
- my ($time,$time2)=@_;
- $time2=$time unless $time2;
- my $dbh = C4::Context->dbh;
-
-
- #my $query="Select * from accountlines,borrowers where (accounttype = 'Pay' or accounttype ='W')
- # and accountlines.borrowernumber = borrowers.borrowernumber";
- #my @bind = ();
- #if ($time eq 'today'){
- # $query .= " and date = now()";
- #} else {
- # $query.=" and date>=? and date<=?";
- # @bind = ($time,$time2);
- #}
-
- my $query="Select * from statistics,borrowers
- where statistics.borrowernumber= borrowers.borrowernumber
- and (statistics.type='payment' or statistics.type='writeoff') ";
- if ($time eq 'today'){
- $query=$query." and datetime = now()";
- } else {
- $query.=" and datetime > '$time'";
- }
-
-
- # $query.=" order by timestamp";
-
- # print $query;
-
- my $sth=$dbh->prepare($query);
-
- $sth->execute();
- # $sth->execute(@bind);
- my @results;
- my $i=0;
- while (my $data=$sth->fetchrow_hashref){
- $results[$i]=$data;
- $i++;
- }
- $sth->finish;
- # print $query;
- return(@results);
-}
+=head2 TotalPaid
-# Otherwise, it needs a POD.
-sub getcharges{
- my($borrowerno,$timestamp,$accountno)=@_;
- my $dbh = C4::Context->dbh;
- my $timestamp2=$timestamp-1;
- my $query="";
- my $sth;
-
- # getcharges is now taking accountno. as an argument
- if ($accountno){
- $sth=$dbh->prepare("Select * from accountlines where borrowernumber=?
- and accountno = ?");
- $sth->execute($borrowerno,$accountno);
-
- # this bit left in for old 2 arg usage of getcharges
- } else {
- $sth=$dbh->prepare("Select * from accountlines where borrowernumber=?
- and timestamp = ? and accounttype <> 'Pay' and
- accounttype <> 'W'");
- $sth->execute($borrowerno,$timestamp);
- }
-
- # print $query,"<br>";
- my $i=0;
- my @results;
- while (my $data=$sth->fetchrow_hashref){
- # if ($data->{'timestamp'} == $timestamp){
- $results[$i]=$data;
- $i++;
- # }
- }
- return(@results);
-}
+ @total = &TotalPaid ( $time, [$time2], [$spreadsheet ]);
-# Otherwise, it needs a POD.
-sub getcredits{
- my ($date,$date2)=@_;
- my $dbh = C4::Context->dbh;
-
- #takes date converts to timestamps
- my $padding="000000";
- (my $a, my $b, my $c) = unpack("A4 x1 A2 x1 A2", $date);
- (my $x, my $y, my $z) = unpack("A4 x1 A2 x1 A2", $date2);
- my $timestamp = $a.$b.$c.$padding;
- my $timestamp2 = $x.$y.$z.$padding;
-
- my $sth=$dbh->prepare("Select * from accountlines,borrowers where (((accounttype = 'LR') or (accounttype <> 'Pay'))
- and amount < 0 and accountlines.borrowernumber = borrowers.borrowernumber
- and timestamp >=? and timestamp <?)");
- $sth->execute($timestamp, $timestamp2);
-
- my $i=0;
- my @results;
- while (my $data=$sth->fetchrow_hashref){
- $results[$i]=$data;
- $i++;
- }
- return(@results);
-}
+Returns an array containing the payments and writeoffs made between two dates
+C<$time> and C<$time2>, or on a specific one, or from C<$time> onwards.
+C<$time> param is mandatory.
+If C<$time> eq 'today', returns are limited to the current day
+If C<$time2> eq '', results are returned from C<$time> onwards.
+If C<$time2> is undef, returns are limited to C<$time>
+C<$spreadsheet> param is optional and controls the sorting of the results.
+Returns undef if no param is given
-# Otherwise, this needs a POD.
-sub Getpaidbranch{
- my($date,$borrno)=@_;
- my $dbh = C4::Context->dbh;
- my $sth=$dbh->prepare("select * from statistics where type='payment' and datetime >? and borrowernumber=?");
- $sth->execute($date,$borrno);
- # print $query;
- my $data=$sth->fetchrow_hashref;
- $sth->finish;
- return($data->{'branch'});
-}
+=cut
-# FIXME - This is only used in reservereport.pl and reservereport.xls,
-# neither of which is used.
-# Otherwise, it needs a POD.
-sub unfilledreserves {
- my $dbh = C4::Context->dbh;
- my $sth=$dbh->prepare("select *,biblio.title from reserves,reserveconstraints,biblio,borrowers,biblioitems where (found <> 'F' or
- found is NULL) and cancellationdate
- is NULL and biblio.biblionumber=reserves.biblionumber and
- reserves.constrainttype='o'
- and (reserves.biblionumber=reserveconstraints.biblionumber
- and reserves.borrowernumber=reserveconstraints.borrowernumber)
- and
- reserves.borrowernumber=borrowers.borrowernumber and
- biblioitems.biblioitemnumber=reserveconstraints.biblioitemnumber order by
- biblio.title,reserves.reservedate");
- $sth->execute;
- my $i=0;
- my @results;
- while (my $data=$sth->fetchrow_hashref){
- $results[$i]=$data;
- $i++;
- }
- $sth->finish;
- $sth=$dbh->prepare("select *,biblio.title from reserves,biblio,borrowers where (found <> 'F' or found is NULL) and cancellationdate
- is NULL and biblio.biblionumber=reserves.biblionumber and reserves.constrainttype='a' and
- reserves.borrowernumber=borrowers.borrowernumber
- order by
- biblio.title,reserves.reservedate");
- $sth->execute;
- while (my $data=$sth->fetchrow_hashref){
- $results[$i]=$data;
- $i++;
- }
- $sth->finish;
- return($i,\@results);
+sub TotalPaid {
+ my ( $time, $time2, $spreadsheet ) = @_;
+ return () unless (defined $time);
+ $time2 = $time unless $time2;
+ my $dbh = C4::Context->dbh;
+ my $query = "SELECT * FROM statistics
+ LEFT JOIN borrowers ON statistics.borrowernumber= borrowers.borrowernumber
+ WHERE (statistics.type='payment' OR statistics.type='writeoff') ";
+ if ( $time eq 'today' ) {
+# FIXME wrong condition. Now() will not get all the payments of the day but of a specific timestamp
+ $query .= " AND datetime = now()";
+ } else {
+ $query .= " AND datetime > '$time'"; # FIXME: use placeholders
+ }
+ if ( $time2 ne '' ) {
+ $query .= " AND datetime < '$time2'"; # FIXME: use placeholders
+ }
+# FIXME if $time2 is undef, query will be "AND datetime > $time AND AND datetime < $time"
+# Operators should probably be <= and >=
+ if ($spreadsheet) {
+ $query .= " ORDER BY branch, type";
+ }
+ $debug and warn "TotalPaid query: $query";
+ my $sth = $dbh->prepare($query);
+ $sth->execute();
+ return @{$sth->fetchall_arrayref({})};
}
1;
__END__
-=back
-
=head1 AUTHOR
-Koha Developement team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
=cut
projects / koha.git / blobdiff