mirror of
https://github.com/apache/httpd.git
synced 2025-09-01 02:02:06 +03:00
a9fbf24e63
Sorry for the huge diff. It seems that switching from Xalan-j to xalan-c causes the attributes to get reordered. Suggestions for improvements to the build system would be greatly appreciated. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@94399 13f79535-47bb-0310-9956-ffa450edef68
129 lines
12 KiB
HTML
129 lines
12 KiB
HTML
<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
This file is generated from xml source: DO NOT EDIT
|
|
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
--><title>mod_usertrack - Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="../style/manual.css"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_usertrack</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>
|
|
This module uses cookies to provide for a
|
|
<em>clickstream</em> log of user activity on a site.
|
|
</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module Identifier:</a></td><td>usertrack_module</td></tr><tr><td valign="top" align="left"><a class="help" href="module-dict.html#Compatibility">Compatibility:</a></td><td><compatibility>Known as mod_cookies prior to Apache 1.3.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2>
|
|
<p>Previous releases of Apache have included a module which
|
|
generates a 'clickstream' log of user activity on a site using
|
|
cookies. This was called the "cookies" module, mod_cookies. In
|
|
Apache 1.2 and later this module has been renamed the "user
|
|
tracking" module, mod_usertrack. This module has been
|
|
simplified and new directives added.</p>
|
|
<h2>Directives</h2><ul><li><a href="#cookiedomain">CookieDomain</a></li><li><a href="#cookieexpires">CookieExpires</a></li><li><a href="#cookiename">CookieName</a></li><li><a href="#cookiestyle">CookieStyle</a></li><li><a href="#cookietracking">CookieTracking</a></li></ul><h2>Logging</h2>
|
|
|
|
|
|
<p>Previously, the cookies module (now the user tracking
|
|
module) did its own logging, using the <code class="directive">CookieLog</code>
|
|
directive. In this release, this module does no logging at all.
|
|
Instead, a configurable log format file should be used to log
|
|
user click-streams. This is possible because the logging module
|
|
now allows multiple log files. The cookie itself is logged by
|
|
using the text <code>%{cookie}n</code> in the log file format. For
|
|
example:</p>
|
|
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
|
|
CustomLog logs/clickstream "%{cookie}n %r %t"
|
|
</code></td></tr></table></blockquote>
|
|
|
|
<p>For backward compatibility the configurable log module
|
|
implements the old <code class="directive">CookieLog</code> directive, but this
|
|
should be upgraded to the above <code class="directive">CustomLog</code> directive. </p>
|
|
<h2>2-digit or 4-digit dates for cookies?</h2>
|
|
|
|
|
|
<p>(the following is from message
|
|
<022701bda43d$9d32bbb0$1201a8c0@christian.office.sane.com>
|
|
in the new-httpd archives) </p>
|
|
<pre>
|
|
From: "Christian Allen" <christian@sane.com>
|
|
Subject: Re: Apache Y2K bug in mod_usertrack.c
|
|
Date: Tue, 30 Jun 1998 11:41:56 -0400
|
|
|
|
Did some work with cookies and dug up some info that might be useful.
|
|
|
|
True, Netscape claims that the correct format NOW is four digit dates, and
|
|
four digit dates do in fact work... for Netscape 4.x (Communicator), that
|
|
is. However, 3.x and below do NOT accept them. It seems that Netscape
|
|
originally had a 2-digit standard, and then with all of the Y2K hype and
|
|
probably a few complaints, changed to a four digit date for Communicator.
|
|
Fortunately, 4.x also understands the 2-digit format, and so the best way to
|
|
ensure that your expiration date is legible to the client's browser is to
|
|
use 2-digit dates.
|
|
|
|
However, this does not limit expiration dates to the year 2000; if you use
|
|
an expiration year of "13", for example, it is interpreted as 2013, NOT
|
|
1913! In fact, you can use an expiration year of up to "37", and it will be
|
|
understood as "2037" by both MSIE and Netscape versions 3.x and up (not sure
|
|
about versions previous to those). Not sure why Netscape used that
|
|
particular year as its cut-off point, but my guess is that it was in respect
|
|
to UNIX's 2038 problem. Netscape/MSIE 4.x seem to be able to understand
|
|
2-digit years beyond that, at least until "50" for sure (I think they
|
|
understand up until about "70", but not for sure).
|
|
|
|
Summary: Mozilla 3.x and up understands two digit dates up until "37"
|
|
(2037). Mozilla 4.x understands up until at least "50" (2050) in 2-digit
|
|
form, but also understands 4-digit years, which can probably reach up until
|
|
9999. Your best bet for sending a long-life cookie is to send it for some
|
|
time late in the year "37".
|
|
</pre>
|
|
|
|
<hr/><h2><a name="CookieDomain">CookieDomain</a> <a name="cookiedomain">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>controls the setting of the domain to which the tracking cookie applies.</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>CookieDomain <em>domain</em></td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>None</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_usertrack</td></tr></table></td></tr></table>
|
|
|
|
<p>This directive controls the setting of the domain to which
|
|
the tracking cookie applies. If not present, no domain is
|
|
included in the cookie header field.</p>
|
|
|
|
<p>The domain string <strong>must</strong> begin with a dot, and
|
|
<strong>must</strong> include at least one embedded dot. That is,
|
|
".foo.com" is legal, but "foo.bar.com" and ".com" are not.</p>
|
|
<hr/><h2><a name="CookieExpires">CookieExpires</a> <a name="cookieexpires">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>CookieExpires <em>expiry-period</em></td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code/></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td/></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_usertrack</td></tr><tr><td valign="top" align="left"><a class="help" href="directive-dict.html#Compatibility">Compatibility:</a></td><td>In 1.3.20 and earlier, not usable in directory and
|
|
.htaccess</td></tr></table></td></tr></table>
|
|
<p>When used, this directive sets an expiry time on the cookie
|
|
generated by the usertrack module. The <em>expiry-period</em>
|
|
can be given either as a number of seconds, or in the format
|
|
such as "2 weeks 3 days 7 hours". Valid denominations are:
|
|
years, months, weeks, hours, minutes and seconds. If the expiry
|
|
time is in any format other than one number indicating the
|
|
number of seconds, it must be enclosed by double quotes.</p>
|
|
|
|
<p>If this directive is not used, cookies last only for the
|
|
current browser session.</p>
|
|
<hr/><h2><a name="CookieName">CookieName</a> <a name="cookiename">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>CookieName <em>token</em></td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>Apache</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_usertrack</td></tr></table></td></tr></table>
|
|
<p>This directive allows you to change the name of the cookie
|
|
this module uses for its tracking purposes. By default the
|
|
cookie is named "<code>Apache</code>".</p>
|
|
|
|
<p>You must specify a valid cookie name; results are
|
|
unpredictable if you use a name containing unusual characters.
|
|
Valid characters include A-Z, a-z, 0-9, "_", and "-".</p>
|
|
<hr/><h2><a name="CookieStyle">CookieStyle</a> <a name="cookiestyle">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Controls the format of the cookie header field</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>CookieStyle
|
|
<em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code/></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_usertrack</td></tr></table></td></tr></table>
|
|
<p>This directive controls the format of the cookie header
|
|
field. The three formats allowed are:</p>
|
|
|
|
<ul>
|
|
<li><strong>Netscape</strong>, which is the original but now deprecated
|
|
syntax. This is the default, and the syntax Apache has
|
|
historically used.</li>
|
|
|
|
<li><strong>Cookie</strong> or <strong>RFC2109</strong>, which is the syntax that
|
|
superseded the Netscape syntax.</li>
|
|
|
|
<li><strong>Cookie2</strong> or <strong>RFC2965</strong>, which is the most
|
|
current cookie syntax.</li>
|
|
</ul>
|
|
|
|
<p>Not all clients can understand all of these formats. but you
|
|
should use the newest one that is generally acceptable to your
|
|
users' browsers.</p>
|
|
<hr/><h2><a name="CookieTracking">CookieTracking</a> <a name="cookietracking">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>CookieTracking on|off</td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code/></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>FileInfo</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_usertrack</td></tr></table></td></tr></table>
|
|
<p>When the user track module is compiled in, and
|
|
"CookieTracking on" is set, Apache will start sending a
|
|
user-tracking cookie for all new requests. This directive can
|
|
be used to turn this behavior on or off on a per-server or
|
|
per-directory basis. By default, compiling mod_usertrack will
|
|
not activate cookies. </p>
|
|
|
|
<hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></blockquote></body></html> |