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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 180x 900x 900x 661x 661x 661x 900x 900x 900x 180x 180x 180x 180x 180x 180x 7x 7x 7x 7x 7x 180x 180x 14x 14x 14x 14x 31x 31x 31x 31x 31x 31x 31x 31x 31x 10x 10x 10x 10x 10x 14x 14x 14x 180x 180x 180x 180x 180x 180x 12x 12x 12x 11x 13x 11x 11x 11x 180x 180x 180x 180x 180x 180x 180x 44x 44x 6x 6x 38x 38x 38x 38x 44x 23x 23x 38x 38x 38x 38x 38x 38x 38x 38x 38x 44x 59x 59x 19x 19x 19x 19x 17x 19x 2x 2x 1x 19x 58x 59x 40x 40x 40x 40x 59x 37x 37x 37x 180x 180x 180x 180x 180x 180x 180x 180x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 2x 180x 180x 180x 180x 180x 180x 180x 180x 180x 32x 32x 32x 32x 31x 31x 31x 180x 180x 180x 180x 180x 180x 180x 32x 32x 32x 32x 31x 31x 31x 31x 31x 31x 31x 32x 6x 6x 1x 1x 1x 1x 1x 6x 6x 6x 25x 32x 6x 6x 19x 19x 19x 180x 180x 180x 180x 180x 180x 180x 180x 4x 4x 4x 4x 4x 4x 4x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 180x 180x 180x 180x 180x 180x 180x 2x 2x 2x 180x 180x 180x 180x 180x 180x 180x 180x 32x 32x 32x 32x 32x 180x 180x 180x 180x 180x 180x 180x 180x 180x 20x 20x 20x 4x 4x 2x 2x 2x 2x 2x 2x 2x 18x 18x 18x 18x 18x 18x 18x 180x 180x 180x 180x 180x 180x 180x 6x 6x 6x 6x 180x 180x 180x 180x 180x 180x 180x 180x 54x 54x 54x 54x 54x 54x 54x 7x 7x 47x 47x 47x 47x 45x 45x 45x 5x 5x 40x 40x 40x 47x 47x 54x 3x 3x 3x 44x 54x 1x 1x 1x 1x 43x 43x 43x 43x 180x 180x 180x 180x 180x 180x 9x 9x 9x 1x 1x 1x 1x 7x 9x 1x 1x 1x 1x 6x 6x 6x 6x 6x 6x 6x 6x 6x 9x 4x 4x 9x 180x 180x 180x 180x 180x 180x 180x 180x 4x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 2x 2x 2x 2x 2x 4x 4x 180x 180x 180x 180x 180x 180x 6x 6x 6x 6x 1x 1x 1x 5x 5x 5x 5x 6x 1x 1x 1x 1x 4x 4x 6x 1x 1x 1x 3x 3x 3x 3x 3x 180x 180x 180x 180x 180x 180x 1x 1x 1x 1x 1x 1x 180x 180x 180x 180x 180x 180x 1x 1x 1x 1x 1x 1x 180x 180x 180x 180x 180x 180x 180x 180x 5x 5x 5x 5x 1x 1x 1x 4x 4x 4x 5x 1x 1x 1x 3x 5x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 5x 1x 1x 2x 2x 2x 2x 2x 180x 180x 180x 180x 180x 3x 3x 3x 4x 4x 4x 4x 4x 6x 6x 6x 4x 4x 4x 4x 4x 4x 3x 180x | import * as path from 'path';
import * as PHOTOS_LIBRARY from './constants.js';
import {Album, AlbumType} from './model/album.js';
import fs from 'fs';
import {Asset} from './model/asset.js';
import {PLibraryEntities} from './model/photos-entity.js';
import {getLogger} from '../logger.js';
import {AxiosResponse} from 'axios';
import {pEvent} from 'p-event';
import {iCloudApp} from '../../app/icloud-app.js';
import {iCPSError} from '../../app/error/error.js';
import EventEmitter from 'events';
import {HANDLER_EVENT} from '../../app/event/error-handler.js';
import {LIBRARY_ERR} from '../../app/error/error-codes.js';
import {Zones} from '../icloud/icloud-photos/query-builder.js';
export type PathTuple = [namePath: string, uuidPath: string]
/**
* This class holds the local data structure
*/
export class PhotosLibrary extends EventEmitter {
/**
* Default logger for the class
*/
private logger = getLogger(this);
/**
* The full path to the data dir, where all information & data is persisted
*/
photoDataDir: string;
/**
* The full path to the sub-dirs within 'photoDataDir', containing all assets from the primary library
*/
primaryAssetDir: string;
/**
* The full path to the sub-dirs within 'photoDataDir', containing all assets from the shared library
*/
sharedAssetDir: string;
/**
* The full path to the sub-dir within 'photoDataDir', containing all archived folders, who have been deleted on the backend
*/
archiveDir: string;
/**
* The full path to the sub-dir within 'archiveDir', containing temporarily stashed albums
*/
stashDir: string;
/**
* Creates the local PhotoLibrary, based on the provided CLI options
* @param app - The app object holding CLI options
*/
constructor(app: iCloudApp) {
super();
this.photoDataDir = this.getFullPathAndCreate([app.options.dataDir]);
this.primaryAssetDir = this.getFullPathAndCreate([PHOTOS_LIBRARY.PRIMARY_ASSET_DIR]);
this.sharedAssetDir = this.getFullPathAndCreate([PHOTOS_LIBRARY.SHARED_ASSET_DIR]);
this.archiveDir = this.getFullPathAndCreate([PHOTOS_LIBRARY.ARCHIVE_DIR]);
this.stashDir = this.getFullPathAndCreate([PHOTOS_LIBRARY.ARCHIVE_DIR, PHOTOS_LIBRARY.STASH_DIR]);
}
/**
* Joins the subpaths & photosDataDir together (if photosDataDir is set) and creates the folder if it does not exist
* @param subpaths - An array of subpaths
* @returns The full path
*/
getFullPathAndCreate(subpaths: string[]) {
const thisDir = this.photoDataDir ? path.join(this.photoDataDir, ...subpaths) : path.join(...subpaths);
if (!fs.existsSync(thisDir)) {
this.logger.debug(`${thisDir} does not exist, creating`);
fs.mkdirSync(thisDir, {"recursive": true});
}
return thisDir;
}
/**
* Loads all assets from disk
* @returns A structured list of assets, as they are currently present on disk
*/
async loadAssets(): Promise<PLibraryEntities<Asset>> {
return {
...await this.loadAssetsForZone(Zones.Primary),
...await this.loadAssetsForZone(Zones.Shared),
};
}
async loadAssetsForZone(zone: Zones): Promise<PLibraryEntities<Asset>> {
const libAssets: PLibraryEntities<Asset> = {};
const zonePath = zone === Zones.Primary ? this.primaryAssetDir : this.sharedAssetDir;
(await fs.promises.readdir(zonePath))
.forEach(fileName => {
try {
const fileStat = fs.statSync(path.format({
"dir": zonePath,
"base": fileName,
}));
const asset = Asset.fromFile(fileName, fileStat, zone);
libAssets[asset.getUUID()] = asset;
this.logger.debug(`Loaded asset ${asset.getDisplayName()}`);
} catch (err) {
this.emit(HANDLER_EVENT, new iCPSError(LIBRARY_ERR.INVALID_FILE)
.setWarning()
.addMessage(fileName)
.addCause(err));
}
});
return libAssets;
}
/**
* Recursively loads all albums from disk
* @returns A structured list of albums, as they are currently present on disk
*/
async loadAlbums(): Promise<PLibraryEntities<Album>> {
// Loading folders
const libAlbums: PLibraryEntities<Album> = {};
(await this.loadAlbum(Album.getRootAlbum(), this.photoDataDir))
.forEach(album => {
libAlbums[album.getUUID()] = album;
});
return libAlbums;
}
/**
* Loads the content of a given album from disc (and recursively does that for all child items)
* @param album - The album that needs to be loaded, containing a filepath
* @returns An array of loaded albums, including the provided one and all its child items
*/
async loadAlbum(album: Album, albumPath: string): Promise<Album[]> {
// If we are loading an archived folder, we can ignore the content and add it to the queue
if (album.albumType === AlbumType.ARCHIVED) {
return [album];
}
const albums: Album[] = [];
// Not adding dummy album
if (album.getUUID().length > 0 && album.getUUID() !== PHOTOS_LIBRARY.STASH_DIR) {
albums.push(album);
}
this.logger.info(`Loading album ${album.getDisplayName()}`);
const symbolicLinks = (await fs.promises.readdir(albumPath, {
"withFileTypes": true,
})).filter(file => file.isSymbolicLink());
this.logger.debug(`Found ${symbolicLinks.length} symbolic links in ${album.getDisplayName()}`);
for (const link of symbolicLinks) {
// If we are loading a folder, we need to iterate over it's contents UUIDs
if (album.albumType === AlbumType.FOLDER) {
let loadedAlbum: Album;
let fullPath: string;
try {
[loadedAlbum, fullPath] = await this.readFolderFromDisk(link.name, albumPath, album.getUUID());
albums.push(...await this.loadAlbum(loadedAlbum, fullPath));
} catch (err) {
// This error might be caused by a dead symlink, let's check
await this.removeDeadSymlink(path.join(albumPath, link.name), err);
}
}
if (album.albumType === AlbumType.ALBUM) { // If we are loading an album, we need to get the assets from their UUID based folder
const target = await fs.promises.readlink(path.join(albumPath, link.name));
const uuidFile = path.parse(target).base;
albums[0].assets[uuidFile] = link.name;
}
}
return albums;
}
/**
* Will try and remove a dead symlink
* @param symlinkPath - Location of the potential dead symlink
* @param cause - Optional cause of the execution of this function
* @throws A LibraryError in case the provided path is NOT a dead symlink
*/
async removeDeadSymlink(symlinkPath: string, cause?: Error) {
try {
// Checking if there is actually a dead symlink
if (await fs.promises.lstat(symlinkPath) && !fs.existsSync(symlinkPath)) {
this.emit(HANDLER_EVENT, new iCPSError(LIBRARY_ERR.DEAD_SYMLINK)
.setWarning()
.addMessage(symlinkPath)
.addCause(cause));
await fs.promises.unlink(symlinkPath);
} else {
throw new iCPSError(LIBRARY_ERR.UNKNOWN_SYMLINK_ERROR)
.addMessage(symlinkPath)
.addCause(cause);
}
} catch (err) {
throw new iCPSError(LIBRARY_ERR.UNKNOWN_SYMLINK_ERROR)
.addMessage(symlinkPath)
.addCause(err);
}
}
/**
* Creates a shallow album, by reading the basic information from disk
* @param folderName - The foldername that will link to the uuid
* @param parentFolderPath - The path of the parent's folder
* @param parentUUID - The parent Album UUID
* @returns The shallow Album and its path
*/
async readFolderFromDisk(folderName: string, parentFolderPath: string, parentUUID: string): Promise<[Album, string]> {
const uuidFolderName = await fs.promises.readlink(path.join(parentFolderPath, folderName));
const uuid = path.basename(uuidFolderName).substring(1); // Removing leading '.'
const fullPath = path.join(parentFolderPath, uuidFolderName);
const folderType = await this.readAlbumTypeFromPath(fullPath);
const loadedAlbum = new Album(uuid, folderType, folderName, parentUUID);
return [loadedAlbum, fullPath];
}
/**
* Derives the album type of a given folder, based on its content
* @param thisPath - The path to the folder on disk
* @returns The album type of the folder
*/
async readAlbumTypeFromPath(thisPath: string): Promise<AlbumType> {
// If the folder contains other folders, it will be of AlbumType.Folder
const directoryPresent = (await fs.promises.readdir(thisPath, {
"withFileTypes": true,
})).some(file => file.isDirectory());
// If there are files in the folders, the folder is treated as archived
const filePresent = (await fs.promises.readdir(thisPath, {
"withFileTypes": true,
})).filter(file => !PHOTOS_LIBRARY.SAFE_FILES.includes(file.name)) // Filter out files that are safe to ignore
.some(file => file.isFile());
if (directoryPresent) {
// AlbumType.Folder cannot be archived!
if (filePresent) {
this.emit(HANDLER_EVENT, new iCPSError(LIBRARY_ERR.EXTRANEOUS_FILE)
.setWarning()
.addMessage(thisPath),
);
}
return AlbumType.FOLDER;
}
if (filePresent) {
return AlbumType.ARCHIVED;
}
return AlbumType.ALBUM;
}
/**
* Writes the contents of the Axios response (as stream) to the filesystem, based on the associated Asset
* @param asset - The asset associated to the request
* @param response - The response -as a stream- containing the data of the asset
* @returns A promise, that resolves once this asset was written to disk and verified
*/
async writeAsset(asset: Asset, response: AxiosResponse<any, any>): Promise<void> {
this.logger.debug(`Writing asset ${asset.getDisplayName()}`);
const location = asset.getAssetFilePath(this.photoDataDir);
const writeStream = fs.createWriteStream(location);
response.data.pipe(writeStream);
await pEvent(writeStream, `close`);
try {
await fs.promises.utimes(location, new Date(asset.modified), new Date(asset.modified)); // Setting modified date on file
await this.verifyAsset(asset);
this.logger.debug(`Asset ${asset.getDisplayName()} successfully downloaded`);
return;
} catch (err) {
this.emit(HANDLER_EVENT, new iCPSError(LIBRARY_ERR.INVALID_ASSET)
.addMessage(asset.getDisplayName())
.addContext(`asset`, asset)
.addCause(err)
.setWarning(),
);
}
}
/**
* Deletes the specified asset from disk
* @param asset - The asset that needs to be removed
* @returns A promise, that resolves once the asset was deleted from disk
*/
async deleteAsset(asset: Asset) {
this.logger.info(`Deleting asset ${asset.getDisplayName()}`);
await fs.promises.rm(asset.getAssetFilePath(this.photoDataDir), {"force": true});
}
/**
* Verifies if a given Asset object is present on disk
* @param asset - The asset to verify
* @returns True, if the Asset object is present on disk
* @throws An error, in case the object cannot be verified
*/
async verifyAsset(asset: Asset): Promise<boolean> {
this.logger.debug(`Verifying asset ${asset.getDisplayName()}`);
const location = asset.getAssetFilePath(this.photoDataDir);
return asset.verify(location);
}
/**
* Finds the absolute paths of the folder pair for a given album
* The path is created, by finding the parent on filesystem. The folder paths do not necessarily exist, the parent path needs to exist.
* @param album - The album
* @returns A tuple containing the albumNamePath, uuidPath
* @throws An error, if the parent path cannot be found
*/
findAlbumPaths(album: Album): PathTuple {
// Directory path of the parent folder
let parentPath = this.photoDataDir;
if (album.parentAlbumUUID) {
const parentPathExt = this.findAlbumByUUIDInPath(album.parentAlbumUUID, this.photoDataDir);
if (parentPathExt.length === 0) {
throw new iCPSError(LIBRARY_ERR.NO_PARENT)
.addMessage(album.getDisplayName())
.addContext(`album`, album);
}
parentPath = path.join(parentPath, parentPathExt);
}
// LinkedAlbum will be the visible album, with the correct name
const albumNamePath = path.join(parentPath, album.getSanitizedFilename());
// AlbumPath will be the actual directory, having the UUID as foldername
const uuidPath = path.join(parentPath, `.${album.getUUID()}`);
return [albumNamePath, uuidPath];
}
/**
* Creates a path tuple containing the full path to the stashed album
* @param album - The album within the stash
* @returns A PathTuple containing the name based and UUID based path (not validated)
*/
findStashAlbumPaths(album: Album): PathTuple {
const stashedAlbumNamePath = path.join(this.stashDir, path.basename(album.getSanitizedFilename()));
const stashedUUIDPath = path.join(this.stashDir, path.basename(`.${album.getUUID()}`));
return [stashedAlbumNamePath, stashedUUIDPath];
}
/**
* Finds a given album in a given path (as long as it is within the directory tree)
* @param albumUUID - The UUID of the album
* @param rootPath - The path in which the album should be searched
* @returns The path to the album, relative to the provided path, or the empty string if the album could not be found, or the full path including photoDataDir, if _rootPath was undefined
*/
findAlbumByUUIDInPath(albumUUID: string, rootPath: string): string {
this.logger.trace(`Checking ${rootPath} for folder ${albumUUID}`);
// Get all folders in the path
const foldersInPath = fs.readdirSync(rootPath, {"withFileTypes": true}).filter(dirent => dirent.isDirectory());
// See if the searched folder is in the path
const filteredFolder = foldersInPath.filter(folder => folder.name === `.${albumUUID}`); // Since the folder is hidden, a dot is prefacing it
if (filteredFolder.length === 1) {
return filteredFolder[0].name;
}
// No luck in the current folder. Looking in all child folders
// This will contain either empty strings or the path to the searched album
const searchResult = foldersInPath.map(folder => {
// Look into each folder and see if the album can be found there
const result = this.findAlbumByUUIDInPath(albumUUID, path.join(rootPath, folder.name));
if (result !== ``) { // We've got a match and it should have returned
return path.join(folder.name, result);
}
// No luck in this directory tree
return ``;
}).filter(result => result !== ``); // Removing non-matches
if (searchResult.length === 1) {
this.logger.debug(`Found folder ${albumUUID} in ${rootPath}`);
return searchResult[0];
}
if (searchResult.length > 1) {
throw new iCPSError(LIBRARY_ERR.MULTIPLE_MATCHES)
.addMessage(`${albumUUID} in path ${rootPath}`)
.addContext(`searchResult`, searchResult);
}
// No match in this folder hierarchy
return ``;
}
/**
* Writes a given album to disk & links the necessary assets
* @param album - The album to be written to disk
*/
writeAlbum(album: Album) {
const [albumNamePath, uuidPath] = this.findAlbumPaths(album);
if (fs.existsSync(uuidPath)) {
throw new iCPSError(LIBRARY_ERR.EXISTS)
.addMessage(uuidPath)
.addContext(`album`, album);
}
if (fs.existsSync(albumNamePath)) {
throw new iCPSError(LIBRARY_ERR.EXISTS)
.addMessage(albumNamePath)
.addContext(`album`, album);
}
// Creating album
this.logger.debug(`Creating folder ${uuidPath}`);
fs.mkdirSync(uuidPath, {"recursive": true});
// Symlinking to correctly named album
this.logger.debug(`Linking ${albumNamePath} to ${path.basename(uuidPath)}`);
fs.symlinkSync(path.basename(uuidPath), albumNamePath);
// @remarks Something is wrong here - see E2E test
if (album.albumType === AlbumType.ALBUM) {
this.linkAlbumAssets(album, uuidPath);
}
}
/**
* Links the assets for the given album
* @remarks ALbums only refer to PrimaryAssets - hardcoding this
* @param album - Album holding information about the linked assets
* @param albumPath - Album path to link assets to
*/
linkAlbumAssets(album: Album, albumPath: string) {
Object.keys(album.assets).forEach(assetUUID => {
const linkedAsset = path.format({
"dir": albumPath,
"base": album.assets[assetUUID],
});
const assetPath = path.format({
"dir": this.primaryAssetDir,
"base": assetUUID,
});
// Relative asset path is relative to album, not the linkedAsset
const relativeAssetPath = path.relative(albumPath, assetPath);
try {
this.logger.debug(`Linking ${relativeAssetPath} to ${linkedAsset}`);
// Getting asset time, in order to update link as well
const assetTime = fs.statSync(assetPath).mtime;
fs.symlinkSync(relativeAssetPath, linkedAsset);
fs.lutimesSync(linkedAsset, assetTime, assetTime);
} catch (err) {
this.emit(HANDLER_EVENT, new iCPSError(LIBRARY_ERR.LINK)
.setWarning()
.addMessage(`${relativeAssetPath} to ${linkedAsset}`)
.addCause(err));
}
});
}
/**
* Deletes the given album. The folder will only be deleted, if it contains no 'real' files
* @param album - The album that needs to be removed
*/
deleteAlbum(album: Album) {
this.logger.debug(`Deleting folder ${album.getDisplayName()}`);
const [albumNamePath, uuidPath] = this.findAlbumPaths(album);
// Path to album
if (!fs.existsSync(uuidPath)) {
throw new iCPSError(LIBRARY_ERR.FIND_PATH)
.addMessage(uuidPath);
}
// Checking content
const pathContent = fs.readdirSync(uuidPath, {"withFileTypes": true})
.filter(item => !(item.isSymbolicLink() || PHOTOS_LIBRARY.SAFE_FILES.includes(item.name))); // Filter out symbolic links, we are fine with deleting those as well as the 'safe' files
if (pathContent.length > 0) {
throw new iCPSError(LIBRARY_ERR.NOT_EMPTY)
.addMessage(uuidPath)
.addContext(`pathContent`, pathContent);
}
// Path to real name folder
if (!fs.existsSync(albumNamePath)) {
throw new iCPSError(LIBRARY_ERR.FIND_PATH)
.addMessage(albumNamePath);
}
fs.rmSync(uuidPath, {"recursive": true});
fs.unlinkSync(albumNamePath);
this.logger.debug(`Successfully deleted album ${album.getDisplayName()} at ${albumNamePath} & ${uuidPath}`);
}
/**
* Stashes an archived album in case it was deleted/moved in the remote library
* @param album - The album that needs to be stashed
*/
stashArchivedAlbum(album: Album) {
this.logger.debug(`Stashing album ${album.getDisplayName()}`);
this.movePathTuple(
this.findAlbumPaths(album),
this.findStashAlbumPaths(album),
);
}
/**
* Tries to retrieve a previously stashed archived album
* @param album - The album that needs to be retrieved
*/
retrieveStashedAlbum(album: Album) {
this.logger.debug(`Retrieving stashed album ${album.getDisplayName()}`);
this.movePathTuple(
this.findStashAlbumPaths(album),
this.findAlbumPaths(album),
);
}
/**
* Moves & re-links the path tuple - if named path cannot be found, unlinking will be ignored
* Modified time is applied to target's modified and access time (atime is not reliable)
* @param src - The source of folders
* @param dest - The destination of folders
*/
movePathTuple(src: PathTuple, dest: PathTuple) {
const [srcNamePath, srcUUIDPath] = src;
const [destNamePath, destUUIDPath] = dest;
if (!fs.existsSync(srcUUIDPath)) {
throw new iCPSError(LIBRARY_ERR.FIND_PATH)
.addMessage(srcUUIDPath);
}
const srcUUIDStats = fs.statSync(srcUUIDPath);
if (fs.existsSync(destNamePath)) {
throw new iCPSError(LIBRARY_ERR.EXISTS)
.addMessage(destNamePath);
}
if (fs.existsSync(destUUIDPath)) {
throw new iCPSError(LIBRARY_ERR.EXISTS)
.addMessage(destUUIDPath);
}
this.logger.debug(`Moving ${srcUUIDPath} to ${destUUIDPath}`);
fs.renameSync(srcUUIDPath, destUUIDPath);
fs.utimesSync(destUUIDPath, srcUUIDStats.mtime, srcUUIDStats.mtime);
let srcNameStats: fs.Stats = srcUUIDStats;
try {
srcNameStats = fs.lstatSync(srcNamePath);
fs.unlinkSync(srcNamePath);
} catch (err) {
this.logger.debug(`Unable to unlink ${srcNamePath}: ${err.message}`);
}
this.logger.debug(`Re-linking ${destNamePath}`);
fs.symlinkSync(path.basename(destUUIDPath), destNamePath);
fs.lutimesSync(destNamePath, srcNameStats.mtime, srcNameStats.mtime);
}
/**
* This function will look for orphaned albums and remove the unnecessary UUID links to make them more manageable
*/
async cleanArchivedOrphans() {
this.logger.debug(`Cleaning archived orphans`);
const archivedOrphans = await this.loadAlbum(Album.getStashAlbum(), this.stashDir);
for (const album of archivedOrphans) {
this.logger.debug(`Found orphaned album ${album}`);
const [namePath, uuidPath] = this.findStashAlbumPaths(album);
let targetPath: string;
let index = 0;
do {
const basename = index === 0 ? path.basename(namePath) : `${path.basename(namePath)}-${index}`;
index++;
targetPath = path.join(this.archiveDir, basename);
} while (fs.existsSync(targetPath));
this.logger.debug(`Moving ${uuidPath} to ${targetPath}, unlinking ${namePath}`);
await fs.promises.rename(uuidPath, targetPath);
await fs.promises.unlink(namePath);
}
}
} |