siyuan/kernel/model/flashcard.go

// SiYuan - Build Your Eternal Digital Garden
// 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 model

import (
	"errors"
	"github.com/siyuan-note/siyuan/kernel/sql"
	"math"
	"os"
	"path/filepath"
	"sort"
	"strings"
	"sync"
	"time"

	"github.com/88250/gulu"
	"github.com/88250/lute/ast"
	"github.com/88250/lute/parse"
	"github.com/dustin/go-humanize"
	"github.com/siyuan-note/logging"
	"github.com/siyuan-note/riff"
	"github.com/siyuan-note/siyuan/kernel/cache"
	"github.com/siyuan-note/siyuan/kernel/treenode"
	"github.com/siyuan-note/siyuan/kernel/util"
)

var Decks = map[string]*riff.Deck{}
var deckLock = sync.Mutex{}

func GetFlashcards(deckID string, page int) (blocks []*Block, total, pageCount int) {
	blocks = []*Block{}
	var allBlockIDs []string
	const pageSize = 20
	if "" == deckID {
		for _, deck := range Decks {
			for bID, _ := range deck.BlockCard {
				allBlockIDs = append(allBlockIDs, bID)
			}
		}
	} else {
		deck := Decks[deckID]
		if nil == deck {
			return
		}

		for bID, _ := range deck.BlockCard {
			allBlockIDs = append(allBlockIDs, bID)
		}
	}

	sort.Strings(allBlockIDs)
	start := (page - 1) * pageSize
	end := page * pageSize
	if start > len(allBlockIDs) {
		start = len(allBlockIDs)
	}
	if end > len(allBlockIDs) {
		end = len(allBlockIDs)
	}
	blockIDs := allBlockIDs[start:end]
	total = len(allBlockIDs)
	pageCount = int(math.Ceil(float64(total) / float64(pageSize)))
	if 1 > len(blockIDs) {
		blocks = []*Block{}
		return
	}

	sqlBlocks := sql.GetBlocks(blockIDs)
	blocks = fromSQLBlocks(&sqlBlocks, "", 36)
	if 1 > len(blocks) {
		blocks = []*Block{}
		return
	}

	for i, b := range blocks {
		if nil == b {
			blocks[i] = &Block{
				ID:      blockIDs[i],
				Content: Conf.Language(180),
			}
		}
	}
	return
}

func ReviewFlashcard(deckID string, blockID string, rating riff.Rating) (err error) {
	deckLock.Lock()
	defer deckLock.Unlock()

	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	deck := Decks[deckID]
	deck.Review(blockID, rating)
	err = deck.Save()
	if nil != err {
		logging.LogErrorf("save deck [%s] failed: %s", deckID, err)
		return
	}
	return
}

type Flashcard struct {
	DeckID   string                 `json:"deckID"`
	BlockID  string                 `json:"blockID"`
	NextDues map[riff.Rating]string `json:"nextDues"`
}

func GetTreeDueFlashcards(rootID string) (ret []*Flashcard, err error) {
	deckLock.Lock()
	defer deckLock.Unlock()

	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	deck := Decks[builtinDeckID]
	if nil == deck {
		logging.LogWarnf("builtin deck not found")
		return
	}

	tree, err := loadTreeByBlockID(rootID)
	if nil != err {
		return
	}

	blockIDs := map[string]bool{}
	for n := tree.Root.FirstChild; nil != n; n = n.Next {
		blockIDs[n.ID] = true
	}

	cards := deck.Dues()
	now := time.Now()
	for _, card := range cards {
		blockID := card.BlockID()
		if !blockIDs[blockID] {
			continue
		}

		nextDues := map[riff.Rating]string{}
		for rating, due := range card.NextDues() {
			nextDues[rating] = strings.TrimSpace(humanize.RelTime(due, now, "", ""))
		}

		ret = append(ret, &Flashcard{
			DeckID:   builtinDeckID,
			BlockID:  blockID,
			NextDues: nextDues,
		})
	}
	if 1 > len(ret) {
		ret = []*Flashcard{}
	}
	return
}

func GetDueFlashcards(deckID string) (ret []*Flashcard, err error) {
	deckLock.Lock()
	defer deckLock.Unlock()

	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	if "" == deckID {
		return getAllDueFlashcards()
	}

	deck := Decks[deckID]
	cards := deck.Dues()
	now := time.Now()
	for _, card := range cards {
		blockID := card.BlockID()

		if nil == treenode.GetBlockTree(blockID) {
			continue
		}

		nextDues := map[riff.Rating]string{}
		for rating, due := range card.NextDues() {
			nextDues[rating] = strings.TrimSpace(humanize.RelTime(due, now, "", ""))
		}

		ret = append(ret, &Flashcard{
			DeckID:   deckID,
			BlockID:  blockID,
			NextDues: nextDues,
		})
	}
	if 1 > len(ret) {
		ret = []*Flashcard{}
	}
	return
}

