X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=9e546de7f85d39adf55545afe8510005d7d64ee0;hb=bd911b54b555b11df7e9849cf92d358bccfecf6e;hp=f5b68640e82f3d8170324bffec6cc3a0e848f7db;hpb=ecb4e35f4e6c7304cb274593c13cb47fd5078b75;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts index f5b68640e..9e546de7f 100644 --- a/server/lib/emailer.ts +++ b/server/lib/emailer.ts @@ -1,10 +1,18 @@ +import { readFileSync } from 'fs-extra' +import { isArray, merge } from 'lodash' import { createTransport, Transporter } from 'nodemailer' -import { isTestInstance } from '../helpers/core-utils' -import { logger } from '../helpers/logger' -import { CONFIG } from '../initializers' +import { join } from 'path' +import { root } from '@shared/core-utils' +import { EmailPayload } from '@shared/models' +import { SendEmailDefaultOptions } from '../../shared/models/server/emailer.model' +import { isTestOrDevInstance } from '../helpers/core-utils' +import { bunyanLogger, logger } from '../helpers/logger' +import { CONFIG, isEmailEnabled } from '../initializers/config' +import { WEBSERVER } from '../initializers/constants' +import { MUser } from '../types/models' import { JobQueue } from './job-queue' -import { EmailPayload } from './job-queue/handlers/email' -import { readFileSync } from 'fs' + +const Email = require('email-templates') class Emailer { @@ -12,86 +20,218 @@ class Emailer { private initialized = false private transporter: Transporter - private constructor () {} + 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) ] - } - } - - this.transporter = createTransport({ - host: CONFIG.SMTP.HOSTNAME, - port: CONFIG.SMTP.PORT, - secure: CONFIG.SMTP.TLS, - tls, - auth: { - user: CONFIG.SMTP.USERNAME, - pass: CONFIG.SMTP.PASSWORD - } - }) - } else { - if (!isTestInstance()) { + if (!isEmailEnabled()) { + if (!isTestOrDevInstance()) { logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!') } + + return } + + if (CONFIG.SMTP.TRANSPORT === 'smtp') this.initSMTPTransport() + else if (CONFIG.SMTP.TRANSPORT === 'sendmail') this.initSendmailTransport() } - async checkConnectionOrDie () { - if (!this.transporter) return + async checkConnection () { + if (!this.transporter || CONFIG.SMTP.TRANSPORT !== 'smtp') return + + logger.info('Testing SMTP server...') try { const success = await this.transporter.verify() - if (success !== true) this.dieOnConnectionFailure() + if (success !== true) this.warnOnConnectionFailure() logger.info('Successfully connected to SMTP server.') } catch (err) { - this.dieOnConnectionFailure(err) + this.warnOnConnectionFailure(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.` + addPasswordResetEmailJob (username: string, to: string, resetPasswordUrl: string) { + const emailPayload: EmailPayload = { + template: 'password-reset', + to: [ to ], + subject: 'Reset your account password', + locals: { + username, + resetPasswordUrl + } + } + return JobQueue.Instance.createJobAsync({ 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.createJobAsync({ type: 'email', payload: emailPayload }) + } + + addVerifyEmailJob (username: string, to: string, verifyEmailUrl: string) { const emailPayload: EmailPayload = { + template: 'verify-email', to: [ to ], - subject: 'Reset your PeerTube password', - text + subject: `Verify your email on ${CONFIG.INSTANCE.NAME}`, + locals: { + username, + verifyEmailUrl + } } - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + return JobQueue.Instance.createJobAsync({ 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.') + addUserBlockJob (user: MUser, blocked: boolean, reason?: string) { + 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 ${CONFIG.INSTANCE.NAME} has been ${blockedWord}${reasonString}.` } - return this.transporter.sendMail({ - from: CONFIG.SMTP.FROM_ADDRESS, - to: to.join(','), - subject, - text + return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload }) + } + + addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) { + const emailPayload: EmailPayload = { + template: 'contact-form', + to: [ CONFIG.ADMIN.EMAIL ], + replyTo: `"${fromName}" <${fromEmail}>`, + subject: `(contact form) ${subject}`, + locals: { + fromName, + fromEmail, + body, + + // There are not notification preferences for the contact form + hideNotificationPreferences: true + } + } + + return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload }) + } + + async sendMail (options: EmailPayload) { + if (!isEmailEnabled()) { + logger.info('Cannot send mail because SMTP is not configured.') + return + } + + const fromDisplayName = options.from + ? options.from + : CONFIG.INSTANCE.NAME + + const email = new Email({ + send: true, + htmlToText: { + selectors: [ + { selector: 'img', format: 'skip' }, + { selector: 'a', options: { hideLinkHrefIfSameAsText: true } } + ] + }, + message: { + from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>` + }, + transport: this.transporter, + views: { + root: join(root(), 'dist', 'server', 'lib', 'emails') + }, + subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX + }) + + const toEmails = isArray(options.to) + ? options.to + : [ options.to ] + + for (const to of toEmails) { + 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 + } + } + + // overridden/new variables given for a specific template in the payload + const sendOptions = merge(baseOptions, options) + + await email.send(sendOptions) + .then(res => logger.debug('Sent email.', { res })) + .catch(err => logger.error('Error in email sender.', { err })) + } + } + + private warnOnConnectionFailure (err?: Error) { + logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err }) + } + + private initSMTPTransport () { + 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 }) } - private dieOnConnectionFailure (err?: Error) { - logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, err) - process.exit(-1) + private initSendmailTransport () { + logger.info('Using sendmail to send emails') + + this.transporter = createTransport({ + sendmail: true, + newline: 'unix', + path: CONFIG.SMTP.SENDMAIL, + logger: bunyanLogger + }) } static get Instance () {