[ViewVC] Diff of: cvs/JSON-XS/XS.pm

Comparing JSON-XS/XS.pm (file contents):
Revision 1.38 by root, Wed Jun 6 18:16:52 2007 UTC vs.
Revision 1.54 by root, Tue Jul 10 16:22:31 2007 UTC

…		…
9	# exported functions, they croak on error	9	# exported functions, they croak on error
10	# and expect/generate UTF-8	10	# and expect/generate UTF-8
11		11
12	$utf8_encoded_json_text = to_json $perl_hash_or_arrayref;	12	$utf8_encoded_json_text = to_json $perl_hash_or_arrayref;
13	$perl_hash_or_arrayref = from_json $utf8_encoded_json_text;	13	$perl_hash_or_arrayref = from_json $utf8_encoded_json_text;
14
15	# objToJson and jsonToObj aliases to to_json and from_json
16	# are exported for compatibility to the JSON module,
17	# but should not be used in new code.
18		14
19	# OO-interface	15	# OO-interface
20		16
21	$coder = JSON::XS->new->ascii->pretty->allow_nonref;	17	$coder = JSON::XS->new->ascii->pretty->allow_nonref;
22	$pretty_printed_unencoded = $coder->encode ($perl_scalar);	18	$pretty_printed_unencoded = $coder->encode ($perl_scalar);
…		…
85		81
86	package JSON::XS;	82	package JSON::XS;
87		83
88	use strict;	84	use strict;
89		85
90	BEGIN {
91	our $VERSION = '1.23';	86	our $VERSION = '1.41';
92	our @ISA = qw(Exporter);	87	our @ISA = qw(Exporter);
93		88
94	our @EXPORT = qw(to_json from_json objToJson jsonToObj);	89	our @EXPORT = qw(to_json from_json);
95	require Exporter;
96		90
97	require XSLoader;	91	use Exporter;
98	XSLoader::load JSON::XS::, $VERSION;	92	use XSLoader;
99	}
100		93
101	=head1 FUNCTIONAL INTERFACE	94	=head1 FUNCTIONAL INTERFACE
102		95
103	The following convinience methods are provided by this module. They are	96	The following convinience methods are provided by this module. They are
104	exported by default:	97	exported by default:
…		…
126	This function call is functionally identical to:	119	This function call is functionally identical to:
127		120
128	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	121	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
129		122
130	except being faster.	123	except being faster.
		124
		125	=item $is_boolean = JSON::XS::is_bool $scalar
		126
		127	Returns true if the passed scalar represents either JSON::XS::true or
		128	JSON::XS::false, two constants that act like C<1> and C<0>, respectively
		129	and are used to represent JSON C<true> and C<false> values in Perl.
		130
		131	See MAPPING, below, for more information on how JSON values are mapped to
		132	Perl.
