rt/lib/RT/Attributes_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 =head1 NAME
  50
  51 RT::Attributes - collection of RT::Attribute objects
  52
  53 =head1 SYNOPSIS
  54
  55     use RT::Attributes;
  56     my $Attributes = new RT::Attributes($CurrentUser);
  57
  58 =head1 DESCRIPTION
  59
  60
  61 =head1 METHODS
  62
  63 =cut
  64
  65
  66 package RT::Attributes;
  67
  68 use strict;
  69 no warnings qw(redefine);
  70
  71
  72 sub _DoSearch {
  73     my $self = shift;
  74     $self->SUPER::_DoSearch();
  75     $self->_BuildAccessTable();
  76 }
  77
  78
  79 sub _BuildAccessTable {
  80     my $self = shift;
  81     delete $self->{'attr'};
  82     while (my $attr = $self->Next) {
  83         push @{$self->{'attr'}->{$attr->Name}}, $attr;
  84     }
  85 }
  86
  87
  88 sub _AttrHash {
  89     my $self = shift;
  90     $self->_DoSearch if ($self->{'must_redo_search'});
  91     unless ($self->{'attr'}) {
  92         $self->{'attr'}->{'__none'} = RT::Attribute->new($self->CurrentUser);
  93     }
  94     return ($self->{'attr'});
  95 }
  96
  97 =head2 Names
  98
  99 Returns a list of the Names of all attributes for this object.
 100
 101 =cut
 102
 103 sub Names {
 104     my $self = shift;
 105     my @keys =  keys %{$self->_AttrHash};
 106     return(@keys);
 107
 108
 109 }
 110
 111 =head2 Named STRING
 112
 113 Returns an array of all the RT::Attribute objects with the name STRING
 114
 115 =cut
 116
 117 sub Named {
 118     my $self = shift;
 119     my $name = shift;
 120     my @attributes;
 121     if ($self->_AttrHash) {
 122         @attributes = @{($self->_AttrHash->{$name}||[])};
 123     }
 124     return (@attributes);
 125 }
 126
 127 =head2 WithId ID
 128
 129 Returns the RT::Attribute objects with the id ID
 130
 131 XXX TODO XXX THIS NEEDS A BETTER ACL CHECK
 132
 133 =cut
 134
 135 sub WithId {
 136     my $self = shift;
 137     my $id = shift;
 138
 139     my $attr = RT::Attribute->new($self->CurrentUser);
 140     $attr->LoadByCols( id => $id );
 141     return($attr);
 142 }
 143
 144 =head2 DeleteEntry { Name =>   Content => , id => }
 145
 146 Deletes attributes with
 147     the matching name
 148  and the matching content or id
 149
 150 If Content and id are both undefined, delete all attributes with
 151 the matching name.
 152
 153 =cut
 154
 155
 156 sub DeleteEntry {
 157     my $self = shift;
 158     my %args = (
 159         Name    => undef,
 160         Content => undef,
 161         id      => undef,
 162         @_
 163     );
 164     my $found = 0;
 165     foreach my $attr ( $self->Named( $args{'Name'} ) ) {
 166         if ( ( !defined $args{'id'} and !defined $args{'Content'} )
 167              or ( defined $args{'id'} and $attr->id eq $args{'id'} )
 168              or ( defined $args{'Content'} and $attr->Content eq $args{'Content'} ) )
 169         {
 170             my ($id, $msg) = $attr->Delete;
 171             return ($id, $msg) unless $id;
 172             $found = 1;
 173         }
 174     }
 175     return (0, "No entry found") unless $found;
 176     $self->RedoSearch;
 177     # XXX: above string must work but because of bug in DBIx::SB it doesn't,
 178     # to reproduce delete string below and run t/api/attribute-tests.t
 179     $self->_DoSearch;
 180     return (1, $self->loc('Attribute Deleted'));
 181 }
 182
 183
 184 # {{{ LimitToObject
 185
 186 =head2 LimitToObject $object
 187
 188 Limit the Attributes to rights for the object $object. It needs to be an RT::Record class.
 189
 190 =cut
 191
 192 sub LimitToObject {
 193     my $self = shift;
 194     my $obj = shift;
 195     unless (defined($obj) && ref($obj) && UNIVERSAL::can($obj, 'id') && $obj->id) {
 196     return undef;
 197     }
 198     $self->Limit(FIELD => 'ObjectType', OPERATOR=> '=', VALUE => ref($obj), ENTRYAGGREGATOR => 'OR');
 199     $self->Limit(FIELD => 'ObjectId', OPERATOR=> '=', VALUE => $obj->id, ENTRYAGGREGATOR => 'OR', QUOTEVALUE => 0);
 200
 201 }
 202
 203 # }}}
 204
 205 1;