buckets/event_buckets.c

/* ====================================================================
 *    Licensed to the Apache Software Foundation (ASF) under one
 *    or more contributor license agreements.  See the NOTICE file
 *    distributed with this work for additional information
 *    regarding copyright ownership.  The ASF licenses this file
 *    to you under the Apache License, Version 2.0 (the
 *    "License"); you may not use this file except in compliance
 *    with the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing,
 *    software distributed under the License is distributed on an
 *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *    KIND, either express or implied.  See the License for the
 *    specific language governing permissions and limitations
 *    under the License.
 * ====================================================================
 */

#include "serf.h"
#include "serf_bucket_util.h"
#include "serf_private.h"


typedef struct event_context_t
{
    apr_uint64_t bytes_read;
    serf_bucket_t *stream;
    void *baton;
    serf_bucket_event_callback_t start_cb;
    serf_bucket_event_callback_t eof_cb;
    serf_bucket_event_callback_t destroy_cb;
    bool at_eof;
} event_context_t;

serf_bucket_t *serf__bucket_event_create(
                        serf_bucket_t *stream,
                        void *baton,
                        serf_bucket_event_callback_t start_cb,
                        serf_bucket_event_callback_t eof_cb,
                        serf_bucket_event_callback_t destroy_cb,
                        serf_bucket_alloc_t *allocator)
{
    event_context_t *ctx = serf_bucket_mem_alloc(allocator, sizeof(*ctx));
    ctx->bytes_read = 0;
    ctx->stream = stream;
    ctx->baton = baton;
    ctx->start_cb = start_cb;
    ctx->eof_cb = eof_cb;
    ctx->destroy_cb = destroy_cb;
    ctx->at_eof = false;

    return serf_bucket_create(&serf_bucket_type__event, allocator, ctx);
}

static apr_status_t serf_event_read(serf_bucket_t *bucket,
                                    apr_size_t requested,
                                    const char **data,
                                    apr_size_t *len)
{
    event_context_t *ctx = bucket->data;
    apr_status_t status;

    if (ctx->start_cb) {
        status = ctx->start_cb(ctx->baton, ctx->bytes_read);
        ctx->start_cb = NULL;

        if (SERF_BUCKET_READ_ERROR(status))
            return status;
    }

    if (ctx->stream && !ctx->at_eof) {
        status = serf_bucket_read(ctx->stream, requested, data, len);
    }
    else {
        status = APR_EOF;
        *data = NULL;
        *len = 0;

        if (ctx->at_eof && ctx->stream) {
            serf_bucket_destroy(ctx->stream);
            ctx->stream = NULL;
        }
    }

    if (!SERF_BUCKET_READ_ERROR(status)) {
        ctx->bytes_read += *len;

        if (APR_STATUS_IS_EOF(status)) {
            ctx->at_eof = true;

            if (ctx->eof_cb) {
                status = ctx->eof_cb(ctx->baton, ctx->bytes_read);
                ctx->eof_cb = NULL;
                status = SERF_BUCKET_READ_ERROR(status) ? status : APR_EOF;
            }
        }
    }

    return status;
}

static apr_status_t serf_event_read_iovec(serf_bucket_t *bucket,
                                          apr_size_t requested,
                                          int vecs_size,
                                          struct iovec *vecs,
                                          int *vecs_used)
{
    event_context_t *ctx = bucket->data;
    apr_status_t status;

    if (ctx->start_cb) {
        status = ctx->start_cb(ctx->baton, ctx->bytes_read);
        ctx->start_cb = NULL;

        if (SERF_BUCKET_READ_ERROR(status))
            return status;
    }

    if (ctx->stream && !ctx->at_eof) {
        status = serf_bucket_read_iovec(ctx->stream, requested, vecs_size,
                                        vecs, vecs_used);
    }
    else {
        status = APR_EOF;
        *vecs_used = 0;

        if (ctx->at_eof && ctx->stream) {
            serf_bucket_destroy(ctx->stream);
            ctx->stream = NULL;
        }
    }

    if (!SERF_BUCKET_READ_ERROR(status)) {
        int i;

        for (i = 0; i < *vecs_used; i++)
            ctx->bytes_read += vecs[i].iov_len;

        if (APR_STATUS_IS_EOF(status)) {
            ctx->at_eof = true;

            if (ctx->eof_cb) {
                status = ctx->eof_cb(ctx->baton, ctx->bytes_read);
                ctx->eof_cb = NULL;
                status = SERF_BUCKET_READ_ERROR(status) ? status : APR_EOF;
            }
        }
    }

    return status;
}

static apr_status_t serf_event_peek(serf_bucket_t *bucket,
                                    const char **data,
                                    apr_size_t *len)
{
    event_context_t *ctx = bucket->data;
    apr_status_t status;

    if (ctx->start_cb) {
        status = ctx->start_cb(ctx->baton, ctx->bytes_read);
        ctx->start_cb = NULL;

        if (SERF_BUCKET_READ_ERROR(status))
            return status;
    }

    if (ctx->stream && !ctx->at_eof) {
        status = serf_bucket_peek(ctx->stream, data, len);
    }
    else {
        status = APR_EOF;
        *len = 0;

        if (ctx->at_eof && ctx->stream) {
            serf_bucket_destroy(ctx->stream);
            ctx->stream = NULL;
        }
    }

    return status;
}

static apr_uint64_t serf_event_get_remaining(serf_bucket_t *bucket)
{
    event_context_t *ctx = bucket->data;

    if (ctx->stream && !ctx->at_eof) {
        return serf_bucket_get_remaining(ctx->stream);
    }
    else {
        if (ctx->at_eof && ctx->stream) {
            serf_bucket_destroy(ctx->stream);
            ctx->stream = NULL;
        }
        return 0;
    }
}

static apr_status_t serf_event_set_config(serf_bucket_t *bucket,
                                          serf_config_t *config)
{
    event_context_t *ctx = bucket->data;

    if (ctx->stream)
        return serf_bucket_set_config(ctx->stream, config);

    return APR_SUCCESS;
}

static void serf_event_destroy(serf_bucket_t *bucket)
{
    event_context_t *ctx = bucket->data;

    if (ctx->stream)
        serf_bucket_destroy(ctx->stream);

    if (ctx->destroy_cb)
        (void)ctx->destroy_cb(ctx->baton, ctx->bytes_read);

    serf_default_destroy_and_data(bucket);
}

const serf_bucket_type_t serf_bucket_type__event = {
    "EVENT",
    serf_event_read,
    serf_default_readline,
    serf_event_read_iovec,
    serf_default_read_for_sendfile,
    serf_buckets_are_v2,
    serf_event_peek,
    serf_event_destroy,
    serf_default_read_bucket,
    serf_event_get_remaining,
    serf_event_set_config
};