Add DELETE /settings/avatar route to delete the stored avatar file

Author: ddlsmurf

docs/settings.md

@@ -1096,7 +1096,25 @@ PUT /settings/avatar HTTP/1.1
 Host: alice.cozy.example.net
 Authorization: Bearer token
 Content-Type: image/jpeg
+...
+```
+
+#### Response
+
+```http
+HTTP/1.1 204 No Content
+```
 
+### DELETE /settings/avatar
+
+This route can be used to delete the avatar for an instance.
+
+#### Request
+
+```http
+DELETE /settings/avatar HTTP/1.1
+Host: alice.cozy.example.net
+Authorization: Bearer token
 ...
 ```
 

model/vfs/vfs.go

@@ -265,6 +265,10 @@ type DiskThresholder interface {
 // Avatarer defines an interface to define an avatar filesystem.
 type Avatarer interface {
 	CreateAvatar(contentType string) (io.WriteCloser, error)
+	// DeleteAvatar deletes the avatar file if it exists.
+	// It does not return an error if the file does not exist,
+	// but does if there was a problem deleting it.
+	DeleteAvatar() error
 	ServeAvatarContent(w http.ResponseWriter, req *http.Request) error
 }
 

model/vfs/vfsafero/avatar.go

@@ -51,6 +51,18 @@ func (a *avatarFS) CreateAvatar(contentType string) (io.WriteCloser, error) {
 	return u, nil
 }
 
+func (a *avatarFS) DeleteAvatar() error {
+	if exists, err := a.AvatarExists(); err != nil {
+		return err
+	} else if !exists {
+		return nil
+	}
+	if err := a.fs.Remove(AvatarFilename); err != nil {
+		return err
+	}
+	return nil
+}
+
 func (a *avatarFS) AvatarExists() (bool, error) {
 	infos, err := a.fs.Stat(AvatarFilename)
 	if os.IsNotExist(err) {

model/vfs/vfsswift/avatar_v3.go

@@ -33,6 +33,14 @@ func (a *avatarV3) CreateAvatar(contentType string) (io.WriteCloser, error) {
 	return a.c.ObjectCreate(a.ctx, a.container, "avatar", true, "", contentType, nil)
 }
 
+func (a *avatarV3) DeleteAvatar() error {
+	err := a.c.ObjectDelete(a.ctx, a.container, "avatar")
+	if err == swift.ObjectNotFound {
+		return nil
+	}
+	return err
+}
+
 func (a *avatarV3) ServeAvatarContent(w http.ResponseWriter, req *http.Request) error {
 	f, o, err := a.c.ObjectOpen(a.ctx, a.container, "avatar", false, nil)
 	if err != nil {

web/settings/settings.go

@@ -279,6 +279,18 @@ func (h *HTTPHandler) UploadAvatar(c echo.Context) error {
 	return c.NoContent(http.StatusNoContent)
 }
 
+func (h *HTTPHandler) DeleteAvatar(c echo.Context) error {
+	inst := middlewares.GetInstance(c)
+	if err := middlewares.AllowWholeType(c, http.MethodPut, consts.Settings); err != nil {
+		return err
+	}
+	err := inst.AvatarFS().DeleteAvatar()
+	if err != nil {
+		return jsonapi.InternalServerError(err)
+	}
+	return c.NoContent(http.StatusNoContent)
+}
+
 // Register all the `/settings` routes to the given router.
 func (h *HTTPHandler) Register(router *echo.Group) {
 	router.GET("/disk-usage", h.diskUsage)
@@ -308,6 +320,7 @@ func (h *HTTPHandler) Register(router *echo.Group) {
 	router.DELETE("/instance/moved_from", h.clearMovedFrom)
 
 	router.PUT("/avatar", h.UploadAvatar)
+	router.DELETE("/avatar", h.DeleteAvatar)
 
 	router.GET("/flags", h.getFlags)
 

web/settings/settings_test.go

@@ -1083,19 +1083,30 @@ func TestSettings(t *testing.T) {
 			Header("location").IsEqual(testInstance.DefaultRedirection().String())
 	})
 
-	t.Run("PutAvatar", func(t *testing.T) {
-		e := testutils.CreateTestClient(t, ts.URL)
-		sessCookie := session.CookieName(testInstance)
+	t.Run("Avatar", func(t *testing.T) {
+		t.Run("Put", func(t *testing.T) {
+			e := testutils.CreateTestClient(t, ts.URL)
+			sessCookie := session.CookieName(testInstance)
 
-		// Create a sample avatar image
-		avatarContent := "fake image content"
+			// Create a sample avatar image
+			avatarContent := "fake image content"
 
-		e.PUT("/settings/avatar").
-			WithCookie(sessCookie, "connected").
-			WithHeader("Authorization", "Bearer "+token).
-			WithHeader("Content-Type", "image/png").
-			WithBytes([]byte(avatarContent)).
-			Expect().Status(204)
+			e.PUT("/settings/avatar").
+				WithCookie(sessCookie, "connected").
+				WithHeader("Authorization", "Bearer "+token).
+				WithHeader("Content-Type", "image/png").
+				WithBytes([]byte(avatarContent)).
+				Expect().Status(204)
+		})
+
+		t.Run("Delete", func(t *testing.T) {
+			e := testutils.CreateTestClient(t, ts.URL)
+			sessCookie := session.CookieName(testInstance)
+			e.DELETE("/settings/avatar").
+				WithCookie(sessCookie, "connected").
+				WithHeader("Authorization", "Bearer "+token).
+				Expect().Status(204)
+		})
 	})
 }