if ($sortby eq 'Relevance') {

                          $attr .= "\@attr 2=102 ";

                      }

package Koha::SuggestionEngine;

# Copyright 2012 C & P Bibliography Services

#

# 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 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.

=head1 NAME

Koha::SuggestionEngine - Dispatcher class for suggestion engines

=head1 SYNOPSIS

  use Koha::SuggestionEngine;

  my $suggestor = Koha::SuggestionEngine->new(%params);

  $suggestor->get_suggestions($search)

=head1 DESCRIPTION

Dispatcher class for retrieving suggestions. SuggestionEngines must

extend Koha::SuggestionEngine::Base, be in the Koha::SuggestionEngine::Plugin

namespace, and provide the following methods:

B<get_suggestions ($search)> - get suggestions from the plugin for the

specified search.

These methods may be overriden:

B<initialize (%params)> - initialize the plugin

B<destroy ()> - destroy the plugin

These methods should not be overridden unless you are very sure of what

you are doing:

B<new ()> - create a new plugin object

=head1 FUNCTIONS

=cut

use strict;

use warnings;

use Module::Load::Conditional qw(can_load);

use Module::Pluggable::Object;

use base qw(Class::Accessor);

__PACKAGE__->mk_accessors(qw( schema plugins options record ));

=head2 new

    my $suggestor = Koha::SuggestionEngine->new(%params);

Create a new suggestor class. Available parameters are:

=over 8

=item B<plugins>

What plugin(s) to use. This must be an arrayref to a list of plugins. Plugins

can be specified either with a complete class path, or, if they are in the

Koha::SuggestionEngine::Plugin namespace, as only the plugin name, and

"Koha::SuggestionEngine::Plugin" will be prepended to it before the plugin

is loaded.

=back

=cut

sub new {

    my $class = shift;

    my $param = shift;

    my $options = $param->{options} || '';

    my @plugins = ();

    foreach my $plugin ( $param->{plugins} ) {

        next unless $plugin;

        my $plugin_module =

            $plugin =~ m/:/

          ? $plugin

          : "Koha::SuggestionEngine::Plugin::${plugin}";

        if ( can_load( modules => { $plugin_module => undef } ) ) {

            my $object = $plugin_module->new();

            $plugin_module->initialize($param);

            push @plugins, $object;

        }

    }

    my $self = $class->SUPER::new(

        {

            plugins => \@plugins,

            options => $options

        }

    );

    bless $self, $class;

    return $self;

}

=head2 get_suggestions

    my $suggestions = $suggester->get_suggestions(\%params)

Get a list of suggestions based on the search passed in. Available parameters

are:

=over 8

=item B<search>

Required. The search for which suggestions are desired.

=item B<count>

Optional. The number of suggestions to retrieve. Defaults to 10.

=back

=cut

