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_remove = table.remove;
23 local t_concat = table.concat;
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, xml_escape)
122 t_insert(buf, t.name);
123 for k, v in pairs(t.attr) do if type(k) == "string" then
127 t_insert(buf, (xml_escape(tostring(v))));
131 for n, child in ipairs(t) do
133 self(child, buf, self, xml_escape);
135 t_insert(buf, (xml_escape(child)));
139 t_insert(buf, t.name);
143 function stanza_mt.__tostring(t)
145 dostring(t, buf, dostring, xml_escape);
146 return t_concat(buf);
150 function stanza_mt.top_tag(t)
151 local attr_string = "";
153 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
155 return s_format("<%s%s>", t.name, attr_string);
158 function stanza_mt.__add(s1, s2)
159 return s1:add_direct_child(s2);
171 function preserialize(stanza)
172 local s = { name = stanza.name, attr = stanza.attr };
173 for _, child in ipairs(stanza) do
174 if type(child) == "table" then
175 t_insert(s, preserialize(child));
183 function deserialize(stanza)
186 setmetatable(stanza, stanza_mt);
187 for _, child in ipairs(stanza) do
188 if type(child) == "table" then
192 if not stanza.tags then
195 for _, child in ipairs(stanza) do
196 if type(child) == "table" then
197 t_insert(tags, child);
207 function message(attr, body)
209 return stanza("message", attr);
211 return stanza("message", attr):tag("body"):text(body);
215 if attr and not attr.id then attr.id = new_id(); end
216 return stanza("iq", attr or { id = new_id() });
220 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) });
223 function error_reply(orig, type, condition, message, clone)
224 local t = reply(orig);
225 t.attr.type = "error";
227 t:tag("error", {type = type})
228 :tag(condition, {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
229 if (message) then t:tag("text"):text(message):up(); end
230 return t; -- stanza ready for adding app-specific errors
233 function presence(attr)
234 return stanza("presence", attr);
237 if do_pretty_printing then
238 local style_attrk = getstyle("yellow");
239 local style_attrv = getstyle("red");
240 local style_tagname = getstyle("red");
241 local style_punc = getstyle("magenta");
243 local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
244 local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
245 --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, ">");
246 local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
247 function stanza_mt.pretty_print(t)
248 local children_text = "";
249 for n, child in ipairs(t) do
250 if type(child) == "string" then
251 children_text = children_text .. xml_escape(child);
253 children_text = children_text .. child:pretty_print();
257 local attr_string = "";
259 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
261 return s_format(tag_format, t.name, attr_string, children_text, t.name);
264 function stanza_mt.pretty_top_tag(t)
265 local attr_string = "";
267 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
269 return s_format(top_tag_format, t.name, attr_string);
272 -- Sorry, fresh out of colours for you guys ;)
273 stanza_mt.pretty_print = stanza_mt.__tostring;
274 stanza_mt.pretty_top_tag = stanza_mt.top_tag;