util/stanza.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 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_remove      =  table.remove;
  12 local t_concat      =  table.concat;
  13 local s_format      = string.format;
  14 local s_match       =  string.match;
  15 local tostring      =      tostring;
  16 local setmetatable  =  setmetatable;
  17 local pairs         =         pairs;
  18 local ipairs        =        ipairs;
  19 local type          =          type;
  20 local s_gsub        =   string.gsub;
  21 local s_find        =   string.find;
  22 local os            =            os;
  23
  24 local do_pretty_printing = not os.getenv("WINDIR");
  25 local getstyle, getstring;
  26 if do_pretty_printing then
  27         local ok, termcolours = pcall(require, "util.termcolours");
  28         if ok then
  29                 getstyle, getstring = termcolours.getstyle, termcolours.getstring;
  30         else
  31                 do_pretty_printing = nil;
  32         end
  33 end
  34
  35 local xmlns_stanzas = "urn:ietf:params:xml:ns:xmpp-stanzas";
  36
  37 module "stanza"
  38
  39 stanza_mt = { __type = "stanza" };
  40 stanza_mt.__index = stanza_mt;
  41 local stanza_mt = stanza_mt;
  42
  43 function stanza(name, attr)
  44         local stanza = { name = name, attr = attr or {}, tags = {} };
  45         return setmetatable(stanza, stanza_mt);
  46 end
  47 local stanza = stanza;
  48
  49 function stanza_mt:query(xmlns)
  50         return self:tag("query", { xmlns = xmlns });
  51 end
  52
  53 function stanza_mt:body(text, attr)
  54         return self:tag("body", attr):text(text);
  55 end
  56
  57 function stanza_mt:tag(name, attrs)
  58         local s = stanza(name, attrs);
  59         local last_add = self.last_add;
  60         if not last_add then last_add = {}; self.last_add = last_add; end
  61         (last_add[#last_add] or self):add_direct_child(s);
  62         t_insert(last_add, s);
  63         return self;
  64 end
  65
  66 function stanza_mt:text(text)
  67         local last_add = self.last_add;
  68         (last_add and last_add[#last_add] or self):add_direct_child(text);
  69         return self;
  70 end
  71
  72 function stanza_mt:up()
  73         local last_add = self.last_add;
  74         if last_add then t_remove(last_add); end
  75         return self;
  76 end
  77
  78 function stanza_mt:reset()
  79         self.last_add = nil;
  80         return self;
  81 end
  82
  83 function stanza_mt:add_direct_child(child)
  84         if type(child) == "table" then
  85                 t_insert(self.tags, child);
  86         end
  87         t_insert(self, child);
  88 end
  89
  90 function stanza_mt:add_child(child)
  91         local last_add = self.last_add;
  92         (last_add and last_add[#last_add] or self):add_direct_child(child);
  93         return self;
  94 end
  95
  96 function stanza_mt:get_child(name, xmlns)
  97         for _, child in ipairs(self.tags) do
  98                 if (not name or child.name == name)
  99                         and ((not xmlns and self.attr.xmlns == child.attr.xmlns)
 100                                 or child.attr.xmlns == xmlns) then
 101
 102                         return child;
 103                 end
 104         end
 105 end
 106
 107 function stanza_mt:get_child_text(name, xmlns)
 108         local tag = self:get_child(name, xmlns);
 109         if tag then
 110                 return tag:get_text();
 111         end
 112         return nil;
 113 end
 114
 115 function stanza_mt:child_with_name(name)
 116         for _, child in ipairs(self.tags) do
 117                 if child.name == name then return child; end
 118         end
 119 end
 120
 121 function stanza_mt:child_with_ns(ns)
 122         for _, child in ipairs(self.tags) do
 123                 if child.attr.xmlns == ns then return child; end
 124         end
 125 end
 126
 127 function stanza_mt:children()
 128         local i = 0;
 129         return function (a)
 130                         i = i + 1
 131                         return a[i];
 132                 end, self, i;
 133 end
 134
 135 function stanza_mt:childtags(name, xmlns)
 136         local tags = self.tags;
 137         local start_i, max_i = 1, #tags;
 138         return function ()
 139                 for i = start_i, max_i do
 140                         local v = tags[i];
 141                         if (not name or v.name == name)
 142                         and ((not xmlns and self.attr.xmlns == v.attr.xmlns)
 143                                 or v.attr.xmlns == xmlns) then
 144                                 start_i = i+1;
 145                                 return v;
 146                         end
 147                 end
 148         end;
 149 end
 150
 151 function stanza_mt:maptags(callback)
 152         local tags, curr_tag = self.tags, 1;
 153         local n_children, n_tags = #self, #tags;
 154
 155         local i = 1;
 156         while curr_tag <= n_tags do
 157                 if self[i] == tags[curr_tag] then
 158                         local ret = callback(self[i]);
 159                         if ret == nil then
 160                                 t_remove(self, i);
 161                                 t_remove(tags, curr_tag);
 162                                 n_children = n_children - 1;
 163                                 n_tags = n_tags - 1;
 164                         else
 165                                 self[i] = ret;
 166                                 tags[i] = ret;
 167                         end
 168                         i = i + 1;
 169                         curr_tag = curr_tag + 1;
 170                 end
 171         end
 172         return self;
 173 end
 174
 175 local xml_escape
 176 do
 177         local escape_table = { ["'"] = "&apos;", ["\""] = "&quot;", ["<"] = "&lt;", [">"] = "&gt;", ["&"] = "&amp;" };
 178         function xml_escape(str) return (s_gsub(str, "['&<>\"]", escape_table)); end
 179         _M.xml_escape = xml_escape;
 180 end
 181
 182 local function _dostring(t, buf, self, xml_escape, parentns)
 183         local nsid = 0;
 184         local name = t.name
 185         t_insert(buf, "<"..name);
 186         for k, v in pairs(t.attr) do
 187                 if s_find(k, "\1", 1, true) then
 188                         local ns, attrk = s_match(k, "^([^\1]*)\1?(.*)$");
 189                         nsid = nsid + 1;
 190                         t_insert(buf, " xmlns:ns"..nsid.."='"..xml_escape(ns).."' ".."ns"..nsid..":"..attrk.."='"..xml_escape(v).."'");
 191                 elseif not(k == "xmlns" and v == parentns) then
 192                         t_insert(buf, " "..k.."='"..xml_escape(v).."'");
 193                 end
 194         end
 195         local len = #t;
 196         if len == 0 then
 197                 t_insert(buf, "/>");
 198         else
 199                 t_insert(buf, ">");
 200                 for n=1,len do
 201                         local child = t[n];
 202                         if child.name then
 203                                 self(child, buf, self, xml_escape, t.attr.xmlns);
 204                         else
 205                                 t_insert(buf, xml_escape(child));
 206                         end
 207                 end
 208                 t_insert(buf, "</"..name..">");
 209         end
 210 end
 211 function stanza_mt.__tostring(t)
 212         local buf = {};
 213         _dostring(t, buf, _dostring, xml_escape, nil);
 214         return t_concat(buf);
 215 end
 216
 217 function stanza_mt.top_tag(t)
 218         local attr_string = "";
 219         if t.attr then
 220                 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
 221         end
 222         return s_format("<%s%s>", t.name, attr_string);
 223 end
 224
 225 function stanza_mt.get_text(t)
 226         if #t.tags == 0 then
 227                 return t_concat(t);
 228         end
 229 end
 230
 231 function stanza_mt.get_error(stanza)
 232         local type, condition, text;
 233
 234         local error_tag = stanza:get_child("error");
 235         if not error_tag then
 236                 return nil, nil, nil;
 237         end
 238         type = error_tag.attr.type;
 239
 240         for _, child in ipairs(error_tag.tags) do
 241                 if child.attr.xmlns == xmlns_stanzas then
 242                         if not text and child.name == "text" then
 243                                 text = child:get_text();
 244                         elseif not condition then
 245                                 condition = child.name;
 246                         end
 247                         if condition and text then
 248                                 break;
 249                         end
 250                 end
 251         end
 252         return type, condition or "undefined-condition", text;
 253 end
 254
 255 do
 256         local id = 0;
 257         function new_id()
 258                 id = id + 1;
 259                 return "lx"..id;
 260         end
 261 end
 262
 263 function preserialize(stanza)
 264         local s = { name = stanza.name, attr = stanza.attr };
 265         for _, child in ipairs(stanza) do
 266                 if type(child) == "table" then
 267                         t_insert(s, preserialize(child));
 268                 else
 269                         t_insert(s, child);
 270                 end
 271         end
 272         return s;
 273 end
 274
 275 function deserialize(stanza)
 276         -- Set metatable
 277         if stanza then
 278                 local attr = stanza.attr;
 279                 for i=1,#attr do attr[i] = nil; end
 280                 local attrx = {};
 281                 for att in pairs(attr) do
 282                         if s_find(att, "|", 1, true) and not s_find(att, "\1", 1, true) then
 283                                 local ns,na = s_match(att, "^([^|]+)|(.+)$");
 284                                 attrx[ns.."\1"..na] = attr[att];
 285                                 attr[att] = nil;
 286                         end
 287                 end
 288                 for a,v in pairs(attrx) do
 289                         attr[a] = v;
 290                 end
 291                 setmetatable(stanza, stanza_mt);
 292                 for _, child in ipairs(stanza) do
 293                         if type(child) == "table" then
 294                                 deserialize(child);
 295                         end
 296                 end
 297                 if not stanza.tags then
 298                         -- Rebuild tags
 299                         local tags = {};
 300                         for _, child in ipairs(stanza) do
 301                                 if type(child) == "table" then
 302                                         t_insert(tags, child);
 303                                 end
 304                         end
 305                         stanza.tags = tags;
 306                 end
 307         end
 308
 309         return stanza;
 310 end
 311
 312 local function _clone(stanza)
 313         local attr, tags = {}, {};
 314         for k,v in pairs(stanza.attr) do attr[k] = v; end
 315         local new = { name = stanza.name, attr = attr, tags = tags };
 316         for i=1,#stanza do
 317                 local child = stanza[i];
 318                 if child.name then
 319                         child = _clone(child);
 320                         t_insert(tags, child);
 321                 end
 322                 t_insert(new, child);
 323         end
 324         return setmetatable(new, stanza_mt);
 325 end
 326 clone = _clone;
 327
 328 function message(attr, body)
 329         if not body then
 330                 return stanza("message", attr);
 331         else
 332                 return stanza("message", attr):tag("body"):text(body):up();
 333         end
 334 end
 335 function iq(attr)
 336         if attr and not attr.id then attr.id = new_id(); end
 337         return stanza("iq", attr or { id = new_id() });
 338 end
 339
 340 function reply(orig)
 341         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) });
 342 end
 343
 344 do
 345         local xmpp_stanzas_attr = { xmlns = xmlns_stanzas };
 346         function error_reply(orig, type, condition, message)
 347                 local t = reply(orig);
 348                 t.attr.type = "error";
 349                 t:tag("error", {type = type}) --COMPAT: Some day xmlns:stanzas goes here
 350                         :tag(condition, xmpp_stanzas_attr):up();
 351                 if (message) then t:tag("text", xmpp_stanzas_attr):text(message):up(); end
 352                 return t; -- stanza ready for adding app-specific errors
 353         end
 354 end
 355
 356 function presence(attr)
 357         return stanza("presence", attr);
 358 end
 359
 360 if do_pretty_printing then
 361         local style_attrk = getstyle("yellow");
 362         local style_attrv = getstyle("red");
 363         local style_tagname = getstyle("red");
 364         local style_punc = getstyle("magenta");
 365
 366         local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
 367         local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
 368         --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, ">");
 369         local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
 370         function stanza_mt.pretty_print(t)
 371                 local children_text = "";
 372                 for n, child in ipairs(t) do
 373                         if type(child) == "string" then
 374                                 children_text = children_text .. xml_escape(child);
 375                         else
 376                                 children_text = children_text .. child:pretty_print();
 377                         end
 378                 end
 379
 380                 local attr_string = "";
 381                 if t.attr then
 382                         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
 383                 end
 384                 return s_format(tag_format, t.name, attr_string, children_text, t.name);
 385         end
 386
 387         function stanza_mt.pretty_top_tag(t)
 388                 local attr_string = "";
 389                 if t.attr then
 390                         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
 391                 end
 392                 return s_format(top_tag_format, t.name, attr_string);
 393         end
 394 else
 395         -- Sorry, fresh out of colours for you guys ;)
 396         stanza_mt.pretty_print = stanza_mt.__tostring;
 397         stanza_mt.pretty_top_tag = stanza_mt.top_tag;
 398 end
 399
 400 return _M;