+import { FindOptions, Includeable, IncludeOptions, Op, Transaction, WhereOptions } from 'sequelize'
import {
AllowNull,
BeforeDestroy,
BelongsTo,
Column,
CreatedAt,
+ DataType,
Default,
DefaultScope,
ForeignKey,
Table,
UpdatedAt
} from 'sequelize-typescript'
+import { ModelCache } from '@server/models/shared/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,
+ MAccountHost,
+ MAccountSummaryFormattable,
+ MChannelHost
+} 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 { getSort, throwIfNotValid } from '../utils'
+import { ServerBlocklistModel } from '../server/server-blocklist'
+import { buildSQLAttributes, getSort, throwIfNotValid } from '../shared'
+import { UserModel } from '../user/user'
+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 { WEBSERVER } from '../../initializers/constants'
-import { Op, Transaction, WhereOptions } from 'sequelize'
+import { AccountBlocklistModel } from './account-blocklist'
export enum ScopeNames {
SUMMARY = 'SUMMARY'
}
-@DefaultScope({
+export type SummaryOptions = {
+ actorRequired?: boolean // Default: true
+ whereActor?: WhereOptions
+ whereServer?: WhereOptions
+ withAccountBlockerIds?: number[]
+ forCount?: boolean
+}
+
+@DefaultScope(() => ({
include: [
{
- model: () => ActorModel, // Default scope includes avatar and server
+ model: ActorModel, // Default scope includes avatar and server
required: true
}
]
-})
-@Scopes({
- [ ScopeNames.SUMMARY ]: (whereActor?: WhereOptions) => {
- return {
- attributes: [ 'id', 'name' ],
- include: [
+}))
+@Scopes(() => ({
+ [ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => {
+ const serverInclude: IncludeOptions = {
+ attributes: [ 'host' ],
+ model: ServerModel.unscoped(),
+ required: !!options.whereServer,
+ where: options.whereServer
+ }
+
+ const actorInclude: Includeable = {
+ attributes: [ 'id', 'preferredUsername', 'url', 'serverId' ],
+ model: ActorModel.unscoped(),
+ required: options.actorRequired ?? true,
+ where: options.whereActor,
+ include: [ serverInclude ]
+ }
+
+ 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) {
+ queryInclude.push({
+ attributes: [ 'id' ],
+ model: AccountBlocklistModel.unscoped(),
+ as: 'BlockedBy',
+ required: false,
+ where: {
+ accountId: {
+ [Op.in]: options.withAccountBlockerIds
+ }
+ }
+ })
+
+ serverInclude.include = [
{
- attributes: [ 'id', 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
- model: ActorModel.unscoped(),
- required: true,
- where: whereActor,
- include: [
- {
- attributes: [ 'host' ],
- model: ServerModel.unscoped(),
- required: false
- },
- {
- model: AvatarModel.unscoped(),
- required: false
+ attributes: [ 'id' ],
+ model: ServerBlocklistModel.unscoped(),
+ required: false,
+ where: {
+ accountId: {
+ [Op.in]: options.withAccountBlockerIds
}
- ]
+ }
}
]
}
+
+ query.include = queryInclude
+
+ return query
}
-})
+}))
@Table({
tableName: 'account',
indexes: [
}
]
})
-export class AccountModel extends Model<AccountModel> {
+export class AccountModel extends Model<Partial<AttributesOnly<AccountModel>>> {
@AllowNull(false)
@Column
@AllowNull(true)
@Default(null)
@Is('AccountDescription', value => throwIfNotValid(value, isAccountDescriptionValid, 'description', true))
- @Column
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.USERS.DESCRIPTION.max))
description: string
@CreatedAt
@HasMany(() => VideoCommentModel, {
foreignKey: {
- allowNull: false
+ allowNull: true
},
onDelete: 'cascade',
hooks: true
})
VideoComments: VideoCommentModel[]
+ @HasMany(() => AccountBlocklistModel, {
+ foreignKey: {
+ name: 'targetAccountId',
+ allowNull: false
+ },
+ as: 'BlockedBy',
+ onDelete: 'CASCADE'
+ })
+ BlockedBy: AccountBlocklistModel[]
+
@BeforeDestroy
static async sendDeleteIfOwned (instance: AccountModel, options) {
if (!instance.Actor) {
- instance.Actor = await instance.$get('Actor', { transaction: options.transaction }) as ActorModel
+ instance.Actor = await instance.$get('Actor', { transaction: options.transaction })
}
+ 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) {
- return AccountModel.findByPk(id, { transaction })
+ // ---------------------------------------------------------------------------
+
+ static getSQLAttributes (tableName: string, aliasPrefix = '') {
+ return buildSQLAttributes({
+ model: this,
+ tableName,
+ aliasPrefix
+ })
}
- static loadByUUID (uuid: string) {
- const query = {
- include: [
- {
- model: ActorModel,
- required: true,
- where: {
- uuid
- }
- }
- ]
- }
+ // ---------------------------------------------------------------------------
- return AccountModel.findOne(query)
+ static load (id: number, transaction?: Transaction): Promise<MAccountDefault> {
+ return AccountModel.findByPk(id, { transaction })
}
- static loadByNameWithHost (nameWithHost: string) {
+ 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) {
- 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: ActorModel.wherePreferredUsername(name)
}
]
- },
- include: [
- {
- model: ActorModel,
- required: true,
- where: {
- preferredUsername: name
- }
- }
- ]
+ }
+
+ return AccountModel.findOne(query)
}
- return AccountModel.findOne(query)
+ 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) {
+ static loadByNameAndHost (name: string, host: string): Promise<MAccountDefault> {
const query = {
include: [
{
model: ActorModel,
required: true,
- where: {
- preferredUsername: name
- },
+ where: ActorModel.wherePreferredUsername(name),
include: [
{
model: ServerModel,
return AccountModel.findOne(query)
}
- static loadByUrl (url: string, transaction?: Transaction) {
+ 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) {
+ static listLocalsForSitemap (sort: string): Promise<MAccountActor[]> {
const query = {
attributes: [ ],
offset: 0,
.findAll(query)
}
- toFormattedJSON (): Account {
- const actor = this.Actor.toFormattedJSON()
- const account = {
+ toFormattedJSON (this: MAccountFormattable): 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 (): AccountSummary {
- const actor = this.Actor.toFormattedJSON()
+ toFormattedSummaryJSON (this: MAccountSummaryFormattable): AccountSummary {
+ const actor = this.Actor.toFormattedSummaryJSON()
return {
id: this.id,
- uuid: actor.uuid,
- 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
}
}
- toActivityPubObject () {
- const obj = this.Actor.toActivityPubObject(this.name, 'Account')
+ async toActivityPubObject (this: MAccountAP) {
+ const obj = await this.Actor.toActivityPubObject(this.name)
return Object.assign(obj, {
summary: this.description
getDisplayName () {
return this.name
}
+
+ // Avoid error when running this method on MAccount... | MChannel...
+ getClientUrl (this: MAccountHost | MChannelHost) {
+ return WEBSERVER.URL + '/a/' + this.Actor.getIdentifier()
+ }
+
+ isBlocked () {
+ return this.BlockedBy && this.BlockedBy.length !== 0
+ }
}
projects / github / Chocobozzz / PeerTube.git / blobdiff