Jonathan Druart
9d6d641d1f
On bug 17591 we discovered that there was something weird going on with the way we export and use subroutines/modules. This patch tries to standardize our EXPORT to use EXPORT_OK only. That way we will need to explicitely define the subroutine we want to use from a module. This patch is a squashed version of: Bug 17600: After export.pl Bug 17600: After perlimport Bug 17600: Manual changes Bug 17600: Other manual changes after second perlimports run Bug 17600: Fix tests And a lot of other manual changes. export.pl is a dirty script that can be found on bug 17600. "perlimport" is: git clone https://github.com/oalders/App-perlimports.git cd App-perlimports/ cpanm --installdeps . export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib" find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \; The ideas of this patch are to: * use EXPORT_OK instead of EXPORT * perltidy the EXPORT_OK list * remove '&' before the subroutine names * remove some uneeded use statements * explicitely import the subroutines we need within the controllers or modules Note that the private subroutines (starting with _) should not be exported (and not used from outside of the module except from tests). EXPORT vs EXPORT_OK (from https://www.thegeekstuff.com/2010/06/perl-exporter-examples/) """ Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members. @EXPORT and @EXPORT_OK are the two main variables used during export operation. @EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace. @EXPORT_OK does export of symbols on demand basis. """ If this patch caused a conflict with a patch you wrote prior to its push: * Make sure you are not reintroducing a "use" statement that has been removed * "$subroutine" is not exported by the C4::$MODULE module means that you need to add the subroutine to the @EXPORT_OK list * Bareword "$subroutine" not allowed while "strict subs" means that you didn't imported the subroutine from the module: - use $MODULE qw( $subroutine list ); You can also use the fully qualified namespace: C4::$MODULE::$subroutine Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
138 lines
3.3 KiB
Perl
Executable file
138 lines
3.3 KiB
Perl
Executable file
#! /usr/bin/perl
|
|
|
|
use Getopt::Long qw( GetOptions );
|
|
|
|
use Koha::Script -cron;
|
|
use C4::Context;
|
|
use Modern::Perl;
|
|
use Pod::Usage qw( pod2usage );
|
|
|
|
my $dbh = C4::Context->dbh();
|
|
|
|
my $query = {
|
|
target_items => q|SELECT itemnumber, biblionumber from items|
|
|
};
|
|
|
|
my $GLOBAL = {
|
|
query => $query
|
|
, sth => {}
|
|
};
|
|
|
|
my $OPTIONS = {
|
|
where => []
|
|
, flags => {
|
|
verbose => ''
|
|
, commit => ''
|
|
, help => ''
|
|
, manual => ''
|
|
, version => ''
|
|
}
|
|
};
|
|
|
|
GetOptions(
|
|
'where=s' => $OPTIONS->{where}
|
|
, 'v|verbose' => sub { $OPTIONS->{flags}->{verbose} = 1 }
|
|
, 'V|version' => sub { $OPTIONS->{flags}->{version} = 1 }
|
|
, 'h|help' => sub { $OPTIONS->{flags}->{help} = 1 }
|
|
, 'm|manual' => sub { $OPTIONS->{flags}->{manual} = 1 }
|
|
, 'c|commit' => sub { $OPTIONS->{flags}->{commit} = 1 } # aka DO-EET!
|
|
);
|
|
|
|
my @where = @{ $OPTIONS->{where} };
|
|
|
|
pod2usage( -verbose => 2 ) if $OPTIONS->{flags}->{manual};
|
|
pod2usage( -verbose => 1 ) if $OPTIONS->{flags}->{help};
|
|
pod2usage( -verbose => 1 -msg => 'You must supply at least one --where option' ) if scalar @where == 0;
|
|
|
|
sub verbose {
|
|
say @_ if $OPTIONS->{flags}->{verbose};
|
|
}
|
|
|
|
my $where_clause = ' where ' . join ( " and ", @where );
|
|
|
|
verbose "Where statement: $where_clause";
|
|
|
|
# FIXME Use Koha::Items instead
|
|
$GLOBAL->{sth}->{target_items} = $dbh->prepare( $query->{target_items} . $where_clause );
|
|
$GLOBAL->{sth}->{target_items}->execute();
|
|
|
|
DELITEM: while ( my $item = $GLOBAL->{sth}->{target_items}->fetchrow_hashref() ) {
|
|
|
|
my $item_object = Koha::Items->find($item->{itemnumber});
|
|
my $safe_to_delete = $item_object->safe_to_delete;
|
|
if( $safe_to_delete eq '1' ) {
|
|
$item_object->safe_delete
|
|
if $OPTIONS->{flags}->{commit};
|
|
verbose "Deleting '$item->{itemnumber}'";
|
|
} else {
|
|
verbose "Item '$item->{itemnumber}' not deleted: $safe_to_delete";
|
|
}
|
|
}
|
|
|
|
=head1 NAME
|
|
|
|
delete_items.pl - A batch item deletion tool, which generates a query against the items database and deletes the items matching the criteria specified in the command line arguments.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
delete_items.pl [--help|--manual]
|
|
|
|
delete_items.pl [--verbose] --where "I<SQL CONDITIONAL EXPRESSION>" ... [--commit]
|
|
|
|
=cut
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 8
|
|
|
|
=item B<--help>
|
|
|
|
Show the brief help information.
|
|
|
|
=item B<--manual>
|
|
|
|
Read the manual, with examples.
|
|
|
|
=item B<--verbose>
|
|
|
|
Send the "WHERE" clause generated by the collected C<--where>
|
|
arguments, as well as items affected to Standard Out.
|
|
|
|
=item B<--where>
|
|
|
|
The C<--where> option may called multiple times. The following argument
|
|
must be a syntactically valid SQL statement which is part of the C<WHERE>
|
|
clause querying the items table. These are joined by C<AND>.
|
|
|
|
=item B<--commit>
|
|
|
|
No items will be deleted unless the C<--commit> flag is present.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following is an example of this script:
|
|
|
|
delete_items.pl --where "items.withdrawn ! 0" --where "items.withdrawn_on < $(date --date="13 month ago" --rfc-3339=date)" --commit
|
|
|
|
delete_items.pl --where "itemlost >= '1'" --where "itemlost <='4'" --where "itemlost_on < '2014-04-28'" --commit
|
|
|
|
=cut
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This is a lightweight batch deletion tool for items, suitable for running in a cron job.
|
|
|
|
=cut
|
|
|
|
|
|
=head1 AUTHOR
|
|
|
|
Barton Chittenden <barton@bywatersolutions.com>
|
|
|
|
=cut
|