src/lib/istream.c

	istream.c revision f4bbeadda12fbd7c219063db68f3e78646d83c2c
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen/*
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen   istream.c : Input stream handling
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    Copyright (c) 2002 Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    Permission is hereby granted, free of charge, to any person obtaining
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    a copy of this software and associated documentation files (the
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    "Software"), to deal in the Software without restriction, including
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    without limitation the rights to use, copy, modify, merge, publish,
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    distribute, sublicense, and/or sell copies of the Software, and to
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    permit persons to whom the Software is furnished to do so, subject to
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    the following conditions:
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    The above copyright notice and this permission notice shall be
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    included in all copies or substantial portions of the Software.
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen*/
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen#include "lib.h"
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen#include "istream-internal.h"
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenvoid i_stream_ref(struct istream *stream)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    _io_stream_ref(&stream->real_stream->iostream);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenvoid i_stream_unref(struct istream *stream)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    _io_stream_unref(&stream->real_stream->iostream);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenint i_stream_get_fd(struct istream *stream)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    struct _istream *_stream = stream->real_stream;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    return _stream->fd;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenvoid i_stream_close(struct istream *stream)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    _io_stream_close(&stream->real_stream->iostream);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    stream->closed = TRUE;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenvoid i_stream_set_max_buffer_size(struct istream *stream, size_t max_size)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    _io_stream_set_max_buffer_size(&stream->real_stream->iostream,
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen                       max_size);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenvoid i_stream_set_blocking(struct istream *stream, int timeout_msecs,
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen               void (*timeout_cb)(void *), void *context)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    _io_stream_set_blocking(&stream->real_stream->iostream, timeout_msecs,
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen                timeout_cb, context);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenvoid i_stream_set_start_offset(struct istream *stream, uoff_t offset)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    struct _istream *_stream = stream->real_stream;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    off_t diff;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    i_assert(stream->v_size == 0 ||
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen         offset <= stream->start_offset + stream->v_size);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    if (offset == stream->start_offset)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        return;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    diff = (off_t)stream->start_offset - (off_t)offset;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    stream->start_offset = offset;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    stream->v_offset += diff;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    if (stream->v_size != 0)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        stream->v_size += diff;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    if (stream->v_limit != 0)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        stream->v_limit += diff;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    /* reset buffer data */
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    _stream->skip = _stream->pos = _stream->high_pos = 0;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenvoid i_stream_set_read_limit(struct istream *stream, uoff_t v_offset)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    struct _istream *_stream = stream->real_stream;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    uoff_t max_pos;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    i_assert(stream->v_size == 0 || v_offset <= stream->v_size);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    if (_stream->high_pos != 0) {
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        _stream->pos = _stream->high_pos;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        _stream->high_pos = 0;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    }
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    if (v_offset == 0)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        stream->v_limit = stream->v_size;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    else {
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        i_assert(v_offset >= stream->v_offset);
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        stream->v_limit = v_offset;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        max_pos = v_offset - stream->v_offset + _stream->skip;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        if (_stream->pos > max_pos) {
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen            if (_stream->high_pos == 0)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen                _stream->high_pos = _stream->pos;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen            _stream->pos = max_pos;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        }
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    }
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen}
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainenssize_t i_stream_read(struct istream *stream)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen{
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    struct _istream *_stream = stream->real_stream;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    if (stream->closed)
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        return -1;
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen    if (_stream->pos < _stream->high_pos) {
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        /* virtual limit reached */
ecc81625167ed96c04c02aa190a1ea5baa65b474Timo Sirainen        return -1;
    }

    return _stream->read(_stream);
}

void i_stream_skip(struct istream *stream, uoff_t count)
{
    struct _istream *_stream = stream->real_stream;
    size_t data_size;

    i_assert(stream->v_size == 0 ||
         stream->v_offset + count <= stream->v_size);

    if (count <= _stream->pos - _stream->skip) {
        stream->v_offset += count;
        _stream->skip += count;
        return;
    }

    if (stream->closed)
        return;

    data_size = _stream->pos - _stream->skip;
    _stream->skip = _stream->pos;

    count -= data_size;
    stream->v_offset += data_size;

    if (_stream->pos < _stream->high_pos) {
        /* virtual limit reached */
    } else {
        _stream->skip_count(_stream, count);
    }
}

void i_stream_seek(struct istream *stream, uoff_t v_offset)
{
    struct _istream *_stream = stream->real_stream;

    i_assert(v_offset <= stream->v_size);

    if (stream->closed)
        return;

    _stream->seek(_stream, v_offset);
}

char *i_stream_next_line(struct istream *stream)
{
    struct _istream *_stream = stream->real_stream;
    char *ret_buf;
        size_t i;

        i_assert(stream != NULL);

    if (_stream->skip >= _stream->pos)
        return NULL;

    if (_stream->w_buffer == NULL) {
        i_error("i_stream_next_line() called for unmodifyable stream");
        return NULL;
    }

    /* @UNSAFE */
    ret_buf = NULL;
    for (i = _stream->skip; i < _stream->pos; i++) {
        if (_stream->buffer[i] == 10) {
            /* got it */
            if (i > 0 && _stream->buffer[i-1] == '\r')
                _stream->w_buffer[i-1] = '\0';
            else
                _stream->w_buffer[i] = '\0';
            ret_buf = (char *) _stream->w_buffer + _stream->skip;

            i++;
            stream->v_offset += i - _stream->skip;
            _stream->skip = i;
                        break;
        }
    }

        return ret_buf;
}

char *i_stream_read_next_line(struct istream *stream)
{
    char *line;

    line = i_stream_next_line(stream);
    if (line != NULL)
        return line;

    if (i_stream_read(stream) > 0)
        line = i_stream_next_line(stream);
    return line;
}

const unsigned char *i_stream_get_data(struct istream *stream, size_t *size)
{
    struct _istream *_stream = stream->real_stream;

    if (_stream->skip >= _stream->pos) {
        *size = 0;
        return NULL;
    }

        *size = _stream->pos - _stream->skip;
        return _stream->buffer + _stream->skip;
}

unsigned char *i_stream_get_modifyable_data(struct istream *stream,
                        size_t *size)
{
    struct _istream *_stream = stream->real_stream;

    if (_stream->skip >= _stream->pos || _stream->w_buffer == NULL) {
        *size = 0;
        return NULL;
    }

        *size = _stream->pos - _stream->skip;
        return _stream->w_buffer + _stream->skip;
}

int i_stream_read_data(struct istream *stream, const unsigned char **data,
               size_t *size, size_t threshold)
{
    struct _istream *_stream = stream->real_stream;
    ssize_t ret = 0;

    while (_stream->pos - _stream->skip <= threshold) {
        /* we need more data */
        ret = i_stream_read(stream);
        if (ret < 0)
            break;
    }

    *data = i_stream_get_data(stream, size);
    return *size > threshold ? 1 :
        ret == -2 ? -2 :
        *size > 0 ? 0 : -1;
}

struct istream *_i_stream_create(struct _istream *_stream, pool_t pool, int fd,
                 uoff_t start_offset, uoff_t v_size)
{
    _stream->fd = fd;
    _stream->istream.start_offset = start_offset;
    _stream->istream.v_size = v_size;
    _stream->istream.v_limit = v_size;
    _stream->istream.real_stream = _stream;

    _io_stream_init(pool, &_stream->iostream);
    return &_stream->istream;
}