1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
51 RT::Queue - an RT Queue object
69 no warnings qw(redefine);
73 use RT::Interface::Email;
75 our @DEFAULT_ACTIVE_STATUS = qw(new open stalled);
76 our @DEFAULT_INACTIVE_STATUS = qw(resolved rejected deleted);
78 # $self->loc('new'); # For the string extractor to get a string to localize
79 # $self->loc('open'); # For the string extractor to get a string to localize
80 # $self->loc('stalled'); # For the string extractor to get a string to localize
81 # $self->loc('resolved'); # For the string extractor to get a string to localize
82 # $self->loc('rejected'); # For the string extractor to get a string to localize
83 # $self->loc('deleted'); # For the string extractor to get a string to localize
87 SeeQueue => 'Can this principal see this queue', # loc_pair
88 AdminQueue => 'Create, delete and modify queues', # loc_pair
89 ShowACL => 'Display Access Control List', # loc_pair
90 ModifyACL => 'Modify Access Control List', # loc_pair
91 ModifyQueueWatchers => 'Modify the queue watchers', # loc_pair
92 SeeCustomField => 'See custom field values', # loc_pair
93 ModifyCustomField => 'Modify custom field values', # loc_pair
94 AssignCustomFields => 'Assign and remove custom fields', # loc_pair
95 ModifyTemplate => 'Modify Scrip templates for this queue', # loc_pair
96 ShowTemplate => 'Display Scrip templates for this queue', # loc_pair
98 ModifyScrips => 'Modify Scrips for this queue', # loc_pair
99 ShowScrips => 'Display Scrips for this queue', # loc_pair
101 ShowTicket => 'See ticket summaries', # loc_pair
102 ShowTicketComments => 'See ticket private commentary', # loc_pair
103 ShowOutgoingEmail => 'See exact outgoing email messages and their recipeients', # loc_pair
105 Watch => 'Sign up as a ticket Requestor or ticket or queue Cc', # loc_pair
106 WatchAsAdminCc => 'Sign up as a ticket or queue AdminCc', # loc_pair
107 CreateTicket => 'Create tickets in this queue', # loc_pair
108 ReplyToTicket => 'Reply to tickets', # loc_pair
109 CommentOnTicket => 'Comment on tickets', # loc_pair
110 OwnTicket => 'Own tickets', # loc_pair
111 ModifyTicket => 'Modify tickets', # loc_pair
112 DeleteTicket => 'Delete tickets', # loc_pair
113 TakeTicket => 'Take tickets', # loc_pair
114 StealTicket => 'Steal tickets', # loc_pair
116 ForwardMessage => 'Forward messages to third person(s)', # loc_pair
120 # Tell RT::ACE that this sort of object can get acls granted
121 $RT::ACE::OBJECT_TYPES{'RT::Queue'} = 1;
123 # TODO: This should be refactored out into an RT::ACLedObject or something
124 # stuff the rights into a hash of rights that can exist.
126 foreach my $right ( keys %{$RIGHTS} ) {
127 $RT::ACE::LOWERCASERIGHTNAMES{ lc $right } = $right;
130 =head2 AddRights C<RIGHT>, C<DESCRIPTION> [, ...]
132 Adds the given rights to the list of possible rights. This method
133 should be called during server startup, not at runtime.
140 $RIGHTS = { %$RIGHTS, %new };
141 %RT::ACE::LOWERCASERIGHTNAMES = ( %RT::ACE::LOWERCASERIGHTNAMES,
142 map { lc($_) => $_ } keys %new);
147 my %args = ( Target => '',
153 unless ( $self->CurrentUserHasRight('ModifyQueue') ) {
154 return ( 0, $self->loc("Permission Denied") );
157 return $self->SUPER::_AddLink(%args);
170 unless ( $self->CurrentUserHasRight('ModifyQueue') ) {
171 $RT::Logger->debug("No permission to delete links");
172 return ( 0, $self->loc('Permission Denied'))
175 return $self->SUPER::_DeleteLink(%args);
178 =head2 AvailableRights
180 Returns a hash of available rights for this object. The keys are the right names and the values are a description of what the rights do
184 sub AvailableRights {
189 # {{{ ActiveStatusArray
191 =head2 ActiveStatusArray
193 Returns an array of all ActiveStatuses for this queue
197 sub ActiveStatusArray {
199 if (RT->Config->Get('ActiveStatus')) {
200 return (RT->Config->Get('ActiveStatus'))
202 $RT::Logger->warning("RT::ActiveStatus undefined, falling back to deprecated defaults");
203 return (@DEFAULT_ACTIVE_STATUS);
209 # {{{ InactiveStatusArray
211 =head2 InactiveStatusArray
213 Returns an array of all InactiveStatuses for this queue
217 sub InactiveStatusArray {
219 if (RT->Config->Get('InactiveStatus')) {
220 return (RT->Config->Get('InactiveStatus'))
222 $RT::Logger->warning("RT::InactiveStatus undefined, falling back to deprecated defaults");
223 return (@DEFAULT_INACTIVE_STATUS);
233 Returns an array of all statuses for this queue
239 return ($self->ActiveStatusArray(), $self->InactiveStatusArray());
246 =head2 IsValidStatus VALUE
248 Returns true if VALUE is a valid status. Otherwise, returns 0.
257 my $retval = grep ( $_ eq $value, $self->StatusArray );
266 =head2 IsActiveStatus VALUE
268 Returns true if VALUE is a Active status. Otherwise, returns 0
277 my $retval = grep ( $_ eq $value, $self->ActiveStatusArray );
284 # {{{ IsInactiveStatus
286 =head2 IsInactiveStatus VALUE
288 Returns true if VALUE is a Inactive status. Otherwise, returns 0
293 sub IsInactiveStatus {
297 my $retval = grep ( $_ eq $value, $self->InactiveStatusArray );
312 Arguments: ARGS is a hash of named parameters. Valid parameters are:
322 If you pass the ACL check, it creates the queue and returns its queue id.
331 CorrespondAddress => '',
333 CommentAddress => '',
335 InitialPriority => 0,
340 _RecordTransaction => 1,
344 unless ( $self->CurrentUser->HasRight(Right => 'AdminQueue', Object => $RT::System) )
346 return ( 0, $self->loc("No permission to create queues") );
349 unless ( $self->ValidateName( $args{'Name'} ) ) {
350 return ( 0, $self->loc('Queue already exists') );
353 my %attrs = map {$_ => 1} $self->ReadableAttributes;
355 #TODO better input validation
356 $RT::Handle->BeginTransaction();
357 my $id = $self->SUPER::Create( map { $_ => $args{$_} } grep exists $args{$_}, keys %attrs );
359 $RT::Handle->Rollback();
360 return ( 0, $self->loc('Queue could not be created') );
363 my $create_ret = $self->_CreateQueueGroups();
364 unless ($create_ret) {
365 $RT::Handle->Rollback();
366 return ( 0, $self->loc('Queue could not be created') );
368 if ( $args{'_RecordTransaction'} ) {
369 $self->_NewTransaction( Type => "Create" );
373 if ( defined $args{'Sign'} ) {
374 my ($status, $msg) = $self->SetSign( $args{'Sign'} );
375 $RT::Logger->error("Couldn't set attribute 'Sign': $msg")
378 if ( defined $args{'Encrypt'} ) {
379 my ($status, $msg) = $self->SetEncrypt( $args{'Encrypt'} );
380 $RT::Logger->error("Couldn't set attribute 'Encrypt': $msg")
384 RT->System->QueueCacheNeedsUpdate(1);
386 return ( $id, $self->loc("Queue created") );
396 $self->loc('Deleting this object would break referential integrity') );
401 # {{{ sub SetDisabled
406 1 will cause this queue to no longer be available for tickets.
407 0 will re-enable this queue.
415 $RT::Handle->BeginTransaction();
416 my $set_err = $self->SUPER::SetDisabled($val);
418 $RT::Handle->Rollback();
419 $RT::Logger->warning("Couldn't ".($val == 1) ? "disable" : "enable"." queue ".$self->PrincipalObj->Id);
422 $self->_NewTransaction( Type => ($val == 1) ? "Disabled" : "Enabled" );
424 $RT::Handle->Commit();
426 RT->System->QueueCacheNeedsUpdate(1);
429 return (1, $self->loc("Queue disabled"));
431 return (1, $self->loc("Queue enabled"));
442 Takes either a numerical id or a textual Name and loads the specified queue.
449 my $identifier = shift;
450 if ( !$identifier ) {
454 if ( $identifier =~ /^(\d+)$/ ) {
455 $self->SUPER::LoadById($identifier);
458 $self->LoadByCols( Name => $identifier );
461 return ( $self->Id );
467 # {{{ sub ValidateName
469 =head2 ValidateName NAME
471 Takes a queue name. Returns true if it's an ok name for
472 a new queue. Returns undef if there's already a queue by that name.
480 my $tempqueue = new RT::Queue($RT::SystemUser);
481 $tempqueue->Load($name);
483 #If this queue exists, return undef
484 if ( $tempqueue->Name() && $tempqueue->id != $self->id) {
488 #If the queue doesn't exist, return 1
490 return ($self->SUPER::ValidateName($name));
505 return undef unless $self->CurrentUserHasRight('SeeQueue');
506 my $attr = $self->FirstAttribute('Sign') or return 0;
507 return $attr->Content;
514 return ( 0, $self->loc('Permission Denied') )
515 unless $self->CurrentUserHasRight('AdminQueue');
517 my ($status, $msg) = $self->SetAttribute(
519 Description => 'Sign outgoing messages by default',
522 return ($status, $msg) unless $status;
523 return ($status, $self->loc('Signing enabled')) if $value;
524 return ($status, $self->loc('Signing disabled'));
531 return undef unless $self->CurrentUserHasRight('SeeQueue');
532 my $attr = $self->FirstAttribute('Encrypt') or return 0;
533 return $attr->Content;
540 return ( 0, $self->loc('Permission Denied') )
541 unless $self->CurrentUserHasRight('AdminQueue');
543 my ($status, $msg) = $self->SetAttribute(
545 Description => 'Encrypt outgoing messages by default',
548 return ($status, $msg) unless $status;
549 return ($status, $self->loc('Encrypting enabled')) if $value;
550 return ($status, $self->loc('Encrypting disabled'));
555 return RT->System->SubjectTag( $self );
562 return ( 0, $self->loc('Permission Denied') )
563 unless $self->CurrentUserHasRight('AdminQueue');
565 my $attr = RT->System->FirstAttribute('BrandedSubjectTag');
566 my $map = $attr ? $attr->Content : {};
567 if ( defined $value && length $value ) {
568 $map->{ $self->id } = $value;
570 delete $map->{ $self->id };
573 my ($status, $msg) = RT->System->SetAttribute(
574 Name => 'BrandedSubjectTag',
575 Description => 'Queue id => subject tag map',
578 return ($status, $msg) unless $status;
579 return ($status, $self->loc(
580 "SubjectTag changed to [_1]",
581 (defined $value && length $value)? $value : $self->loc("(no value)")
589 Returns an RT::Templates object of all of this queue's templates.
596 my $templates = RT::Templates->new( $self->CurrentUser );
598 if ( $self->CurrentUserHasRight('ShowTemplate') ) {
599 $templates->LimitToQueue( $self->id );
607 # {{{ Dealing with custom fields
611 =head2 CustomField NAME
613 Load the queue-specific custom field named NAME
620 my $cf = RT::CustomField->new($self->CurrentUser);
621 $cf->LoadByNameAndQueue(Name => $name, Queue => $self->Id);
626 # {{{ TicketCustomFields
628 =head2 TicketCustomFields
630 Returns an L<RT::CustomFields> object containing all global and
631 queue-specific B<ticket> custom fields.
635 sub TicketCustomFields {
638 my $cfs = RT::CustomFields->new( $self->CurrentUser );
639 if ( $self->CurrentUserHasRight('SeeQueue') ) {
640 $cfs->SetContextObject( $self );
641 $cfs->LimitToGlobalOrObjectId( $self->Id );
642 $cfs->LimitToLookupType( 'RT::Queue-RT::Ticket' );
643 $cfs->ApplySortOrder;
650 # {{{ TicketTransactionCustomFields
652 =head2 TicketTransactionCustomFields
654 Returns an L<RT::CustomFields> object containing all global and
655 queue-specific B<transaction> custom fields.
659 sub TicketTransactionCustomFields {
662 my $cfs = RT::CustomFields->new( $self->CurrentUser );
663 if ( $self->CurrentUserHasRight('SeeQueue') ) {
664 $cfs->LimitToGlobalOrObjectId( $self->Id );
665 $cfs->LimitToLookupType( 'RT::Queue-RT::Ticket-RT::Transaction' );
666 $cfs->ApplySortOrder;
676 # {{{ Routines dealing with watchers.
678 # {{{ _CreateQueueGroups
680 =head2 _CreateQueueGroups
682 Create the ticket groups and links for this ticket.
683 This routine expects to be called from Ticket->Create _inside of a transaction_
685 It will create four groups for this ticket: Requestor, Cc, AdminCc and Owner.
687 It will return true on success and undef on failure.
693 sub _CreateQueueGroups {
696 my @types = qw(Cc AdminCc Requestor Owner);
698 foreach my $type (@types) {
699 my $type_obj = RT::Group->new($self->CurrentUser);
700 my ($id, $msg) = $type_obj->CreateRoleGroup(Instance => $self->Id,
702 Domain => 'RT::Queue-Role');
704 $RT::Logger->error("Couldn't create a Queue group of type '$type' for ticket ".
705 $self->Id.": ".$msg);
720 AddWatcher takes a parameter hash. The keys are as follows:
722 Type One of Requestor, Cc, AdminCc
724 PrinicpalId The RT::Principal id of the user or group that's being added as a watcher
725 Email The email address of the new watcher. If a user with this
726 email address can't be found, a new nonprivileged user will be created.
728 If the watcher you\'re trying to set has an RT account, set the Owner parameter to their User Id. Otherwise, set the Email parameter to their Email address.
730 Returns a tuple of (status/id, message).
738 PrincipalId => undef,
743 return ( 0, "No principal specified" )
744 unless $args{'Email'} or $args{'PrincipalId'};
746 if ( !$args{'PrincipalId'} && $args{'Email'} ) {
747 my $user = RT::User->new( $self->CurrentUser );
748 $user->LoadByEmail( $args{'Email'} );
749 $args{'PrincipalId'} = $user->PrincipalId if $user->id;
753 return ( $self->_AddWatcher(%args) )
754 if $self->CurrentUserHasRight('ModifyQueueWatchers');
756 #If the watcher we're trying to add is for the current user
757 if ( defined $args{'PrincipalId'} && $self->CurrentUser->PrincipalId eq $args{'PrincipalId'}) {
758 # If it's an AdminCc and they don't have
759 # 'WatchAsAdminCc' or 'ModifyTicket', bail
760 if ( defined $args{'Type'} && ($args{'Type'} eq 'AdminCc') ) {
761 return ( $self->_AddWatcher(%args) )
762 if $self->CurrentUserHasRight('WatchAsAdminCc');
765 # If it's a Requestor or Cc and they don't have
766 # 'Watch' or 'ModifyTicket', bail
767 elsif ( $args{'Type'} eq 'Cc' or $args{'Type'} eq 'Requestor' ) {
768 return ( $self->_AddWatcher(%args) )
769 if $self->CurrentUserHasRight('Watch');
772 $RT::Logger->warning( "$self -> AddWatcher got passed a bogus type");
773 return ( 0, $self->loc('Error in parameters to Queue->AddWatcher') );
777 return ( 0, $self->loc("Permission Denied") );
780 #This contains the meat of AddWatcher. but can be called from a routine like
781 # Create, which doesn't need the additional acl check
787 PrincipalId => undef,
793 my $principal = RT::Principal->new( $self->CurrentUser );
794 if ( $args{'PrincipalId'} ) {
795 $principal->Load( $args{'PrincipalId'} );
796 if ( $principal->id and $principal->IsUser and my $email = $principal->Object->EmailAddress ) {
797 return (0, $self->loc("[_1] is an address RT receives mail at. Adding it as a '[_2]' would create a mail loop", $email, $self->loc($args{'Type'})))
798 if RT::EmailParser->IsRTAddress( $email );
801 elsif ( $args{'Email'} ) {
802 if ( RT::EmailParser->IsRTAddress( $args{'Email'} ) ) {
803 return (0, $self->loc("[_1] is an address RT receives mail at. Adding it as a '[_2]' would create a mail loop", $args{'Email'}, $self->loc($args{'Type'})));
805 my $user = RT::User->new($self->CurrentUser);
806 $user->LoadByEmail( $args{'Email'} );
807 $user->Load( $args{'Email'} )
810 if ( $user->Id ) { # If the user exists
811 $principal->Load( $user->PrincipalId );
813 # if the user doesn't exist, we need to create a new user
814 my $new_user = RT::User->new($RT::SystemUser);
816 my ( $Address, $Name ) =
817 RT::Interface::Email::ParseAddressFromHeader($args{'Email'});
819 my ( $Val, $Message ) = $new_user->Create(
821 EmailAddress => $Address,
824 Comments => 'Autocreated when added as a watcher'
827 $RT::Logger->error("Failed to create user ".$args{'Email'} .": " .$Message);
828 # Deal with the race condition of two account creations at once
829 $new_user->LoadByEmail( $args{'Email'} );
831 $principal->Load( $new_user->PrincipalId );
834 # If we can't find this watcher, we need to bail.
835 unless ( $principal->Id ) {
836 return(0, $self->loc("Could not find or create that user"));
839 my $group = RT::Group->new($self->CurrentUser);
840 $group->LoadQueueRoleGroup(Type => $args{'Type'}, Queue => $self->Id);
841 unless ($group->id) {
842 return(0,$self->loc("Group not found"));
845 if ( $group->HasMember( $principal)) {
847 return ( 0, $self->loc('That principal is already a [_1] for this queue', $args{'Type'}) );
851 my ($m_id, $m_msg) = $group->_AddMember(PrincipalId => $principal->Id);
853 $RT::Logger->error("Failed to add ".$principal->Id." as a member of group ".$group->Id.": ".$m_msg);
855 return ( 0, $self->loc('Could not make that principal a [_1] for this queue', $args{'Type'}) );
857 return ( 1, $self->loc('Added principal as a [_1] for this queue', $args{'Type'}) );
862 # {{{ sub DeleteWatcher
864 =head2 DeleteWatcher { Type => TYPE, PrincipalId => PRINCIPAL_ID, Email => EMAIL_ADDRESS }
867 Deletes a queue watcher. Takes two arguments:
869 Type (one of Requestor,Cc,AdminCc)
873 PrincipalId (an RT::Principal Id of the watcher you want to remove)
875 Email (the email address of an existing wathcer)
884 my %args = ( Type => undef,
885 PrincipalId => undef,
889 unless ( $args{'PrincipalId'} || $args{'Email'} ) {
890 return ( 0, $self->loc("No principal specified") );
893 if ( !$args{PrincipalId} and $args{Email} ) {
894 my $user = RT::User->new( $self->CurrentUser );
895 my ($rv, $msg) = $user->LoadByEmail( $args{Email} );
896 $args{PrincipalId} = $user->PrincipalId if $rv;
899 my $principal = RT::Principal->new( $self->CurrentUser );
900 if ( $args{'PrincipalId'} ) {
901 $principal->Load( $args{'PrincipalId'} );
904 my $user = RT::User->new( $self->CurrentUser );
905 $user->LoadByEmail( $args{'Email'} );
906 $principal->Load( $user->Id );
909 # If we can't find this watcher, we need to bail.
910 unless ( $principal->Id ) {
911 return ( 0, $self->loc("Could not find that principal") );
914 my $group = RT::Group->new($self->CurrentUser);
915 $group->LoadQueueRoleGroup(Type => $args{'Type'}, Queue => $self->Id);
916 unless ($group->id) {
917 return(0,$self->loc("Group not found"));
920 my $can_modify_queue = $self->CurrentUserHasRight('ModifyQueueWatchers');
923 #If the watcher we're trying to add is for the current user
924 if ( defined $args{'PrincipalId'} and $self->CurrentUser->PrincipalId eq $args{'PrincipalId'}) {
925 # If it's an AdminCc and they don't have
926 # 'WatchAsAdminCc' or 'ModifyQueue', bail
927 if ( $args{'Type'} eq 'AdminCc' ) {
928 unless ( $can_modify_queue
929 or $self->CurrentUserHasRight('WatchAsAdminCc') ) {
930 return ( 0, $self->loc('Permission Denied'))
934 # If it's a Requestor or Cc and they don't have
935 # 'Watch' or 'ModifyQueue', bail
936 elsif ( ( $args{'Type'} eq 'Cc' ) or ( $args{'Type'} eq 'Requestor' ) ) {
937 unless ( $can_modify_queue
938 or $self->CurrentUserHasRight('Watch') ) {
939 return ( 0, $self->loc('Permission Denied'))
943 $RT::Logger->warning( "$self -> DeleteWatcher got passed a bogus type");
944 return ( 0, $self->loc('Error in parameters to Queue->DeleteWatcher') );
948 # If the watcher isn't the current user
949 # and the current user doesn't have 'ModifyQueueWathcers' bail
951 unless ( $can_modify_queue ) {
952 return ( 0, $self->loc("Permission Denied") );
959 # see if this user is already a watcher.
961 unless ( $group->HasMember($principal)) {
963 $self->loc('That principal is not a [_1] for this queue', $args{'Type'}) );
966 my ($m_id, $m_msg) = $group->_DeleteMember($principal->Id);
968 $RT::Logger->error("Failed to delete ".$principal->Id.
969 " as a member of group ".$group->Id.": ".$m_msg);
971 return ( 0, $self->loc('Could not remove that principal as a [_1] for this queue', $args{'Type'}) );
974 return ( 1, $self->loc("[_1] is no longer a [_2] for this queue.", $principal->Object->Name, $args{'Type'} ));
979 # {{{ AdminCcAddresses
981 =head2 AdminCcAddresses
983 returns String: All queue AdminCc email addresses as a string
987 sub AdminCcAddresses {
990 unless ( $self->CurrentUserHasRight('SeeQueue') ) {
994 return ( $self->AdminCc->MemberEmailAddressesAsString )
1004 returns String: All queue Ccs as a string of email addresses
1011 unless ( $self->CurrentUserHasRight('SeeQueue') ) {
1015 return ( $self->Cc->MemberEmailAddressesAsString);
1026 Returns an RT::Group object which contains this Queue's Ccs.
1027 If the user doesn't have "ShowQueue" permission, returns an empty group
1034 my $group = RT::Group->new($self->CurrentUser);
1035 if ( $self->CurrentUserHasRight('SeeQueue') ) {
1036 $group->LoadQueueRoleGroup(Type => 'Cc', Queue => $self->Id);
1049 Returns an RT::Group object which contains this Queue's AdminCcs.
1050 If the user doesn't have "ShowQueue" permission, returns an empty group
1057 my $group = RT::Group->new($self->CurrentUser);
1058 if ( $self->CurrentUserHasRight('SeeQueue') ) {
1059 $group->LoadQueueRoleGroup(Type => 'AdminCc', Queue => $self->Id);
1067 # {{{ IsWatcher, IsCc, IsAdminCc
1070 # a generic routine to be called by IsRequestor, IsCc and IsAdminCc
1072 =head2 IsWatcher { Type => TYPE, PrincipalId => PRINCIPAL_ID }
1074 Takes a param hash with the attributes Type and PrincipalId
1076 Type is one of Requestor, Cc, AdminCc and Owner
1078 PrincipalId is an RT::Principal id
1080 Returns true if that principal is a member of the group Type for this queue
1088 my %args = ( Type => 'Cc',
1089 PrincipalId => undef,
1093 # Load the relevant group.
1094 my $group = RT::Group->new($self->CurrentUser);
1095 $group->LoadQueueRoleGroup(Type => $args{'Type'}, Queue => $self->id);
1096 # Ask if it has the member in question
1098 my $principal = RT::Principal->new($self->CurrentUser);
1099 $principal->Load($args{'PrincipalId'});
1100 unless ($principal->Id) {
1104 return ($group->HasMemberRecursively($principal));
1112 =head2 IsCc PRINCIPAL_ID
1114 Takes an RT::Principal id.
1115 Returns true if the principal is a requestor of the current queue.
1124 return ( $self->IsWatcher( Type => 'Cc', PrincipalId => $cc ) );
1132 =head2 IsAdminCc PRINCIPAL_ID
1134 Takes an RT::Principal id.
1135 Returns true if the principal is a requestor of the current queue.
1143 return ( $self->IsWatcher( Type => 'AdminCc', PrincipalId => $person ) );
1158 # {{{ ACCESS CONTROL
1164 unless ( $self->CurrentUserHasRight('AdminQueue') ) {
1165 return ( 0, $self->loc('Permission Denied') );
1167 return ( $self->SUPER::_Set(@_) );
1177 unless ( $self->CurrentUserHasRight('SeeQueue') ) {
1181 return ( $self->__Value(@_) );
1186 # {{{ sub CurrentUserHasRight
1188 =head2 CurrentUserHasRight
1190 Takes one argument. A textual string with the name of the right we want to check.
1191 Returns true if the current user has that right for this queue.
1192 Returns undef otherwise.
1196 sub CurrentUserHasRight {
1202 Principal => $self->CurrentUser,
1215 Takes a param hash with the fields 'Right' and 'Principal'.
1216 Principal defaults to the current user.
1217 Returns true if the principal has that right for this queue.
1218 Returns undef otherwise.
1222 # TAKES: Right and optional "Principal" which defaults to the current user
1227 Principal => $self->CurrentUser,
1230 my $principal = delete $args{'Principal'};
1231 unless ( $principal ) {
1232 $RT::Logger->error("Principal undefined in Queue::HasRight");
1236 return $principal->HasRight(
1238 Object => ($self->Id ? $self : $RT::System),