feat: extension support (#78)

pkg/rest/api.go

@@ -8,7 +8,6 @@ import (
 	"io"
 	"net/http"
 	"net/url"
-	"strings"
 )
 
 func Resolve(w http.ResponseWriter, r *http.Request) {
@@ -31,9 +30,9 @@ func CreateTask(w http.ResponseWriter, r *http.Request) {
 			err    error
 		)
 		if req.Rid != "" {
-			taskId, err = Downloader.Create(req.Rid, req.Opts)
+			taskId, err = Downloader.Create(req.Rid, req.Opt)
 		} else if req.Req != nil {
-			taskId, err = Downloader.CreateDirect(req.Req, req.Opts)
+			taskId, err = Downloader.CreateDirect(req.Req, req.Opt)
 		} else {
 			WriteJson(w, model.NewErrorResult("param invalid: rid or req", model.CodeInvalidParam))
 			return
@@ -121,21 +120,16 @@ func GetTask(w http.ResponseWriter, r *http.Request) {
 }
 
 func GetTasks(w http.ResponseWriter, r *http.Request) {
-	status := r.FormValue("status")
-	if status == "" {
-		status = strings.Join([]string{
-			string(base.DownloadStatusReady),
-			string(base.DownloadStatusRunning),
-			string(base.DownloadStatusPause),
-			string(base.DownloadStatusError),
-			string(base.DownloadStatusDone),
-		}, ",")
-	}
-	statusArr := strings.Split(status, ",")
+	r.ParseForm()
+	status := r.Form["status"]
 	tasks := Downloader.GetTasks()
+	if len(status) == 0 {
+		WriteJson(w, model.NewOkResult(tasks))
+		return
+	}
 	result := make([]*download.Task, 0)
 	for _, task := range tasks {
-		for _, s := range statusArr {
+		for _, s := range status {
 			if task.Status == base.Status(s) {
 				result = append(result, task)
 			}
@@ -159,6 +153,101 @@ func PutConfig(w http.ResponseWriter, r *http.Request) {
 	WriteJson(w, model.NewNilResult())
 }
 
+func InstallExtension(w http.ResponseWriter, r *http.Request) {
+	var req model.InstallExtension
+	if ReadJson(r, w, &req) {
+		var (
+			installedExt *download.Extension
+			err          error
+		)
+		if req.DevMode {
+			installedExt, err = Downloader.InstallExtensionByFolder(req.URL, true)
+		} else {
+			installedExt, err = Downloader.InstallExtensionByGit(req.URL)
+		}
+		if err != nil {
+			WriteJson(w, model.NewErrorResult(err.Error()))
+			return
+		}
+		WriteJson(w, model.NewOkResult(installedExt.Identity))
+	}
+}
+
+func GetExtensions(w http.ResponseWriter, r *http.Request) {
+	list := Downloader.GetExtensions()
+	WriteJson(w, model.NewOkResult(list))
+}
+
+func GetExtension(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	identity := vars["identity"]
+	ext, err := Downloader.GetExtension(identity)
+	if err != nil {
+		WriteJson(w, model.NewErrorResult(err.Error()))
+		return
+	}
+	WriteJson(w, model.NewOkResult(ext))
+}
+
+func UpdateExtensionSettings(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	identity := vars["identity"]
+	var req model.UpdateExtensionSettings
+	if ReadJson(r, w, &req) {
+		if err := Downloader.UpdateExtensionSettings(identity, req.Settings); err != nil {
+			WriteJson(w, model.NewErrorResult(err.Error()))
+			return
+		}
+	}
+	WriteJson(w, model.NewNilResult())
+}
+
+func SwitchExtension(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	identity := vars["identity"]
+	var switchExtension model.SwitchExtension
+	if ReadJson(r, w, &switchExtension) {
+		if err := Downloader.SwitchExtension(identity, switchExtension.Status); err != nil {
+			WriteJson(w, model.NewErrorResult(err.Error()))
+			return
+		}
+	}
+	WriteJson(w, model.NewNilResult())
+}
+
+func DeleteExtension(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	identity := vars["identity"]
+	if err := Downloader.DeleteExtension(identity); err != nil {
+		WriteJson(w, model.NewErrorResult(err.Error()))
+		return
+	}
+	WriteJson(w, model.NewNilResult())
+}
+
+func UpdateCheckExtension(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	identity := vars["identity"]
+	newVersion, err := Downloader.UpgradeCheckExtension(identity)
+	if err != nil {
+		WriteJson(w, model.NewErrorResult(err.Error()))
+		return
+	}
+	WriteJson(w, model.NewOkResult(&model.UpdateCheckExtensionResp{
+		NewVersion: newVersion,
+	}))
+}
+
+func UpdateExtension(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	identity := vars["identity"]
+	if err := Downloader.UpgradeExtension(identity); err != nil {
+		WriteJson(w, model.NewErrorResult(err.Error()))
+		return
+	}
+	WriteJson(w, model.NewNilResult())
+}
+
 func DoProxy(w http.ResponseWriter, r *http.Request) {
 	target := r.Header.Get("X-Target-Uri")
 	if target == "" {
@@ -191,18 +280,6 @@ func DoProxy(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 	w.Write(buf)
-	//var reader io.ReadCloser
-	//switch resp.Header.Get("Content-Encoding") {
-	//case "gzip":
-	//	reader, err = gzip.NewReader(resp.Body)
-	//	defer reader.Close()
-	//default:
-	//	reader = resp.Body
-	//}
-	//if _, err := io.Copy(w, resp.Body); err != nil {
-	//	writeError(w, err.Error())
-	//	return
-	//}
 }
 
 func writeError(w http.ResponseWriter, msg string) {

pkg/rest/model/extension.go

@@ -0,0 +1,18 @@
+package model
+
+type InstallExtension struct {
+	DevMode bool   `json:"devMode"`
+	URL     string `json:"url"`
+}
+
+type UpdateExtensionSettings struct {
+	Settings map[string]any `json:"settings"`
+}
+
+type SwitchExtension struct {
+	Status bool `json:"status"`
+}
+
+type UpdateCheckExtensionResp struct {
+	NewVersion string `json:"newVersion"`
+}

pkg/rest/model/server.go

@@ -20,6 +20,8 @@ type StartConfig struct {
 	StorageDir      string  `json:"storageDir"`
 	ApiToken        string  `json:"apiToken"`
 
+	ProductionMode bool
+
 	WebEnable    bool
 	WebFS        fs.FS
 	WebBasicAuth *WebBasicAuth

pkg/rest/model/task.go

@@ -3,7 +3,7 @@ package model
 import "github.com/GopeedLab/gopeed/pkg/base"
 
 type CreateTask struct {
-	Rid  string        `json:"rid"`
-	Req  *base.Request `json:"req"`
-	Opts *base.Options `json:"opts"`
+	Rid string        `json:"rid"`
+	Req *base.Request `json:"req"`
+	Opt *base.Options `json:"opt"`
 }

pkg/rest/server.go

@@ -10,6 +10,10 @@ import (
 	"github.com/gorilla/mux"
 	"net"
 	"net/http"
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
 )
 
 var (
@@ -26,7 +30,6 @@ func Start(startCfg *model.StartConfig) (int, error) {
 
 	go func() {
 		if err := srv.Serve(listener); err != nil && err != http.ErrServerClosed {
-			// TODO log
 			panic(err)
 		}
 	}()
@@ -41,12 +44,12 @@ func Start(startCfg *model.StartConfig) (int, error) {
 func Stop() {
 	if srv != nil {
 		if err := srv.Shutdown(context.TODO()); err != nil {
-			// TODO log
+			Downloader.Logger.Warn().Err(err).Msg("shutdown server failed")
 		}
 	}
 	if Downloader != nil {
 		if err := Downloader.Close(); err != nil {
-			// TODO log
+			Downloader.Logger.Warn().Err(err).Msg("close downloader failed")
 		}
 	}
 }
@@ -58,6 +61,7 @@ func BuildServer(startCfg *model.StartConfig) (*http.Server, net.Listener, error
 	startCfg.Init()
 
 	downloadCfg := &download.DownloaderConfig{
+		ProductionMode:  startCfg.ProductionMode,
 		RefreshInterval: startCfg.RefreshInterval,
 	}
 	if startCfg.Storage == model.StorageBolt {
@@ -93,6 +97,15 @@ func BuildServer(startCfg *model.StartConfig) (*http.Server, net.Listener, error
 	r.Methods(http.MethodGet).Path("/api/v1/tasks").HandlerFunc(GetTasks)
 	r.Methods(http.MethodGet).Path("/api/v1/config").HandlerFunc(GetConfig)
 	r.Methods(http.MethodPut).Path("/api/v1/config").HandlerFunc(PutConfig)
+	r.Methods(http.MethodPost).Path("/api/v1/extensions").HandlerFunc(InstallExtension)
+	r.Methods(http.MethodGet).Path("/api/v1/extensions").HandlerFunc(GetExtensions)
+	r.Methods(http.MethodGet).Path("/api/v1/extensions/{identity}").HandlerFunc(GetExtension)
+	r.Methods(http.MethodPut).Path("/api/v1/extensions/{identity}/settings").HandlerFunc(UpdateExtensionSettings)
+	r.Methods(http.MethodPut).Path("/api/v1/extensions/{identity}/switch").HandlerFunc(SwitchExtension)
+	r.Methods(http.MethodDelete).Path("/api/v1/extensions/{identity}").HandlerFunc(DeleteExtension)
+	r.Methods(http.MethodGet).Path("/api/v1/extensions/{identity}/update").HandlerFunc(UpdateCheckExtension)
+	r.Methods(http.MethodPost).Path("/api/v1/extensions/{identity}/update").HandlerFunc(UpdateExtension)
+	r.PathPrefix("/fs/extensions").Handler(http.FileServer(new(extensionFileSystem)))
 	r.Path("/api/v1/proxy").HandlerFunc(DoProxy)
 	if startCfg.WebEnable {
 		r.PathPrefix("/").Handler(http.FileServer(http.FS(startCfg.WebFS)))
@@ -125,6 +138,32 @@ func BuildServer(startCfg *model.StartConfig) (*http.Server, net.Listener, error
 	return srv, listener, nil
 }
 
+// handle extension file resource
+type extensionFileSystem struct {
+}
+
+func (e *extensionFileSystem) Open(name string) (http.File, error) {
+	// remove prefix
+	path := strings.TrimPrefix(name, "/fs/extensions")
+	// match extension identity, eg: /fs/extensions/identity/xxx
+	reg := regexp.MustCompile(`^/([^/]+)/(.*)$`)
+	if !reg.MatchString(path) {
+		return nil, os.ErrNotExist
+	}
+	matched := reg.FindStringSubmatch(path)
+	if len(matched) != 3 {
+		return nil, os.ErrNotExist
+	}
+	// get extension identity
+	identity := matched[1]
+	extension, err := Downloader.GetExtension(identity)
+	if err != nil {
+		return nil, os.ErrNotExist
+	}
+	extensionPath := Downloader.ExtensionPath(extension)
+	return os.Open(filepath.Join(extensionPath, matched[2]))
+}
+
 func ReadJson(r *http.Request, w http.ResponseWriter, v any) bool {
 	if err := json.NewDecoder(r.Body).Decode(v); err != nil {
 		WriteJson(w, model.NewErrorResult(err.Error()))

pkg/rest/server_test.go

@@ -33,7 +33,6 @@ var (
 		},
 	}
 	taskRes = &base.Resource{
-		Name:  test.BuildName,
 		Size:  test.BuildSize,
 		Range: true,
 		Files: []*base.FileInfo{
@@ -44,15 +43,23 @@ var (
 			},
 		},
 	}
+	createOpts = &base.Options{
+		Path: test.Dir,
+		Name: test.DownloadName,
+		Extra: map[string]any{
+			"connections": 2,
+		},
+	}
 	createReq = &model.CreateTask{
 		Req: taskReq,
-		Opts: &base.Options{
-			Path: test.Dir,
-			Name: test.DownloadName,
-			Extra: map[string]any{
-				"connections": 2,
-			},
-		},
+		Opt: createOpts,
+	}
+	createResoledReq = &model.CreateTask{
+		Req: taskReq,
+		Opt: createOpts,
+	}
+	installExtensionReq = &model.InstallExtension{
+		URL: "https://github.com/GopeedLab/gopeed-extension-samples#github-contributor-avatars-sample",
 	}
 )
 
@@ -66,6 +73,35 @@ func TestResolve(t *testing.T) {
 }
 
 func TestCreateTask(t *testing.T) {
+	doTest(func() {
+		resp := httpRequestCheckOk[*download.ResolveResult](http.MethodPost, "/api/v1/resolve", taskReq)
+
+		var wg sync.WaitGroup
+		wg.Add(1)
+		Downloader.Listener(func(event *download.Event) {
+			if event.Key == download.EventKeyFinally {
+				wg.Done()
+			}
+		})
+
+		taskId := httpRequestCheckOk[string](http.MethodPost, "/api/v1/tasks", &model.CreateTask{
+			Rid: resp.ID,
+			Opt: createOpts,
+		})
+		if taskId == "" {
+			t.Fatal("create task failed")
+		}
+
+		wg.Wait()
+		want := test.FileMd5(test.BuildFile)
+		got := test.FileMd5(test.DownloadFile)
+		if want != got {
+			t.Errorf("CreateTask() got = %v, want %v", got, want)
+		}
+	})
+}
+
+func TestCreateDirectTask(t *testing.T) {
 	doTest(func() {
 		var wg sync.WaitGroup
 		wg.Add(1)
@@ -84,32 +120,41 @@ func TestCreateTask(t *testing.T) {
 		want := test.FileMd5(test.BuildFile)
 		got := test.FileMd5(test.DownloadFile)
 		if want != got {
-			t.Errorf("CreateTask() got = %v, want %v", got, want)
+			t.Errorf("CreateDirectTask() got = %v, want %v", got, want)
+		}
+	})
+}
+
+func TestCreateDirectTaskWithResoled(t *testing.T) {
+	doTest(func() {
+		var wg sync.WaitGroup
+		wg.Add(1)
+		Downloader.Listener(func(event *download.Event) {
+			if event.Key == download.EventKeyFinally {
+				wg.Done()
+			}
+		})
+
+		taskId := httpRequestCheckOk[string](http.MethodPost, "/api/v1/tasks", createResoledReq)
+		if taskId == "" {
+			t.Fatal("create task failed")
+		}
+
+		wg.Wait()
+		want := test.FileMd5(test.BuildFile)
+		got := test.FileMd5(test.DownloadFile)
+		if want != got {
+			t.Errorf("CreateDirectTaskWithResoled() got = %v, want %v", got, want)
 		}
 	})
 }
 
 func TestPauseAndContinueTask(t *testing.T) {
 	doTest(func() {
-		type result struct {
-			pauseCount    int
-			continueCount int
-			md5           string
-		}
-
-		var got = result{
-			pauseCount:    0,
-			continueCount: 0,
-			md5:           "",
-		}
 		var wg sync.WaitGroup
 		wg.Add(1)
 		Downloader.Listener(func(event *download.Event) {
 			switch event.Key {
-			case download.EventKeyPause:
-				got.pauseCount++
-			case download.EventKeyContinue:
-				got.continueCount++
 			case download.EventKeyFinally:
 				wg.Done()
 			}
@@ -132,12 +177,8 @@ func TestPauseAndContinueTask(t *testing.T) {
 		}
 
 		wg.Wait()
-		want := result{
-			pauseCount:    1,
-			continueCount: 1,
-			md5:           test.FileMd5(test.BuildFile),
-		}
-		got.md5 = test.FileMd5(test.DownloadFile)
+		want := test.FileMd5(test.BuildFile)
+		got := test.FileMd5(test.DownloadFile)
 		if !reflect.DeepEqual(got, want) {
 			t.Errorf("PauseAndContinueTask() got = %v, want %v", got, want)
 		}
@@ -163,13 +204,15 @@ func TestPauseAllAndContinueALLTasks(t *testing.T) {
 
 		// continue all
 		httpRequestCheckOk[any](http.MethodPut, "/api/v1/tasks/continue", nil)
+		time.Sleep(time.Millisecond * 100)
 		tasks := httpRequestCheckOk[[]*download.Task](http.MethodGet, fmt.Sprintf("/api/v1/tasks?status=%s", base.DownloadStatusRunning), nil)
 		if len(tasks) != cfg.MaxRunning {
 			t.Errorf("ContinueAllTasks() got = %v, want %v", len(tasks), cfg.MaxRunning)
 		}
 		// pause all
 		httpRequestCheckOk[any](http.MethodPut, "/api/v1/tasks/pause", nil)
-		tasks = httpRequestCheckOk[[]*download.Task](http.MethodGet, fmt.Sprintf("/api/v1/tasks?status=%s,%s", base.DownloadStatusReady, base.DownloadStatusPause), nil)
+		time.Sleep(time.Millisecond * 500)
+		tasks = httpRequestCheckOk[[]*download.Task](http.MethodGet, fmt.Sprintf("/api/v1/tasks?status=%s", base.DownloadStatusPause), nil)
 		if len(tasks) != total {
 			t.Errorf("PauseAllTasks() got = %v, want %v", len(tasks), total)
 		}
@@ -210,7 +253,7 @@ func TestGetTasks(t *testing.T) {
 			}
 		})
 
-		httpRequestCheckOk[string](http.MethodPost, fmt.Sprintf("/api/v1/tasks?status=%s,%s",
+		httpRequestCheckOk[string](http.MethodPost, fmt.Sprintf("/api/v1/tasks?status=%s&status=%s",
 			base.DownloadStatusReady, base.DownloadStatusRunning), createReq)
 		httpRequestCheckOk[[]*download.Task](http.MethodGet, "/api/v1/tasks", nil)
 
@@ -248,6 +291,115 @@ func TestGetAndPutConfig(t *testing.T) {
 	})
 }
 
+func TestInstallExtension(t *testing.T) {
+	doTest(func() {
+		identity := httpRequestCheckOk[string](http.MethodPost, "/api/v1/extensions", installExtensionReq)
+		if identity == "" {
+			t.Errorf("InstallExtension() got = %v, want %v", identity, "not empty")
+		}
+
+		// not a valid extension repository
+		code, _ := httpRequest[string](http.MethodPost, "/api/v1/extensions", &model.InstallExtension{
+			URL: "https://github.com/GopeedLab/gopeed",
+		})
+		checkCode(code, model.CodeError)
+
+		// not a git repository
+		code, _ = httpRequest[string](http.MethodPost, "/api/v1/extensions", &model.InstallExtension{
+			URL: "https://github.com",
+		})
+		checkCode(code, model.CodeError)
+	})
+}
+
+func TestGetExtensions(t *testing.T) {
+	doTest(func() {
+		httpRequestCheckOk[string](http.MethodPost, "/api/v1/extensions", installExtensionReq)
+		extensions := httpRequestCheckOk[[]*download.Extension](http.MethodGet, "/api/v1/extensions", nil)
+		if len(extensions) == 0 {
+			t.Errorf("GetExtensions() got = %v, want %v", len(extensions), "not empty")
+		}
+	})
+}
+
+func TestUpdateExtensionSettings(t *testing.T) {
+	doTest(func() {
+		identity := httpRequestCheckOk[string](http.MethodPost, "/api/v1/extensions", installExtensionReq)
+
+		httpRequestCheckOk[any](http.MethodPut, "/api/v1/extensions/"+identity+"/settings", &model.UpdateExtensionSettings{
+			Settings: map[string]any{
+				"undefined": "test",
+				"ua":        "test",
+			},
+		})
+
+		settings := httpRequestCheckOk[*download.Extension](http.MethodGet, "/api/v1/extensions/"+identity, nil).Settings
+		if len(settings) != 1 {
+			t.Errorf("UpdateExtensionSettings() got = %v, want %v", len(settings), 1)
+		}
+
+		if settings[0].Name != "ua" || settings[0].Value != "test" {
+			t.Errorf("UpdateExtensionSettings() got = %v, want %v", settings[0].Value, "test")
+		}
+	})
+}
+
+func TestSwitchExtension(t *testing.T) {
+	doTest(func() {
+		identity := httpRequestCheckOk[string](http.MethodPost, "/api/v1/extensions", installExtensionReq)
+		httpRequestCheckOk[any](http.MethodPut, "/api/v1/extensions/"+identity+"/switch", &model.SwitchExtension{
+			Status: false,
+		})
+		extensions := httpRequestCheckOk[[]*download.Extension](http.MethodGet, "/api/v1/extensions", nil)
+		if !extensions[0].Disabled {
+			t.Errorf("TestSwitchExtension() got = %v, want %v", extensions[0].Disabled, true)
+		}
+	})
+}
+
+func TestDeleteExtension(t *testing.T) {
+	doTest(func() {
+		identity := httpRequestCheckOk[string](http.MethodPost, "/api/v1/extensions", installExtensionReq)
+		httpRequestCheckOk[any](http.MethodDelete, "/api/v1/extensions/"+identity, nil)
+		extensions := httpRequestCheckOk[[]*download.Extension](http.MethodGet, "/api/v1/extensions", nil)
+		if len(extensions) != 0 {
+			t.Errorf("TestDeleteExtension() got = %v, want %v", len(extensions), 0)
+		}
+	})
+}
+
+func TestUpdateCheckExtension(t *testing.T) {
+	doTest(func() {
+		identity := httpRequestCheckOk[string](http.MethodPost, "/api/v1/extensions", installExtensionReq)
+		resp := httpRequestCheckOk[*model.UpdateCheckExtensionResp](http.MethodGet, "/api/v1/extensions/"+identity+"/update", nil)
+		// no new version
+		if resp.NewVersion != "" {
+			t.Errorf("UpdateCheckExtension() got = %v, want %v", resp.NewVersion, "")
+		}
+		// force update
+		httpRequestCheckOk[any](http.MethodPost, "/api/v1/extensions/"+identity+"/update", nil)
+	})
+}
+
+func TestFsExtension(t *testing.T) {
+	doTest(func() {
+		identity := httpRequestCheckOk[string](http.MethodPost, "/api/v1/extensions", installExtensionReq)
+		statusCode, _ := doHttpRequest0(http.MethodGet, "/fs/extensions/"+identity+"/icon.png", nil, nil)
+		if statusCode != http.StatusOK {
+			t.Errorf("FsExtension() got = %v, want %v", statusCode, http.StatusOK)
+		}
+	})
+}
+
+func TestFsExtensionFail(t *testing.T) {
+	doTest(func() {
+		statusCode, _ := doHttpRequest0(http.MethodGet, "/fs/extensions/not_exist/icon.png", nil, nil)
+		if statusCode != http.StatusNotFound {
+			t.Errorf("TestFsExtensionFail() got = %v, want %v", statusCode, http.StatusNotFound)
+		}
+	})
+}
+
 func TestDoProxy(t *testing.T) {
 	doTest(func() {
 		code, respBody := doHttpRequest0(http.MethodGet, "/api/v1/proxy", map[string]string{
@@ -341,15 +493,18 @@ func doTest(handler func()) {
 		var cfg = &model.StartConfig{}
 		cfg.Init()
 		cfg.Storage = storage
+		cfg.StorageDir = ".test_storage"
 		fileListener := doStart(cfg)
 		defer func() {
 			if err := fileListener.Close(); err != nil {
 				panic(err)
 			}
 			Stop()
+			Downloader.Clear()
 		}()
-		defer Downloader.Clear()
 		defer func() {
+			Downloader.PauseAll()
+
 			tasks := Downloader.GetTasks()
 			taskIds := make([]string, len(tasks))
 			for i, task := range tasks {
@@ -358,6 +513,7 @@ func doTest(handler func()) {
 			for _, id := range taskIds {
 				Downloader.Delete(id, true)
 			}
+			os.RemoveAll(cfg.StorageDir)
 		}()
 		taskReq.URL = "http://" + fileListener.Addr().String() + "/" + test.BuildName
 		handler()