util.stanza: Rewrote stanza_mt.__tostring. 20-30% faster stanza serialization. -...
[prosody.git] / util / stanza.lua
index a4fd0f82ad698557eee3fa61276a4f06eac7902f..aff0bfc7df7b989b6e1045cddb0f7ee675b03195 100644 (file)
@@ -1,13 +1,36 @@
+-- Prosody IM v0.4
+-- Copyright (C) 2008-2009 Matthew Wild
+-- Copyright (C) 2008-2009 Waqas Hussain
+-- 
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+
 local t_insert      =  table.insert;
+local t_concat      =  table.concat;
 local t_remove      =  table.remove;
+local t_concat      =  table.concat;
 local s_format      = string.format;
+local s_match       =  string.match;
 local tostring      =      tostring;
 local setmetatable  =  setmetatable;
+local getmetatable  =  getmetatable;
 local pairs         =         pairs;
 local ipairs        =        ipairs;
 local type          =          type;
+local next          =          next;
+local print         =         print;
 local unpack        =        unpack;
 local s_gsub        =   string.gsub;
+local s_char        =   string.char;
+local os            =            os;
+
+local do_pretty_printing = not os.getenv("WINDIR");
+local getstyle, getstring = require "util.termcolours".getstyle, require "util.termcolours".getstring;
+
+local log = require "util.logger".init("stanza");
+
 module "stanza"
 
 stanza_mt = {};
@@ -21,15 +44,20 @@ end
 function stanza_mt:query(xmlns)
        return self:tag("query", { xmlns = xmlns });
 end
+
+function stanza_mt:body(text, attr)
+       return self:tag("body", attr):text(text);
+end
+
 function stanza_mt:tag(name, attrs)
        local s = stanza(name, attrs);
