tools/viewlog.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2010 BibLibre
   4 # Copyright 2011 MJ Ray and software.coop
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 use Modern::Perl;
  22
  23 use C4::Auth;
  24 use CGI qw ( -utf8 );
  25 use Text::CSV::Encoded;
  26 use C4::Context;
  27 use C4::Koha;
  28 use C4::Output;
  29 use C4::Items;
  30 use C4::Serials;
  31 use C4::Debug;
  32 use C4::Search;    # enabled_staff_search_views
  33
  34 use Koha::ActionLogs;
  35 use Koha::Database;
  36 use Koha::DateUtils;
  37 use Koha::Items;
  38 use Koha::Patrons;
  39
  40 use vars qw($debug $cgi_debug);
  41
  42 =head1 viewlog.pl
  43
  44 plugin that shows stats
  45
  46 =cut
  47
  48 my $input = new CGI;
  49
  50 $debug or $debug = $cgi_debug;
  51 my $do_it    = $input->param('do_it');
  52 my @modules  = $input->multi_param("modules");
  53 my $user     = $input->param("user") // '';
  54 my @actions  = $input->multi_param("actions");
  55 my @interfaces  = $input->multi_param("interfaces");
  56 my $object   = $input->param("object");
  57 my $object_type = $input->param("object_type") // '';
  58 my $info     = $input->param("info");
  59 my $datefrom = $input->param("from");
  60 my $dateto   = $input->param("to");
  61 my $basename = $input->param("basename");
  62 my $output   = $input->param("output") || "screen";
  63 my $src      = $input->param("src") || ""; # this param allows us to be told where we were called from -fbcit
  64
  65 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  66     {
  67         template_name   => "tools/viewlog.tt",
  68         query           => $input,
  69         type            => "intranet",
  70         flagsrequired   => { tools => 'view_system_logs' },
  71         debug           => 1,
  72     }
  73 );
  74
  75 if ( $src eq 'circ' ) {
  76
  77     my $borrowernumber = $object;
  78     my $patron = Koha::Patrons->find( $borrowernumber );
  79     my $circ_info = 1;
  80     unless ( $patron ) {
  81          $circ_info = 0;
  82     }
  83
  84     $template->param(
  85         patron      => $patron,
  86         circulation => $circ_info,
  87     );
  88 }
  89
  90 $template->param(
  91     debug => $debug,
  92     C4::Search::enabled_staff_search_views,
  93     subscriptionsnumber => ( $object ? CountSubscriptionFromBiblionumber($object) : 0 ),
  94     object => $object,
  95 );
  96
  97 if ($do_it) {
  98     my $dtf = Koha::Database->new->schema->storage->datetime_parser;
  99     my %search_params;
 100
 101     if ($datefrom and $dateto ) {
 102         my $dateto_endday = dt_from_string($dateto);
 103         $dateto_endday->set( # We set last second of day to see all log from that day
 104             hour => 23,
 105             minute => 59,
 106             second => 59
 107         );
 108         $search_params{'timestamp'} = {
 109             -between => [
 110                 $dtf->format_datetime( dt_from_string($datefrom) ),
 111                 $dtf->format_datetime( $dateto_endday ),
 112             ]
 113         };
 114     } elsif ($datefrom) {
 115         $search_params{'timestamp'} = {
 116             '>=' => $dtf->format_datetime( dt_from_string($datefrom) )
 117         };
 118     } elsif ($dateto) {
 119         my $dateto_endday = dt_from_string($dateto);
 120         $dateto_endday->set( # We set last second of day to see all log from that day
 121             hour => 23,
 122             minute => 59,
 123             second => 59
 124         );
 125         $search_params{'timestamp'} = {
 126             '<=' => $dtf->format_datetime( $dateto_endday )
 127         };
 128     }
 129     # Circulation uses RENEWAL, but Patrons uses RENEW, this helps to find both
 130     if ( grep { $_ eq 'RENEW'} @actions ) { push @actions, 'RENEWAL' };
 131
 132     $search_params{user} = $user if $user;
 133     $search_params{module} = { -in => [ @modules ] } if ( defined $modules[0] and $modules[0] ne '' ) ;
 134     $search_params{action} = { -in => [ @actions ] } if ( defined $actions[0] && $actions[0] ne '' );
 135     $search_params{interface} = { -in => [ @interfaces ] } if ( defined $interfaces[0] && $interfaces[0] ne '' );
 136
 137     if ( @modules == 1 && $object_type eq 'biblio' ) {
 138         # Handle 'Modification log' from cataloguing
 139         my @itemnumbers = Koha::Items->search({ biblionumber => $object })->get_column('itemnumber');
 140         $search_params{'-or'} = [
 141             { -and => { object => $object, info => { -like => 'biblio%' }}},
 142             { -and => { object => \@itemnumbers, info => { -like => 'item%' }}},
 143         ];
 144     } else {
 145         $search_params{info} = { -like => '%' . $info . '%' } if $info;
 146         $search_params{object} = $object if $object;
 147     }
 148
 149     my @logs = Koha::ActionLogs->search(\%search_params);
 150
 151     my @data;
 152     foreach my $log (@logs) {
 153         my $result = $log->unblessed;
 154         # Init additional columns for CSV export
 155         $result->{'biblionumber'}      = q{};
 156         $result->{'biblioitemnumber'}  = q{};
 157         $result->{'barcode'}           = q{};
 158
 159         if ( substr( $log->info, 0, 4 ) eq 'item' || $log->module eq "CIRCULATION" ) {
 160
 161             # get item information so we can create a working link
 162             my $itemnumber = $log->object;
 163             $itemnumber = $log->info if ( $log->module eq "CIRCULATION" );
 164             my $item = Koha::Items->find($itemnumber);
 165             if ($item) {
 166                 $result->{'biblionumber'}     = $item->biblionumber;
 167                 $result->{'biblioitemnumber'} = $item->biblionumber;
 168                 $result->{'barcode'}          = $item->barcode;
 169             }
 170         }
 171
 172         #always add firstname and surname for librarian/user
 173         if ( $log->user ) {
 174             my $patron = Koha::Patrons->find( $log->user );
 175             if ($patron && $output eq 'screen') {
 176                 $result->{librarian} = $patron;
 177             }
 178         }
 179
 180         #add firstname and surname for borrower, when using the CIRCULATION, MEMBERS, FINES
 181         if ( $log->module eq "CIRCULATION" || $log->module eq "MEMBERS" || $log->module eq "FINES" ) {
 182             if ( $log->object ) {
 183                 my $patron = Koha::Patrons->find( $log->object );
 184                 if ($patron && $output eq 'screen') {
 185                     $result->{patron} = $patron;
 186                 }
 187             }
 188         }
 189         push @data, $result;
 190     }
 191     if ( $output eq "screen" ) {
 192
 193         # Printing results to screen
 194         $template->param(
 195             logview  => 1,
 196             total    => scalar @data,
 197             looprow  => \@data,
 198             do_it    => 1,
 199             datefrom => $datefrom,
 200             dateto   => $dateto,
 201             user     => $user,
 202             info     => $info,
 203             src      => $src,
 204             modules  => \@modules,
 205             actions  => \@actions,
 206             interfaces => \@interfaces
 207         );
 208
 209         # Used modules
 210         foreach my $module (@modules) {
 211             $template->param( $module => 1 );
 212         }
 213         output_html_with_http_headers $input, $cookie, $template->output;
 214     }
 215     else {
 216
 217         # Printing to a csv file
 218         my $content = q{};
 219         my $delimiter = C4::Context->preference('delimiter') || ',';
 220         if (@data) {
 221             my $csv = Text::CSV::Encoded->new( { encoding_out => 'utf8', sep_char => $delimiter } );
 222             $csv or die "Text::CSV::Encoded->new FAILED: " . Text::CSV::Encoded->error_diag();
 223
 224             # First line with heading
 225             # Exporting bd id seems useless
 226             my @headings = grep { $_ ne 'action_id' } sort keys %{$data[0]};
 227             if ( $csv->combine(@headings) ) {
 228                 $content .= $csv->string() . "\n";
 229             }
 230
 231             # Lines of logs
 232             foreach my $line (@data) {
 233                 my @cells = map { $line->{$_} } @headings;
 234                 if ( $csv->combine(@cells) ) {
 235                     $content .= $csv->string() . "\n";
 236                 }
 237             }
 238         }
 239
 240         # Output
 241         print $input->header(
 242             -type       => 'text/csv',
 243             -attachment => $basename . '.csv',
 244         );
 245         print $content;
 246     }
 247     exit;
 248 }
 249 else {
 250     output_html_with_http_headers $input, $cookie, $template->output;
 251 }