Upgrade to 4.2.8
[usit-rt.git] / lib / RT / Attributes.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
6 #                                          <sales@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 = RT::Attributes->new($CurrentUser);
57
58 =head1 DESCRIPTION
59
60
61 =head1 METHODS
62
63 =cut
64
65
66 package RT::Attributes;
67
68 use strict;
69 use warnings;
70
71 use base 'RT::SearchBuilder';
72
73 use RT::Attribute;
74
75 sub Table { 'Attributes'}
76
77
78 sub _DoSearch {
79     my $self = shift;
80     $self->SUPER::_DoSearch();
81 # if _DoSearch doesn't fully succeed, 'must_redo_search' will be true
82 # and call _BuildAccessTable then will result in a deep recursion
83     if ( $self->{'must_redo_search'} ) {
84         $RT::Logger->crit(
85 "_DoSearch is not so successful as it still needs redo search, won't call _BuildAccessTable"
86         );
87     }
88     else {
89         $self->_BuildAccessTable();
90     }
91 }
92
93
94 sub _BuildAccessTable {
95     my $self = shift;
96     delete $self->{'attr'};
97     while (my $attr = $self->Next) {
98         push @{$self->{'attr'}->{$attr->Name}}, $attr;
99     }
100 }
101
102
103 sub _AttrHash {
104     my $self = shift;
105     $self->_DoSearch if ($self->{'must_redo_search'} && $self->{'is_limited'});
106     unless ($self->{'attr'}) {
107         $self->{'attr'}->{'__none'} = RT::Attribute->new($self->CurrentUser);
108     }
109     return ($self->{'attr'});
110 }
111
112 =head2 Names
113
114 Returns a list of the Names of all attributes for this object. 
115
116 =cut
117
118 sub Names {
119     my $self = shift;
120     my @keys =  keys %{$self->_AttrHash};
121     return(@keys);
122
123
124 }
125
126 =head2 Named STRING
127
128 Returns an array of all the RT::Attribute objects with the name STRING
129
130 =cut
131
132 sub Named {
133     my $self = shift;
134     my $name = shift;
135     my @attributes; 
136     if ($self->_AttrHash) {
137         @attributes = @{($self->_AttrHash->{$name}||[])};
138     }
139     return (@attributes);   
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 = (
157         Name    => undef,
158         Content => undef,
159         id      => undef,
160         @_
161     );
162     my $found = 0;
163     foreach my $attr ( $self->Named( $args{'Name'} ) ) {
164         if ( ( !defined $args{'id'} and !defined $args{'Content'} )
165              or ( defined $args{'id'} and $attr->id eq $args{'id'} )
166              or ( defined $args{'Content'} and $attr->Content eq $args{'Content'} ) )
167         {
168             my ($id, $msg) = $attr->Delete;
169             return ($id, $msg) unless $id;
170             $found = 1;
171         }
172     }
173     return (0, "No entry found") unless $found;
174     $self->RedoSearch;
175     # XXX: above string must work but because of bug in DBIx::SB it doesn't,
176     # to reproduce delete string below and run t/api/attribute-tests.t
177     $self->_DoSearch;
178     return (1, $self->loc('Attribute Deleted'));
179 }
180
181
182
183 =head2 LimitToObject $object
184
185 Limit the Attributes to rights for the object $object. It needs to be an RT::Record class.
186
187 =cut
188
189 sub LimitToObject {
190     my $self = shift;
191     my $obj = shift;
192     unless (eval { $obj->id} ){
193         return undef;
194     }
195
196     my $type = $obj->isa("RT::CurrentUser") ? "RT::User" : ref($obj);
197
198     $self->Limit(FIELD => 'ObjectType', OPERATOR=> '=', VALUE => $type, ENTRYAGGREGATOR => 'OR');
199     $self->Limit(FIELD => 'ObjectId', OPERATOR=> '=', VALUE => $obj->id, ENTRYAGGREGATOR => 'OR', QUOTEVALUE => 0);
200
201 }
202
203 RT::Base->_ImportOverlays();
204
205 1;