util/stanza.lua

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