src/ngircd/conn-zip.c

   1 /*
   2  * ngIRCd -- The Next Generation IRC Daemon
   3  * Copyright (c)2001-2006 Alexander Barton (alex@barton.de)
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  * Please read the file COPYING, README and AUTHORS for more information.
  10  *
  11  * Connection compression using ZLIB
  12  */
  13
  14
  15 #include "portab.h"
  16
  17 #define CONN_MODULE
  18
  19
  20 #ifdef ZLIB
  21
  22 /* enable more zlib related debug messages: */
  23 /* #define DEBUG_ZLIB */
  24
  25 static char UNUSED id[] = "$Id: conn-zip.c,v 1.14 2007/05/17 14:46:14 fw Exp $";
  26
  27 #include "imp.h"
  28 #include <assert.h>
  29 #include <string.h>
  30 #include <zlib.h>
  31
  32 #include "conn.h"
  33 #include "conn-func.h"
  34 #include "log.h"
  35
  36 #include "array.h"
  37 #include "exp.h"
  38 #include "conn-zip.h"
  39
  40
  41 GLOBAL bool
  42 Zip_InitConn( CONN_ID Idx )
  43 {
  44         /* Kompression fuer Link initialisieren */
  45
  46         assert( Idx > NONE );
  47
  48         My_Connections[Idx].zip.in.avail_in = 0;
  49         My_Connections[Idx].zip.in.total_in = 0;
  50         My_Connections[Idx].zip.in.total_out = 0;
  51         My_Connections[Idx].zip.in.zalloc = NULL;
  52         My_Connections[Idx].zip.in.zfree = NULL;
  53         My_Connections[Idx].zip.in.data_type = Z_ASCII;
  54
  55         if( inflateInit( &My_Connections[Idx].zip.in ) != Z_OK )
  56         {
  57                 /* Fehler! */
  58                 Log( LOG_ALERT, "Can't initialize compression on connection %d (zlib inflate)!", Idx );
  59                 return false;
  60         }
  61
  62         My_Connections[Idx].zip.out.total_in = 0;
  63         My_Connections[Idx].zip.out.total_in = 0;
  64         My_Connections[Idx].zip.out.zalloc = NULL;
  65         My_Connections[Idx].zip.out.zfree = NULL;
  66         My_Connections[Idx].zip.out.data_type = Z_ASCII;
  67
  68         if( deflateInit( &My_Connections[Idx].zip.out, Z_DEFAULT_COMPRESSION ) != Z_OK )
  69         {
  70                 /* Fehler! */
  71                 Log( LOG_ALERT, "Can't initialize compression on connection %d (zlib deflate)!", Idx );
  72                 return false;
  73         }
  74
  75         My_Connections[Idx].zip.bytes_in = My_Connections[Idx].bytes_in;
  76         My_Connections[Idx].zip.bytes_out = My_Connections[Idx].bytes_out;
  77
  78         Log( LOG_INFO, "Enabled link compression (zlib) on connection %d.", Idx );
  79         Conn_OPTION_ADD( &My_Connections[Idx], CONN_ZIP );
  80
  81         return true;
  82 } /* Zip_InitConn */
  83
  84
  85 GLOBAL bool
  86 Zip_Buffer( CONN_ID Idx, char *Data, size_t Len )
  87 {
  88         size_t buflen;
  89
  90         assert( Idx > NONE );
  91         assert( Data != NULL );
  92         assert( Len > 0 );
  93
  94         buflen = array_bytes(&My_Connections[Idx].zip.wbuf);
  95         if (buflen >= WRITEBUFFER_LEN) {
  96                 /* compression buffer is full, flush */
  97                 if( ! Zip_Flush( Idx )) return false;
  98         }
  99
 100         /* check again; if zip buf is still too large do not append data:
 101          * otherwise the zip wbuf would grow too large */
 102         buflen = array_bytes(&My_Connections[Idx].zip.wbuf);
 103         if (buflen >= WRITEBUFFER_LEN)
 104                 return false;
 105         return array_catb(&My_Connections[Idx].zip.wbuf, Data, Len);
 106 } /* Zip_Buffer */
 107
 108
 109 /**
 110  * Compress data in ZIP buffer and move result to the write buffer of
 111  * the connection.
 112  * @param Idx Connection handle.
 113  * @retrun true on success, false otherwise.
 114  */
 115 GLOBAL bool
 116 Zip_Flush( CONN_ID Idx )
 117 {
 118         int result;
 119         unsigned char zipbuf[WRITEBUFFER_LEN];
 120         int zipbuf_used = 0;
 121         z_stream *out;
 122
 123         out = &My_Connections[Idx].zip.out;
 124
 125         out->avail_in = (uInt)array_bytes(&My_Connections[Idx].zip.wbuf);
 126         if (!out->avail_in)
 127                 return true;    /* nothing to do. */
 128
 129         out->next_in = array_start(&My_Connections[Idx].zip.wbuf);
 130         assert(out->next_in != NULL);
 131
 132         out->next_out = zipbuf;
 133         out->avail_out = (uInt)sizeof zipbuf;
 134
 135 #ifdef DEBUG_ZIP
 136         Log(LOG_DEBUG, "out->avail_in %d, out->avail_out %d",
 137                 out->avail_in, out->avail_out);
 138 #endif
 139         result = deflate( out, Z_SYNC_FLUSH );
 140         if(( result != Z_OK ) || ( out->avail_in > 0 ))
 141         {
 142                 Log( LOG_ALERT, "Compression error: code %d!?", result );
 143                 Conn_Close( Idx, "Compression error!", NULL, false );
 144                 return false;
 145         }
 146
 147         if (out->avail_out <= 0) {
 148                 /* Not all data was compressed, because data became
 149                  * bigger while compressing it. */
 150                 Log (LOG_ALERT, "Compression error: buffer overvlow!?");
 151                 Conn_Close(Idx, "Compression error!", NULL, false);
 152                 return false;
 153         }
 154
 155         assert(out->avail_out <= WRITEBUFFER_LEN);
 156
 157         zipbuf_used = WRITEBUFFER_LEN - out->avail_out;
 158 #ifdef DEBUG_ZIP
 159         Log(LOG_DEBUG, "zipbuf_used: %d", zipbuf_used);
 160 #endif
 161         if (!array_catb(&My_Connections[Idx].wbuf,
 162                         (char *)zipbuf, (size_t) zipbuf_used))
 163                 return false;
 164
 165         My_Connections[Idx].bytes_out += zipbuf_used;
 166         My_Connections[Idx].zip.bytes_out += array_bytes(&My_Connections[Idx].zip.wbuf);
 167         array_trunc(&My_Connections[Idx].zip.wbuf);
 168
 169         return true;
 170 } /* Zip_Flush */
 171
 172
 173 GLOBAL bool
 174 Unzip_Buffer( CONN_ID Idx )
 175 {
 176         /* Daten entpacken und in Lesepuffer kopieren. Bei Fehlern
 177         * wird false geliefert, ansonsten true. Der Fall, dass keine
 178         * Daten mehr zu entpacken sind, ist _kein_ Fehler! */
 179
 180         int result;
 181         unsigned char unzipbuf[READBUFFER_LEN];
 182         int unzipbuf_used = 0;
 183         unsigned int z_rdatalen;
 184         unsigned int in_len;
 185
 186         z_stream *in;
 187
 188         assert( Idx > NONE );
 189
 190         z_rdatalen = (unsigned int)array_bytes(&My_Connections[Idx].zip.rbuf);
 191         if (z_rdatalen == 0)
 192                 return true;
 193
 194         in = &My_Connections[Idx].zip.in;
 195
 196         in->next_in = array_start(&My_Connections[Idx].zip.rbuf);
 197         assert(in->next_in != NULL);
 198
 199         in->avail_in = z_rdatalen;
 200         in->next_out = unzipbuf;
 201         in->avail_out = (uInt)sizeof unzipbuf;
 202
 203 #ifdef DEBUG_ZIP
 204         Log(LOG_DEBUG, "in->avail_in %d, in->avail_out %d",
 205                 in->avail_in, in->avail_out);
 206 #endif
 207         result = inflate( in, Z_SYNC_FLUSH );
 208         if( result != Z_OK )
 209         {
 210                 Log( LOG_ALERT, "Decompression error: %s (code=%d, ni=%d, ai=%d, no=%d, ao=%d)!?", in->msg, result, in->next_in, in->avail_in, in->next_out, in->avail_out );
 211                 Conn_Close( Idx, "Decompression error!", NULL, false );
 212                 return false;
 213         }
 214
 215         assert(z_rdatalen >= in->avail_in);
 216         in_len = z_rdatalen - in->avail_in;
 217         unzipbuf_used = READBUFFER_LEN - in->avail_out;
 218 #ifdef DEBUG_ZIP
 219         Log(LOG_DEBUG, "unzipbuf_used: %d - %d = %d", READBUFFER_LEN,
 220                 in->avail_out, unzipbuf_used);
 221 #endif
 222         assert(unzipbuf_used <= READBUFFER_LEN);
 223         if (!array_catb(&My_Connections[Idx].rbuf, (char*) unzipbuf,
 224                         (size_t)unzipbuf_used))
 225                 return false;
 226
 227         if( in->avail_in > 0 ) {
 228                 array_moveleft(&My_Connections[Idx].zip.rbuf, 1, in_len );
 229         } else {
 230                 array_trunc( &My_Connections[Idx].zip.rbuf );
 231                 My_Connections[Idx].zip.bytes_in += unzipbuf_used;
 232         }
 233
 234         return true;
 235 } /* Unzip_Buffer */
 236
 237
 238 GLOBAL long
 239 Zip_SendBytes( CONN_ID Idx )
 240 {
 241         /* Anzahl gesendeter Bytes (komprimiert!) liefern */
 242
 243         assert( Idx > NONE );
 244         return My_Connections[Idx].zip.bytes_out;
 245 } /* Zip_SendBytes */
 246
 247
 248 GLOBAL long
 249 Zip_RecvBytes( CONN_ID Idx )
 250 {
 251         /* Anzahl gesendeter Bytes (komprimiert!) liefern */
 252
 253         assert( Idx > NONE );
 254         return My_Connections[Idx].zip.bytes_in;
 255 } /* Zip_RecvBytes */
 256
 257
 258 #endif
 259
 260
 261 /* -eof- */