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 Ananyevstatic ngx_int_t ngx_http_static_handler(ngx_http_request_t *r);
14e18a033bSKonstantin Ananyevstatic ngx_int_t ngx_http_static_init(ngx_conf_t *cf);
15e18a033bSKonstantin Ananyev
16e18a033bSKonstantin Ananyev
17e18a033bSKonstantin Ananyevstatic ngx_http_module_t  ngx_http_static_module_ctx = {
18e18a033bSKonstantin Ananyev    NULL,                                  /* preconfiguration */
19e18a033bSKonstantin Ananyev    ngx_http_static_init,                  /* postconfiguration */
20e18a033bSKonstantin Ananyev
21e18a033bSKonstantin Ananyev    NULL,                                  /* create main configuration */
22e18a033bSKonstantin Ananyev    NULL,                                  /* init main configuration */
23e18a033bSKonstantin Ananyev
24e18a033bSKonstantin Ananyev    NULL,                                  /* create server configuration */
25e18a033bSKonstantin Ananyev    NULL,                                  /* merge server configuration */
26e18a033bSKonstantin Ananyev
27e18a033bSKonstantin Ananyev    NULL,                                  /* create location configuration */
28e18a033bSKonstantin Ananyev    NULL                                   /* merge location configuration */
29e18a033bSKonstantin Ananyev};
30e18a033bSKonstantin Ananyev
31e18a033bSKonstantin Ananyev
32e18a033bSKonstantin Ananyevngx_module_t  ngx_http_static_module = {
33e18a033bSKonstantin Ananyev    NGX_MODULE_V1,
34e18a033bSKonstantin Ananyev    &ngx_http_static_module_ctx,           /* module context */
35e18a033bSKonstantin Ananyev    NULL,                                  /* module directives */
36e18a033bSKonstantin Ananyev    NGX_HTTP_MODULE,                       /* module type */
37e18a033bSKonstantin Ananyev    NULL,                                  /* init master */
38e18a033bSKonstantin Ananyev    NULL,                                  /* init module */
39e18a033bSKonstantin Ananyev    NULL,                                  /* init process */
40e18a033bSKonstantin Ananyev    NULL,                                  /* init thread */
41e18a033bSKonstantin Ananyev    NULL,                                  /* exit thread */
42e18a033bSKonstantin Ananyev    NULL,                                  /* exit process */
43e18a033bSKonstantin Ananyev    NULL,                                  /* exit master */
44e18a033bSKonstantin Ananyev    NGX_MODULE_V1_PADDING
45e18a033bSKonstantin Ananyev};
46e18a033bSKonstantin Ananyev
47e18a033bSKonstantin Ananyev
48e18a033bSKonstantin Ananyevstatic ngx_int_t
49e18a033bSKonstantin Ananyevngx_http_static_handler(ngx_http_request_t *r)
50e18a033bSKonstantin Ananyev{
51e18a033bSKonstantin Ananyev    u_char                    *last, *location;
52e18a033bSKonstantin Ananyev    size_t                     root, len;
53e18a033bSKonstantin Ananyev    ngx_str_t                  path;
54e18a033bSKonstantin Ananyev    ngx_int_t                  rc;
55e18a033bSKonstantin Ananyev    ngx_uint_t                 level;
56e18a033bSKonstantin Ananyev    ngx_log_t                 *log;
57e18a033bSKonstantin Ananyev    ngx_buf_t                 *b;
58e18a033bSKonstantin Ananyev    ngx_chain_t                out;
59e18a033bSKonstantin Ananyev    ngx_open_file_info_t       of;
60e18a033bSKonstantin Ananyev    ngx_http_core_loc_conf_t  *clcf;
61e18a033bSKonstantin Ananyev
62e18a033bSKonstantin Ananyev    if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST))) {
63e18a033bSKonstantin Ananyev        return NGX_HTTP_NOT_ALLOWED;
64e18a033bSKonstantin Ananyev    }
65e18a033bSKonstantin Ananyev
66e18a033bSKonstantin Ananyev    if (r->uri.data[r->uri.len - 1] == '/') {
67e18a033bSKonstantin Ananyev        return NGX_DECLINED;
68e18a033bSKonstantin Ananyev    }
69e18a033bSKonstantin Ananyev
70e18a033bSKonstantin Ananyev    log = r->connection->log;
71e18a033bSKonstantin Ananyev
72e18a033bSKonstantin Ananyev    /*
73e18a033bSKonstantin Ananyev     * ngx_http_map_uri_to_path() allocates memory for terminating '\0'
74e18a033bSKonstantin Ananyev     * so we do not need to reserve memory for '/' for possible redirect
75e18a033bSKonstantin Ananyev     */
76e18a033bSKonstantin Ananyev
77e18a033bSKonstantin Ananyev    last = ngx_http_map_uri_to_path(r, &path, &root, 0);
78e18a033bSKonstantin Ananyev    if (last == NULL) {
79e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
80e18a033bSKonstantin Ananyev    }
81e18a033bSKonstantin Ananyev
82e18a033bSKonstantin Ananyev    path.len = last - path.data;
83e18a033bSKonstantin Ananyev
84e18a033bSKonstantin Ananyev    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0,
85e18a033bSKonstantin Ananyev                   "http filename: \"%s\"", path.data);
86e18a033bSKonstantin Ananyev
87e18a033bSKonstantin Ananyev    clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
88e18a033bSKonstantin Ananyev
89e18a033bSKonstantin Ananyev    ngx_memzero(&of, sizeof(ngx_open_file_info_t));
90e18a033bSKonstantin Ananyev
91e18a033bSKonstantin Ananyev    of.read_ahead = clcf->read_ahead;
92e18a033bSKonstantin Ananyev    of.directio = clcf->directio;
93e18a033bSKonstantin Ananyev    of.valid = clcf->open_file_cache_valid;
94e18a033bSKonstantin Ananyev    of.min_uses = clcf->open_file_cache_min_uses;
95e18a033bSKonstantin Ananyev    of.errors = clcf->open_file_cache_errors;
96e18a033bSKonstantin Ananyev    of.events = clcf->open_file_cache_events;
97e18a033bSKonstantin Ananyev
98e18a033bSKonstantin Ananyev    if (ngx_http_set_disable_symlinks(r, clcf, &path, &of) != NGX_OK) {
99e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
100e18a033bSKonstantin Ananyev    }
101e18a033bSKonstantin Ananyev
102e18a033bSKonstantin Ananyev    if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool)
103e18a033bSKonstantin Ananyev        != NGX_OK)
104e18a033bSKonstantin Ananyev    {
105e18a033bSKonstantin Ananyev        switch (of.err) {
106e18a033bSKonstantin Ananyev
107e18a033bSKonstantin Ananyev        case 0:
108e18a033bSKonstantin Ananyev            return NGX_HTTP_INTERNAL_SERVER_ERROR;
109e18a033bSKonstantin Ananyev
110e18a033bSKonstantin Ananyev        case NGX_ENOENT:
111e18a033bSKonstantin Ananyev        case NGX_ENOTDIR:
112e18a033bSKonstantin Ananyev        case NGX_ENAMETOOLONG:
113e18a033bSKonstantin Ananyev
114e18a033bSKonstantin Ananyev            level = NGX_LOG_ERR;
115e18a033bSKonstantin Ananyev            rc = NGX_HTTP_NOT_FOUND;
116e18a033bSKonstantin Ananyev            break;
117e18a033bSKonstantin Ananyev
118e18a033bSKonstantin Ananyev        case NGX_EACCES:
119e18a033bSKonstantin Ananyev#if (NGX_HAVE_OPENAT)
120e18a033bSKonstantin Ananyev        case NGX_EMLINK:
121e18a033bSKonstantin Ananyev        case NGX_ELOOP:
122e18a033bSKonstantin Ananyev#endif
123e18a033bSKonstantin Ananyev
124e18a033bSKonstantin Ananyev            level = NGX_LOG_ERR;
125e18a033bSKonstantin Ananyev            rc = NGX_HTTP_FORBIDDEN;
126e18a033bSKonstantin Ananyev            break;
127e18a033bSKonstantin Ananyev
128e18a033bSKonstantin Ananyev        default:
129e18a033bSKonstantin Ananyev
130e18a033bSKonstantin Ananyev            level = NGX_LOG_CRIT;
131e18a033bSKonstantin Ananyev            rc = NGX_HTTP_INTERNAL_SERVER_ERROR;
132e18a033bSKonstantin Ananyev            break;
133e18a033bSKonstantin Ananyev        }
134e18a033bSKonstantin Ananyev
135e18a033bSKonstantin Ananyev        if (rc != NGX_HTTP_NOT_FOUND || clcf->log_not_found) {
136e18a033bSKonstantin Ananyev            ngx_log_error(level, log, of.err,
137e18a033bSKonstantin Ananyev                          "%s \"%s\" failed", of.failed, path.data);
138e18a033bSKonstantin Ananyev        }
139e18a033bSKonstantin Ananyev
140e18a033bSKonstantin Ananyev        return rc;
141e18a033bSKonstantin Ananyev    }
142e18a033bSKonstantin Ananyev
143e18a033bSKonstantin Ananyev    r->root_tested = !r->error_page;
144e18a033bSKonstantin Ananyev
145e18a033bSKonstantin Ananyev    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0, "http static fd: %d", of.fd);
146e18a033bSKonstantin Ananyev
147e18a033bSKonstantin Ananyev    if (of.is_dir) {
148e18a033bSKonstantin Ananyev
149e18a033bSKonstantin Ananyev        ngx_log_debug0(NGX_LOG_DEBUG_HTTP, log, 0, "http dir");
150e18a033bSKonstantin Ananyev
151e18a033bSKonstantin Ananyev        ngx_http_clear_location(r);
152e18a033bSKonstantin Ananyev
153e18a033bSKonstantin Ananyev        r->headers_out.location = ngx_list_push(&r->headers_out.headers);
154e18a033bSKonstantin Ananyev        if (r->headers_out.location == NULL) {
155e18a033bSKonstantin Ananyev            return NGX_HTTP_INTERNAL_SERVER_ERROR;
156e18a033bSKonstantin Ananyev        }
157e18a033bSKonstantin Ananyev
158e18a033bSKonstantin Ananyev        len = r->uri.len + 1;
159e18a033bSKonstantin Ananyev
160e18a033bSKonstantin Ananyev        if (!clcf->alias && clcf->root_lengths == NULL && r->args.len == 0) {
161e18a033bSKonstantin Ananyev            location = path.data + clcf->root.len;
162e18a033bSKonstantin Ananyev
163e18a033bSKonstantin Ananyev            *last = '/';
164e18a033bSKonstantin Ananyev
165e18a033bSKonstantin Ananyev        } else {
166e18a033bSKonstantin Ananyev            if (r->args.len) {
167e18a033bSKonstantin Ananyev                len += r->args.len + 1;
168e18a033bSKonstantin Ananyev            }
169e18a033bSKonstantin Ananyev
170e18a033bSKonstantin Ananyev            location = ngx_pnalloc(r->pool, len);
171e18a033bSKonstantin Ananyev            if (location == NULL) {
172e18a033bSKonstantin Ananyev                return NGX_HTTP_INTERNAL_SERVER_ERROR;
173e18a033bSKonstantin Ananyev            }
174e18a033bSKonstantin Ananyev
175e18a033bSKonstantin Ananyev            last = ngx_copy(location, r->uri.data, r->uri.len);
176e18a033bSKonstantin Ananyev
177e18a033bSKonstantin Ananyev            *last = '/';
178e18a033bSKonstantin Ananyev
179e18a033bSKonstantin Ananyev            if (r->args.len) {
180e18a033bSKonstantin Ananyev                *++last = '?';
181e18a033bSKonstantin Ananyev                ngx_memcpy(++last, r->args.data, r->args.len);
182e18a033bSKonstantin Ananyev            }
183e18a033bSKonstantin Ananyev        }
184e18a033bSKonstantin Ananyev
185e18a033bSKonstantin Ananyev        r->headers_out.location->hash = 1;
186e18a033bSKonstantin Ananyev        ngx_str_set(&r->headers_out.location->key, "Location");
187e18a033bSKonstantin Ananyev        r->headers_out.location->value.len = len;
188e18a033bSKonstantin Ananyev        r->headers_out.location->value.data = location;
189e18a033bSKonstantin Ananyev
190e18a033bSKonstantin Ananyev        return NGX_HTTP_MOVED_PERMANENTLY;
191e18a033bSKonstantin Ananyev    }
192e18a033bSKonstantin Ananyev
193e18a033bSKonstantin Ananyev#if !(NGX_WIN32) /* the not regular files are probably Unix specific */
194e18a033bSKonstantin Ananyev
195e18a033bSKonstantin Ananyev    if (!of.is_file) {
196e18a033bSKonstantin Ananyev        ngx_log_error(NGX_LOG_CRIT, log, 0,
197e18a033bSKonstantin Ananyev                      "\"%s\" is not a regular file", path.data);
198e18a033bSKonstantin Ananyev
199e18a033bSKonstantin Ananyev        return NGX_HTTP_NOT_FOUND;
200e18a033bSKonstantin Ananyev    }
201e18a033bSKonstantin Ananyev
202e18a033bSKonstantin Ananyev#endif
203e18a033bSKonstantin Ananyev
204e18a033bSKonstantin Ananyev    if (r->method == NGX_HTTP_POST) {
205e18a033bSKonstantin Ananyev        return NGX_HTTP_NOT_ALLOWED;
206e18a033bSKonstantin Ananyev    }
207e18a033bSKonstantin Ananyev
208e18a033bSKonstantin Ananyev    rc = ngx_http_discard_request_body(r);
209e18a033bSKonstantin Ananyev
210e18a033bSKonstantin Ananyev    if (rc != NGX_OK) {
211e18a033bSKonstantin Ananyev        return rc;
212e18a033bSKonstantin Ananyev    }
213e18a033bSKonstantin Ananyev
214e18a033bSKonstantin Ananyev    log->action = "sending response to client";
215e18a033bSKonstantin Ananyev
216e18a033bSKonstantin Ananyev    r->headers_out.status = NGX_HTTP_OK;
217e18a033bSKonstantin Ananyev    r->headers_out.content_length_n = of.size;
218e18a033bSKonstantin Ananyev    r->headers_out.last_modified_time = of.mtime;
219e18a033bSKonstantin Ananyev
220e18a033bSKonstantin Ananyev    if (ngx_http_set_etag(r) != NGX_OK) {
221e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
222e18a033bSKonstantin Ananyev    }
223e18a033bSKonstantin Ananyev
224e18a033bSKonstantin Ananyev    if (ngx_http_set_content_type(r) != NGX_OK) {
225e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
226e18a033bSKonstantin Ananyev    }
227e18a033bSKonstantin Ananyev
228e18a033bSKonstantin Ananyev    if (r != r->main && of.size == 0) {
229e18a033bSKonstantin Ananyev        return ngx_http_send_header(r);
230e18a033bSKonstantin Ananyev    }
231e18a033bSKonstantin Ananyev
232e18a033bSKonstantin Ananyev    r->allow_ranges = 1;
233e18a033bSKonstantin Ananyev
234e18a033bSKonstantin Ananyev    /* we need to allocate all before the header would be sent */
235e18a033bSKonstantin Ananyev
236e18a033bSKonstantin Ananyev    b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
237e18a033bSKonstantin Ananyev    if (b == NULL) {
238e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
239e18a033bSKonstantin Ananyev    }
240e18a033bSKonstantin Ananyev
241e18a033bSKonstantin Ananyev    b->file = ngx_pcalloc(r->pool, sizeof(ngx_file_t));
242e18a033bSKonstantin Ananyev    if (b->file == NULL) {
243e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
244e18a033bSKonstantin Ananyev    }
245e18a033bSKonstantin Ananyev
246e18a033bSKonstantin Ananyev    rc = ngx_http_send_header(r);
247e18a033bSKonstantin Ananyev
248e18a033bSKonstantin Ananyev    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
249e18a033bSKonstantin Ananyev        return rc;
250e18a033bSKonstantin Ananyev    }
251e18a033bSKonstantin Ananyev
252e18a033bSKonstantin Ananyev    b->file_pos = 0;
253e18a033bSKonstantin Ananyev    b->file_last = of.size;
254e18a033bSKonstantin Ananyev
255e18a033bSKonstantin Ananyev    b->in_file = b->file_last ? 1: 0;
256e18a033bSKonstantin Ananyev    b->last_buf = (r == r->main) ? 1: 0;
257e18a033bSKonstantin Ananyev    b->last_in_chain = 1;
258e18a033bSKonstantin Ananyev
259e18a033bSKonstantin Ananyev    b->file->fd = of.fd;
260e18a033bSKonstantin Ananyev    b->file->name = path;
261e18a033bSKonstantin Ananyev    b->file->log = log;
262e18a033bSKonstantin Ananyev    b->file->directio = of.is_directio;
263e18a033bSKonstantin Ananyev
264e18a033bSKonstantin Ananyev    out.buf = b;
265e18a033bSKonstantin Ananyev    out.next = NULL;
266e18a033bSKonstantin Ananyev
267e18a033bSKonstantin Ananyev    return ngx_http_output_filter(r, &out);
268e18a033bSKonstantin Ananyev}
269e18a033bSKonstantin Ananyev
270e18a033bSKonstantin Ananyev
271e18a033bSKonstantin Ananyevstatic ngx_int_t
272e18a033bSKonstantin Ananyevngx_http_static_init(ngx_conf_t *cf)
273e18a033bSKonstantin Ananyev{
274e18a033bSKonstantin Ananyev    ngx_http_handler_pt        *h;
275e18a033bSKonstantin Ananyev    ngx_http_core_main_conf_t  *cmcf;
276e18a033bSKonstantin Ananyev
277e18a033bSKonstantin Ananyev    cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
278e18a033bSKonstantin Ananyev
279e18a033bSKonstantin Ananyev    h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
280e18a033bSKonstantin Ananyev    if (h == NULL) {
281e18a033bSKonstantin Ananyev        return NGX_ERROR;
282e18a033bSKonstantin Ananyev    }
283e18a033bSKonstantin Ananyev
284e18a033bSKonstantin Ananyev    *h = ngx_http_static_handler;
285e18a033bSKonstantin Ananyev
286e18a033bSKonstantin Ananyev    return NGX_OK;
287e18a033bSKonstantin Ananyev}
288