Open-ILS/src/perlmods/lib/OpenILS/Utils/Normalize.pm

   1 package OpenILS::Utils::Normalize;
   2 use strict;
   3 use warnings;
   4 use Unicode::Normalize;
   5 use Encode;
   6
   7 use Exporter 'import';
   8 our @EXPORT_OK = qw( naco_normalize search_normalize );
   9
  10 sub naco_normalize {
  11     my $str = decode_utf8(shift);
  12     my $sf = shift;
  13
  14     # Apply NACO normalization to input string; based on
  15     # http://www.loc.gov/catdir/pcc/naco/SCA_PccNormalization_Final_revised.pdf
  16     #
  17     # Note that unlike a strict reading of the NACO normalization rules,
  18     # output is returned as lowercase instead of uppercase for compatibility
  19     # with previous versions of the Evergreen naco_normalize routine.
  20     $str = _normalize_substitutions($str, $sf);
  21
  22     # Remove apostrophes, per NACO specs
  23     $str =~ tr/'//d;
  24
  25     $str = _normalize_codes($str, $sf);
  26
  27     return $str;
  28 }
  29
  30 sub search_normalize {
  31     my $str = decode_utf8(shift);
  32     my $sf = shift;
  33
  34     $str = _normalize_substitutions($str, $sf);
  35     $str = _normalize_codes($str, $sf);
  36
  37     return $str;
  38 }
  39
  40 sub _normalize_substitutions {
  41     my $str = shift;
  42     my $sf = shift;
  43
  44     # Convert to upper-case first; even though final output will be lowercase, doing this will
  45     # ensure that the German eszett (ß) and certain ligatures (ﬀ, ﬁ, ﬄ, etc.) will be handled correctly.
  46     # If there are any bugs in Perl's implementation of upcasing, they will be passed through here.
  47
  48     $str = uc $str;
  49
  50     # remove non-filing strings
  51     $str =~ s/\x{0098}.*?\x{009C}//g;
  52
  53     $str = NFKD($str);
  54
  55     # additional substitutions - 3.6.
  56     $str =~ s/\x{00C6}/AE/g;
  57     $str =~ s/\x{00DE}/TH/g;
  58     $str =~ s/\x{0152}/OE/g;
  59     $str =~ tr/\x{0110}\x{00D0}\x{00D8}\x{0141}\x{2113}\x{02BB}\x{02BC}][/DDOLl/d;
  60
  61     return $str;
  62 }
  63
  64 sub _normalize_codes {
  65     my $str = shift;
  66     my $sf = shift;
  67
  68     # transformations based on Unicode category codes
  69     $str =~ s/[\p{Cc}\p{Cf}\p{Co}\p{Cs}\p{Lm}\p{Mc}\p{Me}\p{Mn}]//g;
  70
  71         if ($sf && $sf =~ /^a/o) {
  72                 my $commapos = index($str, ',');
  73                 if ($commapos > -1) {
  74                         if ($commapos != length($str) - 1) {
  75                 $str =~ s/,/\x07/; # preserve first comma
  76                         }
  77                 }
  78         }
  79
  80     # since we've stripped out the control characters, we can now
  81     # use a few as placeholders temporarily
  82     $str =~ tr/+&@\x{266D}\x{266F}#/\x01\x02\x03\x04\x05\x06/;
  83     $str =~ s/[\p{Pc}\p{Pd}\p{Pe}\p{Pf}\p{Pi}\p{Po}\p{Ps}\p{Sk}\p{Sm}\p{So}\p{Zl}\p{Zp}\p{Zs}]/ /g;
  84     $str =~ tr/\x01\x02\x03\x04\x05\x06\x07/+&@\x{266D}\x{266F}#,/;
  85
  86     # decimal digits
  87     $str =~ tr/\x{0660}-\x{0669}\x{06F0}-\x{06F9}\x{07C0}-\x{07C9}\x{0966}-\x{096F}\x{09E6}-\x{09EF}\x{0A66}-\x{0A6F}\x{0AE6}-\x{0AEF}\x{0B66}-\x{0B6F}\x{0BE6}-\x{0BEF}\x{0C66}-\x{0C6F}\x{0CE6}-\x{0CEF}\x{0D66}-\x{0D6F}\x{0E50}-\x{0E59}\x{0ED0}-\x{0ED9}\x{0F20}-\x{0F29}\x{1040}-\x{1049}\x{1090}-\x{1099}\x{17E0}-\x{17E9}\x{1810}-\x{1819}\x{1946}-\x{194F}\x{19D0}-\x{19D9}\x{1A80}-\x{1A89}\x{1A90}-\x{1A99}\x{1B50}-\x{1B59}\x{1BB0}-\x{1BB9}\x{1C40}-\x{1C49}\x{1C50}-\x{1C59}\x{A620}-\x{A629}\x{A8D0}-\x{A8D9}\x{A900}-\x{A909}\x{A9D0}-\x{A9D9}\x{AA50}-\x{AA59}\x{ABF0}-\x{ABF9}\x{FF10}-\x{FF19}/0-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-9/;
  88
  89     # intentionally skipping step 8 of the NACO algorithm; if the string
  90     # gets normalized away, that's fine.
  91
  92     # leading and trailing spaces
  93     $str =~ s/\s+/ /g;
  94     $str =~ s/^\s+//;
  95     $str =~ s/\s+$//g;
  96
  97     return lc $str;
  98 }
  99
 100 1;