Open-ILS/src/perlmods/lib/OpenILS/Application/Search.pm

   1 package OpenILS::Application::Search;
   2 use OpenILS::Application;
   3 use base qw/OpenILS::Application/;
   4 use strict; use warnings;
   5 use OpenSRF::Utils::JSON;
   6 use OpenSRF::Utils::Logger qw(:logger);
   7
   8 use OpenILS::Utils::Fieldmapper;
   9 use OpenILS::Utils::ModsParser;
  10 use OpenSRF::Utils::SettingsClient;
  11 use OpenSRF::Utils::Cache;
  12
  13 use OpenILS::Application::Search::Biblio;
  14 use OpenILS::Application::Search::Authority;
  15 use OpenILS::Application::Search::Z3950;
  16 use OpenILS::Application::Search::Zips;
  17 use OpenILS::Application::Search::CNBrowse;
  18 use OpenILS::Application::Search::Serial;
  19
  20
  21 use OpenILS::Application::AppUtils;
  22
  23 use Time::HiRes qw(time);
  24 use OpenSRF::EX qw(:try);
  25
  26 use Text::Aspell;
  27
  28 # Houses generic search utilites
  29
  30 sub initialize {
  31     OpenILS::Application::Search::Z3950->initialize();
  32     OpenILS::Application::Search::Zips->initialize();
  33     OpenILS::Application::Search::Biblio->initialize();
  34 }
  35
  36 sub child_init {
  37     OpenILS::Application::Search::Z3950->child_init;
  38 }
  39
  40
  41
  42 # ------------------------------------------------------------------
  43 # Create custom dictionaries like so:
  44 # aspell --lang=en create  master ./oils_authority.dict < /tmp/words
  45 # where /tmp/words is a space separated list of words
  46 # ------------------------------------------------------------------
  47
  48 __PACKAGE__->register_method(
  49     method    => "spellcheck",
  50     api_name  => "open-ils.search.spellcheck",
  51     signature => {
  52         desc  => 'Returns alternate spelling suggestions',
  53         param => [
  54             {
  55                 name => 'phrase',
  56                 desc => 'Word or phrase to return alternate spelling suggestions for',
  57                 type => 'string'
  58             },
  59             {
  60                 name => 'Dictionary class',
  61                 desc => 'Alternate configured dictionary to use (optional)',
  62                 type => 'string'
  63             },
  64         ],
  65         return => {
  66             desc => 'Array with a suggestions hash for each word in the phrase, like: '
  67                   . q# [{ word: original_word, suggestions: [sug1, sug2, ...], found: 1 }, ... ] #
  68                   . 'The "found" value will be 1 if the word was found in the dictionary, 0 otherwise.',
  69             type => 'array',
  70         }
  71     }
  72 );
  73
  74 my $speller = Text::Aspell->new();
  75
  76 sub spellcheck {
  77     my( $self, $client, $phrase, $class ) = @_;
  78
  79     return [] unless $phrase;   # nothing to check, abort.
  80
  81     my $conf = OpenSRF::Utils::SettingsClient->new;
  82     $class ||= 'default';
  83
  84     my @conf_path = (apps => 'open-ils.search' => app_settings => spelling_dictionary => $class);
  85
  86     if( my $dict = $conf->config_value(@conf_path) ) {
  87         $speller->set_option('master', $dict);
  88         $logger->debug("spelling dictionary set to $dict");
  89     }
  90
  91     $speller->set_option('ignore-case', 'true');
  92
  93     my @resp;
  94
  95     for my $word (split(/\s+/,$phrase) ) {
  96
  97         my @suggestions = $speller->suggest($word);
  98         my @trimmed;
  99
 100         for my $sug (@suggestions) {
 101
 102             # suggestion matches alternate case of original word
 103             next if lc($sug) eq lc($word);
 104
 105             # suggestion matches alternate case of already suggested word
 106             next if grep { lc($sug) eq lc($_) } @trimmed;
 107
 108             push(@trimmed, $sug);
 109         }
 110
 111         push( @resp,
 112             {
 113                 word => $word,
 114                 suggestions => (@trimmed) ? [@trimmed] : undef,
 115                 found => $speller->check($word)
 116             }
 117         );
 118     }
 119     return \@resp;
 120 }
 121
 122
 123
 124 1;