util/stanza.lua

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