feat(strm_driver): add strm driver (#410)

* feat(strm_driver): add strm driver

* chore(strm_driver): get api_url from context

* 优化代码

* chore(strm_driver): update package name

---------

Co-authored-by: j2rong4cn <j2rong@qq.com>

drivers/all.go

@@ -57,6 +57,7 @@ import (
 	_ "github.com/OpenListTeam/OpenList/v4/drivers/seafile"
 	_ "github.com/OpenListTeam/OpenList/v4/drivers/sftp"
 	_ "github.com/OpenListTeam/OpenList/v4/drivers/smb"
+	_ "github.com/OpenListTeam/OpenList/v4/drivers/strm"
 	_ "github.com/OpenListTeam/OpenList/v4/drivers/teambition"
 	_ "github.com/OpenListTeam/OpenList/v4/drivers/terabox"
 	_ "github.com/OpenListTeam/OpenList/v4/drivers/thunder"

drivers/strm/driver.go

@@ -0,0 +1,173 @@
+package strm
+
+import (
+	"context"
+	"errors"
+	"strings"
+
+	"github.com/OpenListTeam/OpenList/v4/internal/driver"
+	"github.com/OpenListTeam/OpenList/v4/internal/errs"
+	"github.com/OpenListTeam/OpenList/v4/internal/fs"
+	"github.com/OpenListTeam/OpenList/v4/internal/model"
+	"github.com/OpenListTeam/OpenList/v4/pkg/utils"
+)
+
+type Strm struct {
+	model.Storage
+	Addition
+	pathMap     map[string][]string
+	autoFlatten bool
+	oneKey      string
+}
+
+func (d *Strm) Config() driver.Config {
+	return config
+}
+
+func (d *Strm) GetAddition() driver.Additional {
+	return &d.Addition
+}
+
+func (d *Strm) Init(ctx context.Context) error {
+	if d.Paths == "" {
+		return errors.New("paths is required")
+	}
+	d.pathMap = make(map[string][]string)
+	for _, path := range strings.Split(d.Paths, "\n") {
+		path = strings.TrimSpace(path)
+		if path == "" {
+			continue
+		}
+		k, v := getPair(path)
+		d.pathMap[k] = append(d.pathMap[k], v)
+	}
+	if len(d.pathMap) == 1 {
+		for k := range d.pathMap {
+			d.oneKey = k
+		}
+		d.autoFlatten = true
+	} else {
+		d.oneKey = ""
+		d.autoFlatten = false
+	}
+
+	if d.FilterFileTypes != "" {
+		types := strings.Split(d.FilterFileTypes, ",")
+		for _, ext := range types {
+			ext = strings.ToLower(strings.TrimSpace(ext))
+			if ext != "" {
+				supportSuffix[ext] = struct{}{}
+			}
+		}
+	}
+	return nil
+}
+
+func (d *Strm) Drop(ctx context.Context) error {
+	d.pathMap = nil
+	return nil
+}
+
+func (d *Strm) Get(ctx context.Context, path string) (model.Obj, error) {
+	if utils.PathEqual(path, "/") {
+		return &model.Object{
+			Name:     "Root",
+			IsFolder: true,
+			Path:     "/",
+		}, nil
+	}
+	root, sub := d.getRootAndPath(path)
+	dsts, ok := d.pathMap[root]
+	if !ok {
+		return nil, errs.ObjectNotFound
+	}
+	for _, dst := range dsts {
+		obj, err := d.get(ctx, path, dst, sub)
+		if err == nil {
+			return obj, nil
+		}
+	}
+	return nil, errs.ObjectNotFound
+}
+
+func (d *Strm) List(ctx context.Context, dir model.Obj, args model.ListArgs) ([]model.Obj, error) {
+	path := dir.GetPath()
+	if utils.PathEqual(path, "/") && !d.autoFlatten {
+		return d.listRoot(), nil
+	}
+	root, sub := d.getRootAndPath(path)
+	dsts, ok := d.pathMap[root]
+	if !ok {
+		return nil, errs.ObjectNotFound
+	}
+	var objs []model.Obj
+	fsArgs := &fs.ListArgs{NoLog: true, Refresh: args.Refresh}
+	for _, dst := range dsts {
+		tmp, err := d.list(ctx, dst, sub, fsArgs)
+		if err == nil {
+			objs = append(objs, tmp...)
+		}
+	}
+	return objs, nil
+}
+
+func (d *Strm) Link(ctx context.Context, file model.Obj, args model.LinkArgs) (*model.Link, error) {
+	root, sub := d.getRootAndPath(file.GetPath())
+	dsts, ok := d.pathMap[root]
+	if !ok {
+		return nil, errs.ObjectNotFound
+	}
+	for _, dst := range dsts {
+		link, err := d.link(ctx, dst, sub)
+		if err == nil {
+			return link, nil
+		}
+	}
+	return nil, errs.ObjectNotFound
+}
+
+func (d *Strm) MakeDir(ctx context.Context, parentDir model.Obj, dirName string) error {
+	return errors.New("strm Driver cannot make dir")
+}
+
+func (d *Strm) Move(ctx context.Context, srcObj, dstDir model.Obj) error {
+	return errors.New("strm Driver cannot move file")
+}
+
+func (d *Strm) Rename(ctx context.Context, srcObj model.Obj, newName string) error {
+	return errors.New("strm Driver cannot rename file")
+}
+
+func (d *Strm) Copy(ctx context.Context, srcObj, dstDir model.Obj) error {
+	return errors.New("strm Driver cannot copy file")
+}
+
+func (d *Strm) Remove(ctx context.Context, obj model.Obj) error {
+	return errors.New("strm Driver cannot remove file")
+}
+
+func (d *Strm) Put(ctx context.Context, dstDir model.Obj, s model.FileStreamer, up driver.UpdateProgress) error {
+	return errors.New("strm Driver cannot put file")
+}
+
+func (d *Strm) PutURL(ctx context.Context, dstDir model.Obj, name, url string) error {
+	return errors.New("strm Driver cannot put file")
+}
+
+func (d *Strm) GetArchiveMeta(ctx context.Context, obj model.Obj, args model.ArchiveArgs) (model.ArchiveMeta, error) {
+	return nil, errs.NotImplement
+}
+
+func (d *Strm) ListArchive(ctx context.Context, obj model.Obj, args model.ArchiveInnerArgs) ([]model.Obj, error) {
+	return nil, errs.NotImplement
+}
+
+func (d *Strm) Extract(ctx context.Context, obj model.Obj, args model.ArchiveInnerArgs) (*model.Link, error) {
+	return nil, errs.NotImplement
+}
+
+func (d *Strm) ArchiveDecompress(ctx context.Context, srcObj, dstDir model.Obj, args model.ArchiveDecompressArgs) error {
+	return errs.NotImplement
+}
+
+var _ driver.Driver = (*Strm)(nil)

drivers/strm/meta.go

@@ -0,0 +1,29 @@
+package strm
+
+import (
+	"github.com/OpenListTeam/OpenList/v4/internal/driver"
+	"github.com/OpenListTeam/OpenList/v4/internal/op"
+)
+
+type Addition struct {
+	Paths           string `json:"paths" required:"true" type:"text"`
+	ProtectSameName bool   `json:"protect_same_name" default:"true" required:"false" help:"Protects same-name files from Delete or Rename"`
+	SiteUrl         string `json:"siteUrl" type:"text" required:"false" help:"The prefix URL of the strm file"`
+	FilterFileTypes string `json:"filterFileTypes" type:"text" default:"strm" required:"false" help:"Supports suffix name of strm file"`
+}
+
+var config = driver.Config{
+	Name:        "Strm",
+	LocalSort:   true,
+	NoCache:     true,
+	NoUpload:    true,
+	DefaultRoot: "/",
+	OnlyLocal:   true,
+	OnlyProxy:   true,
+}
+
+func init() {
+	op.RegisterDriver(func() driver.Driver {
+		return &Strm{}
+	})
+}

drivers/strm/types.go

@@ -0,0 +1,22 @@
+package strm
+
+var supportSuffix = map[string]struct{}{
+	// video
+	"mp4":  {},
+	"mkv":  {},
+	"flv":  {},
+	"avi":  {},
+	"wmv":  {},
+	"ts":   {},
+	"rmvb": {},
+	"webm": {},
+	// audio
+	"mp3":  {},
+	"flac": {},
+	"aac":  {},
+	"wav":  {},
+	"ogg":  {},
+	"m4a":  {},
+	"wma":  {},
+	"alac": {},
+}

drivers/strm/util.go

@@ -0,0 +1,151 @@
+package strm
+
+import (
+	"context"
+	"fmt"
+
+	stdpath "path"
+	"strings"
+
+	"github.com/OpenListTeam/OpenList/v4/internal/fs"
+	"github.com/OpenListTeam/OpenList/v4/internal/model"
+	"github.com/OpenListTeam/OpenList/v4/internal/sign"
+	"github.com/OpenListTeam/OpenList/v4/pkg/utils"
+	"github.com/OpenListTeam/OpenList/v4/server/common"
+)
+
+func (d *Strm) listRoot() []model.Obj {
+	var objs []model.Obj
+	for k := range d.pathMap {
+		obj := model.Object{
+			Name:     k,
+			IsFolder: true,
+			Modified: d.Modified,
+		}
+		objs = append(objs, &obj)
+	}
+	return objs
+}
+
+// do others that not defined in Driver interface
+func getPair(path string) (string, string) {
+	//path = strings.TrimSpace(path)
+	if strings.Contains(path, ":") {
+		pair := strings.SplitN(path, ":", 2)
+		if !strings.Contains(pair[0], "/") {
+			return pair[0], pair[1]
+		}
+	}
+	return stdpath.Base(path), path
+}
+
+func (d *Strm) getRootAndPath(path string) (string, string) {
+	if d.autoFlatten {
+		return d.oneKey, path
+	}
+	path = strings.TrimPrefix(path, "/")
+	parts := strings.SplitN(path, "/", 2)
+	if len(parts) == 1 {
+		return parts[0], ""
+	}
+	return parts[0], parts[1]
+}
+
+func (d *Strm) get(ctx context.Context, path string, dst, sub string) (model.Obj, error) {
+	reqPath := stdpath.Join(dst, sub)
+	obj, err := fs.Get(ctx, reqPath, &fs.GetArgs{NoLog: true})
+	if err != nil {
+		return nil, err
+	}
+	size := int64(0)
+	if !obj.IsDir() {
+		if utils.Ext(obj.GetName()) == "strm" {
+			size = obj.GetSize()
+		} else {
+			file := stdpath.Join(reqPath, obj.GetName())
+			size = int64(len(d.getLink(ctx, file)))
+		}
+	}
+	return &model.Object{
+		Path:     path,
+		Name:     obj.GetName(),
+		Size:     size,
+		Modified: obj.ModTime(),
+		IsFolder: obj.IsDir(),
+		HashInfo: obj.GetHash(),
+	}, nil
+}
+
+func (d *Strm) list(ctx context.Context, dst, sub string, args *fs.ListArgs) ([]model.Obj, error) {
+	reqPath := stdpath.Join(dst, sub)
+	objs, err := fs.List(ctx, reqPath, args)
+	if err != nil {
+		return nil, err
+	}
+
+	var validObjs []model.Obj
+	for _, obj := range objs {
+		if !obj.IsDir() {
+			ext := strings.ToLower(utils.Ext(obj.GetName()))
+			if _, ok := supportSuffix[ext]; !ok {
+				continue
+			}
+		}
+		validObjs = append(validObjs, obj)
+	}
+	return utils.SliceConvert(validObjs, func(obj model.Obj) (model.Obj, error) {
+		name := obj.GetName()
+		size := int64(0)
+		if !obj.IsDir() {
+			ext := utils.Ext(name)
+			name = strings.TrimSuffix(name, ext) + "strm"
+			if ext == "strm" {
+				size = obj.GetSize()
+			} else {
+				file := stdpath.Join(reqPath, obj.GetName())
+				size = int64(len(d.getLink(ctx, file)))
+			}
+		}
+		objRes := model.Object{
+			Name:     name,
+			Size:     size,
+			Modified: obj.ModTime(),
+			IsFolder: obj.IsDir(),
+			Path:     stdpath.Join(sub, obj.GetName()),
+		}
+		thumb, ok := model.GetThumb(obj)
+		if !ok {
+			return &objRes, nil
+		}
+		return &model.ObjThumb{
+			Object: objRes,
+			Thumbnail: model.Thumbnail{
+				Thumbnail: thumb,
+			},
+		}, nil
+	})
+}
+
+func (d *Strm) link(ctx context.Context, dst, sub string) (*model.Link, error) {
+	reqPath := stdpath.Join(dst, sub)
+	_, err := fs.Get(ctx, reqPath, &fs.GetArgs{NoLog: true})
+	if err != nil {
+		return nil, err
+	}
+	return &model.Link{
+		MFile: model.NewNopMFile(strings.NewReader(d.getLink(ctx, reqPath))),
+	}, nil
+}
+
+func (d *Strm) getLink(ctx context.Context, path string) string {
+	apiUrl := d.SiteUrl
+	if len(apiUrl) > 0 {
+		apiUrl = strings.TrimSuffix(apiUrl, "/")
+	} else {
+		apiUrl = common.GetApiUrl(ctx)
+	}
+	return fmt.Sprintf("%s/d%s?sign=%s",
+		apiUrl,
+		utils.EncodePath(path, true),
+		sign.Sign(path))
+}

internal/bootstrap/data/setting.go

@@ -111,7 +111,7 @@ func InitialSettings() []model.SettingItem {
 		{Key: "home_container", Value: "max_980px", Type: conf.TypeSelect, Options: "max_980px,hope_container", Group: model.STYLE},
 		{Key: "settings_layout", Value: "list", Type: conf.TypeSelect, Options: "list,responsive", Group: model.STYLE},
 		// preview settings
-		{Key: conf.TextTypes, Value: "txt,htm,html,xml,java,properties,sql,js,md,json,conf,ini,vue,php,py,bat,gitignore,yml,go,sh,c,cpp,h,hpp,tsx,vtt,srt,ass,rs,lrc", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
+		{Key: conf.TextTypes, Value: "txt,htm,html,xml,java,properties,sql,js,md,json,conf,ini,vue,php,py,bat,gitignore,yml,go,sh,c,cpp,h,hpp,tsx,vtt,srt,ass,rs,lrc,strm", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
 		{Key: conf.AudioTypes, Value: "mp3,flac,ogg,m4a,wav,opus,wma", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
 		{Key: conf.VideoTypes, Value: "mp4,mkv,avi,mov,rmvb,webm,flv,m3u8", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
 		{Key: conf.ImageTypes, Value: "jpg,tiff,jpeg,png,gif,bmp,svg,ico,swf,webp,avif", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},