feat(cli): refactor and add album support (#4434)

* Allow building and installing cli * feat: add format fix * docs: remove cli folder * feat: use immich scoped package * feat: rewrite cli readme * docs: add info on running without building * cleanup * chore: remove import functionality from cli * feat: add logout to cli * docs: add todo for file format from server * docs: add compilation step to cli * fix: success message spacing * feat: can create albums * fix: add check step to cli * fix: typos * feat: pull file formats from server * chore: use crawl service from server * chore: fix lint * docs: add cli documentation * chore: rename ignore pattern * chore: add version number to cli * feat: use sdk * fix: cleanup * feat: album name on windows * chore: remove skipped asset field * feat: add more info to server-info command * chore: cleanup * chore: remove unneeded packages * chore: fix docs links * feat: add cli v2 milestone * fix: set correct cli date --------- Co-authored-by: Alex <alex.tran1502@gmail.com>
2025-12-20 17:25:35 +03:00 · 2023-11-19 23:16:24 +01:00
parent 88b5f5b500
commit 7e38e7c949
31 changed files with 637 additions and 800 deletions
--- a/cli/src/cores/models/asset.ts
+++ b/cli/src/cores/models/asset.ts
@@ -0,0 +1,91 @@
+import * as fs from 'fs';
+import { basename } from 'node:path';
+import crypto from 'crypto';
+import { AssetApiUploadFileRequest } from 'src/api/open-api';
+import Os from 'os';
+
+export class Asset {
+  readonly path: string;
+  readonly deviceId!: string;
+
+  assetData?: File;
+  deviceAssetId?: string;
+  fileCreatedAt?: string;
+  fileModifiedAt?: string;
+  sidecarData?: File;
+  sidecarPath?: string;
+  fileSize!: number;
+  albumName?: string;
+
+  constructor(path: string, deviceId: string) {
+    this.path = path;
+    this.deviceId = deviceId;
+  }
+
+  async process() {
+    const stats = await fs.promises.stat(this.path);
+    this.deviceAssetId = `${basename(this.path)}-${stats.size}`.replace(/\s+/g, '');
+    this.fileCreatedAt = stats.mtime.toISOString();
+    this.fileModifiedAt = stats.mtime.toISOString();
+    this.fileSize = stats.size;
+    this.albumName = this.extractAlbumName();
+
+    this.assetData = await this.getFileObject(this.path);
+
+    // TODO: doesn't xmp replace the file extension? Will need investigation
+    const sideCarPath = `${this.path}.xmp`;
+    try {
+      fs.accessSync(sideCarPath, fs.constants.R_OK);
+      this.sidecarData = await this.getFileObject(sideCarPath);
+    } catch (error) {}
+  }
+
+  getUploadFileRequest(): AssetApiUploadFileRequest {
+    if (!this.assetData) throw new Error('Asset data not set');
+    if (!this.deviceAssetId) throw new Error('Device asset id not set');
+    if (!this.fileCreatedAt) throw new Error('File created at not set');
+    if (!this.fileModifiedAt) throw new Error('File modified at not set');
+    if (!this.deviceId) throw new Error('Device id not set');
+
+    return {
+      assetData: this.assetData,
+      deviceAssetId: this.deviceAssetId,
+      deviceId: this.deviceId,
+      fileCreatedAt: this.fileCreatedAt,
+      fileModifiedAt: this.fileModifiedAt,
+      isFavorite: false,
+      sidecarData: this.sidecarData,
+    };
+  }
+
+  private async getFileObject(path: string): Promise<File> {
+    const buffer = await fs.promises.readFile(path);
+    return new File([buffer], basename(path));
+  }
+
+  async delete(): Promise<void> {
+    return fs.promises.unlink(this.path);
+  }
+
+  public async hash(): Promise<string> {
+    const sha1 = (filePath: string) => {
+      const hash = crypto.createHash('sha1');
+      return new Promise<string>((resolve, reject) => {
+        const rs = fs.createReadStream(filePath);
+        rs.on('error', reject);
+        rs.on('data', (chunk) => hash.update(chunk));
+        rs.on('end', () => resolve(hash.digest('hex')));
+      });
+    };
+
+    return await sha1(this.path);
+  }
+
+  private extractAlbumName(): string {
+    if (Os.platform() === 'win32') {
+      return this.path.split('\\').slice(-2)[0];
+    } else {
+      return this.path.split('/').slice(-2)[0];
+    }
+  }
+}