ObjectCustomFieldValue_Overlay.pm 7.82 KB
Newer Older
1
# BEGIN BPS TAGGED BLOCK {{{
2
# 
Jesse Vincent's avatar
Jesse Vincent committed
3
# COPYRIGHT:
Jesse Vincent's avatar
Jesse Vincent committed
4
# 
5
# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
6
#                                          <jesse@bestpractical.com>
7
# 
Jesse Vincent's avatar
Jesse Vincent committed
8
9
10
11
# (Except where explicitly superseded by other copyright notices)
# 
# 
# LICENSE:
12
13
14
15
16
17
18
19
20
21
22
# 
# 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.
# 
Jesse Vincent's avatar
Jesse Vincent committed
23
24
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
Jesse Vincent's avatar
Jesse Vincent committed
25
26
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
Ruslan Zakirov's avatar
Ruslan Zakirov committed
27
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
Jesse Vincent's avatar
Jesse Vincent committed
28
29
30
31
32
33
34
35
36
# 
# 
# 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.)
37
# 
Jesse Vincent's avatar
Jesse Vincent committed
38
39
40
41
42
43
44
45
# 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.
46
# 
47
# END BPS TAGGED BLOCK }}}
48

49
50
package RT::ObjectCustomFieldValue;

51
use strict;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
52
use warnings;
53
54
use RT::Interface::Web;

55
56
no warnings qw(redefine);

57
58
59
sub Create {
    my $self = shift;
    my %args = (
60
61
62
63
64
65
66
67
68
69
70
        CustomField     => 0,
        ObjectType      => '',
        ObjectId        => 0,
        Disabled        => 0,
        Content         => '',
        LargeContent    => undef,
        ContentType     => '',
        ContentEncoding => '',
        @_,
    );

71
    if ( defined $args{'Content'} && length( Encode::encode_utf8($args{'Content'}) ) > 255 ) {
72
        if ( defined $args{'LargeContent'} && length $args{'LargeContent'} ) {
73
            $RT::Logger->error("Content is longer than 255 bytes and LargeContent specified");
74
75
76
77
78
79
        }
        else {
            $args{'LargeContent'} = $args{'Content'};
            $args{'Content'} = '';
            $args{'ContentType'} ||= 'text/plain';
        }
80
81
82
    }

    ( $args{'ContentEncoding'}, $args{'LargeContent'} ) =
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
83
84
85
86
87
88
89
90
91
92
93
94
95
        $self->_EncodeLOB( $args{'LargeContent'}, $args{'ContentType'} )
            if defined $args{'LargeContent'};

    return $self->SUPER::Create(
        CustomField     => $args{'CustomField'},
        ObjectType      => $args{'ObjectType'},
        ObjectId        => $args{'ObjectId'},
        Disabled        => $args{'Disabled'},
        Content         => $args{'Content'},
        LargeContent    => $args{'LargeContent'},
        ContentType     => $args{'ContentType'},
        ContentEncoding => $args{'ContentEncoding'},
    );
96
97
98
99
100
}


sub LargeContent {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
101
102
103
104
105
    return $self->_DecodeLOB(
        $self->ContentType,
        $self->ContentEncoding,
        $self->_Value( 'LargeContent', decode_utf8 => 0 )
    );
106
107
}

108
109
110
111
112
113
114
115
116
=head2 LoadByTicketContentAndCustomField { Ticket => TICKET, CustomField => CUSTOMFIELD, Content => CONTENT }

Loads a custom field value by Ticket, Content and which CustomField it's tied to

=cut


sub LoadByTicketContentAndCustomField {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
117
118
119
120
121
122
    my %args = (
        Ticket => undef,
        CustomField => undef,
        Content => undef,
        @_
    );
123

Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
124
125
126
127
128
129
130
    return $self->LoadByCols(
        Content => $args{'Content'},
        CustomField => $args{'CustomField'},
        ObjectType => 'RT::Ticket',
        ObjectId => $args{'Ticket'},
        Disabled => 0
    );
131
132
133
134
}

sub LoadByObjectContentAndCustomField {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
135
136
137
138
139
140
    my %args = (
        Object => undef,
        CustomField => undef,
        Content => undef,
        @_
    );
141
142
143

    my $obj = $args{'Object'} or return;

Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
144
145
146
147
148
149
150
    return $self->LoadByCols(
        Content => $args{'Content'},
        CustomField => $args{'CustomField'},
        ObjectType => ref($obj),
        ObjectId => $obj->Id,
        Disabled => 0
    );
151
152
}

