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