my $index = scalar @{ $self->plugins };

        $index--;

=head2 NAME

    my $name = $plugin->NAME;

Getter function for plugin names.

=cut

sub NAME {

    my $self = shift;

    my $package = ref $self || $self;

    return eval '$' . $package . '::NAME';

}

=head2 VERSION

    my $version = $plugin->VERSION;

Getter function for plugin versions.

=cut

sub VERSION {

    my $self = shift;

    my $package = ref $self || $self;

    return eval '$' . $package . '::VERSION';

}

=head2 DESCRIPTION

    my $description = $plugin->DESCRIPTION;

Getter function for plugin descriptions.

=cut

sub DESCRIPTION {

    my $self = shift;

    my $package = ref $self || $self;

    return eval '$' . $package . '::DESCRIPTION';

}

package Koha::SuggestionEngine::Plugin::ExplodedTerms;

# 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::ExplodedTerms - suggest searches for broader/narrower/related subjects

=head1 SYNOPSIS

=head1 DESCRIPTION

Plugin to suggest expanding the search by adding broader/narrower/related

subjects to subject searches.

=cut

use strict;

use warnings;

use Carp;

use C4::Templates qw(gettemplate); # This is necessary for translatability

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

our $NAME    = 'ExplodedTerms';

our $VERSION = '1.0';

=head2 get_suggestions

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

Return suggestions for the specified search that add broader/narrower/related

terms to the search.

=cut

sub get_suggestions {

    my $self  = shift;

    my $param = shift;

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

    return if ( $search =~ m/^(ccl=|cql=|pqf=)/ );

    $search =~ s/(su|su-br|su-na|su-rl)[:=](\w*)/OP!$2/g;

    return if ( $search =~ m/\w+[:=]\w+/ );

    my @indexes = (

        'su-na',

        'su-br',

        'su-rl'

    );

    my $cgi = new CGI;

    my $template = C4::Templates::gettemplate('text/explodedterms.tt', 'opac', $cgi);

    my @results;

    foreach my $index (@indexes) {

        my $thissearch = $search;

        $thissearch = "$index=$thissearch"

          unless ( $thissearch =~ s/OP!/$index=/g );

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

        my $label = pack("U0a*", $template->output); #FIXME: C4::Templates is

        # returning incorrectly-marked UTF-8. This fixes the problem, but is

        # an annoying workaround.

        push @results,

        {

            'search'  => $thissearch,

            relevance => 100,

                # FIXME: it'd be nice to have some empirical measure of

                #        "relevance" in this case, but we don't.

            label => $label

        };

    } return \@results;

}

#!/usr/bin/perl

use strict;

use warnings;

use CGI;

use C4::Context;

use C4::Auth;

use C4::Output;

use Koha::SuggestionEngine;

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

use JSON;

my $input = new CGI;

my ($template, $loggedinuser, $cookie)

    = get_template_and_user({template_name => "admin/didyoumean.tt",

            query => $input,

            type => "intranet",

            authnotrequired => 0,

            flagsrequired => {parameters => 'parameters_remaining_permissions'},

            debug => 1,

            });

my $opacplugins = from_json(C4::Context->preference('OPACdidyoumean') || '[]');

my $intraplugins = from_json(C4::Context->preference('INTRAdidyoumean') || '[]');

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

foreach my $plugin (@pluginlist) {

    next if $plugin eq 'Koha::SuggestionEngine::Plugin::Null';

    next unless (can_load( modules => { "$plugin" => undef } ));

    push @$opacplugins, { name => $plugin->NAME } unless grep { $_->{name} eq $plugin->NAME } @$opacplugins;

    push @$intraplugins, { name => $plugin->NAME } unless grep { $_->{name} eq $plugin->NAME } @$intraplugins;

}

$template->{VARS}->{OPACpluginlist} = $opacplugins;

$template->{VARS}->{INTRApluginlist} = $intraplugins;

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

INSERT INTO systempreferences (variable,value,explanation,type) VALUES('OPACdidyoumean',NULL,'Did you mean? configuration for the OPAC. Do not change, as this is controlled by /cgi-bin/koha/admin/didyoumean.pl.','Free');

INSERT INTO systempreferences (variable,value,explanation,type) VALUES('INTRAdidyoumean',NULL,'Did you mean? configuration for the Intranet. Do not change, as this is controlled by /cgi-bin/koha/admin/didyoumean.pl.','Free');

$DBversion ="3.09.00.XXX";

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

    $dbh->do("INSERT INTO systempreferences (variable,value,explanation,type) VALUES('OPACdidyoumean',NULL,'Did you mean? configuration for the OPAC. Do not change, as this is controlled by /cgi-bin/koha/admin/didyoumean.pl.','Free');");

    $dbh->do("INSERT INTO systempreferences (variable,value,explanation,type) VALUES('INTRAdidyoumean',NULL,'Did you mean? configuration for the Intranet. Do not change, as this is controlled by /cgi-bin/koha/admin/didyoumean.pl.','Free');");

    print "Upgrade to $DBversion done (Add Did You Mean? configuration)\n";

    SetVersion($DBversion);

}

#didyoumeanopac, #didyoumeanintranet {

    float: left;

    width: 260px;

}

#didyoumeanlegend {

    float: right;

}

.pluginlist {

    padding-bottom: 10px;

}

.plugin {

    margin: 0 1em 1em 0;

}

