tags/review.pl

   1 #!/usr/bin/perl
   2
   3 # This software is placed under the gnu General Public License, v2 (http://www.gnu.org/licenses/gpl.html)
   4
   5 # Copyright 2008 LibLime
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it under the
  10 # terms of the GNU General Public License as published by the Free Software
  11 # Foundation; either version 2 of the License, or (at your option) any later
  12 # version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License along
  19 # with Koha; if not, write to the Free Software Foundation, Inc.,
  20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21
  22 use warnings;
  23 use strict;
  24 use Data::Dumper;
  25 use POSIX;
  26 use CGI qw ( -utf8 );
  27 use CGI::Cookie; # need to check cookies before having CGI parse the POST request
  28
  29 use C4::Auth qw(:DEFAULT check_cookie_auth);
  30 use C4::Context;
  31 use C4::Dates qw(format_date format_date_in_iso);
  32 # use C4::Koha;
  33 use C4::Output qw(:html :ajax pagination_bar);
  34 use C4::Debug;
  35 use C4::Tags qw(get_tags get_approval_rows approval_counts whitelist blacklist is_approved);
  36
  37 my $script_name = "/cgi-bin/koha/tags/review.pl";
  38 my $needed_flags = { tools => 'moderate_tags' };        # FIXME: replace when more specific permission is created.
  39
  40 sub ajax_auth_cgi ($) {         # returns CGI object
  41         my $needed_flags = shift;
  42         my %cookies = fetch CGI::Cookie;
  43         my $input = CGI->new;
  44     my $sessid = $cookies{'CGISESSID'}->value;
  45         my ($auth_status, $auth_sessid) = check_cookie_auth($sessid, $needed_flags);
  46         $debug and
  47         print STDERR "($auth_status, $auth_sessid) = check_cookie_auth($sessid," . Dumper($needed_flags) . ")\n";
  48         if ($auth_status ne "ok") {
  49                 output_with_http_headers $input, undef,
  50                         "window.alert('Your CGI session cookie ($sessid) is not current.  " .
  51                         "Please refresh the page and try again.');\n", 'js';
  52                 exit 0;
  53         }
  54         $debug and print STDERR "AJAX request: " . Dumper($input),
  55                 "\n(\$auth_status,\$auth_sessid) = ($auth_status,$auth_sessid)\n";
  56         return $input;
  57 }
  58
  59 if (is_ajax()) {
  60         my $input = &ajax_auth_cgi($needed_flags);
  61         my $operator = C4::Context->userenv->{'number'};  # must occur AFTER auth
  62         $debug and print STDERR "op: " . Dumper($operator) . "\n";
  63         my ($tag, $js_reply);
  64         if ($tag = $input->param('test')) {
  65                 my $check = is_approved($tag);
  66                 $js_reply = ( $check >=  1 ? 'success' :
  67                                           $check <= -1 ? 'failure' : 'indeterminate' ) . "_test('$tag');\n";
  68         }
  69         if ($tag = $input->param('ok')) {
  70                 $js_reply = (   whitelist($operator,$tag) ? 'success' : 'failure') . "_approve('$tag');\n";
  71         }
  72         if ($tag = $input->param('rej')) {
  73                 $js_reply = (   blacklist($operator,$tag) ? 'success' : 'failure')  . "_reject('$tag');\n";
  74         }
  75         output_with_http_headers $input, undef, $js_reply, 'js';
  76         exit;
  77 }
  78
  79 ### Below is the sad, boring, necessary non-AJAX HTML code.
  80
  81 my $input = CGI->new;
  82 my ($template, $borrowernumber, $cookie) = get_template_and_user(
  83     {
  84         template_name   => "tags/review.tt",
  85         query           => $input,
  86         type            => "intranet",
  87         debug           => 1,
  88         authnotrequired => 0,
  89         flagsrequired   => $needed_flags,
  90     }
  91 );
  92
  93 my ($op, @errors, @tags);
  94
  95 foreach (qw( approve reject test )) {
  96     $op = $_ if ( $input->param("op-$_") );
  97 }
  98 $op ||= 'none';
  99
 100 @tags = $input->param('tags');
 101
 102 $borrowernumber == 0 and push @errors, {op_zero=>1};
 103      if ($op eq 'approve') {
 104         foreach (@tags) {
 105                 whitelist($borrowernumber,$_) or push @errors, {failed_ok=>$_};
 106         }
 107 } elsif ($op eq 'reject' ) {
 108         foreach (@tags) {
 109                 blacklist($borrowernumber,$_) or push @errors, {failed_rej=>$_};
 110         }
 111 } elsif ($op eq 'test'   ) {
 112         my $tag = $input->param('test');
 113         push @tags, $tag;
 114         my $check = is_approved($tag);
 115         $template->param(
 116                 test_term => $tag,
 117                 ( $check >=  1 ? 'verdict_ok' :
 118                   $check <= -1 ? 'verdict_rej' : 'verdict_indeterminate' ) => 1,
 119         );
 120 }
 121
 122 my $counts = &approval_counts;
 123 foreach (keys %$counts) {
 124         $template->param($_ => $counts->{$_});
 125 }
 126
 127 sub pagination_calc ($;$) {
 128         my $query = shift or return undef;
 129         my $hardlimit = (@_) ? shift : 100;     # hardcoded, could be another syspref
 130         my $pagesize = $query->param('limit' ) || $hardlimit;
 131         my $page     = $query->param('page'  ) || 1;
 132         my $offset   = $query->param('offset') || 0;
 133         ($pagesize <= $hardlimit) or $pagesize = $hardlimit;
 134         if ($page > 1) {
 135                 $offset = ($page-1)*$pagesize;
 136         } else {
 137                 $page = 1;
 138         }
 139         return ($pagesize,$page,$offset);
 140 }
 141
 142 my ($pagesize,$page,$offset) = pagination_calc($input,100);
 143
 144 my %filters = (
 145         limit => $offset ? "$offset,$pagesize" : $pagesize,
 146          sort => 'approved,-weight_total,+term',
 147 );
 148 my ($filter,$date_from,$date_to);
 149 if (defined $input->param('approved')) { # 0 is valid value, must check defined
 150         $filter = $input->param('approved');
 151 } else {
 152         $filter = 0;
 153 }
 154 if ($filter eq 'all') {
 155         $template->param(filter_approved_all => 1);
 156 } elsif ($filter =~ /-?[01]/) {
 157         $filters{approved} = $filter;
 158         $template->param(
 159                 ($filter == 1  ? 'filter_approved_ok'      :
 160                  $filter == 0  ? 'filter_approved_pending' :
 161                  $filter == -1 ? 'filter_approved_rej'     :
 162                 'filter_approved') => 1
 163         );
 164 }
 165
 166 # my $q_count = get_approval_rows({limit=>$pagesize, sort=>'approved,-weight_total,+term', count=>1});
 167 if ($filter = $input->param('tag')) {
 168         $template->param(filter_tag=>$filter);
 169         $filters{term} = $filter;
 170 }
 171 if ($filter = $input->param('from')) {
 172         if ($date_from = format_date_in_iso($filter)) {
 173                 $template->param(filter_date_approved_from=>$filter);
 174                 $filters{date_approved} = ">=$date_from";
 175         } else {
 176                 push @errors, {date_from=>$filter};
 177         }
 178 }
 179 if ($filter = $input->param('to')) {
 180         if ($date_to = format_date_in_iso($filter)) {
 181                 $template->param(filter_date_approved_to=>$filter);
 182                 $filters{date_approved} = "<=$date_to";
 183         } else {
 184                 push @errors, {date_to=>$filter};
 185         }
 186 }
 187 if ($filter = $input->param('approver')) {              # name (or borrowernumber) from input box
 188         if ($filter =~ /^\d+$/ and $filter > 0) {
 189                 # $filter=get borrowernumber from name
 190                 # FIXME: get borrowernumber from name not implemented.
 191                 $template->param(filter_approver=>$filter);
 192                 $filters{approved_by} = $filter;
 193         } else {
 194                 push @errors, {approver=>$filter};
 195         }
 196 }
 197 if ($filter = $input->param('approved_by')) {   # borrowernumber from link
 198         if ($filter =~ /^\d+$/ and $filter > 0) {
 199                 $template->param(filter_approver=>$filter);
 200                 $filters{approved_by} = $filter;
 201         } else {
 202                 push @errors, {approved_by=>$filter};
 203         }
 204 }
 205 $debug and print STDERR "filters: " . Dumper(\%filters);
 206 my $tagloop = get_approval_rows(\%filters);
 207 my $qstring = $input->query_string;
 208 $qstring =~ s/([&;])*\blimit=\d+//;             # remove pagination var
 209 $qstring =~ s/^;+//;                                    # remove leading delims
 210 $qstring = "limit=$pagesize" . ($qstring ? '&amp;' . $qstring : '');
 211 $debug and print STDERR "number of approval_rows: " . scalar(@$tagloop) . "rows\n";
 212 (scalar @errors) and $template->param(message_loop=>\@errors);
 213 $template->param(
 214         offset => $offset,      # req'd for EXPR
 215         op => $op,
 216         op_count => scalar(@tags),
 217         script_name => $script_name,
 218         approved => 0,          # dummy value (also EXPR)
 219         tagloop => $tagloop,
 220         pagination_bar => pagination_bar(
 221                 "$script_name?$qstring\&amp;",
 222                 ceil($counts->{approved_total}/$pagesize),      # $page, 'page'
 223         )
 224 );
 225
 226 output_html_with_http_headers $input, $cookie, $template->output;
 227 __END__
 228
 229 =head1 AUTHOR
 230
 231 Joe Atzberger
 232 atz AT liblime.com
 233
 234 =cut