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