mod_admin_telnet: Don't rely on getpeerchain returning an empty list
[prosody.git] / plugins / mod_compression.lua
index c2e84f2b022b73892cf062997caac8ae488678d1..928560993bcd367d61cdd45c106a69365b08235e 100644 (file)
@@ -1,5 +1,5 @@
 -- Prosody IM
--- Copyright (C) 2009 Tobias Markmann
+-- Copyright (C) 2009-2012 Tobias Markmann
 -- 
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
@@ -14,13 +14,10 @@ local xmlns_compression_feature = "http://jabber.org/features/compress"
 local xmlns_compression_protocol = "http://jabber.org/protocol/compress"
 local xmlns_stream = "http://etherx.jabber.org/streams";
 local compression_stream_feature = st.stanza("compression", {xmlns=xmlns_compression_feature}):tag("method"):text("zlib"):up();
+local add_filter = require "util.filters".add_filter;
 
-local compression_level = module:get_option("compression_level");
--- if not defined assume admin wants best compression
-if compression_level == nil then compression_level = 9 end;
+local compression_level = module:get_option_number("compression_level", 7);
 
-
-compression_level = tonumber(compression_level);
 if not compression_level or compression_level < 1 or compression_level > 9 then
        module:log("warn", "Invalid compression level in config: %s", tostring(compression_level));
        module:log("warn", "Module loading aborted. Compression won't be available.");
@@ -29,7 +26,7 @@ end
 
 module:hook("stream-features", function(event)
        local origin, features = event.origin, event.features;
-       if not origin.compressed then
+       if not origin.compressed and (origin.type == "c2s" or origin.type == "s2sin" or origin.type == "s2sout") then
                -- FIXME only advertise compression support when TLS layer has no compression enabled
                features:add_child(compression_stream_feature);
        end
@@ -38,7 +35,7 @@ end);
 module:hook("s2s-stream-features", function(event)
        local origin, features = event.origin, event.features;
        -- FIXME only advertise compression support when TLS layer has no compression enabled
-       if not origin.compressed then 
+       if not origin.compressed and (origin.type == "c2s" or origin.type == "s2sin" or origin.type == "s2sout") then
                features:add_child(compression_stream_feature);
        end
 end);
