Files
obsidian-excalidraw-plugin/src/utils/ObsidianUtils.ts
2023-08-16 06:32:51 +02:00

236 lines
8.6 KiB
TypeScript

import {
App,
normalizePath, Workspace, WorkspaceLeaf, WorkspaceSplit
} from "obsidian";
import ExcalidrawPlugin from "../main";
import { checkAndCreateFolder, splitFolderAndFilename } from "./FileUtils";
import { linkClickModifierType, ModifierKeys } from "./ModifierkeyHelper";
import { REG_BLOCK_REF_CLEAN, REG_SECTION_REF_CLEAN } from "src/Constants";
export const getParentOfClass = (element: Element, cssClass: string):HTMLElement | null => {
let parent = element.parentElement;
while (
parent &&
!(parent instanceof window.HTMLBodyElement) &&
!parent.classList.contains(cssClass)
) {
parent = parent.parentElement;
}
return parent?.classList?.contains(cssClass) ? parent : null;
};
export const getLeaf = (
plugin: ExcalidrawPlugin,
origo: WorkspaceLeaf,
ev: ModifierKeys
) => {
const newTab = ():WorkspaceLeaf => {
if(!plugin.settings.openInMainWorkspace) return app.workspace.getLeaf('tab');
const [leafLoc, mainLeavesIds] = getLeafLoc(origo);
if(leafLoc === 'main') return app.workspace.getLeaf('tab');
return getNewOrAdjacentLeaf(plugin,origo);
}
const newTabGroup = ():WorkspaceLeaf => getNewOrAdjacentLeaf(plugin,origo);
const newWindow = ():WorkspaceLeaf => app.workspace.openPopoutLeaf();
switch(linkClickModifierType(ev)) {
case "active-pane": return origo;
case "new-tab": return newTab();
case "new-pane": return newTabGroup();
case "popout-window": return newWindow();
default: return newTab();
}
}
const getLeafLoc = (leaf: WorkspaceLeaf): ["main" | "popout" | "left" | "right" | "hover",any] => {
//@ts-ignore
const leafId = leaf.id;
const layout = app.workspace.getLayout();
const getLeaves = (l:any)=> l.children
.filter((c:any)=>c.type!=="leaf")
.map((c:any)=>getLeaves(c))
.flat()
.concat(l.children.filter((c:any)=>c.type==="leaf").map((c:any)=>c.id))
const mainLeavesIds = getLeaves(layout.main);
return [
layout.main && mainLeavesIds.contains(leafId)
? "main"
: layout.floating && getLeaves(layout.floating).contains(leafId)
? "popout"
: layout.left && getLeaves(layout.left).contains(leafId)
? "left"
: layout.right && getLeaves(layout.right).contains(leafId)
? "right"
: "hover",
mainLeavesIds
];
}
/*
| Setting | Originating Leaf |
| | Main Workspace | Hover Editor | Popout Window |
| ----------------------- | -------------------------------- | -------------------------------------- | -------------------------------- |
| InMain && InAdjacent | 1.1 Reuse Leaf in Main Workspace | 1.1 Reuse Leaf in Main Workspace | 1.1 Reuse Leaf in Main Workspace |
| InMain && !InAdjacent | 1.2 New Leaf in Main Workspace | 1.2 New Leaf in Main Workspace | 1.2 New Leaf in Main Workspace |
| !InMain && InAdjacent | 1.1 Reuse Leaf in Main Workspace | 3 Reuse Leaf in Current Hover Editor | 4 Reuse Leaf in Current Popout |
| !InMain && !InAdjacent | 1.2 New Leaf in Main Workspace | 2 New Leaf in Current Hover Editor | 2 New Leaf in Current Popout |
*/
export const getNewOrAdjacentLeaf = (
plugin: ExcalidrawPlugin,
leaf: WorkspaceLeaf
): WorkspaceLeaf | null => {
const [leafLoc, mainLeavesIds] = getLeafLoc(leaf);
const getMostRecentOrAvailableLeafInMainWorkspace = (inDifferentTabGroup?: boolean):WorkspaceLeaf => {
let mainLeaf = app.workspace.getMostRecentLeaf();
if(mainLeaf && mainLeaf !== leaf && mainLeaf.view?.containerEl.ownerDocument === document) {
//Found a leaf in the main workspace that is not the originating leaf
return mainLeaf;
}
//Iterate all leaves in the main workspace and find the first one that is not the originating leaf
mainLeaf = null;
mainLeavesIds
.forEach((id:any)=> {
const l = app.workspace.getLeafById(id);
if(mainLeaf ||
!l.view?.navigation ||
leaf === l ||
//@ts-ignore
(inDifferentTabGroup && (l?.parent === leaf?.parent))
) return;
mainLeaf = l;
})
return mainLeaf;
}
//1 - In Main Workspace
if(plugin.settings.openInMainWorkspace || ["main","left","right"].contains(leafLoc)) {
//1.1 - Create new leaf in main workspace
if(!plugin.settings.openInAdjacentPane) {
if(leafLoc === "main") {
return app.workspace.createLeafBySplit(leaf);
}
const ml = getMostRecentOrAvailableLeafInMainWorkspace();
return ml
? (ml.view.getViewType() === "empty" ? ml : app.workspace.createLeafBySplit(ml))
: app.workspace.getLeaf(true);
}
//1.2 - Reuse leaf if it is adjacent
const ml = getMostRecentOrAvailableLeafInMainWorkspace(true);
return ml ?? app.workspace.createLeafBySplit(leaf); //app.workspace.getLeaf(true);
}
//2
if(!plugin.settings.openInAdjacentPane) {
return app.workspace.createLeafBySplit(leaf);
}
//3
if(leafLoc === "hover") {
const leaves = new Set<WorkspaceLeaf>();
app.workspace.iterateAllLeaves(l=>{
//@ts-ignore
if(l!==leaf && leaf.containerEl.parentElement === l.containerEl.parentElement) leaves.add(l);
})
if(leaves.size === 0) {
return plugin.app.workspace.createLeafBySplit(leaf);
}
return Array.from(leaves)[0];
}
//4
if(leafLoc === "popout") {
const popoutLeaves = new Set<WorkspaceLeaf>();
app.workspace.iterateAllLeaves(l=>{
if(l !== leaf && l.view.navigation && l.view.containerEl.ownerDocument === leaf.view.containerEl.ownerDocument) {
popoutLeaves.add(l);
}
});
if(popoutLeaves.size === 0) {
return app.workspace.createLeafBySplit(leaf);
}
return Array.from(popoutLeaves)[0];
}
return plugin.app.workspace.createLeafBySplit(leaf);
};
export const getAttachmentsFolderAndFilePath = async (
app: App,
activeViewFilePath: string,
newFileName: string
): Promise<{ folder: string; filepath: string; }> => {
let folder = app.vault.getConfig("attachmentFolderPath");
// folder == null: save to vault root
// folder == "./" save to same folder as current file
// folder == "folder" save to specific folder in vault
// folder == "./folder" save to specific subfolder of current active folder
if (folder && folder.startsWith("./")) {
// folder relative to current file
const activeFileFolder = `${splitFolderAndFilename(activeViewFilePath).folderpath}/`;
folder = normalizePath(activeFileFolder + folder.substring(2));
}
if (!folder || folder === "/") {
folder = "";
}
await checkAndCreateFolder(folder);
return {
folder,
filepath: normalizePath(
folder === "" ? newFileName : `${folder}/${newFileName}`
),
};
};
export const isObsidianThemeDark = () => document.body.classList.contains("theme-dark");
export type ConstructableWorkspaceSplit = new (ws: Workspace, dir: "horizontal"|"vertical") => WorkspaceSplit;
export const getContainerForDocument = (doc:Document) => {
if (doc !== document && app.workspace.floatingSplit) {
for (const container of app.workspace.floatingSplit.children) {
if (container.doc === doc) return container;
}
}
return app.workspace.rootSplit;
};
export const cleanSectionHeading = (heading:string) => {
if(!heading) return heading;
return heading.replace(REG_SECTION_REF_CLEAN, "").replace(/\s+/g, " ").trim();
}
export const cleanBlockRef = (blockRef:string) => {
if(!blockRef) return blockRef;
return blockRef.replace(REG_BLOCK_REF_CLEAN, "").replace(/\s+/g, " ").trim();
}
//needed for backward compatibility
export const legacyCleanBlockRef = (blockRef:string) => {
if(!blockRef) return blockRef;
return blockRef.replace(/[!"#$%&()*+,.:;<=>?@^`{|}~\/\[\]\\]/g, "").replace(/\s+/g, " ").trim();
}
export const getAllWindowDocuments = (app:App):Document[] => {
const documents = new Set<Document>();
documents.add(document);
app.workspace.iterateAllLeaves(l=>{
if(l.view.containerEl.ownerDocument !== document) {
documents.add(l.view.containerEl.ownerDocument);
}
});
return Array.from(documents);
}
export const obsidianPDFQuoteWithRef = (text:string):{quote: string, link: string} => {
const reg = /^> (.*)\n\n\[\[([^|\]]*)\|[^\]]*]]$/gm;
const match = reg.exec(text);
if(match) {
return {quote: match[1], link: match[2]};
}
return null;
}