… | |
… | |
35 | |
35 | |
36 | This module converts Perl data structures to JSON and vice versa. Its |
36 | This module converts Perl data structures to JSON and vice versa. Its |
37 | primary goal is to be I<correct> and its secondary goal is to be |
37 | primary goal is to be I<correct> and its secondary goal is to be |
38 | I<fast>. To reach the latter goal it was written in C. |
38 | I<fast>. To reach the latter goal it was written in C. |
39 | |
39 | |
40 | Beginning with version 2.0 of the JSON module, when both JSON and |
|
|
41 | JSON::XS are installed, then JSON will fall back on JSON::XS (this can be |
|
|
42 | overridden) with no overhead due to emulation (by inheriting constructor |
|
|
43 | and methods). If JSON::XS is not available, it will fall back to the |
|
|
44 | compatible JSON::PP module as backend, so using JSON instead of JSON::XS |
|
|
45 | gives you a portable JSON API that can be fast when you need it and |
|
|
46 | doesn't require a C compiler when that is a problem. |
|
|
47 | |
|
|
48 | As this is the n-th-something JSON module on CPAN, what was the reason |
|
|
49 | to write yet another JSON module? While it seems there are many JSON |
|
|
50 | modules, none of them correctly handle all corner cases, and in most cases |
|
|
51 | their maintainers are unresponsive, gone missing, or not listening to bug |
|
|
52 | reports for other reasons. |
|
|
53 | |
|
|
54 | See MAPPING, below, on how JSON::XS maps perl values to JSON values and |
40 | See MAPPING, below, on how JSON::XS maps perl values to JSON values and |
55 | vice versa. |
41 | vice versa. |
56 | |
42 | |
57 | =head2 FEATURES |
43 | =head2 FEATURES |
58 | |
44 | |
59 | =over 4 |
45 | =over |
60 | |
46 | |
61 | =item * correct Unicode handling |
47 | =item * correct Unicode handling |
62 | |
48 | |
63 | This module knows how to handle Unicode, documents how and when it does |
49 | This module knows how to handle Unicode, documents how and when it does |
64 | so, and even documents what "correct" means. |
50 | so, and even documents what "correct" means. |
… | |
… | |
101 | |
87 | |
102 | package JSON::XS; |
88 | package JSON::XS; |
103 | |
89 | |
104 | use common::sense; |
90 | use common::sense; |
105 | |
91 | |
106 | our $VERSION = 3.04; |
92 | our $VERSION = '4.0'; |
107 | our @ISA = qw(Exporter); |
93 | our @ISA = qw(Exporter); |
108 | |
94 | |
109 | our @EXPORT = qw(encode_json decode_json); |
95 | our @EXPORT = qw(encode_json decode_json); |
110 | |
96 | |
111 | use Exporter; |
97 | use Exporter; |
… | |
… | |
116 | =head1 FUNCTIONAL INTERFACE |
102 | =head1 FUNCTIONAL INTERFACE |
117 | |
103 | |
118 | The following convenience methods are provided by this module. They are |
104 | The following convenience methods are provided by this module. They are |
119 | exported by default: |
105 | exported by default: |
120 | |
106 | |
121 | =over 4 |
107 | =over |
122 | |
108 | |
123 | =item $json_text = encode_json $perl_scalar |
109 | =item $json_text = encode_json $perl_scalar |
124 | |
110 | |
125 | Converts the given Perl data structure to a UTF-8 encoded, binary string |
111 | Converts the given Perl data structure to a UTF-8 encoded, binary string |
126 | (that is, the string contains octets only). Croaks on error. |
112 | (that is, the string contains octets only). Croaks on error. |
… | |
… | |
149 | =head1 A FEW NOTES ON UNICODE AND PERL |
135 | =head1 A FEW NOTES ON UNICODE AND PERL |
150 | |
136 | |
151 | Since this often leads to confusion, here are a few very clear words on |
137 | Since this often leads to confusion, here are a few very clear words on |
152 | how Unicode works in Perl, modulo bugs. |
138 | how Unicode works in Perl, modulo bugs. |
153 | |
139 | |
154 | =over 4 |
140 | =over |
155 | |
141 | |
156 | =item 1. Perl strings can store characters with ordinal values > 255. |
142 | =item 1. Perl strings can store characters with ordinal values > 255. |
157 | |
143 | |
158 | This enables you to store Unicode characters as single characters in a |
144 | This enables you to store Unicode characters as single characters in a |
159 | Perl string - very natural. |
145 | Perl string - very natural. |
… | |
… | |
197 | =head1 OBJECT-ORIENTED INTERFACE |
183 | =head1 OBJECT-ORIENTED INTERFACE |
198 | |
184 | |
199 | The object oriented interface lets you configure your own encoding or |
185 | The object oriented interface lets you configure your own encoding or |
200 | decoding style, within the limits of supported formats. |
186 | decoding style, within the limits of supported formats. |
201 | |
187 | |
202 | =over 4 |
188 | =over |
203 | |
189 | |
204 | =item $json = new JSON::XS |
190 | =item $json = new JSON::XS |
205 | |
191 | |
206 | Creates a new JSON::XS object that can be used to de/encode JSON |
192 | Creates a new JSON::XS object that can be used to de/encode JSON |
207 | strings. All boolean flags described below are by default I<disabled> |
193 | strings. All boolean flags described below are by default I<disabled> |
… | |
… | |
377 | If C<$enable> is false (the default), then C<decode> will only accept |
363 | If C<$enable> is false (the default), then C<decode> will only accept |
378 | valid JSON texts. |
364 | valid JSON texts. |
379 | |
365 | |
380 | Currently accepted extensions are: |
366 | Currently accepted extensions are: |
381 | |
367 | |
382 | =over 4 |
368 | =over |
383 | |
369 | |
384 | =item * list items can have an end-comma |
370 | =item * list items can have an end-comma |
385 | |
371 | |
386 | JSON I<separates> array elements and key-value pairs with commas. This |
372 | JSON I<separates> array elements and key-value pairs with commas. This |
387 | can be annoying if you write JSON texts manually and want to be able to |
373 | can be annoying if you write JSON texts manually and want to be able to |
… | |
… | |
729 | to set resource limits (e.g. C<max_size>) to ensure the parser will stop |
715 | to set resource limits (e.g. C<max_size>) to ensure the parser will stop |
730 | parsing in the presence if syntax errors. |
716 | parsing in the presence if syntax errors. |
731 | |
717 | |
732 | The following methods implement this incremental parser. |
718 | The following methods implement this incremental parser. |
733 | |
719 | |
734 | =over 4 |
720 | =over |
735 | |
721 | |
736 | =item [void, scalar or list context] = $json->incr_parse ([$string]) |
722 | =item [void, scalar or list context] = $json->incr_parse ([$string]) |
737 | |
723 | |
738 | This is the central parsing function. It can both append new text and |
724 | This is the central parsing function. It can both append new text and |
739 | extract objects from the stream accumulated so far (both of these |
725 | extract objects from the stream accumulated so far (both of these |
… | |
… | |
806 | |
792 | |
807 | =back |
793 | =back |
808 | |
794 | |
809 | =head2 LIMITATIONS |
795 | =head2 LIMITATIONS |
810 | |
796 | |
811 | All options that affect decoding are supported, except |
797 | The incremental parser is a non-exact parser: it works by gathering as |
812 | C<allow_nonref>. The reason for this is that it cannot be made to work |
798 | much text as possible that I<could> be a valid JSON text, followed by |
813 | sensibly: JSON objects and arrays are self-delimited, i.e. you can |
799 | trying to decode it. |
814 | concatenate them back to back and still decode them perfectly. This does |
|
|
815 | not hold true for JSON numbers, however. |
|
|
816 | |
800 | |
817 | For example, is the string C<1> a single JSON number, or is it simply the |
801 | That means it sometimes needs to read more data than strictly necessary to |
818 | start of C<12>? Or is C<12> a single JSON number, or the concatenation |
802 | diagnose an invalid JSON text. For example, after parsing the following |
819 | of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS |
803 | fragment, the parser I<could> stop with an error, as this fragment |
820 | takes the conservative route and disallows this case. |
804 | I<cannot> be the beginning of a valid JSON text: |
|
|
805 | |
|
|
806 | [, |
|
|
807 | |
|
|
808 | In reality, hopwever, the parser might continue to read data until a |
|
|
809 | length limit is exceeded or it finds a closing bracket. |
821 | |
810 | |
822 | =head2 EXAMPLES |
811 | =head2 EXAMPLES |
823 | |
812 | |
824 | Some examples will make all this clearer. First, a simple example that |
813 | Some examples will make all this clearer. First, a simple example that |
825 | works similarly to C<decode_prefix>: We want to decode the JSON object at |
814 | works similarly to C<decode_prefix>: We want to decode the JSON object at |
… | |
… | |
969 | refers to the abstract Perl language itself. |
958 | refers to the abstract Perl language itself. |
970 | |
959 | |
971 | |
960 | |
972 | =head2 JSON -> PERL |
961 | =head2 JSON -> PERL |
973 | |
962 | |
974 | =over 4 |
963 | =over |
975 | |
964 | |
976 | =item object |
965 | =item object |
977 | |
966 | |
978 | A JSON object becomes a reference to a hash in Perl. No ordering of object |
967 | A JSON object becomes a reference to a hash in Perl. No ordering of object |
979 | keys is preserved (JSON does not preserve object key ordering itself). |
968 | keys is preserved (JSON does not preserve object key ordering itself). |
… | |
… | |
1047 | |
1036 | |
1048 | The mapping from Perl to JSON is slightly more difficult, as Perl is a |
1037 | The mapping from Perl to JSON is slightly more difficult, as Perl is a |
1049 | truly typeless language, so we can only guess which JSON type is meant by |
1038 | truly typeless language, so we can only guess which JSON type is meant by |
1050 | a Perl value. |
1039 | a Perl value. |
1051 | |
1040 | |
1052 | =over 4 |
1041 | =over |
1053 | |
1042 | |
1054 | =item hash references |
1043 | =item hash references |
1055 | |
1044 | |
1056 | Perl hash references become JSON objects. As there is no inherent |
1045 | Perl hash references become JSON objects. As there is no inherent |
1057 | ordering in hash keys (or JSON objects), they will usually be encoded |
1046 | ordering in hash keys (or JSON objects), they will usually be encoded |
… | |
… | |
1146 | |
1135 | |
1147 | What happens when C<JSON::XS> encounters a Perl object depends on the |
1136 | What happens when C<JSON::XS> encounters a Perl object depends on the |
1148 | C<allow_blessed>, C<convert_blessed> and C<allow_tags> settings, which are |
1137 | C<allow_blessed>, C<convert_blessed> and C<allow_tags> settings, which are |
1149 | used in this order: |
1138 | used in this order: |
1150 | |
1139 | |
1151 | =over 4 |
1140 | =over |
1152 | |
1141 | |
1153 | =item 1. C<allow_tags> is enabled and the object has a C<FREEZE> method. |
1142 | =item 1. C<allow_tags> is enabled and the object has a C<FREEZE> method. |
1154 | |
1143 | |
1155 | In this case, C<JSON::XS> uses the L<Types::Serialiser> object |
1144 | In this case, C<JSON::XS> uses the L<Types::Serialiser> object |
1156 | serialisation protocol to create a tagged JSON value, using a nonstandard |
1145 | serialisation protocol to create a tagged JSON value, using a nonstandard |
… | |
… | |
1267 | takes those codepoint numbers and I<encodes> them, in our case into |
1256 | takes those codepoint numbers and I<encodes> them, in our case into |
1268 | octets. Unicode is (among other things) a codeset, UTF-8 is an encoding, |
1257 | octets. Unicode is (among other things) a codeset, UTF-8 is an encoding, |
1269 | and ISO-8859-1 (= latin 1) and ASCII are both codesets I<and> encodings at |
1258 | and ISO-8859-1 (= latin 1) and ASCII are both codesets I<and> encodings at |
1270 | the same time, which can be confusing. |
1259 | the same time, which can be confusing. |
1271 | |
1260 | |
1272 | =over 4 |
1261 | =over |
1273 | |
1262 | |
1274 | =item C<utf8> flag disabled |
1263 | =item C<utf8> flag disabled |
1275 | |
1264 | |
1276 | When C<utf8> is disabled (the default), then C<encode>/C<decode> generate |
1265 | When C<utf8> is disabled (the default), then C<encode>/C<decode> generate |
1277 | and expect Unicode strings, that is, characters with high ordinal Unicode |
1266 | and expect Unicode strings, that is, characters with high ordinal Unicode |
… | |
… | |
1436 | general you should not try to generate YAML with a JSON generator or vice |
1425 | general you should not try to generate YAML with a JSON generator or vice |
1437 | versa, or try to parse JSON with a YAML parser or vice versa: chances are |
1426 | versa, or try to parse JSON with a YAML parser or vice versa: chances are |
1438 | high that you will run into severe interoperability problems when you |
1427 | high that you will run into severe interoperability problems when you |
1439 | least expect it. |
1428 | least expect it. |
1440 | |
1429 | |
1441 | =over 4 |
1430 | =over |
1442 | |
1431 | |
1443 | =item (*) |
1432 | =item (*) |
1444 | |
1433 | |
1445 | I have been pressured multiple times by Brian Ingerson (one of the |
1434 | I have been pressured multiple times by Brian Ingerson (one of the |
1446 | authors of the YAML specification) to remove this paragraph, despite him |
1435 | authors of the YAML specification) to remove this paragraph, despite him |
… | |
… | |
1572 | are browser design bugs, but it is still you who will have to deal with |
1561 | are browser design bugs, but it is still you who will have to deal with |
1573 | it, as major browser developers care only for features, not about getting |
1562 | it, as major browser developers care only for features, not about getting |
1574 | security right). |
1563 | security right). |
1575 | |
1564 | |
1576 | |
1565 | |
1577 | =head2 "OLD" VS. "NEW" JSON (RFC 4627 VS. RFC 7159) |
1566 | =head2 "OLD" VS. "NEW" JSON (RFC4627 VS. RFC7159) |
1578 | |
1567 | |
1579 | JSON originally required JSON texts to represent an array or object - |
1568 | JSON originally required JSON texts to represent an array or object - |
1580 | scalar values were explicitly not allowed. This has changed, and versions |
1569 | scalar values were explicitly not allowed. This has changed, and versions |
1581 | of JSON::XS beginning with C<4.0> reflect this by allowing scalar values |
1570 | of JSON::XS beginning with C<4.0> reflect this by allowing scalar values |
1582 | by default. |
1571 | by default. |
… | |
… | |
1612 | |
1601 | |
1613 | This is a somewhat unhappy situation, and the blame can fully be put on |
1602 | This is a somewhat unhappy situation, and the blame can fully be put on |
1614 | JSON's inmventor, Douglas Crockford, who unilaterally changed the format |
1603 | JSON's inmventor, Douglas Crockford, who unilaterally changed the format |
1615 | in 2006 without consulting the IETF, forcing the IETF to either fork the |
1604 | in 2006 without consulting the IETF, forcing the IETF to either fork the |
1616 | format or go with it (as I was told, the IETF wasn't amused). |
1605 | format or go with it (as I was told, the IETF wasn't amused). |
|
|
1606 | |
|
|
1607 | |
|
|
1608 | =head1 RELATIONSHIP WITH I-JSON |
|
|
1609 | |
|
|
1610 | JSON is a somewhat sloppily-defined format - it carries around obvious |
|
|
1611 | Javascript baggage, such as not really defining number range, probably |
|
|
1612 | because Javascript only has one type of numbers: IEEE 64 bit floats |
|
|
1613 | ("binary64"). |
|
|
1614 | |
|
|
1615 | For this reaosn, RFC7493 defines "Internet JSON", which is a restricted |
|
|
1616 | subset of JSON that is supposedly more interoperable on the internet. |
|
|
1617 | |
|
|
1618 | While C<JSON::XS> does not offer specific support for I-JSON, it of course |
|
|
1619 | accepts valid I-JSON and by default implements some of the limitations |
|
|
1620 | of I-JSON, such as parsing numbers as perl numbers, which are usually a |
|
|
1621 | superset of binary64 numbers. |
|
|
1622 | |
|
|
1623 | To generate I-JSON, follow these rules: |
|
|
1624 | |
|
|
1625 | =over |
|
|
1626 | |
|
|
1627 | =item * always generate UTF-8 |
|
|
1628 | |
|
|
1629 | I-JSON must be encoded in UTF-8, the default for C<encode_json>. |
|
|
1630 | |
|
|
1631 | =item * numbers should be within IEEE 754 binary64 range |
|
|
1632 | |
|
|
1633 | Basically all existing perl installations use binary64 to represent |
|
|
1634 | floating point numbers, so all you need to do is to avoid large integers. |
|
|
1635 | |
|
|
1636 | =item * objects must not have duplicate keys |
|
|
1637 | |
|
|
1638 | This is trivially done, as C<JSON::XS> does not allow duplicate keys. |
|
|
1639 | |
|
|
1640 | =item * do not generate scalar JSON texts, use C<< ->allow_nonref (0) >> |
|
|
1641 | |
|
|
1642 | I-JSON strongly requests you to only encode arrays and objects into JSON. |
|
|
1643 | |
|
|
1644 | =item * times should be strings in ISO 8601 format |
|
|
1645 | |
|
|
1646 | There are a myriad of modules on CPAN dealing with ISO 8601 - search for |
|
|
1647 | C<ISO8601> on CPAN and use one. |
|
|
1648 | |
|
|
1649 | =item * encode binary data as base64 |
|
|
1650 | |
|
|
1651 | While it's tempting to just dump binary data as a string (and let |
|
|
1652 | C<JSON::XS> do the escaping), for I-JSON, it's I<recommended> to encode |
|
|
1653 | binary data as base64. |
|
|
1654 | |
|
|
1655 | =back |
|
|
1656 | |
|
|
1657 | There are some other considerations - read RFC7493 for the details if |
|
|
1658 | interested. |
1617 | |
1659 | |
1618 | |
1660 | |
1619 | =head1 INTEROPERABILITY WITH OTHER MODULES |
1661 | =head1 INTEROPERABILITY WITH OTHER MODULES |
1620 | |
1662 | |
1621 | C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean |
1663 | C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean |
… | |
… | |
1684 | |
1726 | |
1685 | Again, this has some limitations - the magic string must not be encoded |
1727 | Again, this has some limitations - the magic string must not be encoded |
1686 | with character escapes, and the constructor arguments must be non-empty. |
1728 | with character escapes, and the constructor arguments must be non-empty. |
1687 | |
1729 | |
1688 | |
1730 | |
1689 | =head1 RFC7159 |
|
|
1690 | |
|
|
1691 | Since this module was written, Google has written a new JSON RFC, RFC 7159 |
|
|
1692 | (and RFC7158). Unfortunately, this RFC breaks compatibility with both the |
|
|
1693 | original JSON specification on www.json.org and RFC4627. |
|
|
1694 | |
|
|
1695 | As far as I can see, you can get partial compatibility when parsing by |
|
|
1696 | using C<< ->allow_nonref >>. However, consider the security implications |
|
|
1697 | of doing so. |
|
|
1698 | |
|
|
1699 | I haven't decided yet when to break compatibility with RFC4627 by default |
|
|
1700 | (and potentially leave applications insecure) and change the default to |
|
|
1701 | follow RFC7159, but application authors are well advised to call C<< |
|
|
1702 | ->allow_nonref(0) >> even if this is the current default, if they cannot |
|
|
1703 | handle non-reference values, in preparation for the day when the default |
|
|
1704 | will change. |
|
|
1705 | |
|
|
1706 | |
|
|
1707 | =head1 (I-)THREADS |
1731 | =head1 (I-)THREADS |
1708 | |
1732 | |
1709 | This module is I<not> guaranteed to be ithread (or MULTIPLICITY-) safe |
1733 | This module is I<not> guaranteed to be ithread (or MULTIPLICITY-) safe |
1710 | and there are no plans to change this. Note that perl's builtin so-called |
1734 | and there are no plans to change this. Note that perl's builtin so-called |
1711 | threads/ithreads are officially deprecated and should not be used. |
1735 | threads/ithreads are officially deprecated and should not be used. |
… | |
… | |
1725 | categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>. |
1749 | categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>. |
1726 | |
1750 | |
1727 | If you need C<LC_NUMERIC>, you should enable it only around the code that |
1751 | If you need C<LC_NUMERIC>, you should enable it only around the code that |
1728 | actually needs it (avoiding stringification of numbers), and restore it |
1752 | actually needs it (avoiding stringification of numbers), and restore it |
1729 | afterwards. |
1753 | afterwards. |
|
|
1754 | |
|
|
1755 | |
|
|
1756 | =head1 SOME HISTORY |
|
|
1757 | |
|
|
1758 | At the time this module was created there already were a number of JSON |
|
|
1759 | modules available on CPAN, so what was the reason to write yet another |
|
|
1760 | JSON module? While it seems there are many JSON modules, none of them |
|
|
1761 | correctly handled all corner cases, and in most cases their maintainers |
|
|
1762 | are unresponsive, gone missing, or not listening to bug reports for other |
|
|
1763 | reasons. |
|
|
1764 | |
|
|
1765 | Beginning with version 2.0 of the JSON module, when both JSON and |
|
|
1766 | JSON::XS are installed, then JSON will fall back on JSON::XS (this can be |
|
|
1767 | overridden) with no overhead due to emulation (by inheriting constructor |
|
|
1768 | and methods). If JSON::XS is not available, it will fall back to the |
|
|
1769 | compatible JSON::PP module as backend, so using JSON instead of JSON::XS |
|
|
1770 | gives you a portable JSON API that can be fast when you need it and |
|
|
1771 | doesn't require a C compiler when that is a problem. |
|
|
1772 | |
|
|
1773 | Somewhere around version 3, this module was forked into |
|
|
1774 | C<Cpanel::JSON::XS>, because its maintainer had serious trouble |
|
|
1775 | understanding JSON and insisted on a fork with many bugs "fixed" that |
|
|
1776 | weren't actually bugs, while spreading FUD about this module without |
|
|
1777 | actually giving any details on his accusations. You be the judge, but |
|
|
1778 | in my personal opinion, if you want quality, you will stay away from |
|
|
1779 | dangerous forks like that. |
1730 | |
1780 | |
1731 | |
1781 | |
1732 | =head1 BUGS |
1782 | =head1 BUGS |
1733 | |
1783 | |
1734 | While the goal of this module is to be correct, that unfortunately does |
1784 | While the goal of this module is to be correct, that unfortunately does |