3 * Copyright (C) Igor Sysoev
7 #include <ngx_config.h>
13 * The module can check browser versions conforming to the following formats:
14 * X, X.X, X.X.X, and X.X.X.X. The maximum values of each format may be
15 * 4000, 4000.99, 4000.99.99, and 4000.99.99.99.
19 #define NGX_HTTP_MODERN_BROWSER 0
20 #define NGX_HTTP_ANCIENT_BROWSER 1
28 } ngx_http_modern_browser_mask_t;
36 } ngx_http_modern_browser_t;
41 ngx_http_get_variable_pt handler;
43 } ngx_http_browser_variable_t;
47 ngx_array_t *modern_browsers;
48 ngx_array_t *ancient_browsers;
49 ngx_http_variable_value_t *modern_browser_value;
50 ngx_http_variable_value_t *ancient_browser_value;
52 unsigned modern_unlisted_browsers:1;
54 } ngx_http_browser_conf_t;
57 static ngx_int_t ngx_http_msie_variable(ngx_http_request_t *r,
58 ngx_http_variable_value_t *v, uintptr_t data);
59 static ngx_int_t ngx_http_browser_variable(ngx_http_request_t *r,
60 ngx_http_variable_value_t *v, uintptr_t data);
62 static ngx_uint_t ngx_http_browser(ngx_http_request_t *r,
63 ngx_http_browser_conf_t *cf);
65 static ngx_int_t ngx_http_browser_add_variable(ngx_conf_t *cf);
66 static void *ngx_http_browser_create_conf(ngx_conf_t *cf);
67 static char *ngx_http_browser_merge_conf(ngx_conf_t *cf, void *parent,
69 static int ngx_libc_cdecl ngx_http_modern_browser_sort(const void *one,
71 static char *ngx_http_modern_browser(ngx_conf_t *cf, ngx_command_t *cmd,
73 static char *ngx_http_ancient_browser(ngx_conf_t *cf, ngx_command_t *cmd,
75 static char *ngx_http_modern_browser_value(ngx_conf_t *cf, ngx_command_t *cmd,
77 static char *ngx_http_ancient_browser_value(ngx_conf_t *cf, ngx_command_t *cmd,
81 static ngx_command_t ngx_http_browser_commands[] = {
83 { ngx_string("modern_browser"),
84 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE12,
85 ngx_http_modern_browser,
86 NGX_HTTP_LOC_CONF_OFFSET,
90 { ngx_string("ancient_browser"),
91 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
92 ngx_http_ancient_browser,
93 NGX_HTTP_LOC_CONF_OFFSET,
97 { ngx_string("modern_browser_value"),
98 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
99 ngx_http_modern_browser_value,
100 NGX_HTTP_LOC_CONF_OFFSET,
104 { ngx_string("ancient_browser_value"),
105 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
106 ngx_http_ancient_browser_value,
107 NGX_HTTP_LOC_CONF_OFFSET,
115 static ngx_http_module_t ngx_http_browser_module_ctx = {
116 ngx_http_browser_add_variable, /* preconfiguration */
117 NULL, /* postconfiguration */
119 NULL, /* create main configuration */
120 NULL, /* init main configuration */
122 NULL, /* create server configuration */
123 NULL, /* merge server configuration */
125 ngx_http_browser_create_conf, /* create location configuration */
126 ngx_http_browser_merge_conf /* merge location configuration */
130 ngx_module_t ngx_http_browser_module = {
132 &ngx_http_browser_module_ctx, /* module context */
133 ngx_http_browser_commands, /* module directives */
134 NGX_HTTP_MODULE, /* module type */
135 NULL, /* init master */
136 NULL, /* init module */
137 NULL, /* init process */
138 NULL, /* init thread */
139 NULL, /* exit thread */
140 NULL, /* exit process */
141 NULL, /* exit master */
142 NGX_MODULE_V1_PADDING
146 static ngx_http_modern_browser_mask_t ngx_http_modern_browser_masks[] = {
148 /* Opera must be the first browser to check */
151 * "Opera/7.50 (X11; FreeBSD i386; U) [en]"
152 * "Mozilla/5.0 (X11; FreeBSD i386; U) Opera 7.50 [en]"
153 * "Mozilla/4.0 (compatible; MSIE 6.0; X11; FreeBSD i386) Opera 7.50 [en]"
154 * "Opera/8.0 (Windows NT 5.1; U; ru)"
155 * "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0; en) Opera 8.0"
156 * "Opera/9.01 (X11; FreeBSD 6 i386; U; en)"
161 sizeof("Opera ") - 1,
164 /* "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)" */
167 sizeof("Mozilla/4.0 (compatible; ") - 1,
172 * "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.0.0) Gecko/20020610"
173 * "Mozilla/5.0 (Windows; U; Windows NT 5.1; ru-RU; rv:1.5) Gecko/20031006"
174 * "Mozilla/5.0 (Windows; U; Windows NT 5.1; ru-RU; rv:1.6) Gecko/20040206
176 * "Mozilla/5.0 (Windows; U; Windows NT 5.1; ru-RU; rv:1.7.8)
177 * Gecko/20050511 Firefox/1.0.4"
178 * "Mozilla/5.0 (X11; U; FreeBSD i386; en-US; rv:1.8.0.5) Gecko/20060729
183 sizeof("Mozilla/5.0 (") - 1,
188 * "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; ru-ru) AppleWebKit/125.2
189 * (KHTML, like Gecko) Safari/125.7"
190 * "Mozilla/5.0 (SymbianOS/9.1; U; en-us) AppleWebKit/413
191 * (KHTML, like Gecko) Safari/413"
192 * "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/418
193 * (KHTML, like Gecko) Safari/417.9.3"
194 * "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; ru-ru) AppleWebKit/418.8
195 * (KHTML, like Gecko) Safari/419.3"
199 sizeof("Mozilla/5.0 (") - 1,
200 sizeof("Safari/") - 1,
204 * "Mozilla/5.0 (compatible; Konqueror/3.1; Linux)"
205 * "Mozilla/5.0 (compatible; Konqueror/3.4; Linux) KHTML/3.4.2 (like Gecko)"
206 * "Mozilla/5.0 (compatible; Konqueror/3.5; FreeBSD) KHTML/3.5.1
211 sizeof("Mozilla/5.0 (compatible; ") - 1,
212 sizeof("Konqueror/") - 1,
220 static ngx_http_browser_variable_t ngx_http_browsers[] = {
221 { ngx_string("msie"), ngx_http_msie_variable, 0 },
222 { ngx_string("modern_browser"), ngx_http_browser_variable,
223 NGX_HTTP_MODERN_BROWSER },
224 { ngx_string("ancient_browser"), ngx_http_browser_variable,
225 NGX_HTTP_ANCIENT_BROWSER },
226 { ngx_null_string, NULL, 0 }
231 ngx_http_browser_variable(ngx_http_request_t *r, ngx_http_variable_value_t *v,
235 ngx_http_browser_conf_t *cf;
237 cf = ngx_http_get_module_loc_conf(r, ngx_http_browser_module);
239 rc = ngx_http_browser(r, cf);
241 if (data == NGX_HTTP_MODERN_BROWSER && rc == NGX_HTTP_MODERN_BROWSER) {
242 *v = *cf->modern_browser_value;
246 if (data == NGX_HTTP_ANCIENT_BROWSER && rc == NGX_HTTP_ANCIENT_BROWSER) {
247 *v = *cf->ancient_browser_value;
251 *v = ngx_http_variable_null_value;
257 ngx_http_browser(ngx_http_request_t *r, ngx_http_browser_conf_t *cf)
260 u_char *name, *ua, *last, c;
262 ngx_uint_t i, version, ver, scale;
263 ngx_http_modern_browser_t *modern;
265 if (r->headers_in.user_agent == NULL) {
266 if (cf->modern_unlisted_browsers) {
267 return NGX_HTTP_MODERN_BROWSER;
270 return NGX_HTTP_ANCIENT_BROWSER;
273 ua = r->headers_in.user_agent->value.data;
274 len = r->headers_in.user_agent->value.len;
277 if (cf->modern_browsers) {
278 modern = cf->modern_browsers->elts;
280 for (i = 0; i < cf->modern_browsers->nelts; i++) {
281 name = ua + modern[i].skip;
287 name = (u_char *) ngx_strstr(name, modern[i].name);
293 ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
294 "browser: \"%s\"", name);
296 name += modern[i].add;
302 ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
303 "version: \"%ui\" \"%s\"", modern[i].version, name);
309 while (name < last) {
313 if (c >= '0' && c <= '9') {
314 ver = ver * 10 + (c - '0');
319 version += ver * scale;
321 if (version > modern[i].version) {
322 return NGX_HTTP_MODERN_BROWSER;
333 version += ver * scale;
335 ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
336 "version: \"%ui\" \"%ui\"",
337 modern[i].version, version);
339 if (version >= modern[i].version) {
340 return NGX_HTTP_MODERN_BROWSER;
344 if (!cf->modern_unlisted_browsers) {
345 return NGX_HTTP_ANCIENT_BROWSER;
350 if (len > sizeof("Mozilla/4.72 ") - 1
351 && ngx_strncmp(ua, "Mozilla/", sizeof("Mozilla/") - 1) == 0
352 && ua[8] > '0' && ua[8] < '5')
354 return NGX_HTTP_ANCIENT_BROWSER;
358 if (cf->ancient_browsers) {
359 ancient = cf->ancient_browsers->elts;
361 for (i = 0; i < cf->ancient_browsers->nelts; i++) {
362 if (len >= ancient[i].len
363 && ngx_strstr(ua, ancient[i].data) != NULL)
365 return NGX_HTTP_ANCIENT_BROWSER;
370 if (cf->modern_unlisted_browsers) {
371 return NGX_HTTP_MODERN_BROWSER;
374 return NGX_HTTP_ANCIENT_BROWSER;
379 ngx_http_msie_variable(ngx_http_request_t *r, ngx_http_variable_value_t *v,
382 if (r->headers_in.msie) {
383 *v = ngx_http_variable_true_value;
387 *v = ngx_http_variable_null_value;
393 ngx_http_browser_add_variable(ngx_conf_t *cf)
395 ngx_http_browser_variable_t *var;
396 ngx_http_variable_t *v;
398 for (var = ngx_http_browsers; var->name.len; var++) {
400 v = ngx_http_add_variable(cf, &var->name, NGX_HTTP_VAR_CHANGEABLE);
405 v->get_handler = var->handler;
414 ngx_http_browser_create_conf(ngx_conf_t *cf)
416 ngx_http_browser_conf_t *conf;
418 conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_browser_conf_t));
420 return NGX_CONF_ERROR;
424 * set by ngx_pcalloc():
426 * conf->modern_browsers = NULL;
427 * conf->ancient_browsers = NULL;
428 * conf->modern_browser_value = NULL;
429 * conf->ancient_browser_value = NULL;
431 * conf->modern_unlisted_browsers = 0;
432 * conf->netscape4 = 0;
440 ngx_http_browser_merge_conf(ngx_conf_t *cf, void *parent, void *child)
442 ngx_http_browser_conf_t *prev = parent;
443 ngx_http_browser_conf_t *conf = child;
446 ngx_http_modern_browser_t *browsers, *opera;
449 * At the merge the skip field is used to store the browser slot,
450 * it will be used in sorting and then will overwritten
451 * with a real skip value. The zero value means Opera.
454 if (conf->modern_browsers == NULL) {
455 conf->modern_browsers = prev->modern_browsers;
458 browsers = conf->modern_browsers->elts;
460 for (i = 0; i < conf->modern_browsers->nelts; i++) {
461 if (browsers[i].skip == 0) {
467 * Opera may contain MSIE string, so if Opera was not enumerated
468 * as modern browsers, then add it and set a unreachable version
471 opera = ngx_array_push(conf->modern_browsers);
473 return NGX_CONF_ERROR;
477 opera->version = 4001000000U;
479 browsers = conf->modern_browsers->elts;
483 ngx_qsort(browsers, (size_t) conf->modern_browsers->nelts,
484 sizeof(ngx_http_modern_browser_t),
485 ngx_http_modern_browser_sort);
487 for (i = 0; i < conf->modern_browsers->nelts; i++) {
488 n = browsers[i].skip;
490 browsers[i].skip = ngx_http_modern_browser_masks[n].skip;
491 browsers[i].add = ngx_http_modern_browser_masks[n].add;
492 (void) ngx_cpystrn(browsers[i].name,
493 ngx_http_modern_browser_masks[n].name, 12);
497 if (conf->ancient_browsers == NULL) {
498 conf->ancient_browsers = prev->ancient_browsers;
501 if (conf->modern_browser_value == NULL) {
502 conf->modern_browser_value = prev->modern_browser_value;
505 if (conf->modern_browser_value == NULL) {
506 conf->modern_browser_value = &ngx_http_variable_true_value;
509 if (conf->ancient_browser_value == NULL) {
510 conf->ancient_browser_value = prev->ancient_browser_value;
513 if (conf->ancient_browser_value == NULL) {
514 conf->ancient_browser_value = &ngx_http_variable_true_value;
521 static int ngx_libc_cdecl
522 ngx_http_modern_browser_sort(const void *one, const void *two)
524 ngx_http_modern_browser_t *first = (ngx_http_modern_browser_t *) one;
525 ngx_http_modern_browser_t *second = (ngx_http_modern_browser_t *) two;
527 return (first->skip - second->skip);
532 ngx_http_modern_browser(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
534 ngx_http_browser_conf_t *bcf = conf;
538 ngx_uint_t i, n, version, ver, scale;
539 ngx_http_modern_browser_t *browser;
540 ngx_http_modern_browser_mask_t *mask;
542 value = cf->args->elts;
544 if (cf->args->nelts == 2) {
545 if (ngx_strcmp(value[1].data, "unlisted") == 0) {
546 bcf->modern_unlisted_browsers = 1;
550 return NGX_CONF_ERROR;
553 if (bcf->modern_browsers == NULL) {
554 bcf->modern_browsers = ngx_array_create(cf->pool, 5,
555 sizeof(ngx_http_modern_browser_t));
556 if (bcf->modern_browsers == NULL) {
557 return NGX_CONF_ERROR;
561 browser = ngx_array_push(bcf->modern_browsers);
562 if (browser == NULL) {
563 return NGX_CONF_ERROR;
566 mask = ngx_http_modern_browser_masks;
568 for (n = 0; mask[n].browser[0] != '\0'; n++) {
569 if (ngx_strcasecmp(mask[n].browser, value[1].data) == 0) {
574 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
575 "unknown browser name \"%V\"", &value[1]);
577 return NGX_CONF_ERROR;
582 * at this stage the skip field is used to store the browser slot,
583 * it will be used in sorting in merge stage and then will overwritten
593 for (i = 0; i < value[2].len; i++) {
595 c = value[2].data[i];
597 if (c >= '0' && c <= '9') {
598 ver = ver * 10 + (c - '0');
603 version += ver * scale;
609 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
610 "invalid browser version \"%V\"", &value[2]);
612 return NGX_CONF_ERROR;
615 version += ver * scale;
617 browser->version = version;
624 ngx_http_ancient_browser(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
626 ngx_http_browser_conf_t *bcf = conf;
628 ngx_str_t *value, *browser;
631 value = cf->args->elts;
633 for (i = 1; i < cf->args->nelts; i++) {
634 if (ngx_strcmp(value[i].data, "netscape4") == 0) {
639 if (bcf->ancient_browsers == NULL) {
640 bcf->ancient_browsers = ngx_array_create(cf->pool, 4,
642 if (bcf->ancient_browsers == NULL) {
643 return NGX_CONF_ERROR;
647 browser = ngx_array_push(bcf->ancient_browsers);
648 if (browser == NULL) {
649 return NGX_CONF_ERROR;
660 ngx_http_modern_browser_value(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
662 ngx_http_browser_conf_t *bcf = conf;
666 bcf->modern_browser_value = ngx_palloc(cf->pool,
667 sizeof(ngx_http_variable_value_t));
668 if (bcf->modern_browser_value == NULL) {
669 return NGX_CONF_ERROR;
672 value = cf->args->elts;
674 bcf->modern_browser_value->len = value[1].len;
675 bcf->modern_browser_value->valid = 1;
676 bcf->modern_browser_value->no_cacheable = 0;
677 bcf->modern_browser_value->not_found = 0;
678 bcf->modern_browser_value->data = value[1].data;
685 ngx_http_ancient_browser_value(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
687 ngx_http_browser_conf_t *bcf = conf;
691 bcf->ancient_browser_value = ngx_palloc(cf->pool,
692 sizeof(ngx_http_variable_value_t));
693 if (bcf->ancient_browser_value == NULL) {
694 return NGX_CONF_ERROR;
697 value = cf->args->elts;
699 bcf->ancient_browser_value->len = value[1].len;
700 bcf->ancient_browser_value->valid = 1;
701 bcf->ancient_browser_value->no_cacheable = 0;
702 bcf->ancient_browser_value->not_found = 0;
703 bcf->ancient_browser_value->data = value[1].data;