rt/lib/RT/Attributes_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46
  47 =head1 NAME
  48
  49   RT::Attributes - collection of RT::Attribute objects
  50
  51 =head1 SYNOPSIS
  52
  53   use RT:Attributes;
  54 my $Attributes = new RT::Attributes($CurrentUser);
  55
  56 =head1 DESCRIPTION
  57
  58
  59 =head1 METHODS
  60
  61 =cut
  62
  63
  64 package RT::Attributes;
  65
  66 use strict;
  67 no warnings qw(redefine);
  68
  69
  70 sub _DoSearch {
  71     my $self = shift;
  72     $self->SUPER::_DoSearch();
  73     $self->_BuildAccessTable();
  74 }
  75
  76
  77 sub _BuildAccessTable {
  78     my $self = shift;
  79     delete $self->{'attr'};
  80     while (my $attr = $self->Next) {
  81         push @{$self->{'attr'}->{$attr->Name}}, $attr;
  82     }
  83 }
  84
  85
  86 sub _AttrHash {
  87     my $self = shift;
  88     $self->_DoSearch if ($self->{'must_redo_search'});
  89     unless ($self->{'attr'}) {
  90         $self->{'attr'}->{'__none'} = RT::Attribute->new($self->CurrentUser);
  91     }
  92     return ($self->{'attr'});
  93 }
  94
  95 =head2 Names
  96
  97 Returns a list of the Names of all attributes for this object.
  98
  99 =cut
 100
 101 sub Names {
 102     my $self = shift;
 103     my @keys =  keys %{$self->_AttrHash};
 104     return(@keys);
 105
 106
 107 }
 108
 109 =head2 Named STRING
 110
 111 Returns an array of all the RT::Attribute objects with the name STRING
 112
 113 =cut
 114
 115 sub Named {
 116     my $self = shift;
 117     my $name = shift;
 118     my @attributes;
 119     if ($self->_AttrHash) {
 120         @attributes = @{($self->_AttrHash->{$name}||[])};
 121     }
 122     return (@attributes);
 123 }
 124
 125 =head2 WithId ID
 126
 127 Returns the RT::Attribute objects with the id ID
 128
 129 XXX TODO XXX THIS NEEDS A BETTER ACL CHECK
 130
 131 =cut
 132
 133 sub WithId {
 134     my $self = shift;
 135     my $id = shift;
 136
 137     my $attr = RT::Attribute->new($self->CurrentUser);
 138     $attr->LoadByCols( id => $id );
 139     return($attr);
 140 }
 141
 142 =head2 DeleteEntry { Name =>   Content => , id => }
 143
 144 Deletes attributes with
 145     the matching name
 146  and the matching content or id
 147
 148 If Content and id are both undefined, delete all attributes with
 149 the matching name.
 150
 151 =cut
 152
 153
 154 sub DeleteEntry {
 155     my $self = shift;
 156     my %args = ( Name => undef,
 157                  Content => undef,
 158                  id => undef,
 159                  @_);
 160     my $found = 0;
 161     foreach my $attr ($self->Named($args{'Name'})){
 162       if ((!defined $args{'id'} and !defined $args{'Content'})
 163           or (defined $args{'id'} and $attr->id eq $args{'id'})
 164           or (defined $args{'Content'} and $attr->Content eq $args{'Content'})) {
 165         my ($id, $msg) = $attr->Delete;
 166         return ($id, $msg) unless $id;
 167         $found = 1;
 168       }
 169     }
 170     return (0, "No entry found") unless $found;
 171     $self->_DoSearch();
 172     return (1, $self->loc('Attribute Deleted'));
 173 }
 174
 175
 176 # {{{ LimitToObject
 177
 178 =head2 LimitToObject $object
 179
 180 Limit the Attributes to rights for the object $object. It needs to be an RT::Record class.
 181
 182 =cut
 183
 184 sub LimitToObject {
 185     my $self = shift;
 186     my $obj = shift;
 187     unless (defined($obj) && ref($obj) && UNIVERSAL::can($obj, 'id') && $obj->id) {
 188     return undef;
 189     }
 190     $self->Limit(FIELD => 'ObjectType', OPERATOR=> '=', VALUE => ref($obj), ENTRYAGGREGATOR => 'OR');
 191     $self->Limit(FIELD => 'ObjectId', OPERATOR=> '=', VALUE => $obj->id, ENTRYAGGREGATOR => 'OR', QUOTEVALUE => 0);
 192
 193 }
 194
 195 # }}}
 196
 197 1;