-       (self.last_add[#self.last_add] or self):add_child(s);
+       (self.last_add[#self.last_add] or self):add_direct_child(s);
        t_insert(self.last_add, s);
        return self;
 end
 
 function stanza_mt:text(text)
-       (self.last_add[#self.last_add] or self):add_child(text);
+       (self.last_add[#self.last_add] or self):add_direct_child(text);
        return self; 
 end
 
@@ -38,19 +66,38 @@ function stanza_mt:up()
        return self;
 end
 
-function stanza_mt:add_child(child)
+function stanza_mt:reset()
+       local last_add = self.last_add;
+       for i = 1,#last_add do
+               last_add[i] = nil;
+       end
+       return self;
+end
+
+function stanza_mt:add_direct_child(child)
        if type(child) == "table" then
                t_insert(self.tags, child);
        end
        t_insert(self, child);
 end
 
+function stanza_mt:add_child(child)
+       (self.last_add[#self.last_add] or self):add_direct_child(child);
+       return self;
+end
+
 function stanza_mt:child_with_name(name)
-       for _, child in ipairs(self) do 
+       for _, child in ipairs(self.tags) do    
                if child.name == name then return child; end
        end
 end
 
+function stanza_mt:child_with_ns(ns)
+       for _, child in ipairs(self.tags) do    
+               if child.attr.xmlns == ns then return child; end
+       end
+end
+
 function stanza_mt:children()
        local i = 0;
        return function (a)
@@ -70,33 +117,49 @@ function stanza_mt:childtags()
                                            
 end
 
-do
-       local xml_entities = { ["'"] = "&apos;", ["\""] = "&quot;", ["<"] = "&lt;", [">"] = "&gt;", ["&"] = "&amp;" };
-       function xml_escape(s) return s_gsub(s, "['&<>\"]", xml_entities); end
-end
-
-local xml_escape = xml_escape;
-
-function stanza_mt.__tostring(t)
-       local children_text = "";
-       for n, child in ipairs(t) do
-               if type(child) == "string" then 
-                       children_text = children_text .. xml_escape(child);
+local xml_escape = (function()
+       local escape_table = { ["'"] = "&apos;", ["\""] = "&quot;", ["<"] = "&lt;", [">"] = "&gt;", ["&"] = "&amp;" };
+       return function(str) return (s_gsub(str, "['&<>\"]", escape_table)); end
+end)();
+local function _dostring(t, buf, self, xml_escape)
+       local nsid, ns, attrk = 0;
+       t_insert(buf, "<"..t.name);
+       for k, v in pairs(t.attr) do
+               ns, attrk = s_match(k, "^([^|]+)|(.+)$");
+               if ns then
+                       nsid = nsid + 1;
+                       t_insert(buf, " xmlns:ns"..nsid.."='"..xml_escape(ns).."' ".."ns"..nsid..":"..attrk.."='"..xml_escape(v).."'");
+               else
+                       t_insert(buf, " "..k.."='"..xml_escape(v).."'");
+               end
+       end
+       t_insert(buf, ">");
+       for n=1,#t do
+               local child = t[n];
+               if child.name then
+                       self(child, buf, self, xml_escape);
                else
-                       children_text = children_text .. tostring(child);
+                       t_insert(buf, xml_escape(child));
                end
        end
+       t_insert(buf, "</"..t.name..">");
+end
+function stanza_mt.__tostring(t)
+       local buf = {};
+       _dostring(t, buf, _dostring, xml_escape);
+       return t_concat(buf);
+end
 
+function stanza_mt.top_tag(t)
        local attr_string = "";
        if t.attr then
-               for k, v in pairs(t.attr) do if type(k) == "string" then attr_string = attr_string .. s_format(" %s='%s'", k, tostring(v)); end end
+               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
        end
-
-       return s_format("<%s%s>%s</%s>", t.name, attr_string, children_text, t.name);
+       return s_format("<%s%s>", t.name, attr_string);
 end
 
 function stanza_mt.__add(s1, s2)
-       return s1:add_child(s2);
+       return s1:add_direct_child(s2);
 end
 
 
@@ -122,26 +185,51 @@ end
 
 function deserialize(stanza)
        -- Set metatable
-       setmetatable(stanza, stanza_mt);
-       for _, child in ipairs(stanza) do
-               if type(child) == "table" then
-                       deserialize(child);
-               end
-       end
-       if not stanza.tags then
-               -- Rebuild tags
-               local tags = {};
+       if stanza then
+               local attr = stanza.attr;
+               for i=1,#attr do attr[i] = nil; end
+               setmetatable(stanza, stanza_mt);
                for _, child in ipairs(stanza) do
                        if type(child) == "table" then
-                               t_insert(tags, child);
+                               deserialize(child);
+                       end
+               end
+               if not stanza.tags then
+                       -- Rebuild tags
+                       local tags = {};
+                       for _, child in ipairs(stanza) do
+                               if type(child) == "table" then
+                                       t_insert(tags, child);
+                               end
+                       end
+                       stanza.tags = tags;
+                       if not stanza.last_add then
+                               stanza.last_add = {};
                        end
                end
-               stanza.tags = tags;
        end
        
        return stanza;
 end
 
+function clone(stanza)
+    local lookup_table = {};
+    local function _copy(object)
+        if type(object) ~= "table" then
+            return object;
+        elseif lookup_table[object] then
+            return lookup_table[object];
+        end
+        local new_table = {};
+        lookup_table[object] = new_table;
+        for index, value in pairs(object) do
+            new_table[_copy(index)] = _copy(value);
+        end
+        return setmetatable(new_table, getmetatable(object));
+    end
+    return _copy(stanza)
+end
+
 function message(attr, body)
        if not body then
                return stanza("message", attr);
@@ -155,13 +243,12 @@ function iq(attr)
 end
 
 function reply(orig)
-       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 nil) });
+       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) });
 end
 
-function error_reply(orig, type, condition, message, clone)
+function error_reply(orig, type, condition, message)
        local t = reply(orig);
        t.attr.type = "error";
-       -- TODO use clone
        t:tag("error", {type = type})
                :tag(condition, {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
        if (message) then t:tag("text"):text(message):up(); end
@@ -172,4 +259,44 @@ function presence(attr)
        return stanza("presence", attr);
 end
 
+if do_pretty_printing then
+       local style_attrk = getstyle("yellow");
+       local style_attrv = getstyle("red");
+       local style_tagname = getstyle("red");
+       local style_punc = getstyle("magenta");
+       
+       local attr_format = " "..getstring(style_attrk, "%s")..getstring(style_punc, "=")..getstring(style_attrv, "'%s'");
+       local top_tag_format = getstring(style_punc, "<")..getstring(style_tagname, "%s").."%s"..getstring(style_punc, ">");
+       --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, ">");
+       local tag_format = top_tag_format.."%s"..getstring(style_punc, "</")..getstring(style_tagname, "%s")..getstring(style_punc, ">");
+       function stanza_mt.pretty_print(t)
+               local children_text = "";
+               for n, child in ipairs(t) do
+                       if type(child) == "string" then 
+                               children_text = children_text .. xml_escape(child);
+                       else
+                               children_text = children_text .. child:pretty_print();
+                       end
+               end
+
+               local attr_string = "";
+               if t.attr then
+                       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
+               end
+               return s_format(tag_format, t.name, attr_string, children_text, t.name);
+       end
+       
+       function stanza_mt.pretty_top_tag(t)
+               local attr_string = "";
+               if t.attr then
+                       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
+               end
+               return s_format(top_tag_format, t.name, attr_string);
+       end
+else
+       -- Sorry, fresh out of colours for you guys ;)
+       stanza_mt.pretty_print = stanza_mt.__tostring;
+       stanza_mt.pretty_top_tag = stanza_mt.top_tag;
+end
+
 return _M;