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
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.
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.
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>.
27 TODO :: Description here
29 C4::Scrubber is used to remove all markup content from the sumitted text.
36 use CGI::Cookie; # need to check cookies before having CGI parse the POST request
38 use C4::Auth qw(:DEFAULT check_cookie_auth);
40 use C4::Output qw(:html :ajax );
43 use C4::Items qw(GetItemsInfo GetHiddenItemnumbers);
44 use C4::Tags qw(add_tag get_approval_rows get_tag_rows remove_tag stratify_tags);
51 use Koha::CirculationRules;
57 my $perBibResults = {};
59 # Indexes of @errors that do not apply to a particular biblionumber.
60 my @globalErrorIndexes = ();
62 sub ajax_auth_cgi { # returns CGI object
63 my $needed_flags = shift;
64 my %cookies = CGI::Cookie->fetch;
66 my $sessid = $cookies{'CGISESSID'}->value;
67 my ($auth_status, $auth_sessid) = check_cookie_auth($sessid, $needed_flags);
68 if ($auth_status ne "ok") {
69 output_with_http_headers $input, undef,
70 "window.alert('Your CGI session cookie ($sessid) is not current. " .
71 "Please refresh the page and try again.');\n", 'js';
77 # The trick here is to support multiple tags added to multiple bilbios in one POST.
78 # The HTML might not use this, but it makes it more web-servicey from the start.
79 # So the name of param has to have biblionumber built in.
80 # For lack of anything more compelling, we just use "newtag[biblionumber]"
81 # We split the value into tags at comma and semicolon
83 my $is_ajax = is_ajax();
84 my $openadds = C4::Context->preference('TagsModeration') ? 0 : 1;
85 my $query = ($is_ajax) ? &ajax_auth_cgi({}) : CGI->new();
86 foreach ($query->param) {
88 my $biblionumber = $1;
89 unless ($biblionumber =~ /^\d+$/) {
90 push @errors, {+'badparam' => $_ };
91 push @globalErrorIndexes, $#errors;
94 $newtags{$biblionumber} = $query->param($_);
95 } elsif (/^del(\d+)$/) {
100 my $add_op = (scalar(keys %newtags) + scalar(@deltags)) ? 1 : 0;
101 my ($template, $loggedinuser, $cookie);
103 $loggedinuser = C4::Context->userenv->{'number'}; # must occur AFTER auth
105 ($template, $loggedinuser, $cookie) = get_template_and_user({
106 template_name => "opac-tags.tt",
109 authnotrequired => ($add_op ? 0 : 1), # auth required to add tags
113 unless ( C4::Context->preference('TagsEnabled') ) {
114 print $query->redirect("/cgi-bin/koha/errors/404.pl");
119 unless ($loggedinuser) {
120 push @errors, {+'login' => 1 };
121 push @globalErrorIndexes, $#errors;
122 %newtags=(); # zero out any attempted additions
123 @deltags=(); # zero out any attempted deletions
128 my @newtags_keys = (keys %newtags);
129 if (scalar @newtags_keys) {
130 $scrubber = C4::Scrubber->new();
131 foreach my $biblionumber (@newtags_keys) {
132 my $bibResults = {adds=>0, errors=>[]};
133 my @values = split /[;,]/, $newtags{$biblionumber};
136 my $clean_tag = $scrubber->scrub($_);
137 unless ($clean_tag eq $_) {
138 if ($clean_tag =~ /\S/) {
139 push @errors, {scrubbed=>$clean_tag};
140 push @{$bibResults->{errors}}, {scrubbed=>$clean_tag};
142 push @errors, {scrubbed_all_bad=>1};
143 push @{$bibResults->{errors}}, {scrubbed_all_bad=>1};
144 next; # we don't add it if there's nothing left!
147 my $result = ($openadds) ?
148 add_tag($biblionumber,$clean_tag,$loggedinuser,$loggedinuser) : # pre-approved
149 add_tag($biblionumber,$clean_tag,$loggedinuser) ;
151 $counts{$biblionumber}++;
152 $bibResults->{adds}++;
154 push @errors, {failed_add_tag=>$clean_tag};
155 push @{$bibResults->{errors}}, {failed_add_tag=>$clean_tag};
156 Koha::Logger->get->warn("add_tag($biblionumber,$clean_tag,$loggedinuser...) returned bad result (" . (defined $result ? $result : 'UNDEF') .")");
159 $perBibResults->{$biblionumber} = $bibResults;
164 if (remove_tag($_,$loggedinuser)) {
167 push @errors, {failed_delete=>$_};
173 foreach (values %counts) {$sum += $_;}
174 my $js_reply = sprintf("response = {\n\tadded: %d,\n\tdeleted: %d,\n\terrors: %d",$sum,$dels,scalar @errors);
176 # If no add attempts were made, flag global errors.
177 if (@globalErrorIndexes) {
178 $js_reply .= ",\n\tglobal_errors: [";
180 foreach (@globalErrorIndexes) {
181 $js_reply .= "," unless $first;
183 $js_reply .= "\n\t\t$_";
185 $js_reply .= "\n\t]";
189 if (scalar @errors) {
190 $err_string = ",\n\talerts: ["; # open response_function
193 my $key = (keys %$_)[0];
194 $err_string .= "\n\t\t KOHA.Tags.tag_message.$key(\"" . $_->{$key} . '")';
195 if($i < scalar @errors){ $err_string .= ","; }
198 $err_string .= "\n\t]\n"; # close response_function
201 # Add per-biblionumber results for use on results page
203 for my $bib (keys %$perBibResults) {
204 my $bibResult = $perBibResults->{$bib};
205 my $js_bibres = ",\n\t$bib: {\n\t\tadded: $bibResult->{adds}";
206 $js_bibres .= ",\n\t\terrors: [";
208 foreach (@{$bibResult->{errors}}) {
209 $js_bibres .= "," if ($i);
210 my $key = (keys %$_)[0];
211 $js_bibres .= "\n\t\t\t KOHA.Tags.tag_message.$key(\"" . $_->{$key} . '")';
214 $js_bibres .= "\n\t\t]\n\t}";
215 $js_perbib .= $js_bibres;
218 output_with_http_headers($query, undef, "$js_reply\n$err_string\n$js_perbib\n};", 'js');
227 my $patron = Koha::Patrons->find( { borrowernumber => $loggedinuser } );
228 $borcat = $patron ? $patron->categorycode : $borcat;
229 my $rules = C4::Context->yaml_preference('OpacHiddenItems');
230 my $should_hide = ( $rules ) ? 1 : 0;
231 $my_tags = get_tag_rows({borrowernumber=>$loggedinuser});
232 my $my_approved_tags = get_approval_rows({ approved => 1 });
235 if( C4::Context->preference('ArticleRequests') ) {
236 $art_req_itypes = Koha::CirculationRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
239 # get biblionumbers stored in the cart
242 if($query->cookie("bib_list")){
243 my $cart_list = $query->cookie("bib_list");
244 @cart_list = split(/\//, $cart_list);
247 foreach my $tag (@$my_tags) {
249 my $biblio = Koha::Biblios->find( $tag->{biblionumber} );
250 my $record = &GetMarcBiblio({
251 biblionumber => $tag->{biblionumber},
254 borcat => $borcat });
256 my $hidden_items = undef;
257 my @hidden_itemnumbers;
260 @all_items = GetItemsInfo( $tag->{biblionumber} );
261 @hidden_itemnumbers = GetHiddenItemnumbers({
262 items => \@all_items,
263 borcat => $borcat });
264 $hidden_items = \@hidden_itemnumbers;
270 or ( $patron and !$patron->category->override_hidden_items )
272 and $biblio->hidden_in_opac( { rules => $rules } )
274 $tag->{title} = $biblio->title;
275 $tag->{subtitle} = $biblio->subtitle;
276 $tag->{medium} = $biblio->medium;
277 $tag->{part_number} = $biblio->part_number;
278 $tag->{part_name} = $biblio->part_name;
279 $tag->{author} = $biblio->author;
280 # BZ17530: 'Intelligent' guess if result can be article requested
281 $tag->{artreqpossible} = ( $art_req_itypes->{ $tag->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
283 my $xslfile = C4::Context->preference('OPACXSLTResultsDisplay');
284 my $lang = $xslfile ? C4::Languages::getlanguage() : undef;
285 my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
289 anonymous_session => ($loggedinuser) ? 0 : 1
291 $tag->{XSLTBloc} = XSLTParse4Display(
292 $tag->{biblionumber}, $record,
293 "OPACXSLTResultsDisplay", 1,
294 $hidden_items, $sysxml,
300 my $date = $tag->{date_created} || '';
301 $date =~ /\s+(\d{2}\:\d{2}\:\d{2})/;
302 $tag->{time_created_display} = $1;
303 $tag->{approved} = ( grep { $_->{term} eq $tag->{term} and $_->{approved} } @$my_approved_tags );
305 # while we're checking each line, see if item is in the cart
306 if ( grep {$_ eq $biblio->biblionumber} @cart_list) {
312 $template->param(tagsview => 1);
316 for (values %counts) {$adds += $_;}
319 added_count => $adds,
320 deleted_count => $dels,
323 my ($arg,$limit,$mine);
324 my $hardmax = 100; # you might disagree what this value should be, but there definitely should be a max
325 $limit = $query->param('limit') || $hardmax;
326 $mine = $query->param('mine') || 0; # set if the patron want to see only his own tags.
327 ($limit =~ /^\d+$/ and $limit <= $hardmax) or $limit = $hardmax;
328 $template->param(limit => $limit);
329 my $arghash = {approved=>1, limit=>$limit, 'sort'=>'-weight_total'};
330 $arghash->{'borrowernumber'} = $loggedinuser if $mine;
331 # ($openadds) or $arghash->{approved} = 1;
332 if ($arg = $query->param('tag')) {
333 $arghash->{term} = $arg;
334 } elsif ($arg = $query->param('biblionumber')) {
335 $arghash->{biblionumber} = $arg;
337 $results = get_approval_rows($arghash);
338 stratify_tags(10, $results); # work out the differents sizes for things
339 my $count = scalar @$results;
340 $template->param(TAGLOOP_COUNT => $count, mine => $mine);
342 (scalar @errors ) and $template->param(ERRORS => \@errors);
343 my @orderedresult = sort { uc($a->{'term'}) cmp uc($b->{'term'}) } @$results;
344 (scalar @$results) and $template->param(TAGLOOP => \@orderedresult );
345 (scalar @$my_tags) and $template->param(MY_TAGS => $my_tags);
347 output_html_with_http_headers $query, $cookie, $template->output;
350 =head1 EXAMPLE AJAX POST PARAMETERS
352 CGISESSID 7c6288263107beb320f70f78fd767f56
353 newtag396 fire,+<a+href="foobar.html">foobar</a>,+<img+src="foo.jpg"+/>
355 So this request is trying to add 3 tags to biblio #396. The CGISESSID is the same as that the browser would
356 typically communicate using cookies. If it is valid, the server will split the value of "newtag396" and
357 process the components for addition. In this case the intended tags are:
359 <a+href="foobar.html">foobar</a>
360 <img src="foo.jpg" />
362 The first tag is acceptable. The second will be scrubbed of markup, resulting in the tag "foobar".
363 The third tag is all markup, and will be rejected.
365 =head1 EXAMPLE AJAX JSON response
372 KOHA.Tags.tag_message.scrubbed("foobar"),
373 KOHA.Tags.tag_message.scrubbed_all_bad("1"),