Merge branch 'master' of https://github.com/jgoodman/Freeside
[freeside.git] / rt / lib / RT / Shredder / Group.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::Group ();
50 package RT::Group;
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
61 sub __DependsOn
62 {
63     my $self = shift;
64     my %args = (
65         Shredder => undef,
66         Dependencies => undef,
67         @_,
68     );
69     my $deps = $args{'Dependencies'};
70     my $list = [];
71
72 # User is inconsistent without own Equivalence group
73     if( $self->Domain eq 'ACLEquivalence' ) {
74         # delete user entry after ACL equiv group
75         # in other case we will get deep recursion
76         my $objs = RT::User->new($self->CurrentUser);
77         $objs->Load( $self->Instance );
78         $deps->_PushDependency(
79                 BaseObject => $self,
80                 Flags => DEPENDS_ON | WIPE_AFTER,
81                 TargetObject => $objs,
82                 Shredder => $args{'Shredder'}
83             );
84     }
85
86 # Principal
87     $deps->_PushDependency(
88             BaseObject => $self,
89             Flags => DEPENDS_ON | WIPE_AFTER,
90             TargetObject => $self->PrincipalObj,
91             Shredder => $args{'Shredder'}
92         );
93
94 # Group members records
95     my $objs = RT::GroupMembers->new( $self->CurrentUser );
96     $objs->LimitToMembersOfGroup( $self->PrincipalId );
97     push( @$list, $objs );
98
99 # Group member records group belongs to
100     $objs = RT::GroupMembers->new( $self->CurrentUser );
101     $objs->Limit(
102             VALUE => $self->PrincipalId,
103             FIELD => 'MemberId',
104             ENTRYAGGREGATOR => 'OR',
105             QUOTEVALUE => 0
106             );
107     push( @$list, $objs );
108
109 # Cached group members records
110     push( @$list, $self->DeepMembersObj );
111
112 # Cached group member records group belongs to
113     $objs = RT::GroupMembers->new( $self->CurrentUser );
114     $objs->Limit(
115             VALUE => $self->PrincipalId,
116             FIELD => 'MemberId',
117             ENTRYAGGREGATOR => 'OR',
118             QUOTEVALUE => 0
119             );
120     push( @$list, $objs );
121
122     $deps->_PushDependencies(
123             BaseObject => $self,
124             Flags => DEPENDS_ON,
125             TargetObjects => $list,
126             Shredder => $args{'Shredder'}
127         );
128     return $self->SUPER::__DependsOn( %args );
129 }
130
131 sub __Relates
132 {
133     my $self = shift;
134     my %args = (
135             Shredder => undef,
136             Dependencies => undef,
137             @_,
138            );
139     my $deps = $args{'Dependencies'};
140     my $list = [];
141
142 # Equivalence group id inconsistent without User
143     if( $self->Domain eq 'ACLEquivalence' ) {
144         my $obj = RT::User->new($self->CurrentUser);
145         $obj->Load( $self->Instance );
146         if( $obj->id ) {
147             push( @$list, $obj );
148         } else {
149             my $rec = $args{'Shredder'}->GetRecord( Object => $self );
150             $self = $rec->{'Object'};
151             $rec->{'State'} |= INVALID;
152             $rec->{'Description'} = "ACLEguvivalence group have no related User #". $self->Instance ." object.";
153         }
154     }
155
156 # Principal
157     my $obj = $self->PrincipalObj;
158     if( $obj && $obj->id ) {
159         push( @$list, $obj );
160     } else {
161         my $rec = $args{'Shredder'}->GetRecord( Object => $self );
162         $self = $rec->{'Object'};
163         $rec->{'State'} |= INVALID;
164         $rec->{'Description'} = "Have no related Principal #". $self->id ." object.";
165     }
166
167     $deps->_PushDependencies(
168             BaseObject => $self,
169             Flags => RELATES,
170             TargetObjects => $list,
171             Shredder => $args{'Shredder'}
172         );
173     return $self->SUPER::__Relates( %args );
174 }
175
176 sub BeforeWipeout
177 {
178     my $self = shift;
179     if( $self->Domain eq 'SystemInternal' ) {
180         RT::Shredder::Exception::Info->throw('SystemObject');
181     }
182     return $self->SUPER::BeforeWipeout( @_ );
183 }
184
185 1;