immich-public-proxy/src/index.ts

import express from 'express'
import immich from './immich'
import render from './render'
import dayjs from 'dayjs'
import { AssetType, ImageSize } from './types'
import { Request } from 'express-serve-static-core'

require('dotenv').config()

const app = express()
// Add the EJS view engine, to render the gallery page
app.set('view engine', 'ejs')
// Serve static assets from the /public folder
app.use(express.static('public'))

// An incoming request for a shared link
app.get('/share/:key', async (req, res) => {
  res.set('Cache-Control', 'public, max-age=' + process.env.CACHE_AGE)
  if (!immich.isKey(req.params.key)) {
    log('Invalid share key ' + req.params.key)
    res.status(404).send()
  } else {
    const sharedLink = await immich.getShareByKey(req.params.key)
    if (!sharedLink) {
      log('Unknown share key ' + req.params.key)
      res.status(404).send()
    } else if (!sharedLink.assets.length) {
      log('No assets for key ' + req.params.key)
      res.status(404).send()
    } else if (sharedLink.assets.length === 1) {
      // This is an individual item (not a gallery)
      log('Serving link ' + req.params.key)
      const asset = sharedLink.assets[0]
      if (asset.type === AssetType.image) {
        // For photos, output the image directly
        await render.assetBuffer(res, sharedLink.assets[0], getSize(req))
      } else if (asset.type === AssetType.video) {
        // For videos, show the video as a web player
        await render.gallery(res, sharedLink, 1)
      }
    } else {
      // Multiple images - render as a gallery
      log('Serving link ' + req.params.key)
      await render.gallery(res, sharedLink)
    }
  }
})

// Output the buffer data for a photo or video
app.get('/:type(photo|video)/:key/:id', async (req, res) => {
  res.set('Cache-Control', 'public, max-age=' + process.env.CACHE_AGE)
  // Check for valid key and ID
  if (immich.isKey(req.params.key) && immich.isId(req.params.id)) {
    // Check if the key is a valid share link
    const sharedLink = await immich.getShareByKey(req.params.key)
    if (sharedLink?.assets.length) {
      // Check that the requested asset exists in this share
      const asset = sharedLink.assets.find(x => x.id === req.params.id)
      if (asset) {
        asset.type = req.params.type === 'video' ? AssetType.video : AssetType.image
        render.assetBuffer(res, asset, getSize(req)).then()
        return
      }
    }
  }
  log('No asset found for ' + req.path)
  res.status(404).send()
})

// Healthcheck
app.get('/healthcheck', (_req, res) => {
  res.send('ok')
})

// Send a 404 for all other routes
app.get('*', (req, res) => {
  log('Invalid route ' + req.path)
  res.status(404).send()
})

/**
 * Sanitise the data for an incoming query string `size` parameter
 * e.g. https://example.com/share/abc...xyz?size=thumbnail
 */
const getSize = (req: Request) => {
  return req?.query?.size === 'thumbnail' ? ImageSize.thumbnail : ImageSize.original
}

/**
 * Output a console.log message with timestamp
 */
export const log = (message: string) => console.log(dayjs().format() + ' ' + message)

// Handle process termination requests (e.g. Ctrl+C)
process.on('SIGTERM', () => { process.exit(0) })
process.on('SIGINT', () => { process.exit(0) })

app.listen(3000, () => {
  console.log(dayjs().format() + ' Server started')
})