Add user avatar settings handler methods

docs/content/doc/usage/errors.md

@@ -37,6 +37,7 @@ This document describes the different errors Vikunja can return.
 | 1015 | 412 | Totp is already enabled for this user. |
 | 1016 | 412 | Totp is not enabled for this user. |
 | 1017 | 412 | The provided Totp passcode is invalid. |
+| 1018 | 412 | The provided user avatar provider type setting is invalid. |
 
 ### Validation
 

pkg/routes/api/v1/avatar.go

@@ -17,7 +17,6 @@
 package v1
 
 import (
-	"code.vikunja.io/api/pkg/config"
 	"code.vikunja.io/api/pkg/log"
 	"code.vikunja.io/api/pkg/modules/avatar"
 	"code.vikunja.io/api/pkg/modules/avatar/empty"
@@ -55,7 +54,7 @@ func GetAvatar(c echo.Context) error {
 	// For now, we only have one avatar provider, in the future there could be multiple which
 	// could be changed based on user settings etc.
 	var avatarProvider avatar.Provider
-	switch config.AvatarProvider.GetString() {
+	switch user.AvatarProvider {
 	case "gravatar":
 		avatarProvider = &gravatar.Provider{}
 	default:

pkg/routes/api/v1/user_settings.go

@@ -0,0 +1,97 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2020 Vikunja and contributors. All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package v1
+
+import (
+	"code.vikunja.io/api/pkg/models"
+	user2 "code.vikunja.io/api/pkg/user"
+	"code.vikunja.io/web/handler"
+	"github.com/labstack/echo/v4"
+	"net/http"
+)
+
+// UserAvatarProvider holds the user avatar provider type
+type UserAvatarProvider struct {
+	AvatarProvider string `json:"avatar_provider"`
+}
+
+// GetUserAvatarProvider returns the currently set user avatar
+// @Summary Return user avatar setting
+// @Description Returns the current user's avatar setting.
+// @tags user
+// @Accept json
+// @Produce json
+// @Security JWTKeyAuth
+// @Success 200 {object} UserAvatarProvider
+// @Failure 400 {object} web.HTTPError "Something's invalid."
+// @Failure 500 {object} models.Message "Internal server error."
+// @Router /user/settings/avatar [get]
+func GetUserAvatarProvider(c echo.Context) error {
+
+	u, err := user2.GetCurrentUser(c)
+	if err != nil {
+		return handler.HandleHTTPError(err, c)
+	}
+
+	user, err := user2.GetUserWithEmail(u)
+	if err != nil {
+		return handler.HandleHTTPError(err, c)
+	}
+
+	uap := &UserAvatarProvider{AvatarProvider: user.AvatarProvider}
+	return c.JSON(http.StatusOK, uap)
+}
+
+// ChangeUserAvatarProvider changes the user's avatar provider
+// @Summary Set the user's avatar
+// @Description Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, default.
+// @tags user
+// @Accept json
+// @Produce json
+// @Security JWTKeyAuth
+// @Param avatar body UserAvatarProvider true "The user's avatar setting"
+// @Success 200 {object} UserAvatarProvider
+// @Failure 400 {object} web.HTTPError "Something's invalid."
+// @Failure 500 {object} models.Message "Internal server error."
+// @Router /user/settings/avatar [post]
+func ChangeUserAvatarProvider(c echo.Context) error {
+
+	uap := &UserAvatarProvider{}
+	err := c.Bind(uap)
+	if err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Bad avatar type provided.")
+	}
+
+	u, err := user2.GetCurrentUser(c)
+	if err != nil {
+		return handler.HandleHTTPError(err, c)
+	}
+
+	user, err := user2.GetUserWithEmail(u)
+	if err != nil {
+		return handler.HandleHTTPError(err, c)
+	}
+
+	user.AvatarProvider = uap.AvatarProvider
+
+	_, err = user2.UpdateUser(user)
+	if err != nil {
+		return handler.HandleHTTPError(err, c)
+	}
+
+	return c.JSON(http.StatusOK, &models.Message{Message: "Avatar was changed successfully."})
+}

pkg/user/error.go

@@ -366,3 +366,30 @@ func (err ErrInvalidTOTPPasscode) HTTPError() web.HTTPError {
 		Message:  "Invalid totp passcode.",
 	}
 }
+
+// ErrInvalidAvatarProvider represents a "InvalidAvatarProvider" kind of error.
+type ErrInvalidAvatarProvider struct {
+	AvatarProvider string
+}
+
+// IsErrInvalidAvatarProvider checks if an error is a ErrInvalidAvatarProvider.
+func IsErrInvalidAvatarProvider(err error) bool {
+	_, ok := err.(ErrInvalidAvatarProvider)
+	return ok
+}
+
+func (err ErrInvalidAvatarProvider) Error() string {
+	return "Invalid avatar provider"
+}
+
+// ErrCodeInvalidAvatarProvider holds the unique world-error code of this error
+const ErrCodeInvalidAvatarProvider = 1018
+
+// HTTPError holds the http error description
+func (err ErrInvalidAvatarProvider) HTTPError() web.HTTPError {
+	return web.HTTPError{
+		HTTPCode: http.StatusPreconditionFailed,
+		Code:     ErrCodeInvalidAvatarProvider,
+		Message:  "Invalid avatar provider setting. See docs for valid types.",
+	}
+}

pkg/user/user.go

@@ -325,6 +325,16 @@ func UpdateUser(user *User) (updatedUser *User, err error) {
 
 	user.Password = theUser.Password // set the password to the one in the database to not accedently resetting it
 
+	// Validate the avatar type
+	if user.AvatarProvider != "" {
+		if user.AvatarProvider != "default" &&
+			user.AvatarProvider != "gravatar" &&
+			user.AvatarProvider != "initials" &&
+			user.AvatarProvider != "upload" {
+			return updatedUser, &ErrInvalidAvatarProvider{AvatarProvider: user.AvatarProvider}
+		}
+	}
+
 	// Update it
 	_, err = x.ID(user.ID).Update(user)
 	if err != nil {