Blame buckets/deflate_buckets.c

Packit 3adb1e
/* ====================================================================
Packit 3adb1e
 *    Licensed to the Apache Software Foundation (ASF) under one
Packit 3adb1e
 *    or more contributor license agreements.  See the NOTICE file
Packit 3adb1e
 *    distributed with this work for additional information
Packit 3adb1e
 *    regarding copyright ownership.  The ASF licenses this file
Packit 3adb1e
 *    to you under the Apache License, Version 2.0 (the
Packit 3adb1e
 *    "License"); you may not use this file except in compliance
Packit 3adb1e
 *    with the License.  You may obtain a copy of the License at
Packit 3adb1e
 *
Packit 3adb1e
 *      http://www.apache.org/licenses/LICENSE-2.0
Packit 3adb1e
 *
Packit 3adb1e
 *    Unless required by applicable law or agreed to in writing,
Packit 3adb1e
 *    software distributed under the License is distributed on an
Packit 3adb1e
 *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
Packit 3adb1e
 *    KIND, either express or implied.  See the License for the
Packit 3adb1e
 *    specific language governing permissions and limitations
Packit 3adb1e
 *    under the License.
Packit 3adb1e
 * ====================================================================
Packit 3adb1e
 */
Packit 3adb1e
Packit 3adb1e
#include <apr_strings.h>
Packit 3adb1e
Packit 3adb1e
#include <zlib.h>
Packit 3adb1e
Packit 3adb1e
/* This conditional isn't defined anywhere yet. */
Packit 3adb1e
#ifdef HAVE_ZUTIL_H
Packit 3adb1e
#include <zutil.h>
Packit 3adb1e
#endif
Packit 3adb1e
Packit 3adb1e
#include "serf.h"
Packit 3adb1e
#include "serf_bucket_util.h"
Packit 3adb1e
Packit 3adb1e
/* magic header */
Packit 3adb1e
static char deflate_magic[2] = { '\037', '\213' };
Packit 3adb1e
#define DEFLATE_MAGIC_SIZE 10
Packit 3adb1e
#define DEFLATE_VERIFY_SIZE 8
Packit 3adb1e
#define DEFLATE_BUFFER_SIZE 8096
Packit 3adb1e
Packit 3adb1e
static const int DEFLATE_WINDOW_SIZE = -15;
Packit 3adb1e
static const int DEFLATE_MEMLEVEL = 9;
Packit 3adb1e
Packit 3adb1e
typedef struct {
Packit 3adb1e
    serf_bucket_t *stream;
Packit 3adb1e
    serf_bucket_t *inflate_stream;
Packit 3adb1e
Packit 3adb1e
    int format;                 /* Are we 'deflate' or 'gzip'? */
Packit 3adb1e
Packit 3adb1e
    enum {
Packit 3adb1e
        STATE_READING_HEADER,   /* reading the gzip header */
Packit 3adb1e
        STATE_HEADER,           /* read the gzip header */
Packit 3adb1e
        STATE_INIT,             /* init'ing zlib functions */
Packit 3adb1e
        STATE_INFLATE,          /* inflating the content now */
Packit 3adb1e
        STATE_READING_VERIFY,   /* reading the final gzip CRC */
Packit 3adb1e
        STATE_VERIFY,           /* verifying the final gzip CRC */
Packit 3adb1e
        STATE_FINISH,           /* clean up after reading body */
Packit 3adb1e
        STATE_DONE,             /* body is done; we'll return EOF here */
Packit 3adb1e
    } state;
Packit 3adb1e
Packit 3adb1e
    z_stream zstream;
Packit 3adb1e
    char hdr_buffer[DEFLATE_MAGIC_SIZE];
Packit 3adb1e
    unsigned char buffer[DEFLATE_BUFFER_SIZE];
Packit 3adb1e
    unsigned long crc;
Packit 3adb1e
    int windowSize;
Packit 3adb1e
    int memLevel;
Packit 3adb1e
    int bufferSize;
Packit 3adb1e
Packit 3adb1e
    /* How much of the chunk, or the terminator, do we have left to read? */
Packit 3adb1e
    apr_size_t stream_left;
Packit 3adb1e
Packit 3adb1e
    /* How much are we supposed to read? */
Packit 3adb1e
    apr_size_t stream_size;
Packit 3adb1e
Packit 3adb1e
    int stream_status; /* What was the last status we read? */
Packit 3adb1e
Packit 3adb1e
} deflate_context_t;
Packit 3adb1e
Packit 3adb1e
/* Inputs a string and returns a long.  */
Packit 3adb1e
static unsigned long getLong(unsigned char *string)
Packit 3adb1e
{
Packit 3adb1e
    return ((unsigned long)string[0])
Packit 3adb1e
          | (((unsigned long)string[1]) << 8)
Packit 3adb1e
          | (((unsigned long)string[2]) << 16)
Packit 3adb1e
          | (((unsigned long)string[3]) << 24);
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
serf_bucket_t *serf_bucket_deflate_create(
Packit 3adb1e
    serf_bucket_t *stream,
Packit 3adb1e
    serf_bucket_alloc_t *allocator,
Packit 3adb1e
    int format)
Packit 3adb1e
{
Packit 3adb1e
    deflate_context_t *ctx;
Packit 3adb1e
Packit 3adb1e
    ctx = serf_bucket_mem_alloc(allocator, sizeof(*ctx));
Packit 3adb1e
    ctx->stream = stream;
Packit 3adb1e
    ctx->stream_status = APR_SUCCESS;
Packit 3adb1e
    ctx->inflate_stream = serf_bucket_aggregate_create(allocator);
Packit 3adb1e
    ctx->format = format;
Packit 3adb1e
    ctx->crc = 0;
Packit 3adb1e
    /* zstream must be NULL'd out. */
Packit 3adb1e
    memset(&ctx->zstream, 0, sizeof(ctx->zstream));
Packit 3adb1e
Packit 3adb1e
    switch (ctx->format) {
Packit 3adb1e
        case SERF_DEFLATE_GZIP:
Packit 3adb1e
            ctx->state = STATE_READING_HEADER;
Packit 3adb1e
            break;
Packit 3adb1e
        case SERF_DEFLATE_DEFLATE:
Packit 3adb1e
            /* deflate doesn't have a header. */
Packit 3adb1e
            ctx->state = STATE_INIT;
Packit 3adb1e
            break;
Packit 3adb1e
        default:
Packit 3adb1e
            /* Not reachable */
Packit 3adb1e
            return NULL;
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    /* Initial size of gzip header. */
Packit 3adb1e
    ctx->stream_left = ctx->stream_size = DEFLATE_MAGIC_SIZE;
Packit 3adb1e
Packit 3adb1e
    ctx->windowSize = DEFLATE_WINDOW_SIZE;
Packit 3adb1e
    ctx->memLevel = DEFLATE_MEMLEVEL;
Packit 3adb1e
    ctx->bufferSize = DEFLATE_BUFFER_SIZE;
Packit 3adb1e
Packit 3adb1e
    return serf_bucket_create(&serf_bucket_type_deflate, allocator, ctx);
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static void serf_deflate_destroy_and_data(serf_bucket_t *bucket)
Packit 3adb1e
{
Packit 3adb1e
    deflate_context_t *ctx = bucket->data;
Packit 3adb1e
Packit 3adb1e
    if (ctx->state > STATE_INIT &&
Packit 3adb1e
        ctx->state <= STATE_FINISH)
Packit 3adb1e
        inflateEnd(&ctx->zstream);
Packit 3adb1e
Packit 3adb1e
    /* We may have appended inflate_stream into the stream bucket.
Packit 3adb1e
     * If so, avoid free'ing it twice.
Packit 3adb1e
     */
Packit 3adb1e
    if (ctx->inflate_stream) {
Packit 3adb1e
        serf_bucket_destroy(ctx->inflate_stream);
Packit 3adb1e
    }
Packit 3adb1e
    serf_bucket_destroy(ctx->stream);
Packit 3adb1e
Packit 3adb1e
    serf_default_destroy_and_data(bucket);
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static apr_status_t serf_deflate_read(serf_bucket_t *bucket,
Packit 3adb1e
                                      apr_size_t requested,
Packit 3adb1e
                                      const char **data, apr_size_t *len)
Packit 3adb1e
{
Packit 3adb1e
    deflate_context_t *ctx = bucket->data;
Packit 3adb1e
    apr_status_t status;
Packit 3adb1e
    const char *private_data;
Packit 3adb1e
    apr_size_t private_len;
Packit 3adb1e
    int zRC;
Packit 3adb1e
Packit 3adb1e
    while (1) {
Packit 3adb1e
        switch (ctx->state) {
Packit 3adb1e
        case STATE_READING_HEADER:
Packit 3adb1e
        case STATE_READING_VERIFY:
Packit 3adb1e
            status = serf_bucket_read(ctx->stream, ctx->stream_left,
Packit 3adb1e
                                      &private_data, &private_len);
Packit 3adb1e
Packit 3adb1e
            if (SERF_BUCKET_READ_ERROR(status)) {
Packit 3adb1e
                return status;
Packit 3adb1e
            }
Packit 3adb1e
Packit 3adb1e
            memcpy(ctx->hdr_buffer + (ctx->stream_size - ctx->stream_left),
Packit 3adb1e
                   private_data, private_len);
Packit 3adb1e
Packit 3adb1e
            ctx->stream_left -= private_len;
Packit 3adb1e
Packit 3adb1e
            if (ctx->stream_left == 0) {
Packit 3adb1e
                ctx->state++;
Packit 3adb1e
                if (APR_STATUS_IS_EAGAIN(status)) {
Packit 3adb1e
                    *len = 0;
Packit 3adb1e
                    return status;
Packit 3adb1e
                }
Packit 3adb1e
            }
Packit 3adb1e
            else if (status) {
Packit 3adb1e
                *len = 0;
Packit 3adb1e
                return status;
Packit 3adb1e
            }
Packit 3adb1e
            break;
Packit 3adb1e
        case STATE_HEADER:
Packit 3adb1e
            if (ctx->hdr_buffer[0] != deflate_magic[0] ||
Packit 3adb1e
                ctx->hdr_buffer[1] != deflate_magic[1]) {
Packit 3adb1e
                return SERF_ERROR_DECOMPRESSION_FAILED;
Packit 3adb1e
            }
Packit 3adb1e
            if (ctx->hdr_buffer[3] != 0) {
Packit 3adb1e
                return SERF_ERROR_DECOMPRESSION_FAILED;
Packit 3adb1e
            }
Packit 3adb1e
            ctx->state++;
Packit 3adb1e
            break;
Packit 3adb1e
        case STATE_VERIFY:
Packit 3adb1e
        {
Packit 3adb1e
            unsigned long compCRC, compLen, actualLen;
Packit 3adb1e
Packit 3adb1e
            /* Do the checksum computation. */
Packit 3adb1e
            compCRC = getLong((unsigned char*)ctx->hdr_buffer);
Packit 3adb1e
            if (ctx->crc != compCRC) {
Packit 3adb1e
                return SERF_ERROR_DECOMPRESSION_FAILED;
Packit 3adb1e
            }
Packit 3adb1e
            compLen = getLong((unsigned char*)ctx->hdr_buffer + 4);
Packit 3adb1e
            /* The length in the trailer is module 2^32, so do the same for
Packit 3adb1e
               the actual length. */
Packit 3adb1e
            actualLen = ctx->zstream.total_out;
Packit 3adb1e
            actualLen &= 0xFFFFFFFF;
Packit 3adb1e
            if (actualLen != compLen) {
Packit 3adb1e
                return SERF_ERROR_DECOMPRESSION_FAILED;
Packit 3adb1e
            }
Packit 3adb1e
            ctx->state++;
Packit 3adb1e
            break;
Packit 3adb1e
        }
Packit 3adb1e
        case STATE_INIT:
Packit 3adb1e
            zRC = inflateInit2(&ctx->zstream, ctx->windowSize);
Packit 3adb1e
            if (zRC != Z_OK) {
Packit 3adb1e
                return SERF_ERROR_DECOMPRESSION_FAILED;
Packit 3adb1e
            }
Packit 3adb1e
            ctx->zstream.next_out = ctx->buffer;
Packit 3adb1e
            ctx->zstream.avail_out = ctx->bufferSize;
Packit 3adb1e
            ctx->state++;
Packit 3adb1e
            break;
Packit 3adb1e
        case STATE_FINISH:
Packit 3adb1e
            inflateEnd(&ctx->zstream);
Packit 3adb1e
            serf_bucket_aggregate_prepend(ctx->stream, ctx->inflate_stream);
Packit 3adb1e
            ctx->inflate_stream = 0;
Packit 3adb1e
            ctx->state++;
Packit 3adb1e
            break;
Packit 3adb1e
        case STATE_INFLATE:
Packit 3adb1e
            /* Do we have anything already uncompressed to read? */
Packit 3adb1e
            status = serf_bucket_read(ctx->inflate_stream, requested, data,
Packit 3adb1e
                                      len);
Packit 3adb1e
            if (SERF_BUCKET_READ_ERROR(status)) {
Packit 3adb1e
                return status;
Packit 3adb1e
            }
Packit 3adb1e
            /* Hide EOF. */
Packit 3adb1e
            if (APR_STATUS_IS_EOF(status)) {
Packit 3adb1e
                status = ctx->stream_status;
Packit 3adb1e
                if (APR_STATUS_IS_EOF(status)) {
Packit 3adb1e
                    /* We've read all of the data from our stream, but we
Packit 3adb1e
                     * need to continue to iterate until we flush
Packit 3adb1e
                     * out the zlib buffer.
Packit 3adb1e
                     */
Packit 3adb1e
                    status = APR_SUCCESS;
Packit 3adb1e
                }
Packit 3adb1e
            }
Packit 3adb1e
            if (*len != 0) {
Packit 3adb1e
                return status;
Packit 3adb1e
            }
Packit 3adb1e
Packit 3adb1e
            /* We tried; but we have nothing buffered. Fetch more. */
Packit 3adb1e
Packit 3adb1e
            /* It is possible that we maxed out avail_out before
Packit 3adb1e
             * exhausting avail_in; therefore, continue using the
Packit 3adb1e
             * previous buffer.  Otherwise, fetch more data from
Packit 3adb1e
             * our stream bucket.
Packit 3adb1e
             */
Packit 3adb1e
            if (ctx->zstream.avail_in == 0) {
Packit 3adb1e
                /* When we empty our inflated stream, we'll return this
Packit 3adb1e
                 * status - this allow us to eventually pass up EAGAINs.
Packit 3adb1e
                 */
Packit 3adb1e
                ctx->stream_status = serf_bucket_read(ctx->stream,
Packit 3adb1e
                                                      ctx->bufferSize,
Packit 3adb1e
                                                      &private_data,
Packit 3adb1e
                                                      &private_len);
Packit 3adb1e
Packit 3adb1e
                if (SERF_BUCKET_READ_ERROR(ctx->stream_status)) {
Packit 3adb1e
                    return ctx->stream_status;
Packit 3adb1e
                }
Packit 3adb1e
Packit 3adb1e
                if (!private_len && APR_STATUS_IS_EAGAIN(ctx->stream_status)) {
Packit 3adb1e
                    *len = 0;
Packit 3adb1e
                    status = ctx->stream_status;
Packit 3adb1e
                    ctx->stream_status = APR_SUCCESS;
Packit 3adb1e
                    return status;
Packit 3adb1e
                }
Packit 3adb1e
Packit 3adb1e
                ctx->zstream.next_in = (unsigned char*)private_data;
Packit 3adb1e
                ctx->zstream.avail_in = private_len;
Packit 3adb1e
            }
Packit 3adb1e
Packit 3adb1e
            while (1) {
Packit 3adb1e
Packit 3adb1e
                zRC = inflate(&ctx->zstream, Z_NO_FLUSH);
Packit 3adb1e
Packit 3adb1e
                /* We're full or zlib requires more space. Either case, clear
Packit 3adb1e
                   out our buffer, reset, and return. */
Packit 3adb1e
                if (zRC == Z_BUF_ERROR || ctx->zstream.avail_out == 0) {
Packit 3adb1e
                    serf_bucket_t *tmp;
Packit 3adb1e
                    ctx->zstream.next_out = ctx->buffer;
Packit 3adb1e
                    private_len = ctx->bufferSize - ctx->zstream.avail_out;
Packit 3adb1e
Packit 3adb1e
                    ctx->crc = crc32(ctx->crc, (const Bytef *)ctx->buffer,
Packit 3adb1e
                                     private_len);
Packit 3adb1e
Packit 3adb1e
                    /* FIXME: There probably needs to be a free func. */
Packit 3adb1e
                    tmp = SERF_BUCKET_SIMPLE_STRING_LEN((char *)ctx->buffer,
Packit 3adb1e
                                                        private_len,
Packit 3adb1e
                                                        bucket->allocator);
Packit 3adb1e
                    serf_bucket_aggregate_append(ctx->inflate_stream, tmp);
Packit 3adb1e
                    ctx->zstream.avail_out = ctx->bufferSize;
Packit 3adb1e
                    break;
Packit 3adb1e
                }
Packit 3adb1e
Packit 3adb1e
                if (zRC == Z_STREAM_END) {
Packit 3adb1e
                    serf_bucket_t *tmp;
Packit 3adb1e
Packit 3adb1e
                    private_len = ctx->bufferSize - ctx->zstream.avail_out;
Packit 3adb1e
                    ctx->crc = crc32(ctx->crc, (const Bytef *)ctx->buffer,
Packit 3adb1e
                                     private_len);
Packit 3adb1e
                    /* FIXME: There probably needs to be a free func. */
Packit 3adb1e
                    tmp = SERF_BUCKET_SIMPLE_STRING_LEN((char *)ctx->buffer,
Packit 3adb1e
                                                        private_len,
Packit 3adb1e
                                                        bucket->allocator);
Packit 3adb1e
                    serf_bucket_aggregate_append(ctx->inflate_stream, tmp);
Packit 3adb1e
Packit 3adb1e
                    ctx->zstream.avail_out = ctx->bufferSize;
Packit 3adb1e
Packit 3adb1e
                    /* Push back the remaining data to be read. */
Packit 3adb1e
                    tmp = serf_bucket_aggregate_create(bucket->allocator);
Packit 3adb1e
                    serf_bucket_aggregate_prepend(tmp, ctx->stream);
Packit 3adb1e
                    ctx->stream = tmp;
Packit 3adb1e
Packit 3adb1e
                    /* We now need to take the remaining avail_in and
Packit 3adb1e
                     * throw it in ctx->stream so our next read picks it up.
Packit 3adb1e
                     */
Packit 3adb1e
                    tmp = SERF_BUCKET_SIMPLE_STRING_LEN(
Packit 3adb1e
                                        (const char*)ctx->zstream.next_in,
Packit 3adb1e
                                                     ctx->zstream.avail_in,
Packit 3adb1e
                                                     bucket->allocator);
Packit 3adb1e
                    serf_bucket_aggregate_prepend(ctx->stream, tmp);
Packit 3adb1e
Packit 3adb1e
                    switch (ctx->format) {
Packit 3adb1e
                    case SERF_DEFLATE_GZIP:
Packit 3adb1e
                        ctx->stream_left = ctx->stream_size =
Packit 3adb1e
                            DEFLATE_VERIFY_SIZE;
Packit 3adb1e
                        ctx->state++;
Packit 3adb1e
                        break;
Packit 3adb1e
                    case SERF_DEFLATE_DEFLATE:
Packit 3adb1e
                        /* Deflate does not have a verify footer. */
Packit 3adb1e
                        ctx->state = STATE_FINISH;
Packit 3adb1e
                        break;
Packit 3adb1e
                    default:
Packit 3adb1e
                        /* Not reachable */
Packit 3adb1e
                        return APR_EGENERAL;
Packit 3adb1e
                    }
Packit 3adb1e
Packit 3adb1e
                    break;
Packit 3adb1e
                }
Packit 3adb1e
Packit 3adb1e
                /* Any other error? */
Packit 3adb1e
                if (zRC != Z_OK) {
Packit 3adb1e
                    return SERF_ERROR_DECOMPRESSION_FAILED;
Packit 3adb1e
                }
Packit 3adb1e
Packit 3adb1e
                /* As long as zRC == Z_OK, just keep looping. */
Packit 3adb1e
            }
Packit 3adb1e
            /* Okay, we've inflated.  Try to read. */
Packit 3adb1e
            status = serf_bucket_read(ctx->inflate_stream, requested, data,
Packit 3adb1e
                                      len);
Packit 3adb1e
            /* Hide EOF. */
Packit 3adb1e
            if (APR_STATUS_IS_EOF(status)) {
Packit 3adb1e
                status = ctx->stream_status;
Packit 3adb1e
Packit 3adb1e
                /* If the inflation wasn't finished, return APR_SUCCESS. */
Packit 3adb1e
                if (zRC != Z_STREAM_END)
Packit 3adb1e
                    return APR_SUCCESS;
Packit 3adb1e
Packit 3adb1e
                /* If our stream is finished too and all data was inflated,
Packit 3adb1e
                 * return SUCCESS so we'll iterate one more time.
Packit 3adb1e
                 */
Packit 3adb1e
                if (APR_STATUS_IS_EOF(status)) {
Packit 3adb1e
                    /* No more data to read from the stream, and everything
Packit 3adb1e
                       inflated. If all data was received correctly, state
Packit 3adb1e
                       should have been advanced to STATE_READING_VERIFY or
Packit 3adb1e
                       STATE_FINISH. If not, then the data was incomplete
Packit 3adb1e
                       and we have an error. */
Packit 3adb1e
                    if (ctx->state != STATE_INFLATE)
Packit 3adb1e
                        return APR_SUCCESS;
Packit 3adb1e
                    else
Packit 3adb1e
                        return SERF_ERROR_DECOMPRESSION_FAILED;
Packit 3adb1e
                }
Packit 3adb1e
            }
Packit 3adb1e
            return status;
Packit 3adb1e
        case STATE_DONE:
Packit 3adb1e
            /* We're done inflating.  Use our finished buffer. */
Packit 3adb1e
            return serf_bucket_read(ctx->stream, requested, data, len);
Packit 3adb1e
        default:
Packit 3adb1e
            /* Not reachable */
Packit 3adb1e
            return APR_EGENERAL;
Packit 3adb1e
        }
Packit 3adb1e
    }
Packit 3adb1e
Packit 3adb1e
    /* NOTREACHED */
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
/* ### need to implement */
Packit 3adb1e
#define serf_deflate_readline NULL
Packit 3adb1e
#define serf_deflate_peek NULL
Packit 3adb1e
Packit 3adb1e
const serf_bucket_type_t serf_bucket_type_deflate = {
Packit 3adb1e
    "DEFLATE",
Packit 3adb1e
    serf_deflate_read,
Packit 3adb1e
    serf_deflate_readline,
Packit 3adb1e
    serf_default_read_iovec,
Packit 3adb1e
    serf_default_read_for_sendfile,
Packit 3adb1e
    serf_default_read_bucket,
Packit 3adb1e
    serf_deflate_peek,
Packit 3adb1e
    serf_deflate_destroy_and_data,
Packit 3adb1e
};