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:add_direct_child(child)
69 if type(child) == "table" then
70 t_insert(self.tags, child);
72 t_insert(self, child);
75 function stanza_mt:add_child(child)
76 (self.last_add[#self.last_add] or self):add_direct_child(child);
80 function stanza_mt:child_with_name(name)
81 for _, child in ipairs(self.tags) do
82 if child.name == name then return child; end
86 function stanza_mt:child_with_ns(ns)
87 for _, child in ipairs(self.tags) do
88 if child.attr.xmlns == ns then return child; end
92 function stanza_mt:children()
97 if v then return v; end
101 function stanza_mt:childtags()
105 local v = self.tags[i]
106 if v then return v; end
107 end, self.tags[1], i;
112 local xml_entities = { ["'"] = "'", ["\""] = """, ["<"] = "<", [">"] = ">", ["&"] = "&" };
113 function xml_escape(s) return s_gsub(s, "['&<>\"]", xml_entities); end
116 local xml_escape = xml_escape;
118 local function dostring(t, buf, self, xml_escape)
119 local nsid, ns, attrk = 0;
121 t_insert(buf, t.name);
122 for k, v in pairs(t.attr) do if type(k) == "string" then
124 ns, attrk = s_match(k, "^([^|]+)|(.+)$");
126 nsid = (nsid or -1) + 1;
127 t_insert(buf, "xmlns:ns"..nsid);
129 t_insert(buf, (xml_escape(tostring(ns))));
131 t_insert(buf, "ns"..nsid..":"..attrk);
136 t_insert(buf, (xml_escape(tostring(v))));
140 for n, child in ipairs(t) do
142 self(child, buf, self, xml_escape);
144 t_insert(buf, (xml_escape(child)));
148 t_insert(buf, t.name);
152 function stanza_mt.__tostring(t)
154 dostring(t, buf, dostring, xml_escape);
155 return t_concat(buf);
159 function stanza_mt.top_tag(t)
160 local attr_string = "";
162 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
164 return s_format("<%s%s>", t.name, attr_string);
167 function stanza_mt.__add(s1, s2)
168 return s1:add_direct_child(s2);
180 function preserialize(stanza)
181 local s = { name = stanza.name, attr = stanza.attr };
182 for _, child in ipairs(stanza) do
183 if type(child) == "table" then
184 t_insert(s, preserialize(child));
192 function deserialize(stanza)
195 setmetatable(stanza, stanza_mt);
196 for _, child in ipairs(stanza) do
197 if type(child) == "table" then
201 if not stanza.tags then
204 for _, child in ipairs(stanza) do
205 if type(child) == "table" then
206 t_insert(tags, child);
210 if not stanza.last_add then
211 stanza.last_add = {};
219 function clone(stanza)
220 local lookup_table = {};
221 local function _copy(object)
222 if type(object) ~= "table" then
224 elseif lookup_table[object] then
225 return lookup_table[object];
227 local new_table = {};
228 lookup_table[object] = new_table;
229 for index, value in pairs(object) do
230 new_table[_copy(index)] = _copy(value);
232 return setmetatable(new_table, getmetatable(object));
237 function message(attr, body)
239 return stanza("message", attr);
241 return stanza("message", attr):tag("body"):text(body);
245 if attr and not attr.id then attr.id = new_id(); end
246 return stanza("iq", attr or { id = new_id() });
250 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) });
253 function error_reply(orig, type, condition, message, clone)
254 local t = reply(orig);
255 t.attr.type = "error";
257 t:tag("error", {type = type})
258 :tag(condition, {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
259 if (message) then t:tag("text"):text(message):up(); end
260 return t; -- stanza ready for adding app-specific errors
263 function presence(attr)
264 return stanza("presence", attr);
267 if do_pretty_printing then
268 local style_attrk = getstyle("yellow");
269 local style_attrv = getstyle("red");
270 local style_tagname = getstyle("red");
271 local style_punc = getstyle("magenta");
273 local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
274 local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
275 --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, ">");
276 local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
277 function stanza_mt.pretty_print(t)
278 local children_text = "";
279 for n, child in ipairs(t) do
280 if type(child) == "string" then
281 children_text = children_text .. xml_escape(child);
283 children_text = children_text .. child:pretty_print();
287 local attr_string = "";
289 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
291 return s_format(tag_format, t.name, attr_string, children_text, t.name);
294 function stanza_mt.pretty_top_tag(t)
295 local attr_string = "";
297 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
299 return s_format(top_tag_format, t.name, attr_string);
302 -- Sorry, fresh out of colours for you guys ;)
303 stanza_mt.pretty_print = stanza_mt.__tostring;
304 stanza_mt.pretty_top_tag = stanza_mt.top_tag;