Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

13.4 KB
Raw Blame
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later

package api

import (
	"encoding/json"
	"strconv"

	"github.com/gin-gonic/gin"
	"github.com/siyuan-note/siyuan/kernel/apicontract"
	"github.com/siyuan-note/siyuan/kernel/model"
	"github.com/siyuan-note/siyuan/kernel/util"
)

var refreshBacklink = contractHandler(apicontract.RefreshBacklink, func(c *gin.Context, request apicontract.RefreshBacklinkRequest) apicontract.Response[apicontract.Null] {
	if err := util.ValidateID(request.ID); err != nil {
		return apicontract.FailureFrom[apicontract.Null](err)
	}
	model.RefreshBacklink(request.ID)
	model.FlushTxQueue()
	return apicontract.Success(apicontract.Null{})
})

func isBacklinkDocAccessible(c *gin.Context, refTreeID string) bool {
	if !model.IsReadOnlyRoleContext(c) {
		return true
	}

	return model.CheckBlockIdAccessableByPublishAccess(c, model.GetPublishAccess(), refTreeID)
}

func backlinkRequestNotifier(c *gin.Context) model.BackmentionNotifier {
	if model.IsReadOnlyRoleContext(c) {
		return nil
	}
	app := resolveRequestAppID(c, "")
	return func(msg string, timeout int) string {
		return util.PushMsgWithApp(app, msg, timeout)
	}
}

var getBackmentionDoc = contractHandler(apicontract.GetBackmentionDoc, func(c *gin.Context, request apicontract.BackmentionDocumentRequest) apicontract.Response[apicontract.BacklinkContextData] {
	defID, refTreeID := request.DefID, request.RefTreeID
	knownRevision, keyword, notebook := request.KnownRevision, request.Keyword, request.Notebook
	notify := backlinkRequestNotifier(c)
	encryptedNotebookDenied := isEncryptedNotebookDeniedForPublish(c, notebook)
	if notebook != "" && !model.IsEncryptedBox(notebook) {
		notebook = ""
	}
	if !encryptedNotebookDenied {
		if err := holdEncryptedBoxRequest(c, notebook); err != nil {
			return apicontract.Failure[apicontract.BacklinkContextData](1, err.Error())
		}
	}
	containChildren := model.Conf.Editor.Load().BacklinkContainChildren
	if request.ContainChildren != nil {
		containChildren = *request.ContainChildren
	}
	highlight := true
	if request.Highlight != nil {
		highlight = *request.Highlight
	}

	var backlinks []*model.Backlink
	var keywords []string
	if encryptedNotebookDenied || !isBacklinkDocAccessible(c, refTreeID) {
		backlinks, keywords = []*model.Backlink{}, []string{}
	} else if notebook != "" && model.IsEncryptedBox(notebook) {
		backlinks, keywords = model.GetBackmentionDocInBox(defID, refTreeID, keyword, containChildren, highlight, notebook, notify)
	} else {
		backlinks, keywords = model.GetBackmentionDoc(defID, refTreeID, keyword, containChildren, highlight, notify)
	}
	keywords = canonicalBacklinkKeywords(keywords)
	items := newBacklinkContextResponses(backlinks)
	revision := hashBacklinkRevision("bc1:", struct {
		DefID           string
		RefTreeID       string
		Keyword         string
		Notebook        string
		ContainChildren bool
		Highlight       bool
		Items           []*backlinkContextResponse
		Keywords        []string
	}{defID, refTreeID, keyword, notebook, containChildren, highlight, items, keywords})
	if knownRevision == revision {
		return apicontract.Success(apicontract.BacklinkContextData{Unchanged: true, Revision: revision})
	}
	return apicontract.Success(apicontract.BacklinkContextData{Revision: revision, Backmentions: backlinkContextContracts(items), Keywords: keywords})
})

