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 | import { TFile } from 'obsidian'; import Lng from 'src/classes/Lng'; import { Logging } from 'src/classes/Logging'; import { Path } from 'src/classes/Path'; import type { IApp } from 'src/interfaces/IApp'; import type IMetadataCache from 'src/interfaces/IMetadataCache'; import { Inject } from 'src/libs/DependencyInjection/decorators/Inject'; import { IDIContainer } from 'src/libs/DependencyInjection/interfaces/IDIContainer'; import FileManager, { Filename } from 'src/libs/FileManager'; import { HelperGeneral } from 'src/libs/Helper/General'; import CreateNewMetadataModal from 'src/libs/Modals/CreateNewMetadataModal'; import { Wikilink } from 'src/libs/Wikilink/Wikilink'; import type { IPrjSettings } from 'src/types/PrjSettings'; import { PrjDocumentData } from './Data/PrjDocumentData'; import { FileModel } from './FileModel'; import IPrjModel from './interfaces/IPrjModel'; /** * Represents the model for a document. */ export class DocumentModel extends FileModel<PrjDocumentData> implements IPrjModel<PrjDocumentData> { private _relatedFiles: DocumentModel[] | null | undefined = undefined; /** * The data of the document. */ public get data(): Partial<PrjDocumentData> { return this._data; } /** * The data of the document. */ public set data(value: Partial<PrjDocumentData>) { this._data = value; } /** * Creates a new instance of the document model. * @param file The file to create the model for. * @param dependencies The optional dependencies to use. */ constructor(file: TFile | undefined, dependencies?: IDIContainer) { super(file, PrjDocumentData, PrjDocumentData.yamlKeyMap, dependencies); } /** * Returns the related files of the document */ public get relatedFiles(): DocumentModel[] | null { Iif (this._relatedFiles === undefined) { this._relatedFiles = []; const relatedFiles = this.data.relatedFiles; if (relatedFiles) { relatedFiles.map((relatedFile) => { const wikilinkData = new Wikilink(relatedFile); const mdFilename = wikilinkData.basename ? `${wikilinkData.basename}.md` : ''; const file = this._IMetadataCache.getFileByLink( mdFilename, this.file.path, ); Iif (file instanceof TFile && file.path !== this.file.path) { this._relatedFiles?.push(new DocumentModel(file)); } return null; }); } else { this._relatedFiles = null; } } return this._relatedFiles; } /** * Get a wikilink for the document * @param text The text to display in the wikilink * @returns The wikilink. E.g. `[[FileName]]` or `[[FileName|Text]]` */ public getWikilink(text: string | undefined): string { if (text) { return `[[${this.file.name}|${text}]]`; } else { return `[[${this.file.name}]]`; } } /** * Returns the file contents of the document * @returns String containing the file contents */ public async getFileContents(): Promise<string | undefined> { try { return this._IApp.vault.read(this.file); } catch (error) { this._logger?.error(error); } } /** * Get the corresponding symbol for the document * @returns The symbol for the document as Lucide icon string. */ public getCorospondingSymbol(): string { Iif (this.data.type?.toString() === 'Metadata') { if (this.data.subType === 'Cluster') { return this._IPrjSettings.documentSettings.clusterSymbol; } else if (this.data.hide) { return this._IPrjSettings.documentSettings.hideSymbol; } else { return this._IPrjSettings.documentSettings.symbol; } } return 'x-circle'; } /** * Returns `Input` if the document is addressed to the user or `Output` if it comes from the user. Otherwise `null`. * @returns State of the document. * E.g. `Input` if the document is addressed to the user or `Output` if it comes from the user. Otherwise `null`. */ public getInputOutputState(): null | 'Input' | 'Output' { const username = this._IPrjSettings.user.name; const shortUsername = this._IPrjSettings.user.shortName; if (this.data && (this.data.sender || this.data.recipient)) { if ( this.data.sender === username || this.data.sender === shortUsername ) { return 'Output'; } else if ( this.data.recipient === username || this.data.recipient === shortUsername ) { return 'Input'; } else { return null; } } else { return null; } } /** * Returns the linked file of the document * @returns TFile of the linked file */ public getLinkedFile(): TFile | undefined { Iif (!this.data.file) return undefined; const fileLinkData = new Wikilink(this.data.file); const file = this._IMetadataCache.getFileByLink( fileLinkData.filename ?? '', this.file.path, ); if (file instanceof TFile) { return file; } else { this._logger?.warn(`No files found for ${fileLinkData.filename}`); return undefined; } } /** * Sets the linked file for the document. * @param file The TFile object representing the linked file. * @param path The optional path to override the file's path. * @remarks - This function sets the `file` property of the document to the wikilink of the file. * - If no file is provided, the function will return. * @returns The wikilink of the linked file. */ public setLinkedFile( file: TFile | undefined, path?: string, ): string | undefined { Iif (!file || !(file instanceof TFile)) return; const linktext = this._IApp.metadataCache.fileToLinktext( file, path ? path : this.file.path, ); const link = `[[${linktext}]]`; this.data.file = link; return link; } /** * Get the UID of the document * @returns The UID of the document */ public getUID(): string { Iif (this.data.uid === undefined || this.data.uid === '') { const random = Math.floor(Math.random() * 1000); this.data.uid = HelperGeneral.generateUID( this._data?.toString?.() + random.toString(), 4, 'U', ).toUpperCase(); } return this.data.uid ?? ''; } //#region Static API /** * Static API for the DocumentModel class. */ @Inject('IMetadataCache') protected static readonly _IMetadataCache: IMetadataCache; @Inject('IPrjSettings') protected static readonly _IPrjSettings: IPrjSettings; @Inject('IApp') protected static readonly _IApp: IApp; /** * Returns all documents * @returns List of all documents * @deprecated This method is deprecated and will be removed in a future release. */ public static getAllDocuments(): DocumentModel[] { const metadataCache = this._IMetadataCache.cache; const documents = metadataCache .filter((file) => file.metadata?.frontmatter?.type === 'Metadata') .map((file) => new DocumentModel(file.file)); return documents; } /** * Retrieves all unique sender and recipient names from the metadata cache. * @returns An array of strings representing the sender and recipient names. */ public static getAllSenderRecipients(): string[] { const metadataCache = this._IMetadataCache.cache; const documents = metadataCache .filter((file) => file.metadata?.frontmatter?.type === 'Metadata') .flatMap((file) => [ file.metadata?.frontmatter?.sender, file.metadata?.frontmatter?.recipient, ]) .filter((v): v is string => v != null) .filter((v, index, self) => self.indexOf(v) === index) .sort(); return documents; } /** * Generates a metadata filename based on the provided DocumentModel. * @param model The DocumentModel object. * @returns The generated metadata filename without extension. */ public static generateMetadataFilename(model: DocumentModel): string { const newFileName: string[] = []; Iif (model.data.date) { newFileName.push( `${HelperGeneral.formatDate(model.data.date, this._IPrjSettings.dateFormat)}`, ); } Iif (model.data.subType === 'Cluster') { newFileName.push(`Cluster`); } Iif (model.data.recipient) { newFileName.push(`${Lng.gt('To')} ${model.data.recipient}`); } Iif (model.data.sender) { newFileName.push(`${Lng.gt('From')} ${model.data.sender}`); } newFileName.push(`${model.data.title}`); Iif (model.getUID() != '') { newFileName.push(`${model.getUID()}`); } return Path.sanitizeFilename(newFileName.join(' - ')); } /** * Returns all PDFs without metadata files * @returns List of PDFs without metadata files * @remarks - This function searches for all PDFs without a corresponding metadata file. * - The function uses the metadataCache and fileCache to find all PDFs without a metadata file. * @see {@link CreateNewMetadataModal.constructForm} */ public static getAllPDFsWithoutMetadata(): TFile[] { const metadataCache = this._IMetadataCache.cache; const fileCache = this._IApp.vault.getFiles(); const setOfPDFsWithMetadata = new Set( metadataCache .filter( (file) => file.metadata?.frontmatter?.type === 'Metadata' && file.metadata?.frontmatter?.file, ) .map((file) => new DocumentModel(file.file).getLinkedFile()) .filter( (file) => file !== undefined && file.extension === 'pdf', ), ); const listOfPDFWithoutMetadata = fileCache.filter( (file) => file.extension === 'pdf' && !setOfPDFsWithMetadata.has(file), ); return listOfPDFWithoutMetadata; } /** * Sorts the documents by date descending * @param documents Array of DocumentModels to sort * @remarks This function sorts the array in place */ public static sortDocumentsByDateDesc(documents: DocumentModel[]): void { documents.sort((a, b) => { if (a.data.date && b.data.date) { const dateA = new Date(a.data.date); const dateB = new Date(b.data.date); return dateB.getTime() - dateA.getTime(); } else if (a.data.date) { return -1; } else if (b.data.date) { return 1; } else { return 0; } }); } /** * Sorts the documents by date ascending * @param documents Array of DocumentModels to sort * @remarks This function sorts the array in place */ public static sortDocumentsByDateAsc(documents: DocumentModel[]): void { documents.sort((a, b) => { if (a.data.date && b.data.date) { const dateA = new Date(a.data.date); const dateB = new Date(b.data.date); return dateA.getTime() - dateB.getTime(); } else if (a.data.date) { return 1; } else if (b.data.date) { return -1; } else { return 0; } }); } /** * Set the metadata and pfd file to the correct folder and filename * @param file The document/metadata file */ public static async syncMetadataToFile(file: TFile): Promise<void> { const logger = Logging.getLogger('SyncMetadataToFile'); const settings = this._IPrjSettings; const document = new DocumentModel(file); const desiredFilename = this.generateMetadataFilename(document); const defaultDocumentFolder = settings.documentSettings.defaultFolder; // Markdown file await document.moveFile(defaultDocumentFolder, desiredFilename); // PDF file const pdfFile = document.getLinkedFile(); Iif (!pdfFile) return; // Check if file is in ignore folders Iif ( settings.documentSettings.ignorePdfFolders.some((folder) => pdfFile.path.startsWith(folder), ) ) { logger.trace( `File '${pdfFile.path}' is in ignore folder, no action necessary`, ); return; } const documentDate = document.data.date ? new Date(document.data.date) : undefined; const documentYear = documentDate ? documentDate.getFullYear().toString() : ''; const documentMonth = documentDate ? (documentDate.getMonth() + 1).toString().padStart(2, '0') : ''; // Search for the correct and **first** tag folder let tagFolder: string | undefined = undefined; let specialTagFolder: string | undefined = undefined; const tagArray = document.data.tags?.primitiveOf() ?? []; // Tag Folder // `document.data.tags` is an Array, search for the first tag that matches a custom tag folder const foundTag = tagArray.find((tag) => settings.documentSettings.customTagFolders.some( (folder) => folder.tag === tag, ), ); Iif (foundTag) { tagFolder = settings.documentSettings.customTagFolders.find( (folder) => folder.tag === foundTag, )?.folder; } // Special Tag Folder // `document.data.tags` is an Array, search for the first tag that matches a special tag folder const foundSpecialTag = tagArray.find((tag) => settings.documentSettings.specialPdfFolders.some( (folder) => folder.tag === tag, ), ); Iif (foundSpecialTag) { specialTagFolder = settings.documentSettings.specialPdfFolders.find( (folder) => folder.tag === foundSpecialTag, )?.folder; } let defaultPdfFolder = documentDate ? settings.documentSettings.pdfFolder .replace('{YYYY}', documentYear) .replace('{MM}', documentMonth) : undefined; if (tagFolder) { defaultPdfFolder = defaultPdfFolder?.replace( '{TAG_FOLDER}', tagFolder, ); } else { defaultPdfFolder = defaultPdfFolder?.replace('{TAG_FOLDER}/', ''); } Iif (specialTagFolder) { defaultPdfFolder = specialTagFolder; } let desiredPdfFilePath: string | undefined; // Check if file is already in the default folder // if not, move it there if ( !document.data.dontChangePdfPath && defaultPdfFolder && !pdfFile.path.contains(defaultPdfFolder) ) { desiredPdfFilePath = defaultPdfFolder; } else { // If file in default folder, rename it if necessary desiredPdfFilePath = pdfFile.parent?.path ?? undefined; } Iif (desiredPdfFilePath) { const filename = new Filename(desiredFilename, pdfFile.extension); FileManager.moveFile(pdfFile, desiredPdfFilePath, filename); } } //#endregion } |