From ec87e5310ad038abe4b2b329897638d866bf549a Mon Sep 17 00:00:00 2001 From: Dylan William Hardison Date: Tue, 14 Aug 2018 08:28:31 -0400 Subject: Revert "Bug 1456878 - Support markdown comments" This reverts commit fd850e00db835d2b84c59014c3b1021fea2294fc. --- Bugzilla/Bug.pm | 8 ++--- Bugzilla/Comment.pm | 7 ---- Bugzilla/Hook.pm | 6 ++++ Bugzilla/Template.pm | 80 ++++++++++++++++------------------------------ Bugzilla/WebService/Bug.pm | 7 ++-- 5 files changed, 39 insertions(+), 69 deletions(-) (limited to 'Bugzilla') diff --git a/Bugzilla/Bug.pm b/Bugzilla/Bug.pm index 9c820eedc..ee48ed7a2 100644 --- a/Bugzilla/Bug.pm +++ b/Bugzilla/Bug.pm @@ -732,7 +732,7 @@ sub _preload_referenced_bugs { } else { # bugs referenced in comments - Bugzilla::Template::renderComment($comment->body, undef, undef, 1, + Bugzilla::Template::quoteUrls($comment->body, undef, undef, undef, sub { my $bug_id = $_[0]; push @referenced_bug_ids, $bug_id @@ -999,7 +999,6 @@ sub create { # We now have a bug id so we can fill this out $creation_comment->{'bug_id'} = $bug->id; - $creation_comment->{'is_markdown'} = 1; # Insert the comment. We always insert a comment on bug creation, # but sometimes it's blank. @@ -2663,8 +2662,7 @@ sub set_all { # there are lots of things that want to check if we added a comment. $self->add_comment($params->{'comment'}->{'body'}, { isprivate => $params->{'comment'}->{'is_private'}, - work_time => $params->{'work_time'}, - is_markdown => 1 }); + work_time => $params->{'work_time'} }); } if (defined $params->{comment_tags} && Bugzilla->user->can_tag_comments()) { @@ -3145,7 +3143,7 @@ sub remove_cc { @$cc_users = grep { $_->id != $user->id } @$cc_users; } -# $bug->add_comment("comment", {isprivate => 1, work_time => 10.5, is_markdown => 1, +# $bug->add_comment("comment", {isprivate => 1, work_time => 10.5, # type => CMT_NORMAL, extra_data => $data}); sub add_comment { my ($self, $comment, $params) = @_; diff --git a/Bugzilla/Comment.pm b/Bugzilla/Comment.pm index 937cd1203..f9a6f7d3a 100644 --- a/Bugzilla/Comment.pm +++ b/Bugzilla/Comment.pm @@ -45,7 +45,6 @@ use constant DB_COLUMNS => qw( already_wrapped type extra_data - is_markdown ); use constant UPDATE_COLUMNS => qw( @@ -68,7 +67,6 @@ use constant VALIDATORS => { work_time => \&_check_work_time, thetext => \&_check_thetext, isprivate => \&_check_isprivate, - is_markdown => \&Bugzilla::Object::check_boolean, extra_data => \&_check_extra_data, type => \&_check_type, }; @@ -235,7 +233,6 @@ sub body { return $_[0]->{'thetext'}; } sub bug_id { return $_[0]->{'bug_id'}; } sub creation_ts { return $_[0]->{'bug_when'}; } sub is_private { return $_[0]->{'isprivate'}; } -sub is_markdown { return $_[0]->{'is_markdown'}; } sub work_time { # Work time is returned as a string (see bug 607909) return 0 if $_[0]->{'work_time'} + 0 == 0; @@ -579,10 +576,6 @@ C Time spent as related to this comment. C Comment is marked as private. -=item C - -C Whether this comment needs Markdown rendering to be applied. - =item C If this comment is stored in the database word-wrapped, this will be C<1>. diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm index d27468f55..bed6a53b0 100644 --- a/Bugzilla/Hook.pm +++ b/Bugzilla/Hook.pm @@ -438,6 +438,12 @@ Sometimes this is C, meaning that we are parsing text that is not a bug comment (but could still be some other part of a bug, like the summary line). +=item C + +The L object representing the user who will see the text. +This is useful to determine how much confidential information can be displayed +to the user. + =back =head2 bug_start_of_update diff --git a/Bugzilla/Template.pm b/Bugzilla/Template.pm index f74565302..299734d64 100644 --- a/Bugzilla/Template.pm +++ b/Bugzilla/Template.pm @@ -130,20 +130,17 @@ sub get_format { }; } -# This routine renderComment contains inspirations from the HTML::FromText CPAN +# This routine quoteUrls contains inspirations from the HTML::FromText CPAN # module by Gareth Rees . It has been heavily hacked, # all that is really recognizable from the original is bits of the regular # expressions. # This has been rewritten to be faster, mainly by substituting 'as we go'. # If you want to modify this routine, read the comments carefully -# Renamed from 'quoteUrls' to 'renderComment' after markdown support was added. -sub renderComment { - my ($text, $bug, $comment, $skip_markdown, $bug_link_func) = @_; +sub quoteUrls { + my ($text, $bug, $comment, $user, $bug_link_func) = @_; return $text unless $text; - my $anon_user = Bugzilla::User->new; - # We choose to render markdown by default, unless the comment explicitly isn't. - $skip_markdown ||= $comment && !$comment->is_markdown; + $user ||= Bugzilla->user; $bug_link_func ||= \&get_bug_link; # We use /g for speed, but uris can have other things inside them @@ -176,7 +173,7 @@ sub renderComment { my @hook_regexes; Bugzilla::Hook::process('bug_format_comment', { text => \$text, bug => $bug, regexes => \@hook_regexes, - comment => $comment, user => undef }); + comment => $comment, user => $user }); foreach my $re (@hook_regexes) { my ($match, $replace) = @$re{qw(match replace)}; @@ -196,47 +193,37 @@ sub renderComment { # Provide tooltips for full bug links (Bug 74355) my $urlbase_re = '(' . quotemeta(Bugzilla->localconfig->{urlbase}) . ')'; $text =~ s~\b(${urlbase_re}\Qshow_bug.cgi?id=\E([0-9]+)(\#c([0-9]+))?)\b - ~($things[$count++] = $bug_link_func->($3, $1, { comment_num => $5, user => $anon_user })) && + ~($things[$count++] = $bug_link_func->($3, $1, { comment_num => $5, user => $user })) && ("\x{FDD2}" . ($count-1) . "\x{FDD3}") ~egox; - - if ($skip_markdown) { - # non-mailto protocols - my $safe_protocols = SAFE_URL_REGEXP(); - $text =~ s~\b($safe_protocols) + # non-mailto protocols + my $safe_protocols = SAFE_URL_REGEXP(); + $text =~ s~\b($safe_protocols) ~($tmp = html_quote($1)) && ($things[$count++] = "$tmp") && ("\x{FDD2}" . ($count-1) . "\x{FDD3}") ~egox; - # We have to quote now, otherwise the html itself is escaped - # THIS MEANS THAT A LITERAL ", <, >, ' MUST BE ESCAPED FOR A MATCH - $text = html_quote($text); + # We have to quote now, otherwise the html itself is escaped + # THIS MEANS THAT A LITERAL ", <, >, ' MUST BE ESCAPED FOR A MATCH - # Color quoted text - $text =~ s~^(>.+)$~$1~mg; - $text =~ s~\n~\n~g; + $text = html_quote($text); - # mailto: - # Use | so that $1 is defined regardless - # @ is the encoded '@' character. - $text =~ s~\b(mailto:|)?([\w\.\-\+\=]+&\#64;[\w\-]+(?:\.[\w\-]+)+)\b - ~$1$2~igx; - } - else { - # We intentionally disable all html tags. Users should use markdown syntax. - # This prevents things like inline styles on anchor tags, which otherwise would be valid. - $text =~ s/([<])/</g; + # Color quoted text + $text =~ s~^(>.+)$~$1~mg; + $text =~ s~\n~\n~g; - # As a preference, we opt into all new line breaks being rendered as a new line. - $text =~ s/(\r?\n)/ $1/g; - } + # mailto: + # Use | so that $1 is defined regardless + # @ is the encoded '@' character. + $text =~ s~\b(mailto:|)?([\w\.\-\+\=]+&\#64;[\w\-]+(?:\.[\w\-]+)+)\b + ~$1$2~igx; # attachment links # BMO: don't make diff view the default for patches (Bug 652332) $text =~ s~\b(attachment$s*\#?$s*(\d+)(?:$s+\[diff\])?(?:\s+\[details\])?) - ~($things[$count++] = get_attachment_link($2, $1, $anon_user)) && + ~($things[$count++] = get_attachment_link($2, $1, $user)) && ("\x{FDD2}" . ($count-1) . "\x{FDD3}") ~egmxi; @@ -253,7 +240,7 @@ sub renderComment { $text =~ s~\b($bug_re(?:$s*,?$s*$comment_re)?|$comment_re) ~ # We have several choices. $1 here is the link, and $2-4 are set # depending on which part matched - (defined($2) ? $bug_link_func->($2, $1, { comment_num => $3, user => $anon_user }) : + (defined($2) ? $bug_link_func->($2, $1, { comment_num => $3, user => $user }) : "$1") ~egx; @@ -262,7 +249,7 @@ sub renderComment { $text =~ s~(?<=^\*\*\*\ This\ bug\ has\ been\ marked\ as\ a\ duplicate\ of\ ) (\d+) (?=\ \*\*\*\Z) - ~$bug_link_func->($1, $1, { user => $anon_user }) + ~$bug_link_func->($1, $1, { user => $user }) ~egmx; # Now remove the encoding hacks in reverse order @@ -270,12 +257,7 @@ sub renderComment { $text =~ s/\x{FDD2}($i)\x{FDD3}/$things[$i]/eg; } - if ($skip_markdown) { - return $text; - } - else { - return Bugzilla->markdown_parser->render_html($text); - } + return $text; } # Creates a link to an attachment, including its title. @@ -289,17 +271,11 @@ sub get_attachment_link { if ($attachment) { my $title = ""; my $className = ""; - my $linkClass = ""; - if ($user->can_see_bug($attachment->bug_id) && (!$attachment->isprivate || $user->is_insider)) { $title = $attachment->description; } - else{ - $linkClass = "bz_private_link"; - } - if ($attachment->isobsolete) { $className = "bz_obsolete"; } @@ -320,7 +296,7 @@ sub get_attachment_link { # Whitespace matters here because these links are in 
 tags.
         return qq||
-               . qq|$link_text|
+               . qq|$link_text|
                . qq| [details]|
                . qq|${patchlink}|
                . qq||;
@@ -730,11 +706,11 @@ sub create {
             # Removes control characters and trims extra whitespace.
             clean_text => \&Bugzilla::Util::clean_text ,
 
-            renderComment => [ sub {
-                               my ($context, $bug, $comment, $skip_markdown) = @_;
+            quoteUrls => [ sub {
+                               my ($context, $bug, $comment, $user) = @_;
                                return sub {
                                    my $text = shift;
-                                   return renderComment($text, $bug, $comment, $skip_markdown);
+                                   return quoteUrls($text, $bug, $comment, $user);
                                };
                            },
                            1
diff --git a/Bugzilla/WebService/Bug.pm b/Bugzilla/WebService/Bug.pm
index d14300f6f..feb541c2e 100644
--- a/Bugzilla/WebService/Bug.pm
+++ b/Bugzilla/WebService/Bug.pm
@@ -362,7 +362,7 @@ sub render_comment {
     Bugzilla->switch_to_shadow_db();
     my $bug = $params->{id} ? Bugzilla::Bug->check($params->{id}) : undef;
 
-    my $html = Bugzilla::Template::renderComment($params->{text}, $bug);
+    my $html = Bugzilla::Template::quoteUrls($params->{text}, $bug);
 
     return { html => $html };
 }
@@ -381,7 +381,6 @@ sub _translate_comment {
         time       => $self->type('dateTime', $comment->creation_ts),
         creation_time => $self->type('dateTime', $comment->creation_ts),
         is_private => $self->type('boolean', $comment->is_private),
-        is_markdown => $self->type('boolean', $comment->is_markdown),
         text       => $self->type('string', $comment->body_full),
         attachment_id => $self->type('int', $attach_id),
         count      => $self->type('int', $comment->count),
@@ -1113,11 +1112,9 @@ sub add_comment {
     if (defined $params->{private}) {
         $params->{is_private} = delete $params->{private};
     }
-
     # Append comment
     $bug->add_comment($comment, { isprivate => $params->{is_private},
-                                  work_time => $params->{work_time},
-                                  is_markdown => 1 });
+                                  work_time => $params->{work_time} });
 
     # Add comment tags
     $bug->set_all({ comment_tags => $params->{comment_tags} })
-- 
cgit v1.2.3-24-g4f1b