home *** CD-ROM | disk | FTP | other *** search
/ The Hacker's Encyclopedia 1998 / hackers_encyclopedia.iso / rfc / 3 / rfc2291.txt < prev    next >
Encoding:
Text File  |  2003-06-11  |  43.0 KB  |  1,180 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                                          J. Slein
  8. Request for Comments: 2291                            Xerox Corporation
  9. Category: Informational                                       F. Vitali
  10.                                                   University of Bologna
  11.                                                            E. Whitehead
  12.                                                             U.C. Irvine
  13.                                                               D. Durand
  14.                                                       Boston University
  15.                                                           February 1998
  16.  
  17.  
  18.         Requirements for a Distributed Authoring and Versioning
  19.                     Protocol for the World Wide Web
  20.  
  21. Status of this Memo
  22.  
  23.    This memo provides information for the Internet community.  It does
  24.    not specify an Internet standard of any kind.  Distribution of this
  25.    memo is unlimited.
  26.  
  27. Copyright Notice
  28.  
  29.    Copyright (C) The Internet Society (1998).  All Rights Reserved.
  30.  
  31. Abstract
  32.  
  33.    Current World Wide Web (WWW or Web) standards provide simple support
  34.    for applications which allow remote editing of typed data. In
  35.    practice, the existing capabilities of the WWW have proven inadequate
  36.    to support efficient, scalable remote editing free of overwriting
  37.    conflicts. This document presents a list of features in the form of
  38.    requirements for a Web Distributed Authoring and Versioning protocol
  39.    which, if implemented, would improve the efficiency of common remote
  40.    editing operations, provide a locking mechanism to prevent overwrite
  41.    conflicts, improve link management support between non-HTML data
  42.    types, provide a simple attribute-value metadata facility, provide
  43.    for the creation and reading of container data types, and integrate
  44.    versioning into the WWW.
  45.  
  46. 1. Introduction
  47.  
  48.    This document describes functionality which, if incorporated in an
  49.    extension to the existing HTTP proposed standard [HTTP], would allow
  50.    tools for remote loading, editing and saving (publishing) of various
  51.    media types on the WWW to interoperate with any compliant Web server.
  52.    As much as possible, this functionality is described without
  53.    suggesting a proposed implementation, since there are many ways to
  54.    perform the functionality within the WWW framework. It is also
  55.  
  56.  
  57.  
  58. Slein, et. al.               Informational                      [Page 1]
  59.  
  60. RFC 2291          Distributed Authoring and Versioning     February 1998
  61.  
  62.  
  63.    possible that a single mechanism could simultaneously satisfy several
  64.    requirements.
  65.  
  66.    This document reflects the consensus of the WWW Distributed Authoring
  67.    and Versioning working group (WebDAV) as to the functionality that
  68.    should be standardized to support distributed authoring and
  69.    versioning on the Web.  As with any set of requirements, practical
  70.    considerations may make it impossible to satisfy them all.  It is the
  71.    intention of the WebDAV working group to come as close as possible to
  72.    satisfying them in the specifications that make up the WebDAV
  73.    protocol.
  74.  
  75. 2. Rationale
  76.  
  77.    Current Web standards contain functionality which enables the editing
  78.    of Web content at a remote location, without direct access to the
  79.    storage media via an operating system. This capability is exploited
  80.    by several existing HTML distributed authoring tools, and by a
  81.    growing number of mainstream applications (e.g., word processors)
  82.    which allow users to write (publish) their work to an HTTP server. To
  83.    date, experience from the HTML authoring tools has shown they are
  84.    unable to meet their users' needs using the facilities of Web
  85.    standards. The consequence of this is either postponed introduction
  86.    of distributed authoring capability, or the addition of nonstandard
  87.    extensions to the HTTP protocol or other Web standards.  These
  88.    extensions, developed in isolation, are not interoperable.
  89.  
  90.    Other authoring applications have wanted to access document
  91.    repositories or version control systems through Web gateways, and
  92.    have been similarly frustrated.  Where this access is available at
  93.    all, it is through nonstandard extensions to HTTP or other standards
  94.    that force clients to use a different interface for each vendor's
  95.    service.
  96.  
  97.    This document describes requirements for a set of standard extensions
  98.    to HTTP that would allow distributed Web authoring tools to provide
  99.    the functionality their users need by means of the same standard
  100.    syntax across all compliant servers. The broad categories of
  101.    functionality that need to be standardized are:
  102.  
  103.         Properties
  104.         Links
  105.         Locking
  106.         Reservations
  107.         Retrieval of Unprocessed Source
  108.         Partial Write
  109.         Name Space Manipulation
  110.         Collections
  111.  
  112.  
  113.  
  114. Slein, et. al.               Informational                      [Page 2]
  115.  
  116. RFC 2291          Distributed Authoring and Versioning     February 1998
  117.  
  118.  
  119.         Versioning
  120.         Variants
  121.         Security
  122.         Internationalization
  123.  
  124. 3. Terminology
  125.  
  126.    Where there is overlap, usage is intended to be consistent with that
  127.    in the HTTP 1.1 specification [HTTP].
  128.  
  129.    Client
  130.         A program which issues HTTP requests and accepts responses.
  131.  
  132.    Collection
  133.         A collection is a resource that contains other resources, either
  134.         directly or by reference.
  135.  
  136.    Distributed Authoring Tool
  137.         A program which can retrieve a source entity via HTTP, allow
  138.         editing of this entity, and then save/publish this entity to a
  139.         server using HTTP.
  140.  
  141.    Entity
  142.         The information transferred in a request or response.
  143.  
  144.    Hierarchical Collection
  145.         A hierarchical organization of resources.  A hierarchical
  146.         collection is a resource that contains other resources,
  147.         including collections, either directly or by reference.
  148.  
  149.    Link
  150.         A typed connection between two or more resources.
  151.  
  152.    Lock
  153.         A mechanism for preventing anyone other than the owner of the
  154.         lock from accessing a resource.
  155.  
  156.    Member of Version Graph
  157.         A resource that is a node in a version graph, and so is derived
  158.         from the resources that precede it in the graph, and is the
  159.         basis of those that succeed it.
  160.  
  161.    Property
  162.         Named descriptive information about a resource.
  163.  
  164.    Reservation
  165.         A declaration that one intends to edit a resource.
  166.  
  167.  
  168.  
  169.  
  170. Slein, et. al.               Informational                      [Page 3]
  171.  
  172. RFC 2291          Distributed Authoring and Versioning     February 1998
  173.  
  174.  
  175.    Resource
  176.         A network data object or service that can be identified by a
  177.         URI.
  178.  
  179.    Server
  180.         A program which receives and responds to HTTP requests.
  181.  
  182.    User Agent
  183.         The client that initiates a request.
  184.  
  185.    Variant
  186.         A representation of a resource.  A resource may have one or more
  187.         representations associated with it at any given time.
  188.  
  189.    Version Graph
  190.         A directed acyclic graph with resources as its nodes, where each
  191.         node is derived from its predecessor(s).
  192.  
  193.    Write Lock
  194.         A lock that prevents anyone except its owner from modifying the
  195.         resource it applies to.
  196.  
  197. 4. General Principles
  198.  
  199.    This section describes a set of general principles that the WebDAV
  200.    extensions should follow.  These principles cut across categories of
  201.    functionality.
  202.  
  203. 4.1. User Agent Interoperability
  204.  
  205.    All WebDAV clients should be able to work with any WebDAV-compliant
  206.    HTTP server. It is acceptable for some client/server combinations to
  207.    provide special features that are not universally available, but the
  208.    protocol should be sufficient that a basic level of functionality
  209.    will be universal.
  210.  
  211. 4.2. Client Simplicity
  212.  
  213.    The WebDAV extensions should be designed to allow client
  214.    implementations to be simple.
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226. Slein, et. al.               Informational                      [Page 4]
  227.  
  228. RFC 2291          Distributed Authoring and Versioning     February 1998
  229.  
  230.  
  231. 4.3. Legacy Client Support
  232.  
  233.    It should be possible to implement a WebDAV-compliant server in such
  234.    a way that it can interoperate with non-WebDAV clients.  Such a
  235.    server would be able to understand any valid HTTP 1.1 request from an
  236.    ordinary Web client without WebDAV extensions, and to provide a valid
  237.    HTTP 1.1 response that does not require the client to understand the
  238.    extensions.
  239.  
  240. 4.4. Data Format Compatibility
  241.  
  242.    WebDAV-compliant servers should be able to work with existing
  243.    resources and URIs [URL]. Special additional information should not
  244.    become a mandatory part of document formats.
  245.  
  246. 4.5. Replicated, Distributed Systems
  247.  
  248.    Distribution and replication are at the heart of the Internet.  All
  249.    WebDAV extensions should be designed to allow for distribution and
  250.    replication.  Version trees should be able to be split across
  251.    multiple servers.  Collections may have members on different servers.
  252.    Any resource may be cached or replicated for mobile computing or
  253.    other reasons.  Consequently, the WebDAV extensions must be able to
  254.    operate in a distributed, replicated environment.
  255.  
  256. 4.6 Parsimony in Client-Server Interactions
  257.  
  258.    The WebDAV extensions should keep to a minimum the number of
  259.    interactions between the client and the server needed to perform
  260.    common functions. For example, publishing a document to the Web will
  261.    often mean publishing content together with related properties.  A
  262.    client may often need to find out what version graph a particular
  263.    resource belongs to, or to find out which resource in a version graph
  264.    is the published one.  The extensions should make it possible to do
  265.    these things efficiently.
  266.  
  267. 4.7. Changes to HTTP
  268.  
  269.    WebDAV adds a number of new types of objects to the Web: properties,
  270.    collections, version graphs, etc.  Existing HTTP methods such as
  271.    DELETE and PUT will have to operate in well-defined ways in this
  272.    expanded environment. WebDAV should explicitly address not only new
  273.    methods, headers, and MIME types, but also any required changes to
  274.    the existing HTTP methods and headers.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282. Slein, et. al.               Informational                      [Page 5]
  283.  
  284. RFC 2291          Distributed Authoring and Versioning     February 1998
  285.  
  286.  
  287. 4.8. Alternate Transport Mechanisms
  288.  
  289.    It may be desirable to transport WebDAV requests and responses by
  290.    other mechanisms, particularly EMail, in addition to HTTP.  The
  291.    WebDAV protocol specification should not preclude a future body from
  292.    developing an interoperability specification for disconnected
  293.    operation via EMail.
  294.  
  295. 5. Requirements
  296.  
  297.    In the requirement descriptions below, the requirement will be
  298.    stated, followed by its rationale.
  299.  
  300. 5.1. Properties
  301.  
  302. 5.1.1. Functional Requirements
  303.  
  304.    It must be possible to create, modify, read and delete arbitrary
  305.    properties on resources of any media type.
  306.  
  307. 5.1.2. Rationale
  308.  
  309.    Properties describe resources of any media type.  They may include
  310.    bibliographic information such as author, title, publisher, and
  311.    subject, constraints on usage, PICS ratings, etc. These properties
  312.    have many uses, such as supporting searches on property values,
  313.    enforcing copyrights, and the creation of catalog entries as
  314.    placeholders for objects which are not available in electronic form,
  315.    or which will be available later.
  316.  
  317. 5.2. Links
  318.  
  319. 5.2.1. Functional Requirements
  320.  
  321.    It must be possible to create, modify, read and delete typed links
  322.    between resources of any media type.
  323.  
  324. 5.2.2. Rationale
  325.  
  326.    One type of link between resources is the hypertext link, which is
  327.    browsable using a hypertext style point-and-click user interface.
  328.    Links, whether they are browsable hypertext links, or simply a means
  329.    of capturing a relationship between resources, have many purposes.
  330.    Links can support pushbutton printing of a multi-resource document in
  331.    a prescribed order, jumping to the access control page for a
  332.    resource, and quick browsing of related information, such as a table
  333.  
  334.  
  335.  
  336.  
  337.  
  338. Slein, et. al.               Informational                      [Page 6]
  339.  
  340. RFC 2291          Distributed Authoring and Versioning     February 1998
  341.  
  342.  
  343.    of contents, an index, a glossary, a bibliographic record, help
  344.    pages, etc. While link support is provided by the HTML "LINK"
  345.    element, this is limited only to HTML resources [HTML]. Similar
  346.    support is needed for bitmap image types, and other non-HTML media
  347.    types.
  348.  
  349. 5.3. Locking
  350.  
  351. 5.3.1. General Principles
  352.  
  353.    5.3.1.1. Independence of locks. It must be possible to lock a
  354.    resource without performing an additional retrieval of the resource,
  355.    and without committing to editing the resource.
  356.  
  357.    5.3.1.2. Multi-Resource Locking. It must be possible to take out a
  358.    lock on multiple resources residing on the same server in a single
  359.    action, and this locking operation must be atomic across these
  360.    resources.
  361.  
  362. 5.3.2. Functional Requirements
  363.  
  364.    5.3.2.1. Write Locks. It must be possible to restrict modification of
  365.    a resource to a specific person.
  366.  
  367.    5.3.2.2. Lock Query. It must be possible to find out whether a given
  368.    resource has any active locks, and if so, who holds those locks.
  369.  
  370.    5.3.2.3. Unlock. It must be possible to remove a lock.
  371.  
  372. 5.3.3. Rationale
  373.  
  374.    At present, the Web provides limited support for preventing two or
  375.    more people from overwriting each other's modifications when they
  376.    save to a given URI. Furthermore, there is no way to discover whether
  377.    someone else is currently making modifications to a resource. This is
  378.    known as the "lost update problem," or the "overwrite problem." Since
  379.    there can be significant cost associated with discovering and
  380.    repairing lost modifications, preventing this problem is crucial for
  381.    supporting distributed authoring. A write lock ensures that only one
  382.    person may modify a resource, preventing overwrites. Furthermore,
  383.    locking support is a key component of many versioning schemes, a
  384.    desirable capability for distributed authoring.
  385.  
  386.    An author may wish to lock an entire web of resources even though he
  387.    is editing just a single resource, to keep the other resources from
  388.    changing. In this way, an author can ensure that if a local hypertext
  389.    web is consistent in his distributed authoring tool, it will then be
  390.  
  391.  
  392.  
  393.  
  394. Slein, et. al.               Informational                      [Page 7]
  395.  
  396. RFC 2291          Distributed Authoring and Versioning     February 1998
  397.  
  398.  
  399.    consistent when he writes it to the server. Because of this, it
  400.    should be possible to take out a lock without also causing
  401.    transmission of the contents of a resource.
  402.  
  403.    It is often necessary to guarantee that a lock or unlock operation
  404.    occurs at the same time across multiple resources, a feature which is
  405.    supported by the multiple-resource locking requirement. This is
  406.    useful for preventing a collision between two people trying to
  407.    establish locks on the same set of resources, since with multi-
  408.    resource locking, one of the two people will get a lock. If this same
  409.    multiple-resource locking scenario was repeated by using atomic lock
  410.    operations iterated across the resources, the result would be a
  411.    splitting of the locks between the two people, based on resource
  412.    ordering and race conditions.
  413.  
  414. 5.4. Reservations
  415.  
  416. 5.4.1. Functional Requirements
  417.  
  418.    5.4.1.1. Reserve. It must be possible for a principal to register
  419.    with the server an intent to edit a given resource, so that other
  420.    principals can discover who intends to edit the resource.
  421.  
  422.    5.4.1.2. Reservation Query. It must be possible to find out whether a
  423.    given resource has any active reservations, and if so, who currently
  424.    holds reservations.
  425.  
  426.    5.4.1.3. Release Reservation.  It must be possible to release the
  427.    reservation.
  428.  
  429. 5.4.2. Rationale
  430.  
  431.    Experience from configuration management systems has shown that
  432.    people need to know when they are about to enter a parallel editing
  433.    situation. Once notified, they either decide not to edit in parallel
  434.    with the other authors, or they use out-of-band communication (face-
  435.    to-face, telephone, etc.) to coordinate their editing to minimize the
  436.    difficulty of merging their results. Reservations are separate from
  437.    locking, since a write lock does not necessarily imply a resource
  438.    will be edited, and a reservation does not carry with it any access
  439.    restrictions. This capability supports versioning, since a check-out
  440.    typically involves taking out a write lock, making a reservation, and
  441.    getting the resource to be edited.
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450. Slein, et. al.               Informational                      [Page 8]
  451.  
  452. RFC 2291          Distributed Authoring and Versioning     February 1998
  453.  
  454.  
  455. 5.5. Retrieval of Unprocessed Source for Editing
  456.  
  457. 5.5.1. Functional Requirement
  458.  
  459.    The source of any given resource must be retrievable by any principal
  460.    with authorization to edit the resource.
  461.  
  462. 5.5.2. Rationale
  463.  
  464.    There are many cases where the source stored on a server does not
  465.    correspond to the actual entity transmitted in response to an HTTP
  466.    GET. Current known cases are server side include directives, and
  467.    Standard Generalized Markup Language (SGML) source which is converted
  468.    on the fly to HyperText Markup Language (HTML) [HTML] output
  469.    entities. There are many possible cases, such as automatic conversion
  470.    of bitmap images into several variant bitmap media types (e.g. GIF,
  471.    JPEG), and automatic conversion of an application's native media type
  472.    into HTML. As an example of this last case, a word processor could
  473.    store its native media type on a server which automatically converts
  474.    it to HTML. A GET of this resource would retrieve the HTML.
  475.    Retrieving the source would retrieve the word processor native
  476.    format.
  477.  
  478. 5.6. Partial Write.
  479.  
  480. 5.6.1. Functional Requirement
  481.  
  482.    After editing a resource, it must be possible to write only the
  483.    changes to the resource, rather than retransmitting the entire
  484.    resource.
  485.  
  486. 5.6.2. Rationale
  487.  
  488.    During distributed editing which occurs over wide geographic
  489.    separations and/or over low bandwidth connections, it is extremely
  490.    inefficient and frustrating to rewrite a large resource after minor
  491.    changes, such as a one-character spelling correction. Support is
  492.    needed for transmitting "insert" (e.g., add this sentence in the
  493.    middle of a document) and "delete" (e.g. remove this paragraph from
  494.    the middle of a document) style updates. Support for partial resource
  495.    updates will make small edits more efficient, and allow distributed
  496.    authoring tools to scale up for editing large documents.
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506. Slein, et. al.               Informational                      [Page 9]
  507.  
  508. RFC 2291          Distributed Authoring and Versioning     February 1998
  509.  
  510.  
  511. 5.7. Name Space Manipulation
  512.  
  513. 5.7.1. Copy
  514.  
  515. 5.7.1.1. Functional Requirements
  516.  
  517.    It must be possible to duplicate a resource without a client loading,
  518.    then resaving the resource. After the copy operation, a modification
  519.    to either resource must not cause a modification to the other.
  520.  
  521. 5.7.1.2. Rationale
  522.  
  523.    There are many reasons why a resource might need to be duplicated,
  524.    such as changing ownership, preparing for major modifications, or
  525.    making a backup. Due to network costs associated with loading and
  526.    saving a resource, it is far preferable to have a server perform a
  527.    resource copy than a client.
  528.  
  529. 5.7.2. Move/Rename
  530.  
  531. 5.7.2.1. Functional Requirements
  532.  
  533.    It must be possible to change the location of a resource without a
  534.    client loading, then resaving the resource under a different name.
  535.    After the move operation, it must no longer be possible to access the
  536.    resource at its original location.
  537.  
  538. 5.7.2.2. Rationale
  539.  
  540.    It is often necessary to change the name of a resource, for example
  541.    due to adoption of a new naming convention, or if a typing error was
  542.    made entering the name originally. Due to network costs, it is
  543.    undesirable to perform this operation by loading, then resaving the
  544.    resource, followed by a delete of the old resource. Similarly, a
  545.    single rename operation is more efficient than a copy followed by a
  546.    delete operation.  Note that moving a resource is considered the same
  547.    function as renaming a resource.
  548.  
  549. 5.8. Collections
  550.  
  551.    A collection is a resource that is a container for other resources,
  552.    including other collections.  A resource may belong to a collection
  553.    either directly or by reference.  If a resource belongs to a
  554.    collection directly, name space operations like copy, move, and
  555.    delete applied to the collection also apply to the resource.  If a
  556.    resource belongs to a collection by reference, name space operations
  557.    applied to the collection affect only the reference, not the resource
  558.    itself.
  559.  
  560.  
  561.  
  562. Slein, et. al.               Informational                     [Page 10]
  563.  
  564. RFC 2291          Distributed Authoring and Versioning     February 1998
  565.  
  566.  
  567. 5.8.1. Functional Requirements
  568.  
  569.    5.8.1.1. List Collection. A listing of all resources in a specific
  570.    collection must be accessible.
  571.  
  572.    5.8.1.2. Make Collection. It must be possible to create a new
  573.    collection.
  574.  
  575.    5.8.1.3. Add to Collection.  It must be possible to add a resource to
  576.    a collection directly or by reference.
  577.  
  578.    5.8.1.4. Remove from Collection.  It must be possible to remove a
  579.    resource from a collection.
  580.  
  581. 5.8.2. Rationale
  582.  
  583.    In [URL] it states that, "some URL schemes (such as the ftp, http,
  584.    and file schemes) contain names that can be considered hierarchical."
  585.    Especially for HTTP servers which directly map all or part of their
  586.    URL name space into a filesystem, it is very useful to get a listing
  587.    of all resources located at a particular hierarchy level. This
  588.    functionality supports "Save As..." dialog boxes, which provide a
  589.    listing of the entities at a current hierarchy level, and allow
  590.    navigation through the hierarchy. It also supports the creation of
  591.    graphical visualizations (typically as a network) of the hypertext
  592.    structure among the entities at a hierarchy level, or set of levels.
  593.    It also supports a tree visualization of the entities and their
  594.    hierarchy levels.
  595.  
  596.    In addition, document management systems may want to make their
  597.    documents accessible through the Web.  They typically allow the
  598.    organization of documents into collections, and so also want their
  599.    users to be able to view the collection hierarchy through the Web.
  600.  
  601.    There are many instances where there is not a strong correlation
  602.    between a URL hierarchy level and the notion of a collection. One
  603.    example is a server in which the URL hierarchy level maps to a
  604.    computational process which performs some resolution on the name. In
  605.    this case, the contents of the URL hierarchy level can vary depending
  606.    on the input to the computation, and the number of resources
  607.    accessible via the computation can be very large. It does not make
  608.    sense to implement a directory feature for such a name space.
  609.    However, the utility of listing the contents of those URL hierarchy
  610.    levels which do correspond to collections, such as the large number
  611.    of HTTP servers which map their name space to a filesystem, argue for
  612.    the inclusion of this capability, despite not being meaningful in all
  613.  
  614.  
  615.  
  616.  
  617.  
  618. Slein, et. al.               Informational                     [Page 11]
  619.  
  620. RFC 2291          Distributed Authoring and Versioning     February 1998
  621.  
  622.  
  623.    cases. If listing the contents of a URL hierarchy level does not
  624.    makes sense for a particular URL, then a "405 Method Not Allowed"
  625.    status code could be issued.
  626.  
  627.    The ability to create collections to hold related resources supports
  628.    management of a name space by packaging its members into small,
  629.    related clusters. The utility of this capability is demonstrated by
  630.    the broad implementation of directories in recent operating systems.
  631.    The ability to create a collection also supports the creation of
  632.    "Save As..." dialog boxes with "New Level/Folder/Directory"
  633.    capability, common in many applications.
  634.  
  635. 5.9. Versioning
  636.  
  637. 5.9.1. Background and General Principles
  638.  
  639.    5.9.1.1. Stability of versions. Most versioning systems are intended
  640.    to provide an accurate record of the history of evolution of a
  641.    document. This accuracy is ensured by the fact that a version
  642.    eventually becomes "frozen" and immutable. Once a version is frozen,
  643.    further changes will create new versions rather than modifying the
  644.    original. In order for caching and persistent references to be
  645.    properly maintained, a client must be able to determine that a
  646.    version has been frozen. Any successful attempt to retrieve a frozen
  647.    version of a resource will always retrieve exactly the same content,
  648.    or return an error if that version (or the resource itself) is no
  649.    longer available.
  650.  
  651.    5.9.1.2. Operations for Creating New Versions.  Version management
  652.    systems vary greatly in the operations they require, the order of the
  653.    operations, and how they are combined into atomic functions.  In the
  654.    most complete cases, the logical operations involved are:
  655.  
  656.         o Reserve existing version
  657.         o Lock existing version
  658.         o Retrieve existing version
  659.         o Request or suggest identifier for new version
  660.         o Write new version
  661.         o Release lock
  662.         o Release reservation
  663.  
  664.    With the exception of requesting a new version identifier, all of
  665.    these operations have applications outside of versioning and are
  666.    either already part of HTTP or are discussed in earlier sections of
  667.    these requirements. Typically, versioning systems combine
  668.    reservation, locking, and retrieval -- or some subset of these --
  669.    into an atomic checkout function.  They combine writing, releasing
  670.  
  671.  
  672.  
  673.  
  674. Slein, et. al.               Informational                     [Page 12]
  675.  
  676. RFC 2291          Distributed Authoring and Versioning     February 1998
  677.  
  678.  
  679.    the lock, and releasing the reservation -- or some subset of these --
  680.    into an atomic checkin function.  The new version identifier may be
  681.    assigned either at checkout or at checkin.
  682.  
  683.    The WebDAV extensions must find some balance between allowing
  684.    versioning servers to adopt whatever policies they wish with regard
  685.    to these operations and enforcing enough uniformity to keep client
  686.    implementations simple.
  687.  
  688.    5.9.1.3. The Versioning Model.  Each version typically stands in a
  689.    "derived from" relationship to its predecessor(s).  It is possible to
  690.    derive several different versions from a single version (branching),
  691.    and to derive a single version from several versions (merging).
  692.    Consequently, the collection of related versions forms a directed
  693.    acyclic graph.  In the following discussion, this graph will be
  694.    called a "version graph".  Each node of this graph is a "version" or
  695.    "member of the version graph".  The arcs of the graph capture the
  696.    "derived from" relationships.
  697.  
  698.    It is also possible for a single resource to participate in multiple
  699.    version graphs.
  700.  
  701.    The WebDAV extensions should support this versioning model, though
  702.    particular servers may restrict it in various ways.
  703.  
  704.    5.9.1.4. Versioning Policies. Many writers, including Feiler [CM] and
  705.    Haake and Hicks [VSE], have discussed the notion of versioning styles
  706.    (referred to here as versioning policies, to reflect the nature of
  707.    client/server interaction) as one way to think about the different
  708.    policies that versioning systems implement. Versioning policies
  709.    include decisions on the shape of version histories (linear or
  710.    branched), the granularity of change tracking, locking requirements
  711.    made by a server, etc. The protocol should clearly identify the
  712.    policies that it dictates and the policies that are left up to
  713.    versioning system implementors or administrators.
  714.  
  715.    5.9.1.5. It is possible to version resources of any media type.
  716.  
  717. 5.9.2. Functional Requirements
  718.  
  719.    5.9.2.1. Referring to a version graph. There must be a way to refer
  720.    to a version graph as a whole.
  721.  
  722.    Some queries and operations apply, not to any one member of a version
  723.    graph, but to the version graph as a whole.  For example, a client
  724.    may request that an entire graph be moved, or may ask for a version
  725.    history. In these cases, a way to refer to the whole version graph is
  726.    required.
  727.  
  728.  
  729.  
  730. Slein, et. al.               Informational                     [Page 13]
  731.  
  732. RFC 2291          Distributed Authoring and Versioning     February 1998
  733.  
  734.  
  735.    5.9.2.2. Referring to a specific member of a version graph. There
  736.    must be a way to refer to each member of a version graph. This means
  737.    that each member of the graph is itself a resource.
  738.  
  739.    Each member of a version graph must be a resource if it is to be
  740.    possible for a hypertext link to refer to specific version of a page,
  741.    or for a client to request a specific version of a document for
  742.    editing.
  743.  
  744.    5.9.2.3. A client must be able to determine whether a resource is a
  745.    version graph, or whether a resource is itself a member of a version
  746.    graph.
  747.  
  748.    A resource may be a simple, non-versioned resource, or it may be a
  749.    version graph, or it may be a member of a version graph.  A client
  750.    needs to be able to tell which sort of resource it is accessing.
  751.  
  752.    5.9.2.4. There must be a way to refer to a server-defined default
  753.    member of a version graph.
  754.  
  755.    The server should return a default version of a resource for requests
  756.    that ask for the default version, as well as for requests where no
  757.    specific version information is provided. This is one of the simplest
  758.    ways to guarantee non-versioning client compatibility. This does not
  759.    rule out the possibility of a server returning an error when no
  760.    sensible default exists.
  761.  
  762.    It may also be desirable to be able to refer to other special members
  763.    of a version graph. For example, there may be a current version for
  764.    editing that is different from the default version.  For a graph with
  765.    several branches, it may be useful to be able to request the tip
  766.    version of any branch.
  767.  
  768.    5.9.2.5. It must be possible, given a reference to a member of a
  769.    version graph, to find out which version graph(s) that resource
  770.    belongs to.
  771.  
  772.    This makes it possible to understand the versioning context of the
  773.    resource. It makes it possible to retrieve a version history for the
  774.    graphs to which it belongs, and to browse the version graph. It also
  775.    supports some comparison operations: It makes it possible to
  776.    determine whether two references designate members of the same
  777.    version graph.
  778.  
  779.    5.9.2.6. Navigation of a version graph.  Given a reference to a
  780.    member of a version graph, it must be possible to discover and access
  781.    the following related members of the version graph.
  782.  
  783.  
  784.  
  785.  
  786. Slein, et. al.               Informational                     [Page 14]
  787.  
  788. RFC 2291          Distributed Authoring and Versioning     February 1998
  789.  
  790.  
  791.         o root member of the graph
  792.         o predecessor member(s)
  793.         o successor member(s)
  794.         o default member of the graph
  795.  
  796.    It must be possible in some way for a versioning client to access
  797.    versions related to a resource currently being examined.
  798.  
  799.    5.9.2.7. Version Topology. There must be a way to retrieve the
  800.    complete version topology for a version graph, including information
  801.    about all members of the version graph. The format for this
  802.    information must be standardized so that the basic information can be
  803.    used by all clients. Other specialized formats should be
  804.    accommodated, for servers and clients that require information that
  805.    cannot be included in the standard topology.
  806.  
  807.    5.9.2.8. A client must be able to propose a version identifier to be
  808.    used for a new member of a version graph. The server may refuse to
  809.    use the client's suggested version identifier.  The server should
  810.    tell the client what version identifier it has assigned to the new
  811.    member of the version graph.
  812.  
  813.    5.9.2.9. A version identifier must be unique across a version graph.
  814.  
  815.    5.9.2.10. A client must be able to supply version-specific properties
  816.    to be associated with a new member of a version graph. (See Section
  817.    5.1 "Properties" above.) At a minimum, it must be possible to
  818.    associate comments with the new member, explaining what changes were
  819.    made.
  820.  
  821.    5.9.2.11. A client must be able to query the server for information
  822.    about a version tree, including which versions are locked, which are
  823.    reserved for editing, and by whom (Session Tracking).
  824.  
  825. 5.9.3. Rationale
  826.  
  827.    Versioning in the context of the world-wide web offers a variety of
  828.    benefits:
  829.  
  830.    It provides infrastructure for efficient and controlled management of
  831.    large evolving web sites. Modern configuration management systems are
  832.    built on some form of repository that can track the revision history
  833.    of individual resources, and provide the higher-level tools to manage
  834.    those saved versions. Basic versioning capabilities are required to
  835.    support such systems.
  836.  
  837.  
  838.  
  839.  
  840.  
  841.  
  842. Slein, et. al.               Informational                     [Page 15]
  843.  
  844. RFC 2291          Distributed Authoring and Versioning     February 1998
  845.  
  846.  
  847.    It allows parallel development and update of single resources. Since
  848.    versioning systems register change by creating new objects, they
  849.    enable simultaneous write access by allowing the creation of variant
  850.    versions. Many also provide merge support to ease the reverse
  851.    operation.
  852.  
  853.    It provides a framework for coordinating changes to resources. While
  854.    specifics vary, most systems provide some method of controlling or
  855.    tracking access to enable collaborative resource development.
  856.  
  857.    It allows browsing through past and alternative versions of a
  858.    resource.  Frequently the modification and authorship history of a
  859.    resource is critical information in itself.
  860.  
  861.    It provides stable names that can support externally stored links for
  862.    annotation and link-server support. Both annotation and link servers
  863.    frequently need to store stable references to portions of resources
  864.    that are not under their direct control. By providing stable states
  865.    of resources, version control systems allow not only stable pointers
  866.    into those resources, but also well-defined methods to determine the
  867.    relationships of those states of a resource.
  868.  
  869.    It allows explicit semantic representation of single resources with
  870.    multiple states. A versioning system directly represents the fact
  871.    that a resource has an explicit history, and a persistent identity
  872.    across the various states it has had during the course of that
  873.    history.
  874.  
  875. 5.10. Variants
  876.  
  877.    Detailed requirements for variants will be developed in a separate
  878.    document.
  879.  
  880. 5.10.1. Functional Requirements
  881.  
  882.    It must be possible to send variants to the server, describing the
  883.    relationships between the variants and their parent resource.  In
  884.    addition, it must be possible to write and retrieve variants of
  885.    property labels, property descriptions, and property values.
  886.  
  887. 5.10.2. Rationale
  888.  
  889.    The HTTP working group is addressing problems of content negotiation
  890.    and retrieval of variants of a resource.  To extend this work to an
  891.    authoring environment, WEBDAV must standardize mechanisms for authors
  892.    to use when submitting variants to a server.  Authors need to be able
  893.    to provide variants in different file or document formats, for
  894.    different uses. They need to provide variants optimized for different
  895.  
  896.  
  897.  
  898. Slein, et. al.               Informational                     [Page 16]
  899.  
  900. RFC 2291          Distributed Authoring and Versioning     February 1998
  901.  
  902.  
  903.    clients and for different output devices.  They need to be able to
  904.    provide variants in different languages in the international
  905.    environment of the Web.  In support of internationalization
  906.    requirements (See 5.12 below), variants need to be supported not just
  907.    for the content of resources, but for any information intended for
  908.    human use, such as property values, labels, and descriptions.
  909.  
  910. 5.11. Security
  911.  
  912.    5.11.1. Authentication. The WebDAV specification should state how the
  913.    WebDAV extensions interoperate with existing authentication schemes,
  914.    and should make recommendations for using those schemes.
  915.  
  916.    5.11.2. Access Control. Access control requirements are specified in
  917.    a separate access control work in progress [AC].
  918.  
  919.    5.11.3. Interoperability with Security Protocols. The WebDAV
  920.    specification must provide a minimal list of security protocols which
  921.    any compliant server / client must support.  These protocols should
  922.    insure the authenticity of messages and the privacy and integrity of
  923.    messages in transit.
  924.  
  925. 5.12. Internationalization
  926.  
  927. 5.12.1. Character Sets and Languages
  928.  
  929.    Since Web distributed authoring occurs in a multi-lingual
  930.    environment, information intended for user comprehension must conform
  931.    to the IETF Character Set Policy [CHAR].  This policy addresses
  932.    character sets and encodings, and language tagging.
  933.  
  934. 5.12.2. Rationale
  935.  
  936.    In the international environment of the Internet, it is important to
  937.    insure that any information intended for user comprehension can be
  938.    displayed in a writing system and language agreeable to both the
  939.    client and the server. The information encompassed by this
  940.    requirement includes not only the content of resources, but also such
  941.    things as display names and descriptions of properties, property
  942.    values, and status messages.
  943.  
  944. 6. Acknowledgements
  945.  
  946.    Our understanding of these issues has emerged as the result of much
  947.    thoughtful discussion, email, and assistance by many people, who
  948.    deserve recognition for their effort.
  949.  
  950.  
  951.  
  952.  
  953.  
  954. Slein, et. al.               Informational                     [Page 17]
  955.  
  956. RFC 2291          Distributed Authoring and Versioning     February 1998
  957.  
  958.  
  959.    Terry Allen, tallen@sonic.net
  960.    Alan Babich, FileNet, babich@filenet.com
  961.    Dylan Barrell, Open Text, dbarrell@opentext.ch
  962.    Barbara Bazemore, PC DOCS, barbarab@pcdocs.com
  963.    Martin Cagan, Continuus Software, Marty_Cagan@continuus.com
  964.    Steve Carter, Novell, srcarter@novell.com
  965.    Dan Connolly, World Wide Web Consortium, connolly@w3.org
  966.    Jim Cunningham, Netscape, jfc@netscape.com
  967.    Ron Daniel Jr., Los Alamos National Laboratory, rdaniel@lanl.gov
  968.    Mark Day, Lotus, Mark_Day@lotus.com
  969.    Martin J. Duerst, mduerst@ifi.unizh.ch
  970.    Asad Faizi, Netscape, asad@netscape.com
  971.    Ron Fein, Microsoft, ronfe@microsoft.com
  972.    David Fiander, Mortice Kern Systems, davidf@mks.com
  973.    Roy Fielding, U.C. Irvine, fielding@ics.uci.edu
  974.    Mark Fisher, Thomson Consumer Electronics, FisherM@indy.tce.com
  975.    Yaron Y. Goland, Microsoft, yarong@microsoft.com
  976.    Phill Hallam-Baker, MIT, hallam@ai.mit.edu
  977.    Dennis Hamilton, Xerox PARC, hamilton@parc.xerox.com
  978.    Andre van der Hoek, University of Colorado, Boulder,
  979.      andre@cs.colorado.edu
  980.    Del Jensen, Novell, dcjensen@novell.com
  981.    Gail Kaiser, Columbia University, kaiser@cs.columbia.edu
  982.    Rohit Khare, World Wide Web Consortium, khare@w3.org
  983.    Ora Lassila, Nokia Research Center, ora.lassila@research.nokia.com
  984.    Ben Laurie, A.L. Digital, ben@algroup.co.uk
  985.    Mike Little, Bellcore, little@bellcore.com
  986.    Dave Long, America Online, dave@sb.aol.com
  987.    Larry Masinter, Xerox PARC, masinter@parc.xerox.com
  988.    Murray Maloney, SoftQuad, murray@sq.com
  989.    Jim Miller, World Wide Web Consortium, jmiller@w3.org
  990.    Howard S. Modell, Boeing, howard.s.modell@boeing.com
  991.    Keith Moore, University of Tennessee, Knoxville, moore@cs.utk.edu
  992.    Henrik Frystyk Nielsen, World Wide Web Consortium, frystyk@w3.org
  993.    Jon Radoff, NovaLink, jradoff@novalink.com
  994.    Alan Robertson, alanr@bell-labs.com
  995.    Henry Sanders, Microsoft,
  996.    Andrew Schulert, Microsoft, andyschu@microsoft.com
  997.    Christopher Seiwald, Perforce Software, seiwald@perforce.com
  998.    Einar Stefferud, stef@nma.com
  999.    Richard Taylor, U.C. Irvine, taylor@ics.uci.edu
  1000.    Robert Thau, MIT, rst@ai.mit.edu
  1001.    Sankar Virdhagriswaran, sv@hunchuen.crystaliz.com
  1002.    Dan Whelan, FileNet, dan@FILENET.COM
  1003.    Gregory J. Woodhouse, gjw@wnetc.com
  1004.  
  1005.  
  1006.  
  1007.  
  1008.  
  1009.  
  1010. Slein, et. al.               Informational                     [Page 18]
  1011.  
  1012. RFC 2291          Distributed Authoring and Versioning     February 1998
  1013.  
  1014.  
  1015. 7. References
  1016.  
  1017.    [AC] J. Radoff, "Requirements for Access Control within Distributed
  1018.    Authoring and Versioning Environments on the World Wide Web",
  1019.    unpublished manuscript, <http://lists.w3.org/Archives/Public/w3c-
  1020.    dist-auth/1997AprJun/0183.html>
  1021.  
  1022.    [CHAR] Alvestrand, H., "IETF Policy on Character Sets and Languages",
  1023.    RFC 2277, January 1998.
  1024.  
  1025.    [CM] P. Feiler, "Configuration Management Models in Commercial
  1026.    Environments", Software Engineering Institute Technical Report
  1027.    CMU/SEI-91-TR-7,
  1028.    <http://www.sei.cmu.edu/products/publications/91.reports/91.tr.007.html>
  1029.  
  1030.    [HTML] Berners-Lee, T., and  D. Connolly, "HyperText Markup Language
  1031.    Specification - 2.0", RFC 1866, November 1995.
  1032.  
  1033.    [HTTP] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., and T.
  1034.    Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2068,
  1035.    January 1997.
  1036.  
  1037.    [ISO 10646] ISO/IEC 10646-1:1993. "International Standard --
  1038.    Information Technology -- Universal Multiple-Octet Coded Character
  1039.    Set (UCS) -- Part 1: Architecture and Basic Multilingual Plane."
  1040.  
  1041.    [URL] Berners-Lee, T., Masinter, L., and M. McCahill. "Uniform
  1042.    Resource Locators (URL)", RFC 1738, December 1994.
  1043.  
  1044.    [VSE] A. Haake, D. Hicks, "VerSE: Towards Hypertext Versioning
  1045.    Styles", Proc. Hypertext'96, The Seventh ACM Conference on Hypertext,
  1046.    1996, pages 224-234.
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066. Slein, et. al.               Informational                     [Page 19]
  1067.  
  1068. RFC 2291          Distributed Authoring and Versioning     February 1998
  1069.  
  1070.  
  1071. 8. Authors' Addresses
  1072.  
  1073.    Judith Slein
  1074.    Xerox Corporation
  1075.    800 Phillips Road 128-29E
  1076.    Webster, NY 14580
  1077.  
  1078.    EMail: slein@wrc.xerox.com
  1079.  
  1080.  
  1081.    Fabio Vitali
  1082.    Department of Computer Science
  1083.    University of Bologna
  1084.    ITALY
  1085.  
  1086.    EMail: fabio@cs.unibo.it
  1087.  
  1088.  
  1089.    E. James Whitehead, Jr.
  1090.    Department of Information and Computer Science
  1091.    University of California
  1092.    Irvine, CA 92697-3425
  1093.  
  1094.    Fax: 714-824-4056
  1095.    EMail: ejw@ics.uci.edu
  1096.  
  1097.  
  1098.    David G. Durand
  1099.    Department of Computer Science
  1100.    Boston University
  1101.    Boston, MA
  1102.  
  1103.    EMail: dgd@cs.bu.edu
  1104.  
  1105.  
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.  
  1120.  
  1121.  
  1122. Slein, et. al.               Informational                     [Page 20]
  1123.  
  1124. RFC 2291          Distributed Authoring and Versioning     February 1998
  1125.  
  1126.  
  1127. 9.  Full Copyright Statement
  1128.  
  1129.    Copyright (C) The Internet Society (1998).  All Rights Reserved.
  1130.  
  1131.    This document and translations of it may be copied and furnished to
  1132.    others, and derivative works that comment on or otherwise explain it
  1133.    or assist in its implementation may be prepared, copied, published
  1134.    and distributed, in whole or in part, without restriction of any
  1135.    kind, provided that the above copyright notice and this paragraph are
  1136.    included on all such copies and derivative works.  However, this
  1137.    document itself may not be modified in any way, such as by removing
  1138.    the copyright notice or references to the Internet Society or other
  1139.    Internet organizations, except as needed for the purpose of
  1140.    developing Internet standards in which case the procedures for
  1141.    copyrights defined in the Internet Standards process must be
  1142.    followed, or as required to translate it into languages other than
  1143.    English.
  1144.  
  1145.    The limited permissions granted above are perpetual and will not be
  1146.    revoked by the Internet Society or its successors or assigns.
  1147.  
  1148.    This document and the information contained herein is provided on an
  1149.    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
  1150.    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
  1151.    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
  1152.    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
  1153.    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178. Slein, et. al.               Informational                     [Page 21]
  1179.  
  1180.