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