Fadil Kujundzic
Aug 12th

  I had a problem with serialize function objects were stored as array. To fix this I changed at line 73 [CODE] objname [1] this.serialize (= objname [1 ]);[/ CODE] to [CODE] objname [1] this.serialize (= objname [1] == "Object [" ? "stdClass": objname [1 ]);[/ CODE]. Maybe might be useful for someone.

Le Torbi
26 Sep '09

  Hi there,

when fixing the UTF-8 issue of the unserialize() function I've found a way to improve the speed of the size calculation for strings. It's quite simple and need no complex string operations or regular expressions. Here is the code:

var utf8Size = function(str) { // NEW FUNCTION
    var size = 0;
    for (var i = 0; i < str.length; i++) {
        var code = str[i].charCodeAt(0);
        if (code < 0x0080)
            size += 1;
        else if (code < 0x0800)
            size += 2;
        else
        size += 3;
    }
    return size;
}
var _getType = function (inp) {
    var type = typeof inp, match;
    var key;
// MORE LINES OF CODE
        val = (Math.round(mixed_value) == mixed_value ? "i" : "d") + ":" + mixed_value;
        break;
    case "string":
        val = "s:" + utf8Size(mixed_value) + ":"" + mixed_value + """; // MODIFIED LINE
        break;
 case "array":
case "object":

I've made some simple test and it seems that my function needs about 0.0004ms per run, while the old needs 0.004ms. Ok, it's not much, but maybe worth the code anyway...

BTW: What do I have to to to get this into the official code?

Bai
Le Torbi

Brett Zamir
19 Aug '09

  @Russell Walker: That sounds good, but can you please confirm that this is in fact the same behavior in PHP?

Russell Walker
18 Aug '09

  When serializing strings that contain URL entities (such as the plus symbol), they were being lost during unserialization in PHP. To fix this, I changed line 58 to URIEncode the string value like this:

val = "s:" + encodeURIComponent(mixed_value).replace(/%../g, 'x').length + ":"" + encodeURIComponent(mixed_value) + """;

Kevin van Zonneveld
16 Aug '09

  @ Alexandre Felipe Muller: Thanks for sharing. It's gonna take a while to investigate it and strip it of your environment's specific dependencies like showMessage(Element('cc_msg_err_serialize_data_unknown').value);
If after that all the testcases pass and they're indeed faster I will replace the current implementations with your's

Alexandre Felipe Muller
5 Aug '09

  We're using my serialize and unserialize in my project for 3 years, acording to my tests it's 3 or 4 times faster. Who want to see

	cConnector.prototype.serialize = function(data)
	{	var _thisObject = this;		
		var f = function(data)
		{
			var str_data;
	
			if (data == null || 
				(typeof(data) == 'string' && data == ''))
			{
				str_data = 'N;';
			}
	
			else switch(typeof(data))
			{
				case 'object':
					var arrayCount = 0;
	
					str_data = '';
	
					for (i in data)
					{
						if (i == 'length')
						{
							continue;
						}
						
						arrayCount++;
						switch (typeof(i))
						{
							case 'number':
								str_data += 'i:' + i + ';' + f(data[i]);
								break;
	
							case 'string':
								str_data += 's:' + i.length + ':"' + i + '";' + f(data[i]);
								break;
	
							default:
								showMessage(Element('cc_msg_err_serialize_data_unknown').value);
								break;
						}
					}
	
					if (!arrayCount)
					{
						str_data = 'N;';	
					}
					else
					{
						str_data = 'a:' + arrayCount + ':{' + str_data + '}';
					}
					
					break;
			
				case 'string':
					str_data = 's:' + data.length + ':"' + data + '";';
					break;
					
				case 'number':
					str_data = 'i:' + data + ';';
					break;
	
				case 'boolean':
					str_data = 'b:' + (data ? '1' : '0') + ';';
					break;
	
				default:
					showMessage(Element('cc_msg_err_serialize_data_unknown').value);
					return null;
			}

			return str_data;
		}
	
		return f(data);
	}
	//Unserialize Data Method
	cConnector.prototype.unserialize = function(str)
	{
		_thisObject = this;
		var matchB = function (str, iniPos)
		{
			var nOpen, nClose = iniPos;
			do
			{
				nOpen = str.indexOf('{', nClose+1);
				nClose = str.indexOf('}', nClose+1);

				if (nOpen == -1)
				{
					return nClose;
				}
				if (nOpen < nClose )
				{
					nClose = matchB(str, nOpen);
				}
			} while (nOpen < nClose);

			return nClose;
		}

		var f = function (str)
		{
			switch (str.charAt(0))
			{
				case 'a':
					var data = new Array();
					var n = parseInt( str.substring(str.indexOf(':')+1, str.indexOf(':',2) ) );
					var arrayContent = str.substring(str.indexOf('{')+1, str.lastIndexOf('}'));
					for (var i = 0; i < n; i++)
					{
						var pos = 0;
	
						/* Process Index */
						var indexStr = arrayContent.substr(pos, arrayContent.indexOf(';')+1);
						var index = f(indexStr);
						pos = arrayContent.indexOf(';', pos)+1;
						
						/* Process Content */
						var part = null;
						switch (arrayContent.charAt(pos))
						{
							case 'a':
								var pos_ = matchB(arrayContent, arrayContent.indexOf('{', pos))+1;
								part = arrayContent.substring(pos, pos_);
								pos = pos_;
								data[index] = f(part);
								break;
						
							case 's':
								var pval = arrayContent.indexOf(':', pos+2);
								var val  = parseInt(arrayContent.substring(pos+2, pval));
								pos = pval + val + 4;
								data[index] = arrayContent.substr(pval+2, val);
								break;
	
							default:
								part = arrayContent.substring(pos, arrayContent.indexOf(';', pos)+1);
								pos = arrayContent.indexOf(';', pos)+1;
								data[index] = f(part);
								break;
						}
						arrayContent = arrayContent.substr(pos);
					}
					break;
					
				case 's':
					var pos = str.indexOf(':', 2);
					var val = parseInt(str.substring(2,pos));
					var data = str.substr(pos+2, val);
					str = str.substr(pos + 4 + val);
					break;
	
				case 'i':
				case 'd':
					var pos = str.indexOf(';');
					var data = parseInt(str.substring(2,pos));
					str = str.substr(pos + 1);
					break;
				
				case 'N':
					var data = null;
					str = str.substr(str.indexOf(';') + 1);
					break;
	
				case 'b':
					var data = str.charAt(2) == '1' ? true : false;
					break;
			}
			return data;
		}
	
		return f(str);
	}

Brett Zamir
3 Aug '09

  @Jamie: Fixed in SVN. Thanks for the report!

Jamie Beck
3 Aug '09

  Should not lines 83-84 be as follows for the namespaced version. Otherwise the function cannot be found...

vals += this.serialize(okey) +
    this.serialize(mixed_value[key]);

Brett Zamir
18 Jun '09

  Fixed in SVN! Thanks! (also added your website to the credit)

Russell Walker
16 Jun '09

  I found that if the javascript object has a property which contains a null value, the string cannot be unserialized by PHP. To fix this, I added:

default:
  val = "N";
  break;

...to the end of the switch block (around line 92 on the above function). The 'undefined' case should probably be moved down to the bottom as well so both can be handled together, ie:

case 'undefined':
default:
  val = "N";
  break;

Kevin van Zonneveld
31 May '09

  @ Russell Walker: Thanks for contributing. I've implemented your fix in svn & it will be available shortly.
http://trac.plutonia.nl/projects/phpjs/browser/trunk/functions/var/serialize.js

Russell Walker
30 May '09

  Sorry, I quoted the line number from my own file, but in php.default.js, it is line 5826.

Russell Walker
30 May '09

  I found that when serializing utf-8 characters that differ from iso-8859-1, the string could not be deserialized by PHP. This is because PHP sees the string as containing more characters than it really does (as it thinks 1 character = 1 byte, when unicode characters can take up more than 1 byte). So I amended the code on line 97 from

val = "s:" + mixed_value.length + ":"" + mixed_value + """;

to

val = "s:" + encodeURIComponent(mixed_value).replace(/%../g, 'x').length + ":"" + mixed_value + """;

...so now it serializes utf-8 characters in a way that PHP can deserialize. Note however, that this will probably break the javascript unserialize function, as JS and PHP cannot agree on the number of characters in the string.

The code to get the length of the string in bytes came from DtTvB: http://dt.in.th/2008-09-16.string-length-in-bytes.html

Kevin van Zonneveld
12 May '09

  @ AndreaZ: Thx for the pastebin, this makes it clear to me what's going wrong. You are stripping slashes before you are unserializing the string, while escaped characters are an essential part of of the serialized object.

To circumvent, remove stripslashes, or first use base64_encode over the serialized object, and then in php decode it.

AndreaZ
1 May '09

  @Kevin: http://pastebin.com/m7f1e9ef0

Kevin van Zonneveld
29 Apr '09

  @ AndreaZ: Why don't you put it in pastebin.org, and add a link here. then we have syntax highlighting as well. Thanx!

AndreaZ
25 Apr '09

  @Kevin: i inserted the code inside

but it seems that i wrong something :-(

send me an email, so i can send you the test file

AndreaZ
25 Apr '09

  @Kevin: that's the test code

<html>
<body>
<?php
if (isset($_POST['foo']))
	{
		error_reporting(E_ALL);
		$ar = $_POST['foo'];
		var_dump($ar).'<br/>';
		$ser=stripslashes($ar);
		var_dump($ser).'<br/>';
		$unser = unserialize($ser);
		var_dump($unser).'<br/>';
	}
?>
<script language="javascript" type="text/javascript">
<!--
function clicca() {
	document.adminForm.foo.value = serialize(document.adminForm.foo.value);
}

function serialize( mixed_value ) {
    /* your function */
}
//-->
</script>

<form action="try_serialize.php" method="post" name="adminForm">
<textarea id="foo" name="foo">
a textarea with
newline</textarea>
<br />
<button type="sumbit" onclick="clicca();">Send</button>
</form>
</body>
</html>

Kevin van Zonneveld
20 Apr '09

  @ AndreaZ: Ok if you put the PHP-serialized string inside codeblocks here, I can unserialize it with PHP as well, and then test serializing it with JS.

So if you could provide me with that data that would help me a lot. thx

AndreaZ
20 Apr '09

  @Kevin: i serialized a multidimensional array with your javascript function, then i unserialized the result inside a php file: unserialize returns false (if i serialize with php it works)

how can i send to you the test that i made? it is a little php file with inside your javascript serialize function

PS: thanks a lot for your work ;-)

Kevin van Zonneveld
20 Apr '09

  @ AndreaZ: I did some testing with the following code:

$ser = serialize("a \n b");
var_dump($ser);

.. which is executable by both PHP & JS.
Both return the exact same output:

kevin@kevin-desktop:~/workspace/plutonia-phpjs/_tools$ rhino debug.js 
string(12) "s:5:"a 
 b";"
kevin@kevin-desktop:~/workspace/plutonia-phpjs/_tools$ php debug.php
string(12) "s:5:"a 
 b";"

..so I'm wondering could it be that something else is buggy in the script you are using? If not, can you supply the full input and code that gives the wrong results?

AndreaZ
19 Apr '09

  when there's a newline character (\n) inside a serialized string, php unseriliaze returns false

i don't know why :-(

Kevin van Zonneveld
22 Mar '09

  @ Thomas: You're the first to report. Would it be possible for you to supply test-data?

Thomas
8 Mar '09

  Works fine with php 5.2.0.
But doesn't work with php 5.2.6 ! Php cannot unserialize the string.

Any known issues about this ?

Kevin van Zonneveld
30 Dec '08

  @ Garagoth: Well noticed. That doesn't make any sense at all.

Garagoth
18 Dec '08

  Hm, an interesting line of code, not sure how it is supposed to work:

[CODE="Javascript"]
if (ktype == "function" && ktype == "object") {
continue;
}
[/CODE]

Cheers,
Garagoth.

Kevin van Zonneveld
1 Dec '08

  @ Andrej Pavlovic: Thanks man!

Tom
27 Nov '08

  The returned representation of provided function is valid PHP code (which is correct).
But does anyone have a JS var_export function whose returned representation is valid javascript code?
The returned value type should be string and it could be passed to eval() function.
Examples:

var a = new Array(12, '13', 'abc', 'line1\nline2\nline3');
var js_code = var_export(a);
/*
the returned value should be:
"{0:12, 1:'13', 2:'abc', 3:'line1\nline2\nline3'}"
*/

var b = {'key1':4, 'key2':'5', 'key3':'xxx\n123', 555:'text'};
js_code = var_export(b);
/*
the returned value should be:
"{'key1':4, 'key2':'5', 'key3':'xxx\n123', 555:'text'}"
*/

var c = 123;
js_code = var_export(c); // "123"

var d = '321';
js_code = var_export(d); // "'321'"

var e = 'multilne\ntext';
js_code = var_export(e); // "'multiline\ntext'"

function add(x, y)
{
      res = x + y;
      return res;
}
var js_code = var_export(add);
/*
the returned value should be:
"function add(x, y) { res = x + y; return res; }"
*/

Thanks.

Kevin van Zonneveld
21 Sep '08

  @ Dino: I've committed your changes! Thank you.

mopont
19 Sep '08

  Great function!

dino
19 Sep '08

  woops I don't think my code showed up properly.

[CODE="javascript"]
for (key in mixed_value) {
var ktype = _getType(mixed_value[key]);

//alert(key + ' type is ' + ktype);
if (ktype != "function" && ktype != "object") {
okey = (key.match(/^[0-9]+$/) ? parseInt(key) : key);
vals += serialize(okey) +
serialize(mixed_value[key]);
count++;
}
}
[/CODE]

dino
19 Sep '08

  serialize doesn't work well with mootools since mootools adds or extends the array object with functions which serialize picks up on and tries to translate into a string.

At least it broke my code when I included mootools.

I fixed it by having serialize not try to translate objects or functions. It doesn't seem like functions are being handled anyway.



[CODE="javascript"]
case "function":
val = "";
break;

for (key in mixed_value) {
var ktype = _getType(mixed_value[key]);

//alert(key + ' type is ' + ktype);
if (ktype != "function" && ktype != "object") {
okey = (key.match(/^[0-9]+$/) ? parseInt(key) : key);
vals += serialize(okey) +
serialize(mixed_value[key]);
count++;
}
}

Ren
9 Sep '08

  Sorry plz, it was my fault.
I used htmlspecialchars($_REQUEST), so the variable with serialized string encoded too.
Function works fine :) thx

