util/stanza.lua

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