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 s_format = string.format;
24 local tostring = tostring;
25 local setmetatable = setmetatable;
27 local ipairs = ipairs;
31 local unpack = unpack;
32 local s_gsub = string.gsub;
35 local do_pretty_printing = not os.getenv("WINDIR");
36 local getstyle, getstring = require "util.termcolours".getstyle, require "util.termcolours".getstring;
38 local log = require "util.logger".init("stanza");
43 stanza_mt.__index = stanza_mt;
45 function stanza(name, attr)
46 local stanza = { name = name, attr = attr or {}, tags = {}, last_add = {}};
47 return setmetatable(stanza, stanza_mt);
50 function stanza_mt:query(xmlns)
51 return self:tag("query", { xmlns = xmlns });
54 function stanza_mt:body(text, attr)
55 return self:tag("body", attr):text(text);
58 function stanza_mt:tag(name, attrs)
59 local s = stanza(name, attrs);
60 (self.last_add[#self.last_add] or self):add_direct_child(s);
61 t_insert(self.last_add, s);
65 function stanza_mt:text(text)
66 (self.last_add[#self.last_add] or self):add_direct_child(text);
70 function stanza_mt:up()
71 t_remove(self.last_add);
75 function stanza_mt:add_direct_child(child)
76 if type(child) == "table" then
77 t_insert(self.tags, child);
79 t_insert(self, child);
82 function stanza_mt:add_child(child)
83 (self.last_add[#self.last_add] or self):add_direct_child(child);
87 function stanza_mt:child_with_name(name)
88 for _, child in ipairs(self) do
89 if child.name == name then return child; end
93 function stanza_mt:children()
98 if v then return v; end
102 function stanza_mt:childtags()
106 local v = self.tags[i]
107 if v then return v; end
108 end, self.tags[1], i;
113 local xml_entities = { ["'"] = "'", ["\""] = """, ["<"] = "<", [">"] = ">", ["&"] = "&" };
114 function xml_escape(s) return s_gsub(s, "['&<>\"]", xml_entities); end
117 local xml_escape = xml_escape;
119 function stanza_mt.__tostring(t)
120 local children_text = "";
121 for n, child in ipairs(t) do
122 if type(child) == "string" then
123 children_text = children_text .. xml_escape(child);
125 children_text = children_text .. tostring(child);
129 local attr_string = "";
131 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
133 return s_format("<%s%s>%s</%s>", t.name, attr_string, children_text, t.name);
136 function stanza_mt.top_tag(t)
137 local attr_string = "";
139 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
141 return s_format("<%s%s>", t.name, attr_string);
144 function stanza_mt.__add(s1, s2)
145 return s1:add_direct_child(s2);
157 function preserialize(stanza)
158 local s = { name = stanza.name, attr = stanza.attr };
159 for _, child in ipairs(stanza) do
160 if type(child) == "table" then
161 t_insert(s, preserialize(child));
169 function deserialize(stanza)
172 setmetatable(stanza, stanza_mt);
173 for _, child in ipairs(stanza) do
174 if type(child) == "table" then
178 if not stanza.tags then
181 for _, child in ipairs(stanza) do
182 if type(child) == "table" then
183 t_insert(tags, child);
193 function message(attr, body)
195 return stanza("message", attr);
197 return stanza("message", attr):tag("body"):text(body);
201 if attr and not attr.id then attr.id = new_id(); end
202 return stanza("iq", attr or { id = new_id() });
206 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) });
209 function error_reply(orig, type, condition, message, clone)
210 local t = reply(orig);
211 t.attr.type = "error";
213 t:tag("error", {type = type})
214 :tag(condition, {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
215 if (message) then t:tag("text"):text(message):up(); end
216 return t; -- stanza ready for adding app-specific errors
219 function presence(attr)
220 return stanza("presence", attr);
223 if do_pretty_printing then
224 local style_attrk = getstyle("yellow");
225 local style_attrv = getstyle("red");
226 local style_tagname = getstyle("red");
227 local style_punc = getstyle("magenta");
229 local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
230 local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
231 --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, ">");
232 local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
233 function stanza_mt.pretty_print(t)
234 local children_text = "";
235 for n, child in ipairs(t) do
236 if type(child) == "string" then
237 children_text = children_text .. xml_escape(child);
239 children_text = children_text .. child:pretty_print();
243 local attr_string = "";
245 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
247 return s_format(tag_format, t.name, attr_string, children_text, t.name);
250 function stanza_mt.pretty_top_tag(t)
251 local attr_string = "";
253 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
255 return s_format(top_tag_format, t.name, attr_string);
258 -- Sorry, fresh out of colours for you guys ;)
259 stanza_mt.pretty_print = stanza_mt.__tostring;
260 stanza_mt.pretty_top_tag = stanza_mt.top_tag;