Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support query string encoding for control API #279 #287

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Support query string encoding for control API #279 #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 49 additions & 4 deletions src/ngx_http_vhost_traffic_status_display.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ static ngx_int_t
ngx_http_vhost_traffic_status_display_handler_control(ngx_http_request_t *r)
{
ngx_int_t size, rc;
ngx_str_t type, alpha, arg_cmd, arg_group, arg_zone;
ngx_str_t type, alpha, encoded_ch, arg_cmd, arg_group, arg_zone;
ngx_buf_t *b;
ngx_chain_t out;
ngx_slab_pool_t *shpool;
Expand Down Expand Up @@ -125,7 +125,8 @@ ngx_http_vhost_traffic_status_display_handler_control(ngx_http_request_t *r)

if (ngx_http_arg(r, (u_char *) "group", 5, &arg_group) == NGX_OK) {

if (arg_group.len == 1 && ngx_strncmp(arg_group.data, "*", 1) == 0)
if ((arg_group.len == 1 && ngx_strncmp(arg_group.data, "*", 1) == 0)
|| (arg_group.len == 3 && ngx_strncasecmp(arg_group.data, (u_char *) "%2A", 3) == 0))
{
control->group = -1;
}
Expand All @@ -134,13 +135,17 @@ ngx_http_vhost_traffic_status_display_handler_control(ngx_http_request_t *r)
{
control->group = NGX_HTTP_VHOST_TRAFFIC_STATUS_UPSTREAM_NO;
}
else if (arg_group.len == 14
else if ((arg_group.len == 14
&& ngx_strncasecmp(arg_group.data, (u_char *) "upstream@alone", 14) == 0)
|| (arg_group.len == 16
&& ngx_strncasecmp(arg_group.data, (u_char *) "upstream%40alone", 16) == 0))
{
control->group = NGX_HTTP_VHOST_TRAFFIC_STATUS_UPSTREAM_UA;
}
else if (arg_group.len == 14
else if ((arg_group.len == 14
&& ngx_strncasecmp(arg_group.data, (u_char *) "upstream@group", 14) == 0)
|| (arg_group.len == 16
&& ngx_strncasecmp(arg_group.data, (u_char *) "upstream%40group", 16) == 0))
{
control->group = NGX_HTTP_VHOST_TRAFFIC_STATUS_UPSTREAM_UG;
}
Expand Down Expand Up @@ -171,6 +176,46 @@ ngx_http_vhost_traffic_status_display_handler_control(ngx_http_request_t *r)
"display_handler_control::copy_str() failed");
}

ngx_str_set(&encoded_ch, "%2A");

rc = ngx_http_vhost_traffic_status_replace_strc(control->zone, &encoded_ch, '*');
if (rc != NGX_OK) {
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"display_handler_control::replace_strc() failed");
}

ngx_str_set(&encoded_ch, "%2a");

rc = ngx_http_vhost_traffic_status_replace_strc(control->zone, &encoded_ch, '*');
if (rc != NGX_OK) {
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"display_handler_control::replace_strc() failed");
}

ngx_str_set(&encoded_ch, "%3A");

rc = ngx_http_vhost_traffic_status_replace_strc(control->zone, &encoded_ch, ':');
if (rc != NGX_OK) {
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"display_handler_control::replace_strc() failed");
}

ngx_str_set(&encoded_ch, "%3a");

rc = ngx_http_vhost_traffic_status_replace_strc(control->zone, &encoded_ch, ':');
if (rc != NGX_OK) {
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"display_handler_control::replace_strc() failed");
}

ngx_str_set(&encoded_ch, "%40");

rc = ngx_http_vhost_traffic_status_replace_strc(control->zone, &encoded_ch, '@');
if (rc != NGX_OK) {
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"display_handler_control::replace_strc() failed");
}

(void) ngx_http_vhost_traffic_status_replace_chrc(control->zone, '@',
NGX_HTTP_VHOST_TRAFFIC_STATUS_KEY_SEPARATOR);

Expand Down
1 change: 1 addition & 0 deletions src/ngx_http_vhost_traffic_status_string.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ ngx_http_vhost_traffic_status_replace_strc(ngx_str_t *buf,
if (n > 0) {
buf->len = buf->len - (n * dst->len) + n;
}
*(buf->data + buf->len) = '\0';

return NGX_OK;
}
Expand Down
93 changes: 93 additions & 0 deletions t/007.control_status_group.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,3 +201,96 @@ __DATA__
'OK',
'{"cacheZones.*cache_(one|two)'
]

