Blame buckets/dechunk_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 "serf.h"
Packit 3adb1e
#include "serf_bucket_util.h"
Packit 3adb1e
Packit 3adb1e
typedef struct {
Packit 3adb1e
    serf_bucket_t *stream;
Packit 3adb1e
Packit 3adb1e
    enum {
Packit 3adb1e
        STATE_SIZE,     /* reading the chunk size */
Packit 3adb1e
        STATE_CHUNK,    /* reading the chunk */
Packit 3adb1e
        STATE_TERM,     /* reading the chunk terminator */
Packit 3adb1e
        STATE_DONE      /* body is done; we've returned EOF */
Packit 3adb1e
    } state;
Packit 3adb1e
Packit 3adb1e
    /* Buffer for accumulating a chunk size. */
Packit 3adb1e
    serf_linebuf_t linebuf;
Packit 3adb1e
Packit 3adb1e
    /* How much of the chunk, or the terminator, do we have left to read? */
Packit 3adb1e
    apr_int64_t body_left;
Packit 3adb1e
Packit 3adb1e
} dechunk_context_t;
Packit 3adb1e
Packit 3adb1e
Packit 3adb1e
serf_bucket_t *serf_bucket_dechunk_create(
Packit 3adb1e
    serf_bucket_t *stream,
Packit 3adb1e
    serf_bucket_alloc_t *allocator)
