# BEGIN BPS TAGGED BLOCK {{{ # # COPYRIGHT: # # This software is Copyright (c) 1996-2018 Best Practical Solutions, LLC # # # (Except where explicitly superseded by other copyright notices) # # # LICENSE: # # This work is made available to you under the terms of Version 2 of # the GNU General Public License. A copy of that license should have # been provided with this software, but in any event can be snarfed # from www.gnu.org. # # This work is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA # 02110-1301 or visit their web page on the internet at # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. # # # CONTRIBUTION SUBMISSION POLICY: # # (The following paragraph is not intended to limit the rights granted # to you to modify and distribute this software under the terms of # the GNU General Public License and is only of importance to you if # you choose to contribute your changes and enhancements to the # community by submitting them to Best Practical Solutions, LLC.) # # By intentionally submitting any modifications, corrections or # derivatives to this work, or any other work intended for use with # Request Tracker, to Best Practical Solutions, LLC, you confirm that # you are the copyright holder for those contributions and you grant # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, # royalty-free, perpetual, license to use, copy, create derivative # works based on those contributions, and sublicense and distribute # those contributions and any derivatives thereof. # # END BPS TAGGED BLOCK }}} use strict; use warnings; package RT::ObjectCustomRole; use base 'RT::Record::AddAndSort'; use RT::CustomRole; use RT::ObjectCustomRoles; =head1 NAME RT::ObjectCustomRole - record representing addition of a custom role to a queue =head1 DESCRIPTION This record is created if you want to add a custom role to a queue. Inherits methods from L. For most operations it's better to use methods in L. =head1 METHODS =head2 Table Returns table name for records of this class. =cut sub Table {'ObjectCustomRoles'} =head2 ObjectCollectionClass Returns class name of collection of records custom roles can be added to. Now it's only L, so 'RT::Queues' is returned. =cut sub ObjectCollectionClass {'RT::Queues'} =head2 CustomRoleObj Returns the L object with the id returned by L =cut sub CustomRoleObj { my $self = shift; my $id = shift || $self->CustomRole; my $obj = RT::CustomRole->new( $self->CurrentUser ); $obj->Load( $id ); return $obj; } =head2 QueueObj Returns the L object which this ObjectCustomRole is added to =cut sub QueueObj { my $self = shift; my $queue = RT::Queue->new($self->CurrentUser); $queue->Load($self->ObjectId); return $queue; } =head2 Add Adds the custom role to the queue and creates (or re-enables) that queue's role group. =cut sub Add { my $self = shift; $RT::Handle->BeginTransaction; my ($ok, $msg) = $self->SUPER::Add(@_); unless ($ok) { $RT::Handle->Rollback; $RT::Logger->error("Couldn't add ObjectCustomRole: $msg"); return(undef); } my $queue = $self->QueueObj; my $role = $self->CustomRoleObj; # see if we already have this role group (which can happen if you # add a role to a queue, remove it, then add it back in) my $existing = RT::Group->new($self->CurrentUser); $existing->LoadRoleGroup( Name => $role->GroupType, Object => $queue, ); if ($existing->Id) { # there already was a role group for this queue, which means # this was previously added, then removed, and is now being re-added, # which means we have to re-enable the queue group and all the # ticket groups $role->_SetGroupsDisabledForQueue(0, $queue); } else { my $group = RT::Group->new($self->CurrentUser); my ($ok, $msg) = $group->CreateRoleGroup( Name => $role->GroupType, Object => $queue, ); unless ($ok) { $RT::Handle->Rollback; $RT::Logger->error("Couldn't create a role group: $msg"); return(undef); } } $RT::Handle->Commit; return ($ok, $msg); } =head2 Delete Removes the custom role from the queue and disables that queue's role group. =cut sub Delete { my $self = shift; $RT::Handle->BeginTransaction; $self->CustomRoleObj->_SetGroupsDisabledForQueue(1, $self->QueueObj); # remove the ObjectCustomRole record my ($ok, $msg) = $self->SUPER::Delete(@_); unless ($ok) { $RT::Handle->Rollback; $RT::Logger->error("Couldn't add ObjectCustomRole: $msg"); return(undef); } $RT::Handle->Commit; return ($ok, $msg); } sub FindDependencies { my $self = shift; my ($walker, $deps) = @_; $self->SUPER::FindDependencies($walker, $deps); $deps->Add( out => $self->CustomRoleObj ); $deps->Add( out => $self->QueueObj ); } sub Serialize { my $self = shift; my %args = (@_); my %store = $self->SUPER::Serialize(@_); if ($store{ObjectId}) { my $obj = RT::Queue->new( RT->SystemUser ); $obj->Load( $store{ObjectId} ); $store{ObjectId} = \($obj->UID); } return %store; } =head2 id Returns the current value of id. (In the database, id is stored as int(11).) =cut =head2 CustomRole Returns the current value of CustomRole. (In the database, CustomRole is stored as int(11).) =head2 SetCustomRole VALUE Set CustomRole to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, CustomRole will be stored as a int(11).) =cut =head2 ObjectId Returns the current value of ObjectId. (In the database, ObjectId is stored as int(11).) =head2 SetObjectId VALUE Set ObjectId to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ObjectId will be stored as a int(11).) =cut =head2 SortOrder Returns the current value of SortOrder. (In the database, SortOrder is stored as int(11).) =head2 SetSortOrder VALUE Set SortOrder to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, SortOrder will be stored as a int(11).) =cut =head2 Creator Returns the current value of Creator. (In the database, Creator is stored as int(11).) =cut =head2 Created Returns the current value of Created. (In the database, Created is stored as datetime.) =cut =head2 LastUpdatedBy Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).) =cut =head2 LastUpdated Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.) =cut sub _CoreAccessible { { id => {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, CustomRole => {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, ObjectId => {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, SortOrder => {read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, Creator => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, Created => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, LastUpdatedBy => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, LastUpdated => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, } }; RT::Base->_ImportOverlays(); 1;