Initial vmod_urlcode commit

Author: drwilco

.gitignore

@@ -27,3 +27,4 @@ Makefile.in
 
 /src/vcc_if.c
 /src/vcc_if.h
+/vmod_urlcode.3

Makefile.am

@@ -4,10 +4,10 @@ SUBDIRS = src
 
 EXTRA_DIST = README.rst
 
-dist_man_MANS = vmod_example.3
+dist_man_MANS = vmod_urlcode.3
 MAINTAINERCLEANFILES = $(dist_man_MANS)
 
-vmod_example.3: README.rst
+vmod_urlcode.3: README.rst
 if HAVE_RST2MAN
 	${RST2MAN} README.rst $@
 else

README.rst

@@ -6,50 +6,80 @@ vmod_example
 Varnish Example Module
 ----------------------
 
-:Author: Martin Blix Grydeland
-:Date: 2011-05-26
+:Author: Rogier "DocWilco" Mulhuijzen
+:Date: 2012-02-15
 :Version: 1.0
 :Manual section: 3
 
 SYNOPSIS
 ========
 
-import example;
+::
+
+	import urlcode;
+	urlcode.encode(<string>);
+	urlcode.decode(<string>);
 
 DESCRIPTION
 ===========
 
-Example Varnish vmod demonstrating how to write an out-of-tree Varnish vmod.
+Varnish Module (vmod) for encoding or decoding to/from "percent encoding" as 
+per RFC3986.
 
-Implements the traditional Hello World as a vmod.
+For backward compatibility, a + will be decoded to a space.
 
 FUNCTIONS
 =========
 
-hello
------
+Example VCL::
+
+	backend foo { ... };
+
+	import urlcode;
+
+	sub vcl_recv {
+		set req.url = "/example?url=" + urlcode.encode("http://" +
+			req.http.host + req.url);
+	}
+
+encode
+------
 
 Prototype
         ::
 
-                hello(STRING S)
+		urlcode.encode(STRING input)
+
 Return value
 	STRING
 Description
-	Returns "Hello, " prepended to S
+	Returns a percent encoded version of input.
 Example
+	::
+
+		set resp.http.foo = urlcode.encode("hello world!");
+
+decode
+------
+
+Prototype
         ::
 
-                set resp.http.hello = example.hello("World");
+		urlcode.decode(STRING input)
+
+Return value
+	STRING
+Description
+	Returns a percent decoded version of input.
+Example
+	::
+
+		set resp.http.foo = urlcode.decode("hello%20world%21");
+
 
 INSTALLATION
 ============
 
-This is an example skeleton for developing out-of-tree Varnish
-vmods. It implements the "Hello, World!" as a vmod callback. Not
-particularly useful in good hello world tradition, but demonstrates how
-to get the glue around a vmod working.
-
 The source tree is based on autotools to configure the building, and
 does also have the necessary bits in place to do functional unit tests
 using the varnishtest tool.
