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