+import { FindOptions, Includeable, IncludeOptions, Op, Transaction, WhereOptions } from 'sequelize'
import {
AllowNull,
BeforeDestroy,
Table,
UpdatedAt
} from 'sequelize-typescript'
+import { ModelCache } from '@server/models/model-cache'
+import { AttributesOnly } from '@shared/typescript-utils'
import { Account, AccountSummary } from '../../../shared/models/actors'
import { isAccountDescriptionValid } from '../../helpers/custom-validators/accounts'
-import { sendDeleteActor } from '../../lib/activitypub/send'
-import { ActorModel } from '../activitypub/actor'
+import { CONSTRAINTS_FIELDS, SERVER_ACTOR_NAME, WEBSERVER } from '../../initializers/constants'
+import { sendDeleteActor } from '../../lib/activitypub/send/send-delete'
+import {
+ MAccount,
+ MAccountActor,
+ MAccountAP,
+ MAccountDefault,
+ MAccountFormattable,
+ MAccountSummaryFormattable,
+ MChannelActor
+} from '../../types/models'
+import { ActorModel } from '../actor/actor'
+import { ActorFollowModel } from '../actor/actor-follow'
+import { ActorImageModel } from '../actor/actor-image'
import { ApplicationModel } from '../application/application'
import { ServerModel } from '../server/server'
+import { ServerBlocklistModel } from '../server/server-blocklist'
+import { UserModel } from '../user/user'
import { getSort, throwIfNotValid } from '../utils'
+import { VideoModel } from '../video/video'
import { VideoChannelModel } from '../video/video-channel'
import { VideoCommentModel } from '../video/video-comment'
-import { UserModel } from './user'
-import { AvatarModel } from '../avatar/avatar'
import { VideoPlaylistModel } from '../video/video-playlist'
-import { CONSTRAINTS_FIELDS, SERVER_ACTOR_NAME, WEBSERVER } from '../../initializers/constants'
-import { FindOptions, IncludeOptions, Op, Transaction, WhereOptions } from 'sequelize'
import { AccountBlocklistModel } from './account-blocklist'
-import { ServerBlocklistModel } from '../server/server-blocklist'
-import { ActorFollowModel } from '../activitypub/actor-follow'
-import { MAccountActor, MAccountDefault, MAccountSummaryFormattable, MAccountFormattable, MAccountAP } from '../../typings/models'
-import * as Bluebird from 'bluebird'
export enum ScopeNames {
SUMMARY = 'SUMMARY'
}
export type SummaryOptions = {
+ actorRequired?: boolean // Default: true
whereActor?: WhereOptions
+ whereServer?: WhereOptions
withAccountBlockerIds?: number[]
+ forCount?: boolean
}
@DefaultScope(() => ({
}))
@Scopes(() => ({
[ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => {
- const whereActor = options.whereActor || undefined
-
const serverInclude: IncludeOptions = {
attributes: [ 'host' ],
model: ServerModel.unscoped(),
- required: false
+ required: !!options.whereServer,
+ where: options.whereServer
}
- const query: FindOptions = {
- attributes: [ 'id', 'name' ],
- include: [
- {
- attributes: [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
- model: ActorModel.unscoped(),
- required: true,
- where: whereActor,
- include: [
- serverInclude,
+ const actorInclude: Includeable = {
+ attributes: [ 'id', 'preferredUsername', 'url', 'serverId' ],
+ model: ActorModel.unscoped(),
+ required: options.actorRequired ?? true,
+ where: options.whereActor,
+ include: [ serverInclude ]
+ }
- {
- model: AvatarModel.unscoped(),
- required: false
- }
- ]
- }
- ]
+ if (options.forCount !== true) {
+ actorInclude.include.push({
+ model: ActorImageModel,
+ as: 'Avatars',
+ required: false
+ })
+ }
+
+ const queryInclude: Includeable[] = [
+ actorInclude
+ ]
+
+ const query: FindOptions = {
+ attributes: [ 'id', 'name', 'actorId' ]
}
if (options.withAccountBlockerIds) {
- query.include.push({
+ queryInclude.push({
attributes: [ 'id' ],
model: AccountBlocklistModel.unscoped(),
- as: 'BlockedAccounts',
+ as: 'BlockedBy',
required: false,
where: {
accountId: {
]
}
+ query.include = queryInclude
+
return query
}
}))
}
]
})
-export class AccountModel extends Model<AccountModel> {
+export class AccountModel extends Model<Partial<AttributesOnly<AccountModel>>> {
@AllowNull(false)
@Column
name: 'targetAccountId',
allowNull: false
},
- as: 'BlockedAccounts',
+ as: 'BlockedBy',
onDelete: 'CASCADE'
})
- BlockedAccounts: AccountBlocklistModel[]
-
- private static cache: { [ id: string ]: any } = {}
+ BlockedBy: AccountBlocklistModel[]
@BeforeDestroy
static async sendDeleteIfOwned (instance: AccountModel, options) {
}
await ActorFollowModel.removeFollowsOf(instance.Actor.id, options.transaction)
+
if (instance.isOwned()) {
return sendDeleteActor(instance.Actor, options.transaction)
}
return undefined
}
- static load (id: number, transaction?: Transaction): Bluebird<MAccountDefault> {
+ static load (id: number, transaction?: Transaction): Promise<MAccountDefault> {
return AccountModel.findByPk(id, { transaction })
}
- static loadByNameWithHost (nameWithHost: string): Bluebird<MAccountDefault> {
+ static loadByNameWithHost (nameWithHost: string): Promise<MAccountDefault> {
const [ accountName, host ] = nameWithHost.split('@')
if (!host || host === WEBSERVER.HOST) return AccountModel.loadLocalByName(accountName)
return AccountModel.loadByNameAndHost(accountName, host)
}
- static loadLocalByName (name: string): Bluebird<MAccountDefault> {
- // The server actor never change, so we can easily cache it
- if (name === SERVER_ACTOR_NAME && AccountModel.cache[name]) {
- return Bluebird.resolve(AccountModel.cache[name])
- }
-
- const query = {
- where: {
- [Op.or]: [
- {
- userId: {
- [Op.ne]: null
+ static loadLocalByName (name: string): Promise<MAccountDefault> {
+ const fun = () => {
+ const query = {
+ where: {
+ [Op.or]: [
+ {
+ userId: {
+ [Op.ne]: null
+ }
+ },
+ {
+ applicationId: {
+ [Op.ne]: null
+ }
}
- },
+ ]
+ },
+ include: [
{
- applicationId: {
- [Op.ne]: null
+ model: ActorModel,
+ required: true,
+ where: {
+ preferredUsername: name
}
}
]
- },
- include: [
- {
- model: ActorModel,
- required: true,
- where: {
- preferredUsername: name
- }
- }
- ]
- }
+ }
- return AccountModel.findOne(query)
- .then(account => {
- if (name === SERVER_ACTOR_NAME) {
- AccountModel.cache[name] = account
- }
+ return AccountModel.findOne(query)
+ }
- return account
- })
+ return ModelCache.Instance.doCache({
+ cacheType: 'local-account-name',
+ key: name,
+ fun,
+ // The server actor never change, so we can easily cache it
+ whitelist: () => name === SERVER_ACTOR_NAME
+ })
}
- static loadByNameAndHost (name: string, host: string): Bluebird<MAccountDefault> {
+ static loadByNameAndHost (name: string, host: string): Promise<MAccountDefault> {
const query = {
include: [
{
return AccountModel.findOne(query)
}
- static loadByUrl (url: string, transaction?: Transaction): Bluebird<MAccountDefault> {
+ static loadByUrl (url: string, transaction?: Transaction): Promise<MAccountDefault> {
const query = {
include: [
{
order: getSort(sort)
}
- return AccountModel.findAndCountAll(query)
- .then(({ rows, count }) => {
- return {
- data: rows,
- total: count
+ return Promise.all([
+ AccountModel.count(),
+ AccountModel.findAll(query)
+ ]).then(([ total, data ]) => ({ total, data }))
+ }
+
+ static loadAccountIdFromVideo (videoId: number): Promise<MAccount> {
+ const query = {
+ include: [
+ {
+ attributes: [ 'id', 'accountId' ],
+ model: VideoChannelModel.unscoped(),
+ required: true,
+ include: [
+ {
+ attributes: [ 'id', 'channelId' ],
+ model: VideoModel.unscoped(),
+ where: {
+ id: videoId
+ }
+ }
+ ]
}
- })
+ ]
+ }
+
+ return AccountModel.findOne(query)
}
- static listLocalsForSitemap (sort: string): Bluebird<MAccountActor[]> {
+ static listLocalsForSitemap (sort: string): Promise<MAccountActor[]> {
const query = {
attributes: [ ],
offset: 0,
.findAll(query)
}
+ getClientUrl () {
+ return WEBSERVER.URL + '/accounts/' + this.Actor.getIdentifier()
+ }
+
toFormattedJSON (this: MAccountFormattable): Account {
- const actor = this.Actor.toFormattedJSON()
- const account = {
+ return {
+ ...this.Actor.toFormattedJSON(),
+
id: this.id,
displayName: this.getDisplayName(),
description: this.description,
- createdAt: this.createdAt,
updatedAt: this.updatedAt,
- userId: this.userId ? this.userId : undefined
+ userId: this.userId ?? undefined
}
-
- return Object.assign(actor, account)
}
toFormattedSummaryJSON (this: MAccountSummaryFormattable): AccountSummary {
return {
id: this.id,
- name: actor.name,
displayName: this.getDisplayName(),
+
+ name: actor.name,
url: actor.url,
host: actor.host,
+ avatars: actor.avatars,
+
+ // TODO: remove, deprecated in 4.2
avatar: actor.avatar
}
}
return this.name
}
+ getLocalUrl (this: MAccountActor | MChannelActor) {
+ return WEBSERVER.URL + `/accounts/` + this.Actor.preferredUsername
+ }
+
isBlocked () {
- return this.BlockedAccounts && this.BlockedAccounts.length !== 0
+ return this.BlockedBy && this.BlockedBy.length !== 0
}
}