Mercurial > hg > ngx_http_delay_module
changeset 0:9777bf89da35
Delay module.
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Tue, 29 Jun 2010 22:08:53 +0400 |
parents | |
children | 3cdd7ed86819 |
files | LICENSE README config ngx_http_delay_module.c |
diffstat | 4 files changed, 247 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +/* + * Copyright (C) 2010 Maxim Dounin + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */
new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,27 @@ +Delay module for nginx. + +This module allows to delay requests for a given time. + +Configuration directives: + + delay <time> + + Context: http, server, location + Default: 0 + + Delay requests for a given time. + +Usage: + + location = /slow { + delay 10s; + ... + } + +Note that internal redirects (e.g. directory index ones) will trigger another +delay. + +To compile nginx with delay module, use "--add-module <path>" option +to nginx configure. + +Development of this module was sponsored by Openstat (http://www.openstat.com/).
new file mode 100644 --- /dev/null +++ b/config @@ -0,0 +1,10 @@ +# (C) Maxim Dounin +# Configuration for ngx_http_delay_module. + +ngx_addon_name="ngx_http_delay_module" + +HTTP_MODULES="$HTTP_MODULES \ + ngx_http_delay_module" + +NGX_ADDON_SRCS="$NGX_ADDON_SRCS \ + $ngx_addon_dir/ngx_http_delay_module.c"
new file mode 100644 --- /dev/null +++ b/ngx_http_delay_module.c @@ -0,0 +1,186 @@ + +/* + * Copyright (C) Maxim Dounin + */ + + +#include <ngx_config.h> +#include <ngx_core.h> +#include <ngx_http.h> + + +typedef struct { + ngx_msec_t delay; +} ngx_http_delay_conf_t; + + +static void ngx_http_delay_event_handler(ngx_http_request_t *r); + + +static void *ngx_http_delay_create_conf(ngx_conf_t *cf); +static char *ngx_http_delay_merge_conf(ngx_conf_t *cf, void *parent, + void *child); +static ngx_int_t ngx_http_delay_init(ngx_conf_t *cf); + + +static ngx_command_t ngx_http_delay_commands[] = { + + { ngx_string("delay"), + NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, + ngx_conf_set_msec_slot, + NGX_HTTP_LOC_CONF_OFFSET, + offsetof(ngx_http_delay_conf_t, delay), + NULL }, + + ngx_null_command +}; + + +static ngx_http_module_t ngx_http_delay_module_ctx = { + NULL, /* preconfiguration */ + ngx_http_delay_init, /* postconfiguration */ + + NULL, /* create main configuration */ + NULL, /* init main configuration */ + + NULL, /* create server configuration */ + NULL, /* merge server configuration */ + + ngx_http_delay_create_conf, /* create location configration */ + ngx_http_delay_merge_conf /* merge location configration */ +}; + + +ngx_module_t ngx_http_delay_module = { + NGX_MODULE_V1, + &ngx_http_delay_module_ctx, /* module context */ + ngx_http_delay_commands, /* module directives */ + NGX_HTTP_MODULE, /* module type */ + NULL, /* init master */ + NULL, /* init module */ + NULL, /* init process */ + NULL, /* init thread */ + NULL, /* exit thread */ + NULL, /* exit process */ + NULL, /* exit master */ + NGX_MODULE_V1_PADDING +}; + + +static ngx_int_t +ngx_http_delay_handler(ngx_http_request_t *r) +{ + ngx_http_delay_conf_t *dcf; + + if (ngx_http_get_module_ctx(r, ngx_http_delay_module) != NULL) { + return NGX_DECLINED; + } + + dcf = ngx_http_get_module_loc_conf(r, ngx_http_delay_module); + + if (dcf->delay == NGX_CONF_UNSET_MSEC) { + return NGX_DECLINED; + } + + ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0, + "delaying request"); + + if (ngx_handle_read_event(r->connection->read, 0) != NGX_OK) { + return NGX_HTTP_INTERNAL_SERVER_ERROR; + } + + r->read_event_handler = ngx_http_test_reading; + r->write_event_handler = ngx_http_delay_event_handler; + + ngx_add_timer(r->connection->write, dcf->delay); + + ngx_http_set_ctx(r, (void *) 1, ngx_http_delay_module); + + return NGX_AGAIN; +} + + +static void +ngx_http_delay_event_handler(ngx_http_request_t *r) +{ + ngx_event_t *wev; + + ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0, + "delay"); + + wev = r->connection->write; + + if (!wev->timedout) { + + if (ngx_handle_write_event(wev, 0) != NGX_OK) { + ngx_http_finalize_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR); + } + + return; + } + + wev->timedout = 0; + + if (ngx_handle_read_event(r->connection->read, 0) != NGX_OK) { + ngx_http_finalize_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR); + return; + } + + r->read_event_handler = ngx_http_block_reading; + r->write_event_handler = ngx_http_core_run_phases; + + ngx_http_core_run_phases(r); +} + + +static void * +ngx_http_delay_create_conf(ngx_conf_t *cf) +{ + ngx_http_delay_conf_t *conf; + + conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_delay_conf_t)); + if (conf == NULL) { + return NULL; + } + + /* + * set by ngx_pcalloc(): + * + */ + + conf->delay = NGX_CONF_UNSET_MSEC; + + return conf; +} + + +static char * +ngx_http_delay_merge_conf(ngx_conf_t *cf, void *parent, void *child) +{ + ngx_http_delay_conf_t *prev = parent; + ngx_http_delay_conf_t *conf = child; + + ngx_conf_merge_msec_value(conf->delay, prev->delay, + NGX_CONF_UNSET_MSEC); + + return NGX_CONF_OK; +} + + +static ngx_int_t +ngx_http_delay_init(ngx_conf_t *cf) +{ + ngx_http_handler_pt *h; + ngx_http_core_main_conf_t *cmcf; + + cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module); + + h = ngx_array_push(&cmcf->phases[NGX_HTTP_PREACCESS_PHASE].handlers); + if (h == NULL) { + return NGX_ERROR; + } + + *h = ngx_http_delay_handler; + + return NGX_OK; +}