ObjectCustomFieldValue_Overlay.pm 10.1 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
# 
Thomas Sibley's avatar
Thomas Sibley committed
5
# This software is Copyright (c) 1996-2010 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
72
73
74
75
76
77
78
79
80
81

    my $cf_as_sys = RT::CustomField->new(RT->SystemUser);
    $cf_as_sys->Load($args{'CustomField'});
    if($cf_as_sys->Type eq 'IPAddress' || $cf_as_sys->Type eq 'IPAddressRange') {
        if ($args{'Content'}) {
            ($args{'Content'}, $args{'LargeContent'}) = $self->ParseIPRange( $args{'Content'} );

        }
    }


82
    if ( defined $args{'Content'} && length( Encode::encode_utf8($args{'Content'}) ) > 255 ) {
83
        if ( defined $args{'LargeContent'} && length $args{'LargeContent'} ) {
84
            $RT::Logger->error("Content is longer than 255 bytes and LargeContent specified");
85
86
87
88
89
90
        }
        else {
            $args{'LargeContent'} = $args{'Content'};
            $args{'Content'} = '';
            $args{'ContentType'} ||= 'text/plain';
        }
91
92
93
    }

    ( $args{'ContentEncoding'}, $args{'LargeContent'} ) =
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
94
95
96
97
98
99
100
101
102
103
104
105
106
        $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'},
    );
107
108
109
110
111
}


sub LargeContent {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
112
113
114
115
116
    return $self->_DecodeLOB(
        $self->ContentType,
        $self->ContentEncoding,
        $self->_Value( 'LargeContent', decode_utf8 => 0 )
    );
117
118
}

119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

=head2 LoadByCols

=cut

sub LoadByCols {
    my $self = shift;
    my %args = (@_);
    my $cf;
    if ( $args{CustomField} ) {
        $cf = RT::CustomField->new( $self->CurrentUser );
        $cf->Load( $args{CustomField} );
        if ( $cf->Type eq 'IPAddressRange' ) {

            my ( $sIP, $eIP ) = $cf->ParseIPRange( $args{'Content'} );
            if ( $sIP && $eIP ) {
                $self->SUPER::LoadByCols( %args,
                                          Content      => $sIP,
                                          LargeContent => $eIP
                                        );
            }
        }
    }
    return $self->SUPER::LoadByCols(%args);
}

145
146
147
148
149
150
151
152
153
=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
154
155
156
157
158
159
    my %args = (
        Ticket => undef,
        CustomField => undef,
        Content => undef,
        @_
    );
160

Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
161
162
163
164
165
166
167
    return $self->LoadByCols(
        Content => $args{'Content'},
        CustomField => $args{'CustomField'},
        ObjectType => 'RT::Ticket',
        ObjectId => $args{'Ticket'},
        Disabled => 0
    );
168
169
170
171
}

sub LoadByObjectContentAndCustomField {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
172
173
174
175
176
177
    my %args = (
        Object => undef,
        CustomField => undef,
        Content => undef,
        @_
    );
178
179
180

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

Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
181
182
183
184
185
186
187
    return $self->LoadByCols(
        Content => $args{'Content'},
        CustomField => $args{'CustomField'},
        ObjectType => ref($obj),
        ObjectId => $obj->Id,
        Disabled => 0
    );
188
189
}

190
191
192
193
194
195
196
197
198
199
200
201
202
203
=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;
}

204
205
206
207
208
209
210
211

=head2 Content

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

=cut

212
213
214
my $re_ip_sunit = qr/[0-1][0-9][0-9]|2[0-4][0-9]|25[0-5]/;
my $re_ip_serialized = qr/$re_ip_sunit(?:\.$re_ip_sunit){3}/;

215
216
sub Content {
    my $self = shift;
217

218
    my $content = $self->_Value('Content');
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
    if ( $self->CustomFieldObj->Type eq 'IPAddress' ||
         $self->CustomFieldObj->Type eq 'IPAddressRange') {

       if ($content =~ /^\s*($re_ip_serialized)\s*$/o ) {
        $content = sprintf "%d.%d.%d.%d", split /\./, $1;
       }

        my $large_content = $self->__Value('LargeContent');
            if ( $large_content =~ /^\s*($re_ip_serialized)\s*$/o ) {
                my $eIP = sprintf "%d.%d.%d.%d", split /\./, $1;
                return $content . "-".$eIP if ($content  && $eIP);
            } else {
                return $content;
            }

    }
235
    if ( !(defined $content && length $content) && $self->ContentType && $self->ContentType eq 'text/plain' ) {
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
236
        return $self->LargeContent;
237
238
    } else {
        return $content;
239
240
241
    }
}

Jesse Vincent's avatar
Jesse Vincent committed
242
243
244
245
246
247
=head2 Object

Returns the object this value applies to

=cut

248
249
sub Object {
    my $self  = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
250
251
252
    my $Object = $self->__Value('ObjectType')->new( $self->CurrentUser );
    $Object->LoadById( $self->__Value('ObjectId') );
    return $Object;
253
254
}

Jesse Vincent's avatar
Jesse Vincent committed
255
256
257
258
259
260
261
262

=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
263
264
sub Delete {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
265
    return $self->SetDisabled(1);
Audrey Tang's avatar
Audrey Tang committed
266
267
}

Jesse Vincent's avatar
Jesse Vincent committed
268
269
270
=head2 _FillInTemplateURL URL

Takes a URL containing placeholders and returns the URL as filled in for this 
271
ObjectCustomFieldValue. The values for the placeholders will be URI-escaped.
Jesse Vincent's avatar
Jesse Vincent committed
272
273
274
275
276
277
278
279
280
281
282
283
284

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.

285
286
287
288
=item __WebDomain__, __WebPort__, __WebPath__, __WebBaseURL__ and __WebURL__

The value of the config option.

Jesse Vincent's avatar
Jesse Vincent committed
289
290
291
292
=back

=cut

293
294
295
296
297
298
299
300
301
302
303
{
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
304
305
306
307
sub _FillInTemplateURL {
    my $self = shift;
    my $url = shift;

308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
    return undef unless defined $url && length $url;

    # special case, whole value should be an URL
    if ( $url =~ /^__CustomField__/ ) {
        my $value = $self->Content;
        # protect from javascript: URLs
        if ( $value =~ /^\s*javascript:/i ) {
            my $object = $self->Object;
            $RT::Logger->error(
                "Dangerouse value with JavaScript in custom field '". $self->CustomFieldObj->Name ."'"
                ." on ". ref($object) ." #". $object->id
            );
            return undef;
        }
        $url =~ s/^__CustomField__/$value/;
    }

325
    # default value, uri-escape
326
    for my $key (keys %placeholders) {
327
328
329
330
331
332
        $url =~ s{__${key}__}{
            my $value = $placeholders{$key}{'value'}->( $self );
            $value = '' if !defined($value);
            RT::Interface::Web::EscapeURI(\$value) if $placeholders{$key}{'escape'};
            $value
        }gxe;
333
    }
Jesse Vincent's avatar
Jesse Vincent committed
334
335

    return $url;
336
} }
Jesse Vincent's avatar
Jesse Vincent committed
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366


=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);
}

367
1;