131		133
132	=back	134	=back
133		135
134		136
135	=head1 OBJECT-ORIENTED INTERFACE	137	=head1 OBJECT-ORIENTED INTERFACE
…		…
309	Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>,	311	Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>,
310	resulting in an invalid JSON text:	312	resulting in an invalid JSON text:
311		313
312	JSON::XS->new->allow_nonref->encode ("Hello, World!")	314	JSON::XS->new->allow_nonref->encode ("Hello, World!")
313	=> "Hello, World!"	315	=> "Hello, World!"
		316
		317	=item $json = $json->allow_blessed ([$enable])
		318
		319	If C<$enable> is true (or missing), then the C<encode> method will not
		320	barf when it encounters a blessed reference. Instead, the value of the
		321	B<convert_blessed> option will decide wether C<null> (C<convert_blessed>
		322	disabled or no C<to_json> method found) or a representation of the
		323	object (C<convert_blessed> enabled and C<to_json> method found) is being
		324	encoded. Has no effect on C<decode>.
		325
		326	If C<$enable> is false (the default), then C<encode> will throw an
		327	exception when it encounters a blessed object.
		328
		329	=item $json = $json->convert_blessed ([$enable])
		330
		331	If C<$enable> is true (or missing), then C<encode>, upon encountering a
		332	blessed object, will check for the availability of the C<TO_JSON> method
		333	on the object's class. If found, it will be called in scalar context
		334	and the resulting scalar will be encoded instead of the object. If no
		335	C<TO_JSON> method is found, the value of C<allow_blessed> will decide what
		336	to do.
		337
		338	The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON>
		339	returns other blessed objects, those will be handled in the same
		340	way. C<TO_JSON> must take care of not causing an endless recursion cycle
		341	(== crash) in this case. The name of C<TO_JSON> was chosen because other
		342	methods called by the Perl core (== not by the user of the object) are
		343	usually in upper case letters and to avoid collisions with the C<to_json>
		344	function.
		345
		346	This setting does not yet influence C<decode> in any way, but in the
		347	future, global hooks might get installed that influence C<decode> and are
		348	enabled by this setting.
		349
		350	If C<$enable> is false, then the C<allow_blessed> setting will decide what
		351	to do when a blessed object is found.
		352
		353	=item $json = $json->filter_json_object ([$coderef->($hashref)])
		354
		355	When C<$coderef> is specified, it will be called from C<decode> each
		356	time it decodes a JSON object. The only argument is a reference to the
		357	newly-created hash. If the code references returns a single scalar (which
		358	need not be a reference), this value (i.e. a copy of that scalar to avoid
		359	aliasing) is inserted into the deserialised data structure. If it returns
		360	an empty list (NOTE: I<not> C<undef>, which is a valid scalar), the
		361	original deserialised hash will be inserted. This setting can slow down
		362	decoding considerably.
		363
		364	When C<$coderef> is omitted or undefined, any existing callback will
		365	be removed and C<decode> will not change the deserialised hash in any
		366	way.
		367
		368	Example, convert all JSON objects into the integer 5:
		369
		370	my $js = JSON::XS->new->filter_json_object (sub { 5 });
		371	# returns [5]
		372	$js->decode ('[{}]')
		373	# throw an exception because allow_nonref is not enabled
		374	# so a lone 5 is not allowed.
		375	$js->decode ('{"a":1, "b":2}');
		376
		377	=item $json = $json->filter_json_single_key_object ($key [=> $coderef->($value)])
		378
		379	Works remotely similar to C<filter_json_object>, but is only called for
		380	JSON objects having a single key named C<$key>.
		381
		382	This C<$coderef> is called before the one specified via
		383	C<filter_json_object>, if any. It gets passed the single value in the JSON
		384	object. If it returns a single value, it will be inserted into the data
		385	structure. If it returns nothing (not even C<undef> but the empty list),
		386	the callback from C<filter_json_object> will be called next, as if no
		387	single-key callback were specified.
		388
		389	If C<$coderef> is omitted or undefined, the corresponding callback will be
		390	disabled. There can only ever be one callback for a given key.
		391
		392	As this callback gets called less often then the C<filter_json_object>
		393	one, decoding speed will not usually suffer as much. Therefore, single-key
		394	objects make excellent targets to serialise Perl objects into, especially
		395	as single-key JSON objects are as close to the type-tagged value concept
		396	as JSON gets (its basically an ID/VALUE tuple). Of course, JSON does not
		397	support this in any way, so you need to make sure your data never looks
		398	like a serialised Perl hash.
		399
		400	Typical names for the single object key are C<__class_whatever__>, or
		401	C<$__dollars_are_rarely_used__$> or C<}ugly_brace_placement>, or even
		402	things like C<__class_md5sum(classname)__>, to reduce the risk of clashing
		403	with real hashes.
		404
		405	Example, decode JSON objects of the form C<< { "__widget__" => <id> } >>
		406	into the corresponding C<< $WIDGET{<id>} >> object:
		407
		408	# return whatever is in $WIDGET{5}:
		409	JSON::XS
		410	->new
		411	->filter_json_single_key_object (__widget__ => sub {
		412	$WIDGET{ $_[0] }
		413	})
		414	->decode ('{"__widget__": 5')
		415
		416	# this can be used with a TO_JSON method in some "widget" class
		417	# for serialisation to json:
		418	sub WidgetBase::TO_JSON {
		419	my ($self) = @_;
		420
		421	unless ($self->{id}) {
		422	$self->{id} = ..get..some..id..;
		423	$WIDGET{$self->{id}} = $self;
		424	}
		425
		426	{ __widget__ => $self->{id} }
		427	}
