--- CBOR-XS/XS.pm 2013/12/01 16:40:25 1.35 +++ CBOR-XS/XS.pm 2016/04/25 18:20:22 1.53 @@ -66,7 +66,7 @@ use common::sense; -our $VERSION = 1.11; +our $VERSION = 1.41; our @ISA = qw(Exporter); our @EXPORT = qw(encode_cbor decode_cbor); @@ -220,8 +220,13 @@ If C<$enable> is false (the default), then C will throw an error when it encounters a self-referential/cyclic data structure. +FUTURE DIRECTION: the motivation behind this option is to avoid I +cycles - future versions of this module might chose to decode cyclic data +structures using weak references when this option is off, instead of +throwing an error. + This option does not affect C in any way - shared values and -references will always be decoded properly if present. +references will always be encoded properly if present. =item $cbor = $cbor->pack_strings ([$enable]) @@ -244,6 +249,50 @@ This option does not affect C in any way - string references will always be decoded properly if present. +=item $cbor = $cbor->text_keys ([$enable]) + +=item $enabled = $cbor->get_text_keys + +If C<$enabled> is true (or missing), then C will encode all +perl hash keys as CBOR text strings/UTF-8 string, upgrading them as needed. + +If C<$enable> is false (the default), then C will encode hash keys +normally - upgraded perl strings (strings internally encoded as UTF-8) as +CBOR text strings, and downgraded perl strings as CBOR byte strings. + +This option does not affect C in any way. + +This option is useful for interoperability with CBOR decoders that don't +treat byte strings as a form of text. It is especially useful as Perl +gives very little control over hash keys. + +Enabling this option can be slow, as all downgraded hash keys that are +encoded need to be scanned and converted to UTF-8. + +=item $cbor = $cbor->text_strings ([$enable]) + +=item $enabled = $cbor->get_text_strings + +This option works similar to C, above, but works on all strings +(including hash keys), so C has no further effect after +enabling C. + +If C<$enabled> is true (or missing), then C will encode all perl +strings as CBOR text strings/UTF-8 strings, upgrading them as needed. + +If C<$enable> is false (the default), then C will encode strings +normally (but see C) - upgraded perl strings (strings +internally encoded as UTF-8) as CBOR text strings, and downgraded perl +strings as CBOR byte strings. + +This option does not affect C in any way. + +This option has similar advantages and disadvantages as C. In +addition, this option effectively removes the ability to encode byte +strings, which might break some C and C methods that rely +on this, such as bignum encoding, so this option is mainly useful for very +simple data. + =item $cbor = $cbor->validate_utf8 ([$enable]) =item $enabled = $cbor->get_validate_utf8 @@ -258,7 +307,7 @@ If C<$enable> is false (the default), then C will blindly accept UTF-8 data, marking them as valid UTF-8 in the resulting data structure -regardless of whether thats true or not. +regardless of whether that's true or not. Perl isn't too happy about corrupted UTF-8 in strings, but should generally not crash or do similarly evil things. Extensions might be not @@ -335,6 +384,70 @@ =back +=head2 INCREMENTAL PARSING + +In some cases, there is the need for incremental parsing of JSON +texts. While this module always has to keep both CBOR text and resulting +Perl data structure in memory at one time, it does allow you to parse a +CBOR stream incrementally, using a similar to using "decode_prefix" to see +if a full CBOR object is available, but is much more efficient. + +It basically works by parsing as much of a CBOR string as possible - if +the CBOR data is not complete yet, the pasrer will remember where it was, +to be able to restart when more data has been accumulated. Once enough +data is available to either decode a complete CBOR value or raise an +error, a real decode will be attempted. + +A typical use case would be a network protocol that consists of sending +and receiving CBOR-encoded messages. The solution that works with CBOR and +about anything else is by prepending a length to every CBOR value, so the +receiver knows how many octets to read. More compact (and slightly slower) +would be to just send CBOR values back-to-back, as C knows where +a CBOR value ends, and doesn't need an explicit length. + +The following methods help with this: + +=over 4 + +=item @decoded = $cbor->incr_parse ($buffer) + +This method attempts to decode exactly one CBOR value from the beginning +of the given C<$buffer>. The value is removed from the C<$buffer> on +success. When C<$buffer> doesn't contain a complete value yet, it returns +nothing. Finally, when the C<$buffer> doesn't start with something +that could ever be a valid CBOR value, it raises an exception, just as +C would. In the latter case the decoder state is undefined and +must be reset before being able to parse further. + +This method modifies the C<$buffer> in place. When no CBOR value can be +decoded, the decoder stores the current string offset. On the next call, +continues decoding at the place where it stopped before. For this to make +sense, the C<$buffer> must begin with the same octets as on previous +unsuccessful calls. + +You can call this method in scalar context, in which case it either +returns a decoded value or C. This makes it impossible to +distinguish between CBOR null values (which decode to C) and an +unsuccessful decode, which is often acceptable. + +=item @decoded = $cbor->incr_parse_multiple ($buffer) + +Same as C, but attempts to decode as many CBOR values as +possible in one go, instead of at most one. Calls to C and +C can be interleaved. + +=item $cbor->incr_reset + +Resets the incremental decoder. This throws away any saved state, so that +subsequent calls to C or C start to parse +a new CBOR value from the beginning of the C<$buffer> again. + +This method can be caled at any time, but it I be called if you want +to change your C<$buffer> or there was a decoding error and you want to +reuse the C<$cbor> object for future incremental parsings. + +=back + =head1 MAPPING @@ -414,7 +527,7 @@ Perl hash references become CBOR maps. As there is no inherent ordering in hash keys (or CBOR maps), they will usually be encoded in a pseudo-random -order. This order can be different each time a hahs is encoded. +order. This order can be different each time a hash is encoded. Currently, tied hashes will use the indefinite-length format, while normal hashes will use the fixed-length format. @@ -477,15 +590,16 @@ $x .= ""; # another, more awkward way to stringify print $x; # perl does it for you, too, quite often -You can force whether a string ie encoded as byte or text string by using -C and C): +You can force whether a string is encoded as byte or text string by using +C and C (if C is disabled): utf8::upgrade $x; # encode $x as text string utf8::downgrade $x; # encode $x as byte string Perl doesn't define what operations up- and downgrade strings, so if the difference between byte and text is important, you should up- or downgrade -your string as late as possible before encoding. +your string as late as possible before encoding. You can also force the +use of CBOR text strings by using C or C. You can force the type to be a CBOR number by numifying it: @@ -596,7 +710,6 @@ sub URI::THAW { my ($class, $serialiser, $uri) = @_; - $class->new ($uri) } @@ -737,7 +850,7 @@ =head2 ENFORCED TAGS These tags are always handled when decoding, and their handling cannot be -overriden by the user. +overridden by the user. =over 4 @@ -747,7 +860,7 @@ objects using the C methods (the L object serialisation protocol). See L for details. -=item 28, 29 (shareable, sharedref, L ) +=item 28, 29 (shareable, sharedref, L) These tags are automatically decoded when encountered (and they do not result in a cyclic data structure, see C), resulting in @@ -767,7 +880,7 @@ to be supported in the encoder. The decoder, however, will decode these values as shared values. -=item 256, 25 (stringref-namespace, stringref, L ) +=item 256, 25 (stringref-namespace, stringref, L) These tags are automatically decoded when encountered. They are only encoded, however, when C is enabled. @@ -775,7 +888,7 @@ =item 22098 (indirection, L) This tag is automatically generated when a reference are encountered (with -the exception of hash and array refernces). It is converted to a reference +the exception of hash and array references). It is converted to a reference when decoding. =item 55799 (self-describe CBOR, RFC 7049) @@ -788,7 +901,7 @@ =head2 NON-ENFORCED TAGS These tags have default filters provided when decoding. Their handling can -be overriden by changing the C<%CBOR::XS::FILTER> entry for the tag, or by +be overridden by changing the C<%CBOR::XS::FILTER> entry for the tag, or by providing a custom C callback when decoding. When they result in decoding into a specific Perl class, the module @@ -841,48 +954,6 @@ =cut -our %FILTER = ( - # 0 # rfc4287 datetime, utf-8 - # 1 # unix timestamp, any - - 2 => sub { # pos bigint - require Math::BigInt; - Math::BigInt->new ("0x" . unpack "H*", pop) - }, - - 3 => sub { # neg bigint - require Math::BigInt; - -Math::BigInt->new ("0x" . unpack "H*", pop) - }, - - 4 => sub { # decimal fraction, array - require Math::BigFloat; - Math::BigFloat->new ($_[1][1] . "E" . $_[1][0]) - }, - - 5 => sub { # bigfloat, array - require Math::BigFloat; - scalar Math::BigFloat->new ($_[1][1])->blsft ($_[1][0], 2) - }, - - 21 => sub { pop }, # expected conversion to base64url encoding - 22 => sub { pop }, # expected conversion to base64 encoding - 23 => sub { pop }, # expected conversion to base16 encoding - - # 24 # embedded cbor, byte string - - 32 => sub { - require URI; - URI->new (pop) - }, - - # 33 # base64url rfc4648, utf-8 - # 34 # base64 rfc46484, utf-8 - # 35 # regex pcre/ecma262, utf-8 - # 36 # mime message rfc2045, utf-8 -); - - =head1 CBOR and JSON CBOR is supposed to implement a superset of the JSON data model, and is, @@ -955,7 +1026,8 @@ =head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT On perls that were built without 64 bit integer support (these are rare -nowadays, even on 32 bit architectures), support for any kind of 64 bit +nowadays, even on 32 bit architectures, as all major Perl distributions +are built with 64 bit integer support), support for any kind of 64 bit integer in CBOR is very limited - most likely, these 64 bit values will be truncated, corrupted, or otherwise not decoded correctly. This also includes string, array and map sizes that are stored as 64 bit integers. @@ -989,18 +1061,20 @@ # from FreeBSD, which can't parse ISO 8601, RFC3339, RFC4287 or much of anything # else either. Whats incredibe over standard strptime totally escapes me. # doesn't do fractional times, either. sigh. + # In fact, it's all a lie, it uses whatever strptime it wants, and of course, + # they are all incompatible. The openbsd one simply ignores %z (but according to the + # docs, it would be much more incredibly flexible indeed. If it worked, that is.). scalar eval { my $s = $_[1]; $s =~ s/Z$/+00:00/; - $s =~ s/(\.[0-9]+)?([+-][0-9][0-9]):([0-9][0-9])/$2$3/ + $s =~ s/(\.[0-9]+)?([+-][0-9][0-9]):([0-9][0-9])$// or die; - my $f = $1; # fractional part. hopefully - - my $d = Time::Piece->strptime ($s, "%Y-%m-%dT%H:%M:%S%z"); + my $b = $1 - ($2 * 60 + $3) * 60; # fractional part + offset. hopefully + my $d = Time::Piece->strptime ($s, "%Y-%m-%dT%H:%M:%S"); - Time::Piece::gmtime ($d->epoch + $f) + Time::Piece::gmtime ($d->epoch + $b) } || die "corrupted CBOR date/time string ($_[0])"; }, @@ -1026,7 +1100,7 @@ 5 => sub { # bigfloat, array require Math::BigFloat; - scalar Math::BigFloat->new ($_[1][1])->blsft ($_[1][0], 2) + scalar Math::BigFloat->new ($_[1][1]) * Math::BigFloat->new (2)->bpow ($_[1][0]) }, 21 => sub { pop }, # expected conversion to base64url encoding @@ -1072,7 +1146,7 @@ } sub Time::Piece::TO_CBOR { - tag 1, $_[0]->epoch + tag 1, 0 + $_[0]->epoch } XSLoader::load "CBOR::XS", $VERSION;