util/stanza.lua

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