opac/svc/suggestion

   1 #!/usr/bin/perl
   2
   3 # Copyright 2012 C & P Bibliography Services
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 =head1 NAME
  21
  22 opac-suggestion.pl : script to render suggestions for the OPAC
  23
  24 =head1 SYNOPSIS
  25
  26 =cut
  27
  28 =head1 DESCRIPTION
  29
  30 This script produces suggestions for the OPAC given a search string.
  31
  32 It takes the following parameters:
  33
  34 =over 8
  35
  36 =item I<q>
  37
  38 Required. Query string.
  39
  40 =item I<render>
  41
  42 If set to 'stub' render a stub HTML page suitable for inclusion into a
  43 div via AJAX. If set to 'standalone', return a full page instead of the stub.
  44 If not set, return JSON.
  45
  46 =item I<count>
  47
  48 Number of suggestions to display. Defaults to 4 in stub mode, 20 otherwise.
  49
  50 =back
  51
  52 =cut
  53
  54 use strict;
  55 use warnings;
  56
  57 use C4::Auth;
  58 use C4::Context;
  59 use C4::Output;
  60 use CGI;
  61 use JSON;
  62 use Koha::SuggestionEngine;
  63
  64 my $query = new CGI;
  65
  66 my $dbh = C4::Context->dbh;
  67
  68 my $search = $query->param('q')      || '';
  69 my $render = $query->param('render') || '';
  70 my $count  = $query->param('count')  || ( $render eq 'stub' ? 4 : 20 );
  71
  72 # open template
  73 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  74     {
  75         template_name   => "svc/suggestion.tt",
  76         query           => $query,
  77         type            => "opac",
  78         authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
  79         debug           => 1,
  80     }
  81 );
  82
  83 my @plugins = ();
  84
  85 my $pluginsconfig = from_json(C4::Context->preference('OPACdidyoumean') || '[]');
  86
  87 foreach my $plugin (@$pluginsconfig) {
  88     push @plugins, $plugin->{name} if ($plugin->{enabled});
  89 }
  90
  91 unless ( @plugins ) {
  92     print $query->header;
  93     exit;
  94 }
  95
  96 my $suggestor = Koha::SuggestionEngine->new( { plugins => \@plugins } );
  97
  98 my $suggestions =
  99   $suggestor->get_suggestions( { search => $search, count => $count } );
 100
 101 if ($render) {
 102     $template->{VARS}->{render} = $render;
 103     $template->{VARS}->{suggestions} = $suggestions if $suggestions;
 104     output_html_with_http_headers $query, $cookie, $template->output;
 105 }
 106 else {
 107     print $query->header;
 108     print to_json($suggestions);
 109 }