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