func getAllDueFlashcards() (ret []*Flashcard, err error) {
	blockIDs := map[string]bool{}
	now := time.Now()
	for _, deck := range Decks {
		cards := deck.Dues()
		for _, card := range cards {
			blockID := card.BlockID()
			if nil == treenode.GetBlockTree(blockID) {
				continue
			}

			if blockIDs[blockID] {
				continue
			}

			nextDues := map[riff.Rating]string{}
			for rating, due := range card.NextDues() {
				nextDues[rating] = strings.TrimSpace(humanize.RelTime(due, now, "", ""))
			}

			ret = append(ret, &Flashcard{
				DeckID:   deck.ID,
				BlockID:  blockID,
				NextDues: nextDues,
			})
			blockIDs[blockID] = true
		}
	}
	if 1 > len(ret) {
		ret = []*Flashcard{}
	}
	return
}

func RemoveFlashcards(deckID string, blockIDs []string) (err error) {
	deckLock.Lock()
	defer deckLock.Unlock()

	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	var rootIDs []string
	blockRoots := map[string]string{}
	for _, blockID := range blockIDs {
		bt := treenode.GetBlockTree(blockID)
		if nil == bt {
			continue
		}

		rootIDs = append(rootIDs, bt.RootID)
		blockRoots[blockID] = bt.RootID
	}
	rootIDs = gulu.Str.RemoveDuplicatedElem(rootIDs)

	availableDeckIDs := getDeckIDs()
	trees := map[string]*parse.Tree{}
	for _, blockID := range blockIDs {
		rootID := blockRoots[blockID]

		tree := trees[rootID]
		if nil == tree {
			tree, _ = loadTreeByBlockID(blockID)
		}
		if nil == tree {
			continue
		}
		trees[rootID] = tree

		node := treenode.GetNodeInTree(tree, blockID)
		if nil == node {
			continue
		}

		oldAttrs := parse.IAL2Map(node.KramdownIAL)

		deckAttrs := node.IALAttr("custom-riff-decks")
		var deckIDs []string
		for _, dID := range strings.Split(deckAttrs, ",") {
			if dID != deckID && gulu.Str.Contains(dID, availableDeckIDs) {
				deckIDs = append(deckIDs, dID)
			}
		}

		deckIDs = gulu.Str.RemoveDuplicatedElem(deckIDs)
		val := strings.Join(deckIDs, ",")
		val = strings.TrimPrefix(val, ",")
		val = strings.TrimSuffix(val, ",")
		if "" == val {
			node.RemoveIALAttr("custom-riff-decks")
		} else {
			node.SetIALAttr("custom-riff-decks", val)
		}

		if err = indexWriteJSONQueue(tree); nil != err {
			return
		}

		cache.PutBlockIAL(blockID, parse.IAL2Map(node.KramdownIAL))

		newAttrs := parse.IAL2Map(node.KramdownIAL)
		doOp := &Operation{Action: "updateAttrs", Data: map[string]interface{}{"old": oldAttrs, "new": newAttrs}, ID: blockID}
		trans := []*Transaction{{
			DoOperations:   []*Operation{doOp},
			UndoOperations: []*Operation{},
		}}
		pushBroadcastAttrTransactions(trans)
	}

	deck := Decks[deckID]
	if nil != deck {
		for _, blockID := range blockIDs {
			deck.RemoveCard(blockID)
		}
		err = deck.Save()
		if nil != err {
			logging.LogErrorf("save deck [%s] failed: %s", deckID, err)
			return
		}
	}
	return
}

func AddTreeFlashcards(rootID string) (err error) {
	tree, err := loadTreeByBlockID(rootID)
	if nil != err {
		return
	}

	var blockIDs []string
	for n := tree.Root.FirstChild; nil != n; n = n.Next {
		blockIDs = append(blockIDs, n.ID)
	}
	return AddFlashcards(builtinDeckID, blockIDs)
}

func AddFlashcards(deckID string, blockIDs []string) (err error) {
	deckLock.Lock()
	defer deckLock.Unlock()

	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	blockRoots := map[string]string{}
	for _, blockID := range blockIDs {
		bt := treenode.GetBlockTree(blockID)
		if nil == bt {
			continue
		}

		blockRoots[blockID] = bt.RootID
	}

	trees := map[string]*parse.Tree{}
	for _, blockID := range blockIDs {
		rootID := blockRoots[blockID]

		tree := trees[rootID]
		if nil == tree {
			tree, _ = loadTreeByBlockID(blockID)
		}
		if nil == tree {
			continue
		}
		trees[rootID] = tree

		node := treenode.GetNodeInTree(tree, blockID)
		if nil == node {
			continue
		}

		oldAttrs := parse.IAL2Map(node.KramdownIAL)

		deckAttrs := node.IALAttr("custom-riff-decks")
		deckIDs := strings.Split(deckAttrs, ",")
		deckIDs = append(deckIDs, deckID)
		deckIDs = gulu.Str.RemoveDuplicatedElem(deckIDs)
		val := strings.Join(deckIDs, ",")
		val = strings.TrimPrefix(val, ",")
		val = strings.TrimSuffix(val, ",")
		node.SetIALAttr("custom-riff-decks", val)

		if err = indexWriteJSONQueue(tree); nil != err {
			return
		}

		cache.PutBlockIAL(blockID, parse.IAL2Map(node.KramdownIAL))

		newAttrs := parse.IAL2Map(node.KramdownIAL)
		doOp := &Operation{Action: "updateAttrs", Data: map[string]interface{}{"old": oldAttrs, "new": newAttrs}, ID: blockID}
		trans := []*Transaction{{
			DoOperations:   []*Operation{doOp},
			UndoOperations: []*Operation{},
		}}
		pushBroadcastAttrTransactions(trans)
	}

	deck := Decks[deckID]
	if nil == deck {
		logging.LogWarnf("deck [%s] not found", deckID)
		return
	}

	for _, blockID := range blockIDs {
		cardID := ast.NewNodeID()
		deck.AddCard(cardID, blockID)
	}
	err = deck.Save()
	if nil != err {
		logging.LogErrorf("save deck [%s] failed: %s", deckID, err)
		return
	}
	return
}

