misc/cronjobs/delete_items.pl

   1 #! /usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19
  20 use Getopt::Long qw( GetOptions );
  21 use Pod::Usage qw( pod2usage );
  22
  23 use Koha::Script -cron;
  24
  25 use C4::Context;
  26 use Koha::Items;
  27
  28 my $dbh = C4::Context->dbh();
  29
  30 my $query = {
  31     target_items => q|SELECT itemnumber, biblionumber from items|
  32 };
  33
  34 my $GLOBAL = {
  35       query => $query
  36     , sth   => {}
  37 };
  38
  39 my $OPTIONS = {
  40       where => []
  41     , flags    => {
  42             verbose   => ''
  43           , commit    => ''
  44           , help      => ''
  45           , manual    => ''
  46           , version   => ''
  47       }
  48 };
  49
  50 GetOptions(
  51       'where=s'    => $OPTIONS->{where}
  52     , 'v|verbose'  => sub { $OPTIONS->{flags}->{verbose}   = 1 }
  53     , 'V|version'  => sub { $OPTIONS->{flags}->{version}   = 1 }
  54     , 'h|help'     => sub { $OPTIONS->{flags}->{help}      = 1 }
  55     , 'm|manual'   => sub { $OPTIONS->{flags}->{manual}    = 1 }
  56     , 'c|commit'   => sub { $OPTIONS->{flags}->{commit}    = 1 } # aka DO-EET!
  57 );
  58
  59 my @where = @{ $OPTIONS->{where} };
  60
  61 pod2usage( -verbose => 2 ) if  $OPTIONS->{flags}->{manual};
  62 pod2usage( -verbose => 1 ) if  $OPTIONS->{flags}->{help};
  63 pod2usage( -verbose => 1 -msg => 'You must supply at least one --where option' ) if scalar @where == 0;
  64
  65 sub verbose {
  66     say @_ if $OPTIONS->{flags}->{verbose};
  67 }
  68
  69 my $where_clause = ' where ' . join ( " and ", @where );
  70
  71 verbose "Where statement: $where_clause";
  72
  73 # FIXME Use Koha::Items instead
  74 $GLOBAL->{sth}->{target_items} = $dbh->prepare( $query->{target_items} . $where_clause  );
  75 $GLOBAL->{sth}->{target_items}->execute();
  76
  77 DELITEM: while ( my $item = $GLOBAL->{sth}->{target_items}->fetchrow_hashref() ) {
  78
  79     my $item_object = Koha::Items->find($item->{itemnumber});
  80     my $safe_to_delete = $item_object->safe_to_delete;
  81     if( $safe_to_delete )  {
  82         $item_object->safe_delete
  83             if $OPTIONS->{flags}->{commit};
  84         verbose "Deleting '$item->{itemnumber}'";
  85     } else {
  86         verbose sprintf "Item '%s' not deleted: %s", $item->{itemnumber}, @{$safe_to_delete->messages}[0]->message
  87     }
  88 }
  89
  90 =head1 NAME
  91
  92 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.
  93
  94 =head1 SYNOPSIS
  95
  96 delete_items.pl [--help|--manual]
  97
  98 delete_items.pl [--verbose] --where "I<SQL CONDITIONAL EXPRESSION>" ... [--commit]
  99
 100 =cut
 101
 102 =head1 OPTIONS
 103
 104 =over 8
 105
 106 =item B<--help>
 107
 108 Show the brief help information.
 109
 110 =item B<--manual>
 111
 112 Read the manual, with examples.
 113
 114 =item B<--verbose>
 115
 116 Send the "WHERE" clause generated by the collected C<--where>
 117 arguments, as well as items affected to Standard Out.
 118
 119 =item B<--where>
 120
 121 The C<--where> option may called multiple times. The following argument
 122 must be a syntactically valid SQL statement which is part of the C<WHERE>
 123 clause querying the items table. These are joined by C<AND>.
 124
 125 =item B<--commit>
 126
 127 No items will be deleted unless the C<--commit> flag is present.
 128
 129 =back
 130
 131 =cut
 132
 133
 134 =head1 EXAMPLES
 135
 136   The following is an example of this script:
 137
 138  delete_items.pl --where "items.withdrawn ! 0"  --where "items.withdrawn_on < $(date --date="13 month ago" --rfc-3339=date)" --commit
 139
 140  delete_items.pl --where "itemlost >= '1'" --where "itemlost <='4'" --where "itemlost_on < '2014-04-28'" --commit
 141
 142 =cut
 143
 144
 145 =head1 DESCRIPTION
 146
 147  This is a lightweight batch deletion tool for items, suitable for running in a cron job.
 148
 149 =cut
 150
 151
 152 =head1 AUTHOR
 153
 154  Barton Chittenden <barton@bywatersolutions.com>
 155
 156 =cut