This commit was generated by cvs2svn to compensate for changes in r4407,

[freeside.git] / rt / lib / RT / Queue_Overlay.pm

diff --git a/rt/lib/RT/Queue_Overlay.pm b/rt/lib/RT/Queue_Overlay.pm
index 0d50a74..2f180fc 100644 (file)
--- a/rt/lib/RT/Queue_Overlay.pm
+++ b/rt/lib/RT/Queue_Overlay.pm
@@ -1,8 +1,8 @@
-# {{{ BEGIN BPS TAGGED BLOCK
+# BEGIN BPS TAGGED BLOCK {{{

 # 
 # COPYRIGHT:
 #  
 # 
 # COPYRIGHT:
 #  

-# This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC 
+# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC 

 #                                          <jesse@bestpractical.com>
 # 
 # (Except where explicitly superseded by other copyright notices)
 #                                          <jesse@bestpractical.com>
 # 
 # (Except where explicitly superseded by other copyright notices)


@@ -42,7 +42,8 @@
 # works based on those contributions, and sublicense and distribute
 # those contributions and any derivatives thereof.
 # 
 # works based on those contributions, and sublicense and distribute
 # those contributions and any derivatives thereof.
 # 

-# }}} END BPS TAGGED BLOCK
+# END BPS TAGGED BLOCK }}}
+

 =head1 NAME
 
   RT::Queue - an RT Queue object
 =head1 NAME
 
   RT::Queue - an RT Queue object


@@ -64,18 +65,20 @@ use RT::Queue;
 
 =cut
 
 
 =cut
 

+
+package RT::Queue;
+

 use strict;
 no warnings qw(redefine);
 
 use strict;
 no warnings qw(redefine);
 

-use vars qw(@STATUS @ACTIVE_STATUS @INACTIVE_STATUS $RIGHTS);
+use vars qw(@DEFAULT_ACTIVE_STATUS @DEFAULT_INACTIVE_STATUS $RIGHTS);
+

 use RT::Groups;
 use RT::ACL;
 use RT::Groups;
 use RT::ACL;

-use RT::EmailParser;
-
+use RT::Interface::Email;

 
 

-@ACTIVE_STATUS = qw(new open stalled);
-@INACTIVE_STATUS = qw(resolved rejected deleted);
-@STATUS = (@ACTIVE_STATUS, @INACTIVE_STATUS);
+@DEFAULT_ACTIVE_STATUS = qw(new open stalled);
+@DEFAULT_INACTIVE_STATUS = qw(resolved rejected deleted);  

 
 # $self->loc('new'); # For the string extractor to get a string to localize
 # $self->loc('open'); # For the string extractor to get a string to localize
 
 # $self->loc('new'); # For the string extractor to get a string to localize
 # $self->loc('open'); # For the string extractor to get a string to localize


