XeNote/lib/utils.js

273 lines
8.2 KiB
JavaScript
Raw Normal View History

import { Node } from "./node"
import { Transformer } from "./transformer";
import { unified } from "unified";
import markdown from "remark-parse";
import { toString } from 'mdast-util-to-string'
import path from "path";
import fs from "fs";
const dirTree = require("directory-tree");
2023-12-26 04:42:33 +00:00
class Util {
_counter;
cachedSlugMap;
constructor() {
this._counter = 0;
this.cachedSlugMap = this.getSlugHashMap();
}
2023-12-26 04:39:48 +00:00
getContent(slug) {
let currentFilePath = this.toFilePath(slug)
2023-12-26 04:39:48 +00:00
if (currentFilePath === undefined || currentFilePath == null) return null
return Node.readFileSync(currentFilePath)
}
2023-12-26 04:39:48 +00:00
getShortSummary(slug) {
const content = this.getContent(slug)
2023-12-26 04:39:48 +00:00
if (content === undefined || content === null) {
return
}
2023-12-26 04:39:48 +00:00
const tree = unified().use(markdown)
.parse(content)
let plainText = toString(tree)
return plainText.split(" ").splice(0, 40).join(" ")
}
2020-11-30 11:29:34 +00:00
2023-12-26 04:39:48 +00:00
getAllMarkdownFiles() {
return Node.getFiles(Node.getMarkdownFolder())
}
2020-11-28 15:45:01 +00:00
2023-12-26 04:39:48 +00:00
getSinglePost(slug) {
// List of filenames that will provide existing links to wikilink
let currentFilePath = this.toFilePath(slug)
2023-12-26 04:39:48 +00:00
//console.log("currentFilePath: ", currentFilePath)
2023-12-26 04:39:48 +00:00
var fileContent = Node.readFileSync(currentFilePath)
2023-12-26 04:39:48 +00:00
//const currentFileFrontMatter = Transformer.getFrontMatterData(fileContent)
// console.log("===============\n\nFile is scanning: ", slug)
const [htmlContent] = Transformer.getHtmlContent(fileContent)
// console.log("==================================")
//console.log("hrmlcontents and backlinks")
return {
id: slug,
// ...currentFileFrontMatter,
data: htmlContent,
}
}
2023-12-26 04:39:48 +00:00
toFilePath(slug) {
return this.cachedSlugMap[slug]
2023-12-26 04:39:48 +00:00
}
2023-12-26 04:39:48 +00:00
getSlugHashMap() {
// This is to solve problem of converting between slug and filepath,
// where previously if I convert a slug to a file path sometime
// it does not always resolve to correct filepath, converting function is not bi-directional
// and not conflict-free, other solution was considered (hash file name into a hash, but this
// is not SEO-friendly and make url look ugly ==> I chose this
const slugMap = new Map()
this.getAllMarkdownFiles().map(aFile => {
const aSlug = this.toSlug(aFile);
2023-12-26 04:39:48 +00:00
// if (slugMap.has(aSlug)) {
// slugMap[aSlug].push(aFile)
// } else {
// slugMap[aSlug] = [aFile]
// }
// Note: [Future improvement] Resolve conflict
slugMap[aSlug] = aFile
})
2023-12-26 04:39:48 +00:00
const indexFile = "/🌎 Home.md"
slugMap['index'] = Node.getMarkdownFolder() + indexFile
slugMap['/'] = Node.getMarkdownFolder() + indexFile
2023-12-26 04:39:48 +00:00
return slugMap
}
2023-12-26 04:39:48 +00:00
toSlug(filePath) {
const markdownFolder = Node.getMarkdownFolder()
const isFile = Node.isFile(filePath)
const isMarkdownFolder = filePath.includes(markdownFolder)
if (isFile && isMarkdownFolder) {
return filePath.replace(markdownFolder, '')
.replaceAll('/', '_')
.replaceAll(' ', '+')
.replaceAll('&', '-')
.replace('.md', '')
} else {
//TODO handle this properly
return '/'
}
2023-12-26 04:39:48 +00:00
}
2023-12-26 04:39:48 +00:00
constructGraphData() {
const filepath = path.join(process.cwd(), "graph-data.json");
if (Node.isFile(filepath)) {
const data = fs.readFileSync(filepath);
return JSON.parse(String(data))
} else {
const filePaths = this.getAllMarkdownFiles();
2023-12-26 04:39:48 +00:00
const edges = []
const nodes = []
filePaths
.forEach(aFilePath => {
// const {currentFilePath} = getFileNames(filename)
const aNode = {
title: Transformer.parseFileNameFromPath(aFilePath),
slug: this.toSlug(aFilePath),
shortSummary: this.getShortSummary(this.toSlug(aFilePath))
}
2023-12-26 04:39:48 +00:00
nodes.push(aNode)
// console.log("Constructing graph for node: " + aFilePath )
const internalLinks = Transformer.getInternalLinks(aFilePath)
internalLinks.forEach(aLink => {
if (aLink.slug === null || aLink.slug.length === 0) return
const anEdge = {
source: this.toSlug(aFilePath),
2023-12-26 04:39:48 +00:00
target: aLink.slug,
}
edges.push(anEdge)
// console.log("Source: " + anEdge.source)
// console.log("Target: " + anEdge.target)
})
// console.log("==============Constructing graph" )
}
)
const data = { nodes, edges };
fs.writeFileSync(filepath, JSON.stringify(data), "utf-8");
return data;
}
}
2020-11-28 15:45:01 +00:00
2023-12-26 04:39:48 +00:00
getLocalGraphData(currentNodeId) {
const { nodes, edges } = constructGraphData()
2023-12-26 04:39:48 +00:00
const newNodes = nodes.map(aNode => (
{
data: {
id: aNode.slug.toString(),
label: Transformer.parseFileNameFromPath(this.toFilePath(aNode.slug)),
2023-12-26 04:39:48 +00:00
}
}
))
2023-12-26 04:39:48 +00:00
const newEdges = edges.map(anEdge => ({
data: {
2023-12-26 04:39:48 +00:00
source: anEdge.source,
target: anEdge.target,
}
2023-12-26 04:39:48 +00:00
}))
2023-12-26 04:39:48 +00:00
const existingNodeIDs = newNodes.map(aNode => aNode.data.id)
currentNodeId = currentNodeId === 'index' ? '__index' : currentNodeId
if (currentNodeId != null && existingNodeIDs.includes(currentNodeId)) {
const outGoingNodeIds = newEdges
.filter(anEdge => anEdge.data.source === currentNodeId)
.map(anEdge => anEdge.data.target)
2023-12-26 04:39:48 +00:00
const incomingNodeIds = newEdges
.filter(anEdge => anEdge.data.target === currentNodeId)
.map(anEdge => anEdge.data.source)
2023-12-26 04:39:48 +00:00
outGoingNodeIds.push(currentNodeId)
2023-12-26 04:39:48 +00:00
const localNodeIds = incomingNodeIds.concat(outGoingNodeIds.filter(item => incomingNodeIds.indexOf(item) < 0))
if (localNodeIds.indexOf(currentNodeId) < 0) {
localNodeIds.push(currentNodeId)
}
2023-12-26 04:39:48 +00:00
const localNodes = newNodes.filter(aNode => localNodeIds.includes(aNode.data.id))
let localEdges = newEdges.filter(edge => localNodeIds.includes(edge.data.source)).filter(edge => localNodeIds.includes(edge.data.target));
2023-12-26 04:39:48 +00:00
// Filter self-reference edges
localEdges = localEdges.filter(edge => edge.data.source !== edge.data.target)
2022-04-18 09:47:02 +00:00
2023-12-26 04:39:48 +00:00
// TODO: Find out why target ==='/' in some case
localEdges = localEdges.filter(edge => edge.data.target !== '/')
return {
nodes: localNodes,
edges: localEdges
}
} else {
const filteredEdges = newEdges
.filter(edge => existingNodeIDs.includes(edge.data.source))
.filter(edge => existingNodeIDs.includes(edge.data.target))
return {
nodes: newNodes,
edges: filteredEdges
}
}
2020-11-28 15:45:01 +00:00
2023-12-26 04:39:48 +00:00
}
2022-03-23 03:50:06 +00:00
2023-12-26 04:39:48 +00:00
getAllSlugs() {
//console.log("\n\nAll Posts are scanning")
// Get file names under /posts
const markdownFolder = Node.getMarkdownFolder()
const markdownFiles = Node.getFiles(markdownFolder)
const filePaths = markdownFiles.filter(file => !(file.endsWith("index") || file.endsWith("sidebar")))
return filePaths.map(f => this.toSlug(f))
2023-12-26 04:39:48 +00:00
}
2023-12-26 04:39:48 +00:00
getDirectoryData() {
const filteredDirectory = dirTree(Node.getMarkdownFolder(), { extensions: /\.md/, exclude: [/\.git/, /\.obsidian/] });
return this.convertObject(filteredDirectory)
}
2023-12-26 04:39:48 +00:00
convertObject(thisObject) {
const children = []
let routerPath = this.getAllSlugs().find(slug => {
const fileName = Transformer.parseFileNameFromPath(this.toFilePath(slug))
2023-12-26 04:39:48 +00:00
return Transformer.normalizeFileName(fileName) === Transformer.normalizeFileName(thisObject.name)
}) || null
2023-12-31 17:56:14 +00:00
routerPath = routerPath ? '/notes/' + routerPath : null
2023-12-26 04:39:48 +00:00
const newObject = {
name: thisObject.name,
children: children,
id: (this._counter++).toString(),
2023-12-26 04:39:48 +00:00
routePath: routerPath || null
};
if (thisObject.children != null && thisObject.children.length > 0) {
thisObject.children.forEach(aChild => {
const newChild = this.convertObject(aChild)
2023-12-26 04:39:48 +00:00
children.push(newChild)
})
return newObject;
} else {
return newObject
}
2023-12-26 04:39:48 +00:00
}
flat = (array) => {
2023-12-26 04:39:48 +00:00
var result = [];
const outerThis = this
2023-12-26 04:39:48 +00:00
array.forEach(function(a) {
result.push(a);
if (Array.isArray(a.children)) {
result = result.concat(outerThis.flat(a.children));
2023-12-26 04:39:48 +00:00
}
});
return result;
}
getFlattenArray(thisObject) {
return this.flat(thisObject.children)
2023-12-26 04:39:48 +00:00
}
}
2023-12-26 04:39:48 +00:00
2023-12-26 04:42:33 +00:00
export default new Util()