util/stanza.lua

   1 -- Prosody IM v0.3
   2 -- Copyright (C) 2008 Matthew Wild
   3 -- Copyright (C) 2008 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9
  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 tostring      =      tostring;
  16 local setmetatable  =  setmetatable;
  17 local pairs         =         pairs;
  18 local ipairs        =        ipairs;
  19 local type          =          type;
  20 local next          =          next;
  21 local print         =         print;
  22 local unpack        =        unpack;
  23 local s_gsub        =   string.gsub;
  24 local os            =            os;
  25
  26 local do_pretty_printing = not os.getenv("WINDIR");
  27 local getstyle, getstring = require "util.termcolours".getstyle, require "util.termcolours".getstring;
  28
  29 local log = require "util.logger".init("stanza");
  30
  31 module "stanza"
  32
  33 stanza_mt = {};
  34 stanza_mt.__index = stanza_mt;
  35
  36 function stanza(name, attr)
  37         local stanza = { name = name, attr = attr or {}, tags = {}, last_add = {}};
  38         return setmetatable(stanza, stanza_mt);
  39 end
  40
  41 function stanza_mt:query(xmlns)
  42         return self:tag("query", { xmlns = xmlns });
  43 end
  44
  45 function stanza_mt:body(text, attr)
  46         return self:tag("body", attr):text(text);
  47 end
  48
  49 function stanza_mt:tag(name, attrs)
  50         local s = stanza(name, attrs);
  51         (self.last_add[#self.last_add] or self):add_direct_child(s);
  52         t_insert(self.last_add, s);
  53         return self;
  54 end
  55
  56 function stanza_mt:text(text)
  57         (self.last_add[#self.last_add] or self):add_direct_child(text);
  58         return self;
  59 end
  60
  61 function stanza_mt:up()
  62         t_remove(self.last_add);
  63         return self;
  64 end
  65
  66 function stanza_mt:add_direct_child(child)
  67         if type(child) == "table" then
  68                 t_insert(self.tags, child);
  69         end
  70         t_insert(self, child);
  71 end
  72
  73 function stanza_mt:add_child(child)
  74         (self.last_add[#self.last_add] or self):add_direct_child(child);
  75         return self;
  76 end
  77
  78 function stanza_mt:child_with_name(name)
  79         for _, child in ipairs(self.tags) do
  80                 if child.name == name then return child; end
  81         end
  82 end
  83
  84 function stanza_mt:child_with_ns(ns)
  85         for _, child in ipairs(self.tags) do
  86                 if child.attr.xmlns == ns then return child; end
  87         end
  88 end
  89
  90 function stanza_mt:children()
  91         local i = 0;
  92         return function (a)
  93                         i = i + 1
  94                         local v = a[i]
  95                         if v then return v; end
  96                 end, self, i;
  97
  98 end
  99 function stanza_mt:childtags()
 100         local i = 0;
 101         return function (a)
 102                         i = i + 1
 103                         local v = self.tags[i]
 104                         if v then return v; end
 105                 end, self.tags[1], i;
 106
 107 end
 108
 109 do
 110         local xml_entities = { ["'"] = "&apos;", ["\""] = "&quot;", ["<"] = "&lt;", [">"] = "&gt;", ["&"] = "&amp;" };
 111         function xml_escape(s) return s_gsub(s, "['&<>\"]", xml_entities); end
 112 end
 113
 114 local xml_escape = xml_escape;
 115
 116 local function dostring(t, buf, self, xml_escape)
 117         t_insert(buf, "<");
 118         t_insert(buf, t.name);
 119         for k, v in pairs(t.attr) do if type(k) == "string" then
 120                 t_insert(buf, " ");
 121                 t_insert(buf, k);
 122                 t_insert(buf, "='");
 123                 t_insert(buf, (xml_escape(tostring(v))));
 124                 t_insert(buf, "'");
 125         end end
 126         t_insert(buf, ">");
 127         for n, child in ipairs(t) do
 128                 if child.name then
 129                         self(child, buf, self, xml_escape);
 130                 else
 131                         t_insert(buf, (xml_escape(child)));
 132                 end
 133         end
 134         t_insert(buf, "</");
 135         t_insert(buf, t.name);
 136         t_insert(buf, ">");
 137 end
 138
 139 function stanza_mt.__tostring(t)
 140         local buf = {};
 141         dostring(t, buf, dostring, xml_escape);
 142         return t_concat(buf);
 143 end
 144
 145
 146 function stanza_mt.top_tag(t)
 147         local attr_string = "";
 148         if t.attr then
 149                 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
 150         end
 151         return s_format("<%s%s>", t.name, attr_string);
 152 end
 153
 154 function stanza_mt.__add(s1, s2)
 155         return s1:add_direct_child(s2);
 156 end
 157
 158
 159 do
 160         local id = 0;
 161         function new_id()
 162                 id = id + 1;
 163                 return "lx"..id;
 164         end
 165 end
 166
 167 function preserialize(stanza)
 168         local s = { name = stanza.name, attr = stanza.attr };
 169         for _, child in ipairs(stanza) do
 170                 if type(child) == "table" then
 171                         t_insert(s, preserialize(child));
 172                 else
 173                         t_insert(s, child);
 174                 end
 175         end
 176         return s;
 177 end
 178
 179 function deserialize(stanza)
 180         -- Set metatable
 181         if stanza then
 182                 setmetatable(stanza, stanza_mt);
 183                 for _, child in ipairs(stanza) do
 184                         if type(child) == "table" then
 185                                 deserialize(child);
 186                         end
 187                 end
 188                 if not stanza.tags then
 189                         -- Rebuild tags
 190                         local tags = {};
 191                         for _, child in ipairs(stanza) do
 192                                 if type(child) == "table" then
 193                                         t_insert(tags, child);
 194                                 end
 195                         end
 196                         stanza.tags = tags;
 197                         if not stanza.last_add then
 198                                 stanza.last_add = {};
 199                         end
 200                 end
 201         end
 202
 203         return stanza;
 204 end
 205
 206 function message(attr, body)
 207         if not body then
 208                 return stanza("message", attr);
 209         else
 210                 return stanza("message", attr):tag("body"):text(body);
 211         end
 212 end
 213 function iq(attr)
 214         if attr and not attr.id then attr.id = new_id(); end
 215         return stanza("iq", attr or { id = new_id() });
 216 end
 217
 218 function reply(orig)
 219         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) });
 220 end
 221
 222 function error_reply(orig, type, condition, message, clone)
 223         local t = reply(orig);
 224         t.attr.type = "error";
 225         -- TODO use clone
 226         t:tag("error", {type = type})
 227                 :tag(condition, {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
 228         if (message) then t:tag("text"):text(message):up(); end
 229         return t; -- stanza ready for adding app-specific errors
 230 end
 231
 232 function presence(attr)
 233         return stanza("presence", attr);
 234 end
 235
 236 if do_pretty_printing then
 237         local style_attrk = getstyle("yellow");
 238         local style_attrv = getstyle("red");
 239         local style_tagname = getstyle("red");
 240         local style_punc = getstyle("magenta");
 241
 242         local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
 243         local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
 244         --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, ">");
 245         local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
 246         function stanza_mt.pretty_print(t)
 247                 local children_text = "";
 248                 for n, child in ipairs(t) do
 249                         if type(child) == "string" then
 250                                 children_text = children_text .. xml_escape(child);
 251                         else
 252                                 children_text = children_text .. child:pretty_print();
 253                         end
 254                 end
 255
 256                 local attr_string = "";
 257                 if t.attr then
 258                         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
 259                 end
 260                 return s_format(tag_format, t.name, attr_string, children_text, t.name);
 261         end
 262
 263         function stanza_mt.pretty_top_tag(t)
 264                 local attr_string = "";
 265                 if t.attr then
 266                         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
 267                 end
 268                 return s_format(top_tag_format, t.name, attr_string);
 269         end
 270 else
 271         -- Sorry, fresh out of colours for you guys ;)
 272         stanza_mt.pretty_print = stanza_mt.__tostring;
 273         stanza_mt.pretty_top_tag = stanza_mt.top_tag;
 274 end
 275
 276 return _M;