plugins/mod_compression.lua
author Tobias Markmann <tm@ayena.de>
Tue, 18 Aug 2009 21:46:25 +0200
changeset 1718 af3d0c329396
parent 1716 3f7fd1445d02
child 1719 cf103398e643
permissions -rw-r--r--
Support compression also after SASL.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1669
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     1
-- Prosody IM
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     2
-- Copyright (C) 2009 Tobias Markmann
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     3
-- 
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     4
-- This project is MIT/X11 licensed. Please see the
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     5
-- COPYING file in the source package for more information.
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     6
--
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     7
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
     8
local st = require "util.stanza";
1671
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
     9
local zlib = require "zlib";
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    10
local pcall = pcall;
1669
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    11
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    12
local xmlns_compression_feature = "http://jabber.org/features/compress"
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    13
local xmlns_compression_protocol = "http://jabber.org/protocol/compress"
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    14
local compression_stream_feature = st.stanza("compression", {xmlns=xmlns_compression_feature}):tag("method"):text("zlib"):up();
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    15
1676
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    16
local compression_level = module:get_option("compression_level");
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    17
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    18
-- if not defined assume admin wants best compression
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    19
if compression_level == nil then compression_level = 9 end;
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    20
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    21
compression_level = tonumber(compression_level);
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    22
if not compression_level or compression_level < 1 or compression_level > 9 then
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    23
	module:log("warn", "Invalid compression level in config: %s", tostring(compression_level));
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    24
	module:log("warn", "Module loading aborted. Compression won't be available.");
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    25
	return;
719350956714 Add config option handling.
Tobias Markmann <tm@ayena.de>
parents: 1674
diff changeset
    26
end
1669
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    27
1670
23bb280c5eac Remove unwanted spaces.
Tobias Markmann <tm@ayena.de>
parents: 1669
diff changeset
    28
module:add_event_hook("stream-features",
1669
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    29
		function (session, features)
1673
5f81cd6d4a92 Remove space at the end of a line.
Tobias Markmann <tm@ayena.de>
parents: 1672
diff changeset
    30
			if not session.compressed then
1674
250bddde4162 Add a TODO for s2s compression support.
Tobias Markmann <tm@ayena.de>
parents: 1673
diff changeset
    31
				-- FIXME only advertise compression support when TLS layer has no compression enabled
1672
614623f393c6 Add FIXME to remember TLS compression detection.
Tobias Markmann <tm@ayena.de>
parents: 1671
diff changeset
    32
				features:add_child(compression_stream_feature);
614623f393c6 Add FIXME to remember TLS compression detection.
Tobias Markmann <tm@ayena.de>
parents: 1671
diff changeset
    33
			end
1669
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    34
		end
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    35
);
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    36
1674
250bddde4162 Add a TODO for s2s compression support.
Tobias Markmann <tm@ayena.de>
parents: 1673
diff changeset
    37
-- TODO Support compression on S2S level too.
1718
af3d0c329396 Support compression also after SASL.
Tobias Markmann <tm@ayena.de>
parents: 1716
diff changeset
    38
