Bug 17600: Standardize our EXPORT_OK
[srvgit] / misc / migration_tools / remove_unused_authorities.pl
index fbeee78..da57f88 100755 (executable)
 #
 # 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 2 of the License, or (at your option) any later
-# version.
+# 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.
+# 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, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
-use strict;
-use warnings;
+use Modern::Perl;
 
+use Koha::Script;
 use C4::Context;
 use C4::AuthoritiesMarc;
-use Getopt::Long;
+use Getopt::Long qw( GetOptions );
 
-my ($test,@authtypes);
-my $want_help = 0;
+use Koha::SearchEngine::Search;
+
+my @authtypes;
+my ($confirm, $test, $want_help);
 GetOptions(
-    'aut|authtypecode:s'    => \@authtypes,
-    't'    => \$test,
-    'h|help'        => \$want_help
+    'aut|authtypecode:s' => \@authtypes,
+    'c|confirm'          => \$confirm,
+    't|test'             => \$test,
+    'h|help'             => \$want_help,
 );
 
-if ($want_help) {
+if ( $want_help || !($test || $confirm) ) {
     print_usage();
     exit 0;
 }
+if ($test) {
+    print "*** Testing only, authorities will not be deleted. ***\n";
+}
+if (@authtypes) {
+    print "Restricted to authority type(s) : ".join(',', @authtypes).".\n";
+}
+
+my $searcher = Koha::SearchEngine::Search->new( { index => 'biblios' } );
+my $checksearch;
+if ( C4::Context->preference("SearchEngine") eq 'Zebra' ) {
+    # Check server state
+    my $errZebraConnection = C4::Context->Zconn("biblioserver",0)->errcode();
+    if ( $errZebraConnection == 10000 ) {
+        die "Zebra server seems not to be available. This script needs Zebra runs.";
+    } elsif ( $errZebraConnection ) {
+        die "Error from Zebra: $errZebraConnection";
+    }
+    $checksearch = q{an,alwaysmatches=''};
+}
+else {
+    $checksearch = q{an:*};
+}
+# Check search on authority number as at least one result
+my ($err,$res,$nb) = $searcher->simple_search_compat($checksearch,0,10);
+unless ($nb > 0) {
+    die "Searching authority number in biblio records seems not to be available : $checksearch";
+}
 
 my $dbh=C4::Context->dbh;
-@authtypes or @authtypes = qw( NC );
-my $thresholdmin=0;
-my $thresholdmax=0;
-my @results;
 # prepare the request to retrieve all authorities of the requested types
-my $rqselect = $dbh->prepare(
-    qq{SELECT * from auth_header where authtypecode IN (}
-    . join(",",map{$dbh->quote($_)}@authtypes)
-    . ")"
-);
+my $rqsql = q{ SELECT authid,authtypecode FROM auth_header };
+$rqsql .= q{ WHERE authtypecode IN (}.join(',',map{ '?' }@authtypes).')' if @authtypes;
+my $rqselect = $dbh->prepare($rqsql);
 $|=1;
 
-$rqselect->execute;
+$rqselect->execute(@authtypes);
 my $counter=0;
 my $totdeleted=0;
 my $totundeleted=0;
 while (my $data=$rqselect->fetchrow_hashref){
-    my $query;
-    $query= "an=".$data->{'authid'};
+    $counter++;
+    print 'authid='.$data->{'authid'};
+    print ' type='.$data->{'authtypecode'};
+    my $bibliosearch = 'an:'.$data->{'authid'};
     # search for biblios mapped
-    my ($err,$res,$used) = C4::Search::SimpleSearch($query,0,10);
+    my ($err,$res,$used) = $searcher->simple_search_compat($bibliosearch,0,10);
     if (defined $err) {
-        warn "error: $err on search $query\n";
+        print "\n";
+        warn "Error: $err on search for biblios $bibliosearch\n";
         next;
     }
-    print ".";
-    print "$counter\n" unless $counter++ % 100;
-    # if found, delete, otherwise, just count
-    if ($used>=$thresholdmin and $used<=$thresholdmax){
-        DelAuthority($data->{'authid'}) unless $test;
+    unless ($used > 0){
+        unless ($test) {
+            DelAuthority({ authid => $data->{'authid'}, skip_merge => 1 });
+            print " : deleted";
+        } else {
+            print " : can be deleted";
+        }
         $totdeleted++;
     } else {
         $totundeleted++;
+        print " : used $used time(s)";
     }
+    print "\n";
 }
 
-print "$counter authorities parsed, $totdeleted deleted and $totundeleted unchanged because used\n";
-
+print "$counter authorities parsed\n";
+unless ($test) {
+    print "$totdeleted deleted because unused\n";
+} else {
+    print "$totdeleted can be deleted because unused\n";
+}
+print "$totundeleted unchanged because used\n";
 
 sub print_usage {
     print <<_USAGE_;
-$0: Removes unused authorities.
+$0: Remove unused authority records
+
+This script removes authority records that do not have any biblio
+records attached to them.
+
+If the --aut option is supplied, only authority records of that
+particular type will be checked for usage.  --aut can be repeated.
+
+If --aut is not supplied, all authority records will be checked.
+
+Use --confirm Confirms you want to really run this script, otherwise prints this help.
+
+Use --test to perform a test run.  This script does not ask the
+operator to confirm the deletion of each authority record.
 
-This script will parse all authoritiestypes given as parameter, and remove authorities without any biblio attached.
-warning : there is no individual confirmation !
 parameters
     --aut|authtypecode TYPE       the list of authtypes to check
-    --t|test                      test mode, don't delete really, just count
+    --confirm or -c               confirm running of script
+    --test or -t                  test mode, don't delete really, just count
     --help or -h                  show this message.
 
 _USAGE_