399 lines
15 KiB
C
399 lines
15 KiB
C
/**
|
||
* @copyright
|
||
* ====================================================================
|
||
* Licensed to the Apache Software Foundation (ASF) under one
|
||
* or more contributor license agreements. See the NOTICE file
|
||
* distributed with this work for additional information
|
||
* regarding copyright ownership. The ASF licenses this file
|
||
* to you under the Apache License, Version 2.0 (the
|
||
* "License"); you may not use this file except in compliance
|
||
* with the License. You may obtain a copy of the License at
|
||
*
|
||
* http://www.apache.org/licenses/LICENSE-2.0
|
||
*
|
||
* Unless required by applicable law or agreed to in writing,
|
||
* software distributed under the License is distributed on an
|
||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
* KIND, either express or implied. See the License for the
|
||
* specific language governing permissions and limitations
|
||
* under the License.
|
||
* ====================================================================
|
||
* @endcopyright
|
||
*
|
||
* @file svn_dav.h
|
||
* @brief Code related to WebDAV/DeltaV usage in Subversion.
|
||
*/
|
||
|
||
|
||
|
||
|
||
#ifndef SVN_DAV_H
|
||
#define SVN_DAV_H
|
||
|
||
|
||
#ifdef __cplusplus
|
||
extern "C" {
|
||
#endif /* __cplusplus */
|
||
|
||
|
||
/** This is the MIME type that Subversion uses for its "svndiff" format.
|
||
*
|
||
* This is an application type, for the "svn" vendor. The specific subtype
|
||
* is "svndiff".
|
||
*/
|
||
#define SVN_SVNDIFF_MIME_TYPE "application/vnd.svn-svndiff"
|
||
|
||
/** This is the MIME type that Subversion users for its "skel" format.
|
||
*
|
||
* This is an application type, for the "svn" vendor. The specific subtype
|
||
* is "skel".
|
||
* @since New in 1.7.
|
||
*/
|
||
#define SVN_SKEL_MIME_TYPE "application/vnd.svn-skel"
|
||
|
||
/** This header is *TEMPORARILY* used to transmit the delta base to the
|
||
* server. It contains a version resource URL for what is on the client.
|
||
*
|
||
* @note The HTTP delta draft recommends an If-None-Match header
|
||
* holding an entity tag corresponding to the base copy that the
|
||
* client has. In Subversion, it is much more natural to use a version
|
||
* URL to specify that base. We'd like, then, to use the If: header
|
||
* to specify the URL. Unfortunately, mod_dav sees all "State-token"
|
||
* items as lock tokens. So we'll use this custom header until mod_dav
|
||
* and other backend APIs are taught to be less rigid, at which time
|
||
* we can switch to using an If: header to report our base version.
|
||
*/
|
||
#define SVN_DAV_DELTA_BASE_HEADER "X-SVN-VR-Base"
|
||
|
||
/** This header is used when an svn client wants to trigger specific
|
||
* svn server behaviors. Normal WebDAV or DeltaV clients won't use it.
|
||
*/
|
||
#define SVN_DAV_OPTIONS_HEADER "X-SVN-Options"
|
||
|
||
/**
|
||
* @name options-header defines
|
||
* Specific options that can appear in the options-header:
|
||
* @{
|
||
*/
|
||
#define SVN_DAV_OPTION_NO_MERGE_RESPONSE "no-merge-response"
|
||
#define SVN_DAV_OPTION_LOCK_BREAK "lock-break"
|
||
#define SVN_DAV_OPTION_LOCK_STEAL "lock-steal"
|
||
#define SVN_DAV_OPTION_RELEASE_LOCKS "release-locks"
|
||
#define SVN_DAV_OPTION_KEEP_LOCKS "keep-locks"
|
||
/** @} */
|
||
|
||
/** This header is used when an svn client wants to tell mod_dav_svn
|
||
* exactly what revision of a resource it thinks it's operating on.
|
||
* (For example, an svn server can use it to validate a DELETE request.)
|
||
* Normal WebDAV or DeltaV clients won't use it.
|
||
*/
|
||
#define SVN_DAV_VERSION_NAME_HEADER "X-SVN-Version-Name"
|
||
|
||
/** A header generated by mod_dav_svn whenever it responds
|
||
successfully to a LOCK request. Only svn clients will notice it,
|
||
and use it to fill in svn_lock_t->creation_date. */
|
||
#define SVN_DAV_CREATIONDATE_HEADER "X-SVN-Creation-Date"
|
||
|
||
/** A header generated by mod_dav_svn whenever it responds
|
||
successfully to a PROPFIND for the 'DAV:lockdiscovery' property.
|
||
Only svn clients will notice it, and use it to fill in
|
||
svn_lock_t->owner. (Remember that the DAV:owner field maps to
|
||
svn_lock_t->comment, and that there is no analogue in the DAV
|
||
universe of svn_lock_t->owner.) */
|
||
#define SVN_DAV_LOCK_OWNER_HEADER "X-SVN-Lock-Owner"
|
||
|
||
/** Assuming the OPTIONS was performed against a resource within a
|
||
* Subversion repository, then this header indicates the youngest
|
||
* revision in the repository.
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_YOUNGEST_REV_HEADER "SVN-Youngest-Rev"
|
||
|
||
/** Assuming the OPTIONS was performed against a resource within a
|
||
* Subversion repository, then this header indicates the UUID of the
|
||
* repository.
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_REPOS_UUID_HEADER "SVN-Repository-UUID"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the server speaks HTTP protocol v2. This header provides an
|
||
* opaque URI that the client should send all custom REPORT requests
|
||
* against.
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_ME_RESOURCE_HEADER "SVN-Me-Resource"
|
||
|
||
/** This header provides the repository root URI, suitable for use in
|
||
* calculating the relative paths of other public URIs for this
|
||
* repository into . (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_ROOT_URI_HEADER "SVN-Repository-Root"
|
||
|
||
/** This header provides an opaque URI that the client can append a
|
||
* revision to, to construct a 'revision URL'. This allows direct
|
||
* read/write access to revprops via PROPFIND or PROPPATCH, and is
|
||
* similar to libsvn_fs's revision objects (as distinct from "revision
|
||
* roots"). (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_REV_STUB_HEADER "SVN-Rev-Stub"
|
||
|
||
/** This header provides an opaque URI that the client can append
|
||
* PEGREV/PATH to, in order to construct URIs of pegged objects in the
|
||
* repository, similar to the use of a "revision root" in the
|
||
* libsvn_fs API. (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_REV_ROOT_STUB_HEADER "SVN-Rev-Root-Stub"
|
||
|
||
/** This header provides an opaque URI which represents a Subversion
|
||
* transaction (revision-in-progress) object. It is suitable for use
|
||
* in fetching and modifying transaction properties as part of a
|
||
* commit process, similar to the svn_fs_txn_t object (as distinct
|
||
* from a "txn root"). (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_TXN_STUB_HEADER "SVN-Txn-Stub"
|
||
|
||
/** Companion to @c SVN_DAV_TXN_STUB_HEADER, used when a POST request
|
||
* returns @c SVN_DAV_VTXN_NAME_HEADER in response to a client
|
||
* supplied name. (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_VTXN_STUB_HEADER "SVN-VTxn-Stub"
|
||
|
||
/** This header provides an opaque URI which represents the root
|
||
* directory of a Subversion transaction (revision-in-progress),
|
||
* similar to the concept of a "txn root" in the libsvn_fs API. The
|
||
* client can append additional path segments to it to access items
|
||
* deeper in the transaction tree as part of a commit process. (HTTP
|
||
* protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_TXN_ROOT_STUB_HEADER "SVN-Txn-Root-Stub"
|
||
|
||
/** Companion to @c SVN_DAV_TXN_ROOT_STUB_HEADER, used when a POST
|
||
* request returns @c SVN_DAV_VTXN_NAME_HEADER in response to a
|
||
* client supplied name. (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_VTXN_ROOT_STUB_HEADER "SVN-VTxn-Root-Stub"
|
||
|
||
/** This header is used in the POST response to tell the client the
|
||
* name of the Subversion transaction created by the request. It can
|
||
* then be appended to the transaction stub and transaction root stub
|
||
* for access to the properties and paths, respectively, of the named
|
||
* transaction. (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_TXN_NAME_HEADER "SVN-Txn-Name"
|
||
|
||
/** This header is used in the POST request, to pass a client supplied
|
||
* alternative transaction name to the server, and in the POST
|
||
* response, to tell the client that the alternative transaction
|
||
* resource names should be used. (HTTP protocol v2 only)
|
||
* @since New in 1.7. */
|
||
#define SVN_DAV_VTXN_NAME_HEADER "SVN-VTxn-Name"
|
||
|
||
/** This header is used in the OPTIONS response to identify named
|
||
* skel-based POST request types which the server is prepared to
|
||
* handle. (HTTP protocol v2 only)
|
||
* @since New in 1.8. */
|
||
#define SVN_DAV_SUPPORTED_POSTS_HEADER "SVN-Supported-Posts"
|
||
|
||
/** This header is used in the OPTIONS response to indicate if the server
|
||
* wants bulk update requests (Prefer) or only accepts skelta requests (Off).
|
||
* If this value is On both options are allowed.
|
||
* @since New in 1.8. */
|
||
#define SVN_DAV_ALLOW_BULK_UPDATES "SVN-Allow-Bulk-Updates"
|
||
|
||
/** Assuming the request target is a Subversion repository resource,
|
||
* this header is returned in the OPTIONS response to indicate whether
|
||
* the repository supports the merge tracking feature ("yes") or not
|
||
* ("no").
|
||
* @since New in 1.8. */
|
||
#define SVN_DAV_REPOSITORY_MERGEINFO "SVN-Repository-MergeInfo"
|
||
|
||
/**
|
||
* @name Fulltext MD5 headers
|
||
*
|
||
* These headers are for client and server to verify that the base
|
||
* and the result of a change transmission are the same on both
|
||
* sides, regardless of what transformations (svndiff deltification,
|
||
* gzipping, etc) the data may have gone through in between.
|
||
*
|
||
* The result md5 is always used whenever file contents are
|
||
* transferred, because every transmission has a resulting text.
|
||
*
|
||
* The base md5 is used to verify the base text against which svndiff
|
||
* data is being applied. Note that even for svndiff transmissions,
|
||
* base verification is not strictly necessary (and may therefore be
|
||
* unimplemented), as any error will be caught by the verification of
|
||
* the final result. However, if the problem is that the base text is
|
||
* corrupt, the error will be caught earlier if the base md5 is used.
|
||
*
|
||
* Normal WebDAV or DeltaV clients don't use these.
|
||
* @{
|
||
*/
|
||
#define SVN_DAV_BASE_FULLTEXT_MD5_HEADER "X-SVN-Base-Fulltext-MD5"
|
||
#define SVN_DAV_RESULT_FULLTEXT_MD5_HEADER "X-SVN-Result-Fulltext-MD5"
|
||
/** @} */
|
||
|
||
/* ### should add strings for the various XML elements in the reports
|
||
### and things. also the custom prop names. etc.
|
||
*/
|
||
|
||
/** The svn-specific object that is placed within a <D:error> response.
|
||
*
|
||
* @defgroup svn_dav_error Errors in svn_dav
|
||
* @{ */
|
||
|
||
/** The error object's namespace */
|
||
#define SVN_DAV_ERROR_NAMESPACE "svn:"
|
||
|
||
/** The error object's tag */
|
||
#define SVN_DAV_ERROR_TAG "error"
|
||
|
||
/** @} */
|
||
|
||
|
||
/** General property (xml) namespaces that will be used by both ra_dav
|
||
* and mod_dav_svn for marshalling properties.
|
||
*
|
||
* @defgroup svn_dav_property_xml_namespaces DAV property namespaces
|
||
* @{
|
||
*/
|
||
|
||
/** A property stored in the fs and wc, begins with 'svn:', and is
|
||
* interpreted either by client or server.
|
||
*/
|
||
#define SVN_DAV_PROP_NS_SVN "http://subversion.tigris.org/xmlns/svn/"
|
||
|
||
/** A property stored in the fs and wc, but totally ignored by svn
|
||
* client and server.
|
||
*
|
||
* A property simply invented by the users.
|
||
*/
|
||
#define SVN_DAV_PROP_NS_CUSTOM "http://subversion.tigris.org/xmlns/custom/"
|
||
|
||
/** A property purely generated and consumed by the network layer, not
|
||
* seen by either fs or wc.
|
||
*/
|
||
#define SVN_DAV_PROP_NS_DAV "http://subversion.tigris.org/xmlns/dav/"
|
||
|
||
|
||
/**
|
||
* @name Custom (extension) values for the DAV header.
|
||
* Note that although these share the SVN_DAV_PROP_NS_DAV namespace
|
||
* prefix, they are not properties; they are header values.
|
||
* @{
|
||
*/
|
||
|
||
/* ##################################################################
|
||
*
|
||
* WARNING: At least some versions of Microsoft's Web Folders
|
||
* WebDAV client implementation are unable to handle
|
||
* DAV: headers with values longer than 63 characters,
|
||
* so please keep these strings within that limit.
|
||
*
|
||
* ##################################################################
|
||
*/
|
||
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS request or response
|
||
* indicates that the transmitter supports @c svn_depth_t.
|
||
*
|
||
* @since New in 1.5.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_DEPTH\
|
||
SVN_DAV_PROP_NS_DAV "svn/depth"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS request or response
|
||
* indicates that the server knows how to handle merge-tracking
|
||
* information.
|
||
*
|
||
* Note that this says nothing about whether the repository can handle
|
||
* mergeinfo, only whether the server does. For more information, see
|
||
* mod_dav_svn/version.c:get_vsn_options().
|
||
*
|
||
* @since New in 1.5.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_MERGEINFO\
|
||
SVN_DAV_PROP_NS_DAV "svn/mergeinfo"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) knows how to send
|
||
* custom revprops in log responses.
|
||
*
|
||
* @since New in 1.5.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_LOG_REVPROPS\
|
||
SVN_DAV_PROP_NS_DAV "svn/log-revprops"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) knows how to handle
|
||
* a replay of a directory in the repository (not root).
|
||
*
|
||
* @since New in 1.5.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_PARTIAL_REPLAY\
|
||
SVN_DAV_PROP_NS_DAV "svn/partial-replay"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) knows how to enforce
|
||
* old-value atomicity in PROPPATCH (for editing revprops).
|
||
*
|
||
* @since New in 1.7.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_ATOMIC_REVPROPS\
|
||
SVN_DAV_PROP_NS_DAV "svn/atomic-revprops"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) knows how to get
|
||
* inherited properties.
|
||
*
|
||
* @since New in 1.8.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_INHERITED_PROPS\
|
||
SVN_DAV_PROP_NS_DAV "svn/inherited-props"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) knows how to
|
||
* properly handle ephemeral (that is, deleted-just-before-commit) FS
|
||
* transaction properties.
|
||
*
|
||
* @since New in 1.8.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_EPHEMERAL_TXNPROPS\
|
||
SVN_DAV_PROP_NS_DAV "svn/ephemeral-txnprops"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) supports serving
|
||
* properties inline in update editor when 'send-all' is 'false'.
|
||
*
|
||
* @since New in 1.8.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_INLINE_PROPS\
|
||
SVN_DAV_PROP_NS_DAV "svn/inline-props"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) knows how to handle
|
||
* a replay of a revision resource. Transmitters must be
|
||
* HTTP-v2-enabled to support this feature.
|
||
*
|
||
* @since New in 1.8.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_REPLAY_REV_RESOURCE\
|
||
SVN_DAV_PROP_NS_DAV "svn/replay-rev-resource"
|
||
|
||
/** Presence of this in a DAV header in an OPTIONS response indicates
|
||
* that the transmitter (in this case, the server) knows how to handle
|
||
* a reversed fetch of file versions.
|
||
*
|
||
* @since New in 1.8.
|
||
*/
|
||
#define SVN_DAV_NS_DAV_SVN_REVERSE_FILE_REVS\
|
||
SVN_DAV_PROP_NS_DAV "svn/reverse-file-revs"
|
||
|
||
|
||
/** @} */
|
||
|
||
/** @} */
|
||
|
||
#ifdef __cplusplus
|
||
}
|
||
#endif /* __cplusplus */
|
||
|
||
#endif /* SVN_DAV_H */
|