Compare commits
12 Commits
031dd035ab
...
65542edbe0
| Author | SHA1 | Date |
|---|---|---|
 Tomás Cohen Arazi
|
65542edbe0 | 3 years ago |
|
Tomás Cohen Arazi
|
90291914f9 | 3 years ago |
 Kyle Hall
|
14d843f5f4 | 3 years ago |
 Jonathan Druart
|
48ac552699 | 4 years ago |
Pasi Kallinen
|
ba5be802e0 | 4 years ago |
|
Kyle Hall
|
925eecd6bd | 3 years ago |
 Martin Renvoize
|
ac7f878959 | 3 years ago |
|
Martin Renvoize
|
58ec862da2 | 4 years ago |
Séverine QUEUNE
|
3c6e7ec55d | 3 years ago |
|
Jonathan Druart
|
a10d45ea18 | 3 years ago |
|
Jonathan Druart
|
611d3aa483 | 3 years ago |
|
Martin Renvoize
|
7c854a87d2 | 3 years ago |
17 changed files with 495 additions and 160 deletions
@ -0,0 +1,82 @@ |
|||
<article xmlns='http://docbook.org/ns/docbook'> |
|||
<title>koha-worker</title> |
|||
<info> |
|||
<productname>Koha</productname> is the first free software library automation package. |
|||
<author> |
|||
<orgname>The Koha Community</orgname> |
|||
<uri>https://koha-community.org/</uri> |
|||
</author> |
|||
</info> |
|||
|
|||
<refentry xml:id="koha-worker"> |
|||
|
|||
<refmeta> |
|||
<refentrytitle>koha-worker</refentrytitle> |
|||
<manvolnum>8</manvolnum> |
|||
</refmeta> |
|||
|
|||
<refnamediv> |
|||
<refname>koha-worker</refname> |
|||
<refpurpose>Handle worker daemon for named Koha instances.</refpurpose> |
|||
<refclass>UNIX/Linux</refclass> |
|||
</refnamediv> |
|||
|
|||
<refsynopsisdiv> |
|||
<cmdsynopsis> |
|||
<command>koha-worker</command> |
|||
<arg><option>--start</option>|<option>--stop</option>|<option>--restart</option></arg> |
|||
<arg><option>--status</option></arg> |
|||
<arg><option>--quiet</option>|<option>-q</option></arg> |
|||
<arg><option>-h</option>|<option>--help</option></arg> |
|||
</cmdsynopsis> |
|||
</refsynopsisdiv> |
|||
|
|||
<refsect1><title>Options</title> |
|||
<para>All option switches are mutually exclusive</para> |
|||
<variablelist> |
|||
<varlistentry> |
|||
<term><option>--start</option></term> |
|||
<listitem> |
|||
<para>Start worker daemon for named Koha instances.</para> |
|||
</listitem> |
|||
</varlistentry> |
|||
<varlistentry> |
|||
<term><option>--stop</option></term> |
|||
<listitem> |
|||
<para>Stop worker daemon for named Koha instances.</para> |
|||
</listitem> |
|||
</varlistentry> |
|||
<varlistentry> |
|||
<term><option>--restart</option></term> |
|||
<listitem> |
|||
<para>Restart worker daemon for named Koha instances.</para> |
|||
</listitem> |
|||
</varlistentry> |
|||
<varlistentry> |
|||
<term><option>--status</option></term> |
|||
<listitem> |
|||
<para>Show status information about worker daemon for named Koha instances.</para> |
|||
</listitem> |
|||
</varlistentry> |
|||
<varlistentry> |
|||
<term><option>-v</option>|<option>--verbose</option></term> |
|||
<listitem> |
|||
<para>Enable verbose output.</para> |
|||
</listitem> |
|||
</varlistentry> |
|||
<varlistentry> |
|||
<term><option>-h</option>|<option>--help</option></term> |
|||
<listitem> |
|||
<para>This help.</para> |
|||
</listitem> |
|||
</varlistentry> |
|||
</variablelist> |
|||
</refsect1> |
|||
|
|||
<refsect1><title>Description</title> |
|||
<para>This script handles worker daemons for Koha instances.</para> |
|||
</refsect1> |
|||
|
|||
</refentry> |
|||
|
|||
</article> |
|||
@ -0,0 +1,208 @@ |
|||
#!/usr/bin/perl |
|||
|
|||
use Modern::Perl; |
|||
use feature 'say'; |
|||
|
|||
use Getopt::Long; |
|||
use Pod::Usage; |
|||
|
|||
use Koha::Account::Lines; |
|||
use Koha::DateUtils; |
|||
|
|||
use Koha::Script -cron; |
|||
|
|||
my ( $help, $verbose, @type, $added, $file, $confirm ); |
|||
GetOptions( |
|||
'h|help' => \$help, |
|||
'v|verbose+' => \$verbose, |
|||
't|type:s' => \@type, |
|||
'ab|added_before:s' => \$added, |
|||
'f|file:s' => \$file, |
|||
'c|confirm' => \$confirm, |
|||
); |
|||
@type = split( /,/, join( ',', @type ) ); |
|||
|
|||
pod2usage(1) if ( $help || !$confirm && !$verbose || !$file && !@type && !$added ); |
|||
|
|||
my $where = { 'amountoutstanding' => { '>' => 0 } }; |
|||
my $attr = {}; |
|||
|
|||
if ($file) { |
|||
my @accounts_from_file; |
|||
open( my $fh, '<:encoding(UTF-8)', $file ) |
|||
or die "Could not open file '$file' $!"; |
|||
while ( my $line = <$fh> ) { |
|||
chomp($line); |
|||
push @accounts_from_file, $line; |
|||
} |
|||
close($fh); |
|||
$where->{accountlines_id} = { '-in' => \@accounts_from_file }; |
|||
} |
|||
|
|||
if (@type) { |
|||
$where->{debit_type_code} = \@type; |
|||
} |
|||
|
|||
if ($added) { |
|||
my $added_before = dt_from_string( $added, 'iso' ); |
|||
my $dtf = Koha::Database->new->schema->storage->datetime_parser; |
|||
$where->{date} = { '<' => $dtf->format_datetime($added_before) }; |
|||
} |
|||
|
|||
my $lines = Koha::Account::Lines->search( $where, $attr ); |
|||
if ( $verbose ) { |
|||
print "Attempting to write off " . $lines->count . " debts"; |
|||
print " of type " . join(',',@type) if @type; |
|||
print " added before " . $added if $added; |
|||
print " from the passed list" if $file; |
|||
print "\n"; |
|||
} |
|||
|
|||
while ( my $line = $lines->next ) { |
|||
say "Skipping " . $line->accountlines_id . "; Not a debt" and next |
|||
if $line->is_credit && $verbose > 1; |
|||
say "Skipping " . $line->accountlines_id . "; Is a PAYOUT" and next |
|||
if $line->debit_type_code eq 'PAYOUT' && $verbose > 1; |
|||
|
|||
if ($confirm) { |
|||
$line->_result->result_source->schema->txn_do( |
|||
sub { |
|||
|
|||
# A 'writeoff' is a 'credit' |
|||
my $writeoff = Koha::Account::Line->new( |
|||
{ |
|||
date => \'NOW()', |
|||
amount => 0 - $line->amount, |
|||
credit_type_code => 'WRITEOFF', |
|||
status => 'ADDED', |
|||
amountoutstanding => 0 - $line->amount, |
|||
manager_id => undef, |
|||
borrowernumber => $line->borrowernumber, |
|||
interface => 'intranet', |
|||
branchcode => undef, |
|||
} |
|||
)->store(); |
|||
|
|||
my $writeoff_offset = Koha::Account::Offset->new( |
|||
{ |
|||
credit_id => $writeoff->accountlines_id, |
|||
type => 'WRITEOFF', |
|||
amount => $line->amount |
|||
} |
|||
)->store(); |
|||
|
|||
# Link writeoff to charge |
|||
$writeoff->apply( |
|||
{ |
|||
debits => [$line], |
|||
offset_type => 'WRITEOFF' |
|||
} |
|||
); |
|||
$writeoff->status('APPLIED')->store(); |
|||
|
|||
# Update status of original debit |
|||
$line->status('FORGIVEN')->store; |
|||
} |
|||
); |
|||
} |
|||
|
|||
if ($verbose) { |
|||
if ($confirm) { |
|||
say "Accountline " . $line->accountlines_id . " written off"; |
|||
} |
|||
else { |
|||
say "Accountline " . $line->accountlines_id . " will be written off"; |
|||
} |
|||
} |
|||
} |
|||
|
|||
exit(0); |
|||
|
|||
__END__ |
|||
|
|||
=head1 NAME |
|||
|
|||
writeoff_debts.pl |
|||
|
|||
=head1 SYNOPSIS |
|||
|
|||
./writeoff_debts.pl --added_before DATE --type OVERDUE --file REPORT --confirm |
|||
|
|||
This script batch waives debts. |
|||
|
|||
The options to select the debt records to writeoff are cumulative. For |
|||
example, supplying both --added_before and --type specifies that the |
|||
accountline must meet both conditions to be selected for writeoff. |
|||
|
|||
You must pass at least one of the filtering options for the script to run. |
|||
This is to prevent an accidental 'writeoff all' operation. |
|||
|
|||
=head1 OPTIONS |
|||
|
|||
=over |
|||
|
|||
=item B<-h|--help> |
|||
|
|||
Prints this help message |
|||
|
|||
=item B<--added_before> |
|||
|
|||
Writeoff debts added before the date passed. |
|||
|
|||
Dates should be in ISO format, e.g., 2013-07-19, and can be generated |
|||
with `date -d '-3 month' --iso-8601`. |
|||
|
|||
=item B<--type> |
|||
|
|||
Writeoff debts of the passed type. Accepts a list of CREDIT_TYPE_CODEs. |
|||
|
|||
=item B<--file> |
|||
|
|||
Writeoff debts passed as one accountlines_id per line in this file. If other |
|||
criteria are defined it will only writeoff those in the file that match those |
|||
criteria. |
|||
|
|||
=item B<-v|--verbose> |
|||
|
|||
This flag set the script to output logging for the actions it will perform. |
|||
|
|||
=item B<-c|--confirm> |
|||
|
|||
This flag must be provided in order for the script to actually |
|||
writeoff debts. If it is not supplied, the script will |
|||
only report on the accountline records it would have been written off. |
|||
|
|||
=back |
|||
|
|||
=head1 AUTHOR |
|||
|
|||
Martin Renvoize <martin.renvoize@ptfs-europe.com> |
|||
|
|||
=head1 COPYRIGHT |
|||
|
|||
Copyright 2020 PTFS Europe |
|||
|
|||
=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>. |
|||
|
|||
=head1 DISCLAIMER OF WARRANTY |
|||
|
|||
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. |
|||
|
|||
=cut |
|||
Loading…
Reference in new issue