--- /dev/null
+
+# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Users.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# (c) 1996-1999 Jesse Vincent <jesse@fsck.com>
+# This software is redistributable under the terms of the GNU GPL
+
+=head1 NAME
+
+ RT::Users - Collection of RT::User objects
+
+=head1 SYNOPSIS
+
+ use RT::Users;
+
+
+=head1 DESCRIPTION
+
+
+=head1 METHODS
+
+=begin testing
+
+ok(require RT::TestHarness);
+ok(require RT::Users);
+
+=end testing
+
+=cut
+
+package RT::Users;
+use RT::EasySearch;
+@ISA = qw(RT::EasySearch);
+
+# {{{ sub _Init
+sub _Init {
+ my $self = shift;
+ $self->{'table'} = "Users";
+ $self->{'primary_key'} = "id";
+
+ # By default, order by name
+ $self->OrderBy( ALIAS => 'main',
+ FIELD => 'Name',
+ ORDER => 'ASC');
+
+ return ($self->SUPER::_Init(@_));
+
+}
+# }}}
+
+# {{{ sub _DoSearch
+
+=head2 _DoSearch
+
+ A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that _Disabled rows never get seen unless
+we're explicitly trying to see them.
+
+=cut
+
+sub _DoSearch {
+ my $self = shift;
+
+ #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
+ unless($self->{'find_disabled_rows'}) {
+ $self->LimitToEnabled();
+ }
+
+ return($self->SUPER::_DoSearch(@_));
+
+}
+
+# }}}
+
+# {{{ sub NewItem
+
+sub NewItem {
+ my $self = shift;
+
+ use RT::User;
+ my $item = new RT::User($self->CurrentUser);
+ return($item);
+}
+# }}}
+
+# {{{ LimitToEmail
+=head2 LimitToEmail
+
+Takes one argument. an email address. limits the returned set to
+that email address
+
+=cut
+
+sub LimitToEmail {
+ my $self = shift;
+ my $addr = shift;
+ $self->Limit(FIELD => 'EmailAddress', VALUE => "$addr");
+}
+
+# }}}
+
+# {{{ MemberOfGroup
+
+=head2 MemberOfGroup
+
+takes one argument, a group id number. Limits the returned set
+to members of a given group
+
+=cut
+
+sub MemberOfGroup {
+ my $self = shift;
+ my $group = shift;
+
+ return ("No group specified") if (!defined $group);
+
+ my $groupalias = $self->NewAlias('GroupMembers');
+
+ $self->Join( ALIAS1 => 'main', FIELD1 => 'id',
+ ALIAS2 => "$groupalias", FIELD2 => 'Name');
+
+ $self->Limit (ALIAS => "$groupalias",
+ FIELD => 'GroupId',
+ VALUE => "$group",
+ OPERATOR => "="
+ );
+}
+
+# }}}
+
+# {{{ LimitToPrivileged
+
+=head2 LimitToPrivileged
+
+Limits to users who can be made members of ACLs and groups
+
+=cut
+
+sub LimitToPrivileged {
+ my $self = shift;
+ $self->Limit( FIELD => 'Privileged',
+ OPERATOR => '=',
+ VALUE => '1');
+}
+
+# }}}
+
+
+
+# {{{ LimitToSystem
+
+=head2 LimitToSystem
+
+Limits to users who can be granted rights, but who should
+never have their rights modified by a user or be made members of groups.
+
+=cut
+
+sub LimitToSystem {
+ my $self = shift;
+ $self->Limit( FIELD => 'Privileged',
+ OPERATOR => '=',
+ VALUE => '2');
+}
+
+# }}}
+
+# {{{ HasQueueRight
+
+=head2 HasQueueRight
+
+Takes a queue id as its first argument. Queue Id "0" is treated by RT as "applies to all queues"
+Takes a specific right as an optional second argument
+
+Limits the returned set to users who have rights in the queue specified, personally. If the optional second argument is supplied, limits to users who have been explicitly granted that right.
+
+
+
+This should not be used as an ACL check, but only for obtaining lists of
+users with explicit rights in a given queue.
+
+=cut
+
+sub HasQueueRight {
+ my $self = shift;
+ my $queue = shift;
+ my $right;
+
+ $right = shift if (@_);
+
+
+ my $acl_alias = $self->NewAlias('ACL');
+ $self->Join( ALIAS1 => 'main', FIELD1 => 'id',
+ ALIAS2 => $acl_alias, FIELD2 => 'PrincipalId');
+ $self->Limit (ALIAS => $acl_alias,
+ FIELD => 'PrincipalType',
+ OPERATOR => '=',
+ VALUE => 'User');
+
+
+ $self->Limit(ALIAS => $acl_alias,
+ FIELD => 'RightAppliesTo',
+ OPERATOR => '=',
+ VALUE => "$queue");
+
+
+ $self->Limit(ALIAS => $acl_alias,
+ FIELD => 'RightScope',
+ OPERATOR => '=',
+ ENTRYAGGREGATOR => 'OR',
+ VALUE => 'Queue');
+
+
+ $self->Limit(ALIAS => $acl_alias,
+ FIELD => 'RightScope',
+ OPERATOR => '=',
+ ENTRYAGGREGATOR => 'OR',
+ VALUE => 'Ticket');
+
+
+ #TODO: is this being initialized properly if the right isn't there?
+ if (defined ($right)) {
+
+ $self->Limit(ALIAS => $acl_alias,
+ FIELD => 'RightName',
+ OPERATOR => '=',
+ VALUE => "$right");
+
+
+ };
+
+
+}
+
+
+
+# }}}
+
+# {{{ HasSystemRight
+
+=head2 HasSystemRight
+
+Takes one optional argument:
+ The name of a System level right.
+
+Limits the returned set to users who have been granted system rights, personally. If the optional argument is passed in, limits to users who have been granted the explicit right listed. Please see the note attached to LimitToQueueRights
+
+=cut
+
+sub HasSystemRight {
+ my $self = shift;
+ my $right = shift if (@_);
+ my $acl_alias = $self->NewAlias('ACL');
+
+
+ $self->Join( ALIAS1 => 'main', FIELD1 => 'id',
+ ALIAS2 => $acl_alias, FIELD2 => 'PrincipalId');
+ $self->Limit (ALIAS => $acl_alias,
+ FIELD => 'PrincipalType',
+ OPERATOR => '=',
+ VALUE => 'User');
+
+ $self->Limit(ALIAS => $acl_alias,
+ FIELD => 'RightScope',
+ OPERATOR => '=',
+ VALUE => 'System');
+
+
+ #TODO: is this being initialized properly if the right isn't there?
+ if (defined ($right)) {
+ $self->Limit(ALIAS => $acl_alias,
+ FIELD => 'RightName',
+ OPERATOR => '=',
+ VALUE => "$right");
+
+ }
+
+
+}
+
+# }}}
+
+1;
+
projects / freeside.git / blobdiff