modules/test/mod_dialup.c

	mod_dialup.c revision 6f4e65d3b827973e4d93bf315cd350e9558babdb
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd/* Licensed to the Apache Software Foundation (ASF) under one or more
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * contributor license agreements.  See the NOTICE file distributed with
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * this work for additional information regarding copyright ownership.
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * The ASF licenses this file to You under the Apache License, Version 2.0
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * (the "License"); you may not use this file except in compliance with
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * the License.  You may obtain a copy of the License at
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd *
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd *     http://www.apache.org/licenses/LICENSE-2.0
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd *
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * Unless required by applicable law or agreed to in writing, software
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * distributed under the License is distributed on an "AS IS" BASIS,
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * See the License for the specific language governing permissions and
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd * limitations under the License.
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd */
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "httpd.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "http_core.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "util_filter.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "http_log.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "http_config.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "http_request.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "http_protocol.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#include "ap_mpm.h"
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34ndmodule AP_MODULE_DECLARE_DATA dialup_module;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#ifndef apr_time_from_msec
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#define apr_time_from_msec(x) (x * 1000)
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd#endif
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34ndtypedef struct dialup_dcfg_t {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_size_t bytes_per_second;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd} dialup_dcfg_t;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34ndtypedef struct dialup_baton_t {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_size_t bytes_per_second;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    request_rec *r;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_file_t *fd;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_bucket_brigade *bb;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_bucket_brigade *tmpbb;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd} dialup_baton_t;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34ndstatic int
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nddialup_send_pulse(dialup_baton_t *db)
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd{
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    int status;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_off_t len = 0;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_size_t bytes_sent = 0;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    while (!APR_BRIGADE_EMPTY(db->bb) && bytes_sent < db->bytes_per_second) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        apr_bucket *e;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        if (db->r->connection->aborted) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            return HTTP_INTERNAL_SERVER_ERROR;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        status = apr_brigade_partition(db->bb, db->bytes_per_second, &e);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        if (status != APR_SUCCESS && status != APR_INCOMPLETE) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            /* XXXXXX: Log me. */
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            return HTTP_INTERNAL_SERVER_ERROR;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        if (e != APR_BRIGADE_SENTINEL(db->bb)) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            apr_bucket *f;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            apr_bucket *b = APR_BUCKET_PREV(e);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            f = APR_RING_FIRST(&db->bb->list);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            APR_RING_UNSPLICE(f, b, link);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            APR_RING_SPLICE_HEAD(&db->tmpbb->list, f, b, apr_bucket, link);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        else {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            APR_BRIGADE_CONCAT(db->tmpbb, db->bb);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        e = apr_bucket_flush_create(db->r->connection->bucket_alloc);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        APR_BRIGADE_INSERT_TAIL(db->tmpbb, e);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        apr_brigade_length(db->tmpbb, 1, &len);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        bytes_sent += len;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        status = ap_pass_brigade(db->r->output_filters, db->tmpbb);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        apr_brigade_cleanup(db->tmpbb);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        if (status != OK) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            ap_log_rerror(APLOG_MARK, APLOG_ERR, status, db->r,
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd                          "dialup: pulse: ap_pass_brigade failed:");
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd            return status;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    if (APR_BRIGADE_EMPTY(db->bb)) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        return DONE;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    else {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        return SUSPENDED;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd}
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34ndstatic void
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nddialup_callback(void *baton)
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd{
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    int status;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    dialup_baton_t *db = (dialup_baton_t *)baton;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_thread_mutex_lock(db->r->invoke_mtx);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    status = dialup_send_pulse(db);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    if (status == SUSPENDED) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        ap_mpm_register_timed_callback(apr_time_from_sec(1), dialup_callback, baton);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    else if (status == DONE) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        apr_thread_mutex_unlock(db->r->invoke_mtx);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        ap_finalize_request_protocol(db->r);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        ap_process_request_after_handler(db->r);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        return;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    else {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        ap_log_rerror(APLOG_MARK, APLOG_ERR, status, db->r,
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd                      "dialup: pulse returned: %d", status);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        db->r->status = HTTP_OK;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        ap_die(status, db->r);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_thread_mutex_unlock(db->r->invoke_mtx);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd}
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34ndstatic int
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nddialup_handler(request_rec *r)
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd{
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    int status;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_status_t rv;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    dialup_dcfg_t *dcfg;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    core_dir_config *ccfg;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_file_t *fd;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    dialup_baton_t *db;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    apr_bucket *e;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    /* See core.c, default handler for all of the cases we just decline. */
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    if (r->method_number != M_GET ||
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        r->finfo.filetype == 0 ||
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        r->finfo.filetype == APR_DIR) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        return DECLINED;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    dcfg = ap_get_module_config(r->per_dir_config,
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd                                &dialup_module);
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    if (dcfg->bytes_per_second == 0) {
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd        return DECLINED;
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd    }
97a3ecc40b65d5f8e865bbe0b1c9325d8c016e34nd
    ccfg = ap_get_module_config(r->per_dir_config,
                                &core_module);


    rv = apr_file_open(&fd, r->filename, APR_READ | APR_BINARY
#if APR_HAS_SENDFILE
                           | ((ccfg->enable_sendfile == ENABLE_SENDFILE_OFF)
                              ? 0 : APR_SENDFILE_ENABLED)
#endif
                       , 0, r->pool);

    if (rv) {
        return DECLINED;
    }

    /* copied from default handler: */
    ap_update_mtime(r, r->finfo.mtime);
    ap_set_last_modified(r);
    ap_set_etag(r);
    apr_table_setn(r->headers_out, "Accept-Ranges", "bytes");
    ap_set_content_length(r, r->finfo.size);

    status = ap_meets_conditions(r);
    if (status != OK) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "dialup: declined, meets conditions, good luck core handler");
        return DECLINED;
    }

    db = apr_palloc(r->pool, sizeof(dialup_baton_t));

    db->bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
    db->tmpbb = apr_brigade_create(r->pool, r->connection->bucket_alloc);

    e = apr_brigade_insert_file(db->bb, fd, 0, r->finfo.size, r->pool);

#if APR_HAS_MMAP
    if (ccfg->enable_mmap == ENABLE_MMAP_OFF) {
        apr_bucket_file_enable_mmap(e, 0);
    }
#endif


    db->bytes_per_second = dcfg->bytes_per_second;
    db->r = r;
    db->fd = fd;

    e = apr_bucket_eos_create(r->connection->bucket_alloc);

    APR_BRIGADE_INSERT_TAIL(db->bb, e);

    status = dialup_send_pulse(db);
    if (status != SUSPENDED && status != DONE) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "dialup: failed, send pulse");
        return status;
    }

    ap_mpm_register_timed_callback(apr_time_from_sec(1), dialup_callback, db);

    return SUSPENDED;
}


