X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FStats.pm;h=04378184b35a0ffb93d3f5051e4894a1912301bc;hb=deb968ea45276e56826b592026617a96398b61da;hp=7190d204220dafe5cf290d0a7014cf5041e5ac10;hpb=2ffd5b7228f4e638583162d483e1dd2febeafe1b;p=koha.git diff --git a/C4/Stats.pm b/C4/Stats.pm index 7190d20422..04378184b3 100644 --- a/C4/Stats.pm +++ b/C4/Stats.pm @@ -1,34 +1,40 @@ package C4::Stats; -# $Id$ # Copyright 2000-2002 Katipo Communications # # This file is part of Koha. # -# Koha is free software; you can redistribute it and/or modify it under the -# terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. +# Koha is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. # -# Koha is distributed in the hope that it will be useful, but WITHOUT ANY -# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR -# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# Koha is distributed in the hope that it will be useful, but +# WITHOUT ANY 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, see . use strict; +use warnings; require Exporter; -use DBI; +use Carp; use C4::Context; -use vars qw($VERSION @ISA @EXPORT); +use C4::Debug; +use vars qw(@ISA @EXPORT); + +our $debug; + +BEGIN { + @ISA = qw(Exporter); + @EXPORT = qw( + &UpdateStats + ); +} -# set the version for version checking -$VERSION = $VERSION = do { my @v = '$Revision$' =~ /\d+/g; - shift(@v) . "." . join( "_", map { sprintf "%03d", $_ } @v ); -}; =head1 NAME @@ -40,258 +46,108 @@ C4::Stats - Update Koha statistics (log) =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 - getrefunds); - -=item UpdateStats +=head2 UpdateStats - &UpdateStats($env, $branch, $type, $value, $other, $itemnumber, - $itemtype, $borrowernumber); + &UpdateStats($params); -Adds a line to the statistics table of the Koha database. In effect, -it logs an event. +Adds an entry to the statistics table in the Koha database, which acts as an activity log. -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. +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 -If C<$branch> is the empty string, the branch code will be taken from -C<$env-E{branchcode}>. +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. -C<$env-E{usercode}> specifies the value of the C 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 ($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 location); + my @allowed_circulation_types = qw (renew issue localuse return onsite_checkout); + 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"); } - my $user = $env->{'usercode'}; - my $organisation = $env->{'organisation'}; - - # FIXME - Use $dbh->do() instead - my $sth = $dbh->prepare( - "Insert into statistics (datetime,branch,type,usercode,value, - other,itemnumber,itemtype,borrowernumber,proccode,associatedborrower) values (now(),?,?,?,?,?,?,?,?,?,?)" - ); - $sth->execute( - $branch, $type, $user, $amount, - $other, $itemnum, $itemtype, $borrowernumber, - $accountno, $organisation - ); - $sth->finish; -} - -# Otherwise, it'd need a POD. -sub TotalPaid { - my ( $time, $time2, $spreadsheet ) = @_; - $time2 = $time unless $time2; - my $dbh = C4::Context->dbh; - 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()"; + 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}); } - else { - $query .= " AND datetime > '$time'"; + my @missing_params = (); + for my $mykey (@mandatory_keys ) { + push @missing_params, $mykey if !grep (/^$mykey/, keys %$params); } - if ( $time2 ne '' ) { - $query .= " AND datetime < '$time2'"; + if (scalar @missing_params > 0 ) { + croak ("UpdateStats did not received mandatory param(s): ".join (", ",@missing_params )); } - if ($spreadsheet) { - $query .= " ORDER BY branch, type"; + my @invalid_params = (); + for my $myparam (keys %$params ) { + push @invalid_params, $myparam unless grep (/^$myparam$/, @allowed_keys); } - my $sth = $dbh->prepare($query); - $sth->execute(); - my @results; - while ( my $data = $sth->fetchrow_hashref ) { - push @results, $data; - } - $sth->finish; - return (@results); -} - -# 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 + if (scalar @invalid_params > 0 ) { + croak ("UpdateStats received invalid param(s): ".join (", ",@invalid_params )); } - else { - $sth = $dbh->prepare( - "Select * from accountlines where borrowernumber=? - and timestamp = ? and accounttype <> 'Pay' and - accounttype <> 'W'" - ); - $sth->execute( $borrowerno, $timestamp ); - } - - # print $query,"
"; - my $i = 0; - my @results; - while ( my $data = $sth->fetchrow_hashref ) { - - # if ($data->{'timestamp'} == $timestamp){ - $results[$i] = $data; - $i++; - - # } - } - return (@results); -} +# 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} : undef; + my $amount = exists $params->{amount} ? $params->{amount} : 0; + my $other = exists $params->{other} ? $params->{other} : ''; + my $itemtype = exists $params->{itemtype} ? $params->{itemtype} : ''; + my $location = exists $params->{location} ? $params->{location} : undef; + my $accountno = exists $params->{accountno} ? $params->{accountno} : ''; + my $ccode = exists $params->{ccode} ? $params->{ccode} : ''; -# 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 execute( $timestamp, $timestamp2 ); - - my $i = 0; - my @results; - while ( my $data = $sth->fetchrow_hashref ) { - $results[$i] = $data; - $i++; - } - return (@results); -} - -sub getrefunds { - 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 = 'REF' - and accountlines.borrowernumber = borrowers.borrowernumber - and timestamp >=? and timestamp execute( $timestamp, $timestamp2 ); - - my @results; - while ( my $data = $sth->fetchrow_hashref ) { - push @results, $data; - } - return (@results); -} - -# 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'} ); -} - -# 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" + "INSERT INTO statistics + (datetime, + branch, type, value, + other, itemnumber, itemtype, location, + borrowernumber, proccode, ccode) + VALUES (now(),?,?,?,?,?,?,?,?,?,?)" ); - $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( + $branch, $type, $amount, $other, + $itemnumber, $itemtype, $location, $borrowernumber, + $accountno, $ccode ); - $sth->execute; - while ( my $data = $sth->fetchrow_hashref ) { - $results[$i] = $data; - $i++; - } - $sth->finish; - return ( $i, \@results ); } 1; __END__ -=back - =head1 AUTHOR -Koha Developement team +Koha Development Team =cut