fix #6: added gowebdav and webdav interface (TODO: webdav tests)

auth.go

@@ -2,7 +2,10 @@ package gonextcloud
 
 import (
 	"fmt"
+
 	req "github.com/levigross/grequests"
+	"github.com/studio-b12/gowebdav"
+
 	"gitlab.bertha.cloud/partitio/Nextcloud-Partitio/gonextcloud/types"
 )
 
@@ -33,6 +36,8 @@ func (c *Client) Login(username string, password string) error {
 		e := types.APIError{Message: "authentication failed"}
 		return &e
 	}
+	// Create webdav client
+	c.webdav = gowebdav.NewClient(c.baseURL.String()+"/remote.php/webdav", c.username, c.password)
 	return nil
 }
 

client.go

 package gonextcloud
 
 import (
+	"net/url"
+
 	req "github.com/levigross/grequests"
+	"github.com/studio-b12/gowebdav"
+
 	"gitlab.bertha.cloud/partitio/Nextcloud-Partitio/gonextcloud/types"
-	"net/url"
 )
 
 // Client is the API client that performs all operations against a Nextcloud server.
@@ -23,6 +26,7 @@ type Client struct {
 	shares        *Shares
 	users         *Users
 	groups        *Groups
+	webdav        *gowebdav.Client
 }
 
 // NewClient create a new Client from the Nextcloud Instance URL
@@ -42,6 +46,7 @@ func NewClient(hostname string) (*Client, error) {
 			"Accept":         "application/json",
 		},
 	}
+
 	c.apps = &Apps{c}
 	c.appsConfig = &AppsConfig{c}
 	c.groupFolders = &GroupFolders{c}
@@ -49,6 +54,9 @@ func NewClient(hostname string) (*Client, error) {
 	c.shares = &Shares{c}
 	c.users = &Users{c}
 	c.groups = &Groups{c}
+	// Create empty webdav client
+	// It will be replaced after login
+	c.webdav = &gowebdav.Client{}
 	return c, nil
 }
 
@@ -86,3 +94,8 @@ func (c *Client) Users() types.Users {
 func (c *Client) Groups() types.Groups {
 	return c.groups
 }
+
+// WebDav return the WebDav client Interface
+func (c *Client) WebDav() types.WebDav {
+	return c.webdav
+}

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/pkg/errors v0.0.0-20181023235946-059132a15dd0
 	github.com/sirupsen/logrus v1.4.2
 	github.com/stretchr/testify v1.2.2
+	github.com/studio-b12/gowebdav v0.0.0-20190103184047-38f79aeaf1ac
 	golang.org/x/net v0.0.0-20181129055619-fae4c4e3ad76 // indirect
 	gopkg.in/yaml.v2 v2.2.1
 )

go.sum

@@ -18,6 +18,8 @@ github.com/stretchr/objx v0.1.1 h1:2vfRuCMp5sSVIDSqO8oNnWJq7mPa6KVP3iPIwFBuy8A=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/studio-b12/gowebdav v0.0.0-20190103184047-38f79aeaf1ac h1:xQ9gCVzqb939vjhxuES4IXYe4AlHB4Q71/K06aazQmQ=
+github.com/studio-b12/gowebdav v0.0.0-20190103184047-38f79aeaf1ac/go.mod h1:gCcfDlA1Y7GqOaeEKw5l9dOGx1VLdc/HuQSlQAaZ30s=
 golang.org/x/net v0.0.0-20181129055619-fae4c4e3ad76 h1:xx5MUFyRQRbPk6VjWjIE1epE/K5AoDD8QUN116NCy8k=
 golang.org/x/net v0.0.0-20181129055619-fae4c4e3ad76/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc=

types/interfaces.go

@@ -9,6 +9,7 @@ type Client interface {
 	Shares() Shares
 	Users() Users
 	Groups() Groups
+	WebDav() WebDav
 	Login(username string, password string) error
 	Logout() error
 }

types/webdav.go

+package types
+
+import (
+	"io"
+	"os"
+)
+
+// WebDav available methods
+type WebDav interface {
+	// ReadDir reads the contents of a remote directory
+	ReadDir(path string) ([]os.FileInfo, error)
+	// Stat returns the file stats for a specified path
+	Stat(path string) (os.FileInfo, error)
+	// Remove removes a remote file
+	Remove(path string) error
+	// RemoveAll removes remote files
+	RemoveAll(path string) error
+	// Mkdir makes a directory
+	Mkdir(path string, _ os.FileMode) error
+	// MkdirAll like mkdir -p, but for webdav
+	MkdirAll(path string, _ os.FileMode) error
+	// Rename moves a file from A to B
+	Rename(oldpath, newpath string, overwrite bool) error
+	// Copy copies a file from A to B
+	Copy(oldpath, newpath string, overwrite bool) error
+	// Read reads the contents of a remote file
+	Read(path string) ([]byte, error)
+	// ReadStream reads the stream for a given path
+	ReadStream(path string) (io.ReadCloser, error)
+	// Write writes data to a given path
+	Write(path string, data []byte, _ os.FileMode) error
+	// WriteStream writes a stream
+	WriteStream(path string, stream io.Reader, _ os.FileMode) error
+}

