ObjectCustomFieldValue.pm 13.6 KB
Newer Older
1
# BEGIN BPS TAGGED BLOCK {{{
Jesse Vincent's avatar
Jesse Vincent committed
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>
Jesse Vincent's avatar
Jesse Vincent committed
7
#
Jesse Vincent's avatar
Jesse Vincent committed
8
# (Except where explicitly superseded by other copyright notices)
Jesse Vincent's avatar
Jesse Vincent committed
9
10
#
#
Jesse Vincent's avatar
Jesse Vincent committed
11
# LICENSE:
Jesse Vincent's avatar
Jesse Vincent committed
12
#
13
14
15
16
# 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.
Jesse Vincent's avatar
Jesse Vincent committed
17
#
18
19
20
21
# 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
22
#
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
#
#
Jesse Vincent's avatar
Jesse Vincent committed
30
# CONTRIBUTION SUBMISSION POLICY:
Jesse Vincent's avatar
Jesse Vincent committed
31
#
Jesse Vincent's avatar
Jesse Vincent committed
32
33
34
35
36
# (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.)
Jesse Vincent's avatar
Jesse Vincent committed
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.
Jesse Vincent's avatar
Jesse Vincent committed
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
use RT::Interface::Web;
54
use Regexp::Common qw(RE_net_IPv4);
sunnavy's avatar
sunnavy committed
55
use Regexp::IPv6 qw($IPv6_re);
56
57
58
use Regexp::Common::net::CIDR;
require Net::CIDR;

59

60
61
no warnings qw(redefine);

62
63
64
sub Create {
    my $self = shift;
    my %args = (
65
66
67
68
69
70
71
72
73
74
75
        CustomField     => 0,
        ObjectType      => '',
        ObjectId        => 0,
        Disabled        => 0,
        Content         => '',
        LargeContent    => undef,
        ContentType     => '',
        ContentEncoding => '',
        @_,
    );

76
77
78

    my $cf_as_sys = RT::CustomField->new(RT->SystemUser);
    $cf_as_sys->Load($args{'CustomField'});
sunnavy's avatar
sunnavy committed
79
80

    if($cf_as_sys->Type eq 'IPAddress') {
sunnavy's avatar
sunnavy committed
81
82
83
84
        if ( $args{'Content'} ) {
            $args{'Content'} = $self->ParseIP( $args{'Content'} );
        }

sunnavy's avatar
sunnavy committed
85
86
87
        unless ( defined $args{'Content'} ) {
            return
              wantarray
88
              ? ( 0, $self->loc("Content is an invalid IP address") )
sunnavy's avatar
sunnavy committed
89
90
91
92
93
              : 0;
        }
    }

    if($cf_as_sys->Type eq 'IPAddressRange') {
94
95
        if ($args{'Content'}) {
            ($args{'Content'}, $args{'LargeContent'}) = $self->ParseIPRange( $args{'Content'} );
sunnavy's avatar
sunnavy committed
96
        }
97
        $args{'ContentType'} = 'text/plain';
98

sunnavy's avatar
sunnavy committed
99
100
101
        unless ( defined $args{'Content'} ) {
            return
              wantarray
102
              ? ( 0, $self->loc("Content is an invalid IP address range") )
sunnavy's avatar
sunnavy committed
103
              : 0;
104
105
106
        }
    }

107
    if ( defined $args{'Content'} && length( Encode::encode_utf8($args{'Content'}) ) > 255 ) {
108
        if ( defined $args{'LargeContent'} && length $args{'LargeContent'} ) {
109
            $RT::Logger->error("Content is longer than 255 bytes and LargeContent specified");
110
111
112
113
114
115
        }
        else {
            $args{'LargeContent'} = $args{'Content'};
            $args{'Content'} = '';
            $args{'ContentType'} ||= 'text/plain';
        }
116
117
118
    }

    ( $args{'ContentEncoding'}, $args{'LargeContent'} ) =
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
119
120
121
122
123
124
125
126
127
128
129
130
131
        $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'},
    );
132
133
134
135
136
}


sub LargeContent {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
137
138
139
140
141
    return $self->_DecodeLOB(
        $self->ContentType,
        $self->ContentEncoding,
        $self->_Value( 'LargeContent', decode_utf8 => 0 )
    );
142
143
}

144
145
146
147
148
149
150
151
152
153
154
155

