// 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 . // Package av 包含了属性视图(Attribute View)相关的实现。 package av import ( "errors" "fmt" "math" "os" "path/filepath" "strconv" "strings" "time" "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" "golang.org/x/text/language" "golang.org/x/text/message" ) // AttributeView 描述了属性视图的结构。 type AttributeView struct { Spec int `json:"spec"` // 格式版本 ID string `json:"id"` // 属性视图 ID Name string `json:"name"` // 属性视图名称 KeyValues []*KeyValues `json:"keyValues"` // 属性视图属性列值 ViewID string `json:"viewID"` // 当前视图 ID Views []*View `json:"views"` // 视图 } func ShallowCloneAttributeView(av *AttributeView) (ret *AttributeView) { ret = &AttributeView{} data, err := gulu.JSON.MarshalJSON(av) if nil != err { logging.LogErrorf("marshal attribute view [%s] failed: %s", av.ID, err) return nil } if err = gulu.JSON.UnmarshalJSON(data, ret); nil != err { logging.LogErrorf("unmarshal attribute view [%s] failed: %s", av.ID, err) return nil } ret.ID = ast.NewNodeID() view, err := ret.GetView() if nil == err { view.ID = ast.NewNodeID() ret.ViewID = view.ID } else { view = NewView() ret.ViewID = view.ID ret.Views = append(ret.Views, view) } keyIDMap := map[string]string{} for _, kv := range ret.KeyValues { newID := ast.NewNodeID() keyIDMap[kv.Key.ID] = newID kv.Key.ID = newID kv.Values = []*Value{} } view.Table.ID = ast.NewNodeID() for _, column := range view.Table.Columns { column.ID = keyIDMap[column.ID] } view.Table.RowIDs = []string{} return } // KeyValues 描述了属性视图属性列值的结构。 type KeyValues struct { Key *Key `json:"key"` // 属性视图属性列 Values []*Value `json:"values,omitempty"` // 属性视图属性列值 } type KeyType string const ( KeyTypeBlock KeyType = "block" KeyTypeText KeyType = "text" KeyTypeNumber KeyType = "number" KeyTypeDate KeyType = "date" KeyTypeSelect KeyType = "select" KeyTypeMSelect KeyType = "mSelect" KeyTypeURL KeyType = "url" KeyTypeEmail KeyType = "email" KeyTypePhone KeyType = "phone" KeyTypeMAsset KeyType = "mAsset" KeyTypeTemplate KeyType = "template" KeyTypeCreated KeyType = "created" KeyTypeUpdated KeyType = "updated" ) // Key 描述了属性视图属性列的基础结构。 type Key struct { ID string `json:"id"` // 列 ID Name string `json:"name"` // 列名 Type KeyType `json:"type"` // 列类型 Icon string `json:"icon"` // 列图标 // 以下是某些列类型的特有属性 Options []*KeySelectOption `json:"options,omitempty"` // 选项列表 NumberFormat NumberFormat `json:"numberFormat"` // 列数字格式化 Template string `json:"template"` // 模板内容 } func NewKey(id, name, icon string, keyType KeyType) *Key { return &Key{ ID: id, Name: name, Type: keyType, Icon: icon, } } type KeySelectOption struct { Name string `json:"name"` Color string `json:"color"` } type Value struct { ID string `json:"id,omitempty"` KeyID string `json:"keyID,omitempty"` BlockID string `json:"blockID,omitempty"` Type KeyType `json:"type,omitempty"` IsDetached bool `json:"isDetached,omitempty"` IsInitialized bool `json:"isInitialized,omitempty"` Block *ValueBlock `json:"block,omitempty"` Text *ValueText `json:"text,omitempty"` Number *ValueNumber `json:"number,omitempty"` Date *ValueDate `json:"date,omitempty"` MSelect []*ValueSelect `json:"mSelect,omitempty"` URL *ValueURL `json:"url,omitempty"` Email *ValueEmail `json:"email,omitempty"` Phone *ValuePhone `json:"phone,omitempty"` MAsset []*ValueAsset `json:"mAsset,omitempty"` Template *ValueTemplate `json:"template,omitempty"` Created *ValueCreated `json:"created,omitempty"` Updated *ValueUpdated `json:"updated,omitempty"` } func (value *Value) String() string { switch value.Type { case KeyTypeBlock: if nil == value.Block { return "" } return value.Block.Content case KeyTypeText: if nil == value.Text { return "" } return value.Text.Content case KeyTypeNumber: if nil == value.Number { return "" } return value.Number.FormattedContent case KeyTypeDate: if nil == value.Date { return "" } return value.Date.FormattedContent case KeyTypeSelect: if 1 > len(value.MSelect) { return "" } return value.MSelect[0].Content case KeyTypeMSelect: if 1 > len(value.MSelect) { return "" } var ret []string for _, v := range value.MSelect { ret = append(ret, v.Content) } return strings.Join(ret, " ") case KeyTypeURL: if nil == value.URL { return "" } return value.URL.Content case KeyTypeEmail: if nil == value.Email { return "" } return value.Email.Content case KeyTypePhone: if nil == value.Phone { return "" } return value.Phone.Content case KeyTypeMAsset: if 1 > len(value.MAsset) { return "" } var ret []string for _, v := range value.MAsset { ret = append(ret, v.Content) } return strings.Join(ret, " ") case KeyTypeTemplate: if nil == value.Template { return "" } return value.Template.Content case KeyTypeCreated: if nil == value.Created { return "" } return value.Created.FormattedContent case KeyTypeUpdated: if nil == value.Updated { return "" } return value.Updated.FormattedContent default: return "" } } func (value *Value) ToJSONString() string { data, err := gulu.JSON.MarshalJSON(value) if nil != err { return "" } return string(data) } type ValueBlock struct { ID string `json:"id"` Content string `json:"content"` Created int64 `json:"created"` Updated int64 `json:"updated"` } type ValueText struct { Content string `json:"content"` } type ValueNumber struct { Content float64 `json:"content"` IsNotEmpty bool `json:"isNotEmpty"` Format NumberFormat `json:"format"` FormattedContent string `json:"formattedContent"` } type NumberFormat string const ( NumberFormatNone NumberFormat = "" NumberFormatCommas NumberFormat = "commas" NumberFormatPercent NumberFormat = "percent" NumberFormatUSDollar NumberFormat = "usDollar" NumberFormatYuan NumberFormat = "yuan" NumberFormatEuro NumberFormat = "euro" NumberFormatPound NumberFormat = "pound" NumberFormatYen NumberFormat = "yen" NumberFormatRuble NumberFormat = "ruble" NumberFormatRupee NumberFormat = "rupee" NumberFormatWon NumberFormat = "won" NumberFormatCanadianDollar NumberFormat = "canadianDollar" NumberFormatFranc NumberFormat = "franc" ) func NewValueNumber(content float64) *ValueNumber { return &ValueNumber{ Content: content, IsNotEmpty: true, Format: NumberFormatNone, FormattedContent: fmt.Sprintf("%f", content), } } func NewFormattedValueNumber(content float64, format NumberFormat) (ret *ValueNumber) { ret = &ValueNumber{ Content: content, IsNotEmpty: true, Format: format, FormattedContent: fmt.Sprintf("%f", content), } ret.FormattedContent = formatNumber(content, format) switch format { case NumberFormatNone: s := fmt.Sprintf("%.5f", content) ret.FormattedContent = strings.TrimRight(strings.TrimRight(s, "0"), ".") } return } func (number *ValueNumber) FormatNumber() { number.FormattedContent = formatNumber(number.Content, number.Format) } func formatNumber(content float64, format NumberFormat) string { switch format { case NumberFormatNone: return strconv.FormatFloat(content, 'f', -1, 64) case NumberFormatCommas: p := message.NewPrinter(language.English) s := p.Sprintf("%f", content) return strings.TrimRight(strings.TrimRight(s, "0"), ".") case NumberFormatPercent: s := fmt.Sprintf("%.2f", content*100) return strings.TrimRight(strings.TrimRight(s, "0"), ".") + "%" case NumberFormatUSDollar: p := message.NewPrinter(language.English) return p.Sprintf("$%.2f", content) case NumberFormatYuan: p := message.NewPrinter(language.Chinese) return p.Sprintf("CN¥%.2f", content) case NumberFormatEuro: p := message.NewPrinter(language.German) return p.Sprintf("€%.2f", content) case NumberFormatPound: p := message.NewPrinter(language.English) return p.Sprintf("£%.2f", content) case NumberFormatYen: p := message.NewPrinter(language.Japanese) return p.Sprintf("¥%.0f", content) case NumberFormatRuble: p := message.NewPrinter(language.Russian) return p.Sprintf("₽%.2f", content) case NumberFormatRupee: p := message.NewPrinter(language.Hindi) return p.Sprintf("₹%.2f", content) case NumberFormatWon: p := message.NewPrinter(language.Korean) return p.Sprintf("₩%.0f", content) case NumberFormatCanadianDollar: p := message.NewPrinter(language.English) return p.Sprintf("CA$%.2f", content) case NumberFormatFranc: p := message.NewPrinter(language.French) return p.Sprintf("CHF%.2f", content) default: return strconv.FormatFloat(content, 'f', -1, 64) } } type ValueDate struct { Content int64 `json:"content"` IsNotEmpty bool `json:"isNotEmpty"` HasEndDate bool `json:"hasEndDate"` IsNotTime bool `json:"isNotTime"` Content2 int64 `json:"content2"` IsNotEmpty2 bool `json:"isNotEmpty2"` FormattedContent string `json:"formattedContent"` } type DateFormat string const ( DateFormatNone DateFormat = "" DateFormatDuration DateFormat = "duration" ) func NewFormattedValueDate(content, content2 int64, format DateFormat, isNotTime bool) (ret *ValueDate) { var formatted string if isNotTime { formatted = time.UnixMilli(content).Format("2006-01-02") } else { formatted = time.UnixMilli(content).Format("2006-01-02 15:04") } if 0 < content2 { var formattedContent2 string if isNotTime { formattedContent2 = time.UnixMilli(content2).Format("2006-01-02") } else { formattedContent2 = time.UnixMilli(content2).Format("2006-01-02 15:04") } formatted += " → " + formattedContent2 } switch format { case DateFormatNone: case DateFormatDuration: t1 := time.UnixMilli(content) t2 := time.UnixMilli(content2) formatted = util.HumanizeRelTime(t1, t2, util.Lang) } ret = &ValueDate{ Content: content, Content2: content2, HasEndDate: false, IsNotTime: true, FormattedContent: formatted, } return } // RoundUp rounds like 12.3416 -> 12.35 func RoundUp(val float64, precision int) float64 { return math.Ceil(val*(math.Pow10(precision))) / math.Pow10(precision) } // RoundDown rounds like 12.3496 -> 12.34 func RoundDown(val float64, precision int) float64 { return math.Floor(val*(math.Pow10(precision))) / math.Pow10(precision) } // Round rounds to nearest like 12.3456 -> 12.35 func Round(val float64, precision int) float64 { return math.Round(val*(math.Pow10(precision))) / math.Pow10(precision) } type ValueSelect struct { Content string `json:"content"` Color string `json:"color"` } type ValueURL struct { Content string `json:"content"` } type ValueEmail struct { Content string `json:"content"` } type ValuePhone struct { Content string `json:"content"` } type AssetType string const ( AssetTypeFile = "file" AssetTypeImage = "image" ) type ValueAsset struct { Type AssetType `json:"type"` Name string `json:"name"` Content string `json:"content"` } type ValueTemplate struct { Content string `json:"content"` } type ValueCreated struct { Content int64 `json:"content"` IsNotEmpty bool `json:"isNotEmpty"` Content2 int64 `json:"content2"` IsNotEmpty2 bool `json:"isNotEmpty2"` FormattedContent string `json:"formattedContent"` } type CreatedFormat string const ( CreatedFormatNone CreatedFormat = "" // 2006-01-02 15:04 CreatedFormatDuration CreatedFormat = "duration" ) func NewFormattedValueCreated(content, content2 int64, format CreatedFormat) (ret *ValueCreated) { formatted := time.UnixMilli(content).Format("2006-01-02 15:04") if 0 < content2 { formatted += " → " + time.UnixMilli(content2).Format("2006-01-02 15:04") } switch format { case CreatedFormatNone: case CreatedFormatDuration: t1 := time.UnixMilli(content) t2 := time.UnixMilli(content2) formatted = util.HumanizeRelTime(t1, t2, util.Lang) } ret = &ValueCreated{ Content: content, Content2: content2, FormattedContent: formatted, } return } type ValueUpdated struct { Content int64 `json:"content"` IsNotEmpty bool `json:"isNotEmpty"` Content2 int64 `json:"content2"` IsNotEmpty2 bool `json:"isNotEmpty2"` FormattedContent string `json:"formattedContent"` } type UpdatedFormat string const ( UpdatedFormatNone UpdatedFormat = "" // 2006-01-02 15:04 UpdatedFormatDuration UpdatedFormat = "duration" ) func NewFormattedValueUpdated(content, content2 int64, format UpdatedFormat) (ret *ValueUpdated) { formatted := time.UnixMilli(content).Format("2006-01-02 15:04") if 0 < content2 { formatted += " → " + time.UnixMilli(content2).Format("2006-01-02 15:04") } switch format { case UpdatedFormatNone: case UpdatedFormatDuration: t1 := time.UnixMilli(content) t2 := time.UnixMilli(content2) formatted = util.HumanizeRelTime(t1, t2, util.Lang) } ret = &ValueUpdated{ Content: content, Content2: content2, FormattedContent: formatted, } return } // View 描述了视图的结构。 type View struct { ID string `json:"id"` // 视图 ID Name string `json:"name"` // 视图名称 LayoutType LayoutType `json:"type"` // 当前布局类型 Table *LayoutTable `json:"table,omitempty"` // 表格布局 } // LayoutType 描述了视图布局的类型。 type LayoutType string const ( LayoutTypeTable LayoutType = "table" // 属性视图类型 - 表格 ) func NewView() *View { name := "Table" return &View{ ID: ast.NewNodeID(), Name: name, LayoutType: LayoutTypeTable, Table: &LayoutTable{ Spec: 0, ID: ast.NewNodeID(), Filters: []*ViewFilter{}, Sorts: []*ViewSort{}, }, } } // Viewable 描述了视图的接口。 type Viewable interface { Filterable Sortable Calculable GetType() LayoutType GetID() string } func NewAttributeView(id string) (ret *AttributeView) { view := NewView() key := NewKey(ast.NewNodeID(), "Block", "", KeyTypeBlock) ret = &AttributeView{ Spec: 0, ID: id, KeyValues: []*KeyValues{{Key: key}}, ViewID: view.ID, Views: []*View{view}, } view.Table.Columns = []*ViewTableColumn{{ID: key.ID}} return } func ParseAttributeView(avID string) (ret *AttributeView, err error) { avJSONPath := GetAttributeViewDataPath(avID) if !gulu.File.IsExist(avJSONPath) { err = ErrViewNotFound return } data, readErr := filelock.ReadFile(avJSONPath) if nil != readErr { logging.LogErrorf("read attribute view [%s] failed: %s", avID, readErr) 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 SaveAttributeView(av *AttributeView) (err error) { // 做一些数据兼容和订正处理 now := util.CurrentTimeMillis() for _, kv := range av.KeyValues { if KeyTypeBlock == kv.Key.Type { // 补全 block 的创建时间和更新时间 for _, v := range kv.Values { if 0 == v.Block.Created { if "" == v.Block.ID { v.Block.ID = v.BlockID if "" == v.Block.ID { v.Block.ID = ast.NewNodeID() v.BlockID = v.Block.ID } } createdStr := v.Block.ID[:len("20060102150405")] created, parseErr := time.ParseInLocation("20060102150405", createdStr, time.Local) if nil == parseErr { v.Block.Created = created.UnixMilli() } else { v.Block.Created = now } } if 0 == v.Block.Updated { v.Block.Updated = now } } } } // 数据订正 - 行去重 for _, view := range av.Views { if nil != view.Table { view.Table.RowIDs = gulu.Str.RemoveDuplicatedElem(view.Table.RowIDs) } } data, err := gulu.JSON.MarshalIndentJSON(av, "", "\t") // TODO: single-line for production 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 (av *AttributeView) GetView() (ret *View, err error) { for _, v := range av.Views { if v.ID == av.ViewID { ret = v return } } err = ErrViewNotFound return } func (av *AttributeView) GetKey(keyID string) (ret *Key, err error) { for _, kv := range av.KeyValues { if kv.Key.ID == keyID { ret = kv.Key return } } err = ErrKeyNotFound return } func (av *AttributeView) GetBlockKeyValues() (ret *KeyValues) { for _, kv := range av.KeyValues { if KeyTypeBlock == kv.Key.Type { ret = kv 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 } var ( ErrViewNotFound = errors.New("view not found") ErrKeyNotFound = errors.New("key not found") ) const ( NodeAttrNameAvs = "custom-avs" // 用于标记块所属的属性视图,逗号分隔 av id )