stanza.lua

1
-- Prosody IM
2
-- Copyright (C) 2008-2010 Matthew Wild
3
-- Copyright (C) 2008-2010 Waqas Hussain
4
-- 
5
-- This project is MIT/X11 licensed. Please see the
6
-- COPYING file in the source package for more information.
7
--
8
 
9
 
10
local t_insert      =  table.insert;
11
local t_concat      =  table.concat;
12
local t_remove      =  table.remove;
13
local t_concat      =  table.concat;
14
local s_format      = string.format;
15
local s_match       =  string.match;
16
local tostring      =      tostring;
17
local setmetatable  =  setmetatable;
18
local getmetatable  =  getmetatable;
19
local pairs         =         pairs;
20
local ipairs        =        ipairs;
21
local type          =          type;
22
local next          =          next;
23
local print         =         print;
24
local unpack        =        unpack;
25
local s_gsub        =   string.gsub;
26
local s_char        =   string.char;
27
local s_find        =   string.find;
28
local os            =            os;
29
 
30
local do_pretty_printing = not os.getenv("WINDIR");
31
local getstyle, getstring;
32
if do_pretty_printing then
33
	local ok, termcolours = pcall(require, "util.termcolours");
34
	if ok then
35
		getstyle, getstring = termcolours.getstyle, termcolours.getstring;
36
	else
37
		do_pretty_printing = nil;
38
	end
39
end
40
 
41
local xmlns_stanzas = "urn:ietf:params:xml:ns:xmpp-stanzas";
42
 
43
module "stanza"
44
 
45
stanza_mt = { __type = "stanza" };
46
stanza_mt.__index = stanza_mt;
47
 
48
function stanza(name, attr)
49
	local stanza = { name = name, attr = attr or {}, tags = {}, last_add = {}};
50
	return setmetatable(stanza, stanza_mt);
51
end
52
 
53
function stanza_mt:query(xmlns)
54
	return self:tag("query", { xmlns = xmlns });
55
end
56
 
57
function stanza_mt:body(text, attr)
58
	return self:tag("body", attr):text(text);
59
end
60
 
61
function stanza_mt:tag(name, attrs)
62
	local s = stanza(name, attrs);
