Koha/misc/maintenance/pseudonymize_statistics.pl
Nick Clemens 444f3d8bad
Bug 37181: Add --confirm option to pseudonymize_statistics.pl
To test:
1 - Perform some transactions
2 - Enable Pseudonymization
3 - perl misc/maintenance/pseudonymize_statistics.pl -v
4 - Confirm test run an nothing changed
5 - perl misc/maintenance/pseudonymize_statistics.pl -v -c
6 - Confirm statistics are pseudonymized

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Amend: tidied the changes [tcohen]
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2024-06-27 14:04:54 +02:00

133 lines
4 KiB
Perl
Executable file

#!/usr/bin/perl
# 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 Getopt::Long qw( GetOptions );
use Pod::Usage qw( pod2usage );
use Koha::DateUtils qw( dt_from_string format_sqldatetime );
use Koha::Script;
use Koha::Statistics;
use Koha::PseudonymizedTransactions;
use C4::Context;
my ( $help, $verbose, $before, $confirm );
my $result = GetOptions(
'h|help' => \$help,
'v|verbose' => \$verbose,
'b|before:s' => \$before,
'c|confirm' => \$confirm,
) || pod2usage(0);
if ($help) {
pod2usage(0);
}
unless ( C4::Context->preference('Pseudonymization') ) {
die "The system preference for Pseudonymization is not enabled, no action will be taken";
}
$before //= format_sqldatetime( dt_from_string(), 'sql', undef, 1 );
print "Searching for statistics before $before\n" if $verbose;
my $statistics = Koha::Statistics->search( { datetime => { '<=' => $before } } );
print $statistics->count() . " statistics found\n" if $verbose;
my $existing_pseudo_stats = Koha::PseudonymizedTransactions->search( { datetime => { '<=' => $before } } )->count;
if ( $statistics->count && $existing_pseudo_stats ) {
print "There are "
. $statistics->count()
. " statistics found, and $existing_pseudo_stats already in the database for the date provided.\n";
print "You may have already run this script for the time period given.\n";
print "Please enter 'Y' if you would like to continue:";
chomp( my $continue = <> );
exit unless uc($continue) eq 'Y';
}
if ( !$confirm ) {
print $statistics->count() . " statistics would have been pseudonymized\n" if $verbose;
exit 1;
}
while ( my $statistic = $statistics->next ) {
$statistic->pseudonymize();
}
print $statistics->count() . " statistics pseudonymized\n" if $verbose;
=head1 NAME
pseudonymize_statistics - This script pseudonymizes statistics before a given date, or now if no date passed.
NOTE: If patrons or items have been deleted their fields cannot be saved, additionally the fields will use current
values as the ones from when the transaction occurred are not available.
=head1 SYNOPSIS
pseudonymize_statistics.pl [-h|--help] [-v|--verbose] [-b|--before=DATE]
=head1 OPTIONS
=over
=item B<-h|--help>
Print a brief help message
=item B<-v|--verbose>
Verbose mode.
=item B<-b|--before=DATE>
This option allows for specifying a date to pseudonmyize before. Useful if you have enabled pseudonymization and want to pseudonymize transactions before that date. If not passed all statistics before current time will be pseudonymized.
=item B<-c|--confirm>
Without this parameter the script will be run in test mode and no changes will be made.
=back
=head1 AUTHOR
Nick Clemens <nick@bywatersolutions.com>
=head1 COPYRIGHT
Copyright 2023 ByWater Solutions
=head1 LICENSE
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>.
=cut