rt/share/html/Admin/CustomFields/Modify.html

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2015 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 <& /Admin/Elements/Header, Title => $title &>
  49 <& /Elements/Tabs &>
  50 <& /Elements/ListActions, actions => \@results &>
  51
  52
  53 <form method="post" action="Modify.html" name="ModifyCustomField" id="ModifyCustomField">
  54 <input type="hidden" class="hidden" name="id" value="<% $id %>" />
  55
  56 <table>
  57
  58 <tr><td class="label"><&|/l&>Name</&></td>
  59 <td><input name="Name" value="<% $CustomFieldObj->Name || $Name || '' %>" size="20" /></td></tr>
  60
  61 <tr><td class="label"><&|/l&>Description</&></td>
  62 <td><input name="Description" value="<% $CustomFieldObj->Description || $Description || '' %>" size="80" /></td></tr>
  63
  64 <tr><td class="label"><&|/l&>Type</&></td>
  65 <td><& /Admin/Elements/SelectCustomFieldType,
  66         Name => "TypeComposite",
  67         Default => $CustomFieldObj->TypeComposite, &>
  68 </td></tr>
  69
  70 % if ( $CustomFieldObj->Id and $CustomFieldObj->HasRenderTypes ) {
  71 <tr>
  72   <td class="label"><&|/l&>Render Type</&></td>
  73   <td>
  74     <& /Admin/Elements/SelectCustomFieldRenderType,
  75         Name            => "RenderType",
  76         TypeComposite   => $CustomFieldObj->TypeComposite,
  77         Default         => $CustomFieldObj->RenderType,
  78         BasedOn         => $CustomFieldObj->BasedOnObj->id, &>
  79   </td>
  80 </tr>
  81 % }
  82
  83 % if ( $CustomFieldObj->Id and $CustomFieldObj->IsSelectionType and RT->Config->Get('CustomFieldValuesSources') and ( scalar(@{RT->Config->Get('CustomFieldValuesSources')}) > 0 ) ) {
  84 <tr><td class="label"><&|/l&>Field values source:</&></td><td>
  85 <& /Admin/Elements/EditCustomFieldValuesSource, CustomField => $CustomFieldObj &>
  86 </td></tr>
  87 % }
  88
  89 <tr><td class="label"><&|/l&>Applies to</&></td>
  90 <td><& /Admin/Elements/SelectCustomFieldLookupType,
  91         Name => "LookupType",
  92         Default => $CustomFieldObj->LookupType || $LookupType, &>
  93 </td></tr>
  94
  95 % if ( $CustomFieldObj->Id
  96 %     and $CustomFieldObj->LookupType =~ /RT::Transaction/ ) {
  97 <tr><td class="label"><&|/l&>Display&nbsp;with</&></td>
  98 <td><& /Admin/Elements/EditCustomFieldUILocation,
  99         CustomField => $CustomFieldObj &>
 100 </td></tr>
 101 % }
 102
 103 <tr class="edit_validation"><td class="label"><&|/l&>Validation</&></td>
 104 <td><& /Widgets/ComboBox,
 105     Name    => 'Pattern',
 106     Default => $CustomFieldObj->Pattern || $Pattern,
 107     Size    => 20,
 108     Values  => \@CFvalidations,
 109 &></td></tr>
 110
 111 <tr><td class="label"><&|/l&>Link values to</&></td><td>
 112 <input size="60" name="LinkValueTo"  value="<% $CustomFieldObj->LinkValueTo || $LinkValueTo || '' %>" />
 113 <div class="hints">
 114 <&|/l&>RT can make this custom field's values into hyperlinks to another service.</&>
 115 <&|/l&>Fill in this field with a URL.</&>
 116 <&|/l_unsafe, '<tt>__id__</tt>', '<tt>__CustomField__</tt>' &>RT will replace [_1] and [_2] with the record's id and the custom field's value, respectively.</&>
 117 </div></td></tr>
 118
 119 <tr><td class="label"><&|/l&>Include page</&></td><td>
 120 <input size="60" name="IncludeContentForValue" value="<% $CustomFieldObj->IncludeContentForValue || $IncludeContentForValue || '' %>" />
 121 <div class="hints">
 122 <&|/l&>RT can include content from another web service when showing this custom field.</&>
 123 <&|/l&>Fill in this field with a URL.</&>
 124 <&|/l_unsafe, '<tt>__id__</tt>', '<tt>__CustomField__</tt>' &>RT will replace [_1] and [_2] with the record's id and the custom field's value, respectively.</&>
 125 <i><&|/l&>Some browsers may only load content from the same domain as your RT server.</&></i>
 126 </div></td></tr>
 127
 128 % if ( $CustomFieldObj->Id && $CustomFieldObj->IsSelectionType && !$CustomFieldObj->IsExternalValues ) {
 129 <tr class="categoriesbasedon"><td class="label"><&|/l&>Categories are based on</&></td><td>
 130 <& /Admin/Elements/SelectCustomField,
 131     Name => "BasedOn",
 132     LookupType => $CustomFieldObj->LookupType,
 133     Default => $CustomFieldObj->BasedOnObj || $BasedOn,
 134     Not => $CustomFieldObj->id,
 135 &>
 136 </td></tr>
 137 % }
 138
 139 % $m->callback(CallbackName => 'BeforeEnabled', CustomField => $CustomFieldObj, CFvalidations => \@CFvalidations);
 140
 141 <tr><td class="label">&nbsp;</td><td>
 142 <input type="checkbox" class="checkbox" name="Required" value="1" <% $RequiredChecked |n%> />
 143 <&|/l&>Required for ticket resolution</&>
 144 </td></tr>
 145
 146 <tr><td class="label">&nbsp;</td><td>
 147 <input type="checkbox" class="checkbox" name="YesClone" value="1" <% $YesCloneChecked |n%> />
 148 <&|/l&>Copy this field to new tickets</&>
 149 </td></tr>
 150
 151 <tr><td class="label">&nbsp;</td><td>
 152 <input type="hidden" class="hidden" name="SetEnabled" value="1" />
 153 <input type="checkbox" class="checkbox" name="Enabled" value="1" <% $EnabledChecked |n%> />
 154 <&|/l&>Enabled (Unchecking this box disables this custom field)</&>
 155 </td></tr>
 156
 157 % $m->callback(CallbackName => 'EndOfTable', CustomField => $CustomFieldObj, CFvalidations => \@CFvalidations);
 158
 159 </table>
 160
 161 % if ( $CustomFieldObj->Id && $CustomFieldObj->IsSelectionType && !$CustomFieldObj->IsExternalValues ) {
 162 <h2><&|/l&>Values</&></h2>
 163 <div>
 164 <& /Admin/Elements/EditCustomFieldValues, CustomField => $CustomFieldObj &>
 165 <& /Admin/Elements/AddCustomFieldValue, CustomField => $CustomFieldObj &>
 166 </div>
 167 % }
 168
 169 <& /Elements/Submit, Name => 'Update', Label => $id eq 'new'? loc('Create'): loc('Save Changes') &>
 170
 171 </form>
 172 <%INIT>
 173 my ($title, @results);
 174
 175 my $CustomFieldObj = RT::CustomField->new( $session{'CurrentUser'} );
 176
 177 $m->callback(CallbackName => 'Initial', Pattern => \$Pattern, ARGSRef => \%ARGS);
 178
 179 unless ( $id ) {
 180     $title = loc("Create a CustomField");
 181     $id    = 'new';
 182 }
 183 else {
 184     if ( $id eq 'new' ) {
 185         my ( $val, $msg ) = $CustomFieldObj->Create(
 186             Name          => $Name,
 187             TypeComposite => $TypeComposite,
 188             LookupType    => $LookupType,
 189             Description   => $Description,
 190             Pattern       => $Pattern,
 191             LinkValueTo   => $LinkValueTo,
 192             IncludeContentForValue => $IncludeContentForValue,
 193             BasedOn       => $BasedOn,
 194             Disabled      => !$Enabled,
 195             NoClone       => !$YesClone,
 196         );
 197         if (!$val) {
 198             push @results, loc("Could not create CustomField: [_1]", $msg);
 199             $title = loc( 'Create a CustomField');
 200         }
 201         else {
 202             push @results, loc("Object created");
 203             $title = loc( 'Created CustomField [_1]', $CustomFieldObj->Name );
 204         }
 205     } else {
 206         push @results, loc('No CustomField')
 207             unless  $CustomFieldObj->Load( $id );
 208
 209         $title = loc( 'Editing CustomField [_1]', $CustomFieldObj->Name );
 210     }
 211 }
 212
 213 if ( $ARGS{'Update'} && $id ne 'new' ) {
 214     #we're asking about enabled on the web page but really care about disabled.
 215     $ARGS{'Disabled'} = $Enabled? 0 : 1;
 216     #  likewise
 217     $ARGS{'NoClone'} = $YesClone ? 0 : 1;
 218
 219     $ARGS{'Required'} ||= 0;
 220
 221     my @attribs = qw(Disabled Required Pattern Name TypeComposite LookupType Description LinkValueTo IncludeContentForValue NoClone);
 222     push @results, UpdateRecordObject(
 223         AttributesRef => \@attribs,
 224         Object        => $CustomFieldObj,
 225         ARGSRef       => \%ARGS
 226     );
 227     if ( ($ValuesClass||'RT::CustomFieldValues') ne $CustomFieldObj->ValuesClass ) {
 228         my $original = $CustomFieldObj->ValuesClass;
 229         my ($good, $msg) = $CustomFieldObj->SetValuesClass( $ValuesClass );
 230         if ( $good ) {
 231             $msg = loc("[_1] changed from '[_2]' to '[_3]'",
 232                         loc("Field values source"), $original, $ValuesClass );
 233         }
 234         push @results, $msg;
 235     }
 236
 237     # Set the render type if we have it, but unset it if the new type doesn't
 238     # support render types
 239     if ( $CustomFieldObj->HasRenderTypes($TypeComposite) ) {
 240         my $original = $CustomFieldObj->RenderType;
 241
 242         if ( defined $RenderType and $RenderType ne $original ) {
 243             # It's changed!  Let's update it.
 244             my ($good, $msg) = $CustomFieldObj->SetRenderType( $RenderType );
 245
 246             if ( $good ) {
 247                 $msg = loc("[_1] changed from '[_2]' to '[_3]'",
 248                             loc("Render Type"), $original, $RenderType );
 249             }
 250
 251             push @results, $msg;
 252         }
 253     }
 254     else {
 255         # Delete it if we no longer support render types
 256         $CustomFieldObj->SetRenderType( undef );
 257     }
 258
 259     if (($CustomFieldObj->BasedOn||'') ne ($BasedOn||'')) {
 260         my ($good, $msg) = $CustomFieldObj->SetBasedOn( $BasedOn );
 261         push @results, $msg;
 262     }
 263
 264     $CustomFieldObj->SetUILocation( $UILocation );
 265
 266     my $paramtag = "CustomField-". $CustomFieldObj->Id ."-Value";
 267     # Delete any fields that want to be deleted
 268     foreach my $key ( keys %ARGS ) {
 269         next unless $key =~ /^Delete-$paramtag-(\d+)$/;
 270         my ($val, $msg) = $CustomFieldObj->DeleteValue( $1 );
 271         push (@results, $msg);
 272     }
 273
 274     # Clean up values
 275     foreach my $param (grep /^$paramtag-/, keys(%ARGS)) {
 276       for ($ARGS{$param}) {
 277         s/\r+\n/\n/g;
 278         s/^\s+//;
 279         s/\s+$//;
 280       }
 281     }
 282
 283     # Update any existing values
 284     my $values = $CustomFieldObj->ValuesObj;
 285     while ( my $value = $values->Next ) {
 286         foreach my $attr (qw(Name Description SortOrder Category)) {
 287             my $param = join("-", $paramtag, $value->Id, $attr);
 288             next unless exists $ARGS{$param};
 289             $ARGS{$param} =~ s/^\s+//;
 290             $ARGS{$param} =~ s/\s+$//;
 291             next if ($value->$attr()||'') eq ($ARGS{$param}||'');
 292
 293             my $mutator = "Set$attr";
 294             my ($id, $msg) = $value->$mutator( $ARGS{$param} );
 295             push (@results, $msg);
 296         }
 297         $m->callback(CallbackName => 'AfterUpdateCustomFieldValue', CustomFieldObj => $CustomFieldObj, CustomFieldValueObj => $value, ARGSRef => \%ARGS );
 298     }
 299
 300     # Add any new values
 301     if ( defined $ARGS{ $paramtag ."-new-Name" } && length $ARGS{ $paramtag ."-new-Name" } ) {
 302         my ($id, $msg) = $CustomFieldObj->AddValue(
 303             map {
 304                 $ARGS{$paramtag."-new-$_"} =~ s/^\s+//;
 305                 $ARGS{$paramtag."-new-$_"} =~ s/\s+$//;
 306                 $_ => $ARGS{ $paramtag ."-new-$_" } } qw/ Name Description SortOrder Category/
 307         );
 308         push (@results, $msg);
 309
 310         my $cfv = RT::CustomFieldValue->new( $session{CurrentUser} );
 311         $cfv->Load($id);
 312         $m->callback(CallbackName => 'AfterCreateCustomFieldValue',
 313 CustomFieldObj => $CustomFieldObj, CustomFieldValueObj => $cfv, ARGSRef => \%ARGS );
 314     }
 315 }
 316
 317 $id = $CustomFieldObj->id if $CustomFieldObj->id;
 318
 319 # This code does automatic redirection if any updates happen.
 320 MaybeRedirectForResults(
 321     Actions     => \@results,
 322     Arguments   => { id => $id },
 323 ) if $CustomFieldObj->id;
 324
 325
 326 my $EnabledChecked = qq[checked="checked"];
 327 $EnabledChecked = '' if $CustomFieldObj->Disabled;
 328
 329 my $RequiredChecked = '';
 330 $RequiredChecked = qq[checked="checked"] if $CustomFieldObj->Required;
 331
 332 my $YesCloneChecked = qq[checked="checked"];
 333 $YesCloneChecked = '' if $CustomFieldObj->NoClone;
 334
 335
 336 my @CFvalidations = (
 337     '(?#Mandatory).',
 338     '(?#Digits)^[\d.]+$',
 339     '(?#Year)^[12]\d{3}$',
 340 );
 341
 342 $m->callback(CallbackName => 'ValidationPatterns', Values => \@CFvalidations);
 343
 344 </%INIT>
 345 <%ARGS>
 346 $id => undef
 347 $TypeComposite => undef
 348 $LookupType => RT::Ticket->CustomFieldLookupType
 349 $MaxValues => undef
 350 $SortOrder => undef
 351 $Description => undef
 352 $Pattern => undef
 353 $Name => undef
 354 $SetEnabled => undef
 355 $Enabled => 0
 356 $ValuesClass => 'RT::CustomFieldValues'
 357 $RenderType => undef
 358 $LinkValueTo => undef
 359 $IncludeContentForValue => undef
 360 $BasedOn => undef
 361 $UILocation => undef
 362 $YesClone => undef
 363 </%ARGS>