You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by je...@apache.org on 2011/03/24 22:24:44 UTC
svn commit: r1085149 - in /trafficserver/plugins/cacheurl: ./ CHANGES
LICENSE Makefile NOTICE README cacheurl.c cacheurl.config.example
Author: jesus
Date: Thu Mar 24 21:24:44 2011
New Revision: 1085149
URL: http://svn.apache.org/viewvc?rev=1085149&view=rev
Log:
pursuant to a variety of conversations, here's the cacheurl plugin
Added:
trafficserver/plugins/cacheurl/
trafficserver/plugins/cacheurl/CHANGES
trafficserver/plugins/cacheurl/LICENSE
trafficserver/plugins/cacheurl/Makefile
trafficserver/plugins/cacheurl/NOTICE
trafficserver/plugins/cacheurl/README
trafficserver/plugins/cacheurl/cacheurl.c
trafficserver/plugins/cacheurl/cacheurl.config.example
Added: trafficserver/plugins/cacheurl/CHANGES
URL: http://svn.apache.org/viewvc/trafficserver/plugins/cacheurl/CHANGES?rev=1085149&view=auto
==============================================================================
--- trafficserver/plugins/cacheurl/CHANGES (added)
+++ trafficserver/plugins/cacheurl/CHANGES Thu Mar 24 21:24:44 2011
@@ -0,0 +1,3 @@
+Changes with Apache Traffic Server cacheurl 1.0
+
+ *) This is a basic plugin for changing the cache key for a request
Added: trafficserver/plugins/cacheurl/LICENSE
URL: http://svn.apache.org/viewvc/trafficserver/plugins/cacheurl/LICENSE?rev=1085149&view=auto
==============================================================================
--- trafficserver/plugins/cacheurl/LICENSE (added)
+++ trafficserver/plugins/cacheurl/LICENSE Thu Mar 24 21:24:44 2011
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
Added: trafficserver/plugins/cacheurl/Makefile
URL: http://svn.apache.org/viewvc/trafficserver/plugins/cacheurl/Makefile?rev=1085149&view=auto
==============================================================================
--- trafficserver/plugins/cacheurl/Makefile (added)
+++ trafficserver/plugins/cacheurl/Makefile Thu Mar 24 21:24:44 2011
@@ -0,0 +1,14 @@
+# If tsxs is not in your path, then change this by running
+# make TSXS=/path/to/ts/bin/tsxs target
+TSXS?=tsxs
+
+%.so: %.c
+ $(TSXS) -c $< -o $@
+
+all: cacheurl.so
+
+install: all
+ $(TSXS) -i -o cacheurl.so
+
+clean:
+ rm -f *.lo *.so
Added: trafficserver/plugins/cacheurl/NOTICE
URL: http://svn.apache.org/viewvc/trafficserver/plugins/cacheurl/NOTICE?rev=1085149&view=auto
==============================================================================
--- trafficserver/plugins/cacheurl/NOTICE (added)
+++ trafficserver/plugins/cacheurl/NOTICE Thu Mar 24 21:24:44 2011
@@ -0,0 +1,10 @@
+Apache Traffic Server
+Copyright 2011 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+Google (http://www.google.com)
+~~~
+
+Cacheurl Plugin developed by OmniTI on behalf of Google.
+Copyright (C) 2011 Google Inc.
Added: trafficserver/plugins/cacheurl/README
URL: http://svn.apache.org/viewvc/trafficserver/plugins/cacheurl/README?rev=1085149&view=auto
==============================================================================
--- trafficserver/plugins/cacheurl/README (added)
+++ trafficserver/plugins/cacheurl/README Thu Mar 24 21:24:44 2011
@@ -0,0 +1,25 @@
+This plugin allows you to change the key that is used for caching a request.
+It is designed so that multiple requests that have different URLs but the same
+content (for example, site mirrors) need be cached only once.
+
+Installation:
+
+ make
+ sudo make install
+
+If you don't have the traffic server binaries in your path, then you will need
+to specify the path to tsxs manually:
+
+ make TSXS=/opt/ts/bin/tsxs
+ sudo make TSXS=/opt/ts/bin/tsxs install
+
+Configuration:
+
+ Create a cacheurl.config file in the plugin directory with the url
+ patterns to match. See the cacheurl.config.example file for what to put in
+ this file.
+
+ Add the plugin to your plugins.conf file: cacheurl.so
+
+Start traffic server. Any rewritten URLs will be written to cacheurl.log in
+the log directory by default.
Added: trafficserver/plugins/cacheurl/cacheurl.c
URL: http://svn.apache.org/viewvc/trafficserver/plugins/cacheurl/cacheurl.c?rev=1085149&view=auto
==============================================================================
--- trafficserver/plugins/cacheurl/cacheurl.c (added)
+++ trafficserver/plugins/cacheurl/cacheurl.c Thu Mar 24 21:24:44 2011
@@ -0,0 +1,394 @@
+/*
+ * 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.
+ */
+
+/* cacheurl.c - Plugin to modify the URL used as a cache key for certain
+ * requests, without modifying the URL used for actually fetching data from
+ * the origin server.
+ */
+
+#include <ts/ts.h>
+#include <stdio.h>
+#include <pcre.h>
+#include <string.h>
+
+#define TOKENCOUNT 10
+#define OVECOUNT 30
+#define PATTERNCOUNT 30
+#define PLUGIN_NAME "cacheurl"
+
+typedef struct {
+ pcre *re; /* Compiled regular expression */
+ int tokcount; /* Token count */
+ char *pattern; /* Pattern string */
+ char *replacement; /* Replacement string */
+ int *tokens; /* Array of $x token values */
+ int *tokenoffset; /* Array of $x token offsets */
+} regex_info;
+
+static regex_info *pr_list[PATTERNCOUNT]; /* Pattern/replacement list */
+static int patterncount;
+
+static TSTextLogObject log;
+
+static int regex_substitute(char **buf, char *str, regex_info *info) {
+ int matchcount;
+ int ovector[OVECOUNT]; /* Locations of matches in regex */
+
+ int replacelen; /* length of replacement string */
+ int i;
+ int offset;
+ int prev;
+
+ /* Perform the regex matching */
+ matchcount = pcre_exec(info->re, NULL, str, strlen(str), 0, 0, ovector,
+ OVECOUNT);
+ if (matchcount < 0) {
+ switch (matchcount) {
+ case PCRE_ERROR_NOMATCH:
+ break;
+ default:
+ TSError("[%s] Matching error: %d\n", PLUGIN_NAME, matchcount);
+ break;
+ }
+ return 0;
+ }
+
+ /* Verify the replacement has the right number of matching groups */
+ for (i=0; i<info->tokcount; i++) {
+ if (info->tokens[i] >= matchcount) {
+ TSError("[%s] Invalid reference int replacement: $%d\n",
+ info->tokens[i]);
+ return 0;
+ }
+ }
+
+ /* malloc the replacement string */
+ replacelen = strlen(info->replacement);
+ replacelen -= info->tokcount * 2; /* Subtract $1, $2 etc... */
+ for (i=0; i<info->tokcount; i++) {
+ replacelen += (ovector[info->tokens[i]*2+1] -
+ ovector[info->tokens[i]*2]);
+ }
+ replacelen++; /* Null terminator */
+ *buf = TSmalloc(replacelen);
+
+ /* perform string replacement */
+ offset = 0; /* Where we are adding new data in the string */
+ prev = 0;
+ for (i=0; i<info->tokcount; i++) {
+ memcpy(*buf + offset, info->replacement + prev,
+ info->tokenoffset[i] - prev);
+ offset += (info->tokenoffset[i] - prev);
+ prev = info->tokenoffset[i] + 2;
+
+ memcpy(*buf + offset, str + ovector[info->tokens[i]*2],
+ ovector[info->tokens[i]*2+1] - ovector[info->tokens[i]*2]);
+ offset += (ovector[info->tokens[i]*2+1] - ovector[info->tokens[i]*2]);
+ }
+ memcpy(*buf + offset, info->replacement + prev,
+ strlen(info->replacement) - prev);
+ offset += strlen(info->replacement) - prev;
+ (*buf)[offset] = 0; /* Null termination */
+ return 1;
+}
+
+static int regex_compile(regex_info **buf, char *pattern, char *replacement) {
+ const char *reerror; /* Error string from pcre */
+ int reerroffset; /* Offset where any pcre error occured */
+
+ int tokcount;
+ int *tokens;
+ int *tokenoffset;
+
+ int i;
+
+ int status = 1; /* Status (return value) of the function */
+
+ regex_info *info = TSmalloc(sizeof(regex_info));
+
+
+ /* Precompile the regular expression */
+ info->re = pcre_compile(pattern, 0, &reerror, &reerroffset, NULL);
+ if (!info->re) {
+ TSError("[%s] Compilation of regex '%s' failed at char %d: %s\n",
+ PLUGIN_NAME, pattern, reerroffset, reerror);
+ status = 0;
+ }
+
+ /* Precalculate the location of $X tokens in the replacement */
+ tokcount = 0;
+ if (status) {
+ tokens = TSmalloc(sizeof(int) * TOKENCOUNT);
+ tokenoffset = TSmalloc(sizeof(int) * TOKENCOUNT);
+ for (i=0; i<strlen(replacement); i++) {
+ if (replacement[i] == '$') {
+ if (tokcount >= TOKENCOUNT) {
+ TSError("[%s] Error: too many tokens in replacement "
+ "string: %s\n", PLUGIN_NAME, replacement);
+ status = 0;
+ break;
+ } else if (replacement[i+1] < '0' || replacement[i+1] > '9') {
+ TSError("[%s] Error: Invalid replacement token $%c in "
+ "%s: should be $0 - $9\n", PLUGIN_NAME,
+ replacement[i+1], replacement);
+ status = 0;
+ break;
+ } else {
+ /* Store the location of the replacement */
+ /* Convert '0' to 0 */
+ tokens[tokcount] = replacement[i+1] - '0';
+ tokenoffset[tokcount] = i;
+ tokcount++;
+ /* Skip the next char */
+ i++;
+ }
+ }
+ }
+ }
+
+ if (status) {
+ /* Everything went OK */
+ info->tokcount = tokcount;
+ info->tokens = tokens;
+ info->tokenoffset = tokenoffset;
+
+ info->pattern = TSstrdup(pattern);
+ info->replacement = TSstrdup(replacement);
+
+ *buf = info;
+ } else {
+ /* Something went wrong, clean up */
+ if (info->tokens) TSfree(info->tokens);
+ if (info->tokenoffset) TSfree(info->tokenoffset);
+ if (info->re) pcre_free(info->re);
+ if (info) TSfree(info);
+ }
+ return status;
+}
+
+static void load_config_file() {
+ char buffer[1024];
+ char config_file[1024];
+ TSFile fh;
+
+ /* locations in a config file line, end of line, split start, split end */
+ char *eol, *spstart, *spend;
+ int lineno = 0;
+ int retval;
+ regex_info *info = 0;
+
+ /* TODO - should this file be located in etc/ rather than the plugin dir?
+ * */
+ sprintf(config_file, "%s/cacheurl.config", TSPluginDirGet());
+ TSDebug(PLUGIN_NAME, "Opening config file: %s", config_file);
+ fh = TSfopen(config_file, "r");
+
+ if (!fh) {
+ TSError("[%s] Unable to open %s. No patterns will be loaded\n",
+ PLUGIN_NAME, config_file);
+ return;
+ }
+
+ while (TSfgets(fh, buffer, sizeof(buffer) - 1)) {
+ lineno++;
+ if (*buffer == '#') {
+ /* # Comments, only at line beginning */
+ continue;
+ }
+ eol = strstr(buffer, "\n");
+ if (eol) {
+ *eol = 0; /* Terminate string at newline */
+ } else {
+ /* Malformed line - skip */
+ continue;
+ }
+ /* Split line into two parts based on whitespace */
+ /* Find first whitespace */
+ spstart = strstr(buffer, " ");
+ if (!spstart) {
+ spstart = strstr(buffer, "\t");
+ }
+ if (!spstart) {
+ TSError("[%s] ERROR: Invalid format on line %d. Skipping\n",
+ PLUGIN_NAME, lineno);
+ continue;
+ }
+ /* Find part of the line after any whitespace */
+ spend = spstart + 1;
+ while(*spend == ' ' || *spend == '\t') {
+ spend++;
+ }
+ if (*spend == 0) {
+ /* We reached the end of the string without any non-whitepace */
+ TSError("[%s] ERROR: Invalid format on line %d. Skipping\n",
+ PLUGIN_NAME, lineno);
+ continue;
+ }
+
+ *spstart = 0;
+ /* We have the pattern/replacement, now do precompilation.
+ * buffer is the first part of the line. spend is the second part just
+ * after the whitespace */
+ if (log) {
+ TSTextLogObjectWrite(log,
+ "Adding pattern/replacement pair: '%s' -> '%s'",
+ buffer, spend);
+ }
+ TSDebug(PLUGIN_NAME, "Adding pattern/replacement pair: '%s' -> '%s'\n",
+ buffer, spend);
+ retval = regex_compile(&info, buffer, spend);
+ if (!retval) {
+ TSError("[%s] Error precompiling regex/replacement. Skipping.\n",
+ PLUGIN_NAME);
+ }
+ if (patterncount > PATTERNCOUNT) {
+ TSError("[%s] Warning, too many patterns - skipping the rest"
+ "(max: %d)\n", PLUGIN_NAME, PATTERNCOUNT);
+ TSfree(info);
+ break;
+ }
+ pr_list[patterncount] = info;
+ patterncount++;
+ }
+ TSfclose(fh);
+}
+
+static int handle_hook(TSCont *contp, TSEvent event, void *edata) {
+ TSHttpTxn txnp = (TSHttpTxn) edata;
+ char *newurl = 0;
+ int retval;
+
+ char *url;
+ int url_length;
+ int i;
+
+ int ok = 1;
+
+ switch (event) {
+ case TS_EVENT_HTTP_READ_REQUEST_HDR:
+ if (ok) {
+ url = TSHttpTxnEffectiveUrlStringGet(txnp, &url_length);
+ if (!url) {
+ TSError("[%s] couldn't retrieve request url\n",
+ PLUGIN_NAME);
+ ok = 0;
+ }
+ }
+
+ if (ok) {
+ for (i=0; i<patterncount; i++) {
+ retval = regex_substitute(&newurl, url, pr_list[i]);
+ if (retval) {
+ /* Successful match/substitution */
+ break;
+ }
+ }
+ if (newurl) {
+ if (log) {
+ TSTextLogObjectWrite(log,
+ "Rewriting cache URL for %s to %s", url,
+ newurl);
+ }
+ TSDebug(PLUGIN_NAME, "Rewriting cache URL for %s to %s\n",
+ url, newurl);
+ if (TSCacheUrlSet(txnp, newurl, strlen(newurl))
+ != TS_SUCCESS) {
+ TSError("[%s] Unable to modify cache url from "
+ "%s to %s\n", PLUGIN_NAME, url, newurl);
+ ok = 0;
+ }
+ }
+ }
+ /* Clean up */
+ if (url) TSfree(url);
+ if (newurl) TSfree(newurl);
+ TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE);
+ break;
+ default:
+ TSAssert(!"Unexpected event");
+ ok = 0;
+ break;
+ }
+
+ return ok;
+}
+
+/* Function to ensure we're running a recent enough version of Traffic Server.
+ * (Taken from the example plugin)
+ */
+static int check_ts_version() {
+ const char *ts_version = TSTrafficServerVersionGet();
+ int result = 0;
+
+ if (ts_version) {
+ int major_ts_version = 0;
+ int minor_ts_version = 0;
+ int patch_ts_version = 0;
+
+ if (sscanf(ts_version, "%d.%d.%d", &major_ts_version, &minor_ts_version,
+ &patch_ts_version) != 3) {
+ return 0;
+ }
+
+ /* Need at least TS 2.1.6 */
+ if (major_ts_version == 2 && (
+ (minor_ts_version == 1 && patch_ts_version >= 6 ) ||
+ minor_ts_version > 1)) {
+ result = 1;
+ }
+
+ }
+ return result;
+}
+
+/* Generic error message function for errors in plugin initialization */
+static void initialization_error(char *msg) {
+ TSError("[%s] %s\n", PLUGIN_NAME, msg);
+ TSError("[%s] Unable to initialize plugin (disabled).\n");
+}
+
+void TSPluginInit(int argc, const char *argv[]) {
+ TSPluginRegistrationInfo info;
+ TSReturnCode error;
+
+ info.plugin_name = PLUGIN_NAME;
+ info.vendor_name = "OmniTI";
+ info.support_email = "sa@omniti.com";
+
+ if (TSPluginRegister(TS_SDK_VERSION_2_0, &info) != TS_SUCCESS) {
+ initialization_error("Plugin registration failed.");
+ return;
+ }
+
+ if (!check_ts_version()) {
+ initialization_error("Plugin requires Traffic Server 2.0 or later");
+ return;
+ }
+
+ error = TSTextLogObjectCreate("cacheurl", TS_LOG_MODE_ADD_TIMESTAMP,
+ &log);
+ if (!log || error == TS_ERROR) {
+ TSError("[%s] Error creating log file\n", PLUGIN_NAME);
+ }
+
+ load_config_file();
+
+ TSHttpHookAdd(TS_HTTP_READ_REQUEST_HDR_HOOK,
+ TSContCreate((TSEventFunc)handle_hook, NULL));
+}
Added: trafficserver/plugins/cacheurl/cacheurl.config.example
URL: http://svn.apache.org/viewvc/trafficserver/plugins/cacheurl/cacheurl.config.example?rev=1085149&view=auto
==============================================================================
--- trafficserver/plugins/cacheurl/cacheurl.config.example (added)
+++ trafficserver/plugins/cacheurl/cacheurl.config.example Thu Mar 24 21:24:44 2011
@@ -0,0 +1,22 @@
+
+# Configuration file format:
+#
+# url_pattern cache_key_replacement
+#
+# The url_pattern is a regular expression (pcre). The replacement can contain
+# $1, $2 and so on, which will be replaced with the appropriate matching group
+# from the pattern.
+
+# Make files from s1.example.com, s2.example.com and s3.example.com all
+# be cached with the same key.
+# Adding a unique suffix (TSINTERNAL in this example) to the cache key
+# guarantees that it won't clash with a real URL should s.example.com exist.
+http://s[123].example.com/(.*) http://s.example.com.TSINTERNAL/$1
+
+# Cache based on only some parts of a query string (e.g. ignore session
+# information). This plucks out the id and format query string variables and
+# only considers those when making the cache key.
+http://www.example.com/video\?.*?\&?(id=[0-9a-f]*).*?\&(format=[a-z]*) http://video-srv.example.com.ATSINTERNAL/$1&$2
+
+# Completely ignore a query string for a specific page
+http://www.example.com/some/page.html(?:\?|$) http://www.example.com/some/page.html