module:add_handler({"c2s_unauthed", "c2s_authed"}, "compress", xmlns_compression_protocol,
1669
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    39
		function(session, stanza)
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    40
			-- checking if the compression method is supported
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    41
			local method = stanza:child_with_name("method")[1];
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    42
			if method == "zlib" then
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    43
				session.log("info", method.." compression selected.");
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
    44
				session.send(st.stanza("compressed", {xmlns=xmlns_compression_protocol}));
1671
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    45
				session:reset_stream();
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    46
				
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    47
				-- create deflate and inflate streams
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    48
				local status, deflate_stream = pcall(zlib.deflate, compression_level);
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    49
				if status == false then
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    50
					local error_st = st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("setup-failed");
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    51
					session.send(error_st);
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    52
					session:log("error", "Failed to create zlib.deflate filter.");
1716
3f7fd1445d02 mod_compression: Fixed some undefined global accesses
Waqas Hussain <waqas20@gmail.com>
parents: 1679
diff changeset
    53
					module:log("error", deflate_stream);
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    54
					return
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    55
				end
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    56
				
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    57
				local status, inflate_stream = pcall(zlib.inflate);
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    58
				if status == false then
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    59
					local error_st = st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("setup-failed");
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    60
					session.send(error_st);
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    61
					session:log("error", "Failed to create zlib.deflate filter.");
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    62
					module:log("error", inflate_stream);
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    63
					return
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    64
				end
1671
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    65
				
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    66
				-- setup compression for session.w
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    67
				local old_send = session.send;
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    68
				
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    69
				session.send = function(t)
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    70
						local status, compressed, eof = pcall(deflate_stream, tostring(t), 'sync');
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    71
						if status == false then
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    72
							session:close({
1718
af3d0c329396 Support compression also after SASL.
Tobias Markmann <tm@ayena.de>
parents: 1716
diff changeset
    73
								condition = "undefined-condition";
af3d0c329396 Support compression also after SASL.
Tobias Markmann <tm@ayena.de>
parents: 1716
diff changeset
    74
								text = compressed;
af3d0c329396 Support compression also after SASL.
Tobias Markmann <tm@ayena.de>
parents: 1716
diff changeset
    75
								extra = st.stanza("failure", {xmlns="http://jabber.org/protocol/compress"}):tag("processing-failed");
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    76
							});
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    77
							module:log("error", compressed);
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    78
							return;
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    79
						end
1671
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    80
						old_send(compressed);
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    81
					end;
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    82
					
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    83
				-- setup decompression for session.data
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    84
				local function setup_decompression(session)
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    85
					local old_data = session.data
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    86
					session.data = function(conn, data)
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    87
							local status, decompressed, eof = pcall(inflate_stream, data);
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    88
							if status == false then
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    89
								session:close({
1718
af3d0c329396 Support compression also after SASL.
Tobias Markmann <tm@ayena.de>
parents: 1716
diff changeset
    90
									condition = "undefined-condition";
af3d0c329396 Support compression also after SASL.
Tobias Markmann <tm@ayena.de>
parents: 1716
diff changeset
    91
									text = decompressed;
af3d0c329396 Support compression also after SASL.
Tobias Markmann <tm@ayena.de>
parents: 1716
diff changeset
    92
									extra = st.stanza("failure", {xmlns="http://jabber.org/protocol/compress"}):tag("processing-failed");
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    93
								});
1716
3f7fd1445d02 mod_compression: Fixed some undefined global accesses
Waqas Hussain <waqas20@gmail.com>
parents: 1679
diff changeset
    94
								module:log("error", decompressed);
1678
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    95
								return;
79eb903d0e67 Using pcall to make save the rest from zlib fails. Emit errors on those fails.
Tobias Markmann <tm@ayena.de>
parents: 1677
diff changeset
    96
							end
1671
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    97
							old_data(conn, decompressed);
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    98
						end;
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
    99
				end
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   100
				setup_decompression(session);
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   101
				
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   102
				local session_reset_stream = session.reset_stream;
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   103
				session.reset_stream = function(session)
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   104
						session_reset_stream(session);
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   105
						setup_decompression(session);
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   106
						return true;
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   107
					end;
d196ac213104 Actually inject de- and compression into the reading/writing functions.
Tobias Markmann <tm@ayena.de>
parents: 1670
diff changeset
   108
				session.compressed = true;
1669
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
   109
			else
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
   110
				session.log("info", method.." compression selected. But we don't support it.");
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
   111
				local error_st = st.stanza("failure", {xmlns=xmlns_compression_protocol}):tag("unsupported-method");
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
   112
				session.send(error_st);
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
   113
			end
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
   114
		end
b8eec163a823 Commit initial version of mod_compression.
Tobias Markmann <tm@ayena.de>
parents:
diff changeset
   115
);