1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
30 # CONTRIBUTION SUBMISSION POLICY:
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
47 # END BPS TAGGED BLOCK }}}
49 package RT::Shredder::Plugin::Users;
52 use warnings FATAL => 'all';
53 use base qw(RT::Shredder::Plugin::Base::Search);
57 RT::Shredder::Plugin::Users - search plugin for wiping users.
61 =head2 status - string
63 Status argument allow you to limit result set to C<disabled>,
64 C<enabled> or C<any> users.
65 B<< Default value is C<disabled>. >>
75 =head2 member_of - group identifier
77 Using this option users that are members of a particular group can
78 be selected for deletion. Identifier is name of user defined group
79 or id of a group, as well C<Privileged> or <unprivileged> can used
80 to select people from system groups.
82 =head2 not_member_of - group identifier
84 Like member_of, but selects users who are not members of the provided
87 =head2 replace_relations - user identifier
89 When you delete a user there could be minor links to them in the RT database.
90 This option allow you to replace these links with links to the new user.
91 The replaceable links are Creator and LastUpdatedBy, but NOT any watcher roles.
92 This means that if the user is a watcher(Requestor, Owner,
93 Cc or AdminCc) of the ticket or queue then the link would be deleted.
95 This argument could be a user id or name.
97 =head2 no_tickets - boolean
99 If true then plugin looks for users who are not watchers (Owners,
100 Requestors, Ccs or AdminCcs) of any ticket.
102 Before RT 3.8.5, users who were watchers of deleted tickets B<will be deleted>
103 when this option was enabled. Decision has been made that it's not correct
104 and you should either shred these deleted tickets, change watchers or
105 explicitly delete user by name or email.
107 Note that found users still B<may have relations> with other objects,
108 for example via Creator or LastUpdatedBy fields, and you most probably
109 want to use C<replace_relations> option.
111 =head2 no_ticket_transactions - boolean
113 If true then plugin looks for users who have created no ticket transactions.
114 This is especially useful after wiping out tickets.
116 Note that found users still B<may have relations> with other objects,
117 for example via Creator or LastUpdatedBy fields, and you most probably
118 want to use C<replace_relations> option.
124 return $_[0]->SUPER::SupportArgs,
125 qw(status name email member_of not_member_of replace_relations no_tickets no_ticket_transactions);
132 if( $args{'status'} ) {
133 unless( $args{'status'} =~ /^(disabled|enabled|any)$/i ) {
134 return (0, "Status '$args{'status'}' is unsupported.");
137 $args{'status'} = 'disabled';
139 if( $args{'email'} ) {
140 $args{'email'} = $self->ConvertMaskToSQL( $args{'email'} );
142 if( $args{'name'} ) {
143 $args{'name'} = $self->ConvertMaskToSQL( $args{'name'} );
145 if( $args{'member_of'} or $args{'not_member_of'} ) {
146 foreach my $group_option ( qw(member_of not_member_of) ){
147 next unless $args{$group_option};
149 my $group = RT::Group->new( RT->SystemUser );
150 if ( $args{$group_option} =~ /^(Everyone|Privileged|Unprivileged)$/i ) {
151 $group->LoadSystemInternalGroup( $args{$group_option} );
154 $group->LoadUserDefinedGroup( $args{$group_option} );
156 unless ( $group->id ) {
157 return (0, "Couldn't load group '$args{$group_option}'" );
159 $args{$group_option} = $group->id;
162 if( $args{'replace_relations'} ) {
163 my $uid = $args{'replace_relations'};
164 # XXX: it's possible that SystemUser is not available
165 my $user = RT::User->new( RT->SystemUser );
167 unless( $user->id ) {
168 return (0, "Couldn't load user '$uid'" );
170 $args{'replace_relations'} = $user->id;
172 return $self->SUPER::TestArgs( %args );
178 my %args = ( Shredder => undef, @_ );
179 my $objs = RT::Users->new( RT->SystemUser );
180 # XXX: we want preload only things we need, but later while
181 # logging we need all data, TODO envestigate this
182 # $objs->Columns(qw(id Name EmailAddress Lang Timezone
183 # Creator Created LastUpdated LastUpdatedBy));
184 if( my $s = $self->{'opt'}{'status'} ) {
187 } elsif( $s eq 'disabled' ) {
188 $objs->LimitToDeleted;
190 $objs->LimitToEnabled;
193 if( $self->{'opt'}{'email'} ) {
194 $objs->Limit( FIELD => 'EmailAddress',
195 OPERATOR => 'MATCHES',
196 VALUE => $self->{'opt'}{'email'},
199 if( $self->{'opt'}{'name'} ) {
200 $objs->Limit( FIELD => 'Name',
201 OPERATOR => 'MATCHES',
202 VALUE => $self->{'opt'}{'name'},
206 if( $self->{'opt'}{'member_of'} ) {
207 $objs->MemberOfGroup( $self->{'opt'}{'member_of'} );
210 if( $self->{'opt'}{'not_member_of'} ) {
211 push @filter, $self->FilterNotMemberOfGroup(
212 Shredder => $args{'Shredder'},
213 GroupId => $self->{'opt'}{'not_member_of'},
216 if( $self->{'opt'}{'no_tickets'} ) {
217 push @filter, $self->FilterWithoutTickets(
218 Shredder => $args{'Shredder'},
221 if( $self->{'opt'}{'no_ticket_transactions'} ) {
222 push @filter, $self->FilterWithoutTicketTransactions(
223 Shredder => $args{'Shredder'},
228 $self->FetchNext( $objs, 'init' );
230 USER: while ( my $user = $self->FetchNext( $objs ) ) {
231 for my $filter (@filter) {
232 next USER unless $filter->($user);
235 last if $self->{'opt'}{'limit'} && @res >= $self->{'opt'}{'limit'};
238 } elsif ( $self->{'opt'}{'limit'} ) {
239 $objs->RowsPerPage( $self->{'opt'}{'limit'} );
247 my %args = ( Shredder => undef, @_ );
249 if( $self->{'opt'}{'replace_relations'} ) {
250 my $uid = $self->{'opt'}{'replace_relations'};
253 my $t = $args{'TargetObject'};
254 foreach my $method ( qw(Creator LastUpdatedBy) ) {
255 next unless $t->_Accessible( $method => 'read' );
256 $t->__Set( Field => $method, Value => $uid );
259 $args{'Shredder'}->PutResolver( BaseClass => 'RT::User', Code => $resolver );
264 sub FilterNotMemberOfGroup {
272 my $group = RT::Group->new(RT->SystemUser);
273 $group->Load($args{'GroupId'});
277 not $group->HasMemberRecursively($user->id);
281 sub FilterWithoutTickets {
291 $self->_WithoutTickets( $user )
295 sub _WithoutTickets {
296 my ($self, $user) = @_;
297 return unless $user and $user->Id;
298 my $tickets = RT::Tickets->new( RT->SystemUser );
299 $tickets->{'allow_deleted_search'} = 1;
300 $tickets->FromSQL( 'Watcher.id = '. $user->id );
302 # we could use the Count method which counts all records
303 # that match, but we really want to know only that
304 # at least one record exists, so this is faster
305 $tickets->RowsPerPage(1);
306 return !$tickets->First;
309 sub FilterWithoutTicketTransactions {
319 $self->_WithoutTicketTransactions( $user )
323 sub _WithoutTicketTransactions {
324 my ($self, $user) = @_;
325 return unless $user and $user->Id;
326 my $txns = RT::Transactions->new( RT->SystemUser );
327 $txns->Limit(FIELD => 'ObjectType', VALUE => 'RT::Ticket');
328 $txns->Limit(FIELD => 'Creator', VALUE => $user->Id);
330 # we could use the Count method which counts all records
331 # that match, but we really want to know only that
332 # at least one record exists, so this is faster
333 $txns->RowsPerPage(1);
334 return !$txns->First;