rt/share/html/Elements/ValidateCustomFields

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2016 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
  52 my $CFArgs = _ParseObjectCustomFieldArgs( $ARGSRef )->{ref($Object)}{$Object->Id || 0} || {};
  53
  54 while ( my $CF = $CustomFields->Next ) {
  55     my $submitted = $CFArgs->{$CF->Id};
  56     # Pick the first grouping
  57     $submitted = $submitted ? $submitted->{(keys %$submitted)[0]} : {};
  58
  59     # If we don't have a value and we don't see the Magic, then we're not
  60     # submitting a field.
  61     next if not $ValidateUnsubmitted
  62         and not exists $submitted->{"Value"}
  63         and not exists $submitted->{"Upload"}
  64         and not exists $submitted->{"Values"}
  65         and not $submitted->{"Values-Magic"};
  66
  67     # We only validate Single Combos -- multis can never be user input
  68     next if $submitted->{"Values-Magic"} and exists $submitted->{"Values"}
  69         and ref $submitted->{"Values"};
  70
  71     $m->notes(('Field-' . $CF->Id) => $submitted->{Values} // $submitted->{Value});
  72
  73     my @values = _NormalizeObjectCustomFieldValue(
  74         CustomField => $CF,
  75         Value       => ($submitted->{Values} // $submitted->{Value} // $submitted->{Upload}),
  76     );
  77     if ($CF->Type =~ /^Date(?:Time)?$/) {
  78         if (not @values) {
  79             my $values = $Object->CustomFieldValues($CF->Id);
  80             while (my $ocfv = $values->Next) {
  81                 push @values, $ocfv->Content;
  82             }
  83         }
  84         @values = grep {
  85             my $DateObj = RT::Date->new ( $session{'CurrentUser'} );
  86             $DateObj->Set(
  87                 Format => 'unknown',
  88                 Value => $_,
  89                 ($CF->Type eq "Date" ? (Timezone => 'utc') : ())
  90             );
  91             $DateObj->IsSet
  92         } @values;
  93     }
  94     push @values, '' unless @values;
  95
  96     for my $value( @values ) {
  97         if ($value) {
  98             my $ref = { Content => $value };
  99             my ($ok, $msg) = $CF->_CanonicalizeValue( $ref );
 100             unless ($ok) {
 101                 $m->notes( ( 'InvalidField-' . $CF->Id ) => $msg );
 102                 push @res, $CF->Name .': '. $msg;
 103                 $valid = 0;
 104             }
 105         }
 106
 107         next if $CF->MatchPattern($value);
 108
 109         my $msg = loc("Input must match [_1]", $CF->FriendlyPattern);
 110         $m->notes( ('InvalidField-' . $CF->Id) => $msg );
 111         push @res, $CF->Name .': '. $msg;
 112         $valid = 0;
 113     }
 114 }
 115 $m->notes('ValidFields', $valid);
 116 return wantarray? ($valid, @res): $valid;
 117 </%INIT>
 118 <%ARGS>
 119 $Object => RT::Ticket->new( $session{'CurrentUser'})
 120 $CustomFields
 121 $ARGSRef
 122 $ValidateUnsubmitted => 0
 123 </%ARGS>