gowebdav

README

GoWebDAV

该仓库魔改自 https://github.com/studio-b12/gowebdav

• 删掉了命令行工具
• 引入轱辘工具库日志组件
• 重命名支持中文路径
• 文件返回统一使用指针

Documentation

Overview

Package gowebdav is a WebDAV client library.

Index

• Variables
• func FixSlash(s string) string
• func FixSlashes(s string) string
• func Join(path0 string, path1 string) string
• func PathEscape(path string) string
• func String(r io.Reader) string
• type Authenticator
• type BasicAuth
  • func (b *BasicAuth) Authorize(req *http.Request, method string, path string)
  • func (b *BasicAuth) Pass() string
  • func (b *BasicAuth) Type() string
  • func (b *BasicAuth) User() string
• type Client
  • func NewClient(uri, user, pw string) *Client
  • func (c *Client) Connect() error
  • func (c *Client) Copy(oldpath, newpath string, overwrite bool) error
  • func (c *Client) Mkdir(path string, _ os.FileMode) error
  • func (c *Client) MkdirAll(path string, _ os.FileMode) error
  • func (c *Client) Read(path string) ([]byte, error)
  • func (c *Client) ReadDir(path string) ([]os.FileInfo, error)
  • func (c *Client) ReadStream(path string) (io.ReadCloser, error)
  • func (c *Client) Remove(path string) error
  • func (c *Client) RemoveAll(path string) error
  • func (c *Client) Rename(oldpath, newpath string, overwrite bool) error
  • func (c *Client) SetHeader(key, value string)
  • func (c *Client) SetTimeout(timeout time.Duration)
  • func (c *Client) SetTransport(transport http.RoundTripper)
  • func (c *Client) Stat(path string) (os.FileInfo, error)
  • func (c *Client) Write(path string, data []byte, _ os.FileMode) error
  • func (c *Client) WriteStream(path string, stream io.Reader, _ os.FileMode) error
• type DigestAuth
  • func (d *DigestAuth) Authorize(req *http.Request, method string, path string)
  • func (d *DigestAuth) Pass() string
  • func (d *DigestAuth) Type() string
  • func (d *DigestAuth) User() string
• type File
  • func (f *File) ContentType() string
  • func (f *File) ETag() string
  • func (f *File) IsDir() bool
  • func (f *File) ModTime() time.Time
  • func (f *File) Mode() os.FileMode
  • func (f *File) Name() string
  • func (f *File) Path() string
  • func (f *File) SetContentType(contentType string)
  • func (f *File) SetEtag(etag string)
  • func (f *File) SetIsDir(isDir bool)
  • func (f *File) SetModified(modified time.Time)
  • func (f *File) SetName(name string)
  • func (f *File) SetPath(path string)
  • func (f *File) SetSize(size int64)
  • func (f *File) Size() int64
  • func (f *File) String() string
  • func (f *File) Sys() interface{}
• type NoAuth
  • func (n *NoAuth) Authorize(req *http.Request, method string, path string)
  • func (n *NoAuth) Pass() string
  • func (n *NoAuth) Type() string
  • func (n *NoAuth) User() string

Examples

• PathEscape

Variables

var Logger *gulu.Logger

Functions

func FixSlash

func FixSlash(s string) string

FixSlash appends a trailing / to our string

func FixSlashes

func FixSlashes(s string) string

FixSlashes appends and prepends a / if they are missing

func Join

func Join(path0 string, path1 string) string

Join joins two paths

func PathEscape

func PathEscape(path string) string

PathEscape escapes all segemnts of a given path

Example

fmt.Println(PathEscape(""))
fmt.Println(PathEscape("/"))
fmt.Println(PathEscape("/web"))
fmt.Println(PathEscape("/web/"))
fmt.Println(PathEscape("/w e b/d a v/s%u&c#k:s/"))
fmt.Println(PathEscape("/目录1/目录2/"))

Output:


/
/web
/web/
/w%20e%20b/d%20a%20v/s%25u&c%23k:s/
/%E7%9B%AE%E5%BD%951/%E7%9B%AE%E5%BD%952/

func String

func String(r io.Reader) string

String pulls a string out of our io.Reader

Types

type Authenticator

type Authenticator interface {
	Type() string
	User() string
	Pass() string
	Authorize(*http.Request, string, string)
}

Authenticator stub

type BasicAuth

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

BasicAuth structure holds our credentials

func (*BasicAuth) Authorize

func (b *BasicAuth) Authorize(req *http.Request, method string, path string)

Authorize the current request

func (*BasicAuth) Pass

func (b *BasicAuth) Pass() string

Pass holds the BasicAuth password

func (*BasicAuth) Type

