2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
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;
20 local ipairs = ipairs;
24 local unpack = unpack;
25 local s_gsub = string.gsub;
26 local s_char = string.char;
27 local s_find = string.find;
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");
35 getstyle, getstring = termcolours.getstyle, termcolours.getstring;
37 do_pretty_printing = nil;
41 local xmlns_stanzas = "urn:ietf:params:xml:ns:xmpp-stanzas";
45 stanza_mt = { __type = "stanza" };
46 stanza_mt.__index = stanza_mt;
48 function stanza(name, attr)
49 local stanza = { name = name, attr = attr or {}, tags = {} };
50 return setmetatable(stanza, stanza_mt);
53 function stanza_mt:query(xmlns)
54 return self:tag("query", { xmlns = xmlns });
57 function stanza_mt:body(text, attr)
58 return self:tag("body", attr):text(text);
61 function stanza_mt:tag(name, attrs)
62 local s = stanza(name, attrs);
63 local last_add = self.last_add;
64 if not last_add then last_add = {}; self.last_add = last_add; end
65 (last_add[#last_add] or self):add_direct_child(s);
66 t_insert(last_add, s);
70 function stanza_mt:text(text)
71 local last_add = self.last_add;
72 (last_add and last_add[#last_add] or self):add_direct_child(text);
76 function stanza_mt:up()
77 local last_add = self.last_add;
78 if last_add then t_remove(last_add); end
82 function stanza_mt:reset()
87 function stanza_mt:add_direct_child(child)
88 if type(child) == "table" then
89 t_insert(self.tags, child);
91 t_insert(self, child);
94 function stanza_mt:add_child(child)
95 local last_add = self.last_add;
96 (last_add and last_add[#last_add] or self):add_direct_child(child);
100 function stanza_mt:get_child(name, xmlns)
101 for _, child in ipairs(self.tags) do
102 if (not name or child.name == name)
103 and ((not xmlns and self.attr.xmlns == child.attr.xmlns)
104 or child.attr.xmlns == xmlns) then
111 function stanza_mt:get_child_text(name, xmlns)
112 local tag = self:get_child(name, xmlns);
114 return tag:get_text();
119 function stanza_mt:child_with_name(name)
120 for _, child in ipairs(self.tags) do
121 if child.name == name then return child; end
125 function stanza_mt:child_with_ns(ns)
126 for _, child in ipairs(self.tags) do
127 if child.attr.xmlns == ns then return child; end
131 function stanza_mt:children()
139 function stanza_mt:matching_tags(name, xmlns)
140 xmlns = xmlns or self.attr.xmlns;
141 local tags = self.tags;
142 local start_i, max_i = 1, #tags;
144 for i=start_i,max_i do
146 if (not name or v.name == name)
147 and (not xmlns or xmlns == v.attr.xmlns) then
155 function stanza_mt:childtags()
159 local v = self.tags[i]
160 if v then return v; end
161 end, self.tags[1], i;
164 function stanza_mt:maptags(callback)
165 local tags, curr_tag = self.tags, 1;
166 local n_children, n_tags = #self, #tags;
169 while curr_tag <= n_tags do
170 if self[i] == tags[curr_tag] then
171 local ret = callback(self[i]);
174 t_remove(tags, curr_tag);
175 n_children = n_children - 1;
182 curr_tag = curr_tag + 1;
190 local escape_table = { ["'"] = "'", ["\""] = """, ["<"] = "<", [">"] = ">", ["&"] = "&" };
191 function xml_escape(str) return (s_gsub(str, "['&<>\"]", escape_table)); end
192 _M.xml_escape = xml_escape;
195 local function _dostring(t, buf, self, xml_escape, parentns)
198 t_insert(buf, "<"..name);
199 for k, v in pairs(t.attr) do
200 if s_find(k, "\1", 1, true) then
201 local ns, attrk = s_match(k, "^([^\1]*)\1?(.*)$");
203 t_insert(buf, " xmlns:ns"..nsid.."='"..xml_escape(ns).."' ".."ns"..nsid..":"..attrk.."='"..xml_escape(v).."'");
204 elseif not(k == "xmlns" and v == parentns) then
205 t_insert(buf, " "..k.."='"..xml_escape(v).."'");
216 self(child, buf, self, xml_escape, t.attr.xmlns);
218 t_insert(buf, xml_escape(child));
221 t_insert(buf, "</"..name..">");
224 function stanza_mt.__tostring(t)
226 _dostring(t, buf, _dostring, xml_escape, nil);
227 return t_concat(buf);
230 function stanza_mt.top_tag(t)
231 local attr_string = "";
233 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
235 return s_format("<%s%s>", t.name, attr_string);
238 function stanza_mt.get_text(t)
244 function stanza_mt.get_error(stanza)
245 local type, condition, text;
247 local error_tag = stanza:get_child("error");
248 if not error_tag then
249 return nil, nil, nil;
251 type = error_tag.attr.type;
253 for child in error_tag:childtags() do
254 if child.attr.xmlns == xmlns_stanzas then
255 if not text and child.name == "text" then
256 text = child:get_text();
257 elseif not condition then
258 condition = child.name;
260 if condition and text then
265 return type, condition or "undefined-condition", text;
268 function stanza_mt.__add(s1, s2)
269 return s1:add_direct_child(s2);
281 function preserialize(stanza)
282 local s = { name = stanza.name, attr = stanza.attr };
283 for _, child in ipairs(stanza) do
284 if type(child) == "table" then
285 t_insert(s, preserialize(child));
293 function deserialize(stanza)
296 local attr = stanza.attr;
297 for i=1,#attr do attr[i] = nil; end
299 for att in pairs(attr) do
300 if s_find(att, "|", 1, true) and not s_find(att, "\1", 1, true) then
301 local ns,na = s_match(att, "^([^|]+)|(.+)$");
302 attrx[ns.."\1"..na] = attr[att];
306 for a,v in pairs(attrx) do
309 setmetatable(stanza, stanza_mt);
310 for _, child in ipairs(stanza) do
311 if type(child) == "table" then
315 if not stanza.tags then
318 for _, child in ipairs(stanza) do
319 if type(child) == "table" then
320 t_insert(tags, child);
330 function clone(stanza)
331 local lookup_table = {};
332 local function _copy(object)
333 if type(object) ~= "table" then
335 elseif lookup_table[object] then
336 return lookup_table[object];
338 local new_table = {};
339 lookup_table[object] = new_table;
340 for index, value in pairs(object) do
341 new_table[_copy(index)] = _copy(value);
343 return setmetatable(new_table, getmetatable(object));
349 function message(attr, body)
351 return stanza("message", attr);
353 return stanza("message", attr):tag("body"):text(body):up();
357 if attr and not attr.id then attr.id = new_id(); end
358 return stanza("iq", attr or { id = new_id() });
362 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) });
366 local xmpp_stanzas_attr = { xmlns = xmlns_stanzas };
367 function error_reply(orig, type, condition, message)
368 local t = reply(orig);
369 t.attr.type = "error";
370 t:tag("error", {type = type}) --COMPAT: Some day xmlns:stanzas goes here
371 :tag(condition, xmpp_stanzas_attr):up();
372 if (message) then t:tag("text", xmpp_stanzas_attr):text(message):up(); end
373 return t; -- stanza ready for adding app-specific errors
377 function presence(attr)
378 return stanza("presence", attr);
381 if do_pretty_printing then
382 local style_attrk = getstyle("yellow");
383 local style_attrv = getstyle("red");
384 local style_tagname = getstyle("red");
385 local style_punc = getstyle("magenta");
387 local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
388 local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
389 --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, ">");
390 local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
391 function stanza_mt.pretty_print(t)
392 local children_text = "";
393 for n, child in ipairs(t) do
394 if type(child) == "string" then
395 children_text = children_text .. xml_escape(child);
397 children_text = children_text .. child:pretty_print();
401 local attr_string = "";
403 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
405 return s_format(tag_format, t.name, attr_string, children_text, t.name);
408 function stanza_mt.pretty_top_tag(t)
409 local attr_string = "";
411 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
413 return s_format(top_tag_format, t.name, attr_string);
416 -- Sorry, fresh out of colours for you guys ;)
417 stanza_mt.pretty_print = stanza_mt.__tostring;
418 stanza_mt.pretty_top_tag = stanza_mt.top_tag;