vendor/github.com/studio-b12/gowebdav/.gitignore

+# Folders to ignore
+/src
+/bin
+/pkg
+/gowebdav
+/.idea
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out

vendor/github.com/studio-b12/gowebdav/.travis.yml

+language: go
+
+go:
+  - "1.x"
+
+install:
+  - go get ./...
+
+script:
+  - go test -v --short ./...
\ No newline at end of file

vendor/github.com/studio-b12/gowebdav/LICENSE

+Copyright (c) 2014, Studio B12 GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

vendor/github.com/studio-b12/gowebdav/Makefile

+BIN := gowebdav
+SRC := $(wildcard *.go) cmd/gowebdav/main.go
+
+all: test cmd
+
+cmd: ${BIN}
+
+${BIN}: ${SRC}
+	go build -o $@ ./cmd/gowebdav
+
+test:
+	go test -v --short ./...
+
+api:
+	@sed '/^## API$$/,$$d' -i README.md
+	@echo '## API' >> README.md
+	@godoc2md github.com/studio-b12/gowebdav | sed '/^$$/N;/^\n$$/D' |\
+	sed '2d' |\
+	sed 's/\/src\/github.com\/studio-b12\/gowebdav\//https:\/\/github.com\/studio-b12\/gowebdav\/blob\/master\//g' |\
+	sed 's/\/src\/target\//https:\/\/github.com\/studio-b12\/gowebdav\/blob\/master\//g' |\
+	sed 's/^#/##/g' >> README.md
+
+check:
+	gofmt -w -s $(SRC)
+	@echo
+	gocyclo -over 15 .
+	@echo
+	golint ./...
+
+clean:
+	@rm -f ${BIN}
+
+.PHONY: all cmd clean test api check

vendor/github.com/studio-b12/gowebdav/README.md

