members/statistics.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2012 BibLibre
   4 # This file is part of Koha.
   5 #
   6 # Koha is free software; you can redistribute it and/or modify it under the
   7 # terms of the GNU General Public License as published by the Free Software
   8 # Foundation; either version 2 of the License, or (at your option) any later
   9 # version.
  10 #
  11 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  12 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  13 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along with
  16 # Koha; if not, write to the Free Software Foundation, Inc.,
  17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19 =head1 members/statistics.pl
  20
  21   Generate statistic issues for a member
  22
  23 =cut
  24
  25 use Modern::Perl;
  26
  27 use CGI qw ( -utf8 );
  28 use C4::Auth;
  29 use C4::Context;
  30 use C4::Members;
  31 use C4::Members::Statistics;
  32 use C4::Output;
  33 use Koha::Patrons;
  34 use Koha::Patron::Categories;
  35
  36 my $input = new CGI;
  37
  38 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  39     {   template_name   => "members/statistics.tt",
  40         query           => $input,
  41         type            => "intranet",
  42         authnotrequired => 0,
  43         flagsrequired   => { borrowers => 'edit_borrowers' },
  44         debug           => 1,
  45     }
  46 );
  47
  48 my $borrowernumber = $input->param('borrowernumber');
  49
  50 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
  51 my $patron         = Koha::Patrons->find( $borrowernumber );
  52 output_and_exit_if_error( $input, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
  53
  54 my $category = $patron->category;
  55
  56 # Construct column names
  57 my $fields = C4::Members::Statistics::get_fields();
  58 our @statistic_column_names = split '\|', $fields;
  59 our @value_column_names = ( 'count_precedent_state', 'count_total_issues_today', 'count_total_issues_returned_today' );
  60 our @column_names = ( @statistic_column_names, @value_column_names );
  61
  62 # Get statistics
  63 my $precedent_state = GetPrecedentStateByBorrower( $borrowernumber );
  64 my $total_issues_today = GetTotalIssuesTodayByBorrower( $borrowernumber );
  65 my $total_issues_returned_today = GetTotalIssuesReturnedTodayByBorrower( $borrowernumber );
  66 my $r = merge (
  67     @$precedent_state, @$total_issues_today, @$total_issues_returned_today
  68 );
  69
  70 add_actual_state( $r );
  71 my ( $total, $datas ) = build_array( $r );
  72
  73 # Gettings sums
  74 my $count_total_precedent_state = $total->{count_precedent_state} || 0;
  75 my $count_total_issues = $total->{count_total_issues_today} || 0;
  76 my $count_total_issues_returned = $total->{count_total_issues_returned_today} || 0;
  77 my $count_total_actual_state = ($count_total_precedent_state - $count_total_issues_returned + $count_total_issues);
  78
  79 $template->param(
  80     patron             => $patron,
  81     statisticsview     => 1,
  82     datas              => $datas,
  83     column_names       => \@statistic_column_names,
  84     count_total_issues => $count_total_issues,
  85     count_total_issues_returned => $count_total_issues_returned,
  86     count_total_precedent_state => $count_total_precedent_state,
  87     count_total_actual_state => $count_total_actual_state,
  88 );
  89
  90 output_html_with_http_headers $input, $cookie, $template->output;
  91
  92
  93 =head1 FUNCTIONS
  94
  95 =head2 add_actual_state
  96
  97   Add a 'count_actual_state' key in all hashes
  98   count_actual_state = count_precedent_state - count_total_issues_returned_today + count_total_issues_today
  99
 100 =cut
 101
 102 sub add_actual_state {
 103     my ( $array ) = @_;
 104     for my $hash ( @$array ) {
 105         $hash->{count_actual_state} = ( $hash->{count_precedent_state} // 0 ) - ( $hash->{count_total_issues_returned_today} // 0 ) + ( $hash->{count_total_issues_today} // 0 );
 106     }
 107 }
 108
 109 =head2 build_array
 110
 111   Build a new array containing values of hashes.
 112   It used by template whitch display silly values.
 113   ex:
 114     $array = [
 115       {
 116         'count_total_issues_returned_today' => 1,
 117         'ccode' => 'ccode',
 118         'count_actual_state' => 1,
 119         'count_precedent_state' => 1,
 120         'homebranch' => 'homebranch',
 121         'count_total_issues_today' => 1,
 122         'itype' => 'itype'
 123       }
 124     ];
 125   and returns:
 126     [
 127       [
 128         'homebranch',
 129         'itype',
 130         'ccode',
 131         1,
 132         1,
 133         1,
 134         1
 135       ]
 136     ];
 137
 138 =cut
 139
 140 sub build_array {
 141     my ( $array ) = @_;
 142     my ( @r, $total );
 143     for my $hash ( @$array) {
 144         my @line;
 145         for my $cn ( ( @column_names, 'count_actual_state') ) {
 146             if ( grep /$cn/, ( @value_column_names, 'count_actual_state') ) {
 147                 $hash->{$cn} //= 0;
 148                 if ( exists $total->{$cn} ) {
 149                     $total->{$cn} += $hash->{$cn} if $hash->{$cn};
 150                 } else {
 151                     $total->{$cn} = $hash->{$cn};
 152                 }
 153             }
 154             push @line, $hash->{$cn};
 155         }
 156         push @r, \@line;
 157     }
 158     return ( $total, \@r );
 159 }
 160
 161 =head2 merge
 162
 163   Merge hashes with the same statistic column names into one
 164   param: array, a arrayref of arrayrefs
 165   ex:
 166   @array = (
 167      {
 168        'ccode' => 'ccode',
 169        'count_precedent_state' => '1',
 170        'homebranch' => 'homebranch',
 171        'itype' => 'itype'
 172      },
 173      {
 174        'count_total_issues_returned_today' => '1',
 175        'ccode' => 'ccode',
 176        'homebranch' => 'homebranch',
 177        'itype' => 'itype'
 178      }
 179    );
 180    and returns:
 181    [
 182      {
 183        'count_total_issues_returned_today' => '1',
 184        'ccode' => 'ccode',
 185        'count_precedent_state' => '1',
 186        'homebranch' => 'homebranch',
 187        'itype' => 'itype'
 188      }
 189    ];
 190
 191 =cut
 192
 193 sub merge {
 194     my @array = @_;
 195     my @r;
 196     for my $h ( @array ) {
 197         my $exists = 0;
 198         for my $ch ( @r ) {
 199             $exists = 1;
 200             for my $cn ( @statistic_column_names ) {
 201                 if (   ( not defined $ch->{$cn} && defined $h->{$cn} )
 202                     || ( defined $ch->{$cn} && not defined $h->{$cn} )
 203                     || ( $ch->{$cn} ne $h->{$cn} ) )
 204                 {
 205                     $exists = 0;
 206                     last;
 207                 }
 208             }
 209             if ($exists){
 210                 for my $cn ( @value_column_names ) {
 211                     next if not exists $h->{$cn};
 212                     $ch->{$cn} = $h->{$cn} ? $h->{$cn} : 0;
 213                 }
 214                 last;
 215             }
 216         }
 217
 218         if ( not $exists ) {push @r, $h;}
 219     }
 220     return \@r;
 221 }