1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
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
367
368
369
370
371
372
373
374
375
376
377
378
379
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
#
# LICENSE:
#
# 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.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# 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.)
#
# 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.
#
# END BPS TAGGED BLOCK }}}
package RT::ObjectCustomFieldValue;
use strict;
use warnings;
use base 'RT::Record';
use RT::Interface::Web;
use Regexp::Common qw(RE_net_IPv4);
use Regexp::IPv6 qw($IPv6_re);
use Regexp::Common::net::CIDR;
require Net::CIDR;
# Allow the empty IPv6 address
$IPv6_re = qr/(?:$IPv6_re|::)/;
use RT::CustomField;
sub Table {'ObjectCustomFieldValues'}
sub Create {
my $self = shift;
my %args = (
CustomField => 0,
ObjectType => '',
ObjectId => 0,
Disabled => 0,
Content => '',
LargeContent => undef,
ContentType => '',
ContentEncoding => '',
@_,
);
my $cf = RT::CustomField->new( $self->CurrentUser );
$cf->Load( $args{CustomField} );
my ($val, $msg) = $cf->_CanonicalizeValue(\%args);
return ($val, $msg) unless $val;
my $encoded = Encode::encode("UTF-8", $args{'Content'});
if ( defined $args{'Content'} && length( $encoded ) > 255 ) {
if ( defined $args{'LargeContent'} && length $args{'LargeContent'} ) {
$RT::Logger->error("Content is longer than 255 bytes and LargeContent specified");
}
else {
# _EncodeLOB, and thus LargeContent, takes bytes; Content is
# in characters. Encode it; this may replace illegal
# codepoints (e.g. \x{FDD0}) with \x{FFFD}.
$args{'LargeContent'} = Encode::encode("UTF-8",$args{'Content'});
$args{'Content'} = undef;
$args{'ContentType'} ||= 'text/plain';
}
}
( $args{'ContentEncoding'}, $args{'LargeContent'} ) =
$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'},
);
}
sub LargeContent {
my $self = shift;
return $self->_DecodeLOB(
$self->ContentType,
$self->ContentEncoding,
$self->_Value( 'LargeContent', decode_utf8 => 0 )
);
}
=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} );
my ($ok, $msg) = $cf->_CanonicalizeValue(\%args);
return ($ok, $msg) unless $ok;
}
return $self->SUPER::LoadByCols(%args);
}
=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;
my %args = (
Ticket => undef,
CustomField => undef,
Content => undef,
@_
);
return $self->LoadByCols(
Content => $args{'Content'},
CustomField => $args{'CustomField'},
ObjectType => 'RT::Ticket',
ObjectId => $args{'Ticket'},
Disabled => 0
);
}
sub LoadByObjectContentAndCustomField {
my $self = shift;
my %args = (
Object => undef,
CustomField => undef,
Content => undef,
@_
);
my $obj = $args{'Object'} or return;
return $self->LoadByCols(
Content => $args{'Content'},
CustomField => $args{'CustomField'},
ObjectType => ref($obj),
ObjectId => $obj->Id,
Disabled => 0
);
}
=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;
}
=head2 Content
Return this custom field's content. If there's no "regular"
content, try "LargeContent"
=cut
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}/;
sub Content {
my $self = shift;
return undef unless $self->CustomFieldObj->CurrentUserHasRight('SeeCustomField');
my $content = $self->_Value('Content');
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;
}
return $content if $self->CustomFieldObj->Type eq 'IPAddress';
my $large_content = $self->__Value('LargeContent');
if ( $large_content =~ /^\s*($re_ip_serialized)\s*$/o ) {
my $eIP = sprintf "%d.%d.%d.%d", split /\./, $1;
if ( $content eq $eIP ) {
return $content;
}
else {
return $content . "-" . $eIP;
}
}
elsif ( $large_content =~ /^\s*($IPv6_re)\s*$/o ) {
my $eIP = $1;
if ( $content eq $eIP ) {
return $content;
}
else {
return $content . "-" . $eIP;
}
}
else {
return $content;
}
}
if ( !(defined $content && length $content) && $self->ContentType && $self->ContentType eq 'text/plain' ) {
return $self->LargeContent;
} else {
return $content;
}
}
=head2 Object
Returns the object this value applies to
=cut
sub Object {
my $self = shift;
my $Object = $self->__Value('ObjectType')->new( $self->CurrentUser );
$Object->LoadById( $self->__Value('ObjectId') );
return $Object;
}
=head2 Delete
Disable this value. Used to remove "current" values from records while leaving them in the history.
=cut
sub Delete {
my $self = shift;
return $self->SetDisabled(1);
}
=head2 _FillInTemplateURL URL
Takes a URL containing placeholders and returns the URL as filled in for this
ObjectCustomFieldValue. The values for the placeholders will be URI-escaped.
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.
=item __WebDomain__, __WebPort__, __WebPath__, __WebBaseURL__ and __WebURL__
The value of the config option.
=back
=cut
{
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') } },
);
sub _FillInTemplateURL {
my $self = shift;
my $url = shift;
return undef unless defined $url && length $url;
# special case, whole value should be an URL
if ( $url =~ /^__CustomField__/ ) {
my $value = $self->Content;
# protect from potentially malicious URLs
if ( $value =~ /^\s*(?:javascript|data):/i ) {
my $object = $self->Object;
$RT::Logger->error(
"Potentially dangerous URL type in custom field '". $self->CustomFieldObj->Name ."'"
." on ". ref($object) ." #". $object->id
);
return undef;
}
$url =~ s/^__CustomField__/$value/;
}
# default value, uri-escape
for my $key (keys %placeholders) {
$url =~ s{__${key}__}{
my $value = $placeholders{$key}{'value'}->( $self );
$value = '' if !defined($value);
RT::Interface::Web::EscapeURI(\$value) if $placeholders{$key}{'escape'};
$value
}gxe;
}
return $url;
} }
=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);
}
sub ParseIPRange {
my $self = shift;
my $value = shift or return;
$value = lc $value;
$value =~ s!^\s+!!;
$value =~ s!\s+$!!;
if ( $value =~ /^$RE{net}{CIDR}{IPv4}{-keep}$/go ) {
my $cidr = join( '.', map $_||0, (split /\./, $1)[0..3] ) ."/$2";
$value = (Net::CIDR::cidr2range( $cidr ))[0] || $value;
}
elsif ( $value =~ /^$IPv6_re(?:\/\d+)?$/o ) {
$value = (Net::CIDR::cidr2range( $value ))[0] || $value;
}
my ($sIP, $eIP);
if ( $value =~ /^($RE{net}{IPv4})$/o ) {
$sIP = $eIP = sprintf "%03d.%03d.%03d.%03d", split /\./, $1;
}
elsif ( $value =~ /^($RE{net}{IPv4})-($RE{net}{IPv4})$/o ) {
$sIP = sprintf "%03d.%03d.%03d.%03d", split /\./, $1;
$eIP = sprintf "%03d.%03d.%03d.%03d", split /\./, $2;
}
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 );
}
else {
return;
}
($sIP, $eIP) = ($eIP, $sIP) if $sIP gt $eIP;
return $sIP, $eIP;
}
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;
}
elsif ( $value =~ /^$IPv6_re$/o ) {
# 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;
}
=head2 id
Returns the current value of id.
(In the database, id is stored as int(11).)
=cut
=head2 CustomField
Returns the current value of CustomField.
(In the database, CustomField is stored as int(11).)
=head2 SetCustomField VALUE
Set CustomField to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, CustomField will be stored as a int(11).)
=cut
=head2 ObjectType
Returns the current value of ObjectType.
(In the database, ObjectType is stored as varchar(255).)
=head2 SetObjectType VALUE
Set ObjectType to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, ObjectType will be stored as a varchar(255).)
=cut
=head2 ObjectId
Returns the current value of ObjectId.
(In the database, ObjectId is stored as int(11).)
=head2 SetObjectId VALUE
Set ObjectId to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, ObjectId will be stored as a int(11).)
=cut
=head2 SortOrder
Returns the current value of SortOrder.
(In the database, SortOrder is stored as int(11).)
=head2 SetSortOrder VALUE
Set SortOrder to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, SortOrder will be stored as a int(11).)
=cut
=head2 Content
Returns the current value of Content.
(In the database, Content is stored as varchar(255).)
=head2 SetContent VALUE
Set Content to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Content will be stored as a varchar(255).)
=cut
=head2 LargeContent
Returns the current value of LargeContent.
(In the database, LargeContent is stored as longblob.)
=head2 SetLargeContent VALUE
Set LargeContent to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, LargeContent will be stored as a longblob.)
=cut
=head2 ContentType
Returns the current value of ContentType.
(In the database, ContentType is stored as varchar(80).)
=head2 SetContentType VALUE
Set ContentType to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, ContentType will be stored as a varchar(80).)
=cut
=head2 ContentEncoding
Returns the current value of ContentEncoding.
(In the database, ContentEncoding is stored as varchar(80).)
=head2 SetContentEncoding VALUE
Set ContentEncoding to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, ContentEncoding will be stored as a varchar(80).)
=cut
=head2 Creator
Returns the current value of Creator.
(In the database, Creator is stored as int(11).)
=cut
=head2 Created
Returns the current value of Created.
(In the database, Created is stored as datetime.)
=cut
=head2 LastUpdatedBy
Returns the current value of LastUpdatedBy.
(In the database, LastUpdatedBy is stored as int(11).)
=cut
=head2 LastUpdated
Returns the current value of LastUpdated.
(In the database, LastUpdated is stored as datetime.)
=cut
=head2 Disabled
Returns the current value of Disabled.
(In the database, Disabled is stored as smallint(6).)
=head2 SetDisabled VALUE
Set Disabled to VALUE.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
(In the database, Disabled will be stored as a smallint(6).)
=cut
sub _CoreAccessible {
{
id =>
{read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
CustomField =>
{read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
ObjectType =>
{read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''},
ObjectId =>
{read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''},
SortOrder =>
{read => 1, write => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
Content =>
{read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''},
LargeContent =>
{read => 1, write => 1, sql_type => -4, length => 0, is_blob => 1, is_numeric => 0, type => 'longblob', default => ''},
ContentType =>
{read => 1, write => 1, sql_type => 12, length => 80, is_blob => 0, is_numeric => 0, type => 'varchar(80)', default => ''},
ContentEncoding =>
{read => 1, write => 1, sql_type => 12, length => 80, is_blob => 0, is_numeric => 0, type => 'varchar(80)', default => ''},
Creator =>
{read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
Created =>
{read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
LastUpdatedBy =>
{read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'},
LastUpdated =>
{read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''},
Disabled =>
{read => 1, write => 1, sql_type => 5, length => 6, is_blob => 0, is_numeric => 1, type => 'smallint(6)', default => '0'},
}
};
sub FindDependencies {
my $self = shift;
my ($walker, $deps) = @_;
$self->SUPER::FindDependencies($walker, $deps);
$deps->Add( out => $self->CustomFieldObj );
$deps->Add( out => $self->Object );
}
RT::Base->_ImportOverlays();
1;
|