util/serialization.lua
author Kim Alvefur <zash@zash.se>
Sat, 27 Apr 2013 19:44:37 +0200
changeset 5530 d83482fc4a81
parent 5021 85b2689dbcfe
child 5776 bd0ff8ae98a8
permissions -rw-r--r--
moduleapi: in module:provides(), add the name of the module in item._provided_by
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1523
841d61be198f Remove version number from copyright headers
Matthew Wild <mwild1@gmail.com>
parents: 1135
diff changeset
     1
-- Prosody IM
2923
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2222
diff changeset
     2
-- Copyright (C) 2008-2010 Matthew Wild
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2222
diff changeset
     3
-- Copyright (C) 2008-2010 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
3736
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    18
local loadstring = loadstring;
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    19
local pcall = pcall;
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    20
1107
ebda1845ebc1 util.serialization: Log a warning when trying to serialize something we can't
Matthew Wild <mwild1@gmail.com>
parents: 896
diff changeset
    21
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
    22
local log = require "util.logger".init("serialization");
5021
85b2689dbcfe Eliminate direct setfenv usage
Florian Zeitz <florob@babelmonkeys.de>
parents: 3745
diff changeset
    23
local envload = require"util.envload".envload;
85b2689dbcfe Eliminate direct setfenv usage
Florian Zeitz <florob@babelmonkeys.de>
parents: 3745
diff changeset
    24
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    25
module "serialization"
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    26
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    27
local indent = function(i)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    28
	return string_rep("\t", i);
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    29
end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    30
local function basicSerialize (o)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    31
	if type(o) == "number" or type(o) == "boolean" then
3745
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    32
		-- no need to check for NaN, as that's not a valid table index
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    33
		if o == 1/0 then return "(1/0)";
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    34
		elseif o == -1/0 then return "(-1/0)";
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    35
		else return tostring(o); end
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    36
	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
    37
		return (("%q"):format(tostring(o)):gsub("\\\n", "\\n"));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    38
	end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    39
end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    40
local function _simplesave(o, ind, t, func)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    41
	if type(o) == "number" then
3745
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    42
		if o ~= o then func(t, "(0/0)");
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    43
		elseif o == 1/0 then func(t, "(1/0)");
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    44
		elseif o == -1/0 then func(t, "(-1/0)");
87f6eabd90c9 util.serialization: Proper serialization of Infinity, -Infinity and NaN.
Waqas Hussain <waqas20@gmail.com>
parents: 3736
diff changeset
    45
		else func(t, tostring(o)); end
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    46
	elseif type(o) == "string" then
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    47
		func(t, (("%q"):format(o):gsub("\\\n", "\\n")));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    48
	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
    49
		if next(o) ~= nil then
2148
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    50
			func(t, "{\n");
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    51
			for k,v in pairs(o) do
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    52
				func(t, indent(ind));
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
				func(t, basicSerialize(k));
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    55
				func(t, "] = ");
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    56
				if ind == 0 then
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    57
					_simplesave(v, 0, t, func);
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    58
				else
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    59
					_simplesave(v, ind+1, t, func);
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    60
				end
2149
603134825bdb util.serialization: Replaced commas with semi-colons between table fields.
Waqas Hussain <waqas20@gmail.com>
parents: 2148
diff changeset
    61
				func(t, ";\n");
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    62
			end
2148
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    63
			func(t, indent(ind-1));
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    64
			func(t, "}");
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    65
		else
5590c13552ab util.serialization: Concise output for empty tables.
Waqas Hussain <waqas20@gmail.com>
parents: 1523
diff changeset
    66
			func(t, "{}");
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    67
		end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    68
	elseif type(o) == "boolean" then
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    69
		func(t, (o and "true" or "false"));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    70
	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
    71
		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
    72
		func(t, "nil");
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    73
	end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    74
end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    75
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    76
function append(t, o)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    77
	_simplesave(o, 1, t, t.write or t_insert);
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    78
	return t;
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    79
end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    80
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    81
function serialize(o)
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    82
	return t_concat(append({}, o));
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    83
end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    84
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    85
function deserialize(str)
3736
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    86
	if type(str) ~= "string" then return nil; end
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    87
	str = "return "..str;
5021
85b2689dbcfe Eliminate direct setfenv usage
Florian Zeitz <florob@babelmonkeys.de>
parents: 3745
diff changeset
    88
	local f, err = envload(str, "@data", {});
3736
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    89
	if not f then return nil, err; end
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    90
	local success, ret = pcall(f);
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    91
	if not success then return nil, ret; end
73399dd525e8 util.serialization: Implemented deserialize().
Waqas Hussain <waqas20@gmail.com>
parents: 2923
diff changeset
    92
	return ret;
546
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    93
end
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    94
1e65f64dfabf Added module util.serialization
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    95
return _M;