mod_usertrack.c revision 6db54801798f6021bb464de7b3fdcc9dc3150f7b
d29201dd5328b88140ce050100693c501852657dChristian Maeder/* ====================================================================
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * Copyright (c) 1995-1999 The Apache Group. All rights reserved.
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * Redistribution and use in source and binary forms, with or without
6d81916b9004f8d9b6032113c5987ab07da47015Karl Luc * modification, are permitted provided that the following conditions
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * 1. Redistributions of source code must retain the above copyright
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * notice, this list of conditions and the following disclaimer.
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * 2. Redistributions in binary form must reproduce the above copyright
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * notice, this list of conditions and the following disclaimer in
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * the documentation and/or other materials provided with the
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * distribution.
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * 3. All advertising materials mentioning features or use of this
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * software must display the following acknowledgment:
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * "This product includes software developed by the Apache Group
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * for use in the Apache HTTP server project (http://www.apache.org/)."
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * 4. The names "Apache Server" and "Apache Group" must not be used to
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * endorse or promote products derived from this software without
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * prior written permission. For written permission, please contact
d6ce032cac688f3698be7133d27f53d3967e6749Christian Maeder * apache@apache.org.
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc * 5. Products derived from this software may not be called "Apache"
d75d2d11170f1339ebe37d9d9c06aff148637b13Christian Maeder * nor may "Apache" appear in their names without prior written
66977d201b3ff7ee9c1f992c0f3f701b69eac2c9Karl Luc * permission of the Apache Group.
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * 6. Redistributions of any form whatsoever must retain the following
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * acknowledgment:
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * "This product includes software developed by the Apache Group
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * for use in the Apache HTTP server project (http://www.apache.org/)."
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
a35bacbc16daf5c10f9accfdfadc4971e9d6f648Iulia Ignatov * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
3831cf8a3b0ea144a80d13fe0314cc2752e32107Christian Maeder * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * OF THE POSSIBILITY OF SUCH DAMAGE.
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * ====================================================================
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * This software consists of voluntary contributions made by many
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * individuals on behalf of the Apache Group and was originally based
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * on public domain software written at the National Center for
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * Supercomputing Applications, University of Illinois, Urbana-Champaign.
2c10bceb28a74fc291959697e023f22a66753655Eugen Kuksa * For more information on the Apache Group and the Apache HTTP server
d6ce032cac688f3698be7133d27f53d3967e6749Christian Maeder * project, please see <http://www.apache.org/>.
551f1476dea3f969775527cb15fd512e86279307Karl Luc/* User Tracking Module (Was mod_cookies.c)
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * This Apache module is designed to track users paths through a site.
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * It uses the client-side state ("Cookie") protocol developed by Netscape.
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * It is known to work on Netscape browsers, Microsoft Internet
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * Explorer and others currently being developed.
c51d1f5ff88cce030fe543e271ca6b85625b70d8Karl Luc * Each time a page is requested we look to see if the browser is sending
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa * us a Cookie: header that we previously generated.
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * If we don't find one then the user hasn't been to this site since
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * starting their browser or their browser doesn't support cookies. So
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa * we generate a unique Cookie for the transaction and send it back to
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa * the browser (via a "Set-Cookie" header)
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * Future requests from the same browser should keep the same Cookie line.
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa * By matching up all the requests with the same cookie you can
c51d1f5ff88cce030fe543e271ca6b85625b70d8Karl Luc * work out exactly what path a user took through your site. To log
2c10bceb28a74fc291959697e023f22a66753655Eugen Kuksa * the cookie use the " %{Cookie}n " directive in a custom access log;
2c10bceb28a74fc291959697e023f22a66753655Eugen Kuksa * Example 1 : If you currently use the standard Log file format (CLF)
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc * and use the command "TransferLog somefilename", add the line
d6ce032cac688f3698be7133d27f53d3967e6749Christian Maeder * LogFormat "%h %l %u %t \"%r\" %s %b %{Cookie}n"
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc * to your config file.
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * Example 2 : If you used to use the old "CookieLog" directive, you
551f1476dea3f969775527cb15fd512e86279307Karl Luc * can emulate it by adding the following command to your config file
5e6915f767bd46767306abbfbb39ebcbc10a2a33Christian Maeder * CustomLog filename "%{Cookie}n \"%r\" %t"
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * 1. This code now logs the initial transaction (the one that created
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * the cookie to start with).
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * 2. This module has been designed to not interfere with other Cookies
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * your site may be using; just avoid sending out cookies with
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * the name "Apache=" or things will get confused.
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov * 3. If you want you can modify the Set-Cookie line so that the Cookie
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder * never expires. You would then get the same Cookie each time the
3831cf8a3b0ea144a80d13fe0314cc2752e32107Christian Maeder * user revisits your site.
2c10bceb28a74fc291959697e023f22a66753655Eugen Kuksa * Mark Cox, mark@ukweb.com, 6 July 95
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * This file replaces mod_cookies.c
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maedertypedef struct {
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luctypedef struct {
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc/* Make Cookie: Now we have to generate something that is going to be
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc * pretty unique. We can base it on the pid, time, hostip */
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa cookie_log_state *cls = ap_get_module_config(r->server->module_config,
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa /* 1024 == hardcoded constant */
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa const char *rname = ap_get_remote_host(r->connection, r->per_dir_config,
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa dcfg = ap_get_module_config(r->per_dir_config, &usertrack_module);
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa /* XXX: hmm, this should really tie in with mod_unique_id */
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa ap_snprintf(cookiebuf, sizeof(cookiebuf), "%s.%qd", rname, ap_now());
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa ap_explode_gmt(&tms, r->request_time + cls->expires * AP_USEC_PER_SEC);
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa /* Cookie with date; as strftime '%a, %d-%h-%y %H:%M:%S GMT' */
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa "%s=%s; path=/; expires=%s, %.2d-%s-%.2d %.2d:%.2d:%.2d GMT",
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa dcfg->cookie_name, cookiebuf, ap_day_snames[tms.tm_wday],
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa new_cookie = ap_psprintf(r->pool, "%s=%s; path=/",
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa ap_table_setn(r->headers_out, "Set-Cookie", new_cookie);
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa ap_table_setn(r->notes, "cookie", ap_pstrdup(r->pool, cookiebuf)); /* log first time */
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa cookie_dir_rec *dcfg = ap_get_module_config(r->per_dir_config,
5e6915f767bd46767306abbfbb39ebcbc10a2a33Christian Maeder if ((cookie = ap_table_get(r->headers_in, "Cookie")))
if (cookieend)
make_cookie(r);
return (void *) cls;
return dcfg;
return NULL;
char *word;
return NULL;
while (word[0]) {
if (!word[0])
factor = 0;
return NULL;
return NULL;
{NULL}
static void register_hooks(void)