opac/opac-ratings-ajax.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2011 KohaAloha, NZ
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 =head1 DESCRIPTION
  21
  22 A script that takes an ajax json query, and then inserts or modifies a star-rating.
  23
  24 =cut
  25
  26 use strict;
  27 use warnings;
  28
  29 use CGI qw ( -utf8 );
  30 use CGI::Cookie;  # need to check cookies before having CGI parse the POST request
  31
  32 use C4::Auth qw(:DEFAULT check_cookie_auth);
  33 use C4::Context;
  34 use C4::Debug;
  35 use C4::Output qw(:html :ajax pagination_bar);
  36 use C4::Ratings;
  37 use JSON;
  38
  39 my $is_ajax = is_ajax();
  40
  41 my ( $query, $auth_status );
  42 if ($is_ajax) {
  43     ( $query, $auth_status ) = &ajax_auth_cgi( {} );
  44 }
  45 else {
  46     $query = CGI->new();
  47 }
  48
  49 my $biblionumber     = $query->param('biblionumber');
  50 my $rating_value     = $query->param('rating_value');
  51 my $rating_old_value = $query->param('rating_old_value');
  52
  53 my ( $template, $loggedinuser, $cookie );
  54 if ($is_ajax) {
  55     $loggedinuser = C4::Context->userenv->{'number'};
  56 }
  57 else {
  58     ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  59         {
  60             template_name   => "opac-detail.tt",
  61             query           => $query,
  62             type            => "opac",
  63             authnotrequired => 0,                    # auth required to add tags
  64             debug           => 1,
  65         }
  66     );
  67 }
  68
  69 my $rating;
  70 $rating_value //= '';
  71
  72 if ( $rating_value eq '' ) {
  73 #### delete
  74     $rating = DelRating( $biblionumber, $loggedinuser );
  75 }
  76
  77 elsif ( $rating_value and !$rating_old_value ) {
  78 #### insert
  79     $rating = AddRating( $biblionumber, $loggedinuser, $rating_value );
  80 }
  81
  82 elsif ( $rating_value ne $rating_old_value ) {
  83 #### mod
  84     $rating = ModRating( $biblionumber, $loggedinuser, $rating_value );
  85 }
  86
  87 my %js_reply = (
  88     rating_total   => $rating->{'rating_total'},
  89     rating_avg     => $rating->{'rating_avg'},
  90     rating_avg_int => $rating->{'rating_avg_int'},
  91     rating_value   => $rating->{'rating_value'},
  92     auth_status    => $auth_status,
  93
  94 );
  95
  96 my $json_reply = JSON->new->encode( \%js_reply );
  97
  98 #### $rating
  99 #### %js_reply
 100 #### $json_reply
 101
 102 output_ajax_with_http_headers( $query, $json_reply );
 103 exit;
 104
 105 # a ratings specific ajax return sub, returns CGI object, and an 'auth_success' value
 106 sub ajax_auth_cgi {
 107     my $needed_flags = shift;
 108     my %cookies      = CGI::Cookie->fetch;
 109     my $input        = CGI->new;
 110     my $sessid = $cookies{'CGISESSID'}->value || $input->param('CGISESSID');
 111     my ( $auth_status, $auth_sessid ) =
 112       check_cookie_auth( $sessid, $needed_flags );
 113     return $input, $auth_status;
 114 }