sub get_suggestions {

    my $self  = shift;

    my $param = shift;

    return unless $param->{'search'};

    my $number = $param->{'count'} || 10;

    my %suggestions;

    foreach my $pluginobj ( @{ $self->plugins } ) {

        next unless $pluginobj;

        my $pluginres = $pluginobj->get_suggestions($param);

        foreach my $suggestion (@$pluginres) {

            $suggestions{ $suggestion->{'search'} }->{'relevance'} +=

              $suggestion->{'relevance'};

            $suggestions{ $suggestion->{'search'} }->{'label'} |=

              $suggestion->{'label'};

        }

    }

    my @results = ();

    for (

        sort {

            $suggestions{$b}->{'relevance'} <=> $suggestions{$a}->{'relevance'}

        } keys %suggestions

      )

    {

        last if ( $#results == $number - 1 );

        push @results,

          {

            'search'  => $_,

            relevance => $suggestions{$_}->{'relevance'},

            label     => $suggestions{$_}->{'label'}

          };

    }

    return \@results;

}

sub DESTROY {

    my $self = shift;

    foreach my $pluginobj ( @{ $self->plugins } ) {

        $pluginobj->destroy();

    }

}

=head2 AvailablePlugins

    my @available_plugins = Koha::SuggestionEngine::AvailablePlugins();

Get a list of available plugins.

=cut

sub AvailablePlugins {

    my $path = 'Koha::SuggestionEngine::Plugin';

    my $finder = Module::Pluggable::Object->new( search_path => $path );

    return $finder->plugins;

}

1;

package Koha::SuggestionEngine::Base;

# Copyright 2012 C & P Bibliography Services

#

# 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 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.

=head1 NAME

Koha::SuggestionEngine::Base - Base class for SuggestionEngine plugins

=head1 SYNOPSIS

  use base qw(Koha::SuggestionEngine::Base);

=head1 DESCRIPTION

Base class for suggestion engine plugins. SuggestionEngines must

provide the following methods:

B<get_suggestions (\%param)> - get suggestions for the search described

in $param->{'search'}, and return them in a hashref with the suggestions

as keys and relevance as values.

The following variables must be defined in each filter:

  our $NAME ='Filter';

  our $VERSION = '1.0';

These methods may be overriden:

B<initialize (%params)> - initialize the plugin

B<destroy ()> - destroy the plugin

These methods should not be overridden unless you are very sure of what

you are doing:

B<new ()> - create a new plugin object

=head1 FUNCTIONS

=cut

use strict;

use warnings;

use base qw(Class::Accessor);

__PACKAGE__->mk_ro_accessors(qw( name version ));

__PACKAGE__->mk_accessors(qw( params ));

our $NAME    = 'Base';

our $VERSION = '1.0';

=head2 new

    my $plugin = Koha::SuggestionEngine::Base->new;

Create a new filter;

=cut

sub new {

    my $class = shift;

    my $self = $class->SUPER::new( {} );    #name => $class->NAME,

                                            #version => $class->VERSION });

    bless $self, $class;

    return $self;

}

=head2 initialize

    $plugin->initalize(%params);

Initialize a filter using the specified parameters.

=cut

sub initialize {

    my $self   = shift;

    my $params = shift;

    #$self->params = $params;

    return $self;

}

=head2 destroy

    $plugin->destroy();

Destroy the filter.

=cut

sub destroy {

    my $self = shift;

    return;

}

=head2 get_suggestions

    my $suggestions = $plugin->get_suggestions(\%param);

Return suggestions for the specified search.

=cut

sub get_suggestions {

    my $self  = shift;

    my $param = shift;

    return;

}

1;

package Koha::SuggestionEngine::Plugin::AuthorityFile;

# Copyright 2012 C & P Bibliography Services

#

# 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 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.

=head1 NAME

Koha::SuggestionEngine::Plugin::AuthorityFile - get suggestions from the authority file

=head1 SYNOPSIS

=head1 DESCRIPTION

Plugin to get suggestions from Koha's authority file

=cut

use strict;

use warnings;

use Carp;

use base qw(Koha::SuggestionEngine::Base);

our $NAME    = 'EmbedItems';

our $VERSION = '1.0';

=head2 get_suggestions

    my $suggestions = $plugin->get_suggestions(\%param);

Return suggestions for the specified search by searching for the

search terms in the authority file and returning the results.

=cut

sub get_suggestions {

    my $self  = shift;

    my $param = shift;

    my $search = $param->{'search'};

    # Remove any CCL. This does not handle CQL or PQF, which is unfortunate,

    # but what can you do? At some point the search will have to be passed

    # not as a string but as some sort of data structure, at which point it

    # will be possible to support multiple search syntaxes.

    $search =~ s/ccl=//;

    $search =~ s/\w*[:=](\w*)/$1/g;

    my @marclist  = ['mainentry'];

    my @and_or    = ['and'];

    my @excluding = [];

    my @operator  = ['any'];

    my @value     = ["$search"];

    # FIXME: calling into C4

    require C4::AuthoritiesMarc;

    my ( $searchresults, $count ) = C4::AuthoritiesMarc::SearchAuthorities(

        \@marclist,  \@and_or, \@excluding,       \@operator,

        @value,      0,        $param->{'count'}, '',

        'Relevance', 0

    );

    my @results;

    foreach my $auth (@$searchresults) {

        push @results,

          {

            'search'  => "an=$auth->{'authid'}",

            relevance => $count--,

            label     => $auth->{summary}->{authorized}->[0]

          };

    }

    return \@results;

}

package Koha::SuggestionEngine::Plugin::Null;

# Copyright 2012 C & P Bibliography Services

#

# 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 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.

=head1 NAME

Koha::SuggestionEngine::Plugin::Null - an example plugin that does nothing but allow us to run tests

=head1 SYNOPSIS

=head1 DESCRIPTION

Plugin to allow us to run unit tests and regression tests against the

SuggestionEngine.

=cut

use strict;

use warnings;

use Carp;

use base qw(Koha::SuggestionEngine::Base);

our $NAME    = 'Null';

our $VERSION = '1.0';

=head2 get_suggestions

    my $suggestions = $suggestor->get_suggestions( {search => 'books');

Return a boring suggestion.

=cut

sub get_suggestions {

    my $self  = shift;

    my $param = shift;

    my @result = ();

    push @result, { search => 'book', label => 'Book!', relevance => 1 }

      if ( $param->{'search'} eq 'books' );

    return \@result;

}

INSERT INTO systempreferences (variable,value,explanation,type) VALUES('DidYouMeanFromAuthorities','0','Suggest searches based on authority file.','YesNo');

$DBversion ="3.09.00.XXX";

if ( C4::Context->preference("Version") < TransformToNum($DBversion) ) {

    $dbh->do("INSERT INTO systempreferences (variable,value,explanation,type) VALUES('DidYouMeanFromAuthorities','0','Suggest searches based on authority file.','YesNo');");

    print "Upgrade to $DBversion done (Add system preference DidYouMeanFromAuthorities))\n";

    SetVersion($DBversion);

}

        -

            - pref: DidYouMeanFromAuthorities

              default: 0

              choices:

                  yes: Suggest

                  no: "Don't suggest"

            - alternate searches based on data in the authority file.

#didyoumean {

    background-color: #EEE;

    border: 1px solid #E8E8E8;

    margin-bottom: 4px;

    text-align: center;

    padding: 0.5em 0;

}

.suggestionlabel {

    font-weight: bold;

}

.searchsuggestion {

    border: 2px outset #E8E8E8;

    padding: 0.2em;

    white-space: nowrap;

    display: inline-block;

}

    $('#didyoumean').load('/cgi-bin/koha/svc/suggestion?render=stub&q=[% querystring | uri %]');

[% IF (render=='standalone') %]

[% INCLUDE 'doc-head-open.inc' %]Search suggestions</title>

    [% INCLUDE 'doc-head-close.inc' %]

</head>

<body id="opac-suggestion">

    [% IF ( OpacNav ) %]<div id="doc3" class="yui-t1">[% ELSE %]<div id="doc3" class="yui-t7">[% END %]

        <div id="bd">

            [% INCLUDE 'masthead.inc' %]

            <div id="yui-main">

            <div class="yui-b">

            <div class="yui-ge">

            <div class="container">

            <h1 class="title">Suggestions</h1>

[% END %]

[% IF suggestions && suggestions.size %]

    <div>

    <span class='suggestionlabel'>Did you mean:</span>

    [% FOREACH suggestion IN suggestions %]

        <span class='searchsuggestion'><a href='/cgi-bin/koha/opac-search.pl?q=[% suggestion.search | uri %]'>[% suggestion.label %]</a></span>

    [% END %]

    </div>

[% ELSE %]

    <span class='nosuggestions'>Sorry, no suggestions.</span>

[% END %]

[% IF (render=='standalone') %]

    </div>

    </div>

    </div>

    [% IF ( OpacNav ) %]

        <div class="yui-b"><div id="leftmenus" class="container">

        [% INCLUDE 'navigation.inc' %]

        </div></div>

    [% END %]

    </div>

    [% INCLUDE 'opac-bottom.inc' %]

[% END %]

$template->{VARS}->{querystring} = join(' ', @operands);

$template->{VARS}->{DidYouMeanFromAuthorities} = C4::Context->preference('DidYouMeanFromAuthorities');

#!/usr/bin/perl

# Copyright 2012 C & P Bibliography Services

#

# 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 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.

=head1 NAME

opac-suggestion.pl : script to render suggestions for the OPAC

=head1 SYNOPSIS

=cut

=head1 DESCRIPTION

This script produces suggestions for the OPAC given a search string.

It takes the following parameters:

=over 8

=item I<q>

Required. Query string.

=item I<render>

If set to 'stub' render a stub HTML page suitable for inclusion into a

div via AJAX. If set to 'standalone', return a full page instead of the stub.

If not set, return JSON.

=item I<count>

Number of suggestions to display. Defaults to 4 in stub mode, 20 otherwise.

=back

=cut

use strict;

use warnings;

use C4::Auth;

use C4::Context;

use C4::Output;

use CGI;

use JSON;

use Koha::SuggestionEngine;

my $query = new CGI;

my $dbh = C4::Context->dbh;

my $search = $query->param('q')      || '';

my $render = $query->param('render') || '';

my $count  = $query->param('count')  || ( $render eq 'stub' ? 4 : 20 );

# open template

my ( $template, $loggedinuser, $cookie ) = get_template_and_user(

    {

        template_name   => "svc/suggestion.tt",

        query           => $query,

        type            => "opac",

        authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),

        debug           => 1,

    }

);

