Bug 12728: Add StatisticsFields to sysprefs.sql
[koha.git] / opac / opac-tags.pl
blob1810ed37f3b6d01c566029b2ce9d43d69a1faff9
1 #!/usr/bin/perl
3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
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.
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.
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.
21 =head1 NAME
23 opac-tags.pl
25 =head1 DESCRIPTION
27 TODO :: Description here
29 C4::Scrubber is used to remove all markup content from the sumitted text.
31 =cut
33 use strict;
34 use warnings;
35 use CGI;
36 use CGI::Cookie; # need to check cookies before having CGI parse the POST request
38 use C4::Auth qw(:DEFAULT check_cookie_auth);
39 use C4::Context;
40 use C4::Debug;
41 use C4::Output qw(:html :ajax pagination_bar);
42 use C4::Scrubber;
43 use C4::Biblio;
44 use C4::Tags qw(add_tag get_approval_rows get_tag_rows remove_tag stratify_tags);
46 use Data::Dumper;
48 my %newtags = ();
49 my @deltags = ();
50 my %counts = ();
51 my @errors = ();
52 my $perBibResults = {};
54 # Indexes of @errors that do not apply to a particular biblionumber.
55 my @globalErrorIndexes = ();
57 sub ajax_auth_cgi { # returns CGI object
58 my $needed_flags = shift;
59 my %cookies = fetch CGI::Cookie;
60 my $input = CGI->new;
61 my $sessid = $cookies{'CGISESSID'}->value;
62 my ($auth_status, $auth_sessid) = check_cookie_auth($sessid, $needed_flags);
63 $debug and
64 print STDERR "($auth_status, $auth_sessid) = check_cookie_auth($sessid," . Dumper($needed_flags) . ")\n";
65 if ($auth_status ne "ok") {
66 output_with_http_headers $input, undef,
67 "window.alert('Your CGI session cookie ($sessid) is not current. " .
68 "Please refresh the page and try again.');\n", 'js';
69 exit 0;
71 $debug and print STDERR "AJAX request: " . Dumper($input),
72 "\n(\$auth_status,\$auth_sessid) = ($auth_status,$auth_sessid)\n";
73 return $input;
76 # The trick here is to support multiple tags added to multiple bilbios in one POST.
77 # The HTML might not use this, but it makes it more web-servicey from the start.
78 # So the name of param has to have biblionumber built in.
79 # For lack of anything more compelling, we just use "newtag[biblionumber]"
80 # We split the value into tags at comma and semicolon
82 my $is_ajax = is_ajax();
83 my $openadds = C4::Context->preference('TagsModeration') ? 0 : 1;
84 my $query = ($is_ajax) ? &ajax_auth_cgi({}) : CGI->new();
85 unless (C4::Context->preference('TagsEnabled')) {
86 push @errors, {+ tagsdisabled=>1 };
87 push @globalErrorIndexes, $#errors;
88 } else {
89 foreach ($query->param) {
90 if (/^newtag(.*)/) {
91 my $biblionumber = $1;
92 unless ($biblionumber =~ /^\d+$/) {
93 $debug and warn "$_ references non numerical biblionumber '$biblionumber'";
94 push @errors, {+'badparam' => $_ };
95 push @globalErrorIndexes, $#errors;
96 next;
98 $newtags{$biblionumber} = $query->param($_);
99 } elsif (/^del(\d+)$/) {
100 push @deltags, $1;
105 my $add_op = (scalar(keys %newtags) + scalar(@deltags)) ? 1 : 0;
106 my ($template, $loggedinuser, $cookie);
107 if ($is_ajax) {
108 $loggedinuser = C4::Context->userenv->{'number'}; # must occur AFTER auth
109 $debug and print STDERR "op: $loggedinuser\n";
110 } else {
111 ($template, $loggedinuser, $cookie) = get_template_and_user({
112 template_name => "opac-tags.tt",
113 query => $query,
114 type => "opac",
115 authnotrequired => ($add_op ? 0 : 1), # auth required to add tags
116 debug => 1,
120 if ($add_op) {
121 unless ($loggedinuser) {
122 push @errors, {+'login' => 1 };
123 push @globalErrorIndexes, $#errors;
124 %newtags=(); # zero out any attempted additions
125 @deltags=(); # zero out any attempted deletions
129 my $scrubber;
130 my @newtags_keys = (keys %newtags);
131 if (scalar @newtags_keys) {
132 $scrubber = C4::Scrubber->new();
133 foreach my $biblionumber (@newtags_keys) {
134 my $bibResults = {adds=>0, errors=>[]};
135 my @values = split /[;,]/, $newtags{$biblionumber};
136 foreach (@values) {
137 s/^\s*(.+)\s*$/$1/;
138 my $clean_tag = $scrubber->scrub($_);
139 unless ($clean_tag eq $_) {
140 if ($clean_tag =~ /\S/) {
141 push @errors, {scrubbed=>$clean_tag};
142 push @{$bibResults->{errors}}, {scrubbed=>$clean_tag};
143 } else {
144 push @errors, {scrubbed_all_bad=>1};
145 push @{$bibResults->{errors}}, {scrubbed_all_bad=>1};
146 next; # we don't add it if there's nothing left!
149 my $result = ($openadds) ?
150 add_tag($biblionumber,$clean_tag,$loggedinuser,$loggedinuser) : # pre-approved
151 add_tag($biblionumber,$clean_tag,$loggedinuser) ;
152 if ($result) {
153 $counts{$biblionumber}++;
154 $bibResults->{adds}++;
155 } else {
156 push @errors, {failed_add_tag=>$clean_tag};
157 push @{$bibResults->{errors}}, {failed_add_tag=>$clean_tag};
158 $debug and warn "add_tag($biblionumber,$clean_tag,$loggedinuser...) returned bad result (" . (defined $result ? $result : 'UNDEF') .")";
161 $perBibResults->{$biblionumber} = $bibResults;
164 my $dels = 0;
165 foreach (@deltags) {
166 if (remove_tag($_,$loggedinuser)) {
167 $dels++;
168 } else {
169 push @errors, {failed_delete=>$_};
173 if ($is_ajax) {
174 my $sum = 0;
175 foreach (values %counts) {$sum += $_;}
176 my $js_reply = sprintf("response = {\n\tadded: %d,\n\tdeleted: %d,\n\terrors: %d",$sum,$dels,scalar @errors);
178 # If no add attempts were made, flag global errors.
179 if (@globalErrorIndexes) {
180 $js_reply .= ",\n\tglobal_errors: [";
181 my $first = 1;
182 foreach (@globalErrorIndexes) {
183 $js_reply .= "," unless $first;
184 $first = 0;
185 $js_reply .= "\n\t\t$_";
187 $js_reply .= "\n\t]";
190 my $err_string = '';
191 if (scalar @errors) {
192 $err_string = ",\n\talerts: ["; # open response_function
193 my $i = 1;
194 foreach (@errors) {
195 my $key = (keys %$_)[0];
196 $err_string .= "\n\t\t KOHA.Tags.tag_message.$key(\"" . $_->{$key} . '")';
197 if($i < scalar @errors){ $err_string .= ","; }
198 $i++;
200 $err_string .= "\n\t]\n"; # close response_function
203 # Add per-biblionumber results for use on results page
204 my $js_perbib = "";
205 for my $bib (keys %$perBibResults) {
206 my $bibResult = $perBibResults->{$bib};
207 my $js_bibres = ",\n\t$bib: {\n\t\tadded: $bibResult->{adds}";
208 $js_bibres .= ",\n\t\terrors: [";
209 my $i = 0;
210 foreach (@{$bibResult->{errors}}) {
211 $js_bibres .= "," if ($i);
212 my $key = (keys %$_)[0];
213 $js_bibres .= "\n\t\t\t KOHA.Tags.tag_message.$key(\"" . $_->{$key} . '")';
214 $i++;
216 $js_bibres .= "\n\t\t]\n\t}";
217 $js_perbib .= $js_bibres;
220 output_with_http_headers($query, undef, "$js_reply\n$err_string\n$js_perbib\n};", 'js');
221 exit;
224 my $results = [];
225 my $my_tags = [];
227 if ($loggedinuser) {
228 $my_tags = get_tag_rows({borrowernumber=>$loggedinuser});
229 foreach (@$my_tags) {
230 my $biblio = GetBiblioData($_->{biblionumber});
231 $_->{bib_summary} = $biblio->{title};
232 ($biblio->{author}) and $_->{bib_summary} .= " by " . $biblio->{author};
233 my $date = $_->{date_created} || '';
234 $date =~ /\s+(\d{2}\:\d{2}\:\d{2})/;
235 $_->{time_created_display} = $1;
239 $template->param(tagsview => 1);
241 if ($add_op) {
242 my $adds = 0;
243 for (values %counts) {$adds += $_;}
244 $template->param(
245 add_op => 1,
246 added_count => $adds,
247 deleted_count => $dels,
249 } else {
250 my ($arg,$limit,$mine);
251 my $hardmax = 100; # you might disagree what this value should be, but there definitely should be a max
252 $limit = $query->param('limit') || $hardmax;
253 $mine = $query->param('mine') || 0; # set if the patron want to see only his own tags.
254 ($limit =~ /^\d+$/ and $limit <= $hardmax) or $limit = $hardmax;
255 $template->param(limit => $limit);
256 my $arghash = {approved=>1, limit=>$limit, 'sort'=>'-weight_total'};
257 $arghash->{'borrowernumber'} = $loggedinuser if $mine;
258 # ($openadds) or $arghash->{approved} = 1;
259 if ($arg = $query->param('tag')) {
260 $arghash->{term} = $arg;
261 } elsif ($arg = $query->param('biblionumber')) {
262 $arghash->{biblionumber} = $arg;
264 $results = get_approval_rows($arghash);
265 stratify_tags(10, $results); # work out the differents sizes for things
266 my $count = scalar @$results;
267 $template->param(TAGLOOP_COUNT => $count, mine => $mine);
269 (scalar @errors ) and $template->param(ERRORS => \@errors);
270 my @orderedresult = sort { uc($a->{'term'}) cmp uc($b->{'term'}) } @$results;
271 (scalar @$results) and $template->param(TAGLOOP => \@orderedresult );
272 (scalar @$my_tags) and $template->param(MY_TAGS => $my_tags);
274 output_html_with_http_headers $query, $cookie, $template->output;
275 __END__
277 =head1 EXAMPLE AJAX POST PARAMETERS
279 CGISESSID 7c6288263107beb320f70f78fd767f56
280 newtag396 fire,+<a+href="foobar.html">foobar</a>,+<img+src="foo.jpg"+/>
282 So this request is trying to add 3 tags to biblio #396. The CGISESSID is the same as that the browser would
283 typically communicate using cookies. If it is valid, the server will split the value of "newtag396" and
284 process the components for addition. In this case the intended tags are:
285 fire
286 <a+href="foobar.html">foobar</a>
287 <img src="foo.jpg" />
289 The first tag is acceptable. The second will be scrubbed of markup, resulting in the tag "foobar".
290 The third tag is all markup, and will be rejected.
292 =head1 EXAMPLE AJAX JSON response
294 response = {
295 added: 2,
296 deleted: 0,
297 errors: 2,
298 alerts: [
299 KOHA.Tags.tag_message.scrubbed("foobar"),
300 KOHA.Tags.tag_message.scrubbed_all_bad("1"),
304 =cut