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 and n_tags > 0 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                                 i = i - 1;
 165                                 curr_tag = curr_tag - 1;
 166                         else
 167                                 self[i] = ret;
 168                                 tags[i] = ret;
 169                         end
 170                         curr_tag = curr_tag + 1;
 171                 end
 172                 i = i + 1;
 173         end
 174         return self;
 175 end
 176
 177 local xml_escape
 178 do
 179         local escape_table = { ["'"] = "&apos;", ["\""] = "&quot;", ["<"] = "&lt;", [">"] = "&gt;", ["&"] = "&amp;" };
 180         function xml_escape(str) return (s_gsub(str, "['&<>\"]", escape_table)); end
 181         _M.xml_escape = xml_escape;
 182 end
 183
 184 local function _dostring(t, buf, self, xml_escape, parentns)
 185         local nsid = 0;
 186         local name = t.name
 187         t_insert(buf, "<"..name);
 188         for k, v in pairs(t.attr) do
 189                 if s_find(k, "\1", 1, true) then
 190                         local ns, attrk = s_match(k, "^([^\1]*)\1?(.*)$");
 191                         nsid = nsid + 1;
 192                         t_insert(buf, " xmlns:ns"..nsid.."='"..xml_escape(ns).."' ".."ns"..nsid..":"..attrk.."='"..xml_escape(v).."'");
 193                 elseif not(k == "xmlns" and v == parentns) then
 194                         t_insert(buf, " "..k.."='"..xml_escape(v).."'");
 195                 end
 196         end
 197         local len = #t;
 198         if len == 0 then
 199                 t_insert(buf, "/>");
 200         else
 201                 t_insert(buf, ">");
 202                 for n=1,len do
 203                         local child = t[n];
 204                         if child.name then
 205                                 self(child, buf, self, xml_escape, t.attr.xmlns);
 206                         else
 207                                 t_insert(buf, xml_escape(child));
 208                         end
 209                 end
 210                 t_insert(buf, "</"..name..">");
 211         end
 212 end
 213 function stanza_mt.__tostring(t)
 214         local buf = {};
 215         _dostring(t, buf, _dostring, xml_escape, nil);
 216         return t_concat(buf);
 217 end
 218
 219 function stanza_mt.top_tag(t)
 220         local attr_string = "";
 221         if t.attr then
 222                 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
 223         end
 224         return s_format("<%s%s>", t.name, attr_string);
 225 end
 226
 227 function stanza_mt.get_text(t)
 228         if #t.tags == 0 then
 229                 return t_concat(t);
 230         end
 231 end
 232
 233 function stanza_mt.get_error(stanza)
 234         local type, condition, text;
 235
 236         local error_tag = stanza:get_child("error");
 237         if not error_tag then
 238                 return nil, nil, nil;
 239         end
 240         type = error_tag.attr.type;
 241
 242         for _, child in ipairs(error_tag.tags) do
 243                 if child.attr.xmlns == xmlns_stanzas then
 244                         if not text and child.name == "text" then
 245                                 text = child:get_text();
 246                         elseif not condition then
 247                                 condition = child.name;
 248                         end
 249                         if condition and text then
 250                                 break;
 251                         end
 252                 end
 253         end
 254         return type, condition or "undefined-condition", text;
 255 end
 256
 257 do
 258         local id = 0;
 259         function new_id()
 260                 id = id + 1;
 261                 return "lx"..id;
 262         end
 263 end
 264
 265 function preserialize(stanza)
 266         local s = { name = stanza.name, attr = stanza.attr };
 267         for _, child in ipairs(stanza) do
 268                 if type(child) == "table" then
 269                         t_insert(s, preserialize(child));
 270                 else
 271                         t_insert(s, child);
 272                 end
 273         end
 274         return s;
 275 end
 276
 277 function deserialize(stanza)
 278         -- Set metatable
 279         if stanza then
 280                 local attr = stanza.attr;
 281                 for i=1,#attr do attr[i] = nil; end
 282                 local attrx = {};
 283                 for att in pairs(attr) do
 284                         if s_find(att, "|", 1, true) and not s_find(att, "\1", 1, true) then
 285                                 local ns,na = s_match(att, "^([^|]+)|(.+)$");
 286                                 attrx[ns.."\1"..na] = attr[att];
 287                                 attr[att] = nil;
 288                         end
 289                 end
 290                 for a,v in pairs(attrx) do
 291                         attr[a] = v;
 292                 end
 293                 setmetatable(stanza, stanza_mt);
 294                 for _, child in ipairs(stanza) do
 295                         if type(child) == "table" then
 296                                 deserialize(child);
 297                         end
 298                 end
 299                 if not stanza.tags then
 300                         -- Rebuild tags
 301                         local tags = {};
 302                         for _, child in ipairs(stanza) do
 303                                 if type(child) == "table" then
 304                                         t_insert(tags, child);
 305                                 end
 306                         end
 307                         stanza.tags = tags;
 308                 end
 309         end
 310
 311         return stanza;
 312 end
 313
 314 local function _clone(stanza)
 315         local attr, tags = {}, {};
 316         for k,v in pairs(stanza.attr) do attr[k] = v; end
 317         local new = { name = stanza.name, attr = attr, tags = tags };
 318         for i=1,#stanza do
 319                 local child = stanza[i];
 320                 if child.name then
 321                         child = _clone(child);
 322                         t_insert(tags, child);
 323                 end
 324                 t_insert(new, child);
 325         end
 326         return setmetatable(new, stanza_mt);
 327 end
 328 clone = _clone;
 329
 330 function message(attr, body)
 331         if not body then
 332                 return stanza("message", attr);
 333         else
 334                 return stanza("message", attr):tag("body"):text(body):up();
 335         end
 336 end
 337 function iq(attr)
 338         if attr and not attr.id then attr.id = new_id(); end
 339         return stanza("iq", attr or { id = new_id() });
 340 end
 341
 342 function reply(orig)
 343         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) });
 344 end
 345
 346 do
 347         local xmpp_stanzas_attr = { xmlns = xmlns_stanzas };
 348         function error_reply(orig, type, condition, message)
 349                 local t = reply(orig);
 350                 t.attr.type = "error";
 351                 t:tag("error", {type = type}) --COMPAT: Some day xmlns:stanzas goes here
 352                         :tag(condition, xmpp_stanzas_attr):up();
 353                 if (message) then t:tag("text", xmpp_stanzas_attr):text(message):up(); end
 354                 return t; -- stanza ready for adding app-specific errors
 355         end
 356 end
 357
 358 function presence(attr)
 359         return stanza("presence", attr);
 360 end
 361
 362 if do_pretty_printing then
 363         local style_attrk = getstyle("yellow");
 364         local style_attrv = getstyle("red");
 365         local style_tagname = getstyle("red");
 366         local style_punc = getstyle("magenta");
 367
 368         local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
 369         local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
 370         --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, ">");
 371         local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
 372         function stanza_mt.pretty_print(t)
 373                 local children_text = "";
 374                 for n, child in ipairs(t) do
 375                         if type(child) == "string" then
 376                                 children_text = children_text .. xml_escape(child);
 377                         else
 378                                 children_text = children_text .. child:pretty_print();
 379                         end
 380                 end
 381
 382                 local attr_string = "";
 383                 if t.attr then
 384                         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
 385                 end
 386                 return s_format(tag_format, t.name, attr_string, children_text, t.name);
 387         end
 388
 389         function stanza_mt.pretty_top_tag(t)
 390                 local attr_string = "";
 391                 if t.attr then
 392                         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
 393                 end
 394                 return s_format(top_tag_format, t.name, attr_string);
 395         end
 396 else
 397         -- Sorry, fresh out of colours for you guys ;)
 398         stanza_mt.pretty_print = stanza_mt.__tostring;
 399         stanza_mt.pretty_top_tag = stanza_mt.top_tag;
 400 end
 401
 402 return _M;