Kevin van Zonneveld
9 Sep '08

  @ Ren: Can you please provide a print_r of the array in CODE blocks that you are trying to serialize? We need your import to improve this function. Thanks!

Thomas Buschhardt
9 Sep '08

  Hallo, thanx for the code. How can I find out in the returned object the length of the arrays (if these arrays be)?

d3x
31 May '08

  @ Kevin: Arpad Ray's implementation uses "eval" and "eval is evil"(http://blogs.msdn.com/ericlippert/archive/2003/11/01/53329.aspx)

Kevin van Zonneveld
31 May '08

  @ d3x: Do you think that this function beats Arpad Ray's implementation?

d3x
30 May '08

  For every other person that needs an unserialize implementation:

[CODE="Javascript"]
function unserialize(data){
function error(type, msg, filename, line){throw new window[type](msg, filename, line);}
function read_until(data, offset, stopchar){
var buf = [];
var char = data.slice(offset, offset + 1);
var i = 2;
while(char != stopchar){
if((i+offset) > data.length){
error('Error', 'Invalid');
}
buf.push(char);
char = data.slice(offset + (i - 1),offset + i);
i += 1;
}
return [buf.length, buf.join('')];
};
function read_chars(data, offset, length){
buf = [];
for(var i = 0;i < length;i++){
var char = data.slice(offset + (i - 1),offset + i);
buf.push(char);
}
return [buf.length, buf.join('')];
};
function _unserialize(data, offset){
if(!offset) offset = 0;
var buf = [];
var dtype = (data.slice(offset, offset + 1)).toLowerCase();

var dataoffset = offset + 2;
var typeconvert = new Function('x', 'return x');
var chars = 0;
var datalength = 0;

switch(dtype){
case "i":
typeconvert = new Function('x', 'return parseInt(x)');
var readData = read_until(data, dataoffset, ';');
var chars = readData[0];
var readdata = readData[1];
dataoffset += chars + 1;
break;
case "b":
typeconvert = new Function('x', 'return (parseInt(x) == 1)');
var readData = read_until(data, dataoffset, ';');
var chars = readData[0];
var readdata = readData[1];
dataoffset += chars + 1;
break;
case "d":
typeconvert = new Function('x', 'return parseFloat(x)');
var readData = read_until(data, dataoffset, ';');
var chars = readData[0];
var readdata = readData[1];
dataoffset += chars + 1;
break;
case "n":
readdata = null;
break;
case "s":
var ccount = read_until(data, dataoffset, ':');
var chars = ccount[0];
var stringlength = ccount[1];
dataoffset += chars + 2;

var readData = read_chars(data, dataoffset+1, parseInt(stringlength));
var chars = readData[0];
var readdata = readData[1];
dataoffset += chars + 2;
if(chars != parseInt(stringlength) && chars != readdata.length){
error('SyntaxError', 'String length mismatch');
}
break;
case "a":
var readdata = {};

var keyandchars = read_until(data, dataoffset, ':');
var chars = keyandchars[0];
var keys = keyandchars[1];
dataoffset += chars + 2;

for(var i = 0;i < parseInt(keys);i++){
var kprops = _unserialize(data, dataoffset);
var kchars = kprops[1];
var key = kprops[2];
dataoffset += kchars;

var vprops = _unserialize(data, dataoffset);
var vchars = vprops[1];
var value = vprops[2];
dataoffset += vchars;

readdata[key] = value;
}

dataoffset += 1;
break;
default:
error('SyntaxError', 'Unknown / Unhandled data type(s): ' + dtype);
break;
}
return [dtype, dataoffset - offset, typeconvert(readdata)];
};
return _unserialize(data, 0)[2];
}
[/CODE]