func LoadFlashcards() {
	riffSavePath := getRiffDir()
	if err := os.MkdirAll(riffSavePath, 0755); nil != err {
		logging.LogErrorf("create riff dir [%s] failed: %s", riffSavePath, err)
		return
	}

	Decks = map[string]*riff.Deck{}

	entries, err := os.ReadDir(riffSavePath)
	if nil != err {
		logging.LogErrorf("read riff dir failed: %s", err)
		return
	}
	for _, entry := range entries {
		name := entry.Name()
		if strings.HasSuffix(name, ".deck") {
			deckID := strings.TrimSuffix(name, ".deck")
			deck, loadErr := riff.LoadDeck(riffSavePath, deckID)
			if nil != loadErr {
				logging.LogErrorf("load deck [%s] failed: %s", name, loadErr)
				continue
			}

			if 0 == deck.Created {
				deck.Created = time.Now().Unix()
			}
			if 0 == deck.Updated {
				deck.Updated = deck.Created
			}

			Decks[deckID] = deck
		}
	}

	if 1 > len(Decks) {
		deck, createErr := createDeck("Default Deck")
		if nil == createErr {
			Decks[deck.ID] = deck
		}
	}

	// 支持基于文档复习闪卡 https://github.com/siyuan-note/siyuan/issues/7057
	foudBuiltinDeck := false
	for _, deck := range Decks {
		if builtinDeckID == deck.ID {
			foudBuiltinDeck = true
			break
		}
	}
	if !foudBuiltinDeck {
		deck, createErr := createDeck0("Built-in Deck", builtinDeckID)
		if nil == createErr {
			Decks[deck.ID] = deck
		}
	}
}

const builtinDeckID = "20230218211946-2kw8jgx"

func RenameDeck(deckID, name string) (err error) {
	deckLock.Lock()
	defer deckLock.Unlock()

	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	deck := Decks[deckID]
	deck.Name = name
	err = deck.Save()
	if nil != err {
		logging.LogErrorf("save deck [%s] failed: %s", deckID, err)
		return
	}
	return
}

func RemoveDeck(deckID string) (err error) {
	deckLock.Lock()
	defer deckLock.Unlock()

	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	riffSavePath := getRiffDir()
	deckPath := filepath.Join(riffSavePath, deckID+".deck")
	if gulu.File.IsExist(deckPath) {
		if err = os.Remove(deckPath); nil != err {
			return
		}
	}

	cardsPath := filepath.Join(riffSavePath, deckID+".cards")
	if gulu.File.IsExist(cardsPath) {
		if err = os.Remove(cardsPath); nil != err {
			return
		}
	}

	LoadFlashcards()
	return
}

func CreateDeck(name string) (deck *riff.Deck, err error) {
	deckLock.Lock()
	defer deckLock.Unlock()
	return createDeck(name)
}

func createDeck(name string) (deck *riff.Deck, err error) {
	if syncingStorages {
		err = errors.New(Conf.Language(81))
		return
	}

	deckID := ast.NewNodeID()
	deck, err = createDeck0(name, deckID)
	return
}

func createDeck0(name string, deckID string) (deck *riff.Deck, err error) {
	riffSavePath := getRiffDir()
	deck, err = riff.LoadDeck(riffSavePath, deckID)
	if nil != err {
		logging.LogErrorf("load deck [%s] failed: %s", deckID, err)
		return
	}
	deck.Name = name
	Decks[deckID] = deck
	err = deck.Save()
	if nil != err {
		logging.LogErrorf("save deck [%s] failed: %s", deckID, err)
		return
	}
	return
}

func GetDecks() (decks []*riff.Deck) {
	deckLock.Lock()
	defer deckLock.Unlock()

	for _, deck := range Decks {
		if deck.ID == builtinDeckID {
			continue
		}

		decks = append(decks, deck)
	}
	if 1 > len(decks) {
		decks = []*riff.Deck{}
	}
	return
}

func getRiffDir() string {
	return filepath.Join(util.DataDir, "storage", "riff")
}

func getDeckIDs() (deckIDs []string) {
	for deckID := range Decks {
		deckIDs = append(deckIDs, deckID)
	}
	return
}