X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FStats.pm;h=8a8835c3462e38bfea5f89d8134446617bbbbe7b;hb=4cd4ae7a3d6cc2a1fce7a2ae900bcc9a5ff2124b;hp=e4573fb8b2d4b2370989235d59ebc64200177246;hpb=43ad7fb4dfc1d7f57bac158049e51d4006ef7140;p=koha.git diff --git a/C4/Stats.pm b/C4/Stats.pm index e4573fb8b2..8a8835c346 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,68 +46,106 @@ 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); +=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 + 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{branchcode}>. - -C<$env-E{usercode}> specifies the value of the C field. +Returns undef if no C<$param> is given =cut -#' sub UpdateStats { + 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 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"); + } + 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} : 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 $ccode = exists $params->{ccode} ? $params->{ccode} : ''; - #module to insert stats data into stats table - my ( - $branch, $type, - $amount, $other, $itemnum, - $itemtype, $borrowernumber - ) - = @_; my $dbh = C4::Context->dbh; - # FIXME - Use $dbh->do() instead my $sth = $dbh->prepare( - "Insert into statistics (datetime,branch,type,value, - other,itemnumber,itemtype,borrowernumber) values (now(),?,?,?,?,?,?,?,?)" + "INSERT INTO statistics + (datetime, + branch, type, value, + other, itemnumber, itemtype, location, + borrowernumber, ccode) + VALUES (now(),?,?,?,?,?,?,?,?,?)" ); $sth->execute( - $branch, $type, $amount, - $other, $itemnum, $itemtype, $borrowernumber, + $branch, $type, $amount, $other, + $itemnumber, $itemtype, $location, $borrowernumber, + $ccode ); - $sth->finish; } 1; __END__ -=back - =head1 AUTHOR -Koha Developement team +Koha Development Team =cut