679 lines
17 KiB
JavaScript
679 lines
17 KiB
JavaScript
/*
|
||
|
||
Copyright (c) 2018 - 2020 Michael Mayer <hello@photoprism.org>
|
||
|
||
This program is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU Affero General Public License as published
|
||
by the Free Software Foundation, either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU Affero General Public License for more details.
|
||
|
||
You should have received a copy of the GNU Affero General Public License
|
||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
|
||
PhotoPrism™ is a registered trademark of Michael Mayer. You may use it as required
|
||
to describe our software, run your own server, for educational purposes, but not for
|
||
offering commercial goods, products, or services without prior written permission.
|
||
In other words, please ask.
|
||
|
||
Feel free to send an e-mail to hello@photoprism.org if you have questions,
|
||
want to support our work, or just want to say hello.
|
||
|
||
Additional information can be found in our Developer Guide:
|
||
https://docs.photoprism.org/developer-guide/
|
||
|
||
*/
|
||
|
||
import RestModel from "model/rest";
|
||
import File from "model/file";
|
||
import Api from "common/api";
|
||
import {DateTime} from "luxon";
|
||
import Util from "common/util";
|
||
import {config} from "../session";
|
||
import countries from "resources/countries.json";
|
||
import {$gettext} from "common/vm";
|
||
|
||
export const SrcManual = "manual";
|
||
export const CodecAvc1 = "avc1";
|
||
export const TypeMP4 = "mp4";
|
||
export const TypeJpeg = "jpg";
|
||
export const TypeImage = "image";
|
||
export const YearUnknown = -1;
|
||
export const MonthUnknown = -1;
|
||
export const DayUnknown = -1;
|
||
|
||
export class Photo extends RestModel {
|
||
getDefaults() {
|
||
return {
|
||
DocumentID: "",
|
||
UID: "",
|
||
Type: TypeImage,
|
||
Favorite: false,
|
||
Private: false,
|
||
Scan: false,
|
||
TakenAt: "",
|
||
TakenAtLocal: "",
|
||
TakenSrc: "",
|
||
TimeZone: "",
|
||
Path: "",
|
||
Color: "",
|
||
Name: "",
|
||
OriginalName: "",
|
||
Title: "",
|
||
TitleSrc: "",
|
||
Description: "",
|
||
DescriptionSrc: "",
|
||
Resolution: 0,
|
||
Quality: 0,
|
||
Lat: 0.0,
|
||
Lng: 0.0,
|
||
Altitude: 0,
|
||
Iso: 0,
|
||
FocalLength: 0,
|
||
FNumber: 0.0,
|
||
Exposure: "",
|
||
Views: 0,
|
||
Camera: {},
|
||
CameraID: 0,
|
||
CameraSerial: "",
|
||
CameraSrc: "",
|
||
Lens: {},
|
||
LensID: 0,
|
||
Country: "",
|
||
Year: YearUnknown,
|
||
Month: MonthUnknown,
|
||
Day: DayUnknown,
|
||
Details: {
|
||
Keywords: "",
|
||
Notes: "",
|
||
Subject: "",
|
||
Artist: "",
|
||
Copyright: "",
|
||
License: "",
|
||
},
|
||
Files: [],
|
||
Labels: [],
|
||
Keywords: [],
|
||
Albums: [],
|
||
Geo: {},
|
||
Place: {},
|
||
PlaceID: "",
|
||
GeoID: "",
|
||
GeoSrc: "",
|
||
GeoAccuracy: 0,
|
||
// Additional data in result lists.
|
||
GeoLabel: "",
|
||
GeoCity: "",
|
||
GeoState: "",
|
||
GeoCountry: "",
|
||
FileUID: "",
|
||
FileRoot: "",
|
||
FileName: "",
|
||
Hash: "",
|
||
Width: "",
|
||
Height: "",
|
||
// Date fields.
|
||
CreatedAt: "",
|
||
UpdatedAt: "",
|
||
EditedAt: null,
|
||
CheckedAt: null,
|
||
DeletedAt: null,
|
||
};
|
||
}
|
||
|
||
localDayString() {
|
||
if (!this.TakenAtLocal) {
|
||
return new Date().getDay().toString().padStart(2, "0");
|
||
}
|
||
|
||
if (!this.Day || this.Day <= 0) {
|
||
return this.TakenAtLocal.substr(8, 2);
|
||
}
|
||
|
||
return this.Day.toString().padStart(2, "0");
|
||
}
|
||
|
||
localMonthString() {
|
||
if (!this.TakenAtLocal) {
|
||
return new Date().getMonth().toString().padStart(2, "0");
|
||
}
|
||
|
||
if (!this.Month || this.Month <= 0) {
|
||
return this.TakenAtLocal.substr(5, 2);
|
||
}
|
||
|
||
return this.Month.toString().padStart(2, "0");
|
||
}
|
||
|
||
localYearString() {
|
||
if (!this.TakenAtLocal) {
|
||
return new Date().getFullYear().toString().padStart(4, "0");
|
||
}
|
||
|
||
if (!this.Year || this.Year <= 1000) {
|
||
return this.TakenAtLocal.substr(0, 4);
|
||
}
|
||
|
||
return this.Year.toString();
|
||
}
|
||
|
||
localDateString(time) {
|
||
if (!this.localYearString()) {
|
||
return this.TakenAtLocal;
|
||
}
|
||
|
||
let date = this.localYearString() + "-" + this.localMonthString() + "-" + this.localDayString();
|
||
|
||
if (!time) {
|
||
time = this.TakenAtLocal.substr(11, 8);
|
||
}
|
||
|
||
return `${date}T${time}`;
|
||
}
|
||
|
||
getTimeZone() {
|
||
if (this.TimeZone) {
|
||
return this.TimeZone;
|
||
}
|
||
|
||
return "utc";
|
||
}
|
||
|
||
localDate(time) {
|
||
if(!this.TakenAtLocal) {
|
||
return this.utcDate();
|
||
}
|
||
|
||
let zone = this.getTimeZone();
|
||
|
||
return DateTime.fromISO(this.localDateString(time), {zone});
|
||
}
|
||
|
||
utcDate() {
|
||
return DateTime.fromISO(this.TakenAt).toUTC();
|
||
}
|
||
|
||
baseName(truncate) {
|
||
let result = this.fileBase(this.FileName ? this.FileName : this.mainFile().Name);
|
||
|
||
if (truncate) {
|
||
result = Util.truncate(result, truncate, "…");
|
||
}
|
||
|
||
return result;
|
||
}
|
||
|
||
fileBase(name) {
|
||
let result = name;
|
||
const slash = result.lastIndexOf("/");
|
||
|
||
if (slash >= 0) {
|
||
result = name.substring(slash + 1);
|
||
}
|
||
|
||
return result;
|
||
}
|
||
|
||
getEntityName() {
|
||
return this.Title;
|
||
}
|
||
|
||
getTitle() {
|
||
return this.Title;
|
||
}
|
||
|
||
getGoogleMapsLink() {
|
||
return "https://www.google.com/maps/place/" + this.Lat + "," + this.Lng;
|
||
}
|
||
|
||
refreshFileAttr() {
|
||
const file = this.mainFile();
|
||
|
||
if (!file || !file.Hash) {
|
||
return;
|
||
}
|
||
|
||
this.Hash = file.Hash;
|
||
this.Width = file.Width;
|
||
this.Height = file.Height;
|
||
}
|
||
|
||
isPlayable() {
|
||
if (!this.Files) {
|
||
return false;
|
||
}
|
||
|
||
return this.Files.findIndex(f => f.Codec === CodecAvc1) !== -1 || this.Files.findIndex(f => f.Type === TypeMP4) !== -1;
|
||
}
|
||
|
||
videoFile() {
|
||
if (!this.Files) {
|
||
return false;
|
||
}
|
||
|
||
let file = this.Files.find(f => f.Codec === CodecAvc1);
|
||
|
||
if (!file) {
|
||
file = this.Files.find(f => f.Type === TypeMP4);
|
||
}
|
||
|
||
if (!file) {
|
||
file = this.Files.find(f => !!f.Video);
|
||
}
|
||
|
||
return file;
|
||
}
|
||
|
||
videoUrl() {
|
||
const file = this.videoFile();
|
||
|
||
if (!file) {
|
||
return "";
|
||
}
|
||
|
||
return `/api/v1/videos/${file.Hash}/${config.previewToken()}/${TypeMP4}`;
|
||
}
|
||
|
||
mainFile() {
|
||
if (!this.Files) {
|
||
return false;
|
||
}
|
||
|
||
let file = this.Files.find(f => !!f.Primary);
|
||
|
||
if (!file) {
|
||
file = this.Files.find(f => f.Type === TypeJpeg);
|
||
}
|
||
|
||
return file;
|
||
}
|
||
|
||
mainFileHash() {
|
||
if (this.Files) {
|
||
let file = this.mainFile();
|
||
|
||
if (file && file.Hash) {
|
||
return file.Hash;
|
||
}
|
||
} else if (this.Hash) {
|
||
return this.Hash;
|
||
}
|
||
|
||
return "";
|
||
}
|
||
|
||
fileModels() {
|
||
let result = [];
|
||
|
||
if (!this.Files) {
|
||
return result;
|
||
}
|
||
|
||
this.Files.forEach((f) => {
|
||
result.push(new File(f));
|
||
});
|
||
|
||
result.sort((a, b) => {
|
||
if (a.Primary > b.Primary) {
|
||
return -1;
|
||
} else if (a.Primary < b.Primary) {
|
||
return 1;
|
||
}
|
||
|
||
return a.Name.localeCompare(b.Name);
|
||
});
|
||
|
||
return result;
|
||
}
|
||
|
||
thumbnailUrl(type) {
|
||
let hash = this.mainFileHash();
|
||
|
||
if (!hash) {
|
||
let video = this.videoFile();
|
||
|
||
if (video && video.Hash) {
|
||
return `/api/v1/t/${video.Hash}/${config.previewToken()}/${type}`;
|
||
}
|
||
|
||
return "/api/v1/svg/photo";
|
||
}
|
||
|
||
return `/api/v1/t/${hash}/${config.previewToken()}/${type}`;
|
||
}
|
||
|
||
getDownloadUrl() {
|
||
return `/api/v1/dl/${this.mainFileHash()}?t=${config.downloadToken()}`;
|
||
}
|
||
|
||
downloadAll() {
|
||
if (!this.Files) {
|
||
let link = document.createElement("a");
|
||
link.href = `/api/v1/dl/${this.mainFileHash()}?t=${config.downloadToken()}`;
|
||
link.download = this.baseName(false);
|
||
link.click();
|
||
return;
|
||
}
|
||
|
||
this.Files.forEach((file) => {
|
||
if (!file || !file.Hash) {
|
||
console.warn("no file hash found for download", file);
|
||
return;
|
||
}
|
||
|
||
let link = document.createElement("a");
|
||
link.href = `/api/v1/dl/${file.Hash}?t=${config.downloadToken()}`;
|
||
link.download = this.fileBase(file.Name);
|
||
link.click();
|
||
});
|
||
}
|
||
|
||
thumbnailSrcset() {
|
||
const result = [];
|
||
|
||
result.push(this.thumbnailUrl("fit_720") + " 720w");
|
||
result.push(this.thumbnailUrl("fit_1280") + " 1280w");
|
||
result.push(this.thumbnailUrl("fit_1920") + " 1920w");
|
||
result.push(this.thumbnailUrl("fit_2560") + " 2560w");
|
||
result.push(this.thumbnailUrl("fit_3840") + " 3840w");
|
||
|
||
return result.join(", ");
|
||
}
|
||
|
||
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.round(newW / srcAspectRatio);
|
||
|
||
} else {
|
||
newH = height;
|
||
newW = Math.round(newH * srcAspectRatio);
|
||
}
|
||
|
||
return {width: newW, height: newH};
|
||
}
|
||
|
||
thumbnailSizes() {
|
||
const result = [];
|
||
|
||
result.push("(min-width: 2560px) 3840px");
|
||
result.push("(min-width: 1920px) 2560px");
|
||
result.push("(min-width: 1280px) 1920px");
|
||
result.push("(min-width: 720px) 1280px");
|
||
result.push("720px");
|
||
|
||
return result.join(", ");
|
||
}
|
||
|
||
getDateString() {
|
||
if (!this.TakenAt || this.Year === YearUnknown) {
|
||
return $gettext("Unknown");
|
||
} else if (this.Month === MonthUnknown) {
|
||
return this.localYearString();
|
||
} else if (this.Day === DayUnknown) {
|
||
return this.localDate().toLocaleString({month: "long", year: "numeric"});
|
||
} else if (this.TimeZone) {
|
||
return this.localDate().toLocaleString(DateTime.DATETIME_FULL);
|
||
}
|
||
|
||
return this.localDate().toLocaleString(DateTime.DATE_HUGE);
|
||
}
|
||
|
||
shortDateString() {
|
||
if (!this.TakenAt || this.Year === YearUnknown) {
|
||
return $gettext("Unknown");
|
||
} else if (this.Month === MonthUnknown) {
|
||
return this.localYearString();
|
||
} else if (this.Day === DayUnknown) {
|
||
return this.localDate().toLocaleString({month: "long", year: "numeric"});
|
||
}
|
||
|
||
return this.localDate().toLocaleString(DateTime.DATE_MED);
|
||
}
|
||
|
||
hasLocation() {
|
||
return this.Lat !== 0 || this.Lng !== 0;
|
||
}
|
||
|
||
countryName() {
|
||
if (this.Country !== "zz") {
|
||
const country = countries.find(c => c.Code === this.Country);
|
||
|
||
if (country) {
|
||
return country.Name;
|
||
}
|
||
}
|
||
|
||
return $gettext("Unknown");
|
||
}
|
||
|
||
locationInfo() {
|
||
if (this.PlaceID === "zz" && this.Country !== "zz") {
|
||
const country = countries.find(c => c.Code === this.Country);
|
||
|
||
if (country) {
|
||
return country.Name;
|
||
}
|
||
}
|
||
|
||
return this.GeoLabel ? this.GeoLabel : $gettext("Unknown");
|
||
}
|
||
|
||
addSizeInfo(file, info) {
|
||
if (!file) {
|
||
return;
|
||
}
|
||
|
||
if (file.Width && file.Height) {
|
||
info.push(file.Width + " × " + file.Height);
|
||
} else if (!file.Primary) {
|
||
let main = this.mainFile();
|
||
if (main && main.Width && main.Height) {
|
||
info.push(main.Width + " × " + main.Height);
|
||
}
|
||
}
|
||
|
||
if (file.Size > 102400) {
|
||
const size = Number.parseFloat(file.Size) / 1048576;
|
||
|
||
info.push(size.toFixed(1) + " MB");
|
||
} else if (file.Size) {
|
||
const size = Number.parseFloat(file.Size) / 1024;
|
||
|
||
info.push(size.toFixed(1) + " KB");
|
||
}
|
||
}
|
||
|
||
getVideoInfo() {
|
||
let info = [];
|
||
let file = this.videoFile();
|
||
|
||
if (!file) {
|
||
file = this.mainFile();
|
||
}
|
||
|
||
if (!file) {
|
||
return $gettext("Video");
|
||
}
|
||
|
||
if (file.Duration > 0) {
|
||
info.push(Util.duration(file.Duration));
|
||
}
|
||
|
||
if (file.Codec) {
|
||
info.push(file.Codec.toUpperCase());
|
||
}
|
||
|
||
this.addSizeInfo(file, info);
|
||
|
||
if (!info.length) {
|
||
return $gettext("Video");
|
||
}
|
||
|
||
return info.join(", ");
|
||
}
|
||
|
||
getPhotoInfo() {
|
||
let info = [];
|
||
|
||
if (this.Camera) {
|
||
info.push(this.Camera.Make + " " + this.Camera.Model);
|
||
} else if (this.CameraModel && this.CameraMake) {
|
||
info.push(this.CameraMake + " " + this.CameraModel);
|
||
}
|
||
|
||
let file = this.videoFile();
|
||
|
||
if (!file || !file.Width) {
|
||
file = this.mainFile();
|
||
} else if (file.Codec) {
|
||
info.push(file.Codec.toUpperCase());
|
||
}
|
||
|
||
this.addSizeInfo(file, info);
|
||
|
||
if (!info.length) {
|
||
return $gettext("Unknown");
|
||
}
|
||
|
||
return info.join(", ");
|
||
}
|
||
|
||
getCamera() {
|
||
if (this.Camera) {
|
||
return this.Camera.Make + " " + this.Camera.Model;
|
||
} else if (this.CameraModel) {
|
||
return this.CameraMake + " " + this.CameraModel;
|
||
}
|
||
|
||
return $gettext("Unknown");
|
||
}
|
||
|
||
archive() {
|
||
return Api.post("batch/photos/archive", {"photos": [this.getId()]});
|
||
}
|
||
|
||
approve() {
|
||
return Api.post(this.getEntityResource() + "/approve");
|
||
}
|
||
|
||
toggleLike() {
|
||
this.Favorite = !this.Favorite;
|
||
|
||
if (this.Favorite) {
|
||
return Api.post(this.getEntityResource() + "/like");
|
||
} else {
|
||
return Api.delete(this.getEntityResource() + "/like");
|
||
}
|
||
}
|
||
|
||
togglePrivate() {
|
||
this.Private = !this.Private;
|
||
|
||
return Api.put(this.getEntityResource(), {Private: this.Private});
|
||
}
|
||
|
||
primaryFile(fileUID) {
|
||
return Api.post(`${this.getEntityResource()}/files/${fileUID}/primary`).then((r) => Promise.resolve(this.setValues(r.data)));
|
||
}
|
||
|
||
ungroupFile(fileUID) {
|
||
return Api.post(`${this.getEntityResource()}/files/${fileUID}/ungroup`).then((r) => Promise.resolve(this.setValues(r.data)));
|
||
}
|
||
|
||
like() {
|
||
this.Favorite = true;
|
||
return Api.post(this.getEntityResource() + "/like");
|
||
}
|
||
|
||
unlike() {
|
||
this.Favorite = false;
|
||
return Api.delete(this.getEntityResource() + "/like");
|
||
}
|
||
|
||
addLabel(name) {
|
||
return Api.post(this.getEntityResource() + "/label", {Name: name, Priority: 10})
|
||
.then((r) => Promise.resolve(this.setValues(r.data)));
|
||
}
|
||
|
||
activateLabel(id) {
|
||
return Api.put(this.getEntityResource() + "/label/" + id, {Uncertainty: 0})
|
||
.then((r) => Promise.resolve(this.setValues(r.data)));
|
||
}
|
||
|
||
renameLabel(id, name) {
|
||
return Api.put(this.getEntityResource() + "/label/" + id, {Label: {Name: name}})
|
||
.then((r) => Promise.resolve(this.setValues(r.data)));
|
||
}
|
||
|
||
removeLabel(id) {
|
||
return Api.delete(this.getEntityResource() + "/label/" + id)
|
||
.then((r) => Promise.resolve(this.setValues(r.data)));
|
||
}
|
||
|
||
update() {
|
||
const values = this.getValues(true);
|
||
|
||
if (values.Title) {
|
||
values.TitleSrc = SrcManual;
|
||
}
|
||
|
||
if (values.Description) {
|
||
values.DescriptionSrc = SrcManual;
|
||
}
|
||
|
||
if (values.Lat || values.Lng || values.Country) {
|
||
values.GeoSrc = SrcManual;
|
||
}
|
||
|
||
if (values.TakenAt || values.TimeZone || values.Day || values.Month || values.Year) {
|
||
values.TakenSrc = SrcManual;
|
||
}
|
||
|
||
if (values.CameraID || values.LensID || values.FocalLength || values.FNumber || values.Iso || values.Exposure) {
|
||
values.CameraSrc = SrcManual;
|
||
}
|
||
|
||
return Api.put(this.getEntityResource(), values).then((response) => Promise.resolve(this.setValues(response.data)));
|
||
}
|
||
|
||
static getCollectionResource() {
|
||
return "photos";
|
||
}
|
||
|
||
static getModelName() {
|
||
return $gettext("Photo");
|
||
}
|
||
|
||
static mergeResponse(results, response) {
|
||
if (response.offset === 0 || results.length === 0) {
|
||
return response.models;
|
||
}
|
||
|
||
if (response.models.length > 0) {
|
||
let i = results.length - 1;
|
||
|
||
if (results[i].UID === response.models[0].UID) {
|
||
const first = response.models.shift();
|
||
results[i].Files = results[i].Files.concat(first.Files);
|
||
}
|
||
}
|
||
|
||
return results.concat(response.models);
|
||
}
|
||
}
|
||
|
||
export default Photo;
|