siyuan/kernel/av/av.go

// SiYuan - Refactor your thinking
// Copyright (c) 2020-present, b3log.org
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

// Package av 包含了属性视图（Attribute View）相关的实现。
package av

import (
	"bytes"
	"database/sql"
	"os"
	"path/filepath"
	"sort"
	"strings"

	"github.com/88250/gulu"
	"github.com/88250/lute/ast"
	"github.com/siyuan-note/filelock"
	"github.com/siyuan-note/logging"
	"github.com/siyuan-note/siyuan/kernel/util"
)

// AttributeView 描述了属性视图的结构。
type AttributeView struct {
	Spec    int       `json:"spec"`
	ID      string    `json:"id"`      // 属性视图 ID
	Name    string    `json:"name"`    // 属性视图名称
	Columns []*Column `json:"columns"` // 表格列名
	Rows    []*Row    `json:"rows"`    // 表格行记录

	Type    AttributeViewType      `json:"type"`    // 属性视图类型
	Filters []*AttributeViewFilter `json:"filters"` // 过滤规则
	Sorts   []*AttributeViewSort   `json:"sorts"`   // 排序规则
}

// AttributeViewType 描述了属性视图的类型。
type AttributeViewType string

const (
	AttributeViewTypeTable AttributeViewType = "table" // 属性视图类型 - 表格
)

func NewAttributeView(id string) *AttributeView {
	return &AttributeView{
		Spec:    0,
		ID:      id,
		Name:    "Table",
		Columns: []*Column{{ID: ast.NewNodeID(), Name: "Block", Type: ColumnTypeBlock}},
		Rows:    []*Row{},
		Type:    AttributeViewTypeTable,
		Filters: []*AttributeViewFilter{},
		Sorts:   []*AttributeViewSort{},
	}
}

func (av *AttributeView) GetColumnNames() (ret []string) {
	ret = []string{}
	for _, column := range av.Columns {
		ret = append(ret, column.Name)
	}
	return
}

func ParseAttributeView(avID string) (ret *AttributeView, err error) {
	avJSONPath := getAttributeViewDataPath(avID)
	if !gulu.File.IsExist(avJSONPath) {
		ret = NewAttributeView(avID)
		return
	}

	data, err := filelock.ReadFile(avJSONPath)
	if nil != err {
		logging.LogErrorf("read attribute view [%s] failed: %s", avID, err)
		return
	}

	ret = &AttributeView{}
	if err = gulu.JSON.UnmarshalJSON(data, ret); nil != err {
		logging.LogErrorf("unmarshal attribute view [%s] failed: %s", avID, err)
		return
	}
	return
}

func ParseAttributeViewMap(avID string) (ret map[string]interface{}, err error) {
	ret = map[string]interface{}{}
	avJSONPath := getAttributeViewDataPath(avID)
	if !gulu.File.IsExist(avJSONPath) {
		av := NewAttributeView(avID)
		var data []byte
		data, err = gulu.JSON.MarshalJSON(av)
		if nil == err {
			return
		}

		err = gulu.JSON.UnmarshalJSON(data, &ret)
		return
	}

	data, err := filelock.ReadFile(avJSONPath)
	if nil != err {
		logging.LogErrorf("read attribute view [%s] failed: %s", avID, err)
		return
	}

	if err = gulu.JSON.UnmarshalJSON(data, &ret); nil != err {
		logging.LogErrorf("unmarshal attribute view [%s] failed: %s", avID, err)
		return
	}
	return
}

func SaveAttributeView(av *AttributeView) (err error) {
	data, err := gulu.JSON.MarshalIndentJSON(av, "", "\t")
	if nil != err {
		logging.LogErrorf("marshal attribute view [%s] failed: %s", av.ID, err)
		return
	}

	avJSONPath := getAttributeViewDataPath(av.ID)
	if err = filelock.WriteFile(avJSONPath, data); nil != err {
		logging.LogErrorf("save attribute view [%s] failed: %s", av.ID, err)
		return
	}
	return
}

func getAttributeViewDataPath(avID string) (ret string) {
	av := filepath.Join(util.DataDir, "storage", "av")
	ret = filepath.Join(av, avID+".json")
	if !gulu.File.IsDir(av) {
		if err := os.MkdirAll(av, 0755); nil != err {
			logging.LogErrorf("create attribute view dir failed: %s", err)
			return
		}
	}
	return
}

