TimeWorked-like custom fields, RT#11168
[freeside.git] / rt / lib / RT / CachedGroupMember_Overlay.pm
index f2dc86f..bc21619 100644 (file)
@@ -1,48 +1,89 @@
-# BEGIN LICENSE BLOCK
-# 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-# 
-# (Except where explictly superceded by other copyright notices)
-# 
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (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.
-# 
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
-# 
-# 
-# END LICENSE BLOCK
+#
+# 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 }}}
+
+package RT::CachedGroupMember;
+
 use strict;
 no warnings qw(redefine);
 
-# {{{ Create
+=head1 NAME
+
+  RT::CachedGroupMember
+
+=head1 SYNOPSIS
+
+  use RT::CachedGroupMember;
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=cut
+
+# {{ Create
 
-=item Create PARAMHASH
+=head2 Create PARAMHASH
 
 Create takes a hash of values and creates a row in the database:
 
-  'Group' is the "top level" group we're building the cache for. This is an 
-  RT::Principal object
+  'Group' is the "top level" group we're building the cache for. This 
+  is an RT::Principal object
 
-  'Member' is the RT::Principal  of the user or group we're adding
-  to the cache.
+  'Member' is the RT::Principal  of the user or group we're adding to 
+  the cache.
 
-  'ImmediateParent' is the RT::Principal of the group that this principal
-  belongs to to get here
+  'ImmediateParent' is the RT::Principal of the group that this 
+  principal belongs to to get here
 
   int(11) 'Via' is an internal reference to CachedGroupMembers->Id of
-  the "parent" record of this cached group member. It should be empty if this
-  member is a "direct" member of this group. (In that case, it will be set to this 
-  cached group member's id after creation)
+  the "parent" record of this cached group member. It should be empty if 
+  this member is a "direct" member of this group. (In that case, it will 
+  be set to this cached group member's id after creation)
 
   This routine should _only_ be called by GroupMember->Create
 
@@ -88,7 +129,7 @@ sub Create {
                               Via               => $args{'Via'}, );
 
     unless ($id) {
-        $RT::Logger->warn( "Couldn't create "
+        $RT::Logger->warning( "Couldn't create "
                            . $args{'Member'}
                            . " as a cached member of "
                            . $args{'Group'}->Id . " via "
@@ -98,7 +139,7 @@ sub Create {
     if ( $self->__Value('Via') == 0 ) {
         my ( $vid, $vmsg ) = $self->__Set( Field => 'Via', Value => $id );
         unless ($vid) {
-            $RT::Logger->warn( "Due to a via error, couldn't create "
+            $RT::Logger->warning( "Due to a via error, couldn't create "
                                . $args{'Member'}
                                . " as a cached member of "
                                . $args{'Group'}->Id . " via "
@@ -108,6 +149,8 @@ sub Create {
         }
     }
 
+    return $id if $args{'Member'}->id == $args{'Group'}->id;
+
     if ( $args{'Member'}->IsGroup() ) {
         my $GroupMembers = $args{'Member'}->Object->MembersObj();
         while ( my $member = $GroupMembers->Next() ) {
@@ -175,7 +218,7 @@ sub Delete {
 
     # Unless $self->GroupObj still has the member recursively $self->MemberObj
     # (Since we deleted the database row above, $self no longer counts)
-    unless ( $self->GroupObj->Object->HasMemberRecursively( $self->MemberObj ) ) {
+    unless ( $self->GroupObj->Object->HasMemberRecursively( $self->MemberId ) ) {
 
 
         #   Find all ACEs granted to $self->GroupId
@@ -218,11 +261,14 @@ mysql supported foreign keys with cascading SetDisableds.
 sub SetDisabled {
     my $self = shift;
     my $val = shift;
-    
+    # if it's already disabled, we're good.
+    return (1) if ( $self->__Value('Disabled') == $val);
     my $err = $self->SUPER::SetDisabled($val);
-    unless ($err) {
-        $RT::Logger->error( "Couldn't SetDisabled CachedGroupMember " . $self->Id );
-        return (undef);
+    my ($retval, $msg) = $err->as_array();
+    unless ($retval) {
+        $RT::Logger->error( "Couldn't SetDisabled CachedGroupMember " . $self->Id .": $msg");
+        return ($err);
     }
     
     my $member = $self->MemberObj();
@@ -236,14 +282,14 @@ sub SetDisabled {
             my $kid_err = $kid->SetDisabled($val );
             unless ($kid_err) {
                 $RT::Logger->error( "Couldn't SetDisabled CachedGroupMember " . $kid->Id );
-                return (undef);
+                return ($kid_err);
             }
         }
     }
 
     # Unless $self->GroupObj still has the member recursively $self->MemberObj
     # (Since we SetDisabledd the database row above, $self no longer counts)
-    unless ( $self->GroupObj->Object->HasMemberRecursively( $self->MemberObj ) ) {
+    unless ( $self->GroupObj->Object->HasMemberRecursively( $self->MemberId ) ) {
         #   Find all ACEs granted to $self->GroupId
         my $acl = RT::ACL->new($RT::SystemUser);
         $acl->LimitToPrincipal( Id => $self->GroupId );