Content Transformation Guidelines 1b

Group Working Draft 24 November 2007

This version:
http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/071124
Latest version:
http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/latest
Previous version:
http://www.w3.org/2005/MWI/BPWG/Group/TaskForces/CT/editors-drafts/Guidelines/2007-08/CTGuidelines.html
Editors:
Jo Rabin, dotMobi
Rhys Lewis [Initial Draft], Volantis

Abstract

This document is the Guidelines referred to in the Charter of the W3C Mobile Web Initiative Best Practices Working Group Content Transformation Task Force.

Its purpose is to provide guidance to implementors of components of the delivery context as to how to communicate their intentions and capabilities in respect of content transformation.

Status of this Document

This document is an editors' copy that has no official standing.

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.

Publication as a Group Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document has been produced by the Content Transformation Task Force of the Mobile Web Best Practices Working Group as part of the Mobile Web Initiative . Please send comments on this document to the Working Group's public email list public-bpwg-ct@w3.org, a publicly archived mailing list .

This document was produced under the 5 February 2004 W3C Patent Policy . W3C maintains a public list of patent disclosures made in connection with this document; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) with respect to this specification must disclose the information in accordance with section 6 of the W3C Patent Policy.

Revision Description

Work needed on this draft:

1. Work Brian's suggestions into the text

I think the following require mention at least as heuristics, if not recommended practice as they do play a role:

a) a priori knowledge of device characteristics, as gleaned from a DDR;
				b) administrative arrangements, white lists etc.;
				c) heuristics, such as knowing which content types and DTDs are
				specifically mobile, looking for the presence of "handheld" in style
				sheets and @media attributes, looking for mobileOK labels;
				d) User interaction

In reference to one of Bryan's contributions, user interaction needs more thought and discussion - on the one hand we don't want to interrupt the user experience with excise tasks, yet on the other, in the end, the user must act to signal their intentions and this needs noting. E.g. there could be a note that the host should provide interactions that allow the user to have a choice of presentations and so should the proxy and the client, for that matter.

Another as yet unopened Pandora's box is that the discussion and proposed text below looks at the issues primarily from the point of view of "varying presentation from Thematically consistent URIs". What hasn't, as yet, been explored is how it all works if there is a common entry point to a site (Thematically consistent URI for a home page) which then dispatches via redirect to media specific versions. This is possibly rather more common than the previous case (e.g. redirect to example.com/mobile - or rather better, imo, example.mobi). Naturally, there will also be varying presentation even within a redirected solution. This whole area needs further thought.

Whatever we come up with does of course have to deal with conforming and non conforming and transforming and non-transforming proxies. There isn't, as yet, a use case analysis, it is a bit too soon for that, I think.

The philosophy here should be in line with existing HTTP practice, which is to fall back to safe behavior. Thus, when trying to distinguish reformatting behavior from recoding behavior, the objective is to fall back to "safe" known HTTP/1.1 practice for non conforming (unaware) and say things like:

Cache-Control: no-transform, allow-reencode

