RT 4.2.11, ticket#13852

[freeside.git] / rt / lib / RT / Record / Role / Rights.pm

diff --git a/rt/lib/RT/Record/Role/Rights.pm b/rt/lib/RT/Record/Role/Rights.pm
new file mode 100644 (file)
index 0000000..cd2d60a
--- /dev/null
+++ b/rt/lib/RT/Record/Role/Rights.pm
@@ -0,0 +1,133 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2015 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., 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::Record::Role::Rights;
+use Role::Basic;
+use Scalar::Util qw(blessed);
+
+=head1 NAME
+
+RT::Record::Role::Rights - Common methods for records which can provide rights
+
+=head1 DESCRIPTION
+
+=head1 REQUIRES
+
+=head2 L<RT::Record::Role>
+
+=cut
+
+with 'RT::Record::Role';
+
+=head1 PROVIDES
+
+=cut
+
+=head2 AddRight C<CATEGORY>, C<RIGHT>, C<DESCRIPTION>
+
+Adds the given rights to the list of possible rights.  This method
+should be called during server startup, not at runtime.
+
+=cut
+
+sub AddRight {
+    my $class = shift;
+    $class = ref($class) || $class;
+    my ($category, $name, $description) = @_;
+
+    require RT::ACE;
+    if (exists $RT::ACE::RIGHTS{$class}{lc $name}) {
+        warn "Duplicate right '$name' found";
+        return;
+    }
+
+    $RT::ACE::RIGHTS{$class}{lc $name} = {
+        Name        => $name,
+        Category    => $category,
+        Description => $description,
+    };
+}
+
+=head2 AvailableRights
+
+Returns a hashref of available rights for this object. The keys are the
+right names and the values are a description of what the rights do.
+
+=cut
+
+sub AvailableRights {
+    my $self = shift;
+    my $class = ref($self) || $self;
+
+    my %rights;
+    $rights{$_->{Name}} = $_->{Description}
+        for values %{$RT::ACE::RIGHTS{$class} || {} };
+    return \%rights;
+}
+
+=head2 RightCategories
+
+Returns a hashref where the keys are rights for this type of object and the
+values are the category (General, Staff, Admin) the right falls into.
+
+=cut
+
+sub RightCategories {
+    my $self = shift;
+    my $class = ref($self) || $self;
+
+    my %rights;
+    $rights{$_->{Name}} = $_->{Category}
+        for values %{ $RT::ACE::RIGHTS{$class} || {} };
+    return \%rights;
+}
+
+1;