=== TEST 7: /status/control?cmd=status&group=upstream%40group&zone=%2A
--- http_config
vhost_traffic_status_zone;
upstream backend {
server localhost;
}
server {
server_name backend;
}
--- config
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_format json;
access_log off;
}
location /backend {
proxy_set_header Host backend;
proxy_pass http://backend;
}
--- user_files eval
[
['backend/file.txt' => 'upstream@group:OK']
]
--- request eval
[
'GET /backend/file.txt',
'GET /status/control?cmd=status&group=upstream%40group&zone=%2A',
]
--- response_body_like eval
[
'OK',
'{"upstreamZones.*backend'
]

=== TEST 8: /status/control?cmd=status&group=upstream%40group&zone=%2a
--- http_config
vhost_traffic_status_zone;
upstream backend {
server localhost;
}
server {
server_name backend;
}
--- config
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_format json;
access_log off;
}
location /backend {
proxy_set_header Host backend;
proxy_pass http://backend;
}
--- user_files eval
[
['backend/file.txt' => 'upstream@group:OK']
]
--- request eval
[
'GET /backend/file.txt',
'GET /status/control?cmd=status&group=upstream%40group&zone=%2a',
]
--- response_body_like eval
[
'OK',
'{"upstreamZones.*backend'
]

=== TEST 9: /status/control?cmd=status&group=server&zone=%3A%3Amain
--- http_config
vhost_traffic_status_zone;
--- config
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_format json;
access_log off;
}
--- user_files eval
[
['storage/control/file.txt' => 'server:OK']
]
--- request eval
[
'GET /storage/control/file.txt',
'GET /status/control?cmd=status&group=server&zone=%3A%3Amain',
]
--- response_body_like eval
[
'OK',
'hostName'
]

84 changes: 84 additions & 0 deletions t/008.control_status_zone.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,87 @@ __DATA__
'OK',
'{"cache_one"'
]

=== TEST 6: /status/control?cmd=status&group=filter&zone=storage%3A%3Alocalhost%40vol0
--- http_config
vhost_traffic_status_zone;
--- config
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_format json;
access_log off;
}
location ~ ^/storage/(.+)/.*$ {
set $volume $1;
vhost_traffic_status_filter_by_set_key $volume storage::$server_name;
}
--- user_files eval
[
['storage/vol0/file.txt' => 'filter:OK']
]
--- request eval
[
'GET /storage/vol0/file.txt',
'GET /status/control?cmd=status&group=filter&zone=storage%3A%3Alocalhost%40vol0',
]
--- response_body_like eval
[
'OK',
'{"vol0"'
]

=== TEST 7: /status/control?cmd=status&group=upstream%40alone&zone=127.0.0.1%3A1981
--- http_config
vhost_traffic_status_zone;
--- config
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_format json;
access_log off;
}
location /backend {
proxy_set_header Host backend;
proxy_pass http://127.0.0.1:1981;
}
--- tcp_listen: 1981
--- tcp_reply eval
"HTTP/1.1 200 OK\r\n\r\nupstream\@alone:OK"
--- request eval
[
'GET /backend/file.txt',
'GET /status/control?cmd=status&group=upstream%40alone&zone=127.0.0.1%3A1981',
]
--- response_body_like eval
[
'OK',
'{"server":"127.0.0.1:1981"'
]

=== TEST 8: /status/control?cmd=status&group=filter&zone=storage%3a%3alocalhost%40vol0
--- http_config
vhost_traffic_status_zone;
--- config
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_format json;
access_log off;
}
location ~ ^/storage/(.+)/.*$ {
set $volume $1;
vhost_traffic_status_filter_by_set_key $volume storage::$server_name;
}
--- user_files eval
[
['storage/vol0/file.txt' => 'filter:OK']
]
--- request eval
[
'GET /storage/vol0/file.txt',
'GET /status/control?cmd=status&group=filter&zone=storage%3A%3Alocalhost%40vol0',
]
--- response_body_like eval
[
'OK',
'{"vol0"'
]