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
  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 ) or die "Not logged in";
  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 if (C4::Context->preference('ExtendedPatronAttributes')) {
  80     my $attributes = GetBorrowerAttributes($borrowernumber);
  81     $template->param(
  82         ExtendedPatronAttributes => 1,
  83         extendedattributes => $attributes
  84     );
  85 }
  86
  87 $template->param( adultborrower => 1 ) if ( $category->category_type eq 'A' || $category->category_type eq 'I' );
  88
  89 $template->param(
  90     patron             => $patron,
  91     statisticsview     => 1,
  92     datas              => $datas,
  93     column_names       => \@statistic_column_names,
  94     count_total_issues => $count_total_issues,
  95     count_total_issues_returned => $count_total_issues_returned,
  96     count_total_precedent_state => $count_total_precedent_state,
  97     count_total_actual_state => $count_total_actual_state,
  98 );
  99
 100 output_html_with_http_headers $input, $cookie, $template->output;
 101
 102
 103 =head1 FUNCTIONS
 104
 105 =head2 add_actual_state
 106
 107   Add a 'count_actual_state' key in all hashes
 108   count_actual_state = count_precedent_state - count_total_issues_returned_today + count_total_issues_today
 109
 110 =cut
 111
 112 sub add_actual_state {
 113     my ( $array ) = @_;
 114     for my $hash ( @$array ) {
 115         $hash->{count_actual_state} = ( $hash->{count_precedent_state} // 0 ) - ( $hash->{count_total_issues_returned_today} // 0 ) + ( $hash->{count_total_issues_today} // 0 );
 116     }
 117 }
 118
 119 =head2 build_array
 120
 121   Build a new array containing values of hashes.
 122   It used by template whitch display silly values.
 123   ex:
 124     $array = [
 125       {
 126         'count_total_issues_returned_today' => 1,
 127         'ccode' => 'ccode',
 128         'count_actual_state' => 1,
 129         'count_precedent_state' => 1,
 130         'homebranch' => 'homebranch',
 131         'count_total_issues_today' => 1,
 132         'itype' => 'itype'
 133       }
 134     ];
 135   and returns:
 136     [
 137       [
 138         'homebranch',
 139         'itype',
 140         'ccode',
 141         1,
 142         1,
 143         1,
 144         1
 145       ]
 146     ];
 147
 148 =cut
 149
 150 sub build_array {
 151     my ( $array ) = @_;
 152     my ( @r, $total );
 153     for my $hash ( @$array) {
 154         my @line;
 155         for my $cn ( ( @column_names, 'count_actual_state') ) {
 156             if ( grep /$cn/, ( @value_column_names, 'count_actual_state') ) {
 157                 $hash->{$cn} //= 0;
 158                 if ( exists $total->{$cn} ) {
 159                     $total->{$cn} += $hash->{$cn} if $hash->{$cn};
 160                 } else {
 161                     $total->{$cn} = $hash->{$cn};
 162                 }
 163             }
 164             push @line, $hash->{$cn};
 165         }
 166         push @r, \@line;
 167     }
 168     return ( $total, \@r );
 169 }
 170
 171 =head2 merge
 172
 173   Merge hashes with the same statistic column names into one
 174   param: array, a arrayref of arrayrefs
 175   ex:
 176   @array = (
 177      {
 178        'ccode' => 'ccode',
 179        'count_precedent_state' => '1',
 180        'homebranch' => 'homebranch',
 181        'itype' => 'itype'
 182      },
 183      {
 184        'count_total_issues_returned_today' => '1',
 185        'ccode' => 'ccode',
 186        'homebranch' => 'homebranch',
 187        'itype' => 'itype'
 188      }
 189    );
 190    and returns:
 191    [
 192      {
 193        'count_total_issues_returned_today' => '1',
 194        'ccode' => 'ccode',
 195        'count_precedent_state' => '1',
 196        'homebranch' => 'homebranch',
 197        'itype' => 'itype'
 198      }
 199    ];
 200
 201 =cut
 202
 203 sub merge {
 204     my @array = @_;
 205     my @r;
 206     for my $h ( @array ) {
 207         my $exists = 0;
 208         for my $ch ( @r ) {
 209             $exists = 1;
 210             for my $cn ( @statistic_column_names ) {
 211                 if ( $ch->{$cn} and not $ch->{$cn} eq $h->{$cn} ) {
 212                     $exists = 0;
 213                     last;
 214                 }
 215             }
 216             if ($exists){
 217                 for my $cn ( @value_column_names ) {
 218                     next if not exists $h->{$cn};
 219                     $ch->{$cn} = $h->{$cn} ? $h->{$cn} : 0;
 220                 }
 221                 last;
 222             }
 223         }
 224
 225         if ( not $exists ) {push @r, $h;}
 226     }
 227     return \@r;
 228 }