feat: seeding status for aria2 download tasks (#1422)

* feat: add aria2 seeding

* fix: move RecycleTaskType to the bottom

* refactor: refactor recycle aria2 temp file

pkg/task/job.go

@@ -15,6 +15,8 @@ const (
 	TransferTaskType
 	// ImportTaskType 导入任务
 	ImportTaskType
+	// RecycleTaskType 回收任务
+	RecycleTaskType
 )
 
 // 任务状态
@@ -113,6 +115,8 @@ func GetJobFromModel(task *model.Task) (Job, error) {
 		return NewTransferTaskFromModel(task)
 	case ImportTaskType:
 		return NewImportTaskFromModel(task)
+	case RecycleTaskType:
+		return NewRecycleTaskFromModel(task)
 	default:
 		return nil, ErrUnknownTaskType
 	}

pkg/task/job_test.go

@@ -2,12 +2,12 @@ package task
 
 import (
 	"errors"
-	testMock "github.com/stretchr/testify/mock"
 	"testing"
 
 	"github.com/DATA-DOG/go-sqlmock"
 	model "github.com/cloudreve/Cloudreve/v3/models"
 	"github.com/stretchr/testify/assert"
+	testMock "github.com/stretchr/testify/mock"
 )
 
 func TestRecord(t *testing.T) {
@@ -103,4 +103,16 @@ func TestGetJobFromModel(t *testing.T) {
 		asserts.Nil(job)
 		asserts.Error(err)
 	}
+	// RecycleTaskType
+	{
+		task := &model.Task{
+			Status: 0,
+			Type:   RecycleTaskType,
+		}
+		mock.ExpectQuery("SELECT(.+)users(.+)").WillReturnError(errors.New("error"))
+		job, err := GetJobFromModel(task)
+		asserts.NoError(mock.ExpectationsWereMet())
+		asserts.Nil(job)
+		asserts.Error(err)
+	}
 }

pkg/task/recycle.go

@@ -0,0 +1,130 @@
+package task
+
+import (
+	"encoding/json"
+
+	model "github.com/cloudreve/Cloudreve/v3/models"
+	"github.com/cloudreve/Cloudreve/v3/pkg/cluster"
+	"github.com/cloudreve/Cloudreve/v3/pkg/util"
+)
+
+// RecycleTask 文件回收任务
+type RecycleTask struct {
+	User      *model.User
+	TaskModel *model.Task
+	TaskProps RecycleProps
+	Err       *JobError
+}
+
+// RecycleProps 回收任务属性
+type RecycleProps struct {
+	// 下载任务 GID
+	DownloadGID string `json:"download_gid"`
+}
+
+// Props 获取任务属性
+func (job *RecycleTask) Props() string {
+	res, _ := json.Marshal(job.TaskProps)
+	return string(res)
+}
+
+// Type 获取任务状态
+func (job *RecycleTask) Type() int {
+	return RecycleTaskType
+}
+
+// Creator 获取创建者ID
+func (job *RecycleTask) Creator() uint {
+	return job.User.ID
+}
+
+// Model 获取任务的数据库模型
+func (job *RecycleTask) Model() *model.Task {
+	return job.TaskModel
+}
+
+// SetStatus 设定状态
+func (job *RecycleTask) SetStatus(status int) {
+	job.TaskModel.SetStatus(status)
+}
+
+// SetError 设定任务失败信息
+func (job *RecycleTask) SetError(err *JobError) {
+	job.Err = err
+	res, _ := json.Marshal(job.Err)
+	job.TaskModel.SetError(string(res))
+}
+
+// SetErrorMsg 设定任务失败信息
+func (job *RecycleTask) SetErrorMsg(msg string, err error) {
+	jobErr := &JobError{Msg: msg}
+	if err != nil {
+		jobErr.Error = err.Error()
+	}
+	job.SetError(jobErr)
+}
+
+// GetError 返回任务失败信息
+func (job *RecycleTask) GetError() *JobError {
+	return job.Err
+}
+
+// Do 开始执行任务
+func (job *RecycleTask) Do() {
+	download, err := model.GetDownloadByGid(job.TaskProps.DownloadGID, job.User.ID)
+	if err != nil {
+		util.Log().Warning("回收任务 %d 找不到下载记录", job.TaskModel.ID)
+		job.SetErrorMsg("无法找到下载任务", err)
+		return
+	}
+	nodeID := download.GetNodeID()
+	node := cluster.Default.GetNodeByID(nodeID)
+	if node == nil {
+		util.Log().Warning("回收任务 %d 找不到节点", job.TaskModel.ID)
+		job.SetErrorMsg("从机节点不可用", nil)
+		return
+	}
+	err = node.GetAria2Instance().DeleteTempFile(download)
+	if err != nil {
+		util.Log().Warning("无法删除中转临时目录[%s], %s", download.Parent, err)
+		job.SetErrorMsg("文件回收失败", err)
+		return
+	}
+}
+
+// NewRecycleTask 新建回收任务
+func NewRecycleTask(download *model.Download) (Job, error) {
+	newTask := &RecycleTask{
+		User: download.GetOwner(),
+		TaskProps: RecycleProps{
+			DownloadGID: download.GID,
+		},
+	}
+
+	record, err := Record(newTask)
+	if err != nil {
+		return nil, err
+	}
+	newTask.TaskModel = record
+
+	return newTask, nil
+}
+
+// NewRecycleTaskFromModel 从数据库记录中恢复回收任务
+func NewRecycleTaskFromModel(task *model.Task) (Job, error) {
+	user, err := model.GetActiveUserByID(task.UserID)
+	if err != nil {
+		return nil, err
+	}
+	newTask := &RecycleTask{
+		User:      &user,
+		TaskModel: task,
+	}
+
+	err = json.Unmarshal([]byte(task.Props), &newTask.TaskProps)
+	if err != nil {
+		return nil, err
+	}
+
+	return newTask, nil
+}

pkg/task/recycle_test.go

@@ -0,0 +1,117 @@
+package task
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/DATA-DOG/go-sqlmock"
+	model "github.com/cloudreve/Cloudreve/v3/models"
+	"github.com/jinzhu/gorm"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRecycleTask_Props(t *testing.T) {
+	asserts := assert.New(t)
+	task := &RecycleTask{
+		User: &model.User{},
+	}
+	asserts.NotEmpty(task.Props())
+	asserts.Equal(RecycleTaskType, task.Type())
+	asserts.EqualValues(0, task.Creator())
+	asserts.Nil(task.Model())
+}
+
+func TestRecycleTask_SetStatus(t *testing.T) {
+	asserts := assert.New(t)
+	task := &RecycleTask{
+		User: &model.User{},
+		TaskModel: &model.Task{
+			Model: gorm.Model{ID: 1},
+		},
+	}
+	mock.ExpectBegin()
+	mock.ExpectExec("UPDATE(.+)").WillReturnResult(sqlmock.NewResult(1, 1))
+	mock.ExpectCommit()
+	task.SetStatus(3)
+	asserts.NoError(mock.ExpectationsWereMet())
+}
+
+func TestRecycleTask_SetError(t *testing.T) {
+	asserts := assert.New(t)
+	task := &RecycleTask{
+		User: &model.User{},
+		TaskModel: &model.Task{
+			Model: gorm.Model{ID: 1},
+		},
+	}
+
+	mock.ExpectBegin()
+	mock.ExpectExec("UPDATE(.+)").WillReturnResult(sqlmock.NewResult(1, 1))
+	mock.ExpectCommit()
+
+	task.SetErrorMsg("error", nil)
+	asserts.NoError(mock.ExpectationsWereMet())
+	asserts.Equal("error", task.GetError().Msg)
+}
+
+func TestNewRecycleTask(t *testing.T) {
+	asserts := assert.New(t)
+
+	// 成功
+	{
+		mock.ExpectQuery("SELECT(.+)").WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(1))
+		mock.ExpectBegin()
+		mock.ExpectExec("INSERT(.+)").WillReturnResult(sqlmock.NewResult(1, 1))
+		mock.ExpectCommit()
+		job, err := NewRecycleTask(&model.Download{
+			Model:  gorm.Model{ID: 1},
+			GID:    "test_g_id",
+			Parent: "/",
+			UserID: 1,
+			NodeID: 1,
+		})
+		asserts.NoError(mock.ExpectationsWereMet())
+		asserts.NotNil(job)
+		asserts.NoError(err)
+	}
+
+	// 失败
+	{
+		mock.ExpectQuery("SELECT(.+)").WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(1))
+		mock.ExpectBegin()
+		mock.ExpectExec("INSERT(.+)").WillReturnError(errors.New("error"))
+		mock.ExpectRollback()
+		job, err := NewRecycleTask(&model.Download{
+			Model:  gorm.Model{ID: 1},
+			GID:    "test_g_id",
+			Parent: "test/not_exist",
+			UserID: 1,
+			NodeID: 1,
+		})
+		asserts.NoError(mock.ExpectationsWereMet())
+		asserts.Nil(job)
+		asserts.Error(err)
+	}
+}
+
+func TestNewRecycleTaskFromModel(t *testing.T) {
+	asserts := assert.New(t)
+
+	// 成功
+	{
+		mock.ExpectQuery("SELECT(.+)").WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(1))
+		job, err := NewRecycleTaskFromModel(&model.Task{Props: "{}"})
+		asserts.NoError(mock.ExpectationsWereMet())
+		asserts.NoError(err)
+		asserts.NotNil(job)
+	}
+
+	// JSON解析失败
+	{
+		mock.ExpectQuery("SELECT(.+)").WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(1))
+		job, err := NewRecycleTaskFromModel(&model.Task{Props: "?"})
+		asserts.NoError(mock.ExpectationsWereMet())
+		asserts.Error(err)
+		asserts.Nil(job)
+	}
+}

