1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Igor Sysoev
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#include <ngx_config.h>
9e18a033bSKonstantin Ananyev#include <ngx_core.h>
10e18a033bSKonstantin Ananyev#include <ngx_http.h>
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev
13e18a033bSKonstantin Ananyev#define NGX_HTTP_GZIP_STATIC_OFF     0
14e18a033bSKonstantin Ananyev#define NGX_HTTP_GZIP_STATIC_ON      1
15e18a033bSKonstantin Ananyev#define NGX_HTTP_GZIP_STATIC_ALWAYS  2
16e18a033bSKonstantin Ananyev
17e18a033bSKonstantin Ananyev
18e18a033bSKonstantin Ananyevtypedef struct {
19e18a033bSKonstantin Ananyev    ngx_uint_t  enable;
20e18a033bSKonstantin Ananyev} ngx_http_gzip_static_conf_t;
21e18a033bSKonstantin Ananyev
22e18a033bSKonstantin Ananyev
23e18a033bSKonstantin Ananyevstatic ngx_int_t ngx_http_gzip_static_handler(ngx_http_request_t *r);
24e18a033bSKonstantin Ananyevstatic void *ngx_http_gzip_static_create_conf(ngx_conf_t *cf);
25e18a033bSKonstantin Ananyevstatic char *ngx_http_gzip_static_merge_conf(ngx_conf_t *cf, void *parent,
26e18a033bSKonstantin Ananyev    void *child);
27e18a033bSKonstantin Ananyevstatic ngx_int_t ngx_http_gzip_static_init(ngx_conf_t *cf);
28e18a033bSKonstantin Ananyev
29e18a033bSKonstantin Ananyev
30e18a033bSKonstantin Ananyevstatic ngx_conf_enum_t  ngx_http_gzip_static[] = {
31e18a033bSKonstantin Ananyev    { ngx_string("off"), NGX_HTTP_GZIP_STATIC_OFF },
32e18a033bSKonstantin Ananyev    { ngx_string("on"), NGX_HTTP_GZIP_STATIC_ON },
33e18a033bSKonstantin Ananyev    { ngx_string("always"), NGX_HTTP_GZIP_STATIC_ALWAYS },
34e18a033bSKonstantin Ananyev    { ngx_null_string, 0 }
35e18a033bSKonstantin Ananyev};
36e18a033bSKonstantin Ananyev
37e18a033bSKonstantin Ananyev
38e18a033bSKonstantin Ananyevstatic ngx_command_t  ngx_http_gzip_static_commands[] = {
39e18a033bSKonstantin Ananyev
40e18a033bSKonstantin Ananyev    { ngx_string("gzip_static"),
41e18a033bSKonstantin Ananyev      NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
42e18a033bSKonstantin Ananyev      ngx_conf_set_enum_slot,
43e18a033bSKonstantin Ananyev      NGX_HTTP_LOC_CONF_OFFSET,
44e18a033bSKonstantin Ananyev      offsetof(ngx_http_gzip_static_conf_t, enable),
45e18a033bSKonstantin Ananyev      &ngx_http_gzip_static },
46e18a033bSKonstantin Ananyev
47e18a033bSKonstantin Ananyev      ngx_null_command
48e18a033bSKonstantin Ananyev};
49e18a033bSKonstantin Ananyev
50e18a033bSKonstantin Ananyev
51e18a033bSKonstantin Ananyevstatic ngx_http_module_t  ngx_http_gzip_static_module_ctx = {
52e18a033bSKonstantin Ananyev    NULL,                                  /* preconfiguration */
53e18a033bSKonstantin Ananyev    ngx_http_gzip_static_init,             /* postconfiguration */
54e18a033bSKonstantin Ananyev
55e18a033bSKonstantin Ananyev    NULL,                                  /* create main configuration */
56e18a033bSKonstantin Ananyev    NULL,                                  /* init main configuration */
57e18a033bSKonstantin Ananyev
58e18a033bSKonstantin Ananyev    NULL,                                  /* create server configuration */
59e18a033bSKonstantin Ananyev    NULL,                                  /* merge server configuration */
60e18a033bSKonstantin Ananyev
61e18a033bSKonstantin Ananyev    ngx_http_gzip_static_create_conf,      /* create location configuration */
62e18a033bSKonstantin Ananyev    ngx_http_gzip_static_merge_conf        /* merge location configuration */
63e18a033bSKonstantin Ananyev};
64e18a033bSKonstantin Ananyev
65e18a033bSKonstantin Ananyev
66e18a033bSKonstantin Ananyevngx_module_t  ngx_http_gzip_static_module = {
67e18a033bSKonstantin Ananyev    NGX_MODULE_V1,
68e18a033bSKonstantin Ananyev    &ngx_http_gzip_static_module_ctx,      /* module context */
69e18a033bSKonstantin Ananyev    ngx_http_gzip_static_commands,         /* module directives */
70e18a033bSKonstantin Ananyev    NGX_HTTP_MODULE,                       /* module type */
71e18a033bSKonstantin Ananyev    NULL,                                  /* init master */
72e18a033bSKonstantin Ananyev    NULL,                                  /* init module */
73e18a033bSKonstantin Ananyev    NULL,                                  /* init process */
74e18a033bSKonstantin Ananyev    NULL,                                  /* init thread */
75e18a033bSKonstantin Ananyev    NULL,                                  /* exit thread */
76e18a033bSKonstantin Ananyev    NULL,                                  /* exit process */
77e18a033bSKonstantin Ananyev    NULL,                                  /* exit master */
78e18a033bSKonstantin Ananyev    NGX_MODULE_V1_PADDING
79e18a033bSKonstantin Ananyev};
80e18a033bSKonstantin Ananyev
81e18a033bSKonstantin Ananyev
82e18a033bSKonstantin Ananyevstatic ngx_int_t
83e18a033bSKonstantin Ananyevngx_http_gzip_static_handler(ngx_http_request_t *r)
84e18a033bSKonstantin Ananyev{
85e18a033bSKonstantin Ananyev    u_char                       *p;
86e18a033bSKonstantin Ananyev    size_t                        root;
87e18a033bSKonstantin Ananyev    ngx_str_t                     path;
88e18a033bSKonstantin Ananyev    ngx_int_t                     rc;
89e18a033bSKonstantin Ananyev    ngx_uint_t                    level;
90e18a033bSKonstantin Ananyev    ngx_log_t                    *log;
91e18a033bSKonstantin Ananyev    ngx_buf_t                    *b;
92e18a033bSKonstantin Ananyev    ngx_chain_t                   out;
93e18a033bSKonstantin Ananyev    ngx_table_elt_t              *h;
94e18a033bSKonstantin Ananyev    ngx_open_file_info_t          of;
95e18a033bSKonstantin Ananyev    ngx_http_core_loc_conf_t     *clcf;
96e18a033bSKonstantin Ananyev    ngx_http_gzip_static_conf_t  *gzcf;
97e18a033bSKonstantin Ananyev
98e18a033bSKonstantin Ananyev    if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD))) {
99e18a033bSKonstantin Ananyev        return NGX_DECLINED;
100e18a033bSKonstantin Ananyev    }
101e18a033bSKonstantin Ananyev
102e18a033bSKonstantin Ananyev    if (r->uri.data[r->uri.len - 1] == '/') {
103e18a033bSKonstantin Ananyev        return NGX_DECLINED;
104e18a033bSKonstantin Ananyev    }
105e18a033bSKonstantin Ananyev
106e18a033bSKonstantin Ananyev    gzcf = ngx_http_get_module_loc_conf(r, ngx_http_gzip_static_module);
107e18a033bSKonstantin Ananyev
108e18a033bSKonstantin Ananyev    if (gzcf->enable == NGX_HTTP_GZIP_STATIC_OFF) {
109e18a033bSKonstantin Ananyev        return NGX_DECLINED;
110e18a033bSKonstantin Ananyev    }
111e18a033bSKonstantin Ananyev
112e18a033bSKonstantin Ananyev    if (gzcf->enable == NGX_HTTP_GZIP_STATIC_ON) {
113e18a033bSKonstantin Ananyev        rc = ngx_http_gzip_ok(r);
114e18a033bSKonstantin Ananyev
115e18a033bSKonstantin Ananyev    } else {
116e18a033bSKonstantin Ananyev        /* always */
117e18a033bSKonstantin Ananyev        rc = NGX_OK;
118e18a033bSKonstantin Ananyev    }
119e18a033bSKonstantin Ananyev
120e18a033bSKonstantin Ananyev    clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
121e18a033bSKonstantin Ananyev
122e18a033bSKonstantin Ananyev    if (!clcf->gzip_vary && rc != NGX_OK) {
123e18a033bSKonstantin Ananyev        return NGX_DECLINED;
124e18a033bSKonstantin Ananyev    }
125e18a033bSKonstantin Ananyev
126e18a033bSKonstantin Ananyev    log = r->connection->log;
127e18a033bSKonstantin Ananyev
128e18a033bSKonstantin Ananyev    p = ngx_http_map_uri_to_path(r, &path, &root, sizeof(".gz") - 1);
129e18a033bSKonstantin Ananyev    if (p == NULL) {
130e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
131e18a033bSKonstantin Ananyev    }
132e18a033bSKonstantin Ananyev
133e18a033bSKonstantin Ananyev    *p++ = '.';
134e18a033bSKonstantin Ananyev    *p++ = 'g';
135e18a033bSKonstantin Ananyev    *p++ = 'z';
136e18a033bSKonstantin Ananyev    *p = '\0';
137e18a033bSKonstantin Ananyev
138e18a033bSKonstantin Ananyev    path.len = p - path.data;
139e18a033bSKonstantin Ananyev
140e18a033bSKonstantin Ananyev    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0,
141e18a033bSKonstantin Ananyev                   "http filename: \"%s\"", path.data);
142e18a033bSKonstantin Ananyev
143e18a033bSKonstantin Ananyev    ngx_memzero(&of, sizeof(ngx_open_file_info_t));
144e18a033bSKonstantin Ananyev
145e18a033bSKonstantin Ananyev    of.read_ahead = clcf->read_ahead;
146e18a033bSKonstantin Ananyev    of.directio = clcf->directio;
147e18a033bSKonstantin Ananyev    of.valid = clcf->open_file_cache_valid;
148e18a033bSKonstantin Ananyev    of.min_uses = clcf->open_file_cache_min_uses;
149e18a033bSKonstantin Ananyev    of.errors = clcf->open_file_cache_errors;
150e18a033bSKonstantin Ananyev    of.events = clcf->open_file_cache_events;
151e18a033bSKonstantin Ananyev
152e18a033bSKonstantin Ananyev    if (ngx_http_set_disable_symlinks(r, clcf, &path, &of) != NGX_OK) {
153e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
154e18a033bSKonstantin Ananyev    }
155e18a033bSKonstantin Ananyev
156e18a033bSKonstantin Ananyev    if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool)
157e18a033bSKonstantin Ananyev        != NGX_OK)
158e18a033bSKonstantin Ananyev    {
159e18a033bSKonstantin Ananyev        switch (of.err) {
160e18a033bSKonstantin Ananyev
161e18a033bSKonstantin Ananyev        case 0:
162e18a033bSKonstantin Ananyev            return NGX_HTTP_INTERNAL_SERVER_ERROR;
163e18a033bSKonstantin Ananyev
164e18a033bSKonstantin Ananyev        case NGX_ENOENT:
165e18a033bSKonstantin Ananyev        case NGX_ENOTDIR:
166e18a033bSKonstantin Ananyev        case NGX_ENAMETOOLONG:
167e18a033bSKonstantin Ananyev
168e18a033bSKonstantin Ananyev            return NGX_DECLINED;
169e18a033bSKonstantin Ananyev
170e18a033bSKonstantin Ananyev        case NGX_EACCES:
171e18a033bSKonstantin Ananyev#if (NGX_HAVE_OPENAT)
172e18a033bSKonstantin Ananyev        case NGX_EMLINK:
173e18a033bSKonstantin Ananyev        case NGX_ELOOP:
174e18a033bSKonstantin Ananyev#endif
175e18a033bSKonstantin Ananyev
176e18a033bSKonstantin Ananyev            level = NGX_LOG_ERR;
177e18a033bSKonstantin Ananyev            break;
178e18a033bSKonstantin Ananyev
179e18a033bSKonstantin Ananyev        default:
180e18a033bSKonstantin Ananyev
181e18a033bSKonstantin Ananyev            level = NGX_LOG_CRIT;
182e18a033bSKonstantin Ananyev            break;
183e18a033bSKonstantin Ananyev        }
184e18a033bSKonstantin Ananyev
185e18a033bSKonstantin Ananyev        ngx_log_error(level, log, of.err,
186e18a033bSKonstantin Ananyev                      "%s \"%s\" failed", of.failed, path.data);
187e18a033bSKonstantin Ananyev
188e18a033bSKonstantin Ananyev        return NGX_DECLINED;
189e18a033bSKonstantin Ananyev    }
190e18a033bSKonstantin Ananyev
191e18a033bSKonstantin Ananyev    if (gzcf->enable == NGX_HTTP_GZIP_STATIC_ON) {
192e18a033bSKonstantin Ananyev        r->gzip_vary = 1;
193e18a033bSKonstantin Ananyev
194e18a033bSKonstantin Ananyev        if (rc != NGX_OK) {
195e18a033bSKonstantin Ananyev            return NGX_DECLINED;
196e18a033bSKonstantin Ananyev        }
197e18a033bSKonstantin Ananyev    }
198e18a033bSKonstantin Ananyev
199e18a033bSKonstantin Ananyev    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0, "http static fd: %d", of.fd);
200e18a033bSKonstantin Ananyev
201e18a033bSKonstantin Ananyev    if (of.is_dir) {
202e18a033bSKonstantin Ananyev        ngx_log_debug0(NGX_LOG_DEBUG_HTTP, log, 0, "http dir");
203e18a033bSKonstantin Ananyev        return NGX_DECLINED;
204e18a033bSKonstantin Ananyev    }
205e18a033bSKonstantin Ananyev
206e18a033bSKonstantin Ananyev#if !(NGX_WIN32) /* the not regular files are probably Unix specific */
207e18a033bSKonstantin Ananyev
208e18a033bSKonstantin Ananyev    if (!of.is_file) {
209e18a033bSKonstantin Ananyev        ngx_log_error(NGX_LOG_CRIT, log, 0,
210e18a033bSKonstantin Ananyev                      "\"%s\" is not a regular file", path.data);
211e18a033bSKonstantin Ananyev
212e18a033bSKonstantin Ananyev        return NGX_HTTP_NOT_FOUND;
213e18a033bSKonstantin Ananyev    }
214e18a033bSKonstantin Ananyev
215e18a033bSKonstantin Ananyev#endif
216e18a033bSKonstantin Ananyev
217e18a033bSKonstantin Ananyev    r->root_tested = !r->error_page;
218e18a033bSKonstantin Ananyev
219e18a033bSKonstantin Ananyev    rc = ngx_http_discard_request_body(r);
220e18a033bSKonstantin Ananyev
221e18a033bSKonstantin Ananyev    if (rc != NGX_OK) {
222e18a033bSKonstantin Ananyev        return rc;
223e18a033bSKonstantin Ananyev    }
224e18a033bSKonstantin Ananyev
225e18a033bSKonstantin Ananyev    log->action = "sending response to client";
226e18a033bSKonstantin Ananyev
227e18a033bSKonstantin Ananyev    r->headers_out.status = NGX_HTTP_OK;
228e18a033bSKonstantin Ananyev    r->headers_out.content_length_n = of.size;
229e18a033bSKonstantin Ananyev    r->headers_out.last_modified_time = of.mtime;
230e18a033bSKonstantin Ananyev
231e18a033bSKonstantin Ananyev    if (ngx_http_set_etag(r) != NGX_OK) {
232e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
233e18a033bSKonstantin Ananyev    }
234e18a033bSKonstantin Ananyev
235e18a033bSKonstantin Ananyev    if (ngx_http_set_content_type(r) != NGX_OK) {
236e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
237e18a033bSKonstantin Ananyev    }
238e18a033bSKonstantin Ananyev
239e18a033bSKonstantin Ananyev    h = ngx_list_push(&r->headers_out.headers);
240e18a033bSKonstantin Ananyev    if (h == NULL) {
241e18a033bSKonstantin Ananyev        return NGX_ERROR;
242e18a033bSKonstantin Ananyev    }
243e18a033bSKonstantin Ananyev
244e18a033bSKonstantin Ananyev    h->hash = 1;
245e18a033bSKonstantin Ananyev    ngx_str_set(&h->key, "Content-Encoding");
246e18a033bSKonstantin Ananyev    ngx_str_set(&h->value, "gzip");
247e18a033bSKonstantin Ananyev    r->headers_out.content_encoding = h;
248e18a033bSKonstantin Ananyev
249e18a033bSKonstantin Ananyev    /* we need to allocate all before the header would be sent */
250e18a033bSKonstantin Ananyev
251e18a033bSKonstantin Ananyev    b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
252e18a033bSKonstantin Ananyev    if (b == NULL) {
253e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
254e18a033bSKonstantin Ananyev    }
255e18a033bSKonstantin Ananyev
256e18a033bSKonstantin Ananyev    b->file = ngx_pcalloc(r->pool, sizeof(ngx_file_t));
257e18a033bSKonstantin Ananyev    if (b->file == NULL) {
258e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
259e18a033bSKonstantin Ananyev    }
260e18a033bSKonstantin Ananyev
261e18a033bSKonstantin Ananyev    rc = ngx_http_send_header(r);
262e18a033bSKonstantin Ananyev
263e18a033bSKonstantin Ananyev    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
264e18a033bSKonstantin Ananyev        return rc;
265e18a033bSKonstantin Ananyev    }
266e18a033bSKonstantin Ananyev
267e18a033bSKonstantin Ananyev    b->file_pos = 0;
268e18a033bSKonstantin Ananyev    b->file_last = of.size;
269e18a033bSKonstantin Ananyev
270e18a033bSKonstantin Ananyev    b->in_file = b->file_last ? 1 : 0;
271e18a033bSKonstantin Ananyev    b->last_buf = (r == r->main) ? 1 : 0;
272e18a033bSKonstantin Ananyev    b->last_in_chain = 1;
273e18a033bSKonstantin Ananyev
274e18a033bSKonstantin Ananyev    b->file->fd = of.fd;
275e18a033bSKonstantin Ananyev    b->file->name = path;
276e18a033bSKonstantin Ananyev    b->file->log = log;
277e18a033bSKonstantin Ananyev    b->file->directio = of.is_directio;
278e18a033bSKonstantin Ananyev
279e18a033bSKonstantin Ananyev    out.buf = b;
280e18a033bSKonstantin Ananyev    out.next = NULL;
281e18a033bSKonstantin Ananyev
282e18a033bSKonstantin Ananyev    return ngx_http_output_filter(r, &out);
283e18a033bSKonstantin Ananyev}
284e18a033bSKonstantin Ananyev
285e18a033bSKonstantin Ananyev
286e18a033bSKonstantin Ananyevstatic void *
287e18a033bSKonstantin Ananyevngx_http_gzip_static_create_conf(ngx_conf_t *cf)
288e18a033bSKonstantin Ananyev{
289e18a033bSKonstantin Ananyev    ngx_http_gzip_static_conf_t  *conf;
290e18a033bSKonstantin Ananyev
291e18a033bSKonstantin Ananyev    conf = ngx_palloc(cf->pool, sizeof(ngx_http_gzip_static_conf_t));
292e18a033bSKonstantin Ananyev    if (conf == NULL) {
293e18a033bSKonstantin Ananyev        return NULL;
294e18a033bSKonstantin Ananyev    }
295e18a033bSKonstantin Ananyev
296e18a033bSKonstantin Ananyev    conf->enable = NGX_CONF_UNSET_UINT;
297e18a033bSKonstantin Ananyev
298e18a033bSKonstantin Ananyev    return conf;
299e18a033bSKonstantin Ananyev}
300e18a033bSKonstantin Ananyev
301e18a033bSKonstantin Ananyev
302e18a033bSKonstantin Ananyevstatic char *
303e18a033bSKonstantin Ananyevngx_http_gzip_static_merge_conf(ngx_conf_t *cf, void *parent, void *child)
304e18a033bSKonstantin Ananyev{
305e18a033bSKonstantin Ananyev    ngx_http_gzip_static_conf_t *prev = parent;
306e18a033bSKonstantin Ananyev    ngx_http_gzip_static_conf_t *conf = child;
307e18a033bSKonstantin Ananyev
308e18a033bSKonstantin Ananyev    ngx_conf_merge_uint_value(conf->enable, prev->enable,
309e18a033bSKonstantin Ananyev                              NGX_HTTP_GZIP_STATIC_OFF);
310e18a033bSKonstantin Ananyev
311e18a033bSKonstantin Ananyev    return NGX_CONF_OK;
312e18a033bSKonstantin Ananyev}
313e18a033bSKonstantin Ananyev
314e18a033bSKonstantin Ananyev
315e18a033bSKonstantin Ananyevstatic ngx_int_t
316e18a033bSKonstantin Ananyevngx_http_gzip_static_init(ngx_conf_t *cf)
317e18a033bSKonstantin Ananyev{
318e18a033bSKonstantin Ananyev    ngx_http_handler_pt        *h;
319e18a033bSKonstantin Ananyev    ngx_http_core_main_conf_t  *cmcf;
320e18a033bSKonstantin Ananyev
321e18a033bSKonstantin Ananyev    cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
322e18a033bSKonstantin Ananyev
323e18a033bSKonstantin Ananyev    h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
324e18a033bSKonstantin Ananyev    if (h == NULL) {
325e18a033bSKonstantin Ananyev        return NGX_ERROR;
326e18a033bSKonstantin Ananyev    }
327e18a033bSKonstantin Ananyev
328e18a033bSKonstantin Ananyev    *h = ngx_http_gzip_static_handler;
329e18a033bSKonstantin Ananyev
330e18a033bSKonstantin Ananyev    return NGX_OK;
331e18a033bSKonstantin Ananyev}
332