=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} );
Shawn M Moore's avatar
Shawn M Moore committed
156
        if ( $cf->Type && $cf->Type eq 'IPAddressRange' ) {
157
158
159
160
161
162
163
164
165
166
167
168
169

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

170
171
172
173
174
175
176
177
178
=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
179
180
181
182
183
184
    my %args = (
        Ticket => undef,
        CustomField => undef,
        Content => undef,
        @_
    );
185

Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
186
187
188
189
190
191
192
    return $self->LoadByCols(
        Content => $args{'Content'},
        CustomField => $args{'CustomField'},
        ObjectType => 'RT::Ticket',
        ObjectId => $args{'Ticket'},
        Disabled => 0
    );
193
194
195
196
}

sub LoadByObjectContentAndCustomField {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
197
198
199
200
201
202
    my %args = (
        Object => undef,
        CustomField => undef,
        Content => undef,
        @_
    );
203
204
205

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

Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
206
207
208
209
210
211
212
    return $self->LoadByCols(
        Content => $args{'Content'},
        CustomField => $args{'CustomField'},
        ObjectType => ref($obj),
        ObjectId => $obj->Id,
        Disabled => 0
    );
213
214
}

215
216
217
218
219
220
221
222
223
224
225
226
227
228
=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;
}

229
230
231
232
233
234
235
236

=head2 Content

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

=cut

237
238
239
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}/;

240
241
sub Content {
    my $self = shift;
242

243
    my $content = $self->_Value('Content');
sunnavy's avatar
sunnavy committed
244
245
246
247
248
249
250
    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;
        }
251

sunnavy's avatar
sunnavy committed
252
        return $content if $self->CustomFieldObj->Type eq 'IPAddress';
253

254
        my $large_content = $self->__Value('LargeContent');
sunnavy's avatar
sunnavy committed
255
256
257
        if ( $large_content =~ /^\s*($re_ip_serialized)\s*$/o ) {
            my $eIP = sprintf "%d.%d.%d.%d", split /\./, $1;
            if ( $content eq $eIP ) {
258
259
                return $content;
            }
sunnavy's avatar
sunnavy committed
260
261
262
263
            else {
                return $content . "-" . $eIP;
            }
        }
sunnavy's avatar
sunnavy committed
264
265
266
267
268
269
270
271
272
        elsif ( $large_content =~ /^\s*($IPv6_re)\s*$/o ) {
            my $eIP = $1;
            if ( $content eq $eIP ) {
                return $content;
            }
            else {
                return $content . "-" . $eIP;
            }
        }
sunnavy's avatar
sunnavy committed
273
274
275
        else {
            return $content;
        }
276
    }
sunnavy's avatar
sunnavy committed
277

278
    if ( !(defined $content && length $content) && $self->ContentType && $self->ContentType eq 'text/plain' ) {
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
279
        return $self->LargeContent;
280
281
    } else {
        return $content;
282
283
284
    }
}

Jesse Vincent's avatar
Jesse Vincent committed
285
286
287
288
289
290
=head2 Object

Returns the object this value applies to

=cut

291
292
sub Object {
    my $self  = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
293
294
295
    my $Object = $self->__Value('ObjectType')->new( $self->CurrentUser );
    $Object->LoadById( $self->__Value('ObjectId') );
    return $Object;
296
297
}

Jesse Vincent's avatar
Jesse Vincent committed
298
299
300
301
302
303
304
305

=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
306
307
sub Delete {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
308
    return $self->SetDisabled(1);
Audrey Tang's avatar
Audrey Tang committed
309
310
}

Jesse Vincent's avatar
Jesse Vincent committed
311
312
313
=head2 _FillInTemplateURL URL

Takes a URL containing placeholders and returns the URL as filled in for this 
314
ObjectCustomFieldValue. The values for the placeholders will be URI-escaped.
Jesse Vincent's avatar
Jesse Vincent committed
315
316
317
318
319
320
321
322
323
324
325
326
327

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.

328
329
330
331
=item __WebDomain__, __WebPort__, __WebPath__, __WebBaseURL__ and __WebURL__

The value of the config option.

Jesse Vincent's avatar
Jesse Vincent committed
332
333
334
335
=back

=cut

336
337
338
339
340
341
342
343
344
345
346
{
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
347
348
349
350
sub _FillInTemplateURL {
    my $self = shift;
    my $url = shift;

351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
    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/;
    }

368
    # default value, uri-escape
369
    for my $key (keys %placeholders) {
370
371
372
373
374
375
        $url =~ s{__${key}__}{
            my $value = $placeholders{$key}{'value'}->( $self );
            $value = '' if !defined($value);
            RT::Interface::Web::EscapeURI(\$value) if $placeholders{$key}{'escape'};
            $value
        }gxe;
376
    }
Jesse Vincent's avatar
Jesse Vincent committed
377
378

    return $url;
379
} }
Jesse Vincent's avatar
Jesse Vincent committed
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409


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

