Skip to content

Commit

Permalink
feat: index enhancement (close AlistGo#2632 pr AlistGo#2636)
Browse files Browse the repository at this point in the history
* feat: index paths as setting

* feat: clear index (AlistGo#2632)

* feat: check indexMQ more frequently
  • Loading branch information
BoYanZh authored Dec 9, 2022
1 parent 1f7c1b4 commit 6f1aeb4
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 2 deletions.
1 change: 1 addition & 0 deletions internal/bootstrap/data/setting.go
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ func InitialSettings() []model.SettingItem {
// single settings
{Key: conf.Token, Value: token, Type: conf.TypeString, Group: model.SINGLE, Flag: model.PRIVATE},
{Key: conf.SearchIndex, Value: "none", Type: conf.TypeSelect, Options: "database,bleve,none", Group: model.INDEX},
{Key: conf.IndexPaths, Value: "/", Type: conf.TypeText, Group: model.INDEX, Flag: model.PRIVATE, Help: `one path per line`},
{Key: conf.IgnorePaths, Value: "", Type: conf.TypeText, Group: model.INDEX, Flag: model.PRIVATE, Help: `one path per line`},
{Key: conf.IndexProgress, Value: "{}", Type: conf.TypeText, Group: model.SINGLE, Flag: model.PRIVATE},
}
Expand Down
1 change: 1 addition & 0 deletions internal/conf/const.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ const (

// index
SearchIndex = "search_index"
IndexPaths = "index_paths"
IgnorePaths = "ignore_paths"

// aria2
Expand Down
13 changes: 12 additions & 1 deletion internal/search/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,17 @@ func BuildIndex(ctx context.Context, indexPaths, ignorePaths []string, maxDepth
Quit = make(chan struct{}, 1)
indexMQ := mq.NewInMemoryMQ[ObjWithParent]()
go func() {
ticker := time.NewTicker(5 * time.Second)
ticker := time.NewTicker(time.Second)
tickCount := 0
for {
select {
case <-ticker.C:
tickCount += 1
if indexMQ.Len() < 1000 && tickCount != 5 {
continue
} else if tickCount >= 5 {
tickCount = 0
}
log.Infof("index obj count: %d", objCount)
indexMQ.ConsumeAll(func(messages []mq.Message[ObjWithParent]) {
if len(messages) != 0 {
Expand Down Expand Up @@ -155,6 +162,10 @@ func Update(parent string, objs []model.Obj) {
if instance == nil || !instance.Config().AutoUpdate || Running.Load() {
return
}
indexPaths := GetIndexPaths()
if !isIndexPath(parent, indexPaths) {
return
}
ignorePaths, err := GetIgnorePaths()
if err != nil {
log.Errorf("update search index error while get ignore paths: %+v", err)
Expand Down
18 changes: 18 additions & 0 deletions internal/search/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,24 @@ func WriteProgress(progress *model.IndexProgress) {
}
}

func GetIndexPaths() []string {
indexPaths := make([]string, 0)
customIndexPaths := setting.GetStr(conf.IndexPaths)
if customIndexPaths != "" {
indexPaths = append(indexPaths, strings.Split(customIndexPaths, "\n")...)
}
return indexPaths
}

func isIndexPath(path string, indexPaths []string) bool {
for _, indexPaths := range indexPaths {
if strings.HasPrefix(path, indexPaths) {
return true
}
}
return false
}

func GetIgnorePaths() ([]string, error) {
storages, err := db.GetEnabledStorages()
if err != nil {
Expand Down
5 changes: 5 additions & 0 deletions pkg/mq/mq.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ type MQ[T any] interface {
Consume(BasicConsumer[T])
ConsumeAll(AllConsumer[T])
Clear()
Len() int
}

type inMemoryMQ[T any] struct {
Expand Down Expand Up @@ -54,3 +55,7 @@ func (mq *inMemoryMQ[T]) Clear() {
defer mq.Unlock()
mq.queue.Clear()
}

func (mq *inMemoryMQ[T]) Len() int {
return mq.queue.Len()
}
26 changes: 25 additions & 1 deletion server/handles/index.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ package handles
import (
"context"

"github.com/alist-org/alist/v3/internal/model"
"github.com/alist-org/alist/v3/internal/search"
"github.com/alist-org/alist/v3/server/common"
mapset "github.com/deckarep/golang-set/v2"
"github.com/gin-gonic/gin"
log "github.com/sirupsen/logrus"
)
Expand All @@ -26,6 +28,13 @@ func BuildIndex(c *gin.Context) {
common.ErrorStrResp(c, "index is running", 400)
return
}
indexPaths := search.GetIndexPaths()
indexPaths = append(indexPaths, req.Paths...)
indexPathsSet := mapset.NewSet[string]()
for _, indexPath := range indexPaths {
indexPathsSet.Add(indexPath)
}
indexPaths = indexPathsSet.ToSlice()
ignorePaths, err := search.GetIgnorePaths()
if err != nil {
common.ErrorResp(c, err, 500)
Expand All @@ -50,7 +59,7 @@ func BuildIndex(c *gin.Context) {
}
}
}
err = search.BuildIndex(context.Background(), req.Paths, ignorePaths, req.MaxDepth, true)
err = search.BuildIndex(context.Background(), indexPaths, ignorePaths, req.MaxDepth, true)
if err != nil {
log.Errorf("build index error: %+v", err)
}
Expand All @@ -67,6 +76,21 @@ func StopIndex(c *gin.Context) {
common.SuccessResp(c)
}

func ClearIndex(c *gin.Context) {
if search.Running.Load() {
common.ErrorStrResp(c, "index is running", 400)
return
}
search.Clear(c)
search.WriteProgress(&model.IndexProgress{
ObjCount: 0,
IsDone: false,
LastDoneTime: nil,
Error: "",
})
common.SuccessResp(c)
}

func GetProgress(c *gin.Context) {
progress, err := search.Progress()
if err != nil {
Expand Down
1 change: 1 addition & 0 deletions server/router.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ func admin(g *gin.RouterGroup) {
index := g.Group("/index")
index.POST("/build", middlewares.SearchIndex, handles.BuildIndex)
index.POST("/stop", middlewares.SearchIndex, handles.StopIndex)
index.POST("/clear", middlewares.SearchIndex, handles.ClearIndex)
index.GET("/progress", middlewares.SearchIndex, handles.GetProgress)
}

Expand Down

0 comments on commit 6f1aeb4

Please sign in to comment.