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::Log;
  30 use C4::Items;
  31 use C4::Debug;
  32 use C4::Search;    # enabled_staff_search_views
  33 use Koha::Patron::Images;
  34
  35 use vars qw($debug $cgi_debug);
  36
  37 =head1 viewlog.pl
  38
  39 plugin that shows stats
  40
  41 =cut
  42
  43 my $input = new CGI;
  44
  45 $debug or $debug = $cgi_debug;
  46 my $do_it    = $input->param('do_it');
  47 my @modules  = $input->multi_param("modules");
  48 my $user     = $input->param("user") // '';
  49 my @actions  = $input->multi_param("actions");
  50 my @interfaces  = $input->multi_param("interfaces");
  51 my $object   = $input->param("object");
  52 my $info     = $input->param("info");
  53 my $datefrom = $input->param("from");
  54 my $dateto   = $input->param("to");
  55 my $basename = $input->param("basename");
  56 my $output   = $input->param("output") || "screen";
  57 my $src      = $input->param("src") || ""; # this param allows us to be told where we were called from -fbcit
  58
  59 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  60     {
  61         template_name   => "tools/viewlog.tt",
  62         query           => $input,
  63         type            => "intranet",
  64         authnotrequired => 0,
  65         flagsrequired   => { tools => 'view_system_logs' },
  66         debug           => 1,
  67     }
  68 );
  69
  70 if ( $src eq 'circ' ) {
  71
  72     # if we were called from circulation, use the circulation menu and get data to populate it -fbcit
  73     use C4::Members;
  74     use C4::Members::Attributes qw(GetBorrowerAttributes);
  75     my $borrowernumber = $object;
  76     my $data = GetMember( 'borrowernumber' => $borrowernumber );
  77     my $patron_image = Koha::Patron::Images->find($data->{borrowernumber});
  78     $template->param( picture => 1 ) if $patron_image;
  79
  80     if ( C4::Context->preference('ExtendedPatronAttributes') ) {
  81         my $attributes = GetBorrowerAttributes( $data->{'borrowernumber'} );
  82         $template->param(
  83             ExtendedPatronAttributes => 1,
  84             extendedattributes       => $attributes
  85         );
  86     }
  87
  88     $template->param(%$data);
  89
  90     $template->param(
  91         menu           => 1,
  92         borrowernumber => $borrowernumber,
  93         categoryname   => $data->{'description'},
  94     );
  95 }
  96
  97 $template->param(
  98     debug => $debug,
  99     C4::Search::enabled_staff_search_views,
 100     object => $object,
 101 );
 102
 103 if ($do_it) {
 104
 105     my @data;
 106     my ( $results, $modules, $actions, $interfaces );
 107     if ( defined $actions[0] && $actions[0] ne '' ) { $actions  = \@actions; }     # match All means no limit
 108     if ( $modules[0] ne '' ) { $modules = \@modules; }    # match All means no limit
 109     if ( defined $interfaces[0] && $interfaces[0] ne '' ) { $interfaces = \@interfaces; }    # match All means no limit
 110     $results = GetLogs( $datefrom, $dateto, $user, $modules, $actions, $object, $info, $interfaces );
 111     @data = @$results;
 112     foreach my $result (@data) {
 113
 114         # Init additional columns for CSV export
 115         $result->{'biblionumber'}      = q{};
 116         $result->{'biblioitemnumber'}  = q{};
 117         $result->{'barcode'}           = q{};
 118         $result->{'userfirstname'}     = q{};
 119         $result->{'usersurname'}       = q{};
 120         $result->{'borrowerfirstname'} = q{};
 121         $result->{'borrowersurname'}   = q{};
 122
 123         if ( substr( $result->{'info'}, 0, 4 ) eq 'item' || $result->{module} eq "CIRCULATION" ) {
 124
 125             # get item information so we can create a working link
 126             my $itemnumber = $result->{'object'};
 127             $itemnumber = $result->{'info'} if ( $result->{module} eq "CIRCULATION" );
 128             my $item = GetItem($itemnumber);
 129             if ($item) {
 130                 $result->{'biblionumber'}     = $item->{'biblionumber'};
 131                 $result->{'biblioitemnumber'} = $item->{'biblionumber'};
 132                 $result->{'barcode'}          = $item->{'barcode'};
 133             }
 134         }
 135
 136         #always add firstname and surname for librarian/user
 137         if ( $result->{'user'} ) {
 138             my $userdetails = C4::Members::GetMember( borrowernumber => $result->{'user'} );
 139             if ($userdetails) {
 140                 $result->{'userfirstname'} = $userdetails->{'firstname'};
 141                 $result->{'usersurname'}   = $userdetails->{'surname'};
 142             }
 143         }
 144
 145         #add firstname and surname for borrower, when using the CIRCULATION, MEMBERS, FINES
 146         if ( $result->{module} eq "CIRCULATION" || $result->{module} eq "MEMBERS" || $result->{module} eq "FINES" ) {
 147             if ( $result->{'object'} ) {
 148                 my $borrowerdetails = C4::Members::GetMember( borrowernumber => $result->{'object'} );
 149                 if ($borrowerdetails) {
 150                     $result->{'borrowerfirstname'} = $borrowerdetails->{'firstname'};
 151                     $result->{'borrowersurname'}   = $borrowerdetails->{'surname'};
 152                 }
 153             }
 154         }
 155     }
 156
 157     if ( $output eq "screen" ) {
 158
 159         # Printing results to screen
 160         $template->param(
 161             logview  => 1,
 162             total    => scalar @data,
 163             looprow  => \@data,
 164             do_it    => 1,
 165             datefrom => $datefrom,
 166             dateto   => $dateto,
 167             user     => $user,
 168             info     => $info,
 169             src      => $src,
 170             modules  => \@modules,
 171             actions  => \@actions,
 172             interfaces => \@interfaces
 173         );
 174
 175         # Used modules
 176         foreach my $module (@modules) {
 177             $template->param( $module => 1 );
 178         }
 179
 180         output_html_with_http_headers $input, $cookie, $template->output;
 181     }
 182     else {
 183
 184         # Printing to a csv file
 185         my $content = q{};
 186         my $delimiter = C4::Context->preference('delimiter') || ',';
 187         if (@data) {
 188             my $csv = Text::CSV::Encoded->new( { encoding_out => 'utf8', sep_char => $delimiter } );
 189             $csv or die "Text::CSV::Encoded->new FAILED: " . Text::CSV::Encoded->error_diag();
 190
 191             # First line with heading
 192             # Exporting bd id seems useless
 193             my @headings = grep { $_ ne 'action_id' } sort keys %{$data[0]};
 194             if ( $csv->combine(@headings) ) {
 195                 $content .= $csv->string() . "\n";
 196             }
 197
 198             # Lines of logs
 199             foreach my $line (@data) {
 200                 my @cells = map { $line->{$_} } @headings;
 201                 if ( $csv->combine(@cells) ) {
 202                     $content .= $csv->string() . "\n";
 203                 }
 204             }
 205         }
 206
 207         # Output
 208         print $input->header(
 209             -type       => 'text/csv',
 210             -attachment => $basename . '.csv',
 211         );
 212         print $content;
 213     }
 214     exit;
 215 }
 216 else {
 217     output_html_with_http_headers $input, $cookie, $template->output;
 218 }