Code translated from: http://hurring.com/scott/code/python/serialize/

Kevin van Zonneveld
2 Mar '08

  @ Andrea Giammarchi: Impressive code Andrea! I will look into this and if I use (parts of) it, I will credit you accordingly! Thanks

Andrea Giammarchi
2 Mar '08

  two years ago, 15.000 users, about zero problems:
http://www.devpro.it/javascript_id_102.html

It's able to save correctly UTF-8 strings as well.

Cheers

Kevin van Zonneveld
2 Mar '08

  @ Doug: About unserialize, just now I found a very good javascript unserialize function by Arpad Ray. I've included the function in this project. If Arpad doesn't approve however (I've sent him an email), we will still have to write it ourselves.

Kevin van Zonneveld
28 Feb '08

  @ Doug: Not yet, so feel free!

Doug
28 Feb '08

  Have you started to compile a function for unserialize yet?

Franck Chionna
20 Feb '08

  hello,

i d like to serialize a window object by a js var that contain window.open , thus to keep in memory the window open if the php page is refreshed. i tried to use your code but it says js error "too much recursion... any suggestion ? thanks and congratulation for the work done

Ates Goral
23 Jan '08

  I'll take a look at why serialize() is looping.

Kevin van Zonneveld
23 Jan '08

  @ Ates Goral: Example 14 is giving: too much recursion after implementing the new get_class function in serialize

Kevin van Zonneveld
23 Jan '08

  @ Ates Goral: Works like a charm, I will build this in serialize and add it as a dependency.

About your php-strict/javascript-flexible question. I think we should stay with PHP as close as possible. Hopefully this will provide consistency & clarity for end users. And interoperability between php-js-function throughout the project. This approach should also ensure that no extra function documentation has to be written because PHP's function manual will (in most cases) be valid.

Ates Goral
22 Jan '08

  Here's get_class(). I think serialize() now can re-use this one instead of the local getObjectClass() implementation.

I've added the extra instanceof checks solely to match PHP behaviour. They can be removed since JavaScript has no problem with getting class names for simple types or arrays/functions etc. This brings up the question: Are we trying to mimic PHP behaviour as closely as possible or is it all right to introduce additional functionality brought forth by the flexibility of JavaScript?

[CODE="Javascript"]
function get_class(obj) {
// * example 1: get_class(new (function MyClass() {}));
// * returns 1: "MyClass"
// * example 2: get_class({});
// * returns 2: "Object"
// * example 3: get_class([]);
// * returns 3: false
// * example 4: get_class(42);
// * returns 4: false
// * example 5: get_class(window);
// * returns 5: false
// * example 6: get_class(function MyFunction() {});
// * returns 6: false

if (obj instanceof Object && !(obj instanceof Array) &&
!(obj instanceof Function) && obj.constructor) {
var arr = obj.constructor.toString().match(/function\s*(\w+)/);

if (arr && arr.length == 2) {
return arr[1];
}
}

return false;
}
[/CODE]

Kevin van Zonneveld
22 Jan '08

  @ Ates Goral: Thanks, I've updated the function.

Kevin van Zonneveld
21 Jan '08

  @ uestla: Yes it probably should :) Fixed, thank you!