Documentation ¶
Overview ¶
Package webdav provides a WebDAV server implementation.
Index ¶
Constants ¶
const ( StatusMulti = 207 StatusUnprocessableEntity = 422 StatusLocked = 423 StatusFailedDependency = 424 StatusInsufficientStorage = 507 )
http://www.webdav.org/specs/rfc4918.html#status.code.extensions.to.http11
Variables ¶
var ErrNotImplemented = errors.New("not implemented")
ErrNotImplemented should be returned by optional interfaces if they want the original implementation to be used.
var SessionKeyCtx webdavKeyCtx = "user"
Functions ¶
func StatusText ¶
Types ¶
type ContentTyper ¶
type ContentTyper interface { // ContentType returns the content type for the file. // // If this returns error ErrNotImplemented then the error will // be ignored and the base implementation will be used // instead. ContentType(ctx context.Context) (string, error) }
ContentTyper is an optional interface for the *dfs.INode objects returned by the FileSystem.
If this interface is defined then it will be used to read the content type from the object.
If this interface is not defined the file will be opened and the content type will be guessed from the initial contents of the file.
type DeadPropsHolder ¶
type DeadPropsHolder interface { // DeadProps returns a copy of the dead properties held. DeadProps() (map[xml.Name]Property, error) // Patch patches the dead properties held. // // Patching is atomic; either all or no patches succeed. It returns (nil, // non-nil) if an internal server error occurred, otherwise the Propstats // collectively contain one Property for each proposed patch Property. If // all patches succeed, Patch returns a slice of length one and a Propstat // element with a 200 OK HTTP status code. If none succeed, for reasons // other than an internal server error, no Propstat has status 200 OK. // // For more details on when various HTTP status codes apply, see // http://www.webdav.org/specs/rfc4918.html#PROPPATCH-status Patch([]Proppatch) ([]Propstat, error) }
DeadPropsHolder holds the dead properties of a resource.
Dead properties are those properties that are explicitly defined. In comparison, live properties, such as DAV:getcontentlength, are implicitly defined by the underlying resource, and cannot be explicitly overridden or removed. See the Terminology section of http://www.webdav.org/specs/rfc4918.html#rfc.section.3
There is a whitelist of the names of live properties. This package handles all live properties, and will only pass non-whitelisted names to the Patch method of DeadPropsHolder implementations.
type ETager ¶
type ETager interface { // ETag returns an ETag for the file. This should be of the // form "value" or W/"value" // // If this returns error ErrNotImplemented then the error will // be ignored and the base implementation will be used // instead. ETag(ctx context.Context) (string, error) }
ETager is an optional interface for the *dfs.INode objects returned by the FileSystem.
If this interface is defined then it will be used to read the ETag for the object.
If this interface is not defined an ETag will be computed using the ModTime() and the Size() methods of the *dfs.INode object.
type Handler ¶
type Handler struct { // FileSystem is the virtual file system. FileSystem dfs.Service // Sessions handle the users sessions used for authentification. Sessions davsessions.Service Spaces spaces.Service Users users.Service Files files.Service // Logger is an optional error logger. If non-nil, it will be called // for all HTTP requests. Logger func(*http.Request, error) // Prefix is the URL path prefix to strip from WebDAV resource paths. Prefix string }
type Property ¶
type Property struct { // XMLName is the fully qualified name that identifies this property. XMLName xml.Name // Lang is an optional xml:lang attribute. Lang string `xml:"xml:lang,attr,omitempty"` // InnerXML contains the XML representation of the property value. // See http://www.webdav.org/specs/rfc4918.html#property_values // // Property values of complex type or mixed-content must have fully // expanded XML namespaces or be self-contained with according // XML namespace declarations. They must not rely on any XML // namespace declarations within the scope of the XML document, // even including the DAV: namespace. InnerXML []byte `xml:",innerxml"` }
Property represents a single DAV resource property as defined in RFC 4918. See http://www.webdav.org/specs/rfc4918.html#data.model.for.resource.properties
type Proppatch ¶
type Proppatch struct { // Props contains the properties to be set or removed. Props []Property // Remove specifies whether this patch removes properties. If it does not // remove them, it sets them. Remove bool }
Proppatch describes a property update instruction as defined in RFC 4918. See http://www.webdav.org/specs/rfc4918.html#METHOD_PROPPATCH
type Propstat ¶
type Propstat struct { // XMLError contains the XML representation of the optional error element. // XML content within this field must not rely on any predefined // namespace declarations or prefixes. If empty, the XML error element // is omitted. XMLError string // ResponseDescription contains the contents of the optional // responsedescription field. If empty, the XML element is omitted. ResponseDescription string // Props contains the properties for which Status applies. Props []Property // Status defines the HTTP status code of the properties in Prop. // Allowed values include, but are not limited to the WebDAV status // code extensions for HTTP/1.1. // http://www.webdav.org/specs/rfc4918.html#status.code.extensions.to.http11 Status int }
Propstat describes a XML propstat element as defined in RFC 4918. See http://www.webdav.org/specs/rfc4918.html#ELEMENT_propstat