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