123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234 |
- import { createTransport, Transporter } from 'nodemailer'
- import { UserRight } from '../../shared/models/users'
- 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 { JobQueue } from './job-queue'
- import { EmailPayload } from './job-queue/handlers/email'
- import { readFileSync } from 'fs-extra'
- class Emailer {
- private static instance: Emailer
- private initialized = false
- private transporter: Transporter
- private enabled = false
- 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) ]
- }
- }
- let auth
- if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) {
- auth = {
- user: CONFIG.SMTP.USERNAME,
- pass: CONFIG.SMTP.PASSWORD
- }
- }
- 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
- })
- this.enabled = true
- } else {
- if (!isTestInstance()) {
- logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!')
- }
- }
- }
- isEnabled () {
- return this.enabled
- }
- async checkConnectionOrDie () {
- if (!this.transporter) return
- logger.info('Testing SMTP server...')
- 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` +
- `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 })
- }
- 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! ` +
- `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.`
- const emailPayload: EmailPayload = {
- to: [ to ],
- subject: 'Verify your PeerTube email',
- text
- }
- return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
- }
- async addVideoAbuseReportJob (videoId: number) {
- const video = await VideoModel.load(videoId)
- if (!video) throw new Error('Unknown Video id during Abuse report.')
- const text = `Hi,\n\n` +
- `Your instance received an abuse for the following video ${video.url}\n\n` +
- `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 })
- }
- 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
- 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 })
- }
- 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 })
- }
- 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) {
- logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err })
- process.exit(-1)
- }
- static get Instance () {
- return this.instance || (this.instance = new this())
- }
- }
- // ---------------------------------------------------------------------------
- export {
- Emailer
- }
|