rt/lib/RT/Shredder/User.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
   6 #                                          <sales@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  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
  16 # from www.gnu.org.
  17 #
  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.
  22 #
  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.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  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.)
  37 #
  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.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 use RT::User ();
  50 package RT::User;
  51
  52 use strict;
  53 use warnings;
  54 use warnings FATAL => 'redefine';
  55
  56 use RT::Shredder::Constants;
  57 use RT::Shredder::Exceptions;
  58 use RT::Shredder::Dependencies;
  59
  60 my @OBJECTS = qw(
  61     Attachments
  62     CachedGroupMembers
  63     CustomFields
  64     CustomFieldValues
  65     GroupMembers
  66     Groups
  67     Links
  68     Principals
  69     Queues
  70     ScripActions
  71     ScripConditions
  72     Scrips
  73     Templates
  74     ObjectCustomFieldValues
  75     Tickets
  76     Transactions
  77     Users
  78 );
  79
  80 sub __DependsOn
  81 {
  82     my $self = shift;
  83     my %args = (
  84             Shredder => undef,
  85             Dependencies => undef,
  86             @_,
  87            );
  88     my $deps = $args{'Dependencies'};
  89     my $list = [];
  90
  91 # Principal
  92     $deps->_PushDependency(
  93             BaseObject => $self,
  94             Flags => DEPENDS_ON | WIPE_AFTER,
  95             TargetObject => $self->PrincipalObj,
  96             Shredder => $args{'Shredder'}
  97         );
  98
  99 # ACL equivalence group
 100 # don't use LoadACLEquivalenceGroup cause it may not exists any more
 101     my $objs = RT::Groups->new( $self->CurrentUser );
 102     $objs->Limit( FIELD => 'Domain', VALUE => 'ACLEquivalence' );
 103     $objs->Limit( FIELD => 'Instance', VALUE => $self->Id );
 104     push( @$list, $objs );
 105
 106 # Cleanup user's membership
 107     $objs = RT::GroupMembers->new( $self->CurrentUser );
 108     $objs->Limit( FIELD => 'MemberId', VALUE => $self->Id );
 109     push( @$list, $objs );
 110
 111     $deps->_PushDependencies(
 112             BaseObject => $self,
 113             Flags => DEPENDS_ON,
 114             TargetObjects => $list,
 115             Shredder => $args{'Shredder'}
 116         );
 117
 118 # TODO: Almost all objects has Creator, LastUpdatedBy and etc. fields
 119 # which are references on users(Principal actualy)
 120     my @var_objs;
 121     foreach( @OBJECTS ) {
 122         my $class = "RT::$_";
 123         foreach my $method ( qw(Creator LastUpdatedBy) ) {
 124             my $objs = $class->new( $self->CurrentUser );
 125             next unless $objs->NewItem->_Accessible( $method => 'read' );
 126             $objs->Limit( FIELD => $method, VALUE => $self->id );
 127             push @var_objs, $objs;
 128         }
 129     }
 130     $deps->_PushDependencies(
 131             BaseObject => $self,
 132             Flags => DEPENDS_ON | VARIABLE,
 133             TargetObjects => \@var_objs,
 134             Shredder => $args{'Shredder'}
 135         );
 136
 137     return $self->SUPER::__DependsOn( %args );
 138 }
 139
 140 sub __Relates
 141 {
 142     my $self = shift;
 143     my %args = (
 144             Shredder => undef,
 145             Dependencies => undef,
 146             @_,
 147            );
 148     my $deps = $args{'Dependencies'};
 149     my $list = [];
 150
 151 # Principal
 152     my $obj = $self->PrincipalObj;
 153     if( $obj && defined $obj->id ) {
 154         push( @$list, $obj );
 155     } else {
 156         my $rec = $args{'Shredder'}->GetRecord( Object => $self );
 157         $self = $rec->{'Object'};
 158         $rec->{'State'} |= INVALID;
 159         $rec->{'Description'} = "Have no related ACL equivalence Group object";
 160     }
 161
 162     $obj = RT::Group->new( RT->SystemUser );
 163     $obj->LoadACLEquivalenceGroup( $self->PrincipalObj );
 164     if( $obj && defined $obj->id ) {
 165         push( @$list, $obj );
 166     } else {
 167         my $rec = $args{'Shredder'}->GetRecord( Object => $self );
 168         $self = $rec->{'Object'};
 169         $rec->{'State'} |= INVALID;
 170         $rec->{'Description'} = "Have no related Principal #". $self->id ." object";
 171     }
 172
 173     $deps->_PushDependencies(
 174             BaseObject => $self,
 175             Flags => RELATES,
 176             TargetObjects => $list,
 177             Shredder => $args{'Shredder'}
 178         );
 179     return $self->SUPER::__Relates( %args );
 180 }
 181
 182 sub BeforeWipeout
 183 {
 184     my $self = shift;
 185     if( $self->Name =~ /^(RT_System|Nobody)$/ ) {
 186         RT::Shredder::Exception::Info->throw('SystemObject');
 187     }
 188     return $self->SUPER::BeforeWipeout( @_ );
 189 }
 190
 191 1;