@@ -72,25 +102,16 @@ Make targets:
 * make install - installs your vmod in `VMODDIR`
 * make check - runs the unit tests in ``src/tests/*.vtc``
 
-In your VCL you could then use this vmod along the following lines::
-        
-        import example;
-
-        sub vcl_deliver {
-                # This sets resp.http.hello to "Hello, World"
-                set resp.http.hello = example.hello("World");
-        }
 
 HISTORY
 =======
 
-This manual page was released as part of the libvmod-example package,
-demonstrating how to create an out-of-tree Varnish vmod.
+Version 0.1: Initial version.
 
 COPYRIGHT
 =========
 
 This document is licensed under the same license as the
-libvmod-example project. See LICENSE for details.
+libvmod-urlcode project. See LICENSE for details.
 
-* Copyright (c) 2011 Varnish Software
+* Copyright (c) 2012 Fastly Inc.

configure.ac

@@ -1,8 +1,8 @@
 AC_PREREQ(2.59)
 AC_COPYRIGHT([Copyright (c) 2011 Varnish Software AS])
-AC_INIT([libvmod-example], [trunk])
+AC_INIT([libvmod-urlcode], [master])
 AC_CONFIG_MACRO_DIR([m4])
-AC_CONFIG_SRCDIR(src/vmod_example.vcc)
+AC_CONFIG_SRCDIR(src/vmod_urlcode.vcc)
 AM_CONFIG_HEADER(config.h)
 
 AC_CANONICAL_SYSTEM

src/Makefile.am

@@ -1,17 +1,17 @@
 INCLUDES = -I$(VARNISHSRC)/include -I$(VARNISHSRC)
 
 vmoddir = $(VMODDIR)
-vmod_LTLIBRARIES = libvmod_example.la
+vmod_LTLIBRARIES = libvmod_urlcode.la
 
-libvmod_example_la_LDFLAGS = -module -export-dynamic -avoid-version
+libvmod_urlcode_la_LDFLAGS = -module -export-dynamic -avoid-version
 
-libvmod_example_la_SOURCES = \
+libvmod_urlcode_la_SOURCES = \
 	vcc_if.c \
 	vcc_if.h \
-	vmod_example.c
+	vmod_urlcode.c
 
-vcc_if.c vcc_if.h: $(VARNISHSRC)/lib/libvmod_std/vmod.py $(top_srcdir)/src/vmod_example.vcc
-	@PYTHON@ $(VARNISHSRC)/lib/libvmod_std/vmod.py $(top_srcdir)/src/vmod_example.vcc
+vcc_if.c vcc_if.h: $(VARNISHSRC)/lib/libvmod_std/vmod.py $(top_srcdir)/src/vmod_urlcode.vcc
+	@PYTHON@ $(VARNISHSRC)/lib/libvmod_std/vmod.py $(top_srcdir)/src/vmod_urlcode.vcc
 
 VMOD_TESTS = tests/*.vtc
 .PHONY: $(VMOD_TESTS)
@@ -22,7 +22,7 @@ tests/*.vtc:
 check: $(VMOD_TESTS)
 
 EXTRA_DIST = \
-	vmod_example.vcc \
+	vmod_urlcode.vcc \
 	$(VMOD_TESTS)
 
 CLEANFILES = $(builddir)/vcc_if.c $(builddir)/vcc_if.h

src/tests/test01.vtc

@@ -0,0 +1,55 @@
+varnishtest "Test urlcode vmod"
+
+server s1 {
+	rxreq 
+	txresp	-hdr "Foo1: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_~" \
+		-hdr "Foo2: `!@#$%^&*()+={}[]:;'\\|<>,?/ \"" \
+		-hdr "Foo3: hello" \
+		-hdr "Foo4: world" \
+		-hdr "Foo5: %2" \
+		-hdr "Foo6: %" \
+		-hdr "Foo7: +" \
+		-hdr "Connection: close" \
+		-body "Hi!\n"
+} -start
+
+varnish v1 -vcl+backend {
+	import urlcode from "${vmod_topbuild}/src/.libs/libvmod_urlcode.so";
+
+	sub vcl_fetch {
+		set beresp.http.Bar1 = urlcode.encode(beresp.http.Foo1);
+		set beresp.http.Baz1 = urlcode.decode(beresp.http.Bar1);
+		set beresp.http.Bar2 = urlcode.encode(beresp.http.Foo2);
+		set beresp.http.Baz2 = urlcode.decode(beresp.http.Bar2);
+		set beresp.http.Bar3 = urlcode.encode(beresp.http.Foo3 + " "
+			+ beresp.http.Foo4) + "!";
+		set beresp.http.Baz3 = urlcode.decode("hello" + beresp.http.Foo5
+			+ "0world") + "!";
+		set beresp.http.Baz4 = urlcode.decode("hello" + beresp.http.Foo6
+			+ "20world") + "!";
+		set beresp.http.Baz5 = urlcode.decode("hello" + beresp.http.Foo7
+			+ "world") + "!";
+		set beresp.http.Bar6 = urlcode.encode("hello"
+			+ beresp.http.nonexistant + "world") + "!";
+		set beresp.http.Baz6 = urlcode.decode("hello"
+			+ beresp.http.nonexistant + "world") + "!";
+	}
+} -start
+
+client c1 {
+	txreq -url "/"
+	rxresp
+	expect resp.status == 200
+	expect resp.http.X-Varnish == "1001"
+	expect resp.http.foo1 == "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_~"
+	expect resp.http.bar1 == "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_~"
+	expect resp.http.baz1 == "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_~"
+	expect resp.http.foo2 == "`!@#$%^&*()+={}[]:;'\\|<>,?/ \""
+	expect resp.http.bar2 == "%60%21%40%23%24%25%5E%26%2A%28%29%2B%3D%7B%7D%5B%5D%3A%3B%27%5C%7C%3C%3E%2C%3F%2F%20%22"
+	expect resp.http.baz2 == "`!@#$%^&*()+={}[]:;'\\|<>,?/ \""
+	expect resp.http.bar3 == "hello%20world!"
+	expect resp.http.baz3 == "hello world!"
+	expect resp.http.baz4 == "hello world!"
+	expect resp.http.baz5 == "hello world!"
+	expect resp.http.baz6 == "helloworld!"
+} -run