PeerTube/server/lib/emailer.ts

521 lines
16 KiB
TypeScript
Raw Normal View History

2018-01-30 13:27:07 +01:00
import { createTransport, Transporter } from 'nodemailer'
import { isTestInstance, root } from '../helpers/core-utils'
2018-03-22 11:32:43 +01:00
import { bunyanLogger, logger } from '../helpers/logger'
2020-02-17 10:27:00 +01:00
import { CONFIG, isEmailEnabled } from '../initializers/config'
2018-01-30 13:27:07 +01:00
import { JobQueue } from './job-queue'
import { readFileSync } from 'fs-extra'
2019-04-11 11:33:44 +02:00
import { WEBSERVER } from '../initializers/constants'
import {
MCommentOwnerVideo,
MVideo,
MVideoAbuseVideo,
MVideoAccountLight,
MVideoBlacklistLightVideo,
MVideoBlacklistVideo
2020-06-18 10:45:25 +02:00
} from '../types/models/video'
import { MActorFollowActors, MActorFollowFull, MUser } from '../types/models'
import { MVideoImport, MVideoImportVideo } from '@server/types/models/video/video-import'
2020-04-23 09:32:53 +02:00
import { EmailPayload } from '@shared/models'
import { join } from 'path'
import { VideoAbuse } from '../../shared/models/videos'
import { SendEmailOptions } from '../../shared/models/server/emailer.model'
import { merge } from 'lodash'
import { VideoChannelModel } from '@server/models/video/video-channel'
const Email = require('email-templates')
2018-01-30 13:27:07 +01:00
class Emailer {
private static instance: Emailer
private initialized = false
private transporter: Transporter
2020-01-31 16:56:52 +01:00
private constructor () {
}
2018-01-30 13:27:07 +01:00
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
2020-02-18 08:29:23 +01:00
if (isEmailEnabled()) {
2019-02-13 12:16:27 +01:00
if (CONFIG.SMTP.TRANSPORT === 'smtp') {
logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT)
let tls
if (CONFIG.SMTP.CA_FILE) {
tls = {
ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ]
}
2018-01-30 13:27:07 +01:00
}
2019-02-13 12:16:27 +01:00
let auth
if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) {
auth = {
user: CONFIG.SMTP.USERNAME,
pass: CONFIG.SMTP.PASSWORD
}
2018-01-30 15:16:24 +01:00
}
2019-02-13 12:16:27 +01:00
this.transporter = createTransport({
host: CONFIG.SMTP.HOSTNAME,
port: CONFIG.SMTP.PORT,
secure: CONFIG.SMTP.TLS,
debug: CONFIG.LOG.LEVEL === 'debug',
logger: bunyanLogger as any,
ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS,
tls,
auth
})
} else { // sendmail
logger.info('Using sendmail to send emails')
this.transporter = createTransport({
sendmail: true,
newline: 'unix',
2020-04-10 14:26:42 +02:00
path: CONFIG.SMTP.SENDMAIL
2019-02-13 12:16:27 +01:00
})
}
2018-01-30 13:27:07 +01:00
} else {
if (!isTestInstance()) {
logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!')
}
}
}
2019-01-10 11:12:41 +01:00
static isEnabled () {
2019-02-13 12:16:27 +01:00
if (CONFIG.SMTP.TRANSPORT === 'sendmail') {
return !!CONFIG.SMTP.SENDMAIL
} else if (CONFIG.SMTP.TRANSPORT === 'smtp') {
return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
} else {
return false
}
}
2018-01-30 13:27:07 +01:00
async checkConnectionOrDie () {
2019-02-13 12:16:27 +01:00
if (!this.transporter || CONFIG.SMTP.TRANSPORT !== 'smtp') return
2018-01-30 13:27:07 +01:00
logger.info('Testing SMTP server...')
2018-01-30 13:27:07 +01:00
try {
const success = await this.transporter.verify()
if (success !== true) this.dieOnConnectionFailure()
logger.info('Successfully connected to SMTP server.')
} catch (err) {
this.dieOnConnectionFailure(err)
}
}
2019-08-15 11:53:26 +02:00
addNewVideoFromSubscriberNotification (to: string[], video: MVideoAccountLight) {
2018-12-26 10:36:24 +01:00
const channelName = video.VideoChannel.getDisplayName()
2019-04-11 11:33:44 +02:00
const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
2018-12-26 10:36:24 +01:00
2018-01-30 13:27:07 +01:00
const emailPayload: EmailPayload = {
2018-12-26 10:36:24 +01:00
to,
subject: channelName + ' just published a new video',
text: `Your subscription ${channelName} just published a new video: "${video.name}".`,
locals: {
title: 'New content ',
action: {
text: 'View video',
url: videoUrl
}
}
2018-01-30 13:27:07 +01:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
addNewFollowNotification (to: string[], actorFollow: MActorFollowFull, followType: 'account' | 'channel') {
const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName()
const emailPayload: EmailPayload = {
template: 'follower-on-channel',
to,
subject: `New follower on your channel ${followingName}`,
locals: {
followerName: actorFollow.ActorFollower.Account.getDisplayName(),
followerUrl: actorFollow.ActorFollower.url,
followingName,
followingUrl: actorFollow.ActorFollowing.url,
followType
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
addNewInstanceFollowerNotification (to: string[], actorFollow: MActorFollowActors) {
const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : ''
const emailPayload: EmailPayload = {
to,
subject: 'New instance follower',
text: `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}.`,
locals: {
title: 'New instance follower',
action: {
text: 'Review followers',
url: WEBSERVER.URL + '/admin/follows/followers-list'
}
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
addAutoInstanceFollowingNotification (to: string[], actorFollow: MActorFollowActors) {
const instanceUrl = actorFollow.ActorFollowing.url
const emailPayload: EmailPayload = {
to,
subject: 'Auto instance following',
text: `Your instance automatically followed a new instance: <a href="${instanceUrl}">${instanceUrl}</a>.`
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
myVideoPublishedNotification (to: string[], video: MVideo) {
2019-04-11 11:33:44 +02:00
const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
const emailPayload: EmailPayload = {
to,
subject: `Your video ${video.name} has been published`,
text: `Your video "${video.name}" has been published.`,
locals: {
title: 'You video is live',
action: {
text: 'View video',
url: videoUrl
}
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
myVideoImportSuccessNotification (to: string[], videoImport: MVideoImportVideo) {
2019-04-11 11:33:44 +02:00
const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath()
const emailPayload: EmailPayload = {
to,
subject: `Your video import ${videoImport.getTargetIdentifier()} is complete`,
text: `Your video "${videoImport.getTargetIdentifier()}" just finished importing.`,
locals: {
title: 'Import complete',
action: {
text: 'View video',
url: videoUrl
}
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) {
2019-04-11 11:33:44 +02:00
const importUrl = WEBSERVER.URL + '/my-account/video-imports'
const text =
`Your video import "${videoImport.getTargetIdentifier()}" encountered an error.` +
2020-01-31 16:56:52 +01:00
'\n\n' +
`See your videos import dashboard for more information: <a href="${importUrl}">${importUrl}</a>.`
const emailPayload: EmailPayload = {
to,
subject: `Your video import "${videoImport.getTargetIdentifier()}" encountered an error`,
text,
locals: {
title: 'Import failed',
action: {
text: 'Review imports',
url: importUrl
}
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
addNewCommentOnMyVideoNotification (to: string[], comment: MCommentOwnerVideo) {
2018-12-26 10:36:24 +01:00
const video = comment.Video
const videoUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath()
2019-04-11 11:33:44 +02:00
const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath()
2018-12-26 10:36:24 +01:00
const emailPayload: EmailPayload = {
template: 'video-comment-new',
2018-12-26 10:36:24 +01:00
to,
subject: 'New comment on your video ' + video.name,
locals: {
accountName: comment.Account.getDisplayName(),
accountUrl: comment.Account.Actor.url,
comment,
video,
videoUrl,
action: {
text: 'View comment',
url: commentUrl
}
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
addNewCommentMentionNotification (to: string[], comment: MCommentOwnerVideo) {
const accountName = comment.Account.getDisplayName()
const video = comment.Video
const videoUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath()
2019-04-11 11:33:44 +02:00
const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath()
const emailPayload: EmailPayload = {
template: 'video-comment-mention',
to,
subject: 'Mention on video ' + video.name,
locals: {
comment,
video,
videoUrl,
accountName,
action: {
text: 'View comment',
url: commentUrl
}
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
addVideoAbuseModeratorsNotification (to: string[], parameters: {
videoAbuse: VideoAbuse
videoAbuseInstance: MVideoAbuseVideo
reporter: string
}) {
const videoAbuseUrl = WEBSERVER.URL + '/admin/moderation/video-abuses/list?search=%23' + parameters.videoAbuse.id
const videoUrl = WEBSERVER.URL + parameters.videoAbuseInstance.Video.getWatchStaticPath()
2018-02-01 11:08:10 +01:00
const emailPayload: EmailPayload = {
template: 'video-abuse-new',
2018-02-01 11:08:10 +01:00
to,
subject: `New video abuse report from ${parameters.reporter}`,
locals: {
videoUrl,
videoAbuseUrl,
videoCreatedAt: new Date(parameters.videoAbuseInstance.Video.createdAt).toLocaleString(),
videoPublishedAt: new Date(parameters.videoAbuseInstance.Video.publishedAt).toLocaleString(),
videoAbuse: parameters.videoAbuse,
reporter: parameters.reporter,
action: {
text: 'View report #' + parameters.videoAbuse.id,
url: videoAbuseUrl
}
}
2018-02-01 11:08:10 +01:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
async addVideoAutoBlacklistModeratorsNotification (to: string[], videoBlacklist: MVideoBlacklistLightVideo) {
2019-04-11 11:33:44 +02:00
const VIDEO_AUTO_BLACKLIST_URL = WEBSERVER.URL + '/admin/moderation/video-auto-blacklist/list'
const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
const channel = (await VideoChannelModel.loadByIdAndPopulateAccount(videoBlacklist.Video.channelId)).toFormattedSummaryJSON()
const emailPayload: EmailPayload = {
template: 'video-auto-blacklist-new',
to,
subject: 'A new video is pending moderation',
locals: {
channel,
videoUrl,
videoName: videoBlacklist.Video.name,
action: {
text: 'Review autoblacklist',
url: VIDEO_AUTO_BLACKLIST_URL
}
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
addNewUserRegistrationNotification (to: string[], user: MUser) {
const emailPayload: EmailPayload = {
template: 'user-registered',
to,
subject: `a new user registered on ${WEBSERVER.HOST}: ${user.username}`,
locals: {
user
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
addVideoBlacklistNotification (to: string[], videoBlacklist: MVideoBlacklistVideo) {
2018-12-26 10:36:24 +01:00
const videoName = videoBlacklist.Video.name
2019-04-11 11:33:44 +02:00
const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
2018-08-13 16:57:13 +02:00
2018-12-26 10:36:24 +01:00
const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : ''
2019-04-11 11:33:44 +02:00
const blockedString = `Your video ${videoName} (${videoUrl} on ${WEBSERVER.HOST} has been blacklisted${reasonString}.`
2018-08-13 16:57:13 +02:00
const emailPayload: EmailPayload = {
2018-12-26 10:36:24 +01:00
to,
subject: `Video ${videoName} blacklisted`,
text: blockedString,
locals: {
title: 'Your video was blacklisted'
}
2018-08-13 16:57:13 +02:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
addVideoUnblacklistNotification (to: string[], video: MVideo) {
2019-04-11 11:33:44 +02:00
const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
2018-08-13 16:57:13 +02:00
const emailPayload: EmailPayload = {
2018-12-26 10:36:24 +01:00
to,
subject: `Video ${video.name} unblacklisted`,
text: `Your video "${video.name}" (${videoUrl}) on ${WEBSERVER.HOST} has been unblacklisted.`,
locals: {
title: 'Your video was unblacklisted'
}
2018-08-13 16:57:13 +02:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
addPasswordResetEmailJob (to: string, resetPasswordUrl: string) {
2018-12-26 10:36:24 +01:00
const emailPayload: EmailPayload = {
template: 'password-reset',
2018-12-26 10:36:24 +01:00
to: [ to ],
subject: 'Reset your account password',
locals: {
resetPasswordUrl
}
2018-12-26 10:36:24 +01:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
addPasswordCreateEmailJob (username: string, to: string, createPasswordUrl: string) {
const emailPayload: EmailPayload = {
template: 'password-create',
to: [ to ],
subject: 'Create your account password',
locals: {
username,
createPasswordUrl
}
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2018-12-26 10:36:24 +01:00
addVerifyEmailJob (to: string, verifyEmailUrl: string) {
const emailPayload: EmailPayload = {
template: 'verify-email',
2018-12-26 10:36:24 +01:00
to: [ to ],
subject: `Verify your email on ${WEBSERVER.HOST}`,
locals: {
verifyEmailUrl
}
2018-12-26 10:36:24 +01:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-08-15 11:53:26 +02:00
addUserBlockJob (user: MUser, blocked: boolean, reason?: string) {
2018-08-08 17:36:10 +02:00
const reasonString = reason ? ` for the following reason: ${reason}` : ''
const blockedWord = blocked ? 'blocked' : 'unblocked'
const to = user.email
const emailPayload: EmailPayload = {
to: [ to ],
subject: 'Account ' + blockedWord,
text: `Your account ${user.username} on ${WEBSERVER.HOST} has been ${blockedWord}${reasonString}.`
2018-08-08 17:36:10 +02:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) {
2019-01-09 15:14:29 +01:00
const emailPayload: EmailPayload = {
template: 'contact-form',
2019-01-09 15:14:29 +01:00
to: [ CONFIG.ADMIN.EMAIL ],
replyTo: `"${fromName}" <${fromEmail}>`,
subject: `(contact form) ${subject}`,
locals: {
fromName,
fromEmail,
body
}
2019-01-09 15:14:29 +01:00
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2019-11-29 13:36:40 +01:00
async sendMail (options: EmailPayload) {
2020-02-17 10:27:00 +01:00
if (!isEmailEnabled()) {
2018-01-30 13:27:07 +01:00
throw new Error('Cannot send mail because SMTP is not configured.')
}
const fromDisplayName = options.from
? options.from
2019-04-11 11:33:44 +02:00
: WEBSERVER.HOST
2019-02-14 11:56:23 +01:00
const email = new Email({
send: true,
message: {
from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`
},
transport: this.transporter,
views: {
2020-06-02 09:21:33 +02:00
root: join(root(), 'dist', 'server', 'lib', 'emails')
},
subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX
})
2019-11-29 13:36:40 +01:00
for (const to of options.to) {
await email
.send(merge(
{
template: 'common',
message: {
to,
from: options.from,
subject: options.subject,
replyTo: options.replyTo
},
locals: { // default variables available in all templates
WEBSERVER,
EMAIL: CONFIG.EMAIL,
text: options.text,
subject: options.subject
}
},
options // overriden/new variables given for a specific template in the payload
) as SendEmailOptions)
2020-06-02 09:21:33 +02:00
.then(res => logger.debug('Sent email.', { res }))
.catch(err => logger.error('Error in email sender.', { err }))
2019-11-29 13:36:40 +01:00
}
2018-01-30 13:27:07 +01:00
}
private dieOnConnectionFailure (err?: Error) {
2018-03-26 15:54:13 +02:00
logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err })
2018-01-30 13:27:07 +01:00
process.exit(-1)
}
static get Instance () {
return this.instance || (this.instance = new this())
}
}
// ---------------------------------------------------------------------------
export {
2020-04-23 09:32:53 +02:00
Emailer
2018-01-30 13:27:07 +01:00
}