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