PeerTube/server/lib/emailer.ts

211 lines
6.2 KiB
TypeScript
Raw Normal View History

2018-01-30 13:27:07 +01:00
import { createTransport, Transporter } from 'nodemailer'
2018-02-01 11:08:10 +01:00
import { UserRight } from '../../shared/models/users'
2018-01-30 13:27:07 +01:00
import { isTestInstance } from '../helpers/core-utils'
2018-03-22 11:32:43 +01:00
import { bunyanLogger, logger } from '../helpers/logger'
2018-01-30 13:27:07 +01:00
import { CONFIG } from '../initializers'
2018-02-01 11:08:10 +01:00
import { UserModel } from '../models/account/user'
import { VideoModel } from '../models/video/video'
2018-01-30 13:27:07 +01:00
import { JobQueue } from './job-queue'
import { EmailPayload } from './job-queue/handlers/email'
import { readFileSync } from 'fs'
class Emailer {
private static instance: Emailer
private initialized = false
private transporter: Transporter
private constructor () {}
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
if (CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) {
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 15:16:24 +01:00
let auth
if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) {
auth = {
user: CONFIG.SMTP.USERNAME,
pass: CONFIG.SMTP.PASSWORD
}
}
2018-01-30 13:27:07 +01:00
this.transporter = createTransport({
host: CONFIG.SMTP.HOSTNAME,
port: CONFIG.SMTP.PORT,
secure: CONFIG.SMTP.TLS,
2018-03-22 11:32:43 +01:00
debug: CONFIG.LOG.LEVEL === 'debug',
logger: bunyanLogger as any,
2018-03-22 16:12:52 +01:00
ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS,
2018-01-30 13:27:07 +01:00
tls,
2018-01-30 15:16:24 +01:00
auth
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!')
}
}
}
async checkConnectionOrDie () {
if (!this.transporter) return
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)
}
}
addForgetPasswordEmailJob (to: string, resetPasswordUrl: string) {
const text = `Hi dear user,\n\n` +
`It seems you forgot your password on ${CONFIG.WEBSERVER.HOST}! ` +
`Please follow this link to reset it: ${resetPasswordUrl}\n\n` +
2018-01-30 13:27:07 +01:00
`If you are not the person who initiated this request, please ignore this email.\n\n` +
`Cheers,\n` +
`PeerTube.`
const emailPayload: EmailPayload = {
to: [ to ],
subject: 'Reset your PeerTube password',
text
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2018-08-08 17:36:10 +02:00
async addVideoAbuseReportJob (videoId: number) {
2018-02-01 11:08:10 +01:00
const video = await VideoModel.load(videoId)
if (!video) throw new Error('Unknown Video id during Abuse report.')
2018-02-01 11:08:10 +01:00
const text = `Hi,\n\n` +
`Your instance received an abuse for the following video ${video.url}\n\n` +
2018-02-01 11:08:10 +01:00
`Cheers,\n` +
`PeerTube.`
const to = await UserModel.listEmailsWithRight(UserRight.MANAGE_VIDEO_ABUSES)
const emailPayload: EmailPayload = {
to,
subject: '[PeerTube] Received a video abuse',
text
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2018-08-13 16:57:13 +02:00
async addVideoBlacklistReportJob (videoId: number, reason?: string) {
const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
if (!video) throw new Error('Unknown Video id during Blacklist report.')
// It's not our user
if (video.remote === true) return
const user = await UserModel.loadById(video.VideoChannel.Account.userId)
const reasonString = reason ? ` for the following reason: ${reason}` : ''
const blockedString = `Your video ${video.name} on ${CONFIG.WEBSERVER.HOST} has been blacklisted${reasonString}.`
const text = 'Hi,\n\n' +
blockedString +
'\n\n' +
'Cheers,\n' +
`PeerTube.`
const to = user.email
const emailPayload: EmailPayload = {
to: [ to ],
subject: `[PeerTube] Video ${video.name} blacklisted`,
text
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
async addVideoUnblacklistReportJob (videoId: number) {
const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
if (!video) throw new Error('Unknown Video id during Blacklist report.')
// It's not our user
if (video.remote === true) return
2018-08-13 16:57:13 +02:00
const user = await UserModel.loadById(video.VideoChannel.Account.userId)
const text = 'Hi,\n\n' +
`Your video ${video.name} on ${CONFIG.WEBSERVER.HOST} has been unblacklisted.` +
'\n\n' +
'Cheers,\n' +
`PeerTube.`
const to = user.email
const emailPayload: EmailPayload = {
to: [ to ],
subject: `[PeerTube] Video ${video.name} unblacklisted`,
text
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2018-08-08 17:36:10 +02:00
addUserBlockJob (user: UserModel, 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 text = 'Hi,\n\n' +
blockedString +
'\n\n' +
'Cheers,\n' +
`PeerTube.`
const to = user.email
const emailPayload: EmailPayload = {
to: [ to ],
subject: '[PeerTube] Account ' + blockedWord,
text
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
2018-01-30 13:27:07 +01:00
sendMail (to: string[], subject: string, text: string) {
if (!this.transporter) {
throw new Error('Cannot send mail because SMTP is not configured.')
}
return this.transporter.sendMail({
from: CONFIG.SMTP.FROM_ADDRESS,
to: to.join(','),
subject,
text
})
}
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 {
Emailer
}