Apache's support for content negotiation has been updated to meet the HTTP/1.1 specification. It can choose the best representation of a resource based on the browser-supplied preferences for media type, languages, character set and encoding. It is also implements a couple of features to give more intelligent handling of requests from browsers which send incomplete negotiation information.
Content negotiation is provided by the mod_negotiation module, which is compiled in by default.
A resource may be available in several different representations. For example, it might be available in different languages or different media types, or a combination. One way of selecting the most appropriate choice is to give the user an index page, and let them select. However it is often possible for the server to choose automatically. This works because browsers can send as part of each request information about what representations they prefer. For example, a browser could indicate that it would like to see information in French, if possible, else English will do. Browsers indicate their preferences by headers in the request. To request only French representations, the browser would send
Accept-Language: fr
Note that this preference will only be applied when there is a choice of representations and they vary by language.
As an example of a more complex request, this browser has been configured to accept French and English, but prefer French, and to accept various media types, preferring HTML over plain text or other text types, and preferring GIF or JPEG over other media types, but also allowing any other media type as a last resort:
Accept-Language: fr; q=1.0, en; q=0.5 Accept: text/html; q=1.0, text/*; q=0.8, image/gif; q=0.6, image/jpeg; q=0.6, image/*; q=0.5, */*; q=0.1Apache 1.2 supports 'server driven' content negotiation, as defined in the HTTP/1.1 specification. It fully supports the Accept, Accept-Language, Accept-Charset and Accept-Encoding request headers.
The terms used in content negotiation are: a resource is an item which can be requested of a server, which might be selected as the result of a content negotiation algorithm. If a resource is available in several formats, these are called representations or variants. The ways in which the variants for a particular resource vary are called the dimensions of negotiation.
In order to negotiate a resource, the server needs to be given information about each of the variants. This is done in one of two ways:
*.var
file) which
names the files containing the variants explicitly
A type map is a document which is associated with the handler
named type-map
(or, for backwards-compatibility with
older Apache configurations, the mime type
application/x-type-map
). Note that to use this feature,
you've got to have a SetHandler
some place which defines a
file suffix as type-map
; this is best done with a
AddHandler type-map varin
srm.conf
. See comments in the sample config files for
details. Type map files have an entry for each available variant; these entries consist of contiguous RFC822-format header lines. Entries for different variants are separated by blank lines. Blank lines are illegal within an entry. It is conventional to begin a map file with an entry for the combined entity as a whole (although this is not required, and if present will be ignored). An example map file is:
URI: foo URI: foo.en.html Content-type: text/html Content-language: en URI: foo.fr.de.html Content-type: text/html; charset=iso-8859-2 Content-language: fr, deIf the variants have different source qualities, that may be indicated by the "qs" parameter to the media type, as in this picture (available as jpeg, gif, or ASCII-art):
URI: foo URI: foo.jpeg Content-type: image/jpeg; qs=0.8 URI: foo.gif Content-type: image/gif; qs=0.5 URI: foo.txt Content-type: text/plain; qs=0.01
qs values can vary between 0.000 and 1.000. Note that any variant with a qs value of 0.000 will never be chosen. Variants with no 'qs' parameter value are given a qs factor of 1.0.
The full list of headers recognized is:
URI:
Content-type:
image/gif
, text/plain
, or
text/html; level=3
.
Content-language:
en
for English,
kr
for Korean, etc.).
Content-encoding:
x-compress
, or x-gzip
, as appropriate.
Content-length:
This is a per-directory option, meaning it can be set with an
Options
directive within a <Directory>
,
<Location>
or <Files>
section in access.conf
, or (if AllowOverride
is properly set) in .htaccess
files. Note that
Options All
does not set MultiViews
; you
have to ask for it by name. (Fixing this is a one-line change to
http_core.h
).
The effect of MultiViews
is as follows: if the server
receives a request for /some/dir/foo
, if
/some/dir
has MultiViews
enabled, and
/some/dir/foo
does not exist, then the server reads the
directory looking for files named foo.*, and effectively fakes up a
type map which names all those files, assigning them the same media
types and content-encodings it would have if the client had asked for
one of them by name. It then chooses the best match to the client's
requirements, and forwards them along.
This applies to searches for the file named by the
DirectoryIndex
directive, if the server is trying to
index a directory; if the configuration files specify
DirectoryIndex indexthen the server will arbitrate between
index.html
and index.html3
if both are present. If neither are
present, and index.cgi
is there, the server will run it.
If one of the files found when reading the directive is a CGI script, it's not obvious what should happen. The code gives that case special treatment --- if the request was a POST, or a GET with QUERY_ARGS or PATH_INFO, the script is given an extremely high quality rating, and generally invoked; otherwise it is given an extremely low quality rating, which generally causes one of the other views (if any) to be retrieved.