Main Page   Modules   Data Structures   File List   Data Fields   Globals  

svn_dav.h

Go to the documentation of this file.
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 /** This header is used when an svn client wants to tell mod_dav_svn
00053  * exactly what revision of a resource it thinks it's operating on.
00054  * (For example, an svn server can use it to validate a DELETE request.)
00055  * Normal WebDAV or DeltaV clients won't use it.
00056  */
00057 #define SVN_DAV_VERSION_NAME_HEADER "X-SVN-Version-Name"
00058 
00059 /** These headers are for client and server to verify that the base
00060  * and the result of a change transmission are the same on both
00061  * sides, regardless of what transformations (svndiff deltification,
00062  * gzipping, etc) the data may have gone through in between.  
00063  *
00064  * The result md5 is always used whenever file contents are
00065  * transferred, because every transmission has a resulting text.
00066  *
00067  * The base md5 is used to verify the base text against which svndiff
00068  * data is being applied.  Note that even for svndiff transmissions,
00069  * base verification is not strictly necessary (and may therefore be
00070  * unimplemented), as any error will be caught by the verification of
00071  * the final result.  However, if the problem is that the base text is
00072  * corrupt, the error will be caught earlier if the base md5 is used.
00073  *
00074  * Normal WebDAV or DeltaV clients don't use these.
00075  */
00076 #define SVN_DAV_BASE_FULLTEXT_MD5_HEADER "X-SVN-Base-Fulltext-MD5"
00077 #define SVN_DAV_RESULT_FULLTEXT_MD5_HEADER "X-SVN-Result-Fulltext-MD5"
00078 
00079 /** Specific options that can appear in the options-header: */
00080 #define SVN_DAV_OPTION_NO_MERGE_RESPONSE "no-merge-response"
00081 
00082 /* ### should add strings for the various XML elements in the reports
00083    ### and things. also the custom prop names. etc.
00084 */
00085 
00086 /** The svn-specific object that is placed within a <D:error> response.
00087  *
00088  * @defgroup svn_dav_error svn_dav errors
00089  * @{ */
00090 
00091 /** The error object's namespace */
00092 #define SVN_DAV_ERROR_NAMESPACE "svn:"
00093 
00094 /** The error object's tag */
00095 #define SVN_DAV_ERROR_TAG       "error"
00096 
00097 /** @} */
00098 
00099 
00100 /** General property (xml) namespaces that will be used by both ra_dav
00101  * and mod_dav_svn for marshalling properties.
00102  *
00103  * @defgroup svn_dav_property_xml_namespaces dav property namespaces
00104  * @{
00105  */
00106 
00107 /** A property stored in the fs and wc, begins with 'svn:', and is
00108  * interpreted either by client or server.
00109  */
00110 #define SVN_DAV_PROP_NS_SVN "http://subversion.tigris.org/xmlns/svn/"
00111 
00112 /** A property stored in the fs and wc, but totally ignored by svn
00113  * client and server.
00114  *
00115  * A property simply invented by the users.
00116  */
00117 #define SVN_DAV_PROP_NS_CUSTOM "http://subversion.tigris.org/xmlns/custom/"
00118 
00119 /** A property purely generated and consumed by the network layer, not
00120  * seen by either fs or wc.
00121  */
00122 #define SVN_DAV_PROP_NS_DAV "http://subversion.tigris.org/xmlns/dav/"
00123 
00124 /** @} */
00125 
00126 #ifdef __cplusplus
00127 }
00128 #endif /* __cplusplus */
00129 
00130 #endif  /* SVN_DAV_H */

Generated on Wed Oct 20 01:47:44 2004 for Subversion by doxygen1.2.18