opac/opac-tags.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2000-2002 Katipo Communications
   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
  21 =head1 NAME
  22
  23 opac-tags.pl
  24
  25 =head1 DESCRIPTION
  26
  27 TODO :: Description here
  28
  29 C4::Scrubber is used to remove all markup content from the sumitted text.
  30
  31 =cut
  32
  33 use Modern::Perl;
  34
  35 use CGI qw ( -utf8 );
  36 use CGI::Cookie; # need to check cookies before having CGI parse the POST request
  37
  38 use C4::Auth qw(:DEFAULT check_cookie_auth);
  39 use C4::Context;
  40 use C4::Debug;
  41 use C4::Output qw(:html :ajax );
  42 use C4::Scrubber;
  43 use C4::Biblio;
  44 use C4::Items qw(GetItemsInfo GetHiddenItemnumbers);
  45 use C4::Tags qw(add_tag get_approval_rows get_tag_rows remove_tag stratify_tags);
  46 use C4::XSLT;
  47
  48 use Data::Dumper;
  49
  50 use Koha::Biblios;
  51 use Koha::CirculationRules;
  52
  53 my %newtags = ();
  54 my @deltags = ();
  55 my %counts  = ();
  56 my @errors  = ();
  57 my $perBibResults = {};
  58
  59 # Indexes of @errors that do not apply to a particular biblionumber.
  60 my @globalErrorIndexes = ();
  61
  62 sub ajax_auth_cgi {     # returns CGI object
  63         my $needed_flags = shift;
  64     my %cookies = CGI::Cookie->fetch;
  65         my $input = CGI->new;
  66     my $sessid = $cookies{'CGISESSID'}->value;
  67         my ($auth_status, $auth_sessid) = check_cookie_auth($sessid, $needed_flags);
  68         $debug and
  69         print STDERR "($auth_status, $auth_sessid) = check_cookie_auth($sessid," . Dumper($needed_flags) . ")\n";
  70         if ($auth_status ne "ok") {
  71                 output_with_http_headers $input, undef,
  72                 "window.alert('Your CGI session cookie ($sessid) is not current.  " .
  73                 "Please refresh the page and try again.');\n", 'js';
  74                 exit 0;
  75         }
  76         $debug and print STDERR "AJAX request: " . Dumper($input),
  77                 "\n(\$auth_status,\$auth_sessid) = ($auth_status,$auth_sessid)\n";
  78         return $input;
  79 }
  80
  81 # The trick here is to support multiple tags added to multiple bilbios in one POST.
  82 # The HTML might not use this, but it makes it more web-servicey from the start.
  83 # So the name of param has to have biblionumber built in.
  84 # For lack of anything more compelling, we just use "newtag[biblionumber]"
  85 # We split the value into tags at comma and semicolon
  86
  87 my $is_ajax = is_ajax();
  88 my $openadds = C4::Context->preference('TagsModeration') ? 0 : 1;
  89 my $query = ($is_ajax) ? &ajax_auth_cgi({}) : CGI->new();
  90 foreach ($query->param) {
  91     if (/^newtag(.*)/) {
  92         my $biblionumber = $1;
  93         unless ($biblionumber =~ /^\d+$/) {
  94             $debug and warn "$_ references non numerical biblionumber '$biblionumber'";
  95             push @errors, {+'badparam' => $_ };
  96             push @globalErrorIndexes, $#errors;
  97             next;
  98         }
  99         $newtags{$biblionumber} = $query->param($_);
 100     } elsif (/^del(\d+)$/) {
 101         push @deltags, $1;
 102     }
 103 }
 104
 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         });
 117 }
 118
 119 unless ( C4::Context->preference('TagsEnabled') ) {
 120     print $query->redirect("/cgi-bin/koha/errors/404.pl");
 121     exit;
 122 }
 123
 124 if ($add_op) {
 125         unless ($loggedinuser) {
 126                 push @errors, {+'login' => 1 };
 127         push @globalErrorIndexes, $#errors;
 128                 %newtags=();    # zero out any attempted additions
 129                 @deltags=();    # zero out any attempted deletions
 130         }
 131 }
 132
 133 my $scrubber;
 134 my @newtags_keys = (keys %newtags);
 135 if (scalar @newtags_keys) {
 136         $scrubber = C4::Scrubber->new();
 137         foreach my $biblionumber (@newtags_keys) {
 138         my $bibResults = {adds=>0, errors=>[]};
 139                 my @values = split /[;,]/, $newtags{$biblionumber};
 140                 foreach (@values) {
 141                         s/^\s*(.+)\s*$/$1/;
 142                         my $clean_tag = $scrubber->scrub($_);
 143                         unless ($clean_tag eq $_) {
 144                                 if ($clean_tag =~ /\S/) {
 145                                         push @errors, {scrubbed=>$clean_tag};
 146                                         push @{$bibResults->{errors}}, {scrubbed=>$clean_tag};
 147                                 } else {
 148                                         push @errors, {scrubbed_all_bad=>1};
 149                                         push @{$bibResults->{errors}}, {scrubbed_all_bad=>1};
 150                                         next;   # we don't add it if there's nothing left!
 151                                 }
 152                         }
 153                         my $result = ($openadds) ?
 154                                 add_tag($biblionumber,$clean_tag,$loggedinuser,$loggedinuser) : # pre-approved
 155                                 add_tag($biblionumber,$clean_tag,$loggedinuser)   ;
 156                         if ($result) {
 157                                 $counts{$biblionumber}++;
 158                 $bibResults->{adds}++;
 159                         } else {
 160                                 push @errors, {failed_add_tag=>$clean_tag};
 161                                 push @{$bibResults->{errors}}, {failed_add_tag=>$clean_tag};
 162                                 $debug and warn "add_tag($biblionumber,$clean_tag,$loggedinuser...) returned bad result (" . (defined $result ? $result : 'UNDEF') .")";
 163                         }
 164                 }
 165         $perBibResults->{$biblionumber} = $bibResults;
 166         }
 167 }
 168 my $dels = 0;
 169 foreach (@deltags) {
 170         if (remove_tag($_,$loggedinuser)) {
 171                 $dels++;
 172         } else {
 173                 push @errors, {failed_delete=>$_};
 174         }
 175 }
 176
 177 if ($is_ajax) {
 178         my $sum = 0;
 179         foreach (values %counts) {$sum += $_;}
 180         my $js_reply = sprintf("response = {\n\tadded: %d,\n\tdeleted: %d,\n\terrors: %d",$sum,$dels,scalar @errors);
 181
 182     # If no add attempts were made, flag global errors.
 183     if (@globalErrorIndexes) {
 184         $js_reply .= ",\n\tglobal_errors: [";
 185         my $first = 1;
 186         foreach (@globalErrorIndexes) {
 187             $js_reply .= "," unless $first;
 188             $first = 0;
 189             $js_reply .= "\n\t\t$_";
 190         }
 191         $js_reply .= "\n\t]";
 192     }
 193
 194         my $err_string = '';
 195         if (scalar @errors) {
 196                 $err_string = ",\n\talerts: ["; # open response_function
 197                 my $i = 1;
 198                 foreach (@errors) {
 199                         my $key = (keys %$_)[0];
 200                         $err_string .= "\n\t\t KOHA.Tags.tag_message.$key(\"" . $_->{$key} . '")';
 201                         if($i < scalar @errors){ $err_string .= ","; }
 202                         $i++;
 203                 }
 204                 $err_string .= "\n\t]\n";       # close response_function
 205         }
 206
 207     # Add per-biblionumber results for use on results page
 208     my $js_perbib = "";
 209     for my $bib (keys %$perBibResults) {
 210         my $bibResult = $perBibResults->{$bib};
 211         my $js_bibres = ",\n\t$bib: {\n\t\tadded: $bibResult->{adds}";
 212         $js_bibres .= ",\n\t\terrors: [";
 213         my $i = 0;
 214         foreach (@{$bibResult->{errors}}) {
 215             $js_bibres .= "," if ($i);
 216                         my $key = (keys %$_)[0];
 217                         $js_bibres .= "\n\t\t\t KOHA.Tags.tag_message.$key(\"" . $_->{$key} . '")';
 218             $i++;
 219         }
 220         $js_bibres .= "\n\t\t]\n\t}";
 221         $js_perbib .= $js_bibres;
 222     }
 223
 224         output_with_http_headers($query, undef, "$js_reply\n$err_string\n$js_perbib\n};", 'js');
 225         exit;
 226 }
 227
 228 my $results = [];
 229 my $my_tags = [];
 230 my $borcat  = q{};
 231
 232 if ($loggedinuser) {
 233     my $patron = Koha::Patrons->find( { borrowernumber => $loggedinuser } );
 234     $borcat = $patron ? $patron->categorycode : $borcat;
 235     my $rules = C4::Context->yaml_preference('OpacHiddenItems');
 236     my $should_hide = ( $rules ) ? 1 : 0;
 237     $my_tags = get_tag_rows({borrowernumber=>$loggedinuser});
 238     my $my_approved_tags = get_approval_rows({ approved => 1 });
 239
 240     my $art_req_itypes;
 241     if( C4::Context->preference('ArticleRequests') ) {
 242         $art_req_itypes = Koha::CirculationRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
 243     }
 244
 245     # get biblionumbers stored in the cart
 246     my @cart_list;
 247
 248     if($query->cookie("bib_list")){
 249         my $cart_list = $query->cookie("bib_list");
 250         @cart_list = split(/\//, $cart_list);
 251     }
 252
 253     foreach my $tag (@$my_tags) {
 254         $tag->{visible} = 0;
 255         my $biblio = Koha::Biblios->find( $tag->{biblionumber} );
 256         my $record = &GetMarcBiblio({
 257             biblionumber => $tag->{biblionumber},
 258             embed_items  => 1,
 259             opac         => 1,
 260             borcat       => $borcat });
 261         next unless $record;
 262         my $hidden_items = undef;
 263         my @hidden_itemnumbers;
 264         my @all_items;
 265         if ($should_hide) {
 266             @all_items = GetItemsInfo( $tag->{biblionumber} );
 267             @hidden_itemnumbers = GetHiddenItemnumbers({
 268                 items => \@all_items,
 269                 borcat => $borcat });
 270             $hidden_items = \@hidden_itemnumbers;
 271         }
 272         next
 273           if (
 274             (
 275                 !$patron
 276                 or ( $patron and !$patron->category->override_hidden_items )
 277             )
 278             and $biblio->hidden_in_opac( { rules => $rules } )
 279           );
 280         $tag->{title} = $biblio->title;
 281         $tag->{subtitle} = $biblio->subtitle;
 282         $tag->{medium} = $biblio->medium;
 283         $tag->{part_number} = $biblio->part_number;
 284         $tag->{part_name} = $biblio->part_name;
 285         $tag->{author} = $biblio->author;
 286         # BZ17530: 'Intelligent' guess if result can be article requested
 287         $tag->{artreqpossible} = ( $art_req_itypes->{ $tag->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
 288
 289         my $xslfile = C4::Context->preference('OPACXSLTResultsDisplay');
 290         my $lang   = $xslfile ? C4::Languages::getlanguage()  : undef;
 291         my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
 292
 293         if ($xslfile) {
 294             my $variables = {
 295                 anonymous_session => ($loggedinuser) ? 0 : 1
 296             };
 297             $tag->{XSLTBloc} = XSLTParse4Display(
 298                 $tag->{biblionumber},     $record,
 299                 "OPACXSLTResultsDisplay", 1,
 300                 $hidden_items,            $sysxml,
 301                 $xslfile,                 $lang,
 302                 $variables
 303             );
 304         }
 305
 306         my $date = $tag->{date_created} || '';
 307         $date =~ /\s+(\d{2}\:\d{2}\:\d{2})/;
 308         $tag->{time_created_display} = $1;
 309         $tag->{approved} = ( grep { $_->{term} eq $tag->{term} and $_->{approved} } @$my_approved_tags );
 310         $tag->{visible} = 1;
 311         # while we're checking each line, see if item is in the cart
 312         if ( grep {$_ eq $biblio->biblionumber} @cart_list) {
 313             $tag->{incart} = 1;
 314         }
 315     }
 316 }
 317
 318 $template->param(tagsview => 1);
 319
 320 if ($add_op) {
 321         my $adds = 0;
 322         for (values %counts) {$adds += $_;}
 323         $template->param(
 324                 add_op => 1,
 325                 added_count => $adds,
 326                 deleted_count => $dels,
 327         );
 328 } else {
 329         my ($arg,$limit,$mine);
 330         my $hardmax = 100;      # you might disagree what this value should be, but there definitely should be a max
 331         $limit = $query->param('limit') || $hardmax;
 332     $mine =  $query->param('mine') || 0; # set if the patron want to see only his own tags.
 333         ($limit =~ /^\d+$/ and $limit <= $hardmax) or $limit = $hardmax;
 334         $template->param(limit => $limit);
 335         my $arghash = {approved=>1, limit=>$limit, 'sort'=>'-weight_total'};
 336     $arghash->{'borrowernumber'} = $loggedinuser if $mine;
 337         # ($openadds) or $arghash->{approved} = 1;
 338         if ($arg = $query->param('tag')) {
 339                 $arghash->{term} = $arg;
 340         } elsif ($arg = $query->param('biblionumber')) {
 341                 $arghash->{biblionumber} = $arg;
 342         }
 343         $results = get_approval_rows($arghash);
 344     stratify_tags(10, $results); # work out the differents sizes for things
 345         my $count = scalar @$results;
 346         $template->param(TAGLOOP_COUNT => $count, mine => $mine);
 347 }
 348 (scalar @errors  ) and $template->param(ERRORS  => \@errors);
 349 my @orderedresult = sort { uc($a->{'term'}) cmp uc($b->{'term'}) } @$results;
 350 (scalar @$results) and $template->param(TAGLOOP => \@orderedresult );
 351 (scalar @$my_tags) and $template->param(MY_TAGS => $my_tags);
 352
 353 output_html_with_http_headers $query, $cookie, $template->output;
 354 __END__
 355
 356 =head1 EXAMPLE AJAX POST PARAMETERS
 357
 358 CGISESSID       7c6288263107beb320f70f78fd767f56
 359 newtag396       fire,+<a+href="foobar.html">foobar</a>,+<img+src="foo.jpg"+/>
 360
 361 So this request is trying to add 3 tags to biblio #396.  The CGISESSID is the same as that the browser would
 362 typically communicate using cookies.  If it is valid, the server will split the value of "newtag396" and
 363 process the components for addition.  In this case the intended tags are:
 364         fire
 365         <a+href="foobar.html">foobar</a>
 366         <img src="foo.jpg" />
 367
 368 The first tag is acceptable.  The second will be scrubbed of markup, resulting in the tag "foobar".
 369 The third tag is all markup, and will be rejected.
 370
 371 =head1 EXAMPLE AJAX JSON response
 372
 373 response = {
 374         added: 2,
 375         deleted: 0,
 376         errors: 2,
 377         alerts: [
 378                  KOHA.Tags.tag_message.scrubbed("foobar"),
 379                  KOHA.Tags.tag_message.scrubbed_all_bad("1"),
 380         ],
 381 };
 382
 383 =cut
 384