Files
immich-magic-proxy/app/src/render.ts
T
2026-02-13 11:49:00 +13:00

225 lines
8.4 KiB
TypeScript

import immich from './immich'
import { Response } from 'express-serve-static-core'
import { Asset, AssetType, ImageSize, IncomingShareRequest, SharedLink } from './types'
import { canDownload, escapeHtml, getConfigOption } from './functions'
import archiver from 'archiver'
import { respondToInvalidRequest } from './invalidRequestHandler'
import { sanitize } from './includes/sanitize'
class Render {
lgConfig
constructor () {
this.lgConfig = getConfigOption('lightGallery', {})
}
/**
* Stream data from Immich back to the client
*/
async assetBuffer (req: IncomingShareRequest, res: Response, asset: Asset, size?: ImageSize | string) {
// Get meta info regarding the asset
const metaRes = await fetch(immich.buildUrl(immich.apiUrl() + '/assets/' + encodeURIComponent(asset.id), {
key: asset.key
}))
const meta = await metaRes.json()
// Make sure we should display this asset
if (meta.isTrashed || meta.visibility === 'locked') {
respondToInvalidRequest(res, 404, `Asset ${asset.id} is trashed or locked`)
return
}
// Prepare the request
const headerList = ['content-type', 'content-length', 'last-modified', 'etag']
size = immich.validateImageSize(size)
let subpath, sizeQueryParam
if (asset.type === AssetType.video) {
subpath = '/video/playback'
} else if (asset.type === AssetType.image) {
// For images, there are three combinations of path + query string, depending on image size
if (size === ImageSize.original && getConfigOption('ipp.downloadOriginalPhoto', true)) {
subpath = '/original'
} else if (size === ImageSize.preview || size === ImageSize.original) {
// IPP is configured in config.json to send the preview size instead of the original size
subpath = '/thumbnail'
sizeQueryParam = 'preview'
} else {
subpath = '/' + size
}
}
const headers = { range: '' }
// For videos, request them in 2.5MB chunks rather than the entire video
if (asset.type === AssetType.video) {
const range = (req.range || '').replace(/bytes=/, '').split('-')
const start = parseInt(range[0], 10) || 0
const end = parseInt(range[1], 10) || start + 2499999
headers.range = `bytes=${start}-${end}`
headerList.push('cache-control', 'content-range')
res.setHeader('accept-ranges', 'bytes')
res.status(206) // Partial Content
}
// Request data from Immich
const url = immich.buildUrl(immich.apiUrl() + '/assets/' + encodeURIComponent(asset.id) + subpath, {
[asset.keyType || 'key']: asset.key,
size: sizeQueryParam,
password: asset.password
})
const data = await fetch(url, { headers })
// Add the filename for downloaded assets
if (size === ImageSize.original && asset.originalFileName && getConfigOption('ipp.downloadOriginalPhoto', true)) {
res.setHeader('Content-Disposition', `attachment; filename="${this.getFilename(asset)}"`)
}
// Return the response to the client
if (data.status >= 200 && data.status < 300) {
// Populate the whitelisted response headers
headerList.forEach(header => {
const value = data.headers.get(header)
if (value) res.setHeader(header, value)
})
// Return the Immich asset binary data
await data.body?.pipeTo(
new WritableStream({
write (chunk) { res.write(chunk) }
})
)
res.end()
} else {
let immichMessage = ''
try {
const json = await data.json()
if (json.message) immichMessage = '\nResponse from Immich: ' + json.message
} catch (e) { }
respondToInvalidRequest(res, 404, 'Failed response from Immich for asset ' + asset.id + ' on this URL:\n' + url + immichMessage)
}
}
/**
* Render a gallery page for a given SharedLink, using EJS and lightGallery.
*
* @param res - ExpressJS Response
* @param share - Immich `shared-link` containing the assets to show in the gallery
* @param [openItem] - Immediately open a lightbox to the Nth item when the gallery loads
*/
async gallery (res: Response, share: SharedLink, openItem?: number) {
// publicBaseUrl is used for the og:image, which requires a fully qualified URL.
// You can specify this in your docker-compose file, or send it dynamically as a `publicBaseUrl` header
const publicBaseUrl = process.env.PUBLIC_BASE_URL || res.req.headers.publicBaseUrl || (res.req.protocol + '://' + res.req.headers.host)
// Use .map to generate an array of promises, then await them all to load in parallel.
const items = await Promise.all(share.assets.map(async (asset) => {
let video, downloadUrl
if (asset.type === AssetType.video) {
// Populate the data-video property
video = JSON.stringify({
source: [
{
src: immich.videoUrl(share.key, asset.id),
type: await immich.getVideoContentType(asset)
}
],
attributes: {
playsinline: 'playsinline',
controls: 'controls'
}
})
downloadUrl = immich.videoUrl(share.key, asset.id)
}
if (getConfigOption('ipp.downloadOriginalPhoto', true)) {
// Add a download link for the original-size image, if configured in config.json
downloadUrl = immich.photoUrl(share.key, asset.id, ImageSize.original)
}
const thumbnailUrl = immich.photoUrl(share.key, asset.id, ImageSize.thumbnail)
const previewUrl = immich.photoUrl(share.key, asset.id, immich.getPreviewImageSize(asset))
const description = getConfigOption('ipp.showMetadata.description', false) && typeof asset?.exifInfo?.description === 'string' ? escapeHtml(asset.exifInfo.description) : ''
// Create the full HTML element source to pass to the gallery view
const itemHtml = [
video ? `<a data-video='${video}'` : `<a href="${previewUrl}"`,
downloadUrl ? ` data-download-url="${downloadUrl}"` : '',
description ? ` data-sub-html='<p>${description}</p>'` : '',
` data-download="${this.getFilename(asset)}" data-slide-name="${asset.id}"><img alt="" src="${thumbnailUrl}"/>`,
video ? '<div class="play-icon"></div>' : '',
'</a>'
].join('')
return {
html: itemHtml,
thumbnailUrl,
previewUrl
}
}))
res.render('gallery', {
items,
openItem,
title: this.title(share),
publicBaseUrl,
path: '/share/' + share.key,
showDownload: canDownload(share),
showTitle: getConfigOption('ipp.showGalleryTitle', false),
lgConfig: getConfigOption('lightGallery', {})
})
}
/**
* Attempt to get a title from the link description or the album title
*/
title (share: SharedLink) {
return share.description || share?.album?.albumName || 'Gallery'
}
/**
* Download all assets as a zip file
*/
async downloadAll (res: Response, share: SharedLink) {
res.setHeader('Content-Type', 'application/zip')
let filename = (sanitize(this.title(share)) || 'photos') + '.zip'
filename = encodeURI(filename)
res.setHeader('Content-Disposition', `attachment; filename*=UTF-8''${filename}`)
const archive = archiver('zip', { zlib: { level: 6 } })
archive.pipe(res)
for (const asset of share.assets) {
const url = immich.buildUrl(immich.apiUrl() + '/assets/' + encodeURIComponent(asset.id) + '/original', {
key: asset.key,
password: asset.password
})
const data = await fetch(url)
// Check the response for validity
if (!data.ok) {
console.warn(`Failed to fetch asset: ${asset.id}`)
continue
}
archive.append(Buffer.from(await data.arrayBuffer()), { name: this.getFilename(asset) })
}
await archive.finalize()
archive.on('end', () => res.end())
}
/**
* Generate a filename for the downloaded asset based on the configuration option chosen
*/
getFilename (asset: Asset) {
const extension = asset.originalFileName?.match(/(\.\w+)$/)?.[1] || ''
switch (getConfigOption('ipp.downloadedFilename')) {
case 1:
// Immich's ID number for this asset
return asset.id + extension
case 2:
// A sanitised version of the ID number
return 'img_' + asset.id.slice(0, 8) + extension
default:
// By default, it will choose the asset's original filename
return asset.originalFileName || (asset.id + extension)
}
}
}
const render = new Render()
export default render