ObjectCustomFieldValue_Overlay.pm 6.5 KB
Newer Older
1
# BEGIN BPS TAGGED BLOCK {{{
2
# 
Jesse Vincent's avatar
Jesse Vincent committed
3
4
# COPYRIGHT:
#  
Jesse Vincent's avatar
Jesse Vincent committed
5
# This software is Copyright (c) 1996-2007 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
27
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/copyleft/gpl.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
package RT::ObjectCustomFieldValue;

50
use strict;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
51
use warnings;
52
53
no warnings qw(redefine);

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

    if ( defined $args{'Content'} && length( $args{'Content'} ) > 255 ) {
        if ( defined $args{'LargeContent'} && length $args{'LargeContent'} ) {
            $RT::Logger->error("Content is longer than 255 and LargeContent specified");
        }
        else {
            $args{'LargeContent'} = $args{'Content'};
            $args{'Content'} = '';
            $args{'ContentType'} ||= 'text/plain';
        }
77
78
79
    }

    ( $args{'ContentEncoding'}, $args{'LargeContent'} ) =
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
80
81
82
83
84
85
86
87
88
89
90
91
92
        $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'},
    );
93
94
95
96
97
}


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

105
106
107
108
109
110
111
112
113
=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
114
115
116
117
118
119
    my %args = (
        Ticket => undef,
        CustomField => undef,
        Content => undef,
        @_
    );
120

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

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

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

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

150
151
152
153
154
155
156
157
158
159

=head2 Content

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

=cut

sub Content {
    my $self = shift;
160
    my $content = $self->SUPER::Content;
161
    if ( !(defined $content && length $content) && $self->ContentType eq 'text/plain' ) {
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
162
        return $self->LargeContent;
163
164
    } else {
        return $content;
165
166
167
    }
}

Jesse Vincent's avatar
Jesse Vincent committed
168
169
170
171
172
173
=head2 Object

Returns the object this value applies to

=cut

174
175
sub Object {
    my $self  = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
176
177
178
    my $Object = $self->__Value('ObjectType')->new( $self->CurrentUser );
    $Object->LoadById( $self->__Value('ObjectId') );
    return $Object;
179
180
}

Jesse Vincent's avatar
Jesse Vincent committed
181
182
183
184
185
186
187
188

=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
189
190
sub Delete {
    my $self = shift;
Ruslan Zakirov's avatar
minor    
Ruslan Zakirov committed
191
    return $self->SetDisabled(1);
Audrey Tang's avatar
Audrey Tang committed
192
193
}

Jesse Vincent's avatar
Jesse Vincent committed
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
=head2 _FillInTemplateURL URL

Takes a URL containing placeholders and returns the URL as filled in for this 
ObjectCustomFieldValue.

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.

=back

=cut

sub _FillInTemplateURL {

    my $self = shift;

    my $url = shift;

    $url =~ s/__id__/@{[$self->ObjectId]}/g;
    $url =~ s/__CustomField__/@{[$self->Content]}/g;

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

256
1;