X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=523b11d0dc9ad27411baf38414064be4a9d2d1fb;hb=b5206dfc455c119b0dcb897bd7144be6ea4d999d;hp=672414cc0c95ac94ca18d5fb64cd3f6621cd6ac4;hpb=b426edd4854adc6e65844d8c54b8998e792b5778;p=oweals%2Fpeertube.git diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts index 672414cc0..523b11d0d 100644 --- a/server/lib/emailer.ts +++ b/server/lib/emailer.ts @@ -1,17 +1,30 @@ import { createTransport, Transporter } from 'nodemailer' import { isTestInstance } from '../helpers/core-utils' import { bunyanLogger, logger } from '../helpers/logger' -import { CONFIG } from '../initializers' -import { UserModel } from '../models/account/user' -import { VideoModel } from '../models/video/video' +import { CONFIG } from '../initializers/config' import { JobQueue } from './job-queue' import { EmailPayload } from './job-queue/handlers/email' import { readFileSync } from 'fs-extra' -import { VideoCommentModel } from '../models/video/video-comment' -import { VideoAbuseModel } from '../models/video/video-abuse' -import { VideoBlacklistModel } from '../models/video/video-blacklist' -import { VideoImportModel } from '../models/video/video-import' -import { ActorFollowModel } from '../models/activitypub/actor-follow' +import { WEBSERVER } from '../initializers/constants' +import { + MCommentOwnerVideo, + MVideo, + MVideoAbuseVideo, + MVideoAccountLight, + MVideoBlacklistLightVideo, + MVideoBlacklistVideo +} from '../typings/models/video' +import { MActorFollowActors, MActorFollowFull, MUser } from '../typings/models' +import { MVideoImport, MVideoImportVideo } from '@server/typings/models/video/video-import' + +type SendEmailOptions = { + to: string[] + subject: string + text: string + + fromDisplayName?: string + replyTo?: string +} class Emailer { @@ -80,9 +93,9 @@ class Emailer { } } - addNewVideoFromSubscriberNotification (to: string[], video: VideoModel) { + addNewVideoFromSubscriberNotification (to: string[], video: MVideoAccountLight) { const channelName = video.VideoChannel.getDisplayName() - const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = `Hi dear user,\n\n` + `Your subscription ${channelName} just published a new video: ${video.name}` + @@ -90,18 +103,18 @@ class Emailer { `You can view it on ${videoUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: channelName + ' just published a new video', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + channelName + ' just published a new video', text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewFollowNotification (to: string[], actorFollow: ActorFollowModel, followType: 'account' | 'channel') { + addNewFollowNotification (to: string[], actorFollow: MActorFollowFull, followType: 'account' | 'channel') { const followerName = actorFollow.ActorFollower.Account.getDisplayName() const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName() @@ -109,19 +122,53 @@ class Emailer { `Your ${followType} ${followingName} has a new subscriber: ${followerName}` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New follower on your channel ' + followingName, + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addNewInstanceFollowerNotification (to: string[], actorFollow: MActorFollowActors) { + const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : '' + + const text = `Hi dear admin,\n\n` + + `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}` + + `\n\n` + + `Cheers,\n` + + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New instance follower', + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addAutoInstanceFollowingNotification (to: string[], actorFollow: MActorFollowActors) { + const text = `Hi dear admin,\n\n` + + `Your instance automatically followed a new instance: ${actorFollow.ActorFollowing.url}` + + `\n\n` + + `Cheers,\n` + + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: 'New follower on your channel ' + followingName, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Auto instance following', text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - myVideoPublishedNotification (to: string[], video: VideoModel) { - const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath() + myVideoPublishedNotification (to: string[], video: MVideo) { + const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = `Hi dear user,\n\n` + `Your video ${video.name} has been published.` + @@ -129,19 +176,19 @@ class Emailer { `You can view it on ${videoUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `Your video ${video.name} is published`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video ${video.name} is published`, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - myVideoImportSuccessNotification (to: string[], videoImport: VideoImportModel) { - const videoUrl = CONFIG.WEBSERVER.URL + videoImport.Video.getWatchStaticPath() + myVideoImportSuccessNotification (to: string[], videoImport: MVideoImportVideo) { + const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath() const text = `Hi dear user,\n\n` + `Your video import ${videoImport.getTargetIdentifier()} is finished.` + @@ -149,19 +196,19 @@ class Emailer { `You can view the imported video on ${videoUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `Your video import ${videoImport.getTargetIdentifier()} is finished`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} is finished`, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - myVideoImportErrorNotification (to: string[], videoImport: VideoImportModel) { - const importUrl = CONFIG.WEBSERVER.URL + '/my-account/video-imports' + myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) { + const importUrl = WEBSERVER.URL + '/my-account/video-imports' const text = `Hi dear user,\n\n` + `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` + @@ -169,21 +216,21 @@ class Emailer { `See your videos import dashboard for more information: ${importUrl}` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `Your video import ${videoImport.getTargetIdentifier()} encountered an error`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} encountered an error`, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewCommentOnMyVideoNotification (to: string[], comment: VideoCommentModel) { + addNewCommentOnMyVideoNotification (to: string[], comment: MCommentOwnerVideo) { const accountName = comment.Account.getDisplayName() const video = comment.Video - const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath() + const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() const text = `Hi dear user,\n\n` + `A new comment has been posted by ${accountName} on your video ${video.name}` + @@ -191,21 +238,21 @@ class Emailer { `You can view it on ${commentUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: 'New comment on your video ' + video.name, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New comment on your video ' + video.name, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewCommentMentionNotification (to: string[], comment: VideoCommentModel) { + addNewCommentMentionNotification (to: string[], comment: MCommentOwnerVideo) { const accountName = comment.Account.getDisplayName() const video = comment.Video - const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath() + const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() const text = `Hi dear user,\n\n` + `${accountName} mentioned you on video ${video.name}` + @@ -213,83 +260,106 @@ class Emailer { `You can view the comment on ${commentUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: 'Mention on video ' + video.name, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Mention on video ' + video.name, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) { - const videoUrl = CONFIG.WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath() + addVideoAbuseModeratorsNotification (to: string[], videoAbuse: MVideoAbuseVideo) { + const videoUrl = WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath() const text = `Hi,\n\n` + - `${CONFIG.WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` + + `${WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: '[PeerTube] Received a video abuse', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Received a video abuse', text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewUserRegistrationNotification (to: string[], user: UserModel) { + addVideoAutoBlacklistModeratorsNotification (to: string[], videoBlacklist: MVideoBlacklistLightVideo) { + const VIDEO_AUTO_BLACKLIST_URL = WEBSERVER.URL + '/admin/moderation/video-auto-blacklist/list' + const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() + const text = `Hi,\n\n` + - `User ${user.username} just registered on ${CONFIG.WEBSERVER.HOST} PeerTube instance.\n\n` + + `A recently added video was auto-blacklisted and requires moderator review before publishing.` + + `\n\n` + + `You can view it and take appropriate action on ${videoUrl}` + + `\n\n` + + `A full list of auto-blacklisted videos can be reviewed here: ${VIDEO_AUTO_BLACKLIST_URL}` + + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: '[PeerTube] New user registration on ' + CONFIG.WEBSERVER.HOST, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'An auto-blacklisted video is awaiting review', text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) { + addNewUserRegistrationNotification (to: string[], user: MUser) { + const text = `Hi,\n\n` + + `User ${user.username} just registered on ${WEBSERVER.HOST} PeerTube instance.\n\n` + + `Cheers,\n` + + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New user registration on ' + WEBSERVER.HOST, + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addVideoBlacklistNotification (to: string[], videoBlacklist: MVideoBlacklistVideo) { const videoName = videoBlacklist.Video.name - const videoUrl = CONFIG.WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : '' - const blockedString = `Your video ${videoName} (${videoUrl} on ${CONFIG.WEBSERVER.HOST} has been blacklisted${reasonString}.` + const blockedString = `Your video ${videoName} (${videoUrl} on ${WEBSERVER.HOST} has been blacklisted${reasonString}.` const text = 'Hi,\n\n' + blockedString + '\n\n' + 'Cheers,\n' + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `[PeerTube] Video ${videoName} blacklisted`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Video ${videoName} blacklisted`, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoUnblacklistNotification (to: string[], video: VideoModel) { - const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath() + addVideoUnblacklistNotification (to: string[], video: MVideo) { + const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = 'Hi,\n\n' + - `Your video ${video.name} (${videoUrl}) on ${CONFIG.WEBSERVER.HOST} has been unblacklisted.` + + `Your video ${video.name} (${videoUrl}) on ${WEBSERVER.HOST} has been unblacklisted.` + '\n\n' + 'Cheers,\n' + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `[PeerTube] Video ${video.name} unblacklisted`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Video ${video.name} unblacklisted`, text } @@ -298,15 +368,15 @@ class Emailer { addPasswordResetEmailJob (to: string, resetPasswordUrl: string) { const text = `Hi dear user,\n\n` + - `A reset password procedure for your account ${to} has been requested on ${CONFIG.WEBSERVER.HOST} ` + + `A reset password procedure for your account ${to} has been requested on ${WEBSERVER.HOST} ` + `Please follow this link to reset it: ${resetPasswordUrl}\n\n` + `If you are not the person who initiated this request, please ignore this email.\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to: [ to ], - subject: 'Reset your PeerTube password', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Reset your password', text } @@ -315,43 +385,43 @@ class Emailer { addVerifyEmailJob (to: string, verifyEmailUrl: string) { const text = `Welcome to PeerTube,\n\n` + - `To start using PeerTube on ${CONFIG.WEBSERVER.HOST} you must verify your email! ` + + `To start using PeerTube on ${WEBSERVER.HOST} you must verify your email! ` + `Please follow this link to verify this email belongs to you: ${verifyEmailUrl}\n\n` + `If you are not the person who initiated this request, please ignore this email.\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to: [ to ], - subject: 'Verify your PeerTube email', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Verify your email', text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addUserBlockJob (user: UserModel, blocked: boolean, reason?: string) { + addUserBlockJob (user: MUser, blocked: boolean, reason?: string) { const reasonString = reason ? ` for the following reason: ${reason}` : '' const blockedWord = blocked ? 'blocked' : 'unblocked' - const blockedString = `Your account ${user.username} on ${CONFIG.WEBSERVER.HOST} has been ${blockedWord}${reasonString}.` + const blockedString = `Your account ${user.username} on ${WEBSERVER.HOST} has been ${blockedWord}${reasonString}.` const text = 'Hi,\n\n' + blockedString + '\n\n' + 'Cheers,\n' + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const to = user.email const emailPayload: EmailPayload = { to: [ to ], - subject: '[PeerTube] Account ' + blockedWord, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Account ' + blockedWord, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addContactFormJob (fromEmail: string, fromName: string, body: string) { + addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) { const text = 'Hello dear admin,\n\n' + fromName + ' sent you a message' + '\n\n---------------------------------------\n\n' + @@ -361,26 +431,34 @@ class Emailer { 'PeerTube.' const emailPayload: EmailPayload = { - from: fromEmail, + fromDisplayName: fromEmail, + replyTo: fromEmail, to: [ CONFIG.ADMIN.EMAIL ], - subject: '[PeerTube] Contact form submitted', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + subject, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - sendMail (to: string[], subject: string, text: string, from?: string) { + async sendMail (options: EmailPayload) { if (!Emailer.isEnabled()) { throw new Error('Cannot send mail because SMTP is not configured.') } - return this.transporter.sendMail({ - from: from || CONFIG.SMTP.FROM_ADDRESS, - to: to.join(','), - subject, - text - }) + const fromDisplayName = options.fromDisplayName + ? options.fromDisplayName + : WEBSERVER.HOST + + for (const to of options.to) { + await this.transporter.sendMail({ + from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`, + replyTo: options.replyTo, + to, + subject: options.subject, + text: options.text + }) + } } private dieOnConnectionFailure (err?: Error) { @@ -396,5 +474,6 @@ class Emailer { // --------------------------------------------------------------------------- export { - Emailer + Emailer, + SendEmailOptions }