func (b *BasicAuth) Type() string

Type identifies the BasicAuthenticator

func (*BasicAuth) User

func (b *BasicAuth) User() string

User holds the BasicAuth username

type Client

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

Client defines our structure

func NewClient

func NewClient(uri, user, pw string) *Client

NewClient creates a new instance of client

func (*Client) Connect

func (c *Client) Connect() error

Connect connects to our dav server

func (*Client) Copy

func (c *Client) Copy(oldpath, newpath string, overwrite bool) error

Copy copies a file from A to B

func (*Client) Mkdir

func (c *Client) Mkdir(path string, _ os.FileMode) error

Mkdir makes a directory

func (*Client) MkdirAll

func (c *Client) MkdirAll(path string, _ os.FileMode) error

MkdirAll like mkdir -p, but for webdav

func (*Client) Read

func (c *Client) Read(path string) ([]byte, error)

Read reads the contents of a remote file

func (*Client) ReadDir

func (c *Client) ReadDir(path string) ([]os.FileInfo, error)

ReadDir reads the contents of a remote directory

func (*Client) ReadStream

func (c *Client) ReadStream(path string) (io.ReadCloser, error)

ReadStream reads the stream for a given path

func (*Client) Remove

func (c *Client) Remove(path string) error

Remove removes a remote file

func (*Client) RemoveAll

func (c *Client) RemoveAll(path string) error

RemoveAll removes remote files

func (*Client) Rename

func (c *Client) Rename(oldpath, newpath string, overwrite bool) error

Rename moves a file from A to B

func (*Client) SetHeader

func (c *Client) SetHeader(key, value string)

SetHeader lets us set arbitrary headers for a given client

func (*Client) SetTimeout

func (c *Client) SetTimeout(timeout time.Duration)

SetTimeout exposes the ability to set a time limit for requests

func (*Client) SetTransport

func (c *Client) SetTransport(transport http.RoundTripper)

SetTransport exposes the ability to define custom transports

func (*Client) Stat

func (c *Client) Stat(path string) (os.FileInfo, error)

Stat returns the file stats for a specified path

func (*Client) Write

func (c *Client) Write(path string, data []byte, _ os.FileMode) error

Write writes data to a given path

func (*Client) WriteStream

func (c *Client) WriteStream(path string, stream io.Reader, _ os.FileMode) error

WriteStream writes a stream

type DigestAuth

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

DigestAuth structure holds our credentials

func (*DigestAuth) Authorize

func (d *DigestAuth) Authorize(req *http.Request, method string, path string)

Authorize the current request

func (*DigestAuth) Pass

func (d *DigestAuth) Pass() string

Pass holds the DigestAuth password

func (*DigestAuth) Type

func (d *DigestAuth) Type() string

Type identifies the DigestAuthenticator

func (*DigestAuth) User

func (d *DigestAuth) User() string

User holds the DigestAuth username

type File

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

File is our structure for a given file

func (*File) ContentType

func (f *File) ContentType() string

ContentType returns the content type of a file

func (*File) ETag

func (f *File) ETag() string

ETag returns the ETag of a file

func (*File) IsDir

func (f *File) IsDir() bool

IsDir let us see if a given file is a directory or not

func (*File) ModTime

func (f *File) ModTime() time.Time

ModTime returns the modified time of a file

func (*File) Mode

func (f *File) Mode() os.FileMode

Mode will return the mode of a given file

func (*File) Name

func (f *File) Name() string

Name returns the name of a file

func (*File) Path

func (f *File) Path() string

Path returns the path of a file

func (*File) SetContentType

func (f *File) SetContentType(contentType string)

func (*File) SetEtag

func (f *File) SetEtag(etag string)

func (*File) SetIsDir

func (f *File) SetIsDir(isDir bool)

func (*File) SetModified

func (f *File) SetModified(modified time.Time)

func (*File) SetName

func (f *File) SetName(name string)

func (*File) SetPath

func (f *File) SetPath(path string)

func (*File) SetSize

func (f *File) SetSize(size int64)

func (*File) Size

func (f *File) Size() int64

Size returns the size of a file

func (*File) String

func (f *File) String() string

String lets us see file information

func (*File) Sys

func (f *File) Sys() interface{}

Sys ????

type NoAuth

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

NoAuth structure holds our credentials

func (*NoAuth) Authorize

func (n *NoAuth) Authorize(req *http.Request, method string, path string)

Authorize the current request

func (*NoAuth) Pass

func (n *NoAuth) Pass() string

Pass returns the current password

func (*NoAuth) Type

func (n *NoAuth) Type() string

Type identifies the authenticator

func (*NoAuth) User

func (n *NoAuth) User() string

User returns the current user