Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 | // Note: MetadataCache class import { App, CachedMetadata, TFile } from 'obsidian'; import type { ILogger, ILogger_ } from 'src/interfaces/ILogger'; import IMetadataCache from 'src/interfaces/IMetadataCache'; import { IMetadataCacheEvents } from 'src/interfaces/IMetadataCacheEvents'; import { FileType } from 'src/libs/FileType/FileType'; import type { IPrjSettings } from 'src/types/PrjSettings'; import { Inject } from './DependencyInjection/decorators/Inject'; import { RegisterInstance } from './DependencyInjection/decorators/RegisterInstance'; import GenericEvents, { IEvent } from './GenericEvents'; import { Lifecycle } from './LifecycleManager/decorators/Lifecycle'; /** * FileMetadata interface * @description This interface is used to store the file and the cached metadata in the metadata cache. * @property {TFile} file The file object * @property {CachedMetadata} metadata The cached metadata */ export class FileMetadata { file: TFile; metadata: CachedMetadata; } /** * Singleton class for caching metadata * @description This class is used to cache metadata for all files in the vault. It is used to speed up processing of dataview queries. */ @RegisterInstance('IMetadataCache') @Lifecycle('Instance') export default class MetadataCache implements IMetadataCache { private readonly _eventHandler: GenericEvents<IMetadataCacheEvents>; @Inject('IApp') private readonly _IApp!: App; @Inject('IPrjSettings') private readonly _settings!: IPrjSettings; @Inject('ILogger_', (x: ILogger_) => x.getLogger('MetadataCache'), false) private readonly _logger?: ILogger; private readonly _metadataCachePromise: Promise<void> | undefined = undefined; private _metadataCache: Map<string, FileMetadata> | undefined = undefined; private _metadataCacheArray: FileMetadata[] | undefined = undefined; private _isMetadataCacheReady = false; private _hasEventsRegistered = false; static instance: MetadataCache; /** * Get the metadata cache * @description This method returns the metadata cache as an array of FileMetadata objects. The FileMetadata object contains the file and the cached metadata. * @remarks - The reference of the array is returned and will be the same on every call. * - If the cache is updated, the array is emptied and repopulated with the current values from the metadata cache. * - You can use the array permanently, but you should not rely on the order of the entries. */ public get cache(): FileMetadata[] { if (this._isMetadataCacheReady && this._metadataCache) { if (this._metadataCacheArray) return this._metadataCacheArray; else { this._metadataCacheArray = Array.from( this._metadataCache.values(), ); return this._metadataCacheArray; } } else { this._logger?.error('Metadata cache not initialized'); return []; } } /** * Get the singleton instance of the MetadataCache class * @returns The MetadataCache instance */ static getInstance(): IMetadataCache { Iif (!MetadataCache.instance) { MetadataCache.instance = new MetadataCache(); } return MetadataCache.instance; } /** * Constructor for the MetadataCache class * @description This constructor is private because the MetadataCache class is a singleton. Use the getInstance() method to get the singleton instance. */ constructor() { if (MetadataCache.instance) { return MetadataCache.instance; } else { MetadataCache.instance = this; this.onUnload = this.onUnload.bind(this); this.changedEventHandler = this.changedEventHandler.bind(this); this.renameEventHandler = this.renameEventHandler.bind(this); this.deleteEventHandler = this.deleteEventHandler.bind(this); this._eventHandler = new GenericEvents<IMetadataCacheEvents>( this._logger, ); Iif (!this._metadataCache) { this.buildMetadataCache().then(() => { this._logger?.debug('Metadata cache built'); this.registerEvents(); }); } } } /** * Deconstructor for the MetadataCache class * @description This method is used to unregister the event handlers for the metadata cache. */ public onUnload(): void { Iif (this._hasEventsRegistered) { this._IApp.vault.off('rename', this.renameEventHandler); this._IApp.metadataCache.off('changed', this.changedEventHandler); this._IApp.metadataCache.off('deleted', this.deleteEventHandler); this._hasEventsRegistered = false; this._logger?.debug('Metadata cache events unregistered'); return; } this._logger?.debug('Metadata cache events not registered'); } /** * Check if the metadata cache is ready * @returns True if the metadata cache is ready, false otherwise */ public isCacheReady(): boolean { return this._isMetadataCacheReady; } /** * Wait for the metadata cache to be ready * @returns Promise that resolves when the metadata cache is ready * @description This method returns a promise that resolves when the metadata cache is ready. */ public async waitForCacheReady(): Promise<void> { while (!this._isMetadataCacheReady) { await new Promise((resolve) => setTimeout(resolve, 5)); } } /** * Register an event listener for the metadata cache. The event is emitted when the status of a plugin file is changed. * @param eventName The name of the event: `prj-task-management-changed-status` * @param listener The listener function. The listener function receives the file object as an argument. */ public on( eventName: 'prj-task-management-changed-status-event', listener: (file: TFile) => void, ): void; /** * Register an event listener for the metadata cache. The event is emitted when the metadata of a document is changed. * @param eventName The name of the event: `document-changed-metadata` * @param listener The listener function. The listener function receives the file object as an argument. */ public on( eventName: 'document-changed-metadata-event', listener: (file: TFile) => void, ): void; /** * Register an event listener for the metadata cache. The event is emitted when the metadata of a plugin file is changed. * @param eventName The name of the event: `prj-task-management-file-changed` * @param listener The listener function. The listener function receives the file object as an argument. */ public on( eventName: 'prj-task-management-file-changed-event', listener: (file: TFile) => void, ): void; /** * Register an event listener for the metadata cache. The event is emitted when a kanban file is changed. * @param eventName The name of the event: `changes-in-kanban-event` * @param listener The listener function. The listener function receives the file object as an argument. */ public on( eventName: 'changes-in-kanban-event', listener: (file: TFile) => void, ): void; /** * Register an event listener for the metadata cache. The event is emitted when a file is renamed or moved. * @param eventName The name of the event: `file-rename-event` * @param listener The listener function. The listener function receives `{oldPath: string, newPath: string}` as an argument. */ public on( eventName: 'file-rename-event', listener: (file: { oldPath: string; newPath: string }) => void, ): void; /** * Register an event listener for the metadata cache. * @param eventName The name of the event * @param listener The listener function. The listener function receives the file object as an argument. */ public on<K extends keyof IMetadataCacheEvents['events']>( eventName: K, // eslint-disable-next-line @typescript-eslint/no-explicit-any listener: ( file: IMetadataCacheEvents['events'][K]['data'], // eslint-disable-next-line @typescript-eslint/no-explicit-any ) => IMetadataCacheEvents['events'][K] extends IEvent< // eslint-disable-next-line @typescript-eslint/no-explicit-any any, infer TReturn > ? TReturn : void, ): void { // eslint-disable-next-line @typescript-eslint/no-explicit-any this._eventHandler.registerEvent(eventName, listener as any); } /** * Deregister an event listener for the metadata cache. * @param eventName The name of the event * @param listener The listener function. */ public off<K extends keyof IMetadataCacheEvents['events']>( eventName: K, // eslint-disable-next-line @typescript-eslint/no-explicit-any listener: ( file: IMetadataCacheEvents['events'][K]['data'], // eslint-disable-next-line @typescript-eslint/no-explicit-any ) => IMetadataCacheEvents['events'][K] extends IEvent< // eslint-disable-next-line @typescript-eslint/no-explicit-any any, infer TReturn > ? TReturn : void, ): void { // eslint-disable-next-line @typescript-eslint/no-explicit-any this._eventHandler.deregisterEvent(eventName, listener as any); } /** * Will be called when the metadata of a file is changed. Checks if the file is a plugin file and emits an event if necessary. * @param newMetadata The changed metadata * @param oldMetadata The old metadata * @param file The file object */ private async onChangedMetadata( newMetadata: CachedMetadata, oldMetadata: CachedMetadata, file: TFile, ): Promise<void> { this._logger?.trace( `Metadata changed for file ${file.path} and is processed.`, ); Iif (file.path.startsWith(this._settings.templateFolder)) { this._logger?.trace( `No event emitted for file ${file.path} because it is a template file.`, ); return; } // Check if the file is plugin file Iif ( newMetadata.frontmatter?.type && FileType.validate(newMetadata.frontmatter.type) ) { switch (newMetadata.frontmatter.type) { case 'Topic': case 'Project': case 'Task': // Changed status Iif ( newMetadata.frontmatter?.status !== oldMetadata.frontmatter?.status ) { this._eventHandler.fireEvent( 'prj-task-management-changed-status-event', file, ); } // General file change event this._eventHandler.fireEvent( 'prj-task-management-file-changed-event', file, ); // Changes in Kanban Iif (newMetadata.frontmatter?.subType === 'Kanban') { this._eventHandler.fireEvent( 'changes-in-kanban-event', file, ); } break; case 'Metadata': this._eventHandler.fireEvent( 'document-changed-metadata-event', file, ); break; case 'Note': break; default: this._logger?.error( `Invalid file type ${newMetadata.frontmatter?.type} for file ${file.path}`, ); break; } } } /** * Handles the event when a file is renamed. * @param oldPath The old path of the file. * @param newFile The new file object representing the renamed file. */ private async onRenamedFile( oldPath: string, newFile: TFile, ): Promise<void> { this._logger?.trace( `File renamed from ${oldPath} to ${newFile.path} and is processed.`, ); Iif (newFile.path.startsWith(this._settings.templateFolder)) { this._logger?.trace( `No event emitted for file ${newFile.path} because it is a template file.`, ); return; } this._eventHandler.fireEvent('file-rename-event', { oldPath: oldPath, newPath: newFile.path, }); } /** * Invalidate the metadata cache * @remarks Set the metadata cache array to undefined. */ private invalidateMetadataCacheArray(): void { Iif (this._metadataCacheArray) { if (this._metadataCache) { this._metadataCacheArray = undefined; } else { this._logger?.error('Metadata cache not initialized'); } } } /** * Build the metadata cache * @returns Promise that resolves when the metadata cache is built */ private async buildMetadataCache(): Promise<void> { const startTime = Date.now(); this._metadataCache = new Map<string, FileMetadata>(); const allFiles = this._IApp.vault.getFiles(); const addEntryPromises = allFiles.map((file) => this.addEntry(file)); await Promise.all(addEntryPromises); this._isMetadataCacheReady = true; const endTime = Date.now(); this._logger?.debug( `Metadata cache for ${allFiles.length} files built in ${endTime - startTime}ms`, ); } /** * Get the metadata cache entry for a file. * @param file The file to get from the metadata cache. * @returns The metadata cache entry for the file. * @remarks - This method returns undefined if the metadata cache is not ready. * - As key the file path is used! */ public getEntry(file: TFile): FileMetadata | undefined { if (this._metadataCache) { const metadata = this._metadataCache.get(file.path); if (metadata) { return metadata; } else { this.addEntry(file); const metadata = this._metadataCache.get(file.path); Iif (metadata) { return metadata; } this._logger?.warn( `No metadata cache entry found for file ${file.path}`, ); return undefined; } } else { this._logger?.error('Metadata cache not initialized'); return undefined; } } /** * Get the metadata cache entry for a file path. * @param path The file path to get from the metadata cache. * @returns The metadata cache entry for the file path. * @remarks - This method returns undefined if the metadata cache is not ready or if no entry is found. */ public getEntryByPath(path: string): FileMetadata | undefined { if (this._metadataCache) { const metadata = this._metadataCache.get(path); if (metadata) { return metadata; } else { this._logger?.warn( `No metadata cache entry found for file ${path}`, ); return undefined; } } else { this._logger?.error('Metadata cache not initialized'); return undefined; } } /** * Get the metadata cache entry for a file link. * @param link The file link to get from the metadata cache. * @param path The path of the file where the link is located. * @returns The metadata cache entry for the file link. */ public getEntryByLink(link: string, path = ''): FileMetadata | undefined { const file = this._IApp.metadataCache.getFirstLinkpathDest(link, path); if (file) { return this.getEntry(file); } else { this._logger?.warn(`No file found for link ${link}`); return undefined; } } /** * Get the file object for a file link. * @param link The file link to get the file object for. * @param path The path of the file where the link is located. * @returns The file object for the file link or undefined if no file is found. */ public getFileByLink(link: string, path = ''): TFile | undefined { return ( this._IApp.metadataCache.getFirstLinkpathDest(link, path) ?? undefined ); } /** * Get the backlinks for a file. * @param file The file to get the backlinks for. * @returns Array of files that link to the file. */ public getBacklinks(file: TFile): TFile[] { const filesWithBacklinks: TFile[] = []; for (const [path, fileCache] of Object.entries( this._IApp.metadataCache.resolvedLinks, )) { Iif (fileCache[file.path]) { const file = this.getEntryByPath(path); file && filesWithBacklinks.push(file.file); } } return filesWithBacklinks; } /** * Add a file to the metadata cache * @param file The file to add to the metadata cache */ private async addEntry(file: TFile): Promise<void> { if (this._metadataCache) { const metadata = this._IApp.metadataCache.getFileCache(file); if (metadata) { this._metadataCache.set(file.path, { file, metadata }); this.invalidateMetadataCacheArray(); } else { this._logger?.warn(`No metadata found for file ${file.path}`); } } else { this._logger?.error('Metadata cache not initialized'); } } /** * Delete a file from the metadata cache * @param file The file to delete from the metadata cache */ private deleteEntry(file: TFile): void { if (this._metadataCache) { this._metadataCache.delete(file.path); this.invalidateMetadataCacheArray(); } else { this._logger?.error('Metadata cache not initialized'); } this._logger?.debug( `Metadata cache entry for file ${file.path} deleted`, ); } /** * Update a file in the metadata cache * @param file The file to update in the metadata cache * @param cache The new cached metadata */ private async updateEntry( file: TFile, cache: CachedMetadata, ): Promise<void> { if (this._metadataCache) { const entry = this._metadataCache.get(file.path); if (entry && cache) { const oldMetadata = entry.metadata; entry.metadata = cache; this.invalidateMetadataCacheArray(); this.onChangedMetadata(cache, oldMetadata, file); } else if (!entry) { this._logger?.warn( `No metadata cache entry found for file ${file.path}`, ); } else { this._logger?.warn(`No metadata found for file ${file.path}`); } } else { this._logger?.error('Metadata cache not initialized'); } this._logger?.debug( `Metadata cache entry for file ${file.path} updated`, ); } /** * Rename a file in the metadata cache * @param newFile The new file object * @param oldPath The old path of the file */ private async renameEntry(newFile: TFile, oldPath: string): Promise<void> { if (this._metadataCache) { this._metadataCache.delete(oldPath); this.addEntry(newFile); this.invalidateMetadataCacheArray(); this.onRenamedFile(oldPath, newFile); } else { this._logger?.error('Metadata cache not initialized'); } this._logger?.debug( `Metadata cache entry for file ${oldPath} renamed to ${newFile.path}`, ); } /** * Event handler for the rename event * @param file New file object * @param oldPath Old path of the file */ private renameEventHandler(file: TFile, oldPath: string): void { this._logger?.debug(`File ${oldPath} renamed to ${file.path}`); this.renameEntry(file, oldPath); } /** * Event handler for the delete event * @param file Deleted file object */ private deleteEventHandler(file: TFile): void { this._logger?.debug(`File ${file.path} deleted`); this.deleteEntry(file); } /** * Event handler for the changed event * @param file Changed file object * @param data Changed complete file content * @param cache Cached metadata */ private changedEventHandler( file: TFile, data: string, cache: CachedMetadata, ): void { this._logger?.trace( `File ${file.path} changed. Data-content:`, { data }, 'Cache-metadata:', cache, ); Iif (this._metadataCache) { const existingEntry = this._metadataCache.get(file.path); if (existingEntry) { this.updateEntry(file, cache); } else { this.addEntry(file); } } } /** * Redraw the markdown view * @deprecated This method is deprecated and will be removed in a future version. */ private redrawMarkdownView(): void { this._logger?.debug(`Redrawing markdown view`); this._IApp.workspace.updateOptions(); } /** * Register event handlers for the metadata cache */ private registerEvents(): void { Iif (!this._hasEventsRegistered) { this._IApp.vault.on('rename', this.renameEventHandler); this._IApp.metadataCache.on('changed', this.changedEventHandler); this._IApp.metadataCache.on('deleted', this.deleteEventHandler); this._hasEventsRegistered = true; this._logger?.debug('Metadata cache events registered'); } } } |