util/stanza.lua

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