153
154
155
156
157
158
159
160
161
162
163
164
165
166
=head2 CustomFieldObj

Returns the CustomField Object which has the id returned by CustomField

=cut

sub CustomFieldObj {
    my $self = shift;
    my $CustomField = RT::CustomField->new( $self->CurrentUser );
    $CustomField->SetContextObject( $self->Object );
    $CustomField->Load( $self->__Value('CustomField') );
    return $CustomField;
}

167
168
169
170
171
172
173
174
175
176

=head2 Content

Return this custom field's content. If there's no "regular"
content, try "LargeContent"

=cut

sub Content {
    my $self = shift;
177
    my $content = $self->SUPER::Content;
178
    if ( !(defined $content && length $content) && $self->ContentType && $self->ContentType eq 'text/plain' ) {
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
179
        return $self->LargeContent;
180
181
    } else {
        return $content;
182
183
184
    }
}

Jesse Vincent's avatar
Jesse Vincent committed
185
186
187
188
189
190
=head2 Object

Returns the object this value applies to

=cut

191
192
sub Object {
    my $self  = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
193
194
195
    my $Object = $self->__Value('ObjectType')->new( $self->CurrentUser );
    $Object->LoadById( $self->__Value('ObjectId') );
    return $Object;
196
197
}

Jesse Vincent's avatar
Jesse Vincent committed
198
199
200
201
202
203
204
205

=head2 Delete

Disable this value. Used to remove "current" values from records while leaving them in the history.

=cut


Audrey Tang's avatar
Audrey Tang committed
206
207
sub Delete {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
208
    return $self->SetDisabled(1);
Audrey Tang's avatar
Audrey Tang committed
209
210
}

Jesse Vincent's avatar
Jesse Vincent committed
211
212
213
=head2 _FillInTemplateURL URL

Takes a URL containing placeholders and returns the URL as filled in for this 
214
ObjectCustomFieldValue. The values for the placeholders will be URI-escaped.
Jesse Vincent's avatar
Jesse Vincent committed
215
216
217
218
219
220
221
222
223
224
225
226
227

Available placeholders:

=over

=item __id__

The id of the object in question.

=item __CustomField__

The value of this custom field for the object in question.

228
229
230
231
=item __WebDomain__, __WebPort__, __WebPath__, __WebBaseURL__ and __WebURL__

The value of the config option.

Jesse Vincent's avatar
Jesse Vincent committed
232
233
234
235
=back

=cut

236
237
238
239
240
241
242
243
244
245
246
{
my %placeholders = (
    id          => { value => sub { $_[0]->ObjectId }, escape => 1 },
    CustomField => { value => sub { $_[0]->Content }, escape => 1 },
    WebDomain   => { value => sub { RT->Config->Get('WebDomain') } },
    WebPort     => { value => sub { RT->Config->Get('WebPort') } },
    WebPath     => { value => sub { RT->Config->Get('WebPath') } },
    WebBaseURL  => { value => sub { RT->Config->Get('WebBaseURL') } },
    WebURL      => { value => sub { RT->Config->Get('WebURL') } },
);

Jesse Vincent's avatar
Jesse Vincent committed
247
248
249
250
sub _FillInTemplateURL {
    my $self = shift;
    my $url = shift;

251
    # default value, uri-escape
252
    for my $key (keys %placeholders) {
253
254
255
256
257
258
        $url =~ s{__${key}__}{
            my $value = $placeholders{$key}{'value'}->( $self );
            $value = '' if !defined($value);
            RT::Interface::Web::EscapeURI(\$value) if $placeholders{$key}{'escape'};
            $value
        }gxe;
259
    }
Jesse Vincent's avatar
Jesse Vincent committed
260
261

    return $url;
262
} }
Jesse Vincent's avatar
Jesse Vincent committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292


=head2 ValueLinkURL

Returns a filled in URL template for this ObjectCustomFieldValue, suitable for 
constructing a hyperlink in RT's webui. Returns undef if this custom field doesn't have
a LinkValueTo

=cut

sub LinkValueTo {
    my $self = shift;
    return $self->_FillInTemplateURL($self->CustomFieldObj->LinkValueTo);
}



=head2 ValueIncludeURL

Returns a filled in URL template for this ObjectCustomFieldValue, suitable for 
constructing a hyperlink in RT's webui. Returns undef if this custom field doesn't have
a IncludeContentForValue

=cut

sub IncludeContentForValue {
    my $self = shift;
    return $self->_FillInTemplateURL($self->CustomFieldObj->IncludeContentForValue);
}

293
1;