util/stanza.lua

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