func backlinkContextContracts(items []*backlinkContextResponse) []*apicontract.BacklinkContext {
	if items == nil {
		return nil
	}
	ret := make([]*apicontract.BacklinkContext, len(items))
	for i, item := range items {
		if item == nil {
			continue
		}
		value := &apicontract.BacklinkContext{Type: item.Type, ReferenceBlockID: item.ReferenceBlockID, ID: item.ID,
			DOM: item.DOM, BlockPaths: blockPathContracts(item.BlockPaths), Expand: item.Expand, Revision: item.Revision}
		if item.AttributeViewTargets != nil {
			value.AttributeViewTargets = make([]*apicontract.BacklinkAttributeViewTarget, len(item.AttributeViewTargets))
			for j, target := range item.AttributeViewTargets {
				if target == nil {
					continue
				}
				converted := &apicontract.BacklinkAttributeViewTarget{BlockID: target.BlockID}
				if target.Matches != nil {
					converted.Matches = make([]*apicontract.BacklinkAttributeViewMatch, len(target.Matches))
					for k, match := range target.Matches {
						converted.Matches[k] = (*apicontract.BacklinkAttributeViewMatch)(match)
					}
				}
				value.AttributeViewTargets[j] = converted
			}
		}
		ret[i] = value
	}
	return ret
}

var getBacklinkDoc = contractHandler(apicontract.GetBacklinkDoc, func(c *gin.Context, request apicontract.BacklinkDocumentRequest) apicontract.Response[apicontract.BacklinkContextData] {
	defID, refTreeID := request.DefID, request.RefTreeID
	knownRevision, keyword, notebook := request.KnownRevision, request.Keyword, request.Notebook
	encryptedNotebookDenied := isEncryptedNotebookDeniedForPublish(c, notebook)
	if notebook != "" && !model.IsEncryptedBox(notebook) {
		notebook = ""
	}
	if !encryptedNotebookDenied {
		if err := holdEncryptedBoxRequest(c, notebook); err != nil {
			return apicontract.Failure[apicontract.BacklinkContextData](1, err.Error())
		}
		if err := validateBacklinkDatabaseRequest(c, backlinkSourceFilterModel(request.SourceFilter), notebook); err != nil {
			return apicontract.Failure[apicontract.BacklinkContextData](1, err.Error())
		}
	}
	containChildren := model.Conf.Editor.Load().BacklinkContainChildren
	if request.ContainChildren != nil {
		containChildren = *request.ContainChildren
	}
	highlight := true
	if request.Highlight != nil {
		highlight = *request.Highlight
	}

	var backlinks []*model.Backlink
	var keywords []string
	if encryptedNotebookDenied || !isBacklinkDocAccessible(c, refTreeID) {
		backlinks, keywords = []*model.Backlink{}, []string{}
	} else if notebook != "" && model.IsEncryptedBox(notebook) {
		backlinks, keywords = model.GetBacklinkDocInBoxWithSort(defID, refTreeID, keyword, containChildren, highlight, notebook, request.BlockSort, backlinkSourceFilterModel(request.SourceFilter))
	} else {
		backlinks, keywords = model.GetBacklinkDocWithSort(defID, refTreeID, keyword, containChildren, highlight, request.BlockSort, backlinkSourceFilterModel(request.SourceFilter))
	}
	keywords = canonicalBacklinkKeywords(keywords)
	items := newBacklinkContextResponses(backlinks)
	revision := hashBacklinkRevision("bc1:", struct {
		DefID           string
		RefTreeID       string
		Keyword         string
		Notebook        string
		ContainChildren bool
		Highlight       bool
		BlockSort       int
		Items           []*backlinkContextResponse
		Keywords        []string
	}{defID, refTreeID, keyword, notebook, containChildren, highlight, request.BlockSort, items, keywords})
	if knownRevision == revision {
		return apicontract.Success(apicontract.BacklinkContextData{Unchanged: true, Revision: revision})
	}
	return apicontract.Success(apicontract.BacklinkContextData{Revision: revision, Backlinks: backlinkContextContracts(items), Keywords: keywords})
})

