ethanolivertroy_obsidian-markitdown/main.ts

import { Notice, Plugin, TFile, MarkdownView, MarkdownFileInfo, Editor } from 'obsidian';
import * as path from 'path';
import * as fs from 'fs';
import {
	MarkitdownSettings,
	DEFAULT_SETTINGS,
	ConversionOptions,
	ConversionResult,
	ConversionLogEntry,
	DependencyStatus,
	PluginArgEntry,
	TriedPath,
} from './src/types/settings';
import { MarkitdownConverter } from './src/converter/MarkitdownConverter';
import { checkDependencies, installPackage } from './src/utils/python';
import {
	getVaultBasePath,
	resolveOutputFolder,
	resolveFilenameTemplate,
	resolveImageDir,
	toVaultRelative,
} from './src/utils/paths';
import { isConvertible } from './src/utils/fileTypes';
import { addHistoryEntry } from './src/utils/history';
import { ensurePythonScripts } from './src/utils/bundledScripts';
import { SettingsTab } from './src/settings/SettingsTab';
import { FileConvertModal } from './src/modals/FileConvertModal';
import { FolderConvertModal } from './src/modals/FolderConvertModal';
import { UrlConvertModal } from './src/modals/UrlConvertModal';
import { HistoryModal } from './src/modals/HistoryModal';
import { SetupModal } from './src/modals/SetupModal';

export default class MarkitdownPlugin extends Plugin {
	settings: MarkitdownSettings = DEFAULT_SETTINGS;
	dependencyStatus: DependencyStatus = {
		pythonInstalled: false,
		pythonVersion: null,
		markitdownInstalled: false,
		markitdownVersion: null,
	};
	converter: MarkitdownConverter = new MarkitdownConverter('python', '.');
	pythonDiscoveryLog: TriedPath[] = [];
	private _resolvedPythonPath = 'python';

	/** The Python path actually used after discovery/fallback resolution. */
	get resolvedPythonPath(): string {
		return this._resolvedPythonPath;
	}

	async onload() {
		await this.loadSettings();

		const pluginDir = this.getPluginDir();

		// Ensure bundled Python scripts exist on disk (community plugin installs
		// only include main.js, manifest.json, and styles.css — no python/ dir)
		await ensurePythonScripts(pluginDir);

		const depCheck = await checkDependencies(this.settings.pythonPath, pluginDir);
		this.dependencyStatus = depCheck.status;
		this.pythonDiscoveryLog = depCheck.triedPaths;
		// Use the resolved python path (handles python→python3 fallback)
		this._resolvedPythonPath = depCheck.resolvedPythonPath;
		this.converter = new MarkitdownConverter(this.resolvedPythonPath, pluginDir);

		// Ribbon icon
		this.addRibbonIcon('file-text', 'Convert to Markdown', () => {
			this.openConvertModal();
		});

		// Commands
		this.addCommand({
			id: 'convert-file',
			name: 'Convert file to Markdown',
			callback: () => this.openConvertModal(),
		});

		this.addCommand({
			id: 'convert-folder',
			name: 'Convert folder to Markdown',
			callback: () => this.openFolderModal(),
		});

		this.addCommand({
			id: 'convert-url',
			name: 'Convert URL to Markdown',
			callback: () => this.openUrlModal(),
		});

		this.addCommand({
			id: 'view-conversion-history',
			name: 'View conversion history',
			callback: () => new HistoryModal(this.app, this).open(),
		});

		// Context menu
		if (this.settings.enableContextMenu) {
			this.registerFileMenu();
		}

		// Drag-and-drop conversion
		if (this.settings.enableDragDrop) {
			this.registerDropHandler();
		}

		// Settings tab
		this.addSettingTab(new SettingsTab(this.app, this));
	}

	onunload() {
		// registerEvent handles cleanup automatically
	}

	/** Open file conversion modal, or setup modal if not installed. */
	private openConvertModal() {
		if (!this.dependencyStatus.markitdownInstalled) {
			new SetupModal(this.app, this).open();
			return;
		}
		new FileConvertModal(this.app, this).open();
	}

	/** Open folder conversion modal, or setup modal if not installed. */
	private openFolderModal() {
		if (!this.dependencyStatus.markitdownInstalled) {
			new SetupModal(this.app, this).open();
			return;
		}
		new FolderConvertModal(this.app, this).open();
	}

	/** Open URL conversion modal, or setup modal if not installed. */
	private openUrlModal() {
		if (!this.dependencyStatus.markitdownInstalled) {
			new SetupModal(this.app, this).open();
			return;
		}
		new UrlConvertModal(this.app, this).open();
	}

