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_remove = table.remove;
12 local t_concat = table.concat;
13 local s_format = string.format;
14 local s_match = string.match;
15 local tostring = tostring;
16 local setmetatable = setmetatable;
18 local ipairs = ipairs;
20 local s_gsub = string.gsub;
21 local s_sub = string.sub;
22 local s_find = string.find;
25 local do_pretty_printing = not os.getenv("WINDIR");
26 local getstyle, getstring;
27 if do_pretty_printing then
28 local ok, termcolours = pcall(require, "util.termcolours");
30 getstyle, getstring = termcolours.getstyle, termcolours.getstring;
32 do_pretty_printing = nil;
36 local xmlns_stanzas = "urn:ietf:params:xml:ns:xmpp-stanzas";
40 local stanza_mt = { __type = "stanza" };
41 stanza_mt.__index = stanza_mt;
43 local function stanza(name, attr)
44 local stanza = { name = name, attr = attr or {}, tags = {} };
45 return setmetatable(stanza, stanza_mt);
47 local stanza = stanza;
49 function stanza_mt:query(xmlns)
50 return self:tag("query", { xmlns = xmlns });
53 function stanza_mt:body(text, attr)
54 return self:tag("body", attr):text(text);
57 function stanza_mt:tag(name, attrs)
58 local s = stanza(name, attrs);
59 local last_add = self.last_add;
60 if not last_add then last_add = {}; self.last_add = last_add; end
61 (last_add[#last_add] or self):add_direct_child(s);
62 t_insert(last_add, s);
66 function stanza_mt:text(text)
67 local last_add = self.last_add;
68 (last_add and last_add[#last_add] or self):add_direct_child(text);
72 function stanza_mt:up()
73 local last_add = self.last_add;
74 if last_add then t_remove(last_add); end
78 function stanza_mt:reset()
83 function stanza_mt:add_direct_child(child)
84 if type(child) == "table" then
85 t_insert(self.tags, child);
87 t_insert(self, child);
90 function stanza_mt:add_child(child)
91 local last_add = self.last_add;
92 (last_add and last_add[#last_add] or self):add_direct_child(child);
96 function stanza_mt:get_child(name, xmlns)
97 for _, child in ipairs(self.tags) do
98 if (not name or child.name == name)
99 and ((not xmlns and self.attr.xmlns == child.attr.xmlns)
100 or child.attr.xmlns == xmlns) then
107 function stanza_mt:get_child_text(name, xmlns)
108 local tag = self:get_child(name, xmlns);
110 return tag:get_text();
115 function stanza_mt:child_with_name(name)
116 for _, child in ipairs(self.tags) do
117 if child.name == name then return child; end
121 function stanza_mt:child_with_ns(ns)
122 for _, child in ipairs(self.tags) do
123 if child.attr.xmlns == ns then return child; end
127 function stanza_mt:children()
135 function stanza_mt:childtags(name, xmlns)
136 local tags = self.tags;
137 local start_i, max_i = 1, #tags;
139 for i = start_i, max_i do
141 if (not name or v.name == name)
142 and ((not xmlns and self.attr.xmlns == v.attr.xmlns)
143 or v.attr.xmlns == xmlns) then
151 function stanza_mt:maptags(callback)
152 local tags, curr_tag = self.tags, 1;
153 local n_children, n_tags = #self, #tags;
156 while curr_tag <= n_tags and n_tags > 0 do
157 if self[i] == tags[curr_tag] then
158 local ret = callback(self[i]);
161 t_remove(tags, curr_tag);
162 n_children = n_children - 1;
165 curr_tag = curr_tag - 1;
168 tags[curr_tag] = ret;
170 curr_tag = curr_tag + 1;
177 function stanza_mt:find(path)
179 local len = #path + 1;
182 local xmlns, name, text;
183 local char = s_sub(path, pos, pos);
185 return self.attr[s_sub(path, pos + 1)];
186 elseif char == "{" then
187 xmlns, pos = s_match(path, "^([^}]+)}()", pos + 1);
189 name, text, pos = s_match(path, "^([^@/#]*)([/#]?)()", pos);
190 name = name ~= "" and name or nil;
193 return self:get_child_text(name, xmlns);
195 return self:get_child(name, xmlns);
197 self = self:get_child(name, xmlns);
202 local escape_table = { ["'"] = "'", ["\""] = """, ["<"] = "<", [">"] = ">", ["&"] = "&" };
203 local function xml_escape(str) return (s_gsub(str, "['&<>\"]", escape_table)); end
205 local function _dostring(t, buf, self, xml_escape, parentns)
208 t_insert(buf, "<"..name);
209 for k, v in pairs(t.attr) do
210 if s_find(k, "\1", 1, true) then
211 local ns, attrk = s_match(k, "^([^\1]*)\1?(.*)$");
213 t_insert(buf, " xmlns:ns"..nsid.."='"..xml_escape(ns).."' ".."ns"..nsid..":"..attrk.."='"..xml_escape(v).."'");
214 elseif not(k == "xmlns" and v == parentns) then
215 t_insert(buf, " "..k.."='"..xml_escape(v).."'");
226 self(child, buf, self, xml_escape, t.attr.xmlns);
228 t_insert(buf, xml_escape(child));
231 t_insert(buf, "</"..name..">");
234 function stanza_mt.__tostring(t)
236 _dostring(t, buf, _dostring, xml_escape, nil);
237 return t_concat(buf);
240 function stanza_mt.top_tag(t)
241 local attr_string = "";
243 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
245 return s_format("<%s%s>", t.name, attr_string);
248 function stanza_mt.get_text(t)
254 function stanza_mt.get_error(stanza)
255 local type, condition, text;
257 local error_tag = stanza:get_child("error");
258 if not error_tag then
259 return nil, nil, nil;
261 type = error_tag.attr.type;
263 for _, child in ipairs(error_tag.tags) do
264 if child.attr.xmlns == xmlns_stanzas then
265 if not text and child.name == "text" then
266 text = child:get_text();
267 elseif not condition then
268 condition = child.name;
270 if condition and text then
275 return type, condition or "undefined-condition", text;
279 local function new_id()
284 local function preserialize(stanza)
285 local s = { name = stanza.name, attr = stanza.attr };
286 for _, child in ipairs(stanza) do
287 if type(child) == "table" then
288 t_insert(s, preserialize(child));
296 local function deserialize(stanza)
299 local attr = stanza.attr;
300 for i=1,#attr do attr[i] = nil; end
302 for att in pairs(attr) do
303 if s_find(att, "|", 1, true) and not s_find(att, "\1", 1, true) then
304 local ns,na = s_match(att, "^([^|]+)|(.+)$");
305 attrx[ns.."\1"..na] = attr[att];
309 for a,v in pairs(attrx) do
312 setmetatable(stanza, stanza_mt);
313 for _, child in ipairs(stanza) do
314 if type(child) == "table" then
318 if not stanza.tags then
321 for _, child in ipairs(stanza) do
322 if type(child) == "table" then
323 t_insert(tags, child);
333 local function clone(stanza)
334 local attr, tags = {}, {};
335 for k,v in pairs(stanza.attr) do attr[k] = v; end
336 local new = { name = stanza.name, attr = attr, tags = tags };
338 local child = stanza[i];
340 child = clone(child);
341 t_insert(tags, child);
343 t_insert(new, child);
345 return setmetatable(new, stanza_mt);
348 local function message(attr, body)
350 return stanza("message", attr);
352 return stanza("message", attr):tag("body"):text(body):up();
355 local function iq(attr)
356 if attr and not attr.id then attr.id = new_id(); end
357 return stanza("iq", attr or { id = new_id() });
360 local function reply(orig)
361 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) });
364 local xmpp_stanzas_attr = { xmlns = xmlns_stanzas };
365 local function error_reply(orig, type, condition, message)
366 local t = reply(orig);
367 t.attr.type = "error";
368 t:tag("error", {type = type}) --COMPAT: Some day xmlns:stanzas goes here
369 :tag(condition, xmpp_stanzas_attr):up();
370 if (message) then t:tag("text", xmpp_stanzas_attr):text(message):up(); end
371 return t; -- stanza ready for adding app-specific errors
374 local function presence(attr)
375 return stanza("presence", attr);
378 if do_pretty_printing then
379 local style_attrk = getstyle("yellow");
380 local style_attrv = getstyle("red");
381 local style_tagname = getstyle("red");
382 local style_punc = getstyle("magenta");
384 local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
385 local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
386 --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, ">");
387 local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
388 function stanza_mt.pretty_print(t)
389 local children_text = "";
390 for n, child in ipairs(t) do
391 if type(child) == "string" then
392 children_text = children_text .. xml_escape(child);
394 children_text = children_text .. child:pretty_print();
398 local attr_string = "";
400 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
402 return s_format(tag_format, t.name, attr_string, children_text, t.name);
405 function stanza_mt.pretty_top_tag(t)
406 local attr_string = "";
408 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
410 return s_format(top_tag_format, t.name, attr_string);
413 -- Sorry, fresh out of colours for you guys ;)
414 stanza_mt.pretty_print = stanza_mt.__tostring;
415 stanza_mt.pretty_top_tag = stanza_mt.top_tag;
419 stanza_mt = stanza_mt;
422 preserialize = preserialize;
423 deserialize = deserialize;
428 error_reply = error_reply;
430 xml_escape = xml_escape;