314		428
315	=item $json = $json->shrink ([$enable])	429	=item $json = $json->shrink ([$enable])
316		430
317	Perl usually over-allocates memory a bit when allocating space for	431	Perl usually over-allocates memory a bit when allocating space for
318	strings. This flag optionally resizes strings generated by either	432	strings. This flag optionally resizes strings generated by either
…		…
351	given character in a string.	465	given character in a string.
352		466
353	Setting the maximum depth to one disallows any nesting, so that ensures	467	Setting the maximum depth to one disallows any nesting, so that ensures
354	that the object is only a single hash/object or array.	468	that the object is only a single hash/object or array.
355		469
356	The argument to C<max_depth> will be rounded up to the next nearest power	470	The argument to C<max_depth> will be rounded up to the next highest power
357	of two.	471	of two. If no argument is given, the highest possible setting will be
		472	used, which is rarely useful.
		473
		474	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
		475
		476	=item $json = $json->max_size ([$maximum_string_size])
		477
		478	Set the maximum length a JSON text may have (in bytes) where decoding is
		479	being attempted. The default is C<0>, meaning no limit. When C<decode>
		480	is called on a string longer then this number of characters it will not
		481	attempt to decode the string but throw an exception. This setting has no
		482	effect on C<encode> (yet).
		483
		484	The argument to C<max_size> will be rounded up to the next B<highest>
		485	power of two (so may be more than requested). If no argument is given, the
		486	limit check will be deactivated (same as when C<0> is specified).
358		487
359	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	488	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
360		489
361	=item $json_text = $json->encode ($perl_scalar)	490	=item $json_text = $json->encode ($perl_scalar)
362		491
…		…
402		531
403	For the more enlightened: note that in the following descriptions,	532	For the more enlightened: note that in the following descriptions,
404	lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl>	533	lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl>
405	refers to the abstract Perl language itself.	534	refers to the abstract Perl language itself.
406		535
		536
407	=head2 JSON -> PERL	537	=head2 JSON -> PERL
408		538
409	=over 4	539	=over 4
410		540
411	=item object	541	=item object
…		…
431	conversion details, but an integer may take slightly less memory and might	561	conversion details, but an integer may take slightly less memory and might
432	represent more values exactly than (floating point) numbers.	562	represent more values exactly than (floating point) numbers.
433		563
434	=item true, false	564	=item true, false
435		565
436	These JSON atoms become C<0>, C<1>, respectively. Information is lost in	566	These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,
437	this process. Future versions might represent those values differently,	567	respectively. They are overloaded to act almost exactly like the numbers
438	but they will be guarenteed to act like these integers would normally in	568	C<1> and C<0>. You can check wether a scalar is a JSON boolean by using
439	Perl.	569	the C<JSON::XS::is_bool> function.
440		570
441	=item null	571	=item null
442		572
443	A JSON null atom becomes C<undef> in Perl.	573	A JSON null atom becomes C<undef> in Perl.
444		574
445	=back	575	=back
		576
