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::Members::Attributes qw(GetBorrowerAttributes);
  33 use C4::Output;
  34 use Koha::Patrons;
  35 use Koha::Patron::Categories;
  36
  37 my $input = new CGI;
  38
  39 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  40     {   template_name   => "members/statistics.tt",
  41         query           => $input,
  42         type            => "intranet",
  43         authnotrequired => 0,
  44         flagsrequired   => { borrowers => 'edit_borrowers' },
  45         debug           => 1,
  46     }
  47 );
  48
  49 my $borrowernumber = $input->param('borrowernumber');
  50
  51 my $logged_in_user = Koha::Patrons->find( $loggedinuser ) or die "Not logged in";
  52 my $patron         = Koha::Patrons->find( $borrowernumber );
  53 output_and_exit_if_error( $input, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
  54
  55 my $category = $patron->category;
  56
  57 # Construct column names
  58 my $fields = C4::Members::Statistics::get_fields();
  59 our @statistic_column_names = split '\|', $fields;
  60 our @value_column_names = ( 'count_precedent_state', 'count_total_issues_today', 'count_total_issues_returned_today' );
  61 our @column_names = ( @statistic_column_names, @value_column_names );
  62
  63 # Get statistics
  64 my $precedent_state = GetPrecedentStateByBorrower( $borrowernumber );
  65 my $total_issues_today = GetTotalIssuesTodayByBorrower( $borrowernumber );
  66 my $total_issues_returned_today = GetTotalIssuesReturnedTodayByBorrower( $borrowernumber );
  67 my $r = merge (
  68     @$precedent_state, @$total_issues_today, @$total_issues_returned_today
  69 );
  70
  71 add_actual_state( $r );
  72 my ( $total, $datas ) = build_array( $r );
  73
  74 # Gettings sums
  75 my $count_total_precedent_state = $total->{count_precedent_state} || 0;
  76 my $count_total_issues = $total->{count_total_issues_today} || 0;
  77 my $count_total_issues_returned = $total->{count_total_issues_returned_today} || 0;
  78 my $count_total_actual_state = ($count_total_precedent_state - $count_total_issues_returned + $count_total_issues);
  79
  80 if (C4::Context->preference('ExtendedPatronAttributes')) {
  81     my $attributes = GetBorrowerAttributes($borrowernumber);
  82     $template->param(
  83         ExtendedPatronAttributes => 1,
  84         extendedattributes => $attributes
  85     );
  86 }
  87
  88 $template->param(
  89     patron             => $patron,
  90     statisticsview     => 1,
  91     datas              => $datas,
  92     column_names       => \@statistic_column_names,
  93     count_total_issues => $count_total_issues,
  94     count_total_issues_returned => $count_total_issues_returned,
  95     count_total_precedent_state => $count_total_precedent_state,
  96     count_total_actual_state => $count_total_actual_state,
  97 );
  98
  99 output_html_with_http_headers $input, $cookie, $template->output;
 100
 101
 102 =head1 FUNCTIONS
 103
 104 =head2 add_actual_state
 105
 106   Add a 'count_actual_state' key in all hashes
 107   count_actual_state = count_precedent_state - count_total_issues_returned_today + count_total_issues_today
 108
 109 =cut
 110
 111 sub add_actual_state {
 112     my ( $array ) = @_;
 113     for my $hash ( @$array ) {
 114         $hash->{count_actual_state} = ( $hash->{count_precedent_state} // 0 ) - ( $hash->{count_total_issues_returned_today} // 0 ) + ( $hash->{count_total_issues_today} // 0 );
 115     }
 116 }
 117
 118 =head2 build_array
 119
 120   Build a new array containing values of hashes.
 121   It used by template whitch display silly values.
 122   ex:
 123     $array = [
 124       {
 125         'count_total_issues_returned_today' => 1,
 126         'ccode' => 'ccode',
 127         'count_actual_state' => 1,
 128         'count_precedent_state' => 1,
 129         'homebranch' => 'homebranch',
 130         'count_total_issues_today' => 1,
 131         'itype' => 'itype'
 132       }
 133     ];
 134   and returns:
 135     [
 136       [
 137         'homebranch',
 138         'itype',
 139         'ccode',
 140         1,
 141         1,
 142         1,
 143         1
 144       ]
 145     ];
 146
 147 =cut
 148
 149 sub build_array {
 150     my ( $array ) = @_;
 151     my ( @r, $total );
 152     for my $hash ( @$array) {
 153         my @line;
 154         for my $cn ( ( @column_names, 'count_actual_state') ) {
 155             if ( grep /$cn/, ( @value_column_names, 'count_actual_state') ) {
 156                 $hash->{$cn} //= 0;
 157                 if ( exists $total->{$cn} ) {
 158                     $total->{$cn} += $hash->{$cn} if $hash->{$cn};
 159                 } else {
 160                     $total->{$cn} = $hash->{$cn};
 161                 }
 162             }
 163             push @line, $hash->{$cn};
 164         }
 165         push @r, \@line;
 166     }
 167     return ( $total, \@r );
 168 }
 169
 170 =head2 merge
 171
 172   Merge hashes with the same statistic column names into one
 173   param: array, a arrayref of arrayrefs
 174   ex:
 175   @array = (
 176      {
 177        'ccode' => 'ccode',
 178        'count_precedent_state' => '1',
 179        'homebranch' => 'homebranch',
 180        'itype' => 'itype'
 181      },
 182      {
 183        'count_total_issues_returned_today' => '1',
 184        'ccode' => 'ccode',
 185        'homebranch' => 'homebranch',
 186        'itype' => 'itype'
 187      }
 188    );
 189    and returns:
 190    [
 191      {
 192        'count_total_issues_returned_today' => '1',
 193        'ccode' => 'ccode',
 194        'count_precedent_state' => '1',
 195        'homebranch' => 'homebranch',
 196        'itype' => 'itype'
 197      }
 198    ];
 199
 200 =cut
 201
 202 sub merge {
 203     my @array = @_;
 204     my @r;
 205     for my $h ( @array ) {
 206         my $exists = 0;
 207         for my $ch ( @r ) {
 208             $exists = 1;
 209             for my $cn ( @statistic_column_names ) {
 210                 if (   ( not defined $ch->{$cn} && defined $h->{$cn} )
 211                     || ( defined $ch->{$cn} && not defined $h->{$cn} )
 212                     || ( $ch->{$cn} ne $h->{$cn} ) )
 213                 {
 214                     $exists = 0;
 215                     last;
 216                 }
 217             }
 218             if ($exists){
 219                 for my $cn ( @value_column_names ) {
 220                     next if not exists $h->{$cn};
 221                     $ch->{$cn} = $h->{$cn} ? $h->{$cn} : 0;
 222                 }
 223                 last;
 224             }
 225         }
 226
 227         if ( not $exists ) {push @r, $h;}
 228     }
 229     return \@r;
 230 }