PHP's unserialize in JavaScript

Here’s what our current JavaScript equivalent to PHP's unserialize looks like.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
module.exports = function unserialize (data) {
// discuss at: http://locutus.io/php/unserialize/
// original by: Arpad Ray (mailto:arpad@php.net)
// improved by: Pedro Tainha (http://www.pedrotainha.com)
// improved by: Kevin van Zonneveld (http://kvz.io)
// improved by: Kevin van Zonneveld (http://kvz.io)
// improved by: Chris
// improved by: James
// improved by: Le Torbi
// improved by: Eli Skeggs
// bugfixed by: dptr1988
// bugfixed by: Kevin van Zonneveld (http://kvz.io)
// bugfixed by: Brett Zamir (http://brett-zamir.me)
// bugfixed by: philippsimon (https://github.com/philippsimon/)
// revised by: d3x
// input by: Brett Zamir (http://brett-zamir.me)
// input by: Martin (http://www.erlenwiese.de/)
// input by: kilops
// input by: Jaroslaw Czarniak
// input by: lovasoa (https://github.com/lovasoa/)
// note 1: We feel the main purpose of this function should be
// note 1: to ease the transport of data between php & js
// note 1: Aiming for PHP-compatibility, we have to translate objects to arrays
// example 1: unserialize('a:3:{i:0;s:5:"Kevin";i:1;s:3:"van";i:2;s:9:"Zonneveld";}')
// returns 1: ['Kevin', 'van', 'Zonneveld']
// example 2: unserialize('a:2:{s:9:"firstName";s:5:"Kevin";s:7:"midName";s:3:"van";}')
// returns 2: {firstName: 'Kevin', midName: 'van'}
// example 3: unserialize('a:3:{s:2:"ü";s:2:"ü";s:3:"四";s:3:"四";s:4:"𠜎";s:4:"𠜎";}')
// returns 3: {'ü': 'ü', '四': '四', '𠜎': '𠜎'}

var $global = (typeof window !== 'undefined' ? window : global)

var utf8Overhead = function (str) {
var s = str.length
for (var i = str.length - 1; i >= 0; i--) {
var code = str.charCodeAt(i)
if (code > 0x7f && code <= 0x7ff) {
s++
} else if (code > 0x7ff && code <= 0xffff) {
s += 2
}
// trail surrogate
if (code >= 0xDC00 && code <= 0xDFFF) {
i--
}
}
return s - 1
}
var error = function (type,
msg, filename, line)
{

throw new $global[type](msg, filename, line)
}
var readUntil = function (data, offset, stopchr) {
var i = 2
var buf = []
var chr = data.slice(offset, offset + 1)

while (chr !== stopchr) {
if ((i + offset) > data.length) {
error('Error', 'Invalid')
}
buf.push(chr)
chr = data.slice(offset + (i - 1), offset + i)
i += 1
}
return [buf.length, buf.join('')]
}
var readChrs = function (data, offset, length) {
var i, chr, buf

buf = []
for (i = 0; i < length; i++) {
chr = data.slice(offset + (i - 1), offset + i)
buf.push(chr)
length -= utf8Overhead(chr)
}
return [buf.length, buf.join('')]
}
function _unserialize (data, offset) {
var dtype
var dataoffset
var keyandchrs
var keys
var contig
var length
var array
var readdata
var readData
var ccount
var stringlength
var i
var key
var kprops
var kchrs
var vprops
var vchrs
var value
var chrs = 0
var typeconvert = function (x) {
return x
}

if (!offset) {
offset = 0
}
dtype = (data.slice(offset, offset + 1)).toLowerCase()

dataoffset = offset + 2

switch (dtype) {
case 'i':
typeconvert = function (x) {
return parseInt(x, 10)
}
readData = readUntil(data, dataoffset, ';')
chrs = readData[0]
readdata = readData[1]
dataoffset += chrs + 1
break
case 'b':
typeconvert = function (x) {
return parseInt(x, 10) !== 0
}
readData = readUntil(data, dataoffset, ';')
chrs = readData[0]
readdata = readData[1]
dataoffset += chrs + 1
break
case 'd':
typeconvert = function (x) {
return parseFloat(x)
}
readData = readUntil(data, dataoffset, ';')
chrs = readData[0]
readdata = readData[1]
dataoffset += chrs + 1
break
case 'n':
readdata = null
break
case 's':
ccount = readUntil(data, dataoffset, ':')
chrs = ccount[0]
stringlength = ccount[1]
dataoffset += chrs + 2

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

keyandchrs = readUntil(data, dataoffset, ':')
chrs = keyandchrs[0]
keys = keyandchrs[1]
dataoffset += chrs + 2

length = parseInt(keys, 10)
contig = true

for (i = 0; i < length; i++) {
kprops = _unserialize(data, dataoffset)
kchrs = kprops[1]
key = kprops[2]
dataoffset += kchrs

vprops = _unserialize(data, dataoffset)
vchrs = vprops[1]
value = vprops[2]
dataoffset += vchrs

if (key !== i) {
contig = false
}

readdata[key] = value
}

if (contig) {
array = new Array(length)
for (i = 0; i < length; i++) {
array[i] = readdata[i]
}
readdata = array
}

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

return _unserialize((data + ''), 0)[2]
}
[ View on GitHub | Edit on GitHub | Source on GitHub ]

How to use

You you can install via npm install locutus and require it via require('locutus/php/var/unserialize'). You could also require the var module in full so that you could access var.unserialize instead.

If you intend to target the browser, you can then use a module bundler such as Browserify, webpack or rollup.js.

ES5/ES6

This function targets ES5, but as of Locutus 2.0.2 we also support ES6 functions. Locutus transpiles to ES5 before publishing to npm.

A community effort

Not unlike Wikipedia, Locutus is an ongoing community effort. Our philosophy follows The McDonald’s Theory. This means that we don't consider it to be a bad thing that many of our functions are first iterations, which may still have their fair share of issues. We hope that these flaws will inspire others to come up with better ideas.

This way of working also means that we don't offer any production guarantees, and recommend to use Locutus inspiration and learning purposes only.

Notes

  • We feel the main purpose of this function should be to ease the transport of data between php & js Aiming for PHP-compatibility, we have to translate objects to arrays

Examples

Please note that these examples are distilled from test cases that automatically verify our functions still work correctly. This could explain some quirky ones.

#codeexpected result
1unserialize('a:3:{i:0;s:5:"Kevin";i:1;s:3:"van";i:2;s:9:"Zonneveld";}')['Kevin', 'van', 'Zonneveld']
2unserialize('a:2:{s:9:"firstName";s:5:"Kevin";s:7:"midName";s:3:"van";}'){firstName: 'Kevin', midName: 'van'}
3unserialize('a:3:{s:2:"ü";s:2:"ü";s:3:"四";s:3:"四";s:4:"𠜎";s:4:"𠜎";}'){'ü': 'ü', '四': '四', '𠜎': '𠜎'}

« More PHP var functions