2 -- Copyright (C) 2008-2009 Matthew Wild
3 -- Copyright (C) 2008-2009 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;
28 local do_pretty_printing = not os.getenv("WINDIR");
29 local getstyle, getstring = require "util.termcolours".getstyle, require "util.termcolours".getstring;
31 local log = require "util.logger".init("stanza");
36 stanza_mt.__index = stanza_mt;
38 function stanza(name, attr)
39 local stanza = { name = name, attr = attr or {}, tags = {}, last_add = {}};
40 return setmetatable(stanza, stanza_mt);
43 function stanza_mt:query(xmlns)
44 return self:tag("query", { xmlns = xmlns });
47 function stanza_mt:body(text, attr)
48 return self:tag("body", attr):text(text);
51 function stanza_mt:tag(name, attrs)
52 local s = stanza(name, attrs);
53 (self.last_add[#self.last_add] or self):add_direct_child(s);
54 t_insert(self.last_add, s);
58 function stanza_mt:text(text)
59 (self.last_add[#self.last_add] or self):add_direct_child(text);
63 function stanza_mt:up()
64 t_remove(self.last_add);
68 function stanza_mt:reset()
69 local last_add = self.last_add;
70 for i = 1,#last_add do
76 function stanza_mt:add_direct_child(child)
77 if type(child) == "table" then
78 t_insert(self.tags, child);
80 t_insert(self, child);
83 function stanza_mt:add_child(child)
84 (self.last_add[#self.last_add] or self):add_direct_child(child);
88 function stanza_mt:child_with_name(name)
89 for _, child in ipairs(self.tags) do
90 if child.name == name then return child; end
94 function stanza_mt:child_with_ns(ns)
95 for _, child in ipairs(self.tags) do
96 if child.attr.xmlns == ns then return child; end
100 function stanza_mt:children()
105 if v then return v; end
109 function stanza_mt:childtags()
113 local v = self.tags[i]
114 if v then return v; end
115 end, self.tags[1], i;
120 local xml_entities = { ["'"] = "'", ["\""] = """, ["<"] = "<", [">"] = ">", ["&"] = "&" };
121 function xml_escape(s) return s_gsub(s, "['&<>\"]", xml_entities); end
124 local xml_escape = xml_escape;
126 local function dostring(t, buf, self, xml_escape)
127 local nsid, ns, attrk = 0;
129 t_insert(buf, t.name);
130 for k, v in pairs(t.attr) do if type(k) == "string" then
132 ns, attrk = s_match(k, "^([^|]+)|(.+)$");
134 nsid = (nsid or -1) + 1;
135 t_insert(buf, "xmlns:ns"..nsid);
137 t_insert(buf, (xml_escape(tostring(ns))));
139 t_insert(buf, "ns"..nsid..":"..attrk);
144 t_insert(buf, (xml_escape(tostring(v))));
148 for n, child in ipairs(t) do
150 self(child, buf, self, xml_escape);
152 t_insert(buf, (xml_escape(child)));
156 t_insert(buf, t.name);
160 function stanza_mt.__tostring(t)
162 dostring(t, buf, dostring, xml_escape);
163 return t_concat(buf);
167 function stanza_mt.top_tag(t)
168 local attr_string = "";
170 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
172 return s_format("<%s%s>", t.name, attr_string);
175 function stanza_mt.__add(s1, s2)
176 return s1:add_direct_child(s2);
188 function preserialize(stanza)
189 local s = { name = stanza.name, attr = stanza.attr };
190 for _, child in ipairs(stanza) do
191 if type(child) == "table" then
192 t_insert(s, preserialize(child));
200 function deserialize(stanza)
203 setmetatable(stanza, stanza_mt);
204 for _, child in ipairs(stanza) do
205 if type(child) == "table" then
209 if not stanza.tags then
212 for _, child in ipairs(stanza) do
213 if type(child) == "table" then
214 t_insert(tags, child);
218 if not stanza.last_add then
219 stanza.last_add = {};
227 function clone(stanza)
228 local lookup_table = {};
229 local function _copy(object)
230 if type(object) ~= "table" then
232 elseif lookup_table[object] then
233 return lookup_table[object];
235 local new_table = {};
236 lookup_table[object] = new_table;
237 for index, value in pairs(object) do
238 new_table[_copy(index)] = _copy(value);
240 return setmetatable(new_table, getmetatable(object));
245 function message(attr, body)
247 return stanza("message", attr);
249 return stanza("message", attr):tag("body"):text(body);
253 if attr and not attr.id then attr.id = new_id(); end
254 return stanza("iq", attr or { id = new_id() });
258 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) });
261 function error_reply(orig, type, condition, message)
262 local t = reply(orig);
263 t.attr.type = "error";
264 t:tag("error", {type = type})
265 :tag(condition, {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
266 if (message) then t:tag("text"):text(message):up(); end
267 return t; -- stanza ready for adding app-specific errors
270 function presence(attr)
271 return stanza("presence", attr);
274 if do_pretty_printing then
275 local style_attrk = getstyle("yellow");
276 local style_attrv = getstyle("red");
277 local style_tagname = getstyle("red");
278 local style_punc = getstyle("magenta");
280 local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
281 local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
282 --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, ">");
283 local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
284 function stanza_mt.pretty_print(t)
285 local children_text = "";
286 for n, child in ipairs(t) do
287 if type(child) == "string" then
288 children_text = children_text .. xml_escape(child);
290 children_text = children_text .. child:pretty_print();
294 local attr_string = "";
296 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
298 return s_format(tag_format, t.name, attr_string, children_text, t.name);
301 function stanza_mt.pretty_top_tag(t)
302 local attr_string = "";
304 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
306 return s_format(top_tag_format, t.name, attr_string);
309 -- Sorry, fresh out of colours for you guys ;)
310 stanza_mt.pretty_print = stanza_mt.__tostring;
311 stanza_mt.pretty_top_tag = stanza_mt.top_tag;