C4/Stats.pm

   1 package C4::Stats;
   2
   3
   4 # Copyright 2000-2002 Katipo Communications
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 use strict;
  22 use warnings;
  23 require Exporter;
  24 use Carp;
  25 use C4::Context;
  26 use C4::Debug;
  27 use vars qw(@ISA @EXPORT);
  28
  29 our $debug;
  30
  31 BEGIN {
  32         @ISA    = qw(Exporter);
  33         @EXPORT = qw(
  34                 &UpdateStats
  35                 &TotalPaid
  36         );
  37 }
  38
  39
  40 =head1 NAME
  41
  42 C4::Stats - Update Koha statistics (log)
  43
  44 =head1 SYNOPSIS
  45
  46   use C4::Stats;
  47
  48 =head1 DESCRIPTION
  49
  50 The functions of this module deals with statistics table of Koha database.
  51
  52 =head1 FUNCTIONS
  53
  54 =head2 UpdateStats
  55
  56   &UpdateStats($params);
  57
  58 Adds an entry to the statistics table in the Koha database, which acts as an activity log.
  59
  60 C<$params> is an hashref whose expected keys are:
  61     branch             : the branch where the transaction occurred
  62     type               : the type of transaction (renew, issue, localuse, return, writeoff, payment
  63     itemnumber         : the itemnumber of the item
  64     borrowernumber     : the borrowernumber of the patron
  65     amount             : the amount of the transaction
  66     other              : sipmode
  67     itemtype           : the type of the item
  68     accountno          : the count
  69     ccode              : the collection code of the item
  70
  71 type key is mandatory.
  72 For types used in C4::Circulation (renew,issue,localuse,return), the following other keys are mandatory:
  73 branch, borrowernumber, itemnumber, ccode, itemtype
  74 For types used in C4::Accounts (writeoff, payment), the following other keys are mandatory:
  75 branch, borrowernumber, itemnumber, ccode, itemtype
  76 If an optional key is not provided, the value '' is used for this key.
  77
  78 Returns undef if no C<$param> is given
  79
  80 =cut
  81
  82 sub UpdateStats {
  83     my ($params) = @_;
  84 # make some controls
  85     return () if ! defined $params;
  86 # change these arrays if new types of transaction or new parameters are allowed
  87     my @allowed_keys = qw (type branch amount other itemnumber itemtype borrowernumber accountno ccode);
  88     my @allowed_circulation_types = qw (renew issue localuse return onsite_checkout);
  89     my @allowed_accounts_types = qw (writeoff payment);
  90     my @circulation_mandatory_keys = qw (type branch borrowernumber itemnumber ccode itemtype);
  91     my @accounts_mandatory_keys = qw (type branch borrowernumber amount);
  92
  93     my @mandatory_keys = ();
  94     if (! exists $params->{type} or ! defined $params->{type}) {
  95         croak ("UpdateStats did not received type param");
  96     }
  97     if (grep ($_ eq $params->{type}, @allowed_circulation_types  )) {
  98         @mandatory_keys = @circulation_mandatory_keys;
  99     } elsif (grep ($_ eq $params->{type}, @allowed_accounts_types )) {
 100         @mandatory_keys = @accounts_mandatory_keys;
 101     } else {
 102         croak ("UpdateStats received forbidden type param: ".$params->{type});
 103     }
 104     my @missing_params = ();
 105     for my $mykey (@mandatory_keys ) {
 106         push @missing_params, $mykey if !grep (/^$mykey/, keys %$params);
 107     }
 108     if (scalar @missing_params > 0 ) {
 109         croak ("UpdateStats did not received mandatory param(s): ".join (", ",@missing_params ));
 110     }
 111     my @invalid_params = ();
 112     for my $myparam (keys %$params ) {
 113         push @invalid_params, $myparam unless grep (/^$myparam$/, @allowed_keys);
 114     }
 115     if (scalar @invalid_params > 0 ) {
 116         croak ("UpdateStats received invalid param(s): ".join (", ",@invalid_params ));
 117     }
 118 # get the parameters
 119     my $branch            = $params->{branch};
 120     my $type              = $params->{type};
 121     my $borrowernumber    = exists $params->{borrowernumber} ? $params->{borrowernumber} :'';
 122     my $itemnumber        = exists $params->{itemnumber}     ? $params->{itemnumber} :'';
 123     my $amount            = exists $params->{amount}         ? $params->{amount} :'';
 124     my $other             = exists $params->{other}          ? $params->{other} :'';
 125     my $itemtype          = exists $params->{itemtype}       ? $params->{itemtype} :'';
 126     my $accountno         = exists $params->{accountno}      ? $params->{accountno} :'';
 127     my $ccode             = exists $params->{ccode}          ? $params->{ccode} :'';
 128
 129     my $dbh = C4::Context->dbh;
 130     my $sth = $dbh->prepare(
 131         "INSERT INTO statistics
 132         (datetime,
 133          branch,          type,        value,
 134          other,           itemnumber,  itemtype,
 135          borrowernumber,  proccode,    ccode)
 136          VALUES (now(),?,?,?,?,?,?,?,?,?)"
 137     );
 138     $sth->execute(
 139         $branch,         $type,        $amount,
 140         $other,          $itemnumber,  $itemtype,
 141         $borrowernumber, $accountno,   $ccode
 142     );
 143 }
 144
 145 =head2 TotalPaid
 146
 147   @total = &TotalPaid ( $time, [$time2], [$spreadsheet ]);
 148
 149 Returns an array containing the payments and writeoffs made between two dates
 150 C<$time> and C<$time2>, or on a specific one, or from C<$time> onwards.
 151
 152 C<$time> param is mandatory.
 153 If C<$time> eq 'today', returns are limited to the current day
 154 If C<$time2> eq '', results are returned from C<$time> onwards.
 155 If C<$time2> is undef, returns are limited to C<$time>
 156 C<$spreadsheet> param is optional and controls the sorting of the results.
 157
 158 Returns undef if no param is given
 159
 160 =cut
 161
 162 sub TotalPaid {
 163     my ( $time, $time2, $spreadsheet ) = @_;
 164     return () unless (defined $time);
 165     $time2 = $time unless $time2;
 166     my $dbh   = C4::Context->dbh;
 167     my $query = "SELECT * FROM statistics
 168   LEFT JOIN borrowers ON statistics.borrowernumber= borrowers.borrowernumber
 169   WHERE (statistics.type='payment' OR statistics.type='writeoff') ";
 170     if ( $time eq 'today' ) {
 171 # FIXME wrong condition. Now() will not get all the payments of the day but of a specific timestamp
 172         $query .= " AND datetime = now()";
 173     } else {
 174         $query .= " AND datetime > '$time'";    # FIXME: use placeholders
 175     }
 176     if ( $time2 ne '' ) {
 177         $query .= " AND datetime < '$time2'";   # FIXME: use placeholders
 178     }
 179 # FIXME if $time2 is undef, query will be "AND datetime > $time AND AND datetime < $time"
 180 # Operators should probably be <= and >=
 181     if ($spreadsheet) {
 182         $query .= " ORDER BY branch, type";
 183     }
 184     $debug and warn "TotalPaid query: $query";
 185     my $sth = $dbh->prepare($query);
 186     $sth->execute();
 187     return @{$sth->fetchall_arrayref({})};
 188 }
 189
 190 1;
 191 __END__
 192
 193 =head1 AUTHOR
 194
 195 Koha Development Team <http://koha-community.org/>
 196
 197 =cut
 198