From 35671f4ab3397f4c0d5ea96e0269d94c3d6bd2ac Mon Sep 17 00:00:00 2001 From: Dylan William Hardison Date: Mon, 7 Nov 2016 15:25:06 -0500 Subject: Bug 1313766 - Bugzilla::Bug->send_changes() should not output HTML directly --- Bugzilla/Bug.pm | 43 +++++------ process_bug.cgi | 87 +++++++++++++---------- template/en/default/bug/process/bugmail.html.tmpl | 4 +- 3 files changed, 68 insertions(+), 66 deletions(-) diff --git a/Bugzilla/Bug.pm b/Bugzilla/Bug.pm index 69734e6c0..3889e7481 100644 --- a/Bugzilla/Bug.pm +++ b/Bugzilla/Bug.pm @@ -1331,13 +1331,13 @@ sub remove_from_db { ##################################################################### sub send_changes { - my ($self, $changes, $vars) = @_; - + my ($self, $changes) = @_; + my @results; my $user = Bugzilla->user; - my $old_qa = $changes->{'qa_contact'} + my $old_qa = $changes->{'qa_contact'} ? $changes->{'qa_contact'}->[0] : ''; - my $old_own = $changes->{'assigned_to'} + my $old_own = $changes->{'assigned_to'} ? $changes->{'assigned_to'}->[0] : ''; my $old_cc = $changes->{cc} ? $changes->{cc}->[0] : ''; @@ -1349,15 +1349,15 @@ sub send_changes { changer => $user, ); - my $recipient_count = _send_bugmail( - { id => $self->id, type => 'bug', forced => \%forced }, $vars); + push @results, _send_bugmail( + { id => $self->id, type => 'bug', forced => \%forced }); # If the bug was marked as a duplicate, we need to notify users on the # other bug of any changes to that bug. my $new_dup_id = $changes->{'dup_id'} ? $changes->{'dup_id'}->[1] : undef; if ($new_dup_id) { - $recipient_count += _send_bugmail( - { forced => { changer => $user }, type => "dupe", id => $new_dup_id }, $vars); + push @results, _send_bugmail( + { forced => { changer => $user }, type => "dupe", id => $new_dup_id }); } # If there were changes in dependencies, we need to notify those @@ -1376,7 +1376,7 @@ sub send_changes { foreach my $id (@{ $self->blocked }) { $params->{id} = $id; - $recipient_count += _send_bugmail($params, $vars); + push @results, _send_bugmail($params); } } } @@ -1394,37 +1394,28 @@ sub send_changes { delete $changed_deps{''}; foreach my $id (sort { $a <=> $b } (keys %changed_deps)) { - $recipient_count += _send_bugmail( - { forced => { changer => $user }, type => "dep", id => $id }, $vars); + push @results, _send_bugmail( + { forced => { changer => $user }, type => "dep", id => $id }); } # Sending emails for the referenced bugs. foreach my $ref_bug_id (uniq @{ $self->{see_also_changes} || [] }) { - $recipient_count += _send_bugmail( - { forced => { changer => $user }, id => $ref_bug_id }, $vars); + push @results, _send_bugmail( + { forced => { changer => $user }, id => $ref_bug_id }); } - return $recipient_count; + return \@results; } sub _send_bugmail { - my ($params, $vars) = @_; + my ($params) = @_; require Bugzilla::BugMail; - my $results = + my $sent_bugmail = Bugzilla::BugMail::Send($params->{'id'}, $params->{'forced'}, $params); - if (Bugzilla->usage_mode == USAGE_MODE_BROWSER) { - my $template = Bugzilla->template; - $vars->{$_} = $params->{$_} foreach keys %$params; - $vars->{'sent_bugmail'} = $results; - $template->process("bug/process/results.html.tmpl", $vars) - || ThrowTemplateError($template->error()); - $vars->{'header_done'} = 1; - } - - return scalar @{ $results->{sent} }; + return { params => $params, sent_bugmail => $sent_bugmail }; } ##################################################################### diff --git a/process_bug.cgi b/process_bug.cgi index 80018cfb3..0b1b30dbf 100755 --- a/process_bug.cgi +++ b/process_bug.cgi @@ -111,8 +111,6 @@ my $user_match_fields = { Bugzilla::Hook::process('bug_user_match_fields', { fields => $user_match_fields }); Bugzilla::User::match_field($user_match_fields); -print $cgi->header() unless Bugzilla->usage_mode == USAGE_MODE_EMAIL; - # Check for a mid-air collision. Currently this only works when updating # an individual bug. my $delta_ts = $cgi->param('delta_ts') || ''; @@ -158,6 +156,7 @@ if ($delta_ts) { $cgi->param('token', issue_hash_token([$first_bug->id, $first_bug->delta_ts])); # Warn the user about the mid-air collision and ask them what to do. + print $cgi->header() unless Bugzilla->usage_mode == USAGE_MODE_EMAIL; $template->process("bug/process/midair.html.tmpl", $vars) || ThrowTemplateError($template->error()); exit; @@ -186,6 +185,9 @@ $vars->{'title_tag'} = "bug_processed"; my $action; if (defined $cgi->param('id')) { $action = $user->setting('post_bug_submit_action'); + if ($action ne 'nothing' && $action ne 'same_bug' && $action ne 'next_bug') { + ThrowCodeError("invalid_post_bug_submit_action"); + } if ($action eq 'next_bug') { my $bug_list_obj = $user->recent_search_for($first_bug); @@ -376,6 +378,7 @@ if (defined $cgi->param('id')) { ############################## # Do Actual Database Updates # ############################## +my $sent_changes; foreach my $bug (@bug_objects) { my $changes = $bug->update(); @@ -389,50 +392,58 @@ foreach my $bug (@bug_objects) { } } - my $recipient_count = $bug->send_changes($changes, $vars); + $sent_changes = $bug->send_changes($changes); } # Delete the session token used for the mass-change. delete_token($token) unless $cgi->param('id'); -if (Bugzilla->usage_mode == USAGE_MODE_EMAIL) { - # Do nothing. -} -elsif ($action eq 'next_bug' or $action eq 'same_bug') { - my $bug = $vars->{'bug'}; - if ($bug and $user->can_see_bug($bug)) { - if ($action eq 'same_bug') { - # $bug->update() does not update the internal structure of - # the bug sufficiently to display the bug with the new values. - # (That is, if we just passed in the old Bug object, we'd get - # a lot of old values displayed.) - $bug = new Bugzilla::Bug($bug->id); - $vars->{'bug'} = $bug; - } - $vars->{'bugs'} = [$bug]; - if ($action eq 'next_bug') { - $vars->{'nextbug'} = $bug->id; - } +# BMO: add show_bug_format hook for experimental UI work +my $format_params = { + format => scalar $cgi->param('format'), + ctype => scalar $cgi->param('ctype'), +}; +Bugzilla::Hook::process('show_bug_format', $format_params); +my $format = $template->get_format("bug/show", + $format_params->{format}, + $format_params->{ctype}); + +if (Bugzilla->usage_mode != USAGE_MODE_EMAIL) { + print $cgi->header(); + + foreach my $sent_change (@$sent_changes) { + my $params = $sent_change->{params}; + my $sent_bugmail = $sent_change->{sent_bugmail}; + $vars->{$_} = $params->{$_} foreach keys %$params; + $vars->{'sent_bugmail'} = $sent_bugmail; + $template->process("bug/process/results.html.tmpl", $vars) + || ThrowTemplateError($template->error()); + $vars->{'header_done'} = 1; + } - # BMO: add show_bug_format hook for experimental UI work - my $format_params = { - format => scalar $cgi->param('format'), - ctype => scalar $cgi->param('ctype'), - }; - Bugzilla::Hook::process('show_bug_format', $format_params); - my $format = $template->get_format("bug/show", - $format_params->{format}, - $format_params->{ctype}); - $template->process($format->{template}, $vars) - || ThrowTemplateError($template->error()); - exit; + if ($action eq 'next_bug' or $action eq 'same_bug') { + my $bug = $vars->{'bug'}; + if ($bug and $user->can_see_bug($bug)) { + if ($action eq 'same_bug') { + # $bug->update() does not update the internal structure of + # the bug sufficiently to display the bug with the new values. + # (That is, if we just passed in the old Bug object, we'd get + # a lot of old values displayed.) + $bug = Bugzilla::Bug->new($bug->id); + $vars->{'bug'} = $bug; + } + $vars->{'bugs'} = [$bug]; + if ($action eq 'next_bug') { + $vars->{'nextbug'} = $bug->id; + } + + $template->process($format->{template}, $vars) + || ThrowTemplateError($template->error()); + exit; + } } -} elsif ($action ne 'nothing') { - ThrowCodeError("invalid_post_bug_submit_action"); -} -# End the response page. -unless (Bugzilla->usage_mode == USAGE_MODE_EMAIL) { + # End the response page. $template->process("bug/navigate.html.tmpl", $vars) || ThrowTemplateError($template->error()); $template->process("global/footer.html.tmpl", $vars) diff --git a/template/en/default/bug/process/bugmail.html.tmpl b/template/en/default/bug/process/bugmail.html.tmpl index 21e4ff7b7..0c4f2f27d 100644 --- a/template/en/default/bug/process/bugmail.html.tmpl +++ b/template/en/default/bug/process/bugmail.html.tmpl @@ -24,13 +24,13 @@ # sent_bugmail: The results of Bugzilla::BugMail::Send(). #%] -[% USE CGI %] +[% USE Bugzilla %] [% PROCESS global/variables.none.tmpl %] [%# hide the recipient list by default from new users %] [% show_recipients = user.settings.post_bug_submit_action.value == 'nothing' - || CGI.cookie('show_bugmail_recipients') + || Bugzilla.cgi.cookie('show_bugmail_recipients') || !user.can_see_bug(mailing_bugid) %] [% recipient_count = sent_bugmail.sent.size %] -- cgit v1.2.3-24-g4f1b