func backlinkSourceFilterModel(filter *apicontract.BacklinkSourceFilter) *model.BacklinkSourceFilter {
	if filter == nil {
		return nil
	}
	ret := &model.BacklinkSourceFilter{DailyNote: filter.DailyNote, ExcludeSelf: filter.ExcludeSelf,
		ExcludedRefDefIDs: filter.ExcludedRefDefIDs, ExcludedNotebookIDs: filter.ExcludedNotebookIDs}
	if filter.Database != nil {
		ret.Database = &model.BacklinkDatabaseFilter{AvID: filter.Database.AvID,
			Filters: avContractSlice(filter.Database.Filters, fromContractAVViewFilter)}
	}
	return model.NormalizeBacklinkSourceFilter(ret)
}

var getBacklink2 = contractHandler(apicontract.GetBacklink2, func(c *gin.Context, request apicontract.BacklinkListRequest) apicontract.Response[apicontract.BacklinkListData] {
	if request.ID == nil {
		return apicontract.Success(apicontract.BacklinkListData{})
	}
	id, knownRevision := *request.ID, request.KnownRevision
	keyword, mentionKeyword := request.K, request.MK
	notify := backlinkRequestNotifier(c)
	includeMentions := true
	if request.IncludeMentions != nil {
		includeMentions = *request.IncludeMentions
	}
	includeBacklinks := request.IncludeBacklinks == nil || *request.IncludeBacklinks
	sort := util.SortModeUpdatedDESC
	if request.Sort != nil {
		sort, _ = strconv.Atoi(*request.Sort)
	}
	mentionSort := util.SortModeUpdatedDESC
	if request.MentionSort != nil {
		mentionSort, _ = strconv.Atoi(*request.MentionSort)
	}
	containChildren := model.Conf.Editor.Load().BacklinkContainChildren
	if request.ContainChildren != nil {
		containChildren = *request.ContainChildren
	}
	sourceFilter := backlinkSourceFilterModel(request.SourceFilter)
	if request.RefDefCandidates {
		empty := apicontract.BacklinkDefinitionsResult([]*apicontract.BacklinkRefDef{})
		notebook := request.Notebook
		if model.IsReadOnlyRoleContext(c) || isEncryptedNotebookDeniedForPublish(c, notebook) {
			return apicontract.Success(empty)
		}
		if err := holdEncryptedBoxRequest(c, notebook); nil != err {
			return apicontract.GetBacklink2.FailureWithData(1, err.Error(), empty)
		}
		if !model.IsEncryptedBox(notebook) {
			notebook = ""
		}
		defs, err := model.GetBacklinkRefDefs(id, keyword, containChildren, notebook, sourceFilter)
		if nil != err {
			return apicontract.GetBacklink2.FailureWithData(1, err.Error(), empty)
		}
		var converted []*apicontract.BacklinkRefDef
		if defs != nil {
			converted = make([]*apicontract.BacklinkRefDef, len(defs))
			for i, def := range defs {
				converted[i] = (*apicontract.BacklinkRefDef)(def)
			}
		}
		return apicontract.Success(apicontract.BacklinkDefinitionsResult(converted))
	}
	var boxID string
	var backlinks, backmentions []*model.Path
	var linkRefsCount, mentionsCount int
	// 加密笔记本的反链面板走 InBox 版(查加密 content db)
	notebook := request.Notebook
	if !isEncryptedNotebookDeniedForPublish(c, notebook) {
		if err := holdEncryptedBoxRequest(c, notebook); err != nil {
			return apicontract.Failure[apicontract.BacklinkListData](1, err.Error())
		}
		if notebook != "" && model.IsEncryptedBox(notebook) {
			if err := validateBacklinkDatabaseRequest(c, sourceFilter, notebook); err != nil {
				return apicontract.Failure[apicontract.BacklinkListData](1, err.Error())
			}
			boxID, backlinks, backmentions, linkRefsCount, mentionsCount = model.GetBacklink2InBoxWithOptions(id, keyword, mentionKeyword, sort, mentionSort, containChildren, notebook, sourceFilter, includeMentions, includeBacklinks, notify)
		} else {
			if err := validateBacklinkDatabaseRequest(c, sourceFilter, ""); err != nil {
				return apicontract.Failure[apicontract.BacklinkListData](1, err.Error())
			}
			boxID, backlinks, backmentions, linkRefsCount, mentionsCount = model.GetBacklink2InBoxWithOptions(id, keyword, mentionKeyword, sort, mentionSort, containChildren, "", sourceFilter, includeMentions, includeBacklinks, notify)
		}
	}
	if model.IsReadOnlyRoleContext(c) {
		publishAccess := model.GetPublishAccess()
		backlinks = model.FilterPathsByPublishAccess(c, publishAccess, backlinks)
		backmentions = model.FilterPathsByPublishAccess(c, publishAccess, backmentions)
		linkRefsCount = countBacklinkPaths(backlinks)
		mentionsCount = countBacklinkPaths(backmentions)
	}
	backlinkResponses := newBacklinkPathResponses(backlinks)
	backmentionResponses := newBacklinkPathResponses(backmentions)
	response := &backlinkListResponse{
		Backlinks:     backlinkResponses,
		LinkRefsCount: linkRefsCount,
		Backmentions:  backmentionResponses,
		MentionsCount: mentionsCount,
		K:             keyword,
		MK:            mentionKeyword,
		Box:           boxID,
	}
	response.Revision = hashBacklinkRevision("bl1:", struct {
		ID              string
		Keyword         string
		MentionKeyword  string
		Sort            int
		MentionSort     int
		ContainChildren bool
		Notebook        string
		SourceFilter    *model.BacklinkSourceFilter
		Backlinks       []string
		LinkRefsCount   int
		Backmentions    []string
		MentionsCount   int
		Box             string
	}{
		id,
		keyword,
		mentionKeyword,
		sort,
		mentionSort,
		containChildren,
		notebook,
		sourceFilter,
		backlinkPathRevisions(backlinkResponses),
		linkRefsCount,
		backlinkPathRevisions(backmentionResponses),
		mentionsCount,
		boxID,
	})
	if knownRevision == response.Revision {
		return apicontract.Success(apicontract.BacklinkListResult(apicontract.BacklinkList{Unchanged: true, Revision: response.Revision}))
	}
	encoded, err := json.Marshal(response)
	if err != nil {
		return apicontract.Failure[apicontract.BacklinkListData](-1, err.Error())
	}
	var result apicontract.BacklinkList
	if err = json.Unmarshal(encoded, &result); err != nil {
		return apicontract.Failure[apicontract.BacklinkListData](-1, err.Error())
	}
	return apicontract.Success(apicontract.BacklinkListResult(result))
})

func parseBacklinkSourceFilter(arg map[string]any) *model.BacklinkSourceFilter {
	filterArg, ok := arg["sourceFilter"].(map[string]any)
	if !ok {
		return nil
	}

	filter := &model.BacklinkSourceFilter{}
	filter.DailyNote, _ = filterArg["dailyNote"].(string)
	filter.ExcludeSelf, _ = filterArg["excludeSelf"].(bool)
	if ids, ok := filterArg["excludedRefDefIDs"].([]any); ok {
		for _, value := range ids {
			if id, ok := value.(string); ok {
				filter.ExcludedRefDefIDs = append(filter.ExcludedRefDefIDs, id)
			}
		}
	}
	if notebookIDs, ok := filterArg["excludedNotebookIDs"].([]any); ok {
		for _, notebookID := range notebookIDs {
			if id, ok := notebookID.(string); ok {
				filter.ExcludedNotebookIDs = append(filter.ExcludedNotebookIDs, id)
			}
		}
	}
	return model.NormalizeBacklinkSourceFilter(filter)
}