]>
Commit | Line | Data |
---|---|---|
e4f97bab C |
1 | import * as Sequelize from 'sequelize' |
2 | ||
3 | import { | |
4 | isUserUsernameValid, | |
5 | isAccountPublicKeyValid, | |
6 | isAccountUrlValid, | |
7 | isAccountPrivateKeyValid, | |
8 | isAccountFollowersCountValid, | |
9 | isAccountFollowingCountValid, | |
10 | isAccountInboxValid, | |
11 | isAccountOutboxValid, | |
12 | isAccountSharedInboxValid, | |
13 | isAccountFollowersValid, | |
14 | isAccountFollowingValid, | |
15 | activityPubContextify | |
16 | } from '../../helpers' | |
17 | ||
7a7724e6 | 18 | import { addMethodsToModel, getSort } from '../utils' |
e4f97bab C |
19 | import { |
20 | AccountInstance, | |
21 | AccountAttributes, | |
22 | ||
23 | AccountMethods | |
24 | } from './account-interface' | |
7a7724e6 | 25 | import { sendDeleteAccount } from '../../lib/activitypub/send-request' |
51548b31 | 26 | import { CONFIG, CONSTRAINTS_FIELDS } from '../../initializers/constants' |
e4f97bab C |
27 | |
28 | let Account: Sequelize.Model<AccountInstance, AccountAttributes> | |
60862425 | 29 | let loadAccountByServerAndUUID: AccountMethods.LoadAccountByServerAndUUID |
e4f97bab | 30 | let load: AccountMethods.Load |
7a7724e6 | 31 | let loadApplication: AccountMethods.LoadApplication |
e4f97bab C |
32 | let loadByUUID: AccountMethods.LoadByUUID |
33 | let loadByUrl: AccountMethods.LoadByUrl | |
350e31d6 C |
34 | let loadLocalByName: AccountMethods.LoadLocalByName |
35 | let loadByNameAndHost: AccountMethods.LoadByNameAndHost | |
e4f97bab | 36 | let listOwned: AccountMethods.ListOwned |
e4f97bab C |
37 | let isOwned: AccountMethods.IsOwned |
38 | let toActivityPubObject: AccountMethods.ToActivityPubObject | |
7a7724e6 | 39 | let toFormattedJSON: AccountMethods.ToFormattedJSON |
e4f97bab C |
40 | let getFollowerSharedInboxUrls: AccountMethods.GetFollowerSharedInboxUrls |
41 | let getFollowingUrl: AccountMethods.GetFollowingUrl | |
42 | let getFollowersUrl: AccountMethods.GetFollowersUrl | |
43 | let getPublicKeyUrl: AccountMethods.GetPublicKeyUrl | |
44 | ||
45 | export default function defineAccount (sequelize: Sequelize.Sequelize, DataTypes: Sequelize.DataTypes) { | |
46 | Account = sequelize.define<AccountInstance, AccountAttributes>('Account', | |
47 | { | |
48 | uuid: { | |
49 | type: DataTypes.UUID, | |
50 | defaultValue: DataTypes.UUIDV4, | |
51 | allowNull: false, | |
52 | validate: { | |
53 | isUUID: 4 | |
54 | } | |
55 | }, | |
56 | name: { | |
57 | type: DataTypes.STRING, | |
58 | allowNull: false, | |
59 | validate: { | |
e34c85e5 | 60 | nameValid: value => { |
e4f97bab | 61 | const res = isUserUsernameValid(value) |
e34c85e5 | 62 | if (res === false) throw new Error('Name is not valid.') |
e4f97bab C |
63 | } |
64 | } | |
65 | }, | |
66 | url: { | |
e34c85e5 | 67 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max), |
e4f97bab C |
68 | allowNull: false, |
69 | validate: { | |
70 | urlValid: value => { | |
71 | const res = isAccountUrlValid(value) | |
72 | if (res === false) throw new Error('URL is not valid.') | |
73 | } | |
74 | } | |
75 | }, | |
76 | publicKey: { | |
e34c85e5 | 77 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.PUBLIC_KEY.max), |
e4f97bab C |
78 | allowNull: false, |
79 | validate: { | |
80 | publicKeyValid: value => { | |
81 | const res = isAccountPublicKeyValid(value) | |
82 | if (res === false) throw new Error('Public key is not valid.') | |
83 | } | |
84 | } | |
85 | }, | |
86 | privateKey: { | |
e34c85e5 | 87 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.PRIVATE_KEY.max), |
350e31d6 | 88 | allowNull: true, |
e4f97bab C |
89 | validate: { |
90 | privateKeyValid: value => { | |
91 | const res = isAccountPrivateKeyValid(value) | |
92 | if (res === false) throw new Error('Private key is not valid.') | |
93 | } | |
94 | } | |
95 | }, | |
96 | followersCount: { | |
97 | type: DataTypes.INTEGER, | |
98 | allowNull: false, | |
99 | validate: { | |
100 | followersCountValid: value => { | |
101 | const res = isAccountFollowersCountValid(value) | |
102 | if (res === false) throw new Error('Followers count is not valid.') | |
103 | } | |
104 | } | |
105 | }, | |
106 | followingCount: { | |
107 | type: DataTypes.INTEGER, | |
108 | allowNull: false, | |
109 | validate: { | |
e34c85e5 | 110 | followingCountValid: value => { |
e4f97bab C |
111 | const res = isAccountFollowingCountValid(value) |
112 | if (res === false) throw new Error('Following count is not valid.') | |
113 | } | |
114 | } | |
115 | }, | |
116 | inboxUrl: { | |
e34c85e5 | 117 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max), |
e4f97bab C |
118 | allowNull: false, |
119 | validate: { | |
120 | inboxUrlValid: value => { | |
121 | const res = isAccountInboxValid(value) | |
122 | if (res === false) throw new Error('Inbox URL is not valid.') | |
123 | } | |
124 | } | |
125 | }, | |
126 | outboxUrl: { | |
e34c85e5 | 127 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max), |
e4f97bab C |
128 | allowNull: false, |
129 | validate: { | |
130 | outboxUrlValid: value => { | |
131 | const res = isAccountOutboxValid(value) | |
132 | if (res === false) throw new Error('Outbox URL is not valid.') | |
133 | } | |
134 | } | |
135 | }, | |
136 | sharedInboxUrl: { | |
e34c85e5 | 137 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max), |
e4f97bab C |
138 | allowNull: false, |
139 | validate: { | |
140 | sharedInboxUrlValid: value => { | |
141 | const res = isAccountSharedInboxValid(value) | |
142 | if (res === false) throw new Error('Shared inbox URL is not valid.') | |
143 | } | |
144 | } | |
145 | }, | |
146 | followersUrl: { | |
e34c85e5 | 147 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max), |
e4f97bab C |
148 | allowNull: false, |
149 | validate: { | |
150 | followersUrlValid: value => { | |
151 | const res = isAccountFollowersValid(value) | |
152 | if (res === false) throw new Error('Followers URL is not valid.') | |
153 | } | |
154 | } | |
155 | }, | |
156 | followingUrl: { | |
e34c85e5 | 157 | type: DataTypes.STRING(CONSTRAINTS_FIELDS.ACCOUNTS.URL.max), |
e4f97bab C |
158 | allowNull: false, |
159 | validate: { | |
160 | followingUrlValid: value => { | |
161 | const res = isAccountFollowingValid(value) | |
162 | if (res === false) throw new Error('Following URL is not valid.') | |
163 | } | |
164 | } | |
165 | } | |
166 | }, | |
167 | { | |
168 | indexes: [ | |
169 | { | |
170 | fields: [ 'name' ] | |
171 | }, | |
172 | { | |
60862425 | 173 | fields: [ 'serverId' ] |
e4f97bab C |
174 | }, |
175 | { | |
176 | fields: [ 'userId' ], | |
177 | unique: true | |
178 | }, | |
179 | { | |
180 | fields: [ 'applicationId' ], | |
181 | unique: true | |
182 | }, | |
183 | { | |
60862425 | 184 | fields: [ 'name', 'serverId', 'applicationId' ], |
e4f97bab C |
185 | unique: true |
186 | } | |
187 | ], | |
188 | hooks: { afterDestroy } | |
189 | } | |
190 | ) | |
191 | ||
192 | const classMethods = [ | |
193 | associate, | |
60862425 | 194 | loadAccountByServerAndUUID, |
7a7724e6 | 195 | loadApplication, |
e4f97bab C |
196 | load, |
197 | loadByUUID, | |
ce548a10 | 198 | loadByUrl, |
350e31d6 C |
199 | loadLocalByName, |
200 | loadByNameAndHost, | |
51548b31 | 201 | listOwned |
e4f97bab C |
202 | ] |
203 | const instanceMethods = [ | |
204 | isOwned, | |
205 | toActivityPubObject, | |
7a7724e6 | 206 | toFormattedJSON, |
e4f97bab C |
207 | getFollowerSharedInboxUrls, |
208 | getFollowingUrl, | |
209 | getFollowersUrl, | |
210 | getPublicKeyUrl | |
211 | ] | |
212 | addMethodsToModel(Account, classMethods, instanceMethods) | |
213 | ||
214 | return Account | |
215 | } | |
216 | ||
217 | // --------------------------------------------------------------------------- | |
218 | ||
219 | function associate (models) { | |
60862425 | 220 | Account.belongsTo(models.Server, { |
e4f97bab | 221 | foreignKey: { |
60862425 | 222 | name: 'serverId', |
e4f97bab C |
223 | allowNull: true |
224 | }, | |
225 | onDelete: 'cascade' | |
226 | }) | |
227 | ||
228 | Account.belongsTo(models.User, { | |
229 | foreignKey: { | |
230 | name: 'userId', | |
231 | allowNull: true | |
232 | }, | |
233 | onDelete: 'cascade' | |
234 | }) | |
235 | ||
236 | Account.belongsTo(models.Application, { | |
237 | foreignKey: { | |
e34c85e5 | 238 | name: 'applicationId', |
e4f97bab C |
239 | allowNull: true |
240 | }, | |
241 | onDelete: 'cascade' | |
242 | }) | |
243 | ||
244 | Account.hasMany(models.VideoChannel, { | |
245 | foreignKey: { | |
246 | name: 'accountId', | |
247 | allowNull: false | |
248 | }, | |
249 | onDelete: 'cascade', | |
250 | hooks: true | |
251 | }) | |
252 | ||
e34c85e5 | 253 | Account.hasMany(models.AccountFollow, { |
e4f97bab C |
254 | foreignKey: { |
255 | name: 'accountId', | |
256 | allowNull: false | |
257 | }, | |
7a7724e6 | 258 | as: 'following', |
e4f97bab C |
259 | onDelete: 'cascade' |
260 | }) | |
261 | ||
e34c85e5 | 262 | Account.hasMany(models.AccountFollow, { |
e4f97bab C |
263 | foreignKey: { |
264 | name: 'targetAccountId', | |
265 | allowNull: false | |
266 | }, | |
7a7724e6 | 267 | as: 'followers', |
e4f97bab C |
268 | onDelete: 'cascade' |
269 | }) | |
270 | } | |
271 | ||
272 | function afterDestroy (account: AccountInstance) { | |
273 | if (account.isOwned()) { | |
7a7724e6 | 274 | return sendDeleteAccount(account, undefined) |
e4f97bab C |
275 | } |
276 | ||
277 | return undefined | |
278 | } | |
279 | ||
7a7724e6 | 280 | toFormattedJSON = function (this: AccountInstance) { |
60862425 C |
281 | let host = CONFIG.WEBSERVER.HOST |
282 | let score: number | |
283 | ||
284 | if (this.Server) { | |
285 | host = this.Server.host | |
286 | score = this.Server.score as number | |
287 | } | |
51548b31 | 288 | |
7a7724e6 C |
289 | const json = { |
290 | id: this.id, | |
51548b31 | 291 | host, |
60862425 C |
292 | score, |
293 | name: this.name, | |
294 | createdAt: this.createdAt, | |
295 | updatedAt: this.updatedAt | |
7a7724e6 C |
296 | } |
297 | ||
298 | return json | |
299 | } | |
300 | ||
e4f97bab | 301 | toActivityPubObject = function (this: AccountInstance) { |
60862425 | 302 | const type = this.serverId ? 'Application' as 'Application' : 'Person' as 'Person' |
e4f97bab C |
303 | |
304 | const json = { | |
305 | type, | |
306 | id: this.url, | |
307 | following: this.getFollowingUrl(), | |
308 | followers: this.getFollowersUrl(), | |
309 | inbox: this.inboxUrl, | |
310 | outbox: this.outboxUrl, | |
311 | preferredUsername: this.name, | |
312 | url: this.url, | |
313 | name: this.name, | |
314 | endpoints: { | |
315 | sharedInbox: this.sharedInboxUrl | |
316 | }, | |
317 | uuid: this.uuid, | |
318 | publicKey: { | |
319 | id: this.getPublicKeyUrl(), | |
320 | owner: this.url, | |
321 | publicKeyPem: this.publicKey | |
322 | } | |
323 | } | |
324 | ||
325 | return activityPubContextify(json) | |
326 | } | |
327 | ||
328 | isOwned = function (this: AccountInstance) { | |
60862425 | 329 | return this.serverId === null |
e4f97bab C |
330 | } |
331 | ||
332 | getFollowerSharedInboxUrls = function (this: AccountInstance) { | |
333 | const query: Sequelize.FindOptions<AccountAttributes> = { | |
334 | attributes: [ 'sharedInboxUrl' ], | |
335 | include: [ | |
336 | { | |
e34c85e5 | 337 | model: Account['sequelize'].models.AccountFollow, |
350e31d6 C |
338 | required: true, |
339 | as: 'followers', | |
e4f97bab C |
340 | where: { |
341 | targetAccountId: this.id | |
342 | } | |
343 | } | |
344 | ] | |
345 | } | |
346 | ||
347 | return Account.findAll(query) | |
348 | .then(accounts => accounts.map(a => a.sharedInboxUrl)) | |
349 | } | |
350 | ||
351 | getFollowingUrl = function (this: AccountInstance) { | |
51548b31 | 352 | return this.url + '/following' |
e4f97bab C |
353 | } |
354 | ||
355 | getFollowersUrl = function (this: AccountInstance) { | |
356 | return this.url + '/followers' | |
357 | } | |
358 | ||
359 | getPublicKeyUrl = function (this: AccountInstance) { | |
360 | return this.url + '#main-key' | |
361 | } | |
362 | ||
363 | // ------------------------------ STATICS ------------------------------ | |
364 | ||
365 | listOwned = function () { | |
366 | const query: Sequelize.FindOptions<AccountAttributes> = { | |
367 | where: { | |
60862425 | 368 | serverId: null |
e4f97bab C |
369 | } |
370 | } | |
371 | ||
372 | return Account.findAll(query) | |
373 | } | |
374 | ||
7a7724e6 C |
375 | loadApplication = function () { |
376 | return Account.findOne({ | |
377 | include: [ | |
378 | { | |
350e31d6 | 379 | model: Account['sequelize'].models.Application, |
7a7724e6 C |
380 | required: true |
381 | } | |
382 | ] | |
383 | }) | |
e4f97bab C |
384 | } |
385 | ||
386 | load = function (id: number) { | |
387 | return Account.findById(id) | |
388 | } | |
389 | ||
390 | loadByUUID = function (uuid: string) { | |
391 | const query: Sequelize.FindOptions<AccountAttributes> = { | |
392 | where: { | |
393 | uuid | |
394 | } | |
395 | } | |
396 | ||
397 | return Account.findOne(query) | |
398 | } | |
399 | ||
350e31d6 | 400 | loadLocalByName = function (name: string) { |
e4f97bab C |
401 | const query: Sequelize.FindOptions<AccountAttributes> = { |
402 | where: { | |
403 | name, | |
350e31d6 C |
404 | [Sequelize.Op.or]: [ |
405 | { | |
406 | userId: { | |
407 | [Sequelize.Op.ne]: null | |
408 | } | |
409 | }, | |
410 | { | |
411 | applicationId: { | |
412 | [Sequelize.Op.ne]: null | |
413 | } | |
414 | } | |
415 | ] | |
416 | } | |
417 | } | |
418 | ||
419 | return Account.findOne(query) | |
420 | } | |
421 | ||
422 | loadByNameAndHost = function (name: string, host: string) { | |
423 | const query: Sequelize.FindOptions<AccountAttributes> = { | |
424 | where: { | |
425 | name | |
7a7724e6 C |
426 | }, |
427 | include: [ | |
428 | { | |
60862425 | 429 | model: Account['sequelize'].models.Server, |
350e31d6 | 430 | required: true, |
7a7724e6 C |
431 | where: { |
432 | host | |
433 | } | |
434 | } | |
435 | ] | |
e4f97bab C |
436 | } |
437 | ||
438 | return Account.findOne(query) | |
439 | } | |
440 | ||
ce548a10 | 441 | loadByUrl = function (url: string, transaction?: Sequelize.Transaction) { |
e4f97bab C |
442 | const query: Sequelize.FindOptions<AccountAttributes> = { |
443 | where: { | |
444 | url | |
ce548a10 C |
445 | }, |
446 | transaction | |
e4f97bab C |
447 | } |
448 | ||
449 | return Account.findOne(query) | |
450 | } | |
451 | ||
60862425 | 452 | loadAccountByServerAndUUID = function (uuid: string, serverId: number, transaction: Sequelize.Transaction) { |
e4f97bab C |
453 | const query: Sequelize.FindOptions<AccountAttributes> = { |
454 | where: { | |
60862425 | 455 | serverId, |
e4f97bab C |
456 | uuid |
457 | }, | |
458 | transaction | |
459 | } | |
460 | ||
461 | return Account.find(query) | |
462 | } |