summaryrefslogtreecommitdiffstats
path: root/extensions/EditComments/Extension.pm
blob: 7396c6f28a9602443ee76a8c91a05d10a9db700d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

package Bugzilla::Extension::EditComments;

use 5.10.1;
use strict;

use base qw(Bugzilla::Extension);

use Bugzilla::Bug;
use Bugzilla::Util;
use Bugzilla::Error;
use Bugzilla::Config::Common;
use Bugzilla::Config::GroupSecurity;
use Bugzilla::WebService::Bug;
use Bugzilla::WebService::Util qw(filter_wants);

our $VERSION = '0.01';

################
# Installation #
################

sub db_schema_abstract_schema {
    my ($self, $args) = @_;
    my $schema = $args->{schema};

    $schema->{'longdescs_activity'} = {
        FIELDS => [
            comment_id  => {TYPE => 'INT', NOTNULL => 1,
                            REFERENCES => {TABLE  => 'longdescs',
                                           COLUMN => 'comment_id',
                                           DELETE => 'CASCADE'}},
            who         => {TYPE => 'INT3', NOTNULL => 1,
                            REFERENCES => {TABLE  => 'profiles',
                                           COLUMN => 'userid',
                                           DELETE => 'CASCADE'}},
            change_when => {TYPE => 'DATETIME', NOTNULL => 1},
            old_comment => {TYPE => 'LONGTEXT', NOTNULL => 1},
        ],
        INDEXES => [
            longdescs_activity_comment_id_idx => ['comment_id'],
            longdescs_activity_change_when_idx => ['change_when'],
            longdescs_activity_comment_id_change_when_idx => [qw(comment_id change_when)],
        ],
    };
}

sub install_update_db {
    my $dbh = Bugzilla->dbh;
    $dbh->bz_add_column('longdescs', 'edit_count', { TYPE => 'INT3', DEFAULT => 0 });
}

####################
# Template Methods #
####################

sub page_before_template {
    my ($self, $args) = @_;

    return if $args->{'page_id'} ne 'editcomments.html';

    my $vars   = $args->{'vars'};
    my $user   = Bugzilla->user;
    my $params = Bugzilla->input_params;

    # validate group membership
    my $edit_comments_group = Bugzilla->params->{edit_comments_group};
    if (!$edit_comments_group || !$user->in_group($edit_comments_group)) {
        ThrowUserError('auth_failure', { group  => $edit_comments_group,
                                         action => 'view',
                                         object => 'editcomments' });
    }

    my $bug_id = $params->{bug_id};
    my $bug = Bugzilla::Bug->check($bug_id);

    my $comment_id = $params->{comment_id};

    my ($comment) = grep($_->id == $comment_id, @{ $bug->comments });
    if (!$comment
        || ($comment->is_private && !$user->is_insider))
    {
        ThrowUserError("edit_comment_invalid_comment_id", { comment_id => $comment_id });
    }

    $vars->{'bug'}     = $bug;
    $vars->{'comment'} = $comment;
}

##################
# Object Methods #
##################

BEGIN {
    no warnings 'redefine';
    *Bugzilla::Comment::activity = \&_get_activity;
    *Bugzilla::Comment::edit_count = \&_edit_count;
    *Bugzilla::WebService::Bug::_super_translate_comment = \&Bugzilla::WebService::Bug::_translate_comment;
    *Bugzilla::WebService::Bug::_translate_comment = \&_new_translate_comment;
}

sub _new_translate_comment {
    my ($self, $comment, $filters) = @_;

    my $comment_hash = $self->_super_translate_comment($comment, $filters);

    if (filter_wants $filters, 'raw_text') {
        $comment_hash->{raw_text} = $self->type('string', $comment->body);
    }

    return $comment_hash;
}

sub _edit_count { return $_[0]->{'edit_count'}; }

