changeset 0:6535d94ae07d

Compose filter module skeleton, currently does nothing.
author Maxim Dounin <mdounin@mdounin.ru>
date Sat, 12 Jul 2008 19:23:17 +0400
parents
children ba5471a3c988
files LICENSE README config ngx_http_compose_filter_module.c
diffstat 4 files changed, 189 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,25 @@
+/* 
+ * Copyright (C) 2008 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,18 @@
+Compose module for nginx.
+
+This module allows compose several subrequests into one reply.  The
+same thing may be achieved by SSI, but unlike SSI this module will also
+set Content-Length and allow range requests.
+
+Basically it grabs X-Compose and X-Compose-Length headers from original
+reply and does the following:
+
+    1. If X-Compose-Length present, sets Content-Length to it's value.
+    2. Composes multiple subrequests from X-Compose headers.
+
+When used without X-Compose-Length it's basically identical to SSI and
+not needed.  The X-Compose-Length header must be calculated correctly by
+somebody.
+
+To compile nginx with compose module, use "--add-module <path>" option to
+nginx configure.
new file mode 100644
--- /dev/null
+++ b/config
@@ -0,0 +1,10 @@
+# (C) Maxim Dounin
+# Configuration for ngx_http_compose_filter_module.
+
+ngx_addon_name="ngx_http_compose_filter_module"
+
+HTTP_RANGE_BODY_FILTER_MODULE="$HTTP_RANGE_BODY_FILTER_MODULE \
+		ngx_http_compose_filter_module"
+
+NGX_ADDON_SRCS="$NGX_ADDON_SRCS \
+		$ngx_addon_dir/ngx_http_compose_filter_module.c"
new file mode 100644
--- /dev/null
+++ b/ngx_http_compose_filter_module.c
@@ -0,0 +1,136 @@
+
+/*
+ * Copyright (C) Maxim Dounin
+ */
+
+#include <ngx_config.h>
+#include <ngx_core.h>
+#include <ngx_http.h>
+
+
+typedef struct {
+    ngx_flag_t         enable;
+} ngx_http_compose_conf_t;
+
+
+static void *ngx_http_compose_create_conf(ngx_conf_t *cf);
+static char *ngx_http_compose_merge_conf(ngx_conf_t *cf, void *parent,
+    void *child);
+static ngx_int_t ngx_http_compose_init(ngx_conf_t *cf);
+
+
+static ngx_command_t  ngx_http_compose_commands[] = {
+
+    { ngx_string("compose"),
+      NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
+      ngx_conf_set_flag_slot,
+      NGX_HTTP_LOC_CONF_OFFSET,
+      offsetof(ngx_http_compose_conf_t, enable),
+      NULL },
+
+      ngx_null_command
+};
+
+
+static ngx_http_module_t  ngx_http_compose_module_ctx = {
+    NULL,                          /* preconfiguration */
+    ngx_http_compose_init,         /* postconfiguration */
+
+    NULL,                          /* create main configuration */
+    NULL,                          /* init main configuration */
+
+    NULL,                          /* create server configuration */
+    NULL,                          /* merge server configuration */
+
+    ngx_http_compose_create_conf,  /* create location configuration */
+    ngx_http_compose_merge_conf    /* merge location configuration */
+};
+
+
+ngx_module_t  ngx_http_compose_filter_module = {
+    NGX_MODULE_V1,
+    &ngx_http_compose_module_ctx,  /* module context */
+    ngx_http_compose_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_http_output_header_filter_pt  ngx_http_next_header_filter;
+static ngx_http_output_body_filter_pt    ngx_http_next_body_filter;
+
+
+static ngx_int_t
+ngx_http_compose_header_filter(ngx_http_request_t *r)
+{
+    ngx_http_compose_conf_t  *conf;
+
+    conf = ngx_http_get_module_loc_conf(r, ngx_http_compose_filter_module);
+
+    if (!conf->enable) {
+        return ngx_http_next_header_filter(r);
+    }
+
+    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
+                   "compose header filter");
+
+    return ngx_http_next_header_filter(r);
+}
+
+
+static ngx_int_t
+ngx_http_compose_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
+{
+    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
+                   "compose body filter");
+
+    return ngx_http_next_body_filter(r, in);
+}
+
+
+static void *
+ngx_http_compose_create_conf(ngx_conf_t *cf)
+{
+    ngx_http_compose_conf_t  *conf;
+
+    conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_compose_conf_t));
+    if (conf == NULL) {
+        return NGX_CONF_ERROR;
+    }
+
+    conf->enable = NGX_CONF_UNSET;
+
+    return conf;
+}
+
+
+static char *
+ngx_http_compose_merge_conf(ngx_conf_t *cf, void *parent, void *child)
+{
+    ngx_http_compose_conf_t *prev = parent;
+    ngx_http_compose_conf_t *conf = child;
+
+    ngx_conf_merge_value(conf->enable, prev->enable, 0);
+
+    return NGX_CONF_OK;
+}
+
+
+static ngx_int_t
+ngx_http_compose_init(ngx_conf_t *cf)
+{
+    ngx_http_next_header_filter = ngx_http_top_header_filter;
+    ngx_http_top_header_filter = ngx_http_compose_header_filter;
+
+    ngx_http_next_body_filter = ngx_http_top_body_filter;
+    ngx_http_top_body_filter = ngx_http_compose_body_filter;
+
+    return NGX_OK;
+}