// Package backlinks maintains the index of backlinks and lets you update it and query it. package backlinks import ( "os" "github.com/bouncepaw/mycorrhiza/hyphae" "github.com/bouncepaw/mycorrhiza/util" ) // YieldHyphaBacklinks gets backlinks for the desired hypha, sorts and yields them one by one. func YieldHyphaBacklinks(hyphaName string) <-chan string { hyphaName = util.CanonicalName(hyphaName) out := make(chan string) sorted := hyphae.PathographicSort(out) go func() { backlinks, exists := backlinkIndex[hyphaName] if exists { for link := range backlinks { out <- link } } close(out) }() return sorted } var backlinkConveyor = make(chan backlinkIndexOperation) // No need to buffer because these operations are rare. // RunBacklinksConveyor runs an index operation processing loop. Call it somewhere in main. func RunBacklinksConveyor() { // It is supposed to run as a goroutine for all the time. So, don't blame the infinite loop. defer close(backlinkConveyor) for { (<-backlinkConveyor).apply() } } var backlinkIndex = make(map[string]linkSet) // IndexBacklinks traverses all text hyphae, extracts links from them and forms an initial index. Call it when indexing and reindexing hyphae. func IndexBacklinks() { // It is safe to ignore the mutex, because there is only one worker. for h := range hyphae.FilterHyphaeWithText(hyphae.YieldExistingHyphae()) { foundLinks := extractHyphaLinksFromContent(h.CanonicalName(), fetchText(h)) for _, link := range foundLinks { if _, exists := backlinkIndex[link]; !exists { backlinkIndex[link] = make(linkSet) } backlinkIndex[link][h.CanonicalName()] = struct{}{} } } } // BacklinksCount returns the amount of backlinks to the hypha. func BacklinksCount(h *hyphae.Hypha) int { if _, exists := backlinkIndex[h.Name]; exists { return len(backlinkIndex[h.Name]) } return 0 } // Using set here seems like the most appropriate solution type linkSet map[string]struct{} func toLinkSet(xs []string) linkSet { result := make(linkSet) for _, x := range xs { result[x] = struct{}{} } return result } func fetchText(h hyphae.Hypher) string { if !h.HasTextPart() { return "" } text, err := os.ReadFile(h.TextPartPath()) if err == nil { return string(text) } return "" } // backlinkIndexOperation is an operation for the backlink index. This operation is executed async-safe. type backlinkIndexOperation interface { apply() } // backlinkIndexEdit contains data for backlink index update after a hypha edit type backlinkIndexEdit struct { name string oldLinks []string newLinks []string } // apply changes backlink index respective to the operation data func (op backlinkIndexEdit) apply() { oldLinks := toLinkSet(op.oldLinks) newLinks := toLinkSet(op.newLinks) for link := range oldLinks { if _, exists := newLinks[link]; !exists { delete(backlinkIndex[link], op.name) } } for link := range newLinks { if _, exists := oldLinks[link]; !exists { if _, exists := backlinkIndex[link]; !exists { backlinkIndex[link] = make(linkSet) } backlinkIndex[link][op.name] = struct{}{} } } } // backlinkIndexDeletion contains data for backlink index update after a hypha deletion type backlinkIndexDeletion struct { name string links []string } // apply changes backlink index respective to the operation data func (op backlinkIndexDeletion) apply() { for _, link := range op.links { if lSet, exists := backlinkIndex[link]; exists { delete(lSet, op.name) } } } // backlinkIndexRenaming contains data for backlink index update after a hypha renaming type backlinkIndexRenaming struct { oldName string newName string links []string } // Apply changes backlink index respective to the operation data func (op backlinkIndexRenaming) apply() { for _, link := range op.links { if lSet, exists := backlinkIndex[link]; exists { delete(lSet, op.oldName) backlinkIndex[link][op.newName] = struct{}{} } } }