as this will result in a stricter interpretation by unaware participants. This behavior is discussed in detail in HTTP section 14.9.6 (reproduced below in this note for your convenience and see Sean's detailed list of references to points in the HTTP spec that need to be included also).

This, of course, immediately introduces the question as to whether we are over stepping the mark in introducing such extensions, and I think we need to be clear about that before going further. On the one hand HTTP makes it clear, in explaining how to introduce extensions that it expects such extensions to be introduced. On the other hand, we do typically take a conservative approach and say if it is not in the IANA registry then it's not an existing protocol and therefore beyond our scope. Introducing extensions to existing header values, to my mind falls short of introducing new headers. Though it's not clear that we can do what we need to if we don't do that, go through IANA registration and so on.

I think that we are going to need to do that and suggest we speak to this point tomorrow on our call, if necessary by joining forces with a group that is actually chartered to "invent new protocols". The alternative being a much more insipid document that only gets to a small subset of the problem.

I'd also like to bring the group's attention to the following RFCs:

RFC 2506 Media Feature Tag Registration Procedure
				RFC 2295 Transparent Content Negotiation
				RFC 2296 Remote Variant Selection Algorithm

RFC 2295 is experimental, but actually gets to some of the points we want to make, though doesn't exactly address what we are doing. It's rather a lengthy and detailed read, and has a lot of features that we don't need. It does, however, introduce a couple of headers and field values which have been IANA registered. Also, the main points of the negotiation are implemented in Apache in mod_negotiation (see [APACHE]).

[APACHE] http://httpd.apache.org/docs/2.2/content-negotiation.html

IANA registration is probably a bit of a nuisance, and may be something we don't need to do - e.g. it would seem that the q parameter for content type and much else is not registered. For those of you who fancy a bit of train spotting, I think you'll find registered things at [IANA], though I confess I find this all a bit impenetrable and difficult to navigate.

[IANA] http://www.iana.org/numbers.html

I have tried to take into account the contributions and discussions on the list, especially those threads starting at the following points. Some are quite lengthy threads and can be followed with the "Next in Thread" link:

Magnus's original proposal for 2.1 [1] elaborated in the text below

[1]
				http://lists.w3.org/Archives/Public/public-bpwg-ct/2007Sep/att-0014/00-p
				art
				
				Sean Patterson's original proposal for 2.3 [2] points included in the
				text and included verbatim
				[2] http://lists.w3.org/Archives/Public/public-bpwg-ct/2007Sep/0029.html
				
				Aaron's contribution for section 2.3 [3] points included in the text and
				included verbatim
				[3] http://lists.w3.org/Archives/Public/public-bpwg-ct/2007Sep/0025.html
				
				Pointer to ISSUE-222 TAG Finding on Alternative Representations
				[4] http://lists.w3.org/Archives/Public/public-bpwg-ct/2007Oct/0011.html
				
				Pointer to ISSUE-223 (Jo's CT Shopping List): Various Items to Consider
				for the CT Guidelines
				[5] http://lists.w3.org/Archives/Public/public-bpwg-ct/2007Oct/0012.html
				
				Pointer to ACTION-575 Techniques for Guidelines Document
				[6] http://lists.w3.org/Archives/Public/public-bpwg-ct/2007Oct/0023.html
				
				Scope of CT Guidelines
				[7] http://lists.w3.org/Archives/Public/public-bpwg-ct/2007Oct/0041.html

3. Find a solution to how to communicate the orignal user agent headers: This can be done in at least the following ways: a) by including X-Original-xxx headers b) by including a request body that contains either the original headers or the headers the proxy would have sent if it had replaced the original headers c) by requesting twice, first with the original headers, then if permitted/desirable with the modified headers [understood the limitations wrt GET only, but that is true of any of these solutions, I think], then caching the inference as to whether to modify headers in future requests d) by decorating the modified headers to allow inference as to what their previous value was (e.g. as suggested in the draft sent as response to ACTION-581 adding a parameter where a content type has been inserted in the Accept header)

Table of Contents

1 Introduction
    1.1 Purpose
    1.2 Scope
2 Requirements
    2.1 general requirements
        2.1.1 preferences
        2.1.2 provision of highest-quality content
        2.1.3 detection of CT-awareness
        2.1.4 user agent identification and capabilities disclosure
        2.1.5 original representation availability
    2.2 CT proxy serving CT-unaware CP and browser
        2.2.1 CT-unaware browser user selection of content representation
        2.2.2 CT-unaware browser user selection of original content representation
        2.2.3 CT-unaware browser user selection of alternate content representation
    2.3 CT proxy serving CT-aware CP and CT-unaware browser
        2.3.1 CP directives
    2.4 CT proxy capabilities disclosure to CP
    2.5 CT proxy serving CT-aware CP and CT-aware browser
        2.5.1 browser directives
        2.5.2 CT proxy capabilities disclosure to CT-aware browser
        2.5.3 CT actions disclosure to CT-aware browser
        2.5.4 CT-aware browser selection of original content representation
        2.5.5 CT-aware browser selection of alternate content representation
    2.6 security considerations
    2.7 non-browser user agents
3 Guidelines
    3.1 Objectives
    3.2 Types of Proxy
    3.3 Types of Transformation
    3.4 Alteration of HTTP Requests and Responses
    3.5 Control by Client/User
    3.6 Control by Server
4 Behavior of Components
    4.1 Client Request to Proxy
    4.2 Proxy Request to Server
        4.2.1 Alternative 1
        4.2.2 Alternative 2
    4.3 Server Response to Proxy
    4.4 Proxy Receipt of Response from Server
    4.5 Proxy Response to Client
    4.6 Client Action on Receipt of Response
    4.7 Encoding of [@@new] Features
5 Use Case Analysis
6 Testing
7 Conformance

