Agnostic actor image storage

7 files changed, 70 insertions, 39 deletions

diff --git a/server/models/account/account.ts b/server/models/account/account.ts
index c72f9c63d..312451abe 100644
--- a/server/models/account/account.ts
+++ b/server/models/account/account.ts
@@ -33,7 +33,7 @@ import {
 import { ActorModel } from '../activitypub/actor'
 import { ActorFollowModel } from '../activitypub/actor-follow'
 import { ApplicationModel } from '../application/application'
-import { AvatarModel } from '../avatar/avatar'
+import { ActorImageModel } from './actor-image'
 import { ServerModel } from '../server/server'
 import { ServerBlocklistModel } from '../server/server-blocklist'
 import { getSort, throwIfNotValid } from '../utils'
@@ -82,7 +82,8 @@ export type SummaryOptions = {
           serverInclude,
 
           {
-            model: AvatarModel.unscoped(),
+            model: ActorImageModel.unscoped(),
+            as: 'Avatar',
             required: false
           }
         ]
diff --git a/server/models/avatar/avatar.ts b/server/models/account/actor-image.ts
index 0d246a144..c532bd08d 100644
--- a/server/models/avatar/avatar.ts
+++ b/server/models/account/actor-image.ts
@@ -1,16 +1,17 @@
+import { remove } from 'fs-extra'
 import { join } from 'path'
 import { AfterDestroy, AllowNull, Column, CreatedAt, Is, Model, Table, UpdatedAt } from 'sequelize-typescript'
-import { Avatar } from '../../../shared/models/avatars/avatar.model'
-import { LAZY_STATIC_PATHS } from '../../initializers/constants'
+import { MActorImageFormattable } from '@server/types/models'
+import { ActorImageType } from '@shared/models'
+import { ActorImage } from '../../../shared/models/actors/actor-image.model'
+import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
 import { logger } from '../../helpers/logger'
-import { remove } from 'fs-extra'
 import { CONFIG } from '../../initializers/config'
+import { LAZY_STATIC_PATHS } from '../../initializers/constants'
 import { throwIfNotValid } from '../utils'
-import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
-import { MAvatarFormattable } from '@server/types/models'
 
 @Table({
-  tableName: 'avatar',
+  tableName: 'actorImage',
   indexes: [
     {
       fields: [ 'filename' ],
@@ -18,14 +19,14 @@ import { MAvatarFormattable } from '@server/types/models'
     }
   ]
 })
-export class AvatarModel extends Model {
+export class ActorImageModel extends Model {
 
   @AllowNull(false)
   @Column
   filename: string
 
   @AllowNull(true)
-  @Is('AvatarFileUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'fileUrl', true))
+  @Is('ActorImageFileUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'fileUrl', true))
   @Column
   fileUrl: string
 
@@ -33,6 +34,10 @@ export class AvatarModel extends Model {
   @Column
   onDisk: boolean
 
+  @AllowNull(false)
+  @Column
+  type: ActorImageType
+
   @CreatedAt
   createdAt: Date
 
@@ -40,12 +45,12 @@ export class AvatarModel extends Model {
   updatedAt: Date
 
   @AfterDestroy
-  static removeFilesAndSendDelete (instance: AvatarModel) {
-    logger.info('Removing avatar file %s.', instance.filename)
+  static removeFilesAndSendDelete (instance: ActorImageModel) {
+    logger.info('Removing actor image file %s.', instance.filename)
 
     // Don't block the transaction
-    instance.removeAvatar()
-      .catch(err => logger.error('Cannot remove avatar file %s.', instance.filename, err))
+    instance.removeImage()
+      .catch(err => logger.error('Cannot remove actor image file %s.', instance.filename, err))
   }
 
   static loadByName (filename: string) {
@@ -55,10 +60,10 @@ export class AvatarModel extends Model {
       }
     }
 
-    return AvatarModel.findOne(query)
+    return ActorImageModel.findOne(query)
   }
 
-  toFormattedJSON (this: MAvatarFormattable): Avatar {
+  toFormattedJSON (this: MActorImageFormattable): ActorImage {
     return {
       path: this.getStaticPath(),
       createdAt: this.createdAt,
@@ -71,11 +76,11 @@ export class AvatarModel extends Model {
   }
 
   getPath () {
-    return join(CONFIG.STORAGE.AVATARS_DIR, this.filename)
+    return join(CONFIG.STORAGE.ACTOR_IMAGES, this.filename)
   }
 
-  removeAvatar () {
-    const avatarPath = join(CONFIG.STORAGE.AVATARS_DIR, this.filename)
-    return remove(avatarPath)
+  removeImage () {
+    const imagePath = join(CONFIG.STORAGE.ACTOR_IMAGES, this.filename)
+    return remove(imagePath)
   }
 }
diff --git a/server/models/account/user-notification.ts b/server/models/account/user-notification.ts
index 25c523203..805095002 100644
--- a/server/models/account/user-notification.ts
+++ b/server/models/account/user-notification.ts
@@ -10,7 +10,6 @@ import { VideoCommentAbuseModel } from '../abuse/video-comment-abuse'
 import { ActorModel } from '../activitypub/actor'
 import { ActorFollowModel } from '../activitypub/actor-follow'
 import { ApplicationModel } from '../application/application'
-import { AvatarModel } from '../avatar/avatar'
 import { PluginModel } from '../server/plugin'
 import { ServerModel } from '../server/server'
 import { getSort, throwIfNotValid } from '../utils'
@@ -20,6 +19,7 @@ import { VideoChannelModel } from '../video/video-channel'
 import { VideoCommentModel } from '../video/video-comment'
 import { VideoImportModel } from '../video/video-import'
 import { AccountModel } from './account'
+import { ActorImageModel } from './actor-image'
 import { UserModel } from './user'
 
 enum ScopeNames {
@@ -34,7 +34,8 @@ function buildActorWithAvatarInclude () {
     include: [
       {
         attributes: [ 'filename' ],
-        model: AvatarModel.unscoped(),
+        as: 'Avatar',
+        model: ActorImageModel.unscoped(),
         required: false
       },
       {
@@ -172,7 +173,8 @@ function buildAccountInclude (required: boolean, withActor = false) {
               },
               {
                 attributes: [ 'filename' ],
-                model: AvatarModel.unscoped(),
+                as: 'Avatar',
+                model: ActorImageModel.unscoped(),
                 required: false
               },
               {
diff --git a/server/models/activitypub/actor.ts b/server/models/activitypub/actor.ts
index 3b98e8841..09d96b24d 100644
--- a/server/models/activitypub/actor.ts
+++ b/server/models/activitypub/actor.ts
@@ -19,7 +19,7 @@ import {
 } from 'sequelize-typescript'
 import { ModelCache } from '@server/models/model-cache'
 import { ActivityIconObject, ActivityPubActorType } from '../../../shared/models/activitypub'
-import { Avatar } from '../../../shared/models/avatars/avatar.model'
+import { ActorImage } from '../../../shared/models/actors/actor-image.model'
 import { activityPubContextify } from '../../helpers/activitypub'
 import {
   isActorFollowersCountValid,
@@ -43,7 +43,7 @@ import {
   MActorWithInboxes
 } from '../../types/models'
 import { AccountModel } from '../account/account'
-import { AvatarModel } from '../avatar/avatar'
+import { ActorImageModel } from '../account/actor-image'
 import { ServerModel } from '../server/server'
 import { isOutdated, throwIfNotValid } from '../utils'
 import { VideoModel } from '../video/video'
@@ -73,7 +73,8 @@ export const unusedActorAttributesForAPI = [
       required: false
     },
     {
-      model: AvatarModel,
+      model: ActorImageModel,
+      as: 'Avatar',
       required: false
     }
   ]
@@ -100,7 +101,8 @@ export const unusedActorAttributesForAPI = [
         required: false
       },
       {
-        model: AvatarModel,
+        model: ActorImageModel,
+        as: 'Avatar',
         required: false
       }
     ]
@@ -213,18 +215,35 @@ export class ActorModel extends Model {
   @UpdatedAt
   updatedAt: Date
 
-  @ForeignKey(() => AvatarModel)
+  @ForeignKey(() => ActorImageModel)
   @Column
   avatarId: number
 
-  @BelongsTo(() => AvatarModel, {
+  @ForeignKey(() => ActorImageModel)
+  @Column
+  bannerId: number
+
+  @BelongsTo(() => ActorImageModel, {
+    foreignKey: {
+      name: 'avatarId',
+      allowNull: true
+    },
+    as: 'Avatar',
+    onDelete: 'set null',
+    hooks: true
+  })
+  Avatar: ActorImageModel
+
+  @BelongsTo(() => ActorImageModel, {
     foreignKey: {
+      name: 'bannerId',
       allowNull: true
     },
+    as: 'Banner',
     onDelete: 'set null',
     hooks: true
   })
-  Avatar: AvatarModel
+  Banner: ActorImageModel
 
   @HasMany(() => ActorFollowModel, {
     foreignKey: {
@@ -496,7 +515,7 @@ export class ActorModel extends Model {
   }
 
   toFormattedSummaryJSON (this: MActorSummaryFormattable) {
-    let avatar: Avatar = null
+    let avatar: ActorImage = null
     if (this.Avatar) {
       avatar = this.Avatar.toFormattedJSON()
     }
diff --git a/server/models/video/video-channel.ts b/server/models/video/video-channel.ts
index 178878c55..815fb16c0 100644
--- a/server/models/video/video-channel.ts
+++ b/server/models/video/video-channel.ts
@@ -36,9 +36,9 @@ import {
   MChannelSummaryFormattable
 } from '../../types/models/video'
 import { AccountModel, ScopeNames as AccountModelScopeNames, SummaryOptions as AccountSummaryOptions } from '../account/account'
+import { ActorImageModel } from '../account/actor-image'
 import { ActorModel, unusedActorAttributesForAPI } from '../activitypub/actor'
 import { ActorFollowModel } from '../activitypub/actor-follow'
-import { AvatarModel } from '../avatar/avatar'
 import { ServerModel } from '../server/server'
 import { buildServerIdsFollowedBy, buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils'
 import { VideoModel } from './video'
@@ -130,7 +130,8 @@ export type SummaryOptions = {
             required: false
           },
           {
-            model: AvatarModel.unscoped(),
+            model: ActorImageModel.unscoped(),
+            as: 'Avatar',
             required: false
           }
         ]
diff --git a/server/models/video/video-query-builder.ts b/server/models/video/video-query-builder.ts
index 96df0a7f8..4d95ddee2 100644
--- a/server/models/video/video-query-builder.ts
+++ b/server/models/video/video-query-builder.ts
@@ -490,12 +490,13 @@ function wrapForAPIResults (baseQuery: string, replacements: any, options: Build
     'INNER JOIN "actor" AS "VideoChannel->Account->Actor" ON "VideoChannel->Account"."actorId" = "VideoChannel->Account->Actor"."id"',
 
     'LEFT OUTER JOIN "server" AS "VideoChannel->Actor->Server" ON "VideoChannel->Actor"."serverId" = "VideoChannel->Actor->Server"."id"',
-    'LEFT OUTER JOIN "avatar" AS "VideoChannel->Actor->Avatar" ON "VideoChannel->Actor"."avatarId" = "VideoChannel->Actor->Avatar"."id"',
+    'LEFT OUTER JOIN "actorImage" AS "VideoChannel->Actor->Avatar" ' +
+      'ON "VideoChannel->Actor"."avatarId" = "VideoChannel->Actor->Avatar"."id"',
 
     'LEFT OUTER JOIN "server" AS "VideoChannel->Account->Actor->Server" ' +
       'ON "VideoChannel->Account->Actor"."serverId" = "VideoChannel->Account->Actor->Server"."id"',
 
-    'LEFT OUTER JOIN "avatar" AS "VideoChannel->Account->Actor->Avatar" ' +
+    'LEFT OUTER JOIN "actorImage" AS "VideoChannel->Account->Actor->Avatar" ' +
       'ON "VideoChannel->Account->Actor"."avatarId" = "VideoChannel->Account->Actor->Avatar"."id"',
 
     'LEFT OUTER JOIN "thumbnail" AS "Thumbnails" ON "video"."id" = "Thumbnails"."videoId"'
diff --git a/server/models/video/video.ts b/server/models/video/video.ts
index 9d89efa5b..086269921 100644
--- a/server/models/video/video.ts
+++ b/server/models/video/video.ts
@@ -100,10 +100,10 @@ import { MVideoFile, MVideoFileStreamingPlaylistVideo } from '../../types/models
 import { VideoAbuseModel } from '../abuse/video-abuse'
 import { AccountModel } from '../account/account'
 import { AccountVideoRateModel } from '../account/account-video-rate'
+import { ActorImageModel } from '../account/actor-image'
 import { UserModel } from '../account/user'
 import { UserVideoHistoryModel } from '../account/user-video-history'
 import { ActorModel } from '../activitypub/actor'
-import { AvatarModel } from '../avatar/avatar'
 import { VideoRedundancyModel } from '../redundancy/video-redundancy'
 import { ServerModel } from '../server/server'
 import { TrackerModel } from '../server/tracker'
@@ -286,7 +286,8 @@ export type AvailableForListIDsOptions = {
                 required: false
               },
               {
-                model: AvatarModel.unscoped(),
+                model: ActorImageModel.unscoped(),
+                as: 'Avatar',
                 required: false
               }
             ]
@@ -308,7 +309,8 @@ export type AvailableForListIDsOptions = {
                     required: false
                   },
                   {
-                    model: AvatarModel.unscoped(),
+                    model: ActorImageModel.unscoped(),
+                    as: 'Avatar',
                     required: false
                   }
                 ]
@@ -1703,7 +1705,7 @@ export class VideoModel extends Model {
 
     function buildActor (rowActor: any) {
       const avatarModel = rowActor.Avatar.id !== null
-        ? new AvatarModel(pick(rowActor.Avatar, avatarKeys), buildOpts)
+        ? new ActorImageModel(pick(rowActor.Avatar, avatarKeys), buildOpts)
         : null
 
       const serverModel = rowActor.Server.id !== null