+# GoWebDAV
+
+[![Build Status](https://travis-ci.org/studio-b12/gowebdav.svg?branch=master)](https://travis-ci.org/studio-b12/gowebdav)
+[![GoDoc](https://godoc.org/github.com/studio-b12/gowebdav?status.svg)](https://godoc.org/github.com/studio-b12/gowebdav)
+[![Go Report Card](https://goreportcard.com/badge/github.com/studio-b12/gowebdav)](https://goreportcard.com/report/github.com/studio-b12/gowebdav)
+
+A golang WebDAV client library.
+
+## Main features
+`gowebdav` library allows to perform following actions on the remote WebDAV server:
+* [create path](#create-path-on-a-webdav-server)
+* [get files list](#get-files-list)
+* [download file](#download-file-to-byte-array)
+* [upload file](#upload-file-from-byte-array)
+* [get information about specified file/folder](#get-information-about-specified-filefolder)
+* [move file to another location](#move-file-to-another-location)
+* [copy file to another location](#copy-file-to-another-location)
+* [delete file](#delete-file)
+
+## Usage
+
+First of all you should create `Client` instance using `NewClient()` function:
+
+```go
+root := "https://webdav.mydomain.me"
+user := "user"
+password := "password"
+
+c := gowebdav.NewClient(root, user, password)
+```
+
+After you can use this `Client` to perform actions, described below.
+
+**NOTICE:** we will not check errors in examples, to focus you on the `gowebdav` library's code, but you should do it in your code!
+
+### Create path on a WebDAV server
+```go
+err := c.Mkdir("folder", 0644)
+```
+In case you want to create several folders you can use `c.MkdirAll()`:
+```go
+err := c.MkdirAll("folder/subfolder/subfolder2", 0644)
+```
+
+### Get files list
+```go
+files, _ := c.ReadDir("folder/subfolder")
+for _, file := range files {
+    //notice that [file] has os.FileInfo type
+    fmt.Println(file.Name())
+}
+```
+
+### Download file to byte array
+```go
+webdavFilePath := "folder/subfolder/file.txt"
+localFilePath := "/tmp/webdav/file.txt"
+
+bytes, _ := c.Read(webdavFilePath)
+ioutil.WriteFile(localFilePath, bytes, 0644)
+```
+
+### Download file via reader
+Also you can use `c.ReadStream()` method:
+```go
+webdavFilePath := "folder/subfolder/file.txt"
+localFilePath := "/tmp/webdav/file.txt"
+
+reader, _ := c.ReadStream(webdavFilePath)
+
+file, _ := os.Create(localFilePath)
+defer file.Close()
+
+io.Copy(file, reader)
+```
+
+### Upload file from byte array
+```go
+webdavFilePath := "folder/subfolder/file.txt"
+localFilePath := "/tmp/webdav/file.txt"
+
+bytes, _ := ioutil.ReadFile(localFilePath)
+
+c.Write(webdavFilePath, bytes, 0644)
+```
+
+### Upload file via writer
+```go
+webdavFilePath := "folder/subfolder/file.txt"
+localFilePath := "/tmp/webdav/file.txt"
+
+file, _ := os.Open(localFilePath)
+defer file.Close()
+
+c.WriteStream(webdavFilePath, file, 0644)
+```
+
+### Get information about specified file/folder
+```go
+webdavFilePath := "folder/subfolder/file.txt"
+
+info := c.Stat(webdavFilePath)
+//notice that [info] has os.FileInfo type
+fmt.Println(info)
+```
+
+### Move file to another location
+```go
+oldPath := "folder/subfolder/file.txt"
+newPath := "folder/subfolder/moved.txt"
+isOverwrite := true
+
+c.Rename(oldPath, newPath, isOverwrite)
+```
+
+### Copy file to another location
+```go
+oldPath := "folder/subfolder/file.txt"
+newPath := "folder/subfolder/file-copy.txt"
+isOverwrite := true
+
+c.Copy(oldPath, newPath, isOverwrite)
+```
+
+### Delete file
+```go
+webdavFilePath := "folder/subfolder/file.txt"
+
+c.Remove(webdavFilePath)
+```
+
+## Links
+
+More details about WebDAV server you can read from following resources:
+
+* [RFC 4918 - HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)](https://tools.ietf.org/html/rfc4918)
+* [RFC 5689 - Extended MKCOL for Web Distributed Authoring and Versioning (WebDAV)](https://tools.ietf.org/html/rfc5689)
+* [RFC 2616 - HTTP/1.1 Status Code Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html "HTTP/1.1 Status Code Definitions")
+* [WebDav: Next Generation Collaborative Web Authoring By Lisa Dusseaul](https://books.google.de/books?isbn=0130652083 "WebDav: Next Generation Collaborative Web Authoring By Lisa Dusseault")
+
+**NOTICE**: RFC 2518 is obsoleted by RFC 4918 in June 2007
+
+## Contributing
+All contributing are welcome. If you have any suggestions or find some bug - please create an Issue to let us make this project better. We appreciate your help!
+
+## License
+This library is distributed under the BSD 3-Clause license found in the [LICENSE](https://github.com/studio-b12/gowebdav/blob/master/LICENSE) file.

vendor/github.com/studio-b12/gowebdav/basicAuth.go

+package gowebdav
+
+import (
+	"encoding/base64"
+)
+
+// BasicAuth structure holds our credentials
+type BasicAuth struct {
+	user string
+	pw   string
+}
+
+// Type identifies the BasicAuthenticator
+func (b *BasicAuth) Type() string {
+	return "BasicAuth"
+}
+
+// User holds the BasicAuth username
+func (b *BasicAuth) User() string {
+	return b.user
+}
+
+// Pass holds the BasicAuth password
+func (b *BasicAuth) Pass() string {
+	return b.pw
+}
+
+// Authorize the current request
+func (b *BasicAuth) Authorize(c *Client, method string, path string) {
+	a := b.user + ":" + b.pw
+	auth := "Basic " + base64.StdEncoding.EncodeToString([]byte(a))
+	c.headers.Set("Authorization", auth)
+}

vendor/github.com/studio-b12/gowebdav/client.go

+package gowebdav
+
+import (
+	"bytes"
+	"encoding/xml"
+	"io"
+	"net/http"
+	"net/url"
+	"os"
+	pathpkg "path"
+	"strings"
+	"time"
+)
+
+// Client defines our structure
+type Client struct {
+	root    string
+	headers http.Header
+	c       *http.Client
+	auth    Authenticator
+}
+
+// Authenticator stub
+type Authenticator interface {
+	Type() string
+	User() string
+	Pass() string
+	Authorize(*Client, string, string)
+}
+
+// NoAuth structure holds our credentials
+type NoAuth struct {
+	user string
+	pw   string
+}
+
+// Type identifies the authenticator
+func (n *NoAuth) Type() string {
+	return "NoAuth"
+}
+
+// User returns the current user
+func (n *NoAuth) User() string {
+	return n.user
+}
+
+// Pass returns the current password
+func (n *NoAuth) Pass() string {
+	return n.pw
+}
+
+// Authorize the current request
+func (n *NoAuth) Authorize(c *Client, method string, path string) {
+}
+
+// NewClient creates a new instance of client
+func NewClient(uri, user, pw string) *Client {
+	return &Client{FixSlash(uri), make(http.Header), &http.Client{}, &NoAuth{user, pw}}
+}
+
+// SetHeader lets us set arbitrary headers for a given client
+func (c *Client) SetHeader(key, value string) {
+	c.headers.Add(key, value)
+}
+
+// SetTimeout exposes the ability to set a time limit for requests
+func (c *Client) SetTimeout(timeout time.Duration) {
+	c.c.Timeout = timeout
+}
+
+// SetTransport exposes the ability to define custom transports
+func (c *Client) SetTransport(transport http.RoundTripper) {
+	c.c.Transport = transport
+}
+
+// Connect connects to our dav server
+func (c *Client) Connect() error {
+	rs, err := c.options("/")
+	if err != nil {
+		return err
+	}
+
+	err = rs.Body.Close()
+	if err != nil {
+		return err
+	}
+
+	if rs.StatusCode != 200 {
+		return newPathError("Connect", c.root, rs.StatusCode)
+	}
+
+	return nil
+}
+
+type props struct {
+	Status      string   `xml:"DAV: status"`
+	Name        string   `xml:"DAV: prop>displayname,omitempty"`
+	Type        xml.Name `xml:"DAV: prop>resourcetype>collection,omitempty"`
+	Size        string   `xml:"DAV: prop>getcontentlength,omitempty"`
+	ContentType string   `xml:"DAV: prop>getcontenttype,omitempty"`
+	ETag        string   `xml:"DAV: prop>getetag,omitempty"`
+	Modified    string   `xml:"DAV: prop>getlastmodified,omitempty"`
+}
+
+type response struct {
+	Href  string  `xml:"DAV: href"`
+	Props []props `xml:"DAV: propstat"`
+}
+
+func getProps(r *response, status string) *props {
+	for _, prop := range r.Props {
+		if strings.Contains(prop.Status, status) {
+			return &prop
+		}
+	}
+	return nil
+}
+
+// ReadDir reads the contents of a remote directory
+func (c *Client) ReadDir(path string) ([]os.FileInfo, error) {
+	path = FixSlashes(path)
+	files := make([]os.FileInfo, 0)
+	skipSelf := true
+	parse := func(resp interface{}) error {
+		r := resp.(*response)
+
+		if skipSelf {
+			skipSelf = false
+			if p := getProps(r, "200"); p != nil && p.Type.Local == "collection" {
+				r.Props = nil
+				return nil
+			}
+			return newPathError("ReadDir", path, 405)
+		}
+
+		if p := getProps(r, "200"); p != nil {
+			f := new(File)
+			if ps, err := url.QueryUnescape(r.Href); err == nil {
+				f.name = pathpkg.Base(ps)
+			} else {
+				f.name = p.Name
+			}
+			f.path = path + f.name
+			f.modified = parseModified(&p.Modified)
+			f.etag = p.ETag
+			f.contentType = p.ContentType
+
+			if p.Type.Local == "collection" {
+				f.path += "/"
+				f.size = 0
+				f.isdir = true
+			} else {
+				f.size = parseInt64(&p.Size)
+				f.isdir = false
+			}
+
+			files = append(files, *f)
+		}
+
+		r.Props = nil
+		return nil
+	}
+
+	err := c.propfind(path, false,
+		`<d:propfind xmlns:d='DAV:'>
+			<d:prop>
+				<d:displayname/>
+				<d:resourcetype/>
+				<d:getcontentlength/>
+				<d:getcontenttype/>
+				<d:getetag/>
+				<d:getlastmodified/>
+			</d:prop>
+		</d:propfind>`,
+		&response{},
+		parse)
+
+	if err != nil {
+		if _, ok := err.(*os.PathError); !ok {
+			err = newPathErrorErr("ReadDir", path, err)
+		}
+	}
+	return files, err
+}
+
+// Stat returns the file stats for a specified path
+func (c *Client) Stat(path string) (os.FileInfo, error) {
+	var f *File
+	parse := func(resp interface{}) error {
+		r := resp.(*response)
+		if p := getProps(r, "200"); p != nil && f == nil {
+			f = new(File)
+			f.name = p.Name
+			f.path = path
+			f.etag = p.ETag
+			f.contentType = p.ContentType
+
+			if p.Type.Local == "collection" {
+				if !strings.HasSuffix(f.path, "/") {
+					f.path += "/"