@@ -91,7 +94,7 @@ $RIGHTS = {
     ShowACL             => 'Display Access Control List',             # loc_pair
     ModifyACL           => 'Modify Access Control List',              # loc_pair
     ModifyQueueWatchers => 'Modify the queue watchers',               # loc_pair
     ShowACL             => 'Display Access Control List',             # loc_pair
     ModifyACL           => 'Modify Access Control List',              # loc_pair
     ModifyQueueWatchers => 'Modify the queue watchers',               # loc_pair

-    AdminCustomFields   => 'Create, delete and modify custom fields', # loc_pair
+    AssignCustomFields  => 'Assign and remove custom fields',         # loc_pair

     ModifyTemplate      => 'Modify Scrip templates for this queue',   # loc_pair
     ShowTemplate        => 'Display Scrip templates for this queue',  # loc_pair
 
     ModifyTemplate      => 'Modify Scrip templates for this queue',   # loc_pair
     ShowTemplate        => 'Display Scrip templates for this queue',  # loc_pair
 


@@ -180,7 +183,12 @@ Returns an array of all ActiveStatuses for this queue
 
 sub ActiveStatusArray {
     my $self = shift;
 
 sub ActiveStatusArray {
     my $self = shift;

-    return (@ACTIVE_STATUS);
+    if (@RT::ActiveStatus) {
+       return (@RT::ActiveStatus)
+    } else {
+        $RT::Logger->warning("RT::ActiveStatus undefined, falling back to deprecated defaults");
+        return (@DEFAULT_ACTIVE_STATUS);
+    }

 }
 
 # }}}
 }
 
 # }}}


@@ -195,7 +203,12 @@ Returns an array of all InactiveStatuses for this queue
 
 sub InactiveStatusArray {
     my $self = shift;
 
 sub InactiveStatusArray {
     my $self = shift;

-    return (@INACTIVE_STATUS);
+    if (@RT::InactiveStatus) {
+       return (@RT::InactiveStatus)
+    } else {
+        $RT::Logger->warning("RT::InactiveStatus undefined, falling back to deprecated defaults");
+        return (@DEFAULT_INACTIVE_STATUS);
+    }

 }
 
 # }}}
 }
 
 # }}}


@@ -210,7 +223,7 @@ Returns an array of all statuses for this queue
 
 sub StatusArray {
     my $self = shift;
 
 sub StatusArray {
     my $self = shift;

-    return (@STATUS);
+    return ($self->ActiveStatusArray(), $self->InactiveStatusArray());

 }
 
 # }}}
 }
 
 # }}}


@@ -219,20 +232,23 @@ sub StatusArray {
 
 =head2 IsValidStatus VALUE
 
 
 =head2 IsValidStatus VALUE
 

-Returns true if VALUE is a valid status.  Otherwise, returns 0
+Returns true if VALUE is a valid status.  Otherwise, returns 0.
+
+=begin testing

 
 

-=for testing

 my $q = RT::Queue->new($RT::SystemUser);
 ok($q->IsValidStatus('new')== 1, 'New is a valid status');
 ok($q->IsValidStatus('f00')== 0, 'f00 is not a valid status');
 
 my $q = RT::Queue->new($RT::SystemUser);
 ok($q->IsValidStatus('new')== 1, 'New is a valid status');
 ok($q->IsValidStatus('f00')== 0, 'f00 is not a valid status');
 

+=end testing
+

 =cut
 
 sub IsValidStatus {
     my $self  = shift;
     my $value = shift;
 
 =cut
 
 sub IsValidStatus {
     my $self  = shift;
     my $value = shift;
 

-    my $retval = grep ( /^$value$/, $self->StatusArray );
+    my $retval = grep ( $_ eq $value, $self->StatusArray );

     return ($retval);
 
 }
     return ($retval);
 
 }


@@ -245,19 +261,22 @@ sub IsValidStatus {
 
 Returns true if VALUE is a Active status.  Otherwise, returns 0
 
 
 Returns true if VALUE is a Active status.  Otherwise, returns 0
 

-=for testing
+=begin testing
+

 my $q = RT::Queue->new($RT::SystemUser);
 ok($q->IsActiveStatus('new')== 1, 'New is a Active status');
 ok($q->IsActiveStatus('rejected')== 0, 'Rejected is an inactive status');
 ok($q->IsActiveStatus('f00')== 0, 'f00 is not a Active status');
 
 my $q = RT::Queue->new($RT::SystemUser);
 ok($q->IsActiveStatus('new')== 1, 'New is a Active status');
 ok($q->IsActiveStatus('rejected')== 0, 'Rejected is an inactive status');
 ok($q->IsActiveStatus('f00')== 0, 'f00 is not a Active status');
 

+=end testing
+

 =cut
 
 sub IsActiveStatus {
     my $self  = shift;
     my $value = shift;
 
 =cut
 
 sub IsActiveStatus {
     my $self  = shift;
     my $value = shift;
 

-    my $retval = grep ( /^$value$/, $self->ActiveStatusArray );
+    my $retval = grep ( $_ eq $value, $self->ActiveStatusArray );

     return ($retval);
 
 }
     return ($retval);
 
 }


@@ -270,19 +289,22 @@ sub IsActiveStatus {
 
 Returns true if VALUE is a Inactive status.  Otherwise, returns 0
 
 
 Returns true if VALUE is a Inactive status.  Otherwise, returns 0
 

-=for testing
+=begin testing
+

 my $q = RT::Queue->new($RT::SystemUser);
 ok($q->IsInactiveStatus('new')== 0, 'New is a Active status');
 ok($q->IsInactiveStatus('rejected')== 1, 'rejeected is an Inactive status');
 ok($q->IsInactiveStatus('f00')== 0, 'f00 is not a Active status');
 
 my $q = RT::Queue->new($RT::SystemUser);
 ok($q->IsInactiveStatus('new')== 0, 'New is a Active status');
 ok($q->IsInactiveStatus('rejected')== 1, 'rejeected is an Inactive status');
 ok($q->IsInactiveStatus('f00')== 0, 'f00 is not a Active status');
 

+=end testing
+

 =cut
 
 sub IsInactiveStatus {
     my $self  = shift;
     my $value = shift;
 
 =cut
 
 sub IsInactiveStatus {
     my $self  = shift;
     my $value = shift;
 

-    my $retval = grep ( /^$value$/, $self->InactiveStatusArray );
+    my $retval = grep ( $_ eq $value, $self->InactiveStatusArray );

     return ($retval);
 
 }
     return ($retval);
 
 }


@@ -292,11 +314,34 @@ sub IsInactiveStatus {
 
 # {{{ sub Create
 
 
 # {{{ sub Create
 

-=head2 Create

 
 

-Create takes the name of the new queue 
+
+
+=head2 Create(ARGS)
+
+Arguments: ARGS is a hash of named parameters.  Valid parameters are:
+
+  Name (required)
+  Description
+  CorrespondAddress
+  CommentAddress
+  InitialPriority
+  FinalPriority
+  DefaultDueIn
+ 

 If you pass the ACL check, it creates the queue and returns its queue id.
 
 If you pass the ACL check, it creates the queue and returns its queue id.
 

+=begin testing
+
+my $queue = RT::Queue->new($RT::SystemUser);
+my ($id, $val) = $queue->Create( Name => 'Test1');
+ok($id, $val);
+
+($id, $val) = $queue->Create( Name => '66');
+ok(!$id, $val);
+
+=end testing
+

 =cut
 
 sub Create {
 =cut
 
 sub Create {


@@ -357,8 +402,8 @@ sub Delete {
 =head2 SetDisabled
 
 Takes a boolean.
 =head2 SetDisabled
 
 Takes a boolean.

-1 will cause this queue to no longer be avaialble for tickets.
-0 will re-enable this queue
+1 will cause this queue to no longer be available for tickets.
+0 will re-enable this queue.

 
 =cut
 
 
 =cut
 


@@ -409,20 +454,14 @@ sub ValidateName {
     my $tempqueue = new RT::Queue($RT::SystemUser);
     $tempqueue->Load($name);
 
     my $tempqueue = new RT::Queue($RT::SystemUser);
     $tempqueue->Load($name);
 

-    #If we couldn't load it :)
-    unless ( $tempqueue->id() ) {
-        return (1);
-    }
-

     #If this queue exists, return undef
     #If this queue exists, return undef

-    #Avoid the ACL check.
-    if ( $tempqueue->Name() ) {
+    if ( $tempqueue->Name() && $tempqueue->id != $self->id)  {

         return (undef);
     }
 
     #If the queue doesn't exist, return 1
     else {
         return (undef);
     }
 
     #If the queue doesn't exist, return 1
     else {

-        return (1);
+        return ($self->SUPER::ValidateName($name));

     }
 
 }
     }
 
 }


@@ -455,7 +494,7 @@ sub Templates {
 
 # {{{  CustomField
 
 
 # {{{  CustomField
 

-=item CustomField NAME
+=head2 CustomField NAME

 
 Load the queue-specific custom field named NAME
 
 
 Load the queue-specific custom field named NAME
 


@@ -472,18 +511,38 @@ sub CustomField {
 
 # {{{ CustomFields
 
 
 # {{{ CustomFields
 

-=item CustomFields
+=head2 CustomFields

 
 Returns an RT::CustomFields object containing all global custom fields, as well as those tied to this queue
 
 =cut
 
 
 Returns an RT::CustomFields object containing all global custom fields, as well as those tied to this queue
 
 =cut
 

+# XXX TODO - this should become TicketCustomFields
+

 sub CustomFields {
     my $self = shift;
 sub CustomFields {
     my $self = shift;

+    warn "Queue->CustomFields is deprecated, use Queue->TicketCustomFields instead";
+    return $self->TicketCustomFields(@_);
+}
+
+sub TicketCustomFields {
+    my $self = shift;
+
+    my $cfs = RT::CustomFields->new( $self->CurrentUser );
+    if ( $self->CurrentUserHasRight('SeeQueue') ) {
+       $cfs->LimitToGlobalOrObjectId( $self->Id );
+       $cfs->LimitToLookupType( 'RT::Queue-RT::Ticket' );
+    }
+    return ($cfs);
+}
+
+sub TicketTransactionCustomFields {
+    my $self = shift;

 
     my $cfs = RT::CustomFields->new( $self->CurrentUser );
     if ( $self->CurrentUserHasRight('SeeQueue') ) {
 
     my $cfs = RT::CustomFields->new( $self->CurrentUser );
     if ( $self->CurrentUserHasRight('SeeQueue') ) {

-        $cfs->LimitToGlobalOrQueue( $self->Id );
+       $cfs->LimitToGlobalOrObjectId( $self->Id );
+       $cfs->LimitToLookupType( 'RT::Queue-RT::Ticket-RT::Transaction' );

     }
     return ($cfs);
 }
     }
     return ($cfs);
 }


@@ -610,7 +669,7 @@ sub AddWatcher {
             }
         }
      else {
             }
         }
      else {

-            $RT::Logger->warn( "$self -> AddWatcher got passed a bogus type");
+            $RT::Logger->warning( "$self -> AddWatcher got passed a bogus type");

             return ( 0, $self->loc('Error in parameters to Queue->AddWatcher') );
         }
     }
             return ( 0, $self->loc('Error in parameters to Queue->AddWatcher') );
         }
     }


@@ -662,7 +721,7 @@ sub _AddWatcher {
              my $new_user = RT::User->new($RT::SystemUser);
 
             my ( $Address, $Name ) =  
              my $new_user = RT::User->new($RT::SystemUser);
 
             my ( $Address, $Name ) =  

-               RT::EmailParser::ParseAddressFromHeader('', $args{'Email'});
+               RT::Interface::Email::ParseAddressFromHeader($args{'Email'});

 
             my ( $Val, $Message ) = $new_user->Create(
                 Name => $Address,
 
             my ( $Val, $Message ) = $new_user->Create(
                 Name => $Address,


@@ -771,7 +830,7 @@ sub DeleteWatcher {
             }
         }
         else {
             }
         }
         else {

-            $RT::Logger->warn( "$self -> DeleteWatcher got passed a bogus type");
+            $RT::Logger->warning( "$self -> DeleteWatcher got passed a bogus type");

             return ( 0, $self->loc('Error in parameters to Queue->DeleteWatcher') );
         }
     }
             return ( 0, $self->loc('Error in parameters to Queue->DeleteWatcher') );
         }
     }


@@ -942,8 +1001,8 @@ sub IsWatcher {
 
 =head2 IsCc PRINCIPAL_ID
 
 
 =head2 IsCc PRINCIPAL_ID
 

-  Takes an RT::Principal id.
-  Returns true if the principal is a requestor of the current queue.
+Takes an RT::Principal id.
+Returns true if the principal is a requestor of the current queue.

 
 
 =cut
 
 
 =cut


@@ -962,8 +1021,8 @@ sub IsCc {
 
 =head2 IsAdminCc PRINCIPAL_ID
 
 
 =head2 IsAdminCc PRINCIPAL_ID
 

-  Takes an RT::Principal id.
-  Returns true if the principal is a requestor of the current queue.
+Takes an RT::Principal id.
+Returns true if the principal is a requestor of the current queue.

 
 =cut
 
 
 =cut
 


@@ -1064,7 +1123,7 @@ sub HasRight {
     }
     return (
         $args{'Principal'}->HasRight(
     }
     return (
         $args{'Principal'}->HasRight(

-            Object => $self,
+            Object => $self->Id ? $self : $RT::System,

             Right    => $args{'Right'}
           )
     );
             Right    => $args{'Right'}
           )
     );