	/** Register right-click context menu on supported file types. */
	private registerFileMenu() {
		this.registerEvent(
			this.app.workspace.on('file-menu', (menu, file) => {
				if (!(file instanceof TFile)) return;
				if (!isConvertible(file.extension)) return;

				menu.addItem((item) => {
					item.setTitle('Convert to Markdown')
						.setIcon('file-text')
						.onClick(() => this.convertVaultFile(file));
				});
			})
		);
	}

	/** Register drag-and-drop handler for converting dropped files. */
	private registerDropHandler() {
		this.registerEvent(
			this.app.workspace.on('editor-drop', (evt: DragEvent, editor: Editor, info: MarkdownView | MarkdownFileInfo) => {
				const files = evt.dataTransfer?.files;
				if (!files || files.length === 0) return;

				// Check if any dropped file is convertible
				const convertibleFiles: File[] = [];
				for (let i = 0; i < files.length; i++) {
					const file = files[i];
					const ext = path.extname(file.name).toLowerCase().replace(/^\./, '');
					if (isConvertible(ext)) {
						convertibleFiles.push(file);
					}
				}

				if (convertibleFiles.length === 0) return;

				// Intercept the event for convertible files
				evt.preventDefault();

				// Process each convertible file asynchronously
				for (const file of convertibleFiles) {
					this.handleDroppedFile(file, editor).catch((error) => {
						const msg = error instanceof Error ? error.message : String(error);
						new Notice(`Drop conversion error: ${msg}`);
					});
				}
			})
		);
	}

	/** Handle a single dropped file: write to temp, convert, insert link, clean up. */
	private async handleDroppedFile(file: File, editor: Editor): Promise<void> {
		const vaultPath = getVaultBasePath(this.app);
		if (!vaultPath) {
			new Notice('Could not determine vault path. This plugin requires a local vault.');
			return;
		}

		if (!this.dependencyStatus.markitdownInstalled) {
			new SetupModal(this.app, this).open();
			return;
		}

		new Notice(`Converting dropped file: ${file.name}...`);

		const outputFolder = resolveOutputFolder(vaultPath, this.settings.outputPath);
		const baseName = path.basename(file.name, path.extname(file.name));
		const outputPath = path.join(outputFolder, `${baseName}.md`);

		// Write the DOM File to a temp file on disk
		const safeName = file.name.replace(/[^a-zA-Z0-9._-]/g, '_');
		const tempFilePath = path.join(outputFolder, `tmp_${Date.now()}_${safeName}`);
		const buffer = await file.arrayBuffer();
		await fs.promises.writeFile(tempFilePath, Buffer.from(buffer));

		try {
			const result = await this.convertExternalFile(tempFilePath, outputPath);

			if (result.success) {
				const relativePath = toVaultRelative(outputPath, vaultPath);
				const linkText = `[[${relativePath.replace(/\.md$/, '')}]]`;
				const cursor = editor.getCursor();
				editor.replaceRange(linkText, cursor);

				const msg = result.imagesExtracted
					? `Converted ${file.name} (${result.imagesExtracted} images extracted)`
					: `Converted ${file.name} successfully`;
				new Notice(msg);
			} else {
				new Notice(`Conversion failed for ${file.name}: ${result.error}`);
			}
		} finally {
			// Clean up temp file
			await fs.promises.unlink(tempFilePath).catch(() => {});
		}
	}

	/** Convert a file that already exists in the vault (from context menu). */
	async convertVaultFile(file: TFile): Promise<void> {
		const vaultPath = getVaultBasePath(this.app);
		if (!vaultPath) {
			new Notice('Could not determine vault path. This plugin requires a local vault.');
			return;
		}

		if (!this.dependencyStatus.markitdownInstalled) {
			new SetupModal(this.app, this).open();
			return;
		}

		const inputPath = path.join(vaultPath, file.path);
		const outputFolder = resolveOutputFolder(vaultPath, this.settings.outputPath);
		const resolvedName = resolveFilenameTemplate(
			this.settings.outputFilenameTemplate || '{filename}',
			inputPath
		);
		const outputPath = path.join(outputFolder, `${resolvedName}.md`);
		const options = this.buildConversionOptions(outputPath, inputPath);

		new Notice('Converting file...');
		const startTime = Date.now();
		const result = await this.converter.convert(inputPath, outputPath, options);
		const elapsed = Date.now() - startTime;

		addHistoryEntry(this.settings, {
			inputFile: inputPath,
			outputFile: outputPath,
			timestamp: new Date().toISOString(),
			success: result.success,
			error: result.error,
			processingTimeMs: elapsed,
			imagesExtracted: result.imagesExtracted,
		});
		await this.saveSettings();

		if (result.success) {
			const msg = result.imagesExtracted
				? `Converted successfully (${result.imagesExtracted} images extracted)`
				: 'Converted successfully';
			new Notice(msg);
			await this.openConvertedFile(outputPath, vaultPath);
		} else {
			new Notice(`Conversion failed: ${result.error}`);
		}
	}

