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