X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fnotifier.ts;h=b7cc2607d3160370f36eb5c29192b87027c7506a;hb=8c559fad1e1c4c2ab7f1388c73200aa4c6256d74;hp=9fe93ec0d1fb1cf3a285d71e234fdc4f75e216ab;hpb=7ccddd7b5250bd25a917a6e77e58b87b9484a2a4;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/notifier.ts b/server/lib/notifier.ts index 9fe93ec0d..b7cc2607d 100644 --- a/server/lib/notifier.ts +++ b/server/lib/notifier.ts @@ -1,20 +1,30 @@ import { UserNotificationSettingValue, UserNotificationType, UserRight } from '../../shared/models/users' import { logger } from '../helpers/logger' -import { VideoModel } from '../models/video/video' import { Emailer } from './emailer' import { UserNotificationModel } from '../models/account/user-notification' -import { VideoCommentModel } from '../models/video/video-comment' import { UserModel } from '../models/account/user' import { PeerTubeSocket } from './peertube-socket' -import { CONFIG } from '../initializers/constants' +import { CONFIG } from '../initializers/config' import { VideoPrivacy, VideoState } from '../../shared/models/videos' -import { VideoAbuseModel } from '../models/video/video-abuse' -import { VideoBlacklistModel } from '../models/video/video-blacklist' import * as Bluebird from 'bluebird' -import { VideoImportModel } from '../models/video/video-import' import { AccountBlocklistModel } from '../models/account/account-blocklist' -import { ActorFollowModel } from '../models/activitypub/actor-follow' -import { AccountModel } from '../models/account/account' +import { + MCommentOwnerVideo, + MVideoAbuseVideo, + MVideoAccountLight, + MVideoBlacklistLightVideo, + MVideoBlacklistVideo, + MVideoFullLight +} from '../typings/models/video' +import { + MUser, + MUserDefault, + MUserNotifSettingAccount, + MUserWithNotificationSetting, + UserNotificationModelForApi +} from '@server/typings/models/user' +import { MActorFollowFull } from '../typings/models' +import { MVideoImportVideo } from '@server/typings/models/video/video-import' class Notifier { @@ -22,15 +32,15 @@ class Notifier { private constructor () {} - notifyOnNewVideo (video: VideoModel): void { + notifyOnNewVideoIfNeeded (video: MVideoAccountLight): void { // Only notify on public and published videos which are not blacklisted - if (video.privacy !== VideoPrivacy.PUBLIC || video.state !== VideoState.PUBLISHED || video.VideoBlacklist) return + if (video.privacy !== VideoPrivacy.PUBLIC || video.state !== VideoState.PUBLISHED || video.isBlacklisted()) return this.notifySubscribersOfNewVideo(video) .catch(err => logger.error('Cannot notify subscribers of new video %s.', video.url, { err })) } - notifyOnVideoPublishedAfterTranscoding (video: VideoModel): void { + notifyOnVideoPublishedAfterTranscoding (video: MVideoFullLight): void { // don't notify if didn't wait for transcoding or video is still blacklisted/waiting for scheduled update if (!video.waitTranscoding || video.VideoBlacklist || video.ScheduleVideoUpdate) return @@ -38,7 +48,7 @@ class Notifier { .catch(err => logger.error('Cannot notify owner that its video %s has been published after transcoding.', video.url, { err })) } - notifyOnVideoPublishedAfterScheduledUpdate (video: VideoModel): void { + notifyOnVideoPublishedAfterScheduledUpdate (video: MVideoFullLight): void { // don't notify if video is still blacklisted or waiting for transcoding if (video.VideoBlacklist || (video.waitTranscoding && video.state !== VideoState.PUBLISHED)) return @@ -46,7 +56,7 @@ class Notifier { .catch(err => logger.error('Cannot notify owner that its video %s has been published after scheduled update.', video.url, { err })) } - notifyOnVideoPublishedAfterRemovedFromAutoBlacklist (video: VideoModel): void { + notifyOnVideoPublishedAfterRemovedFromAutoBlacklist (video: MVideoFullLight): void { // don't notify if video is still waiting for transcoding or scheduled update if (video.ScheduleVideoUpdate || (video.waitTranscoding && video.state !== VideoState.PUBLISHED)) return @@ -54,7 +64,7 @@ class Notifier { .catch(err => logger.error('Cannot notify owner that its video %s has been published after removed from auto-blacklist.', video.url, { err })) // tslint:disable-line:max-line-length } - notifyOnNewComment (comment: VideoCommentModel): void { + notifyOnNewComment (comment: MCommentOwnerVideo): void { this.notifyVideoOwnerOfNewComment(comment) .catch(err => logger.error('Cannot notify video owner of new comment %s.', comment.url, { err })) @@ -62,60 +72,74 @@ class Notifier { .catch(err => logger.error('Cannot notify mentions of comment %s.', comment.url, { err })) } - notifyOnNewVideoAbuse (videoAbuse: VideoAbuseModel): void { + notifyOnNewVideoAbuse (videoAbuse: MVideoAbuseVideo): void { this.notifyModeratorsOfNewVideoAbuse(videoAbuse) .catch(err => logger.error('Cannot notify of new video abuse of video %s.', videoAbuse.Video.url, { err })) } - notifyOnVideoAutoBlacklist (video: VideoModel): void { - this.notifyModeratorsOfVideoAutoBlacklist(video) - .catch(err => logger.error('Cannot notify of auto-blacklist of video %s.', video.url, { err })) + notifyOnVideoAutoBlacklist (videoBlacklist: MVideoBlacklistLightVideo): void { + this.notifyModeratorsOfVideoAutoBlacklist(videoBlacklist) + .catch(err => logger.error('Cannot notify of auto-blacklist of video %s.', videoBlacklist.Video.url, { err })) } - notifyOnVideoBlacklist (videoBlacklist: VideoBlacklistModel): void { + notifyOnVideoBlacklist (videoBlacklist: MVideoBlacklistVideo): void { this.notifyVideoOwnerOfBlacklist(videoBlacklist) .catch(err => logger.error('Cannot notify video owner of new video blacklist of %s.', videoBlacklist.Video.url, { err })) } - notifyOnVideoUnblacklist (video: VideoModel): void { + notifyOnVideoUnblacklist (video: MVideoFullLight): void { this.notifyVideoOwnerOfUnblacklist(video) .catch(err => logger.error('Cannot notify video owner of unblacklist of %s.', video.url, { err })) } - notifyOnFinishedVideoImport (videoImport: VideoImportModel, success: boolean): void { + notifyOnFinishedVideoImport (videoImport: MVideoImportVideo, success: boolean): void { this.notifyOwnerVideoImportIsFinished(videoImport, success) .catch(err => logger.error('Cannot notify owner that its video import %s is finished.', videoImport.getTargetIdentifier(), { err })) } - notifyOnNewUserRegistration (user: UserModel): void { + notifyOnNewUserRegistration (user: MUserDefault): void { this.notifyModeratorsOfNewUserRegistration(user) .catch(err => logger.error('Cannot notify moderators of new user registration (%s).', user.username, { err })) } - notifyOfNewFollow (actorFollow: ActorFollowModel): void { + notifyOfNewUserFollow (actorFollow: MActorFollowFull): void { this.notifyUserOfNewActorFollow(actorFollow) .catch(err => { logger.error( 'Cannot notify owner of channel %s of a new follow by %s.', actorFollow.ActorFollowing.VideoChannel.getDisplayName(), actorFollow.ActorFollower.Account.getDisplayName(), - err + { err } ) }) } - private async notifySubscribersOfNewVideo (video: VideoModel) { + notifyOfNewInstanceFollow (actorFollow: MActorFollowFull): void { + this.notifyAdminsOfNewInstanceFollow(actorFollow) + .catch(err => { + logger.error('Cannot notify administrators of new follower %s.', actorFollow.ActorFollower.url, { err }) + }) + } + + notifyOfAutoInstanceFollowing (actorFollow: MActorFollowFull): void { + this.notifyAdminsOfAutoInstanceFollowing(actorFollow) + .catch(err => { + logger.error('Cannot notify administrators of auto instance following %s.', actorFollow.ActorFollowing.url, { err }) + }) + } + + private async notifySubscribersOfNewVideo (video: MVideoAccountLight) { // List all followers that are users const users = await UserModel.listUserSubscribersOf(video.VideoChannel.actorId) logger.info('Notifying %d users of new video %s.', users.length, video.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.newVideoFromSubscription } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.NEW_VIDEO_FROM_SUBSCRIPTION, userId: user.id, videoId: video.id @@ -132,7 +156,7 @@ class Notifier { return this.notify({ users, settingGetter, notificationCreator, emailSender }) } - private async notifyVideoOwnerOfNewComment (comment: VideoCommentModel) { + private async notifyVideoOwnerOfNewComment (comment: MCommentOwnerVideo) { if (comment.Video.isOwned() === false) return const user = await UserModel.loadByVideoId(comment.videoId) @@ -145,12 +169,12 @@ class Notifier { logger.info('Notifying user %s of new comment %s.', user.username, comment.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.newCommentOnMyVideo } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.NEW_COMMENT_ON_MY_VIDEO, userId: user.id, commentId: comment.id @@ -167,7 +191,7 @@ class Notifier { return this.notify({ users: [ user ], settingGetter, notificationCreator, emailSender }) } - private async notifyOfCommentMention (comment: VideoCommentModel) { + private async notifyOfCommentMention (comment: MCommentOwnerVideo) { const extractedUsernames = comment.extractMentions() logger.debug( 'Extracted %d username from comment %s.', extractedUsernames.length, comment.url, @@ -190,14 +214,14 @@ class Notifier { logger.info('Notifying %d users of new comment %s.', users.length, comment.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserNotifSettingAccount) { if (accountMutedHash[user.Account.id] === true) return UserNotificationSettingValue.NONE return user.NotificationSetting.commentMention } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserNotifSettingAccount) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.COMMENT_MENTION, userId: user.id, commentId: comment.id @@ -214,7 +238,7 @@ class Notifier { return this.notify({ users, settingGetter, notificationCreator, emailSender }) } - private async notifyUserOfNewActorFollow (actorFollow: ActorFollowModel) { + private async notifyUserOfNewActorFollow (actorFollow: MActorFollowFull) { if (actorFollow.ActorFollowing.isOwned() === false) return // Account follows one of our account? @@ -229,9 +253,6 @@ class Notifier { if (!user) return - if (!actorFollow.ActorFollower.Account || !actorFollow.ActorFollower.Account.name) { - actorFollow.ActorFollower.Account = await actorFollow.ActorFollower.$get('Account') as AccountModel - } const followerAccount = actorFollow.ActorFollower.Account const accountMuted = await AccountBlocklistModel.isAccountMutedBy(user.Account.id, followerAccount.id) @@ -239,12 +260,12 @@ class Notifier { logger.info('Notifying user %s of new follower: %s.', user.username, followerAccount.getDisplayName()) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.newFollow } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.NEW_FOLLOW, userId: user.id, actorFollowId: actorFollow.id @@ -261,18 +282,72 @@ class Notifier { return this.notify({ users: [ user ], settingGetter, notificationCreator, emailSender }) } - private async notifyModeratorsOfNewVideoAbuse (videoAbuse: VideoAbuseModel) { + private async notifyAdminsOfNewInstanceFollow (actorFollow: MActorFollowFull) { + const admins = await UserModel.listWithRight(UserRight.MANAGE_SERVER_FOLLOW) + + logger.info('Notifying %d administrators of new instance follower: %s.', admins.length, actorFollow.ActorFollower.url) + + function settingGetter (user: MUserWithNotificationSetting) { + return user.NotificationSetting.newInstanceFollower + } + + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ + type: UserNotificationType.NEW_INSTANCE_FOLLOWER, + userId: user.id, + actorFollowId: actorFollow.id + }) + notification.ActorFollow = actorFollow + + return notification + } + + function emailSender (emails: string[]) { + return Emailer.Instance.addNewInstanceFollowerNotification(emails, actorFollow) + } + + return this.notify({ users: admins, settingGetter, notificationCreator, emailSender }) + } + + private async notifyAdminsOfAutoInstanceFollowing (actorFollow: MActorFollowFull) { + const admins = await UserModel.listWithRight(UserRight.MANAGE_SERVER_FOLLOW) + + logger.info('Notifying %d administrators of auto instance following: %s.', admins.length, actorFollow.ActorFollowing.url) + + function settingGetter (user: MUserWithNotificationSetting) { + return user.NotificationSetting.autoInstanceFollowing + } + + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ + type: UserNotificationType.AUTO_INSTANCE_FOLLOWING, + userId: user.id, + actorFollowId: actorFollow.id + }) + notification.ActorFollow = actorFollow + + return notification + } + + function emailSender (emails: string[]) { + return Emailer.Instance.addAutoInstanceFollowingNotification(emails, actorFollow) + } + + return this.notify({ users: admins, settingGetter, notificationCreator, emailSender }) + } + + private async notifyModeratorsOfNewVideoAbuse (videoAbuse: MVideoAbuseVideo) { const moderators = await UserModel.listWithRight(UserRight.MANAGE_VIDEO_ABUSES) if (moderators.length === 0) return logger.info('Notifying %s user/moderators of new video abuse %s.', moderators.length, videoAbuse.Video.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.videoAbuseAsModerator } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification: UserNotificationModelForApi = await UserNotificationModel.create({ type: UserNotificationType.NEW_VIDEO_ABUSE_FOR_MODERATORS, userId: user.id, videoAbuseId: videoAbuse.id @@ -289,46 +364,46 @@ class Notifier { return this.notify({ users: moderators, settingGetter, notificationCreator, emailSender }) } - private async notifyModeratorsOfVideoAutoBlacklist (video: VideoModel) { + private async notifyModeratorsOfVideoAutoBlacklist (videoBlacklist: MVideoBlacklistLightVideo) { const moderators = await UserModel.listWithRight(UserRight.MANAGE_VIDEO_BLACKLIST) if (moderators.length === 0) return - logger.info('Notifying %s moderators of video auto-blacklist %s.', moderators.length, video.url) + logger.info('Notifying %s moderators of video auto-blacklist %s.', moderators.length, videoBlacklist.Video.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.videoAutoBlacklistAsModerator } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.VIDEO_AUTO_BLACKLIST_FOR_MODERATORS, userId: user.id, - videoId: video.id + videoBlacklistId: videoBlacklist.id }) - notification.Video = video + notification.VideoBlacklist = videoBlacklist return notification } function emailSender (emails: string[]) { - return Emailer.Instance.addVideoAutoBlacklistModeratorsNotification(emails, video) + return Emailer.Instance.addVideoAutoBlacklistModeratorsNotification(emails, videoBlacklist) } return this.notify({ users: moderators, settingGetter, notificationCreator, emailSender }) } - private async notifyVideoOwnerOfBlacklist (videoBlacklist: VideoBlacklistModel) { + private async notifyVideoOwnerOfBlacklist (videoBlacklist: MVideoBlacklistVideo) { const user = await UserModel.loadByVideoId(videoBlacklist.videoId) if (!user) return logger.info('Notifying user %s that its video %s has been blacklisted.', user.username, videoBlacklist.Video.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.blacklistOnMyVideo } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.BLACKLIST_ON_MY_VIDEO, userId: user.id, videoBlacklistId: videoBlacklist.id @@ -345,18 +420,18 @@ class Notifier { return this.notify({ users: [ user ], settingGetter, notificationCreator, emailSender }) } - private async notifyVideoOwnerOfUnblacklist (video: VideoModel) { + private async notifyVideoOwnerOfUnblacklist (video: MVideoFullLight) { const user = await UserModel.loadByVideoId(video.id) if (!user) return logger.info('Notifying user %s that its video %s has been unblacklisted.', user.username, video.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.blacklistOnMyVideo } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.UNBLACKLIST_ON_MY_VIDEO, userId: user.id, videoId: video.id @@ -373,18 +448,18 @@ class Notifier { return this.notify({ users: [ user ], settingGetter, notificationCreator, emailSender }) } - private async notifyOwnedVideoHasBeenPublished (video: VideoModel) { + private async notifyOwnedVideoHasBeenPublished (video: MVideoFullLight) { const user = await UserModel.loadByVideoId(video.id) if (!user) return logger.info('Notifying user %s of the publication of its video %s.', user.username, video.url) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.myVideoPublished } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.MY_VIDEO_PUBLISHED, userId: user.id, videoId: video.id @@ -401,18 +476,18 @@ class Notifier { return this.notify({ users: [ user ], settingGetter, notificationCreator, emailSender }) } - private async notifyOwnerVideoImportIsFinished (videoImport: VideoImportModel, success: boolean) { + private async notifyOwnerVideoImportIsFinished (videoImport: MVideoImportVideo, success: boolean) { const user = await UserModel.loadByVideoImportId(videoImport.id) if (!user) return logger.info('Notifying user %s its video import %s is finished.', user.username, videoImport.getTargetIdentifier()) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.myVideoImportFinished } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: success ? UserNotificationType.MY_VIDEO_IMPORT_SUCCESS : UserNotificationType.MY_VIDEO_IMPORT_ERROR, userId: user.id, videoImportId: videoImport.id @@ -431,21 +506,21 @@ class Notifier { return this.notify({ users: [ user ], settingGetter, notificationCreator, emailSender }) } - private async notifyModeratorsOfNewUserRegistration (registeredUser: UserModel) { + private async notifyModeratorsOfNewUserRegistration (registeredUser: MUserDefault) { const moderators = await UserModel.listWithRight(UserRight.MANAGE_USERS) if (moderators.length === 0) return logger.info( 'Notifying %s moderators of new user registration of %s.', - moderators.length, registeredUser.Account.Actor.preferredUsername + moderators.length, registeredUser.username ) - function settingGetter (user: UserModel) { + function settingGetter (user: MUserWithNotificationSetting) { return user.NotificationSetting.newUserRegistration } - async function notificationCreator (user: UserModel) { - const notification = await UserNotificationModel.create({ + async function notificationCreator (user: MUserWithNotificationSetting) { + const notification = await UserNotificationModel.create({ type: UserNotificationType.NEW_USER_REGISTRATION, userId: user.id, accountId: registeredUser.Account.id @@ -462,11 +537,11 @@ class Notifier { return this.notify({ users: moderators, settingGetter, notificationCreator, emailSender }) } - private async notify (options: { - users: UserModel[], - notificationCreator: (user: UserModel) => Promise, + private async notify (options: { + users: T[], + notificationCreator: (user: T) => Promise, emailSender: (emails: string[]) => Promise | Bluebird, - settingGetter: (user: UserModel) => UserNotificationSettingValue + settingGetter: (user: T) => UserNotificationSettingValue }) { const emails: string[] = [] @@ -487,7 +562,7 @@ class Notifier { } } - private isEmailEnabled (user: UserModel, value: UserNotificationSettingValue) { + private isEmailEnabled (user: MUser, value: UserNotificationSettingValue) { if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION === true && user.emailVerified === false) return false return value & UserNotificationSettingValue.EMAIL