frontend/src/model/file.js - develop - githubmirror/photoprism

frontend/src/model/file.js
275 строк6 KB
Michael Mayer
Frontend: Make is*/has* predicates return Boolean #4966
18 май 2026, 13:11
18 май 2026, 13:11949b97f
import RestModel from "model/rest";
import { DateTime } from "luxon";
import { $config } from "app/session";
import { $gettext } from "common/gettext";
import download from "common/download";
import * as media from "common/media";
import $api from "common/api";
import $util from "common/util";

// File represents a single stored media file (original or derivative) for a photo.
export class File extends RestModel {
  getDefaults() {
    return {
      UID: "",
      PhotoUID: "",
      InstanceID: "",
      MediaID: "",
      MediaUTC: 0,
      TakenAt: "",
      Root: "/",
      Name: "",
      OriginalName: "",
      Hash: "",
      Size: 0,
      ModTime: 0,
      Codec: "",
      FileType: "",
      MediaType: "",
      Mime: "",
      Primary: false,
      Sidecar: false,
      Missing: false,
      Portrait: false,
      Video: false,
      Duration: 0,
      FPS: 0.0,
      Frames: 0,
      Pages: 0,
      Width: 0,
      Height: 0,
      Orientation: 0,
      OrientationSrc: "",
      Projection: "",
      AspectRatio: 1.0,
      HDR: false,
      Watermark: false,
      ColorProfile: "",
      MainColor: "",
      Colors: "",
      Luminance: "",
      Diff: 0,
      Chroma: 0,
      Software: "",
      Error: "",
      Markers: [],
      CreatedAt: "",
      CreatedIn: 0,
      UpdatedAt: "",
      UpdatedIn: 0,
      DeletedAt: "",
    };
  }

  classes(selected) {
    let classes = ["is-file", "uid-" + this.UID];

    if (this.Primary) {
      classes.push("is-primary");
    }
    if (this.Sidecar) {
      classes.push("is-sidecar");
    }
    if (this.Video) {
      classes.push("is-video");
    }
    if (selected) {
      classes.push("is-selected");
    }

    return classes;
  }

  baseName(truncate) {
    let result = this.Name;
    const slash = result.lastIndexOf("/");

    if (slash >= 0) {
      result = this.Name.substring(slash + 1);
    }

    if (truncate) {
      result = $util.truncate(result, truncate, "…");
    }

    return result;
  }

  isFile() {
    return true;
  }

  getEntityName() {
    return this.Root + "/" + this.Name;
  }

  thumbnailUrl(size) {
    if (this.Error || this.Missing) {
      return `${$config.contentUri}/svg/broken`;
    } else if (this.Sidecar) {
      return `${$config.contentUri}/svg/file`;
    }

    return `${$config.contentUri}/t/${this.Hash}/${$config.previewToken}/${size}`;
  }

  getDownloadUrl() {
    return `${$config.apiUri}/dl/${this.Hash}?t=${$config.downloadToken}`;
  }

  download() {
    if (!this.Hash) {
      return;
    }

    download(this.getDownloadUrl(), this.baseName(this.Name));
  }

  calculateSize(width, height) {
    if (width >= this.Width && height >= this.Height) {
      // Smaller
      return { width: this.Width, height: this.Height };
    }

    const srcAspectRatio = this.Width / this.Height;
    const maxAspectRatio = width / height;

    let newW, newH;

    if (srcAspectRatio > maxAspectRatio) {
      newW = width;
      newH = Math.ceil(newW / srcAspectRatio);
    } else {
      newH = height;
      newW = Math.ceil(newH * srcAspectRatio);
    }

    return { width: newW, height: newH };
  }

  getDateString() {
    return DateTime.fromISO(this.CreatedAt).toLocaleString(DateTime.DATETIME_MED);
  }

  getInfo() {
    let info = [];

    if (this.FileType) {
      info.push(this.FileType.toUpperCase());
    }

    if (this.Duration > 0) {
      info.push($util.formatDuration(this.Duration));
    }

    if (this.FPS > 0) {
      info.push($util.formatFPS(this.FPS));
    }

    this.addSizeInfo(info);

    return info.join(", ");
  }

  storageInfo() {
    if (!this.Root || this.Root === "") {
      return "";
    }

    if (this.Root.length === 1) {
      return $gettext("Originals");
    } else {
      return $util.capitalize(this.Root);
    }
  }

  // isAnimated returns true when the file is an image with multiple frames or a non-trivial duration.
  isAnimated() {
    return this.MediaType === media.Image && (this.Frames > 1 || this.Duration > 1);
  }

  typeInfo() {
    let info = [];

    if (this.Sidecar) {
      info.push($gettext("Sidecar"));
    }

    if (this.Primary && !this.MediaType) {
      info.push($gettext("Image"));
      return info.join(" ");
    } else if (this.Video && !this.MediaType) {
      info.push($gettext("Video"));
      return info.join(" ");
    } else if (this.MediaType === "vector") {
      info.push($util.fileType(this.FileType));
      return info.join(" ");
    } else {
      const format = $util.fileType(this.FileType);
      if (format) {
        info.push(format);
      }

      if (this.MediaType && this.MediaType !== this.FileType) {
        const media = $util.capitalize(this.MediaType);
        if (media) {
          info.push(media);
        }
      }

      return info.join(" ");
    }
  }

  sizeInfo() {
    let info = [];

    this.addSizeInfo(info);

    return info.join(", ");
  }

  addSizeInfo(info) {
    if (this.Width && this.Height) {
      info.push(this.Width + " × " + this.Height);
    }

    if (this.Size) {
      info.push($util.formatBytes(this.Size));
    }
  }

  toggleLike() {
    this.Favorite = !this.Favorite;

    if (this.Favorite) {
      return $api.post(this.getPhotoResource() + "/like");
    } else {
      return $api.delete(this.getPhotoResource() + "/like");
    }
  }

  getPhotoResource() {
    return "photos/" + this.PhotoUID;
  }

  like() {
    this.Favorite = true;
    return $api.post(this.getPhotoResource() + "/like");
  }

  unlike() {
    this.Favorite = false;
    return $api.delete(this.getPhotoResource() + "/like");
  }

  static getCollectionResource() {
    return "files";
  }

  static getModelName() {
    return $gettext("File");
  }
}

export default File;