feat: sftp support

drivers/all.go

@@ -18,6 +18,7 @@ import (
 	_ "github.com/Xhofe/alist/drivers/pikpak"
 	_ "github.com/Xhofe/alist/drivers/quark"
 	_ "github.com/Xhofe/alist/drivers/s3"
+	_ "github.com/Xhofe/alist/drivers/sftp"
 	_ "github.com/Xhofe/alist/drivers/shandian"
 	_ "github.com/Xhofe/alist/drivers/teambition"
 	_ "github.com/Xhofe/alist/drivers/uss"

drivers/sftp/driver.go

@@ -0,0 +1,220 @@
+package template
+
+import (
+	"github.com/Xhofe/alist/conf"
+	"github.com/Xhofe/alist/drivers/base"
+	"github.com/Xhofe/alist/model"
+	"github.com/Xhofe/alist/utils"
+	"io"
+	"path"
+	"path/filepath"
+)
+
+type SFTP struct {
+}
+
+func (driver SFTP) Config() base.DriverConfig {
+	return base.DriverConfig{
+		Name:      "SFTP",
+		OnlyProxy: true,
+		OnlyLocal: true,
+		LocalSort: true,
+	}
+}
+
+func (driver SFTP) Items() []base.Item {
+	// TODO fill need info
+	return []base.Item{
+		{
+			Name:     "site_url",
+			Label:    "ip/host",
+			Type:     base.TypeString,
+			Required: true,
+		},
+		{
+			Name:     "limit",
+			Label:    "port",
+			Type:     base.TypeNumber,
+			Required: true,
+			Default:  "22",
+		},
+		{
+			Name:     "username",
+			Label:    "username",
+			Type:     base.TypeString,
+			Required: true,
+		},
+		{
+			Name:     "password",
+			Label:    "password",
+			Type:     base.TypeString,
+			Required: true,
+		},
+		{
+			Name:     "root_folder",
+			Label:    "root folder path",
+			Type:     base.TypeString,
+			Default:  "/",
+			Required: true,
+		},
+	}
+}
+
+func (driver SFTP) Save(account *model.Account, old *model.Account) error {
+	if old != nil {
+		clientsMap.Lock()
+		defer clientsMap.Unlock()
+		delete(clientsMap.clients, old.Name)
+	}
+	if account == nil {
+		return nil
+	}
+	_, err := GetClient(account)
+	if err != nil {
+		account.Status = err.Error()
+	} else {
+		account.Status = "work"
+	}
+	_ = model.SaveAccount(account)
+	return err
+}
+
+func (driver SFTP) File(path string, account *model.Account) (*model.File, error) {
+	path = utils.ParsePath(path)
+	if path == "/" {
+		return &model.File{
+			Id:        account.RootFolder,
+			Name:      account.Name,
+			Size:      0,
+			Type:      conf.FOLDER,
+			Driver:    driver.Config().Name,
+			UpdatedAt: account.UpdatedAt,
+		}, nil
+	}
+	dir, name := filepath.Split(path)
+	files, err := driver.Files(dir, account)
+	if err != nil {
+		return nil, err
+	}
+	for _, file := range files {
+		if file.Name == name {
+			return &file, nil
+		}
+	}
+	return nil, base.ErrPathNotFound
+}
+
+func (driver SFTP) Files(path string, account *model.Account) ([]model.File, error) {
+	path = utils.ParsePath(path)
+	remotePath := utils.Join(account.RootFolder, path)
+	cache, err := base.GetCache(path, account)
+	if err == nil {
+		files, _ := cache.([]model.File)
+		return files, nil
+	}
+	client, err := GetClient(account)
+	if err != nil {
+		return nil, err
+	}
+	var files []model.File
+	rawFiles, err := client.Files(remotePath)
+	if err != nil {
+		return nil, err
+	}
+	for i := 0; i < len(rawFiles); i++ {
+		files = append(files, driver.formatFile(rawFiles[i]))
+	}
+	if len(files) > 0 {
+		_ = base.SetCache(path, files, account)
+	}
+	return files, nil
+}
+
+func (driver SFTP) Link(args base.Args, account *model.Account) (*base.Link, error) {
+	client, err := GetClient(account)
+	if err != nil {
+		return nil, err
+	}
+	remoteFileName := utils.Join(account.RootFolder, args.Path)
+	remoteFile, err := client.Open(remoteFileName)
+	if err != nil {
+		return nil, err
+	}
+	return &base.Link{
+		Data: remoteFile,
+	}, nil
+}
+
+func (driver SFTP) Path(path string, account *model.Account) (*model.File, []model.File, error) {
+	path = utils.ParsePath(path)
+	file, err := driver.File(path, account)
+	if err != nil {
+		return nil, nil, err
+	}
+	if !file.IsDir() {
+		return file, nil, nil
+	}
+	files, err := driver.Files(path, account)
+	if err != nil {
+		return nil, nil, err
+	}
+	return nil, files, nil
+}
+
+func (driver SFTP) Preview(path string, account *model.Account) (interface{}, error) {
+	//TODO preview interface if driver support
+	return nil, base.ErrNotImplement
+}
+
+func (driver SFTP) MakeDir(path string, account *model.Account) error {
+	client, err := GetClient(account)
+	if err != nil {
+		return err
+	}
+	return client.MkdirAll(utils.Join(account.RootFolder, path))
+}
+
+func (driver SFTP) Move(src string, dst string, account *model.Account) error {
+	return driver.Rename(src, dst, account)
+}
+
+func (driver SFTP) Rename(src string, dst string, account *model.Account) error {
+	client, err := GetClient(account)
+	if err != nil {
+		return err
+	}
+	return client.Rename(utils.Join(account.RootFolder, src), utils.Join(account.RootFolder, dst))
+}
+
+func (driver SFTP) Copy(src string, dst string, account *model.Account) error {
+	return base.ErrNotSupport
+}
+
+func (driver SFTP) Delete(path string, account *model.Account) error {
+	client, err := GetClient(account)
+	if err != nil {
+		return err
+	}
+	return client.Remove(utils.Join(account.RootFolder, path))
+}
+
+func (driver SFTP) Upload(file *model.FileStream, account *model.Account) error {
+	if file == nil {
+		return base.ErrEmptyFile
+	}
+	client, err := GetClient(account)
+	if err != nil {
+		return err
+	}
+	dstFile, err := client.Create(path.Join(account.RootFolder, file.ParentPath, file.Name))
+	if err != nil {
+		return err
+	}
+	defer func() {
+		_ = dstFile.Close()
+	}()
+	_, err = io.Copy(dstFile, file)
+	return err
+}
+
+var _ base.Driver = (*SFTP)(nil)

drivers/sftp/sftp.go

@@ -0,0 +1,109 @@
+package template
+
+import (
+	"github.com/Xhofe/alist/conf"
+	"github.com/Xhofe/alist/drivers/base"
+	"github.com/Xhofe/alist/model"
+	"github.com/Xhofe/alist/utils"
+	"github.com/pkg/sftp"
+	"golang.org/x/crypto/ssh"
+	"os"
+	"path"
+	"sync"
+)
+
+var clientsMap = struct {
+	sync.Mutex
+	clients map[string]*Client
+}{clients: make(map[string]*Client)}
+
+func GetClient(account *model.Account) (*Client, error) {
+	clientsMap.Lock()
+	defer clientsMap.Unlock()
+	if v, ok := clientsMap.clients[account.Name]; ok {
+		return v, nil
+	}
+	conn, err := ssh.Dial("tcp", account.SiteUrl, &ssh.ClientConfig{
+		User:            account.Username,
+		Auth:            []ssh.AuthMethod{ssh.Password(account.Password)},
+		HostKeyCallback: ssh.InsecureIgnoreHostKey(),
+	})
+	if err != nil {
+		return nil, err
+	}
+	client, err := sftp.NewClient(conn)
+	if err != nil {
+		return nil, err
+	}
+	c := &Client{client}
+	clientsMap.clients[account.Name] = c
+	return c, nil
+}
+
+type Client struct {
+	*sftp.Client
+}
+
+func (client *Client) Files(remotePath string) ([]os.FileInfo, error) {
+	return client.ReadDir(remotePath)
+}
+
+func (client *Client) Remove(remotePath string) error {
+	f, err := client.Stat(remotePath)
+	if err != nil {
+		return nil
+	}
+	if f.IsDir() {
+		return client.removeDirectory(remotePath)
+	} else {
+		return client.removeFile(remotePath)
+	}
+}
+
+func (client *Client) removeDirectory(remotePath string) error {
+	//打不开,说明要么文件路径错误了,要么是第一次部署
+	remoteFiles, err := client.ReadDir(remotePath)
+	if err != nil {
+		return err
+	}
+	for _, backupDir := range remoteFiles {
+		remoteFilePath := path.Join(remotePath, backupDir.Name())
+		if backupDir.IsDir() {
+			err := client.removeDirectory(remoteFilePath)
+			if err != nil {
+				return err
+			}
+		} else {
+			err := client.Remove(path.Join(remoteFilePath))
+			if err != nil {
+				return err
+			}
+		}
+	}
+	return client.RemoveDirectory(remotePath)
+}
+
+func (client *Client) removeFile(remotePath string) error {
+	return client.Remove(utils.Join(remotePath))
+}
+
+func (driver SFTP) formatFile(f os.FileInfo) model.File {
+	t := f.ModTime()
+	file := model.File{
+		//Id:        f.Id,
+		Name:      f.Name(),
+		Size:      f.Size(),
+		Driver:    driver.Config().Name,
+		UpdatedAt: &t,
+	}
+	if f.IsDir() {
+		file.Type = conf.FOLDER
+	} else {
+		file.Type = utils.GetFileType(path.Ext(f.Name()))
+	}
+	return file
+}
+
+func init() {
+	base.RegisterDriver(&SFTP{})
+}

drivers/sftp/types.go

@@ -0,0 +1,18 @@
+package template
+
+import "time"
+
+// write all struct here
+
+type Resp struct {
+	Code    int    `json:"code"`
+	Message string `json:"message"`
+}
+
+type File struct {
+	Id        string     `json:"id"`
+	FileName  string     `json:"file_name"`
+	Size      int64      `json:"size"`
+	File      bool       `json:"file"`
+	UpdatedAt *time.Time `json:"updated_at"`
+}

drivers/sftp/util.go

@@ -0,0 +1,3 @@
+package template
+
+// write util func here, such as cal sign