|
50
|
1
|
|
|
2 /*
|
|
|
3 * Copyright (C) Igor Sysoev
|
|
|
4 */
|
|
|
5
|
|
|
6
|
|
|
7 #include <ngx_config.h>
|
|
|
8 #include <ngx_core.h>
|
|
|
9 #include <ngx_http.h>
|
|
|
10
|
|
|
11
|
|
|
12 typedef struct {
|
|
58
|
13 ngx_str_t name;
|
|
|
14 ngx_array_t *lengths;
|
|
|
15 ngx_array_t *values;
|
|
|
16 } ngx_http_index_t;
|
|
|
17
|
|
|
18
|
|
|
19 typedef struct {
|
|
|
20 ngx_array_t *indices; /* array of ngx_http_index_t */
|
|
50
|
21 size_t max_index_len;
|
|
|
22 } ngx_http_index_loc_conf_t;
|
|
|
23
|
|
|
24
|
|
|
25 #define NGX_HTTP_DEFAULT_INDEX "index.html"
|
|
|
26
|
|
|
27
|
|
|
28 static ngx_int_t ngx_http_index_test_dir(ngx_http_request_t *r,
|
|
344
|
29 ngx_http_core_loc_conf_t *clcf, u_char *path, u_char *last);
|
|
|
30 static ngx_int_t ngx_http_index_error(ngx_http_request_t *r, u_char *file,
|
|
|
31 ngx_err_t err);
|
|
50
|
32
|
|
230
|
33 static ngx_int_t ngx_http_index_init(ngx_conf_t *cf);
|
|
50
|
34 static void *ngx_http_index_create_loc_conf(ngx_conf_t *cf);
|
|
|
35 static char *ngx_http_index_merge_loc_conf(ngx_conf_t *cf,
|
|
58
|
36 void *parent, void *child);
|
|
50
|
37 static char *ngx_http_index_set_index(ngx_conf_t *cf, ngx_command_t *cmd,
|
|
58
|
38 void *conf);
|
|
50
|
39
|
|
|
40
|
|
|
41 static ngx_command_t ngx_http_index_commands[] = {
|
|
|
42
|
|
|
43 { ngx_string("index"),
|
|
58
|
44 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
|
|
50
|
45 ngx_http_index_set_index,
|
|
|
46 NGX_HTTP_LOC_CONF_OFFSET,
|
|
|
47 0,
|
|
|
48 NULL },
|
|
|
49
|
|
|
50 ngx_null_command
|
|
|
51 };
|
|
|
52
|
|
|
53
|
|
216
|
54 static ngx_http_module_t ngx_http_index_module_ctx = {
|
|
58
|
55 NULL, /* preconfiguration */
|
|
230
|
56 ngx_http_index_init, /* postconfiguration */
|
|
50
|
57
|
|
|
58 NULL, /* create main configuration */
|
|
|
59 NULL, /* init main configuration */
|
|
|
60
|
|
|
61 NULL, /* create server configuration */
|
|
|
62 NULL, /* merge server configuration */
|
|
|
63
|
|
|
64 ngx_http_index_create_loc_conf, /* create location configration */
|
|
|
65 ngx_http_index_merge_loc_conf /* merge location configration */
|
|
|
66 };
|
|
|
67
|
|
|
68
|
|
|
69 ngx_module_t ngx_http_index_module = {
|
|
58
|
70 NGX_MODULE_V1,
|
|
50
|
71 &ngx_http_index_module_ctx, /* module context */
|
|
|
72 ngx_http_index_commands, /* module directives */
|
|
|
73 NGX_HTTP_MODULE, /* module type */
|
|
90
|
74 NULL, /* init master */
|
|
230
|
75 NULL, /* init module */
|
|
90
|
76 NULL, /* init process */
|
|
|
77 NULL, /* init thread */
|
|
|
78 NULL, /* exit thread */
|
|
|
79 NULL, /* exit process */
|
|
|
80 NULL, /* exit master */
|
|
|
81 NGX_MODULE_V1_PADDING
|
|
50
|
82 };
|
|
|
83
|
|
|
84
|
|
|
85 /*
|
|
|
86 * Try to open the first index file before the test of the directory existence
|
|
|
87 * because the valid requests should be many more than invalid ones.
|
|
|
88 * If open() would fail, then stat() should be more quickly because some data
|
|
|
89 * is already cached in the kernel.
|
|
|
90 * Besides, Win32 has ERROR_PATH_NOT_FOUND (NGX_ENOTDIR).
|
|
|
91 * Unix has ENOTDIR error, although it less helpfull - it points only
|
|
|
92 * that path contains the usual file in place of the directory.
|
|
|
93 */
|
|
|
94
|
|
58
|
95 static ngx_int_t
|
|
|
96 ngx_http_index_handler(ngx_http_request_t *r)
|
|
50
|
97 {
|
|
344
|
98 u_char *p, *name;
|
|
|
99 size_t len, nlen, root, allocated;
|
|
58
|
100 ngx_int_t rc;
|
|
332
|
101 ngx_str_t path, uri;
|
|
58
|
102 ngx_log_t *log;
|
|
344
|
103 ngx_uint_t i, dir_tested;
|
|
58
|
104 ngx_http_index_t *index;
|
|
332
|
105 ngx_open_file_info_t of;
|
|
58
|
106 ngx_http_script_code_pt code;
|
|
|
107 ngx_http_script_engine_t e;
|
|
|
108 ngx_http_core_loc_conf_t *clcf;
|
|
|
109 ngx_http_index_loc_conf_t *ilcf;
|
|
|
110 ngx_http_script_len_code_pt lcode;
|
|
50
|
111
|
|
|
112 if (r->uri.data[r->uri.len - 1] != '/') {
|
|
|
113 return NGX_DECLINED;
|
|
|
114 }
|
|
|
115
|
|
272
|
116 if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST))) {
|
|
|
117 return NGX_DECLINED;
|
|
|
118 }
|
|
|
119
|
|
50
|
120 /* TODO: Win32 */
|
|
|
121 if (r->zero_in_uri) {
|
|
|
122 return NGX_DECLINED;
|
|
|
123 }
|
|
|
124
|
|
|
125 log = r->connection->log;
|
|
|
126
|
|
332
|
127 ilcf = ngx_http_get_module_loc_conf(r, ngx_http_index_module);
|
|
|
128 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
|
|
|
129
|
|
344
|
130 allocated = 0;
|
|
|
131 root = 0;
|
|
|
132 dir_tested = 0;
|
|
|
133 name = NULL;
|
|
|
134 path.data = NULL;
|
|
50
|
135
|
|
58
|
136 index = ilcf->indices->elts;
|
|
344
|
137 for (i = 0; i < ilcf->indices->nelts; i++) {
|
|
58
|
138
|
|
|
139 if (index[i].lengths == NULL) {
|
|
50
|
140
|
|
58
|
141 if (index[i].name.data[0] == '/') {
|
|
|
142 return ngx_http_internal_redirect(r, &index[i].name, &r->args);
|
|
|
143 }
|
|
50
|
144
|
|
58
|
145 len = ilcf->max_index_len;
|
|
344
|
146 nlen = index[i].name.len;
|
|
50
|
147
|
|
58
|
148 } else {
|
|
|
149 ngx_memzero(&e, sizeof(ngx_http_script_engine_t));
|
|
50
|
150
|
|
58
|
151 e.ip = index[i].lengths->elts;
|
|
|
152 e.request = r;
|
|
122
|
153 e.flushed = 1;
|
|
58
|
154
|
|
112
|
155 /* 1 byte for terminating '\0' */
|
|
106
|
156
|
|
112
|
157 len = 1;
|
|
50
|
158
|
|
58
|
159 while (*(uintptr_t *) e.ip) {
|
|
|
160 lcode = *(ngx_http_script_len_code_pt *) e.ip;
|
|
|
161 len += lcode(&e);
|
|
|
162 }
|
|
50
|
163
|
|
344
|
164 nlen = len;
|
|
112
|
165
|
|
|
166 /* 16 bytes are preallocation */
|
|
|
167
|
|
|
168 len += 16;
|
|
58
|
169 }
|
|
50
|
170
|
|
344
|
171 if (len > (size_t) (path.data + allocated - name)) {
|
|
106
|
172
|
|
344
|
173 name = ngx_http_map_uri_to_path(r, &path, &root, len);
|
|
|
174 if (name == NULL) {
|
|
106
|
175 return NGX_ERROR;
|
|
50
|
176 }
|
|
106
|
177
|
|
344
|
178 allocated = path.len;
|
|
50
|
179 }
|
|
|
180
|
|
58
|
181 if (index[i].values == NULL) {
|
|
106
|
182
|
|
|
183 /* index[i].name.len includes the terminating '\0' */
|
|
|
184
|
|
344
|
185 ngx_memcpy(name, index[i].name.data, index[i].name.len);
|
|
50
|
186
|
|
344
|
187 path.len = (name + index[i].name.len - 1) - path.data;
|
|
332
|
188
|
|
58
|
189 } else {
|
|
|
190 e.ip = index[i].values->elts;
|
|
344
|
191 e.pos = name;
|
|
50
|
192
|
|
58
|
193 while (*(uintptr_t *) e.ip) {
|
|
|
194 code = *(ngx_http_script_code_pt *) e.ip;
|
|
|
195 code((ngx_http_script_engine_t *) &e);
|
|
50
|
196 }
|
|
|
197
|
|
344
|
198 if (*name == '/') {
|
|
|
199 uri.len = nlen - 1;
|
|
|
200 uri.data = name;
|
|
|
201 return ngx_http_internal_redirect(r, &uri, &r->args);
|
|
50
|
202 }
|
|
|
203
|
|
332
|
204 path.len = e.pos - path.data;
|
|
|
205
|
|
58
|
206 *e.pos++ = '\0';
|
|
50
|
207 }
|
|
|
208
|
|
344
|
209 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0, "open index \"%V\"", &path);
|
|
50
|
210
|
|
384
|
211 ngx_memzero(&of, sizeof(ngx_open_file_info_t));
|
|
|
212
|
|
358
|
213 of.valid = clcf->open_file_cache_valid;
|
|
|
214 of.min_uses = clcf->open_file_cache_min_uses;
|
|
332
|
215 of.errors = clcf->open_file_cache_errors;
|
|
|
216 of.events = clcf->open_file_cache_events;
|
|
112
|
217
|
|
362
|
218 if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool)
|
|
|
219 != NGX_OK)
|
|
|
220 {
|
|
332
|
221 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, of.err,
|
|
344
|
222 ngx_open_file_n " \"%s\" failed", path.data);
|
|
50
|
223
|
|
332
|
224 if (of.err == 0) {
|
|
|
225 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
|
226 }
|
|
50
|
227
|
|
344
|
228 if (of.err == NGX_ENOTDIR || of.err == NGX_EACCES) {
|
|
|
229 return ngx_http_index_error(r, path.data, of.err);
|
|
50
|
230 }
|
|
|
231
|
|
344
|
232 if (!dir_tested) {
|
|
|
233 rc = ngx_http_index_test_dir(r, clcf, path.data, name - 1);
|
|
50
|
234
|
|
|
235 if (rc != NGX_OK) {
|
|
|
236 return rc;
|
|
|
237 }
|
|
|
238
|
|
344
|
239 dir_tested = 1;
|
|
50
|
240 }
|
|
|
241
|
|
332
|
242 if (of.err == NGX_ENOENT) {
|
|
50
|
243 continue;
|
|
|
244 }
|
|
|
245
|
|
332
|
246 ngx_log_error(NGX_LOG_ERR, log, of.err,
|
|
344
|
247 ngx_open_file_n " \"%s\" failed", path.data);
|
|
50
|
248
|
|
|
249 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
|
250 }
|
|
|
251
|
|
344
|
252 uri.len = r->uri.len + nlen - 1;
|
|
106
|
253
|
|
|
254 if (!clcf->alias) {
|
|
344
|
255 uri.data = path.data + root;
|
|
106
|
256
|
|
|
257 } else {
|
|
382
|
258 uri.data = ngx_pnalloc(r->pool, uri.len);
|
|
106
|
259 if (uri.data == NULL) {
|
|
|
260 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
|
261 }
|
|
|
262
|
|
344
|
263 p = ngx_copy(uri.data, r->uri.data, r->uri.len);
|
|
|
264 ngx_memcpy(p, name, nlen - 1);
|
|
50
|
265 }
|
|
|
266
|
|
106
|
267 return ngx_http_internal_redirect(r, &uri, &r->args);
|
|
50
|
268 }
|
|
|
269
|
|
|
270 return NGX_DECLINED;
|
|
|
271 }
|
|
|
272
|
|
|
273
|
|
58
|
274 static ngx_int_t
|
|
332
|
275 ngx_http_index_test_dir(ngx_http_request_t *r, ngx_http_core_loc_conf_t *clcf,
|
|
344
|
276 u_char *path, u_char *last)
|
|
58
|
277 {
|
|
332
|
278 u_char c;
|
|
344
|
279 ngx_str_t dir;
|
|
332
|
280 ngx_open_file_info_t of;
|
|
58
|
281
|
|
344
|
282 c = *last;
|
|
346
|
283 if (c != '/' || path == last) {
|
|
344
|
284 /* "alias" without trailing slash */
|
|
|
285 c = *(++last);
|
|
|
286 }
|
|
|
287 *last = '\0';
|
|
50
|
288
|
|
344
|
289 dir.len = last - path;
|
|
|
290 dir.data = path;
|
|
50
|
291
|
|
332
|
292 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
|
|
344
|
293 "http index check dir: \"%V\"", &dir);
|
|
50
|
294
|
|
384
|
295 ngx_memzero(&of, sizeof(ngx_open_file_info_t));
|
|
|
296
|
|
332
|
297 of.test_dir = 1;
|
|
358
|
298 of.valid = clcf->open_file_cache_valid;
|
|
332
|
299 of.errors = clcf->open_file_cache_errors;
|
|
50
|
300
|
|
344
|
301 if (ngx_open_cached_file(clcf->open_file_cache, &dir, &of, r->pool)
|
|
332
|
302 != NGX_OK)
|
|
|
303 {
|
|
|
304 if (of.err) {
|
|
|
305
|
|
|
306 if (of.err == NGX_ENOENT) {
|
|
344
|
307 *last = c;
|
|
|
308 return ngx_http_index_error(r, dir.data, NGX_ENOENT);
|
|
332
|
309 }
|
|
|
310
|
|
|
311 ngx_log_error(NGX_LOG_CRIT, r->connection->log, of.err,
|
|
344
|
312 ngx_open_file_n " \"%s\" failed", dir.data);
|
|
50
|
313 }
|
|
|
314
|
|
|
315 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
|
316 }
|
|
|
317
|
|
344
|
318 *last = c;
|
|
50
|
319
|
|
332
|
320 if (of.is_dir) {
|
|
50
|
321 return NGX_OK;
|
|
|
322 }
|
|
|
323
|
|
58
|
324 ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
|
|
344
|
325 "\"%s\" is not a directory", dir.data);
|
|
58
|
326
|
|
|
327 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
50
|
328 }
|
|
|
329
|
|
|
330
|
|
58
|
331 static ngx_int_t
|
|
344
|
332 ngx_http_index_error(ngx_http_request_t *r, u_char *file, ngx_err_t err)
|
|
50
|
333 {
|
|
|
334 if (err == NGX_EACCES) {
|
|
|
335 ngx_log_error(NGX_LOG_ERR, r->connection->log, err,
|
|
344
|
336 "\"%s\" is forbidden", file);
|
|
126
|
337
|
|
50
|
338 return NGX_HTTP_FORBIDDEN;
|
|
|
339 }
|
|
|
340
|
|
|
341 ngx_log_error(NGX_LOG_ERR, r->connection->log, err,
|
|
344
|
342 "\"%s\" is not found", file);
|
|
58
|
343
|
|
50
|
344 return NGX_HTTP_NOT_FOUND;
|
|
|
345 }
|
|
|
346
|
|
|
347
|
|
58
|
348 static void *
|
|
|
349 ngx_http_index_create_loc_conf(ngx_conf_t *cf)
|
|
|
350 {
|
|
|
351 ngx_http_index_loc_conf_t *conf;
|
|
|
352
|
|
|
353 conf = ngx_palloc(cf->pool, sizeof(ngx_http_index_loc_conf_t));
|
|
|
354 if (conf == NULL) {
|
|
|
355 return NGX_CONF_ERROR;
|
|
|
356 }
|
|
|
357
|
|
|
358 conf->indices = NULL;
|
|
230
|
359 conf->max_index_len = 0;
|
|
58
|
360
|
|
|
361 return conf;
|
|
|
362 }
|
|
|
363
|
|
|
364
|
|
|
365 static char *
|
|
|
366 ngx_http_index_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
|
|
|
367 {
|
|
|
368 ngx_http_index_loc_conf_t *prev = parent;
|
|
|
369 ngx_http_index_loc_conf_t *conf = child;
|
|
|
370
|
|
|
371 ngx_http_index_t *index;
|
|
|
372
|
|
|
373 if (conf->indices == NULL) {
|
|
|
374 conf->indices = prev->indices;
|
|
|
375 conf->max_index_len = prev->max_index_len;
|
|
|
376 }
|
|
|
377
|
|
|
378 if (conf->indices == NULL) {
|
|
|
379 conf->indices = ngx_array_create(cf->pool, 1, sizeof(ngx_http_index_t));
|
|
|
380 if (conf->indices == NULL) {
|
|
|
381 return NGX_CONF_ERROR;
|
|
|
382 }
|
|
|
383
|
|
|
384 index = ngx_array_push(conf->indices);
|
|
|
385 if (index == NULL) {
|
|
|
386 return NGX_CONF_ERROR;
|
|
|
387 }
|
|
|
388
|
|
|
389 index->name.len = sizeof(NGX_HTTP_DEFAULT_INDEX);
|
|
|
390 index->name.data = (u_char *) NGX_HTTP_DEFAULT_INDEX;
|
|
|
391 index->lengths = NULL;
|
|
|
392 index->values = NULL;
|
|
|
393
|
|
|
394 conf->max_index_len = sizeof(NGX_HTTP_DEFAULT_INDEX);
|
|
|
395
|
|
|
396 return NGX_CONF_OK;
|
|
|
397 }
|
|
|
398
|
|
|
399 return NGX_CONF_OK;
|
|
|
400 }
|
|
|
401
|
|
|
402
|
|
230
|
403 static ngx_int_t
|
|
|
404 ngx_http_index_init(ngx_conf_t *cf)
|
|
|
405 {
|
|
|
406 ngx_http_handler_pt *h;
|
|
|
407 ngx_http_core_main_conf_t *cmcf;
|
|
|
408
|
|
|
409 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
|
|
|
410
|
|
|
411 h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
|
|
|
412 if (h == NULL) {
|
|
|
413 return NGX_ERROR;
|
|
|
414 }
|
|
|
415
|
|
|
416 *h = ngx_http_index_handler;
|
|
|
417
|
|
|
418 return NGX_OK;
|
|
|
419 }
|
|
|
420
|
|
|
421
|
|
58
|
422 /* TODO: warn about duplicate indices */
|
|
|
423
|
|
|
424 static char *
|
|
|
425 ngx_http_index_set_index(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
|
426 {
|
|
|
427 ngx_http_index_loc_conf_t *ilcf = conf;
|
|
|
428
|
|
230
|
429 ngx_str_t *value;
|
|
58
|
430 ngx_uint_t i, n;
|
|
|
431 ngx_http_index_t *index;
|
|
|
432 ngx_http_script_compile_t sc;
|
|
|
433
|
|
|
434 if (ilcf->indices == NULL) {
|
|
|
435 ilcf->indices = ngx_array_create(cf->pool, 2, sizeof(ngx_http_index_t));
|
|
|
436 if (ilcf->indices == NULL) {
|
|
|
437 return NGX_CONF_ERROR;
|
|
|
438 }
|
|
|
439 }
|
|
|
440
|
|
|
441 value = cf->args->elts;
|
|
|
442
|
|
|
443 for (i = 1; i < cf->args->nelts; i++) {
|
|
344
|
444
|
|
58
|
445 if (value[i].data[0] == '/' && i != cf->args->nelts - 1) {
|
|
344
|
446 ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
|
|
58
|
447 "only the last index in \"index\" directive "
|
|
344
|
448 "should be absolute");
|
|
58
|
449 }
|
|
|
450
|
|
|
451 if (value[i].len == 0) {
|
|
|
452 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
|
453 "index \"%V\" in \"index\" directive is invalid",
|
|
|
454 &value[1]);
|
|
|
455 return NGX_CONF_ERROR;
|
|
|
456 }
|
|
|
457
|
|
|
458 index = ngx_array_push(ilcf->indices);
|
|
|
459 if (index == NULL) {
|
|
|
460 return NGX_CONF_ERROR;
|
|
|
461 }
|
|
|
462
|
|
|
463 index->name.len = value[i].len;
|
|
|
464 index->name.data = value[i].data;
|
|
|
465 index->lengths = NULL;
|
|
|
466 index->values = NULL;
|
|
|
467
|
|
|
468 n = ngx_http_script_variables_count(&value[i]);
|
|
|
469
|
|
|
470 if (n == 0) {
|
|
230
|
471 if (ilcf->max_index_len < index->name.len) {
|
|
58
|
472 ilcf->max_index_len = index->name.len;
|
|
|
473 }
|
|
|
474
|
|
344
|
475 if (index->name.data[0] == '/') {
|
|
|
476 continue;
|
|
|
477 }
|
|
|
478
|
|
122
|
479 /* include the terminating '\0' to the length to use ngx_copy() */
|
|
106
|
480 index->name.len++;
|
|
|
481
|
|
58
|
482 continue;
|
|
|
483 }
|
|
|
484
|
|
|
485 ngx_memzero(&sc, sizeof(ngx_http_script_compile_t));
|
|
|
486
|
|
|
487 sc.cf = cf;
|
|
|
488 sc.source = &value[i];
|
|
|
489 sc.lengths = &index->lengths;
|
|
|
490 sc.values = &index->values;
|
|
|
491 sc.variables = n;
|
|
|
492 sc.complete_lengths = 1;
|
|
|
493 sc.complete_values = 1;
|
|
|
494
|
|
|
495 if (ngx_http_script_compile(&sc) != NGX_OK) {
|
|
|
496 return NGX_CONF_ERROR;
|
|
|
497 }
|
|
|
498 }
|
|
|
499
|
|
|
500 return NGX_CONF_OK;
|
|
|
501 }
|
