rt/share/html/Elements/ValidateCustomFields

   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 my ($valid, @res) = (1, ());
  50 $CustomFields->GotoFirstItem;
  51 while ( my $CF = $CustomFields->Next ) {
  52     my $field = $NamePrefix . $CF->Id . "-Value";
  53
  54     my $value;
  55     if ($ARGSRef->{"${field}s-Magic"} and exists $ARGSRef->{"${field}s"}) {
  56         $value = $ARGSRef->{"${field}s"};
  57
  58         # We only validate Single Combos -- multis can never be user input
  59         next if ref $value;
  60     }
  61     else {
  62         $value = $ARGSRef->{$field};
  63     }
  64     $m->notes(('Field-' . $CF->Id) => $value);
  65
  66     my @values = ();
  67     if ( ref $value eq 'ARRAY' ) {
  68         @values = @$value;
  69     } elsif ( $CF->Type =~ /text/i ) {
  70         @values = ($value);
  71     } else {
  72         @values = split /\r*\n/, ( defined $value ? $value : '');
  73     }
  74     @values = grep $_ ne '',
  75         map {
  76             s/\r+\n/\n/g;
  77             s/^\s+//;
  78             s/\s+$//;
  79             $_;
  80         }
  81         grep defined, @values;
  82     @values = ('') unless @values;
  83
  84     for my $value( @values ) {
  85         if ($value) {
  86             if ( $CF->Type eq 'IPAddress' ) {
  87                 use Regexp::Common qw(RE_net_IPv4);
  88                 my $ip = RT::ObjectCustomFieldValue->ParseIP( $value );
  89                 unless ( $ip ) {
  90                     my $msg =
  91                       loc( "Input can not be parsed as an IP address" );
  92                     $m->notes( ( 'InvalidField-' . $CF->Id ) => $msg );
  93                     push @res, $msg;
  94                     $valid = 0;
  95                 }
  96             }
  97             elsif ( $CF->Type eq 'IPAddressRange' ) {
  98                 my ( $start_ip, $end_ip ) =
  99                   RT::ObjectCustomFieldValue->ParseIPRange($value);
 100                 unless ( $start_ip && $end_ip ) {
 101                     my $msg =
 102                       loc( "Input can not be parsed as an IP address range" );
 103                     $m->notes( ( 'InvalidField-' . $CF->Id ) => $msg );
 104                     push @res, $msg;
 105                     $valid = 0;
 106                 }
 107             }
 108         }
 109
 110         next if $CF->MatchPattern($value);
 111
 112         my $msg = loc("Input must match [_1]", $CF->FriendlyPattern);
 113         $m->notes( ('InvalidField-' . $CF->Id) => $msg );
 114         push @res, $msg;
 115         $valid = 0;
 116     }
 117 }
 118 $m->notes('ValidFields', $valid);
 119 return wantarray? ($valid, @res): $valid;
 120 </%INIT>
 121 <%ARGS>
 122 $CustomFields
 123 $ARGSRef
 124 $NamePrefix => "Object-RT::Ticket--CustomField-"
 125 </%ARGS>