446		577
447	=head2 PERL -> JSON	578	=head2 PERL -> JSON
448		579
449	The mapping from Perl to JSON is slightly more difficult, as Perl is a	580	The mapping from Perl to JSON is slightly more difficult, as Perl is a
450	truly typeless language, so we can only guess which JSON type is meant by	581	truly typeless language, so we can only guess which JSON type is meant by
…		…
475	C<1>, which get turned into C<false> and C<true> atoms in JSON. You can	606	C<1>, which get turned into C<false> and C<true> atoms in JSON. You can
476	also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.	607	also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
477		608
478	to_json [\0,JSON::XS::true] # yields [false,true]	609	to_json [\0,JSON::XS::true] # yields [false,true]
479		610
		611	=item JSON::XS::true, JSON::XS::false
		612
		613	These special values become JSON true and JSON false values,
		614	respectively. You cna alos use C<\1> and C<\0> directly if you want.
		615
480	=item blessed objects	616	=item blessed objects
481		617
482	Blessed objects are not allowed. JSON::XS currently tries to encode their	618	Blessed objects are not allowed. JSON::XS currently tries to encode their
483	underlying representation (hash- or arrayref), but this behaviour might	619	underlying representation (hash- or arrayref), but this behaviour might
484	change in future versions.	620	change in future versions.
…		…
605		741
606	Does not check input for validity.	742	Does not check input for validity.
607		743
608	=back	744	=back
609		745
		746
		747	=head2 JSON and YAML
		748
		749	You often hear that JSON is a subset (or a close subset) of YAML. This is,
		750	however, a mass hysteria and very far from the truth. In general, there is
		751	no way to configure JSON::XS to output a data structure as valid YAML.
		752
		753	If you really must use JSON::XS to generate YAML, you should use this
		754	algorithm (subject to change in future versions):
		755
		756	my $to_yaml = JSON::XS->new->utf8->space_after (1);
		757	my $yaml = $to_yaml->encode ($ref) . "\n";
		758
		759	This will usually generate JSON texts that also parse as valid
		760	YAML. Please note that YAML has hardcoded limits on (simple) object key
		761	lengths that JSON doesn't have, so you should make sure that your hash
		762	keys are noticably shorter than the 1024 characters YAML allows.
		763
		764	There might be other incompatibilities that I am not aware of. In general
		765	you should not try to generate YAML with a JSON generator or vice versa,
		766	or try to parse JSON with a YAML parser or vice versa: chances are high
		767	that you will run into severe interoperability problems.
		768
		769