@@ -46,7 +43,7 @@ end);
 -- Hook to activate compression if remote server supports it.
 module:hook_stanza(xmlns_stream, "features",
                function (session, stanza)
-                       if not session.compressed then
+                       if not session.compressed and (session.type == "c2s" or session.type == "s2sin" or session.type == "s2sout") then
                                -- does remote server support compression?
                                local comp_st = stanza:child_with_name("compression");
                                if comp_st then
@@ -55,7 +52,7 @@ module:hook_stanza(xmlns_stream, "features",
                                                local algorithm = a[1]
                                                if algorithm == "zlib" then
                                                        session.sends2s(st.stanza("compress", {xmlns=xmlns_compression_protocol}):tag("method"):text("zlib"))
-                                                       session.log("info", "Enabled compression using zlib.")
+                                                       session.log("debug", "Enabled compression using zlib.")
                                                        return true;
                                                end
                                        end
@@ -94,122 +91,105 @@ end
 
 -- setup compression for a stream
 local function setup_compression(session, deflate_stream)
-       local old_send = (session.sends2s or session.send);
-       
-       local new_send = function(t)
-                       --TODO: Better code injection in the sending process
-                       session.log(t)
-                       local status, compressed, eof = pcall(deflate_stream, tostring(t), 'sync');
-                       if status == false then
-                               session:close({
-                                       condition = "undefined-condition";
-                                       text = compressed;
-                                       extra = st.stanza("failure", {xmlns="http://jabber.org/protocol/compress"}):tag("processing-failed");
-                               });
-                               module:log("warn", "%s", tostring(compressed));
-                               return;
-                       end
-                       session.conn:write(compressed);
-               end;
-       
-       if session.sends2s then session.sends2s = new_send
-       elseif session.send then session.send = new_send end
+       add_filter(session, "bytes/out", function(t)
+               local status, compressed, eof = pcall(deflate_stream, tostring(t), 'sync');
+               if status == false then
+                       module:log("warn", "%s", tostring(compressed));
+                       session:close({
+                               condition = "undefined-condition";
+                               text = compressed;
+                               extra = st.stanza("failure", {xmlns="http://jabber.org/protocol/compress"}):tag("processing-failed");
+                       });
+                       return;
+               end
+               return compressed;
+       end);   
 end
 
 -- setup decompression for a stream
 local function setup_decompression(session, inflate_stream)
-       local old_data = session.data
-       session.data = function(conn, data)
-                       local status, decompressed, eof = pcall(inflate_stream, data);
-                       if status == false then
-                               session:close({
-                                       condition = "undefined-condition";
-                                       text = decompressed;
-                                       extra = st.stanza("failure", {xmlns="http://jabber.org/protocol/compress"}):tag("processing-failed");
-                               });
-                               module:log("warn", "%s", tostring(decompressed));
-                               return;
-                       end
-                       old_data(conn, decompressed);
-               end;
+       add_filter(session, "bytes/in", function(data)
+               local status, decompressed, eof = pcall(inflate_stream, data);
+               if status == false then
+                       module:log("warn", "%s", tostring(decompressed));
+                       session:close({
+                               condition = "undefined-condition";
+                               text = decompressed;
+                               extra = st.stanza("failure", {xmlns="http://jabber.org/protocol/compress"}):tag("processing-failed");
+                       });
+                       return;
+               end
+               return decompressed;
+       end);
 end
 
-module:add_handler({"s2sout_unauthed", "s2sout"}, "compressed", xmlns_compression_protocol, 
-               function(session ,stanza)
-                       session.log("debug", "Activating compression...")
+module:hook("stanza/http://jabber.org/protocol/compress:compressed", function(event)
+       local session = event.origin;
+       
+       if session.type == "s2sout_unauthed" or session.type == "s2sout" then
+               session.log("debug", "Activating compression...")
+               -- create deflate and inflate streams
+               local deflate_stream = get_deflate_stream(session);
+               if not deflate_stream then return true; end
+               
+               local inflate_stream = get_inflate_stream(session);
+               if not inflate_stream then return true; end
+               
+               -- setup compression for session.w
+               setup_compression(session, deflate_stream);
+                       
+               -- setup decompression for session.data
+               setup_decompression(session, inflate_stream);
+               session:reset_stream();
+               session:open_stream(session.from_host, session.to_host);
+               session.compressed = true;
+               return true;
+       end
+end);
+
+module:hook("stanza/http://jabber.org/protocol/compress:compress", function(event)
+       local session, stanza = event.origin, event.stanza;
+
+       if session.type == "c2s" or session.type == "s2sin" or session.type == "c2s_unauthed" or session.type == "s2sin_unauthed" then
+               -- fail if we are already compressed
+               if session.compressed then
+                       local error_st = st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("setup-failed");
+                       (session.sends2s or session.send)(error_st);
+                       session.log("debug", "Client tried to establish another compression layer.");
+                       return true;
+               end
+               
+               -- checking if the compression method is supported
+               local method = stanza:child_with_name("method");
+               method = method and (method[1] or "");
+               if method == "zlib" then
+                       session.log("debug", "zlib compression enabled.");
+                       
                        -- create deflate and inflate streams
                        local deflate_stream = get_deflate_stream(session);
-                       if not deflate_stream then return end
+                       if not deflate_stream then return true; end
                        
                        local inflate_stream = get_inflate_stream(session);
-                       if not inflate_stream then return end
+                       if not inflate_stream then return true; end
+                       
+                       (session.sends2s or session.send)(st.stanza("compressed", {xmlns=xmlns_compression_protocol}));
+                       session:reset_stream();
                        
                        -- setup compression for session.w
                        setup_compression(session, deflate_stream);
                                
                        -- setup decompression for session.data
                        setup_decompression(session, inflate_stream);
-                       local session_reset_stream = session.reset_stream;
-                       session.reset_stream = function(session)
-                                       session_reset_stream(session);
-                                       setup_decompression(session, inflate_stream);
-                                       return true;
-                               end;
-                       session:reset_stream();
-                       local default_stream_attr = {xmlns = "jabber:server", ["xmlns:stream"] = "http://etherx.jabber.org/streams",
-                                                                               ["xmlns:db"] = 'jabber:server:dialback', version = "1.0", to = session.to_host, from = session.from_host};
-                       session.sends2s("<?xml version='1.0'?>");
-                       session.sends2s(st.stanza("stream:stream", default_stream_attr):top_tag());
-                       session.compressed = true;
-               end
-);
-
-module:add_handler({"c2s_unauthed", "c2s", "s2sin_unauthed", "s2sin"}, "compress", xmlns_compression_protocol,
-               function(session, stanza)
-                       -- fail if we are already compressed
-                       if session.compressed then
-                               local error_st = st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("setup-failed");
-                               (session.sends2s or session.send)(error_st);
-                               session.log("debug", "Client tried to establish another compression layer.");
-                               return;
-                       end
                        
-                       -- checking if the compression method is supported
-                       local method = stanza:child_with_name("method");
-                       method = method and (method[1] or "");
-                       if method == "zlib" then
-                               session.log("debug", "zlib compression enabled.");
-                               
-                               -- create deflate and inflate streams
-                               local deflate_stream = get_deflate_stream(session);
-                               if not deflate_stream then return end
-                               
-                               local inflate_stream = get_inflate_stream(session);
-                               if not inflate_stream then return end
-                               
-                               (session.sends2s or session.send)(st.stanza("compressed", {xmlns=xmlns_compression_protocol}));
-                               session:reset_stream();
-                               
-                               -- setup compression for session.w
-                               setup_compression(session, deflate_stream);
-                                       
-                               -- setup decompression for session.data
-                               setup_decompression(session, inflate_stream);
-                               
-                               local session_reset_stream = session.reset_stream;
-                               session.reset_stream = function(session)
-                                               session_reset_stream(session);
-                                               setup_decompression(session, inflate_stream);
-                                               return true;
-                                       end;
-                               session.compressed = true;
-                       elseif method then
-                               session.log("debug", "%s compression selected, but we don't support it.", tostring(method));
-                               local error_st = st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("unsupported-method");
-                               (session.sends2s or session.send)(error_st);
-                       else
-                               (session.sends2s or session.send)(st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("setup-failed"));
-                       end
+                       session.compressed = true;
+               elseif method then
+                       session.log("debug", "%s compression selected, but we don't support it.", tostring(method));
+                       local error_st = st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("unsupported-method");
+                       (session.sends2s or session.send)(error_st);
+               else
+                       (session.sends2s or session.send)(st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("setup-failed"));
                end
-);
+               return true;
+       end
+end);