compression.hxx File Reference

#include <zlib.h>
#include <string>
#include "Exception.hxx"
#include "LOG.hxx"

Include dependency graph for compression.hxx:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
std::string	compressString (const std::string &stringToCompress)
	Compress a given string with zlib. More...
std::string	decompressString (const std::string &compressedString)
	decompresses given string More...

Variables
constexpr int	CHUNK_SIZE = 65536

Function Documentation

compressString()

std::string compressString

(

const std::string &

stringToCompress

)

Compress a given string with zlib.

Compress the given string. Returns an empty string if something went wrong

Parameters

stringToCompress

String that should be compressed

Returns

std::string compressed data

Exceptions

CompressionError

if Zlib stream initialization fails or there was an error during the compression process

Definition at line 17 of file compression.hxx.

{
  z_stream zstream;
  std::string compressedString;
  int deflateResult = Z_OK;
  char writeBuffer[CHUNK_SIZE];
 
  // initialize zstream struct with zeroes, to prevent memory access violation during Initialization.
  zstream.zalloc = Z_NULL;
  zstream.zfree = Z_NULL;
  zstream.opaque = Z_NULL;
 
  if (deflateInit(&zstream, Z_BEST_COMPRESSION) != Z_OK)
  {
    if (zstream.msg)
      throw CompressionError(TRACE_INFO "Failed initialize Zlib stream: " + string{zstream.msg});
    throw CompressionError(TRACE_INFO "Failed initialize Zlib stream");
  }
 
  zstream.avail_in = static_cast<unsigned int>(stringToCompress.size());
  zstream.next_in = (Bytef *)stringToCompress.data();
 
  // run decompression until deflate stream ends
  do
  {
    zstream.next_out = reinterpret_cast<Bytef *>(writeBuffer);
    zstream.avail_out = sizeof(writeBuffer);
 
    deflateResult = deflate(&zstream, Z_FINISH);
 
    if (compressedString.size() < zstream.total_out)
    {
      compressedString.append(writeBuffer, zstream.total_out - compressedString.size());
    }
  } while (zstream.avail_out == 0);
 
  deflateEnd(&zstream);
 
  if (deflateResult != Z_STREAM_END)
  {
    if (zstream.msg)
      throw CompressionError(TRACE_INFO "Error while compressing file: " + string{zstream.msg});
    throw CompressionError(TRACE_INFO "Error while compressing file");
  }
 
  return compressedString;
}

decompressString()

std::string decompressString

(

const std::string &

compressedString

)

decompresses given string

Parameters

compressedString

The String that should be decompressed

Returns

std::string Uncompressed string

Exceptions

CompressionError

if Zlib stream initialization fails or there was an error during the decompression process

Definition at line 71 of file compression.hxx.

{
  z_stream zstream;
  std::string uncompressedString;
  int inflateResult;
  char readBuffer[CHUNK_SIZE];
 
  // initialize zstream struct with zeroes, to prevent memory access violation during Initialization.
  zstream.zalloc = Z_NULL;
  zstream.zfree = Z_NULL;
  zstream.opaque = Z_NULL;
 
  if (inflateInit(&zstream) != Z_OK)
  {
    if (zstream.msg)
      throw CompressionError(TRACE_INFO "Failed initialize Zlib stream: " + string{zstream.msg});
    throw CompressionError(TRACE_INFO "Failed initialize Zlib stream");
  }
 
  zstream.next_in = (Bytef *)compressedString.data();
  zstream.avail_in = static_cast<unsigned int>(compressedString.size());
 
  // run decompression until buffer is empty
  do
  {
    zstream.next_out = reinterpret_cast<Bytef *>(readBuffer);
    zstream.avail_out = sizeof(readBuffer);
 
    inflateResult = inflate(&zstream, 0);
 
    if (uncompressedString.size() < zstream.total_out)
    {
      uncompressedString.append(readBuffer, zstream.total_out - uncompressedString.size());
    }
 
  } while (inflateResult == Z_OK);
 
  inflateEnd(&zstream);
 
  if (inflateResult != Z_STREAM_END)
  {
    if (zstream.msg)
      throw CompressionError(TRACE_INFO "Error while decompressing file: " + string{zstream.msg});
    throw CompressionError(TRACE_INFO "Error while decompressing file");
  }
 
  return uncompressedString;
}

Variable Documentation

CHUNK_SIZE

constexpr int CHUNK_SIZE = 65536

constexpr

Definition at line 8 of file compression.hxx.