Merge remote-tracking branch 'origin/new/bug_6488'
[koha.git] / 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;
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 3.02 qw(:html :ajax pagination_bar);
34 use C4::Debug;
35 use C4::Tags 0.03 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 || $input->param('CGISESSID');
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                 template_name => "tags/review.tmpl",
84                 query => $input,
85                  type => "intranet",
86                 debug => 1,
87                 authnotrequired => 0,
88                   flagsrequired => $needed_flags,
89 });
90
91 my ($op, @errors, @tags);
92 $op   = lc($input->param('op')) || 'none';
93 @tags = $input->param('tags');
94
95 $borrowernumber == 0 and push @errors, {op_zero=>1};
96      if ($op eq 'approve') {
97         foreach (@tags) {
98                 whitelist($borrowernumber,$_) or push @errors, {failed_ok=>$_};
99         }
100 } elsif ($op eq 'reject' ) {
101         foreach (@tags) {
102                 blacklist($borrowernumber,$_) or push @errors, {failed_rej=>$_};
103         }
104 } elsif ($op eq 'test'   ) {
105         my $tag = $input->param('test');
106         push @tags, $tag;
107         my $check = is_approved($tag);
108         $template->param(
109                 test_term => $tag,
110                 ( $check >=  1 ? 'verdict_ok' :
111                   $check <= -1 ? 'verdict_rej' : 'verdict_indeterminate' ) => 1,
112         );
113 }
114
115 my $counts = &approval_counts;
116 foreach (keys %$counts) {
117         $template->param($_ => $counts->{$_});
118 }
119
120 sub pagination_calc ($;$) {
121         my $query = shift or return undef;      
122         my $hardlimit = (@_) ? shift : 100;     # hardcoded, could be another syspref
123         my $pagesize = $query->param('limit' ) || $hardlimit;
124         my $page     = $query->param('page'  ) || 1;
125         my $offset   = $query->param('offset') || 0;
126         ($pagesize <= $hardlimit) or $pagesize = $hardlimit;
127         if ($page > 1) {
128                 $offset = ($page-1)*$pagesize;
129         } else {
130                 $page = 1;
131         }
132         return ($pagesize,$page,$offset);
133 }
134
135 my ($pagesize,$page,$offset) = pagination_calc($input,100);
136
137 my %filters = (
138         limit => $offset ? "$offset,$pagesize" : $pagesize,
139          sort => 'approved,-weight_total,+term',
140 );
141 my ($filter,$date_from,$date_to);
142 if (defined $input->param('approved')) { # 0 is valid value, must check defined
143         $filter = $input->param('approved');
144 } else {
145         $filter = 0;
146 }
147 if ($filter eq 'all') {
148         $template->param(filter_approved_all => 1);
149 } elsif ($filter =~ /-?[01]/) {
150         $filters{approved} = $filter;
151         $template->param(
152                 ($filter == 1  ? 'filter_approved_ok'      : 
153                  $filter == 0  ? 'filter_approved_pending' :
154                  $filter == -1 ? 'filter_approved_rej'     :
155                 'filter_approved') => 1
156         );
157 }
158
159 # my $q_count = get_approval_rows({limit=>$pagesize, sort=>'approved,-weight_total,+term', count=>1});
160 if ($filter = $input->param('tag')) {
161         $template->param(filter_tag=>$filter);
162         $filters{term} = $filter;
163 }
164 if ($filter = $input->param('from')) {
165         if ($date_from = format_date_in_iso($filter)) {
166                 $template->param(filter_date_approved_from=>$filter);
167                 $filters{date_approved} = ">=$date_from";
168         } else {
169                 push @errors, {date_from=>$filter};
170         }
171 }
172 if ($filter = $input->param('to')) {
173         if ($date_to = format_date_in_iso($filter)) {
174                 $template->param(filter_date_approved_to=>$filter);
175                 $filters{date_approved} = "<=$date_to";
176         } else {
177                 push @errors, {date_to=>$filter};
178         }
179 }
180 if ($filter = $input->param('approver')) {              # name (or borrowernumber) from input box
181         if ($filter =~ /^\d+$/ and $filter > 0) {
182                 # $filter=get borrowernumber from name
183                 # FIXME: get borrowernumber from name not implemented.
184                 $template->param(filter_approver=>$filter);
185                 $filters{approved_by} = $filter;
186         } else {
187                 push @errors, {approver=>$filter};
188         }
189 }
190 if ($filter = $input->param('approved_by')) {   # borrowernumber from link
191         if ($filter =~ /^\d+$/ and $filter > 0) {
192                 $template->param(filter_approver=>$filter);
193                 $filters{approved_by} = $filter;
194         } else {
195                 push @errors, {approved_by=>$filter};
196         }
197 }
198 $debug and print STDERR "filters: " . Dumper(\%filters);
199 my $tagloop = get_approval_rows(\%filters);
200 for ( @{$tagloop} ) {
201     $_->{date_approved} = format_date( $_->{date_approved} );
202 }
203 my $qstring = $input->query_string;
204 $qstring =~ s/([&;])*\blimit=\d+//;             # remove pagination var
205 $qstring =~ s/^;+//;                                    # remove leading delims
206 $qstring = "limit=$pagesize" . ($qstring ? '&amp;' . $qstring : '');
207 $debug and print STDERR "number of approval_rows: " . scalar(@$tagloop) . "rows\n";
208 (scalar @errors) and $template->param(message_loop=>\@errors);
209 $template->param(
210         DHTMLcalendar_dateformat => C4::Dates->DHTMLcalendar(),
211         offset => $offset,      # req'd for EXPR
212         op => $op,
213         op_count => scalar(@tags),
214         script_name => $script_name,
215         approved => 0,          # dummy value (also EXPR)
216         tagloop => $tagloop,
217         pagination_bar => pagination_bar(
218                 "$script_name?$qstring\&amp;",
219                 ceil($counts->{approved_total}/$pagesize),      # $page, 'page'
220         )
221 );
222
223 output_html_with_http_headers $input, $cookie, $template->output;
224 __END__
225
226 =head1 AUTHOR
227
228 Joe Atzberger
229 atz AT liblime.com
230
231 =cut