server/models/account/actor-image.ts

   1 import { remove } from 'fs-extra'
   2 import { join } from 'path'
   3 import { AfterDestroy, AllowNull, Column, CreatedAt, Default, Is, Model, Table, UpdatedAt } from 'sequelize-typescript'
   4 import { MActorImageFormattable } from '@server/types/models'
   5 import { ActorImageType } from '@shared/models'
   6 import { ActorImage } from '../../../shared/models/actors/actor-image.model'
   7 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
   8 import { logger } from '../../helpers/logger'
   9 import { CONFIG } from '../../initializers/config'
  10 import { LAZY_STATIC_PATHS } from '../../initializers/constants'
  11 import { throwIfNotValid } from '../utils'
  12
  13 @Table({
  14   tableName: 'actorImage',
  15   indexes: [
  16     {
  17       fields: [ 'filename' ],
  18       unique: true
  19     }
  20   ]
  21 })
  22 export class ActorImageModel extends Model {
  23
  24   @AllowNull(false)
  25   @Column
  26   filename: string
  27
  28   @AllowNull(true)
  29   @Default(null)
  30   @Column
  31   height: number
  32
  33   @AllowNull(true)
  34   @Default(null)
  35   @Column
  36   width: number
  37
  38   @AllowNull(true)
  39   @Is('ActorImageFileUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'fileUrl', true))
  40   @Column
  41   fileUrl: string
  42
  43   @AllowNull(false)
  44   @Column
  45   onDisk: boolean
  46
  47   @AllowNull(false)
  48   @Column
  49   type: ActorImageType
  50
  51   @CreatedAt
  52   createdAt: Date
  53
  54   @UpdatedAt
  55   updatedAt: Date
  56
  57   @AfterDestroy
  58   static removeFilesAndSendDelete (instance: ActorImageModel) {
  59     logger.info('Removing actor image file %s.', instance.filename)
  60
  61     // Don't block the transaction
  62     instance.removeImage()
  63       .catch(err => logger.error('Cannot remove actor image file %s.', instance.filename, err))
  64   }
  65
  66   static loadByName (filename: string) {
  67     const query = {
  68       where: {
  69         filename
  70       }
  71     }
  72
  73     return ActorImageModel.findOne(query)
  74   }
  75
  76   toFormattedJSON (this: MActorImageFormattable): ActorImage {
  77     return {
  78       path: this.getStaticPath(),
  79       createdAt: this.createdAt,
  80       updatedAt: this.updatedAt
  81     }
  82   }
  83
  84   getStaticPath () {
  85     if (this.type === ActorImageType.AVATAR) {
  86       return join(LAZY_STATIC_PATHS.AVATARS, this.filename)
  87     }
  88
  89     return join(LAZY_STATIC_PATHS.BANNERS, this.filename)
  90   }
  91
  92   getPath () {
  93     return join(CONFIG.STORAGE.ACTOR_IMAGES, this.filename)
  94   }
  95
  96   removeImage () {
  97     const imagePath = join(CONFIG.STORAGE.ACTOR_IMAGES, this.filename)
  98     return remove(imagePath)
  99   }
 100 }