webdav

type BufferedResponseWriter struct {
	// contains filtered or unexported fields
}

type Condition struct {
	Not   bool   // 是否为否定条件
	Token string // 锁定令牌
	ETag  string // 实体标签
}

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)
}

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)
}

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)
}

type Handler struct {
	// Prefix 是要从WebDAV资源路径中删除的URL路径前缀
	// 用于在子目录中挂载WebDAV服务
	Prefix string

	// LockSystem 是锁管理系统
	// 用于支持WebDAV的锁定功能
	LockSystem LockSystem

	// Logger 是可选的错误日志记录器
	// 如果非nil，将为所有HTTP请求调用它来记录错误
	Logger func(*http.Request, error)
}

type LockDetails struct {
	// Root 是被锁定的根资源名称
	// 对于零深度锁，根是唯一被锁定的资源
	Root string

	// Duration 是锁的超时时间
	// 负持续时间表示无限期
	Duration time.Duration

	// OwnerXML 是LOCK HTTP请求中给出的原始<owner>XML内容
	//
	// TODO: "原始"内容是否与XML命名空间兼容？
	// OwnerXML字段是否需要更多结构？参见
	// https://codereview.appspot.com/175140043/#msg2
	OwnerXML string

	// ZeroDepth 表示锁是否具有零深度
	// 如果没有零深度，则具有无限深度
	ZeroDepth bool
}

type LockSystem interface {
	// Confirm 确认调用方可以声明指定条件的所有锁，
	// 并且持有这些锁的并集可以对所有指定资源进行独占访问。
	// 最多可以命名两个资源，空名称将被忽略。
	//
	// release和err中有且仅有一个非nil。如果release非nil，
	// 则所有请求的锁将被持有直到调用release。调用release不会
	// 在WebDAV UNLOCK的意义上解锁，但一旦Confirm确认锁定声明有效，
	// 该锁就不能再被Confirm，直到它被释放。
	//
	// 如果Confirm返回ErrConfirmationFailed，则Handler将继续尝试
	// 请求中提供的其他锁集合（WebDAV HTTP请求可以提供多个锁集合）。
	// 如果返回任何其他非nil错误，Handler将写入"500 Internal Server Error"HTTP状态。
	Confirm(now time.Time, name0, name1 string, conditions ...Condition) (release func(), err error)

	// Create 使用给定的深度、持续时间、所有者和根(name)创建锁。
	// 深度要么为负(表示无限)，要么为零。
	//
	// 如果Create返回ErrLocked，则Handler将写入"423 Locked"HTTP状态。
	// 如果返回任何其他非nil错误，Handler将写入"500 Internal Server Error"HTTP状态。
	//
	// 有关何时使用每种错误的信息，请参见
	// http://www.webdav.org/specs/rfc4918.html#rfc.section.9.10.6
	//
	// 返回的令牌标识创建的锁。它应该是由RFC 3986第4.3节定义的绝对URI。
	// 特别是，它不应包含空格。
	Create(now time.Time, details LockDetails) (token string, err error)

	// Refresh 刷新具有给定令牌的锁的持续时间。
	//
	// 如果Refresh返回ErrLocked，则Handler将写入"423 Locked"HTTP状态。
	// 如果Refresh返回ErrNoSuchLock，则Handler将写入"412 Precondition Failed"HTTP状态。
	// 如果返回任何其他非nil错误，Handler将写入"500 Internal Server Error"HTTP状态。
	//
	// 有关何时使用每种错误的信息，请参见
	// http://www.webdav.org/specs/rfc4918.html#rfc.section.9.10.6
	Refresh(now time.Time, token string, duration time.Duration) (LockDetails, error)

	// Unlock 解锁具有给定令牌的锁。
	//
	// 如果Unlock返回ErrForbidden，则Handler将写入"403 Forbidden"HTTP状态。
	// 如果Unlock返回ErrLocked，则Handler将写入"423 Locked"HTTP状态。
	// 如果Unlock返回ErrNoSuchLock，则Handler将写入"409 Conflict"HTTP状态。
	// 如果返回任何其他非nil错误，Handler将写入"500 Internal Server Error"HTTP状态。
	//
	// 有关何时使用每种错误的信息，请参见
	// http://www.webdav.org/specs/rfc4918.html#rfc.section.9.11.1
	Unlock(now time.Time, token string) error
}

type Property struct {
	// XMLName 是标识此属性的完全限定名称
	XMLName xml.Name

	// Lang 是可选的 xml:lang 属性
	Lang string `xml:"xml:lang,attr,omitempty"`

	// InnerXML 包含属性值的 XML 表示
	// 参见 http://www.webdav.org/specs/rfc4918.html#property_values
	//
	// 复杂类型或混合内容的属性值必须具有完全展开的 XML 命名空间
	// 或者是带有相应 XML 命名空间声明的自包含内容。它们不能依赖于
	// XML 文档范围内的任何 XML 命名空间声明，甚至包括 DAV: 命名空间。
	InnerXML []byte `xml:",innerxml"`
}

type Proppatch struct {
	// Remove specifies whether this patch removes properties. If it does not
	// remove them, it sets them.
	Remove bool
	// Props contains the properties to be set or removed.
	Props []Property
}

type Propstat struct {
	// 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

	// 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
}