Add requesting and downloading a data export

pkg/models/events.go

@@ -267,3 +267,13 @@ type TeamDeletedEvent struct {
 func (t *TeamDeletedEvent) Name() string {
 	return "team.deleted"
 }
+
+// UserDataExportRequestedEvent represents a UserDataExportRequestedEvent event
+type UserDataExportRequestedEvent struct {
+	User *user.User
+}
+
+// Name defines the name for UserDataExportRequestedEvent
+func (t *UserDataExportRequestedEvent) Name() string {
+	return "user.export.requested"
+}

pkg/models/export.go

@@ -19,7 +19,6 @@ package models
 
 import (
 	"code.vikunja.io/api/pkg/config"
-	"code.vikunja.io/api/pkg/db"
 	"code.vikunja.io/api/pkg/files"
 	"code.vikunja.io/api/pkg/notifications"
 	"code.vikunja.io/api/pkg/user"
@@ -36,7 +35,7 @@ import (
 	"xorm.io/xorm"
 )
 
-func ExportUserData(u *user.User) (err error) {
+func ExportUserData(s *xorm.Session, u *user.User) (err error) {
 	exportDir := config.ServiceRootpath.GetString() + "/files/user-export-tmp/"
 	err = os.MkdirAll(exportDir, 0700)
 	if err != nil {
@@ -54,48 +53,38 @@ func ExportUserData(u *user.User) (err error) {
 	defer dumpWriter.Close()
 
 	// Get the data
-	s := db.NewSession()
-	defer s.Close()
-
 	err = exportListsAndTasks(s, u, dumpWriter)
 	if err != nil {
-		_ = s.Rollback()
 		return err
 	}
 	// Task attachment files
 	err = exportTaskAttachments(s, u, dumpWriter)
 	if err != nil {
-		_ = s.Rollback()
 		return err
 	}
 	// Saved filters
 	err = exportSavedFilters(s, u, dumpWriter)
 	if err != nil {
-		_ = s.Rollback()
 		return err
 	}
 	// Background files
 	err = exportListBackgrounds(s, u, dumpWriter)
 	if err != nil {
-		_ = s.Rollback()
 		return err
 	}
 	// Vikunja Version
 	err = utils.WriteBytesToZip("VERSION", []byte(version.Version), dumpWriter)
 	if err != nil {
-		_ = s.Rollback()
 		return err
 	}
 
 	stat, err := dumpFile.Stat()
 	if err != nil {
-		_ = s.Rollback()
 		return err
 	}
 
 	exportFile, err := files.Create(dumpFile, dumpFile.Name(), uint64(stat.Size()), u)
 	if err != nil {
-		_ = s.Rollback()
 		return err
 	}
 
@@ -103,16 +92,9 @@ func ExportUserData(u *user.User) (err error) {
 	u.ExportFileID = exportFile.ID
 	_, err = s.Cols("export_file_id").Update(u)
 	if err != nil {
-		_ = s.Rollback()
 		return
 	}
 
-	err = s.Commit()
-	if err != nil {
-		_ = s.Rollback()
-		return err
-	}
-
 	// Remove the old file
 	err = os.Remove(dumpFile.Name())
 	if err != nil {

pkg/models/listeners.go

@@ -50,6 +50,7 @@ func RegisterListeners() {
 	events.RegisterListener((&TaskCommentUpdatedEvent{}).Name(), &HandleTaskCommentEditMentions{})
 	events.RegisterListener((&TaskCreatedEvent{}).Name(), &HandleTaskCreateMentions{})
 	events.RegisterListener((&TaskUpdatedEvent{}).Name(), &HandleTaskUpdatedMentions{})
+	events.RegisterListener((&UserDataExportRequestedEvent{}).Name(), &HandleUserDataExport{})
 }
 
 //////
@@ -562,3 +563,40 @@ func (s *SendTeamMemberAddedNotification) Handle(msg *message.Message) (err erro
 		Team:   event.Team,
 	})
 }
+
+// HandleUserDataExport  represents a listener
+type HandleUserDataExport struct {
+}
+
+// Name defines the name for the HandleUserDataExport listener
+func (s *HandleUserDataExport) Name() string {
+	return "handle.user.data.export"
+}
+
+// Handle is executed when the event HandleUserDataExport listens on is fired
+func (s *HandleUserDataExport) Handle(msg *message.Message) (err error) {
+	event := &UserDataExportRequestedEvent{}
+	err = json.Unmarshal(msg.Payload, event)
+	if err != nil {
+		return err
+	}
+
+	log.Debugf("Starting to export user data for user %d...", event.User.ID)
+
+	sess := db.NewSession()
+	defer sess.Close()
+	err = sess.Begin()
+	if err != nil {
+		return
+	}
+
+	err = ExportUserData(sess, event.User)
+	if err != nil {
+		_ = sess.Rollback()
+		return
+	}
+
+	log.Debugf("Done exporting user data for user %d...", event.User.ID)
+
+	return sess.Commit()
+}

pkg/routes/api/v1/user_deletion.go

@@ -27,7 +27,7 @@ import (
 	"github.com/labstack/echo/v4"
 )
 
-type UserDeletionRequest struct {
+type UserPasswordConfirmation struct {
 	Password string `json:"password" valid:"required"`
 }
 
@@ -41,13 +41,13 @@ type UserDeletionRequestConfirm struct {
 // @tags user
 // @Accept json
 // @Produce json
-// @Param credentials body v1.UserDeletionRequest true "The user password."
+// @Param credentials body v1.UserPasswordConfirmation true "The user password."
 // @Success 200 {object} models.Message
 // @Failure 412 {object} web.HTTPError "Bad password provided."
 // @Failure 500 {object} models.Message "Internal error"
 // @Router /user/deletion/request [post]
 func UserRequestDeletion(c echo.Context) error {
-	var deletionRequest UserDeletionRequest
+	var deletionRequest UserPasswordConfirmation
 	if err := c.Bind(&deletionRequest); err != nil {
 		return echo.NewHTTPError(http.StatusBadRequest, "No password provided.")
 	}
@@ -149,13 +149,13 @@ func UserConfirmDeletion(c echo.Context) error {
 // @tags user
 // @Accept json
 // @Produce json
-// @Param credentials body v1.UserDeletionRequest true "The user password to confirm."
+// @Param credentials body v1.UserPasswordConfirmation true "The user password to confirm."
 // @Success 200 {object} models.Message
 // @Failure 412 {object} web.HTTPError "Bad password provided."
 // @Failure 500 {object} models.Message "Internal error"
 // @Router /user/deletion/cancel [post]
 func UserCancelDeletion(c echo.Context) error {
-	var deletionRequest UserDeletionRequest
+	var deletionRequest UserPasswordConfirmation
 	if err := c.Bind(&deletionRequest); err != nil {
 		return echo.NewHTTPError(http.StatusBadRequest, "No password provided.")
 	}

pkg/routes/api/v1/user_export.go

@@ -0,0 +1,122 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2021 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 Affero General Public Licensee 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 Affero General Public Licensee for more details.
+//
+// You should have received a copy of the GNU Affero General Public Licensee
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package v1
+
+import (
+	"code.vikunja.io/api/pkg/db"
+	"code.vikunja.io/api/pkg/events"
+	"code.vikunja.io/api/pkg/models"
+	"code.vikunja.io/api/pkg/user"
+	"code.vikunja.io/web/handler"
+
+	"github.com/labstack/echo/v4"
+
+	"net/http"
+)
+
+func exportHandler(c echo.Context, closure func(*user.User) error) error {
+	var pass UserPasswordConfirmation
+	if err := c.Bind(&pass); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "No password provided.")
+	}
+
+	err := c.Validate(pass)
+	if err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, err)
+	}
+
+	s := db.NewSession()
+	defer s.Close()
+
+	err = s.Begin()
+	if err != nil {
+		return handler.HandleHTTPError(err, c)
+	}
+
+	u, err := user.GetCurrentUserFromDB(s, c)
+	if err != nil {
+		_ = s.Rollback()
+		return handler.HandleHTTPError(err, c)
+	}
+
+	err = user.CheckUserPassword(u, pass.Password)
+	if err != nil {
+		_ = s.Rollback()
+		return handler.HandleHTTPError(err, c)
+	}
+
+	err = closure(u)
+	if err != nil {
+		_ = s.Rollback()
+		return handler.HandleHTTPError(err, c)
+	}
+
+	err = s.Commit()
+	if err != nil {
+		_ = s.Rollback()
+		return handler.HandleHTTPError(err, c)
+	}
+
+	return c.JSON(http.StatusOK, models.Message{Message: "Successfully requested data export. We will send you an email when it's ready."})
+}
+
+// RequestUserDataExport is the handler to request a user data export
+// @Summary Request a user data export.
+// @tags user
+// @Accept json
+// @Produce json
+// @Security JWTKeyAuth
+// @Param password body v1.UserPasswordConfirmation true "User password to confirm the data export request."
+// @Success 200 {object} models.Message
+// @Failure 400 {object} web.HTTPError "Something's invalid."
+// @Failure 500 {object} models.Message "Internal server error."
+// @Router /user/export/request [post]
+func RequestUserDataExport(c echo.Context) error {
+	err := exportHandler(c, func(u *user.User) error {
+		return events.Dispatch(&models.UserDataExportRequestedEvent{
+			User: u,
+		})
+	})
+	if err != nil {
+		return err
+	}
+
+	return c.JSON(http.StatusOK, models.Message{Message: "Successfully requested data export. We will send you an email when it's ready."})
+}
+
+// DownloadUserDataExport is the handler to download a created user data export
+// @Summary Download a user data export.
+// @tags user
+// @Accept json
+// @Produce json
+// @Security JWTKeyAuth
+// @Param password body v1.UserPasswordConfirmation true "User password to confirm the download."
+// @Success 200 {object} models.Message
+// @Failure 400 {object} web.HTTPError "Something's invalid."
+// @Failure 500 {object} models.Message "Internal server error."
+// @Router /user/export/download [post]
+func DownloadUserDataExport(c echo.Context) error {
+	err := exportHandler(c, func(u *user.User) error {
+	})
+	if err != nil {
+		return err
+	}
+
+	// TODO
+
+	return c.JSON(http.StatusOK, models.Message{Message: "Successfully requested data export. We will send you an email when it's ready."})
+}

pkg/routes/routes.go

@@ -303,6 +303,8 @@ func registerAPIRoutes(a *echo.Group) {
 	u.POST("/settings/avatar", apiv1.ChangeUserAvatarProvider)
 	u.PUT("/settings/avatar/upload", apiv1.UploadAvatar)
 	u.POST("/settings/general", apiv1.UpdateGeneralUserSettings)
+	u.POST("/export/request", apiv1.RequestUserDataExport)
+	u.POST("/export/dowload", apiv1.DownloadUserDataExport)
 
 	if config.ServiceEnableTotp.GetBool() {
 		u.GET("/settings/totp", apiv1.UserTOTP)