Packit 3adb1e
{
Packit 3adb1e
    dechunk_context_t *ctx;
Packit 3adb1e
Packit 3adb1e
    ctx = serf_bucket_mem_alloc(allocator, sizeof(*ctx));
Packit 3adb1e
    ctx->stream = stream;
Packit 3adb1e
    ctx->state = STATE_SIZE;
Packit 3adb1e
Packit 3adb1e
    serf_linebuf_init(&ctx->linebuf);
Packit 3adb1e
Packit 3adb1e
    return serf_bucket_create(&serf_bucket_type_dechunk, allocator, ctx);
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
static void serf_dechunk_destroy_and_data(serf_bucket_t *bucket)
Packit 3adb1e
{
Packit 3adb1e
    dechunk_context_t *ctx = bucket->data;
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_dechunk_read(serf_bucket_t *bucket,
Packit 3adb1e
                                      apr_size_t requested,
Packit 3adb1e
                                      const char **data, apr_size_t *len)
Packit 3adb1e
{
Packit 3adb1e
    dechunk_context_t *ctx = bucket->data;
Packit 3adb1e
    apr_status_t status;
Packit 3adb1e
Packit 3adb1e
    while (1) {
Packit 3adb1e
        switch (ctx->state) {
Packit 3adb1e
        case STATE_SIZE:
Packit 3adb1e
Packit 3adb1e
            /* fetch a line terminated by CRLF */
Packit 3adb1e
            status = serf_linebuf_fetch(&ctx->linebuf, ctx->stream,
Packit 3adb1e
                                        SERF_NEWLINE_CRLF);
Packit 3adb1e
            if (SERF_BUCKET_READ_ERROR(status))
Packit 3adb1e
                return status;
Packit 3adb1e
Packit 3adb1e
            /* if a line was read, then parse it. */
Packit 3adb1e
            if (ctx->linebuf.state == SERF_LINEBUF_READY) {
Packit 3adb1e
                /* NUL-terminate the line. if it filled the entire buffer,
Packit 3adb1e
                   then just assume the thing is too large. */
Packit 3adb1e
                if (ctx->linebuf.used == sizeof(ctx->linebuf.line))
Packit 3adb1e
                    return APR_FROM_OS_ERROR(ERANGE);
Packit 3adb1e
                ctx->linebuf.line[ctx->linebuf.used] = '\0';
Packit 3adb1e
Packit 3adb1e
                /* convert from HEX digits. */
Packit 3adb1e
                ctx->body_left = apr_strtoi64(ctx->linebuf.line, NULL, 16);
Packit 3adb1e
                if (errno == ERANGE) {
Packit 3adb1e
                    return APR_FROM_OS_ERROR(ERANGE);
Packit 3adb1e
                }
Packit 3adb1e
Packit 3adb1e
                if (ctx->body_left == 0) {
Packit 3adb1e
                    /* Just read the last-chunk marker. We're DONE. */
Packit 3adb1e
                    ctx->state = STATE_DONE;
Packit 3adb1e
                    status = APR_EOF;
Packit 3adb1e
                }
Packit 3adb1e
                else {
Packit 3adb1e
                    /* Got a size, so we'll start reading the chunk now. */
Packit 3adb1e
                    ctx->state = STATE_CHUNK;
Packit 3adb1e
                }
Packit 3adb1e
Packit 3adb1e
                /* If we can read more, then go do so. */
Packit 3adb1e
                if (!status)
Packit 3adb1e
                    continue;
Packit 3adb1e
            }
Packit 3adb1e
            /* assert: status != 0 */
Packit 3adb1e
Packit 3adb1e
            /* Note that we didn't actually read anything, so our callers
Packit 3adb1e
             * don't get confused.
Packit 3adb1e
             */
Packit 3adb1e
            *len = 0;
Packit 3adb1e
Packit 3adb1e
            return status;
Packit 3adb1e
Packit 3adb1e
        case STATE_CHUNK:
Packit 3adb1e
Packit 3adb1e
            if (requested > ctx->body_left) {
Packit 3adb1e
                requested = ctx->body_left;
Packit 3adb1e
            }
Packit 3adb1e
Packit 3adb1e
            /* Delegate to the stream bucket to do the read. */
Packit 3adb1e
            status = serf_bucket_read(ctx->stream, requested, data, len);
Packit 3adb1e
            if (SERF_BUCKET_READ_ERROR(status))
Packit 3adb1e
                return status;
Packit 3adb1e
Packit 3adb1e
            /* Some data was read, so decrement the amount left and see
Packit 3adb1e
             * if we're done reading this chunk.
Packit 3adb1e
             */
Packit 3adb1e
            ctx->body_left -= *len;
Packit 3adb1e
            if (!ctx->body_left) {
Packit 3adb1e
                ctx->state = STATE_TERM;
Packit 3adb1e
                ctx->body_left = 2;     /* CRLF */
Packit 3adb1e
            }
Packit 3adb1e
Packit 3adb1e
            /* We need more data but there is no more available. */
Packit 3adb1e
            if (ctx->body_left && APR_STATUS_IS_EOF(status)) {
Packit 3adb1e
                return SERF_ERROR_TRUNCATED_HTTP_RESPONSE;
Packit 3adb1e
            }
Packit 3adb1e
Packit 3adb1e
            /* Return the data we just read. */
Packit 3adb1e
            return status;
Packit 3adb1e
Packit 3adb1e
        case STATE_TERM:
Packit 3adb1e
            /* Delegate to the stream bucket to do the read. */
Packit 3adb1e
            status = serf_bucket_read(ctx->stream, ctx->body_left, data, len);
Packit 3adb1e
            if (SERF_BUCKET_READ_ERROR(status))
Packit 3adb1e
                return status;
Packit 3adb1e
Packit 3adb1e
            /* Some data was read, so decrement the amount left and see
Packit 3adb1e
             * if we're done reading the chunk terminator.
Packit 3adb1e
             */
Packit 3adb1e
            ctx->body_left -= *len;
Packit 3adb1e
Packit 3adb1e
            /* We need more data but there is no more available. */
Packit 3adb1e
            if (ctx->body_left && APR_STATUS_IS_EOF(status))
Packit 3adb1e
                return SERF_ERROR_TRUNCATED_HTTP_RESPONSE;
Packit 3adb1e
Packit 3adb1e
            if (!ctx->body_left) {
Packit 3adb1e
                ctx->state = STATE_SIZE;
Packit 3adb1e
            }
Packit 3adb1e
Packit 3adb1e
            /* Don't return the CR of CRLF to the caller! */
Packit 3adb1e
            *len = 0;
Packit 3adb1e
Packit 3adb1e
            if (status)
Packit 3adb1e
                return status;
Packit 3adb1e
Packit 3adb1e
            break;
Packit 3adb1e
Packit 3adb1e
        case STATE_DONE:
Packit 3adb1e
            /* Just keep returning EOF */
Packit 3adb1e
            *len = 0;
Packit 3adb1e
            return APR_EOF;
Packit 3adb1e
Packit 3adb1e
        default:
Packit 3adb1e
            /* Not reachable */
Packit 3adb1e
            return APR_EGENERAL;
Packit 3adb1e
        }
Packit 3adb1e
    }
Packit 3adb1e
    /* NOTREACHED */
Packit 3adb1e
}
Packit 3adb1e
Packit 3adb1e
/* ### need to implement */
Packit 3adb1e
#define serf_dechunk_readline NULL
Packit 3adb1e
#define serf_dechunk_peek NULL
Packit 3adb1e
Packit 3adb1e
const serf_bucket_type_t serf_bucket_type_dechunk = {
Packit 3adb1e
    "DECHUNK",
Packit 3adb1e
    serf_dechunk_read,
Packit 3adb1e
    serf_dechunk_readline,
Packit 3adb1e
    serf_default_read_iovec,
Packit 3adb1e
    serf_default_read_for_sendfile,
Packit 3adb1e
    serf_default_read_bucket,
Packit 3adb1e
    serf_dechunk_peek,
Packit 3adb1e
    serf_dechunk_destroy_and_data,
Packit 3adb1e
};