Koha/tools/viewlog.pl
Martin Renvoize 058884ed4f Bug 14233: Add logging support to notices and slips management
This enhancements adds support for logging changes to notices and slips.
Features include:
- a system preference (NoticesLog) which allows you to enable logging changes for notices and slips
- logging new notices, changes to notices, and deletion of notices
- filtering in the log viewer so you can show all changes for a specific notice
- a comparison feature, so you can see what changes were made to a notice.

Test plan:
1/ Add some 'Notice' action logs by adding a new notice or updateing an
existing notice
2/ Go to the 'Log viewer' under 'Tools'
3/ Note you can filter by 'Notices'
4/ Confirm the changes you made appear in the logs and that the 'Object'
field links back to the updated notice ready for editing.

1/ Make some changes to at least two different notices to trigger logs
2/ Go to the 'Log viewer' from 'Tools' and filter on 'Notices'
3/ Note, you can now see the 'Compare' checkbox option for these logs
4/ Select the checkbox on one of the notices and note that the results
are now filtered by that specific notice.
5/ Select a second checkbox to expose the option to 'View comparison'
6/ Click 'View comparison' to see the 'Diff view' of the two notices.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-04-09 15:45:12 +02:00

261 lines
8.4 KiB
Perl
Executable file

#!/usr/bin/perl
# Copyright 2010 BibLibre
# Copyright 2011 MJ Ray and software.coop
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use C4::Auth;
use CGI qw ( -utf8 );
use Text::CSV::Encoded;
use C4::Context;
use C4::Koha;
use C4::Output;
use C4::Items;
use C4::Serials;
use C4::Debug;
use C4::Search; # enabled_staff_search_views
use Koha::ActionLogs;
use Koha::Database;
use Koha::DateUtils;
use Koha::Items;
use Koha::Patrons;
use vars qw($debug $cgi_debug);
=head1 viewlog.pl
plugin that shows stats
=cut
my $input = CGI->new;
$debug or $debug = $cgi_debug;
my $do_it = $input->param('do_it');
my @modules = $input->multi_param("modules");
my $user = $input->param("user") // '';
my @actions = $input->multi_param("actions");
my @interfaces = $input->multi_param("interfaces");
my $object = $input->param("object");
my $object_type = $input->param("object_type") // '';
my $info = $input->param("info");
my $datefrom = $input->param("from");
my $dateto = $input->param("to");
my $basename = $input->param("basename");
my $output = $input->param("output") || "screen";
my $src = $input->param("src") || ""; # this param allows us to be told where we were called from -fbcit
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
{
template_name => "tools/viewlog.tt",
query => $input,
type => "intranet",
flagsrequired => { tools => 'view_system_logs' },
debug => 1,
}
);
if ( $src eq 'circ' ) {
my $borrowernumber = $object;
my $patron = Koha::Patrons->find( $borrowernumber );
my $circ_info = 1;
unless ( $patron ) {
$circ_info = 0;
}
$template->param(
patron => $patron,
circulation => $circ_info,
);
}
$template->param(
debug => $debug,
C4::Search::enabled_staff_search_views,
subscriptionsnumber => ( $object ? CountSubscriptionFromBiblionumber($object) : 0 ),
object => $object,
);
if ($do_it) {
my $dtf = Koha::Database->new->schema->storage->datetime_parser;
my %search_params;
if ($datefrom and $dateto ) {
my $dateto_endday = dt_from_string($dateto);
$dateto_endday->set( # We set last second of day to see all log from that day
hour => 23,
minute => 59,
second => 59
);
$search_params{'timestamp'} = {
-between => [
$dtf->format_datetime( dt_from_string($datefrom) ),
$dtf->format_datetime( $dateto_endday ),
]
};
} elsif ($datefrom) {
$search_params{'timestamp'} = {
'>=' => $dtf->format_datetime( dt_from_string($datefrom) )
};
} elsif ($dateto) {
my $dateto_endday = dt_from_string($dateto);
$dateto_endday->set( # We set last second of day to see all log from that day
hour => 23,
minute => 59,
second => 59
);
$search_params{'timestamp'} = {
'<=' => $dtf->format_datetime( $dateto_endday )
};
}
# Circulation uses RENEWAL, but Patrons uses RENEW, this helps to find both
if ( grep { $_ eq 'RENEW'} @actions ) { push @actions, 'RENEWAL' };
$search_params{user} = $user if $user;
$search_params{module} = { -in => [ @modules ] } if ( defined $modules[0] and $modules[0] ne '' ) ;
$search_params{action} = { -in => [ @actions ] } if ( defined $actions[0] && $actions[0] ne '' );
$search_params{interface} = { -in => [ @interfaces ] } if ( defined $interfaces[0] && $interfaces[0] ne '' );
if ( @modules == 1 && $object_type eq 'biblio' ) {
# Handle 'Modification log' from cataloguing
my @itemnumbers = Koha::Items->search({ biblionumber => $object })->get_column('itemnumber');
$search_params{'-or'} = [
{ -and => { object => $object, info => { -like => 'biblio%' }}},
{ -and => { object => \@itemnumbers, info => { -like => 'item%' }}},
];
} else {
$search_params{info} = { -like => '%' . $info . '%' } if $info;
$search_params{object} = $object if $object;
}
my @logs = Koha::ActionLogs->search(\%search_params);
my @data;
foreach my $log (@logs) {
my $result = $log->unblessed;
# Init additional columns for CSV export
$result->{'biblionumber'} = q{};
$result->{'biblioitemnumber'} = q{};
$result->{'barcode'} = q{};
if ( substr( $log->info, 0, 4 ) eq 'item' || $log->module eq "CIRCULATION" ) {
# get item information so we can create a working link
my $itemnumber = $log->object;
$itemnumber = $log->info if ( $log->module eq "CIRCULATION" );
my $item = Koha::Items->find($itemnumber);
if ($item) {
$result->{'biblionumber'} = $item->biblionumber;
$result->{'biblioitemnumber'} = $item->biblionumber;
$result->{'barcode'} = $item->barcode;
}
}
#always add firstname and surname for librarian/user
if ( $log->user ) {
my $patron = Koha::Patrons->find( $log->user );
if ($patron && $output eq 'screen') {
$result->{librarian} = $patron;
}
}
#add firstname and surname for borrower, when using the CIRCULATION, MEMBERS, FINES
if ( $log->module eq "CIRCULATION" || $log->module eq "MEMBERS" || $log->module eq "FINES" ) {
if ( $log->object ) {
my $patron = Koha::Patrons->find( $log->object );
if ($patron && $output eq 'screen') {
$result->{patron} = $patron;
}
}
}
if ( $log->module eq 'NOTICES' ) {
if ( $log->object ) {
my $notice = Koha::Notice::Templates->find( { id => $log->object } );
if ($notice && $output eq 'screen') {
$result->{notice} = $notice->unblessed;
}
}
}
push @data, $result;
}
if ( $output eq "screen" ) {
# Printing results to screen
$template->param(
logview => 1,
total => scalar @data,
looprow => \@data,
do_it => 1,
datefrom => $datefrom,
dateto => $dateto,
user => $user,
info => $info,
src => $src,
modules => \@modules,
actions => \@actions,
interfaces => \@interfaces
);
# Used modules
foreach my $module (@modules) {
$template->param( $module => 1 );
}
output_html_with_http_headers $input, $cookie, $template->output;
}
else {
# Printing to a csv file
my $content = q{};
my $delimiter = C4::Context->preference('CSVDelimiter') || ',';
if (@data) {
my $csv = Text::CSV::Encoded->new( { encoding_out => 'utf8', sep_char => $delimiter } );
$csv or die "Text::CSV::Encoded->new FAILED: " . Text::CSV::Encoded->error_diag();
# First line with heading
# Exporting bd id seems useless
my @headings = grep { $_ ne 'action_id' } sort keys %{$data[0]};
if ( $csv->combine(@headings) ) {
$content .= $csv->string() . "\n";
}
# Lines of logs
foreach my $line (@data) {
my @cells = map { $line->{$_} } @headings;
if ( $csv->combine(@cells) ) {
$content .= $csv->string() . "\n";
}
}
}
# Output
print $input->header(
-type => 'text/csv',
-attachment => $basename . '.csv',
);
print $content;
}
exit;
}
else {
output_html_with_http_headers $input, $cookie, $template->output;
}