Main Page   Modules   Data Structures   File List   Data Fields  

svn_dav.h

00001 /**
00002  * @copyright
00003  * ====================================================================
00004  * Copyright (c) 2000-2004 CollabNet.  All rights reserved.
00005  *
00006  * This software is licensed as described in the file COPYING, which
00007  * you should have received as part of this distribution.  The terms
00008  * are also available at http://subversion.tigris.org/license-1.html.
00009  * If newer versions of this license are posted there, you may use a
00010  * newer version instead, at your option.
00011  *
00012  * This software consists of voluntary contributions made by many
00013  * individuals.  For exact contribution history, see the revision
00014  * history and logs, available at http://subversion.tigris.org/.
00015  * ====================================================================
00016  * @endcopyright
00017  *
00018  * @file svn_dav.h
00019  * @brief Code related to WebDAV/DeltaV usage in Subversion.
00020  */
00021 
00022 
00023 
00024 
00025 #ifndef SVN_DAV_H
00026 #define SVN_DAV_H
00027 
00028 
00029 #ifdef __cplusplus
00030 extern "C" {
00031 #endif /* __cplusplus */
00032 
00033 
00034 /** This is the MIME type that Subversion uses for its "svndiff" format.
00035  *
00036  * This is an application type, for the "svn" vendor. The specific subtype
00037  * is "svndiff".
00038  */
00039 #define SVN_SVNDIFF_MIME_TYPE "application/vnd.svn-svndiff"
00040 
00041 
00042 /** This header is *TEMPORARILY* used to transmit the delta base to the
00043  * server. It contains a version resource URL for what is on the client.
00044  */
00045 #define SVN_DAV_DELTA_BASE_HEADER "X-SVN-VR-Base"
00046 
00047 /** This header is used when an svn client wants to trigger specific
00048  * svn server behaviors.  Normal WebDAV or DeltaV clients won't use it.
00049  */
00050 #define SVN_DAV_OPTIONS_HEADER "X-SVN-Options"
00051 
00052 /** @{
00053  * Specific options that can appear in the options-header: */
00054 #define SVN_DAV_OPTION_NO_MERGE_RESPONSE "no-merge-response"
00055 #define SVN_DAV_OPTION_LOCK_BREAK        "lock-break"
00056 #define SVN_DAV_OPTION_LOCK_STEAL        "lock-steal"
00057 #define SVN_DAV_OPTION_RELEASE_LOCKS     "release-locks"
00058 #define SVN_DAV_OPTION_KEEP_LOCKS        "keep-locks"
00059 /** @} */
00060 
00061 /** This header is used when an svn client wants to tell mod_dav_svn
00062  * exactly what revision of a resource it thinks it's operating on.
00063  * (For example, an svn server can use it to validate a DELETE request.)
00064  * Normal WebDAV or DeltaV clients won't use it.
00065  */
00066 #define SVN_DAV_VERSION_NAME_HEADER "X-SVN-Version-Name"
00067 
00068 /** A header generated by mod_dav_svn whenever it responds
00069     successfully to a LOCK request.  Only svn clients will notice it,
00070     and use it to fill in svn_lock_t->creation_date.   */
00071 #define SVN_DAV_CREATIONDATE_HEADER "X-SVN-Creation-Date"
00072 
00073 /** A header generated by mod_dav_svn whenever it responds
00074     successfully to a PROPFIND for the 'DAV:lockdiscovery' property.
00075     Only svn clients will notice it, and use it to fill in
00076     svn_lock_t->owner.  (Remember that the DAV:owner field maps to
00077     svn_lock_t->comment, and that there is no analogue in the DAV
00078     universe of svn_lock_t->owner.)  */
00079 #define SVN_DAV_LOCK_OWNER_HEADER "X-SVN-Lock-Owner"
00080 
00081 
00082 /** @{
00083  * These headers are for client and server to verify that the base
00084  * and the result of a change transmission are the same on both
00085  * sides, regardless of what transformations (svndiff deltification,
00086  * gzipping, etc) the data may have gone through in between.  
00087  *
00088  * The result md5 is always used whenever file contents are
00089  * transferred, because every transmission has a resulting text.
00090  *
00091  * The base md5 is used to verify the base text against which svndiff
00092  * data is being applied.  Note that even for svndiff transmissions,
00093  * base verification is not strictly necessary (and may therefore be
00094  * unimplemented), as any error will be caught by the verification of
00095  * the final result.  However, if the problem is that the base text is
00096  * corrupt, the error will be caught earlier if the base md5 is used.
00097  *
00098  * Normal WebDAV or DeltaV clients don't use these.
00099  */
00100 #define SVN_DAV_BASE_FULLTEXT_MD5_HEADER "X-SVN-Base-Fulltext-MD5"
00101 #define SVN_DAV_RESULT_FULLTEXT_MD5_HEADER "X-SVN-Result-Fulltext-MD5"
00102 /** @} */
00103 
00104 /* ### should add strings for the various XML elements in the reports
00105    ### and things. also the custom prop names. etc.
00106 */
00107 
00108 /** The svn-specific object that is placed within a <D:error> response.
00109  *
00110  * @defgroup svn_dav_error svn_dav errors
00111  * @{ */
00112 
00113 /** The error object's namespace */
00114 #define SVN_DAV_ERROR_NAMESPACE "svn:"
00115 
00116 /** The error object's tag */
00117 #define SVN_DAV_ERROR_TAG       "error"
00118 
00119 /** @} */
00120 
00121 
00122 /** General property (xml) namespaces that will be used by both ra_dav
00123  * and mod_dav_svn for marshalling properties.
00124  *
00125  * @defgroup svn_dav_property_xml_namespaces dav property namespaces
00126  * @{
00127  */
00128 
00129 /** A property stored in the fs and wc, begins with 'svn:', and is
00130  * interpreted either by client or server.
00131  */
00132 #define SVN_DAV_PROP_NS_SVN "http://subversion.tigris.org/xmlns/svn/"
00133 
00134 /** A property stored in the fs and wc, but totally ignored by svn
00135  * client and server.
00136  *
00137  * A property simply invented by the users.
00138  */
00139 #define SVN_DAV_PROP_NS_CUSTOM "http://subversion.tigris.org/xmlns/custom/"
00140 
00141 /** A property purely generated and consumed by the network layer, not
00142  * seen by either fs or wc.
00143  */
00144 #define SVN_DAV_PROP_NS_DAV "http://subversion.tigris.org/xmlns/dav/"
00145 
00146 /** @} */
00147 
00148 #ifdef __cplusplus
00149 }
00150 #endif /* __cplusplus */
00151 
00152 #endif  /* SVN_DAV_H */

Generated on Wed Aug 31 01:47:56 2005 for Subversion by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002