2023-07-31 07:34:36 -05:00
|
|
|
import { arrayify } from '@peertube/peertube-core-utils'
|
2024-02-12 03:47:52 -06:00
|
|
|
import { EmailPayload, SendEmailDefaultOptions, UserExportState, UserRegistrationState } from '@peertube/peertube-models'
|
2023-07-31 07:34:36 -05:00
|
|
|
import { isTestOrDevInstance, root } from '@peertube/peertube-node-utils'
|
|
|
|
import { readFileSync } from 'fs'
|
|
|
|
import merge from 'lodash-es/merge.js'
|
|
|
|
import { Transporter, createTransport } from 'nodemailer'
|
2020-07-01 09:05:30 -05:00
|
|
|
import { join } from 'path'
|
2023-07-31 07:34:36 -05:00
|
|
|
import { bunyanLogger, logger } from '../helpers/logger.js'
|
|
|
|
import { CONFIG, isEmailEnabled } from '../initializers/config.js'
|
|
|
|
import { WEBSERVER } from '../initializers/constants.js'
|
2024-02-12 03:47:52 -06:00
|
|
|
import { MRegistration, MUser, MUserExport, MUserImport } from '../types/models/index.js'
|
2023-07-31 07:34:36 -05:00
|
|
|
import { JobQueue } from './job-queue/index.js'
|
2024-02-12 03:47:52 -06:00
|
|
|
import { UserModel } from '@server/models/user/user.js'
|
2019-02-20 08:54:32 -06:00
|
|
|
|
2018-01-30 06:27:07 -06:00
|
|
|
class Emailer {
|
|
|
|
|
|
|
|
private static instance: Emailer
|
|
|
|
private initialized = false
|
|
|
|
private transporter: Transporter
|
|
|
|
|
2020-01-31 09:56:52 -06:00
|
|
|
private constructor () {
|
|
|
|
}
|
2018-01-30 06:27:07 -06:00
|
|
|
|
|
|
|
init () {
|
|
|
|
// Already initialized
|
|
|
|
if (this.initialized === true) return
|
|
|
|
this.initialized = true
|
|
|
|
|
2021-01-26 02:28:28 -06:00
|
|
|
if (!isEmailEnabled()) {
|
2022-07-06 08:44:14 -05:00
|
|
|
if (!isTestOrDevInstance()) {
|
2018-01-30 06:27:07 -06:00
|
|
|
logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!')
|
|
|
|
}
|
|
|
|
|
2021-01-26 02:28:28 -06:00
|
|
|
return
|
2019-02-13 05:16:27 -06:00
|
|
|
}
|
2021-01-26 02:28:28 -06:00
|
|
|
|
|
|
|
if (CONFIG.SMTP.TRANSPORT === 'smtp') this.initSMTPTransport()
|
|
|
|
else if (CONFIG.SMTP.TRANSPORT === 'sendmail') this.initSendmailTransport()
|
2018-12-05 08:10:45 -06:00
|
|
|
}
|
|
|
|
|
2020-12-11 14:02:32 -06:00
|
|
|
async checkConnection () {
|
2019-02-13 05:16:27 -06:00
|
|
|
if (!this.transporter || CONFIG.SMTP.TRANSPORT !== 'smtp') return
|
2018-01-30 06:27:07 -06:00
|
|
|
|
2018-04-04 04:04:14 -05:00
|
|
|
logger.info('Testing SMTP server...')
|
|
|
|
|
2018-01-30 06:27:07 -06:00
|
|
|
try {
|
|
|
|
const success = await this.transporter.verify()
|
2020-12-11 14:02:32 -06:00
|
|
|
if (success !== true) this.warnOnConnectionFailure()
|
2018-01-30 06:27:07 -06:00
|
|
|
|
|
|
|
logger.info('Successfully connected to SMTP server.')
|
|
|
|
} catch (err) {
|
2020-12-11 14:02:32 -06:00
|
|
|
this.warnOnConnectionFailure(err)
|
2018-01-30 06:27:07 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2020-07-20 07:58:58 -05:00
|
|
|
addPasswordResetEmailJob (username: string, to: string, resetPasswordUrl: string) {
|
2018-12-26 03:36:24 -06:00
|
|
|
const emailPayload: EmailPayload = {
|
2020-05-05 13:22:22 -05:00
|
|
|
template: 'password-reset',
|
2018-12-26 03:36:24 -06:00
|
|
|
to: [ to ],
|
2020-05-05 13:22:22 -05:00
|
|
|
subject: 'Reset your account password',
|
|
|
|
locals: {
|
2020-07-20 07:58:58 -05:00
|
|
|
username,
|
2023-01-19 02:27:16 -06:00
|
|
|
resetPasswordUrl,
|
|
|
|
|
|
|
|
hideNotificationPreferencesLink: true
|
2020-05-05 13:22:22 -05:00
|
|
|
}
|
2018-12-26 03:36:24 -06:00
|
|
|
}
|
|
|
|
|
2022-08-08 08:48:17 -05:00
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
2018-12-26 03:36:24 -06:00
|
|
|
}
|
|
|
|
|
2020-05-05 13:22:22 -05:00
|
|
|
addPasswordCreateEmailJob (username: string, to: string, createPasswordUrl: string) {
|
2020-02-17 03:16:52 -06:00
|
|
|
const emailPayload: EmailPayload = {
|
2020-05-05 13:22:22 -05:00
|
|
|
template: 'password-create',
|
2020-02-17 03:16:52 -06:00
|
|
|
to: [ to ],
|
2020-05-05 13:22:22 -05:00
|
|
|
subject: 'Create your account password',
|
|
|
|
locals: {
|
|
|
|
username,
|
2023-01-19 02:27:16 -06:00
|
|
|
createPasswordUrl,
|
|
|
|
|
|
|
|
hideNotificationPreferencesLink: true
|
2020-05-05 13:22:22 -05:00
|
|
|
}
|
2020-02-17 03:16:52 -06:00
|
|
|
}
|
|
|
|
|
2022-08-08 08:48:17 -05:00
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
2020-02-17 03:16:52 -06:00
|
|
|
}
|
|
|
|
|
2023-01-19 02:27:16 -06:00
|
|
|
addVerifyEmailJob (options: {
|
|
|
|
username: string
|
|
|
|
isRegistrationRequest: boolean
|
|
|
|
to: string
|
|
|
|
verifyEmailUrl: string
|
|
|
|
}) {
|
|
|
|
const { username, isRegistrationRequest, to, verifyEmailUrl } = options
|
|
|
|
|
2018-12-26 03:36:24 -06:00
|
|
|
const emailPayload: EmailPayload = {
|
2020-05-05 13:22:22 -05:00
|
|
|
template: 'verify-email',
|
2018-12-26 03:36:24 -06:00
|
|
|
to: [ to ],
|
2020-12-10 17:10:37 -06:00
|
|
|
subject: `Verify your email on ${CONFIG.INSTANCE.NAME}`,
|
2020-05-05 13:22:22 -05:00
|
|
|
locals: {
|
2020-07-20 07:58:58 -05:00
|
|
|
username,
|
2023-01-19 02:27:16 -06:00
|
|
|
verifyEmailUrl,
|
|
|
|
isRegistrationRequest,
|
|
|
|
|
|
|
|
hideNotificationPreferencesLink: true
|
2020-05-05 13:22:22 -05:00
|
|
|
}
|
2018-12-26 03:36:24 -06:00
|
|
|
}
|
|
|
|
|
2022-08-08 08:48:17 -05:00
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
2018-12-26 03:36:24 -06:00
|
|
|
}
|
|
|
|
|
2019-08-15 04:53:26 -05:00
|
|
|
addUserBlockJob (user: MUser, blocked: boolean, reason?: string) {
|
2018-08-08 10:36:10 -05:00
|
|
|
const reasonString = reason ? ` for the following reason: ${reason}` : ''
|
|
|
|
const blockedWord = blocked ? 'blocked' : 'unblocked'
|
|
|
|
|
|
|
|
const to = user.email
|
|
|
|
const emailPayload: EmailPayload = {
|
|
|
|
to: [ to ],
|
2020-05-05 13:22:22 -05:00
|
|
|
subject: 'Account ' + blockedWord,
|
2020-12-10 17:10:37 -06:00
|
|
|
text: `Your account ${user.username} on ${CONFIG.INSTANCE.NAME} has been ${blockedWord}${reasonString}.`
|
2018-08-08 10:36:10 -05:00
|
|
|
}
|
|
|
|
|
2022-08-08 08:48:17 -05:00
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
2018-08-08 10:36:10 -05:00
|
|
|
}
|
|
|
|
|
2019-06-21 01:49:35 -05:00
|
|
|
addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) {
|
2019-01-09 08:14:29 -06:00
|
|
|
const emailPayload: EmailPayload = {
|
2020-05-05 13:22:22 -05:00
|
|
|
template: 'contact-form',
|
2019-01-09 08:14:29 -06:00
|
|
|
to: [ CONFIG.ADMIN.EMAIL ],
|
2020-05-05 13:22:22 -05:00
|
|
|
replyTo: `"${fromName}" <${fromEmail}>`,
|
|
|
|
subject: `(contact form) ${subject}`,
|
|
|
|
locals: {
|
|
|
|
fromName,
|
|
|
|
fromEmail,
|
2020-11-10 08:56:13 -06:00
|
|
|
body,
|
|
|
|
|
|
|
|
// There are not notification preferences for the contact form
|
2023-01-19 02:27:16 -06:00
|
|
|
hideNotificationPreferencesLink: true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
|
|
|
}
|
|
|
|
|
|
|
|
addUserRegistrationRequestProcessedJob (registration: MRegistration) {
|
|
|
|
let template: string
|
|
|
|
let subject: string
|
|
|
|
if (registration.state === UserRegistrationState.ACCEPTED) {
|
|
|
|
template = 'user-registration-request-accepted'
|
|
|
|
subject = `Your registration request for ${registration.username} has been accepted`
|
|
|
|
} else {
|
|
|
|
template = 'user-registration-request-rejected'
|
|
|
|
subject = `Your registration request for ${registration.username} has been rejected`
|
|
|
|
}
|
|
|
|
|
|
|
|
const to = registration.email
|
|
|
|
const emailPayload: EmailPayload = {
|
|
|
|
to: [ to ],
|
|
|
|
template,
|
|
|
|
subject,
|
|
|
|
locals: {
|
|
|
|
username: registration.username,
|
|
|
|
moderationResponse: registration.moderationResponse,
|
2024-02-12 03:47:52 -06:00
|
|
|
loginLink: WEBSERVER.URL + '/login',
|
|
|
|
|
|
|
|
hideNotificationPreferencesLink: true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
|
|
|
}
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
async addUserExportCompletedOrErroredJob (userExport: MUserExport) {
|
|
|
|
let template: string
|
|
|
|
let subject: string
|
|
|
|
|
|
|
|
if (userExport.state === UserExportState.COMPLETED) {
|
|
|
|
template = 'user-export-completed'
|
|
|
|
subject = `Your export archive has been created`
|
|
|
|
} else {
|
|
|
|
template = 'user-export-errored'
|
|
|
|
subject = `Failed to create your export archive`
|
|
|
|
}
|
|
|
|
|
|
|
|
const user = await UserModel.loadById(userExport.userId)
|
|
|
|
|
|
|
|
const emailPayload: EmailPayload = {
|
|
|
|
to: [ user.email ],
|
|
|
|
template,
|
|
|
|
subject,
|
|
|
|
locals: {
|
|
|
|
exportsUrl: WEBSERVER.URL + '/my-account/import-export',
|
|
|
|
errorMessage: userExport.error,
|
|
|
|
|
|
|
|
hideNotificationPreferencesLink: true
|
2020-05-05 13:22:22 -05:00
|
|
|
}
|
2019-01-09 08:14:29 -06:00
|
|
|
}
|
|
|
|
|
2022-08-08 08:48:17 -05:00
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
2019-01-09 08:14:29 -06:00
|
|
|
}
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
async addUserImportErroredJob (userImport: MUserImport) {
|
|
|
|
const user = await UserModel.loadById(userImport.userId)
|
|
|
|
|
|
|
|
const emailPayload: EmailPayload = {
|
|
|
|
to: [ user.email ],
|
|
|
|
template: 'user-import-errored',
|
|
|
|
subject: 'Failed to import your archive',
|
|
|
|
locals: {
|
|
|
|
errorMessage: userImport.error,
|
|
|
|
|
|
|
|
hideNotificationPreferencesLink: true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
|
|
|
}
|
|
|
|
|
|
|
|
async addUserImportSuccessJob (userImport: MUserImport) {
|
|
|
|
const user = await UserModel.loadById(userImport.userId)
|
|
|
|
|
|
|
|
const emailPayload: EmailPayload = {
|
|
|
|
to: [ user.email ],
|
|
|
|
template: 'user-import-completed',
|
|
|
|
subject: 'Your archive import has finished',
|
|
|
|
locals: {
|
|
|
|
resultStats: userImport.resultSummary.stats,
|
|
|
|
|
|
|
|
hideNotificationPreferencesLink: true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
|
|
|
|
}
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2019-11-29 06:36:40 -06:00
|
|
|
async sendMail (options: EmailPayload) {
|
2020-02-17 03:27:00 -06:00
|
|
|
if (!isEmailEnabled()) {
|
2022-07-12 09:32:05 -05:00
|
|
|
logger.info('Cannot send mail because SMTP is not configured.')
|
|
|
|
return
|
2018-01-30 06:27:07 -06:00
|
|
|
}
|
|
|
|
|
2020-05-05 13:22:22 -05:00
|
|
|
const fromDisplayName = options.from
|
|
|
|
? options.from
|
2020-12-10 17:10:37 -06:00
|
|
|
: CONFIG.INSTANCE.NAME
|
2019-02-14 04:56:23 -06:00
|
|
|
|
2023-07-31 07:34:36 -05:00
|
|
|
const EmailTemplates = (await import('email-templates')).default
|
|
|
|
|
|
|
|
const email = new EmailTemplates({
|
2020-05-05 13:22:22 -05:00
|
|
|
send: true,
|
2022-04-15 07:19:07 -05:00
|
|
|
htmlToText: {
|
|
|
|
selectors: [
|
|
|
|
{ selector: 'img', format: 'skip' },
|
2022-04-15 08:17:32 -05:00
|
|
|
{ selector: 'a', options: { hideLinkHrefIfSameAsText: true } }
|
2022-04-15 07:19:07 -05:00
|
|
|
]
|
|
|
|
},
|
2020-05-05 13:22:22 -05:00
|
|
|
message: {
|
|
|
|
from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`
|
|
|
|
},
|
|
|
|
transport: this.transporter,
|
|
|
|
views: {
|
2023-10-04 08:40:33 -05:00
|
|
|
root: join(root(), 'dist', 'core', 'lib', 'emails')
|
2020-05-05 13:22:22 -05:00
|
|
|
},
|
|
|
|
subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX
|
|
|
|
})
|
|
|
|
|
2022-08-17 08:36:03 -05:00
|
|
|
const toEmails = arrayify(options.to)
|
2021-07-30 09:51:27 -05:00
|
|
|
|
|
|
|
for (const to of toEmails) {
|
2021-03-12 03:22:17 -06:00
|
|
|
const baseOptions: SendEmailDefaultOptions = {
|
|
|
|
template: 'common',
|
|
|
|
message: {
|
|
|
|
to,
|
|
|
|
from: options.from,
|
|
|
|
subject: options.subject,
|
|
|
|
replyTo: options.replyTo
|
|
|
|
},
|
|
|
|
locals: { // default variables available in all templates
|
|
|
|
WEBSERVER,
|
|
|
|
EMAIL: CONFIG.EMAIL,
|
|
|
|
instanceName: CONFIG.INSTANCE.NAME,
|
|
|
|
text: options.text,
|
|
|
|
subject: options.subject
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
|
|
|
// overridden/new variables given for a specific template in the payload
|
2021-03-12 03:22:17 -06:00
|
|
|
const sendOptions = merge(baseOptions, options)
|
|
|
|
|
|
|
|
await email.send(sendOptions)
|
2020-06-02 02:21:33 -05:00
|
|
|
.then(res => logger.debug('Sent email.', { res }))
|
|
|
|
.catch(err => logger.error('Error in email sender.', { err }))
|
2019-11-29 06:36:40 -06:00
|
|
|
}
|
2018-01-30 06:27:07 -06:00
|
|
|
}
|
|
|
|
|
2020-12-11 14:02:32 -06:00
|
|
|
private warnOnConnectionFailure (err?: Error) {
|
2018-03-26 08:54:13 -05:00
|
|
|
logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err })
|
2018-01-30 06:27:07 -06:00
|
|
|
}
|
|
|
|
|
2021-01-26 02:28:28 -06:00
|
|
|
private initSMTPTransport () {
|
|
|
|
logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT)
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
let tls: { ca: [ Buffer ] }
|
2021-01-26 02:28:28 -06:00
|
|
|
if (CONFIG.SMTP.CA_FILE) {
|
|
|
|
tls = {
|
|
|
|
ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-02-12 03:47:52 -06:00
|
|
|
let auth: { user: string, pass: string }
|
2021-01-26 02:28:28 -06:00
|
|
|
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
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
private initSendmailTransport () {
|
|
|
|
logger.info('Using sendmail to send emails')
|
|
|
|
|
|
|
|
this.transporter = createTransport({
|
|
|
|
sendmail: true,
|
|
|
|
newline: 'unix',
|
2021-04-21 02:16:06 -05:00
|
|
|
path: CONFIG.SMTP.SENDMAIL,
|
2021-10-11 07:49:10 -05:00
|
|
|
logger: bunyanLogger
|
2021-01-26 02:28:28 -06:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2018-01-30 06:27:07 -06:00
|
|
|
static get Instance () {
|
|
|
|
return this.instance || (this.instance = new this())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
export {
|
2020-04-23 02:32:53 -05:00
|
|
|
Emailer
|
2018-01-30 06:27:07 -06:00
|
|
|
}
|