-import * as Sequelize from 'sequelize'
import {
- activityPubContextify,
- isAccountFollowersCountValid,
- isAccountFollowersValid,
- isAccountFollowingCountValid,
- isAccountFollowingValid,
- isAccountInboxValid,
- isAccountOutboxValid,
- isAccountPrivateKeyValid,
- isAccountPublicKeyValid,
- isAccountSharedInboxValid,
- isAccountUrlValid,
- isUserUsernameValid
-} from '../../helpers'
-import { CONFIG, CONSTRAINTS_FIELDS } from '../../initializers/constants'
-import { sendDeleteAccount } from '../../lib/activitypub/send/send-delete'
-
-import { addMethodsToModel } from '../utils'
-import { AccountAttributes, AccountInstance, AccountMethods } from './account-interface'
-
-let Account: Sequelize.Model<AccountInstance, AccountAttributes>
-let load: AccountMethods.Load
-let loadApplication: AccountMethods.LoadApplication
-let loadByUUID: AccountMethods.LoadByUUID
-let loadByUrl: AccountMethods.LoadByUrl
-let loadLocalByName: AccountMethods.LoadLocalByName
-let loadByNameAndHost: AccountMethods.LoadByNameAndHost
-let isOwned: AccountMethods.IsOwned
-let toActivityPubObject: AccountMethods.ToActivityPubObject
-let toFormattedJSON: AccountMethods.ToFormattedJSON
-let getFollowerSharedInboxUrls: AccountMethods.GetFollowerSharedInboxUrls
-let getFollowingUrl: AccountMethods.GetFollowingUrl
-let getFollowersUrl: AccountMethods.GetFollowersUrl
-let getPublicKeyUrl: AccountMethods.GetPublicKeyUrl
-
-export default function defineAccount (sequelize: Sequelize.Sequelize, DataTypes: Sequelize.DataTypes) {
- Account = sequelize.define<AccountInstance, AccountAttributes>('Account',
+ AllowNull,
+ BeforeDestroy,
+ BelongsTo,
+ Column,
+ CreatedAt,
+ DataType,
+ Default,
+ DefaultScope,
+ ForeignKey,
+ HasMany,
+ Is,
+ Model,
+ Scopes,
+ Table,
+ UpdatedAt
+} from 'sequelize-typescript'
+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 { ApplicationModel } from '../application/application'
+import { ServerModel } from '../server/server'
+import { getSort, throwIfNotValid } from '../utils'
+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, MAccountAP, MAccountDefault, MAccountFormattable, MAccountSummaryFormattable, MAccount } from '../../types/models'
+import * as Bluebird from 'bluebird'
+import { ModelCache } from '@server/models/model-cache'
+import { VideoModel } from '../video/video'
+
+export enum ScopeNames {
+ SUMMARY = 'SUMMARY'
+}
+
+export type SummaryOptions = {
+ whereActor?: WhereOptions
+ withAccountBlockerIds?: number[]
+}
+
+@DefaultScope(() => ({
+ include: [
{
- uuid: {
- type: DataTypes.UUID,
- defaultValue: DataTypes.UUIDV4,
- allowNull: false,
- validate: {
- isUUID: 4
- }
- },
- name: {
- type: DataTypes.STRING,
- allowNull: false,
- validate: {
- nameValid: value => {
- const res = isUserUsernameValid(value)
- if (res === false) throw new Error('Name is not valid.')
- }
- }
- },
- url: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max),
- allowNull: false,
- validate: {
- urlValid: value => {
- const res = isAccountUrlValid(value)
- if (res === false) throw new Error('URL is not valid.')
- }
- }
- },
- publicKey: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.PUBLIC_KEY.max),
- allowNull: true,
- validate: {
- publicKeyValid: value => {
- const res = isAccountPublicKeyValid(value)
- if (res === false) throw new Error('Public key is not valid.')
- }
- }
- },
- privateKey: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.PRIVATE_KEY.max),
- allowNull: true,
- validate: {
- privateKeyValid: value => {
- const res = isAccountPrivateKeyValid(value)
- if (res === false) throw new Error('Private key is not valid.')
- }
- }
- },
- followersCount: {
- type: DataTypes.INTEGER,
- allowNull: false,
- validate: {
- followersCountValid: value => {
- const res = isAccountFollowersCountValid(value)
- if (res === false) throw new Error('Followers count is not valid.')
- }
- }
- },
- followingCount: {
- type: DataTypes.INTEGER,
- allowNull: false,
- validate: {
- followingCountValid: value => {
- const res = isAccountFollowingCountValid(value)
- if (res === false) throw new Error('Following count is not valid.')
- }
- }
- },
- inboxUrl: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max),
- allowNull: false,
- validate: {
- inboxUrlValid: value => {
- const res = isAccountInboxValid(value)
- if (res === false) throw new Error('Inbox URL is not valid.')
- }
- }
- },
- outboxUrl: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max),
- allowNull: false,
- validate: {
- outboxUrlValid: value => {
- const res = isAccountOutboxValid(value)
- if (res === false) throw new Error('Outbox URL is not valid.')
- }
- }
- },
- sharedInboxUrl: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max),
- allowNull: false,
- validate: {
- sharedInboxUrlValid: value => {
- const res = isAccountSharedInboxValid(value)
- if (res === false) throw new Error('Shared inbox URL is not valid.')
- }
+ model: ActorModel, // Default scope includes avatar and server
+ required: true
+ }
+ ]
+}))
+@Scopes(() => ({
+ [ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => {
+ const whereActor = options.whereActor || undefined
+
+ const serverInclude: IncludeOptions = {
+ attributes: [ 'host' ],
+ model: ServerModel.unscoped(),
+ required: false
+ }
+
+ const query: FindOptions = {
+ attributes: [ 'id', 'name' ],
+ include: [
+ {
+ attributes: [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
+ model: ActorModel.unscoped(),
+ required: true,
+ where: whereActor,
+ include: [
+ serverInclude,
+
+ {
+ model: AvatarModel.unscoped(),
+ required: false
+ }
+ ]
}
- },
- followersUrl: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max),
- allowNull: false,
- validate: {
- followersUrlValid: value => {
- const res = isAccountFollowersValid(value)
- if (res === false) throw new Error('Followers URL is not valid.')
+ ]
+ }
+
+ if (options.withAccountBlockerIds) {
+ query.include.push({
+ attributes: [ 'id' ],
+ model: AccountBlocklistModel.unscoped(),
+ as: 'BlockedAccounts',
+ required: false,
+ where: {
+ accountId: {
+ [Op.in]: options.withAccountBlockerIds
}
}
- },
- followingUrl: {
- type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max),
- allowNull: false,
- validate: {
- followingUrlValid: value => {
- const res = isAccountFollowingValid(value)
- if (res === false) throw new Error('Following URL is not valid.')
+ })
+
+ serverInclude.include = [
+ {
+ attributes: [ 'id' ],
+ model: ServerBlocklistModel.unscoped(),
+ required: false,
+ where: {
+ accountId: {
+ [Op.in]: options.withAccountBlockerIds
+ }
}
}
- }
+ ]
+ }
+
+ return query
+ }
+}))
+@Table({
+ tableName: 'account',
+ indexes: [
+ {
+ fields: [ 'actorId' ],
+ unique: true
},
{
- indexes: [
- {
- fields: [ 'name' ]
- },
- {
- fields: [ 'serverId' ]
- },
- {
- fields: [ 'userId' ],
- unique: true
- },
- {
- fields: [ 'applicationId' ],
- unique: true
- },
- {
- fields: [ 'name', 'serverId', 'applicationId' ],
- unique: true
- }
- ],
- hooks: { afterDestroy }
+ fields: [ 'applicationId' ]
+ },
+ {
+ fields: [ 'userId' ]
}
- )
-
- const classMethods = [
- associate,
- loadApplication,
- load,
- loadByUUID,
- loadByUrl,
- loadLocalByName,
- loadByNameAndHost
]
- const instanceMethods = [
- isOwned,
- toActivityPubObject,
- toFormattedJSON,
- getFollowerSharedInboxUrls,
- getFollowingUrl,
- getFollowersUrl,
- getPublicKeyUrl
- ]
- addMethodsToModel(Account, classMethods, instanceMethods)
+})
+export class AccountModel extends Model<AccountModel> {
- return Account
-}
+ @AllowNull(false)
+ @Column
+ name: string
-// ---------------------------------------------------------------------------
+ @AllowNull(true)
+ @Default(null)
+ @Is('AccountDescription', value => throwIfNotValid(value, isAccountDescriptionValid, 'description', true))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.USERS.DESCRIPTION.max))
+ description: string
-function associate (models) {
- Account.belongsTo(models.Server, {
+ @CreatedAt
+ createdAt: Date
+
+ @UpdatedAt
+ updatedAt: Date
+
+ @ForeignKey(() => ActorModel)
+ @Column
+ actorId: number
+
+ @BelongsTo(() => ActorModel, {
foreignKey: {
- name: 'serverId',
- allowNull: true
+ allowNull: false
},
onDelete: 'cascade'
})
+ Actor: ActorModel
- Account.belongsTo(models.User, {
+ @ForeignKey(() => UserModel)
+ @Column
+ userId: number
+
+ @BelongsTo(() => UserModel, {
foreignKey: {
- name: 'userId',
allowNull: true
},
onDelete: 'cascade'
})
+ User: UserModel
+
+ @ForeignKey(() => ApplicationModel)
+ @Column
+ applicationId: number
- Account.belongsTo(models.Application, {
+ @BelongsTo(() => ApplicationModel, {
foreignKey: {
- name: 'applicationId',
allowNull: true
},
onDelete: 'cascade'
})
+ Application: ApplicationModel
- Account.hasMany(models.VideoChannel, {
+ @HasMany(() => VideoChannelModel, {
foreignKey: {
- name: 'accountId',
allowNull: false
},
onDelete: 'cascade',
hooks: true
})
+ VideoChannels: VideoChannelModel[]
- Account.hasMany(models.AccountFollow, {
+ @HasMany(() => VideoPlaylistModel, {
foreignKey: {
- name: 'accountId',
allowNull: false
},
- onDelete: 'cascade'
+ onDelete: 'cascade',
+ hooks: true
})
+ VideoPlaylists: VideoPlaylistModel[]
- Account.hasMany(models.AccountFollow, {
+ @HasMany(() => VideoCommentModel, {
+ foreignKey: {
+ allowNull: true
+ },
+ onDelete: 'cascade',
+ hooks: true
+ })
+ VideoComments: VideoCommentModel[]
+
+ @HasMany(() => AccountBlocklistModel, {
foreignKey: {
name: 'targetAccountId',
allowNull: false
},
- as: 'followers',
- onDelete: 'cascade'
+ as: 'BlockedAccounts',
+ onDelete: 'CASCADE'
})
-}
-
-function afterDestroy (account: AccountInstance) {
- if (account.isOwned()) {
- return sendDeleteAccount(account, undefined)
- }
+ BlockedAccounts: AccountBlocklistModel[]
- return undefined
-}
+ @BeforeDestroy
+ static async sendDeleteIfOwned (instance: AccountModel, options) {
+ if (!instance.Actor) {
+ instance.Actor = await instance.$get('Actor', { transaction: options.transaction })
+ }
-toFormattedJSON = function (this: AccountInstance) {
- let host = CONFIG.WEBSERVER.HOST
- let score: number
+ await ActorFollowModel.removeFollowsOf(instance.Actor.id, options.transaction)
+ if (instance.isOwned()) {
+ return sendDeleteActor(instance.Actor, options.transaction)
+ }
- if (this.Server) {
- host = this.Server.host
- score = this.Server.score as number
+ return undefined
}
- const json = {
- id: this.id,
- host,
- score,
- name: this.name,
- createdAt: this.createdAt,
- updatedAt: this.updatedAt
+ static load (id: number, transaction?: Transaction): Bluebird<MAccountDefault> {
+ return AccountModel.findByPk(id, { transaction })
}
- return json
-}
-
-toActivityPubObject = function (this: AccountInstance) {
- const type = this.serverId ? 'Application' as 'Application' : 'Person' as 'Person'
-
- const json = {
- type,
- id: this.url,
- following: this.getFollowingUrl(),
- followers: this.getFollowersUrl(),
- inbox: this.inboxUrl,
- outbox: this.outboxUrl,
- preferredUsername: this.name,
- url: this.url,
- name: this.name,
- endpoints: {
- sharedInbox: this.sharedInboxUrl
- },
- uuid: this.uuid,
- publicKey: {
- id: this.getPublicKeyUrl(),
- owner: this.url,
- publicKeyPem: this.publicKey
- }
- }
+ static loadByNameWithHost (nameWithHost: string): Bluebird<MAccountDefault> {
+ const [ accountName, host ] = nameWithHost.split('@')
- return activityPubContextify(json)
-}
+ if (!host || host === WEBSERVER.HOST) return AccountModel.loadLocalByName(accountName)
-isOwned = function (this: AccountInstance) {
- return this.serverId === null
-}
+ return AccountModel.loadByNameAndHost(accountName, host)
+ }
-getFollowerSharedInboxUrls = function (this: AccountInstance) {
- const query: Sequelize.FindOptions<AccountAttributes> = {
- attributes: [ 'sharedInboxUrl' ],
- include: [
- {
- model: Account['sequelize'].models.AccountFollow,
- required: true,
- as: 'followers',
+ static loadLocalByName (name: string): Bluebird<MAccountDefault> {
+ const fun = () => {
+ const query = {
where: {
- targetAccountId: this.id
- }
+ [Op.or]: [
+ {
+ userId: {
+ [Op.ne]: null
+ }
+ },
+ {
+ applicationId: {
+ [Op.ne]: null
+ }
+ }
+ ]
+ },
+ include: [
+ {
+ model: ActorModel,
+ required: true,
+ where: {
+ preferredUsername: name
+ }
+ }
+ ]
}
- ]
- }
- return Account.findAll(query)
- .then(accounts => accounts.map(a => a.sharedInboxUrl))
-}
-
-getFollowingUrl = function (this: AccountInstance) {
- return this.url + '/following'
-}
+ return AccountModel.findOne(query)
+ }
-getFollowersUrl = function (this: AccountInstance) {
- return this.url + '/followers'
-}
+ 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
+ })
+ }
-getPublicKeyUrl = function (this: AccountInstance) {
- return this.url + '#main-key'
-}
+ static loadByNameAndHost (name: string, host: string): Bluebird<MAccountDefault> {
+ const query = {
+ include: [
+ {
+ model: ActorModel,
+ required: true,
+ where: {
+ preferredUsername: name
+ },
+ include: [
+ {
+ model: ServerModel,
+ required: true,
+ where: {
+ host
+ }
+ }
+ ]
+ }
+ ]
+ }
-// ------------------------------ STATICS ------------------------------
+ return AccountModel.findOne(query)
+ }
-loadApplication = function () {
- return Account.findOne({
- include: [
- {
- model: Account['sequelize'].models.Application,
- required: true
- }
- ]
- })
-}
+ static loadByUrl (url: string, transaction?: Transaction): Bluebird<MAccountDefault> {
+ const query = {
+ include: [
+ {
+ model: ActorModel,
+ required: true,
+ where: {
+ url
+ }
+ }
+ ],
+ transaction
+ }
-load = function (id: number) {
- return Account.findById(id)
-}
+ return AccountModel.findOne(query)
+ }
-loadByUUID = function (uuid: string) {
- const query: Sequelize.FindOptions<AccountAttributes> = {
- where: {
- uuid
+ static listForApi (start: number, count: number, sort: string) {
+ const query = {
+ offset: start,
+ limit: count,
+ order: getSort(sort)
}
- }
- return Account.findOne(query)
-}
+ return AccountModel.findAndCountAll(query)
+ .then(({ rows, count }) => {
+ return {
+ data: rows,
+ total: count
+ }
+ })
+ }
-loadLocalByName = function (name: string) {
- const query: Sequelize.FindOptions<AccountAttributes> = {
- where: {
- name,
- [Sequelize.Op.or]: [
+ static loadAccountIdFromVideo (videoId: number): Bluebird<MAccount> {
+ const query = {
+ include: [
{
- userId: {
- [Sequelize.Op.ne]: null
- }
- },
+ 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[]> {
+ const query = {
+ attributes: [ ],
+ offset: 0,
+ order: getSort(sort),
+ include: [
{
- applicationId: {
- [Sequelize.Op.ne]: null
+ attributes: [ 'preferredUsername', 'serverId' ],
+ model: ActorModel.unscoped(),
+ where: {
+ serverId: null
}
}
]
}
+
+ return AccountModel
+ .unscoped()
+ .findAll(query)
}
- return Account.findOne(query)
-}
+ toFormattedJSON (this: MAccountFormattable): Account {
+ const actor = this.Actor.toFormattedJSON()
+ const account = {
+ id: this.id,
+ displayName: this.getDisplayName(),
+ description: this.description,
+ createdAt: this.createdAt,
+ updatedAt: this.updatedAt,
+ userId: this.userId ? this.userId : undefined
+ }
-loadByNameAndHost = function (name: string, host: string) {
- const query: Sequelize.FindOptions<AccountAttributes> = {
- where: {
- name
- },
- include: [
- {
- model: Account['sequelize'].models.Server,
- required: true,
- where: {
- host
- }
- }
- ]
+ return Object.assign(actor, account)
}
- return Account.findOne(query)
-}
+ toFormattedSummaryJSON (this: MAccountSummaryFormattable): AccountSummary {
+ const actor = this.Actor.toFormattedSummaryJSON()
-loadByUrl = function (url: string, transaction?: Sequelize.Transaction) {
- const query: Sequelize.FindOptions<AccountAttributes> = {
- where: {
- url
- },
- transaction
+ return {
+ id: this.id,
+ name: actor.name,
+ displayName: this.getDisplayName(),
+ url: actor.url,
+ host: actor.host,
+ avatar: actor.avatar
+ }
+ }
+
+ toActivityPubObject (this: MAccountAP) {
+ const obj = this.Actor.toActivityPubObject(this.name)
+
+ return Object.assign(obj, {
+ summary: this.description
+ })
}
- return Account.findOne(query)
+ isOwned () {
+ return this.Actor.isOwned()
+ }
+
+ isOutdated () {
+ return this.Actor.isOutdated()
+ }
+
+ getDisplayName () {
+ return this.name
+ }
+
+ isBlocked () {
+ return this.BlockedAccounts && this.BlockedAccounts.length !== 0
+ }
}
projects / oweals / peertube.git / blobdiff