prosody
81b4e738e4d3
util/serialization.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Annotate

util/serialization.lua @ 2222:81b4e738e4d3 0.6.1

util.serialization: Correctly serialize tables with 'false' as a key, fixes an issue with rosters not saving (thanks mathias, Tobias)
author Matthew Wild <mwild1@gmail.com>
date Wed, 25 Nov 2009 23:45:45 +0000
parent 2149:603134825bdb
child 2923:b7049746bd29
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1523
841d61be198f Remove version number from copyright headers
Matthew Wild <mwild1@gmail.com>
parents: 1135
diff changeset
1 -- Prosody IM
760
90ce865eebd8 Update copyright notices for 2009
Matthew Wild <mwild1@gmail.com>
parents: 759
diff changeset
2 -- Copyright (C) 2008-2009 Matthew Wild
90ce865eebd8 Update copyright notices for 2009
Matthew Wild <mwild1@gmail.com>
parents: 759
diff changeset
3 -- Copyright (C) 2008-2009 Waqas Hussain
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
4 --
758
b1885732e979 GPL->MIT!
Matthew Wild <mwild1@gmail.com>
parents: 615
diff changeset
5 -- This project is MIT/X11 licensed. Please see the
b1885732e979 GPL->MIT!
Matthew Wild <mwild1@gmail.com>
parents: 615
diff changeset
6 -- COPYING file in the source package for more information.
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
7 --
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
8
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
9 local string_rep = string.rep;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
10 local type = type;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
11 local tostring = tostring;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
12 local t_insert = table.insert;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
13 local t_concat = table.concat;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
14 local error = error;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15 local pairs = pairs;
2148
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
16 local next = next;
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17
1107
ebda1845ebc1 util.serialization: Log a warning when trying to serialize something we can't
Matthew Wild <mwild1@gmail.com>
parents: 896
diff changeset
18 local debug_traceback = debug.traceback;
ebda1845ebc1 util.serialization: Log a warning when trying to serialize something we can't
Matthew Wild <mwild1@gmail.com>
parents: 896
diff changeset
19 local log = require "util.logger".init("serialization");
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
20 module "serialization"
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
21
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
22 local indent = function(i)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
23 return string_rep("\t", i);
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
24 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
25 local function basicSerialize (o)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
26 if type(o) == "number" or type(o) == "boolean" then
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
27 return tostring(o);
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
28 else -- assume it is a string -- FIXME make sure it's a string. throw an error otherwise.
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
29 return (("%q"):format(tostring(o)):gsub("\\\n", "\\n"));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
30 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
31 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
32 local function _simplesave(o, ind, t, func)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
33 if type(o) == "number" then
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
34 func(t, tostring(o));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
35 elseif type(o) == "string" then
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
36 func(t, (("%q"):format(o):gsub("\\\n", "\\n")));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
37 elseif type(o) == "table" then
2222
81b4e738e4d3 util.serialization: Correctly serialize tables with 'false' as a key, fixes an issue with rosters not saving (thanks mathias, Tobias)
Matthew Wild <mwild1@gmail.com>
parents: 2149
diff changeset
38 if next(o) ~= nil then
2148
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
39 func(t, "{\n");
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
40 for k,v in pairs(o) do
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
41 func(t, indent(ind));
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
42 func(t, "[");
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
43 func(t, basicSerialize(k));
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
44 func(t, "] = ");
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
45 if ind == 0 then
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
46 _simplesave(v, 0, t, func);
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
47 else
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
48 _simplesave(v, ind+1, t, func);
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
49 end
2149
603134825bdb util.serialization: Replaced commas with semi-colons between table fields.
Waqas Hussain <waqas20@gmail.com>
parents: 2148
diff changeset
50 func(t, ";\n");
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
51 end
2148
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
52 func(t, indent(ind-1));
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
53 func(t, "}");
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
54 else
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
55 func(t, "{}");
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
56 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
57 elseif type(o) == "boolean" then
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
58 func(t, (o and "true" or "false"));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
59 else
1128
b2e548344d61 util.serialization: Write nil for non-serializable data types, and bump the log level to 'error'
Matthew Wild <mwild1@gmail.com>
parents: 1107
diff changeset
60 log("error", "cannot serialize a %s: %s", type(o), debug_traceback())
1135
355f9487ab38 util/serialization: Fixed serialization formatting
Waqas Hussain <waqas20@gmail.com>
parents: 1128
diff changeset
61 func(t, "nil");
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
62 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
63 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
64
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
65 function append(t, o)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
66 _simplesave(o, 1, t, t.write or t_insert);
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
67 return t;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
68 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
69
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
70 function serialize(o)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
71 return t_concat(append({}, o));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
72 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
73
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
74 function deserialize(str)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
75 error("Not implemented");
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
76 end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
77
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
78 return _M;