610	=head2 SPEED	770	=head2 SPEED
611		771
612	It seems that JSON::XS is surprisingly fast, as shown in the following	772	It seems that JSON::XS is surprisingly fast, as shown in the following
613	tables. They have been generated with the help of the C<eg/bench> program	773	tables. They have been generated with the help of the C<eg/bench> program
614	in the JSON::XS distribution, to make it easy to compare on your own	774	in the JSON::XS distribution, to make it easy to compare on your own
…		…
618	single-line JSON string:	778	single-line JSON string:
619		779
620	{"method": "handleMessage", "params": ["user1", "we were just talking"], \	780	{"method": "handleMessage", "params": ["user1", "we were just talking"], \
621	"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}	781	"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}
622		782
623	It shows the number of encodes/decodes per second (JSON::XS uses the	783	It shows the number of encodes/decodes per second (JSON::XS uses
624	functional interface, while JSON::XS/2 uses the OO interface with	784	the functional interface, while JSON::XS/2 uses the OO interface
625	pretty-printing and hashkey sorting enabled). Higher is better:	785	with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
		786	shrink). Higher is better:
626		787
		788	Storable \| 15779.925 \| 14169.946 \|
		789	-----------+------------+------------+
627	module \| encode \| decode \|	790	module \| encode \| decode \|
628	-----------\|------------\|------------\|	791	-----------\|------------\|------------\|
629	JSON \| 7645.468 \| 4208.613 \|	792	JSON \| 4990.842 \| 4088.813 \|
630	JSON::DWIW \| 68534.379 \| 79437.576 \|	793	JSON::DWIW \| 51653.990 \| 71575.154 \|
631	JSON::PC \| 65948.176 \| 78251.940 \|	794	JSON::PC \| 65948.176 \| 74631.744 \|
632	JSON::Syck \| 23379.621 \| 28416.694 \|	795	JSON::PP \| 8931.652 \| 3817.168 \|
		796	JSON::Syck \| 24877.248 \| 27776.848 \|
633	JSON::XS \| 388361.481 \| 199728.762 \|	797	JSON::XS \| 388361.481 \| 227951.304 \|
634	JSON::XS/2 \| 218453.333 \| 192399.266 \|	798	JSON::XS/2 \| 227951.304 \| 218453.333 \|
635	JSON::XS/3 \| 338250.323 \| 192399.266 \|	799	JSON::XS/3 \| 338250.323 \| 218453.333 \|
636	Storable \| 15732.573 \| 28571.553 \|	800	Storable \| 16500.016 \| 135300.129 \|
637	-----------+------------+------------+	801	-----------+------------+------------+
638		802
639	That is, JSON::XS is about five times faster than JSON::DWIW on encoding,	803	That is, JSON::XS is about five times faster than JSON::DWIW on encoding,
640	about three times faster on decoding, and over fourty times faster	804	about three times faster on decoding, and over fourty times faster
641	than JSON, even with pretty-printing and key sorting. It also compares	805	than JSON, even with pretty-printing and key sorting. It also compares
…		…
644	Using a longer test string (roughly 18KB, generated from Yahoo! Locals	808	Using a longer test string (roughly 18KB, generated from Yahoo! Locals
645	search API (http://nanoref.com/yahooapis/mgPdGg):	809	search API (http://nanoref.com/yahooapis/mgPdGg):
646		810
647	module \| encode \| decode \|	811	module \| encode \| decode \|
648	-----------\|------------\|------------\|	812	-----------\|------------\|------------\|
649	JSON \| 254.685 \| 37.665 \|	813	JSON \| 55.260 \| 34.971 \|
650	JSON::DWIW \| 1014.244 \| 1087.678 \|	814	JSON::DWIW \| 825.228 \| 1082.513 \|
651	JSON::PC \| 3602.116 \| 2307.352 \|	815	JSON::PC \| 3571.444 \| 2394.829 \|
652	JSON::Syck \| 558.035 \| 776.263 \|	816	JSON::PP \| 210.987 \| 32.574 \|
653	JSON::XS \| 5747.196 \| 3543.684 \|	817	JSON::Syck \| 552.551 \| 787.544 \|
654	JSON::XS/2 \| 3968.121 \| 3589.170 \|	818	JSON::XS \| 5780.463 \| 4854.519 \|
655	JSON::XS/3 \| 6105.246 \| 3561.134 \|	819	JSON::XS/2 \| 3869.998 \| 4798.975 \|
656	Storable \| 4456.337 \| 5320.020 \|	820	JSON::XS/3 \| 5862.880 \| 4798.975 \|
		821	Storable \| 4445.002 \| 5235.027 \|
657	-----------+------------+------------+	822	-----------+------------+------------+
658		823
659	Again, JSON::XS leads by far.	824	Again, JSON::XS leads by far (except for Storable which non-surprisingly
		825	decodes faster).
660		826
661	On large strings containing lots of high unicode characters, some modules	827	On large strings containing lots of high unicode characters, some modules
662	(such as JSON::PC) seem to decode faster than JSON::XS, but the result	828	(such as JSON::PC) seem to decode faster than JSON::XS, but the result
663	will be broken due to missing (or wrong) unicode handling. Others refuse	829	will be broken due to missing (or wrong) unicode handling. Others refuse
664	to decode or encode properly, so it was impossible to prepare a fair	830	to decode or encode properly, so it was impossible to prepare a fair
…		…
677	Second, you need to avoid resource-starving attacks. That means you should	843	Second, you need to avoid resource-starving attacks. That means you should
678	limit the size of JSON texts you accept, or make sure then when your	844	limit the size of JSON texts you accept, or make sure then when your
679	resources run out, thats just fine (e.g. by using a separate process that	845	resources run out, thats just fine (e.g. by using a separate process that
680	can crash safely). The size of a JSON text in octets or characters is	846	can crash safely). The size of a JSON text in octets or characters is
681	usually a good indication of the size of the resources required to decode	847	usually a good indication of the size of the resources required to decode
682	it into a Perl structure.	848	it into a Perl structure. While JSON::XS can check the size of the JSON
		849	text, it might be too late when you already have it in memory, so you
		850	might want to check the size before you accept the string.
683		851
684	Third, JSON::XS recurses using the C stack when decoding objects and	852	Third, JSON::XS recurses using the C stack when decoding objects and
685	arrays. The C stack is a limited resource: for instance, on my amd64	853	arrays. The C stack is a limited resource: for instance, on my amd64
686	machine with 8MB of stack size I can decode around 180k nested arrays but	854	machine with 8MB of stack size I can decode around 180k nested arrays but
687	only 14k nested JSON objects (due to perl itself recursing deeply on croak	855	only 14k nested JSON objects (due to perl itself recursing deeply on croak
…		…
692		860
693	And last but least, something else could bomb you that I forgot to think	861	And last but least, something else could bomb you that I forgot to think
694	of. In that case, you get to keep the pieces. I am always open for hints,	862	of. In that case, you get to keep the pieces. I am always open for hints,
695	though...	863	though...
696		864
		865	If you are using JSON::XS to return packets to consumption
		866	by javascript scripts in a browser you should have a look at
		867	L<http://jpsykes.com/47/practical-csrf-and-json-security> to see wether
		868	you are vulnerable to some common attack vectors (which really are browser
		869	design bugs, but it is still you who will have to deal with it, as major
		870	browser developers care only for features, not about doing security
		871	right).
		872
697		873
698	=head1 BUGS	874	=head1 BUGS
699		875
700	While the goal of this module is to be correct, that unfortunately does	876	While the goal of this module is to be correct, that unfortunately does
701	not mean its bug-free, only that I think its design is bug-free. It is	877	not mean its bug-free, only that I think its design is bug-free. It is
702	still relatively early in its development. If you keep reporting bugs they	878	still relatively early in its development. If you keep reporting bugs they
703	will be fixed swiftly, though.	879	will be fixed swiftly, though.
704		880
705	=cut	881	=cut
706		882
		883	our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" };
		884	our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" };
		885
707	sub true() { \1 }	886	sub true() { $true }
708	sub false() { \0 }	887	sub false() { $false }
		888
		889	sub is_bool($) {
		890	UNIVERSAL::isa $_[0], "JSON::XS::Boolean"
		891	# or UNIVERSAL::isa $_[0], "JSON::Literal"
		892	}
		893
		894	XSLoader::load "JSON::XS", $VERSION;
		895
		896	package JSON::XS::Boolean;
		897
		898	use overload
		899	"0+" => sub { ${$_[0]} },
		900	"++" => sub { $_[0] = ${$_[0]} + 1 },
		901	"--" => sub { $_[0] = ${$_[0]} - 1 },
		902	fallback => 1;
709		903
710	1;	904	1;
711		905
712	=head1 AUTHOR	906	=head1 AUTHOR
713		907

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing JSON-XS/XS.pm (file contents): Revision 1.38 by root, Wed Jun 6 18:16:52 2007 UTC vs. Revision 1.54 by root, Tue Jul 10 16:22:31 2007 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.38 by root, Wed Jun 6 18:16:52 2007 UTC vs.
Revision 1.54 by root, Tue Jul 10 16:22:31 2007 UTC