* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
-#include <string>
-#include <vector>
-
-#include "zlib.h"
-
-#include "inspircd_config.h"
-#include "configreader.h"
+#include "inspircd.h"
+#include <zlib.h>
#include "users.h"
#include "channels.h"
#include "modules.h"
-
#include "socket.h"
#include "hashcomp.h"
-#include "inspircd.h"
-
#include "transport.h"
/* $ModDesc: Provides zlib link support for servers */
*
*/
+/* Status of a connection */
enum izip_status { IZIP_OPEN, IZIP_CLOSED };
+/* Maximum transfer size per read operation */
const unsigned int CHUNK = 128 * 1024;
+/* This class manages a compressed chunk of data preceeded by
+ * a length count.
+ *
+ * It can handle having multiple chunks of data in the buffer
+ * at any time.
+ */
class CountedBuffer : public classbase
{
std::string buffer; /* Current buffer contents */
}
};
-/** Represents an ZIP user's extra data
+/** Represents an zipped connections extra data
*/
class izip_session : public classbase
{
public:
- z_stream c_stream; /* compression stream */
- z_stream d_stream; /* decompress stream */
- izip_status status;
- int fd;
- CountedBuffer* inbuf;
- std::string outbuf;
+ z_stream c_stream; /* compression stream */
+ z_stream d_stream; /* decompress stream */
+ izip_status status; /* Connection status */
+ int fd; /* File descriptor */
+ CountedBuffer* inbuf; /* Holds input buffer */
+ std::string outbuf; /* Holds output buffer */
};
class ModuleZLib : public Module
{
izip_session sessions[MAX_DESCRIPTORS];
+
+ /* Used for stats z extensions */
float total_out_compressed;
float total_in_compressed;
float total_out_uncompressed;
virtual ~ModuleZLib()
{
+ ServerInstance->UnpublishInterface("InspSocketHook", this);
}
virtual Version GetVersion()
List[I_OnStats] = List[I_OnRequest] = 1;
}
- virtual char* OnRequest(Request* request)
+ /* Handle InspSocketHook API requests */
+ virtual char* OnRequest(Request* request)
{
ISHRequest* ISR = (ISHRequest*)request;
if (strcmp("IS_NAME", request->GetId()) == 0)
{
+ /* Return name */
return "zip";
}
else if (strcmp("IS_HOOK", request->GetId()) == 0)
{
+ /* Attach to an inspsocket */
char* ret = "OK";
try
{
}
else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
{
+ /* Detatch from an inspsocket */
return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
}
else if (strcmp("IS_HSDONE", request->GetId()) == 0)
{
+ /* Check for completion of handshake
+ * (actually, this module doesnt handshake)
+ */
return "OK";
}
else if (strcmp("IS_ATTACH", request->GetId()) == 0)
{
+ /* Attach certificate data to the inspsocket
+ * (this module doesnt do that, either)
+ */
return NULL;
}
return NULL;
}
+ /* Handle stats z (misc stats) */
virtual int OnStats(char symbol, userrec* user, string_list &results)
{
if (symbol == 'z')
{
std::string sn = ServerInstance->Config->ServerName;
+ /* Yeah yeah, i know, floats are ew.
+ * We used them here because we'd be casting to float anyway to do this maths,
+ * and also only floating point numbers can deal with the pretty large numbers
+ * involved in the total throughput of a server over a large period of time.
+ * (we dont count 64 bit ints because not all systems have 64 bit ints, and floats
+ * can still hold more.
+ */
float outbound_r = 100 - ((total_out_compressed / (total_out_uncompressed + 0.001)) * 100);
float inbound_r = 100 - ((total_in_compressed / (total_in_uncompressed + 0.001)) * 100);
{
izip_session* session = &sessions[fd];
- /* allocate deflate state */
+ /* allocate state and buffers */
session->fd = fd;
session->status = IZIP_OPEN;
-
session->inbuf = new CountedBuffer();
- ServerInstance->Log(DEBUG,"session->inbuf ALLOC = %d, %08x", fd, session->inbuf);
session->c_stream.zalloc = (alloc_func)0;
session->c_stream.zfree = (free_func)0;
virtual void OnRawSocketConnect(int fd)
{
+ /* Nothing special needs doing here compared to accept() */
OnRawSocketAccept(fd, "", 0);
}
virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
{
+ /* Find the sockets session */
izip_session* session = &sessions[fd];
if (session->status == IZIP_CLOSED)
- return 1;
+ return 0;
- unsigned char compr[CHUNK + 1];
+ unsigned char compr[CHUNK + 4];
unsigned int offset = 0;
unsigned int total_size = 0;
+ /* Read CHUNK bytes at a time to the buffer (usually 128k) */
readresult = read(fd, compr, CHUNK);
+ /* Did we get anything? */
if (readresult > 0)
{
+ /* Add it to the frame queue */
session->inbuf->AddData(compr, readresult);
+ total_in_compressed += readresult;
+ /* Parse all completed frames */
int size = 0;
while ((size = session->inbuf->GetFrame(compr, CHUNK)) != 0)
{
session->d_stream.next_in = (Bytef*)compr;
session->d_stream.avail_in = 0;
session->d_stream.next_out = (Bytef*)(buffer + offset);
+
+ /* If we cant call this, well, we're boned. */
if (inflateInit(&session->d_stream) != Z_OK)
- return -EBADF;
+ return 0;
while ((session->d_stream.total_out < count) && (session->d_stream.total_in < (unsigned int)size))
{
break;
}
+ /* Stick a fork in me, i'm done */
inflateEnd(&session->d_stream);
- total_in_compressed += readresult;
+ /* Update counters and offsets */
total_size += session->d_stream.total_out;
total_in_uncompressed += session->d_stream.total_out;
offset += session->d_stream.total_out;
}
+ /* Null-terminate the buffer -- this doesnt harm binary data */
buffer[total_size] = 0;
+
+ /* Set the read size to the correct total size */
readresult = total_size;
}
virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
{
- ServerInstance->Log(DEBUG,"Compressing %d bytes", count);
-
izip_session* session = &sessions[fd];
int ocount = count;
- if (!count)
- {
- ServerInstance->Log(DEBUG,"Nothing to do!");
- return 1;
- }
+ if (!count) /* Nothing to do! */
+ return 0;
if(session->status != IZIP_OPEN)
{
+ /* Seriously, wtf? */
CloseSession(session);
- return -1;
+ return 0;
}
- unsigned char compr[CHUNK];
+ unsigned char compr[CHUNK + 4];
+ /* Gentlemen, start your engines! */
if (deflateInit(&session->c_stream, Z_BEST_COMPRESSION) != Z_OK)
{
- ServerInstance->Log(DEBUG,"Deflate init failed");
+ CloseSession(session);
+ return 0;
}
+ /* Set buffer sizes (we reserve 4 bytes at the start of the
+ * buffer for the length counters)
+ */
session->c_stream.next_in = (Bytef*)buffer;
- session->c_stream.next_out = compr+4;
+ session->c_stream.next_out = compr + 4;
+ /* Compress the text */
while ((session->c_stream.total_in < (unsigned int)count) && (session->c_stream.total_out < CHUNK))
{
- session->c_stream.avail_in = session->c_stream.avail_out = 1; /* force small buffers */
+ session->c_stream.avail_in = session->c_stream.avail_out = 1;
if (deflate(&session->c_stream, Z_NO_FLUSH) != Z_OK)
{
- ServerInstance->Log(DEBUG,"Couldnt deflate!");
CloseSession(session);
return 0;
}
}
- /* Finish the stream, still forcing small buffers: */
- for (;;)
- {
- session->c_stream.avail_out = 1;
- if (deflate(&session->c_stream, Z_FINISH) == Z_STREAM_END)
- break;
- }
-
+ /* Finish the stream */
+ for (session->c_stream.avail_out = 1; deflate(&session->c_stream, Z_FINISH) != Z_STREAM_END; session->c_stream.avail_out = 1);
deflateEnd(&session->c_stream);
total_out_uncompressed += ocount;
compr[2] = (session->c_stream.total_out >> 8);
compr[3] = (session->c_stream.total_out & 0xFF);
- session->outbuf.append((const char*)compr, session->c_stream.total_out+4);
+ /* Add compressed data plus leading length to the output buffer -
+ * Note, we may have incomplete half-sent frames in here.
+ */
+ session->outbuf.append((const char*)compr, session->c_stream.total_out + 4);
+ /* Lets see how much we can send out */
int ret = write(fd, session->outbuf.data(), session->outbuf.length());
+ /* Check for errors, and advance the buffer if any was sent */
if (ret > 0)
session->outbuf = session->outbuf.substr(ret);
else if (ret < 1)
return 0;
else
{
- session->outbuf = "";
+ session->outbuf.clear();
return 0;
}
}
else
{
- session->outbuf = "";
+ session->outbuf.clear();
return 0;
}
}
void CloseSession(izip_session* session)
{
- if (session->status = IZIP_OPEN)
+ if (session->status == IZIP_OPEN)
{
session->status = IZIP_CLOSED;
- session->outbuf = "";
+ session->outbuf.clear();
delete session->inbuf;
}
}
};
-class ModuleZLibFactory : public ModuleFactory
-{
- public:
- ModuleZLibFactory()
- {
- }
-
- ~ModuleZLibFactory()
- {
- }
-
- virtual Module * CreateModule(InspIRCd* Me)
- {
- return new ModuleZLib(Me);
- }
-};
+MODULE_INIT(ModuleZLib);
-
-extern "C" void * init_module( void )
-{
- return new ModuleZLibFactory;
-}
projects / user / henk / code / inspircd.git / blobdiff