#
# COPYRIGHT:
#
-# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
or id of a group, as well C<Privileged> or <unprivileged> can used
to select people from system groups.
+=head2 not_member_of - group identifier
+
+Like member_of, but selects users who are not members of the provided
+group.
+
=head2 replace_relations - user identifier
-When you delete user there are could be minor links to him in RT DB.
-This option allow you to replace this links with link to other user.
-This links are Creator and LastUpdatedBy, but NOT any watcher roles,
-this means that if user is watcher(Requestor, Owner,
-Cc or AdminCc) of the ticket or queue then link would be deleted.
+When you delete a user there could be minor links to them in the RT database.
+This option allow you to replace these links with links to the new user.
+The replaceable links are Creator and LastUpdatedBy, but NOT any watcher roles.
+This means that if the user is a watcher(Requestor, Owner,
+Cc or AdminCc) of the ticket or queue then the link would be deleted.
-This argument could be user id or name.
+This argument could be a user id or name.
=head2 no_tickets - boolean
for example via Creator or LastUpdatedBy fields, and you most probably
want to use C<replace_relations> option.
+=head2 no_ticket_transactions - boolean
+
+If true then plugin looks for users who have created no ticket transactions.
+This is especially useful after wiping out tickets.
+
+Note that found users still B<may have relations> with other objects,
+for example via Creator or LastUpdatedBy fields, and you most probably
+want to use C<replace_relations> option.
+
=cut
sub SupportArgs
{
return $_[0]->SUPER::SupportArgs,
- qw(status name email member_of replace_relations no_tickets);
+ qw(status name email member_of not_member_of replace_relations no_tickets no_ticket_transactions);
}
sub TestArgs
if( $args{'name'} ) {
$args{'name'} = $self->ConvertMaskToSQL( $args{'name'} );
}
- if( $args{'member_of'} ) {
- my $group = RT::Group->new( RT->SystemUser );
- if ( $args{'member_of'} =~ /^(Everyone|Privileged|Unprivileged)$/i ) {
- $group->LoadSystemInternalGroup( $args{'member_of'} );
- }
- else {
- $group->LoadUserDefinedGroup( $args{'member_of'} );
- }
- unless ( $group->id ) {
- return (0, "Couldn't load group '$args{'member_of'}'" );
- }
- $args{'member_of'} = $group->id;
+ if( $args{'member_of'} or $args{'not_member_of'} ) {
+ foreach my $group_option ( qw(member_of not_member_of) ){
+ next unless $args{$group_option};
+ my $group = RT::Group->new( RT->SystemUser );
+ if ( $args{$group_option} =~ /^(Everyone|Privileged|Unprivileged)$/i ) {
+ $group->LoadSystemInternalGroup( $args{$group_option} );
+ }
+ else {
+ $group->LoadUserDefinedGroup( $args{$group_option} );
+ }
+ unless ( $group->id ) {
+ return (0, "Couldn't load group '$args{$group_option}'" );
+ }
+ $args{$group_option} = $group->id;
+ }
}
if( $args{'replace_relations'} ) {
my $uid = $args{'replace_relations'};
$objs->Limit( FIELD => 'Name',
OPERATOR => 'MATCHES',
VALUE => $self->{'opt'}{'name'},
+ CASESENSITIVE => 0,
);
}
if( $self->{'opt'}{'member_of'} ) {
$objs->MemberOfGroup( $self->{'opt'}{'member_of'} );
}
+ my @filter;
+ if( $self->{'opt'}{'not_member_of'} ) {
+ push @filter, $self->FilterNotMemberOfGroup(
+ Shredder => $args{'Shredder'},
+ GroupId => $self->{'opt'}{'not_member_of'},
+ );
+ }
if( $self->{'opt'}{'no_tickets'} ) {
- return $self->FilterWithoutTickets(
+ push @filter, $self->FilterWithoutTickets(
Shredder => $args{'Shredder'},
- Objects => $objs,
);
- } else {
- if( $self->{'opt'}{'limit'} ) {
- $objs->RowsPerPage( $self->{'opt'}{'limit'} );
+ }
+ if( $self->{'opt'}{'no_ticket_transactions'} ) {
+ push @filter, $self->FilterWithoutTicketTransactions(
+ Shredder => $args{'Shredder'},
+ );
+ }
+
+ if (@filter) {
+ $self->FetchNext( $objs, 'init' );
+ my @res;
+ USER: while ( my $user = $self->FetchNext( $objs ) ) {
+ for my $filter (@filter) {
+ next USER unless $filter->($user);
+ }
+ push @res, $user;
+ last if $self->{'opt'}{'limit'} && @res >= $self->{'opt'}{'limit'};
}
+ $objs = \@res;
+ } elsif ( $self->{'opt'}{'limit'} ) {
+ $objs->RowsPerPage( $self->{'opt'}{'limit'} );
}
return (1, $objs);
}
return (1);
}
+sub FilterNotMemberOfGroup {
+ my $self = shift;
+ my %args = (
+ Shredder => undef,
+ GroupId => undef,
+ @_,
+ );
+
+ my $group = RT::Group->new(RT->SystemUser);
+ $group->Load($args{'GroupId'});
+
+ return sub {
+ my $user = shift;
+ not $group->HasMemberRecursively($user->id);
+ };
+}
+
sub FilterWithoutTickets {
my $self = shift;
my %args = (
Objects => undef,
@_,
);
- my $users = $args{Objects};
- $self->FetchNext( $users, 'init' );
- my @res;
- while ( my $user = $self->FetchNext( $users ) ) {
- push @res, $user if $self->_WithoutTickets( $user );
- return (1, \@res) if $self->{'opt'}{'limit'} && @res >= $self->{'opt'}{'limit'};
- }
- return (1, \@res);
+ return sub {
+ my $user = shift;
+ $self->_WithoutTickets( $user )
+ };
}
sub _WithoutTickets {
my ($self, $user) = @_;
+ return unless $user and $user->Id;
my $tickets = RT::Tickets->new( RT->SystemUser );
$tickets->{'allow_deleted_search'} = 1;
$tickets->FromSQL( 'Watcher.id = '. $user->id );
- # HACK: we may use Count method which counts all records
- # that match condtion, but we really want to know only that
- # at least one record exist, so we fetch first row only
+
+ # we could use the Count method which counts all records
+ # that match, but we really want to know only that
+ # at least one record exists, so this is faster
$tickets->RowsPerPage(1);
return !$tickets->First;
}
+sub FilterWithoutTicketTransactions {
+ my $self = shift;
+ my %args = (
+ Shredder => undef,
+ Objects => undef,
+ @_,
+ );
+
+ return sub {
+ my $user = shift;
+ $self->_WithoutTicketTransactions( $user )
+ };
+}
+
+sub _WithoutTicketTransactions {
+ my ($self, $user) = @_;
+ return unless $user and $user->Id;
+ my $txns = RT::Transactions->new( RT->SystemUser );
+ $txns->Limit(FIELD => 'ObjectType', VALUE => 'RT::Ticket');
+ $txns->Limit(FIELD => 'Creator', VALUE => $user->Id);
+
+ # we could use the Count method which counts all records
+ # that match, but we really want to know only that
+ # at least one record exists, so this is faster
+ $txns->RowsPerPage(1);
+ return !$txns->First;
+}
+
1;