Appendices

A Scope for Future Work (Non-Normative)
B References (Non-Normative)
C Acknowledgments (Non-Normative)


1 Introduction

2 Requirements

These are pasted verbatim from Bryan's original note

CT = Content Transformation, CP = Content Provider(s)

An entity that is "CT-aware" is assumed to be specifically designed to use or provide CT service per these guidelines. A "CT proxy" is assumed to be CT-aware. A "non-CT proxy" is assumed to be CT-unaware. Browsers and CP may be CT-aware or CT-unaware.

3 Guidelines

From here on, taken from text in email response to ACTION-581

The purpose of this section is to explore the need for actors (clients, proxy servers, gateways, origin servers, etc) to communicate with each other, and also suggest guidelines for doing so. The relevant scenario involving a content transformation proxy is as follows:

There may be other scenarios as well but they will initially be ignored for the sake of simplicity. The needs of these three actors are as follows:

  1. The client browser needs to be able to tell the content transformation proxy:

    1. what media-type (presentation format e.g. desktop, handheld) is desired.

    2. that all content transformation should be avoided, or that reformatting is allowed/desired

    3. what type of mobile device and what user agent is being used

    4. that the device has (zoom, linearize, keyhole) presentation [@@??]

  2. The content transformation proxy needs to be able to tell the origin server:

    1. that some degree of content transformation (re-coding and reformatting) can be performed

    2. Content transformation will be carried out unless instructed not to.

    3. that content is being requested on behalf of something else.

    4. about the delivery context (for example mobile device type and user agent).

    5. That the request headers have been altered (e.g. additional content types inserted) [??]

  3. The origin server needs to be able to tell the content transformation proxy:

    1. that content is already optimized and no additional transformation is required (or that it should not be restructured by may be recoded]

    2. that it's OK to perform additional content transformation.[??]

    3. That it varies its presentation

    4. That it has media-specific presentations

    5. I can't/don't wish to handle this request in its present form

    6. That request headers should/should not be modified

  4. The content transformation proxy needs to be able to tell the client browser:

    1. the status of the content: it is reformatted/recoded/untouched;

    2. where to find the original content if it has been transformed. [@@ should this read "how", or do we suppose that there are "magic" mechanisms/URIs for by-passing proxies?]

4 Behavior of Components

4.1 Client Request to Proxy

The client may request that the Content-Type and Content-Encoding must not be altered in the response by setting the Cache-Control: no-transform directive.

The client may add a [@@preserve-headers directive] to indicate that transforming proxies must not alter other aspects of the request headers, except as permitted by HTTP/1.1 to allow correct operation of caching functions [want to say that do not affect transparency, but that is probably not technically exact]. The [@@preserve-headers directive] may only be present in addition to the no-transform Cache-Control directive.

The client may add an [@@allow-recode directive] to the Cache-Control: no-transform directive, indicating that the proxy may change the format of the response but not restructure the content.

The client may add an [@@allow-compress] to the Cache-Control: no-transform directive, meaning that a proxy may remove redundant white space, recompress images or change the Content-Encoding (to use gzip, from identity, for example).

The client may also add [@@preferred-medium directive] indicating that a preference for a presentation style. The [@@preferred-medium directive] has the form media=presentation-format (as described in RFC ..., current values of the presentation format-directive are taken from IANA ... and include "screen" and "handheld").

[It would be nice if the client were able to indicate what type of presentational capabilites it has, for example, zoom, linearize, keyhole ... @@@ client-feature indication]

4.2 Proxy Request to Server

If the request contains a Cache-Control: no-transform directive [@@or any of the other directives specified in previous section] the proxy must forward the request unaltered to the server.

If there are no [@@ such directives] present in the request from the client, and there is no indication from a downstream proxy that it intends to transform [@@ see I will transform below] the proxy should analyze whether it intends to offer transformation services by referring to any administrative arrangements that are in place with the user of the client, or the server, and any a priori knowledge it has of client capabilities [@@ from a DDR and so on]. Knowing that the client has available a linearization or zoom capability the proxy should not broad range of formats the proxy should not offer to recode content.

