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 Modern::Perl;
  22 require Exporter;
  23 use Carp;
  24 use C4::Context;
  25 use C4::Debug;
  26
  27 use Koha::DateUtils qw( dt_from_string );
  28 use Koha::Statistics;
  29 use Koha::PseudonymizedTransactions;
  30
  31 use vars qw(@ISA @EXPORT);
  32
  33 our $debug;
  34
  35 BEGIN {
  36         @ISA    = qw(Exporter);
  37         @EXPORT = qw(
  38                 &UpdateStats
  39         );
  40 }
  41
  42
  43 =head1 NAME
  44
  45 C4::Stats - Update Koha statistics (log)
  46
  47 =head1 SYNOPSIS
  48
  49   use C4::Stats;
  50
  51 =head1 DESCRIPTION
  52
  53 The functions of this module deals with statistics table of Koha database.
  54
  55 =head1 FUNCTIONS
  56
  57 =head2 UpdateStats
  58
  59   &UpdateStats($params);
  60
  61 Adds an entry to the statistics table in the Koha database, which acts as an activity log.
  62
  63 C<$params> is an hashref whose expected keys are:
  64     branch             : the branch where the transaction occurred
  65     type               : the type of transaction (renew, issue, localuse, return, writeoff, payment
  66     itemnumber         : the itemnumber of the item
  67     borrowernumber     : the borrowernumber of the patron
  68     amount             : the amount of the transaction
  69     other              : sipmode
  70     itemtype           : the type of the item
  71     ccode              : the collection code of the item
  72
  73 type key is mandatory.
  74 For types used in C4::Circulation (renew,issue,localuse,return), the following other keys are mandatory:
  75 branch, borrowernumber, itemnumber, ccode, itemtype
  76 For types used in C4::Accounts (writeoff, payment), the following other keys are mandatory:
  77 branch, borrowernumber, itemnumber, ccode, itemtype
  78 If an optional key is not provided, the value '' is used for this key.
  79
  80 Returns undef if no C<$param> is given
  81
  82 =cut
  83
  84 sub UpdateStats {
  85     my ($params) = @_;
  86 # make some controls
  87     return () if ! defined $params;
  88 # change these arrays if new types of transaction or new parameters are allowed
  89     my @allowed_keys = qw (type branch amount other itemnumber itemtype borrowernumber ccode location);
  90     my @allowed_circulation_types = qw (renew issue localuse return onsite_checkout);
  91     my @allowed_accounts_types = qw (writeoff payment);
  92     my @circulation_mandatory_keys = qw (type branch borrowernumber itemnumber ccode itemtype);
  93     my @accounts_mandatory_keys = qw (type branch borrowernumber amount);
  94
  95     my @mandatory_keys = ();
  96     if (! exists $params->{type} or ! defined $params->{type}) {
  97         croak ("UpdateStats did not received type param");
  98     }
  99     if (grep ($_ eq $params->{type}, @allowed_circulation_types  )) {
 100         @mandatory_keys = @circulation_mandatory_keys;
 101     } elsif (grep ($_ eq $params->{type}, @allowed_accounts_types )) {
 102         @mandatory_keys = @accounts_mandatory_keys;
 103     } else {
 104         croak ("UpdateStats received forbidden type param: ".$params->{type});
 105     }
 106     my @missing_params = ();
 107     for my $mykey (@mandatory_keys ) {
 108         push @missing_params, $mykey if !grep (/^$mykey/, keys %$params);
 109     }
 110     if (scalar @missing_params > 0 ) {
 111         croak ("UpdateStats did not received mandatory param(s): ".join (", ",@missing_params ));
 112     }
 113     my @invalid_params = ();
 114     for my $myparam (keys %$params ) {
 115         push @invalid_params, $myparam unless grep { $_ eq $myparam } @allowed_keys;
 116     }
 117     if (scalar @invalid_params > 0 ) {
 118         croak ("UpdateStats received invalid param(s): ".join (", ",@invalid_params ));
 119     }
 120 # get the parameters
 121     my $branch            = $params->{branch};
 122     my $type              = $params->{type};
 123     my $borrowernumber    = exists $params->{borrowernumber} ? $params->{borrowernumber} : '';
 124     my $itemnumber        = exists $params->{itemnumber}     ? $params->{itemnumber}     : undef;
 125     my $amount            = exists $params->{amount}         ? $params->{amount}         : 0;
 126     my $other             = exists $params->{other}          ? $params->{other}          : '';
 127     my $itemtype          = exists $params->{itemtype}       ? $params->{itemtype}       : '';
 128     my $location          = exists $params->{location}       ? $params->{location}       : undef;
 129     my $ccode             = exists $params->{ccode}          ? $params->{ccode}          : '';
 130
 131     my $dtf = Koha::Database->new->schema->storage->datetime_parser;
 132     my $statistic = Koha::Statistic->new(
 133         {
 134             datetime       => $dtf->format_datetime( dt_from_string ),
 135             branch         => $branch,
 136             type           => $type,
 137             value          => $amount,
 138             other          => $other,
 139             itemnumber     => $itemnumber,
 140             itemtype       => $itemtype,
 141             location       => $location,
 142             borrowernumber => $borrowernumber,
 143             ccode          => $ccode,
 144         }
 145     )->store;
 146
 147     Koha::PseudonymizedTransaction->new_from_statistic($statistic)->store
 148       if C4::Context->preference('Pseudonymization')
 149         && $borrowernumber # Not a real transaction if the patron does not exist
 150                            # For instance can be a transfer, or hold trigger
 151         && grep { $_ eq $params->{type} } qw(renew issue return onsite_checkout);
 152 }
 153
 154 1;
 155 __END__
 156
 157 =head1 AUTHOR
 158
 159 Koha Development Team <http://koha-community.org/>
 160
 161 =cut
 162