Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / rt / lib / RT / Shredder / Plugin / Users.pm
index 2565fc5..7e1c31f 100644 (file)
@@ -1,40 +1,40 @@
 # BEGIN BPS TAGGED BLOCK {{{
-# 
+#
 # COPYRIGHT:
-# 
-# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
-#                                          <jesse@bestpractical.com>
-# 
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
 # (Except where explicitly superseded by other copyright notices)
-# 
-# 
+#
+#
 # LICENSE:
-# 
+#
 # This work is made available to you under the terms of Version 2 of
 # the GNU General Public License. A copy of that license should have
 # been provided with this software, but in any event can be snarfed
 # from www.gnu.org.
-# 
+#
 # This work is distributed in the hope that it will be useful, but
 # WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 # General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 # 02110-1301 or visit their web page on the internet at
 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
-# 
-# 
+#
+#
 # CONTRIBUTION SUBMISSION POLICY:
-# 
+#
 # (The following paragraph is not intended to limit the rights granted
 # to you to modify and distribute this software under the terms of
 # the GNU General Public License and is only of importance to you if
 # you choose to contribute your changes and enhancements to the
 # community by submitting them to Best Practical Solutions, LLC.)
-# 
+#
 # By intentionally submitting any modifications, corrections or
 # derivatives to this work, or any other work intended for use with
 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
@@ -43,7 +43,7 @@
 # royalty-free, perpetual, license to use, copy, create derivative
 # works based on those contributions, and sublicense and distribute
 # those contributions and any derivatives thereof.
-# 
+#
 # END BPS TAGGED BLOCK }}}
 
 package RT::Shredder::Plugin::Users;
@@ -79,15 +79,20 @@ be selected for deletion. Identifier is name of user defined group
 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 user id or name.
 
 =head2 no_tickets - boolean
 
@@ -108,7 +113,7 @@ want to use C<replace_relations> option.
 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);
 }
 
 sub TestArgs
@@ -128,24 +133,27 @@ 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'};
         # XXX: it's possible that SystemUser is not available
-        my $user = RT::User->new( $RT::SystemUser );
+        my $user = RT::User->new( RT->SystemUser );
         $user->Load( $uid );
         unless( $user->id ) {
             return (0, "Couldn't load user '$uid'" );
@@ -159,22 +167,16 @@ sub Run
 {
     my $self = shift;
     my %args = ( Shredder => undef, @_ );
-    my $objs = RT::Users->new( $RT::SystemUser );
+    my $objs = RT::Users->new( RT->SystemUser );
     # XXX: we want preload only things we need, but later while
     # logging we need all data, TODO envestigate this
     # $objs->Columns(qw(id Name EmailAddress Lang Timezone
     #                   Creator Created LastUpdated LastUpdatedBy));
     if( my $s = $self->{'opt'}{'status'} ) {
         if( $s eq 'any' ) {
-            $objs->{'find_disabled_rows'} = 1;
+            $objs->FindAllRows;
         } elsif( $s eq 'disabled' ) {
-            $objs->{'find_disabled_rows'} = 1;
-            $objs->Limit(
-                ALIAS => $objs->PrincipalsAlias,
-                FIELD    => 'Disabled',
-                OPERATOR => '!=',
-                VALUE    => '0',
-            );
+            $objs->LimitToDeleted;
         } else {
             $objs->LimitToEnabled;
         }
@@ -189,20 +191,38 @@ sub Run
         $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 (@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);
 }
@@ -227,6 +247,23 @@ sub SetResolvers
     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 = (
@@ -234,20 +271,17 @@ sub FilterWithoutTickets {
         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) = @_;
-    my $tickets = RT::Tickets->new( $RT::SystemUser );
+    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