ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/JSON-XS/XS.pm
(Generate patch)

Comparing JSON-XS/XS.pm (file contents):
Revision 1.119 by root, Sun Feb 22 10:13:16 2009 UTC vs.
Revision 1.128 by root, Tue Jan 19 00:31:13 2010 UTC

99 99
100=cut 100=cut
101 101
102package JSON::XS; 102package JSON::XS;
103 103
104no warnings; 104use common::sense;
105use strict;
106 105
107our $VERSION = '2.232'; 106our $VERSION = '2.28';
108our @ISA = qw(Exporter); 107our @ISA = qw(Exporter);
109 108
110our @EXPORT = qw(encode_json decode_json to_json from_json); 109our @EXPORT = qw(encode_json decode_json to_json from_json);
111 110
112sub to_json($) { 111sub to_json($) {
441the same JSON text (given the same overall settings). If it is disabled, 440the same JSON text (given the same overall settings). If it is disabled,
442the same hash might be encoded differently even if contains the same data, 441the same hash might be encoded differently even if contains the same data,
443as key-value pairs have no inherent ordering in Perl. 442as key-value pairs have no inherent ordering in Perl.
444 443
445This setting has no effect when decoding JSON texts. 444This setting has no effect when decoding JSON texts.
445
446This setting has currently no effect on tied hashes.
446 447
447=item $json = $json->allow_nonref ([$enable]) 448=item $json = $json->allow_nonref ([$enable])
448 449
449=item $enabled = $json->get_allow_nonref 450=item $enabled = $json->get_allow_nonref
450 451
1267 my $yaml = $to_yaml->encode ($ref) . "\n"; 1268 my $yaml = $to_yaml->encode ($ref) . "\n";
1268 1269
1269This will I<usually> generate JSON texts that also parse as valid 1270This will I<usually> generate JSON texts that also parse as valid
1270YAML. Please note that YAML has hardcoded limits on (simple) object key 1271YAML. Please note that YAML has hardcoded limits on (simple) object key
1271lengths that JSON doesn't have and also has different and incompatible 1272lengths that JSON doesn't have and also has different and incompatible
1272unicode handling, so you should make sure that your hash keys are 1273unicode character escape syntax, so you should make sure that your hash
1273noticeably shorter than the 1024 "stream characters" YAML allows and that 1274keys are noticeably shorter than the 1024 "stream characters" YAML allows
1274you do not have characters with codepoint values outside the Unicode BMP 1275and that you do not have characters with codepoint values outside the
1275(basic multilingual page). YAML also does not allow C<\/> sequences in 1276Unicode BMP (basic multilingual page). YAML also does not allow C<\/>
1276strings (which JSON::XS does not I<currently> generate, but other JSON 1277sequences in strings (which JSON::XS does not I<currently> generate, but
1277generators might). 1278other JSON generators might).
1278 1279
1279There might be other incompatibilities that I am not aware of (or the YAML 1280There might be other incompatibilities that I am not aware of (or the YAML
1280specification has been changed yet again - it does so quite often). In 1281specification has been changed yet again - it does so quite often). In
1281general you should not try to generate YAML with a JSON generator or vice 1282general you should not try to generate YAML with a JSON generator or vice
1282versa, or try to parse JSON with a YAML parser or vice versa: chances are 1283versa, or try to parse JSON with a YAML parser or vice versa: chances are
1300proponents, I would kindly suggest reading the JSON spec (which is not 1301proponents, I would kindly suggest reading the JSON spec (which is not
1301that difficult or long) and finally make YAML compatible to it, and 1302that difficult or long) and finally make YAML compatible to it, and
1302educating users about the changes, instead of spreading lies about the 1303educating users about the changes, instead of spreading lies about the
1303real compatibility for many I<years> and trying to silence people who 1304real compatibility for many I<years> and trying to silence people who
1304point out that it isn't true. 1305point out that it isn't true.
1306
1307Addendum/2009: the YAML 1.2 spec is still incomaptible with JSON, even
1308though the incompatibilities have been documented (and are known to
1309Brian) for many years and the spec makes explicit claims that YAML is a
1310superset of JSON. It would be so easy to fix, but apparently, bullying and
1311corrupting userdata is so much easier.
1305 1312
1306=back 1313=back
1307 1314
1308 1315
1309=head2 SPEED 1316=head2 SPEED
1405information you might want to make sure that exceptions thrown by JSON::XS 1412information you might want to make sure that exceptions thrown by JSON::XS
1406will not end up in front of untrusted eyes. 1413will not end up in front of untrusted eyes.
1407 1414
1408If you are using JSON::XS to return packets to consumption 1415If you are using JSON::XS to return packets to consumption
1409by JavaScript scripts in a browser you should have a look at 1416by JavaScript scripts in a browser you should have a look at
1410L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether 1417L<http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/> to
1411you are vulnerable to some common attack vectors (which really are browser 1418see whether you are vulnerable to some common attack vectors (which really
1412design bugs, but it is still you who will have to deal with it, as major 1419are browser design bugs, but it is still you who will have to deal with
1413browser developers care only for features, not about getting security 1420it, as major browser developers care only for features, not about getting
1414right). 1421security right).
1415 1422
1416 1423
1417=head1 THREADS 1424=head1 THREADS
1418 1425
1419This module is I<not> guaranteed to be thread safe and there are no 1426This module is I<not> guaranteed to be thread safe and there are no

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines