1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Igor Sysoev
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#include <ngx_config.h>
9e18a033bSKonstantin Ananyev#include <ngx_core.h>
10e18a033bSKonstantin Ananyev#include <ngx_http.h>
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev
13e18a033bSKonstantin Ananyevtypedef struct {
14e18a033bSKonstantin Ananyev    ngx_flag_t  enable;
15e18a033bSKonstantin Ananyev} ngx_http_random_index_loc_conf_t;
16e18a033bSKonstantin Ananyev
17e18a033bSKonstantin Ananyev
18e18a033bSKonstantin Ananyev#define NGX_HTTP_RANDOM_INDEX_PREALLOCATE  50
19e18a033bSKonstantin Ananyev
20e18a033bSKonstantin Ananyev
21e18a033bSKonstantin Ananyevstatic ngx_int_t ngx_http_random_index_error(ngx_http_request_t *r,
22e18a033bSKonstantin Ananyev    ngx_dir_t *dir, ngx_str_t *name);
23e18a033bSKonstantin Ananyevstatic ngx_int_t ngx_http_random_index_init(ngx_conf_t *cf);
24e18a033bSKonstantin Ananyevstatic void *ngx_http_random_index_create_loc_conf(ngx_conf_t *cf);
25e18a033bSKonstantin Ananyevstatic char *ngx_http_random_index_merge_loc_conf(ngx_conf_t *cf,
26e18a033bSKonstantin Ananyev    void *parent, void *child);
27e18a033bSKonstantin Ananyev
28e18a033bSKonstantin Ananyev
29e18a033bSKonstantin Ananyevstatic ngx_command_t  ngx_http_random_index_commands[] = {
30e18a033bSKonstantin Ananyev
31e18a033bSKonstantin Ananyev    { ngx_string("random_index"),
32e18a033bSKonstantin Ananyev      NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
33e18a033bSKonstantin Ananyev      ngx_conf_set_flag_slot,
34e18a033bSKonstantin Ananyev      NGX_HTTP_LOC_CONF_OFFSET,
35e18a033bSKonstantin Ananyev      offsetof(ngx_http_random_index_loc_conf_t, enable),
36e18a033bSKonstantin Ananyev      NULL },
37e18a033bSKonstantin Ananyev
38e18a033bSKonstantin Ananyev      ngx_null_command
39e18a033bSKonstantin Ananyev};
40e18a033bSKonstantin Ananyev
41e18a033bSKonstantin Ananyev
42e18a033bSKonstantin Ananyevstatic ngx_http_module_t  ngx_http_random_index_module_ctx = {
43e18a033bSKonstantin Ananyev    NULL,                                  /* preconfiguration */
44e18a033bSKonstantin Ananyev    ngx_http_random_index_init,            /* postconfiguration */
45e18a033bSKonstantin Ananyev
46e18a033bSKonstantin Ananyev    NULL,                                  /* create main configuration */
47e18a033bSKonstantin Ananyev    NULL,                                  /* init main configuration */
48e18a033bSKonstantin Ananyev
49e18a033bSKonstantin Ananyev    NULL,                                  /* create server configuration */
50e18a033bSKonstantin Ananyev    NULL,                                  /* merge server configuration */
51e18a033bSKonstantin Ananyev
52e18a033bSKonstantin Ananyev    ngx_http_random_index_create_loc_conf, /* create location configuration */
53e18a033bSKonstantin Ananyev    ngx_http_random_index_merge_loc_conf   /* merge location configuration */
54e18a033bSKonstantin Ananyev};
55e18a033bSKonstantin Ananyev
56e18a033bSKonstantin Ananyev
57e18a033bSKonstantin Ananyevngx_module_t  ngx_http_random_index_module = {
58e18a033bSKonstantin Ananyev    NGX_MODULE_V1,
59e18a033bSKonstantin Ananyev    &ngx_http_random_index_module_ctx,     /* module context */
60e18a033bSKonstantin Ananyev    ngx_http_random_index_commands,        /* module directives */
61e18a033bSKonstantin Ananyev    NGX_HTTP_MODULE,                       /* module type */
62e18a033bSKonstantin Ananyev    NULL,                                  /* init master */
63e18a033bSKonstantin Ananyev    NULL,                                  /* init module */
64e18a033bSKonstantin Ananyev    NULL,                                  /* init process */
65e18a033bSKonstantin Ananyev    NULL,                                  /* init thread */
66e18a033bSKonstantin Ananyev    NULL,                                  /* exit thread */
67e18a033bSKonstantin Ananyev    NULL,                                  /* exit process */
68e18a033bSKonstantin Ananyev    NULL,                                  /* exit master */
69e18a033bSKonstantin Ananyev    NGX_MODULE_V1_PADDING
70e18a033bSKonstantin Ananyev};
71e18a033bSKonstantin Ananyev
72e18a033bSKonstantin Ananyev
73e18a033bSKonstantin Ananyevstatic ngx_int_t
74e18a033bSKonstantin Ananyevngx_http_random_index_handler(ngx_http_request_t *r)
75e18a033bSKonstantin Ananyev{
76e18a033bSKonstantin Ananyev    u_char                            *last, *filename;
77e18a033bSKonstantin Ananyev    size_t                             len, allocated, root;
78e18a033bSKonstantin Ananyev    ngx_err_t                          err;
79e18a033bSKonstantin Ananyev    ngx_int_t                          rc;
80e18a033bSKonstantin Ananyev    ngx_str_t                          path, uri, *name;
81e18a033bSKonstantin Ananyev    ngx_dir_t                          dir;
82e18a033bSKonstantin Ananyev    ngx_uint_t                         n, level;
83e18a033bSKonstantin Ananyev    ngx_array_t                        names;
84e18a033bSKonstantin Ananyev    ngx_http_random_index_loc_conf_t  *rlcf;
85e18a033bSKonstantin Ananyev
86e18a033bSKonstantin Ananyev    if (r->uri.data[r->uri.len - 1] != '/') {
87e18a033bSKonstantin Ananyev        return NGX_DECLINED;
88e18a033bSKonstantin Ananyev    }
89e18a033bSKonstantin Ananyev
90e18a033bSKonstantin Ananyev    if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST))) {
91e18a033bSKonstantin Ananyev        return NGX_DECLINED;
92e18a033bSKonstantin Ananyev    }
93e18a033bSKonstantin Ananyev
94e18a033bSKonstantin Ananyev    rlcf = ngx_http_get_module_loc_conf(r, ngx_http_random_index_module);
95e18a033bSKonstantin Ananyev
96e18a033bSKonstantin Ananyev    if (!rlcf->enable) {
97e18a033bSKonstantin Ananyev        return NGX_DECLINED;
98e18a033bSKonstantin Ananyev    }
99e18a033bSKonstantin Ananyev
100e18a033bSKonstantin Ananyev#if (NGX_HAVE_D_TYPE)
101e18a033bSKonstantin Ananyev    len = NGX_DIR_MASK_LEN;
102e18a033bSKonstantin Ananyev#else
103e18a033bSKonstantin Ananyev    len = NGX_HTTP_RANDOM_INDEX_PREALLOCATE;
104e18a033bSKonstantin Ananyev#endif
105e18a033bSKonstantin Ananyev
106e18a033bSKonstantin Ananyev    last = ngx_http_map_uri_to_path(r, &path, &root, len);
107e18a033bSKonstantin Ananyev    if (last == NULL) {
108e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
109e18a033bSKonstantin Ananyev    }
110e18a033bSKonstantin Ananyev
111e18a033bSKonstantin Ananyev    allocated = path.len;
112e18a033bSKonstantin Ananyev
113e18a033bSKonstantin Ananyev    path.len = last - path.data - 1;
114e18a033bSKonstantin Ananyev    path.data[path.len] = '\0';
115e18a033bSKonstantin Ananyev
116e18a033bSKonstantin Ananyev    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
117e18a033bSKonstantin Ananyev                   "http random index: \"%s\"", path.data);
118e18a033bSKonstantin Ananyev
119e18a033bSKonstantin Ananyev    if (ngx_open_dir(&path, &dir) == NGX_ERROR) {
120e18a033bSKonstantin Ananyev        err = ngx_errno;
121e18a033bSKonstantin Ananyev
122e18a033bSKonstantin Ananyev        if (err == NGX_ENOENT
123e18a033bSKonstantin Ananyev            || err == NGX_ENOTDIR
124e18a033bSKonstantin Ananyev            || err == NGX_ENAMETOOLONG)
125e18a033bSKonstantin Ananyev        {
126e18a033bSKonstantin Ananyev            level = NGX_LOG_ERR;
127e18a033bSKonstantin Ananyev            rc = NGX_HTTP_NOT_FOUND;
128e18a033bSKonstantin Ananyev
129e18a033bSKonstantin Ananyev        } else if (err == NGX_EACCES) {
130e18a033bSKonstantin Ananyev            level = NGX_LOG_ERR;
131e18a033bSKonstantin Ananyev            rc = NGX_HTTP_FORBIDDEN;
132e18a033bSKonstantin Ananyev
133e18a033bSKonstantin Ananyev        } else {
134e18a033bSKonstantin Ananyev            level = NGX_LOG_CRIT;
135e18a033bSKonstantin Ananyev            rc = NGX_HTTP_INTERNAL_SERVER_ERROR;
136e18a033bSKonstantin Ananyev        }
137e18a033bSKonstantin Ananyev
138e18a033bSKonstantin Ananyev        ngx_log_error(level, r->connection->log, err,
139e18a033bSKonstantin Ananyev                      ngx_open_dir_n " \"%s\" failed", path.data);
140e18a033bSKonstantin Ananyev
141e18a033bSKonstantin Ananyev        return rc;
142e18a033bSKonstantin Ananyev    }
143e18a033bSKonstantin Ananyev
144e18a033bSKonstantin Ananyev    if (ngx_array_init(&names, r->pool, 32, sizeof(ngx_str_t)) != NGX_OK) {
145e18a033bSKonstantin Ananyev        return ngx_http_random_index_error(r, &dir, &path);
146e18a033bSKonstantin Ananyev    }
147e18a033bSKonstantin Ananyev
148e18a033bSKonstantin Ananyev    filename = path.data;
149e18a033bSKonstantin Ananyev    filename[path.len] = '/';
150e18a033bSKonstantin Ananyev
151e18a033bSKonstantin Ananyev    for ( ;; ) {
152e18a033bSKonstantin Ananyev        ngx_set_errno(0);
153e18a033bSKonstantin Ananyev
154e18a033bSKonstantin Ananyev        if (ngx_read_dir(&dir) == NGX_ERROR) {
155e18a033bSKonstantin Ananyev            err = ngx_errno;
156e18a033bSKonstantin Ananyev
157e18a033bSKonstantin Ananyev            if (err != NGX_ENOMOREFILES) {
158e18a033bSKonstantin Ananyev                ngx_log_error(NGX_LOG_CRIT, r->connection->log, err,
159e18a033bSKonstantin Ananyev                              ngx_read_dir_n " \"%V\" failed", &path);
160e18a033bSKonstantin Ananyev                return ngx_http_random_index_error(r, &dir, &path);
161e18a033bSKonstantin Ananyev            }
162e18a033bSKonstantin Ananyev
163e18a033bSKonstantin Ananyev            break;
164e18a033bSKonstantin Ananyev        }
165e18a033bSKonstantin Ananyev
166e18a033bSKonstantin Ananyev        ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
167e18a033bSKonstantin Ananyev                       "http random index file: \"%s\"", ngx_de_name(&dir));
168e18a033bSKonstantin Ananyev
169e18a033bSKonstantin Ananyev        if (ngx_de_name(&dir)[0] == '.') {
170e18a033bSKonstantin Ananyev            continue;
171e18a033bSKonstantin Ananyev        }
172e18a033bSKonstantin Ananyev
173e18a033bSKonstantin Ananyev        len = ngx_de_namelen(&dir);
174e18a033bSKonstantin Ananyev
175e18a033bSKonstantin Ananyev        if (dir.type == 0 || ngx_de_is_link(&dir)) {
176e18a033bSKonstantin Ananyev
177e18a033bSKonstantin Ananyev            /* 1 byte for '/' and 1 byte for terminating '\0' */
178e18a033bSKonstantin Ananyev
179e18a033bSKonstantin Ananyev            if (path.len + 1 + len + 1 > allocated) {
180e18a033bSKonstantin Ananyev                allocated = path.len + 1 + len + 1
181e18a033bSKonstantin Ananyev                                     + NGX_HTTP_RANDOM_INDEX_PREALLOCATE;
182e18a033bSKonstantin Ananyev
183e18a033bSKonstantin Ananyev                filename = ngx_pnalloc(r->pool, allocated);
184e18a033bSKonstantin Ananyev                if (filename == NULL) {
185e18a033bSKonstantin Ananyev                    return ngx_http_random_index_error(r, &dir, &path);
186e18a033bSKonstantin Ananyev                }
187e18a033bSKonstantin Ananyev
188e18a033bSKonstantin Ananyev                last = ngx_cpystrn(filename, path.data, path.len + 1);
189e18a033bSKonstantin Ananyev                *last++ = '/';
190e18a033bSKonstantin Ananyev            }
191e18a033bSKonstantin Ananyev
192e18a033bSKonstantin Ananyev            ngx_cpystrn(last, ngx_de_name(&dir), len + 1);
193e18a033bSKonstantin Ananyev
194e18a033bSKonstantin Ananyev            if (ngx_de_info(filename, &dir) == NGX_FILE_ERROR) {
195e18a033bSKonstantin Ananyev                err = ngx_errno;
196e18a033bSKonstantin Ananyev
197e18a033bSKonstantin Ananyev                if (err != NGX_ENOENT) {
198e18a033bSKonstantin Ananyev                    ngx_log_error(NGX_LOG_CRIT, r->connection->log, err,
199e18a033bSKonstantin Ananyev                                  ngx_de_info_n " \"%s\" failed", filename);
200e18a033bSKonstantin Ananyev                    return ngx_http_random_index_error(r, &dir, &path);
201e18a033bSKonstantin Ananyev                }
202e18a033bSKonstantin Ananyev
203e18a033bSKonstantin Ananyev                if (ngx_de_link_info(filename, &dir) == NGX_FILE_ERROR) {
204e18a033bSKonstantin Ananyev                    ngx_log_error(NGX_LOG_CRIT, r->connection->log, ngx_errno,
205e18a033bSKonstantin Ananyev                                  ngx_de_link_info_n " \"%s\" failed",
206e18a033bSKonstantin Ananyev                                  filename);
207e18a033bSKonstantin Ananyev                    return ngx_http_random_index_error(r, &dir, &path);
208e18a033bSKonstantin Ananyev                }
209e18a033bSKonstantin Ananyev            }
210e18a033bSKonstantin Ananyev        }
211e18a033bSKonstantin Ananyev
212e18a033bSKonstantin Ananyev        if (!ngx_de_is_file(&dir)) {
213e18a033bSKonstantin Ananyev            continue;
214e18a033bSKonstantin Ananyev        }
215e18a033bSKonstantin Ananyev
216e18a033bSKonstantin Ananyev        name = ngx_array_push(&names);
217e18a033bSKonstantin Ananyev        if (name == NULL) {
218e18a033bSKonstantin Ananyev            return ngx_http_random_index_error(r, &dir, &path);
219e18a033bSKonstantin Ananyev        }
220e18a033bSKonstantin Ananyev
221e18a033bSKonstantin Ananyev        name->len = len;
222e18a033bSKonstantin Ananyev
223e18a033bSKonstantin Ananyev        name->data = ngx_pnalloc(r->pool, len);
224e18a033bSKonstantin Ananyev        if (name->data == NULL) {
225e18a033bSKonstantin Ananyev            return ngx_http_random_index_error(r, &dir, &path);
226e18a033bSKonstantin Ananyev        }
227e18a033bSKonstantin Ananyev
228e18a033bSKonstantin Ananyev        ngx_memcpy(name->data, ngx_de_name(&dir), len);
229e18a033bSKonstantin Ananyev    }
230e18a033bSKonstantin Ananyev
231e18a033bSKonstantin Ananyev    if (ngx_close_dir(&dir) == NGX_ERROR) {
232e18a033bSKonstantin Ananyev        ngx_log_error(NGX_LOG_ALERT, r->connection->log, ngx_errno,
233e18a033bSKonstantin Ananyev                      ngx_close_dir_n " \"%V\" failed", &path);
234e18a033bSKonstantin Ananyev    }
235e18a033bSKonstantin Ananyev
236e18a033bSKonstantin Ananyev    n = names.nelts;
237e18a033bSKonstantin Ananyev
238e18a033bSKonstantin Ananyev    if (n == 0) {
239e18a033bSKonstantin Ananyev        return NGX_DECLINED;
240e18a033bSKonstantin Ananyev    }
241e18a033bSKonstantin Ananyev
242e18a033bSKonstantin Ananyev    name = names.elts;
243e18a033bSKonstantin Ananyev
244e18a033bSKonstantin Ananyev    n = (ngx_uint_t) (((uint64_t) ngx_random() * n) / 0x80000000);
245e18a033bSKonstantin Ananyev
246e18a033bSKonstantin Ananyev    uri.len = r->uri.len + name[n].len;
247e18a033bSKonstantin Ananyev
248e18a033bSKonstantin Ananyev    uri.data = ngx_pnalloc(r->pool, uri.len);
249e18a033bSKonstantin Ananyev    if (uri.data == NULL) {
250e18a033bSKonstantin Ananyev        return NGX_HTTP_INTERNAL_SERVER_ERROR;
251e18a033bSKonstantin Ananyev    }
252e18a033bSKonstantin Ananyev
253e18a033bSKonstantin Ananyev    last = ngx_copy(uri.data, r->uri.data, r->uri.len);
254e18a033bSKonstantin Ananyev    ngx_memcpy(last, name[n].data, name[n].len);
255e18a033bSKonstantin Ananyev
256e18a033bSKonstantin Ananyev    return ngx_http_internal_redirect(r, &uri, &r->args);
257e18a033bSKonstantin Ananyev}
258e18a033bSKonstantin Ananyev
259e18a033bSKonstantin Ananyev
260e18a033bSKonstantin Ananyevstatic ngx_int_t
261e18a033bSKonstantin Ananyevngx_http_random_index_error(ngx_http_request_t *r, ngx_dir_t *dir,
262e18a033bSKonstantin Ananyev    ngx_str_t *name)
263e18a033bSKonstantin Ananyev{
264e18a033bSKonstantin Ananyev    if (ngx_close_dir(dir) == NGX_ERROR) {
265e18a033bSKonstantin Ananyev        ngx_log_error(NGX_LOG_ALERT, r->connection->log, ngx_errno,
266e18a033bSKonstantin Ananyev                      ngx_close_dir_n " \"%V\" failed", name);
267e18a033bSKonstantin Ananyev    }
268e18a033bSKonstantin Ananyev
269e18a033bSKonstantin Ananyev    return NGX_HTTP_INTERNAL_SERVER_ERROR;
270e18a033bSKonstantin Ananyev}
271e18a033bSKonstantin Ananyev
272e18a033bSKonstantin Ananyev
273e18a033bSKonstantin Ananyevstatic void *
274e18a033bSKonstantin Ananyevngx_http_random_index_create_loc_conf(ngx_conf_t *cf)
275e18a033bSKonstantin Ananyev{
276e18a033bSKonstantin Ananyev    ngx_http_random_index_loc_conf_t  *conf;
277e18a033bSKonstantin Ananyev
278e18a033bSKonstantin Ananyev    conf = ngx_palloc(cf->pool, sizeof(ngx_http_random_index_loc_conf_t));
279e18a033bSKonstantin Ananyev    if (conf == NULL) {
280e18a033bSKonstantin Ananyev        return NULL;
281e18a033bSKonstantin Ananyev    }
282e18a033bSKonstantin Ananyev
283e18a033bSKonstantin Ananyev    conf->enable = NGX_CONF_UNSET;
284e18a033bSKonstantin Ananyev
285e18a033bSKonstantin Ananyev    return conf;
286e18a033bSKonstantin Ananyev}
287e18a033bSKonstantin Ananyev
288e18a033bSKonstantin Ananyev
289e18a033bSKonstantin Ananyevstatic char *
290e18a033bSKonstantin Ananyevngx_http_random_index_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
291e18a033bSKonstantin Ananyev{
292e18a033bSKonstantin Ananyev    ngx_http_random_index_loc_conf_t *prev = parent;
293e18a033bSKonstantin Ananyev    ngx_http_random_index_loc_conf_t *conf = child;
294e18a033bSKonstantin Ananyev
295e18a033bSKonstantin Ananyev    ngx_conf_merge_value(conf->enable, prev->enable, 0);
296e18a033bSKonstantin Ananyev
297e18a033bSKonstantin Ananyev    return NGX_CONF_OK;
298e18a033bSKonstantin Ananyev}
299e18a033bSKonstantin Ananyev
300e18a033bSKonstantin Ananyev
301e18a033bSKonstantin Ananyevstatic ngx_int_t
302e18a033bSKonstantin Ananyevngx_http_random_index_init(ngx_conf_t *cf)
303e18a033bSKonstantin Ananyev{
304e18a033bSKonstantin Ananyev    ngx_http_handler_pt        *h;
305e18a033bSKonstantin Ananyev    ngx_http_core_main_conf_t  *cmcf;
306e18a033bSKonstantin Ananyev
307e18a033bSKonstantin Ananyev    cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
308e18a033bSKonstantin Ananyev
309e18a033bSKonstantin Ananyev    h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
310e18a033bSKonstantin Ananyev    if (h == NULL) {
311e18a033bSKonstantin Ananyev        return NGX_ERROR;
312e18a033bSKonstantin Ananyev    }
313e18a033bSKonstantin Ananyev
314e18a033bSKonstantin Ananyev    *h = ngx_http_random_index_handler;
315e18a033bSKonstantin Ananyev
316e18a033bSKonstantin Ananyev    return NGX_OK;
317e18a033bSKonstantin Ananyev}
318