func RebuildAttributeViewTable(tx *sql.Tx, av *AttributeView) (err error) {
	avID := av.ID
	var columns []string
	for _, c := range av.Columns {
		columns = append(columns, "`"+c.ID+"`")
	}

	_, err = tx.Exec("DROP TABLE IF EXISTS `av_" + avID + "`")
	if nil != err {
		logging.LogErrorf("drop table [%s] failed: %s", avID, err)
		return
	}

	_, err = tx.Exec("CREATE TABLE IF NOT EXISTS `av_" + avID + "` (" + strings.Join(columns, ", ") + ")")
	if nil != err {
		logging.LogErrorf("create table [%s] failed: %s", avID, err)
		return
	}

	for _, r := range av.Rows {
		buf := bytes.Buffer{}
		for i, _ := range r.Cells {
			buf.WriteString("?")
			if i < len(r.Cells)-1 {
				buf.WriteString(", ")
			}
		}

		var values []interface{}
		for _, c := range r.Cells {
			values = append(values, c.Value)
		}

		_, err = tx.Exec("INSERT INTO `av_"+avID+"` VALUES ("+buf.String()+")", values...)
		if nil != err {
			logging.LogErrorf("insert row [%s] failed: %s", r.ID, err)
			return
		}
	}
	return
}

type AttributeViewSort struct {
	Column string    `json:"column"` // 列 ID
	Order  SortOrder `json:"order"`  // 排序顺序
}

type SortOrder string

const (
	SortOrderAsc  SortOrder = "ASC"
	SortOrderDesc SortOrder = "DESC"
)

func (av *AttributeView) SortRows() {
	if 1 > len(av.Sorts) {
		return
	}

	type ColIndexSort struct {
		Index int
		Order SortOrder
	}

	var colIndexSorts []*ColIndexSort
	for _, s := range av.Sorts {
		for i, c := range av.Columns {
			if c.ID == s.Column {
				colIndexSorts = append(colIndexSorts, &ColIndexSort{Index: i, Order: s.Order})
				break
			}
		}
	}

	sort.Slice(av.Rows, func(i, j int) bool {
		for _, colIndexSort := range colIndexSorts {
			c := av.Columns[colIndexSort.Index]
			if c.Type == ColumnTypeBlock {
				continue
			}

			result := av.Rows[i].Cells[colIndexSort.Index].Value.Compare(av.Rows[j].Cells[colIndexSort.Index].Value)
			if 0 == result {
				continue
			}

			if colIndexSort.Order == SortOrderAsc {
				return 0 > result
			}
			return 0 < result
		}
		return false
	})
}

type AttributeViewFilter struct {
	Column   string         `json:"column"`
	Operator FilterOperator `json:"operator"`
	Value    *Value         `json:"value"`
}

type FilterOperator string

const (
	FilterOperatorIsEqual           FilterOperator = "="
	FilterOperatorIsNotEqual        FilterOperator = "!="
	FilterOperatorIsGreater         FilterOperator = ">"
	FilterOperatorIsGreaterOrEqual  FilterOperator = ">="
	FilterOperatorIsLess            FilterOperator = "<"
	FilterOperatorIsLessOrEqual     FilterOperator = "<="
	FilterOperatorContains          FilterOperator = "Contains"
	FilterOperatorDoesNotContain    FilterOperator = "Does not contains"
	FilterOperatorIsEmpty           FilterOperator = "Is empty"
	FilterOperatorIsNotEmpty        FilterOperator = "Is not empty"
	FilterOperatorStartsWith        FilterOperator = "Starts with"
	FilterOperatorEndsWith          FilterOperator = "Ends with"
	FilterOperatorIsBetween         FilterOperator = "Is between"
	FilterOperatorIsRelativeToToday FilterOperator = "Is relative to today"
)

func (av *AttributeView) FilterRows() {
	if 1 > len(av.Filters) {
		return
	}

	var colIndexes []int
	for _, f := range av.Filters {
		for i, c := range av.Columns {
			if c.ID == f.Column {
				colIndexes = append(colIndexes, i)
				break
			}
		}
	}

	rows := []*Row{}
	for _, row := range av.Rows {
		pass := true
		for j, index := range colIndexes {
			c := av.Columns[index]
			if c.Type == ColumnTypeBlock {
				continue
			}

			if !row.Cells[index].Value.CompareOperator(av.Filters[j].Value, av.Filters[j].Operator) {
				pass = false
				break
			}
		}
		if pass {
			rows = append(rows, row)
		}
	}
	av.Rows = rows
}