2 -- Copyright (C) 2008 Matthew Wild
3 -- Copyright (C) 2008 Waqas Hussain
5 -- This program is free software; you can redistribute it and/or
6 -- modify it under the terms of the GNU General Public License
7 -- as published by the Free Software Foundation; either version 2
8 -- of the License, or (at your option) any later version.
10 -- This program is distributed in the hope that it will be useful,
11 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
12 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 -- GNU General Public License for more details.
15 -- You should have received a copy of the GNU General Public License
16 -- along with this program; if not, write to the Free Software
17 -- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 local t_insert = table.insert;
22 local t_concat = table.concat;
23 local t_remove = table.remove;
24 local s_format = string.format;
25 local tostring = tostring;
26 local setmetatable = setmetatable;
28 local ipairs = ipairs;
32 local unpack = unpack;
33 local s_gsub = string.gsub;
36 local do_pretty_printing = not os.getenv("WINDIR");
37 local getstyle, getstring = require "util.termcolours".getstyle, require "util.termcolours".getstring;
39 local log = require "util.logger".init("stanza");
44 stanza_mt.__index = stanza_mt;
46 function stanza(name, attr)
47 local stanza = { name = name, attr = attr or {}, tags = {}, last_add = {}};
48 return setmetatable(stanza, stanza_mt);
51 function stanza_mt:query(xmlns)
52 return self:tag("query", { xmlns = xmlns });
55 function stanza_mt:body(text, attr)
56 return self:tag("body", attr):text(text);
59 function stanza_mt:tag(name, attrs)
60 local s = stanza(name, attrs);
61 (self.last_add[#self.last_add] or self):add_direct_child(s);
62 t_insert(self.last_add, s);
66 function stanza_mt:text(text)
67 (self.last_add[#self.last_add] or self):add_direct_child(text);
71 function stanza_mt:up()
72 t_remove(self.last_add);
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) do
90 if child.name == name then return child; end
94 function stanza_mt:children()
99 if v then return v; end
103 function stanza_mt:childtags()
107 local v = self.tags[i]
108 if v then return v; end
109 end, self.tags[1], i;
114 local xml_entities = { ["'"] = "'", ["\""] = """, ["<"] = "<", [">"] = ">", ["&"] = "&" };
115 function xml_escape(s) return s_gsub(s, "['&<>\"]", xml_entities); end
118 local xml_escape = xml_escape;
120 local function dostring(t, buf, self)
122 t_insert(buf, t.name);
124 for k, v in pairs(t.attr) do if type(k) == "string" then
128 t_insert(buf, (xml_escape(tostring(v))));
133 for n, child in ipairs(t) do
135 self(child, buf, self);
137 t_insert(buf, (xml_escape(child)));
141 t_insert(buf, t.name);
145 function stanza_mt.__tostring(t)
147 dostring(t, buf, dostring);
148 return t_concat(buf);
151 function stanza_mt.top_tag(t)
152 local attr_string = "";
154 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
156 return s_format("<%s%s>", t.name, attr_string);
159 function stanza_mt.__add(s1, s2)
160 return s1:add_direct_child(s2);
172 function preserialize(stanza)
173 local s = { name = stanza.name, attr = stanza.attr };
174 for _, child in ipairs(stanza) do
175 if type(child) == "table" then
176 t_insert(s, preserialize(child));
184 function deserialize(stanza)
187 setmetatable(stanza, stanza_mt);
188 for _, child in ipairs(stanza) do
189 if type(child) == "table" then
193 if not stanza.tags then
196 for _, child in ipairs(stanza) do
197 if type(child) == "table" then
198 t_insert(tags, child);
208 function message(attr, body)
210 return stanza("message", attr);
212 return stanza("message", attr):tag("body"):text(body);
216 if attr and not attr.id then attr.id = new_id(); end
217 return stanza("iq", attr or { id = new_id() });
221 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) });
224 function error_reply(orig, type, condition, message, clone)
225 local t = reply(orig);
226 t.attr.type = "error";
228 t:tag("error", {type = type})
229 :tag(condition, {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
230 if (message) then t:tag("text"):text(message):up(); end
231 return t; -- stanza ready for adding app-specific errors
234 function presence(attr)
235 return stanza("presence", attr);
238 if do_pretty_printing then
239 local style_attrk = getstyle("yellow");
240 local style_attrv = getstyle("red");
241 local style_tagname = getstyle("red");
242 local style_punc = getstyle("magenta");
244 local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
245 local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
246 --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, ">");
247 local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
248 function stanza_mt.pretty_print(t)
249 local children_text = "";
250 for n, child in ipairs(t) do
251 if type(child) == "string" then
252 children_text = children_text .. xml_escape(child);
254 children_text = children_text .. child:pretty_print();
258 local attr_string = "";
260 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
262 return s_format(tag_format, t.name, attr_string, children_text, t.name);
265 function stanza_mt.pretty_top_tag(t)
266 local attr_string = "";
268 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
270 return s_format(top_tag_format, t.name, attr_string);
273 -- Sorry, fresh out of colours for you guys ;)
274 stanza_mt.pretty_print = stanza_mt.__tostring;
275 stanza_mt.pretty_top_tag = stanza_mt.top_tag;