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::Patrons;
  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 $patron = Koha::Patrons->find( $borrowernumber );
  77     unless ( $patron ) {
  78         print $input->redirect("/cgi-bin/koha/circ/circulation.pl?borrowernumber=$borrowernumber");
  79         exit;
  80     }
  81     $template->param( picture => 1 ) if $patron->image;
  82     my $data = $patron->unblessed;
  83
  84     if ( C4::Context->preference('ExtendedPatronAttributes') ) {
  85         my $attributes = GetBorrowerAttributes( $data->{'borrowernumber'} );
  86         $template->param(
  87             ExtendedPatronAttributes => 1,
  88             extendedattributes       => $attributes
  89         );
  90     }
  91
  92     $template->param(%$data);
  93
  94     $template->param(
  95         menu           => 1,
  96         borrowernumber => $borrowernumber,
  97         categoryname   => $patron->category->description,
  98     );
  99 }
 100
 101 $template->param(
 102     debug => $debug,
 103     C4::Search::enabled_staff_search_views,
 104     object => $object,
 105 );
 106
 107 if ($do_it) {
 108
 109     my @data;
 110     my ( $results, $modules, $actions, $interfaces );
 111     if ( defined $actions[0] && $actions[0] ne '' ) { $actions  = \@actions; }     # match All means no limit
 112     if ( $modules[0] ne '' ) { $modules = \@modules; }    # match All means no limit
 113     if ( defined $interfaces[0] && $interfaces[0] ne '' ) { $interfaces = \@interfaces; }    # match All means no limit
 114     $results = GetLogs( $datefrom, $dateto, $user, $modules, $actions, $object, $info, $interfaces );
 115     @data = @$results;
 116     foreach my $result (@data) {
 117
 118         # Init additional columns for CSV export
 119         $result->{'biblionumber'}      = q{};
 120         $result->{'biblioitemnumber'}  = q{};
 121         $result->{'barcode'}           = q{};
 122         $result->{'userfirstname'}     = q{};
 123         $result->{'usersurname'}       = q{};
 124         $result->{'borrowerfirstname'} = q{};
 125         $result->{'borrowersurname'}   = q{};
 126
 127         if ( substr( $result->{'info'}, 0, 4 ) eq 'item' || $result->{module} eq "CIRCULATION" ) {
 128
 129             # get item information so we can create a working link
 130             my $itemnumber = $result->{'object'};
 131             $itemnumber = $result->{'info'} if ( $result->{module} eq "CIRCULATION" );
 132             my $item = GetItem($itemnumber);
 133             if ($item) {
 134                 $result->{'biblionumber'}     = $item->{'biblionumber'};
 135                 $result->{'biblioitemnumber'} = $item->{'biblionumber'};
 136                 $result->{'barcode'}          = $item->{'barcode'};
 137             }
 138         }
 139
 140         #always add firstname and surname for librarian/user
 141         if ( $result->{'user'} ) {
 142             my $patron = Koha::Patrons->find( $result->{'user'} );
 143             if ($patron) {
 144                 $result->{'userfirstname'} = $patron->firstname;
 145                 $result->{'usersurname'}   = $patron->surname;
 146             }
 147         }
 148
 149         #add firstname and surname for borrower, when using the CIRCULATION, MEMBERS, FINES
 150         if ( $result->{module} eq "CIRCULATION" || $result->{module} eq "MEMBERS" || $result->{module} eq "FINES" ) {
 151             if ( $result->{'object'} ) {
 152                 my $patron = Koha::Patrons->find( $result->{'object'} );
 153                 if ($patron) {
 154                     $result->{'borrowerfirstname'} = $patron->firstname;
 155                     $result->{'borrowersurname'}   = $patron->surname;
 156                 }
 157             }
 158         }
 159     }
 160
 161     if ( $output eq "screen" ) {
 162
 163         # Printing results to screen
 164         $template->param(
 165             logview  => 1,
 166             total    => scalar @data,
 167             looprow  => \@data,
 168             do_it    => 1,
 169             datefrom => $datefrom,
 170             dateto   => $dateto,
 171             user     => $user,
 172             info     => $info,
 173             src      => $src,
 174             modules  => \@modules,
 175             actions  => \@actions,
 176             interfaces => \@interfaces
 177         );
 178
 179         # Used modules
 180         foreach my $module (@modules) {
 181             $template->param( $module => 1 );
 182         }
 183
 184         output_html_with_http_headers $input, $cookie, $template->output;
 185     }
 186     else {
 187
 188         # Printing to a csv file
 189         my $content = q{};
 190         my $delimiter = C4::Context->preference('delimiter') || ',';
 191         if (@data) {
 192             my $csv = Text::CSV::Encoded->new( { encoding_out => 'utf8', sep_char => $delimiter } );
 193             $csv or die "Text::CSV::Encoded->new FAILED: " . Text::CSV::Encoded->error_diag();
 194
 195             # First line with heading
 196             # Exporting bd id seems useless
 197             my @headings = grep { $_ ne 'action_id' } sort keys %{$data[0]};
 198             if ( $csv->combine(@headings) ) {
 199                 $content .= $csv->string() . "\n";
 200             }
 201
 202             # Lines of logs
 203             foreach my $line (@data) {
 204                 my @cells = map { $line->{$_} } @headings;
 205                 if ( $csv->combine(@cells) ) {
 206                     $content .= $csv->string() . "\n";
 207                 }
 208             }
 209         }
 210
 211         # Output
 212         print $input->header(
 213             -type       => 'text/csv',
 214             -attachment => $basename . '.csv',
 215         );
 216         print $content;
 217     }
 218     exit;
 219 }
 220 else {
 221     output_html_with_http_headers $input, $cookie, $template->output;
 222 }