410
411
412

sub ParseIPRange {
    my $self = shift;
sunnavy's avatar
sunnavy committed
413
414
415
416
    my $value = shift or return;
    $value = lc $value;
    $value =~ s!^\s+!!;
    $value =~ s!\s+$!!;
417
    
sunnavy's avatar
sunnavy committed
418
    if ( $value =~ /^$RE{net}{CIDR}{IPv4}{-keep}$/go ) {
419
        my $cidr = join( '.', map $_||0, (split /\./, $1)[0..3] ) ."/$2";
sunnavy's avatar
sunnavy committed
420
421
422
423
        $value = (Net::CIDR::cidr2range( $cidr ))[0] || $value;
    }
    elsif ( $value =~ /^$IPv6_re(?:\/\d+)?$/o ) {
        $value = (Net::CIDR::cidr2range( $value ))[0] || $value;
424
425
426
    }
    
    my ($sIP, $eIP);
sunnavy's avatar
sunnavy committed
427
    if ( $value =~ /^($RE{net}{IPv4})$/o ) {
428
429
        $sIP = $eIP = sprintf "%03d.%03d.%03d.%03d", split /\./, $1;
    }
sunnavy's avatar
sunnavy committed
430
    elsif ( $value =~ /^($RE{net}{IPv4})-($RE{net}{IPv4})$/o ) {
431
432
433
        $sIP = sprintf "%03d.%03d.%03d.%03d", split /\./, $1;
        $eIP = sprintf "%03d.%03d.%03d.%03d", split /\./, $2;
    }
sunnavy's avatar
sunnavy committed
434
435
436
437
438
439
440
441
442
    elsif ( $value =~ /^($IPv6_re)$/o ) {
        $sIP = $self->ParseIP( $1 );
        $eIP = $sIP;
    }
    elsif ( $value =~ /^($IPv6_re)-($IPv6_re)$/o ) {
        ($sIP, $eIP) = ( $1, $2 );
        $sIP = $self->ParseIP( $sIP );
        $eIP = $self->ParseIP( $eIP );
    }
443
    else {
sunnavy's avatar
sunnavy committed
444
        return;
445
    }
sunnavy's avatar
sunnavy committed
446

447
448
449
450
451
    ($sIP, $eIP) = ($eIP, $sIP) if $sIP gt $eIP;
    
    return $sIP, $eIP;
}

sunnavy's avatar
sunnavy committed
452
453
454
455
456
457
458
459
460
461
sub ParseIP {
    my $self = shift;
    my $value = shift or return;
    $value = lc $value;
    $value =~ s!^\s+!!;
    $value =~ s!\s+$!!;

    if ( $value =~ /^($RE{net}{IPv4})$/o ) {
        return sprintf "%03d.%03d.%03d.%03d", split /\./, $1;
    }
sunnavy's avatar
sunnavy committed
462
    elsif ( $value =~ /^$IPv6_re$/o ) {
sunnavy's avatar
sunnavy committed
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499

        # up_fields are before '::'
        # low_fields are after '::' but without v4
        # v4_fields are the v4
        my ( @up_fields, @low_fields, @v4_fields );
        my $v6;
        if ( $value =~ /(.*:)(\d+\..*)/ ) {
            ( $v6, my $v4 ) = ( $1, $2 );
            chop $v6 unless $v6 =~ /::$/;
            while ( $v4 =~ /(\d+)\.(\d+)/g ) {
                push @v4_fields, sprintf '%.2x%.2x', $1, $2;
            }
        }
        else {
            $v6 = $value;
        }

        my ( $up, $low );
        if ( $v6 =~ /::/ ) {
            ( $up, $low ) = split /::/, $v6;
        }
        else {
            $up = $v6;
        }

        @up_fields = split /:/, $up;
        @low_fields = split /:/, $low if $low;

        my @zero_fields =
          ('0000') x ( 8 - @v4_fields - @up_fields - @low_fields );
        my @fields = ( @up_fields, @zero_fields, @low_fields, @v4_fields );

        return join ':', map { sprintf "%.4x", hex "0x$_" } @fields;
    }
    return;
}

500
1;