# Copyrights 2006-2013 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
use warnings;
use strict;
no warnings 'recursion';
package XML::Compile::Schema::BuiltInFacets;
use vars '$VERSION';
$VERSION = '1.32';
use base 'Exporter';
our @EXPORT = qw/builtin_facet/;
use Log::Report 'xml-compile', syntax => 'SHORT';
use Math::BigInt;
use Math::BigFloat;
use XML::LibXML; # for ::RegExp
use XML::Compile::Util qw/SCHEMA2001 pack_type/;
use MIME::Base64 qw/decoded_base64_length/;
use constant DBL_MAX_DIG => 15;
use constant DBL_MAX_EXP => 307;
# depend on Perl's compile flags
use constant INT_MAX => int((sprintf"%u\n",-1)/2);
use constant INT_MIN => -1 - INT_MAX;
my %facets_simple =
( enumeration => \&_enumeration
, fractionDigits => \&_s_fractionDigits
, length => \&_s_length
, maxExclusive => \&_s_maxExclusive
, maxInclusive => \&_s_maxInclusive
, maxLength => \&_s_maxLength
, maxScale => undef # ignore
, minExclusive => \&_s_minExclusive
, minInclusive => \&_s_minInclusive
, minLength => \&_s_minLength
, minScale => undef # ignore
, pattern => \&_pattern
, totalDigits => \&_s_totalDigits
, whiteSpace => \&_s_whiteSpace
, _totalFracDigits=> \&_s_totalFracDigits
);
my %facets_list =
( enumeration => \&_enumeration
, length => \&_l_length
, maxLength => \&_l_maxLength
, minLength => \&_l_minLength
, pattern => \&_pattern
, whiteSpace => \&_l_whiteSpace
);
my %facets_date = # inclusive or exclusive times is rather useless.
( maxExclusive => \&_d_max
, maxInclusive => \&_d_max
, minExclusive => \&_d_min
, minInclusive => \&_d_min
);
sub builtin_facet($$$$$$$$)
{ my ($path, $args, $facet, $value, $is_list, $type, $nss, $action) = @_;
my $date_time_type = pack_type SCHEMA2001, 'dateTime';
my $def
= $is_list ? $facets_list{$facet}
: $nss->doesExtend($type, $date_time_type) ? $facets_date{$facet}
: $facets_simple{$facet};
$def or error __x"facet {facet} not implemented at {where}"
, facet => $facet, where => $path;
$def->($path, $args, $value, $type, $nss, $action);
}
sub _l_whiteSpace($$$)
{ my ($path, undef, $ws) = @_;
$ws eq 'collapse'
or error __x"list whiteSpace facet fixed to 'collapse', not '{ws}' in {path}"
, ws => $ws, path => $path;
();
}
sub _s_whiteSpace($$$)
{ my ($path, undef, $ws) = @_;
$ws eq 'replace' ? \&_whitespace_replace
: $ws eq 'collapse' ? \&_whitespace_collapse
: $ws eq 'preserve' ? ()
: error __x"illegal whiteSpace facet '{ws}' in {path}"
, ws => $ws, path => $path;
}
sub _whitespace_replace($)
{ (my $value = shift) =~ s/[\t\r\n]/ /gs;
$value;
}
sub _whitespace_collapse($)
{ my $value = shift;
for($value)
{ s/[\t\r\n ]+/ /gs;
s/^ +//;
s/ +$//;
}
$value;
}
sub _maybe_big($$$)
{ my ($path, $args, $value) = @_;
return $value if $args->{sloppy_integers};
# modules Math::Big* loaded by Schema::Spec when not sloppy
$value =~ s/\s//g;
if($value =~ m/[.eE]/)
{ my $c = $value;
my $exp = $c =~ s/[eE][+-]?(\d+)// ? $1 : 0;
for($c) { s/\.//; s/^[-+]// }
return Math::BigFloat->new($value)
if length($c) > DBL_MAX_DIG || $exp > DBL_MAX_EXP;
}
# compare ints as strings, because they will overflow!!
if(substr($value, 0, 1) eq '-')
{ return Math::BigInt->new($value)
if length($value) > length(INT_MIN)
|| (length($value)==length(INT_MIN) && $value gt INT_MIN);
}
else
{ return Math::BigInt->new($value)
if length($value) > length(INT_MAX)
|| (length($value)==length(INT_MAX) && $value gt INT_MAX);
}
$value;
}
sub _s_minInclusive($$$)
{ my ($path, $args, $min) = @_;
$min = _maybe_big $path, $args, $min;
sub { return $_[0] if $_[0] >= $min;
error __x"too small inclusive {value}, min {min} at {where}"
, value => $_[0], min => $min, where => $path;
};
}
sub _s_minExclusive($$$)
{ my ($path, $args, $min) = @_;
$min = _maybe_big $path, $args, $min;
sub { return $_[0] if $_[0] > $min;
error __x"too small exclusive {value}, larger {min} at {where}"
, value => $_[0], min => $min, where => $path;
};
}
sub _s_maxInclusive($$$)
{ my ($path, $args, $max) = @_;
$max = _maybe_big $path, $args, $max;
sub { return $_[0] if $_[0] <= $max;
error __x"too large inclusive {value}, max {max} at {where}"
, value => $_[0], max => $max, where => $path;
};
}
sub _s_maxExclusive($$$)
{ my ($path, $args, $max) = @_;
$max = _maybe_big $path, $args, $max;
sub { return $_[0] if $_[0] < $max;
error __x"too large exclusive {value}, smaller {max} at {where}"
, value => $_[0], max => $max, where => $path;
};
}
my $qname = pack_type SCHEMA2001, 'QName';
sub _enumeration($$$$$$)
{ my ($path, $args, $enums, $type, $nss, $action) = @_;
if($action eq 'WRITER' && $nss->doesExtend($type, $qname))
{ # quite tricky to get ns involved here..., so validation
# only partial
my %enum = map { s/.*\}//; ($_ => 1) } @$enums;
return sub
{ my $x = $_[0]; $x =~ s/.*\://;
return $_[0] if exists $enum{$x};
error __x"invalid enumerate `{string}' at {where}"
, string => $_[0], where => $path;
};
}
my %enum = map { ($_ => 1) } @$enums;
sub { return $_[0] if exists $enum{$_[0]};
error __x"invalid enumerate `{string}' at {where}"
, string => $_[0], where => $path;
};
}
sub _s_totalDigits($$$)
{ my ($path, undef, $total) = @_;
# this accidentally also works correctly for NaN +INF -INF
sub
{ my $v = $_[0];
$v =~ s/[eE].*//;
$v =~ s/^[+-]?0*//;
return $_[0] if $total >= ($v =~ tr/0-9//);
error __x"decimal too long, got {length} digits max {max} at {where}"
, length => ($v =~ tr/0-9//), max => $total, where => $path;
};
}
sub _s_fractionDigits($$$)
{ my $frac = $_[2];
# can be result from Math::BigFloat, so too long to use %f But rounding
# is very hard to implement. If you need this accuracy, then format your
# value yourself!
sub
{ my $v = $_[0];
$v =~ s/(\.[0-9]{$frac}).*/$1/;
$v;
};
}
sub _s_totalFracDigits($$$)
{ my ($path, undef, $dig) = @_;
my ($total, $frac) = @$dig;
sub
{ my $w = $_[0]; # frac is dwimming in shortening
$w =~ s/(\.[0-9]{$frac}).*/$1/;
my $v = $w; # total is checking length
$v =~ s/[eE].*//;
$v =~ s/^[+-]?0*//;
return $w if $total >= ($v =~ tr/0-9//);
error __x"decimal too long, got {length} digits max {max} at {where}"
, length => ($v =~ tr/0-9//), max => $total, where => $path;
};
}
my $base64 = pack_type SCHEMA2001, 'base64Binary';
my $hex = pack_type SCHEMA2001, 'hexBinary';
sub _hex_length($)
{ my $ref = shift;
my $enc = $$ref =~ tr/0-9a-fA-F//;
$enc >> 1;
}
sub _s_length($$$$$$)
{ my ($path, $args, $len, $type, $nss, $action) = @_;
if($action eq 'WRITER' && $nss->doesExtend($type, $base64))
{ # it is a pitty that this is called after formatting... now the
# size check is expensive.
return sub
{ defined $_[0]
or error __x"base64 data missing at {where}", where => $path;
my $size = decoded_base64_length $_[0];
return $_[0] if $size == $len;
error __x"base64 data does not have required length {len}, but {has} at {where}"
, len => $len, has => $size, where => $path;
};
}
if($action eq 'WRITER' && $nss->doesExtend($type, $hex))
{ return sub
{ defined $_[0]
or error __x"hex data missing at {where}", where => $path;
my $size = _hex_length \$_[0];
return $_[0] if $size == $len;
error __x"hex data does not have required length {len}, but {has} at {where}"
, len => $len, has => $size, where => $path;
};
}
sub { return $_[0] if defined $_[0] && length($_[0])==$len;
error __x"string `{string}' does not have required length {len} but {size} at {where}"
, string => $_[0], len => $len, size => length($_[0]), where => $path;
};
}
sub _l_length($$$)
{ my ($path, $args, $len) = @_;
sub { return $_[0] if defined $_[0] && @{$_[0]}==$len;
error __x"list `{list}' does not have required length {len} at {where}"
, list => $_[0], len => $len, where => $path;
};
}
sub _s_minLength($$$)
{ my ($path, $args, $len, $type, $nss, $action) = @_;
if($action eq 'WRITER' && $nss->doesExtend($type, $base64))
{ return sub
{ defined $_[0]
or error __x"base64 data missing at {where}", where => $path;
my $size = decoded_base64_length $_[0];
return $_[0] if $size >= $len;
error __x"base64 data does not have minimal length {len}, but {has} at {where}"
, len => $len, has => $size, where => $path;
};
}
if($action eq 'WRITER' && $nss->doesExtend($type, $hex))
{ return sub
{ defined $_[0]
or error __x"hex data missing at {where}", where => $path;
my $size = _hex_length \$_[0];
return $_[0] if $size >= $len;
error __x"hex data does not have minimal length {len}, but {has} at {where}"
, len => $len, has => $size, where => $path;
};
}
sub { return $_[0] if defined $_[0] && length($_[0]) >=$len;
error __x"string `{string}' does not have minimum length {len} at {where}"
, string => $_[0], len => $len, where => $path;
};
}
sub _l_minLength($$$)
{ my ($path, $args, $len) = @_;
sub { return $_[0] if defined $_[0] && @{$_[0]} >=$len;
error __x"list `{list}' does not have minimum length {len} at {where}"
, list => $_[0], len => $len, where => $path;
};
}
sub _s_maxLength($$$)
{ my ($path, $args, $len, $type, $nss, $action) = @_;
if($action eq 'WRITER' && $nss->doesExtend($type, $base64))
{ return sub
{ defined $_[0]
or error __x"base64 data missing at {where}", where => $path;
my $size = decoded_base64_length $_[0];
return $_[0] if $size <= $len;
error __x"base64 data longer than maximum length {len}, but {has} at {where}"
, len => $len, has => $size, where => $path;
};
}
if($action eq 'WRITER' && $nss->doesExtend($type, $hex))
{ return sub
{ defined $_[0]
or error __x"hex data missing at {where}", where => $path;
my $size = _hex_length \$_[0];
return $_[0] if $size >= $len;
error __x"hex data longer than maximum length {len}, but {has} at {where}"
, len => $len, has => $size, where => $path;
};
}
sub { return $_[0] if defined $_[0] && length $_[0] <= $len;
error __x"string `{string}' longer than maximum length {len} at {where}"
, string => $_[0], len => $len, where => $path;
};
}
sub _l_maxLength($$$)
{ my ($path, $args, $len) = @_;
sub { return $_[0] if defined $_[0] && @{$_[0]} <= $len;
error __x"list `{list}' longer than maximum length {len} at {where}"
, list => $_[0], len => $len, where => $path;
};
}
sub _pattern($$$)
{ my ($path, $args, $pats) = @_;
@$pats or return ();
my $regex = @$pats==1 ? $pats->[0] : "(".join(')|(', @$pats).")";
my $compiled = XML::LibXML::RegExp->new($regex);
sub { return $_[0] if $compiled->matches($_[0]);
error __x"string `{string}' does not match pattern `{pat}' at {where}"
, string => $_[0], pat => $regex, where => $path;
};
}
sub _d_min($$$)
{ my ($path, $args, $min) = @_;
sub { return $_[0] if $_[0] gt $min;
error __x"too small inclusive {value}, min {min} at {where}"
, value => $_[0], min => $min, where => $path;
};
}
sub _d_max($$$)
{ my ($path, $args, $min) = @_;
sub { return $_[0] if $_[0] lt $min;
error __x"too large inclusive {value}, min {min} at {where}"
, value => $_[0], min => $min, where => $path;
};
}
1;