63
	(self.last_add[#self.last_add] or self):add_direct_child(s);
64
	t_insert(self.last_add, s);
65
	return self;
66
end
67
 
68
function stanza_mt:text(text)
69
	(self.last_add[#self.last_add] or self):add_direct_child(text);
70
	return self;
71
end
72
 
73
function stanza_mt:up()
74
	t_remove(self.last_add);
75
	return self;
76
end
77
 
78
function stanza_mt:reset()
79
	local last_add = self.last_add;
80
	for i = 1,#last_add do
81
		last_add[i] = nil;
82
	end
83
	return self;
84
end
85
 
86
function stanza_mt:add_direct_child(child)
87
	if type(child) == "table" then
88
		t_insert(self.tags, child);
89
	end
90
	t_insert(self, child);
91
end
92
 
93
function stanza_mt:add_child(child)
94
	(self.last_add[#self.last_add] or self):add_direct_child(child);
95
	return self;
96
end
97
 
98
function stanza_mt:get_child(name, xmlns)
99
	for _, child in ipairs(self.tags) do
100
		if (not name or child.name == name)
101
			and ((not xmlns and self.attr.xmlns == child.attr.xmlns)
102
				or child.attr.xmlns == xmlns) then
103
			
104
			return child;
105
		end
106
	end
107
end
108
 
109
function stanza_mt:child_with_name(name)
110
	for _, child in ipairs(self.tags) do
111
		if child.name == name then return child; end
112
	end
113
end
114
 
115
function stanza_mt:child_with_ns(ns)
116
	for _, child in ipairs(self.tags) do
117
		if child.attr.xmlns == ns then return child; end
118
	end
119
end
120
 
121
function stanza_mt:children()
122
	local i = 0;
123
	return function (a)
124
			i = i + 1
125
			local v = a[i]
126
			if v then return v; end
127
		end, self, i;
128
end
129
function stanza_mt:childtags()
130
	local i = 0;
131
	return function (a)
132
			i = i + 1
133
			local v = self.tags[i]
134
			if v then return v; end
135
		end, self.tags[1], i;
136
end
137
 
138
local xml_escape
139
do
140
	local escape_table = { ["'"] = "&apos;", ["\""] = "&quot;", ["<"] = "&lt;", [">"] = "&gt;", ["&"] = "&amp;" };
141
	function xml_escape(str) return (s_gsub(str, "['&<>\"]", escape_table)); end
142
	_M.xml_escape = xml_escape;
143
end
144
 
145
local function _dostring(t, buf, self, xml_escape, parentns)
146
	local nsid = 0;
147
	local name = t.name
148
	t_insert(buf, "<"..name);
149
	for k, v in pairs(t.attr) do
150
		if s_find(k, "\1", 1, true) then
151
			local ns, attrk = s_match(k, "^([^\1]*)\1?(.*)$");
152
			nsid = nsid + 1;
153
			t_insert(buf, " xmlns:ns"..nsid.."='"..xml_escape(ns).."' ".."ns"..nsid..":"..attrk.."='"..xml_escape(v).."'");
154
		elseif not(k == "xmlns" and v == parentns) then
155
			t_insert(buf, " "..k.."='"..xml_escape(v).."'");
156
		end
157
	end
158
	local len = #t;
159
	if len == 0 then
160
		t_insert(buf, "/>");
161
	else
162
		t_insert(buf, ">");
163
		for n=1,len do
164
			local child = t[n];
165
			if child.name then
166
				self(child, buf, self, xml_escape, t.attr.xmlns);
167
			else
168
				t_insert(buf, xml_escape(child));
169
			end
170
		end
171
		t_insert(buf, "</"..name..">");
172
	end
173
end
174
function stanza_mt.__tostring(t)
175
	local buf = {};
176
	_dostring(t, buf, _dostring, xml_escape, nil);
177
	return t_concat(buf);
178
end
179
 
180
function stanza_mt.top_tag(t)
181
	local attr_string = "";
182
	if t.attr then
183
		for k, v in pairs(t.attr) do if type(k) == "string" then attr_string = attr_string .. s_format(" %s='%s'", k, xml_escape(tostring(v))); end end
184
	end
185
	return s_format("<%s%s>", t.name, attr_string);
186
end
187
 
188
function stanza_mt.get_text(t)
189
	if #t.tags == 0 then
190
		return t_concat(t);
191
	end
192
end
193
 
194
function stanza_mt.get_error(stanza)
195
	local type, condition, text;
196
	
197
	local error_tag = stanza:get_child("error");
198
	if not error_tag then
199
		return nil, nil, nil;
200
	end
201
	type = error_tag.attr.type;
202
	
203
	for child in error_tag:children() do
204
		if child.attr.xmlns == xmlns_stanzas then
205
			if not text and child.name == "text" then
206
				text = child:get_text();
207
			elseif not condition then
208
				condition = child.name;
209
			end
210
			if condition and text then
211
				break;
212
			end
213
		end
214
	end
215
	return type, condition or "undefined-condition", text or "";
216
end
217
 
218
function stanza_mt.__add(s1, s2)
219
	return s1:add_direct_child(s2);
220
end
221
 
222
 
223
do
224
	local id = 0;
225
	function new_id()
226
		id = id + 1;
227
		return "lx"..id;
228
	end
229
end
230
 
231
function preserialize(stanza)
232
	local s = { name = stanza.name, attr = stanza.attr };
233
	for _, child in ipairs(stanza) do
234
		if type(child) == "table" then
235
			t_insert(s, preserialize(child));
236
		else
237
			t_insert(s, child);
238
		end
239
	end
240
	return s;
241
end
242
 
243
function deserialize(stanza)
244
	-- Set metatable
245
	if stanza then
246
		local attr = stanza.attr;
247
		for i=1,#attr do attr[i] = nil; end
248
		local attrx = {};
249
		for att in pairs(attr) do
250
			if s_find(att, "|", 1, true) and not s_find(att, "\1", 1, true) then
251
				local ns,na = s_match(att, "^([^|]+)|(.+)$");
252
				attrx[ns.."\1"..na] = attr[att];
253
				attr[att] = nil;
254
			end
255
		end
256
		for a,v in pairs(attrx) do
257
			attr[a] = v;
258
		end
259
		setmetatable(stanza, stanza_mt);
260
		for _, child in ipairs(stanza) do
261
			if type(child) == "table" then
262
				deserialize(child);
263
			end
264
		end
265
		if not stanza.tags then
266
			-- Rebuild tags
267
			local tags = {};
268
			for _, child in ipairs(stanza) do
269
				if type(child) == "table" then
270
					t_insert(tags, child);
271
				end
272
			end
273
			stanza.tags = tags;
274
			if not stanza.last_add then
275
				stanza.last_add = {};
276
			end
277
		end
278
	end
279
	
280
	return stanza;
281
end
282
 
283
function clone(stanza)
284
	local lookup_table = {};
285
	local function _copy(object)
286
		if type(object) ~= "table" then
287
			return object;
288
		elseif lookup_table[object] then
289
			return lookup_table[object];
290
		end
291
		local new_table = {};
292
		lookup_table[object] = new_table;
293
		for index, value in pairs(object) do
294
			new_table[_copy(index)] = _copy(value);
295
		end
296
		return setmetatable(new_table, getmetatable(object));
297
	end
298
	
299
	return _copy(stanza)
300
end
301
 
302
function message(attr, body)
303
	if not body then
304
		return stanza("message", attr);
305
	else
306
		return stanza("message", attr):tag("body"):text(body);
307
	end
308
end
309
function iq(attr)
310
	if attr and not attr.id then attr.id = new_id(); end
311
	return stanza("iq", attr or { id = new_id() });
312
end
313
 
314
function reply(orig)
315
	return stanza(orig.name, orig.attr and { to = orig.attr.from, from = orig.attr.to, id = orig.attr.id, type = ((orig.name == "iq" and "result") or orig.attr.type) });
316
end
317
 
318
do
319
	local xmpp_stanzas_attr = { xmlns = xmlns_stanzas };
320
	function error_reply(orig, type, condition, message)
321
		local t = reply(orig);
322
		t.attr.type = "error";
323
		t:tag("error", {type = type}) --COMPAT: Some day xmlns:stanzas goes here
324
			:tag(condition, xmpp_stanzas_attr):up();
325
		if (message) then t:tag("text", xmpp_stanzas_attr):text(message):up(); end
326
		return t; -- stanza ready for adding app-specific errors
327
	end
328
end
329
 
330
function presence(attr)
331
	return stanza("presence", attr);
332
end
333
 
334
if do_pretty_printing then
335
	local style_attrk = getstyle("yellow");
336
	local style_attrv = getstyle("red");
337
	local style_tagname = getstyle("red");
338
	local style_punc = getstyle("magenta");
339
	
340
	local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
341
	local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
342
	--local tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">").."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
343
	local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
344
	function stanza_mt.pretty_print(t)
345
		local children_text = "";
346
		for n, child in ipairs(t) do
347
			if type(child) == "string" then
348
				children_text = children_text .. xml_escape(child);
349
			else
350
				children_text = children_text .. child:pretty_print();
351
			end
352
		end
353
 
354
		local attr_string = "";
355
		if t.attr then
356
			for k, v in pairs(t.attr) do if type(k) == "string" then attr_string = attr_string .. s_format(attr_format, k, tostring(v)); end end
357
		end
358
		return s_format(tag_format, t.name, attr_string, children_text, t.name);
359
	end
360
	
361
	function stanza_mt.pretty_top_tag(t)
362
		local attr_string = "";
363
		if t.attr then
364
			for k, v in pairs(t.attr) do if type(k) == "string" then attr_string = attr_string .. s_format(attr_format, k, tostring(v)); end end
365
		end
366
		return s_format(top_tag_format, t.name, attr_string);
367
	end
368
else
369
	-- Sorry, fresh out of colours for you guys ;)
370
	stanza_mt.pretty_print = stanza_mt.__tostring;
371
	stanza_mt.pretty_top_tag = stanza_mt.top_tag;
372
end
373
 
374
return _M;