47f5858239163e7b369d435514f35f1d020c8918
[migration-tools.git] / compress_fingerprints
1 #!/usr/bin/perl
2 use strict;
3 use warnings;
4 use open ':utf8';
5
6 use Digest::SHA1 qw(sha1_base64);
7 use Getopt::Long;
8
9 my $conf  = {}; # configuration hashref
10 initialize($conf);
11
12 my %fps  = (); # records matching each fingerprint (and the lead)
13 my %recs = (); # fingerprints belonging to each record
14 my $lastscore = 0; # previous fingerprint's score
15
16 open FP, '<', $ARGV[0] or die "Can't open input file: $!\n";
17
18 print "Loading and ranking fingerprints\n";
19 while (<FP>) {
20     my @fields = split "\t", $_;
21     my $fp = populate_fingerprint(@fields);
22     rank_fingerprint($fp);
23 }
24 print "Writing matchset to disk\n";
25 dump_records();
26
27
28
29 sub populate_fingerprint {
30     my @fields = @_;
31     my %fp = (); # zero fingerprint hash each time thru
32
33     # populate fp hash -- first the simple data
34     $fp{compact} = shift @fields;
35     $fp{json}    = shift @fields;
36     $fp{id}      = shift @fields;
37     # then smash everything else together, remove non-Roman characters, and
38     # generate a SHA1 hash to represent it
39     my $stripped = join('', @fields);
40     $stripped   =~ s/[^A-Za-z0-9]//g;
41     $fp{sha1}    = sha1_base64($stripped);
42
43     # make sure file is sorted properly
44     if ($lastscore and $fp{compact} > $lastscore) {
45         print "Input file is sorted improperly or unsorted.\n";
46         die "Sort descending (sort -ru) and rerun this script.\n";
47     }
48     $lastscore = $fp{compact};
49
50     # populate records hash
51     $recs{ $fp{id} }{ $fp{sha1} } = {};
52
53     return \%fp;
54 }
55
56
57 sub rank_fingerprint {
58     my ($fp) = @_;
59
60     my $sha1 = $fp->{sha1};
61     my $id   = $fp->{id};
62
63     # only process records which haven't already been seen
64     unless (defined $recs{$id}{lead}) {
65         unless ($fps{$sha1}) {
66             # haven't seen this fp before. create a new hashref with the current
67             # record as lead
68             $fps{$sha1} = { lead => { id    => $id,
69                                       score => $fp->{compact} },
70                             recs => [ $id ] };
71             $recs{$id}{lead} = 1;
72         } else {
73             # have seen this fp. push record id onto matchlist
74             push @{ $fps{$sha1}{recs} }, $id;
75             if ($fp->{compact} > $fps{$sha1}{lead}{score}) {
76                 # and set this record as lead if it scores higher than current lead
77                 $recs{ $fps{$sha1}{lead}{id} }{lead} = 0; # unset current
78                 $recs{ $id }{lead} = 1;                   # set new as lead
79                 $fps{$sha1}{lead}{id}    = $id;
80                 $fps{$sha1}{lead}{score} = $fp->{compact};
81             } else {
82                 # otherwise, mark it as a sub so it never gets processed again
83                 $recs{$id}{lead} = 0;                
84             }
85         }
86     }
87 }
88
89
90 =head2 dump_records
91
92 Writes out a 2-column file of lead and subordinate records.
93
94 =cut
95
96 sub dump_records {
97     my %used = ();
98     open OUT, '>', $conf->{output}
99       or die "Can't open ", $conf->{output}, "$!\n";
100     for my $id (keys %recs) {
101         next unless $recs{$id}{lead};
102         $used{$id} = 1;
103         for my $sha1 ( keys %{$recs{$id}} ) {
104             for my $subid ( @{$fps{$sha1}{recs}} ) {
105                 next if ($id == $subid);
106                 next if defined $used{$subid};
107                 $used{$subid} = 1;
108                 print OUT "$id\t$subid\n";
109             }
110         }
111     }
112 }
113
114 sub initialize {
115     my ($c) = @_;
116     my @missing = ();
117
118     # set mode on existing filehandles
119     binmode(STDIN, ':utf8');
120
121     my $rc = GetOptions( $c,
122                          'output|o=s',
123                          'help|h',
124                        );
125     show_help() unless $rc;
126     show_help() if ($c->{help});
127
128     my @keys = keys %{$c};
129     show_help() unless (@ARGV and @keys);
130     for my $key ('output')
131       { push @missing, $key unless $c->{$key} }
132     if (@missing) {
133         print "Required option: ", join(', ', @missing), " missing!\n";
134         show_help();
135     }
136 }
137
138 sub show_help {
139     print <<HELP;
140 Usage is: compress_fingerprints -o OUTPUTFILE INPUTFILE
141 HELP
142 exit;
143 }