This is an automated email from the ASF dual-hosted git repository. zwoop pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit afacb24414760b7029fafd7998a890fb97415dda Author: Leif Hedstrom <[email protected]> AuthorDate: Fri Jul 19 13:39:58 2019 -0600 Removes the hipes plugin. See #5395 --- doc/admin-guide/plugins/hipes.en.rst | 126 ----- doc/admin-guide/plugins/index.en.rst | 4 - .../ja/LC_MESSAGES/admin-guide/plugins/hipes.en.po | 215 -------- .../ja/LC_MESSAGES/admin-guide/plugins/index.en.po | 4 - plugins/Makefile.am | 1 - plugins/experimental/hipes/Makefile.inc | 20 - plugins/experimental/hipes/README | 25 - plugins/experimental/hipes/gen_escape.c | 46 -- plugins/experimental/hipes/hipes.cc | 552 --------------------- 9 files changed, 993 deletions(-) diff --git a/doc/admin-guide/plugins/hipes.en.rst b/doc/admin-guide/plugins/hipes.en.rst deleted file mode 100644 index 75d637d..0000000 --- a/doc/admin-guide/plugins/hipes.en.rst +++ /dev/null @@ -1,126 +0,0 @@ -.. _admin-plugins-hipes: - -HIPES Plugin -************ - -.. Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - - -This is a remap plugin used in the HIPES system. - -Configuration -============= - -``urlp:<name>`` - Default: ``url`` - Name of the query parameter for the service URL - -``path:<path>`` - Default: ``/`` - Path to use for the service URL - -``ssl`` - Default: ``no`` - Use SSL when connecting to the service - -``service`` - Service server, ``host[:port]`` - -``server`` - Default: ``hipes.yimg.com`` - Name of HIPES server, ``host[:port]`` - -``active_timeout`` - The active connection timeout in ms - -``no_activity_timeout`` - The no activity timeout in ms - -``connect_timeout`` - The connect timeout in ms - -``dns_timeout`` - The DNS timeout - -The timeout options override the server defaults (from -```records.config``), and -only apply to the connection to the specific "service" host. - -Notes on HIPES -============== - -HTTP Pipes (aka HIPES and pronounced "Hippies") allows data services to be pipelined together, as illustrated by the -example below. - -Example -======= -1. ATS is run on port 80 and apache HTTP web server is run on port 8080 on localhost (127.0.0.1) - -2. The HIPES plugin is used in ``remap.config`` :: - - map http://127.0.0.1/svc_case http://nosuchhost @plugin=hipes.so @pparam=service:127.0.0.1:8080 @pparam=path:svc_case.php @pparam=server:127.0.0.1 - map http://127.0.0.1/svc_reverse http://nosuchhost @plugin=hipes.so @pparam=service:127.0.0.1:8080 @pparam=path:svc_reverse.php @pparam=server:127.0.0.1 - map http://127.0.0.1/test.txt http://127.0.0.1:8080/test.txt - -3. The plugin remaps the incoming URL such as :: - - http://127.0.0.1/svc_reverse/svc_case;case=u/test.txt - -to the following :: - - http://127.0.0.1:8080/svc_reverse?url=http%3A%2F%2F127.0.0.1%2Fsvc_case%3Bcase%3Du%2Ftest.txt - -4. The service ``svc_reverse.php`` fetches the ``url`` from the ATS again and the plugin remaps the URL :: - - http://127.0.0.1/svc_case;case=u/test.txt - -to this URL :: - - http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt - -5. In this example, the service ``svc_case.php`` fetches and transforms the response of ``http://127.0.0.1/test.txt`` -(which ATS proxies the request to a local file) to upper case. And subsequently the service ``svc_reverse.php`` receives -the response and reverse the order before the response is sent back to the client by ATS. - -Notes on reducing traffic -========================= - -There can be significant overhead using HIPES because the data can traverse through ATS many times. Caching can be -important to reduce traffic to services/through ATS and can be achieved via a proper ``Cache-Control`` header returned -by the services. Another way to reduce traffic through ATS is to have ATS to return 302 redirects to url for the -requests made by service, instead of proxying the requests to that url. However, the service must then be able to follow -the redirect. The down side is that we cannot use ATS to cache intermediate results. Below is an example of using -redirect. - -Modification to above example to reduce traffic using redirect -============================================================== - -1. The service ``svc_reverse.php`` is modified to add a header of ``X-HIPES-Redirect: 2`` to the request made against -``url``. - -2. HIPES plugin will instruct ATS to return a redirect response to this url :: - - http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt - -for the following request :: - - http://127.0.0.1/svc_case;case=u/test.txt - -3. The service ``svc_reverse.php`` is also modified to follow the redirect. Thus the response of the service of -``svc_case.php`` will not pass through ATS and will pass to ``svc_reverse.php`` service instead. - diff --git a/doc/admin-guide/plugins/index.en.rst b/doc/admin-guide/plugins/index.en.rst index fecae96..e2ff09a 100644 --- a/doc/admin-guide/plugins/index.en.rst +++ b/doc/admin-guide/plugins/index.en.rst @@ -150,7 +150,6 @@ directory of the |TS| source tree. Experimental plugins can be compiled by passi GeoIP ACL <geoip_acl.en> FQ Pacing <fq_pacing.en> Header Frequency <header_freq.en> - HIPES <hipes.en> Hook Trace <hook-trace.en> JA3 Fingerprint <ja3_fingerprint.en> Memcache <memcache.en> @@ -190,9 +189,6 @@ directory of the |TS| source tree. Experimental plugins can be compiled by passi :doc:`Header Frequency <header_freq.en>` Count the frequency of headers. -:doc:`HIPES <hipes.en>` - Adds support for HTTP Pipes. - :doc:`JA3 Fingerprint <ja3_fingerprint.en>` Calculates JA3 Fingerprints for incoming SSL traffic. diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/hipes.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/hipes.en.po deleted file mode 100644 index a0e6c62..0000000 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/hipes.en.po +++ /dev/null @@ -1,215 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: Apache Traffic Server 6.2\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2016-06-30 14:07+0900\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" -"Language-Team: LANGUAGE <[email protected]>\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.2.0\n" - -#: ../../../admin-guide/plugins/hipes.en.rst:4 -msgid "HIPES Plugin" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:24 -msgid "This is a remap plugin used in the HIPES system." -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:27 -msgid "Configuration" -msgstr "設定" - -#: ../../../admin-guide/plugins/hipes.en.rst:31 -msgid "``urlp:<name>``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:30 -msgid "Default: ``url`` Name of the query parameter for the service URL" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:35 -msgid "``path:<path>``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:34 -msgid "Default: ``/`` Path to use for the service URL" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:39 -#, fuzzy -msgid "``ssl``" -msgstr "ssl" - -#: ../../../admin-guide/plugins/hipes.en.rst:38 -msgid "Default: ``no`` Use SSL when connecting to the service" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:42 -msgid "``service``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:42 -msgid "Service server, ``host[:port]``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:46 -msgid "``server``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:45 -msgid "Default: ``hipes.yimg.com`` Name of HIPES server, ``host[:port]``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:49 -msgid "``active_timeout``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:49 -msgid "The active connection timeout in ms" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:52 -msgid "``no_activity_timeout``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:52 -msgid "The no activity timeout in ms" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:55 -msgid "``connect_timeout``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:55 -msgid "The connect timeout in ms" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:58 -msgid "``dns_timeout``" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:58 -msgid "The DNS timeout" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:60 -msgid "" -"The timeout options override the server defaults (from ```records." -"config``), and only apply to the connection to the specific \"service\" " -"host." -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:65 -msgid "Notes on HIPES" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:67 -msgid "" -"HTTP Pipes (aka HIPES and pronounced \"Hippies\") allows data services to " -"be pipelined together, as illustrated by the example below." -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:71 -msgid "Example" -msgstr "例" - -#: ../../../admin-guide/plugins/hipes.en.rst:72 -msgid "" -"ATS is run on port 80 and apache HTTP web server is run on port 8080 on " -"localhost (127.0.0.1)" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:74 -msgid "The HIPES plugin is used in ``remap.config`` ::" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:80 -msgid "The plugin remaps the incoming URL such as ::" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:84 -msgid "to the following ::" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:88 -msgid "" -"The service ``svc_reverse.php`` fetches the ``url`` from the ATS again and " -"the plugin remaps the URL ::" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:92 -msgid "to this URL ::" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:96 -msgid "" -"5. In this example, the service ``svc_case.php`` fetches and transforms the " -"response of ``http://127.0.0.1/test.txt`` (which ATS proxies the request to " -"a local file) to upper case. And subsequently the service ``svc_reverse." -"php`` receives the response and reverse the order before the response is " -"sent back to the client by ATS." -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:101 -msgid "Notes on reducing traffic" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:103 -msgid "" -"There can be significant overhead using HIPES because the data can traverse " -"through ATS many times. Caching can be important to reduce traffic to " -"services/through ATS and can be achieved via a proper ``Cache-Control`` " -"header returned by the services. Another way to reduce traffic through ATS " -"is to have ATS to return 302 redirects to url for the requests made by " -"service, instead of proxying the requests to that url. However, the service " -"must then be able to follow the redirect. The down side is that we cannot " -"use ATS to cache intermediate results. Below is an example of using " -"redirect." -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:111 -msgid "Modification to above example to reduce traffic using redirect" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:113 -msgid "" -"1. The service ``svc_reverse.php`` is modified to add a header of ``X-HIPES-" -"Redirect: 2`` to the request made against ``url``." -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:116 -msgid "" -"HIPES plugin will instruct ATS to return a redirect response to this url ::" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:120 -msgid "for the following request ::" -msgstr "" - -#: ../../../admin-guide/plugins/hipes.en.rst:124 -msgid "" -"3. The service ``svc_reverse.php`` is also modified to follow the " -"redirect. Thus the response of the service of ``svc_case.php`` will not " -"pass through ATS and will pass to ``svc_reverse.php`` service instead." -msgstr "" diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/index.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/index.en.po index 7f2da51..76d9172 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/index.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/index.en.po @@ -251,10 +251,6 @@ msgid "Deny or allow requests based on the source IP geo-location." msgstr "" #: ../../../admin-guide/plugins/index.en.rst:165 -msgid ":doc:`HIPES <hipes.en>`" -msgstr "" - -#: ../../../admin-guide/plugins/index.en.rst:165 msgid "Adds support for HTTP Pipes." msgstr "" diff --git a/plugins/Makefile.am b/plugins/Makefile.am index 1cc1467..d11e100 100644 --- a/plugins/Makefile.am +++ b/plugins/Makefile.am @@ -65,7 +65,6 @@ include experimental/custom_redirect/Makefile.inc include experimental/fq_pacing/Makefile.inc include experimental/geoip_acl/Makefile.inc include experimental/header_freq/Makefile.inc -include experimental/hipes/Makefile.inc include experimental/hook-trace/Makefile.inc include experimental/inliner/Makefile.inc include experimental/memcache/Makefile.inc diff --git a/plugins/experimental/hipes/Makefile.inc b/plugins/experimental/hipes/Makefile.inc deleted file mode 100644 index 412cd02..0000000 --- a/plugins/experimental/hipes/Makefile.inc +++ /dev/null @@ -1,20 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -pkglib_LTLIBRARIES += experimental/hipes/hipes.la - -experimental_hipes_hipes_la_SOURCES = \ - experimental/hipes/hipes.cc diff --git a/plugins/experimental/hipes/README b/plugins/experimental/hipes/README deleted file mode 100644 index b12f722..0000000 --- a/plugins/experimental/hipes/README +++ /dev/null @@ -1,25 +0,0 @@ -This plugin implements the HIPES system. - -Plugin configuration --------------------- - - server:<host> Name of the server to send this request to - urlp:<name> Name of the query parameter for the service URL [url] - path:<path> Path to use for the service URL [/] - ssl Use SSL when connecting to the service [no] - service Service server, host[:port] [no default] - server Name of HIPES server, host[:port] [hipes.yimg.com] - active_timeout The active connection timeout in ms [no default] - no_activity_timeout The no activity timeout in ms [no default] - connect_timeout The connect timeout in ms [no default] - dns_timeout The DNS timeout [no default] - - -The timeout options override the server defaults (from records.config), -and only apply to the connection to the specific "service" host. - -RELEASES --------- - -Version 1.0 (??/??/10) - - First release. diff --git a/plugins/experimental/hipes/gen_escape.c b/plugins/experimental/hipes/gen_escape.c deleted file mode 100644 index 3f1b346..0000000 --- a/plugins/experimental/hipes/gen_escape.c +++ /dev/null @@ -1,46 +0,0 @@ -/** @file - - @section license License - - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -*/ -#include <stdio.h> -#include <string.h> - -int -main() -{ - unsigned char codes[32]; - unsigned char hex; - int c; - - memset(codes, 0, sizeof(codes)); - - for (c = 0; c <= 255; ++c) { - if (((c >= '0') && (c <= '9')) || ((c >= 'A') && (c <= 'Z')) || ((c >= 'a') && (c <= 'z')) || ((c == '_')) || ((c == '-')) || - ((c == '.'))) { - } else { - codes[c / 8] |= (1 << (7 - c % 8)); - } - } - - for (hex = 0; hex < 32; ++hex) { - printf("0x%02lX, ", codes[hex]); - if (!((hex + 1) % 4)) - printf("\n"); - } -} diff --git a/plugins/experimental/hipes/hipes.cc b/plugins/experimental/hipes/hipes.cc deleted file mode 100644 index c90148a..0000000 --- a/plugins/experimental/hipes/hipes.cc +++ /dev/null @@ -1,552 +0,0 @@ -/** @file - - @section license License - - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -*/ -#include <cstdio> -#include <sys/time.h> -#include <cstring> -#include <cstdlib> -#include <string> - -#include <ts/ts.h> -#include <ts/remap.h> - -static const char *PLUGIN_NAME = "hipes"; -static const char *HIPES_SERVER_NAME = "hipes.example.com"; - -static const int MAX_PATH_SIZE = 2048; -static const int MAX_REDIRECT_URL = 2048; - -/////////////////////////////////////////////////////////////////////////////// -// Escape a URL string. -// -int -escapify_url(const char *src, int src_len, char *dst, int dst_len) -{ - // This bitmap is generated using the gen_escape.c prog. - static unsigned char codes_to_escape[32] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xF9, 0x00, 0x3F, 0x80, 0x00, 0x00, - 0x1E, 0x80, 0x00, 0x00, 0x1F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, - 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; - - static char hex_digit[16] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'}; - - const char *from = src; - char *to = dst; - int len = 0; - - // Sanity check - if (!src) { - return -1; - } - - while (from < (src + src_len)) { - unsigned char c = *from; - - if (len >= dst_len) { - return -1; // Does not fit.... abort! - } - - if (codes_to_escape[c / 8] & (1 << (7 - c % 8))) { - *to++ = '%'; - *to++ = hex_digit[c / 16]; - *to++ = hex_digit[c % 16]; - len += 3; - } else { - *to++ = *from; - ++len; - } - ++from; - } - *to = '\0'; - - return len; -} - -/////////////////////////////////////////////////////////////////////////////// -// Unescape a string. Have to make sure the destination buffer is at least as -// long as the source buffer. -// -char * -unescapify(const char *src, char *dst, int len) -{ - const char *cur = src; - char *next; - char subStr[3]; - int size; - - subStr[2] = '\0'; - while ((next = (char *)memchr(cur, '%', len))) { - size = next - cur; - if (size > 0) { - memcpy(dst, cur, size); - dst += size; - cur += size; - len -= size; - } - - if (len > 2 && (*cur + 1) != '\0' && *(cur + 2) != '\0') { - subStr[0] = *(++cur); - subStr[1] = *(++cur); - len -= 2; - *dst = (char)strtol(subStr, (char **)nullptr, 16); - } else { - *dst = *cur; - } - ++dst; - ++cur; - --len; - } - - if (len > 0) { - memcpy(dst, cur, len); - dst += len; - } - - return dst; -} - -/////////////////////////////////////////////////////////////////////////////// -// Class encapsulating one service configuration -// -struct HIPESService { - HIPESService() - : url_param("url"), - path(""), - svc_server(""), - - hipes_server(HIPES_SERVER_NAME), - - x_hipes_header("X-HIPES-Redirect"){}; - - std::string url_param; - std::string path; - std::string svc_server; - int svc_port = 80; - bool ssl = false; - std::string hipes_server; - int hipes_port = 80; - unsigned int default_redirect_flag = 1; - std::string x_hipes_header; - int active_timeout = -1; - int no_activity_timeout = -1; - int connect_timeout = -1; - int dns_timeout = -1; -}; - -/////////////////////////////////////////////////////////////////////////////// -// Initialize the plugin. -// -TSReturnCode -TSRemapInit(TSRemapInterface *api_info, char *errbuf, int errbuf_size) -{ - if (!api_info) { - strncpy(errbuf, "[tsremap_init] - Invalid TSRemapInterface argument", errbuf_size - 1); - return TS_ERROR; - } - - if (api_info->tsremap_version < TSREMAP_VERSION) { - snprintf(errbuf, errbuf_size, "[tsremap_init] - Incorrect API version %ld.%ld", api_info->tsremap_version >> 16, - (api_info->tsremap_version & 0xffff)); - return TS_ERROR; - } - - TSDebug(PLUGIN_NAME, "plugin is successfully initialized"); - return TS_SUCCESS; -} - -/////////////////////////////////////////////////////////////////////////////// -// One instance per remap.config invocation. -// -TSReturnCode -TSRemapNewInstance(int argc, char *argv[], void **ih, char * /* errbuf ATS_UNUSED */, int /* errbuf_size ATS_UNUSED */) -{ - HIPESService *ri = new HIPESService(); - - *ih = (void *)ri; - - if (ri == nullptr) { - TSError("[hipes] Unable to create remap instance"); - return TS_ERROR; - } - - for (int ix = 2; ix < argc; ++ix) { - std::string arg = argv[ix]; - std::string::size_type sep = arg.find_first_of(':'); - - if (sep == std::string::npos) { - TSError("[hipes] Malformed options in url_remap: %s", argv[ix]); - } else { - std::string arg_val = arg.substr(sep + 1, std::string::npos); - - if (arg.compare(0, 4, "urlp") == 0) { - ri->url_param = arg_val; - } else if (arg.compare(0, 4, "path") == 0) { - ri->path = arg_val; - if (arg_val[0] == '/') { - ri->path = arg_val.substr(1); - } else { - ri->path = arg_val; - } - } else if (arg.compare(0, 3, "ssl") == 0) { - ri->ssl = true; - } else if (arg.compare(0, 7, "service") == 0) { - std::string::size_type port = arg_val.find_first_of(':'); - - if (port == std::string::npos) { - ri->svc_server = arg_val; - } else { - ri->svc_server = arg_val.substr(0, port); - ri->svc_port = atoi(arg_val.substr(port + 1).c_str()); - } - } else if (arg.compare(0, 6, "server") == 0) { - std::string::size_type port = arg_val.find_first_of(':'); - - if (port == std::string::npos) { - ri->hipes_server = arg_val; - } else { - ri->hipes_server = arg_val.substr(0, port); - ri->hipes_port = atoi(arg_val.substr(port + 1).c_str()); - } - } else if (arg.compare(0, 14, "active_timeout") == 0) { - ri->active_timeout = atoi(arg_val.c_str()); - } else if (arg.compare(0, 19, "no_activity_timeout") == 0) { - ri->no_activity_timeout = atoi(arg_val.c_str()); - } else if (arg.compare(0, 15, "connect_timeout") == 0) { - ri->connect_timeout = atoi(arg_val.c_str()); - } else if (arg.compare(0, 11, "dns_timeout") == 0) { - ri->dns_timeout = atoi(arg_val.c_str()); - } else { - TSError("[hipes] Unknown url_remap option: %s", argv[ix]); - } - } - } - - return TS_SUCCESS; -} - -void -TSRemapDeleteInstance(void *ih) -{ - HIPESService *ri = static_cast<HIPESService *>(ih); - - delete ri; -} - -/////////////////////////////////////////////////////////////////////////////// -// This is the main "entry" point for the plugin, called for every request. -// -TSRemapStatus -TSRemapDoRemap(void *ih, TSHttpTxn rh, TSRemapRequestInfo *rri) -{ - const char *slash; - char *ptr; - HIPESService *h_conf = (HIPESService *)ih; - - char new_query[MAX_PATH_SIZE]; - int new_query_size; - char redirect_url[MAX_REDIRECT_URL]; - int redirect_url_size; - - if (nullptr == h_conf) { - TSDebug(PLUGIN_NAME, "Falling back to default URL on URL remap without rules"); - return TSREMAP_NO_REMAP; - } - - int param_len = 0; - const char *param = TSUrlHttpParamsGet(rri->requestBufp, rri->requestUrl, ¶m_len); - - // Make sure we have a matrix parameter, anything without is a bogus request. - if (param_len <= 0) { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_BAD_REQUEST); - return TSREMAP_NO_REMAP; - } - - if (param_len > MAX_PATH_SIZE) { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_REQUEST_URI_TOO_LONG); - return TSREMAP_NO_REMAP; - } - - // If there is a '/' in the matrix parameters, we know there are multiple service requests in - // the incoming URL, so nibble off the first one, and pass the rest as a HIPES URL to the service. - if ((slash = static_cast<const char *>(memchr(param, '/', param_len)))) { - char svc_url[MAX_PATH_SIZE + 1]; - char svc_url_esc[MAX_PATH_SIZE + 1]; - int len, query_len; - - // Create the escaped URL, which gets passed over to the service as a url= param. - char port[6]; - snprintf(port, 6, ":%d", h_conf->hipes_port); - - if (h_conf->hipes_port != 80) { - len = 8 + h_conf->hipes_server.size() + strlen(port) + (param_len - (slash - param) - 1); - } else { - len = 8 + h_conf->hipes_server.size() + (param_len - (slash - param) - 1); - } - if (len > MAX_PATH_SIZE) { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_REQUEST_URI_TOO_LONG); - return TSREMAP_NO_REMAP; - } - if (h_conf->hipes_port != 80) { - snprintf(svc_url, MAX_PATH_SIZE, "http://%s%s/%.*s";, h_conf->hipes_server.c_str(), port, len, slash + 1); - } else { - snprintf(svc_url, MAX_PATH_SIZE, "http://%s/%.*s";, h_conf->hipes_server.c_str(), len, slash + 1); - } - TSDebug(PLUGIN_NAME, "Service URL is %s", svc_url); - - len = escapify_url(svc_url, len, svc_url_esc, MAX_PATH_SIZE); - if (len < 0) { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_BAD_REQUEST); - return TSREMAP_NO_REMAP; - } - TSDebug(PLUGIN_NAME, "Escaped service URL is %s(%d)", svc_url_esc, len); - - // Prepare the new query arguments, make sure it fits - if (((slash - param) + 2 + (int)h_conf->url_param.size() + len) > MAX_PATH_SIZE) { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_REQUEST_URI_TOO_LONG); - return TSREMAP_NO_REMAP; - } - - query_len = (slash - param); - memcpy(new_query, param, query_len); - ptr = new_query; - while ((ptr = static_cast<char *>(memchr(ptr, ';', (new_query + query_len) - ptr)))) { - *ptr = '&'; - } - new_query[query_len++] = '&'; - memcpy(new_query + query_len, h_conf->url_param.c_str(), h_conf->url_param.size()); - query_len += h_conf->url_param.size(); - new_query[query_len++] = '='; - - memcpy(new_query + query_len, svc_url_esc, len); - new_query_size = query_len + len; - TSDebug(PLUGIN_NAME, "New query is %.*s(%d)", new_query_size, new_query, new_query_size); - } else { - // This is the "final" step in this HIPES URL, so don't point back to HIPES (or we'll never leave) - new_query_size = param_len; - memcpy(new_query, param, param_len); - ptr = new_query; - while ((ptr = static_cast<char *>(memchr(ptr, ';', (new_query + new_query_size) - ptr)))) { - *ptr = '&'; - } - TSDebug(PLUGIN_NAME, "New query is %.*s(%d)", new_query_size, new_query, new_query_size); - } - - // Test if we should redirect or not - bool do_redirect = false; - int redirect_flag = h_conf->default_redirect_flag; - char *pos = new_query; - - while (pos && (pos = (char *)memchr(pos, '_', new_query_size - (pos - new_query)))) { - if (pos) { - ++pos; - if ((new_query_size - (pos - new_query)) < 10) { // redirect=n - pos = nullptr; - } else { - if ((*pos == 'r') && (!strncmp(pos, "redirect=", 9))) { - redirect_flag = *(pos + 9) - '0'; - if ((redirect_flag < 0) || (redirect_flag > 2)) { - redirect_flag = h_conf->default_redirect_flag; - } - TSDebug(PLUGIN_NAME, "Found _redirect flag in URL: %d", redirect_flag); - pos = nullptr; - } - } - } - } - - if (redirect_flag > 0) { - // Now check the incoming request header, and match up. - TSMBuffer bufp; - TSMLoc hdr_loc, field_loc; - bool has_error = false; - - if (TSHttpTxnClientReqGet(rh, &bufp, &hdr_loc) == TS_SUCCESS) { - field_loc = TSMimeHdrFieldFind(bufp, hdr_loc, h_conf->x_hipes_header.c_str(), h_conf->x_hipes_header.size()); - if (field_loc) { - int hdr_flag; - - hdr_flag = TSMimeHdrFieldValueIntGet(bufp, hdr_loc, field_loc, 0); - // Alright, now match up this header flag with the request (or default) flag - TSDebug(PLUGIN_NAME, "Extracted %s header with value %d", h_conf->x_hipes_header.c_str(), hdr_flag); - switch (redirect_flag) { - case 1: - if (hdr_flag == 2) { - do_redirect = true; - } // Everything else is a "no" - break; - case 2: - if (hdr_flag == 2) { - do_redirect = true; - } else { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_BAD_REQUEST); - has_error = true; - } - break; - default: - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_BAD_REQUEST); - has_error = true; - break; - } - TSHandleMLocRelease(bufp, hdr_loc, field_loc); - } else { - if (redirect_flag == 2) { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_BAD_REQUEST); - has_error = true; - } - } - TSHandleMLocRelease(bufp, TS_NULL_MLOC, hdr_loc); - } else { - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_BAD_REQUEST); - has_error = true; - } - if (has_error) { - return TSREMAP_NO_REMAP; - } - } - - // If we redirect, just generate a 302 URL, otherwise update the RRI struct properly. - if (do_redirect) { - int len; - - if (h_conf->ssl) { - // https://<host>:<port>/<path>?<query?\0 - len = 5 + 3 + h_conf->svc_server.size() + 6 + 1 + h_conf->path.size() + 1 + new_query_size + 1; - } else { - // http://<host>:<port>/<path>?<query?\0 - len = 4 + 3 + h_conf->svc_server.size() + 6 + 1 + h_conf->path.size() + 1 + new_query_size + 1; - } - - if (len > MAX_REDIRECT_URL) { - TSError("[hipes] Redirect in HIPES URL too long"); - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_REQUEST_URI_TOO_LONG); - } else { - int port = -1; - - pos = redirect_url; - - // HTTP vs HTTPS - if (h_conf->ssl) { - memcpy(pos, "https://";, 8); - pos += 8; - if (h_conf->svc_port != 443) { - port = h_conf->svc_port; - } - } else { - memcpy(pos, "http://";, 7); - pos += 7; - if (h_conf->svc_port != 80) { - port = h_conf->svc_port; - } - } - - // Server - memcpy(pos, h_conf->svc_server.c_str(), h_conf->svc_server.size()); - pos += h_conf->svc_server.size(); - - // Port - if (port != -1) { - pos += snprintf(pos, 6, ":%d", port); - } - - // Path - *(pos++) = '/'; - if (h_conf->path.size() > 0) { - memcpy(pos, h_conf->path.c_str(), h_conf->path.size()); - pos += h_conf->path.size(); - } - - // Query - if (new_query_size > 0) { - *(pos++) = '?'; - memcpy(pos, new_query, new_query_size); - pos += new_query_size; - } - - // NULL terminate the URL. - *pos = '\0'; - - redirect_url_size = pos - redirect_url + 1; - TSDebug(PLUGIN_NAME, "Redirecting to %.*s", redirect_url_size, redirect_url); - const char *start = redirect_url; - const char *end = start + redirect_url_size; - rri->redirect = 1; - TSUrlParse(rri->requestBufp, rri->requestUrl, &start, end); - TSHttpTxnStatusSet(rh, TS_HTTP_STATUS_MOVED_TEMPORARILY); - } - } else { // Not a redirect, so proceed normally - // Set timeouts (if requested) - if (h_conf->active_timeout > -1) { - TSDebug(PLUGIN_NAME, "Setting active timeout to %d", h_conf->active_timeout); - TSHttpTxnActiveTimeoutSet(rh, h_conf->active_timeout); - } - if (h_conf->no_activity_timeout > -1) { - TSDebug(PLUGIN_NAME, "Setting no activity timeout to %d", h_conf->no_activity_timeout); - TSHttpTxnNoActivityTimeoutSet(rh, h_conf->no_activity_timeout); - } - if (h_conf->connect_timeout > -1) { - TSDebug(PLUGIN_NAME, "Setting connect timeout to %d", h_conf->connect_timeout); - TSHttpTxnConnectTimeoutSet(rh, h_conf->connect_timeout); - } - if (h_conf->dns_timeout > -1) { - TSDebug(PLUGIN_NAME, "Setting DNS timeout to %d", h_conf->dns_timeout); - TSHttpTxnDNSTimeoutSet(rh, h_conf->dns_timeout); - } - - // Set server ... - TSUrlHostSet(rri->requestBufp, rri->requestUrl, h_conf->svc_server.c_str(), h_conf->svc_server.size()); - TSDebug(PLUGIN_NAME, "New server is %.*s", (int)h_conf->svc_server.size(), h_conf->svc_server.c_str()); - - // ... and port - TSUrlPortSet(rri->requestBufp, rri->requestUrl, h_conf->svc_port); - TSDebug(PLUGIN_NAME, "New port is %d", h_conf->svc_port); - - // Update the path - TSUrlPathSet(rri->requestBufp, rri->requestUrl, h_conf->path.c_str(), h_conf->path.size()); - TSDebug(PLUGIN_NAME, "New path is %.*s", (int)h_conf->path.size(), h_conf->path.c_str()); - - // Enable SSL? - if (h_conf->ssl) { - TSUrlSchemeSet(rri->requestBufp, rri->requestUrl, "https", 5); - } - - // Clear previous matrix params - TSUrlHttpParamsSet(rri->requestBufp, rri->requestUrl, "", 0); - - // set query - TSUrlHttpQuerySet(rri->requestBufp, rri->requestUrl, new_query, new_query_size); - } - - // Step 3: Profit - return TSREMAP_DID_REMAP; -} - -/* - local variables: - mode: C++ - indent-tabs-mode: nil - c-basic-offset: 2 - c-comment-only-line-offset: 0 - c-file-offsets: ((statement-block-intro . +) - (label . 0) - (statement-cont . +) - - end: - - Indent with: /usr/bin/indent -ncs -nut -npcs -l 120 logstats.cc -*/
