Koha/SuggestionEngine/Plugin/LibrisSpellcheck.pm

   1 package Koha::SuggestionEngine::Plugin::LibrisSpellcheck;
   2 # Copyright (C) 2015 Eivin Giske Skaaren
   3 #
   4 # This file is part of Koha.
   5 #
   6 # Koha is free software; you can redistribute it and/or modify it
   7 # under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # Koha is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  18
  19 use Modern::Perl;
  20 use LWP::UserAgent;
  21 use XML::Simple qw(XMLin);
  22 use C4::Context;
  23 use base qw(Koha::SuggestionEngine::Base);
  24
  25 sub NAME {
  26     return 'LibrisSpellcheck';
  27 }
  28
  29 sub get_suggestions {
  30     my ($self, $query) = @_;
  31     my $key = C4::Context->preference('LibrisKey');
  32     my $base = C4::Context->preference('LibrisURL');
  33     my $search = $query->{'search'};
  34     my $response = LWP::UserAgent->new->get($base."spell?query={$search}&key=$key");
  35     my $xml = XMLin($response->content, NoAttr => 1, ForceArray => qr/term/);
  36
  37     my @terms;
  38     my $label;
  39
  40     if ($xml->{suggestion}->{term}) {
  41         for (@{$xml->{suggestion}->{term}}) {
  42             push @terms, $_;
  43         }
  44         $label = join(' ', @terms);
  45     } else {
  46         return; # No result from LIBRIS
  47     }
  48
  49     my @results;
  50     push @results,
  51     {
  52         'search'  => $label,  #$thissearch,
  53         relevance => 100,
  54             # FIXME: it'd be nice to have some empirical measure of
  55             #        "relevance" in this case, but we don't.
  56         label => $label
  57     };
  58     return \@results;
  59 }
  60
  61 1;
  62 __END__
  63
  64 =head1 NAME
  65
  66 Koha::SuggestionEngine::Plugin::LibrisSpellcheck
  67
  68 =head2 FUNCTIONS
  69
  70 This module provides facilities for using the LIBRIS spell checker API
  71
  72 =over
  73
  74 =item NAME
  75
  76 my $name = $plugin->NAME;
  77
  78 =back
  79
  80 =over
  81
  82 =item get_suggestions(query)
  83
  84 Sends in the search query and gets an XML with a suggestion
  85
  86 my $suggestions = $plugin->get_suggestions(\%query);
  87
  88 =back
  89
  90 =cut
  91
  92 =head1 NOTES
  93
  94 =cut
  95
  96 =head1 AUTHOR
  97
  98 Eivin Giske Skaaren <eskaaren@yahoo.no>
  99
 100 =cut