unless ( C4::Context->preference('DidYouMeanFromAuthorities') ) {

    print $query->header;

    exit;

}

my $suggestor = Koha::SuggestionEngine->new( { plugins => ('AuthorityFile') } );

my $suggestions =

  $suggestor->get_suggestions( { search => $search, count => $count } );

if ($render) {

    $template->{VARS}->{render} = $render;

    $template->{VARS}->{suggestions} = $suggestions if $suggestions;

    output_html_with_http_headers $query, $cookie, $template->output;

}

else {

    print $query->header;

    print to_json($suggestions);

}

#!/usr/bin/perl

use strict;

use warnings;

use File::Spec;

use Test::More;

BEGIN {

        use_ok('Koha::SuggestionEngine');

}

my $plugindir = File::Spec->rel2abs('Koha/SuggestionEngine/Plugin');

opendir(my $dh, $plugindir);

my @installed_plugins = map { ( /\.pm$/ && -f "$plugindir/$_" && s/\.pm$// ) ? "Koha::SuggestionEngine::Plugin::$_" : () } readdir($dh);

my @available_plugins = Koha::SuggestionEngine::AvailablePlugins();

foreach my $plugin (@installed_plugins) {

    ok(grep($plugin, @available_plugins), "Found plugin $plugin");

}

my $suggestor = Koha::SuggestionEngine->new( { plugins => ( 'ABCD::EFGH::IJKL' ) } );

is(ref($suggestor), 'Koha::SuggestionEngine', 'Created suggestion engine with invalid plugin');

is(scalar @{ $suggestor->get_suggestions({ 'search' => 'books' }) }, 0 , 'Request suggestions with empty suggestor');

$suggestor = Koha::SuggestionEngine->new( { plugins => ( 'Null' ) } );

is(ref($suggestor->plugins->[0]), 'Koha::SuggestionEngine::Plugin::Null', 'Created record suggestor with implicitly scoped Null filter');

$suggestor = Koha::SuggestionEngine->new( { plugins => ( 'Koha::SuggestionEngine::Plugin::Null' ) } );

is(ref($suggestor->plugins->[0]), 'Koha::SuggestionEngine::Plugin::Null', 'Created record suggestor with explicitly scoped Null filter');

my $suggestions = $suggestor->get_suggestions({ 'search' => 'books' });

is_deeply($suggestions->[0], { 'search' => 'book', label => 'Book!', relevance => 1 }, "Good suggestion");

$suggestions = $suggestor->get_suggestions({ 'search' => 'silliness' });

eval {

    $suggestor = Koha::SuggestionEngine->new( { plugins => ( 'Koha::SuggestionEngine::Plugin::Null' ) } );

    undef $suggestor;

};

ok(!$@, 'Destroyed suggestor successfully');

done_testing();