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

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2011 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 <& /Admin/Elements/CustomFieldTabs,
  50     id => $CustomFieldObj->Id ,
  51     current_tab => $current_tab,
  52     Title => $title &>
  53 <& /Elements/ListActions, actions => \@results &>
  54
  55
  56 <form method="post" action="Modify.html" name="ModifyCustomField">
  57 <input type="hidden" class="hidden" name="id" value="<% $id %>" />
  58
  59 <table>
  60
  61 <tr><td class="label"><&|/l&>Name</&></td>
  62 <td><input name="Name" value="<% $CustomFieldObj->Name || '' %>" size="20" /></td></tr>
  63
  64 <tr><td class="label"><&|/l&>Description</&></td>
  65 <td><input name="Description" value="<% $CustomFieldObj->Description || '' %>" size="80" /></td></tr>
  66
  67 <tr><td class="label"><&|/l&>Type</&></td>
  68 <td><& /Admin/Elements/SelectCustomFieldType,
  69         Name => "TypeComposite",
  70         Default => $CustomFieldObj->TypeComposite, &>
  71 </td></tr>
  72
  73 % if ( $CustomFieldObj->Id and $CustomFieldObj->IsSelectionType and RT->Config->Get('CustomFieldValuesSources') and ( scalar(@{RT->Config->Get('CustomFieldValuesSources')}) > 0 ) ) {
  74 <tr><td class="label"><&|/l&>Field values source:</&></td><td>
  75 <& /Admin/Elements/EditCustomFieldValuesSource, CustomField => $CustomFieldObj &>
  76 </td></tr>
  77 % }
  78
  79 <tr><td class="label"><&|/l&>Applies to</&></td>
  80 <td><& /Admin/Elements/SelectCustomFieldLookupType,
  81         Name => "LookupType",
  82         Default => $CustomFieldObj->LookupType, &>
  83 </td></tr>
  84
  85 <tr><td class="label"><&|/l&>Validation</&></td>
  86 <td><& /Widgets/ComboBox,
  87     Name    => 'Pattern',
  88     Default => $CustomFieldObj->Pattern,
  89     Size    => 20,
  90     Values  => \@CFvalidations,
  91 &></td></tr>
  92
  93 <tr><td class="label"><&|/l&>Link values to</&></td><td>
  94 <input size="60" name="LinkValueTo"  value="<% $CustomFieldObj->LinkValueTo || '' %>" />
  95 <div class="hints">
  96 <&|/l&>RT can make this custom field's values into hyperlinks to another service.</&>
  97 <&|/l&>Fill in this field with a URL.</&>
  98 <&|/l&>RT will replace <tt>__id__</tt> and <tt>__CustomField__</tt> with the record id and custom field value, respectively</&>
  99 </div></td></tr>
 100
 101 <tr><td class="label"><&|/l&>Include page</&></td><td>
 102 <input size="60" name="IncludeContentForValue" value="<% $CustomFieldObj->IncludeContentForValue || '' %>" />
 103 <div class="hints">
 104 <&|/l&>RT can include content from another web service when showing this custom field.</&>
 105 <&|/l&>Fill in this field with a URL.</&>
 106 <&|/l&>RT will replace <tt>__id__</tt> and <tt>__CustomField__</tt> with the record id and custom field value, respectively</&>
 107 <i><&|/l&>Some browsers may only load content from the same domain as your RT server.</&></i>
 108 </div></td></tr>
 109
 110 % if ( $CustomFieldObj->Id && $CustomFieldObj->IsSelectionType && !$CustomFieldObj->IsExternalValues ) {
 111 <tr><td class="label"><&|/l&>Categories are based on</&></td><td>
 112 <& /Admin/Elements/SelectCustomField,
 113     Name => "BasedOn",
 114     LookupType => $CustomFieldObj->LookupType,
 115     Default => $CustomFieldObj->BasedOnObj,
 116     Not => $CustomFieldObj->id,
 117 &>
 118 </td></tr>
 119 % }
 120
 121 <tr><td class="label">&nbsp;</td><td>
 122 <input type="checkbox" class="checkbox" name="Required" value="1" <% $RequiredChecked |n%> />
 123 <&|/l&>Required for ticket resolution</&>
 124 </td></tr>
 125
 126 <tr><td class="label">&nbsp;</td><td>
 127 <input type="hidden" class="hidden" name="SetEnabled" value="1" />
 128 <input type="checkbox" class="checkbox" name="Enabled" value="1" <% $EnabledChecked |n%> />
 129 <&|/l&>Enabled (Unchecking this box disables this custom field)</&>
 130 </td></tr>
 131
 132 </table>
 133
 134 % if ( $CustomFieldObj->Id && $CustomFieldObj->IsSelectionType && !$CustomFieldObj->IsExternalValues ) {
 135 <h2><&|/l&>Values</&></h2>
 136 <div>
 137 <& /Admin/Elements/EditCustomFieldValues, CustomField => $CustomFieldObj &>
 138 <& /Admin/Elements/AddCustomFieldValue, CustomField => $CustomFieldObj &>
 139 </div>
 140 % }
 141
 142 <& /Elements/Submit, Name => 'Update', Label => $id eq 'new'? loc('Create'): loc('Save Changes') &>
 143
 144 </form>
 145 <%INIT>
 146 my ($title, @results, $Disabled);
 147
 148 my $CustomFieldObj = RT::CustomField->new( $session{'CurrentUser'} );
 149 my $current_tab = 'Admin/CustomFields/Modify.html';
 150
 151 unless ( $id ) {
 152     $title = loc("Create a CustomField");
 153     $id    = 'new';
 154     $current_tab .= '?Create=1';
 155 }
 156 else {
 157     if ( $id eq 'new' ) {
 158         my ( $val, $msg ) = $CustomFieldObj->Create(
 159             Name          => $Name,
 160             TypeComposite => $TypeComposite,
 161             LookupType    => $LookupType,
 162             Description   => $Description,
 163             Pattern       => $Pattern,
 164             LinkValueTo   => $LinkValueTo,
 165             IncludeContentForValue => $IncludeContentForValue,
 166             BasedOn       => $BasedOn,
 167         );
 168         $m->comp( "/Elements/Error", Why => loc( "Could not create CustomField", $msg ) ) unless $val;
 169         push @results, $msg;
 170         $title = loc( 'Created CustomField [_1]', $CustomFieldObj->Name );
 171     } else {
 172         $CustomFieldObj->Load( $id ) || $m->comp("/Elements/Error", Why => loc('No CustomField') );
 173         $title = loc( 'Editing CustomField [_1]', $CustomFieldObj->Name );
 174     }
 175     $current_tab .= "?id=$id";
 176 }
 177
 178 if ( $ARGS{'Update'} && $id ne 'new' ) {
 179     #we're asking about enabled on the web page but really care about disabled.
 180     $ARGS{'Disabled'} = $Disabled = $Enabled? 0 : 1;
 181
 182     $ARGS{'Required'} ||= 0;
 183
 184     my @attribs = qw(Disabled Required Pattern Name TypeComposite LookupType Description LinkValueTo IncludeContentForValue);
 185     push @results, UpdateRecordObject(
 186         AttributesRef => \@attribs,
 187         Object        => $CustomFieldObj,
 188         ARGSRef       => \%ARGS
 189     );
 190     $CustomFieldObj->SetValuesClass( $ValuesClass );
 191
 192     $CustomFieldObj->SetBasedOn( $BasedOn );
 193
 194     my $paramtag = "CustomField-". $CustomFieldObj->Id ."-Value";
 195     # Delete any fields that want to be deleted
 196     foreach my $key ( keys %ARGS ) {
 197         next unless $key =~ /^Delete-$paramtag-(\d+)$/o;
 198         my ($val, $msg) = $CustomFieldObj->DeleteValue( $1 );
 199         push (@results, $msg);
 200     }
 201
 202     # Clean up values
 203     foreach my $param (grep /^$paramtag-/, keys(%ARGS)) {
 204       for ($ARGS{$param}) {
 205         s/\r+\n/\n/g;
 206         s/^\s+//;
 207         s/\s+$//;
 208       }
 209     }
 210
 211     # Update any existing values
 212     my $values = $CustomFieldObj->ValuesObj;
 213     while ( my $value = $values->Next ) {
 214         foreach my $attr qw(Name Description SortOrder Category) {
 215             my $param = join("-", $paramtag, $value->Id, $attr);
 216             next unless exists $ARGS{$param};
 217             $ARGS{$param} =~ s/^\s+//;
 218             $ARGS{$param} =~ s/\s+$//;
 219             next if ($value->$attr()||'') eq ($ARGS{$param}||'');
 220             my $mutator = "Set$attr";
 221             my ($id, $msg) = $value->$mutator( $ARGS{$param} );
 222             push (@results, $msg);
 223         }
 224     }
 225
 226     # Add any new values
 227     if ( defined $ARGS{ $paramtag ."-new-Name" } && length $ARGS{ $paramtag ."-new-Name" } ) {
 228         my ($id, $msg) = $CustomFieldObj->AddValue(
 229             map {
 230                 $ARGS{$paramtag."-new-$_"} =~ s/^\s+//;
 231                 $ARGS{$paramtag."-new-$_"} =~ s/\s+$//;
 232                 $_ => $ARGS{ $paramtag ."-new-$_" } } qw/ Name Description SortOrder Category/
 233         );
 234         push (@results, $msg);
 235     }
 236 }
 237
 238 $id = $CustomFieldObj->id if $CustomFieldObj->id;
 239
 240 my $EnabledChecked = qq[checked="checked"];
 241 $EnabledChecked = '' if $CustomFieldObj->Disabled;
 242
 243 my $RequiredChecked = '';
 244 $RequiredChecked = qq[checked="checked"] if $CustomFieldObj->Required;
 245
 246 my @CFvalidations = (
 247     '(?#Mandatory).',
 248     '(?#Digits)^[\d.]+$',
 249     '(?#Year)^[12]\d{3}$',
 250 );
 251
 252 $m->callback(CallbackName => 'ValidationPatterns', Values => \@CFvalidations);
 253
 254 </%INIT>
 255 <%ARGS>
 256 $id => undef
 257 $TypeComposite => undef
 258 $LookupType => undef
 259 $MaxValues => undef
 260 $SortOrder => undef
 261 $Description => undef
 262 $Pattern => undef
 263 $Name => undef
 264 $SetEnabled => undef
 265 $Enabled => 0
 266 $ValuesClass => 'RT::CustomFieldValues'
 267 $LinkValueTo => undef
 268 $IncludeContentForValue => undef
 269 $BasedOn => undef
 270 </%ARGS>