From 8ef5210e3b6f1aa82e8392e73fa4ee69cb27d886 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Tue, 28 Feb 2017 09:56:01 +0100 Subject: [PATCH 1/5] Updated autocrap with libvmod-example latest master --- .gitignore | 25 ++- .travis.yml | 32 ++++ CHANGES.rst | 20 ++ COPYING | 5 - LICENSE | 42 ++-- Makefile.am | 17 +- README.rst | 141 +++++++------- autogen.sh | 13 +- configure.ac | 65 +++---- m4/PLACEHOLDER | 0 m4/ax_pthread.m4 | 485 +++++++++++++++++++++++++++++++++++++++++++++++ src/Makefile.am | 30 +-- 12 files changed, 693 insertions(+), 182 deletions(-) create mode 100644 .travis.yml create mode 100644 CHANGES.rst delete mode 100644 m4/PLACEHOLDER create mode 100644 m4/ax_pthread.m4 diff --git a/.gitignore b/.gitignore index 02c3804..3515ebd 100644 --- a/.gitignore +++ b/.gitignore @@ -6,27 +6,26 @@ Makefile.in *.lo *.la *~ +*.[1-9] +*.log +*.trs /aclocal.m4 /autom4te.cache/ -/compile -/config.guess +/build-aux/ /config.h /config.h.in /config.log /config.status -/config.sub /configure -/depcomp -/install-sh /libtool -/ltmain.sh -/missing /stamp-h1 -/m4/ - -/src/vcc_if.c -/src/vcc_if.h -/vmod_urlcode.3 -/nbproject/private/ +/m4/libtool.m4 +/m4/ltoptions.m4 +/m4/ltsugar.m4 +/m4/ltversion.m4 +/m4/lt~obsolete.m4 +/src/vcc_*_if.c +/src/vcc_*_if.h +/src/vmod_*rst diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..0c8b639 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,32 @@ +--- +sudo: required +dist: trusty + +language: c + +addons: + apt: + packages: + - python-docutils + +before_install: + - set -e + - wget https://repo.varnish-cache.org/source/varnish-5.0.0.tar.gz + - tar -zxf varnish-*.tar.gz + - pushd varnish-*/ + - ./configure --prefix=/usr + - make -sj32 + - sudo make install + - popd + +before_script: + - ./autogen.sh + - ./configure --prefix=/usr + - make -j4 + +script: + - make check -j4 + +compiler: + - clang + - gcc diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..3f6ac66 --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,20 @@ +This is a running log of changes to libvmod-urlcode. + +libvmod-urlcode 0.2 (unreleased) +-------------------------------- + +* The most recent release entry is at the top. + +libvmod-urlcode 0.1 (1970-01-01) +-------------------------------- + +* Add list items with changes done. +* Issues fixed could also be list entries. + +If you need to, a paragraph or two of explanation for any complicated changes +is appreciated. + +Make sure to mention any changing breaking user-visible interfaces. (function +names, type of arguments, order of arguments) + + diff --git a/COPYING b/COPYING index f792696..eb810db 100644 --- a/COPYING +++ b/COPYING @@ -1,7 +1,2 @@ -Copyright (c) 2011 Varnish Software AS -... See LICENSE for details. -You're free to use and distribute this under terms in the -LICENSE. Please add your relevant copyright statements. - diff --git a/LICENSE b/LICENSE index 264d421..68a49da 100644 --- a/LICENSE +++ b/LICENSE @@ -1,20 +1,24 @@ -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions -are met: -1. Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. +This is free and unencumbered software released into the public domain. -THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -SUCH DAMAGE. +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to diff --git a/Makefile.am b/Makefile.am index cacfc13..7d37665 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,18 +1,5 @@ -ACLOCAL_AMFLAGS = -I m4 +ACLOCAL_AMFLAGS = -I m4 -I ${VARNISHAPI_DATAROOTDIR}/aclocal SUBDIRS = src -EXTRA_DIST = README.rst - -dist_man_MANS = vmod_urlcode.3 -MAINTAINERCLEANFILES = $(dist_man_MANS) - -vmod_urlcode.3: README.rst -if HAVE_RST2MAN - ${RST2MAN} README.rst $@ -else - @echo "========================================" - @echo "You need rst2man installed to make dist" - @echo "========================================" - @false -endif +dist_doc_DATA = README.rst LICENSE diff --git a/README.rst b/README.rst index ee1eaf2..feca916 100644 --- a/README.rst +++ b/README.rst @@ -1,120 +1,109 @@ ============ -vmod_urlcode +vmod-urlcode ============ ----------------------- -Varnish URLcode Module ----------------------- - -:Author: Rogier "DocWilco" Mulhuijzen -:Date: 2012-02-15 -:Version: 1.0 -:Manual section: 3 - SYNOPSIS ======== -:: - - import urlcode; - urlcode.encode(); - urlcode.decode(); +import urlcode; DESCRIPTION =========== -Varnish Module (vmod) for encoding or decoding to/from "percent encoding" as -per RFC3986. +Urlcode Varnish vmod demonstrating how to write an out-of-tree Varnish vmod. -For backward compatibility, a + will be decoded to a space. +Implements the traditional Hello World as a vmod. FUNCTIONS ========= -Example VCL:: - - backend foo { ... }; - - import urlcode; - - sub vcl_recv { - set req.url = "/example?url=" + urlcode.encode("http://" + - req.http.host + req.url); - } - -encode ------- +hello +----- Prototype :: - urlcode.encode(STRING_LIST input) - + hello(STRING S) Return value STRING Description - Returns a percent encoded version of input. Or NULL if sess_workspace - does not have enough space for the operation. -Example - :: - - set resp.http.foo = urlcode.encode("hello world!"); - -decode ------- - -Prototype + Returns "Hello, " prepended to S +Urlcode :: - urlcode.decode(STRING_LIST input) - -Return value - STRING -Description - Returns a percent decoded version of input. Or NULL if either the - encoding is invalid or sess_workspace does not have enough space for - the operation. -Example - :: - - set resp.http.foo = urlcode.decode("hello%20world%21"); - + set resp.http.hello = urlcode.hello("World"); INSTALLATION ============ 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. +using the ``varnishtest`` tool. + +Building requires the Varnish header files and uses pkg-config to find +the necessary paths. Usage:: - ./configure VARNISHSRC=DIR [VMODDIR=DIR] + ./autogen.sh + ./configure -`VARNISHSRC` is the directory of the Varnish source tree for which to -compile your vmod. Both the `VARNISHSRC` and `VARNISHSRC/include` -will be added to the include search paths for your module. +If you have installed Varnish to a non-standard directory, call +``autogen.sh`` and ``configure`` with ``PKG_CONFIG_PATH`` pointing to +the appropriate path. For instance, when varnishd configure was called +with ``--prefix=$PREFIX``, use -Optionally you can also set the vmod install directory by adding -`VMODDIR=DIR` (defaults to the pkg-config discovered directory from your -Varnish installation). +:: + + export PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig + export ACLOCAL_PATH=${PREFIX}/share/aclocal + +The module will inherit its prefix from Varnish, unless you specify a +different ``--prefix`` when running the ``configure`` script for this +module. Make targets: -* make - builds the vmod -* make install - installs your vmod in `VMODDIR` -* make check - runs the unit tests in ``src/tests/*.vtc`` +* make - builds the vmod. +* make install - installs your vmod. +* make check - runs the unit tests in ``src/tests/*.vtc``. +* make distcheck - run check and prepare a tarball of the vmod. +If you build a dist tarball, you don't need any of the autotools or +pkg-config. You can build the module simply by running:: -HISTORY -======= + ./configure + make -Version 1.0: Initial version. +Installation directories +------------------------ -COPYRIGHT -========= +By default, the vmod ``configure`` script installs the built vmod in the +directory relevant to the prefix. The vmod installation directory can be +overridden by passing the ``vmoddir`` variable to ``make install``. + +USAGE +===== + +In your VCL you could then use this vmod along the following lines:: + + import urlcode; + + sub vcl_deliver { + # This sets resp.http.hello to "Hello, World" + set resp.http.hello = urlcode.hello("World"); + } + +COMMON PROBLEMS +=============== + +* configure: error: Need varnish.m4 -- see README.rst + + Check whether ``PKG_CONFIG_PATH`` and ``ACLOCAL_PATH`` were set correctly + before calling ``autogen.sh`` and ``configure`` -This document is licensed under the same license as the -libvmod-urlcode project. See LICENSE for details. +* Incompatibilities with different Varnish Cache versions -* Copyright (c) 2012 Fastly Inc. + Make sure you build this vmod against its correspondent Varnish Cache version. + For instance, to build against Varnish Cache 4.1, this vmod must be built from + branch 4.1. diff --git a/autogen.sh b/autogen.sh index 9a12ef5..55f7894 100755 --- a/autogen.sh +++ b/autogen.sh @@ -35,9 +35,18 @@ else esac fi +# check for varnishapi.m4 in custom paths +dataroot=$(pkg-config --variable=datarootdir varnishapi 2>/dev/null) +if [ -z "$dataroot" ] ; then + cat >&2 <<'EOF' +Package varnishapi was not found in the pkg-config search path. +Perhaps you should add the directory containing `varnishapi.pc' +to the PKG_CONFIG_PATH environment variable +EOF + exit 1 +fi set -ex - -aclocal -I m4 +aclocal -I m4 -I ${dataroot}/aclocal $LIBTOOLIZE --copy --force autoheader automake --add-missing --copy --foreign diff --git a/configure.ac b/configure.ac index 026f535..f988be8 100644 --- a/configure.ac +++ b/configure.ac @@ -1,51 +1,42 @@ -AC_PREREQ(2.59) -AC_COPYRIGHT([Copyright (c) 2011 Varnish Software AS]) -AC_INIT([libvmod-urlcode], [master]) +AC_PREREQ([2.68]) +AC_INIT([libvmod-urlcode], [0.1], [], [vmod-urlcode]) +AC_COPYRIGHT([Copyright (c) 2011-2016 Varnish Software AS]) AC_CONFIG_MACRO_DIR([m4]) +AC_CONFIG_AUX_DIR([build-aux]) AC_CONFIG_SRCDIR(src/vmod_urlcode.vcc) -AM_CONFIG_HEADER(config.h) +AC_CONFIG_HEADER([config.h]) -AC_CANONICAL_SYSTEM -AC_LANG(C) +AM_INIT_AUTOMAKE([1.12 -Wall -Werror foreign parallel-tests]) +AM_SILENT_RULES([yes]) +AM_PROG_AR -AM_INIT_AUTOMAKE([foreign]) +LT_PREREQ([2.2.6]) +LT_INIT([dlopen disable-static]) -AC_GNU_SOURCE -AC_PROG_CC -AC_PROG_CC_STDC -if test "x$ac_cv_prog_cc_c99" = xno; then - AC_MSG_ERROR([Could not find a C99 compatible compiler]) -fi -AC_PROG_CPP +AX_PTHREAD(,[AC_MSG_ERROR([Could not configure pthreads support])]) -AC_PROG_INSTALL -AC_PROG_LIBTOOL -AC_PROG_MAKE_SET +LIBS="$PTHREAD_LIBS $LIBS" +CFLAGS="$CFLAGS $PTHREAD_CFLAGS" +CC="$PTHREAD_CC" -# Check for rst utilities -AC_CHECK_PROGS(RST2MAN, [rst2man rst2man.py], "no") -if test "x$RST2MAN" = "xno"; then - AC_MSG_WARN([rst2man not found - not building man pages]) -fi -AM_CONDITIONAL(HAVE_RST2MAN, [test "x$RST2MAN" != "xno"]) +AC_ARG_WITH([rst2man], + AS_HELP_STRING( + [--with-rst2man=PATH], + [Location of rst2man (auto)]), + [RST2MAN="$withval"], + AC_CHECK_PROGS(RST2MAN, [rst2man rst2man.py], [])) -# Check for pkg-config -PKG_PROG_PKG_CONFIG +m4_ifndef([VARNISH_PREREQ], AC_MSG_ERROR([Need varnish.m4 -- see README.rst])) -# Checks for header files. -AC_HEADER_STDC -AC_CHECK_HEADERS([sys/stdlib.h]) +VARNISH_PREREQ([5.0], [5.1]) +VARNISH_VMODS([urlcode]) -# Check for python -AC_CHECK_PROGS(PYTHON, [python3 python3.1 python3.2 python2.7 python2.6 python2.5 python2 python], [AC_MSG_ERROR([Python is needed to build this vmod, please install python.])]) +VMOD_TESTS="$(cd $srcdir/src && echo tests/*.vtc)" +AC_SUBST(VMOD_TESTS) -# Varnish include files tree -VARNISH_VMOD_INCLUDES -VARNISH_VMOD_DIR -VARNISH_VMODTOOL - -AC_PATH_PROG([VARNISHTEST], [varnishtest]) -AC_PATH_PROG([VARNISHD], [varnishd]) +PKG_CHECK_VAR([LIBVARNISHAPI_LIBDIR], [varnishapi], [libdir]) +AC_SUBST([VARNISH_LIBRARY_PATH], + [$LIBVARNISHAPI_LIBDIR:$LIBVARNISHAPI_LIBDIR/varnish]) AC_CONFIG_FILES([ Makefile diff --git a/m4/PLACEHOLDER b/m4/PLACEHOLDER deleted file mode 100644 index e69de29..0000000 diff --git a/m4/ax_pthread.m4 b/m4/ax_pthread.m4 new file mode 100644 index 0000000..4c4051e --- /dev/null +++ b/m4/ax_pthread.m4 @@ -0,0 +1,485 @@ +# =========================================================================== +# http://www.gnu.org/software/autoconf-archive/ax_pthread.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_PTHREAD([ACTION-IF-FOUND[, ACTION-IF-NOT-FOUND]]) +# +# DESCRIPTION +# +# This macro figures out how to build C programs using POSIX threads. It +# sets the PTHREAD_LIBS output variable to the threads library and linker +# flags, and the PTHREAD_CFLAGS output variable to any special C compiler +# flags that are needed. (The user can also force certain compiler +# flags/libs to be tested by setting these environment variables.) +# +# Also sets PTHREAD_CC to any special C compiler that is needed for +# multi-threaded programs (defaults to the value of CC otherwise). (This +# is necessary on AIX to use the special cc_r compiler alias.) +# +# NOTE: You are assumed to not only compile your program with these flags, +# but also to link with them as well. For example, you might link with +# $PTHREAD_CC $CFLAGS $PTHREAD_CFLAGS $LDFLAGS ... $PTHREAD_LIBS $LIBS +# +# If you are only building threaded programs, you may wish to use these +# variables in your default LIBS, CFLAGS, and CC: +# +# LIBS="$PTHREAD_LIBS $LIBS" +# CFLAGS="$CFLAGS $PTHREAD_CFLAGS" +# CC="$PTHREAD_CC" +# +# In addition, if the PTHREAD_CREATE_JOINABLE thread-attribute constant +# has a nonstandard name, this macro defines PTHREAD_CREATE_JOINABLE to +# that name (e.g. PTHREAD_CREATE_UNDETACHED on AIX). +# +# Also HAVE_PTHREAD_PRIO_INHERIT is defined if pthread is found and the +# PTHREAD_PRIO_INHERIT symbol is defined when compiling with +# PTHREAD_CFLAGS. +# +# ACTION-IF-FOUND is a list of shell commands to run if a threads library +# is found, and ACTION-IF-NOT-FOUND is a list of commands to run it if it +# is not found. If ACTION-IF-FOUND is not specified, the default action +# will define HAVE_PTHREAD. +# +# Please let the authors know if this macro fails on any platform, or if +# you have any other suggestions or comments. This macro was based on work +# by SGJ on autoconf scripts for FFTW (http://www.fftw.org/) (with help +# from M. Frigo), as well as ac_pthread and hb_pthread macros posted by +# Alejandro Forero Cuervo to the autoconf macro repository. We are also +# grateful for the helpful feedback of numerous users. +# +# Updated for Autoconf 2.68 by Daniel Richard G. +# +# LICENSE +# +# Copyright (c) 2008 Steven G. Johnson +# Copyright (c) 2011 Daniel Richard G. +# +# This program is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General +# Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with this program. If not, see . +# +# As a special exception, the respective Autoconf Macro's copyright owner +# gives unlimited permission to copy, distribute and modify the configure +# scripts that are the output of Autoconf when processing the Macro. You +# need not follow the terms of the GNU General Public License when using +# or distributing such scripts, even though portions of the text of the +# Macro appear in them. The GNU General Public License (GPL) does govern +# all other use of the material that constitutes the Autoconf Macro. +# +# This special exception to the GPL applies to versions of the Autoconf +# Macro released by the Autoconf Archive. When you make and distribute a +# modified version of the Autoconf Macro, you may extend this special +# exception to the GPL to apply to your modified version as well. + +#serial 23 + +AU_ALIAS([ACX_PTHREAD], [AX_PTHREAD]) +AC_DEFUN([AX_PTHREAD], [ +AC_REQUIRE([AC_CANONICAL_HOST]) +AC_REQUIRE([AC_PROG_CC]) +AC_REQUIRE([AC_PROG_SED]) +AC_LANG_PUSH([C]) +ax_pthread_ok=no + +# We used to check for pthread.h first, but this fails if pthread.h +# requires special compiler flags (e.g. on Tru64 or Sequent). +# It gets checked for in the link test anyway. + +# First of all, check if the user has set any of the PTHREAD_LIBS, +# etcetera environment variables, and if threads linking works using +# them: +if test "x$PTHREAD_CFLAGS$PTHREAD_LIBS" != "x"; then + ax_pthread_save_CC="$CC" + ax_pthread_save_CFLAGS="$CFLAGS" + ax_pthread_save_LIBS="$LIBS" + AS_IF([test "x$PTHREAD_CC" != "x"], [CC="$PTHREAD_CC"]) + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + LIBS="$PTHREAD_LIBS $LIBS" + AC_MSG_CHECKING([for pthread_join using $CC $PTHREAD_CFLAGS $PTHREAD_LIBS]) + AC_LINK_IFELSE([AC_LANG_CALL([], [pthread_join])], [ax_pthread_ok=yes]) + AC_MSG_RESULT([$ax_pthread_ok]) + if test "x$ax_pthread_ok" = "xno"; then + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" + fi + CC="$ax_pthread_save_CC" + CFLAGS="$ax_pthread_save_CFLAGS" + LIBS="$ax_pthread_save_LIBS" +fi + +# We must check for the threads library under a number of different +# names; the ordering is very important because some systems +# (e.g. DEC) have both -lpthread and -lpthreads, where one of the +# libraries is broken (non-POSIX). + +# Create a list of thread flags to try. Items starting with a "-" are +# C compiler flags, and other items are library names, except for "none" +# which indicates that we try without any flags at all, and "pthread-config" +# which is a program returning the flags for the Pth emulation library. + +ax_pthread_flags="pthreads none -Kthread -pthread -pthreads -mthreads pthread --thread-safe -mt pthread-config" + +# The ordering *is* (sometimes) important. Some notes on the +# individual items follow: + +# pthreads: AIX (must check this before -lpthread) +# none: in case threads are in libc; should be tried before -Kthread and +# other compiler flags to prevent continual compiler warnings +# -Kthread: Sequent (threads in libc, but -Kthread needed for pthread.h) +# -pthread: Linux/gcc (kernel threads), BSD/gcc (userland threads), Tru64 +# (Note: HP C rejects this with "bad form for `-t' option") +# -pthreads: Solaris/gcc (Note: HP C also rejects) +# -mt: Sun Workshop C (may only link SunOS threads [-lthread], but it +# doesn't hurt to check since this sometimes defines pthreads and +# -D_REENTRANT too), HP C (must be checked before -lpthread, which +# is present but should not be used directly; and before -mthreads, +# because the compiler interprets this as "-mt" + "-hreads") +# -mthreads: Mingw32/gcc, Lynx/gcc +# pthread: Linux, etcetera +# --thread-safe: KAI C++ +# pthread-config: use pthread-config program (for GNU Pth library) + +case $host_os in + + freebsd*) + + # -kthread: FreeBSD kernel threads (preferred to -pthread since SMP-able) + # lthread: LinuxThreads port on FreeBSD (also preferred to -pthread) + + ax_pthread_flags="-kthread lthread $ax_pthread_flags" + ;; + + hpux*) + + # From the cc(1) man page: "[-mt] Sets various -D flags to enable + # multi-threading and also sets -lpthread." + + ax_pthread_flags="-mt -pthread pthread $ax_pthread_flags" + ;; + + openedition*) + + # IBM z/OS requires a feature-test macro to be defined in order to + # enable POSIX threads at all, so give the user a hint if this is + # not set. (We don't define these ourselves, as they can affect + # other portions of the system API in unpredictable ways.) + + AC_EGREP_CPP([AX_PTHREAD_ZOS_MISSING], + [ +# if !defined(_OPEN_THREADS) && !defined(_UNIX03_THREADS) + AX_PTHREAD_ZOS_MISSING +# endif + ], + [AC_MSG_WARN([IBM z/OS requires -D_OPEN_THREADS or -D_UNIX03_THREADS to enable pthreads support.])]) + ;; + + solaris*) + + # On Solaris (at least, for some versions), libc contains stubbed + # (non-functional) versions of the pthreads routines, so link-based + # tests will erroneously succeed. (N.B.: The stubs are missing + # pthread_cleanup_push, or rather a function called by this macro, + # so we could check for that, but who knows whether they'll stub + # that too in a future libc.) So we'll check first for the + # standard Solaris way of linking pthreads (-mt -lpthread). + + ax_pthread_flags="-mt,pthread pthread $ax_pthread_flags" + ;; +esac + +# GCC generally uses -pthread, or -pthreads on some platforms (e.g. SPARC) + +AS_IF([test "x$GCC" = "xyes"], + [ax_pthread_flags="-pthread -pthreads $ax_pthread_flags"]) + +# The presence of a feature test macro requesting re-entrant function +# definitions is, on some systems, a strong hint that pthreads support is +# correctly enabled + +case $host_os in + darwin* | hpux* | linux* | osf* | solaris*) + ax_pthread_check_macro="_REENTRANT" + ;; + + aix*) + ax_pthread_check_macro="_THREAD_SAFE" + ;; + + *) + ax_pthread_check_macro="--" + ;; +esac +AS_IF([test "x$ax_pthread_check_macro" = "x--"], + [ax_pthread_check_cond=0], + [ax_pthread_check_cond="!defined($ax_pthread_check_macro)"]) + +# Are we compiling with Clang? + +AC_CACHE_CHECK([whether $CC is Clang], + [ax_cv_PTHREAD_CLANG], + [ax_cv_PTHREAD_CLANG=no + # Note that Autoconf sets GCC=yes for Clang as well as GCC + if test "x$GCC" = "xyes"; then + AC_EGREP_CPP([AX_PTHREAD_CC_IS_CLANG], + [/* Note: Clang 2.7 lacks __clang_[a-z]+__ */ +# if defined(__clang__) && defined(__llvm__) + AX_PTHREAD_CC_IS_CLANG +# endif + ], + [ax_cv_PTHREAD_CLANG=yes]) + fi + ]) +ax_pthread_clang="$ax_cv_PTHREAD_CLANG" + +ax_pthread_clang_warning=no + +# Clang needs special handling, because older versions handle the -pthread +# option in a rather... idiosyncratic way + +if test "x$ax_pthread_clang" = "xyes"; then + + # Clang takes -pthread; it has never supported any other flag + + # (Note 1: This will need to be revisited if a system that Clang + # supports has POSIX threads in a separate library. This tends not + # to be the way of modern systems, but it's conceivable.) + + # (Note 2: On some systems, notably Darwin, -pthread is not needed + # to get POSIX threads support; the API is always present and + # active. We could reasonably leave PTHREAD_CFLAGS empty. But + # -pthread does define _REENTRANT, and while the Darwin headers + # ignore this macro, third-party headers might not.) + + PTHREAD_CFLAGS="-pthread" + PTHREAD_LIBS= + + ax_pthread_ok=yes + + # However, older versions of Clang make a point of warning the user + # that, in an invocation where only linking and no compilation is + # taking place, the -pthread option has no effect ("argument unused + # during compilation"). They expect -pthread to be passed in only + # when source code is being compiled. + # + # Problem is, this is at odds with the way Automake and most other + # C build frameworks function, which is that the same flags used in + # compilation (CFLAGS) are also used in linking. Many systems + # supported by AX_PTHREAD require exactly this for POSIX threads + # support, and in fact it is often not straightforward to specify a + # flag that is used only in the compilation phase and not in + # linking. Such a scenario is extremely rare in practice. + # + # Even though use of the -pthread flag in linking would only print + # a warning, this can be a nuisance for well-run software projects + # that build with -Werror. So if the active version of Clang has + # this misfeature, we search for an option to squash it. + + AC_CACHE_CHECK([whether Clang needs flag to prevent "argument unused" warning when linking with -pthread], + [ax_cv_PTHREAD_CLANG_NO_WARN_FLAG], + [ax_cv_PTHREAD_CLANG_NO_WARN_FLAG=unknown + # Create an alternate version of $ac_link that compiles and + # links in two steps (.c -> .o, .o -> exe) instead of one + # (.c -> exe), because the warning occurs only in the second + # step + ax_pthread_save_ac_link="$ac_link" + ax_pthread_sed='s/conftest\.\$ac_ext/conftest.$ac_objext/g' + ax_pthread_link_step=`$as_echo "$ac_link" | sed "$ax_pthread_sed"` + ax_pthread_2step_ac_link="($ac_compile) && (echo ==== >&5) && ($ax_pthread_link_step)" + ax_pthread_save_CFLAGS="$CFLAGS" + for ax_pthread_try in '' -Qunused-arguments -Wno-unused-command-line-argument unknown; do + AS_IF([test "x$ax_pthread_try" = "xunknown"], [break]) + CFLAGS="-Werror -Wunknown-warning-option $ax_pthread_try -pthread $ax_pthread_save_CFLAGS" + ac_link="$ax_pthread_save_ac_link" + AC_LINK_IFELSE([AC_LANG_SOURCE([[int main(void){return 0;}]])], + [ac_link="$ax_pthread_2step_ac_link" + AC_LINK_IFELSE([AC_LANG_SOURCE([[int main(void){return 0;}]])], + [break]) + ]) + done + ac_link="$ax_pthread_save_ac_link" + CFLAGS="$ax_pthread_save_CFLAGS" + AS_IF([test "x$ax_pthread_try" = "x"], [ax_pthread_try=no]) + ax_cv_PTHREAD_CLANG_NO_WARN_FLAG="$ax_pthread_try" + ]) + + case "$ax_cv_PTHREAD_CLANG_NO_WARN_FLAG" in + no | unknown) ;; + *) PTHREAD_CFLAGS="$ax_cv_PTHREAD_CLANG_NO_WARN_FLAG $PTHREAD_CFLAGS" ;; + esac + +fi # $ax_pthread_clang = yes + +if test "x$ax_pthread_ok" = "xno"; then +for ax_pthread_try_flag in $ax_pthread_flags; do + + case $ax_pthread_try_flag in + none) + AC_MSG_CHECKING([whether pthreads work without any flags]) + ;; + + -mt,pthread) + AC_MSG_CHECKING([whether pthreads work with -mt -lpthread]) + PTHREAD_CFLAGS="-mt" + PTHREAD_LIBS="-lpthread" + ;; + + -*) + AC_MSG_CHECKING([whether pthreads work with $ax_pthread_try_flag]) + PTHREAD_CFLAGS="$ax_pthread_try_flag" + ;; + + pthread-config) + AC_CHECK_PROG([ax_pthread_config], [pthread-config], [yes], [no]) + AS_IF([test "x$ax_pthread_config" = "xno"], [continue]) + PTHREAD_CFLAGS="`pthread-config --cflags`" + PTHREAD_LIBS="`pthread-config --ldflags` `pthread-config --libs`" + ;; + + *) + AC_MSG_CHECKING([for the pthreads library -l$ax_pthread_try_flag]) + PTHREAD_LIBS="-l$ax_pthread_try_flag" + ;; + esac + + ax_pthread_save_CFLAGS="$CFLAGS" + ax_pthread_save_LIBS="$LIBS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + LIBS="$PTHREAD_LIBS $LIBS" + + # Check for various functions. We must include pthread.h, + # since some functions may be macros. (On the Sequent, we + # need a special flag -Kthread to make this header compile.) + # We check for pthread_join because it is in -lpthread on IRIX + # while pthread_create is in libc. We check for pthread_attr_init + # due to DEC craziness with -lpthreads. We check for + # pthread_cleanup_push because it is one of the few pthread + # functions on Solaris that doesn't have a non-functional libc stub. + # We try pthread_create on general principles. + + AC_LINK_IFELSE([AC_LANG_PROGRAM([#include +# if $ax_pthread_check_cond +# error "$ax_pthread_check_macro must be defined" +# endif + static void routine(void *a) { a = 0; } + static void *start_routine(void *a) { return a; }], + [pthread_t th; pthread_attr_t attr; + pthread_create(&th, 0, start_routine, 0); + pthread_join(th, 0); + pthread_attr_init(&attr); + pthread_cleanup_push(routine, 0); + pthread_cleanup_pop(0) /* ; */])], + [ax_pthread_ok=yes], + []) + + CFLAGS="$ax_pthread_save_CFLAGS" + LIBS="$ax_pthread_save_LIBS" + + AC_MSG_RESULT([$ax_pthread_ok]) + AS_IF([test "x$ax_pthread_ok" = "xyes"], [break]) + + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" +done +fi + +# Various other checks: +if test "x$ax_pthread_ok" = "xyes"; then + ax_pthread_save_CFLAGS="$CFLAGS" + ax_pthread_save_LIBS="$LIBS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + LIBS="$PTHREAD_LIBS $LIBS" + + # Detect AIX lossage: JOINABLE attribute is called UNDETACHED. + AC_CACHE_CHECK([for joinable pthread attribute], + [ax_cv_PTHREAD_JOINABLE_ATTR], + [ax_cv_PTHREAD_JOINABLE_ATTR=unknown + for ax_pthread_attr in PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_UNDETACHED; do + AC_LINK_IFELSE([AC_LANG_PROGRAM([#include ], + [int attr = $ax_pthread_attr; return attr /* ; */])], + [ax_cv_PTHREAD_JOINABLE_ATTR=$ax_pthread_attr; break], + []) + done + ]) + AS_IF([test "x$ax_cv_PTHREAD_JOINABLE_ATTR" != "xunknown" && \ + test "x$ax_cv_PTHREAD_JOINABLE_ATTR" != "xPTHREAD_CREATE_JOINABLE" && \ + test "x$ax_pthread_joinable_attr_defined" != "xyes"], + [AC_DEFINE_UNQUOTED([PTHREAD_CREATE_JOINABLE], + [$ax_cv_PTHREAD_JOINABLE_ATTR], + [Define to necessary symbol if this constant + uses a non-standard name on your system.]) + ax_pthread_joinable_attr_defined=yes + ]) + + AC_CACHE_CHECK([whether more special flags are required for pthreads], + [ax_cv_PTHREAD_SPECIAL_FLAGS], + [ax_cv_PTHREAD_SPECIAL_FLAGS=no + case $host_os in + solaris*) + ax_cv_PTHREAD_SPECIAL_FLAGS="-D_POSIX_PTHREAD_SEMANTICS" + ;; + esac + ]) + AS_IF([test "x$ax_cv_PTHREAD_SPECIAL_FLAGS" != "xno" && \ + test "x$ax_pthread_special_flags_added" != "xyes"], + [PTHREAD_CFLAGS="$ax_cv_PTHREAD_SPECIAL_FLAGS $PTHREAD_CFLAGS" + ax_pthread_special_flags_added=yes]) + + AC_CACHE_CHECK([for PTHREAD_PRIO_INHERIT], + [ax_cv_PTHREAD_PRIO_INHERIT], + [AC_LINK_IFELSE([AC_LANG_PROGRAM([[#include ]], + [[int i = PTHREAD_PRIO_INHERIT;]])], + [ax_cv_PTHREAD_PRIO_INHERIT=yes], + [ax_cv_PTHREAD_PRIO_INHERIT=no]) + ]) + AS_IF([test "x$ax_cv_PTHREAD_PRIO_INHERIT" = "xyes" && \ + test "x$ax_pthread_prio_inherit_defined" != "xyes"], + [AC_DEFINE([HAVE_PTHREAD_PRIO_INHERIT], [1], [Have PTHREAD_PRIO_INHERIT.]) + ax_pthread_prio_inherit_defined=yes + ]) + + CFLAGS="$ax_pthread_save_CFLAGS" + LIBS="$ax_pthread_save_LIBS" + + # More AIX lossage: compile with *_r variant + if test "x$GCC" != "xyes"; then + case $host_os in + aix*) + AS_CASE(["x/$CC"], + [x*/c89|x*/c89_128|x*/c99|x*/c99_128|x*/cc|x*/cc128|x*/xlc|x*/xlc_v6|x*/xlc128|x*/xlc128_v6], + [#handle absolute path differently from PATH based program lookup + AS_CASE(["x$CC"], + [x/*], + [AS_IF([AS_EXECUTABLE_P([${CC}_r])],[PTHREAD_CC="${CC}_r"])], + [AC_CHECK_PROGS([PTHREAD_CC],[${CC}_r],[$CC])])]) + ;; + esac + fi +fi + +test -n "$PTHREAD_CC" || PTHREAD_CC="$CC" + +AC_SUBST([PTHREAD_LIBS]) +AC_SUBST([PTHREAD_CFLAGS]) +AC_SUBST([PTHREAD_CC]) + +# Finally, execute ACTION-IF-FOUND/ACTION-IF-NOT-FOUND: +if test "x$ax_pthread_ok" = "xyes"; then + ifelse([$1],,[AC_DEFINE([HAVE_PTHREAD],[1],[Define if you have POSIX threads libraries and header files.])],[$1]) + : +else + ax_pthread_ok=no + $2 +fi +AC_LANG_POP +])dnl AX_PTHREAD diff --git a/src/Makefile.am b/src/Makefile.am index 607085a..7e858a6 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,28 +1,28 @@ -AM_CPPFLAGS = @VMOD_INCLUDES@ +AM_CFLAGS = $(VARNISHAPI_CFLAGS) -Wall -Werror +AM_LDFLAGS = $(VARNISHAPI_LIBS) $(VMOD_LDFLAGS) -vmoddir = @VMOD_DIR@ vmod_LTLIBRARIES = libvmod_urlcode.la -libvmod_urlcode_la_LDFLAGS = -module -export-dynamic -avoid-version - libvmod_urlcode_la_SOURCES = \ - vcc_if.c \ - vcc_if.h \ vmod_urlcode.c -vcc_if.c vcc_if.h: @VMODTOOL@ $(top_srcdir)/src/vmod_urlcode.vcc - @VMODTOOL@ $(top_srcdir)/src/vmod_urlcode.vcc +nodist_libvmod_urlcode_la_SOURCES = \ + vcc_urlcode_if.c \ + vcc_urlcode_if.h + +dist_man_MANS = vmod_urlcode.3 -VMOD_TESTS = tests/*.vtc -.PHONY: $(VMOD_TESTS) +@BUILD_VMOD_URLCODE@ -tests/*.vtc: - @VARNISHTEST@ -Dvarnishd=@VARNISHD@ -Dvmod_topbuild=$(abs_top_builddir) $@ +AM_TESTS_ENVIRONMENT = \ + PATH="$(VMOD_TEST_PATH)" \ + LD_LIBRARY_PATH="$(VARNISH_LIBRARY_PATH)" +TEST_EXTENSIONS = .vtc +VTC_LOG_COMPILER = varnishtest -v +AM_VTC_LOG_FLAGS = -Dvmod_urlcode="$(VMOD_URLCODE)" -check: $(VMOD_TESTS) +TESTS = @VMOD_TESTS@ EXTRA_DIST = \ vmod_urlcode.vcc \ $(VMOD_TESTS) - -CLEANFILES = $(builddir)/vcc_if.c $(builddir)/vcc_if.h From d15c50b8df4f082b71c5c354c5e981cde0d4463c Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Tue, 28 Feb 2017 13:24:16 +0100 Subject: [PATCH 2/5] Fixed minor issues after having migrated autotools --- configure.ac | 7 +++---- src/tests/urlcode01.vtc | 2 +- src/vmod_urlcode.c | 5 +++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/configure.ac b/configure.ac index f988be8..2a940a0 100644 --- a/configure.ac +++ b/configure.ac @@ -1,4 +1,4 @@ -AC_PREREQ([2.68]) +AC_PREREQ([2.63]) AC_INIT([libvmod-urlcode], [0.1], [], [vmod-urlcode]) AC_COPYRIGHT([Copyright (c) 2011-2016 Varnish Software AS]) AC_CONFIG_MACRO_DIR([m4]) @@ -6,9 +6,8 @@ AC_CONFIG_AUX_DIR([build-aux]) AC_CONFIG_SRCDIR(src/vmod_urlcode.vcc) AC_CONFIG_HEADER([config.h]) -AM_INIT_AUTOMAKE([1.12 -Wall -Werror foreign parallel-tests]) +AM_INIT_AUTOMAKE([1.11 -Wall -Werror foreign parallel-tests]) AM_SILENT_RULES([yes]) -AM_PROG_AR LT_PREREQ([2.2.6]) LT_INIT([dlopen disable-static]) @@ -28,7 +27,7 @@ AC_ARG_WITH([rst2man], m4_ifndef([VARNISH_PREREQ], AC_MSG_ERROR([Need varnish.m4 -- see README.rst])) -VARNISH_PREREQ([5.0], [5.1]) +VARNISH_PREREQ([4.1], [trunk]) VARNISH_VMODS([urlcode]) VMOD_TESTS="$(cd $srcdir/src && echo tests/*.vtc)" diff --git a/src/tests/urlcode01.vtc b/src/tests/urlcode01.vtc index 61c37d3..32b7c77 100644 --- a/src/tests/urlcode01.vtc +++ b/src/tests/urlcode01.vtc @@ -15,7 +15,7 @@ server s1 { } -start varnish v1 -vcl+backend { - import urlcode from "${vmod_topbuild}/src/.libs/libvmod_urlcode.so"; + import ${vmod_urlcode}; sub vcl_backend_response { set beresp.http.Bar1 = urlcode.encode(beresp.http.Foo1); diff --git a/src/vmod_urlcode.c b/src/vmod_urlcode.c index 69f1920..256c0f0 100644 --- a/src/vmod_urlcode.c +++ b/src/vmod_urlcode.c @@ -3,7 +3,7 @@ #include "vrt.h" #include "cache/cache.h" -#include "vcc_if.h" +#include "vcc_urlcode_if.h" static char hexchars[] = "0123456789ABCDEF"; #define visalpha(c) \ @@ -71,10 +71,11 @@ const char * vmod_decode(const struct vrt_ctx *ctx, const char *str, ...) { char *b, *e; - int h, l; + int l; unsigned u; va_list ap; int percent = 0; + int h = 0; CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); CHECK_OBJ_NOTNULL(ctx->ws, WS_MAGIC); From ff61679b90650aaf19ea5a937d34c183fee4c0f3 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Tue, 28 Feb 2017 18:45:29 +0100 Subject: [PATCH 3/5] Reverted licence/doc overwrite when libvmod-example merge was applied. --- COPYING | 5 ++ LICENSE | 42 ++++++++-------- README.rst | 141 +++++++++++++++++++++++++++++------------------------ 3 files changed, 100 insertions(+), 88 deletions(-) diff --git a/COPYING b/COPYING index eb810db..f792696 100644 --- a/COPYING +++ b/COPYING @@ -1,2 +1,7 @@ +Copyright (c) 2011 Varnish Software AS +... See LICENSE for details. +You're free to use and distribute this under terms in the +LICENSE. Please add your relevant copyright statements. + diff --git a/LICENSE b/LICENSE index 68a49da..264d421 100644 --- a/LICENSE +++ b/LICENSE @@ -1,24 +1,20 @@ -This is free and unencumbered software released into the public domain. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. -Anyone is free to copy, modify, publish, use, compile, sell, or -distribute this software, either in source code form or as a compiled -binary, for any purpose, commercial or non-commercial, and by any -means. - -In jurisdictions that recognize copyright laws, the author or authors -of this software dedicate any and all copyright interest in the -software to the public domain. We make this dedication for the benefit -of the public at large and to the detriment of our heirs and -successors. We intend this dedication to be an overt act of -relinquishment in perpetuity of all present and future rights to this -software under copyright law. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR -OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -OTHER DEALINGS IN THE SOFTWARE. - -For more information, please refer to +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. diff --git a/README.rst b/README.rst index feca916..ee1eaf2 100644 --- a/README.rst +++ b/README.rst @@ -1,109 +1,120 @@ ============ -vmod-urlcode +vmod_urlcode ============ +---------------------- +Varnish URLcode Module +---------------------- + +:Author: Rogier "DocWilco" Mulhuijzen +:Date: 2012-02-15 +:Version: 1.0 +:Manual section: 3 + SYNOPSIS ======== -import urlcode; +:: + + import urlcode; + urlcode.encode(); + urlcode.decode(); DESCRIPTION =========== -Urlcode 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_LIST input) + Return value STRING Description - Returns "Hello, " prepended to S -Urlcode + Returns a percent encoded version of input. Or NULL if sess_workspace + does not have enough space for the operation. +Example + :: + + set resp.http.foo = urlcode.encode("hello world!"); + +decode +------ + +Prototype :: - set resp.http.hello = urlcode.hello("World"); + urlcode.decode(STRING_LIST input) + +Return value + STRING +Description + Returns a percent decoded version of input. Or NULL if either the + encoding is invalid or sess_workspace does not have enough space for + the operation. +Example + :: + + set resp.http.foo = urlcode.decode("hello%20world%21"); + INSTALLATION ============ 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. - -Building requires the Varnish header files and uses pkg-config to find -the necessary paths. +using the varnishtest tool. Usage:: - ./autogen.sh - ./configure + ./configure VARNISHSRC=DIR [VMODDIR=DIR] -If you have installed Varnish to a non-standard directory, call -``autogen.sh`` and ``configure`` with ``PKG_CONFIG_PATH`` pointing to -the appropriate path. For instance, when varnishd configure was called -with ``--prefix=$PREFIX``, use +`VARNISHSRC` is the directory of the Varnish source tree for which to +compile your vmod. Both the `VARNISHSRC` and `VARNISHSRC/include` +will be added to the include search paths for your module. -:: - - export PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig - export ACLOCAL_PATH=${PREFIX}/share/aclocal - -The module will inherit its prefix from Varnish, unless you specify a -different ``--prefix`` when running the ``configure`` script for this -module. +Optionally you can also set the vmod install directory by adding +`VMODDIR=DIR` (defaults to the pkg-config discovered directory from your +Varnish installation). Make targets: -* make - builds the vmod. -* make install - installs your vmod. -* make check - runs the unit tests in ``src/tests/*.vtc``. -* make distcheck - run check and prepare a tarball of the vmod. - -If you build a dist tarball, you don't need any of the autotools or -pkg-config. You can build the module simply by running:: +* make - builds the vmod +* make install - installs your vmod in `VMODDIR` +* make check - runs the unit tests in ``src/tests/*.vtc`` - ./configure - make -Installation directories ------------------------- +HISTORY +======= -By default, the vmod ``configure`` script installs the built vmod in the -directory relevant to the prefix. The vmod installation directory can be -overridden by passing the ``vmoddir`` variable to ``make install``. +Version 1.0: Initial version. -USAGE -===== - -In your VCL you could then use this vmod along the following lines:: - - import urlcode; - - sub vcl_deliver { - # This sets resp.http.hello to "Hello, World" - set resp.http.hello = urlcode.hello("World"); - } - -COMMON PROBLEMS -=============== - -* configure: error: Need varnish.m4 -- see README.rst - - Check whether ``PKG_CONFIG_PATH`` and ``ACLOCAL_PATH`` were set correctly - before calling ``autogen.sh`` and ``configure`` +COPYRIGHT +========= -* Incompatibilities with different Varnish Cache versions +This document is licensed under the same license as the +libvmod-urlcode project. See LICENSE for details. - Make sure you build this vmod against its correspondent Varnish Cache version. - For instance, to build against Varnish Cache 4.1, this vmod must be built from - branch 4.1. +* Copyright (c) 2012 Fastly Inc. From f6e0006f4a49d1d34d4c45280e3f0a8258246c3d Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Tue, 28 Feb 2017 18:48:08 +0100 Subject: [PATCH 4/5] Added initial changelog --- CHANGES.rst | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 3f6ac66..0425c08 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,20 +1,12 @@ This is a running log of changes to libvmod-urlcode. -libvmod-urlcode 0.2 (unreleased) +libvmod-urlcode 1.1 (unreleased) -------------------------------- -* The most recent release entry is at the top. +* Updated autotools to be compatible with latest V4/V5 core m4 versions -libvmod-urlcode 0.1 (1970-01-01) +libvmod-urlcode 1.0 (unreleased) -------------------------------- -* Add list items with changes done. -* Issues fixed could also be list entries. - -If you need to, a paragraph or two of explanation for any complicated changes -is appreciated. - -Make sure to mention any changing breaking user-visible interfaces. (function -names, type of arguments, order of arguments) - - +* initial encode function +* initial decode function From 7e4f0a6be5b9993801897c5ea80a22d85073c6b1 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Wed, 30 Aug 2017 14:26:57 +0200 Subject: [PATCH 5/5] Added optional AM_PROG_AR Differents versions require different commands... --- configure.ac | 1 + 1 file changed, 1 insertion(+) diff --git a/configure.ac b/configure.ac index 2a940a0..f68391c 100644 --- a/configure.ac +++ b/configure.ac @@ -8,6 +8,7 @@ AC_CONFIG_HEADER([config.h]) AM_INIT_AUTOMAKE([1.11 -Wall -Werror foreign parallel-tests]) AM_SILENT_RULES([yes]) +m4_ifdef([AM_PROG_AR], [AM_PROG_AR]) LT_PREREQ([2.2.6]) LT_INIT([dlopen disable-static])