sub _get_activity {
    my ($self, $activity_sort_order) = @_;

    return $self->{'activity'} if $self->{'activity'};

    my $dbh = Bugzilla->dbh;
    my $query = 'SELECT longdescs_activity.comment_id AS id, profiles.userid, ' .
                        $dbh->sql_date_format('longdescs_activity.change_when', '%Y.%m.%d %H:%i:%s') . '
                        AS time, longdescs_activity.old_comment AS old
                   FROM longdescs_activity
             INNER JOIN profiles
                     ON profiles.userid = longdescs_activity.who
                  WHERE longdescs_activity.comment_id = ?';
    $query .= " ORDER BY longdescs_activity.change_when DESC";
    my $sth = $dbh->prepare($query);
    $sth->execute($self->id);

    # We are shifting each comment activity body 1 back. The reason this
    # has to be done is that the longdescs_activity table stores the comment
    # body that the comment was before the edit, not the actual new version
    # of the comment.
    my @activity;
    my $new_comment;
    my $last_old_comment;
    my $count = 0;
    while (my $change_ref = $sth->fetchrow_hashref()) {
        my %change = %$change_ref;
        $change{'author'} = Bugzilla::User->new({ id => $change{'userid'}, cache => 1 });
        if ($count == 0) {
            $change{new} = $self->body;
        }
        else {
            $change{new} = $new_comment;
        }
        $new_comment = $change{old};
        $last_old_comment = $change{old};
        push (@activity, \%change);
        $count++;
    }

    return [] if !@activity;

    # Store the original comment as the first or last entry
    # depending on sort order
    push(@activity, {
        author   => $self->author,
        body     => $last_old_comment,
        time     => $self->creation_ts,
        original => 1
    });

    $activity_sort_order
        ||= Bugzilla->user->settings->{'comment_sort_order'}->{'value'};

    if ($activity_sort_order eq "oldest_to_newest") {
        @activity = reverse @activity;
    }

    $self->{'activity'} = \@activity;

    return $self->{'activity'};
}

#########
# Hooks #
#########

sub object_columns {
    my ($self, $args) = @_;
    my ($class, $columns) = @$args{qw(class columns)};
    if ($class->isa('Bugzilla::Comment')) {
        push(@$columns, 'edit_count');
    }
}

sub bug_end_of_update {
    my ($self, $args) = @_;

    # Silently return if not in the proper group
    # or if editing comments is disabled
    my $user = Bugzilla->user;
    my $edit_comments_group = Bugzilla->params->{edit_comments_group};
    return if (!$edit_comments_group || !$user->in_group($edit_comments_group));

    my $bug       = $args->{bug};
    my $timestamp = $args->{timestamp};
    my $params    = Bugzilla->input_params;
    my $dbh       = Bugzilla->dbh;

    my $updated = 0;
    foreach my $param (grep(/^edit_comment_textarea_/, keys %$params)) {
        my ($comment_id) = $param =~ /edit_comment_textarea_(\d+)$/;
        next if !detaint_natural($comment_id);

        # The comment ID must belong to this bug.
        my ($comment_obj) = grep($_->id == $comment_id, @{ $bug->comments});
        next if (!$comment_obj || ($comment_obj->is_private && !$user->is_insider));

        my $new_comment = $comment_obj->_check_thetext($params->{$param});

        my $old_comment = $comment_obj->body;
        next if $old_comment eq $new_comment;

        trick_taint($new_comment);
        $dbh->do("UPDATE longdescs SET thetext = ?, edit_count = edit_count + 1
                  WHERE comment_id = ?",
                 undef, $new_comment, $comment_id);

        # Log old comment to the longdescs activity table
        $timestamp ||= $dbh->selectrow_array("SELECT NOW()");
        $dbh->do("INSERT INTO longdescs_activity " .
                 "(comment_id, who, change_when, old_comment) " .
                 "VALUES (?, ?, ?, ?)",
                 undef, ($comment_id, $user->id, $timestamp, $old_comment));

        $comment_obj->{thetext} = $new_comment;

        $updated = 1;
    }

    $bug->_sync_fulltext( update_comments => 1 ) if $updated;
}

sub config_modify_panels {
    my ($self, $args) = @_;
    push @{ $args->{panels}->{groupsecurity}->{params} }, {
        name    => 'edit_comments_group',
        type    => 's',
        choices => \&Bugzilla::Config::GroupSecurity::_get_all_group_names,
        default => 'admin',
        checker => \&check_group
    };
}

sub webservice {
    my ($self,  $args) = @_;
    my $dispatch = $args->{dispatch};
    $dispatch->{EditComments} = "Bugzilla::Extension::EditComments::WebService";
}

__PACKAGE__->NAME;