#ifndef APR_HOOK_ALMOST_LAST
#define APR_HOOK_ALMOST_LAST (APR_HOOK_REALLY_LAST - 1)
#endif

static void
dialup_register_hooks(apr_pool_t *p)
{
    ap_hook_handler(dialup_handler, NULL, NULL, APR_HOOK_ALMOST_LAST);
}

typedef struct modem_speed_t {
    const char *name;
    apr_size_t bytes_per_second;
} modem_speed_t;

#ifndef BITRATE_TO_BYTES
#define BITRATE_TO_BYTES(x) ((1000 * x)/8)
#endif

static const modem_speed_t modem_bitrates[] =
{
    {"V.21",    BITRATE_TO_BYTES(0.1)},
    {"V.26bis", BITRATE_TO_BYTES(2.4)},
    {"V.32",    BITRATE_TO_BYTES(9.6)},
    {"V.34",    BITRATE_TO_BYTES(28.8)},
    {"V.92",    BITRATE_TO_BYTES(56.0)},
    {"i-was-rich-and-got-a-leased-line", BITRATE_TO_BYTES(1500)},
    {NULL, 0}
};

static const char *
cmd_modem_standard(cmd_parms *cmd,
             void *dconf,
             const char *input)
{
    const modem_speed_t *standard;
    int i = 0;
    dialup_dcfg_t *dcfg = (dialup_dcfg_t*)dconf;

    dcfg->bytes_per_second = 0;

    while (modem_bitrates[i].name != NULL) {
        standard = &modem_bitrates[i];
        if (strcasecmp(standard->name, input) == 0) {
            dcfg->bytes_per_second = standard->bytes_per_second;
            break;
        }
        i++;
    }

    if (dcfg->bytes_per_second == 0) {
        return "mod_diaulup: Unkonwn Modem Standard specified.";
    }

    return NULL;
}

static void *
dialup_dcfg_create(apr_pool_t *p, char *dummy)
{
    dialup_dcfg_t *cfg = apr_palloc(p, sizeof(dialup_dcfg_t));

    cfg->bytes_per_second = 0;

    return cfg;
}


static const command_rec dialup_cmds[] =
{
    AP_INIT_TAKE1("ModemStandard", cmd_modem_standard, NULL, ACCESS_CONF,
                  "Modem Standard to.. simulate. "
                  "Must be one of: 'V.21', 'V.26bis', 'V.32', 'V.34', or 'V.92'"),
    {NULL}
};

module AP_MODULE_DECLARE_DATA dialup_module =
{
    STANDARD20_MODULE_STUFF,
    dialup_dcfg_create,
    NULL,
    NULL,
    NULL,
    dialup_cmds,
    dialup_register_hooks
};