	/**
	 * Convert an external file (from file input dialog, not in vault).
	 * Used by FileConvertModal and FolderConvertModal.
	 */
	async convertExternalFile(
		inputPath: string,
		outputPath: string
	): Promise<ConversionResult> {
		const options = this.buildConversionOptions(outputPath, inputPath);
		const startTime = Date.now();
		const result = await this.converter.convert(inputPath, outputPath, options);
		const elapsed = Date.now() - startTime;

		addHistoryEntry(this.settings, {
			inputFile: inputPath,
			outputFile: outputPath,
			timestamp: new Date().toISOString(),
			success: result.success,
			error: result.error,
			processingTimeMs: elapsed,
			imagesExtracted: result.imagesExtracted,
		});
		await this.saveSettings();

		return result;
	}

	/** Build ConversionOptions from current settings. */
	buildConversionOptions(outputPath: string, inputPath?: string): ConversionOptions {
		const options: ConversionOptions = {
			enablePlugins: this.settings.enablePlugins,
			docintelEndpoint: this.settings.docintelEndpoint || undefined,
		};

		if (this.settings.pluginArgs.length > 0) {
			options.pluginArgs = this.pluginArgsToRecord(this.settings.pluginArgs);
		}

		if (this.settings.imageExtractionEnabled) {
			options.extractImages = true;
			options.imageDir = resolveImageDir(
				outputPath,
				this.settings.imageSubfolderTemplate
			);
		}

		// Attach post-processing settings when hooks are enabled
		if (inputPath && (this.settings.enableAutoFrontmatter || this.settings.autoTags.trim())) {
			options.postProcess = {
				settings: this.settings,
				inputPath,
			};
		}

		return options;
	}

	/** Convert PluginArgEntry[] to Record for Python. */
	private pluginArgsToRecord(entries: PluginArgEntry[]): Record<string, unknown> {
		const record: Record<string, unknown> = Object.create(null);
		for (const entry of entries) {
			if (!entry.key.trim()) continue;
			// Reject prototype pollution keys
			if (entry.key === '__proto__' || entry.key === 'constructor' || entry.key === 'prototype') continue;
			// Try to parse as JSON value, fall back to string
			try {
				record[entry.key] = JSON.parse(entry.value);
			} catch {
				record[entry.key] = entry.value;
			}
		}
		return record;
	}

	/** Open a converted file in the workspace. */
	async openConvertedFile(outputPath: string, vaultPath: string): Promise<void> {
		const relativePath = toVaultRelative(outputPath, vaultPath);
		const existingFile = this.app.vault.getAbstractFileByPath(relativePath);
		if (existingFile instanceof TFile) {
			await this.app.workspace.getLeaf().openFile(existingFile);
		}
	}

	/** Get the absolute path to the plugin directory. */
	getPluginDir(): string {
		const vaultPath = getVaultBasePath(this.app);
		if (vaultPath && this.manifest.dir) {
			return path.join(vaultPath, this.manifest.dir);
		}
		// Non-local vaults (e.g., Obsidian Sync without local adapter) cannot resolve plugin dir
		console.warn('markitdown: Could not resolve vault base path. Plugin features may not work correctly.');
		return path.resolve(this.manifest.dir ?? '.');
	}

	/** Install markitdown package using the resolved Python path. */
	async installMarkitdown(onProgress?: (line: string) => void): Promise<boolean> {
		const pluginDir = this.getPluginDir();
		const success = await installPackage(
			this._resolvedPythonPath,
			pluginDir,
			'markitdown[all]',
			onProgress
		);
		if (success) {
			this.dependencyStatus.markitdownInstalled = true;
		}
		return success;
	}

	/** Refresh dependency status and resolved Python path. */
	async refreshDependencies(): Promise<void> {
		const pluginDir = this.getPluginDir();
		const depCheck = await checkDependencies(this.settings.pythonPath, pluginDir);
		this.dependencyStatus = depCheck.status;
		this.pythonDiscoveryLog = depCheck.triedPaths;
		this._resolvedPythonPath = depCheck.resolvedPythonPath;
		this.converter = new MarkitdownConverter(this.resolvedPythonPath, pluginDir);
	}

	async loadSettings() {
		this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
	}

	async saveSettings() {
		await this.saveData(this.settings);
	}
}