]>
Commit | Line | Data |
---|---|---|
1 | import { readFileSync } from 'fs-extra' | |
2 | import { isArray, merge } from 'lodash' | |
3 | import { createTransport, Transporter } from 'nodemailer' | |
4 | import { join } from 'path' | |
5 | import { EmailPayload } from '@shared/models' | |
6 | import { SendEmailDefaultOptions } from '../../shared/models/server/emailer.model' | |
7 | import { isTestInstance } from '../helpers/core-utils' | |
8 | import { root } from '@shared/core-utils' | |
9 | import { bunyanLogger, logger } from '../helpers/logger' | |
10 | import { CONFIG, isEmailEnabled } from '../initializers/config' | |
11 | import { WEBSERVER } from '../initializers/constants' | |
12 | import { MUser } from '../types/models' | |
13 | import { JobQueue } from './job-queue' | |
14 | ||
15 | const Email = require('email-templates') | |
16 | ||
17 | class Emailer { | |
18 | ||
19 | private static instance: Emailer | |
20 | private initialized = false | |
21 | private transporter: Transporter | |
22 | ||
23 | private constructor () { | |
24 | } | |
25 | ||
26 | init () { | |
27 | // Already initialized | |
28 | if (this.initialized === true) return | |
29 | this.initialized = true | |
30 | ||
31 | if (!isEmailEnabled()) { | |
32 | if (!isTestInstance()) { | |
33 | logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!') | |
34 | } | |
35 | ||
36 | return | |
37 | } | |
38 | ||
39 | if (CONFIG.SMTP.TRANSPORT === 'smtp') this.initSMTPTransport() | |
40 | else if (CONFIG.SMTP.TRANSPORT === 'sendmail') this.initSendmailTransport() | |
41 | } | |
42 | ||
43 | async checkConnection () { | |
44 | if (!this.transporter || CONFIG.SMTP.TRANSPORT !== 'smtp') return | |
45 | ||
46 | logger.info('Testing SMTP server...') | |
47 | ||
48 | try { | |
49 | const success = await this.transporter.verify() | |
50 | if (success !== true) this.warnOnConnectionFailure() | |
51 | ||
52 | logger.info('Successfully connected to SMTP server.') | |
53 | } catch (err) { | |
54 | this.warnOnConnectionFailure(err) | |
55 | } | |
56 | } | |
57 | ||
58 | addPasswordResetEmailJob (username: string, to: string, resetPasswordUrl: string) { | |
59 | const emailPayload: EmailPayload = { | |
60 | template: 'password-reset', | |
61 | to: [ to ], | |
62 | subject: 'Reset your account password', | |
63 | locals: { | |
64 | username, | |
65 | resetPasswordUrl | |
66 | } | |
67 | } | |
68 | ||
69 | return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) | |
70 | } | |
71 | ||
72 | addPasswordCreateEmailJob (username: string, to: string, createPasswordUrl: string) { | |
73 | const emailPayload: EmailPayload = { | |
74 | template: 'password-create', | |
75 | to: [ to ], | |
76 | subject: 'Create your account password', | |
77 | locals: { | |
78 | username, | |
79 | createPasswordUrl | |
80 | } | |
81 | } | |
82 | ||
83 | return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) | |
84 | } | |
85 | ||
86 | addVerifyEmailJob (username: string, to: string, verifyEmailUrl: string) { | |
87 | const emailPayload: EmailPayload = { | |
88 | template: 'verify-email', | |
89 | to: [ to ], | |
90 | subject: `Verify your email on ${CONFIG.INSTANCE.NAME}`, | |
91 | locals: { | |
92 | username, | |
93 | verifyEmailUrl | |
94 | } | |
95 | } | |
96 | ||
97 | return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) | |
98 | } | |
99 | ||
100 | addUserBlockJob (user: MUser, blocked: boolean, reason?: string) { | |
101 | const reasonString = reason ? ` for the following reason: ${reason}` : '' | |
102 | const blockedWord = blocked ? 'blocked' : 'unblocked' | |
103 | ||
104 | const to = user.email | |
105 | const emailPayload: EmailPayload = { | |
106 | to: [ to ], | |
107 | subject: 'Account ' + blockedWord, | |
108 | text: `Your account ${user.username} on ${CONFIG.INSTANCE.NAME} has been ${blockedWord}${reasonString}.` | |
109 | } | |
110 | ||
111 | return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) | |
112 | } | |
113 | ||
114 | addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) { | |
115 | const emailPayload: EmailPayload = { | |
116 | template: 'contact-form', | |
117 | to: [ CONFIG.ADMIN.EMAIL ], | |
118 | replyTo: `"${fromName}" <${fromEmail}>`, | |
119 | subject: `(contact form) ${subject}`, | |
120 | locals: { | |
121 | fromName, | |
122 | fromEmail, | |
123 | body, | |
124 | ||
125 | // There are not notification preferences for the contact form | |
126 | hideNotificationPreferences: true | |
127 | } | |
128 | } | |
129 | ||
130 | return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) | |
131 | } | |
132 | ||
133 | async sendMail (options: EmailPayload) { | |
134 | if (!isEmailEnabled()) { | |
135 | throw new Error('Cannot send mail because SMTP is not configured.') | |
136 | } | |
137 | ||
138 | const fromDisplayName = options.from | |
139 | ? options.from | |
140 | : CONFIG.INSTANCE.NAME | |
141 | ||
142 | const email = new Email({ | |
143 | send: true, | |
144 | htmlToText: { | |
145 | selectors: [ | |
146 | { selector: 'img', format: 'skip' }, | |
147 | { selector: 'a', options: { hideLinkHrefIfSameAsText: true } } | |
148 | ] | |
149 | }, | |
150 | message: { | |
151 | from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>` | |
152 | }, | |
153 | transport: this.transporter, | |
154 | views: { | |
155 | root: join(root(), 'dist', 'server', 'lib', 'emails') | |
156 | }, | |
157 | subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX | |
158 | }) | |
159 | ||
160 | const toEmails = isArray(options.to) | |
161 | ? options.to | |
162 | : [ options.to ] | |
163 | ||
164 | for (const to of toEmails) { | |
165 | const baseOptions: SendEmailDefaultOptions = { | |
166 | template: 'common', | |
167 | message: { | |
168 | to, | |
169 | from: options.from, | |
170 | subject: options.subject, | |
171 | replyTo: options.replyTo | |
172 | }, | |
173 | locals: { // default variables available in all templates | |
174 | WEBSERVER, | |
175 | EMAIL: CONFIG.EMAIL, | |
176 | instanceName: CONFIG.INSTANCE.NAME, | |
177 | text: options.text, | |
178 | subject: options.subject | |
179 | } | |
180 | } | |
181 | ||
182 | // overridden/new variables given for a specific template in the payload | |
183 | const sendOptions = merge(baseOptions, options) | |
184 | ||
185 | await email.send(sendOptions) | |
186 | .then(res => logger.debug('Sent email.', { res })) | |
187 | .catch(err => logger.error('Error in email sender.', { err })) | |
188 | } | |
189 | } | |
190 | ||
191 | private warnOnConnectionFailure (err?: Error) { | |
192 | logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err }) | |
193 | } | |
194 | ||
195 | private initSMTPTransport () { | |
196 | logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT) | |
197 | ||
198 | let tls | |
199 | if (CONFIG.SMTP.CA_FILE) { | |
200 | tls = { | |
201 | ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ] | |
202 | } | |
203 | } | |
204 | ||
205 | let auth | |
206 | if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) { | |
207 | auth = { | |
208 | user: CONFIG.SMTP.USERNAME, | |
209 | pass: CONFIG.SMTP.PASSWORD | |
210 | } | |
211 | } | |
212 | ||
213 | this.transporter = createTransport({ | |
214 | host: CONFIG.SMTP.HOSTNAME, | |
215 | port: CONFIG.SMTP.PORT, | |
216 | secure: CONFIG.SMTP.TLS, | |
217 | debug: CONFIG.LOG.LEVEL === 'debug', | |
218 | logger: bunyanLogger as any, | |
219 | ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS, | |
220 | tls, | |
221 | auth | |
222 | }) | |
223 | } | |
224 | ||
225 | private initSendmailTransport () { | |
226 | logger.info('Using sendmail to send emails') | |
227 | ||
228 | this.transporter = createTransport({ | |
229 | sendmail: true, | |
230 | newline: 'unix', | |
231 | path: CONFIG.SMTP.SENDMAIL, | |
232 | logger: bunyanLogger | |
233 | }) | |
234 | } | |
235 | ||
236 | static get Instance () { | |
237 | return this.instance || (this.instance = new this()) | |
238 | } | |
239 | } | |
240 | ||
241 | // --------------------------------------------------------------------------- | |
242 | ||
243 | export { | |
244 | Emailer | |
245 | } |