3 # Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
5 # (Except where explictly superceded by other copyright notices)
7 # This work is made available to you under the terms of Version 2 of
8 # the GNU General Public License. A copy of that license should have
9 # been provided with this software, but in any event can be snarfed
12 # This work is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # Unless otherwise specified, all modifications, corrections or
18 # extensions to this work which alter its source code become the
19 # property of Best Practical Solutions, LLC when submitted for
20 # inclusion in the work.
26 RT::Groups - a collection of RT::Group objects
31 my $groups = $RT::Groups->new($CurrentUser);
32 $groups->LimitToReal();
33 while (my $group = $groups->Next()) {
34 print $group->Id ." is a group id\n";
45 ok (require RT::Groups);
52 no warnings qw(redefine);
59 $self->{'table'} = "Groups";
60 $self->{'primary_key'} = "id";
62 $self->OrderBy( ALIAS => 'main',
67 return ( $self->SUPER::_Init(@_));
71 # {{{ LimiToSystemInternalGroups
73 =head2 LimitToSystemInternalGroups
75 Return only SystemInternal Groups, such as "privileged" "unprivileged" and "everyone"
80 sub LimitToSystemInternalGroups {
82 $self->Limit(FIELD => 'Domain', OPERATOR => '=', VALUE => 'SystemInternal');
83 $self->Limit(FIELD => 'Instance', OPERATOR => '=', VALUE => '');
89 # {{{ LimiToUserDefinedGroups
91 =head2 LimitToUserDefined Groups
93 Return only UserDefined Groups
98 sub LimitToUserDefinedGroups {
100 $self->Limit(FIELD => 'Domain', OPERATOR => '=', VALUE => 'UserDefined');
101 $self->Limit(FIELD => 'Instance', OPERATOR => '=', VALUE => '');
107 # {{{ LimiToPersonalGroups
109 =head2 LimitToPersonalGroupsFor PRINCIPAL_ID
111 Return only Personal Groups for the user whose principal id
117 sub LimitToPersonalGroupsFor {
121 $self->Limit(FIELD => 'Domain', OPERATOR => '=', VALUE => 'Personal');
122 $self->Limit( FIELD => 'Instance',
125 ENTRY_AGGREGATOR => 'OR');
131 # {{{ LimitToRolesForQueue
133 =item LimitToRolesForQueue QUEUE_ID
135 Limits the set of groups found to role groups for queue QUEUE_ID
139 sub LimitToRolesForQueue {
142 $self->Limit(FIELD => 'Domain', OPERATOR => '=', VALUE => 'RT::Queue-Role');
143 $self->Limit(FIELD => 'Instance', OPERATOR => '=', VALUE => $queue);
148 # {{{ LimitToRolesForTicket
150 =item LimitToRolesForTicket Ticket_ID
152 Limits the set of groups found to role groups for Ticket Ticket_ID
156 sub LimitToRolesForTicket {
159 $self->Limit(FIELD => 'Domain', OPERATOR => '=', VALUE => 'RT::Ticket-Role');
160 $self->Limit(FIELD => 'Instance', OPERATOR => '=', VALUE => '$Ticket');
165 # {{{ LimitToRolesForSystem
167 =item LimitToRolesForSystem System_ID
169 Limits the set of groups found to role groups for System System_ID
173 sub LimitToRolesForSystem {
175 $self->Limit(FIELD => 'Domain', OPERATOR => '=', VALUE => 'RT::System-Role');
180 =head2 WithMember {PrincipalId => PRINCIPAL_ID, Recursively => undef}
182 Limits the set of groups returned to groups which have
183 Principal PRINCIPAL_ID as a member
187 my $u = RT::User->new($RT::SystemUser);
188 $u->Create(Name => 'Membertests');
189 my $g = RT::Group->new($RT::SystemUser);
190 my ($id, $msg) = $g->CreateUserDefinedGroup(Name => 'Membertests');
193 my ($aid, $amsg) =$g->AddMember($u->id);
195 ok($g->HasMember($u->PrincipalObj),"G has member u");
197 my $groups = RT::Groups->new($RT::SystemUser);
198 $groups->LimitToUserDefinedGroups();
199 $groups->WithMember(PrincipalId => $u->id);
200 ok ($groups->Count == 1,"found the 1 group - " . $groups->Count);
201 ok ($groups->First->Id == $g->Id, "it's the right one");
213 my %args = ( PrincipalId => undef,
214 Recursively => undef,
218 if ($args{'Recursively'}) {
219 $members = $self->NewAlias('CachedGroupMembers');
221 $members = $self->NewAlias('GroupMembers');
223 $self->Join(ALIAS1 => 'main', FIELD1 => 'id',
224 ALIAS2 => $members, FIELD2 => 'GroupId');
226 $self->Limit(ALIAS => $members, FIELD => 'MemberId', OPERATOR => '=', VALUE => $args{'PrincipalId'});
232 my %args = ( Right => undef,
234 IncludeSystemRights => undef,
235 IncludeSuperusers => undef,
238 my $groupprinc = $self->NewAlias('Principals');
239 my $acl = $self->NewAlias('ACL');
241 # {{{ Find only rows where the right granted is the one we're looking up or _possibly_ superuser
242 $self->Limit( ALIAS => $acl,
243 FIELD => 'RightName',
245 VALUE => $args{Right},
246 ENTRYAGGREGATOR => 'OR' );
248 if ( $args{'IncludeSuperusers'} ) {
249 $self->Limit( ALIAS => $acl,
250 FIELD => 'RightName',
252 VALUE => 'SuperUser',
253 ENTRYAGGREGATOR => 'OR' );
257 my ($or_check_ticket_roles, $or_check_roles, $or_look_at_object);
259 if ( defined $args{'Object'} ) {
260 if ( ref($args{'Object'}) eq 'RT::Ticket' ) {
261 $or_check_ticket_roles =
262 " OR ( main.Domain = 'RT::Ticket-Role' AND main.Instance = " . $args{'Object'}->Id . ") ";
264 # If we're looking at ticket rights, we also want to look at the associated queue rights.
265 # this is a little bit hacky, but basically, now that we've done the ticket roles magic,
266 # we load the queue object and ask all the rest of our questions about the queue.
267 $args{'Object'} = $args{'Object'}->QueueObj;
269 # TODO XXX This really wants some refactoring
270 if ( ref($args{'Object'}) eq 'RT::Queue' ) {
272 " OR ( ( (main.Domain = 'RT::Queue-Role' AND main.Instance = " .
273 $args{'Object'}->Id . ") $or_check_ticket_roles ) " .
274 " AND main.Type = $acl.PrincipalType AND main.id = $groupprinc.id) ";
278 " OR ($acl.ObjectType = '" . ref($args{'Object'}) . "'" .
279 " AND $acl.ObjectId = " . $args{'Object'}->Id . ") ";
282 $self->_AddSubClause( "WhichObject", "($acl.ObjectType = 'RT::System' $or_look_at_object)" );
284 $self->_AddSubClause( "WhichGroup",
286 ( ( $acl.PrincipalId = $groupprinc.id
287 AND $acl.PrincipalType = 'Group'
288 AND ( main.Domain = 'SystemInternal'
289 OR main.Domain = 'UserDefined'
290 OR main.Domain = 'ACLEquivalence')
291 AND main.id = $groupprinc.id)