If as a result of this deliberation it intends to restructure the proxy must indicate this by including a [@@@ I will transform (restructure / reformat / compress)] - [@@ and even if it doesn't it may indicate its potential for restructuring or recoding or compressing content [@@by means of ...].

The proxy must include a Via HTTP header indicating its presence.

Proxies must not intervene in https and should not intervene in methods other than GET and HEAD.

4.3 Server Response to Proxy

If the server varies its presentation according to examination of received HTTP Headers then it must include a Vary HTTP header indicating this to be the case. If, in addition to, or instead of HTTP headers, the server varies its presentation on other factors (source IP Address ...) then it must include a * as one of the fields in the Vary response.

The server must include a no-transform directive if one is received from the client. If it is capable of varying its presentation it should take account of client capabilities [@@as derived from a DDR etc.] and formulate an appropriate experience according to those criteria.

If the server has distinct presentations according to its perception of the presentation media, then the medium for which the presentation is intended should be indicated [@@using the ...]

If the client has requested a specific presentation using the [@@ directive] the server should provide a presentation of that kind. e.g. if the server would ordinarily provide a handheld experience but the client requests a screen experience the screen experience should be provided. And vice versa, of course.

If the server creates a specific user experience for certain presentation media types it should inhibit transformation of the response by including a no-transform directive. The server should not prohibit recoding or compression of its content unless it has specific reasons not to allow it [including that this has been requested by the client] and hence should in general add a [@@allow-recoding or allow-compression] directive when adding a no-transform directive.

Note that including a no-transform directive may [@@should actually] disrupt the behaviour of WAP/WML proxies, because this inhibits such proxies from converting WML to WMLC (because this is a content-encoding behavior). Adding [@@allow-recoding] or [@@allow-compression] is unlikely to be recognized in the short-term by such proxies which predate these guidelines.

Servers may base their actions on a priori knowledge of behaviour of transforming proxies, when they are identified in a Via header.

The server should not choose a Content-Type for its response based on its assumptions about the heuristic behavior of any intermediaries. (e.g. it should not choose content-type: application/vnd.wap.xhtml+xml solely on the basis that it suspects that transforming proxies will apply heuristics that make them not restructure it).

If servers provide only limited variants of presentation they should consider providing a rich presentation and allowing a transforming proxy to reduce this - which may result in a richer experience for the user than providing a basic handheld experience only, say.

406 Response - Note that some clients (MSIE for instance) don't display the body of a 406 response, this is in contravention of HTTP/1.1 as far as I can see.

Vary headers in 406 response - restrict to the one(s) that have caused the 406.

In general, successful responses should are done with 200 OK Vary: User-Agent, Accept, Accept-Language etc. e.g. MS doesn't want you to do updates except with IE. so they should say 406 Vary: User-Agent (but note that IE doesn't display the body of 406 responses)

Servers should respond with a 406 not a 200 if they can't handle the request and should indicate that they permit header alteration in that 406. Servers should provide information about alternative representations by using the Vary header (if the alternatives are available from the same URI) or using link information if alternative representations are handled by different URIs. [This restricts to HTML for now. If link headers a reinstated in HTTP then this becomes a more universal mechanism. Open question as to whether it SVG or WICD etc. support any such notion]

[@@300 Response - could this be used as a signal from the server to say that it understands the protocol? A la RFC 2295]

5 Use Case Analysis

Client Proxy Server

Unaware Unaware Unaware etc.

[@@TBD]

6 Testing

All ... must be tested for deleterious effects ... [@@TBD]

Providers of transforming proxies should make available interfaces that facilitate testing of Web sites accessed through them. [@@ though how they should make known how to do this and what administrative arrangements would be needed are both probably out of scope]

7 Conformance

A Scope for Future Work (Non-Normative)

A placeholder for the bits we couldn't do

B References (Non-Normative)

BestPractices
Mobile Web Best Practices 1.0 Basic Guidelines, Jo Rabin, Charles McCathieNevile (eds), W3C Proposed Recommendation, 2 November 2006 (See http://www.w3.org/TR/mobile-bp/.)
CT-Landscape
Content Transformation Landscape 1.0, Jo Rabin, Andrew Swainston (eds), W3C Working Draft 25 October 2007 (See http://www.w3.org/TR/ct-landscape/.)
HTTP
Hypertext Transfer Protocol -- HTTP/1.1 Request for Comments: 2616, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. Leach, T. Berners-Lee, June 1999 (See http://tools.ietf.org/html/rfc2616.)

C Acknowledgments (Non-Normative)

The editors acknowledge contributions of various kinds from members of the MWI BPWG Content Transformation Task Force.

The editors acknowledge significant written contributions from: