import rt 3.8.10
[freeside.git] / rt / lib / RT / System.pm
index 515e3a4..7a5bff0 100644 (file)
@@ -1,38 +1,40 @@
 # BEGIN BPS TAGGED BLOCK {{{
-# 
+#
 # COPYRIGHT:
-#  
-# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC 
-#                                          <jesse@bestpractical.com>
-# 
+#
+# 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.
-# 
+#
 # 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., 675 Mass Ave, Cambridge, MA 02139, USA.
-# 
-# 
+# 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
@@ -41,7 +43,7 @@
 # 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 }}}
 
 =head1 NAME 
@@ -64,19 +66,19 @@ In the future, there will probably be other API goodness encapsulated here.
 
 
 package RT::System;
-use base qw /RT::Base/;
+
 use strict;
+use warnings;
+use base qw/RT::Record/;
 
 use RT::ACL;
-use vars qw/ $RIGHTS/;
 
 # System rights are rights granted to the whole system
 # XXX TODO Can't localize these outside of having an object around.
-$RIGHTS = {
+our $RIGHTS = {
     SuperUser              => 'Do anything and everything',           # loc_pair
     AdminAllPersonalGroups =>
-      "Create, delete and modify the members of any user's personal groups"
-    ,                                                                 # loc_pair
+      "Create, delete and modify the members of any user's personal groups", # loc_pair
     AdminOwnPersonalGroups =>
       'Create, delete and modify the members of personal groups',     # loc_pair
     AdminUsers     => 'Create, delete and modify users',              # loc_pair
@@ -84,6 +86,7 @@ $RIGHTS = {
     DelegateRights =>
       "Delegate specific rights which have been granted to you.",     # loc_pair
     ShowConfigTab => "show Configuration tab",     # loc_pair
+    ShowApprovalsTab => "show Approvals tab",     # loc_pair
     LoadSavedSearch => "allow loading of saved searches",     # loc_pair
     CreateSavedSearch => "allow creation of saved searches",      # loc_pair
 };
@@ -98,25 +101,20 @@ foreach my $right ( keys %{$RIGHTS} ) {
 
 =head2 AvailableRights
 
-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
-
-=begin testing
-
-my $s = RT::System->new($RT::SystemUser);
-my $rights = $s->AvailableRights;
-ok ($rights, "Rights defined");
-ok ($rights->{'AdminUsers'},"AdminUsers right found");
-ok ($rights->{'CreateTicket'},"CreateTicket right found");
-ok ($rights->{'AdminGroupMembership'},"ModifyGroupMembers right found");
-ok (!$rights->{'CasdasdsreateTicket'},"bogus right not found");
-
-
-
-=end testing
+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.
 
+This method as well returns rights of other RT objects,
+like L<RT::Queue> or L<RT::Group>. To allow users to apply
+those rights globally.
 
 =cut
 
+
+use RT::CustomField;
+use RT::Queue;
+use RT::Group; 
 sub AvailableRights {
     my $self = shift;
 
@@ -124,55 +122,44 @@ sub AvailableRights {
     my $group = RT::Group->new($RT::SystemUser);
     my $cf    = RT::CustomField->new($RT::SystemUser);
 
-    my $qr =$queue->AvailableRights();
+    my $qr = $queue->AvailableRights();
     my $gr = $group->AvailableRights();
     my $cr = $cf->AvailableRights();
 
     # Build a merged list of all system wide rights, queue rights and group rights.
     my %rights = (%{$RIGHTS}, %{$gr}, %{$qr}, %{$cr});
+
     return(\%rights);
 }
 
+=head2 AddRights C<RIGHT>, C<DESCRIPTION> [, ...]
 
-=head2 new
-
-Create a new RT::System object. Really, you should be using $RT::System
+Adds the given rights to the list of possible rights.  This method
+should be called during server startup, not at runtime.
 
 =cut
 
-                         
-sub new {
-    my $proto = shift;
-    my $class = ref($proto) || $proto;
-    my $self  = {};
-    bless( $self, $class );
-
+sub AddRights {
+    my $self = shift if ref $_[0] or $_[0] eq __PACKAGE__;
+    my %new = @_;
+    $RIGHTS = { %$RIGHTS, %new };
+    %RT::ACE::LOWERCASERIGHTNAMES = ( %RT::ACE::LOWERCASERIGHTNAMES,
+                                      map { lc($_) => $_ } keys %new);
+}
 
-    return ($self);
+sub _Init {
+    my $self = shift;
+    $self->SUPER::_Init (@_) if @_ && $_[0];
 }
 
 =head2 id
 
 Returns RT::System's id. It's 1. 
 
-
-=begin testing
-
-use RT::System;
-my $sys = RT::System->new();
-is( $sys->Id, 1);
-is ($sys->id, 1);
-
-=end testing
-
-
 =cut
 
 *Id = \&id;
-
-sub id {
-    return (1);
-}
+sub id { return 1 }
 
 =head2 Load
 
@@ -181,13 +168,27 @@ It does nothing
 
 =cut
 
-sub Load {
-       return (1);
+sub Load    { return 1 }
+sub Name    { return 'RT System' }
+sub __Set   { return 0 }
+sub __Value { return 0 }
+sub Create  { return 0 }
+sub Delete  { return 0 }
+
+sub SubjectTag {
+    my $self = shift;
+    my $queue = shift;
+
+    my $map = $self->FirstAttribute('BrandedSubjectTag');
+    $map = $map->Content if $map;
+    return $queue ? undef : () unless $map;
+
+    return $map->{ $queue->id } if $queue;
+
+    my %seen = ();
+    return grep !$seen{lc $_}++, values %$map;
 }
 
-eval "require RT::System_Vendor";
-die $@ if ($@ && $@ !~ qr{^Can't locate RT/System_Vendor.pm});
-eval "require RT::System_Local";
-die $@ if ($@ && $@ !~ qr{^Can't locate RT/System_Local.pm});
+RT::Base->_ImportOverlays();
 
 1;