pkg/task/slavetask/transfer.go

@@ -2,6 +2,8 @@ package slavetask
 
 import (
 	"context"
+	"os"
+
 	model "github.com/cloudreve/Cloudreve/v3/models"
 	"github.com/cloudreve/Cloudreve/v3/pkg/cluster"
 	"github.com/cloudreve/Cloudreve/v3/pkg/filesystem"
@@ -10,7 +12,6 @@ import (
 	"github.com/cloudreve/Cloudreve/v3/pkg/serializer"
 	"github.com/cloudreve/Cloudreve/v3/pkg/task"
 	"github.com/cloudreve/Cloudreve/v3/pkg/util"
-	"os"
 )
 
 // TransferTask 文件中转任务
@@ -79,8 +80,6 @@ func (job *TransferTask) GetError() *task.JobError {
 
 // Do 开始执行任务
 func (job *TransferTask) Do() {
-	defer job.Recycle()
-
 	fs, err := filesystem.NewAnonymousFileSystem()
 	if err != nil {
 		job.SetErrorMsg("无法初始化匿名文件系统", err)
@@ -137,11 +136,3 @@ func (job *TransferTask) Do() {
 		util.Log().Warning("无法发送转存成功通知到从机, %s", err)
 	}
 }
-
-// Recycle 回收临时文件
-func (job *TransferTask) Recycle() {
-	err := os.Remove(job.Req.Src)
-	if err != nil {
-		util.Log().Warning("无法删除中转临时文件[%s], %s", job.Req.Src, err)
-	}
-}

pkg/task/tranfer.go

@@ -3,7 +3,6 @@ package task
 import (
 	"context"
 	"encoding/json"
-	"os"
 	"path"
 	"path/filepath"
 	"strings"
@@ -87,8 +86,6 @@ func (job *TransferTask) GetError() *JobError {
 
 // Do 开始执行任务
 func (job *TransferTask) Do() {
-	defer job.Recycle()
-
 	// 创建文件系统
 	fs, err := filesystem.NewFileSystem(job.User)
 	if err != nil {
@@ -139,16 +136,6 @@ func (job *TransferTask) Do() {
 
 }
 
-// Recycle 回收临时文件
-func (job *TransferTask) Recycle() {
-	if job.TaskProps.NodeID == 1 {
-		err := os.RemoveAll(job.TaskProps.Parent)
-		if err != nil {
-			util.Log().Warning("无法删除中转临时目录[%s], %s", job.TaskProps.Parent, err)
-		}
-	}
-}
-
 // NewTransferTask 新建中转任务
 func NewTransferTask(user uint, src []string, dst, parent string, trim bool, node uint, sizes map[string]uint64) (Job, error) {
 	creator, err := model.GetActiveUserByID(user)