.pluginname {

    margin: 0.3em;

    padding-bottom: 4px;

    padding-left: 0.2em;

    background-color: #E6F0F2;

}

.pluginname .ui-icon {

    float: right;

}

.plugindesc {

    padding: 0.4em;

}

.ui-sortable-placeholder {

    border: 1px dotted black;

    visibility: visible !important;

    height: 80px !important;

}

.ui-sortable-placeholder * {

    visibility: hidden;

}

    <li><a href="/cgi-bin/koha/admin/didyoumean.pl">Did you mean?</a></li>

    <dt><a href="/cgi-bin/koha/admin/didyoumean.pl">Did you mean?</a></dt>

    <dd>Choose which plugins to use to suggest searches to patrons and staff.</dd>

[% BLOCK pluginlist %]

<div class="pluginlist">

[% FOREACH plugin IN plugins %]

    <div class="plugin">

        <div class="pluginname">

            [% IF plugin.enabled %]<input type="checkbox" checked="checked" id="checkbox_[% plugin.name %]">[% ELSE %]<input type="checkbox" id="checkbox_[% plugin.name %]">[% END %]

            <label class='pluginlabel' for="checkbox_[% plugin.name %]">[% plugin.name %]</label></div>

        <div class="plugindesc">

        [% SWITCH plugin.name %]

        [% CASE 'AuthorityFile' %]

            Suggest authorities which are relevant to the term the user searched for.

        [% CASE 'ExplodedTerms' %]

            Suggest that patrons expand their searches to include

            broader/narrower/related terms.

        [% END %]

        </div>

    </div>

[% END %]

</div>

[% END %]

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

<title>Koha &rsaquo; Administration &rsaquo; Did you mean?</title>

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

<script>

    $(document).ready(function() {

        $( ".pluginlist" ).sortable();

        $( ".plugin" ).addClass( "ui-widget ui-widget-content ui-helper-clearfix ui-corner-all" )

            .find( ".pluginname" )

                    .addClass( "ui-widget-header ui-corner-all" )

                    .end()

            .find( ".plugindesc" );

    });

    function yesimeant() {

        var OPACdidyoumean = serialize_plugins('opac');

        var INTRAdidyoumean = serialize_plugins('intranet');

        var data = "pref_OPACdidyoumean=" + encodeURIComponent(OPACdidyoumean) + "&pref_INTRAdidyoumean=" + encodeURIComponent(INTRAdidyoumean);

        $.ajax({

            data: data,

            type: 'POST',

            url: '/cgi-bin/koha/svc/config/systempreferences/',

            success: function () { alert("Successfully saved configuration"); },

        });

        return false;

    }

    function serialize_plugins(interface) {

        var serializedconfig = '[';

        $('#didyoumean' + interface + ' .pluginlist .plugin').each(function(index) {

            var name = $(this).find('.pluginlabel').text();

            var enabled = $(this).find('#checkbox_' + name).attr('checked') == 'checked' ?

                          ', "enabled": 1' : '';

            serializedconfig += '{ "name": "' + name + '"' + enabled + '}, ';

            });

            serializedconfig = serializedconfig.substring(0, serializedconfig.length - 2);

            serializedconfig += ']';

            return serializedconfig;

    }

</script>

</head>

<body id="admin_didyoumean" class="admin">

[% INCLUDE 'header.inc' %]

[% INCLUDE 'cat-search.inc' %]

<div id="breadcrumbs"><a href="/cgi-bin/koha/mainpage.pl">Home</a> &rsaquo; <a href="/cgi-bin/koha/admin/admin-home.pl">Administration</a> &rsaquo; Did you mean?</div>

<div id="doc3" class="yui-t2">

    <div id="bd">

    <div id="yui-main">

    <div class="yui-b">

        <h3>Did you mean?</h3>

        <noscript><div class="dialog alert"><strong>Please enable Javascript:</strong>

            Configuring <em>Did you mean?</em> plugins requires Javascript. If

            you are unable to use Javascript, you may be able to enter the

            configuration (which is stored in JSON in the OPACdidyoumean and

            INTRAdidyoumean system preferences) in the Local Preferences tab in

            the system preference editor, but this is unsupported, not

            recommended, and likely will not work.</div></noscript>

        <div id="didyoumeanlegend">

            Please put the <em>Did you mean?</em> plugins in order by significance, from

            most significant to least significant, and check the box to enable those

            plugins that you want to use.

        </div>

        <form action="/cgi-bin/koha/admin/didyoumean.pl" method="post">

            <fieldset id="didyoumeanopac">

                <legend>OPAC</legend>

                [% PROCESS pluginlist plugins=OPACpluginlist %]

            </fieldset>

            <fieldset id="didyoumeanintranet">

                <legend>Intranet</legend>

                [% PROCESS pluginlist plugins=INTRApluginlist %]

            </fieldset>

            <fieldset class="action"><button class="save-all submit" onclick="yesimeant();return false;" type="submit">Save configuration</button> <a href="#" onclick="window.location.reload(true);" class="cancel">Cancel</a></fieldset>

        </form>

        </div>

        </div>

<div class="yui-b">

[% INCLUDE 'admin-menu.inc' %]

</div>

</div>

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

[%- SWITCH index -%]

[%- CASE 'su-na' -%]

Search also for narrower subjects

[%- CASE 'su-br' -%]

Search also for broader subjects

[%- CASE 'su-rl' -%]

Search also for related subjects

[%- END -%]