From e58346a6687a04187c1d348c9756b24a873653d4 Mon Sep 17 00:00:00 2001 From: Bill Erickson Date: Mon, 11 Jul 2022 16:42:20 -0400 Subject: [PATCH] LP1944986 Patron penalty batch updater script Signed-off-by: Bill Erickson Signed-off-by: Mike Rylander Signed-off-by: Elizabeth Davis --- .../src/support-scripts/patron-penalties-batch.pl | 315 +++++++++++++++++++++ 1 file changed, 315 insertions(+) create mode 100755 Open-ILS/src/support-scripts/patron-penalties-batch.pl diff --git a/Open-ILS/src/support-scripts/patron-penalties-batch.pl b/Open-ILS/src/support-scripts/patron-penalties-batch.pl new file mode 100755 index 0000000000..c187fc0bfd --- /dev/null +++ b/Open-ILS/src/support-scripts/patron-penalties-batch.pl @@ -0,0 +1,315 @@ +#!/usr/bin/perl +# --------------------------------------------------------------- +# Copyright (C) 2022 King County Library System +# Author: Bill Erickson +# +# This program 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 2 +# of the License, or (at your option) any later version. +# +# This program 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. +# --------------------------------------------------------------- +use strict; +use warnings; +use Getopt::Long; +use OpenSRF::System; +use OpenSRF::AppSession; +use OpenSRF::Utils::SettingsClient; +use OpenILS::Utils::Fieldmapper; +use OpenSRF::Utils::Logger q/$logger/; +use OpenILS::Utils::CStoreEditor; +use OpenILS::Application::AppUtils; + +my $U = 'OpenILS::Application::AppUtils'; +$ENV{OSRF_LOG_CLIENT} = 1; + +my $osrf_config = '/openils/conf/opensrf_core.xml'; +my $ids_file; +my $process_as = 'admin'; +my $min_id = 0; +my $max_id; +my $has_open_circ = 0; +my $owes_more_than; +my $owes_less_than; +my $verbose; +my $help; +my $batch_size = 100; +my $authtoken; + +my $ops = GetOptions( + 'osrf-config=s' => \$osrf_config, + 'ids-file=s' => \$ids_file, + 'process-as=s' => \$process_as, + 'min-id=s' => \$min_id, + 'max-id=s' => \$max_id, + 'has-open-circ' => \$has_open_circ, + 'owes-more-than=s' => \$owes_more_than, + 'owes-less-than=s' => \$owes_less_than, + 'verbose' => \$verbose, + 'help' => \$help +); + +sub help { + print < + Username of an Evergreen account to use for creating the + internal auth session. Defaults to 'admin'. + + --min-id + Lowest patron ID to process. + + --max-id + Highest patron ID to process. + + Together with --min-id, these are useful for running parallel + batches of this script without overlapping and/or processing + chunks of a controlled size. + + --has-open-circ + Limit to patrons that have at least on open circulation. + For simplicity, "open" in this context means null xact finish. + + --owes-more-than + Limit to patrons who have an outstanding balance greater than + the specified amount. + + --owes-less-than + Limit to patrons who have an outstanding balance less than + the specified amount. + + --verbose + Log debug info to STDOUT. This script logs various information + via \$logger regardless of this option. + + --help + Show this message. +HELP + exit 0; +} + +help() if $help or !$ops; + +# $lvl should match a $logger logging function. E.g. 'info', 'error', etc. +sub announce { + my $lvl = shift; + my $msg = shift; + $logger->$lvl($msg); + + # always announce errors and warnings + return unless $verbose || $lvl =~ /error|warn/; + + my $date_str = DateTime->now(time_zone => 'local')->strftime('%F %T'); + print "$date_str $msg\n"; +} + +# connect to osrf... +OpenSRF::System->bootstrap_client(config_file => $osrf_config); +Fieldmapper->import(IDL => + OpenSRF::Utils::SettingsClient->new->config_value("IDL")); +OpenILS::Utils::CStoreEditor::init(); +my $e = OpenILS::Utils::CStoreEditor->new; + +sub get_user_ids { + my ($limit, $offset) = @_; + + if ($ids_file) { + + open(IDS_FILE, '<', $ids_file) + or die "Cannot open user IDs file: $ids_file: $!\n"; + + my @ids = ; + + chomp @ids; + + @ids = grep { defined $_ } @ids[$offset..($offset + $limit)]; + + return \@ids; + } + + my $query = { + select => { + au => ['id'], + mus => ['balance_owed'] + }, + from => { + au => { + mus => { + type => 'left', + field => 'usr', + fkey => 'id' + } + } + }, + limit => $limit, + offset => $offset, + order_by => [{class => 'au', field => 'id'}] + }; + + my @where = ({'+au' => {deleted => 'f'}}); + + if (defined $max_id) { + + push(@where, { + '+au' => { # min_id defaults to 0. + id => {between => [$min_id, $max_id]} + } + }); + + } elsif (defined $min_id) { + + push(@where, { + '+au' => { + # min_id defaults to 0. + id => {'>' => $min_id} + } + }); + } + + # For owes more / less, there is a special case because not all + # patrons have a money.usr_summary row. If they don't, they + # effectively owe $0.00. + + if (defined $owes_more_than) { + + if ($owes_more_than > 0) { + + push(@where, { + '+mus' => { + balance_owed => {'>' => $owes_more_than} + } + }); + + } else { + push(@where, { + '-or' => [{ + '+mus' => { + balance_owed => {'>' => $owes_more_than} + }, + }, { + '+mus' => { + usr => undef # owes $0.00 + } + }] + }); + } + } + + if (defined $owes_less_than) { + + if ($owes_less_than < 0) { + push(@where, { + '+mus' => { + balance_owed => {'<' => $owes_less_than} + } + }) if $owes_less_than; + + } else { + + push(@where, { + '-or' => [{ + '+mus' => { + balance_owed => {'<' => $owes_less_than} + }, + }, { + '+mus' => { + usr => undef # owes $0.00 + } + }] + }); + } + } + + push(@where, { + '-exists' => { + select => {circ => ['id']}, + from => 'circ', + where => { + usr => {'=' => {'+au' => 'id'}}, + xact_finish => undef + }, + limit => 1 + } + }) if $has_open_circ; + + $query->{where}->{'-and'} = \@where; + + my $resp = $e->json_query($query); + + return [map {$_->{id}} @$resp]; +} + +sub process_users { + + my $limit = $batch_size; + my $offset = 0; + my $counter = 0; + my $batches = 0; + + while (1) { + my $user_ids = get_user_ids($limit, $offset); + + my $num = scalar(@$user_ids); + + last unless $num; + + $batches++; + + announce('debug', + "Processing batch $batches with $num patrons and offset $offset."); + + for my $user_id (@$user_ids) { + + $U->simplereq( + 'open-ils.actor', + 'open-ils.actor.user.penalties.update', + $authtoken, $user_id + ); + + $counter++; + } + + $offset += $batch_size; + announce('debug', "$counter patrons processed."); + } + + announce('debug', "$counter total patrons processed."); +} + +sub login { + + my $auth_user = $e->search_actor_user( + {usrname => $process_as, deleted => 'f'})->[0]; + + die "No such user '$process_as' to use for authentication\n" unless $auth_user; + + my $auth_resp = $U->simplereq( + 'open-ils.auth_internal', + 'open-ils.auth_internal.session.create', + {user_id => $auth_user->id, login_type => 'staff'} + ); + + die "Could not create an internal auth session\n" unless ( + $auth_resp && + $auth_resp->{payload} && + ($authtoken = $auth_resp->{payload}->{authtoken}) + ); +} + +login(); +process_users(); + -- 2.11.0