1 |
root |
1.84 |
=encoding utf-8 |
2 |
|
|
|
3 |
root |
1.1 |
=head1 NAME |
4 |
|
|
|
5 |
|
|
JSON::XS - JSON serialising/deserialising, done correctly and fast |
6 |
|
|
|
7 |
root |
1.62 |
JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ |
8 |
|
|
(http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html) |
9 |
|
|
|
10 |
root |
1.1 |
=head1 SYNOPSIS |
11 |
|
|
|
12 |
|
|
use JSON::XS; |
13 |
|
|
|
14 |
root |
1.22 |
# exported functions, they croak on error |
15 |
|
|
# and expect/generate UTF-8 |
16 |
root |
1.12 |
|
17 |
root |
1.78 |
$utf8_encoded_json_text = encode_json $perl_hash_or_arrayref; |
18 |
|
|
$perl_hash_or_arrayref = decode_json $utf8_encoded_json_text; |
19 |
root |
1.12 |
|
20 |
root |
1.22 |
# OO-interface |
21 |
root |
1.12 |
|
22 |
|
|
$coder = JSON::XS->new->ascii->pretty->allow_nonref; |
23 |
|
|
$pretty_printed_unencoded = $coder->encode ($perl_scalar); |
24 |
|
|
$perl_scalar = $coder->decode ($unicode_json_text); |
25 |
|
|
|
26 |
root |
1.77 |
# Note that JSON version 2.0 and above will automatically use JSON::XS |
27 |
|
|
# if available, at virtually no speed overhead either, so you should |
28 |
|
|
# be able to just: |
29 |
|
|
|
30 |
|
|
use JSON; |
31 |
|
|
|
32 |
|
|
# and do the same things, except that you have a pure-perl fallback now. |
33 |
|
|
|
34 |
root |
1.1 |
=head1 DESCRIPTION |
35 |
|
|
|
36 |
root |
1.2 |
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 |
38 |
|
|
I<fast>. To reach the latter goal it was written in C. |
39 |
|
|
|
40 |
root |
1.77 |
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 |
|
|
overriden) with no overhead due to emulation (by inheritign 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 and doesn't |
46 |
|
|
require a C compiler when that is a problem. |
47 |
|
|
|
48 |
root |
1.2 |
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 COMPARISON, below, for a comparison to some other JSON modules. |
55 |
|
|
|
56 |
root |
1.10 |
See MAPPING, below, on how JSON::XS maps perl values to JSON values and |
57 |
|
|
vice versa. |
58 |
|
|
|
59 |
root |
1.2 |
=head2 FEATURES |
60 |
|
|
|
61 |
root |
1.1 |
=over 4 |
62 |
|
|
|
63 |
root |
1.68 |
=item * correct Unicode handling |
64 |
root |
1.2 |
|
65 |
root |
1.84 |
This module knows how to handle Unicode, documents how and when it does |
66 |
|
|
so, and even documents what "correct" means. |
67 |
root |
1.2 |
|
68 |
|
|
=item * round-trip integrity |
69 |
|
|
|
70 |
|
|
When you serialise a perl data structure using only datatypes supported |
71 |
|
|
by JSON, the deserialised data structure is identical on the Perl level. |
72 |
root |
1.21 |
(e.g. the string "2.0" doesn't suddenly become "2" just because it looks |
73 |
root |
1.84 |
like a number). There minor I<are> exceptions to this, read the MAPPING |
74 |
|
|
section below to learn about those. |
75 |
root |
1.2 |
|
76 |
|
|
=item * strict checking of JSON correctness |
77 |
|
|
|
78 |
root |
1.16 |
There is no guessing, no generating of illegal JSON texts by default, |
79 |
root |
1.10 |
and only JSON is accepted as input by default (the latter is a security |
80 |
|
|
feature). |
81 |
root |
1.2 |
|
82 |
|
|
=item * fast |
83 |
|
|
|
84 |
root |
1.84 |
Compared to other JSON modules and other serialisers such as Storable, |
85 |
|
|
this module usually compares favourably in terms of speed, too. |
86 |
root |
1.2 |
|
87 |
|
|
=item * simple to use |
88 |
|
|
|
89 |
root |
1.84 |
This module has both a simple functional interface as well as an objetc |
90 |
|
|
oriented interface interface. |
91 |
root |
1.2 |
|
92 |
|
|
=item * reasonably versatile output formats |
93 |
|
|
|
94 |
root |
1.84 |
You can choose between the most compact guaranteed-single-line format |
95 |
root |
1.21 |
possible (nice for simple line-based protocols), a pure-ascii format |
96 |
|
|
(for when your transport is not 8-bit clean, still supports the whole |
97 |
root |
1.68 |
Unicode range), or a pretty-printed format (for when you want to read that |
98 |
root |
1.21 |
stuff). Or you can combine those features in whatever way you like. |
99 |
root |
1.2 |
|
100 |
|
|
=back |
101 |
|
|
|
102 |
root |
1.1 |
=cut |
103 |
|
|
|
104 |
|
|
package JSON::XS; |
105 |
|
|
|
106 |
root |
1.20 |
use strict; |
107 |
|
|
|
108 |
root |
1.78 |
our $VERSION = '2.01'; |
109 |
root |
1.43 |
our @ISA = qw(Exporter); |
110 |
root |
1.1 |
|
111 |
root |
1.78 |
our @EXPORT = qw(encode_json decode_json to_json from_json); |
112 |
|
|
|
113 |
|
|
sub to_json($) { |
114 |
|
|
require Carp; |
115 |
|
|
Carp::croak ("JSON::XS::to_json has been renamed to encode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call"); |
116 |
|
|
} |
117 |
|
|
|
118 |
|
|
sub from_json($) { |
119 |
|
|
require Carp; |
120 |
|
|
Carp::croak ("JSON::XS::from_json has been renamed to decode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call"); |
121 |
|
|
} |
122 |
root |
1.1 |
|
123 |
root |
1.43 |
use Exporter; |
124 |
|
|
use XSLoader; |
125 |
root |
1.1 |
|
126 |
root |
1.2 |
=head1 FUNCTIONAL INTERFACE |
127 |
|
|
|
128 |
root |
1.68 |
The following convenience methods are provided by this module. They are |
129 |
root |
1.2 |
exported by default: |
130 |
|
|
|
131 |
|
|
=over 4 |
132 |
|
|
|
133 |
root |
1.78 |
=item $json_text = encode_json $perl_scalar |
134 |
root |
1.2 |
|
135 |
root |
1.63 |
Converts the given Perl data structure to a UTF-8 encoded, binary string |
136 |
|
|
(that is, the string contains octets only). Croaks on error. |
137 |
root |
1.2 |
|
138 |
root |
1.16 |
This function call is functionally identical to: |
139 |
root |
1.2 |
|
140 |
root |
1.16 |
$json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
141 |
|
|
|
142 |
|
|
except being faster. |
143 |
|
|
|
144 |
root |
1.78 |
=item $perl_scalar = decode_json $json_text |
145 |
root |
1.2 |
|
146 |
root |
1.78 |
The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries |
147 |
root |
1.63 |
to parse that as an UTF-8 encoded JSON text, returning the resulting |
148 |
|
|
reference. Croaks on error. |
149 |
root |
1.2 |
|
150 |
root |
1.16 |
This function call is functionally identical to: |
151 |
|
|
|
152 |
|
|
$perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
153 |
|
|
|
154 |
|
|
except being faster. |
155 |
root |
1.2 |
|
156 |
root |
1.43 |
=item $is_boolean = JSON::XS::is_bool $scalar |
157 |
|
|
|
158 |
|
|
Returns true if the passed scalar represents either JSON::XS::true or |
159 |
|
|
JSON::XS::false, two constants that act like C<1> and C<0>, respectively |
160 |
|
|
and are used to represent JSON C<true> and C<false> values in Perl. |
161 |
|
|
|
162 |
|
|
See MAPPING, below, for more information on how JSON values are mapped to |
163 |
|
|
Perl. |
164 |
|
|
|
165 |
root |
1.2 |
=back |
166 |
|
|
|
167 |
root |
1.23 |
|
168 |
root |
1.63 |
=head1 A FEW NOTES ON UNICODE AND PERL |
169 |
|
|
|
170 |
|
|
Since this often leads to confusion, here are a few very clear words on |
171 |
|
|
how Unicode works in Perl, modulo bugs. |
172 |
|
|
|
173 |
|
|
=over 4 |
174 |
|
|
|
175 |
|
|
=item 1. Perl strings can store characters with ordinal values > 255. |
176 |
|
|
|
177 |
root |
1.68 |
This enables you to store Unicode characters as single characters in a |
178 |
root |
1.63 |
Perl string - very natural. |
179 |
|
|
|
180 |
|
|
=item 2. Perl does I<not> associate an encoding with your strings. |
181 |
|
|
|
182 |
root |
1.84 |
... until you force it to, e.g. when matching it against a regex, or |
183 |
|
|
printing the scalar to a file, in which case Perl either interprets your |
184 |
|
|
string as locale-encoded text, octets/binary, or as Unicode, depending |
185 |
|
|
on various settings. In no case is an encoding stored together with your |
186 |
|
|
data, it is I<use> that decides encoding, not any magical meta data. |
187 |
root |
1.63 |
|
188 |
|
|
=item 3. The internal utf-8 flag has no meaning with regards to the |
189 |
|
|
encoding of your string. |
190 |
|
|
|
191 |
|
|
Just ignore that flag unless you debug a Perl bug, a module written in |
192 |
|
|
XS or want to dive into the internals of perl. Otherwise it will only |
193 |
|
|
confuse you, as, despite the name, it says nothing about how your string |
194 |
root |
1.68 |
is encoded. You can have Unicode strings with that flag set, with that |
195 |
root |
1.63 |
flag clear, and you can have binary data with that flag set and that flag |
196 |
|
|
clear. Other possibilities exist, too. |
197 |
|
|
|
198 |
|
|
If you didn't know about that flag, just the better, pretend it doesn't |
199 |
|
|
exist. |
200 |
|
|
|
201 |
|
|
=item 4. A "Unicode String" is simply a string where each character can be |
202 |
|
|
validly interpreted as a Unicode codepoint. |
203 |
|
|
|
204 |
|
|
If you have UTF-8 encoded data, it is no longer a Unicode string, but a |
205 |
|
|
Unicode string encoded in UTF-8, giving you a binary string. |
206 |
|
|
|
207 |
|
|
=item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string. |
208 |
|
|
|
209 |
root |
1.68 |
It's a fact. Learn to live with it. |
210 |
root |
1.63 |
|
211 |
|
|
=back |
212 |
|
|
|
213 |
|
|
I hope this helps :) |
214 |
|
|
|
215 |
|
|
|
216 |
root |
1.2 |
=head1 OBJECT-ORIENTED INTERFACE |
217 |
|
|
|
218 |
|
|
The object oriented interface lets you configure your own encoding or |
219 |
|
|
decoding style, within the limits of supported formats. |
220 |
|
|
|
221 |
|
|
=over 4 |
222 |
|
|
|
223 |
|
|
=item $json = new JSON::XS |
224 |
|
|
|
225 |
|
|
Creates a new JSON::XS object that can be used to de/encode JSON |
226 |
|
|
strings. All boolean flags described below are by default I<disabled>. |
227 |
root |
1.1 |
|
228 |
root |
1.2 |
The mutators for flags all return the JSON object again and thus calls can |
229 |
|
|
be chained: |
230 |
|
|
|
231 |
root |
1.16 |
my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]}) |
232 |
root |
1.3 |
=> {"a": [1, 2]} |
233 |
root |
1.2 |
|
234 |
root |
1.7 |
=item $json = $json->ascii ([$enable]) |
235 |
root |
1.2 |
|
236 |
root |
1.72 |
=item $enabled = $json->get_ascii |
237 |
|
|
|
238 |
root |
1.16 |
If C<$enable> is true (or missing), then the C<encode> method will not |
239 |
|
|
generate characters outside the code range C<0..127> (which is ASCII). Any |
240 |
root |
1.68 |
Unicode characters outside that range will be escaped using either a |
241 |
root |
1.16 |
single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, |
242 |
root |
1.32 |
as per RFC4627. The resulting encoded JSON text can be treated as a native |
243 |
root |
1.68 |
Unicode string, an ascii-encoded, latin1-encoded or UTF-8 encoded string, |
244 |
root |
1.32 |
or any other superset of ASCII. |
245 |
root |
1.2 |
|
246 |
|
|
If C<$enable> is false, then the C<encode> method will not escape Unicode |
247 |
root |
1.33 |
characters unless required by the JSON syntax or other flags. This results |
248 |
|
|
in a faster and more compact format. |
249 |
|
|
|
250 |
|
|
The main use for this flag is to produce JSON texts that can be |
251 |
|
|
transmitted over a 7-bit channel, as the encoded JSON texts will not |
252 |
|
|
contain any 8 bit characters. |
253 |
root |
1.2 |
|
254 |
root |
1.16 |
JSON::XS->new->ascii (1)->encode ([chr 0x10401]) |
255 |
|
|
=> ["\ud801\udc01"] |
256 |
root |
1.3 |
|
257 |
root |
1.33 |
=item $json = $json->latin1 ([$enable]) |
258 |
|
|
|
259 |
root |
1.72 |
=item $enabled = $json->get_latin1 |
260 |
|
|
|
261 |
root |
1.33 |
If C<$enable> is true (or missing), then the C<encode> method will encode |
262 |
|
|
the resulting JSON text as latin1 (or iso-8859-1), escaping any characters |
263 |
|
|
outside the code range C<0..255>. The resulting string can be treated as a |
264 |
root |
1.68 |
latin1-encoded JSON text or a native Unicode string. The C<decode> method |
265 |
root |
1.33 |
will not be affected in any way by this flag, as C<decode> by default |
266 |
root |
1.68 |
expects Unicode, which is a strict superset of latin1. |
267 |
root |
1.33 |
|
268 |
|
|
If C<$enable> is false, then the C<encode> method will not escape Unicode |
269 |
|
|
characters unless required by the JSON syntax or other flags. |
270 |
|
|
|
271 |
|
|
The main use for this flag is efficiently encoding binary data as JSON |
272 |
|
|
text, as most octets will not be escaped, resulting in a smaller encoded |
273 |
|
|
size. The disadvantage is that the resulting JSON text is encoded |
274 |
|
|
in latin1 (and must correctly be treated as such when storing and |
275 |
root |
1.68 |
transferring), a rare encoding for JSON. It is therefore most useful when |
276 |
root |
1.33 |
you want to store data structures known to contain binary data efficiently |
277 |
|
|
in files or databases, not when talking to other JSON encoders/decoders. |
278 |
|
|
|
279 |
|
|
JSON::XS->new->latin1->encode (["\x{89}\x{abc}"] |
280 |
|
|
=> ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not) |
281 |
|
|
|
282 |
root |
1.7 |
=item $json = $json->utf8 ([$enable]) |
283 |
root |
1.2 |
|
284 |
root |
1.72 |
=item $enabled = $json->get_utf8 |
285 |
|
|
|
286 |
root |
1.7 |
If C<$enable> is true (or missing), then the C<encode> method will encode |
287 |
root |
1.16 |
the JSON result into UTF-8, as required by many protocols, while the |
288 |
root |
1.7 |
C<decode> method expects to be handled an UTF-8-encoded string. Please |
289 |
|
|
note that UTF-8-encoded strings do not contain any characters outside the |
290 |
root |
1.16 |
range C<0..255>, they are thus useful for bytewise/binary I/O. In future |
291 |
|
|
versions, enabling this option might enable autodetection of the UTF-16 |
292 |
|
|
and UTF-32 encoding families, as described in RFC4627. |
293 |
root |
1.2 |
|
294 |
|
|
If C<$enable> is false, then the C<encode> method will return the JSON |
295 |
root |
1.68 |
string as a (non-encoded) Unicode string, while C<decode> expects thus a |
296 |
|
|
Unicode string. Any decoding or encoding (e.g. to UTF-8 or UTF-16) needs |
297 |
root |
1.2 |
to be done yourself, e.g. using the Encode module. |
298 |
|
|
|
299 |
root |
1.16 |
Example, output UTF-16BE-encoded JSON: |
300 |
|
|
|
301 |
|
|
use Encode; |
302 |
|
|
$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object); |
303 |
|
|
|
304 |
|
|
Example, decode UTF-32LE-encoded JSON: |
305 |
|
|
|
306 |
|
|
use Encode; |
307 |
|
|
$object = JSON::XS->new->decode (decode "UTF-32LE", $jsontext); |
308 |
root |
1.12 |
|
309 |
root |
1.7 |
=item $json = $json->pretty ([$enable]) |
310 |
root |
1.2 |
|
311 |
|
|
This enables (or disables) all of the C<indent>, C<space_before> and |
312 |
root |
1.3 |
C<space_after> (and in the future possibly more) flags in one call to |
313 |
root |
1.2 |
generate the most readable (or most compact) form possible. |
314 |
|
|
|
315 |
root |
1.12 |
Example, pretty-print some simple structure: |
316 |
|
|
|
317 |
root |
1.3 |
my $json = JSON::XS->new->pretty(1)->encode ({a => [1,2]}) |
318 |
|
|
=> |
319 |
|
|
{ |
320 |
|
|
"a" : [ |
321 |
|
|
1, |
322 |
|
|
2 |
323 |
|
|
] |
324 |
|
|
} |
325 |
|
|
|
326 |
root |
1.7 |
=item $json = $json->indent ([$enable]) |
327 |
root |
1.2 |
|
328 |
root |
1.72 |
=item $enabled = $json->get_indent |
329 |
|
|
|
330 |
root |
1.7 |
If C<$enable> is true (or missing), then the C<encode> method will use a multiline |
331 |
root |
1.2 |
format as output, putting every array member or object/hash key-value pair |
332 |
root |
1.68 |
into its own line, indenting them properly. |
333 |
root |
1.2 |
|
334 |
|
|
If C<$enable> is false, no newlines or indenting will be produced, and the |
335 |
root |
1.68 |
resulting JSON text is guaranteed not to contain any C<newlines>. |
336 |
root |
1.2 |
|
337 |
root |
1.16 |
This setting has no effect when decoding JSON texts. |
338 |
root |
1.2 |
|
339 |
root |
1.7 |
=item $json = $json->space_before ([$enable]) |
340 |
root |
1.2 |
|
341 |
root |
1.72 |
=item $enabled = $json->get_space_before |
342 |
|
|
|
343 |
root |
1.7 |
If C<$enable> is true (or missing), then the C<encode> method will add an extra |
344 |
root |
1.2 |
optional space before the C<:> separating keys from values in JSON objects. |
345 |
|
|
|
346 |
|
|
If C<$enable> is false, then the C<encode> method will not add any extra |
347 |
|
|
space at those places. |
348 |
|
|
|
349 |
root |
1.16 |
This setting has no effect when decoding JSON texts. You will also |
350 |
|
|
most likely combine this setting with C<space_after>. |
351 |
root |
1.2 |
|
352 |
root |
1.12 |
Example, space_before enabled, space_after and indent disabled: |
353 |
|
|
|
354 |
|
|
{"key" :"value"} |
355 |
|
|
|
356 |
root |
1.7 |
=item $json = $json->space_after ([$enable]) |
357 |
root |
1.2 |
|
358 |
root |
1.72 |
=item $enabled = $json->get_space_after |
359 |
|
|
|
360 |
root |
1.7 |
If C<$enable> is true (or missing), then the C<encode> method will add an extra |
361 |
root |
1.2 |
optional space after the C<:> separating keys from values in JSON objects |
362 |
|
|
and extra whitespace after the C<,> separating key-value pairs and array |
363 |
|
|
members. |
364 |
|
|
|
365 |
|
|
If C<$enable> is false, then the C<encode> method will not add any extra |
366 |
|
|
space at those places. |
367 |
|
|
|
368 |
root |
1.16 |
This setting has no effect when decoding JSON texts. |
369 |
root |
1.2 |
|
370 |
root |
1.12 |
Example, space_before and indent disabled, space_after enabled: |
371 |
|
|
|
372 |
|
|
{"key": "value"} |
373 |
|
|
|
374 |
root |
1.59 |
=item $json = $json->relaxed ([$enable]) |
375 |
|
|
|
376 |
root |
1.72 |
=item $enabled = $json->get_relaxed |
377 |
|
|
|
378 |
root |
1.59 |
If C<$enable> is true (or missing), then C<decode> will accept some |
379 |
|
|
extensions to normal JSON syntax (see below). C<encode> will not be |
380 |
|
|
affected in anyway. I<Be aware that this option makes you accept invalid |
381 |
|
|
JSON texts as if they were valid!>. I suggest only to use this option to |
382 |
|
|
parse application-specific files written by humans (configuration files, |
383 |
|
|
resource files etc.) |
384 |
|
|
|
385 |
|
|
If C<$enable> is false (the default), then C<decode> will only accept |
386 |
|
|
valid JSON texts. |
387 |
|
|
|
388 |
|
|
Currently accepted extensions are: |
389 |
|
|
|
390 |
|
|
=over 4 |
391 |
|
|
|
392 |
|
|
=item * list items can have an end-comma |
393 |
|
|
|
394 |
|
|
JSON I<separates> array elements and key-value pairs with commas. This |
395 |
|
|
can be annoying if you write JSON texts manually and want to be able to |
396 |
|
|
quickly append elements, so this extension accepts comma at the end of |
397 |
|
|
such items not just between them: |
398 |
|
|
|
399 |
|
|
[ |
400 |
|
|
1, |
401 |
|
|
2, <- this comma not normally allowed |
402 |
|
|
] |
403 |
|
|
{ |
404 |
|
|
"k1": "v1", |
405 |
|
|
"k2": "v2", <- this comma not normally allowed |
406 |
|
|
} |
407 |
|
|
|
408 |
root |
1.60 |
=item * shell-style '#'-comments |
409 |
|
|
|
410 |
|
|
Whenever JSON allows whitespace, shell-style comments are additionally |
411 |
|
|
allowed. They are terminated by the first carriage-return or line-feed |
412 |
|
|
character, after which more white-space and comments are allowed. |
413 |
|
|
|
414 |
|
|
[ |
415 |
|
|
1, # this comment not allowed in JSON |
416 |
|
|
# neither this one... |
417 |
|
|
] |
418 |
|
|
|
419 |
root |
1.59 |
=back |
420 |
|
|
|
421 |
root |
1.7 |
=item $json = $json->canonical ([$enable]) |
422 |
root |
1.2 |
|
423 |
root |
1.72 |
=item $enabled = $json->get_canonical |
424 |
|
|
|
425 |
root |
1.7 |
If C<$enable> is true (or missing), then the C<encode> method will output JSON objects |
426 |
root |
1.2 |
by sorting their keys. This is adding a comparatively high overhead. |
427 |
|
|
|
428 |
|
|
If C<$enable> is false, then the C<encode> method will output key-value |
429 |
|
|
pairs in the order Perl stores them (which will likely change between runs |
430 |
|
|
of the same script). |
431 |
|
|
|
432 |
|
|
This option is useful if you want the same data structure to be encoded as |
433 |
root |
1.16 |
the same JSON text (given the same overall settings). If it is disabled, |
434 |
root |
1.68 |
the same hash might be encoded differently even if contains the same data, |
435 |
root |
1.2 |
as key-value pairs have no inherent ordering in Perl. |
436 |
|
|
|
437 |
root |
1.16 |
This setting has no effect when decoding JSON texts. |
438 |
root |
1.2 |
|
439 |
root |
1.7 |
=item $json = $json->allow_nonref ([$enable]) |
440 |
root |
1.3 |
|
441 |
root |
1.72 |
=item $enabled = $json->get_allow_nonref |
442 |
|
|
|
443 |
root |
1.7 |
If C<$enable> is true (or missing), then the C<encode> method can convert a |
444 |
root |
1.3 |
non-reference into its corresponding string, number or null JSON value, |
445 |
|
|
which is an extension to RFC4627. Likewise, C<decode> will accept those JSON |
446 |
|
|
values instead of croaking. |
447 |
|
|
|
448 |
|
|
If C<$enable> is false, then the C<encode> method will croak if it isn't |
449 |
root |
1.16 |
passed an arrayref or hashref, as JSON texts must either be an object |
450 |
root |
1.3 |
or array. Likewise, C<decode> will croak if given something that is not a |
451 |
|
|
JSON object or array. |
452 |
|
|
|
453 |
root |
1.12 |
Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>, |
454 |
|
|
resulting in an invalid JSON text: |
455 |
|
|
|
456 |
|
|
JSON::XS->new->allow_nonref->encode ("Hello, World!") |
457 |
|
|
=> "Hello, World!" |
458 |
|
|
|
459 |
root |
1.44 |
=item $json = $json->allow_blessed ([$enable]) |
460 |
|
|
|
461 |
root |
1.75 |
=item $enabled = $json->get_allow_blessed |
462 |
root |
1.72 |
|
463 |
root |
1.44 |
If C<$enable> is true (or missing), then the C<encode> method will not |
464 |
|
|
barf when it encounters a blessed reference. Instead, the value of the |
465 |
root |
1.68 |
B<convert_blessed> option will decide whether C<null> (C<convert_blessed> |
466 |
root |
1.76 |
disabled or no C<TO_JSON> method found) or a representation of the |
467 |
|
|
object (C<convert_blessed> enabled and C<TO_JSON> method found) is being |
468 |
root |
1.44 |
encoded. Has no effect on C<decode>. |
469 |
|
|
|
470 |
|
|
If C<$enable> is false (the default), then C<encode> will throw an |
471 |
|
|
exception when it encounters a blessed object. |
472 |
|
|
|
473 |
|
|
=item $json = $json->convert_blessed ([$enable]) |
474 |
|
|
|
475 |
root |
1.72 |
=item $enabled = $json->get_convert_blessed |
476 |
|
|
|
477 |
root |
1.44 |
If C<$enable> is true (or missing), then C<encode>, upon encountering a |
478 |
|
|
blessed object, will check for the availability of the C<TO_JSON> method |
479 |
|
|
on the object's class. If found, it will be called in scalar context |
480 |
|
|
and the resulting scalar will be encoded instead of the object. If no |
481 |
|
|
C<TO_JSON> method is found, the value of C<allow_blessed> will decide what |
482 |
|
|
to do. |
483 |
|
|
|
484 |
|
|
The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON> |
485 |
|
|
returns other blessed objects, those will be handled in the same |
486 |
|
|
way. C<TO_JSON> must take care of not causing an endless recursion cycle |
487 |
|
|
(== crash) in this case. The name of C<TO_JSON> was chosen because other |
488 |
root |
1.46 |
methods called by the Perl core (== not by the user of the object) are |
489 |
root |
1.78 |
usually in upper case letters and to avoid collisions with any C<to_json> |
490 |
|
|
function or method. |
491 |
root |
1.44 |
|
492 |
root |
1.45 |
This setting does not yet influence C<decode> in any way, but in the |
493 |
|
|
future, global hooks might get installed that influence C<decode> and are |
494 |
|
|
enabled by this setting. |
495 |
|
|
|
496 |
root |
1.44 |
If C<$enable> is false, then the C<allow_blessed> setting will decide what |
497 |
|
|
to do when a blessed object is found. |
498 |
|
|
|
499 |
root |
1.52 |
=item $json = $json->filter_json_object ([$coderef->($hashref)]) |
500 |
root |
1.51 |
|
501 |
|
|
When C<$coderef> is specified, it will be called from C<decode> each |
502 |
|
|
time it decodes a JSON object. The only argument is a reference to the |
503 |
|
|
newly-created hash. If the code references returns a single scalar (which |
504 |
|
|
need not be a reference), this value (i.e. a copy of that scalar to avoid |
505 |
|
|
aliasing) is inserted into the deserialised data structure. If it returns |
506 |
|
|
an empty list (NOTE: I<not> C<undef>, which is a valid scalar), the |
507 |
|
|
original deserialised hash will be inserted. This setting can slow down |
508 |
|
|
decoding considerably. |
509 |
|
|
|
510 |
root |
1.52 |
When C<$coderef> is omitted or undefined, any existing callback will |
511 |
|
|
be removed and C<decode> will not change the deserialised hash in any |
512 |
|
|
way. |
513 |
root |
1.51 |
|
514 |
|
|
Example, convert all JSON objects into the integer 5: |
515 |
|
|
|
516 |
|
|
my $js = JSON::XS->new->filter_json_object (sub { 5 }); |
517 |
|
|
# returns [5] |
518 |
|
|
$js->decode ('[{}]') |
519 |
root |
1.52 |
# throw an exception because allow_nonref is not enabled |
520 |
|
|
# so a lone 5 is not allowed. |
521 |
root |
1.51 |
$js->decode ('{"a":1, "b":2}'); |
522 |
|
|
|
523 |
root |
1.52 |
=item $json = $json->filter_json_single_key_object ($key [=> $coderef->($value)]) |
524 |
root |
1.51 |
|
525 |
root |
1.52 |
Works remotely similar to C<filter_json_object>, but is only called for |
526 |
|
|
JSON objects having a single key named C<$key>. |
527 |
root |
1.51 |
|
528 |
|
|
This C<$coderef> is called before the one specified via |
529 |
root |
1.52 |
C<filter_json_object>, if any. It gets passed the single value in the JSON |
530 |
|
|
object. If it returns a single value, it will be inserted into the data |
531 |
|
|
structure. If it returns nothing (not even C<undef> but the empty list), |
532 |
|
|
the callback from C<filter_json_object> will be called next, as if no |
533 |
|
|
single-key callback were specified. |
534 |
|
|
|
535 |
|
|
If C<$coderef> is omitted or undefined, the corresponding callback will be |
536 |
|
|
disabled. There can only ever be one callback for a given key. |
537 |
root |
1.51 |
|
538 |
|
|
As this callback gets called less often then the C<filter_json_object> |
539 |
|
|
one, decoding speed will not usually suffer as much. Therefore, single-key |
540 |
|
|
objects make excellent targets to serialise Perl objects into, especially |
541 |
|
|
as single-key JSON objects are as close to the type-tagged value concept |
542 |
root |
1.68 |
as JSON gets (it's basically an ID/VALUE tuple). Of course, JSON does not |
543 |
root |
1.51 |
support this in any way, so you need to make sure your data never looks |
544 |
|
|
like a serialised Perl hash. |
545 |
|
|
|
546 |
|
|
Typical names for the single object key are C<__class_whatever__>, or |
547 |
|
|
C<$__dollars_are_rarely_used__$> or C<}ugly_brace_placement>, or even |
548 |
|
|
things like C<__class_md5sum(classname)__>, to reduce the risk of clashing |
549 |
|
|
with real hashes. |
550 |
|
|
|
551 |
|
|
Example, decode JSON objects of the form C<< { "__widget__" => <id> } >> |
552 |
|
|
into the corresponding C<< $WIDGET{<id>} >> object: |
553 |
|
|
|
554 |
|
|
# return whatever is in $WIDGET{5}: |
555 |
|
|
JSON::XS |
556 |
|
|
->new |
557 |
root |
1.52 |
->filter_json_single_key_object (__widget__ => sub { |
558 |
|
|
$WIDGET{ $_[0] } |
559 |
root |
1.51 |
}) |
560 |
|
|
->decode ('{"__widget__": 5') |
561 |
|
|
|
562 |
|
|
# this can be used with a TO_JSON method in some "widget" class |
563 |
|
|
# for serialisation to json: |
564 |
|
|
sub WidgetBase::TO_JSON { |
565 |
|
|
my ($self) = @_; |
566 |
|
|
|
567 |
|
|
unless ($self->{id}) { |
568 |
|
|
$self->{id} = ..get..some..id..; |
569 |
|
|
$WIDGET{$self->{id}} = $self; |
570 |
|
|
} |
571 |
|
|
|
572 |
|
|
{ __widget__ => $self->{id} } |
573 |
|
|
} |
574 |
|
|
|
575 |
root |
1.7 |
=item $json = $json->shrink ([$enable]) |
576 |
|
|
|
577 |
root |
1.72 |
=item $enabled = $json->get_shrink |
578 |
|
|
|
579 |
root |
1.7 |
Perl usually over-allocates memory a bit when allocating space for |
580 |
root |
1.24 |
strings. This flag optionally resizes strings generated by either |
581 |
root |
1.7 |
C<encode> or C<decode> to their minimum size possible. This can save |
582 |
root |
1.16 |
memory when your JSON texts are either very very long or you have many |
583 |
root |
1.8 |
short strings. It will also try to downgrade any strings to octet-form |
584 |
|
|
if possible: perl stores strings internally either in an encoding called |
585 |
|
|
UTF-X or in octet-form. The latter cannot store everything but uses less |
586 |
root |
1.24 |
space in general (and some buggy Perl or C code might even rely on that |
587 |
|
|
internal representation being used). |
588 |
root |
1.7 |
|
589 |
root |
1.24 |
The actual definition of what shrink does might change in future versions, |
590 |
|
|
but it will always try to save space at the expense of time. |
591 |
|
|
|
592 |
|
|
If C<$enable> is true (or missing), the string returned by C<encode> will |
593 |
|
|
be shrunk-to-fit, while all strings generated by C<decode> will also be |
594 |
|
|
shrunk-to-fit. |
595 |
root |
1.7 |
|
596 |
|
|
If C<$enable> is false, then the normal perl allocation algorithms are used. |
597 |
|
|
If you work with your data, then this is likely to be faster. |
598 |
|
|
|
599 |
|
|
In the future, this setting might control other things, such as converting |
600 |
|
|
strings that look like integers or floats into integers or floats |
601 |
|
|
internally (there is no difference on the Perl level), saving space. |
602 |
|
|
|
603 |
root |
1.23 |
=item $json = $json->max_depth ([$maximum_nesting_depth]) |
604 |
|
|
|
605 |
root |
1.72 |
=item $max_depth = $json->get_max_depth |
606 |
|
|
|
607 |
root |
1.28 |
Sets the maximum nesting level (default C<512>) accepted while encoding |
608 |
root |
1.23 |
or decoding. If the JSON text or Perl data structure has an equal or |
609 |
|
|
higher nesting level then this limit, then the encoder and decoder will |
610 |
|
|
stop and croak at that point. |
611 |
|
|
|
612 |
|
|
Nesting level is defined by number of hash- or arrayrefs that the encoder |
613 |
|
|
needs to traverse to reach a given point or the number of C<{> or C<[> |
614 |
|
|
characters without their matching closing parenthesis crossed to reach a |
615 |
|
|
given character in a string. |
616 |
|
|
|
617 |
|
|
Setting the maximum depth to one disallows any nesting, so that ensures |
618 |
|
|
that the object is only a single hash/object or array. |
619 |
|
|
|
620 |
root |
1.47 |
The argument to C<max_depth> will be rounded up to the next highest power |
621 |
|
|
of two. If no argument is given, the highest possible setting will be |
622 |
|
|
used, which is rarely useful. |
623 |
|
|
|
624 |
|
|
See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
625 |
|
|
|
626 |
|
|
=item $json = $json->max_size ([$maximum_string_size]) |
627 |
|
|
|
628 |
root |
1.72 |
=item $max_size = $json->get_max_size |
629 |
|
|
|
630 |
root |
1.47 |
Set the maximum length a JSON text may have (in bytes) where decoding is |
631 |
|
|
being attempted. The default is C<0>, meaning no limit. When C<decode> |
632 |
|
|
is called on a string longer then this number of characters it will not |
633 |
|
|
attempt to decode the string but throw an exception. This setting has no |
634 |
|
|
effect on C<encode> (yet). |
635 |
|
|
|
636 |
|
|
The argument to C<max_size> will be rounded up to the next B<highest> |
637 |
|
|
power of two (so may be more than requested). If no argument is given, the |
638 |
|
|
limit check will be deactivated (same as when C<0> is specified). |
639 |
root |
1.23 |
|
640 |
|
|
See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
641 |
|
|
|
642 |
root |
1.16 |
=item $json_text = $json->encode ($perl_scalar) |
643 |
root |
1.2 |
|
644 |
|
|
Converts the given Perl data structure (a simple scalar or a reference |
645 |
|
|
to a hash or array) to its JSON representation. Simple scalars will be |
646 |
|
|
converted into JSON string or number sequences, while references to arrays |
647 |
|
|
become JSON arrays and references to hashes become JSON objects. Undefined |
648 |
|
|
Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true> |
649 |
|
|
nor C<false> values will be generated. |
650 |
root |
1.1 |
|
651 |
root |
1.16 |
=item $perl_scalar = $json->decode ($json_text) |
652 |
root |
1.1 |
|
653 |
root |
1.16 |
The opposite of C<encode>: expects a JSON text and tries to parse it, |
654 |
root |
1.2 |
returning the resulting simple scalar or reference. Croaks on error. |
655 |
root |
1.1 |
|
656 |
root |
1.2 |
JSON numbers and strings become simple Perl scalars. JSON arrays become |
657 |
|
|
Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
658 |
|
|
C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
659 |
root |
1.1 |
|
660 |
root |
1.34 |
=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text) |
661 |
|
|
|
662 |
|
|
This works like the C<decode> method, but instead of raising an exception |
663 |
|
|
when there is trailing garbage after the first JSON object, it will |
664 |
|
|
silently stop parsing there and return the number of characters consumed |
665 |
|
|
so far. |
666 |
|
|
|
667 |
|
|
This is useful if your JSON texts are not delimited by an outer protocol |
668 |
|
|
(which is not the brightest thing to do in the first place) and you need |
669 |
|
|
to know where the JSON text ends. |
670 |
|
|
|
671 |
|
|
JSON::XS->new->decode_prefix ("[1] the tail") |
672 |
|
|
=> ([], 3) |
673 |
|
|
|
674 |
root |
1.1 |
=back |
675 |
|
|
|
676 |
root |
1.23 |
|
677 |
root |
1.10 |
=head1 MAPPING |
678 |
|
|
|
679 |
|
|
This section describes how JSON::XS maps Perl values to JSON values and |
680 |
|
|
vice versa. These mappings are designed to "do the right thing" in most |
681 |
|
|
circumstances automatically, preserving round-tripping characteristics |
682 |
|
|
(what you put in comes out as something equivalent). |
683 |
|
|
|
684 |
|
|
For the more enlightened: note that in the following descriptions, |
685 |
root |
1.68 |
lowercase I<perl> refers to the Perl interpreter, while uppercase I<Perl> |
686 |
root |
1.10 |
refers to the abstract Perl language itself. |
687 |
|
|
|
688 |
root |
1.39 |
|
689 |
root |
1.10 |
=head2 JSON -> PERL |
690 |
|
|
|
691 |
|
|
=over 4 |
692 |
|
|
|
693 |
|
|
=item object |
694 |
|
|
|
695 |
|
|
A JSON object becomes a reference to a hash in Perl. No ordering of object |
696 |
root |
1.68 |
keys is preserved (JSON does not preserve object key ordering itself). |
697 |
root |
1.10 |
|
698 |
|
|
=item array |
699 |
|
|
|
700 |
|
|
A JSON array becomes a reference to an array in Perl. |
701 |
|
|
|
702 |
|
|
=item string |
703 |
|
|
|
704 |
|
|
A JSON string becomes a string scalar in Perl - Unicode codepoints in JSON |
705 |
|
|
are represented by the same codepoints in the Perl string, so no manual |
706 |
|
|
decoding is necessary. |
707 |
|
|
|
708 |
|
|
=item number |
709 |
|
|
|
710 |
root |
1.56 |
A JSON number becomes either an integer, numeric (floating point) or |
711 |
|
|
string scalar in perl, depending on its range and any fractional parts. On |
712 |
|
|
the Perl level, there is no difference between those as Perl handles all |
713 |
|
|
the conversion details, but an integer may take slightly less memory and |
714 |
root |
1.84 |
might represent more values exactly than floating point numbers. |
715 |
root |
1.56 |
|
716 |
|
|
If the number consists of digits only, JSON::XS will try to represent |
717 |
|
|
it as an integer value. If that fails, it will try to represent it as |
718 |
|
|
a numeric (floating point) value if that is possible without loss of |
719 |
root |
1.84 |
precision. Otherwise it will preserve the number as a string value (in |
720 |
|
|
which case you lose roundtripping ability, as the JSON number will be |
721 |
|
|
re-encoded toa JSON string). |
722 |
root |
1.56 |
|
723 |
|
|
Numbers containing a fractional or exponential part will always be |
724 |
|
|
represented as numeric (floating point) values, possibly at a loss of |
725 |
root |
1.84 |
precision (in which case you might lose perfect roundtripping ability, but |
726 |
|
|
the JSON number will still be re-encoded as a JSON number). |
727 |
root |
1.10 |
|
728 |
|
|
=item true, false |
729 |
|
|
|
730 |
root |
1.43 |
These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, |
731 |
|
|
respectively. They are overloaded to act almost exactly like the numbers |
732 |
root |
1.68 |
C<1> and C<0>. You can check whether a scalar is a JSON boolean by using |
733 |
root |
1.43 |
the C<JSON::XS::is_bool> function. |
734 |
root |
1.10 |
|
735 |
|
|
=item null |
736 |
|
|
|
737 |
|
|
A JSON null atom becomes C<undef> in Perl. |
738 |
|
|
|
739 |
|
|
=back |
740 |
|
|
|
741 |
root |
1.39 |
|
742 |
root |
1.10 |
=head2 PERL -> JSON |
743 |
|
|
|
744 |
|
|
The mapping from Perl to JSON is slightly more difficult, as Perl is a |
745 |
|
|
truly typeless language, so we can only guess which JSON type is meant by |
746 |
|
|
a Perl value. |
747 |
|
|
|
748 |
|
|
=over 4 |
749 |
|
|
|
750 |
|
|
=item hash references |
751 |
|
|
|
752 |
|
|
Perl hash references become JSON objects. As there is no inherent ordering |
753 |
root |
1.25 |
in hash keys (or JSON objects), they will usually be encoded in a |
754 |
|
|
pseudo-random order that can change between runs of the same program but |
755 |
|
|
stays generally the same within a single run of a program. JSON::XS can |
756 |
|
|
optionally sort the hash keys (determined by the I<canonical> flag), so |
757 |
|
|
the same datastructure will serialise to the same JSON text (given same |
758 |
|
|
settings and version of JSON::XS), but this incurs a runtime overhead |
759 |
|
|
and is only rarely useful, e.g. when you want to compare some JSON text |
760 |
|
|
against another for equality. |
761 |
root |
1.10 |
|
762 |
|
|
=item array references |
763 |
|
|
|
764 |
|
|
Perl array references become JSON arrays. |
765 |
|
|
|
766 |
root |
1.25 |
=item other references |
767 |
|
|
|
768 |
|
|
Other unblessed references are generally not allowed and will cause an |
769 |
|
|
exception to be thrown, except for references to the integers C<0> and |
770 |
|
|
C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
771 |
|
|
also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
772 |
|
|
|
773 |
root |
1.78 |
encode_json [\0,JSON::XS::true] # yields [false,true] |
774 |
root |
1.25 |
|
775 |
root |
1.43 |
=item JSON::XS::true, JSON::XS::false |
776 |
|
|
|
777 |
|
|
These special values become JSON true and JSON false values, |
778 |
root |
1.61 |
respectively. You can also use C<\1> and C<\0> directly if you want. |
779 |
root |
1.43 |
|
780 |
root |
1.10 |
=item blessed objects |
781 |
|
|
|
782 |
root |
1.83 |
Blessed objects are not directly representable in JSON. See the |
783 |
|
|
C<allow_blessed> and C<convert_blessed> methods on various options on |
784 |
|
|
how to deal with this: basically, you can choose between throwing an |
785 |
|
|
exception, encoding the reference as if it weren't blessed, or provide |
786 |
|
|
your own serialiser method. |
787 |
root |
1.10 |
|
788 |
|
|
=item simple scalars |
789 |
|
|
|
790 |
|
|
Simple Perl scalars (any scalar that is not a reference) are the most |
791 |
|
|
difficult objects to encode: JSON::XS will encode undefined scalars as |
792 |
root |
1.83 |
JSON C<null> values, scalars that have last been used in a string context |
793 |
|
|
before encoding as JSON strings, and anything else as number value: |
794 |
root |
1.10 |
|
795 |
|
|
# dump as number |
796 |
root |
1.78 |
encode_json [2] # yields [2] |
797 |
|
|
encode_json [-3.0e17] # yields [-3e+17] |
798 |
|
|
my $value = 5; encode_json [$value] # yields [5] |
799 |
root |
1.10 |
|
800 |
|
|
# used as string, so dump as string |
801 |
|
|
print $value; |
802 |
root |
1.78 |
encode_json [$value] # yields ["5"] |
803 |
root |
1.10 |
|
804 |
|
|
# undef becomes null |
805 |
root |
1.78 |
encode_json [undef] # yields [null] |
806 |
root |
1.10 |
|
807 |
root |
1.68 |
You can force the type to be a JSON string by stringifying it: |
808 |
root |
1.10 |
|
809 |
|
|
my $x = 3.1; # some variable containing a number |
810 |
|
|
"$x"; # stringified |
811 |
|
|
$x .= ""; # another, more awkward way to stringify |
812 |
|
|
print $x; # perl does it for you, too, quite often |
813 |
|
|
|
814 |
root |
1.68 |
You can force the type to be a JSON number by numifying it: |
815 |
root |
1.10 |
|
816 |
|
|
my $x = "3"; # some variable containing a string |
817 |
|
|
$x += 0; # numify it, ensuring it will be dumped as a number |
818 |
root |
1.68 |
$x *= 1; # same thing, the choice is yours. |
819 |
root |
1.10 |
|
820 |
root |
1.68 |
You can not currently force the type in other, less obscure, ways. Tell me |
821 |
root |
1.83 |
if you need this capability (but don't forget to explain why its needed |
822 |
|
|
:). |
823 |
root |
1.10 |
|
824 |
|
|
=back |
825 |
|
|
|
826 |
root |
1.23 |
|
827 |
root |
1.84 |
=head1 ENCODING/CODESET FLAG NOTES |
828 |
|
|
|
829 |
|
|
The interested reader might have seen a number of flags that signify |
830 |
|
|
encodings or codesets - C<utf8>, C<latin1> and C<ascii>. There seems to be |
831 |
|
|
some confusion on what these do, so here is a short comparison: |
832 |
|
|
|
833 |
|
|
C<utf8> controls wether the JSON text created by C<encode> (and expected |
834 |
|
|
by C<decode>) is UTF-8 encoded or not, while C<latin1> and C<ascii> only |
835 |
|
|
control wether C<encode> escapes character values outside their respective |
836 |
|
|
codeset range. Neither of these flags conflict with each other, although |
837 |
|
|
some combinations make less sense than others. |
838 |
|
|
|
839 |
|
|
Care has been taken to make all flags symmetrical with respect to |
840 |
|
|
C<encode> and C<decode>, that is, texts encoded with any combination of |
841 |
|
|
these flag values will be correctly decoded when the same flags are used |
842 |
|
|
- in general, if you use different flag settings while encoding vs. when |
843 |
|
|
decoding you likely have a bug somewhere. |
844 |
|
|
|
845 |
|
|
Below comes a verbose discussion of these flags. Note that a "codeset" is |
846 |
|
|
simply an abstract set of character-codepoint pairs, while an encoding |
847 |
|
|
takes those codepoint numbers and I<encodes> them, in our case into |
848 |
|
|
octets. Unicode is (among other things) a codeset, UTF-8 is an encoding, |
849 |
|
|
and ISO-8859-1 (= latin 1) and ASCII are both codesets I<and> encodings at |
850 |
|
|
the same time, which can be confusing. |
851 |
|
|
|
852 |
|
|
=over 4 |
853 |
|
|
|
854 |
|
|
=item C<utf8> flag disabled |
855 |
|
|
|
856 |
|
|
When C<utf8> is disabled (the default), then C<encode>/C<decode> generate |
857 |
|
|
and expect Unicode strings, that is, characters with high ordinal Unicode |
858 |
|
|
values (> 255) will be encoded as such characters, and likewise such |
859 |
|
|
characters are decoded as-is, no canges to them will be done, except |
860 |
|
|
"(re-)interpreting" them as Unicode codepoints or Unicode characters, |
861 |
|
|
respectively (to Perl, these are the same thing in strings unless you do |
862 |
|
|
funny/weird/dumb stuff). |
863 |
|
|
|
864 |
|
|
This is useful when you want to do the encoding yourself (e.g. when you |
865 |
|
|
want to have UTF-16 encoded JSON texts) or when some other layer does |
866 |
|
|
the encoding for you (for example, when printing to a terminal using a |
867 |
|
|
filehandle that transparently encodes to UTF-8 you certainly do NOT want |
868 |
|
|
to UTF-8 encode your data first and have Perl encode it another time). |
869 |
|
|
|
870 |
|
|
=item C<utf8> flag enabled |
871 |
|
|
|
872 |
|
|
If the C<utf8>-flag is enabled, C<encode>/C<decode> will encode all |
873 |
|
|
characters using the corresponding UTF-8 multi-byte sequence, and will |
874 |
|
|
expect your input strings to be encoded as UTF-8, that is, no "character" |
875 |
|
|
of the input string must have any value > 255, as UTF-8 does not allow |
876 |
|
|
that. |
877 |
|
|
|
878 |
|
|
The C<utf8> flag therefore switches between two modes: disabled means you |
879 |
|
|
will get a Unicode string in Perl, enabled means you get an UTF-8 encoded |
880 |
|
|
octet/binary string in Perl. |
881 |
|
|
|
882 |
|
|
=item C<latin1> or C<ascii> flags enabled |
883 |
|
|
|
884 |
|
|
With C<latin1> (or C<ascii>) enabled, C<encode> will escape characters |
885 |
|
|
with ordinal values > 255 (> 127 with C<ascii>) and encode the remaining |
886 |
|
|
characters as specified by the C<utf8> flag. |
887 |
|
|
|
888 |
|
|
If C<utf8> is disabled, then the result is also correctly encoded in those |
889 |
|
|
character sets (as both are proper subsets of Unicode, meaning that a |
890 |
|
|
Unicode string with all character values < 256 is the same thing as a |
891 |
|
|
ISO-8859-1 string, and a Unicode string with all character values < 128 is |
892 |
|
|
the same thing as an ASCII string in Perl). |
893 |
|
|
|
894 |
|
|
If C<utf8> is enabled, you still get a correct UTF-8-encoded string, |
895 |
|
|
regardless of these flags, just some more characters will be escaped using |
896 |
|
|
C<\uXXXX> then before. |
897 |
|
|
|
898 |
|
|
Note that ISO-8859-1-I<encoded> strings are not compatible with UTF-8 |
899 |
|
|
encoding, while ASCII-encoded strings are. That is because the ISO-8859-1 |
900 |
|
|
encoding is NOT a subset of UTF-8 (despite the ISO-8859-1 I<codeset> being |
901 |
|
|
a subset of Unicode), while ASCII is. |
902 |
|
|
|
903 |
|
|
Surprisingly, C<decode> will ignore these flags and so treat all input |
904 |
|
|
values as governed by the C<utf8> flag. If it is disabled, this allows you |
905 |
|
|
to decode ISO-8859-1- and ASCII-encoded strings, as both strict subsets of |
906 |
|
|
Unicode. If it is enabled, you can correctly decode UTF-8 encoded strings. |
907 |
|
|
|
908 |
|
|
So neither C<latin1> nor C<ascii> are incompatible with the C<utf8> flag - |
909 |
|
|
they only govern when the JSON output engine escapes a character or not. |
910 |
|
|
|
911 |
|
|
The main use for C<latin1> is to relatively efficiently store binary data |
912 |
|
|
as JSON, at the expense of breaking compatibility with most JSON decoders. |
913 |
|
|
|
914 |
|
|
The main use for C<ascii> is to force the output to not contain characters |
915 |
|
|
with values > 127, which means you can interpret the resulting string |
916 |
|
|
as UTF-8, ISO-8859-1, ASCII, KOI8-R or most about any character set and |
917 |
|
|
8-bit-encoding, and still get the same data structure back. This is useful |
918 |
|
|
when your channel for JSON transfer is not 8-bit clean or the encoding |
919 |
|
|
might be mangled in between (e.g. in mail), and works because ASCII is a |
920 |
|
|
proper subset of most 8-bit and multibyte encodings in use in the world. |
921 |
|
|
|
922 |
|
|
=back |
923 |
|
|
|
924 |
|
|
|
925 |
root |
1.3 |
=head1 COMPARISON |
926 |
|
|
|
927 |
|
|
As already mentioned, this module was created because none of the existing |
928 |
|
|
JSON modules could be made to work correctly. First I will describe the |
929 |
|
|
problems (or pleasures) I encountered with various existing JSON modules, |
930 |
root |
1.4 |
followed by some benchmark values. JSON::XS was designed not to suffer |
931 |
|
|
from any of these problems or limitations. |
932 |
root |
1.3 |
|
933 |
|
|
=over 4 |
934 |
|
|
|
935 |
root |
1.84 |
=item JSON 2.xx |
936 |
|
|
|
937 |
|
|
A marvellous piece of engineering, this module either uses JSON::XS |
938 |
|
|
directly when available (so will be 100% compatible with it, including |
939 |
|
|
speed), or it uses JSON::PP, which is basically JSON::XS translated to |
940 |
|
|
Pure Perl, which should be 100% compatible with JSON::XS, just a bit |
941 |
|
|
slower. |
942 |
|
|
|
943 |
root |
1.85 |
You cannot really lose by using this module, especially as it tries very |
944 |
|
|
hard to work even with ancient Perl versions, while JSON::XS does not. |
945 |
root |
1.84 |
|
946 |
root |
1.5 |
=item JSON 1.07 |
947 |
root |
1.3 |
|
948 |
|
|
Slow (but very portable, as it is written in pure Perl). |
949 |
|
|
|
950 |
root |
1.68 |
Undocumented/buggy Unicode handling (how JSON handles Unicode values is |
951 |
|
|
undocumented. One can get far by feeding it Unicode strings and doing |
952 |
|
|
en-/decoding oneself, but Unicode escapes are not working properly). |
953 |
root |
1.3 |
|
954 |
root |
1.69 |
No round-tripping (strings get clobbered if they look like numbers, e.g. |
955 |
root |
1.3 |
the string C<2.0> will encode to C<2.0> instead of C<"2.0">, and that will |
956 |
|
|
decode into the number 2. |
957 |
|
|
|
958 |
root |
1.5 |
=item JSON::PC 0.01 |
959 |
root |
1.3 |
|
960 |
|
|
Very fast. |
961 |
|
|
|
962 |
|
|
Undocumented/buggy Unicode handling. |
963 |
|
|
|
964 |
root |
1.69 |
No round-tripping. |
965 |
root |
1.3 |
|
966 |
root |
1.4 |
Has problems handling many Perl values (e.g. regex results and other magic |
967 |
|
|
values will make it croak). |
968 |
root |
1.3 |
|
969 |
|
|
Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}> |
970 |
root |
1.16 |
which is not a valid JSON text. |
971 |
root |
1.3 |
|
972 |
|
|
Unmaintained (maintainer unresponsive for many months, bugs are not |
973 |
|
|
getting fixed). |
974 |
|
|
|
975 |
root |
1.5 |
=item JSON::Syck 0.21 |
976 |
root |
1.3 |
|
977 |
|
|
Very buggy (often crashes). |
978 |
|
|
|
979 |
root |
1.4 |
Very inflexible (no human-readable format supported, format pretty much |
980 |
|
|
undocumented. I need at least a format for easy reading by humans and a |
981 |
|
|
single-line compact format for use in a protocol, and preferably a way to |
982 |
root |
1.16 |
generate ASCII-only JSON texts). |
983 |
root |
1.3 |
|
984 |
root |
1.68 |
Completely broken (and confusingly documented) Unicode handling (Unicode |
985 |
root |
1.3 |
escapes are not working properly, you need to set ImplicitUnicode to |
986 |
|
|
I<different> values on en- and decoding to get symmetric behaviour). |
987 |
|
|
|
988 |
root |
1.69 |
No round-tripping (simple cases work, but this depends on whether the scalar |
989 |
root |
1.3 |
value was used in a numeric context or not). |
990 |
|
|
|
991 |
|
|
Dumping hashes may skip hash values depending on iterator state. |
992 |
|
|
|
993 |
|
|
Unmaintained (maintainer unresponsive for many months, bugs are not |
994 |
|
|
getting fixed). |
995 |
|
|
|
996 |
|
|
Does not check input for validity (i.e. will accept non-JSON input and |
997 |
|
|
return "something" instead of raising an exception. This is a security |
998 |
root |
1.68 |
issue: imagine two banks transferring money between each other using |
999 |
root |
1.3 |
JSON. One bank might parse a given non-JSON request and deduct money, |
1000 |
|
|
while the other might reject the transaction with a syntax error. While a |
1001 |
|
|
good protocol will at least recover, that is extra unnecessary work and |
1002 |
|
|
the transaction will still not succeed). |
1003 |
|
|
|
1004 |
root |
1.5 |
=item JSON::DWIW 0.04 |
1005 |
root |
1.3 |
|
1006 |
|
|
Very fast. Very natural. Very nice. |
1007 |
|
|
|
1008 |
root |
1.68 |
Undocumented Unicode handling (but the best of the pack. Unicode escapes |
1009 |
root |
1.3 |
still don't get parsed properly). |
1010 |
|
|
|
1011 |
|
|
Very inflexible. |
1012 |
|
|
|
1013 |
root |
1.69 |
No round-tripping. |
1014 |
root |
1.3 |
|
1015 |
root |
1.16 |
Does not generate valid JSON texts (key strings are often unquoted, empty keys |
1016 |
root |
1.4 |
result in nothing being output) |
1017 |
|
|
|
1018 |
root |
1.3 |
Does not check input for validity. |
1019 |
|
|
|
1020 |
|
|
=back |
1021 |
|
|
|
1022 |
root |
1.39 |
|
1023 |
|
|
=head2 JSON and YAML |
1024 |
|
|
|
1025 |
root |
1.80 |
You often hear that JSON is a subset of YAML. This is, however, a mass |
1026 |
root |
1.82 |
hysteria(*) and very far from the truth. In general, there is no way to |
1027 |
root |
1.80 |
configure JSON::XS to output a data structure as valid YAML that works for |
1028 |
|
|
all cases. |
1029 |
root |
1.39 |
|
1030 |
root |
1.41 |
If you really must use JSON::XS to generate YAML, you should use this |
1031 |
root |
1.39 |
algorithm (subject to change in future versions): |
1032 |
|
|
|
1033 |
|
|
my $to_yaml = JSON::XS->new->utf8->space_after (1); |
1034 |
|
|
my $yaml = $to_yaml->encode ($ref) . "\n"; |
1035 |
|
|
|
1036 |
root |
1.83 |
This will I<usually> generate JSON texts that also parse as valid |
1037 |
root |
1.41 |
YAML. Please note that YAML has hardcoded limits on (simple) object key |
1038 |
root |
1.80 |
lengths that JSON doesn't have and also has different and incompatible |
1039 |
|
|
unicode handling, so you should make sure that your hash keys are |
1040 |
|
|
noticeably shorter than the 1024 "stream characters" YAML allows and that |
1041 |
|
|
you do not have codepoints with values outside the Unicode BMP (basic |
1042 |
root |
1.81 |
multilingual page). YAML also does not allow C<\/> sequences in strings |
1043 |
|
|
(which JSON::XS does not I<currently> generate). |
1044 |
root |
1.39 |
|
1045 |
root |
1.83 |
There might be other incompatibilities that I am not aware of (or the YAML |
1046 |
|
|
specification has been changed yet again - it does so quite often). In |
1047 |
|
|
general you should not try to generate YAML with a JSON generator or vice |
1048 |
|
|
versa, or try to parse JSON with a YAML parser or vice versa: chances are |
1049 |
|
|
high that you will run into severe interoperability problems when you |
1050 |
|
|
least expect it. |
1051 |
root |
1.39 |
|
1052 |
root |
1.82 |
=over 4 |
1053 |
|
|
|
1054 |
|
|
=item (*) |
1055 |
|
|
|
1056 |
|
|
This is spread actively by the YAML team, however. For many years now they |
1057 |
|
|
claim YAML were a superset of JSON, even when proven otherwise. |
1058 |
|
|
|
1059 |
|
|
Even the author of this manpage was at some point accused of providing |
1060 |
|
|
"incorrect" information, despite the evidence presented (claims ranged |
1061 |
|
|
from "your documentation contains inaccurate and negative statements about |
1062 |
|
|
YAML" (the only negative comment is this footnote, and it didn't exist |
1063 |
|
|
back then; the question on which claims were inaccurate was never answered |
1064 |
root |
1.83 |
etc.) to "the YAML spec is not up-to-date" (the *real* and supposedly |
1065 |
root |
1.82 |
JSON-compatible spec is apparently not currently publicly available) |
1066 |
|
|
to actual requests to replace this section by *incorrect* information, |
1067 |
|
|
suppressing information about the real problem). |
1068 |
|
|
|
1069 |
|
|
So whenever you are told that YAML was a superset of JSON, first check |
1070 |
root |
1.83 |
wether it is really true (it might be when you check it, but it certainly |
1071 |
|
|
was not true when this was written). I would much prefer if the YAML team |
1072 |
root |
1.82 |
would spent their time on actually making JSON compatibility a truth |
1073 |
|
|
(JSON, after all, has a very small and simple specification) instead of |
1074 |
|
|
trying to lobby/force people into reporting untruths. |
1075 |
|
|
|
1076 |
|
|
=back |
1077 |
|
|
|
1078 |
root |
1.39 |
|
1079 |
root |
1.3 |
=head2 SPEED |
1080 |
|
|
|
1081 |
root |
1.4 |
It seems that JSON::XS is surprisingly fast, as shown in the following |
1082 |
|
|
tables. They have been generated with the help of the C<eg/bench> program |
1083 |
|
|
in the JSON::XS distribution, to make it easy to compare on your own |
1084 |
|
|
system. |
1085 |
|
|
|
1086 |
root |
1.88 |
First comes a comparison between various modules using |
1087 |
|
|
a very short single-line JSON string (also available at |
1088 |
|
|
L<http://dist.schmorp.de/misc/json/long.json>). |
1089 |
root |
1.18 |
|
1090 |
root |
1.37 |
{"method": "handleMessage", "params": ["user1", "we were just talking"], \ |
1091 |
root |
1.38 |
"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]} |
1092 |
root |
1.18 |
|
1093 |
root |
1.39 |
It shows the number of encodes/decodes per second (JSON::XS uses |
1094 |
|
|
the functional interface, while JSON::XS/2 uses the OO interface |
1095 |
|
|
with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
1096 |
|
|
shrink). Higher is better: |
1097 |
root |
1.4 |
|
1098 |
|
|
module | encode | decode | |
1099 |
|
|
-----------|------------|------------| |
1100 |
root |
1.72 |
JSON 1.x | 4990.842 | 4088.813 | |
1101 |
root |
1.48 |
JSON::DWIW | 51653.990 | 71575.154 | |
1102 |
|
|
JSON::PC | 65948.176 | 74631.744 | |
1103 |
|
|
JSON::PP | 8931.652 | 3817.168 | |
1104 |
|
|
JSON::Syck | 24877.248 | 27776.848 | |
1105 |
|
|
JSON::XS | 388361.481 | 227951.304 | |
1106 |
|
|
JSON::XS/2 | 227951.304 | 218453.333 | |
1107 |
|
|
JSON::XS/3 | 338250.323 | 218453.333 | |
1108 |
|
|
Storable | 16500.016 | 135300.129 | |
1109 |
root |
1.4 |
-----------+------------+------------+ |
1110 |
|
|
|
1111 |
root |
1.37 |
That is, JSON::XS is about five times faster than JSON::DWIW on encoding, |
1112 |
root |
1.68 |
about three times faster on decoding, and over forty times faster |
1113 |
root |
1.37 |
than JSON, even with pretty-printing and key sorting. It also compares |
1114 |
|
|
favourably to Storable for small amounts of data. |
1115 |
root |
1.4 |
|
1116 |
root |
1.13 |
Using a longer test string (roughly 18KB, generated from Yahoo! Locals |
1117 |
root |
1.88 |
search API (L>http://dist.schmorp.de/misc/json/long.json>). |
1118 |
root |
1.4 |
|
1119 |
|
|
module | encode | decode | |
1120 |
|
|
-----------|------------|------------| |
1121 |
root |
1.72 |
JSON 1.x | 55.260 | 34.971 | |
1122 |
root |
1.48 |
JSON::DWIW | 825.228 | 1082.513 | |
1123 |
|
|
JSON::PC | 3571.444 | 2394.829 | |
1124 |
|
|
JSON::PP | 210.987 | 32.574 | |
1125 |
|
|
JSON::Syck | 552.551 | 787.544 | |
1126 |
|
|
JSON::XS | 5780.463 | 4854.519 | |
1127 |
|
|
JSON::XS/2 | 3869.998 | 4798.975 | |
1128 |
|
|
JSON::XS/3 | 5862.880 | 4798.975 | |
1129 |
|
|
Storable | 4445.002 | 5235.027 | |
1130 |
root |
1.4 |
-----------+------------+------------+ |
1131 |
|
|
|
1132 |
root |
1.40 |
Again, JSON::XS leads by far (except for Storable which non-surprisingly |
1133 |
|
|
decodes faster). |
1134 |
root |
1.4 |
|
1135 |
root |
1.68 |
On large strings containing lots of high Unicode characters, some modules |
1136 |
root |
1.18 |
(such as JSON::PC) seem to decode faster than JSON::XS, but the result |
1137 |
root |
1.68 |
will be broken due to missing (or wrong) Unicode handling. Others refuse |
1138 |
root |
1.18 |
to decode or encode properly, so it was impossible to prepare a fair |
1139 |
|
|
comparison table for that case. |
1140 |
root |
1.13 |
|
1141 |
root |
1.11 |
|
1142 |
root |
1.23 |
=head1 SECURITY CONSIDERATIONS |
1143 |
|
|
|
1144 |
|
|
When you are using JSON in a protocol, talking to untrusted potentially |
1145 |
|
|
hostile creatures requires relatively few measures. |
1146 |
|
|
|
1147 |
|
|
First of all, your JSON decoder should be secure, that is, should not have |
1148 |
|
|
any buffer overflows. Obviously, this module should ensure that and I am |
1149 |
|
|
trying hard on making that true, but you never know. |
1150 |
|
|
|
1151 |
|
|
Second, you need to avoid resource-starving attacks. That means you should |
1152 |
|
|
limit the size of JSON texts you accept, or make sure then when your |
1153 |
root |
1.68 |
resources run out, that's just fine (e.g. by using a separate process that |
1154 |
root |
1.23 |
can crash safely). The size of a JSON text in octets or characters is |
1155 |
|
|
usually a good indication of the size of the resources required to decode |
1156 |
root |
1.47 |
it into a Perl structure. While JSON::XS can check the size of the JSON |
1157 |
|
|
text, it might be too late when you already have it in memory, so you |
1158 |
|
|
might want to check the size before you accept the string. |
1159 |
root |
1.23 |
|
1160 |
|
|
Third, JSON::XS recurses using the C stack when decoding objects and |
1161 |
|
|
arrays. The C stack is a limited resource: for instance, on my amd64 |
1162 |
root |
1.28 |
machine with 8MB of stack size I can decode around 180k nested arrays but |
1163 |
|
|
only 14k nested JSON objects (due to perl itself recursing deeply on croak |
1164 |
root |
1.79 |
to free the temporary). If that is exceeded, the program crashes. To be |
1165 |
root |
1.28 |
conservative, the default nesting limit is set to 512. If your process |
1166 |
|
|
has a smaller stack, you should adjust this setting accordingly with the |
1167 |
|
|
C<max_depth> method. |
1168 |
root |
1.23 |
|
1169 |
root |
1.86 |
Something else could bomb you, too, that I forgot to think of. In that |
1170 |
|
|
case, you get to keep the pieces. I am always open for hints, though... |
1171 |
|
|
|
1172 |
|
|
Also keep in mind that JSON::XS might leak contents of your Perl data |
1173 |
|
|
structures in its error messages, so when you serialise sensitive |
1174 |
|
|
information you might want to make sure that exceptions thrown by JSON::XS |
1175 |
|
|
will not end up in front of untrusted eyes. |
1176 |
root |
1.23 |
|
1177 |
root |
1.42 |
If you are using JSON::XS to return packets to consumption |
1178 |
root |
1.68 |
by JavaScript scripts in a browser you should have a look at |
1179 |
|
|
L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether |
1180 |
root |
1.42 |
you are vulnerable to some common attack vectors (which really are browser |
1181 |
|
|
design bugs, but it is still you who will have to deal with it, as major |
1182 |
root |
1.79 |
browser developers care only for features, not about getting security |
1183 |
root |
1.42 |
right). |
1184 |
|
|
|
1185 |
root |
1.11 |
|
1186 |
root |
1.64 |
=head1 THREADS |
1187 |
|
|
|
1188 |
root |
1.68 |
This module is I<not> guaranteed to be thread safe and there are no |
1189 |
root |
1.64 |
plans to change this until Perl gets thread support (as opposed to the |
1190 |
|
|
horribly slow so-called "threads" which are simply slow and bloated |
1191 |
|
|
process simulations - use fork, its I<much> faster, cheaper, better). |
1192 |
|
|
|
1193 |
root |
1.68 |
(It might actually work, but you have been warned). |
1194 |
root |
1.64 |
|
1195 |
|
|
|
1196 |
root |
1.4 |
=head1 BUGS |
1197 |
|
|
|
1198 |
|
|
While the goal of this module is to be correct, that unfortunately does |
1199 |
|
|
not mean its bug-free, only that I think its design is bug-free. It is |
1200 |
root |
1.23 |
still relatively early in its development. If you keep reporting bugs they |
1201 |
|
|
will be fixed swiftly, though. |
1202 |
root |
1.4 |
|
1203 |
root |
1.64 |
Please refrain from using rt.cpan.org or any other bug reporting |
1204 |
|
|
service. I put the contact address into my modules for a reason. |
1205 |
|
|
|
1206 |
root |
1.2 |
=cut |
1207 |
|
|
|
1208 |
root |
1.53 |
our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; |
1209 |
|
|
our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; |
1210 |
root |
1.43 |
|
1211 |
|
|
sub true() { $true } |
1212 |
|
|
sub false() { $false } |
1213 |
|
|
|
1214 |
|
|
sub is_bool($) { |
1215 |
|
|
UNIVERSAL::isa $_[0], "JSON::XS::Boolean" |
1216 |
root |
1.44 |
# or UNIVERSAL::isa $_[0], "JSON::Literal" |
1217 |
root |
1.43 |
} |
1218 |
|
|
|
1219 |
|
|
XSLoader::load "JSON::XS", $VERSION; |
1220 |
|
|
|
1221 |
|
|
package JSON::XS::Boolean; |
1222 |
|
|
|
1223 |
|
|
use overload |
1224 |
|
|
"0+" => sub { ${$_[0]} }, |
1225 |
|
|
"++" => sub { $_[0] = ${$_[0]} + 1 }, |
1226 |
|
|
"--" => sub { $_[0] = ${$_[0]} - 1 }, |
1227 |
|
|
fallback => 1; |
1228 |
root |
1.25 |
|
1229 |
root |
1.2 |
1; |
1230 |
|
|
|
1231 |
root |
1.1 |
=head1 AUTHOR |
1232 |
|
|
|
1233 |
|
|
Marc Lehmann <schmorp@schmorp.de> |
1234 |
|
|
http://home.schmorp.de/ |
1235 |
|
|
|
1236 |
|
|
=cut |
1237 |
|
|
|