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
|
332
|
211 of.test_dir = 0;
|
|
212 of.retest = clcf->open_file_cache_retest;
|
|
213 of.errors = clcf->open_file_cache_errors;
|
|
214 of.events = clcf->open_file_cache_events;
|
112
|
215
|
332
|
216 rc = ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool);
|
50
|
217
|
332
|
218 if (rc == NGX_ERROR) {
|
50
|
219
|
332
|
220 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, of.err,
|
344
|
221 ngx_open_file_n " \"%s\" failed", path.data);
|
50
|
222
|
332
|
223 if (of.err == 0) {
|
|
224 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
225 }
|
50
|
226
|
344
|
227 if (of.err == NGX_ENOTDIR || of.err == NGX_EACCES) {
|
|
228 return ngx_http_index_error(r, path.data, of.err);
|
50
|
229 }
|
|
230
|
344
|
231 if (!dir_tested) {
|
|
232 rc = ngx_http_index_test_dir(r, clcf, path.data, name - 1);
|
50
|
233
|
|
234 if (rc != NGX_OK) {
|
|
235 return rc;
|
|
236 }
|
|
237
|
344
|
238 dir_tested = 1;
|
50
|
239 }
|
|
240
|
332
|
241 if (of.err == NGX_ENOENT) {
|
50
|
242 continue;
|
|
243 }
|
|
244
|
332
|
245 ngx_log_error(NGX_LOG_ERR, log, of.err,
|
344
|
246 ngx_open_file_n " \"%s\" failed", path.data);
|
50
|
247
|
|
248 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
249 }
|
|
250
|
344
|
251 uri.len = r->uri.len + nlen - 1;
|
106
|
252
|
|
253 if (!clcf->alias) {
|
344
|
254 uri.data = path.data + root;
|
106
|
255
|
|
256 } else {
|
|
257 uri.data = ngx_palloc(r->pool, uri.len);
|
|
258 if (uri.data == NULL) {
|
|
259 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
260 }
|
|
261
|
344
|
262 p = ngx_copy(uri.data, r->uri.data, r->uri.len);
|
|
263 ngx_memcpy(p, name, nlen - 1);
|
50
|
264 }
|
|
265
|
106
|
266 return ngx_http_internal_redirect(r, &uri, &r->args);
|
50
|
267 }
|
|
268
|
|
269 return NGX_DECLINED;
|
|
270 }
|
|
271
|
|
272
|
58
|
273 static ngx_int_t
|
332
|
274 ngx_http_index_test_dir(ngx_http_request_t *r, ngx_http_core_loc_conf_t *clcf,
|
344
|
275 u_char *path, u_char *last)
|
58
|
276 {
|
332
|
277 u_char c;
|
344
|
278 ngx_str_t dir;
|
332
|
279 ngx_open_file_info_t of;
|
58
|
280
|
344
|
281 c = *last;
|
346
|
282 if (c != '/' || path == last) {
|
344
|
283 /* "alias" without trailing slash */
|
|
284 c = *(++last);
|
|
285 }
|
|
286 *last = '\0';
|
50
|
287
|
344
|
288 dir.len = last - path;
|
|
289 dir.data = path;
|
50
|
290
|
332
|
291 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
|
344
|
292 "http index check dir: \"%V\"", &dir);
|
50
|
293
|
332
|
294 of.test_dir = 1;
|
|
295 of.retest = clcf->open_file_cache_retest;
|
|
296 of.errors = clcf->open_file_cache_errors;
|
50
|
297
|
344
|
298 if (ngx_open_cached_file(clcf->open_file_cache, &dir, &of, r->pool)
|
332
|
299 != NGX_OK)
|
|
300 {
|
|
301 if (of.err) {
|
|
302
|
|
303 if (of.err == NGX_ENOENT) {
|
344
|
304 *last = c;
|
|
305 return ngx_http_index_error(r, dir.data, NGX_ENOENT);
|
332
|
306 }
|
|
307
|
|
308 ngx_log_error(NGX_LOG_CRIT, r->connection->log, of.err,
|
344
|
309 ngx_open_file_n " \"%s\" failed", dir.data);
|
50
|
310 }
|
|
311
|
|
312 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
|
313 }
|
|
314
|
344
|
315 *last = c;
|
50
|
316
|
332
|
317 if (of.is_dir) {
|
50
|
318 return NGX_OK;
|
|
319 }
|
|
320
|
58
|
321 ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
|
344
|
322 "\"%s\" is not a directory", dir.data);
|
58
|
323
|
|
324 return NGX_HTTP_INTERNAL_SERVER_ERROR;
|
50
|
325 }
|
|
326
|
|
327
|
58
|
328 static ngx_int_t
|
344
|
329 ngx_http_index_error(ngx_http_request_t *r, u_char *file, ngx_err_t err)
|
50
|
330 {
|
|
331 if (err == NGX_EACCES) {
|
|
332 ngx_log_error(NGX_LOG_ERR, r->connection->log, err,
|
344
|
333 "\"%s\" is forbidden", file);
|
126
|
334
|
50
|
335 return NGX_HTTP_FORBIDDEN;
|
|
336 }
|
|
337
|
|
338 ngx_log_error(NGX_LOG_ERR, r->connection->log, err,
|
344
|
339 "\"%s\" is not found", file);
|
58
|
340
|
50
|
341 return NGX_HTTP_NOT_FOUND;
|
|
342 }
|
|
343
|
|
344
|
58
|
345 static void *
|
|
346 ngx_http_index_create_loc_conf(ngx_conf_t *cf)
|
|
347 {
|
|
348 ngx_http_index_loc_conf_t *conf;
|
|
349
|
|
350 conf = ngx_palloc(cf->pool, sizeof(ngx_http_index_loc_conf_t));
|
|
351 if (conf == NULL) {
|
|
352 return NGX_CONF_ERROR;
|
|
353 }
|
|
354
|
|
355 conf->indices = NULL;
|
230
|
356 conf->max_index_len = 0;
|
58
|
357
|
|
358 return conf;
|
|
359 }
|
|
360
|
|
361
|
|
362 static char *
|
|
363 ngx_http_index_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
|
|
364 {
|
|
365 ngx_http_index_loc_conf_t *prev = parent;
|
|
366 ngx_http_index_loc_conf_t *conf = child;
|
|
367
|
|
368 ngx_http_index_t *index;
|
|
369
|
|
370 if (conf->indices == NULL) {
|
|
371 conf->indices = prev->indices;
|
|
372 conf->max_index_len = prev->max_index_len;
|
|
373 }
|
|
374
|
|
375 if (conf->indices == NULL) {
|
|
376 conf->indices = ngx_array_create(cf->pool, 1, sizeof(ngx_http_index_t));
|
|
377 if (conf->indices == NULL) {
|
|
378 return NGX_CONF_ERROR;
|
|
379 }
|
|
380
|
|
381 index = ngx_array_push(conf->indices);
|
|
382 if (index == NULL) {
|
|
383 return NGX_CONF_ERROR;
|
|
384 }
|
|
385
|
|
386 index->name.len = sizeof(NGX_HTTP_DEFAULT_INDEX);
|
|
387 index->name.data = (u_char *) NGX_HTTP_DEFAULT_INDEX;
|
|
388 index->lengths = NULL;
|
|
389 index->values = NULL;
|
|
390
|
|
391 conf->max_index_len = sizeof(NGX_HTTP_DEFAULT_INDEX);
|
|
392
|
|
393 return NGX_CONF_OK;
|
|
394 }
|
|
395
|
|
396 return NGX_CONF_OK;
|
|
397 }
|
|
398
|
|
399
|
230
|
400 static ngx_int_t
|
|
401 ngx_http_index_init(ngx_conf_t *cf)
|
|
402 {
|
|
403 ngx_http_handler_pt *h;
|
|
404 ngx_http_core_main_conf_t *cmcf;
|
|
405
|
|
406 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
|
|
407
|
|
408 h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
|
|
409 if (h == NULL) {
|
|
410 return NGX_ERROR;
|
|
411 }
|
|
412
|
|
413 *h = ngx_http_index_handler;
|
|
414
|
|
415 return NGX_OK;
|
|
416 }
|
|
417
|
|
418
|
58
|
419 /* TODO: warn about duplicate indices */
|
|
420
|
|
421 static char *
|
|
422 ngx_http_index_set_index(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
423 {
|
|
424 ngx_http_index_loc_conf_t *ilcf = conf;
|
|
425
|
230
|
426 ngx_str_t *value;
|
58
|
427 ngx_uint_t i, n;
|
|
428 ngx_http_index_t *index;
|
|
429 ngx_http_script_compile_t sc;
|
|
430
|
|
431 if (ilcf->indices == NULL) {
|
|
432 ilcf->indices = ngx_array_create(cf->pool, 2, sizeof(ngx_http_index_t));
|
|
433 if (ilcf->indices == NULL) {
|
|
434 return NGX_CONF_ERROR;
|
|
435 }
|
|
436 }
|
|
437
|
|
438 value = cf->args->elts;
|
|
439
|
|
440 for (i = 1; i < cf->args->nelts; i++) {
|
344
|
441
|
58
|
442 if (value[i].data[0] == '/' && i != cf->args->nelts - 1) {
|
344
|
443 ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
|
58
|
444 "only the last index in \"index\" directive "
|
344
|
445 "should be absolute");
|
58
|
446 }
|
|
447
|
|
448 if (value[i].len == 0) {
|
|
449 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
450 "index \"%V\" in \"index\" directive is invalid",
|
|
451 &value[1]);
|
|
452 return NGX_CONF_ERROR;
|
|
453 }
|
|
454
|
|
455 index = ngx_array_push(ilcf->indices);
|
|
456 if (index == NULL) {
|
|
457 return NGX_CONF_ERROR;
|
|
458 }
|
|
459
|
|
460 index->name.len = value[i].len;
|
|
461 index->name.data = value[i].data;
|
|
462 index->lengths = NULL;
|
|
463 index->values = NULL;
|
|
464
|
|
465 n = ngx_http_script_variables_count(&value[i]);
|
|
466
|
|
467 if (n == 0) {
|
230
|
468 if (ilcf->max_index_len < index->name.len) {
|
58
|
469 ilcf->max_index_len = index->name.len;
|
|
470 }
|
|
471
|
344
|
472 if (index->name.data[0] == '/') {
|
|
473 continue;
|
|
474 }
|
|
475
|
122
|
476 /* include the terminating '\0' to the length to use ngx_copy() */
|
106
|
477 index->name.len++;
|
|
478
|
58
|
479 continue;
|
|
480 }
|
|
481
|
|
482 ngx_memzero(&sc, sizeof(ngx_http_script_compile_t));
|
|
483
|
|
484 sc.cf = cf;
|
|
485 sc.source = &value[i];
|
|
486 sc.lengths = &index->lengths;
|
|
487 sc.values = &index->values;
|
|
488 sc.variables = n;
|
|
489 sc.complete_lengths = 1;
|
|
490 sc.complete_values = 1;
|
|
491
|
|
492 if (ngx_http_script_compile(&sc) != NGX_OK) {
|
|
493 return NGX_CONF_ERROR;
|
|
494 }
|
|
495 }
|
|
496
|
|
497 return NGX_CONF_OK;
|
|
498 }
|