Upgrade to 4.2.8
[usit-rt.git] / share / html / Elements / EditCustomField
1 %# BEGIN BPS TAGGED BLOCK {{{
2 %#
3 %# COPYRIGHT:
4 %#
5 %# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
6 %#                                          <sales@bestpractical.com>
7 %#
8 %# (Except where explicitly superseded by other copyright notices)
9 %#
10 %#
11 %# LICENSE:
12 %#
13 %# This work is made available to you under the terms of Version 2 of
14 %# the GNU General Public License. A copy of that license should have
15 %# been provided with this software, but in any event can be snarfed
16 %# from www.gnu.org.
17 %#
18 %# This work is distributed in the hope that it will be useful, but
19 %# WITHOUT ANY WARRANTY; without even the implied warranty of
20 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21 %# General Public License for more details.
22 %#
23 %# You should have received a copy of the GNU General Public License
24 %# along with this program; if not, write to the Free Software
25 %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 %# 02110-1301 or visit their web page on the internet at
27 %# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28 %#
29 %#
30 %# CONTRIBUTION SUBMISSION POLICY:
31 %#
32 %# (The following paragraph is not intended to limit the rights granted
33 %# to you to modify and distribute this software under the terms of
34 %# the GNU General Public License and is only of importance to you if
35 %# you choose to contribute your changes and enhancements to the
36 %# community by submitting them to Best Practical Solutions, LLC.)
37 %#
38 %# By intentionally submitting any modifications, corrections or
39 %# derivatives to this work, or any other work intended for use with
40 %# Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 %# you are the copyright holder for those contributions and you grant
42 %# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
43 %# royalty-free, perpetual, license to use, copy, create derivative
44 %# works based on those contributions, and sublicense and distribute
45 %# those contributions and any derivatives thereof.
46 %#
47 %# END BPS TAGGED BLOCK }}}
48 <%INIT>
49
50 my $Type = $CustomField->Type;
51 unless ( $Type ) {
52     # if we can't see the type, all hell will break loose.
53     $RT::Logger->error( "Custom field #". $CustomField->id ." has empty type" );
54     return;
55 }
56
57 my $Values;
58 if ( $Object ) {
59     $Grouping =~ s/\W//g if $Grouping;
60
61     if ( $Object->Id ) {
62         $Values = $Object->CustomFieldValues( $CustomField->id );
63         $Values->Columns(
64             qw( id CustomField ObjectType ObjectId Disabled Content
65             ContentType ContentEncoding SortOrder Creator Created
66             LastUpdatedBy LastUpdated )
67         );
68         # Don't take care of $Values if there isn't values inside
69         undef ( $Values ) unless ( $Values->Count );
70     }
71 }
72
73 my $Name;
74 if ( !$NamePrefix ) {
75     $Name = GetCustomFieldInputName(Object => $Object, CustomField => $CustomField, Grouping => $Grouping );
76 }
77
78 # Always fill $Default with submited values if it's empty
79 if ( ( !defined $Default || !length $Default ) && $DefaultsFromTopArguments ) {
80     my %TOP = %$DECODED_ARGS;
81     $Default = $TOP{ $Name } if $Name;
82     # check both -Values and -Value for back compatibility
83     if ( $NamePrefix ) {
84         $Default //= $TOP{ $NamePrefix . $CustomField->Id . '-Values' }
85             // $TOP{ $NamePrefix . $CustomField->Id . '-Value' };
86     }
87     else {
88         my $prefix = GetCustomFieldInputNamePrefix(Object => $Object, CustomField => $CustomField, Grouping => $Grouping );
89         $Default //= $TOP{ $prefix . 'Values' } // $TOP{ $prefix . 'Value' };
90     }
91 }
92
93 my $MaxValues = $CustomField->MaxValues;
94 if ($MaxValues == 1 && $Values) {
95     # what exactly is this doing?  Without the "unless" it breaks RTFM
96     # transaction extraction into articles.
97     $Default = ($Values->First ? $Values->First->Content : '') unless $Default;
98     $Values->GotoFirstItem;
99 }
100 # The "Magic" hidden input causes RT to know that we were trying to edit the field, even if 
101 # we don't see a value later, since browsers aren't compelled to submit empty form fields
102 $m->out("\n".'<input type="hidden" class="hidden" name="'
103         . ($Name ? $m->interp->apply_escapes($Name, 'h') : $m->interp->apply_escapes($NamePrefix, 'h').$CustomField->Id.'-Values')
104         . '-Magic" value="1" />'."\n");
105
106
107 my $EditComponent = "EditCustomField$Type";
108 $m->callback( %ARGS, CallbackName => 'EditComponentName', Name => \$EditComponent, CustomField => $CustomField, Object => $Object );
109 $EditComponent = "EditCustomField$Type" unless $m->comp_exists($EditComponent);
110
111 return $m->comp(
112     $EditComponent,
113     %ARGS,
114     Rows => $Rows,
115     Cols => $Cols,
116     Default => $Default,
117     Object => $Object,
118     Values => $Values,
119     MaxValues => $MaxValues,
120     Multiple => ($MaxValues != 1),
121     NamePrefix => $NamePrefix,
122     CustomField => $CustomField,
123     Name => $Name,
124     $CustomField->BasedOn && $Name ? ( BasedOnName => GetCustomFieldInputName(Object => $Object, CustomField => $CustomField->BasedOnObj, Grouping => $Grouping) ) : (),
125 );
126 </%INIT>
127 <%ARGS>
128 $Grouping    => undef
129 $Object      => undef
130 $CustomField => undef
131 $NamePrefix  => undef
132 $Rows        => 5
133 $Cols        => 15
134 $Default     => undef
135 $DefaultsFromTopArguments => 1,
136 </%ARGS>