Fix WebDAV spelling, remove some inconsistencies (#143)

* Simplify logging, fix WebDAV spelling

* Define options types per package

* Move util functions that are not used cross package

* Add per file license headers

* Rename config type

internal/storage/webdav/webdav.go

@@ -1,7 +1,11 @@
+// Copyright 2022 - Offen Authors <hioffen@posteo.de>
+// SPDX-License-Identifier: MPL-2.0
+
 package webdav
 
 import (
 	"errors"
+	"fmt"
 	"io/fs"
 	"net/http"
 	"os"
@@ -20,28 +24,36 @@ type webDavStorage struct {
 	url    string
 }
 
+// Config allows to configure a WebDAV storage backend.
+type Config struct {
+	URL         string
+	RemotePath  string
+	Username    string
+	Password    string
+	URLInsecure bool
+}
+
 // NewStorageBackend creates and initializes a new WebDav storage backend.
-func NewStorageBackend(url string, remotePath string, username string, password string, urlInsecure bool,
-	logFunc storage.Log) (storage.Backend, error) {
+func NewStorageBackend(opts Config, logFunc storage.Log) (storage.Backend, error) {
 
-	if username == "" || password == "" {
-		return nil, errors.New("newScript: WEBDAV_URL is defined, but no credentials were provided")
+	if opts.Username == "" || opts.Password == "" {
+		return nil, errors.New("NewStorageBackend: WEBDAV_URL is defined, but no credentials were provided")
 	} else {
-		webdavClient := gowebdav.NewClient(url, username, password)
+		webdavClient := gowebdav.NewClient(opts.URL, opts.Username, opts.Password)
 
-		if urlInsecure {
+		if opts.URLInsecure {
 			defaultTransport, ok := http.DefaultTransport.(*http.Transport)
 			if !ok {
-				return nil, errors.New("newScript: unexpected error when asserting type for http.DefaultTransport")
+				return nil, errors.New("NewStorageBackend: unexpected error when asserting type for http.DefaultTransport")
 			}
 			webdavTransport := defaultTransport.Clone()
-			webdavTransport.TLSClientConfig.InsecureSkipVerify = urlInsecure
+			webdavTransport.TLSClientConfig.InsecureSkipVerify = opts.URLInsecure
 			webdavClient.SetTransport(webdavTransport)
 		}
 
 		return &webDavStorage{
 			StorageBackend: &storage.StorageBackend{
-				DestinationPath: remotePath,
+				DestinationPath: opts.RemotePath,
 				Log:             logFunc,
 			},
 			client: webdavClient,
@@ -51,7 +63,7 @@ func NewStorageBackend(url string, remotePath string, username string, password
 
 // Name returns the name of the storage backend
 func (b *webDavStorage) Name() string {
-	return "WebDav"
+	return "WebDAV"
 }
 
 // Copy copies the given file to the WebDav storage backend.
@@ -59,15 +71,15 @@ func (b *webDavStorage) Copy(file string) error {
 	bytes, err := os.ReadFile(file)
 	_, name := path.Split(file)
 	if err != nil {
-		return b.Log(storage.ERROR, b.Name(), "Copy: Error reading the file to be uploaded! %w", err)
+		return fmt.Errorf("(*webDavStorage).Copy: Error reading the file to be uploaded! %w", err)
 	}
 	if err := b.client.MkdirAll(b.DestinationPath, 0644); err != nil {
-		return b.Log(storage.ERROR, b.Name(), "Copy: Error creating directory '%s' on WebDAV server! %w", b.DestinationPath, err)
+		return fmt.Errorf("(*webDavStorage).Copy: Error creating directory '%s' on WebDAV server! %w", b.DestinationPath, err)
 	}
 	if err := b.client.Write(filepath.Join(b.DestinationPath, name), bytes, 0644); err != nil {
-		return b.Log(storage.ERROR, b.Name(), "Copy: Error uploading the file to WebDAV server! %w", err)
+		return fmt.Errorf("(*webDavStorage).Copy: Error uploading the file to WebDAV server! %w", err)
 	}
-	b.Log(storage.INFO, b.Name(), "Uploaded a copy of backup `%s` to WebDAV-URL '%s' at path '%s'.", file, b.url, b.DestinationPath)
+	b.Log(storage.LogLevelInfo, b.Name(), "Uploaded a copy of backup `%s` to WebDAV-URL '%s' at path '%s'.", file, b.url, b.DestinationPath)
 
 	return nil
 }
@@ -76,7 +88,7 @@ func (b *webDavStorage) Copy(file string) error {
 func (b *webDavStorage) Prune(deadline time.Time, pruningPrefix string) (*storage.PruneStats, error) {
 	candidates, err := b.client.ReadDir(b.DestinationPath)
 	if err != nil {
-		return nil, b.Log(storage.ERROR, b.Name(), "Prune: Error looking up candidates from remote storage! %w", err)
+		return nil, fmt.Errorf("(*webDavStorage).Prune: Error looking up candidates from remote storage! %w", err)
 	}
 	var matches []fs.FileInfo
 	var lenCandidates int
@@ -95,14 +107,16 @@ func (b *webDavStorage) Prune(deadline time.Time, pruningPrefix string) (*storag
 		Pruned: uint(len(matches)),
 	}
 
-	b.DoPrune(b.Name(), len(matches), lenCandidates, "WebDAV backup(s)", func() error {
+	if err := b.DoPrune(b.Name(), len(matches), lenCandidates, "WebDAV backup(s)", func() error {
 		for _, match := range matches {
 			if err := b.client.Remove(filepath.Join(b.DestinationPath, match.Name())); err != nil {
-				return b.Log(storage.ERROR, b.Name(), "Prune: Error removing file from WebDAV storage! %w", err)
+				return fmt.Errorf("(*webDavStorage).Prune: Error removing file from WebDAV storage! %w", err)
 			}
 		}
 		return nil
-	})
+	}); err != nil {
+		return stats, err
+	}
 
 	return stats, nil
 }