]>
Commit | Line | Data |
---|---|---|
50d6de9c | 1 | import { values } from 'lodash' |
47564bbe | 2 | import { extname } from 'path' |
fadf619a | 3 | import { |
2422c46b C |
4 | AllowNull, |
5 | BelongsTo, | |
6 | Column, | |
7 | CreatedAt, | |
8 | DataType, | |
2422c46b C |
9 | DefaultScope, |
10 | ForeignKey, | |
11 | HasMany, | |
12 | HasOne, | |
13 | Is, | |
2422c46b C |
14 | Model, |
15 | Scopes, | |
16 | Table, | |
17 | UpdatedAt | |
fadf619a | 18 | } from 'sequelize-typescript' |
50d6de9c | 19 | import { ActivityPubActorType } from '../../../shared/models/activitypub' |
fadf619a | 20 | import { Avatar } from '../../../shared/models/avatars/avatar.model' |
da854ddd | 21 | import { activityPubContextify } from '../../helpers/activitypub' |
fadf619a | 22 | import { |
2422c46b C |
23 | isActorFollowersCountValid, |
24 | isActorFollowingCountValid, | |
25 | isActorPreferredUsernameValid, | |
26 | isActorPrivateKeyValid, | |
da854ddd C |
27 | isActorPublicKeyValid |
28 | } from '../../helpers/custom-validators/activitypub/actor' | |
29 | import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc' | |
e4a686b4 | 30 | import { ACTIVITY_PUB, ACTIVITY_PUB_ACTOR_TYPES, CONSTRAINTS_FIELDS, SERVER_ACTOR_NAME, WEBSERVER } from '../../initializers/constants' |
50d6de9c | 31 | import { AccountModel } from '../account/account' |
fadf619a C |
32 | import { AvatarModel } from '../avatar/avatar' |
33 | import { ServerModel } from '../server/server' | |
9f79ade6 | 34 | import { isOutdated, throwIfNotValid } from '../utils' |
50d6de9c C |
35 | import { VideoChannelModel } from '../video/video-channel' |
36 | import { ActorFollowModel } from './actor-follow' | |
e5565833 | 37 | import { VideoModel } from '../video/video' |
1ca9f7c3 C |
38 | import { |
39 | MActor, | |
40 | MActorAccountChannelId, | |
b5fecbf4 | 41 | MActorAP, |
1ca9f7c3 | 42 | MActorFormattable, |
b5fecbf4 C |
43 | MActorFull, |
44 | MActorHost, | |
1ca9f7c3 | 45 | MActorServer, |
47581df0 C |
46 | MActorSummaryFormattable, |
47 | MActorWithInboxes | |
1ca9f7c3 | 48 | } from '../../typings/models' |
453e83ea | 49 | import * as Bluebird from 'bluebird' |
941c5eac | 50 | import { Op, Transaction } from 'sequelize' |
fadf619a | 51 | |
50d6de9c C |
52 | enum ScopeNames { |
53 | FULL = 'FULL' | |
54 | } | |
55 | ||
f37dc0dd C |
56 | export const unusedActorAttributesForAPI = [ |
57 | 'publicKey', | |
58 | 'privateKey', | |
59 | 'inboxUrl', | |
60 | 'outboxUrl', | |
61 | 'sharedInboxUrl', | |
62 | 'followersUrl', | |
aa55a4da | 63 | 'followingUrl', |
f5b0af50 C |
64 | 'url', |
65 | 'createdAt', | |
66 | 'updatedAt' | |
f37dc0dd C |
67 | ] |
68 | ||
3acc5084 | 69 | @DefaultScope(() => ({ |
ce33ee01 C |
70 | include: [ |
71 | { | |
3acc5084 | 72 | model: ServerModel, |
ce33ee01 | 73 | required: false |
c5911fd3 C |
74 | }, |
75 | { | |
3acc5084 | 76 | model: AvatarModel, |
c5911fd3 | 77 | required: false |
ce33ee01 C |
78 | } |
79 | ] | |
3acc5084 C |
80 | })) |
81 | @Scopes(() => ({ | |
50d6de9c C |
82 | [ScopeNames.FULL]: { |
83 | include: [ | |
84 | { | |
3acc5084 | 85 | model: AccountModel.unscoped(), |
50d6de9c C |
86 | required: false |
87 | }, | |
88 | { | |
3acc5084 | 89 | model: VideoChannelModel.unscoped(), |
c48e82b5 C |
90 | required: false, |
91 | include: [ | |
92 | { | |
3acc5084 | 93 | model: AccountModel, |
c48e82b5 C |
94 | required: true |
95 | } | |
96 | ] | |
ce33ee01 C |
97 | }, |
98 | { | |
3acc5084 | 99 | model: ServerModel, |
ce33ee01 | 100 | required: false |
c5911fd3 C |
101 | }, |
102 | { | |
3acc5084 | 103 | model: AvatarModel, |
c5911fd3 | 104 | required: false |
50d6de9c | 105 | } |
3acc5084 | 106 | ] |
50d6de9c | 107 | } |
3acc5084 | 108 | })) |
fadf619a | 109 | @Table({ |
50d6de9c C |
110 | tableName: 'actor', |
111 | indexes: [ | |
2ccaeeb3 | 112 | { |
8cd72bd3 C |
113 | fields: [ 'url' ], |
114 | unique: true | |
2ccaeeb3 | 115 | }, |
50d6de9c | 116 | { |
e12a0092 | 117 | fields: [ 'preferredUsername', 'serverId' ], |
77e08517 C |
118 | unique: true, |
119 | where: { | |
120 | serverId: { | |
121 | [Op.ne]: null | |
122 | } | |
123 | } | |
124 | }, | |
458218d2 C |
125 | // { |
126 | // fields: [ 'preferredUsername' ], | |
127 | // unique: true, | |
128 | // where: { | |
129 | // serverId: null | |
130 | // } | |
131 | // }, | |
6502c3d4 C |
132 | { |
133 | fields: [ 'inboxUrl', 'sharedInboxUrl' ] | |
57c36b27 | 134 | }, |
a3d1026b C |
135 | { |
136 | fields: [ 'sharedInboxUrl' ] | |
137 | }, | |
57c36b27 C |
138 | { |
139 | fields: [ 'serverId' ] | |
140 | }, | |
141 | { | |
142 | fields: [ 'avatarId' ] | |
8cd72bd3 | 143 | }, |
8cd72bd3 C |
144 | { |
145 | fields: [ 'followersUrl' ] | |
50d6de9c C |
146 | } |
147 | ] | |
fadf619a C |
148 | }) |
149 | export class ActorModel extends Model<ActorModel> { | |
150 | ||
50d6de9c | 151 | @AllowNull(false) |
3acc5084 | 152 | @Column(DataType.ENUM(...values(ACTIVITY_PUB_ACTOR_TYPES))) |
50d6de9c C |
153 | type: ActivityPubActorType |
154 | ||
fadf619a | 155 | @AllowNull(false) |
e12a0092 | 156 | @Is('ActorPreferredUsername', value => throwIfNotValid(value, isActorPreferredUsernameValid, 'actor preferred username')) |
fadf619a | 157 | @Column |
e12a0092 | 158 | preferredUsername: string |
fadf619a C |
159 | |
160 | @AllowNull(false) | |
161 | @Is('ActorUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url')) | |
01de67b9 | 162 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) |
fadf619a C |
163 | url: string |
164 | ||
165 | @AllowNull(true) | |
1735c825 | 166 | @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPublicKeyValid, 'public key', true)) |
01de67b9 | 167 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PUBLIC_KEY.max)) |
fadf619a C |
168 | publicKey: string |
169 | ||
170 | @AllowNull(true) | |
1735c825 | 171 | @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPrivateKeyValid, 'private key', true)) |
01de67b9 | 172 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PRIVATE_KEY.max)) |
fadf619a C |
173 | privateKey: string |
174 | ||
175 | @AllowNull(false) | |
176 | @Is('ActorFollowersCount', value => throwIfNotValid(value, isActorFollowersCountValid, 'followers count')) | |
177 | @Column | |
178 | followersCount: number | |
179 | ||
180 | @AllowNull(false) | |
181 | @Is('ActorFollowersCount', value => throwIfNotValid(value, isActorFollowingCountValid, 'following count')) | |
182 | @Column | |
183 | followingCount: number | |
184 | ||
185 | @AllowNull(false) | |
186 | @Is('ActorInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'inbox url')) | |
01de67b9 | 187 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) |
fadf619a C |
188 | inboxUrl: string |
189 | ||
0b5c385b C |
190 | @AllowNull(true) |
191 | @Is('ActorOutboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'outbox url', true)) | |
01de67b9 | 192 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) |
fadf619a C |
193 | outboxUrl: string |
194 | ||
47581df0 C |
195 | @AllowNull(true) |
196 | @Is('ActorSharedInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'shared inbox url', true)) | |
01de67b9 | 197 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) |
fadf619a C |
198 | sharedInboxUrl: string |
199 | ||
0b5c385b C |
200 | @AllowNull(true) |
201 | @Is('ActorFollowersUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'followers url', true)) | |
01de67b9 | 202 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) |
fadf619a C |
203 | followersUrl: string |
204 | ||
0b5c385b C |
205 | @AllowNull(true) |
206 | @Is('ActorFollowingUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'following url', true)) | |
01de67b9 | 207 | @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) |
fadf619a C |
208 | followingUrl: string |
209 | ||
210 | @CreatedAt | |
211 | createdAt: Date | |
212 | ||
213 | @UpdatedAt | |
214 | updatedAt: Date | |
215 | ||
216 | @ForeignKey(() => AvatarModel) | |
217 | @Column | |
218 | avatarId: number | |
219 | ||
220 | @BelongsTo(() => AvatarModel, { | |
221 | foreignKey: { | |
222 | allowNull: true | |
223 | }, | |
f05a1c30 C |
224 | onDelete: 'set null', |
225 | hooks: true | |
fadf619a C |
226 | }) |
227 | Avatar: AvatarModel | |
228 | ||
50d6de9c | 229 | @HasMany(() => ActorFollowModel, { |
fadf619a | 230 | foreignKey: { |
50d6de9c | 231 | name: 'actorId', |
fadf619a C |
232 | allowNull: false |
233 | }, | |
cef534ed | 234 | as: 'ActorFollowings', |
fadf619a C |
235 | onDelete: 'cascade' |
236 | }) | |
54e74059 | 237 | ActorFollowing: ActorFollowModel[] |
fadf619a | 238 | |
50d6de9c | 239 | @HasMany(() => ActorFollowModel, { |
fadf619a | 240 | foreignKey: { |
50d6de9c | 241 | name: 'targetActorId', |
fadf619a C |
242 | allowNull: false |
243 | }, | |
54e74059 | 244 | as: 'ActorFollowers', |
fadf619a C |
245 | onDelete: 'cascade' |
246 | }) | |
54e74059 | 247 | ActorFollowers: ActorFollowModel[] |
fadf619a C |
248 | |
249 | @ForeignKey(() => ServerModel) | |
250 | @Column | |
251 | serverId: number | |
252 | ||
253 | @BelongsTo(() => ServerModel, { | |
254 | foreignKey: { | |
255 | allowNull: true | |
256 | }, | |
257 | onDelete: 'cascade' | |
258 | }) | |
259 | Server: ServerModel | |
260 | ||
50d6de9c C |
261 | @HasOne(() => AccountModel, { |
262 | foreignKey: { | |
c5a893d5 C |
263 | allowNull: true |
264 | }, | |
265 | onDelete: 'cascade', | |
266 | hooks: true | |
50d6de9c C |
267 | }) |
268 | Account: AccountModel | |
269 | ||
270 | @HasOne(() => VideoChannelModel, { | |
271 | foreignKey: { | |
c5a893d5 C |
272 | allowNull: true |
273 | }, | |
274 | onDelete: 'cascade', | |
275 | hooks: true | |
50d6de9c C |
276 | }) |
277 | VideoChannel: VideoChannelModel | |
278 | ||
e4a686b4 C |
279 | private static cache: { [ id: string ]: any } = {} |
280 | ||
453e83ea | 281 | static load (id: number): Bluebird<MActor> { |
9b39106d | 282 | return ActorModel.unscoped().findByPk(id) |
50d6de9c C |
283 | } |
284 | ||
453e83ea C |
285 | static loadFull (id: number): Bluebird<MActorFull> { |
286 | return ActorModel.scope(ScopeNames.FULL).findByPk(id) | |
287 | } | |
288 | ||
941c5eac | 289 | static loadFromAccountByVideoId (videoId: number, transaction: Transaction): Bluebird<MActor> { |
e5565833 C |
290 | const query = { |
291 | include: [ | |
292 | { | |
293 | attributes: [ 'id' ], | |
294 | model: AccountModel.unscoped(), | |
295 | required: true, | |
296 | include: [ | |
297 | { | |
298 | attributes: [ 'id' ], | |
299 | model: VideoChannelModel.unscoped(), | |
300 | required: true, | |
3acc5084 C |
301 | include: [ |
302 | { | |
303 | attributes: [ 'id' ], | |
304 | model: VideoModel.unscoped(), | |
305 | required: true, | |
306 | where: { | |
307 | id: videoId | |
308 | } | |
e5565833 | 309 | } |
3acc5084 | 310 | ] |
e5565833 C |
311 | } |
312 | ] | |
313 | } | |
314 | ], | |
315 | transaction | |
316 | } | |
317 | ||
3acc5084 | 318 | return ActorModel.unscoped().findOne(query) |
e5565833 C |
319 | } |
320 | ||
d4defe07 C |
321 | static isActorUrlExist (url: string) { |
322 | const query = { | |
323 | raw: true, | |
324 | where: { | |
325 | url | |
326 | } | |
327 | } | |
328 | ||
329 | return ActorModel.unscoped().findOne(query) | |
330 | .then(a => !!a) | |
331 | } | |
332 | ||
941c5eac | 333 | static listByFollowersUrls (followersUrls: string[], transaction?: Transaction): Bluebird<MActorFull[]> { |
fadf619a C |
334 | const query = { |
335 | where: { | |
336 | followersUrl: { | |
941c5eac | 337 | [ Op.in ]: followersUrls |
fadf619a C |
338 | } |
339 | }, | |
340 | transaction | |
341 | } | |
342 | ||
50d6de9c C |
343 | return ActorModel.scope(ScopeNames.FULL).findAll(query) |
344 | } | |
345 | ||
941c5eac | 346 | static loadLocalByName (preferredUsername: string, transaction?: Transaction): Bluebird<MActorFull> { |
e4a686b4 C |
347 | // The server actor never change, so we can easily cache it |
348 | if (preferredUsername === SERVER_ACTOR_NAME && ActorModel.cache[preferredUsername]) { | |
349 | return Bluebird.resolve(ActorModel.cache[preferredUsername]) | |
350 | } | |
351 | ||
50d6de9c C |
352 | const query = { |
353 | where: { | |
e12a0092 | 354 | preferredUsername, |
50d6de9c | 355 | serverId: null |
8a19bee1 C |
356 | }, |
357 | transaction | |
50d6de9c C |
358 | } |
359 | ||
e4a686b4 C |
360 | return ActorModel.scope(ScopeNames.FULL) |
361 | .findOne(query) | |
362 | .then(actor => { | |
363 | if (preferredUsername === SERVER_ACTOR_NAME) { | |
364 | ActorModel.cache[ preferredUsername ] = actor | |
365 | } | |
366 | ||
367 | return actor | |
368 | }) | |
50d6de9c C |
369 | } |
370 | ||
453e83ea | 371 | static loadByNameAndHost (preferredUsername: string, host: string): Bluebird<MActorFull> { |
50d6de9c C |
372 | const query = { |
373 | where: { | |
e12a0092 | 374 | preferredUsername |
50d6de9c C |
375 | }, |
376 | include: [ | |
377 | { | |
378 | model: ServerModel, | |
379 | required: true, | |
380 | where: { | |
381 | host | |
382 | } | |
383 | } | |
384 | ] | |
385 | } | |
386 | ||
387 | return ActorModel.scope(ScopeNames.FULL).findOne(query) | |
388 | } | |
389 | ||
941c5eac | 390 | static loadByUrl (url: string, transaction?: Transaction): Bluebird<MActorAccountChannelId> { |
e587e0ec C |
391 | const query = { |
392 | where: { | |
393 | url | |
394 | }, | |
395 | transaction, | |
396 | include: [ | |
397 | { | |
398 | attributes: [ 'id' ], | |
399 | model: AccountModel.unscoped(), | |
400 | required: false | |
401 | }, | |
402 | { | |
403 | attributes: [ 'id' ], | |
404 | model: VideoChannelModel.unscoped(), | |
405 | required: false | |
406 | } | |
407 | ] | |
408 | } | |
409 | ||
410 | return ActorModel.unscoped().findOne(query) | |
411 | } | |
412 | ||
941c5eac | 413 | static loadByUrlAndPopulateAccountAndChannel (url: string, transaction?: Transaction): Bluebird<MActorFull> { |
50d6de9c C |
414 | const query = { |
415 | where: { | |
416 | url | |
417 | }, | |
418 | transaction | |
419 | } | |
420 | ||
421 | return ActorModel.scope(ScopeNames.FULL).findOne(query) | |
fadf619a C |
422 | } |
423 | ||
32b2b43c | 424 | static incrementFollows (id: number, column: 'followersCount' | 'followingCount', by: number) { |
3acc5084 | 425 | return ActorModel.increment(column, { |
32b2b43c C |
426 | by, |
427 | where: { | |
428 | id | |
429 | } | |
430 | }) | |
431 | } | |
432 | ||
47581df0 C |
433 | getSharedInbox (this: MActorWithInboxes) { |
434 | return this.sharedInboxUrl || this.inboxUrl | |
435 | } | |
436 | ||
1ca9f7c3 | 437 | toFormattedSummaryJSON (this: MActorSummaryFormattable) { |
fadf619a C |
438 | let avatar: Avatar = null |
439 | if (this.Avatar) { | |
c5911fd3 | 440 | avatar = this.Avatar.toFormattedJSON() |
fadf619a C |
441 | } |
442 | ||
fadf619a | 443 | return { |
4cb6d457 | 444 | url: this.url, |
60650c77 | 445 | name: this.preferredUsername, |
e12a0092 | 446 | host: this.getHost(), |
1ca9f7c3 C |
447 | avatar |
448 | } | |
449 | } | |
450 | ||
451 | toFormattedJSON (this: MActorFormattable) { | |
452 | const base = this.toFormattedSummaryJSON() | |
453 | ||
454 | return Object.assign(base, { | |
455 | id: this.id, | |
c48e82b5 | 456 | hostRedundancyAllowed: this.getRedundancyAllowed(), |
fadf619a C |
457 | followingCount: this.followingCount, |
458 | followersCount: this.followersCount, | |
60650c77 C |
459 | createdAt: this.createdAt, |
460 | updatedAt: this.updatedAt | |
1ca9f7c3 | 461 | }) |
fadf619a C |
462 | } |
463 | ||
8424c402 | 464 | toActivityPubObject (this: MActorAP, name: string) { |
c5911fd3 C |
465 | let icon = undefined |
466 | if (this.avatarId) { | |
467 | const extension = extname(this.Avatar.filename) | |
468 | icon = { | |
469 | type: 'Image', | |
470 | mediaType: extension === '.png' ? 'image/png' : 'image/jpeg', | |
471 | url: this.getAvatarUrl() | |
472 | } | |
473 | } | |
474 | ||
fadf619a | 475 | const json = { |
8424c402 | 476 | type: this.type, |
fadf619a C |
477 | id: this.url, |
478 | following: this.getFollowingUrl(), | |
479 | followers: this.getFollowersUrl(), | |
418d092a | 480 | playlists: this.getPlaylistsUrl(), |
fadf619a C |
481 | inbox: this.inboxUrl, |
482 | outbox: this.outboxUrl, | |
e12a0092 | 483 | preferredUsername: this.preferredUsername, |
fadf619a | 484 | url: this.url, |
e12a0092 | 485 | name, |
fadf619a C |
486 | endpoints: { |
487 | sharedInbox: this.sharedInboxUrl | |
488 | }, | |
fadf619a C |
489 | publicKey: { |
490 | id: this.getPublicKeyUrl(), | |
491 | owner: this.url, | |
492 | publicKeyPem: this.publicKey | |
c5911fd3 C |
493 | }, |
494 | icon | |
fadf619a C |
495 | } |
496 | ||
497 | return activityPubContextify(json) | |
498 | } | |
499 | ||
941c5eac | 500 | getFollowerSharedInboxUrls (t: Transaction) { |
fadf619a C |
501 | const query = { |
502 | attributes: [ 'sharedInboxUrl' ], | |
503 | include: [ | |
504 | { | |
54e74059 C |
505 | attribute: [], |
506 | model: ActorFollowModel.unscoped(), | |
fadf619a | 507 | required: true, |
d6e99e53 | 508 | as: 'ActorFollowing', |
fadf619a | 509 | where: { |
54e74059 | 510 | state: 'accepted', |
50d6de9c | 511 | targetActorId: this.id |
fadf619a C |
512 | } |
513 | } | |
514 | ], | |
515 | transaction: t | |
516 | } | |
517 | ||
518 | return ActorModel.findAll(query) | |
519 | .then(accounts => accounts.map(a => a.sharedInboxUrl)) | |
520 | } | |
521 | ||
522 | getFollowingUrl () { | |
523 | return this.url + '/following' | |
524 | } | |
525 | ||
526 | getFollowersUrl () { | |
527 | return this.url + '/followers' | |
528 | } | |
529 | ||
418d092a C |
530 | getPlaylistsUrl () { |
531 | return this.url + '/playlists' | |
532 | } | |
533 | ||
fadf619a C |
534 | getPublicKeyUrl () { |
535 | return this.url + '#main-key' | |
536 | } | |
537 | ||
538 | isOwned () { | |
539 | return this.serverId === null | |
540 | } | |
e12a0092 | 541 | |
1ca9f7c3 | 542 | getWebfingerUrl (this: MActorServer) { |
e12a0092 C |
543 | return 'acct:' + this.preferredUsername + '@' + this.getHost() |
544 | } | |
545 | ||
80e36cd9 AB |
546 | getIdentifier () { |
547 | return this.Server ? `${this.preferredUsername}@${this.Server.host}` : this.preferredUsername | |
548 | } | |
549 | ||
1ca9f7c3 | 550 | getHost (this: MActorHost) { |
6dd9de95 | 551 | return this.Server ? this.Server.host : WEBSERVER.HOST |
e12a0092 | 552 | } |
c5911fd3 | 553 | |
b5fecbf4 | 554 | getRedundancyAllowed () { |
c48e82b5 C |
555 | return this.Server ? this.Server.redundancyAllowed : false |
556 | } | |
557 | ||
c5911fd3 C |
558 | getAvatarUrl () { |
559 | if (!this.avatarId) return undefined | |
560 | ||
557b13ae | 561 | return WEBSERVER.URL + this.Avatar.getStaticPath() |
c5911fd3 | 562 | } |
a5625b41 C |
563 | |
564 | isOutdated () { | |
565 | if (this.isOwned()) return false | |
566 | ||
9f79ade6 | 567 | return isOutdated(this, ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL) |
a5625b41 | 568 | } |
fadf619a | 569 | } |